Свойства позиций корзины

Свойства конкретной позиции корзины: название, значение, символьный код и порядок сортировки.

Битрикс24 API: sale.basketproperties.* Скоуп: sale

Операции

• Создать свойство позиции корзины — POST /v1/basket-item-properties
• Список свойств позиций корзины — GET /v1/basket-item-properties
• Получить свойство позиции корзины — GET /v1/basket-item-properties/:id
• Обновить свойство позиции корзины — PATCH /v1/basket-item-properties/:id
• Удалить свойство позиции корзины — DELETE /v1/basket-item-properties/:id
• Поиск свойств позиций корзины — POST /v1/basket-item-properties/search
• Поля свойства позиции корзины — GET /v1/basket-item-properties/fields
• Агрегация свойств позиций корзины — POST /v1/basket-item-properties/aggregate

Ключевые поля

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

Полный список полей — GET /v1/basket-item-properties/fields.

Что нужно знать перед работой

1. Чтение в карточке позиции и запись разделены. GET /v1/basket-items/:id возвращает свойства в поле properties, доступном только для чтения. Для создания, изменения и удаления используйте методы этого раздела.
2. Свойства заказа выбираются через позиции корзины. Получите ID позиций через GET /v1/basket-items с фильтром по orderId. Источник orderId — GET /v1/orders. Затем передайте ID позиций в фильтре basketId списка или поиска.
3. Частичное изменение сохраняет неуказанные поля. Если в PATCH пропущены name, code или value, Вайбкод перечитывает свойство и подставляет сохранённые значения. В пакетном обновлении передавайте все три поля явно для каждого свойства. Формат — Пакетные вызовы.
4. Создание и удаление свойства сохраняют заказ. У заказа, которому принадлежит позиция корзины, обновляются dateUpdate и version.

Типичный сценарий

1. Выбрать позицию корзины и получить её id: GET /v1/basket-items.
2. Проверить её свойства фильтром по basketId: GET /v1/basket-item-properties.
3. Создать свойство с basketId, name, value и code: POST /v1/basket-item-properties.
4. Прочитать свойство по полученному id: GET /v1/basket-item-properties/:id.
5. Изменить значение: PATCH /v1/basket-item-properties/:id.
6. Когда свойство больше не нужно, удалить его: DELETE /v1/basket-item-properties/:id.

Лимиты

Лимит	Значение
Записей на запрос списка или поиска	limit от 1 до 5000, по умолчанию 50. Следующие записи запрашиваются через offset. См. Список свойств позиций корзины и Поиск свойств позиций корзины
Автоматическая пагинация	При limit > 50 Вайбкод читает страницы Битрикс24 по 50 записей и объединяет их в один ответ. См. Список
Пакетные вызовы	POST /v1/batch и POST /v1/basket-item-properties/batch. По умолчанию до 500 элементов для записи и до 50 вызовов для чтения. Настройки платформы могут менять лимиты. Формат — Пакетные вызовы
Частота запросов	Общий лимит API Вайбкод — см. Лимиты и оптимизация

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

• Позиции корзины
• Заказы
• Синтаксис фильтрации
• API сущностей
• Пакетные вызовы