## Создать статус заказа

`POST /v1/order-statuses`

Создаёт новый статус для заказа или доставки. Символьный код `id` задаёт пользователь — он используется как ссылка в [`orders.statusId`](../orders/fields.md).

## Поля запроса (тело)

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `id` | string | да | Символьный код статуса (1-2 символа). Например: `N`, `IP`, `DT`. Должен быть уникальным независимо от типа |
| `type` | string | да | Тип статуса: `O` — статус заказа, `D` — статус доставки |
| `sort` | number | нет | Порядок сортировки в списках. Если не передан, сохраняется как `null` |
| `notify` | boolean | нет | Отправлять ли уведомление клиенту при переходе в этот статус. Если не передан, сохраняется как `false` |
| `color` | string | нет | HEX-код цвета для отображения, например `#FFA500`. Если не передан, сохраняется как `null` |
| `xmlId` | string | нет | Внешний идентификатор. Если не передан, генерируется автоматически вида `bx_<hash>` |

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/order-statuses" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "ZZ",
    "type": "O"
  }'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/order-statuses" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "ZZ",
    "type": "O"
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/order-statuses', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    id: 'ZZ',
    type: 'O',
  }),
})

const { success, data } = await res.json()
console.log('Статус создан:', data.id)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/order-statuses', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    id: 'ZZ',
    type: 'O',
  }),
})

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

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

Возвращается полный объект созданного статуса. Переданные поля сохраняются как есть, опущенные необязательные поля остаются `null` или `false`.

| Поле | Тип | Описание |
|------|-----|---------|
| `id` | string | Символьный код, переданный в запросе |
| `type` | string | Тип статуса |
| `sort` | number \| null | Порядок сортировки. `null`, если не передан |
| `notify` | boolean | Уведомление клиента. `false`, если не передан |
| `color` | string \| null | HEX-код цвета. `null`, если не передан |
| `xmlId` | string \| null | Внешний идентификатор. Сгенерирован автоматически, если не передан |

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

Минимальное создание — переданы только `id` и `type`:

```json
{
  "success": true,
  "data": {
    "id": "ZZ",
    "type": "O",
    "sort": null,
    "color": null,
    "notify": false,
    "xmlId": "bx_6a3e47867ed3b"
  }
}
```

Необязательные поля `sort`, `color` и `notify` без значения остаются `null` и `false` — значения по умолчанию не подставляются. Поле `xmlId` сгенерировано автоматически. Передайте эти поля в теле запроса, чтобы задать их.

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

422 — не переданы обязательные поля:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Required fields: id, type"
  }
}
```

## Ошибки

| HTTP | `error.code` | Маркер в `error.message` | Описание |
|------|--------------|--------------------------|---------|
| 422 | `BITRIX_ERROR` | `Required fields: id, type` | Не переданы обязательные поля `id` или `type` |
| 400 | `BITRIX_ERROR` | `Duplicate entry` | Статус с таким `id` уже существует — `id` должен быть уникальным независимо от типа |
| 400 | `BITRIX_ERROR` | — | Длина `id` превышает 2 символа |
| 400 | `BITRIX_ERROR` | — | Передано пустое значение `id` |
| 403 | `SCOPE_DENIED` | — | API-ключ не имеет скоупа `sale` |
| 401 | `TOKEN_MISSING` | — | API-ключ не имеет настроенных токенов |

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

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

**Уникальность `id` глобальная.** Создать статус заказа и статус доставки с одинаковым `id` нельзя — код уникален независимо от типа. Перед созданием проверьте, что код не занят, через [`GET /v1/order-statuses`](./list.md).

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

- [Список статусов](./list.md)
- [Получить статус](./get.md)
- [Обновить статус](./update.md)
- [Поля статуса](./fields.md)
- [Обновить заказ](../orders/update.md)
- [Batch](/docs/batch)
- [Лимиты и оптимизация](/docs/optimization)