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

Создать значение списочного свойства

POST /v1/catalog-product-property-enums

Добавляет новый вариант в списочное свойство товарного каталога. Поля передаются в корне JSON без обёртки.

Поля запроса (body)

Поле Тип Обяз. Описание
propertyId number да Идентификатор списочного свойства. Возьмите из списка свойств товаров каталога. У свойства должно быть propertyType: "L"
value string да Текст варианта
xmlId string да Внешний код для импорта и интеграций
sort number нет Порядок сортировки внутри свойства
def boolean нет Сделать вариант значением свойства по умолчанию
id number нет RO. Идентификатор назначается при создании, передавать его нельзя

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-product-property-enums" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"propertyId":295,"value":"Дополнительный вариант","xmlId":"EXTRA-20261013","sort":100,"def":false}'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-product-property-enums" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"propertyId":295,"value":"Дополнительный вариант","xmlId":"EXTRA-20261013","sort":100,"def":false}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-product-property-enums', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    propertyId: 295,
    value: 'Дополнительный вариант',
    xmlId: 'EXTRA-20261013',
    sort: 100,
    def: false,
  }),
})

const { data } = await res.json()
console.log(data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-product-property-enums', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    propertyId: 295,
    value: 'Дополнительный вариант',
    xmlId: 'EXTRA-20261013',
    sort: 100,
    def: false,
  }),
})

const { data } = await res.json()
console.log(data.id)

Поля ответа

Поле Тип Описание
success boolean true при успешном запросе
data object Значение списочного свойства
data.id number Идентификатор значения
data.propertyId number Идентификатор свойства-владельца
data.value string Текст варианта
data.def boolean Является ли вариант значением свойства по умолчанию
data.sort number Порядок сортировки внутри свойства
data.xmlId string | null Внешний код. null, если код не задан
meta object Необязательные дополнительные сведения
meta.warnings object[] Предупреждения о полях запроса, если они есть
meta.warnings[].code string Код предупреждения
meta.warnings[].message string Пояснение к предупреждению
meta.warnings[].field string Поле, к которому относится предупреждение

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

201 — вариант создан:

JSON 
{
  "success": true,
  "data": {
    "def": false,
    "id": 1769,
    "propertyId": 295,
    "sort": 100,
    "value": "Дополнительный вариант",
    "xmlId": "EXTRA-20261013"
  }
}

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

422 — вариант с таким внешним кодом уже существует:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Запись со значением \"Внешний код\", равным \"EXTRA-20261013\", уже есть в базе данных",
    "b24Code": "BX_INVALID_VALUE"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Некорректный тип или форма поля запроса
400 MISSING_REQUIRED_FIELDS Не передано одно из обязательных полей: propertyId, value, xmlId
400 READONLY_FIELD В теле передан id, доступный только для чтения
422 BITRIX_ERROR Отказ Битрикс24: повторяющийся xmlId, свойство другого типа или свойство вне товарного каталога. Причина — в error.message
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
403 WRITE_BLOCKED_READONLY_KEY API-ключ разрешает только чтение
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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