Getting order track

Request

POST

https://fleet-api.taxi.yandex.net/v1/parks/orders/track

Query parameters

Name

Description

order_id*

Type: string

Order ID

Example: d3639f5f4de4675bb23124b53f63c3d0

park_id*

Type: string

Partner ID

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Headers

Name

Description

X-API-Key*

Type: string

API-key

Example: <API key>

Min length: 1

X-Client-ID*

Type: string

Client ID

Example: <Client ID>

Min length: 1

Responses

200 OK

A track of an order

Body

application/json

{
    "track": [
        {
            "tracked_at": "2020-09-10T13:37:00+00:00",
            "location": {
                "lat": 55.751244,
                "lon": 37.618423
            },
            "speed": 17,
            "order_status": "waiting",
            "direction": 342,
            "distance": 323.35060609
        }
    ]
}

Name	Description
track*	Type: OrderTrackPoint[]

OrderTrackPoint

Name	Description
location*	Type: TrackLocation Location
tracked_at*	Type: string<date-time> Point tracking time Example: `2020-09-10T13:37:00+00:00`
direction	Type: number Direction. Angle from 0 degrees to 360 degrees from north direction, clockwise. 0 - north, 90 - east, 180 - south, 270 - west Example: `342` Min value: `0` Max value: `360`
distance	Type: number<double> Distance traveled from the first point of the track in meters Example: `323.35060609` Min value: `0`
order_status	Type: TrackOrderStatus Order status at the point. Allowed values: `driving` - en route to start point; `waiting` - is waiting at start point; `transporting` - is on the ride. Example: `waiting` Enum: `driving`, `waiting`, `transporting`
speed	Type: number<double> Speed in meters per second Example: `17` Min value: `0`

TrackLocation

Location

Name

Description

lat*

Type: number<double>

Latitude in degrees

Example: 55.751244

Min value: -90

Max value: 90

lon*

Type: number<double>

Longitude in degrees

Example: 37.618423

Min value: -180

Max value: 180

TrackOrderStatus

Order status at the point. Allowed values:

driving - en route to start point;
waiting - is waiting at start point;
transporting - is on the ride.

Type

Description

TrackOrderStatus

Example: waiting

Enum: driving, waiting, transporting

400 Bad Request

Invalid request parameters

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

401 Unauthorized

Request authorization parameters are missing

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

403 Forbidden

Insufficient rights to execute the request

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

404 Not Found

Requested resource was not found

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

429 Too Many Requests

Limit of requests was exceeded

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

500 Internal Server Error

Internal server error

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

Was the article helpful?

Getting list of orders

Create transaction on driver (courier) account (depricated)