Add Delivery Service Handler sale.delivery.handler.add

Scope: sale

Who can execute the method: CRM administrator

This method adds a delivery service handler.

Method Parameters

Required parameters are marked with *

Name `type`	Description
NAME* `string`	Name of the delivery service handler
CODE* `string`	Symbolic code of the delivery service handler
SORT `integer`	Sorting
DESCRIPTION `integer`	Description of the delivery service handler
SETTINGS* `object`	Object containing information about the settings of the delivery service handler (detailed description provided below)
PROFILES* `object[]`	Array containing a list of delivery profile objects (detailed description provided below). It is implied that the delivery service handler must have at least 1 profile

SETTINGS Parameter

Required parameters are marked with *

Name `type`	Description
CALCULATE_URL* `string`	URL for calculating delivery cost. Data about the shipment (what to deliver, where, and how) is sent to this URL, for which the delivery cost needs to be calculated in the response. The request and response format is detailed in the documentation for the webhook Calculate Delivery Cost
CREATE_DELIVERY_REQUEST_URL `string`	URL for creating a delivery order. Data about the shipment (what to deliver, where, and how) is sent to this URL, for which an order needs to be placed with the delivery service. The request and response format is detailed in the documentation for the webhook Create Delivery Order
CANCEL_DELIVERY_REQUEST_URL `string`	URL for canceling a delivery order. Data about the shipment (what to deliver, where, and how) is sent to this URL, for which the order needs to be canceled with the delivery service. The request and response format is detailed in the documentation for the webhook Cancel Delivery Order
HAS_CALLBACK_TRACKING_SUPPORT `string`	Indicator of whether the delivery service will send notifications about the status of the delivery order (see method `sale.delivery.request.sendmessage`). If event support is indicated, a delivery activity will be created in the manager's interface when ordering delivery, into which changes related to the current delivery status can be transmitted. Possible values: `Y` — support available `N` — no support
CONFIG `object[]`	Array of objects with available settings for the delivery service created using this handler (detailed description provided below)

CONFIG Parameter

Required parameters are marked with *

Name `type`	Description
TYPE* `string`	Type of the setting field Possible values: `STRING` — string `Y/N` — checkbox (yes / no) `NUMBER` — number `ENUM` — list `DATE` — date `LOCATION` — location
CODE* `string`	Symbolic code of the setting
NAME* `string`	Name of the setting
OPTIONS `object`	List of options for selection. Object in the format `key=value`. Where key is the option code, and value is the option. Example: `{ "Option1Code": "Option1Value", "Option2Code": "Option2Value", "Option3Code": "Option3Value" }` This parameter is relevant only for settings of type `ENUM`

PROFILES Parameter

Required parameters are marked with *

