Поля статуса заказа

GET /v1/order-statuses/fields

Возвращает статическую карту полей статуса: тип каждого поля, флаг только-для-чтения, список агрегируемых полей и доступные batch-операции. Динамически загружаемого описания или отображаемого названия полей здесь нет — это фиксированная схема типов.

Примеры

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

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

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

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

const { data } = await res.json()
console.log('Поля статуса:', Object.keys(data.fields))

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

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

const { data } = await res.json()

Поля ответа

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

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "string", "readonly": false },
      "type": { "type": "string", "readonly": false },
      "sort": { "type": "number", "readonly": false },
      "notify": { "type": "boolean", "readonly": false },
      "color": { "type": "string", "readonly": false },
      "xmlId": { "type": "string", "readonly": false }
    },
    "aggregatable": ["type", "notify"],
    "batch": ["create", "update", "delete"]
  }
}

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

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

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

Ошибки

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

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

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