Получение истории изменений статусов по заказу

Вспомогательный метод для получении всех статусов заказа на доставку. После получения финального статуса доставки, вне зависимости от успешности доставки, ИС Золотого Яблока может выполнить данный запрос, чтобы получить всю историю и синхронизировать с уже полученными статусами, во избежание хранения хронологически некорректной, неполной ввиду сетевых проблем или неправильной по любой другой причине истории статусов. Эндпоинт должен быть опубликован по защищенному протоколу HTTPS.

Основная информация

Тип метода запроса	GET
Путь/URL	/api/v1/orders/{orderNumber}/history
Описание	Метод для получения всех изменений статусов по заказу на стороне ИС курьерской службы
Направление	Запрос выполняется ИС Золотого Яблока Ответ предоставляется ИС курьерской службы

Запрос

Параметры заголовка

Параметр	Тип данных	Обязательность	Описание	Комментарий
Authorization	string	1	Access token, полученный при авторизации. Передаётся в формате Bearer <access_token>	Формат передаёт курьерская служба (см. Авторизация в сервисе ВКС)
content-type	string	1	Тип содержимого запроса	Заполняется "application/json"

Параметры пути запроса

Параметр	Тип данных	Обязательность	Описание	Комментарий
orderNumber	string	1	Номер заказа в ИС Золотого Яблока	Внутренний номер заказа в ИС Золотого Яблока. Трек-номер

Пример запроса

curl --location 'https://ecs.goldapple.ru/api/v1/orders/I-1000000515/history' \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.
eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.
SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
-H "Content-Type: application/json"

Ответ

Коды ответов и сообщений

Код	Статус	Сообщение	Причина
200	ОК	Status history has been sent	История статусов предоставлена в полезной нагрузке ответа
400	Bad Request	Missing or inappropriate required parameters	Не переданы или некорретно заполнены обязательные поля
401	Unauthorized	Token is invalid	Ошибка аутентификации в КС
403	Forbidden	Has no permission	Запрещено в текущем контексте
404	Not Found	Resource not found	Заказ не найден в ИС Золотого Яблока
500	Internal Server Error	Server unavailable	Сервер недоступен

Параметры успешного ответа

№	Параметр		Тип данных	Обязательность	Описание	Комментарий
1	statusHistory		array of objects	1	Массив объектов информации о присвоении статуса
2		Status object type	object	1	Объект, содержащий информацию о статусе	см. Приложение: Тип данных статуса заказа

Пример успешного ответа

{
  "statusHistory": [
    {
      "deliveryServiceCode": "CDEK",
      "actualStatus": "ECS_ORDER_DELIVERED",
      "statusComment": "Заказ доставлен клиенту полностью",
      "statusAssignmentDate": "2025-04-05T14:25:00Z",
      "hasBeenDelivered": true,
      "actualDeliveryDate": "2025-04-05T14:25:00Z"
    },
    {
      "deliveryServiceCode": "CDEK",
      "actualStatus": "ECS_ORDER_TAKEN_BY_COURIER",
      "statusComment": "Заказ выдан курьеру на доставку, курьер в пути",
      "statusAssignmentDate": "2025-04-05T11:15:22Z",
      "hasBeenDelivered": false,
      "actualDeliveryDate": null
    },
    {
      "deliveryServiceCode": "CDEK",
      "actualStatus": "ECS_COURIER_APPOINTED",
      "statusComment": "Курьер назначен на заказ",
      "statusAssignmentDate": "2025-04-05T10:15:30Z",
      "hasBeenDelivered": false,
      "actualDeliveryDate": null
    },
    {
      "deliveryServiceCode": "CDEK",
      "actualStatus": "ECS_ORDER_READY_FOR_APPOINTMENT",
      "statusComment": "Заказ прибыл в город назначения, ожидает назначения курьера (для курьерской доставки), заказ прибыл на ПВЗ (для доставки до ПВЗ)",
      "statusAssignmentDate": "2025-04-04T18:40:22Z",
      "hasBeenDelivered": false,
      "actualDeliveryDate": null
    },
    {
      "deliveryServiceCode": "CDEK",
      "actualStatus": "ECS_ORDER_ACCEPTED",
      "statusComment": "Заказ принят к исполнению в ИС ВКС, пройдя необходимые валидации",
      "statusAssignmentDate": "2025-04-04T14:30:05Z",
      "hasBeenDelivered": false,
      "actualDeliveryDate": null
    },
    {
      "deliveryServiceCode": "CDEK",
      "actualStatus": "ECS_ORDER_CREATED",
      "statusComment": "Заказ создан в ИС ВКС но требует дополнительной валидации",
      "statusAssignmentDate": "2025-04-04T14:30:05Z",
      "hasBeenDelivered": false,
      "actualDeliveryDate": null
    }
  ]
}

Параметры неуспешного ответа

Параметр	Тип данных	Обязательность	Описание	Комментарий
error	string	1	Человекочитаемое описание ошибки	см. п. "Коды ответов и сообщений"

Пример неуспешного ответа

Неуспешный ответ

{
  "error": "Invalid request format"
}