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

# List Orders

> Retrieve a paginated list of your distribution orders

Returns a paginated list of orders for your partner account. Supports filtering by status, date range, and client reference. Replaces both the date-path and customer-reference-path endpoints from v1.

## Endpoint

**GET /v2/orders**

## Query Parameters

| Name              | Type    | Required | Description                                                                                           |
| ----------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------- |
| `clientReference` | string  | No       | Exact match on your client reference                                                                  |
| `status`          | string  | No       | Filter by order status (`PENDING`, `PROCESSING`, `COMPLETED`, `CANCELLED`, `ON_HOLD`, `OUT_OF_STOCK`) |
| `createdFrom`     | date    | No       | Inclusive start date (`YYYY-MM-DD`)                                                                   |
| `createdTo`       | date    | No       | Inclusive end date (`YYYY-MM-DD`)                                                                     |
| `page`            | integer | No       | Page number, default `1`                                                                              |
| `pageSize`        | integer | No       | Results per page, default `100`, max `2000`                                                           |

## Example Requests

```bash theme={null}
# All orders
curl -X GET "https://partner.orbt.com/v2/orders" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-client-id: YOUR_CLIENT_ID" \
  -H "x-timestamp: 2026-08-13T10:00:00.000Z" \
  -H "x-body-hash: BODY_HASH" \
  -H "x-signature: SIGNATURE"

# Filter by date range
curl -X GET "https://partner.orbt.com/v2/orders?createdFrom=2026-01-01&createdTo=2026-08-13" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-client-id: YOUR_CLIENT_ID" \
  -H "x-timestamp: 2026-08-13T10:00:00.000Z" \
  -H "x-body-hash: BODY_HASH" \
  -H "x-signature: SIGNATURE"

# Filter by client reference
curl -X GET "https://partner.orbt.com/v2/orders?clientReference=CLIENT-12345" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-client-id: YOUR_CLIENT_ID" \
  -H "x-timestamp: 2026-08-13T10:00:00.000Z" \
  -H "x-body-hash: BODY_HASH" \
  -H "x-signature: SIGNATURE"

# Filter by status
curl -X GET "https://partner.orbt.com/v2/orders?status=COMPLETED" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-client-id: YOUR_CLIENT_ID" \
  -H "x-timestamp: 2026-08-13T10:00:00.000Z" \
  -H "x-body-hash: BODY_HASH" \
  -H "x-signature: SIGNATURE"
```

```javascript theme={null}
// Filter by date range
const response = await fetch(
  'https://partner.orbt.com/v2/orders?createdFrom=2026-01-01&createdTo=2026-08-13',
  {
    method: 'GET',
    headers: {
      'x-api-key': 'YOUR_API_KEY',
      'x-client-id': 'YOUR_CLIENT_ID',
      'x-timestamp': timestamp,
      'x-body-hash': bodyHash,
      'x-signature': signature
    }
  }
);
```

## Response — 200 OK

```json theme={null}
{
  "data": [
    {
      "id": "ORD-123456",
      "clientReference": "CLIENT-12345",
      "status": "COMPLETED",
      "currency": "USD",
      "totalAmount": 500,
      "createdAt": "2026-01-16T10:00:00Z"
    },
    {
      "id": "ORD-123457",
      "clientReference": "CLIENT-12346",
      "status": "PENDING",
      "currency": "AED",
      "totalAmount": 1000,
      "createdAt": "2026-08-13T09:00:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pageSize": 100,
      "totalRecords": 2,
      "totalPages": 1,
      "hasNext": false
    }
  }
}
```

## Response Fields

| Field                     | Type     | Description                         |
| ------------------------- | -------- | ----------------------------------- |
| `data[].id`               | string   | Orbt order ID                       |
| `data[].clientReference`  | string   | Your reference for this order       |
| `data[].status`           | string   | Current order status                |
| `data[].currency`         | string   | Wallet currency used for this order |
| `data[].totalAmount`      | number   | Total face value of the order       |
| `data[].createdAt`        | datetime | Order creation timestamp            |
| `meta.pagination.hasNext` | boolean  | Whether more pages exist            |

## Error Responses

| Status | Code                   | Description                               |
| ------ | ---------------------- | ----------------------------------------- |
| `401`  | `AUTHENTICATION_ERROR` | Missing or invalid authentication headers |
| `400`  | `VALIDATION_ERROR`     | Invalid query parameter format            |