Получение трека по заказу

Request

POST

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

Query parameters

Name

Description

order_id*

Type: string

Идентификатор заказа

Example: d3639f5f4de4675bb23124b53f63c3d0

park_id*

Type: string

Идентификатор партнера

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Headers

Name

Description

X-API-Key*

Type: string

API-ключ

Example: <API-ключ>

Min length: 1

X-Client-ID*

Type: string

Идентификатор клиента

Example: <Идентификатор клиента>

Min length: 1

Responses

200 OK

Трэк по заказу

Body

application/json

{
    "track": [
        {
            "tracked_at": "2020-09-10T13:37:00.000Z",
            "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 Местоположение
tracked_at*	Type: string<date-time> Время отслеживания точки Example: `Thu Sep 10 2020 16:37:00 GMT+0300 (Moscow Standard Time)`
direction	Type: number Направление. Угол от 0 градусов до 360 градусов от направления на север, по часовой стрелке. 0 - север, 90 - восток, 180 - юг, 270 - запад Example: `342` Min value: `0` Max value: `360`
distance	Type: number<double> Расстояние, пройденное от первой точки трека в метрах Example: `323.35060609` Min value: `0`
order_status	Type: TrackOrderStatus Статус заказа в точке. Допустимые значения: `driving` - исполнитель едет к начальной точке; `waiting` - исполнитель ждёт в начальной точке; `transporting` - исполнитель выполняет перевозку. Example: `waiting` Enum: `driving`, `waiting`, `transporting`
speed	Type: number<double> Скорость в метрах в секунду Example: `17` Min value: `0`

TrackLocation

Местоположение

Name

Description

lat*

Type: number<double>

Широта в градусах

Example: 55.751244

Min value: -90

Max value: 90

lon*

Type: number<double>

Долгода в градусах

Example: 37.618423

Min value: -180

Max value: 180

TrackOrderStatus

Статус заказа в точке. Допустимые значения:

driving - исполнитель едет к начальной точке;
waiting - исполнитель ждёт в начальной точке;
transporting - исполнитель выполняет перевозку.

Type

Description

TrackOrderStatus

Example: waiting

Enum: driving, waiting, transporting

400 Bad Request

Некорректные параметры запроса

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

401 Unauthorized

Отсутствуют параметры авторизации запроса

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

403 Forbidden

Недостаточно прав для выполнения запроса

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

404 Not Found

Запрашиваемый ресурс не найден

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

429 Too Many Requests

Превышено допустимое число запросов

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

500 Internal Server Error

Внутренняя ошибка сервера

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

Была ли статья полезна?

Получение списка заказов

Создание транзакции на балансе водителя (курьера)