#Установить товары лида

PUT /v1/leads/: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 — личный ключ

Terminal 
curl -X PUT "https://vibecode.bitrix24.tech/v1/leads/312/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-приложение

Terminal 
curl -X PUT "https://vibecode.bitrix24.tech/v1/leads/312/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 — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads/312/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-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads/312/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.

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

JSON 
{
  "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 — неверный формат:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "items must be an array"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS items не является массивом
404 ENTITY_NOT_FOUND Лид не найден
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Полная замена: PUT заменяет весь список товаров. Чтобы добавить позицию — сначала получите текущие (GET), добавьте новую в массив, отправьте всё (PUT).

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