Delivery Requests for Shipping Services: Overview of Methods

Delivery requests synchronize an order in Bitrix24 with the statuses and messages from an external shipping service. For example, you can update the tracking number, change the delivery date, or send a notification to the customer.

This is necessary to keep the information about the cargo movement up to date and to inform the participants in the delivery process.

Quick Navigation: all methods

Data Structure of the RequestData Structure of the Request

The method sale.delivery.request.update updates the request data through the parameters STATUS, PROPERTIES, and FINALIZE.

The PROPERTIES parameter transmits additional delivery data, while STATUS indicates the current state of the request. To completely replace the set of properties, use OVERWRITE_PROPERTIES=Y.

The method sale.delivery.request.sendmessage creates notifications for the request. Specify the recipient using the ADDRESSEE parameter, and the text, title, and status of the message in the MESSAGE object.

Linking Delivery Requests with Other ObjectsLinking Delivery Requests with Other Objects

Shipping Services. A delivery request is linked to a specific shipping service by DELIVERY_ID. Manage services through the methods sale.delivery.*.

Order and Shipments. The request is associated with an order through shipments. The request identifier is generated by the external system in the scenario Creating a Delivery Order.

How to Work with Delivery RequestsHow to Work with Delivery Requests

1. Obtain the DELIVERY_ID of the shipping service using the method sale.delivery.getlist.
2. Use the REQUEST_ID that the external system returns in the webhook Creating a Delivery Order.
3. Update the status and properties of the request using the method sale.delivery.request.update.
4. Send notifications to the manager or recipient using the method sale.delivery.request.sendmessage.
5. Delete any outdated requests using the method sale.delivery.request.delete.

Overview of MethodsOverview of Methods

Scope: sale, delivery

Who can perform the methods: administrator

Method	Description
sale.delivery.request.update	Updates the delivery request
sale.delivery.request.sendmessage	Creates notifications for the delivery request
sale.delivery.request.delete	Deletes the delivery request