Agent-readable docs index: /llms.txt. Download /docs.zip to grep all markdown files locally.

Fields

path idID!required
The order ID.
path cartIdID!requireddeprecated
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.
path cartCart!required
The cart used at checkout. Contains detailed line items, buyer info and product information.
path statusOrderStatus!required
The status of the order.
path requiredActions[OrderRequiredActions!]!required
Required action that developer needs to perform on the order.
path events[OrderEvent!]!required
The list of events associated with the order.
path shipments[OrderShipment!]!required
Shipment details for the order.
path lineItems[OrderLineItem!]!required
Line item details for the order.
path returns[OrderReturn!]!required
Return details for the order.
path marketplaceMarketplace!required
Marketplace order originated from.
path marketplaceOrderIds[String!]!required
The list of marketplace order IDs associated with the order.
path taxPrice!required
The tax value applied to the order.
path shippingPrice!required
The shipping amount for the order.
path subtotalPrice!required
The value of all items on the order void of shipping and tax.
path totalPrice!required
The total value of the order.
path createdAtTime!required
The time the order was created.
path metadataOrderMetadata
Marketplace specific information about the order.

Related types

Rye
Powered byHolocron