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

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-ключ

Min length: 1

Example: <API-ключ>

X-Client-ID

Type: string

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

Min length: 1

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

Responses

200 OK

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

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: OrderTrack Example `[ { "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 } ]`

TrackedAt

Время отслеживания точки

Type: string<date-time>

Example: 2020-09-10T13:37:00+00:00

Latitude

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

Type: number

Min value: -90

Max value: 90

Longitude

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

Type: number

Min value: -180

Max value: 180

TrackLocation

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

Name

Description

lat

Type: Latitude

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

Min value: -90

Max value: 90

Example: 55.751244

lon

Type: Longitude

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

Min value: -180

Max value: 180

Example: 37.618423

Example

{
  "lat": 55.751244,
  "lon": 37.618423
}

TrackSpeed

Скорость в метрах в секунду

Type: number

Min value: 0

TrackOrderStatus

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

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

Type: string

Enum: driving, waiting, transporting

TrackDirection

Направление. Угол от 0 градусов до 360 градусов от направления на север, по часовой стрелке. 0 - север, 90 - восток, 180 - юг, 270 - запад

Type: number

Min value: 0

Max value: 360

TrackDistance

Расстояние, пройденное от первой точки трека в метрах

Type: number

Min value: 0

OrderTrackPoint

Name	Description
location	Type: TrackLocation Местоположение Example `{ "lat": 55.751244, "lon": 37.618423 }`
tracked_at	Type: TrackedAt Время отслеживания точки Example: `2020-09-10T13:37:00+00:00`
direction	Type: TrackDirection Направление. Угол от 0 градусов до 360 градусов от направления на север, по часовой стрелке. 0 - север, 90 - восток, 180 - юг, 270 - запад Min value: `0` Max value: `360` Example: `342`
distance	Type: TrackDistance Расстояние, пройденное от первой точки трека в метрах Min value: `0` Example: `323.35060609`
order_status	Type: TrackOrderStatus Статус заказа в точке. Допустимые значения: `driving` - исполнитель едет к начальной точке; `waiting` - исполнитель ждёт в начальной точке; `transporting` - исполнитель выполняет перевозку. Enum: `driving`, `waiting`, `transporting`
speed	Type: TrackSpeed Скорость в метрах в секунду Min value: `0` Example: `17`

Example

{
  "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
}

OrderTrack

Type: OrderTrackPoint[]

Example

[
  {
    "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
  }
]

400 Bad Request

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

Body

application/json

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

401 Unauthorized

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

Body

application/json

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

403 Forbidden

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

Body

application/json

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

404 Not Found

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

Body

application/json

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

429 Too Many Requests

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

Body

application/json

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

500 Internal Server Error

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

Body

application/json

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

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

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

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