Отменить заказ на доставку CANCEL_DELIVERY_REQUEST_URL
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Битрикс24 отправляет HTTP-запрос методом POST на адрес из параметра CANCEL_DELIVERY_REQUEST_URL, который передан при создании обработчика доставки методом sale.delivery.handler.add. Внешняя система должна отменить заказ на доставку и вернуть результат в формате JSON.
Параметры запроса
|
Название |
Описание |
|
DELIVERY_ID |
Идентификатор службы доставки. Получить идентификаторы служб доставки можно с помощью метода sale.delivery.getlist |
|
REQUEST_ID |
Идентификатор транспортной заявки. Идентификатор назначается внешней системой в ответе на создание заказа на доставку |
Пример запроса
{
"DELIVERY_ID": 694,
"REQUEST_ID": "4757aca4931a4f029f49c0db4374d13d"
}
Параметры ответа
Обработчик должен вернуть HTTP-статус 200 и JSON-объект.
Обязательные параметры отмечены *
|
Название |
Описание |
|
SUCCESS* |
Индикатор успеха отмены заказа на доставку. Возможные значения:
|
|
REASON |
Причина ошибки. Передается в случае неудачной попытки отмены заказа на доставку (подробное описание приведено ниже) |
Объект REASON
|
Название |
Описание |
|
TEXT* |
Описание ошибки |
Пример ответа с успешной отменой заказа на доставку
{
"SUCCESS": "Y"
}
Пример ответа с ошибкой при отмене заказа на доставку
{
"SUCCESS": "N",
"REASON": {
"TEXT": "The order has been already delivered"
}
}
Обработка ошибок
Если SUCCESS отсутствует или отличается от Y, Битрикс24 считает отмену заказа неуспешной. Передайте пояснение в REASON.TEXT. Если поле REASON.TEXT отсутствует или пустое, Битрикс24 использует стандартный текст ошибки.