Получить статус заказа

GET /v1/order-statuses/:id

Возвращает один статус заказа или доставки по символьному коду.

Параметры

Параметр Тип Обяз. Описание
id (path) string да Символьный код статуса (например, N, IP, DT)

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/order-statuses/D" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/order-statuses/D" \
  -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/D', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Статус:', data.id, '— тип:', data.type)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/order-statuses/D', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
id string Символьный код статуса
type string Тип статуса: O — заказа, D — доставки
sort number | null Порядок сортировки
notify boolean Отправлять ли уведомление клиенту
color string | null HEX-код цвета или null
xmlId string | null Внешний идентификатор или null

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

JSON 
{
  "success": true,
  "data": {
    "id": "D",
    "type": "O",
    "sort": 140,
    "notify": true,
    "color": "#FFBEBD",
    "xmlId": null
  }
}

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

422 — статус не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "status is not exists"
  }
}

Ошибки

HTTP Код Описание
422 BITRIX_ERROR Статус с таким id не найден
403 SCOPE_DENIED API-ключ не имеет скоупа sale
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

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