## Список товаров

`GET /v1/catalog-products`

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

## Параметры

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

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

## Примеры

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

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

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

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

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

```javascript
const params = new URLSearchParams({ 'filter[iblockId]': '25', limit: '10' })
const res = await fetch(`https://vibecode.bitrix24.tech/v1/catalog-products?${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', limit: '10' })
const res = await fetch(`https://vibecode.bitrix24.tech/v1/catalog-products?${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` |

URL карточки любого товара из массива `data` строится из его `iblockId` и `id`:

```
https://<portal>.bitrix24.ru/shop/catalog/<iblockId>/product/<id>/
```

`<portal>` — домен портала. Доступ ограничен правами сотрудника в Битрикс24.

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

```json
{
  "success": true,
  "data": [
    {
      "id": 533,
      "iblockId": 25,
      "iblockSectionId": 19,
      "name": "Колонка настольная",
      "active": true,
      "available": true,
      "barcodeMulti": false,
      "bundle": false,
      "canBuyZero": true,
      "measure": 9,
      "purchasingCurrency": "RUB",
      "purchasingPrice": 0,
      "quantity": null,
      "quantityTrace": true,
      "subscribe": true,
      "vatIncluded": false,
      "weight": null,
      "withoutOrder": false,
      "dateCreate": "2021-07-20T10:01:36.000Z",
      "timestampX": "2023-08-21T08:12:18.000Z"
    },
    {
      "id": 541,
      "iblockId": 25,
      "iblockSectionId": null,
      "name": "Кабель USB-C",
      "active": true,
      "available": true,
      "barcodeMulti": false,
      "bundle": false,
      "canBuyZero": true,
      "measure": 9,
      "purchasingCurrency": "RUB",
      "purchasingPrice": 110,
      "quantity": null,
      "quantityTrace": false,
      "subscribe": true,
      "vatIncluded": false,
      "weight": null,
      "withoutOrder": false,
      "dateCreate": "2021-08-06T12:59:15.000Z",
      "timestampX": "2025-10-31T10:24:18.000Z"
    }
  ],
  "meta": {
    "total": 19,
    "hasMore": false
  }
}
```

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

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

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

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `MISSING_REQUIRED_FILTER` | Не передан обязательный фильтр `filter[iblockId]`. Запрос отклоняется до обращения к Битрикс24 — сообщение содержит имя недостающего поля и пример вызова |
| 422 | `BITRIX_ERROR` | Каталог с указанным `iblockId` не найден (`Iblock Not Found`) |
| 422 | `BITRIX_ERROR` | В `select` передан без `iblockId` (`Required select fields: iblockId`) |
| 400 | `UNKNOWN_FILTER_FIELD` | Фильтр по полю, которого нет у товара. Сообщение содержит список доступных полей |
| 400 | `UNKNOWN_SORT_FIELD` | Сортировка по полю, которого нет у товара. Сообщение содержит список доступных полей |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `catalog` |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

- [Создать товар](/docs/entities/catalog-products/create)
- [Получить товар](/docs/entities/catalog-products/get)
- [Поиск товаров](/docs/entities/catalog-products/search)
- [Поля товара](/docs/entities/catalog-products/fields)
- [Цены каталога](/docs/entities/catalog-prices)
- [Синтаксис фильтрации](/docs/filtering)
- [Справочник сущностей](/docs/entities-index)