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

Обновить товар элемента

PATCH /v1/items/:entityTypeId/:id/products/:rowId

Обновляет товарную позицию элемента. Передайте только изменяемые поля.

Поле, которого нет среди записываемых, отклоняется с 400 INVALID_PARAMS, и в тексте ошибки перечислены записываемые имена. Поля только для чтения, которые приходят в ответах товарных позиций (priceAccount, ownerId, storeId и другие), принимаются и игнорируются. Поэтому объект, прочитанный через GET, можно отправить обратно без чистки.

В путь /v1/items/:entityTypeId подставляйте поле entityTypeId из GET /v1/smart-processes. Внутреннее поле id записи типа — другой идентификатор. Например, для типа { "id": 3, "entityTypeId": 174 } путь начинается с /v1/items/174. Берите возвращённое значение, не ограничивайте типы числами от 1030.

Параметры

Параметр Тип Обяз. Описание
ПараметрentityTypeId (path) Типnumber Обяз.да ОписаниеID типа смарт-процесса. Список: GET /v1/smart-processes
Параметрid (path) Типnumber Обяз.да ОписаниеID элемента. Список: GET /v1/items/:entityTypeId
ПараметрrowId (path) Типnumber Обяз.да ОписаниеID товарной позиции, не productId из каталога. Список позиций элемента: GET /v1/items/:entityTypeId/:id/products

Поля запроса (body)

Параметр Тип Описание
Параметрprice Типnumber ОписаниеЦена за единицу
Параметрquantity Типnumber ОписаниеКоличество
ПараметрproductId Типnumber ОписаниеID товара. Каталог: GET /v1/products
ПараметрdiscountTypeId Типnumber ОписаниеКак задана скидка: 1 — суммой в поле discount, 2 — процентом в поле discountRate. Опущенное поле сохраняет прежнее значение позиции — чтобы сменить режим скидки, передайте его явно
Параметрdiscount Типnumber ОписаниеСумма скидки. Учитывается только при discountTypeId равном 1
ПараметрdiscountRate Типnumber ОписаниеПроцент скидки. Учитывается только при discountTypeId равном 2
ПараметрtaxRate Типnumber ОписаниеСтавка налога (%)
ПараметрtaxIncluded Типboolean ОписаниеНалог включён в цену
Параметрsort Типnumber ОписаниеСортировка

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/items/156/741/products/1471" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "price": 9999, "quantity": 10 }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/items/156/741/products/1471" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "price": 9999, "quantity": 10 }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/items/156/741/products/1471', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ price: 9999, quantity: 10 }),
})

const { success, data } = await res.json()
console.log('Обновлено:', data.price, 'x', data.quantity)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/items/156/741/products/1471', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ price: 9999, quantity: 10 }),
})

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеОбновлённая товарная позиция целиком, id сохраняется. Поля позиции — см. Поля товаров

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

Показаны основные поля. Полный список: Поля товаров.

JSON 
{
  "success": true,
  "data": {
    "id": 1471,
    "productId": 1,
    "productName": "Серверное оборудование",
    "price": 9999,
    "quantity": 10,
    "discount": 0,
    "taxRate": null,
    "taxIncluded": false
  }
}

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

404 — позиция не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеТело содержит имя, которого нет среди записываемых полей — см. Поля товаров
HTTP400 КодINVALID_DYNAMIC_PARAM ОписаниеentityTypeId не является положительным целым или является зарезервированным (1, 2, 3, 4, 7, 31)
HTTP400 КодINVALID_ROW_ID ОписаниеrowId не является положительным целым
HTTP400 КодINVALID_PARAMS ОписаниеТело запроса не объект или не содержит распознанных полей товарной строки
HTTP404 КодENTITY_NOT_FOUND ОписаниеПозиция не найдена
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа crm
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов

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

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