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

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

Request

GET

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

Path parameters

Name

Description

company_id*

Type: integer<int64>

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

order_id*

Type: integer<int64>

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

Responses

200 OK

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

Body

application/json

{
    "delivery_queue_position": 0,
    "status": "string",
    "tracking_url": "string",
    "estimated_delivery_time": {
        "value": 0,
        "text": "string"
    },
    "courier": {
        "number": "string",
        "name": "string",
        "location_updated_at": {
            "value": 0,
            "text": "string"
        },
        "location": {
            "lat": 0,
            "lon": 0
        }
    }
}

Name	Description
courier*	Type: OrderInfo_courier Информация о курьере.
status*	Type: string Текущий статус заказа.
tracking_url*	Type: string URL для отслеживания транспортных средств.
delivery_queue_position	Type: integer Текущая позиция заказа в маршруте.
estimated_delivery_time	Type: OrderInfo_estimated_delivery_time Расчетное время доставки.

OrderInfo_courier

Информация о курьере.

Name	Description
name*	Type: string Имя курьера.
number*	Type: string Номер курьере.
location	Type: OrderInfo_courier_location Последняя известная позиция курьера.
location_updated_at	Type: OrderInfo_courier_location_updated_at Время последней известной позиции курьера.

OrderInfo_estimated_delivery_time

Расчетное время доставки.

Name

Description

text

Type: string

Расчетное время доставки в формате ISO 8601. Пример — '2018-09-06T10:15:00+03:00'.

value

Type: number

UNIX timestamp расчетного времени доставки.

OrderInfo_courier_location

Последняя известная позиция курьера.

Name

Description

lat

Type: number<float>

Широта последней известной позиции курьера.

lon

Type: number<float>

Долгота последней известной позиции курьера.

OrderInfo_courier_location_updated_at

Время последней известной позиции курьера.

Name

Description

text

Type: string

Время последней известной позиции курьера в формате ISO 8601. Пример — '2018-09-06T10:15:00+03:00'.

value

Type: number

UNIX timestamp последней известной позиции курьера.

401 Unauthorized

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

403 Forbidden

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

404 Not Found

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

422 Unprocessable Entity

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

Was the article helpful?

Обзор

Отправляет позиции курьеров в базу данных