Обновить статус заказа

PATCH /v1/order-statuses/:id

Обновляет параметры существующего статуса. Передавайте только изменяемые поля плоско в корне JSON — без обёртки fields.

Параметры

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

Поля для обновления (тело)

Параметр Тип Описание
sort number Порядок сортировки
notify boolean Отправлять ли уведомление клиенту
color string HEX-код цвета (#FFA500)
xmlId string Внешний идентификатор

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/order-statuses/T" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sort": 35,
    "color": "#2ECC71"
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/order-statuses/T" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sort": 35,
    "color": "#2ECC71"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/order-statuses/T', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    sort: 35,
    color: '#2ECC71',
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/order-statuses/T', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    sort: 35,
    color: '#2ECC71',
  }),
})

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

Поля ответа

Поле Тип Описание
data object Обновлённый объект статуса со всеми полями

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

JSON 
{
  "success": true,
  "data": {
    "id": "T",
    "type": "O",
    "sort": 35,
    "notify": true,
    "color": "#2ECC71",
    "xmlId": null
  }
}

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

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

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

Ошибки

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

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

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

Поле type подтягивается автоматически. Вайбкод перед обновлением статуса получает текущее значение type через GET /v1/order-statuses/:id и автоматически добавляет его в запрос, если оно не передано. Это позволяет обновлять одно поле через PATCH, не указывая тип каждый раз.

Поле id не редактируется. Изменить символьный код статуса нельзя — PATCH принимает остальные поля, но не сам id. Чтобы переименовать статус, удалите старый и создайте новый с нужным id. Внимание: заказы со ссылкой на старый id останутся с этой ссылкой и продолжат работать.

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