Skip to main content

​
Fields

​
id
required
The order ID.
​
cartId
required
deprecated
The ID of the Cart this order belongs to.

We recommend accessing the cart object directly. The id as well as all other relevant properties can be accessed directly.

​
cart
required
The cart used at checkout. Contains detailed line items, buyer info and product information.
​
status
required
The status of the order.
​
requiredActions
required
Required action that developer needs to perform on the order.
​
events
required
The list of events associated with the order.
​
shipments
required
Shipment details for the order.
​
lineItems
required
Line item details for the order.
​
returns
required
Return details for the order.
​
marketplace
required
Marketplace order originated from.
​
marketplaceOrderIds
required
The list of marketplace order IDs associated with the order.
​
tax
required
The tax value applied to the order.
​
shipping
required
The shipping amount for the order.
​
subtotal
required
The value of all items on the order void of shipping and tax.
​
total
required
The total value of the order.
​
createdAt
required
The time the order was created.
​
metadata
Marketplace specific information about the order.