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

Scope: sale, delivery

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

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

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

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

Название
тип

Описание

ID*
sale_delivery_extra_service.ID

Идентификатор услуги.

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

NAME
string

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

ACTIVE
string

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

  • Y — да
  • 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 '{"ID":128,"ACTIVE":"N","CODE":"door_delivery","NAME":"Door Delivery New Name","DESCRIPTION":"Door Delivery New Description","SORT":200,"PRICE":399.99}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.extra.service.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":128,"ACTIVE":"N","CODE":"door_delivery","NAME":"Door Delivery New Name","DESCRIPTION":"Door Delivery New Description","SORT":200,"PRICE":399.99,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.delivery.extra.service.update
        
try
        {
        	const response = await $b24.callMethod(
        		'sale.delivery.extra.service.update', {
        			ID: 128,
        			ACTIVE: "N",
        			CODE: "door_delivery",
        			NAME: "Door Delivery New Name",
        			DESCRIPTION: "Door Delivery New Description",
        			SORT: 200,
        			PRICE: 399.99,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.delivery.extra.service.update',
                    [
                        'ID'          => 128,
                        'ACTIVE'      => "N",
                        'CODE'        => "door_delivery",
                        'NAME'        => "Door Delivery New Name",
                        'DESCRIPTION' => "Door Delivery New Description",
                        'SORT'        => 200,
                        'PRICE'       => 399.99,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating delivery service: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'sale.delivery.extra.service.update', {
                ID: 128,
                ACTIVE: "N",
                CODE: "door_delivery",
                NAME: "Door Delivery New Name",
                DESCRIPTION: "Door Delivery New Description",
                SORT: 200,
                PRICE: 399.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.update',
            [
                'ID' => 128,
                'ACTIVE' => "N",
                'CODE' => "door_delivery",
                'NAME' => "Door Delivery New Name",
                'DESCRIPTION' => "Door Delivery New Description",
                'SORT' => 200,
                'PRICE' => 399.99,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":129,"ACTIVE":"N","CODE":"cargo_type","NAME":"Cargo Type New Name","DESCRIPTION":"Cargo Type New Description","TYPE":"enum","SORT":500,"ITEMS":[{"TITLE":"Small Package(s)","CODE":"small_package","PRICE":129.99},{"TITLE":"Documents","CODE":"documents","PRICE":69.99},{"TITLE":"Large Package(s)","CODE":"large_package","PRICE":1290.99}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.extra.service.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":129,"ACTIVE":"N","CODE":"cargo_type","NAME":"Cargo Type New Name","DESCRIPTION":"Cargo Type New Description","TYPE":"enum","SORT":500,"ITEMS":[{"TITLE":"Small Package(s)","CODE":"small_package","PRICE":129.99},{"TITLE":"Documents","CODE":"documents","PRICE":69.99},{"TITLE":"Large Package(s)","CODE":"large_package","PRICE":1290.99}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.delivery.extra.service.update
        
try
        {
        	const response = await $b24.callMethod(
        		'sale.delivery.extra.service.update', {
        			ID: 129,
        			ACTIVE: "N",
        			CODE: "cargo_type",
        			NAME: "Cargo Type New Name",
        			DESCRIPTION: "Cargo Type New Description",
        			TYPE: "enum",
        			SORT: 500,
        			ITEMS: [{
        					TITLE: "Small Package(s)",
        					CODE: "small_package",
        					PRICE: 129.99,
        				},
        				{
        					TITLE: "Documents",
        					CODE: "documents",
        					PRICE: 69.99,
        				},
        				{
        					TITLE: "Large Package(s)",
        					CODE: "large_package",
        					PRICE: 1290.99,
        				},
        			],
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.delivery.extra.service.update',
                    [
                        'ID'          => 129,
                        'ACTIVE'      => "N",
                        'CODE'        => "cargo_type",
                        'NAME'        => "Cargo Type New Name",
                        'DESCRIPTION' => "Cargo Type New Description",
                        'TYPE'        => "enum",
                        'SORT'        => 500,
                        'ITEMS'       => [
                            [
                                'TITLE' => "Small Package(s)",
                                'CODE'  => "small_package",
                                'PRICE' => 129.99,
                            ],
                            [
                                'TITLE' => "Documents",
                                'CODE'  => "documents",
                                'PRICE' => 69.99,
                            ],
                            [
                                'TITLE' => "Large Package(s)",
                                'CODE'  => "large_package",
                                'PRICE' => 1290.99,
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating delivery extra service: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'sale.delivery.extra.service.update', {
                ID: 129,
                ACTIVE: "N",
                CODE: "cargo_type",
                NAME: "Cargo Type New Name",
                DESCRIPTION: "Cargo Type New Description",
                TYPE: "enum",
                SORT: 500,
                ITEMS: [{
                        TITLE: "Small Package(s)",
                        CODE: "small_package",
                        PRICE: 129.99,
                    },
                    {
                        TITLE: "Documents",
                        CODE: "documents",
                        PRICE: 69.99,
                    },
                    {
                        TITLE: "Large Package(s)",
                        CODE: "large_package",
                        PRICE: 1290.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.update',
            [
                'ID' => 129,
                'ACTIVE' => "N",
                'CODE' => "cargo_type",
                'NAME' => "Cargo Type New Name",
                'DESCRIPTION' => "Cargo Type New Description",
                'TYPE' => "enum",
                'SORT' => 500,
                'ITEMS' => [
                    [
                        'TITLE' => "Small Package(s)",
                        'CODE' => "small_package",
                        'PRICE' => 129.99,
                    ],
                    [
                        'TITLE' => "Documents",
                        'CODE' => "documents",
                        'PRICE' => 69.99,
                    ],
                    [
                        'TITLE' => "Large Package(s)",
                        'CODE' => "large_package",
                        'PRICE' => 1290.99,
                    ],
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
           "result":true,
           "time":{
              "start":1714549724.272976,
              "finish":1714549724.479944,
              "duration":0.20696806907653809,
              "processing":0.02615499496459961,
              "date_start":"2024-05-01T10:48:44+03:00",
              "date_finish":"2024-05-01T10:48:44+03:00"
           }
        }

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

Название
тип

Описание

result
boolean

Результат обновления услуги

time
time

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

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

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

{
           "error":"ERROR_EXTRA_SERVICE_NOT_FOUND",
           "error_description":"Extra service not found"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Статус

ERROR_CHECK_FAILURE

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

400

ERROR_EXTRA_SERVICE_UPDATE

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

400

ERROR_EXTRA_SERVICE_NOT_FOUND

Услуга с указанным идентификатором (ID) не найдена

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

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

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

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

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

Предыдущая
Добавить услугу службы доставки
Следующая
Получить информацию обо всех услугах конкретной службы доставки