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

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

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

Scope: delivery

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

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

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

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

Название
тип

Описание

DELIVERY_ID*
sale_delivery_service.ID

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

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DELIVERY_ID":198}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.extra.service.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DELIVERY_ID":198,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.delivery.extra.service.get
// 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

// Shape of each ExtraService returned in result[]
type ExtraService = {
  ID: string,
  CODE: string,
  NAME: string,
  DESCRIPTION: string,
  ACTIVE: string,
  SORT: string,
  TYPE: string,
  PRICE?: number,
  ITEMS?: Array<{
    TITLE: string,
    CODE: string | null,
    PRICE: string,
  }>,
}

try {
  const response = await $b24.actions.v2.call.make<ExtraService[]>({
    method: 'sale.delivery.extra.service.get',
    params: {
      DELIVERY_ID: 198,
    },
    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('Extra services count:', result.length, 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 getDeliveryExtraServices() {
    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.get',
        params: {
          DELIVERY_ID: 198,
        },
        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('Extra services count:', result.length, result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.sale.delivery.extra.service.get(
        delivery_id=198,
    ).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.get',
            [
                'DELIVERY_ID' => 198,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting extra service for delivery: ' . $e->getMessage();
}
BX24.callMethod(
    'sale.delivery.extra.service.get', {
        DELIVERY_ID: 198,
    },
    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.get',
    [
        'DELIVERY_ID' => 198,
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.delivery.extra.service.get", b24.Params{
	"DELIVERY_ID": 198,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("sale.delivery.extra.service.get: %w", err)
}

var items []struct {
	ID          b24.ID `json:"ID"`
	Code        string `json:"CODE"`
	Name        string `json:"NAME"`
	Description string `json:"DESCRIPTION"`
	Active      string `json:"ACTIVE"`
	Sort        string `json:"SORT"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID, it.Code)
}

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

HTTP-статус: 200

{
   "result":[
      {
         "ID":"136",
         "CODE":"door_delivery",
         "NAME":"Door Delivery",
         "DESCRIPTION":"Door Delivery Description",
         "ACTIVE":"Y",
         "SORT":"100",
         "TYPE":"checkbox",
         "PRICE":99.99
      },
      {
         "ID":"129",
         "CODE":"cargo_type",
         "NAME":"Cargo Type",
         "DESCRIPTION":"Cargo Type",
         "ACTIVE":"Y",
         "SORT":"200",
         "TYPE":"enum",
         "ITEMS":[
            {
               "TITLE":"Documents",
               "CODE":null,
               "PRICE":"69.99"
            },
            {
               "TITLE":"Small Package(s)",
               "CODE":null,
               "PRICE":"129.99"
            },
            {
               "TITLE":"Large Package(s)",
               "CODE":null,
               "PRICE":"199.99"
            }
         ]
      }
   ],
   "time":{
      "start":1714551728.295288,
      "finish":1714551728.519896,
      "duration":0.2246079444885254,
      "processing":0.01918506622314453,
      "date_start":"2024-05-01T11:22:08+03:00",
      "date_finish":"2024-05-01T11:22:08+03:00"
   }
}

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

Название
тип

Описание

result
sale_delivery_extra_service[]

Список всех услуг службы доставки

time
time

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

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

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

{
    "error":"ERROR_DELIVERY_NOT_FOUND",
    "error_description":"Delivery not found"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Статус

ERROR_DELIVERY_NOT_FOUND

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

400

ERROR_CHECK_FAILURE

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

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

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

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