Menu

OrderShippingMethodDTO

The order shipping method details.

idstring
The ID of the shipping method.
order_idstring
The ID of the associated order.
namestring
The name of the shipping method.
amountBigNumberValue
The price of the shipping method.
raw_amountBigNumberRawValue
The raw price of the shipping method.
is_tax_inclusiveboolean
Whether the shipping method price is tax inclusive or not.
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 order shipping method.
original_subtotalBigNumberValue
The original subtotal of the order shipping method.
original_tax_totalBigNumberValue
The original tax total of the order shipping method.
totalBigNumberValue
The total of the order shipping method.
subtotalBigNumberValue
The subtotal of the order shipping method.
tax_totalBigNumberValue
The tax total of the order shipping method.
discount_totalBigNumberValue
The discount total of the order shipping method.
discount_tax_totalBigNumberValue
The discount tax total of the order shipping method.
raw_original_totalBigNumberRawValue
The raw original total of the order shipping method.
raw_original_subtotalBigNumberRawValue
The raw original subtotal of the order shipping method.
raw_original_tax_totalBigNumberRawValue
The raw original tax total of the order shipping method.
raw_totalBigNumberRawValue
The raw total of the order shipping method.
raw_subtotalBigNumberRawValue
The raw subtotal of the order shipping method.
raw_tax_totalBigNumberRawValue
The raw tax total of the order shipping method.
raw_discount_totalBigNumberRawValue
The raw discount total of the order shipping method.
raw_discount_tax_totalBigNumberRawValue
The raw discount tax total of the order 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_linesOrderShippingMethodTaxLineDTO[]Optional
The associated tax lines.
adjustmentsOrderShippingMethodAdjustmentDTO[]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
⇧↵