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.

HTTP Request

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

Path Parameters

company_id *	integer The ID of the company that is used in requests to the Track & Trace API.
order_id *	integer The ID of the order that is used in requests to the Track & Trace API.

* Required parameter

Responses

Code 200

Order delivery information.

{
  "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
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

courier *	object Courier information.
courier.location	object Last known courier position.
courier.location.lat	number Latitude of the last known courier position.
courier.location.lon	number Longitude of the last known courier position.
courier.location_updated_at	object Time of the last known courier position.
courier.location_updated_at.text	string The time of the last known courier position, in ISO 8601 format. Example - '2018-09-06T10:15:00+03:00'
courier.location_updated_at.value	number UNIX timestamp of the last known courier position.
courier.name *	string Name of the courier.
courier.number *	string Courier number.
delivery_queue_position	integer Current position of the order in а route.
estimated_delivery_time	object Estimated time of delivery.
estimated_delivery_time.text	string The estimated time of delivery, in ISO 8601 format. Example - '2018-09-06T10:15:00+03:00'
estimated_delivery_time.value	number UNIX timestamp of the estimated time of delivery.
status *	string Current status of the order.
tracking_url *	string URL for vehicle tracking.

* Required parameter

Code 401

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

Code 403

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

Code 404

Provided order_id does not exist.

Code 422

Incorrect input. The operation can't be performed.