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

Отменить проведение складского документа

POST /v1/catalog-documents/:id/cancel

Отменяет проведение складского документа: остатки товаров на складах возвращаются к значениям до проведения, а документ снова становится непроведённым. Вызывайте, чтобы изменить проведённый документ или его позиции.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор документа, целое положительное число без ведущих нулей. Список: GET /v1/catalog-documents

Передайте пустой объект {} с заголовком Content-Type: application/json либо отправьте запрос без тела и без этого заголовка.

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-documents/301/cancel" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-documents/301/cancel" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-documents/301/cancel', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: '{}',
})

const { success, data } = await res.json()
console.log('Статус документа:', data.status)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-documents/301/cancel', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: '{}',
})

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

Поля ответа

Поле Тип Описание
success boolean true при успехе
data.id number Идентификатор документа
data.status string Статус документа, перечитанный после отмены. В успешном ответе всегда N

Остальные поля документа — GET /v1/catalog-documents/:id. Кто и когда последним сменил статус, показывают поля statusBy и dateStatus.

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

JSON 
{
  "success": true,
  "data": {
    "id": 301,
    "status": "N"
  }
}

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

422 — документ не проведён:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Ошибка отмены проведения документа: Документ еще не проведен.",
    "b24Code": "0"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS id в пути не является целым положительным числом либо тело запроса не пустое. Текст ошибки — id must be a positive safe integer and body must be empty
400 FST_ERR_CTP_EMPTY_JSON_BODY Передан заголовок Content-Type: application/json, а тело пустое. Отправьте {} или уберите заголовок
404 ENTITY_NOT_FOUND Документа с таким id нет. Текст ошибки — Catalog document not found
422 BITRIX_ERROR Документ не проведён. Текст ошибки — Ошибка отмены проведения документа: Документ еще не проведен.
422 BITRIX_ERROR Битрикс24 отклонил отмену по другой причине. Текст причины — в message
422 BITRIX_ERROR Битрикс24 не подтвердил отмену. Текст ошибки — Bitrix24 rejected the document action
422 BITRIX_ERROR Документ перечитан, а статус не стал N. Текст ошибки — Document action did not change status
502 BITRIX_UNAVAILABLE Портал недоступен либо статус документа после отмены не удалось перечитать. Во втором случае текст ошибки — Unable to verify document status
503 BITRIX_TIMEOUT Битрикс24 не ответил за отведённое время. Отмена могла состояться — перед повтором проверьте status через GET /v1/catalog-documents/:id
403 BITRIX_ACCESS_DENIED Битрикс24 отказал пользователю ключа в доступе к операции
403 WRITE_BLOCKED_READONLY_KEY Ключ работает в режиме только для чтения
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Переданный API-ключ не найден
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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