Получает информацию о заказе

Получает информацию о текущем состоянии заказа: текущая позиция заказа в маршруте, статус заказа, расчетное время доставки заказа, местонахождение курьера осуществляющего доставку.

HTTP-запрос

GET https://courier.yandex.ru/api/v1/companies/{company_id}/orders/{order_id}/order-info

Path-параметры

company_id *	integer ID компании, используемый в запросах к API Мониторинга.
order_id *	integer ID заказа, используемый в запросах к API Мониторинга.

* Обязательный параметр

Ответы

Код 200

Информация о доставке заказа.

{
  "courier": {
    "location": {
      "lat": number,
      "lon": number
    },
    "location_updated_at": {
      "text": string,
      "value": number
    },
    "name": string,
    "number": string
  },
  "delivery_queue_position": integer,
  "estimated_delivery_time": {
    "text": string,
    "value": number
  },
  "status": string,
  "tracking_url": string
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

courier *	object Информация о курьере.
courier.location	object Последняя известная позиция курьера.
courier.location.lat	number Широта последней известной позиции курьера.
courier.location.lon	number Долгота последней известной позиции курьера.
courier.location_updated_at	object Время последней известной позиции курьера.
courier.location_updated_at.text	string Время последней известной позиции курьера в формате ISO 8601. Пример - '2018-09-06T10:15:00+03:00'
courier.location_updated_at.value	number UNIX timestamp последней известной позиции курьера.
courier.name *	string Имя курьера.
courier.number *	string Номер курьере.
delivery_queue_position	integer Текущая позиция заказа в маршруте.
estimated_delivery_time	object Расчетное время доставки.
estimated_delivery_time.text	string Расчетное время доставки в формате ISO 8601. Пример - '2018-09-06T10:15:00+03:00'
estimated_delivery_time.value	number UNIX timestamp расчетного времени доставки.
status *	string Текущий статус заказа.
tracking_url *	string URL для отслеживания транспортных средств.

* Обязательный параметр

Код 401

Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.

Код 403

Ошибка доступа к объекту. У пользователя недостаточно прав для доступа к объекту.

Код 404

Указанного order_id не существует.

Код 422

Неверный ввод. Операция не может быть выполнена.