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

`POST /v1/catalog-skus/search`

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

В отличие от [`GET /v1/catalog-skus`](./list.md), параметры `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`](/docs/entities/catalogs). Ключ `type` принимает одно точное число: `3` — головные товары с вариациями, `6` — без вариаций.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `{ "iblockId": 25, "type": 3 }` |
| `select` | string[] | нет | — | Выборка полей: `["iblockId", "id", "name", "type"]`. Если параметр передан, в нём обязательны `iblockId` и `id`. Без `select` приходит сокращённый набор полей: символьный код, тексты, сортировка и внешний код возвращаются только по явному перечислению — какие именно, видно в [Полях головного товара](./fields.md). Свойство каталога запрашивается своим именем: `["iblockId", "id", "name", "property295"]` |
| `sort` | string | нет | — | Поле сортировки. Префикс `-` — по убыванию: `"-id"` |
| `limit` | number | нет | `50` | Количество записей (до 5000) |
| `offset` | number | нет | `0` | Смещение от начала выборки |

## Примеры

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

```bash
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-приложение

```bash
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 | Массив головных товаров. Состав полей элемента — см. [Поля головного товара](./fields.md) |
| `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 — не передан обязательный фильтр:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FILTER",
    "message": "POST /v1/catalog-skus/search requires filter fields: iblockId. Example body: { \"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 — [Ошибки](/docs/errors).

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

- [Список головных товаров](/docs/entities/catalog-skus/list)
- [Создать головной товар](/docs/entities/catalog-skus/create)
- [Получить головной товар](/docs/entities/catalog-skus/get)
- [Поля головного товара](/docs/entities/catalog-skus/fields)
- [Вариации товара](/docs/entities/catalog-offers)
- [Синтаксис фильтрации](/docs/filtering)
- [Справочник API](/docs/api-reference)