Удалить статус заказа

DELETE /v1/order-statuses/:id

Удаляет статус заказа или доставки по символьному коду. Восстановить удалённый статус через API нельзя — создавайте новый при необходимости.

Параметры

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

Примеры

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

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

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

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

if (res.status === 204) {
  console.log('Статус удалён')
}

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

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

if (res.status === 204) {
  console.log('Статус удалён')
}

Ответ

При успешном удалении возвращается HTTP-статус 204 No Content с пустым телом — успех проверяется по статусу.

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

http 
HTTP/1.1 204 No Content

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

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

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

Заказы со ссылкой на удалённый статус продолжают работать. При удалении статуса заказы с этим statusId не меняются — поле orders.statusId сохраняет старое значение. В интерфейсе портала такой заказ будет показан с пустым названием статуса. Для миграции — перед удалением статуса выполните `PATCH /v1/orders/:id` для всех затронутых заказов.

Стандартные статусы удаляются тем же запросом. Статусы по умолчанию (N, P, F, D и другие) для Битрикс24 не системные — удалить их можно тем же DELETE /v1/order-statuses/:id, что и пользовательские. Перед удалением убедитесь, что они не используются в существующих заказах.

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