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

Scope: sale, delivery

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

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

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

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

Название
тип

Описание

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
        
try
        {
        	const response = await $b24.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",
        				},
        			],
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(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>';
        

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

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

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

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

Код

Описание

Статус

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-статус: 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

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

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