For AI agents: markdown of this page — /docs-content-en/entities/basket-item-properties.md documentation index — /llms.txt
Basket item properties
Methods: sale.basketproperties.*. Scope: sale.
Operations
- Create:
POST /v1/basket-item-properties - List:
GET /v1/basket-item-properties - Get:
GET /v1/basket-item-properties/:id - Update:
PATCH /v1/basket-item-properties/:id - Delete:
DELETE /v1/basket-item-properties/:id - Search: Basket item properties:
POST /v1/basket-item-properties/search - Fields:
GET /v1/basket-item-properties/fields - Aggregate: Basket item properties:
POST /v1/basket-item-properties/aggregate
Usage notes
Properties of an individual basket item. To read them as part of the item card, use Basket items, where properties is read-only. Use this section to create, update, delete or list properties across items with a basketId filter. Creation requires basketId, name, value and code. basketId is read-only on PATCH. Missing basket item: 404; business refusal: 422. Bitrix24 saves the entire order when a property is written or deleted: discounts, the modification date and order automation may change. Prices and discounts depend on the Bitrix24 account settings.
Y/N flags accept and return booleans. Missing record: 404 ENTITY_NOT_FOUND. Business refusal: 422 with the Bitrix24 message. Empty POST: 400 MISSING_REQUIRED_FIELDS. A READONLY key cannot write (403). Lists support filter, select, sort, limit, offset; Bitrix24 pages contain 50 rows and V1 fetches more automatically when limit > 50.
POST /v1/batch, POST /v1/basket-item-properties/batch.
PATCH re-reads name, code and value, which Bitrix24 requires on every update, and fills in any you omit. In batch requests, supply these three fields explicitly.