Удалить товар

DELETE /v1/products/:id

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

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор товара. Список: `GET /v1/products`

Примеры

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

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

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/products/7027', {
  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/products/7027', {
  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": "Product is not found."
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Товар с таким id не найден или уже удалён
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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

Деактивация вместо удаления. Чтобы скрыть товар из каталога без удаления, обновите его полем active: `PATCH /v1/products/:id` с телом {"active": false}. Товар останется в каталоге и его можно вернуть обратным обновлением.

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