Для AI-агентов: markdown этой страницы — /docs-content/entities/deals/products-set.md индекс документации — /llms.txt
Поле, которого нет среди записываемых, больше не отбрасывается молча — запрос отклоняется с
400 INVALID_PARAMS, и в тексте ошибки перечислены записываемые имена. Поля только для чтения, которые приходят в ответах товарных позиций (priceAccount,ownerId,storeIdи другие) по-прежнему принимаются и игнорируются, поэтому объект, прочитанный через GET, можно отправить обратно без чистки.
Сохраняйте
idу элемента, чтобы обновить существующую строку на месте: без него строка будет создана заново с новым идентификатором.
Установить товары сделки
PUT /v1/deals/:id/products
Устанавливает товарные позиции сделки. Полностью заменяет текущий список — передайте все нужные позиции.
Поля запроса (body)
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
items |
array | да | Массив товарных позиций |
items[].productId |
number | да | ID товара. Каталог: GET /v1/products |
items[].price |
number | да | Цена за единицу |
items[].quantity |
number | да | Количество |
items[].discount |
number | нет | Сумма скидки |
items[].taxRate |
number | нет | Ставка налога (%) |
items[].taxIncluded |
boolean | нет | Налог включён в цену |
Примеры
curl — личный ключ
curl -X PUT "https://vibecode.bitrix24.tech/v1/deals/741/products" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"items": [
{ "productId": 1, "price": 25000, "quantity": 2 },
{ "productId": 5, "price": 5000, "quantity": 1, "discount": 500 }
]
}'
curl — OAuth-приложение
curl -X PUT "https://vibecode.bitrix24.tech/v1/deals/741/products" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"items": [
{ "productId": 1, "price": 25000, "quantity": 2 },
{ "productId": 5, "price": 5000, "quantity": 1, "discount": 500 }
]
}'
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/deals/741/products', {
method: 'PUT',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
items: [
{ productId: 1, price: 25000, quantity: 2 },
{ productId: 5, price: 5000, quantity: 1, discount: 500 },
],
}),
})
const { success, data } = await res.json()
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/deals/741/products', {
method: 'PUT',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
items: [
{ productId: 1, price: 25000, quantity: 2 },
{ productId: 5, price: 5000, quantity: 1, discount: 500 },
],
}),
})
const { success, data } = await res.json()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
data |
array | Массив установленных позиций с полями productId, productName, price, quantity, discount, taxRate, taxIncluded |
Массив установленных позиций с полями productId, productName, price, quantity, discount, taxRate, taxIncluded.
Пример ответа
{
"success": true,
"data": [
{
"productId": 1,
"productName": "Серверное оборудование",
"price": 25000,
"quantity": 2,
"discount": 0,
"taxRate": null,
"taxIncluded": false
},
{
"productId": 5,
"productName": "Установка и настройка",
"price": 5000,
"quantity": 1,
"discount": 500,
"taxRate": null,
"taxIncluded": false
}
]
}
Пример ответа при ошибке
400 — неверный формат:
{
"success": false,
"error": {
"code": "INVALID_PARAMS",
"message": "items must be an array"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| 400 | INVALID_PARAMS |
Тело содержит имя, которого нет среди записываемых полей — см. Поля товаров |
| 400 | INVALID_PARAMS |
items не является массивом |
| 404 | ENTITY_NOT_FOUND |
Сделка не найдена |
| 403 | SCOPE_DENIED |
API-ключ не имеет скоупа crm |
| 401 | TOKEN_MISSING |
API-ключ не имеет настроенных токенов |
Полный список общих ошибок API — Ошибки.
Известные особенности
Полная замена: PUT заменяет весь список товаров. Чтобы добавить позицию — сначала получите текущие (GET), добавьте новую в массив, отправьте всё (PUT).