Add Delivery Service Handler sale.delivery.handler.add

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: sale

Who can execute the method: CRM administrator

The method sale.delivery.handler.add 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)

JS (TS)

JS (UMD)

Python

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

// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<number>({
            method: 'sale.delivery.handler.add',
            params: {
              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' },
              ],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Added delivery handler, ID:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function addDeliveryHandler() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.delivery.handler.add',
                params: {
                  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' },
                  ],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Added delivery handler, ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addDeliveryHandler)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        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",
            },
        ]
        
        try:
            bitrix_response = client.sale.delivery.handler.add(
                code='uber',
                name='Uber',
                settings=settings,
                profiles=profiles,
                sort=250,
                description='Uber Description',
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected 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>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sale.delivery.handler.add", b24.Params{
        	"CODE":        "uber",
        	"NAME":        "Uber",
        	"DESCRIPTION": "Uber Description",
        	"SORT":        250,
        	"SETTINGS": b24.Params{
        		"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": []b24.Params{
        			{
        				"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": b24.Params{
        					"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": []b24.Params{
        		{
        			"NAME":        "Taxi",
        			"CODE":        "TAXI",
        			"DESCRIPTION": "Taxi Delivery",
        		},
        		{
        			"NAME":        "Cargo",
        			"CODE":        "CARGO",
        			"DESCRIPTION": "Cargo Delivery",
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("sale.delivery.handler.add: %w", err)
        }
        
        var newID b24.ID
        if err := json.Unmarshal(res.Result, &newID); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("id:", newID)

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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

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: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

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

Was the article helpful?

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