refreshCartItemsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the refreshCartItemsWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow refreshes a cart to ensure its prices, promotion codes, taxes, and other details are applied correctly. It's useful after making a chnge to a cart, such as after adding an item to the cart or adding a promotion code.
This workflow is used by other cart-related workflows, such as the addToCartWorkflow after an item is added to the cart.
You can use this workflow within your own customizations or custom workflows, allowing you to refresh the cart after making updates to it in your custom flows.
Source CodeExamples#
Steps#
Workflow Hook
Step conditioned by when
Input#
RefreshCartItemsWorkflowInputRefreshCartItemsWorkflowInputThe details of the cart to refresh.
RefreshCartItemsWorkflowInputRefreshCartItemsWorkflowInputcart_idstringThe cart's ID.
cart_idstringpromo_codesstring[]OptionalThe promotion codes applied on the cart.
These promotion codes will replace previously applied codes.
promo_codesstring[]Optionalforce_refreshbooleanOptionalForce refresh the cart items
force_refreshbooleanOptionalitemsany[]OptionalThe items to refresh.
itemsany[]Optionalshipping_methodsany[]OptionalThe shipping methods to refresh.
shipping_methodsany[]Optionalforce_tax_calculationbooleanOptionalWhether to force re-calculating tax amounts, which
may include sending requests to a third-part tax provider, depending
on the configurations of the cart's tax region.
force_tax_calculationbooleanOptionalWas this page helpful?