метод REST scope: delivery

sale.delivery.handler.update

Обновить обработчик службы доставки

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

Описание

Метод sale.delivery.handler.update обновляет обработчик службы доставки.

Параметры

ID sale_delivery_handler.ID обязательный

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

NAME string необязательный

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

CODE string необязательный

Символьный код обработчика службы доставки

SORT integer необязательный

Сортировка

DESCRIPTION string необязательный

Описание обработчика службы доставки

SETTINGS object необязательный

Объект, содержащий информацию о настройках обработчика службы доставки (подробное описание приведено ниже)

PROFILES object[] необязательный

Массив, содержащий список объектов профилей доставки (подробное описание приведено ниже).

Подразумевается, что у обработчика службы доставки должен быть как минимум 1 профиль

Параметр SETTINGS

CALCULATE_URL string обязательный

URL для расчета стоимости доставки.

На данный URL приходят данные о посылке (что доставить, куда и как), стоимость доставки которой нужно рассчитать в ответе.

Формат запроса и ответа детально описан в документации по веб-хуку Расчет стоимости доставки

CREATE_DELIVERY_REQUEST_URL string необязательный

URL для создания заказа на доставку.

На данный URL приходят данные о посылке (что доставить, куда и как), заказ на которую нужно оформить в службе доставки.

Формат запроса и ответа детально описан в документации по веб-хуку Создание заказа на доставку

CANCEL_DELIVERY_REQUEST_URL string необязательный

URL для отмены заказа на доставку

На данный URL приходят данные о посылке (что доставить, куда и как), заказ на которую нужно отменить в службе доставки.

Формат запроса и ответа детально описан в документации по веб-хуку Отмена заказа на доставку

HAS_CALLBACK_TRACKING_SUPPORT string необязательный

Индикатор того, будет ли служба доставки присылать оповещения о статусе заказа на доставку (см. метод sale.delivery.request.sendmessage).

В случае, если поддержка событий указана, то в интерфейсе менеджера при заказе доставки будет создано дело на доставку, в которое могут транслироваться изменения, связанные с текущим статусом доставки.

Возможные значения:
- Y — есть поддержка
- N — нет поддержки

CONFIG object необязательный

Массив объектов с доступными настройками для службы доставки, создаваемой с использованием данного обработчика (подробное описание приведено ниже)

Параметр CONFIG

TYPE string обязательный

Тип поля настройки
Возможные значения:
- STRING — строка
- Y/N — чекбокс (да / нет)
- NUMBER — число
- ENUM — список
- DATE — дата
- LOCATION — местоположение

CODE string обязательный

Символьный код настройки

NAME string обязательный

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

OPTIONS object необязательный

Список опций для выбора. Объект в формате ключ=значение. Где ключ — код опции, а значение — опция.

Пример:

{
   "Option1Code": "Option1Value",
   "Option2Code": "Option2Value",
   "Option3Code": "Option3Value"
}

Параметр актуален только для настройки типа ENUM

Параметр PROFILES

NAME string обязательный

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

CODE string обязательный

Символьный код профиля обработчика службы доставки

DESCRIPTION string необязательный

Описание профиля обработчика службы доставки

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":14,"CODE":"uber","NAME":"New Uber","DESCRIPTION":"New Uber Description","SORT":300,"SETTINGS":{"CALCULATE_URL":"https://gateway.bx/calculate.php","CREATE_DELIVERY_REQUEST_URL":"https://gateway.bx/create_delivery_request.php","CANCEL_DELIVERY_REQUEST_URL":"https://gateway.bx/cancel_delivery_request.php","HAS_CALLBACK_TRACKING_SUPPORT":"N","CONFIG":[{"TYPE":"STRING","CODE":"SETTING_1","NAME":"String Example"},{"TYPE":"Y/N","CODE":"SETTING_2","NAME":"Checkbox Example"},{"TYPE":"NUMBER","CODE":"SETTING_3","NAME":"Number Example"},{"TYPE":"ENUM","CODE":"SETTING_4","NAME":"Enum Example","OPTIONS":{"Option1Code":"Option1Value","Option2Code":"Option2Value","Option3Code":"Option3Value","Option4Code":"Option4Value","Option5Code":"Option5Value"}},{"TYPE":"DATE","CODE":"SETTING_5","NAME":"Date Example"},{"TYPE":"LOCATION","CODE":"SETTING_6","NAME":"Location Example"}]},"PROFILES":[{"NAME":"New Taxi","CODE":"TAXI","DESCRIPTION":"New Taxi Delivery"},{"NAME":"New Cargo","CODE":"CARGO","DESCRIPTION":"New Cargo Delivery"}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.handler.update

Ответ

HTTP-статус: 200

{
   "result":true,
   "time":{
      "start":1713857588.711742,
      "finish":1713857589.121912,
      "duration":0.4101700782775879,
      "processing":0.02155303955078125,
      "date_start":"2024-04-23T10:33:08+03:00",
      "date_finish":"2024-04-23T10:33:09+03:00"
   }
}

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

result boolean

Результат обновления обработчика службы доставки

time time

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

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

HTTP-статус: 400

{
   "error":"ERROR_HANDLER_NOT_FOUND",
   "error_description":"Handler not found"
}
Код Описание Значение
ERROR_HANDLER_NOT_FOUND Обработчик службы доставки с указанным идентификатором не найден 400
ERROR_CHECK_FAILURE Ошибка валидации входящих параметров (детали в описании ошибки) 400
ERROR_HANDLER_UPDATE Ошибка при попытке обновления обработчика службы доставки 400
ERROR_HANDLER_ALREADY_EXIST Обработчик службы доставки с указанным кодом уже существует 400
ACCESS_DENIED Недостаточно прав для обновления обработчика службы доставки 403

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

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