updateShippingMethodsStep - Medusa Core Workflows Reference

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

This step updates a cart's shipping methods.

Example#

Code
1const data = updateOrderShippingMethodsStep([2  {3    id: "sm_123",4    amount: 105  }6])

Input#

UpdateShippingMethodsStepInputUpdateShippingMethodsStepInput
The details of the shipping methods to update.
idstring
The ID of the shipping method.
namestringOptional
The name of the shipping method.
amountBigNumberInputOptional
The amount of the shipping method.
is_tax_inclusivebooleanOptional
The tax inclusivity setting of the shipping method.
dataRecord<string, unknown>Optional
The data of the shipping method.
tax_linesCreateTaxLineDTO[] | UpdateTaxLineDTO[]Optional
The tax lines of the shipping method.
adjustmentsCreateAdjustmentDTO[] | UpdateAdjustmentDTO[]Optional
The adjustments of the shipping method.

Output#

CartShippingMethodDTO[]CartShippingMethodDTO[]
CartShippingMethodDTOCartShippingMethodDTO
The cart shipping method details.
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