Добавить услугу службы доставки sale.delivery.extra.service.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: sale, delivery

Кто может выполнять метод: администратор

Метод добавляет услугу службы доставки.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

DELIVERY_ID*
sale_delivery_service.ID

Идентификатор службы доставки, к которой будет привязана создаваемая услуга.

Получить идентификаторы служб доставки можно с помощью метода sale.delivery.getlist

TYPE*
string

Тип услуги. Возможные значения:

  • enum — список (выбор опции из заранее сформированного списка)
  • checkbox — единичная услуга (например, доставка до двери)
  • quantity — количественная услуга (например, требуемое количество грузчиков)

NAME*
string

Название услуги

ACTIVE
string

Индикатор активности услуги. Возможные значения:

  • Y — да
  • N — нет

Если значение не передано, то по умолчанию используется N

CODE
string

Символьный код услуги

SORT
integer

Сортировка

DESCRIPTION
string

Описание услуги

PRICE
double

Стоимость услуги в валюте службы доставки.

Поле актуально только для услуг типа единичная услуга (checkbox) и количественная услуга (quantity)

ITEMS*
object[]

Список доступных для выбора опций (подробное описание приведено ниже).

Поле актуально только для услуг типа список (enum)

Параметр ITEMS

Обязательные параметры отмечены *

Название
тип

Описание

TITLE*
string

Название опции списка

CODE*
string

Символьный код опции списка

PRICE
double

Стоимость услуги при выборе данной опции в валюте службы доставки

Примеры кода

Как использовать примеры в документации

Добавление услуги с типом Количественная услуга:

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>';

Добавление услуги с типом Список:

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>';

Обработка ответа

HTTP-статус: 200

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

Возвращаемые данные

Название
тип

Описание

result
sale_delivery_extra_service.ID

Идентификатор добавленной услуги

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400, 403

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

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Статус

ERROR_CHECK_FAILURE

Ошибка валидации входящих параметров (детали в описании ошибки)

400

ERROR_EXTRA_SERVICE_ADD

Ошибка при попытке добавления услуги

400

ERROR_DELIVERY_NOT_FOUND

Служба доставки с указанным идентификатором не найдена

400

ACCESS_DENIED

Недостаточно прав для добавления службы доставки

403

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Обзор методов
Следующая
Обновить услугу службы доставки