метод REST scope: delivery

sale.delivery.request.update

Обновить транспортную заявку

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

Описание

Метод 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

Ответ

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

{
    "error":"DELIVERY_NOT_FOUND",
    "error_description":"Delivery service has not been found"
}
Код Описание Значение
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

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.