## Поиск цен

`POST /v1/catalog-prices/search`

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

В отличие от [`GET /v1/catalog-prices`](./list.md), параметры `filter`, `select`, `sort`, `limit` и `offset` передаются в JSON-теле, а не в строке адреса — это удобнее для условий по нескольким полям. Формат ответа тот же, что у списка.

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

| Параметр | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `filter` | object | — | Фильтрация по полям записи цены.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `{ "catalogGroupId": 1 }` |
| `select` | string[] | — | Выборка полей: `["id", "productId", "price"]`. Возвращаются только перечисленные поля |
| `sort` | string | — | Поле сортировки. Префикс `-` — по убыванию: `"-price"` |
| `limit` | number | `50` | Количество записей (до 5000) |
| `offset` | number | `0` | Смещение от начала выборки. Вместе с фильтром по диапазону дат шире 14 дней отклоняется — см. `UNSTABLE_OFFSET_PAGINATION` в разделе «Ошибки» |
| `autoWindow` | boolean | `true` | Разбивать выборку по недельным окнам при фильтре по диапазону дат шире 14 дней. `false` отключает разбиение |

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-prices/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "catalogGroupId": 1 },
    "limit": 2
  }'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-prices/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "catalogGroupId": 1 },
    "limit": 2
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-prices/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { catalogGroupId: 1 },
    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-prices/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { catalogGroupId: 1 },
    limit: 2,
  }),
})

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

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив цен |
| `data[].id` | number | Идентификатор записи цены |
| `data[].catalogGroupId` | number | Тип цены. Базовая цена — `1` |
| `data[].currency` | string | Валюта цены, например `RUB` |
| `data[].price` | number | Значение цены |
| `data[].productId` | number | Идентификатор товара, к которому относится цена |
| `data[].quantityFrom` | number \| null | Нижняя граница количественного диапазона. `null`, если цена не зависит от количества |
| `data[].quantityTo` | number \| null | Верхняя граница количественного диапазона. `null`, если цена не зависит от количества |
| `data[].extraId` | number \| null | Идентификатор наценки (`catalog_extra`). Устаревшее поле Битрикс24 |
| `data[].priceScale` | number | Цена в базовой валюте портала |
| `data[].timestampX` | string | Дата последнего изменения (ISO 8601) |
| `meta.total` | number | Сколько записей подошло под фильтр |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |
| `meta.durationMs` | number | Длительность запроса в миллисекундах |
| `meta.autoWindowed` | boolean | `true`, если выборка была разбита по временны́м окнам |
| `meta.windowCount` | number | Число окон. Приходит при `autoWindowed: true` |
| `meta.batchWaves` | number | Число волн параллельных запросов. Приходит при `autoWindowed: true` |

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

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

```json
{
  "success": true,
  "data": [
    {
      "catalogGroupId": 1,
      "currency": "RUB",
      "extraId": null,
      "id": 5002,
      "price": 10,
      "priceScale": 10,
      "productId": 102,
      "quantityFrom": null,
      "quantityTo": null,
      "timestampX": "2021-09-27T16:32:20+03:00"
    },
    {
      "catalogGroupId": 1,
      "currency": "RUB",
      "extraId": null,
      "id": 5003,
      "price": 32999,
      "priceScale": 32999,
      "productId": 103,
      "quantityFrom": null,
      "quantityTo": null,
      "timestampX": "2025-01-10T14:49:59+03:00"
    }
  ],
  "meta": {
    "total": 22,
    "hasMore": true,
    "durationMs": 487
  }
}
```

С фильтром по диапазону дат шире 14 дней в `meta` дополнительно приходят `autoWindowed`, `windowCount` и `batchWaves`:

```json
{
  "success": true,
  "data": [ /* ... */ ],
  "meta": {
    "total": 19,
    "hasMore": true,
    "autoWindowed": true,
    "windowCount": 131,
    "batchWaves": 3,
    "durationMs": 1092
  }
}
```

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

400 — фильтр по несуществующему полю:

```json
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'bogus' for entity 'catalog-prices'. Available: id, catalogGroupId, currency, price, productId, quantityFrom, quantityTo"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `UNKNOWN_FILTER_FIELD` | Фильтр по полю, которого нет у записи цены. Сообщение содержит список доступных полей |
| 400 | `UNSTABLE_OFFSET_PAGINATION` | `offset` больше нуля вместе с фильтром по диапазону дат шире 14 дней. Два разных алгоритма выдачи дают несогласованные результаты, поэтому запрос отклоняется. Возьмите всё одним запросом с `limit` до 5000, либо передайте `autoWindow: false` с сортировкой по `id`, либо режьте диапазон дат на части сами |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `catalog` |
| 401 | `TOKEN_MISSING` | Не передан заголовок `X-Api-Key` |

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

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

**Разбиение по временны́м окнам.** Фильтр по диапазону дат шире 14 дней автоматически разбивается на недельные окна, которые выполняются параллельными волнами — так выборка обходит потолок в 5000 записей на один вызов. В `meta` тогда приходят `autoWindowed: true`, число окон `windowCount` и число волн `batchWaves`. Отключает разбиение параметр `autoWindow: false`. При активном разбиении `offset` больше нуля отклоняется с `UNSTABLE_OFFSET_PAGINATION`.

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

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