## Список свойств заказа

`GET /v1/order-properties`

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

## Параметры

| Параметр | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `filter` (query) | object | — | Фильтрация по полям [`GET /v1/order-properties/fields`](/docs/entities/order-properties/fields).<br>[Синтаксис фильтрации](/docs/filtering). Пример: `?filter[id]=125` |
| `select` (query) | string \| string[] \| object | — | Поля через запятую: `?select=id,name,type`. Массив: `?select[]=id&select[]=name`. Для объекта берутся значения: `?select[id]=id&select[name]=name`. В `data` останутся только выбранные поля. Неизвестные имена отмечаются в `meta.warnings` с кодом `UNKNOWN_SELECT_FIELD` |
| `sort` (query) | string \| object \| string[] | — | Сортировка: `?sort=id`, `?sort=-sort,id`, объект `?sort[id]=desc` или массив `?sort[]=id&sort[]=-name` |
| `order` (query) | object | — | Сортировка объектом: `?order[id]=desc`. Если передан `sort`, действует он |
| `limit` (query) | number | `50` | Количество записей, от 1 до 5000. Значение больше 5000 приводится к 5000 |
| `offset` (query) | number | `0` | Количество записей, которые нужно пропустить |
| `withTotal` (query) | string | — | Принимается как `true` или `false`, но для свойств заказа не меняет подсчёт и наличие `meta.total` |

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

## Примеры

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

```bash
curl -g "https://vibecode.bitrix24.tech/v1/order-properties?filter[id]=125&select=id,name,personTypeId,propsGroupId,type,active&limit=10&sort=id&offset=0&withTotal=true" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl -g "https://vibecode.bitrix24.tech/v1/order-properties?filter[id]=125&select=id,name,personTypeId,propsGroupId,type,active&limit=10&sort=id&offset=0&withTotal=true" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/order-properties?filter[id]=125&select=id,name,personTypeId,propsGroupId,type,active&limit=10&sort=id&offset=0&withTotal=true', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/order-properties?filter[id]=125&select=id,name,personTypeId,propsGroupId,type,active&limit=10&sort=id&offset=0&withTotal=true', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

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

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

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

```json
{
  "success": true,
  "data": [
    {
      "id": 125,
      "name": "Комментарий курьеру",
      "personTypeId": 5,
      "propsGroupId": 9,
      "type": "STRING",
      "active": false
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}
```

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

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

```json
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'unknownField' for entity 'order-properties'. Available: id, personTypeId, type, name, propsGroupId, code, sort, defaultValue, description, settings, xmlId, inputFieldLocation, active, required, multiple, userProps, util, isAddress, isAddressFrom, isAddressTo, isEmail, isFiltered, isLocation, isLocation4tax, isPayer, isPhone, isProfileName, isZip"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `UNKNOWN_FILTER_FIELD` | Фильтр по полю, которого нет в схеме. Список полей: [`GET /v1/order-properties/fields`](/docs/entities/order-properties/fields) |
| 400 | `INVALID_FILTER_FIELD` | Имя поля фильтра начинается с неподдерживаемого префикса `@` или `!@` |
| 400 | `INVALID_FILTER_OPERATOR` | Неизвестный оператор, пустой объект в условии или логическое условие `$or` либо `$and` |
| 400 | `INVALID_DUPLICATE_FILTER_FIELD` | Два условия сводятся к одному условию фильтра. Передайте одно из них |
| 400 | `INVALID_SORT_FIELD` | В сортировке передано запрещённое имя `__proto__`, `constructor` или `prototype` |
| 400 | `UNKNOWN_SORT_FIELD` | Сортировка по неизвестному полю |
| 400 | `INVALID_SORT_DIRECTION` | Направление в объекте сортировки не из списка `asc`, `desc`, `ASC`, `DESC` |
| 400 | `INVALID_FILTER` | `filter` не является объектом или JSON-строкой с объектом, либо смешаны две формы записи фильтра |
| 422 | `BITRIX_ERROR` | У пользователя ключа нет прав в Битрикс24. Код Битрикс24 — в `error.b24Code`: `200040300010` |
| 403 | `BITRIX_ACCESS_DENIED` | У учётных данных портала нет скоупа `sale` (`insufficient_scope`) |
| 422 | `BITRIX_ERROR` | Бизнес-отказ Битрикс24. Причина указана в `error.message` |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `sale` |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `TOKEN_MISSING` | Нет настроенных токенов доступа к Битрикс24 |
| 429 | `RATE_LIMITED` | Превышен лимит запросов. Точное значение — в заголовке `x-ratelimit-limit`. Повторите после срока из заголовка `Retry-After` |

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

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

- [Поиск свойств заказа](/docs/entities/order-properties/search)
- [Получить свойство заказа](/docs/entities/order-properties/get)
- [Создать свойство заказа](/docs/entities/order-properties/create)
- [Поля свойства заказа](/docs/entities/order-properties/fields)
- [Свойства заказа](/docs/entities/order-properties)
- [Синтаксис фильтрации](/docs/filtering)
- [Лимиты и оптимизация](/docs/optimization)