#Удалить заказ

DELETE /v1/orders/:id

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

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор заказа

#Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/orders/859" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/orders/859" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/orders/859', {
  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/orders/859', {
  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": "order is not exists"
  }
}

#Ошибки

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

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

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

Каскадное удаление. Удаление заказа автоматически удаляет связанные позиции корзины и оплаты — отдельно вызывать DELETE /v1/basket-items/:id или DELETE /v1/payments/:id не нужно.

Альтернатива — отмена вместо удаления. Чтобы сохранить историю и связи, лучше отменить заказ через `PATCH /v1/orders/:id` с {"canceled": true, "reasonCanceled": "..."} — заказ останется в выборках с filter[canceled]=true.

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