Menu

refreshCartShippingMethodsWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the refreshCartShippingMethodsWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow refreshes a cart's shipping methods, ensuring that their associated shipping options can still be used on the cart, and retrieve their correct pricing after a cart update. This workflow is used by the refreshCartItemsWorkflow.

You can use this workflow within your own customizations or custom workflows, allowing you to refresh the cart's shipping method after making updates to the cart.

Source Code

Examples#

Steps#

useRemoteQueryStep

validate

listShippingOptionsForCartWithPricingWorkflow

removeShippingMethodFromCartStep

updateShippingMethodsStep

Workflow hook

Step conditioned by when

View step details

Input#

RefreshCartShippingMethodsWorkflowInputRefreshCartShippingMethodsWorkflowInput
The details of the cart to refresh.
cart_idstringOptional
The cart's ID.
cartanyOptional
The Cart reference.

Hooks#

Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.

Learn more about Hooks and Additional Data.

validate#

Handlers consuming this hook accept the following input.

invokeInvokeFn<object, TOutput, TCompensateInput>
The type of invocation function passed to a step.
compensateCompensateFn<TCompensateInput>Optional
The type of compensation function passed to a step.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