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

  1. HTTP-запрос
  2. Query-параметры
  3. Заголовки запроса
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 400
      1. Представление
      2. Поля
    3. Код 401
      1. Представление
      2. Поля
    4. Код 403
      1. Представление
      2. Поля
    5. Код 404
      1. Представление
      2. Поля
    6. Код 429
      1. Представление
      2. Поля
    7. Код 500
      1. Представление
      2. Поля
  5. Пример

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

HTTP-запрос

POST https://fleet-api.taxi.yandex.net/v1/parks/orders/track?park_id={string}&order_id={string}

Query-параметры

park_id *

string

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

order_id *

string

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

park_id *

string

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

order_id *

string

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

Заголовки запроса

X-Client-ID *

string

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

X-API-Key *

string

API-ключ

X-Client-ID *

string

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

X-API-Key *

string

API-ключ

Ответы

Код 200

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

{
  "track": [
    {
      "direction": 342,
      "distance": 323.35060609,
      "location": {
        "lat": 55.751244,
        "lon": 37.618423
      },
      "order_status": "waiting",
      "speed": 17,
      "tracked_at": "2020-09-10T13:37:00+00:00"
    }
  ]
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

track[] *

array

track[].direction

number

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

Минимальное значение: 0.
Максимальное значение: 360.

track[].distance

number

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

Минимальное значение: 0.

track[].location *

object

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

track[].location.lat *

number

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

Минимальное значение: -90.
Максимальное значение: 90.

track[].location.lon *

number

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

Минимальное значение: -180.
Максимальное значение: 180.

track[].order_status

string

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

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

track[].speed

number

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

Минимальное значение: 0.

track[].tracked_at *

string

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

track[] *

array

track[].direction

number

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

Минимальное значение: 0.
Максимальное значение: 360.

track[].distance

number

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

Минимальное значение: 0.

track[].location *

object

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

track[].location.lat *

number

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

Минимальное значение: -90.
Максимальное значение: 90.

track[].location.lon *

number

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

Минимальное значение: -180.
Максимальное значение: 180.

track[].order_status

string

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

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

track[].speed

number

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

Минимальное значение: 0.

track[].tracked_at *

string

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

Код 400

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 401

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 403

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 404

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 429

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 500

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Пример

Request:

curl -X POST "https://fleet-api.taxi.yandex.net/v1/parks/orders/track?park_id={string}\
&order_id={string}" \
-H "X-Client-ID: <Идентификатор клиента>" \
-H "X-API-Key: <API-ключ>"
Скопировано

Responses:

{
  "track": [
    {
      "direction": 342,
      "distance": 323.35060609,
      "location": {
        "lat": 55.751244,
        "lon": 37.618423
      },
      "order_status": "waiting",
      "speed": 17,
      "tracked_at": "2020-09-10T13:37:00+00:00"
    }
  ]
}
Скопировано