Для AI-агентов: markdown этой страницы — /docs-content/entities/order-statuses/fields.md индекс документации — /llms.txt

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

GET /v1/order-statuses/fields

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

Примеры

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()

Поля ответа

Подписи полей label и description приходят на русском языке. Заголовками запроса язык не переключается.

Поле Тип Описание
success boolean Всегда true при успехе
data.fields object Схема полей статуса: имя поля → type, readonly, label, description. Поля перечислены ниже
data.aggregatable array Поля, допустимые в groupBy агрегации статусов: type, notify
data.batch array Операции статуса, доступные в POST /v1/batch: create, update, delete

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

Поле Тип RO Описание
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, "label": "Код статуса", "description": "Символьный код статуса, задаётся при создании — Битрикс24 его не генерирует." },
      "type": { "type": "string", "readonly": false, "label": "Тип статуса", "description": "Тип статуса: O — статус заказа, D — статус доставки. Битрикс24 требует поле при каждом обновлении, поэтому обёртка подставляет сохранённое значение, если запрос его не передал." },
      "sort": { "type": "number", "readonly": false, "label": "Индекс сортировки", "description": "Индекс сортировки, задающий порядок статусов в интерфейсе Битрикс24: чем меньше значение, тем раньше статус." },
      "notify": { "type": "boolean", "readonly": false, "label": "Уведомлять покупателя", "description": "Уведомлять ли покупателя, когда заказ переходит в этот статус. Битрикс24 хранит флаг как Y или N, обёртка возвращает и принимает булево." },
      "color": { "type": "string", "readonly": false, "label": "Цвет", "description": "HEX-код цвета, которым Битрикс24 подсвечивает статус в интерфейсе, например #ACE9FB. Ограничение — 10 символов (ширина колонки в базе): более длинное значение отклоняется, а не обрезается молча." },
      "xmlId": { "type": "string", "readonly": false, "label": "Внешний идентификатор", "description": "Внешний идентификатор статуса для синхронизации со сторонними системами." }
    },
    "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-ключ не имеет настроенных токенов
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики). Повторите после срока из заголовка Retry-After

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

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