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

GET /v1/order-statuses

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

#Параметры

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

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/order-statuses?filter[type]=O&order[sort]=asc" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/order-statuses?filter[type]=O&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?filter[type]=O&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?filter[type]=O&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 Порядок сортировки
data[].notify boolean Отправлять ли уведомление клиенту
data[].color string HEX-код цвета
data[].xmlId string Внешний идентификатор
meta.total number Общее количество записей, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

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

JSON 
{
  "success": true,
  "data": [
    { "id": "T", "type": "O", "sort": 30, "notify": true, "color": "#ACE9FB", "xmlId": null },
    { "id": "N", "type": "O", "sort": 100, "notify": true, "color": "#ACE9FB", "xmlId": null },
    { "id": "S", "type": "O", "sort": 110, "notify": true, "color": "#ACE9FB", "xmlId": null },
    { "id": "P", "type": "O", "sort": 130, "notify": true, "color": "#ACE9FB", "xmlId": null },
    { "id": "D", "type": "O", "sort": 140, "notify": true, "color": "#FFBEBD", "xmlId": null },
    { "id": "F", "type": "O", "sort": 200, "notify": true, "color": "#DBF199", "xmlId": null }
  ],
  "meta": {
    "total": 6,
    "hasMore": false
  }
}

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

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 — Ошибки.

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

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

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