Сервис для отзыва посылки (отмены доставки до получателя).
Режим редактирования посылок возможен на разных статусах движения заказа.
Список всех статусов приведен в "Таблица статусов доступности изменения свойств отправления" – графа «Отзыв посылки».
postman - GET- CancelOrder. Отзыв или удаление посылки
URL запроса (GET): https://api.boxberry.ru/json?token={{token}}&method=CancelOrder&track={{track}}
URL запроса (POST): https://api.boxberry.ru/json
Входящие параметры:
Параметр | Обяз. | Тип | Описание | Пример |
---|---|---|---|---|
token | ● | string | Токен для доступа к api-сервисам | d6f33e419c16131e5325cbd84d5d6000 |
method | ● | string | Название метода | CancelOrder |
track | string | Трек-номер посылки | AAP114630687 | |
orderid | string | Номер заказа ИМ | ||
cancelType | string | Вариант отмены заказа: Если не передан, то по умолчанию 1 - удалить посылку в ЛК ИМ. Если передано непустое значение отличное от 1 и 2, то метод возвращает ошибку: Если посылка была успешно отозвана то статус у заказа будет "Готовится к возврату" | 2 |
Данные ответа:
Параметр | Тип | Описание |
---|---|---|
err | bool | false - запрос успешно выполнен (в ЛК ИМ изменены данные посылки) |
string | Сообщение об ошибке, в случае err != false |
Справочник ошибок:
Текст ошибки | Описание |
---|---|
"Не найдена посылка, доступная к отмене" |
|
"Необходимо передавать один из параметров 'track' или 'orderid'." | Переданы оба параметра одновременно или ни одного. |