Gets positions of courier on the route for the specified time interval. The interval is not longer than 2 hours.

  1. HTTP Request
  2. Path Parameters
  3. Query Parameters
  4. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 400
    3. Code 401
    4. Code 403
    5. Code 422
    6. Code 504

Gets positions of courier on the route for the specified time interval. The interval is not longer than 2 hours.

HTTP Request

GET https://courier.yandex.ru/api/v2/companies/{company_id}/routes/{route_id}/courier-positions\
?from={integer}\
&to={integer}

Path Parameters

company_id *

integer

The ID of the company.

route_id *

integer

Route ID that is used in requests to the Track & Trace API.

company_id *

integer

The ID of the company.

route_id *

integer

Route ID that is used in requests to the Track & Trace API.

Query Parameters

from *

integer

Start of interval for the courier positions, in unix timestamp.

to

integer

Finish of interval for the courier positions, in unix timestamp.

from *

integer

Start of interval for the courier positions, in unix timestamp.

to

integer

Finish of interval for the courier positions, in unix timestamp.

Responses

Code 200

Success.

[
  {
    "lat": number,
    "lon": number,
    "server_timestamp": number,
    "timestamp": number
  }
]
Copied to clipboard

Representation

Collapse all
Expand all

Fields

lat *

number

Latitude of position.

lon *

number

Longitude of position.

server_timestamp

number

Unix timestamp of receiving position by server.

timestamp *

number

Unix timestamp of position.

lat *

number

Latitude of position.

lon *

number

Longitude of position.

server_timestamp

number

Unix timestamp of receiving position by server.

timestamp *

number

Unix timestamp of position.

Code 400

Time interval has invalid format.

Code 401

Authorization failed. Send the correct OAuth token in the authorization header.

Code 403

You do not have access to this object.

Code 422

Incorrect input.

Code 504

Server error during request processing.