Отмена заказа по инициативе Золотого Яблока
При необходимости отмены заказа по любой причине ИС Золотого Яблока может направить запрос на отмену заказа на доставку в ИС курьерской службы. Заказ на доставку, созданный на стороне ИС КС, отменяется автоматически, если это допустимо при актуальном статусе доставки, а факт принятия запроса логируется ИС КС.
Если первая попытка отправки запроса на отмену завершается ошибкой, повторная попытка выполняется через заданный интервал. Если повторный запрос завершается ошибкой, на электронную почту направляется письмо с запросом на отмену заказа, это запускает процедуру SLA по отмене, порядок и сроки которой аналогичны сценарию с успешным HTTP-запросом на отмену.
Детали физического взаимодействия сервисов в данном документе не оговариваются: заказ, отменённый в информационных системах, может оставаться активным на стороне курьерской службы. Эндпоинт должен быть доступен по защищённому протоколу HTTPS.
После получения отмены по инициативе Золотого Яблока ИС КС присылает статус GA_CANCEL_REQUEST с использованием метода Изменение статуса заказа.
Основная информация
| Тип метода запроса | POST |
|---|---|
| Путь/URL | /api/v1/orders/{orderNumber}/cancel |
| Описание | Метод для отмены заказа в Курьерской службе по инициативе Золотого Яблока. |
| Направление | Запрос выполняет ИС Золотого Яблока. Ответ предоставляется курьерской службой. |
Запрос
Параметры заголовка
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| Authorization | string | 1 | Access token, полученный при авторизации. Передаётся в формате Bearer <access_token> | Формат передаёт курьерская служба (см. Авторизация в сервисе ВКС) |
| content-type | string | 1 | Тип содержимого запроса | Заполняется "application/json" |
Параметры пути
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| orderNumber | string | 1 | Номер заказа ЗЯ | Внутренний номер заказа в ИС Золотого Яблока. Трек-номер. |
Ответ
Коды ответов и сообщений
| Код | Статус | Сообщение | Причина |
|---|---|---|---|
| 200 | ОК | Order has been canceled | Все прошло успешно. Заказ отменен в ИС курьерской службы |
| 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": "Token is invalid"
}