Для AI-агентов: markdown этой страницы — /docs-content/entities/catalog-product-property-enums/get.md индекс документации — /llms.txt

Получить значение

GET /v1/catalog-product-property-enums/:id

Возвращает один вариант списочного свойства по идентификатору элемента перечисления. Это тот же id, что приходит у товара каталога в propertyNNN.value.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор элемента перечисления

Фильтр по propertyId здесь не нужен: элемент адресуется своим собственным идентификатором.

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalog-product-property-enums/116" \
  -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-product-property-enums/116', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Значение:', data.value)

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект варианта. Состав полей — см. Поля значения

Поле xmlId приходит null, если внешний код не задан.

Один вариант читается точечно, когда его id уже известен — например, взят из propertyNNN.value товара. Чтобы получить все варианты свойства, нужен список с filter[propertyId].

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

JSON 
{
  "success": true,
  "data": {
    "id": 116,
    "propertyId": 166,
    "value": "L",
    "def": false,
    "sort": 400,
    "xmlId": null
  }
}

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

404 — элемента с таким id нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "catalogProductPropertyEnum 116 not found"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Элемента перечисления с указанным id не существует
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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