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

---
title: "Order"
description: "Represents an order that a customer places for a product."
---

## Fields

***

<ParamField path="id" type="ID!" required>
  The order ID.
</ParamField>

<ParamField path="cartId" type="ID!" required deprecated>
  The ID of the [`Cart`](/api-reference/cart) this order belongs to.

  <Warning>
    <p className="my-0">**We recommend accessing the `cart` object directly.** The `id` as well as all other relevant properties can be accessed directly.</p>
  </Warning>
</ParamField>

<ParamField path="cart" type={<a href="/api-reference/cart">Cart!</a>} required>
  The cart used at checkout. Contains detailed line items, buyer info and product information.
</ParamField>

<ParamField path="status" type={<a href="/api-reference/orderstatus">OrderStatus!</a>} required>
  The status of the order.
</ParamField>

<ParamField path="requiredActions" type="[OrderRequiredActions!]!" required>
  Required action that developer needs to perform on the order.
</ParamField>

<ParamField path="events" type={<a href="/api-reference/orderevent">[OrderEvent!]!</a>} required>
  The list of events associated with the order.
</ParamField>

<ParamField path="shipments" type={<a href="/api-reference/ordershipment">[OrderShipment!]!</a>} required>
  Shipment details for the order.
</ParamField>

<ParamField path="lineItems" type={<a href="/api-reference/orderlineitem">[OrderLineItem!]!</a>} required>
  Line item details for the order.
</ParamField>

<ParamField path="returns" type={<a href="/api-reference/orderreturn">[OrderReturn!]!</a>} required>
  Return details for the order.
</ParamField>

<ParamField path="marketplace" type={<a href="/api-reference/marketplace">Marketplace!</a>} required>
  Marketplace order originated from.
</ParamField>

<ParamField path="marketplaceOrderIds" type="[String!]!" required>
  The list of marketplace order IDs associated with the order.
</ParamField>

<ParamField path="tax" type={<a href="/api-reference/price">Price!</a>} required>
  The tax value applied to the order.
</ParamField>

<ParamField path="shipping" type={<a href="/api-reference/price">Price!</a>} required>
  The shipping amount for the order.
</ParamField>

<ParamField path="subtotal" type={<a href="/api-reference/price">Price!</a>} required>
  The value of all items on the order void of shipping and tax.
</ParamField>

<ParamField path="total" type={<a href="/api-reference/price">Price!</a>} required>
  The total value of the order.
</ParamField>

<ParamField path="createdAt" type={<a href="/api-reference/time">Time!</a>} required>
  The time the order was created.
</ParamField>

<ParamField path="metadata" type={<a href="/api-reference/ordermetadata">OrderMetadata</a>}>
  Marketplace specific information about the order.
</ParamField>

## Related types

* [`Cart`](/api-reference/cart)
* [`Checkout`](/api-reference/checkout)


---

*Powered by [holocron.so](https://holocron.so)*