addShippingMethodToCartStep - Medusa Core Workflows Reference
This documentation provides a reference to the addShippingMethodToCartStep
. It belongs to the @medusajs/medusa/core-flows
package.
This step adds shipping methods to a cart.
Example#
Input#
AddShippingMethodToCartStepInput
AddShippingMethodToCartStepInputThe details of the shipping methods to add.
AddShippingMethodToCartStepInput
AddShippingMethodToCartStepInputshipping_methods
CreateShippingMethodDTO[]The shipping methods to add.
shipping_methods
CreateShippingMethodDTO[]Output#
CartShippingMethodDTO[]
CartShippingMethodDTO[]
CartShippingMethodDTO[]
CartShippingMethodDTO[]id
stringThe ID of the shipping method.
id
stringcart_id
stringThe ID of the associated cart.
cart_id
stringname
stringThe name of the shipping method.
name
stringamount
BigNumberValueThe price of the shipping method.
amount
BigNumberValueis_tax_inclusive
booleanWhether the shipping method price is tax inclusive.
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 cart shipping method.
original_total
BigNumberValueoriginal_subtotal
BigNumberValueThe original subtotal of the cart shipping method.
original_subtotal
BigNumberValueoriginal_tax_total
BigNumberValueThe original tax total of the cart shipping method.
original_tax_total
BigNumberValuetotal
BigNumberValueThe total of the cart shipping method.
total
BigNumberValuesubtotal
BigNumberValueThe subtotal of the cart shipping method.
subtotal
BigNumberValuetax_total
BigNumberValueThe tax total of the cart shipping method.
tax_total
BigNumberValuediscount_total
BigNumberValueThe discount total of the cart shipping method.
discount_total
BigNumberValuediscount_tax_total
BigNumberValueThe discount tax total of the cart shipping method.
discount_tax_total
BigNumberValueraw_original_total
BigNumberRawValueThe raw original total of the cart shipping method.
raw_original_total
BigNumberRawValueraw_original_subtotal
BigNumberRawValueThe raw original subtotal of the cart shipping method.
raw_original_subtotal
BigNumberRawValueraw_original_tax_total
BigNumberRawValueThe raw original tax total of the cart shipping method.
raw_original_tax_total
BigNumberRawValueraw_total
BigNumberRawValueThe raw total of the cart shipping method.
raw_total
BigNumberRawValueraw_subtotal
BigNumberRawValueThe raw subtotal of the cart shipping method.
raw_subtotal
BigNumberRawValueraw_tax_total
BigNumberRawValueThe raw tax total of the cart shipping method.
raw_tax_total
BigNumberRawValueraw_discount_total
BigNumberRawValueThe raw discount total of the cart shipping method.
raw_discount_total
BigNumberRawValueraw_discount_tax_total
BigNumberRawValueThe raw discount tax total of the cart 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?