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

Товарные позиции элемента

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

Возвращает список товарных позиций, привязанных к элементу смарт-процесса.

Параметры

Параметр Тип Обяз. Описание
entityTypeId (path) number да ID типа смарт-процесса
id (path) number да ID элемента
limit (query) number нет Сколько позиций вернуть за вызов, от 1 до 5000, по умолчанию 50. Значение выше 5000 приводится к 5000. limit=0 размером страницы не считается: применяется значение по умолчанию, а в meta.warnings приходит запись с кодом LIMIT_ZERO_IGNORED
offset (query) number нет Смещение в позициях, а не в страницах: offset=7 начинает выдачу с восьмой позиции

Без limit и offset приходит первая страница выдачи. Есть ли позиции за её пределами, показывает meta.hasMore, а сколько их всего у элемента — meta.total.

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/items/156/741/products" \
  -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', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Товаров:', data.length)

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив товарных позиций
data[].id number ID товарной позиции. Он же rowId в операциях над одной позицией
data[].productId number ID товара. Каталог: GET /v1/products
data[].productName string Название товара
data[].price number Цена за единицу
data[].quantity number Количество
data[].discount number Сумма скидки
data[].taxRate number/null Ставка налога (%)
data[].taxIncluded boolean Налог включён в цену
data[].ownerId number ID элемента-владельца позиции, тот же, что в адресе запроса
data[].ownerType string Тип владельца позиции: буква T и шестнадцатеричный entityTypeId, для типа 156 это T9c
data[].storeId number | null ID склада. Список: GET /v1/warehouses. null, если складской учёт выключен
meta.total number Сколько товарных позиций у элемента всего. Приходит, когда Битрикс24 вернул счётчик, иначе поля в ответе нет.
meta.hasMore boolean Есть ли позиции за пределами отданной страницы. Верно для любого запрошенного окна, а не только для первого
meta.warnings array Приходит только когда запрос нёс limit=0: одна запись с code равным LIMIT_ZERO_IGNORED

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

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1671,
      "ownerId": 741,
      "ownerType": "T9c",
      "productId": 1,
      "productName": "Серверное оборудование",
      "price": 1000,
      "quantity": 2,
      "discount": 0,
      "taxRate": null,
      "taxIncluded": false,
      "storeId": null
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}

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

404 — элемент не найден:

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

Ошибки

HTTP Код Описание
400 INVALID_DYNAMIC_PARAM entityTypeId не является положительным целым или является зарезервированным (1, 2, 3, 4, 7, 31)
404 ENTITY_NOT_FOUND Элемент не найден
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики). Повторите после срока из заголовка Retry-After

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

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