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

Получить свойство позиции корзины

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

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

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор свойства. Источник: GET /v1/basket-item-properties
select (query) string нет Поля через запятую. В data останутся только выбранные поля. Список: GET /v1/basket-item-properties/fields

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/basket-item-properties/1007" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/basket-item-properties/1007" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/basket-item-properties/1007', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/basket-item-properties/1007', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Свойство позиции корзины
data.id number Идентификатор свойства. Источник: GET /v1/basket-item-properties
data.basketId number Идентификатор позиции корзины. Источник: 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": "PRODUCT.XML_ID",
    "id": 1007,
    "name": "Product XML_ID",
    "sort": 100,
    "value": "6967",
    "xmlId": "bx_69e72bbf34260"
  }
}

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

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

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не является целым неотрицательным числом
404 ENTITY_NOT_FOUND Свойство с таким id не найдено
404 ENTITY_NOT_FOUND Запрос выполнился, но объект свойства не получен
422 BITRIX_ERROR Битрикс24 отклонил запрос. Причина указана в error.message
503 BITRIX_TIMEOUT Битрикс24 не ответил вовремя
502 BITRIX_UNAVAILABLE Нет соединения с Битрикс24
403 SCOPE_DENIED У API-ключа нет скоупа sale
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING Нет настроенных токенов доступа к Битрикс24
429 RATE_LIMITED Превышен лимит запросов. Повторите после срока из заголовка Retry-After

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

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