Para agentes de IA: markdown desta página — /docs-content-en/entities/basket-item-properties.md índice da documentação — /llms.txt

Os artigos da documentação estão disponíveis atualmente em inglês.

Basket item properties

Properties of a specific basket item: name, value, symbolic code, and sort order.

Bitrix24 API: sale.basketproperties.* Scope: sale

Operations

Key fields

Field Type Description
Fieldid Typenumber DescriptionProperty ID. List: GET /v1/basket-item-properties. Read-only
FieldbasketId Typenumber DescriptionBasket item ID from GET /v1/basket-items. Required on creation, cannot be changed through PATCH
Fieldname Typestring DescriptionProperty name. Required on creation
Fieldvalue Typestring | null DescriptionProperty value. Required on creation
Fieldcode Typestring | null DescriptionProperty symbolic code. Required on creation
Fieldsort Typenumber DescriptionSort order of the property within the item
FieldxmlId Typestring | null DescriptionExternal ID

For the complete field list, see GET /v1/basket-item-properties/fields.

Before you start

  1. Reading properties in an item and writing them use separate methods. GET /v1/basket-items/:id returns properties in the read-only properties field. Use the methods in this section to create, update, and delete properties.
  2. Select an order's properties through its basket items. Get item IDs using GET /v1/basket-items with an orderId filter. Source of orderId: GET /v1/orders. Then pass the item IDs in the basketId filter of list or search.
  3. Partial updates preserve omitted fields. If PATCH omits name, code, or value, Vibecode reads the property and fills in the stored values. For batch updates, pass all three fields explicitly for each property. For the format, see Batch calls.
  4. Creating and deleting a property saves the order. The order that owns the basket item has its dateUpdate and version updated.

Typical workflow

  1. Select a basket item and get its id: GET /v1/basket-items.
  2. Check its properties with a basketId filter: GET /v1/basket-item-properties.
  3. Create a property with basketId, name, value, and code: POST /v1/basket-item-properties.
  4. Read the property by its returned id: GET /v1/basket-item-properties/:id.
  5. Update the value: PATCH /v1/basket-item-properties/:id.
  6. Delete the property when it is no longer needed: DELETE /v1/basket-item-properties/:id.

Limits

Limit Value
LimitRecords per list or search request Valuelimit from 1 to 5000, default 50. Use offset for the following records. See List basket item properties and Search basket item properties
LimitAutomatic pagination ValueWith limit > 50, Vibecode reads Bitrix24 pages of 50 records and merges them into one response. See List
LimitBatch calls ValuePOST /v1/batch and POST /v1/basket-item-properties/batch. Defaults: up to 500 items for writes and up to 50 calls for reads. Platform settings can change these limits. For the format, see Batch calls
LimitRequest rate ValueShared Vibecode API limit — see Limits and optimization

See also