Menu

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[]
idstring
The ID of the shipping method.
cart_idstring
The ID of the associated cart.
namestring
The name of the shipping method.
amountBigNumberValue
The price of the shipping method.
is_tax_inclusiveboolean
Whether the shipping method price is tax inclusive.
created_atstring | Date
When the shipping method was created.
updated_atstring | Date
When the shipping method was updated.
original_totalBigNumberValue
The original total of the cart shipping method.
original_subtotalBigNumberValue
The original subtotal of the cart shipping method.
original_tax_totalBigNumberValue
The original tax total of the cart shipping method.
totalBigNumberValue
The total of the cart shipping method.
subtotalBigNumberValue
The subtotal of the cart shipping method.
tax_totalBigNumberValue
The tax total of the cart shipping method.
discount_totalBigNumberValue
The discount total of the cart shipping method.
discount_tax_totalBigNumberValue
The discount tax total of the cart shipping method.
raw_original_totalBigNumberRawValue
The raw original total of the cart shipping method.
raw_original_subtotalBigNumberRawValue
The raw original subtotal of the cart shipping method.
raw_original_tax_totalBigNumberRawValue
The raw original tax total of the cart shipping method.
raw_totalBigNumberRawValue
The raw total of the cart shipping method.
raw_subtotalBigNumberRawValue
The raw subtotal of the cart shipping method.
raw_tax_totalBigNumberRawValue
The raw tax total of the cart shipping method.
raw_discount_totalBigNumberRawValue
The raw discount total of the cart shipping method.
raw_discount_tax_totalBigNumberRawValue
The raw discount tax total of the cart shipping method.
descriptionstringOptional
The description of the shipping method.
shipping_option_idstringOptional
The ID of the shipping option the method was created from.
dataRecord<string, unknown>Optional
Additional data needed for fulfillment.
metadatanull | Record<string, unknown>Optional
Holds custom data in key-value pairs.
tax_linesShippingMethodTaxLineDTO[]Optional
The associated tax lines.
adjustmentsShippingMethodAdjustmentDTO[]Optional
The associated adjustments.
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
⇧↵