Pushes courier positions from client

Pushes courier positions to the database for tracking.

Request

POST

https://api.courier.yandex.net/api/v1/couriers/{courier_id}/routes/{route_id}/push-positions-v3

Path parameters

Name

Description

courier_id*

Type: integer

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

route_id*

Type: integer

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

Query parameters

Name

Description

apikey*

Type: string

Company's apikey.

Body

application/json
{
    "positions": [
        {
            "accuracy": 0,
            "point": {
                "lat": 0,
                "lon": 0
            },
            "timestamp": 0,
            "heading": 0,
            "speed": 0
        }
    ]
}

Name

Description

positions*

Type: PositionV3[]

PositionV3

Name

Description

accuracy*

Type: integer

GPS accuracy in meters.

point*

Type: Point

timestamp*

Type: integer<datetime>

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

heading

Type: integer

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

speed

Type: number<float>

Instantaneous velocity. Not supported yet.

Point

Name

Description

lat*

Type: number<float>

Location latitude.

lon*

Type: number<float>

Location longitude.

Responses

200 OK

Data was saved.

403 Forbidden

You do not have access to this object.

404 Not Found

No object found.

422 Unprocessable Entity

Incorrect input.