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

Обновить свойство позиции корзины

PATCH /v1/basket-item-properties/:id

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

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID свойства. Источник: GET /v1/basket-item-properties

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

Передайте поля плоско в корне JSON, без обёртки fields.

Поле Тип Обяз. Описание
name string нет Название свойства
value string | null нет Значение свойства
code string | null нет Символьный код свойства
sort number нет Порядок сортировки
xmlId string | null нет Внешний идентификатор
id number нет ID свойства. Источник: GET /v1/basket-item-properties. RO. Только чтение, задаётся сервером.
basketId number нет ID позиции корзины. Источник: GET /v1/basket-items. Только при создании, не передавайте в PATCH.

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/basket-item-properties/1037" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Цвет",
  "code": "COLOR",
  "value": "Красный",
  "sort": 200,
  "xmlId": "color-red"
}'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/basket-item-properties/1037" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Цвет",
  "code": "COLOR",
  "value": "Красный",
  "sort": 200,
  "xmlId": "color-red"
}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/basket-item-properties/1037', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Цвет",
    "code": "COLOR",
    "value": "Красный",
    "sort": 200,
    "xmlId": "color-red"
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/basket-item-properties/1037', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Цвет",
    "code": "COLOR",
    "value": "Красный",
    "sort": 200,
    "xmlId": "color-red"
  }),
})

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

Поля ответа

Поле Тип Описание
success boolean true при успехе. HTTP-статус — 200
data object Обновлённое свойство позиции корзины
data.id number ID свойства. Источник: GET /v1/basket-item-properties
data.basketId number ID позиции корзины. Источник: GET /v1/basket-items
data.name string Название свойства
data.value string | null Значение свойства
data.code string | null Символьный код свойства
data.sort number Порядок сортировки
data.xmlId string | null Внешний идентификатор

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

JSON 
{
  "success": true,
  "data": {
    "basketId": 1001,
    "code": "COLOR",
    "id": 1037,
    "name": "Цвет",
    "sort": 200,
    "value": "Красный",
    "xmlId": "color-red"
  }
}

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

404 — свойство не найдено:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "basket property is not exists"
  }
}

Ошибки

HTTP Код Описание
400 READONLY_FIELD Передано поле id или basketId, которое нельзя изменить
400 EMPTY_UPDATE_BODY Тело запроса пустое
400 NO_RECOGNIZED_UPDATE_FIELDS В теле нет ни одного распознанного изменяемого поля
400 INVALID_PARAMS id в пути не является целым неотрицательным числом
404 ENTITY_NOT_FOUND Свойства с таким id нет или оно уже удалено
422 BITRIX_ERROR Битрикс24 отклонил операцию. Причина — в message
403 WRITE_BLOCKED_READONLY_KEY Ключ работает в режиме только для чтения
403 SCOPE_DENIED API-ключ не имеет скоупа sale
401 MISSING_API_KEY Не передан заголовок X-Api-Key
429 RATE_LIMITED Превышен лимит запросов

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

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

Если name, code или value не переданы, Вайбкод читает их текущие значения и подставляет перед записью. При изменении одного value остальные поля сохраняются.

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