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

Поиск вариаций

POST /v1/catalog-offers/search

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

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

Поля дат dateCreate, timestampX, dateActiveFrom и dateActiveTo в фильтре не принимаются: метод Битрикс24 фильтры по датам не применяет и вернул бы все вариации каталога. Запрос с таким фильтром отклоняется с 400 UNKNOWN_FILTER_FIELD.

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

Параметр	Тип	Обяз.	По умолч.	Описание
`filter`	object	да	—	Фильтрация по полям `GET /v1/catalog-offers/fields`. Ключ `iblockId` обязателен — ID каталога вариаций из `GET /v1/catalogs`, у этого каталога заполнен `productIblockId`. Вариации одного головного товара отбирает `parentId` с ID из `GET /v1/catalog-skus`. `type` принимает одно точное значение: `4` или `5`. Синтаксис фильтрации. Пример: `{ "iblockId": 27, "parentId": 7189 }`
`select`	string[]	нет	—	Выборка полей: `["iblockId", "id", "name", "parentId"]`. Если параметр передан, в нём обязательны `iblockId` и `id`. Без `select` приходит сокращённый набор полей: символьный код, габариты, тексты, картинки и свойства каталога возвращаются только по явному перечислению — какие именно, сказано в Полях вариации
`sort`	string	нет	—	Поле сортировки. Префикс `-` — по убыванию: `"-id"`
`limit`	number	нет	`50`	Количество записей (до 5000)
`offset`	number	нет	`0`	Смещение от начала выборки

Примеры

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

Terminal

curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-offers/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 27, "parentId": 7189 },
    "limit": 10
  }'

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

Terminal

curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-offers/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 27, "parentId": 7189 },
    "limit": 10
  }'

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-offers/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 27, parentId: 7189 },
    limit: 10,
  }),
})

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

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-offers/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 27, parentId: 7189 },
    limit: 10,
  }),
})

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

Поля ответа

Поле	Тип	Описание
`success`	boolean	Всегда `true` при успехе
`data`	array	Массив вариаций. Состав полей элемента — см. Поля вариации
`meta.total`	number	Сколько записей подошло под фильтр
`meta.hasMore`	boolean	Есть ли ещё записи за пределами `limit`
`meta.durationMs`	number	Длительность запроса в миллисекундах

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

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

JSON

{
  "success": true,
  "data": [
    {
      "active": true,
      "available": true,
      "barcodeMulti": false,
      "bundle": false,
      "canBuyZero": true,
      "createdBy": 1295,
      "dateActiveFrom": null,
      "dateActiveTo": null,
      "dateCreate": "2026-10-08T18:41:55.000Z",
      "iblockId": 27,
      "iblockSectionId": null,
      "id": 7191,
      "measure": 9,
      "modifiedBy": 1295,
      "name": "Футболка базовая, размер M",
      "parentId": { "value": "7189", "valueId": "3895" },
      "purchasingCurrency": "RUB",
      "purchasingPrice": 450,
      "quantity": null,
      "quantityTrace": true,
      "subscribe": true,
      "timestampX": "2026-10-08T18:41:55.000Z",
      "type": 4,
      "vatIncluded": false,
      "weight": null,
      "withoutOrder": false
    },
    {
      "active": true,
      "available": true,
      "barcodeMulti": false,
      "bundle": false,
      "canBuyZero": true,
      "createdBy": 1295,
      "dateActiveFrom": null,
      "dateActiveTo": null,
      "dateCreate": "2026-10-08T18:41:56.000Z",
      "iblockId": 27,
      "iblockSectionId": null,
      "id": 7193,
      "measure": 9,
      "modifiedBy": 1295,
      "name": "Футболка базовая, размер L",
      "parentId": { "value": "7189", "valueId": "3897" },
      "purchasingCurrency": "RUB",
      "purchasingPrice": 490,
      "quantity": 10,
      "quantityTrace": true,
      "subscribe": true,
      "timestampX": "2026-10-08T18:41:56.000Z",
      "type": 4,
      "vatIncluded": false,
      "weight": null,
      "withoutOrder": false
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false,
    "durationMs": 474
  }
}

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

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