## Получить свойство заказа

`GET /v1/order-properties/:id`

Получает определение свойства заказа по идентификатору.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `id` (path) | number | да | ID свойства заказа. Список: [`GET /v1/order-properties`](/docs/entities/order-properties/list) |
| `select` (query) | string | нет | Поля через запятую, например `?select=id,name,type`. Список полей: [`GET /v1/order-properties/fields`](/docs/entities/order-properties/fields). В `data` останутся только выбранные поля |

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/order-properties/125" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/order-properties/125" \
  -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/125', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/order-properties/125', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | object | Определение свойства заказа. Все поля — [Поля свойства заказа](/docs/entities/order-properties/fields) |
| `meta.warnings` | array | Предупреждения о неизвестных именах в `select`, с полями `code`, `message`, `field`. Приходит, только если предупреждения есть |

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

Показаны основные поля. Полный список: [Поля свойства заказа](/docs/entities/order-properties/fields).

```json
{
  "success": true,
  "data": {
    "id": 125,
    "personTypeId": 5,
    "type": "STRING",
    "name": "Комментарий курьеру",
    "propsGroupId": 9,
    "code": "DELIVERY_COMMENT",
    "defaultValue": "Позвонить перед доставкой",
    "settings": {
      "maxlength": 200,
      "multiline": "N",
      "size": 40
    },
    "active": false,
    "required": false
  }
}
```

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

404 — свойство заказа не найдено:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "property is not exists"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | `id` не является целым неотрицательным числом |
| 404 | `ENTITY_NOT_FOUND` | Свойства с таким `id` нет. Текст ошибки — `property is not exists` |
| 404 | `ENTITY_NOT_FOUND` | Запрос выполнился, но объекта в ответе нет. Текст ошибки — `orderProperty <id> not found` |
| 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 |

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

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

- [Список свойств заказа](/docs/entities/order-properties/list)
- [Поиск свойств заказа](/docs/entities/order-properties/search)
- [Обновить свойство заказа](/docs/entities/order-properties/update)
- [Поля свойства заказа](/docs/entities/order-properties/fields)
- [Свойства заказа](/docs/entities/order-properties)