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

Изменить значение списочного свойства

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

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

Параметры

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

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

Передайте хотя бы одно изменяемое поле.

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

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/catalog-product-property-enums/1769" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":"Дополнительный вариант 2"}'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/catalog-product-property-enums/1769" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"value":"Дополнительный вариант 2"}'

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

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

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/1769', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    value: 'Дополнительный вариант 2',
  }),
})

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 Поле, к которому относится предупреждение

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

200 — вариант изменён:

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

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

404 — значение удалено, в запросе переданы propertyId и xmlId:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "productPropertyEnum does not exist."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Некорректный тип или форма поля запроса либо id в пути
400 EMPTY_UPDATE_BODY Тело запроса пустое
400 READONLY_FIELD В теле передан id, доступный только для чтения
404 ENTITY_NOT_FOUND Значения с указанным идентификатором нет
422 BITRIX_ERROR Отказ Битрикс24. Для удалённого значения без propertyId или xmlId приходит сообщение Required fields со списком недостающих полей
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
403 WRITE_BLOCKED_READONLY_KEY API-ключ разрешает только чтение
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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

Подстановка полей. При одиночном обновлении API читает текущую запись и подставляет propertyId и xmlId, если они не переданы. Явно переданные значения имеют приоритет.

В пакетных запросах подстановки нет. В каждом обновлении через POST /v1/batch или POST /v1/catalog-product-property-enums/batch явно передавайте propertyId и xmlId. Иначе операция отклоняется до обращения к Битрикс24.

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