Deliveries in Universal CRM Objects: 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.
The methods crm.item.delivery.* work with deliveries associated with universal CRM objects. For example, you can retrieve a list of deliveries for a deal or get details about a specific shipment by invoice.
This is necessary to integrate logistics services with CRM data. Bitrix24 stores delivery information separately from the main fields of the object but links them through identifiers.
The methods crm.item.delivery.* are read-only: they retrieve a delivery and a list of deliveries, but do not create, modify, or delete them. Deliveries themselves are created in the Bitrix24 interface while working with a CRM object card. A delivery can be linked to a payment using the crm.item.payment.delivery.* methods.
Quick navigation: all methods
Linking Deliveries to CRM Objects
CRM Object. The connection is made through the pair of parameters entityTypeId and entityId. The first indicates the type of CRM object, while the second refers to a specific element of that type. Deliveries appear for objects that have an order attached — deals with entityTypeId = 2 and invoices with entityTypeId = 31. If the object has no orders, the crm.item.delivery.list method returns an empty list.
Delivery Service. Each delivery record contains a reference to a configured delivery service. The delivery service identifier can be obtained using the sale.delivery.getlist method. In the current section, deliveryId is returned by the crm.item.delivery.list and crm.item.delivery.get methods.
Payments. A single delivery can be partially or fully paid. Delivery items within a payment are handled by the crm.item.payment.delivery.* methods, and the payments themselves by the crm.item.payment.* methods.
How to Work with Deliveries in CRM
- Determine the CRM object type
entityTypeIdand its identifierentityId. - Retrieve the list of deliveries associated with the object using the crm.item.delivery.list method.
- Select the desired delivery from the list and obtain information using its
idwith the crm.item.delivery.get method.
Overview of Methods
Scope:
crmWho can perform the methods: depending on the method
|
Method |
Description |
|
Returns information about the delivery by identifier |
|
|
Returns a list of deliveries for the CRM object |