Изменение статуса заказа
Когда при осуществлении доставки курьерской службой наступает событие, требующее обновление статуса текущей доставки, курьерская служба должна уведомить об этом Золотое Яблоко. Для этого взаимодействия предлагается технология webhook с реализацией подписки на стороне курьерской службы (т.е. классическое взаимодействие по отслеживанию отправлений). Любое существенное (с точки зрения Золотого Яблока и его клиентов) изменение статуса отправления на стороне курьерской службы - должно повлечь за собой отправку такого запроса, исключение составляют: отправка изменения даты доставки со стороны КС (см. Изменение даты доставки по инициативе курьерской службы) и отправка изменения даты доставки со стороны Золотого Яблока (см. Изменение даты доставки по инициативе Золотого Яблока).
Основная информация
| Тип метода запроса | PUT |
|---|---|
| Путь/URL | /api/v1/orders/{orderNumber} |
| Описание | Метод для изменения статуса заказа курьерской службой |
| Направление | Событие на стороне ВКС приводит к запросу. Запрос выполняется курьерской службой. Ответ предоставляется ИС Золотого Яблока. |
Запрос
Параметры заголовка
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| Authorization | string | 1 | Access-token, выданнный сервисом | см. метод Авторизация в сервисе |
| content-type | string | 1 | Тип содержимого запроса | Заполняется "application/json" |
Параметры пути запроса
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| orderNumber | string | 1 | Номер заказа в ИС Золотого Яблока | Внутренний номер заказа в ИС Золотого Яблока. Трек-номер |
Параметры запроса
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| Status object type | object | 1 | Объект, содержащий информацию об актуальном статусе | см. Приложение: Тип данных статуса заказа |
Пример запроса
{
"deliveryServiceCode": "CDEK",
"actualStatus": "ECS_ORDER_TAKEN_BY_COURIER",
"statusComment": "Заказ выдан на доставку, курьер в пути",
"statusAssignmentDate": "2025-04-05T10:15:30Z",
"hasBeenDelivered": false,
"actualDeliveryDate": null
}
Ответ
Коды ответов и сообщений
| Код | Статус | Сообщение | Причина |
|---|---|---|---|
| 200 | ОК | Status has been updated | Все прошло успешно. Статус заказа принят ИС Золотого Яблока |
| 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"
}