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

Удалить ставку НДС

DELETE /v1/catalog-vat-rates/:id

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

Параметры

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

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/catalog-vat-rates/25" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/catalog-vat-rates/25" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-vat-rates/25', {
  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/catalog-vat-rates/25', {
  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

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

404 — ставки нет, например при повторном удалении:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "vat does not exist."
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Ставки с таким id нет, в том числе после удаления.
400 INVALID_PARAMS id не является целым неотрицательным числом, например abc.
422 BITRIX_ERROR Битрикс24 отклонил запрос. Причина — в error.message, исходный код — в error.b24Code.
403 WRITE_BLOCKED_READONLY_KEY Запись запрещена: ключ работает в режиме только для чтения.
403 SCOPE_DENIED У ключа нет скоупа catalog.
401 MISSING_API_KEY Не передан заголовок X-Api-Key.
401 TOKEN_MISSING У ключа нет настроенных токенов Битрикс24. Для ключа OAuth-приложения проверьте пользовательскую сессию.

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

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

Перед удалением проверьте товары, использующие ставку. Найдите их через GET /v1/catalog-products?filter[vatId]=25 и при необходимости назначьте другую ставку.

Если нужно убрать ставку из использования и сохранить запись, сначала проверьте её текущее поле rate. Для числового rate отправьте PATCH /v1/catalog-vat-rates/:id с {"active": "N"}. У существующей ставки «Без НДС» с rate: null такой PATCH вернёт 422 BITRIX_ERROR с сообщением Required fields: rate. Запись останется активной. PATCH только с полем active не может деактивировать её, пока rate остаётся равным null.

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