Add Delivery Service sale.delivery.extra.service.add

Scope: sale, delivery

Who can execute the method: administrator

This method adds a delivery service.

Method Parameters

Required parameters are marked with *

Name `type`	Description
DELIVERY_ID* `sale_delivery_service.ID`	Identifier of the delivery service to which the created service will be linked. You can obtain the identifiers of delivery services using the sale.delivery.getlist method.
TYPE* `string`	Type of service. Possible values: `enum` — list (selecting an option from a pre-defined list) `checkbox` — single service (e.g., door delivery) `quantity` — quantitative service (e.g., required number of movers)
NAME* `string`	Name of the service
ACTIVE `string`	Indicator of service activity. Possible values: `Y` — yes `N` — no If the value is not provided, `N` is used by default.
CODE `string`	Symbolic code of the service
SORT `integer`	Sorting
DESCRIPTION `string`	Description of the service
PRICE `double`	Cost of the service in the currency of the delivery service. This field is relevant only for services of type `single service (checkbox)` and `quantitative service (quantity)`.
ITEMS* `object[]`	List of available options for selection (detailed description provided below). This field is relevant only for services of type `list (enum)`.

ITEMS Parameter

Required parameters are marked with *

Name `type`	Description
TITLE* `string`	Name of the list option
CODE* `string`	Symbolic code of the list option
PRICE `double`	Cost of the service when selecting this option in the currency of the delivery service

Code Examples

How to Use Examples in Documentation

Adding a service with the type Quantitative Service:

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"DELIVERY_ID":197,"ACTIVE":"Y","CODE":"door_delivery","NAME":"Door Delivery","DESCRIPTION":"Door Delivery Description","TYPE":"checkbox","SORT":100,"PRICE":99.99}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.extra.service.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"DELIVERY_ID":197,"ACTIVE":"Y","CODE":"door_delivery","NAME":"Door Delivery","DESCRIPTION":"Door Delivery Description","TYPE":"checkbox","SORT":100,"PRICE":99.99,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.delivery.extra.service.add

