Order
An order is a purchase made by a customer. It holds details about payment and fulfillment of the order. An order may also be created from a draft order, which is created by an admin user.
Properties
idstringRequiredThe order's ID
created_atDateRequiredThe date with timezone at which the resource was created.
updated_atDateRequiredThe date with timezone at which the resource was updated.
object"order"RequiredDefault: "order"
The order's status
Default: pending
The order's fulfillment status
Default: not_fulfilled
The order's payment status
Default: not_paid
display_idnumberRequiredThe order's display ID
cart_idstringRequiredThe ID of the cart associated with the order
The details of the cart associated with the order.
customer_idstringRequiredThe ID of the customer associated with the order
The details of the customer associated with the order.
emailstringRequiredThe email associated with the order
billing_address_idstringRequiredThe ID of the billing address associated with the order
The details of the billing address associated with the order.
shipping_address_idstringRequiredThe ID of the shipping address associated with the order
The details of the shipping address associated with the order.
region_idstringRequiredThe ID of the region this order was created in.
The details of the region this order was created in.
currency_codestringRequiredThe 3 character currency code that is used in the order
The details of the currency used in the order.
tax_ratenull | numberRequiredThe order's tax rate
The details of the discounts applied on the order.
The details of the gift card used in the order.
The details of the shipping methods used in the order.
The details of the payments used in the order.
The details of the fulfillments created for the order.
The details of the returns created for the order.
The details of the claims created for the order.
The details of the refunds created for the order.
The details of the swaps created for the order.
draft_order_idstringRequiredThe ID of the draft order this order was created from.
The details of the draft order this order was created from.
The details of the order edits done on the order.
The details of the line items that belong to the order.
The gift card transactions made in the order.
canceled_atDateRequiredThe date the order was canceled on.
metadataRecord<string, unknown>RequiredAn optional key-value map with additional details
no_notificationbooleanRequiredFlag for describing whether or not notifications related to this should be send.
idempotency_keystringRequiredRandomly generated key used to continue the processing of the order in case of failure.
external_idnull | stringRequiredThe ID of an external order.
sales_channel_idnull | stringRequiredThe ID of the sales channel this order belongs to.
The details of the sales channel this order belongs to.
shipping_totalnumberRequiredThe total of shipping
shipping_tax_totalnull | numberRequiredThe tax total applied on shipping
discount_totalnumberRequiredThe total of discount rounded
raw_discount_totalnumberRequiredThe total of discount
item_tax_totalnull | numberRequiredThe tax total applied on items
tax_totalnull | numberRequiredThe total of tax
refunded_totalnumberRequiredThe total amount refunded if the order is returned.
totalnumberRequiredThe total amount of the order
subtotalnumberRequiredThe subtotal of the order
paid_totalnumberRequiredThe total amount paid
refundable_amountnumberRequiredThe amount that can be refunded
gift_card_totalnumberRequiredThe total of gift cards
gift_card_tax_totalnumberRequiredThe total of gift cards with taxes
The associated sales channels.
The details of the line items that are returnable as part of the order, swaps, or claims
Was this section helpful?