## Поля единицы измерения

`GET /v1/catalog-measures/fields`

Возвращает схему полей единицы измерения торгового каталога: по ней проверяют типы и допустимые значения перед созданием и обновлением записи.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/catalog-measures/fields" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/catalog-measures/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-measures/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Поля:', Object.keys(data.fields))
```

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

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

const { success, data } = await res.json()
console.log('Поля:', Object.keys(data.fields))
```

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data.fields` | object | Карта полей единицы измерения. Ключ — имя поля, значение — его описание |
| `data.batch` | array | Действия записи, доступные в пакетном режиме через `POST /v1/catalog-measures/batch`: `create`, `update`, `delete` |

Каждое поле карты `fields` описано ключами `type`, `readonly`, подписью `label` и описанием `description`. Ключ `required: true` стоит у полей, без которых запись не создаётся, — `code` и `measureTitle`. Ключ `nullable: true` стоит у полей, значение которых может прийти как `null`. У поля `isDefault` есть перечень допустимых значений `enum`: каждое значение с английской подписью `label` и русской `labelRu`. Подпись `label` и описание `description` самих полей приходят на русском языке.

| Поле | Тип | RO | Описание |
|------|-----|:--:|---------|
| `id` | number | да | Идентификатор единицы измерения. Его передают в поле `measure` товара |
| `code` | number | | Код единицы по Общероссийскому классификатору единиц измерения (ОКЕИ), целое число. Уникален на портале. Обязателен при создании |
| `measureTitle` | string \| null | | Название единицы измерения. Обязательно при создании, но у части существующих единиц приходит `null` — тогда обозначение заполнено в `symbolIntl` и `symbolLetterIntl` |
| `symbol` | string \| null | | Краткое обозначение. `null`, если не задано |
| `symbolIntl` | string \| null | | Международное обозначение. `null`, если не задано |
| `symbolLetterIntl` | string \| null | | Международное буквенное обозначение. `null`, если не задано |
| `isDefault` | string | | Единица по умолчанию на портале: `Y` или `N`. Другие значения отклоняются |

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

```json
{
  "success": true,
  "data": {
    "fields": {
      "id": {
        "type": "number",
        "readonly": true,
        "label": "ID",
        "description": "Идентификатор единицы измерения."
      },
      "code": {
        "type": "number",
        "readonly": false,
        "required": true,
        "label": "Код ОКЕИ",
        "description": "Уникальный код единицы измерения по ОКЕИ."
      },
      "measureTitle": {
        "type": "string",
        "readonly": false,
        "required": true,
        "nullable": true,
        "label": "Название",
        "description": "Название единицы измерения."
      },
      "symbol": {
        "type": "string",
        "readonly": false,
        "nullable": true,
        "label": "Символ",
        "description": "Краткое обозначение."
      },
      "symbolIntl": {
        "type": "string",
        "readonly": false,
        "nullable": true,
        "label": "Международный символ",
        "description": "Международное обозначение."
      },
      "symbolLetterIntl": {
        "type": "string",
        "readonly": false,
        "nullable": true,
        "label": "Международное буквенное обозначение",
        "description": "Международное буквенное обозначение."
      },
      "isDefault": {
        "type": "string",
        "readonly": false,
        "label": "Единица по умолчанию",
        "description": "Y, если это единица по умолчанию на портале; иначе N. Такой может быть только одна.",
        "enum": [
          { "value": "Y", "label": "Default", "labelRu": "По умолчанию" },
          { "value": "N", "label": "Not default", "labelRu": "Не по умолчанию" }
        ]
      }
    },
    "batch": ["create", "update", "delete"]
  }
}
```

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

401 — не передан API-ключ:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `catalog` |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |
| 429 | `RATE_LIMITED` | Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке `x-ratelimit-limit` (потолок делится на реплики). Повторите после срока из заголовка `Retry-After` |

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

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

- [Создать единицу измерения](/docs/entities/catalog-measures/create)
- [Обновить единицу измерения](/docs/entities/catalog-measures/update)
- [Список единиц измерения](/docs/entities/catalog-measures/list)
- [Единицы измерения каталога](/docs/entities/catalog-measures)
- [Товары каталога](/docs/entities/catalog-products)
- [Entity API](/docs/entity-api)