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

`GET /v1/products`

Возвращает список товаров CRM-каталога с поддержкой фильтрации, сортировки и авто-пагинации.

По умолчанию элемент списка содержит базовые поля товара. Пользовательские свойства каталога `PROPERTY_<N>` приходят в том же элементе, если перечислить их в `select` поимённо.

## Параметры

| Параметр | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `limit` | number | `50` | Количество записей (до 5000). При `limit > 50` запрос автоматически собирается из нескольких страниц на стороне сервера |
| `offset` | number | `0` | Смещение от начала выборки |
| `select` | string | — | Выборка полей: `?select=id,name,price,active`. Пользовательское свойство каталога запрашивается своим именем: `?select=id,name,price,PROPERTY_301`. Имена свойств — в [Полях товара](./fields.md) |
| `order` | object | — | Сортировка по полям `id`, `name`, `sort`. Пример: `?order[sort]=desc`, `?order[name]=asc`. Поля `price` и `currency` сортировку не поддерживают |
| `filter` | object | — | Только точное равенство и `$in` (IN-множество) по полям `id`, `name`, `code`, `xmlId`, `active`, `sectionId`, `sort`, `description`. Операторы (`>`, `>=`, `<`, `<=`, `!`, `%`, `$ne`, `$contains`, `$nin`) и фильтрация по другим полям (`price`, `currency`) не поддерживаются — вернётся `400 UNSUPPORTED_FILTER`.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `?filter[active]=true` |

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/products?filter[active]=true&order[sort]=desc&limit=10" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/products?filter[active]=true&order[sort]=desc&limit=10" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const params = new URLSearchParams({
  'filter[active]': 'true',
  'order[sort]': 'desc',
  limit: '10',
})
const res = await fetch(`https://vibecode.bitrix24.tech/v1/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[active]': 'true',
  'order[sort]': 'desc',
  limit: '10',
})
const res = await fetch(`https://vibecode.bitrix24.tech/v1/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` в магазине портала строится из `catalogId` и `id`:

```
https://<портал>.bitrix24.ru/shop/catalog/<catalogId>/product/<id>/
```

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

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

```json
{
  "success": true,
  "data": [
    {
      "id": 6967,
      "name": "Головной товар",
      "code": "product_sku",
      "active": true,
      "previewPicture": null,
      "detailPicture": null,
      "sort": 100,
      "xmlId": "6967",
      "updatedAt": "2025-05-12T09:05:27.000Z",
      "createdAt": "2025-05-12T09:03:15.000Z",
      "modifyBy": 1,
      "createdBy": 1,
      "catalogId": 25,
      "sectionId": null,
      "description": null,
      "descriptionType": "text",
      "price": 100,
      "currency": "RUB",
      "vatId": null,
      "vatIncluded": false,
      "measure": null
    },
    {
      "id": 533,
      "name": "тест",
      "code": "test",
      "active": true,
      "previewPicture": null,
      "detailPicture": null,
      "sort": 500,
      "xmlId": "533",
      "updatedAt": "2023-08-21T09:12:18.000Z",
      "createdAt": "2021-07-20T11:01:36.000Z",
      "modifyBy": 29,
      "createdBy": 99,
      "catalogId": 25,
      "sectionId": 19,
      "description": null,
      "descriptionType": "html",
      "price": 10,
      "currency": "RUB",
      "vatId": 1,
      "vatIncluded": false,
      "measure": 9
    }
  ],
  "meta": {
    "total": 19,
    "hasMore": true
  }
}
```

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

400 — оператор или неподдерживаемое поле в фильтре:

```json
{
  "success": false,
  "error": {
    "code": "UNSUPPORTED_FILTER",
    "message": "UNSUPPORTED_FILTER: 'price' is not filterable on 'products'. Its Bitrix24 method (crm.product.list) filters by exact match only. Filterable: id, name, code, xmlId, active, sectionId, sort, description."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `UNSUPPORTED_FILTER` | Оператор или неподдерживаемое поле в фильтре. Фильтруйте точным равенством или `$in` по `id`, `name`, `code`, `xmlId`, `active`, `sectionId`, `sort`, `description` |
| 400 | `INVALID_FILTER` | Ошибка в синтаксисе фильтра |
| 400 | `UNKNOWN_SELECT_FIELD` | В `select` передано имя, которого нет у товара. Сообщение перечисляет допустимые имена после слова `Available` |
| 400 | `SELECT_FIELD_NOT_RETURNED` | В `select` передано имя, которое [Поля товара](./fields.md) показывают с признаком `notReturned: true`, — например `currencyId`. Уберите его из `select` |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |

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

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

**Свойства каталога приходят по явному перечислению.** Каждое нужное свойство называется в `select` своим именем — `?select=id,name,PROPERTY_295,PROPERTY_297`. Значение `select=*` их не возвращает, оно отдаёт базовые поля товара. Пустое свойство приходит ключом со значением `null`, заполненное — объектом `{ "valueId": …, "value": … }`, как в [Получить товар](/docs/entities/products/get).

**Номер свойства не проверяется.** Имя вида `PROPERTY_<N>` принимается с любым номером. Если свойства с таким номером на портале нет, ключ не приходит в ответе — ни отказа, ни предупреждения при этом не будет. Действующие номера — в [Полях товара](./fields.md).

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

- [Получить товар](/docs/entities/products/get)
- [Поиск товаров](/docs/entities/products/search)
- [Создать товар](/docs/entities/products/create)
- [Поля товара](/docs/entities/products/fields)
- [Товары CRM](/docs/entities/products)
- [Товары каталога](/docs/entities/catalog-products)
- [Синтаксис фильтрации](/docs/filtering)
- [Batch](/docs/batch)