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

Список головных товаров

GET /v1/catalog-skus

Возвращает головные товары каталога с поддержкой фильтрации, сортировки, выборки полей и пагинации. Требует фильтр filter[iblockId] — товарный каталог, по которому идёт выборка. Без этого фильтра запрос возвращает 400.

Поля dateCreate, timestampX, dateActiveFrom и dateActiveTo не принимаются в filter: запрос возвращает 400 UNKNOWN_FILTER_FIELD до обращения к Битрикс24. Эти даты можно запрашивать через select и читать в ответе.

Параметры

Параметр Тип Обяз. По умолч. Описание
filter object да — Условия фильтрации. Ключ filter[iblockId] обязателен — ID товарного каталога из GET /v1/catalogs. Фильтр filter[type] принимает одно точное число: 3 — головные товары с вариациями, 6 — без вариаций.
Синтаксис фильтрации. Пример: ?filter[iblockId]=25&filter[type]=3
select string нет — Выборка полей: ?select=iblockId,id,name,type. Если параметр передан, в нём обязательны iblockId и id. Без select приходит сокращённый набор полей: символьный код, тексты, сортировка и внешний код возвращаются только по явному перечислению — какие именно, видно в Полях головного товара. Свойство каталога запрашивается своим именем: ?select=iblockId,id,name,property295
sort string нет — Поле сортировки. Префикс - — по убыванию: ?sort=-id
limit number нет 50 Количество записей (до 5000)
offset number нет 0 Смещение от начала выборки

Для limit > 50 ответ автоматически собирается из нескольких страниц на стороне сервера. Максимум — 5000 записей за вызов. Если под фильтр попадает больше записей, чем возвращено, в meta.hasMore придёт true.

Примеры

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

Terminal
curl -g "https://vibecode.bitrix24.tech/v1/catalog-skus?filter[iblockId]=25&filter[type]=3&sort=-id&limit=2" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal
curl -g "https://vibecode.bitrix24.tech/v1/catalog-skus?filter[iblockId]=25&filter[type]=3&sort=-id&limit=2" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript
const params = new URLSearchParams({
  'filter[iblockId]': '25',
  'filter[type]': '3',
  sort: '-id',
  limit: '2',
})
const res = await fetch(`https://vibecode.bitrix24.tech/v1/catalog-skus?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Головных товаров: ${meta.total}`)

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

javascript
const params = new URLSearchParams({
  'filter[iblockId]': '25',
  'filter[type]': '3',
  sort: '-id',
  limit: '2',
})
const res = await fetch(`https://vibecode.bitrix24.tech/v1/catalog-skus?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив головных товаров. Состав полей элемента — см. Поля головного товара
meta.total number Общее количество записей, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit
meta.warnings array Предупреждения о select. Приходит, когда в select есть имя, которого нет в справочнике полей: элемент { code: "UNKNOWN_SELECT_FIELD", message, field }, значение по этому имени в ответ не попадает

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

JSON
{
  "success": true,
  "data": [
    {
      "id": 7205,
      "iblockId": 25,
      "iblockSectionId": 19,
      "name": "Худи базовое",
      "type": 3,
      "active": true,
      "available": true,
      "bundle": false,
      "createdBy": 1295,
      "modifiedBy": 1295,
      "dateActiveFrom": null,
      "dateActiveTo": null,
      "dateCreate": "2026-10-08T18:45:34.000Z",
      "timestampX": "2026-10-08T18:45:36.000Z"
    },
    {
      "id": 7203,
      "iblockId": 25,
      "iblockSectionId": null,
      "name": "Футболка базовая",
      "type": 3,
      "active": true,
      "available": true,
      "bundle": false,
      "createdBy": 1295,
      "modifiedBy": 1295,
      "dateActiveFrom": null,
      "dateActiveTo": null,
      "dateCreate": "2026-10-08T18:45:34.000Z",
      "timestampX": "2026-10-08T18:45:35.000Z"
    }
  ],
  "meta": {
    "total": 14,
    "hasMore": true
  }
}

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

400 — не передан обязательный фильтр:

JSON
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FILTER",
    "message": "GET /v1/catalog-skus requires filter fields: iblockId. Example: GET /v1/catalog-skus?filter[iblockId]=..."
  }
}

Ошибки

HTTP Код Описание
400 MISSING_REQUIRED_FILTER Не передан обязательный фильтр filter[iblockId]. Запрос отклоняется до обращения к Битрикс24 — сообщение содержит имя недостающего поля и пример вызова
400 UNSUPPORTED_FILTER Фильтр filter[type] передан не одним числом 3 или 6 — другим числом, оператором или массивом
422 BITRIX_ERROR iblockId указывает на каталог вариаций (productType is not allowed for this catalog)
422 BITRIX_ERROR iblockId не является каталогом (iblock is not catalog)
422 BITRIX_ERROR Параметр select передан без iblockId (Required select fields: iblockId)
422 BITRIX_ERROR Параметр select передан без id (Required select fields: id)
400 UNKNOWN_FILTER_FIELD Неизвестное поле фильтра или поле даты: dateCreate, timestampX, dateActiveFrom, dateActiveTo. Сообщение содержит список доступных полей
400 UNKNOWN_SORT_FIELD Сортировка по полю, которого нет у головного товара. Сообщение содержит список доступных полей
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики). Повторите после срока из заголовка Retry-After

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

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

Головной товар без вариаций уходит из списка. Когда у головного товара удалена последняя вариация, Битрикс24 переводит его в обычные товары с type: 1. Такой товар больше не возвращается в GET /v1/catalog-skus и читается через GET /v1/catalog-products.

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