Name `type`	Description
NAME* `string`	Name of the delivery service handler profile
CODE* `string`	Symbolic code of the delivery service handler profile
DESCRIPTION `string`	Description of the delivery service handler profile

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CODE":"uber","NAME":"Uber","DESCRIPTION":"Uber Description","SORT":250,"SETTINGS":{"CALCULATE_URL":"http://gateway.bx/calculate.php","CREATE_DELIVERY_REQUEST_URL":"http://gateway.bx/create_delivery_request.php","CANCEL_DELIVERY_REQUEST_URL":"http://gateway.bx/cancel_delivery_request.php","HAS_CALLBACK_TRACKING_SUPPORT":"Y","CONFIG":[{"TYPE":"STRING","CODE":"SETTING_1","NAME":"String Example"},{"TYPE":"Y/N","CODE":"SETTING_2","NAME":"Checkbox Example"},{"TYPE":"NUMBER","CODE":"SETTING_3","NAME":"Number Example"},{"TYPE":"ENUM","CODE":"SETTING_4","NAME":"Enum Example","OPTIONS":{"Option1Code":"Option1Value","Option2Code":"Option2Value","Option3Code":"Option3Value","Option4Code":"Option4Value","Option5Code":"Option5Value"}},{"TYPE":"DATE","CODE":"SETTING_5","NAME":"Date Example"},{"TYPE":"LOCATION","CODE":"SETTING_6","NAME":"Location Example"}]},"PROFILES":[{"NAME":"Taxi","CODE":"TAXI","DESCRIPTION":"Taxi Delivery"},{"NAME":"Cargo","CODE":"CARGO","DESCRIPTION":"Cargo Delivery"}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.handler.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CODE":"uber","NAME":"Uber","DESCRIPTION":"Uber Description","SORT":250,"SETTINGS":{"CALCULATE_URL":"http://gateway.bx/calculate.php","CREATE_DELIVERY_REQUEST_URL":"http://gateway.bx/create_delivery_request.php","CANCEL_DELIVERY_REQUEST_URL":"http://gateway.bx/cancel_delivery_request.php","HAS_CALLBACK_TRACKING_SUPPORT":"Y","CONFIG":[{"TYPE":"STRING","CODE":"SETTING_1","NAME":"String Example"},{"TYPE":"Y/N","CODE":"SETTING_2","NAME":"Checkbox Example"},{"TYPE":"NUMBER","CODE":"SETTING_3","NAME":"Number Example"},{"TYPE":"ENUM","CODE":"SETTING_4","NAME":"Enum Example","OPTIONS":{"Option1Code":"Option1Value","Option2Code":"Option2Value","Option3Code":"Option3Value","Option4Code":"Option4Value","Option5Code":"Option5Value"}},{"TYPE":"DATE","CODE":"SETTING_5","NAME":"Date Example"},{"TYPE":"LOCATION","CODE":"SETTING_6","NAME":"Location Example"}]},"PROFILES":[{"NAME":"Taxi","CODE":"TAXI","DESCRIPTION":"Taxi Delivery"},{"NAME":"Cargo","CODE":"CARGO","DESCRIPTION":"Cargo Delivery"}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.delivery.handler.add

