#Получить товар из лида

GET /v1/leads/:id/products/:rowId

Возвращает одну товарную позицию лида по ID строки.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да ID лида
rowId (path) number да ID товарной строки (из ответа add или list)

rowId — это ID товарной строки, а не productId из каталога товаров.

#Примеры

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

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/leads/741/products/1471" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/leads/741/products/1471" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads/741/products/1471', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Цена:', data.price)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads/741/products/1471', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

#Поля ответа

Поле Тип Описание
data.id number ID товарной строки
data.productId number ID товара из каталога
data.productName string Название товара
data.price number Цена за единицу
data.quantity number Количество
data.discount number Сумма скидки
data.discountRate number Процент скидки
data.discountTypeId number Тип скидки (1 — сумма, 2 — процент)
data.taxRate number | null Ставка налога (%)
data.taxIncluded boolean Налог включён в цену
data.priceExclusive number Цена без скидки
data.priceNetto number Цена нетто
data.priceBrutto number Цена брутто
data.priceAccount number Цена в валюте учёта
data.measureCode number Код единицы измерения
data.measureName string Название единицы измерения
data.sort number Сортировка

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

JSON 
{
  "success": true,
  "data": {
    "id": 1471,
    "productId": 1,
    "productName": "День добрый!",
    "price": 5000,
    "priceAccount": 5000,
    "priceExclusive": 5000,
    "priceNetto": 5000,
    "priceBrutto": 5000,
    "quantity": 3,
    "discountTypeId": 2,
    "discountRate": 0,
    "discount": 0,
    "taxRate": null,
    "taxIncluded": false,
    "customized": "Y",
    "measureCode": 796,
    "measureName": "шт",
    "sort": 0,
    "xmlId": "sale_basket_995",
    "type": 1
  }
}

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

404 — лид или товарная строка не найден:

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

#Ошибки

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

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

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