Binding Order Properties in an Online Store: Overview of Methods
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Binding a property determines in which scenario the order field will be displayed to the customer during checkout. You can link properties to payment systems, delivery services, landing pages, and trading platforms.
Each binding is defined by a set of fields:
entityType— type of the binding objectentityId— identifier of the selected object typepropertyId— identifier of the order property
Quick navigation: all methods
How to Get Started with Property Binding
- Obtain the
propertyIdusing the sale.property.list method. - Define the object type in
entityType:P— payment systemD— deliveryL— landing pageT— trading platform
- Find the object identifier in
entityIdfor the selected type. - Check the available binding fields using the sale.propertyRelation.getFields method.
- Create the binding using the sale.propertyRelation.add method.
- Verify the current bindings with the sale.propertyRelation.list method.
- Remove unnecessary bindings using the sale.propertyRelation.deleteByFilter method.
Linking to Other Objects
Order Properties. The binding applies to a specific order property via the propertyId field. Working with order properties is done in the sale.property.* section.
Payment Systems. If entityType is P, the payment system identifier is passed in entityId. You can obtain it using the sale.paysystem.list method.
Delivery Services. For entityType = D, specify the delivery service identifier in entityId, which is returned by the sale.delivery.getlist method.
Order Sources. When the type is T, the trading platform identifier is used in entityId. A list of order sources is available through the sale.tradePlatform.list method.
Landing Pages. For binding with entityType = L, the landing page identifier is required in entityId. You can obtain the identifier using the landing.landing.getList method.
Overview of Methods
Scope:
saleWho can execute the methods: administrator
|
Method |
Description |
|
Adds a property binding |
|
|
Retrieves a list of property bindings |
|
|
Deletes a property binding |
|
|
Returns the fields of the property binding |