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.
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_wDVWZO2Ayg0"9 })10 }11)
Input#
UpdateOrderShippingMethodsStepInput
UpdateOrderShippingMethodsStepInputThe order shipping methods to update.
UpdateOrderShippingMethodsStepInput
UpdateOrderShippingMethodsStepInputid
stringThe ID of the shipping method.
id
stringname
stringOptionalThe name of the shipping method.
name
stringOptionalshipping_option_id
stringOptionalThe associated shipping option's ID.
shipping_option_id
stringOptionalThe amount of the shipping method.
data
Record<string, unknown>OptionalThe data of the shipping method.
data
Record<string, unknown>OptionalThe tax lines of the shipping method.
The adjustments of the shipping method.
Output#
OrderShippingMethodDTO[]
OrderShippingMethodDTO[]
OrderShippingMethodDTO[]
OrderShippingMethodDTO[]id
stringThe ID of the shipping method.
id
stringorder_id
stringThe ID of the associated order.
order_id
stringname
stringThe name of the shipping method.
name
stringamount
BigNumberValueThe price of the shipping method.
amount
BigNumberValueraw_amount
BigNumberRawValueThe raw price of the shipping method.
raw_amount
BigNumberRawValueis_tax_inclusive
booleanWhether the shipping method price is tax inclusive or not.
is_tax_inclusive
booleancreated_at
string | DateWhen the shipping method was created.
created_at
string | Dateupdated_at
string | DateWhen the shipping method was updated.
updated_at
string | Dateoriginal_total
BigNumberValueThe original total of the order shipping method.
original_total
BigNumberValueoriginal_subtotal
BigNumberValueThe original subtotal of the order shipping method.
original_subtotal
BigNumberValueoriginal_tax_total
BigNumberValueThe original tax total of the order shipping method.
original_tax_total
BigNumberValuetotal
BigNumberValueThe total of the order shipping method.
total
BigNumberValuesubtotal
BigNumberValueThe subtotal of the order shipping method.
subtotal
BigNumberValuetax_total
BigNumberValueThe tax total of the order shipping method.
tax_total
BigNumberValuediscount_total
BigNumberValueThe discount total of the order shipping method.
discount_total
BigNumberValuediscount_tax_total
BigNumberValueThe discount tax total of the order shipping method.
discount_tax_total
BigNumberValueraw_original_total
BigNumberRawValueThe raw original total of the order shipping method.
raw_original_total
BigNumberRawValueraw_original_subtotal
BigNumberRawValueThe raw original subtotal of the order shipping method.
raw_original_subtotal
BigNumberRawValueraw_original_tax_total
BigNumberRawValueThe raw original tax total of the order shipping method.
raw_original_tax_total
BigNumberRawValueraw_total
BigNumberRawValueThe raw total of the order shipping method.
raw_total
BigNumberRawValueraw_subtotal
BigNumberRawValueThe raw subtotal of the order shipping method.
raw_subtotal
BigNumberRawValueraw_tax_total
BigNumberRawValueThe raw tax total of the order shipping method.
raw_tax_total
BigNumberRawValueraw_discount_total
BigNumberRawValueThe raw discount total of the order shipping method.
raw_discount_total
BigNumberRawValueraw_discount_tax_total
BigNumberRawValueThe raw discount tax total of the order shipping method.
raw_discount_tax_total
BigNumberRawValuedescription
stringOptionalThe description of the shipping method.
description
stringOptionalshipping_option_id
stringOptionalThe ID of the shipping option the method was created from.
shipping_option_id
stringOptionaldata
Record<string, unknown>OptionalAdditional data needed for fulfillment.
data
Record<string, unknown>Optionalmetadata
null | Record<string, unknown>OptionalHolds custom data in key-value pairs.
metadata
null | Record<string, unknown>OptionalThe associated tax lines.
The associated adjustments.
Was this page helpful?