## Поиск свойств позиций корзины

`POST /v1/basket-item-properties/search`

Ищет свойства позиций корзины по условиям фильтрации и сортировки, переданным в теле JSON-запроса. Для списка GET /v1/basket-item-properties параметры передают в URL, а для поиска — в теле запроса.

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

| Поле | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `filter` | object | — | Фильтрация по полям [`GET /v1/basket-item-properties/fields`](/docs/entities/basket-item-properties/fields).<br>[Синтаксис фильтрации](/docs/filtering). Пример: `{ "basketId": 1001 }` |
| `select` | string \| string[] | — | Массив имён полей или строка через запятую. В `data` останутся выбранные поля |
| `sort` | string \| object \| string[] | — | Сортировка строкой, объектом или массивом имён полей. Минус перед именем означает убывание |
| `order` | object | — | Сортировка объектом. Если передан `sort`, действует он |
| `limit` | number | `50` | Количество записей, от 1 до 5000. По умолчанию `50`. Ноль заменяется на `50`, отрицательное значение — на `1`, значение больше 5000 — на `5000` |
| `offset` | number | `0` | Количество записей, которые нужно пропустить. По умолчанию `0` |
| `withTotal` | boolean | — | Принимается как `true` или `false`, но для свойств позиций корзины не меняет подсчёт и наличие `meta.total` |
| `autoWindow` | boolean | — | Принимает `true` и `false` |

**Пагинация.** При `limit > 50` Вайбкод читает несколько страниц по 50 записей. Для следующей выборки увеличьте `offset` на количество полученных записей. Продолжайте, пока `meta.hasMore` равен `true`.

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/basket-item-properties/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"filter":{"basketId":1001},"select":["id","name","value"],"sort":"-id","limit":2}'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/basket-item-properties/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"filter":{"basketId":1001},"select":["id","name","value"],"sort":"-id","limit":2}'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/basket-item-properties/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filter": {
      "basketId": 1001
    },
    "select": [
      "id",
      "name",
      "value"
    ],
    "sort": "-id",
    "limit": 2
  }),
})

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

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/basket-item-properties/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filter": {
      "basketId": 1001
    },
    "select": [
      "id",
      "name",
      "value"
    ],
    "sort": "-id",
    "limit": 2
  }),
})

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

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

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

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

```json
{
  "success": true,
  "data": [
    {
      "id": 1007,
      "name": "Product XML_ID",
      "value": "6967"
    },
    {
      "id": 1005,
      "name": "Catalog XML_ID",
      "value": "FUTURE-1C-CATALOG"
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false,
    "durationMs": 64
  }
}
```

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

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

```json
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'color' for entity 'basket-item-properties'. Available: id, basketId, name, value, code, sort, xmlId"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|---|---|---|
| 400 | `UNKNOWN_FILTER_FIELD` | Фильтр содержит поле, которого нет в схеме. Сообщение перечисляет доступные поля |
| 400 | `INVALID_LIMIT` | `limit` имеет неподдерживаемый тип |
| 400 | `INVALID_SELECT_TYPE` | `select` не является строкой или массивом строк |
| 400 | `INVALID_REQUEST` | Тело запроса не является JSON-объектом |
| 422 | `BITRIX_ERROR` | Битрикс24 отклонил запрос. Причина указана в `error.message` |
| 503 | `BITRIX_TIMEOUT` | Битрикс24 не ответил вовремя |
| 502 | `BITRIX_UNAVAILABLE` | Нет соединения с Битрикс24 |
| 403 | `SCOPE_DENIED` | У API-ключа нет скоупа `sale` |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `TOKEN_MISSING` | Нет настроенных токенов доступа к Битрикс24 |
| 429 | `RATE_LIMITED` | Превышен лимит запросов. Повторите после срока из заголовка `Retry-After` |

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

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

- [Список свойств позиций корзины](/docs/entities/basket-item-properties/list)
- [Получить свойство позиции корзины](/docs/entities/basket-item-properties/get)
- [Поля свойства позиции корзины](/docs/entities/basket-item-properties/fields)
- [Агрегация свойств позиций корзины](/docs/entities/basket-item-properties/aggregate)
- [Синтаксис фильтрации](/docs/filtering)
- [Лимиты и оптимизация](/docs/optimization)
- [Список позиций корзины](/docs/entities/basket-items/list)