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

Получить товар из элемента

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

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

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

Параметры

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

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

Примеры

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

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

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

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/items/156/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/items/156/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/items/156/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 товара. Каталог: GET /v1/products
Поле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 ОписаниеСортировка
Полеdata.ownerId Типnumber ОписаниеID сущности-владельца, которой принадлежит позиция
Полеdata.ownerType Типstring ОписаниеТип владельца позиции: буква T и шестнадцатеричный entityTypeId, для типа 156 это T9c
Полеdata.storeId Типnumber | null ОписаниеID склада. Список: GET /v1/warehouses. null, если складской учёт выключен

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

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,
    "ownerId": 741,
    "ownerType": "T9c",
    "storeId": 3,
    "xmlId": "sale_basket_995",
    "type": 1
  }
}

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

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

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

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_DYNAMIC_PARAM ОписаниеentityTypeId не является положительным целым или является зарезервированным (1, 2, 3, 4, 7, 31)
HTTP400 КодINVALID_ROW_ID ОписаниеrowId не является положительным целым
HTTP404 КодENTITY_NOT_FOUND ОписаниеЭлемент или товарная строка не найдена
HTTP404 КодNOT_FOUND ОписаниеБитрикс24 вернул успех, но товарная строка отсутствует (Product row not found)
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа crm
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке x-ratelimit-limit. Повторите после срока из заголовка Retry-After

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

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