try
        {
        	const response = await $b24.callMethod(
        		'sale.delivery.handler.add', {
        			CODE: "uber",
        			NAME: "Uber",
        			DESCRIPTION: "Uber Description",
        			SORT: 250,
        			SETTINGS: {
        				CALCULATE_URL: "http://gateway.bx/calculate.php",
        				CREATE_DELIVERY_REQUEST_URL: "http://gateway.bx/create_delivery_request.php",
        				CANCEL_DELIVERY_REQUEST_URL: "http://gateway.bx/cancel_delivery_request.php",
        				HAS_CALLBACK_TRACKING_SUPPORT: "Y",
        				CONFIG: [{
        						TYPE: "STRING",
        						CODE: "SETTING_1",
        						NAME: "String Example",
        					},
        					{
        						TYPE: "Y/N",
        						CODE: "SETTING_2",
        						NAME: "Checkbox Example",
        					},
        					{
        						TYPE: "NUMBER",
        						CODE: "SETTING_3",
        						NAME: "Number Example",
        					},
        					{
        						TYPE: "ENUM",
        						CODE: "SETTING_4",
        						NAME: "Enum Example",
        						OPTIONS: {
        							"Option1Code": "Option1Value",
        							"Option2Code": "Option2Value",
        							"Option3Code": "Option3Value",
        							"Option4Code": "Option4Value",
        							"Option5Code": "Option5Value",
        						},
        					},
        					{
        						TYPE: "DATE",
        						CODE: "SETTING_5",
        						NAME: "Date Example",
        					},
        					{
        						TYPE: "LOCATION",
        						CODE: "SETTING_6",
        						NAME: "Location Example",
        					},
        				],
        			},
        			PROFILES: [{
        					NAME: "Taxi",
        					CODE: "TAXI",
        					DESCRIPTION: "Taxi Delivery",
        				},
        				{
        					NAME: "Cargo",
        					CODE: "CARGO",
        					DESCRIPTION: "Cargo Delivery",
        				},
        			],
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.delivery.handler.add',
                    [
                        'CODE'        => "uber",
                        'NAME'        => "Uber",
                        'DESCRIPTION' => "Uber Description",
                        'SORT'        => 250,
                        'SETTINGS'    => [
                            'CALCULATE_URL'                => "http://gateway.bx/calculate.php",
                            'CREATE_DELIVERY_REQUEST_URL'  => "http://gateway.bx/create_delivery_request.php",
                            'CANCEL_DELIVERY_REQUEST_URL'  => "http://gateway.bx/cancel_delivery_request.php",
                            'HAS_CALLBACK_TRACKING_SUPPORT' => "Y",
                            'CONFIG'                       => [
                                [
                                    'TYPE' => "STRING",
                                    'CODE' => "SETTING_1",
                                    'NAME' => "String Example",
                                ],
                                [
                                    'TYPE' => "Y/N",
                                    'CODE' => "SETTING_2",
                                    'NAME' => "Checkbox Example",
                                ],
                                [
                                    'TYPE' => "NUMBER",
                                    'CODE' => "SETTING_3",
                                    'NAME' => "Number Example",
                                ],
                                [
                                    'TYPE'    => "ENUM",
                                    'CODE'    => "SETTING_4",
                                    'NAME'    => "Enum Example",
                                    'OPTIONS' => [
                                        "Option1Code" => "Option1Value",
                                        "Option2Code" => "Option2Value",
                                        "Option3Code" => "Option3Value",
                                        "Option4Code" => "Option4Value",
                                        "Option5Code" => "Option5Value",
                                    ],
                                ],
                                [
                                    'TYPE' => "DATE",
                                    'CODE' => "SETTING_5",
                                    'NAME' => "Date Example",
                                ],
                                [
                                    'TYPE' => "LOCATION",
                                    'CODE' => "SETTING_6",
                                    'NAME' => "Location Example",
                                ],
                            ],
                        ],
                        'PROFILES'    => [
                            [
                                'NAME'        => "Taxi",
                                'CODE'        => "TAXI",
                                'DESCRIPTION' => "Taxi Delivery",
                            ],
                            [
                                'NAME'        => "Cargo",
                                'CODE'        => "CARGO",
                                'DESCRIPTION' => "Cargo Delivery",
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding delivery handler: ' . $e->getMessage();
        }

BX24.callMethod(
            'sale.delivery.handler.add', {
                CODE: "uber",
                NAME: "Uber",
                DESCRIPTION: "Uber Description",
                SORT: 250,
                SETTINGS: {
                    CALCULATE_URL: "http://gateway.bx/calculate.php",
                    CREATE_DELIVERY_REQUEST_URL: "http://gateway.bx/create_delivery_request.php",
                    CANCEL_DELIVERY_REQUEST_URL: "http://gateway.bx/cancel_delivery_request.php",
                    HAS_CALLBACK_TRACKING_SUPPORT: "Y",
                    CONFIG: [{
                            TYPE: "STRING",
                            CODE: "SETTING_1",
                            NAME: "String Example",
                        },
                        {
                            TYPE: "Y/N",
                            CODE: "SETTING_2",
                            NAME: "Checkbox Example",
                        },
                        {
                            TYPE: "NUMBER",
                            CODE: "SETTING_3",
                            NAME: "Number Example",
                        },
                        {
                            TYPE: "ENUM",
                            CODE: "SETTING_4",
                            NAME: "Enum Example",
                            OPTIONS: {
                                "Option1Code": "Option1Value",
                                "Option2Code": "Option2Value",
                                "Option3Code": "Option3Value",
                                "Option4Code": "Option4Value",
                                "Option5Code": "Option5Value",
                            },
                        },
                        {
                            TYPE: "DATE",
                            CODE: "SETTING_5",
                            NAME: "Date Example",
                        },
                        {
                            TYPE: "LOCATION",
                            CODE: "SETTING_6",
                            NAME: "Location Example",
                        },
                    ],
                },
                PROFILES: [{
                        NAME: "Taxi",
                        CODE: "TAXI",
                        DESCRIPTION: "Taxi Delivery",
                    },
                    {
                        NAME: "Cargo",
                        CODE: "CARGO",
                        DESCRIPTION: "Cargo Delivery",
                    },
                ],
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.delivery.handler.add',
            [
                'CODE' => "uber",
                'NAME' => "Uber",
                'DESCRIPTION' => "Uber Description",
                'SORT' => 250,
                'SETTINGS' => [
                    'CALCULATE_URL' => "http://gateway.bx/calculate.php",
                    'CREATE_DELIVERY_REQUEST_URL' => "http://gateway.bx/create_delivery_request.php",
                    'CANCEL_DELIVERY_REQUEST_URL' => "http://gateway.bx/cancel_delivery_request.php",
                    'HAS_CALLBACK_TRACKING_SUPPORT' => "Y",
                    'CONFIG' => [
                        ['TYPE' => "STRING", 'CODE' => "SETTING_1", 'NAME' => "String Example"],
                        ['TYPE' => "Y/N", 'CODE' => "SETTING_2", 'NAME' => "Checkbox Example"],
                        ['TYPE' => "NUMBER", 'CODE' => "SETTING_3", 'NAME' => "Number Example"],
                        [
                            'TYPE' => "ENUM",
                            'CODE' => "SETTING_4",
                            'NAME' => "Enum Example",
                            'OPTIONS' => [
                                "Option1Code" => "Option1Value",
                                "Option2Code" => "Option2Value",
                                "Option3Code" => "Option3Value",
                                "Option4Code" => "Option4Value",
                                "Option5Code" => "Option5Value",
                            ],
                        ],
                        ['TYPE' => "DATE", 'CODE' => "SETTING_5", 'NAME' => "Date Example"],
                        ['TYPE' => "LOCATION", 'CODE' => "SETTING_6", 'NAME' => "Location Example"],
                    ],
                ],
                'PROFILES' => [
                    ['NAME' => "Taxi", 'CODE' => "TAXI", 'DESCRIPTION' => "Taxi Delivery"],
                    ['NAME' => "Cargo", 'CODE' => "CARGO", 'DESCRIPTION' => "Cargo Delivery"],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Successful Response

HTTP status: 200

{
           "result":14,
           "time":{
              "start":1713872092.378366,
              "finish":1713872092.691408,
              "duration":0.31304192543029785,
              "processing":0.015096187591552734,
              "date_start":"2024-04-23T14:34:52+02:00",
              "date_finish":"2024-04-23T14:34:52+02:00"
           }
        }

Returned Data

Name `type`	Description
result `sale_delivery_handler.ID`	Identifier of the delivery service handler
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 400, 403

{
           "error":"ERROR_CHECK_FAILURE",
           "error_description":"Parameter CODE is not defined"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Status
`ERROR_CHECK_FAILURE`	Validation error of incoming parameters (details in the error description)	400
`ERROR_HANDLER_ADD`	Error when trying to add a delivery service handler	400
`ERROR_HANDLER_ALREADY_EXIST`	A delivery service handler with the specified code `CODE` already exists	400
`ACCESS_DENIED`	Insufficient rights to add a delivery service handler	403

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Remove Delivery Service Handler

Add Delivery Service Handler sale.delivery.handler.add

Method ParametersMethod Parameters

SETTINGS ParameterSETTINGS Parameter

CONFIG ParameterCONFIG Parameter

PROFILES ParameterPROFILES Parameter

Code ExamplesCode Examples

Successful ResponseSuccessful Response

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

SETTINGS Parameter

CONFIG Parameter

PROFILES Parameter

Code Examples

Successful Response

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning