Menu

maybeRefreshShippingMethodsWorkflow - Medusa Core Workflows Reference

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

This workflows refreshes shipping method prices of an order and its changes. It's used in Return Merchandise Authorization (RMA) flows. It's used by other workflows, such as refreshExchangeShippingWorkflow.

You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around refreshing shipping methods in your custom flows.

Source Code

Examples#

Steps#

useQueryGraphStep

useQueryGraphStep

useQueryGraphStep

calculateShippingOptionsPricesStep

updateOrderChangeActionsStep

updateOrderShippingMethodsStep

Workflow hook

Step conditioned by when

View step details

Input#

MaybeRefreshShippingMethodsWorkflowInputMaybeRefreshShippingMethodsWorkflowInput
The data to create a shipping method for an order edit.
shipping_method_idstring
The ID of the shipping method to refresh.
order_idstring
The ID of the order.
action_idstring
The ID of the ADD SHIPPING action to update.
contextCalculatedRMAShippingContext
Data to pass for the shipping calculation.
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
⇧↵