Обновить транспортную заявку sale.delivery.request.update
Scope:
sale, deliveryКто может выполнять метод: администратор
Метод обновляет транспортную заявку.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
DELIVERY_ID* |
Идентификатор службы доставки, к которой относится транспортная заявка. Получить идентификаторы |
|
REQUEST_ID* |
Идентификатор транспортной заявки. Идентификатор назначается внешней системой в ответе вебхука на создание заказа на доставку (подробнее в описании вебхука Создание заказа на доставку) |
|
FINALIZE |
Индикатор необходимости завершить (финализировать) транспортную заявку. Подразумевается, что значение индикатора необходимо выставлять в По умолчанию если не передано значение, то заявка не финализируется. Возможные значения:
|
|
STATUS |
Статус транспортной заявки (подробное описание приведено ниже) |
|
PROPERTIES |
Свойства транспортной заявки (подробное описание приведено ниже) |
|
OVERWRITE_PROPERTIES |
Индикатор необходимости полностью переписать значения свойств заявки при обновлении. По умолчанию свойства при обновлении только добавляются (эквивалент передачи значения Возможные значения:
|
Параметр STATUS
Обязательные параметры отмечены *
|
Название |
Описание |
|
TEXT* |
Текстовое название статуса транспортной заявки |
|
SEMANTIC* |
Значение семантики статуса. Возможные значения:
|
Параметр PROPERTIES
Обязательные параметры отмечены *
|
Название |
Описание |
|
NAME* |
Название свойства |
|
VALUE* |
Значение свойства |
|
TAGS |
Список тегов. Возможные значения:
|
Примеры кода
Как использовать примеры в документации
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 |
Результат обновления транспортной заявки |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400, 403
{
"error":"DELIVERY_NOT_FOUND",
"error_description":"Delivery service has not been found"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Статус |
|
|
Не указан идентификатор службы доставки |
|
|
|
Служба доставки не найдена |
|
|
|
Не указан идентификатор транспортной заявки |
|
|
|
Транспортная заявка не найдена |
|
|
|
Некорректный формат значения параметра |
|
|
|
Не указано значение названия статуса |
|
|
|
Не указано значение семантики статуса |
|
|
|
Некорректный формат значения параметра |
|
|
|
Некорректный формат одного из переданных свойств |
|
|
|
Некорректный формат значения тегов свойства |
|
|
|
Некорректный формат значения тега свойства |
|
|
|
Некорректное значение параметра Допустимые значения: |
|
|
|
Некорректное значение параметра Допустимые значения: |
|
|
|
Ошибка при попытке обновления транспортной заявки |
|
|
|
Пустой набор полей для обновления транспортной заявки |
|
|
|
Недостаточно прав для добавления службы доставки |
|
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Создать оповещения по транспортной заявке sale.delivery.request.sendmessage
- Удалить транспортную заявку sale.delivery.request.delete