## Список вариаций

`GET /v1/catalog-offers`

Возвращает вариации товаров из каталога вариаций с фильтрацией, сортировкой, выборкой полей и пагинацией.

Требует фильтр `filter[iblockId]` — ID каталога вариаций. Без этого фильтра запрос отклоняется с `400`.

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

## Параметры

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

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

## Примеры

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

```bash
curl -g "https://vibecode.bitrix24.tech/v1/catalog-offers?filter[iblockId]=27&filter[parentId]=7189&limit=10" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl -g "https://vibecode.bitrix24.tech/v1/catalog-offers?filter[iblockId]=27&filter[parentId]=7189&limit=10" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const params = new URLSearchParams({
  'filter[iblockId]': '27',
  'filter[parentId]': '7189',
  limit: '10',
})
const res = await fetch(`https://vibecode.bitrix24.tech/v1/catalog-offers?${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]': '27',
  'filter[parentId]': '7189',
  limit: '10',
})
const res = await fetch(`https://vibecode.bitrix24.tech/v1/catalog-offers?${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 | Массив вариаций. Состав полей элемента — см. [Поля вариации](./fields.md) |
| `meta.total` | number | Общее количество записей, соответствующих фильтру |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |
| `meta.warnings` | array | Предупреждения. Приходит, когда в `select` передано имя, которое нельзя выбрать: элемент с `code: UNKNOWN_SELECT_FIELD` называет его в `field`. Запрос при этом выполняется, имя в ответе отсутствует |

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

```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
  }
}
```

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

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

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

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `MISSING_REQUIRED_FILTER` | Не передан обязательный фильтр `filter[iblockId]`. Запрос отклоняется до обращения к Битрикс24 — сообщение содержит имя недостающего поля и пример вызова |
| 400 | `UNSUPPORTED_FILTER` | В `filter[type]` передано значение, отличное от `4` и `5`, массив или оператор |
| 400 | `UNKNOWN_FILTER_FIELD` | Фильтр по полю, которого нет у вариации, или по полю даты: `dateCreate`, `timestampX`, `dateActiveFrom`, `dateActiveTo`. Сообщение содержит список доступных полей |
| 400 | `UNKNOWN_SORT_FIELD` | Сортировка по полю, которого нет у вариации. Сообщение содержит список доступных полей |
| 422 | `BITRIX_ERROR` | В `select` нет `iblockId` (`Required select fields: iblockId`) |
| 422 | `BITRIX_ERROR` | В `select` нет `id` (`Required select fields: id`) |
| 422 | `BITRIX_ERROR` | В `filter[iblockId]` передан ID товарного каталога, а не каталога вариаций (`productType is not allowed for this catalog`) |
| 422 | `BITRIX_ERROR` | Каталога с указанным `iblockId` нет (`iblock is not catalog`) |
| 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).

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

**`parentId` в ответе — объект, в фильтре — число.** В элементах `data` связь с головным товаром приходит объектом: `value` — ID головного товара строкой, `valueId` — служебный ID значения связи. Для отбора вариаций передайте в `filter[parentId]` сам ID головного товара. У свободной вариации `parentId` равен `null`.

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

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