> ## 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 reservations

> Reservations for the reference

> [!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.

### Query parameters

**reference\_type** `string`

What the holds are for (`order`, `cart`, …).

**reference\_id** `string`

Id of that thing.

### Response

`ReservationListResponse`

**items** `ReservationResponse[]` *required*

The reservations, oldest first.

**ReservationResponse**

**created\_at** `string (date-time)` *required*

When the hold was taken.

**expires\_at** `string,null (date-time)`

When the hold lapses, if it is time-boxed.

**id** `string (uuid)` *required*

Reservation id.

**item\_id** `integer (int64)` *required*

Inventory item the hold is against.

**location\_id** `integer (int32)` *required*

Location the units are held at.

**quantity** `string` *required*

Units held.

**reference\_id** `string` *required*

Id of that thing.

**reference\_type** `string` *required*

What the hold is for (`order`, `cart`, `backorder`, …).

**status** `string` *required*

`pending`, `confirmed`, `allocated`, `released`, `expired` or `cancelled`.

**total** `integer` *required*

How many were returned. Minimum: `0`.

### Status codes

| Code | Meaning |
| - | - |
| `200` | Reservations for the reference |
| `422` | Validation error |

### 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.

```bash cURL theme={null}
curl --silent --show-error --fail-with-body --request GET \
  --url 'https://api.stateset.com/api/v1/inventory/reservations' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

```json 200 theme={null}
{
  "items": [
    {
      "created_at": "2026-08-31T14:22:05Z",
      "expires_at": "2026-08-31T14:22:05Z",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "item_id": 1001,
      "location_id": 1001,
      "quantity": "2",
      "reference_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reference_type": "string",
      "status": "pending"
    }
  ],
  "total": 102
}
```


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