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
id
stringRequiredThe order's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe 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_id
numberRequiredThe order's display ID
cart_id
stringRequiredThe ID of the cart associated with the order
The details of the cart associated with the order.
customer_id
stringRequiredThe ID of the customer associated with the order
The details of the customer associated with the order.
email
stringRequiredThe email associated with the order
billing_address_id
stringRequiredThe ID of the billing address associated with the order
The details of the billing address associated with the order.
shipping_address_id
stringRequiredThe ID of the shipping address associated with the order
The details of the shipping address associated with the order.
region_id
stringRequiredThe ID of the region this order was created in.
The details of the region this order was created in.
currency_code
stringRequiredThe 3 character currency code that is used in the order
The details of the currency used in the order.
tax_rate
null | 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_id
stringRequiredThe 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_at
DateRequiredThe date the order was canceled on.
metadata
Record<string, unknown>RequiredAn optional key-value map with additional details
no_notification
booleanRequiredFlag for describing whether or not notifications related to this should be send.
idempotency_key
stringRequiredRandomly generated key used to continue the processing of the order in case of failure.
external_id
null | stringRequiredThe ID of an external order.
sales_channel_id
null | stringRequiredThe ID of the sales channel this order belongs to.
The details of the sales channel this order belongs to.
shipping_total
numberRequiredThe total of shipping
shipping_tax_total
null | numberRequiredThe tax total applied on shipping
discount_total
numberRequiredThe total of discount rounded
raw_discount_total
numberRequiredThe total of discount
item_tax_total
null | numberRequiredThe tax total applied on items
tax_total
null | numberRequiredThe total of tax
refunded_total
numberRequiredThe total amount refunded if the order is returned.
total
numberRequiredThe total amount of the order
subtotal
numberRequiredThe subtotal of the order
paid_total
numberRequiredThe total amount paid
refundable_amount
numberRequiredThe amount that can be refunded
gift_card_total
numberRequiredThe total of gift cards
gift_card_tax_total
numberRequiredThe 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?