Skip to main content
Skip to main content
You're viewing the documentation for v1, which isn't the latest Medusa version.Latest documentation

OrderDTO

Properties​

idstringRequired
The ID of the order.
versionnumberRequired
The version of the order.
currency_codestringRequired
The currency of the order
original_item_totalBigNumberValueRequired
The original item total of the order.
original_item_subtotalBigNumberValueRequired
The original item subtotal of the order.
original_item_tax_totalBigNumberValueRequired
The original item tax total of the order.
item_totalBigNumberValueRequired
The item total of the order.
item_subtotalBigNumberValueRequired
The item subtotal of the order.
item_tax_totalBigNumberValueRequired
The item tax total of the order.
original_totalBigNumberValueRequired
The original total of the order.
original_subtotalBigNumberValueRequired
The original subtotal of the order.
original_tax_totalBigNumberValueRequired
The original tax total of the order.
totalBigNumberValueRequired
The total of the order.
subtotalBigNumberValueRequired
The subtotal of the order. (Excluding taxes)
tax_totalBigNumberValueRequired
The tax total of the order.
discount_totalBigNumberValueRequired
The discount total of the order.
discount_tax_totalBigNumberValueRequired
The discount tax total of the order.
gift_card_totalBigNumberValueRequired
The gift card total of the order.
gift_card_tax_totalBigNumberValueRequired
The gift card tax total of the order.
shipping_totalBigNumberValueRequired
The shipping total of the order.
shipping_subtotalBigNumberValueRequired
The shipping subtotal of the order.
shipping_tax_totalBigNumberValueRequired
The shipping tax total of the order.
original_shipping_totalBigNumberValueRequired
The original shipping total of the order.
original_shipping_subtotalBigNumberValueRequired
The original shipping subtotal of the order.
original_shipping_tax_totalBigNumberValueRequired
The original shipping tax total of the order.
raw_original_item_totalBigNumberRawValueRequired
The raw original item total of the order.
raw_original_item_subtotalBigNumberRawValueRequired
The raw original item subtotal of the order.
raw_original_item_tax_totalBigNumberRawValueRequired
The raw original item tax total of the order.
raw_item_totalBigNumberRawValueRequired
The raw item total of the order.
raw_item_subtotalBigNumberRawValueRequired
The raw item subtotal of the order.
raw_item_tax_totalBigNumberRawValueRequired
The raw item tax total of the order.
raw_original_totalBigNumberRawValueRequired
The raw original total of the order.
raw_original_subtotalBigNumberRawValueRequired
The raw original subtotal of the order.
raw_original_tax_totalBigNumberRawValueRequired
The raw original tax total of the order.
raw_totalBigNumberRawValueRequired
The raw total of the order.
raw_subtotalBigNumberRawValueRequired
The raw subtotal of the order. (Excluding taxes)
raw_tax_totalBigNumberRawValueRequired
The raw tax total of the order.
raw_discount_totalBigNumberRawValueRequired
The raw discount total of the order.
raw_discount_tax_totalBigNumberRawValueRequired
The raw discount tax total of the order.
raw_gift_card_totalBigNumberRawValueRequired
The raw gift card total of the order.
raw_gift_card_tax_totalBigNumberRawValueRequired
The raw gift card tax total of the order.
raw_shipping_totalBigNumberRawValueRequired
The raw shipping total of the order.
raw_shipping_subtotalBigNumberRawValueRequired
The raw shipping subtotal of the order.
raw_shipping_tax_totalBigNumberRawValueRequired
The raw shipping tax total of the order.
raw_original_shipping_totalBigNumberRawValueRequired
The raw original shipping total of the order.
raw_original_shipping_subtotalBigNumberRawValueRequired
The raw original shipping subtotal of the order.
raw_original_shipping_tax_totalBigNumberRawValueRequired
The raw original shipping tax total of the order.
region_idstring
The ID of the region the order belongs to.
customer_idstring
The ID of the customer on the order.
sales_channel_idstring
The ID of the sales channel the order belongs to.
emailstring
The email of the order.
shipping_addressOrderAddressDTO
The associated shipping address.
billing_addressOrderAddressDTO
The associated billing address.
itemsOrderLineItemDTO[]
The associated order details / line items.
shipping_methodsOrderShippingMethodDTO[]
The associated shipping methods
transactionsOrderTransactionDTO[]
The tramsactions associated with the order
summaryOrderSummaryDTO
The summary of the order totals.
metadatanull | Record<string, unknown>
Holds custom data in key-value pairs.
created_atstring | Date
When the order was created.
updated_atstring | Date
When the order was updated.
Was this section helpful?
© 2025 Medusa, Inc. All rights reserved.