Поля значения

GET /v1/catalog-product-property-enums/fields

Возвращает справочник полей элемента перечисления с типами и признаком «только для чтения», а также операции, доступные в пакетном запросе.

Ответ собирается из статической схемы сущности — обращения к Битрикс24 не происходит.

Примеры

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

curl "https://vibecode.bitrix24.tech/v1/catalog-product-property-enums/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

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

curl "https://vibecode.bitrix24.tech/v1/catalog-product-property-enums/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

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

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

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

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

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

Поля ответа

data.fields — объект, ключ которого совпадает с именем поля, а значение содержит type (тип поля), readonly и человекочитаемые label и description. data.batch перечисляет записывающие операции, доступные в пакетном запросе; у этой сущности он пустой, потому что записи нет вовсе. Чтения в батче это не отменяет: подвызовы list и get через POST /v1/batch и POST /v1/catalog-product-property-enums/batch работают. Подвызов fields в батче тоже принимается, но у этой сущности отвечает 200 с пустым объектом — обращения к Битрикс24 не происходит, и справочник полей так не получить. Берите его одиночным GET /v1/catalog-product-property-enums/fields.

Подписи полей label и description приходят на русском языке. Заголовками запроса язык не переключается.

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

Поля label и description показаны только у первого поля, у остальных опущены для краткости.

{
  "success": true,
  "data": {
    "fields": {
      "id": {
        "type": "number",
        "readonly": true,
        "label": "ID",
        "description": "Идентификатор элемента перечисления. Именно он приходит в поле propertyNNN.value у товара каталога."
      },
      "propertyId": { "type": "number", "readonly": true },
      "value": { "type": "string", "readonly": true },
      "def": { "type": "boolean", "readonly": true },
      "sort": { "type": "number", "readonly": true },
      "xmlId": { "type": "string", "readonly": true, "nullable": true }
    },
    "batch": []
  }
}

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

403 — нет скоупа:

{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'catalog' scope"
  }
}

Ошибки

Полный список общих ошибок API — Ошибки.

Известные особенности

Сущность только для чтения. Варианты списка заводятся в интерфейсе Битрикс24. POST, PATCH, DELETE и POST /aggregate не зарегистрированы и отвечают 404, а data.batch приходит пустым массивом. Читающие подвызовы в пакетном запросе при этом доступны.

Перечисление есть только у свойств типа L. У свойства любого другого типа (S, N, F, E, G) список вариантов пуст. Тип свойства читается из GET /v1/catalog-product-properties/:id в поле propertyType.

Связь с полями товара. Значение списочного свойства приходит у товара каталога в поле propertyNNN, где NNN — id свойства. Внутри — value (это id элемента перечисления, строкой), valueEnum (готовый текст) и valueId (id строки значения). Сопоставление делается по String(элемент.id) === товар.propertyNNN.value.

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

• Список значений
• Получить значение
• Поиск значений
• Свойства товаров каталога
• Товары каталога
• Справочник API