Pushes courier positions from client

  1. HTTP Request
  2. Path Parameters
  3. Query Parameters
  4. Request Body
    1. Representation
    2. Fields
  5. Responses
    1. Code 200
    2. Code 403
    3. Code 404
    4. Code 422

Pushes courier positions to the database for tracking.

HTTP Request

POST https://courier.yandex.ru/api/v1/couriers/{courier_id}/routes/{route_id}/push-positions-v3\
?apikey={string}

Path Parameters

courier_id *

integer

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

route_id *

integer

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

courier_id *

integer

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

route_id *

integer

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

Query Parameters

apikey *

string

Company's apikey.

apikey *

string

Company's apikey.

Request Body

{
  "positions": [
    {
      "accuracy": integer,
      "heading": integer,
      "point": {
        "lat": number,
        "lon": number
      },
      "speed": number,
      "timestamp": integer
    }
  ]
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

positions[] *

array

positions[].accuracy *

integer

GPS accuracy in meters.

positions[].heading

integer

Direction toward true North, in degrees. Not supported yet.

positions[].point *

object

positions[].point.lat *

number

Location latitude.

positions[].point.lon *

number

Location longitude.

positions[].speed

number

Instantaneous velocity. Not supported yet.

positions[].timestamp *

integer

Timestamp of the courier position in UTC (in seconds).

Minimum value: 0.

positions[] *

array

positions[].accuracy *

integer

GPS accuracy in meters.

positions[].heading

integer

Direction toward true North, in degrees. Not supported yet.

positions[].point *

object

positions[].point.lat *

number

Location latitude.

positions[].point.lon *

number

Location longitude.

positions[].speed

number

Instantaneous velocity. Not supported yet.

positions[].timestamp *

integer

Timestamp of the courier position in UTC (in seconds).

Minimum value: 0.

Responses

Code 200

Data was saved.

Code 403

You do not have access to this object.

Code 404

No object found.

Code 422

Incorrect input.