Gets order info

Gets information about the current order status: а current position of the order in а route, а status of the order, an estimated delivery time of the order, a location of a courier who delivers the order.

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>

The ID of the company that is used in requests to the Track & Trace API.

order_id*

Type: integer<int64>

The ID of the order that is used in requests to the Track & Trace API.

Responses

200 OK

Order delivery information.

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 Courier information.
status*	Type: string Current status of the order.
tracking_url*	Type: string URL for vehicle tracking.
delivery_queue_position	Type: integer Current position of the order in а route.
estimated_delivery_time	Type: OrderInfo_estimated_delivery_time Estimated time of delivery.

OrderInfo_courier

Courier information.

Name	Description
name*	Type: string Name of the courier.
number*	Type: string Courier number.
location	Type: OrderInfo_courier_location Last known courier position.
location_updated_at	Type: OrderInfo_courier_location_updated_at Time of the last known courier position.

OrderInfo_estimated_delivery_time

Estimated time of delivery.

Name

Description

text

Type: string

The estimated time of delivery, in ISO 8601 format. Example — '2018-09-06T10:15:00+03:00'.

value

Type: number

UNIX timestamp of the estimated time of delivery.

OrderInfo_courier_location

Last known courier position.

Name

Description

lat

Type: number<float>

Latitude of the last known courier position.

lon

Type: number<float>

Longitude of the last known courier position.

OrderInfo_courier_location_updated_at

Time of the last known courier position.

Name

Description

text

Type: string

The time of the last known courier position, in ISO 8601 format. Example — '2018-09-06T10:15:00+03:00'.

value

Type: number

UNIX timestamp of the last known courier position.

401 Unauthorized

Authorization error. Make sure that the request header contains the correct OAuth token.

403 Forbidden

Error accessing the object. The user doesn't have the rights to access the object.

404 Not Found

Provided order_id does not exist.

422 Unprocessable Entity

Incorrect input. The operation can't be performed.

Was the article helpful?

Overview

Pushes courier positions from client