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

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

POST /v1/catalog-skus/search

Поиск головных товаров по условиям, переданным в теле запроса.

В отличие от GET /v1/catalog-skus, параметры filter, select, sort, limit и offset передаются в JSON-теле, а не в строке адреса — условия по нескольким полям задаются вложенной структурой. Как и список, поиск требует filter.iblockId — без этого поля запрос возвращает 400. Формат ответа тот же, что у списка.

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

Поля запроса (body)

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

Примеры

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

Terminal

curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-skus/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25, "type": 3 },
    "sort": "-id",
    "limit": 2
  }'

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

Terminal

curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-skus/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25, "type": 3 },
    "sort": "-id",
    "limit": 2
  }'

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-skus/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 25, type: 3 },
    sort: '-id',
    limit: 2,
  }),
})

const { success, data, meta } = await res.json()
console.log(`Найдено: ${meta.total}`)

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-skus/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 25, type: 3 },
    sort: '-id',
    limit: 2,
  }),
})

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

Поля ответа

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

Поля meta лежат рядом с data, а не внутри него. Обходить страницы нужно по meta.hasMore: длина data, равная limit, последней страницы не исключает.

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

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,
    "durationMs": 140
  }
}

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

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