Delivery Service Handlers in Online Stores: Overview of Methods

Delivery service handlers are templates for connecting delivery services to Bitrix24. Handlers automatically calculate delivery costs, create orders, and track statuses.

Quick navigation: all methods

Typical use-cases and scenarios

URLs in the Delivery Service Handler

When creating a delivery service handler, specify the URLs:

  • CALCULATE_URL — URL for calculating delivery costs, a required parameter. Data about the package, including products, destination address, and other parameters, will be sent to this address. In response, you will receive information about the delivery cost. See the request and response format in the article Calculating Delivery Costs.
  • CREATE_DELIVERY_REQUEST_URL — data about the package is sent to this address, and the delivery service processes the order. See the request and response format in the article Creating a Delivery Order.
  • CANCEL_DELIVERY_REQUEST_URL — use this URL if the order needs to be canceled. Data about the package is sent to this address, and the delivery service cancels the previously created order. See the request and response format in the article Canceling a Delivery Order.

Connection of Delivery Service Handlers with Other Objects

Delivery Services. Create a delivery service using the methods sale.delivery.*, specifying the symbolic code of the delivery service handler. You can obtain the symbolic codes of handlers using the method sale.delivery.handler.list.

Transport Requests. If you want to track changes in delivery status, set the option HAS_CALLBACK_TRACKING_SUPPORT to Y. Configure notifications using the method sale.delivery.request.sendmessage.

Overview of Methods

Scope: sale

Who can perform the methods: administrator

Method

Description

sale.delivery.handler.add

Adds a delivery service handler

sale.delivery.handler.update

Modifies a delivery service handler

sale.delivery.handler.list

Returns a list of delivery service handlers

sale.delivery.handler.delete

Deletes a delivery service handler