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

Удалить отгрузку

DELETE /v1/shipments/:id

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

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID отгрузки, целое неотрицательное число. Список: GET /v1/shipments

Примеры

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

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

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/shipments/1205', {
  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/shipments/1205', {
  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": "Отгрузка уже отгружена. Отмените отгрузку",
    "b24Code": "SALE_SHIPMENT_EXIST_SHIPPED"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS id в пути не является целым неотрицательным числом. Текст ошибки — id must be a non-negative integer
404 ENTITY_NOT_FOUND Отгрузки с таким id нет или она уже удалена. Текст ошибки — shipment is not exists
422 BITRIX_ERROR У отгрузки стоит отметка «отгружено», b24Code равен SALE_SHIPMENT_EXIST_SHIPPED. Снимите отметку через POST /v1/shipments/:id/unship
422 BITRIX_ERROR Битрикс24 отклонил удаление по другой причине. Текст причины — в message
403 BITRIX_ACCESS_DENIED У пользователя ключа нет прав на изменение заказов в Битрикс24
403 WRITE_BLOCKED_READONLY_KEY Ключ работает в режиме только для чтения
403 SCOPE_DENIED API-ключ не имеет скоупа sale
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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