Обновить транспортную заявку sale.delivery.request.update

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

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

Scope: delivery

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

Метод sale.delivery.request.update обновляет транспортную заявку.

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

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

Название
тип

Описание

DELIVERY_ID*
sale_delivery_service.ID

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

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

REQUEST_ID*
string

Идентификатор транспортной заявки.

Идентификатор назначается внешней системой в ответе вебхука на создание заказа на доставку (подробнее в описании вебхука Создание заказа на доставку)

FINALIZE
string

Индикатор необходимости завершить (финализировать) транспортную заявку.

Подразумевается, что значение индикатора необходимо выставлять в Y в том случае, когда транспортная заявка выполнена.

По умолчанию если не передано значение, то заявка не финализируется.

Возможные значения:

  • Y — да
  • N — нет

STATUS
object

Статус транспортной заявки (подробное описание приведено ниже)

PROPERTIES
object[]

Свойства транспортной заявки (подробное описание приведено ниже)

OVERWRITE_PROPERTIES
string

Индикатор необходимости полностью переписать значения свойств заявки при обновлении.

По умолчанию свойства при обновлении только добавляются (эквивалент передачи значения N). Если вызывающей стороне требуется передать полный набор свойств и перезаписать существующие свойства, то необходимо выставлять значение этого индикатора в Y.

Возможные значения:

  • Y — да
  • N — нет

Параметр STATUS

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

Название
тип

Описание

TEXT*
string

Текстовое название статуса транспортной заявки

SEMANTIC*
string

Значение семантики статуса.

Возможные значения:

  • process — заявка в процессе выполнения
  • success — заявка успешно выполнена

Параметр PROPERTIES

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

Название
тип

Описание

NAME*
string

Название свойства

VALUE*
string

Значение свойства

TAGS
string[]

Список тегов.

