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

Поля свойства позиции корзины

GET /v1/basket-item-properties/fields

Описывает поля свойства позиции корзины для создания, изменения, выборки и фильтрации, а также доступные поля группировки.

Параметры

Параметр Тип По умолч. Описание
refresh (query) string false Передайте true, чтобы получить метаданные без кэша

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/basket-item-properties/fields" \
  -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/fields', {
  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/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Метаданные свойства позиции корзины
data.fields object Описание полей. Ключ — имя поля, значение — его свойства
data.fields.<field>.type string Тип значения: number или string
data.fields.<field>.readonly boolean true — поле только для чтения
data.fields.<field>.createOnly boolean Приходит со значением true у basketId, задаваемого только при создании
data.fields.<field>.required boolean Приходит со значением true у обязательных при создании полей basketId, name, value, code
data.fields.<field>.nullable boolean Приходит со значением true у value, code, xmlId, допускающих null
data.fields.<field>.label string Название поля
data.fields.<field>.description string Описание поля
data.aggregatable array Поля для groupBy в агрегации: basketId, code
data.batch array Операции пакетной записи: create, update, delete

Поля свойства позиции корзины

Полный набор полей из схемы. Колонка RO — поле только для чтения.

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

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": {
        "type": "number",
        "readonly": true,
        "label": "ID",
        "description": "ID."
      },
      "basketId": {
        "type": "number",
        "readonly": false,
        "createOnly": true,
        "required": true,
        "label": "ID позиции корзины",
        "description": "ID позиции корзины."
      },
      "name": {
        "type": "string",
        "readonly": false,
        "required": true,
        "label": "Название",
        "description": "Название."
      },
      "value": {
        "type": "string",
        "readonly": false,
        "required": true,
        "nullable": true,
        "label": "Значение",
        "description": "Значение."
      },
      "code": {
        "type": "string",
        "readonly": false,
        "required": true,
        "nullable": true,
        "label": "Код",
        "description": "Код."
      },
      "sort": {
        "type": "number",
        "readonly": false,
        "label": "Порядок сортировки",
        "description": "Порядок сортировки."
      },
      "xmlId": {
        "type": "string",
        "readonly": false,
        "nullable": true,
        "label": "Внешний идентификатор",
        "description": "Внешний идентификатор."
      }
    },
    "aggregatable": [
      "basketId",
      "code"
    ],
    "batch": [
      "create",
      "update",
      "delete"
    ]
  }
}

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

401 — API-ключ не передан:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}

Ошибки

HTTP Код Описание
403 SCOPE_DENIED У API-ключа нет скоупа sale
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING Нет настроенных токенов доступа к Битрикс24
429 RATE_LIMITED Превышен лимит запросов. Повторите после срока из заголовка Retry-After

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

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