## Поиск типов цен

`POST /v1/catalog-price-types/search`

Поиск типов цен с фильтрами. Аналог [`GET /v1/catalog-price-types`](./list.md) с фильтрами, но через POST — удобнее для условий по нескольким полям.

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

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

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-price-types/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "base": "Y" },
    "limit": 10
  }'
```

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

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

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-price-types/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { base: 'Y' },
    limit: 10,
  }),
})

const { success, data, meta } = await res.json()
console.log('catalogGroupId базовой цены:', data[0].id)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-price-types/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { base: 'Y' },
    limit: 10,
  }),
})

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив типов цен (все поля — см. [Поля типа цены](/docs/entities/catalog-price-types/fields)) |
| `meta.total` | number | Общее количество типов цен, соответствующих фильтру |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |
| `meta.durationMs` | number | Длительность запроса в миллисекундах |

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

```json
{
  "success": true,
  "data": [
    {
      "base": "Y",
      "createdBy": 1,
      "dateCreate": "2020-04-22T05:37:42.000Z",
      "id": 1,
      "modifiedBy": 1,
      "name": "BASE",
      "sort": 100,
      "timestampX": "2024-10-22T04:31:37.000Z",
      "xmlId": "BASE"
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false,
    "durationMs": 95
  }
}
```

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

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

```json
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'nonExistentField' for entity 'catalog-price-types'. Available: id, name, base, xmlId, sort, createdBy, modifiedBy, dateCreate, timestampX"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `UNKNOWN_FILTER_FIELD` | Фильтр по полю, которого нет у типа цены. Сообщение содержит список доступных полей |
| 400 | `UNKNOWN_SORT_FIELD` | Сортировка по полю, которого нет у типа цены |
| 400 | `UNSTABLE_OFFSET_PAGINATION` | `offset` больше нуля вместе с фильтром по диапазону дат шире 14 дней. Передайте один запрос с `limit` до 5000, либо `autoWindow: false` с явным `sort: "id"`, либо разбейте диапазон дат на части |
| 422 | `BITRIX_ERROR` | Битрикс24 отказал в чтении типов цен: у владельца ключа нет прав администратора портала |
| 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).

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

**Фильтр `base: "Y"` — самый короткий способ узнать `catalogGroupId` базовой цены.** Он возвращает ровно одну запись, и её `id` не обязан быть равен 1.

**Метод требует прав администратора.** Скоупа `catalog` недостаточно: Битрикс24 отдаёт типы цен только ключу, владелец которого имеет роль администратора портала. Иначе приходит `422 BITRIX_ERROR` с сообщением Битрикс24 о недостатке прав.

**Фильтр по датам шире 14 дней разбивается на недельные окна.** Вайбкод сам делит такой диапазон `dateCreate` или `timestampX` на окна и склеивает результат. Вместе с `offset` больше нуля это невозможно — приходит `400 UNSTABLE_OFFSET_PAGINATION`. Разбиение отключает `autoWindow: false`.

**Запись не поддерживается.** `POST /v1/catalog-price-types` (без `/search`), `PATCH` и `DELETE` возвращают `404 ROUTE_NOT_FOUND` — типы цен заводятся в интерфейсе Битрикс24.

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

- [Список типов цен](/docs/entities/catalog-price-types/list)
- [Получить тип цены](/docs/entities/catalog-price-types/get)
- [Поля типа цены](/docs/entities/catalog-price-types/fields)
- [Цены каталога](/docs/entities/catalog-prices)
- [Синтаксис фильтрации](/docs/filtering)
- [Справочник API](/docs/api-reference)