updateOrderShippingMethodsStep - Medusa Core Workflows Reference

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

This step updates order shipping methods.

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { updateOrderShippingMethodsStep } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = updateOrderShippingMethodsStep({8      "id": "id_MybeJiTRPUh5942fr"9    })10  }11)

Input#

UpdateOrderShippingMethodsStepInputUpdateOrderShippingMethodsStepInput
The order shipping methods to update.
idstring
The ID of the shipping method.
namestringOptional
The name of the shipping method.
shipping_option_idstringOptional
The associated shipping option's ID.
amountBigNumberInputOptional
The amount of the shipping method.
dataRecord<string, unknown>Optional
The data of the shipping method.
The tax lines of the shipping method.
The adjustments of the shipping method.

Output#

OrderShippingMethodDTO[]OrderShippingMethodDTO[]
OrderShippingMethodDTOOrderShippingMethodDTO
The order 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