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

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

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

Scope: delivery

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

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

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

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

Название
тип

Описание

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
// 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<boolean>({
    method: 'sale.delivery.extra.service.update',
    params: {
      ID: 128,
      ACTIVE: 'N',
      CODE: 'door_delivery',
      NAME: 'Door Delivery New Name',
      DESCRIPTION: 'Door Delivery New Description',
      SORT: 200,
      PRICE: 399.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('Updated:', 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 updateExtraService() {
    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.update',
        params: {
          ID: 128,
          ACTIVE: 'N',
          CODE: 'door_delivery',
          NAME: 'Door Delivery New Name',
          DESCRIPTION: 'Door Delivery New Description',
          SORT: 200,
          PRICE: 399.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('Updated:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateExtraService)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.sale.delivery.extra.service.update(
        bitrix_id=128,
        name='Door Delivery New Name',
        active=False,
        code='door_delivery',
        sort=200,
        description='Door Delivery New Description',
        price=399.99,
        items='[{',
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.delivery.extra.service.update", b24.Params{
	"ID":          128,
	"ACTIVE":      "N",
	"CODE":        "door_delivery",
	"NAME":        "Door Delivery New Name",
	"DESCRIPTION": "Door Delivery New Description",
	"SORT":        200,
	"PRICE":       399.99,
})
if err != nil {
	return fmt.Errorf("sale.delivery.extra.service.update: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

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

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
// 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<boolean>({
    method: 'sale.delivery.extra.service.update',
    params: {
      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,
        },
      ],
    },
    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('Updated:', 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 updateEnumExtraService() {
    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.update',
        params: {
          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,
            },
          ],
        },
        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('Updated:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateEnumExtraService)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.sale.delivery.extra.service.update(
        bitrix_id=129,
        name="Cargo Type New Name",
        active="N",
        code="cargo_type",
        sort=500,
        description="Cargo Type New Description",
        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,
            },
        ],
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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
string

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

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

Код

Описание

Статус

ERROR_CHECK_FAILURE

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

400

ERROR_EXTRA_SERVICE_UPDATE

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

400

ERROR_EXTRA_SERVICE_NOT_FOUND

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

400

ACCESS_DENIED

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

403

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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