Отмена заказа по инициативе курьерской службы
В случае, если становится известно, что заказ не может быть доставлен клиенту по любой причине, включая просьбу клиента, ИС КС может отправить запрос на отмену заказа в ИС Золотого Яблока. Заказ на доставку, зафиксированный на стороне ИС Золотого Яблока при создании отправления, автоматически изменится и для него будет запущен таймер отмены (если это допустимо при актуальном статусе доставки). Дополнительно, факт принятия запроса фиксируется ИС Золотого Яблока, и, если в течение 48 часов (этот период времени зависит от условий договора на оказание услуг) не будет зарегистрирован отказ от отмены, выполненный курьерской службой (см. Отказ от отмены заказа по инициативе курьерской службы), заказ будет отменён. Детали физического взаимодействия сервисов в данном документе не оговариваются, физически отменённый заказ может оставаться в курьерской службе.
Основная информация
| Тип метода запроса | POST |
|---|---|
| Путь/URL | /api/v1/orders/{orderNumber}/cancel |
| Описание | Метод для отмены заказа по инициативе Курьерской службы. |
| Направление | Запрос выполняется курьерской службой. Ответ предоставляется ИС Золотого Яблока. |
Запрос
Параметры заголовка
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| Authorization | string | 1 | Access-token, выданнный сервисом | см. метод Авторизация в сервисе |
| content-type | string | 1 | Тип содержимого запроса | Заполняется "application/json" |
Параметры пути
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| orderNumber | string | 1 | Номер заказа ЗЯ | Внутренний номер заказа в ИС Золотого Яблока. Трек-номер. |
Параметры запроса
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| dateTime | date | 1 | Дата и время отмены заказа | Согласно стандарту "ISO 8601", UTC0 (YYYY-MM-DDThh:mm:ssZ) |
| сomment | string | 1 | Комментарий к событию отмены | Комментарий в свободной строковой форме |
Пример запроса
{
"dateTime": "2019-04-05T12:05:18Z",
"comment": "Клиент отказался от получения заказа"
}
Ответ
Коды ответов и сообщений
| Код | Статус | Сообщение | Причина |
|---|---|---|---|
| 200 | ОК | Order has been marked for cancellation | Все прошло успешно. Заказ помечен на отмену в ИС Золотого Яблока |
| 400 | Bad Request | Missing or inappropriate required parameters | Не переданы или некорретно заполнены обязательные поля |
| 401 | Unauthorized | Token is invalid | Ошибка аутентификации в КС |
| 403 | Forbidden | Has no permission | Запрещено в текущем контексте |
| 500 | Internal Server Error | Server unavailable | Сервер недоступен |
Параметры успешного ответа
200 ОК
Параметры неуспешного ответа
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| error | string | 1 | Человекочитаемое описание ошибки | см. п. "Коды ответов и сообщений" |
Пример неуспешного ответа
Неуспешный ответ
{
"error": "Has no permission"
}