Add Delivery Service sale.delivery.extra.service.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: delivery

Who can execute the method: administrator

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

JS (TS)

JS (UMD)

Python

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

// 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.extra.service.add',
            params: {
              DELIVERY_ID: 197,
              ACTIVE: 'Y',
              CODE: 'door_delivery',
              NAME: 'Door Delivery',
              DESCRIPTION: 'Door Delivery Description',
              TYPE: 'checkbox',
              SORT: 100,
              PRICE: 99.99,
            },
            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 extra service 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 addExtraService() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.delivery.extra.service.add',
                params: {
                  DELIVERY_ID: 197,
                  ACTIVE: 'Y',
                  CODE: 'door_delivery',
                  NAME: 'Door Delivery',
                  DESCRIPTION: 'Door Delivery Description',
                  TYPE: 'checkbox',
                  SORT: 100,
                  PRICE: 99.99,
                },
                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 extra service ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addExtraService)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.sale.delivery.extra.service.add(
                delivery_id=197,
                type='checkbox',
                name='Door Delivery',
                active=True,
                code='door_delivery',
                sort=100,
                description='Door Delivery Description',
                price=99.99,
                items='[{',
            ).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.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>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sale.delivery.extra.service.add", b24.Params{
        	"DELIVERY_ID": 197,
        	"ACTIVE":      "Y",
        	"CODE":        "door_delivery",
        	"NAME":        "Door Delivery",
        	"DESCRIPTION": "Door Delivery Description",
        	"TYPE":        "checkbox",
        	"SORT":        100,
        	"PRICE":       99.99,
        })
        if err != nil {
        	return fmt.Errorf("sale.delivery.extra.service.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)

Adding a service with the type List:

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 '{"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

// 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.extra.service.add',
            params: {
              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,
                },
              ],
            },
            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 extra service 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 addExtraService() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.delivery.extra.service.add',
                params: {
                  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,
                    },
                  ],
                },
                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 extra service ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addExtraService)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.sale.delivery.extra.service.add(
                delivery_id=198,
                type="enum",
                name="Cargo Type",
                active="Y",
                code="cargo_type",
                sort=100,
                description="Cargo Type Description",
                items=[
                    {
                        "TITLE": "Small Package(s)",
                        "CODE": "small_package",
                        "PRICE": 129.99,
                    },
                    {
                        "TITLE": "Documents",
                        "CODE": "documents",
                        "PRICE": 69.99,
                    },
                ],
            ).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.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>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sale.delivery.extra.service.add", b24.Params{
        	"DELIVERY_ID": 198,
        	"ACTIVE":      "Y",
        	"CODE":        "cargo_type",
        	"NAME":        "Cargo Type",
        	"DESCRIPTION": "Cargo Type Description",
        	"TYPE":        "enum",
        	"SORT":        100,
        	"ITEMS": []b24.Params{
        		{
        			"TITLE": "Small Package(s)",
        			"CODE":  "small_package",
        			"PRICE": 129.99,
        		},
        		{
        			"TITLE": "Documents",
        			"CODE":  "documents",
        			"PRICE": 69.99,
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("sale.delivery.extra.service.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)

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 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_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: 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

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