try
        {
        	const response = await $b24.callMethod(
        		'sale.delivery.extra.service.add', {
        			DELIVERY_ID: 197,
        			ACTIVE: "Y",
        			CODE: "door_delivery",
        			NAME: "Door Delivery",
        			DESCRIPTION: "Door Delivery Description",
        			TYPE: "checkbox",
        			SORT: 100,
        			PRICE: 99.99,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.delivery.extra.service.add',
                    [
                        'DELIVERY_ID'  => 197,
                        'ACTIVE'       => "Y",
                        'CODE'         => "door_delivery",
                        'NAME'         => "Door Delivery",
                        'DESCRIPTION'  => "Door Delivery Description",
                        'TYPE'         => "checkbox",
                        'SORT'         => 100,
                        'PRICE'        => 99.99,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding extra service: ' . $e->getMessage();
        }

BX24.callMethod(
            'sale.delivery.extra.service.add', {
                DELIVERY_ID: 197,
                ACTIVE: "Y",
                CODE: "door_delivery",
                NAME: "Door Delivery",
                DESCRIPTION: "Door Delivery Description",
                TYPE: "checkbox",
                SORT: 100,
                PRICE: 99.99,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $params = [
            'DELIVERY_ID' => 197,
            'ACTIVE' => 'Y',
            'CODE' => 'door_delivery',
            'NAME' => 'Door Delivery',
            'DESCRIPTION' => 'Door Delivery Description',
            'TYPE' => 'checkbox',
            'SORT' => 100,
            'PRICE' => 99.99
        ];
        
        $result = CRest::call(
            'sale.delivery.extra.service.add',
            $params
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Adding a service with the type List:

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"DELIVERY_ID":198,"ACTIVE":"Y","CODE":"cargo_type","NAME":"Cargo Type","DESCRIPTION":"Cargo Type Description","TYPE":"enum","SORT":100,"ITEMS":[{"TITLE":"Small Package(s)","CODE":"small_package","PRICE":129.99},{"TITLE":"Documents","CODE":"documents","PRICE":69.99}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.extra.service.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"DELIVERY_ID":198,"ACTIVE":"Y","CODE":"cargo_type","NAME":"Cargo Type","DESCRIPTION":"Cargo Type Description","TYPE":"enum","SORT":100,"ITEMS":[{"TITLE":"Small Package(s)","CODE":"small_package","PRICE":129.99},{"TITLE":"Documents","CODE":"documents","PRICE":69.99}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.delivery.extra.service.add

try
        {
        	const response = await $b24.callMethod(
        		'sale.delivery.extra.service.add', {
        			DELIVERY_ID: 198,
        			ACTIVE: "Y",
        			CODE: "cargo_type",
        			NAME: "Cargo Type",
        			DESCRIPTION: "Cargo Type Description",
        			TYPE: "enum",
        			SORT: 100,
        			ITEMS: [{
        					TITLE: "Small Package(s)",
        					CODE: "small_package",
        					PRICE: 129.99,
        				},
        				{
        					TITLE: "Documents",
        					CODE: "documents",
        					PRICE: 69.99,
        				},
        			],
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.delivery.extra.service.add',
                    [
                        'DELIVERY_ID'  => 198,
                        'ACTIVE'       => "Y",
                        'CODE'         => "cargo_type",
                        'NAME'         => "Cargo Type",
                        'DESCRIPTION'  => "Cargo Type Description",
                        'TYPE'         => "enum",
                        'SORT'         => 100,
                        'ITEMS'        => [
                            [
                                'TITLE' => "Small Package(s)",
                                'CODE'  => "small_package",
                                'PRICE' => 129.99,
                            ],
                            [
                                'TITLE' => "Documents",
                                'CODE'  => "documents",
                                'PRICE' => 69.99,
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding extra service: ' . $e->getMessage();
        }

BX24.callMethod(
            'sale.delivery.extra.service.add', {
                DELIVERY_ID: 198,
                ACTIVE: "Y",
                CODE: "cargo_type",
                NAME: "Cargo Type",
                DESCRIPTION: "Cargo Type Description",
                TYPE: "enum",
                SORT: 100,
                ITEMS: [{
                        TITLE: "Small Package(s)",
                        CODE: "small_package",
                        PRICE: 129.99,
                    },
                    {
                        TITLE: "Documents",
                        CODE: "documents",
                        PRICE: 69.99,
                    },
                ],
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.delivery.extra.service.add',
            [
                'DELIVERY_ID' => 198,
                'ACTIVE' => "Y",
                'CODE' => "cargo_type",
                'NAME' => "Cargo Type",
                'DESCRIPTION' => "Cargo Type Description",
                'TYPE' => "enum",
                'SORT' => 100,
                'ITEMS' => [
                    [
                        'TITLE' => "Small Package(s)",
                        'CODE' => "small_package",
                        'PRICE' => 129.99,
                    ],
                    [
                        'TITLE' => "Documents",
                        'CODE' => "documents",
                        'PRICE' => 69.99,
                    ],
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": 128,
            "time": {
                "start": 1714204589.717545,
                "finish": 1714204589.95374,
                "duration": 0.23619484901428223,
                "processing": 0.031846046447753906,
                "date_start": "2024-04-27T10:56:29+02:00",
                "date_finish": "2024-04-27T10:56:29+02:00"
            }
        }

Returned Data

Name `type`	Description
result `sale_delivery_extra_service.ID`	Identifier of the added service
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 400, 403

{
            "error":"ERROR_CHECK_FAILURE",
            "error_description":"Parameter DELIVERY_ID 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_EXTRA_SERVICE_ADD`	Error when trying to add a service	`400`
`ERROR_DELIVERY_NOT_FOUND`	Delivery service with the specified identifier not found	`400`
`ACCESS_DENIED`	Insufficient rights to add a delivery service	`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

Update Delivery Service

Add Delivery Service sale.delivery.extra.service.add

Method ParametersMethod Parameters

ITEMS ParameterITEMS Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning