## Поиск значений

`POST /v1/catalog-product-property-enums/search`

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

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

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

| Параметр | Тип | Обяз. | По умолч. | Описание |
|----------|-----|:-----:|-----------|---------|
| `filter.propertyId` | number | **да** | — | ID свойства-владельца из [`GET /v1/catalog-product-properties`](/docs/entities/catalog-product-properties/list). Без него запрос отклоняется с `400 MISSING_REQUIRED_FILTER` до обращения к Битрикс24 |
| `filter` | object | нет | — | Остальные условия фильтрации.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `{ "propertyId": 166, "def": true }` |
| `select` | string[] | нет | — | Выборка полей: `["id", "value"]`. Без `select` возвращаются все поля элемента |
| `sort` | string | нет | — | Поле сортировки. Префикс `-` — по убыванию: `"-sort"` |
| `limit` | number | нет | `50` | Количество записей (до 5000) |
| `offset` | number | нет | `0` | Смещение от начала выборки |

Как и в списке, конец выборки определяется по `meta.hasMore` — Битрикс24 сообщает общее количество, так что `meta.total` и `meta.hasMore` достоверны.

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-product-property-enums/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "propertyId": 166 },
    "sort": "sort",
    "limit": 1000
  }'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-product-property-enums/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "propertyId": 166 },
    "sort": "sort",
    "limit": 1000
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-product-property-enums/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { propertyId: 166 },
    sort: 'sort',
    limit: 1000,
  }),
})

const { success, data, meta } = await res.json()
console.log(`Вариантов: ${meta.total}`)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-product-property-enums/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { propertyId: 166 },
    sort: 'sort',
    limit: 1000,
  }),
})

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив вариантов. Состав полей элемента — см. [Поля значения](./fields.md) |
| `meta.total` | number | Сколько записей подошло под фильтр. Если Битрикс24 не сообщил его, приходит длина окна |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit`. На границе окна ненадёжен — см. предупреждение выше |
| `meta.durationMs` | number | Длительность запроса в миллисекундах |

Поля `meta` лежат рядом с `data`, а не внутри него.

Свойство не списочного типа (`propertyType` не равен `L`) перечисления не имеет: запрос вернёт `200` с пустым `data`, а не ошибку. Доступ ограничен правами сотрудника в Битрикс24.

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

```json
{
  "success": true,
  "data": [
    { "id": 110, "propertyId": 166, "value": "XS", "def": false, "sort": 100, "xmlId": null },
    { "id": 112, "propertyId": 166, "value": "S",  "def": false, "sort": 200, "xmlId": null },
    { "id": 114, "propertyId": 166, "value": "M",  "def": false, "sort": 300, "xmlId": null },
    { "id": 116, "propertyId": 166, "value": "L",  "def": false, "sort": 400, "xmlId": null },
    { "id": 118, "propertyId": 166, "value": "XL", "def": false, "sort": 500, "xmlId": null }
  ],
  "meta": {
    "total": 5,
    "hasMore": false,
    "durationMs": 148
  }
}
```

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

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

```json
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FILTER",
    "message": "POST /v1/catalog-product-property-enums/search requires filter fields: propertyId. Example body: { \"filter\": {\"propertyId\":\"...\"} }"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `MISSING_REQUIRED_FILTER` | В теле нет ключа `filter.propertyId`. Обращения к Битрикс24 не происходит |
| 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-product-property-enums/list)
- [Получить значение](/docs/entities/catalog-product-property-enums/get)
- [Поля значения](/docs/entities/catalog-product-property-enums/fields)
- [Свойства товаров каталога](/docs/entities/catalog-product-properties)
- [Товары каталога](/docs/entities/catalog-products)
- [Синтаксис фильтрации](/docs/filtering)
- [Справочник API](/docs/api-reference)