Получает маршрут

Ресурсы API

Получает маршрут

Возвращает информацию о маршруте по его ID.

HTTP-запрос

GET https://courier.yandex.ru/api/v1/companies/{company_id}/routes/{route_id}

Path-параметры

company_id *	integer ID компании, используемый в запросах к API Мониторинга.
route_id *	integer ID маршрута, используемый в запросах к API Мониторинга.

* Обязательный параметр

Ответы

Код 200

Информация о маршруте получена.

{
  "company_id": integer,
  "courier_id": integer,
  "courier_violated_route": boolean,
  "custom_fields": [
    {
      "key": string,
      "value": string
    }
  ],
  "date": string,
  "depot_id": integer,
  "id": integer,
  "imei": integer,
  "imei_str": string,
  "number": string,
  "rented_courier_id": string,
  "route_finish": string,
  "route_start": string,
  "routing_mode": string,
  "track_start_timestamp": integer,
  "tracking_start_h": integer
}
Скопировано

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

Свернуть всё

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

Поля

custom_fields[]	array Список пользовательских полей маршрута. Максимальное количество пользовательских полей - 10.
custom_fields[].key	string Ключ пользовательского поля. Должен соответствовать одному из пользовательский полей маршрута, заданных в настройках компании.
custom_fields[].value	string Значение пользовательского поля.
date	string Дата исполнения маршрута в формате YYYY-MM-DD. Нельзя менять при наличии заказов в маршруте.
id	integer ID маршрута, используемый в запросах к API Мониторинга.
imei	integer Номер GPS трекера, установленного на транспортном средстве, выполняющем маршрут.
imei_str	string Строковое представление числового номера GPS-трекера. Должно использоваться в случае целочисленного переполнения номера GPS-трекера в используемом языке программирования. Если это поле определено в запросе, его значение имеет приоритет над значением числового поля номера GPS-трекера.
number	string Номер маршрута. Используется для синхронизации с учетной системой компании, выполняющей доставку.
rented_courier_id	string ID нанятого курьера, используемый в запросах к API Мониторинга.
route_finish	string Время окончания маршрута относительно `date`, в формате [d.]HH:MM:SS. Если указано, позиции курьеров, отправленные GPS-трекерами и приложением, будут записаны только до указанного времени.
route_start	string Время начала маршрута относительно `date`, в формате [d.]HH:MM:SS. Если указано: GPS-трекеры и приложения начнут записывать информацию только после `route_start - tracking_start_h`. Событие START истории заказов будет добавлено в историю заказов только после указанного времени. SMS-уведомления об изменении статуса заказа, если они включены, будут отправляться клиентам только по истечении указанного времени.
routing_mode	string Способ передвижения. Возможные значения: `driving` - курьер управляет автомобилем. `truck` - курьер управляет грузовиком. `transit` - курьер пользуется общественным транспортом и ходит пешком. `walking` - курьер ходит пешком.
tracking_start_h	integer Отслеживание маршрута начнётся за `tracking_start_h` часов до начала маршрута. Если `route.route_start` определено, GPS-трекеры и приложения начнут записывать информацию только после `route.route_start - route.tracking_start_h`, если `route.tracking_start_h` определено, иначе после `route.route_start - company.tracking_start_h`. Минимальное значение: `0`. Максимальное значение: `24`.
company_id	integer ID компании, используемый в запросах к API Мониторинга.
courier_id	integer ID курьера, выполняющего доставку по маршруту.
courier_violated_route	boolean Указывает, посещает ли курьер заказы в порядке, отличном от предопределенной последовательности заказов.
depot_id	integer ID склада, с которого будет начинаться маршрут.
track_start_timestamp	integer Время первой позиции трека маршрута (UNIX timestamp).

custom_fields[]	array Список пользовательских полей маршрута. Максимальное количество пользовательских полей - 10.
custom_fields[].key	string Ключ пользовательского поля. Должен соответствовать одному из пользовательский полей маршрута, заданных в настройках компании.
custom_fields[].value	string Значение пользовательского поля.
date	string Дата исполнения маршрута в формате YYYY-MM-DD. Нельзя менять при наличии заказов в маршруте.
id	integer ID маршрута, используемый в запросах к API Мониторинга.
imei	integer Номер GPS трекера, установленного на транспортном средстве, выполняющем маршрут.
imei_str	string Строковое представление числового номера GPS-трекера. Должно использоваться в случае целочисленного переполнения номера GPS-трекера в используемом языке программирования. Если это поле определено в запросе, его значение имеет приоритет над значением числового поля номера GPS-трекера.
number	string Номер маршрута. Используется для синхронизации с учетной системой компании, выполняющей доставку.
rented_courier_id	string ID нанятого курьера, используемый в запросах к API Мониторинга.
route_finish	string Время окончания маршрута относительно `date`, в формате [d.]HH:MM:SS. Если указано, позиции курьеров, отправленные GPS-трекерами и приложением, будут записаны только до указанного времени.
route_start	string Время начала маршрута относительно `date`, в формате [d.]HH:MM:SS. Если указано: GPS-трекеры и приложения начнут записывать информацию только после `route_start - tracking_start_h`. Событие START истории заказов будет добавлено в историю заказов только после указанного времени. SMS-уведомления об изменении статуса заказа, если они включены, будут отправляться клиентам только по истечении указанного времени.
routing_mode	string Способ передвижения. Возможные значения: `driving` - курьер управляет автомобилем. `truck` - курьер управляет грузовиком. `transit` - курьер пользуется общественным транспортом и ходит пешком. `walking` - курьер ходит пешком.
tracking_start_h	integer Отслеживание маршрута начнётся за `tracking_start_h` часов до начала маршрута. Если `route.route_start` определено, GPS-трекеры и приложения начнут записывать информацию только после `route.route_start - route.tracking_start_h`, если `route.tracking_start_h` определено, иначе после `route.route_start - company.tracking_start_h`. Минимальное значение: `0`. Максимальное значение: `24`.
company_id	integer ID компании, используемый в запросах к API Мониторинга.
courier_id	integer ID курьера, выполняющего доставку по маршруту.
courier_violated_route	boolean Указывает, посещает ли курьер заказы в порядке, отличном от предопределенной последовательности заказов.
depot_id	integer ID склада, с которого будет начинаться маршрут.
track_start_timestamp	integer Время первой позиции трека маршрута (UNIX timestamp).

* Обязательный параметр

Код 401

Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.

Код 403

Ошибка доступа к объекту. У пользователя недостаточно прав для доступа к объекту.

Код 404

Ошибка поиска объекта. Объект не найден.

Код 422

Неверный ввод. Операция не может быть выполнена.

Код 504

Ошибка при работе с API. Повторите запрос.

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

Расскажите, что вам не понравилось в статье:

Задает узлы маршрута и их последовательность

Получает несколько маршрутов

В этой статье

HTTP-запрос Path-параметры Ответы Код 200 Представление Поля Код 401 Код 403 Код 404 Код 422 Код 504

Задает узлы маршрута и их последовательность

Получает несколько маршрутов