Возможные значения:

  • phone — переданное значение будет отображаться как телефонный номер

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DELIVERY_ID":225,"REQUEST_ID":"4757aca4931a4f029f49c0db4374d13d","STATUS":{"TEXT":"Performer found","SEMANTIC":"process"},"PROPERTIES":[{"NAME":"Car","VALUE":"Gray Skoda Octavia, a777zn"},{"NAME":"Driver","VALUE":"John Smith"},{"NAME":"Phone Number","VALUE":"+11111111111","TAGS":["phone"]},{"NAME":"Something else","VALUE":"Some value"}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.request.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DELIVERY_ID":225,"REQUEST_ID":"4757aca4931a4f029f49c0db4374d13d","STATUS":{"TEXT":"Performer found","SEMANTIC":"process"},"PROPERTIES":[{"NAME":"Car","VALUE":"Gray Skoda Octavia, a777zn"},{"NAME":"Driver","VALUE":"John Smith"},{"NAME":"Phone Number","VALUE":"+11111111111","TAGS":["phone"]},{"NAME":"Something else","VALUE":"Some value"}],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.delivery.request.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.request.update',
    params: {
      DELIVERY_ID: 225,
      REQUEST_ID: '4757aca4931a4f029f49c0db4374d13d',
      STATUS: {
        TEXT: 'Performer found',
        SEMANTIC: 'process',
      },
      PROPERTIES: [
        {
          NAME: 'Car',
          VALUE: 'Gray Skoda Octavia, a777zn',
        },
        {
          NAME: 'Driver',
          VALUE: 'John Smith',
        },
        {
          NAME: 'Phone Number',
          VALUE: '+11111111111',
          TAGS: ['phone'],
        },
        {
          NAME: 'Something else',
          VALUE: 'Some value',
        },
      ],
    },
    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('Delivery request 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 updateDeliveryRequest() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.delivery.request.update',
        params: {
          DELIVERY_ID: 225,
          REQUEST_ID: '4757aca4931a4f029f49c0db4374d13d',
          STATUS: {
            TEXT: 'Performer found',
            SEMANTIC: 'process',
          },
          PROPERTIES: [
            {
              NAME: 'Car',
              VALUE: 'Gray Skoda Octavia, a777zn',
            },
            {
              NAME: 'Driver',
              VALUE: 'John Smith',
            },
            {
              NAME: 'Phone Number',
              VALUE: '+11111111111',
              TAGS: ['phone'],
            },
            {
              NAME: 'Something else',
              VALUE: 'Some value',
            },
          ],
        },
        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('Delivery request updated:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

status = {
    "TEXT": "Performer found",
    "SEMANTIC": "process",
}

properties = [
    {
        "NAME": "Car",
        "VALUE": "Gray Skoda Octavia, a777zn",
    },
    {
        "NAME": "Driver",
        "VALUE": "John Smith",
    },
    {
        "NAME": "Phone Number",
        "VALUE": "+11111111111",
        "TAGS": [
            "phone",
        ],
    },
    {
        "NAME": "Something else",
        "VALUE": "Some value",
    },
]

try:
    bitrix_response = client.sale.delivery.request.update(
        delivery_id=225,
        request_id='4757aca4931a4f029f49c0db4374d13d',
        status=status,
        properties=properties,
    ).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.request.update',
            [
                'DELIVERY_ID' => 225,
                'REQUEST_ID' => "4757aca4931a4f029f49c0db4374d13d",
                'STATUS' => [
                    'TEXT' => "Performer found",
                    'SEMANTIC' => "process",
                ],
                'PROPERTIES' => [
                    [
                        'NAME' => "Car",
                        'VALUE' => "Gray Skoda Octavia, a777zn",
                    ],
                    [
                        'NAME' => "Driver",
                        'VALUE' => "John Smith",
                    ],
                    [
                        'NAME' => "Phone Number",
                        'VALUE' => "+11111111111",
                        'TAGS' => [
                            "phone"
                        ],
                    ],
                    [
                        'NAME' => "Something else",
                        'VALUE' => "Some value",
                    ],
                ],
            ]
        );

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

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error updating delivery request: ' . $e->getMessage();
}
BX24.callMethod(
    'sale.delivery.request.update', {
        DELIVERY_ID: 225,
        REQUEST_ID: "4757aca4931a4f029f49c0db4374d13d",
        STATUS: {
            TEXT: "Performer found",
            SEMANTIC: "process",
        },
        PROPERTIES: [{
                NAME: "Car",
                VALUE: "Gray Skoda Octavia, a777zn",
            },
            {
                NAME: "Driver",
                VALUE: "John Smith",
            },
            {
                NAME: "Phone Number",
                VALUE: "+11111111111",
                TAGS: [
                    "phone"
                ],
            },
            {
                NAME: "Something else",
                VALUE: "Some value",
            },
        ],
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.info(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'sale.delivery.request.update',
    [
        'DELIVERY_ID' => 225,
        'REQUEST_ID' => "4757aca4931a4f029f49c0db4374d13d",
        'STATUS' => [
            'TEXT' => "Performer found",
            'SEMANTIC' => "process",
        ],
        'PROPERTIES' => [
            [
                'NAME' => "Car",
                'VALUE' => "Gray Skoda Octavia, a777zn",
            ],
            [
                'NAME' => "Driver",
                'VALUE' => "John Smith",
            ],
            [
                'NAME' => "Phone Number",
                'VALUE' => "+11111111111",
                'TAGS' => [
                    "phone"
                ],
            ],
            [
                'NAME' => "Something else",
                'VALUE' => "Some value",
            ],
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.delivery.request.update", b24.Params{
	"DELIVERY_ID": 225,
	"REQUEST_ID":  "4757aca4931a4f029f49c0db4374d13d",
	"STATUS": b24.Params{
		"TEXT":     "Performer found",
		"SEMANTIC": "process",
	},
	"PROPERTIES": []b24.Params{
		{
			"NAME":  "Car",
			"VALUE": "Gray Skoda Octavia, a777zn",
		},
		{
			"NAME":  "Driver",
			"VALUE": "John Smith",
		},
		{
			"NAME":  "Phone Number",
			"VALUE": "+11111111111",
			"TAGS":  []string{"phone"},
		},
		{
			"NAME":  "Something else",
			"VALUE": "Some value",
		},
	},
})
if err != nil {
	return fmt.Errorf("sale.delivery.request.update: %w", err)
}

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

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

HTTP-статус: 200

{
    "result":true,
    "time":{
        "start":1714557963.841951,
        "finish":1714557964.052347,
        "duration":0.21039605140686035,
        "processing":0.04059791564941406,
        "date_start":"2024-05-01T13:06:03+03:00",
        "date_finish":"2024-05-01T13:06:04+03:00"
    }
}

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

Название
тип

Описание

result
boolean

Результат обновления транспортной заявки

time
time

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

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

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

{
    "error":"DELIVERY_NOT_FOUND",
    "error_description":"Delivery service has not been found"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Статус

DELIVERY_ID_NOT_SPECIFIED

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

400

DELIVERY_NOT_FOUND

Служба доставки не найдена

400

REQUEST_ID_NOT_SPECIFIED

Не указан идентификатор транспортной заявки

400

REQUEST_NOT_FOUND

Транспортная заявка не найдена

400

STATUS_UNEXPECTED_FORMAT

Некорректный формат значения параметра STATUS

400

STATUS_TEXT_NOT_SPECIFIED

Не указано значение названия статуса

400

STATUS_SEMANTIC_NOT_SPECIFIED

Не указано значение семантики статуса

400

PROPERTIES_UNEXPECTED_FORMAT

Некорректный формат значения параметра PROPERTIES

400

PROPERTY_VALUE_UNEXPECTED_FORMAT

Некорректный формат одного из переданных свойств

400

PROPERTY_VALUE_TAGS_UNEXPECTED_FORMAT

Некорректный формат значения тегов свойства

400

PROPERTY_VALUE_TAG_UNEXPECTED_FORMAT

Некорректный формат значения тега свойства

400

UNEXPECTED_REQUEST_FINALIZE_INDICATOR_VALUE

Некорректное значение параметра FINALIZE.

Допустимые значения: Y, N

400

UNEXPECTED_OVERWRITE_PROPERTIES_VALUE

Некорректное значение параметра OVERWRITE_PROPERTIES.

Допустимые значения: Y, N

400

UPDATE_REQUEST_INTERNAL_ERROR

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

400

EMPTY_UPDATE_PAYLOAD

Пустой набор полей для обновления транспортной заявки

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

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

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