## Список статусов заказов

`GET /v1/order-statuses`

Возвращает список статусов заказов и доставки с поддержкой фильтрации.

## Параметры

| Параметр | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `limit` | number | `50` | Количество записей (до 5000) |
| `select` | string | — | Выборка полей: `?select=id,type,sort,color` |
| `order` | object | — | Сортировка: `?order[sort]=asc` |
| `filter` | object | — | Фильтрация по полям статуса.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `?filter[type]=O` |

## Примеры

### curl — личный ключ

```bash
curl "https://vibecode.bitrix24.tech/v1/order-statuses?limit=3&order[sort]=asc" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth-приложение

```bash
curl "https://vibecode.bitrix24.tech/v1/order-statuses?limit=3&order[sort]=asc" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/order-statuses?limit=3&order[sort]=asc', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Всего статусов: ${meta.total}`)
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/order-statuses?limit=3&order[sort]=asc', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив статусов |
| `data[].id` | string | Символьный код статуса |
| `data[].type` | string | Тип статуса: `O` — заказа, `D` — доставки |
| `data[].sort` | number \| null | Порядок сортировки |
| `data[].notify` | boolean | Отправлять ли уведомление клиенту |
| `data[].color` | string \| null | HEX-код цвета или `null` |
| `data[].xmlId` | string \| null | Внешний идентификатор или `null` |
| `meta.total` | number | Общее количество записей, соответствующих фильтру |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |

## Пример ответа

```json
{
  "success": true,
  "data": [
    { "id": "D", "type": "O", "sort": 140, "notify": true, "color": "#FFBEBD", "xmlId": null },
    { "id": "DF", "type": "D", "sort": 400, "notify": true, "color": null, "xmlId": null },
    { "id": "DD", "type": "D", "sort": 500, "notify": true, "color": null, "xmlId": null }
  ],
  "meta": {
    "total": 9,
    "hasMore": true
  }
}
```

## Пример ответа при ошибке

403 — нет скоупа:

```json
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'sale' scope"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `UNKNOWN_FILTER_FIELD` | Фильтр по полю, которого нет в схеме статуса |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `sale` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Известные особенности

**Разделение по типу.** По умолчанию ответ включает статусы обоих типов — заказа и доставки. Чтобы получить только статусы заказа, добавьте `filter[type]=O`. Для доставки — `filter[type]=D`.

## Смотрите также

- [Поиск статусов](./search.md)
- [Получить статус](./get.md)
- [Создать статус](./create.md)
- [Поля статуса](./fields.md)
- [Заказы в этом статусе](../orders/list.md)
- [Синтаксис фильтрации](/docs/filtering)
- [Entity API](/docs/entity-api)
- [Batch](/docs/batch)
- [Лимиты и оптимизация](/docs/optimization)