Сервис для отзыва посылки (отмены доставки до получателя).
Внимание! Режим редактирования посылок возможен на разных статусах движения заказа.
Список всех статусов приведен в "Таблица статусов доступности изменения свойств отправления" – графа «Отзыв посылки».
Входящие параметры:
Параметр | Обяз. | Тип | Описание | Пример |
|---|---|---|---|---|
| token | ● | string | Токен для доступа к api-сервисам | d6f33e419c16131e5325cbd84d5d6000 |
| track | string | Трек-номер посылки | AAP114630687 | |
| orderid | string | Номер заказа ИМ | ||
| cancelType | string | Вариант отмены заказа: Если не передан, то по умолчанию 1 - удалить посылку в ЛК ИМ. Если передано непустое значение отличное от 1 и 2, то метод возвращает ошибку: | 2 |
Данные ответа:
Параметр | Тип | Описание |
|---|---|---|
| err | bool | Наличие ошибки при выполнении, возможные значения: true - при выполнении запроса произошла ошибка, запрос не выполнен false - запрос успешно выполнен (в ЛК ИМ изменены данные посылки) |
message | string | Сообщение об ошибке, в случае error=true |
Справочник ошибок:
err | Текст ошибки | Описание |
|---|---|---|
| false | - | Успешный запрос |
| true | "Не найдена посылка, доступная к отмене" |
|
| "Необходимо передавать один из параметров 'track' или 'orderid'." | Переданы оба параметра одновременно или ни одного. |