> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List carts

> List carts

<Warning>
  **Confirm your deployment before running this request.** This page describes an API contract;
  a published reference does not establish hosted availability. Check the dated
  [host report](/api-reference/hosts) and obtain your deployment URL and credentials.
  Replace the example host if your provisioned service uses a different URL.
</Warning>

### Query parameters

<ParamField query="customer_id" type="string" />

<ParamField query="customer_email" type="string" />

<ParamField query="status" type="string">
  One of `active`, `ready_for_payment`, `payment_pending`, `completed`, `abandoned`, `expired`, `cancelled`.
</ParamField>

<ParamField query="limit" type="integer (int32)" />

<ParamField query="offset" type="integer (int32)" />

### Response

`CartListResponse`

<ResponseField name="carts" type="CartResponse[]" required>
  <Expandable title="CartResponse">
    <ResponseField name="cart_number" type="string" required />

    <ResponseField name="created_at" type="string" required />

    <ResponseField name="currency" type="string" required />

    <ResponseField name="customer_email" type="string,null" />

    <ResponseField name="customer_id" type="string,null" />

    <ResponseField name="discount_amount" type="string" required />

    <ResponseField name="grand_total" type="string" required />

    <ResponseField name="id" type="string" required />

    <ResponseField name="items" type="CartItemResponse[]" required>
      <Expandable title="CartItemResponse">
        <ResponseField name="discount_amount" type="string" required />

        <ResponseField name="id" type="string" required />

        <ResponseField name="name" type="string" required />

        <ResponseField name="product_id" type="string,null" />

        <ResponseField name="quantity" type="integer (int32)" required />

        <ResponseField name="sku" type="string" required />

        <ResponseField name="total" type="string" required />

        <ResponseField name="unit_price" type="string" required />
      </Expandable>
    </ResponseField>

    <ResponseField name="order_id" type="string,null" />

    <ResponseField name="order_number" type="string,null" />

    <ResponseField name="payment_method" type="string,null" />

    <ResponseField name="shipping_amount" type="string" required />

    <ResponseField name="shipping_method" type="string,null" />

    <ResponseField name="status" type="string" required />

    <ResponseField name="subtotal" type="string" required />

    <ResponseField name="tax_amount" type="string" required />
  </Expandable>
</ResponseField>

<ResponseField name="total" type="integer" required>
  Minimum: `0`.
</ResponseField>

### Status codes

| Code | Meaning |
| - | - |
| `200` | — |
| `400` | — |

### Using this contract

Read the [source OpenAPI document](/spec/stateset-icommerce.json) for declared schemas and alternatives.
This page also includes documented corrections from the [spec overlays](https://github.com/stateset/docs/tree/main/spec/overlays).
Example IDs and values are illustrative; replace them with records from your workspace.

<RequestExample>
  ```bash cURL theme={null}
  curl --silent --show-error --fail-with-body --request GET \
    --url 'https://api.stateset.com/api/v1/carts' \
    --header "Authorization: Bearer $STATESET_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "carts": [
      {
        "cart_number": "string",
        "created_at": "2026-08-31T14:22:05Z",
        "currency": "USD",
        "customer_email": "ada.lovelace@example.com",
        "customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "discount_amount": "5.00",
        "grand_total": "102.12",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "items": [
          {
            "discount_amount": "5.00",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "Two-Person Tent",
            "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "quantity": 2,
            "sku": "SKU-TENT-2P-GRN",
            "total": "102.12",
            "unit_price": "49.00"
          }
        ],
        "order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "order_number": "ORD-10042",
        "payment_method": "card",
        "shipping_amount": "8.00",
        "shipping_method": "ground",
        "status": "pending",
        "subtotal": "98.00",
        "tax_amount": "4.12"
      }
    ],
    "total": 102
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.