Получает информацию о маршруте

Ресурсы API

Получает список, содержащий информацию о маршрутах и о их заказах.

HTTP-запрос

GET https://courier.yandex.ru/api/v1/companies/{company_id}/route-info\
?date={string}\
&depot_id={integer}\
&route_id={integer}\
&with_prolongation={boolean}\
&page={integer}\
&per_page={integer}

Path-параметры

company_id *

integer

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

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

Query-параметры

date	string Дата, когда маршрут активен (начат и не завершен) в формате YYYY-MM-DD.
depot_id	integer ID склада, используемый в запросах к API Мониторинга. Минимальное значение: `1`.
route_id	integer ID маршрута, используемый в запросах к API Мониторинга. Минимальное значение: `1`.
with_prolongation	boolean `false` - использовать `route_finish_s` или последнее временное окно заказа при фильтрации по дате, `true` - использовать автоматически продлённое время маршрута.
page	integer Номер страницы в базе данных. Каждая страница содержит per_page маршрутов, упорядоченных по возрастанию ID маршрута. Минимальное значение: `1`. Значение по умолчанию: `1`.
per_page	integer Количество маршрутов на страницу. Минимальное значение: `1`. Максимальное значение: `2000`. Значение по умолчанию: `100`.

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

Ответы

Код 200

Возвращает список, содержащий информацию о маршрутах и о их заказах.

[
  {
    "meta": {
      "company_id": string,
      "courier": {
        "deleted": boolean,
        "id": string,
        "name": string,
        "number": string
      },
      "courier_position": {
        "node": {
          "next": integer,
          "prev": integer
        }
      },
      "date": string,
      "id": string,
      "last_update_info": {
        "courier_position": {
          "lat": number,
          "lon": number
        },
        "update_time": {
          "text": string,
          "value": number
        }
      },
      "number": string,
      "planning_area": {
        "id": string,
        "time_zone": string,
        "type": string
      },
      "routing_mode": string,
      "total_transit_distance_m": number
    },
    "nodes": [
      {
        "type": string,
        "types": [
          string
        ]
      }
    ]
  }
]
Скопировано

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

Свернуть всё

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

Поля

meta	object
meta.company_id	string ID компании, используемый в запросах к API Мониторинга.
meta.courier	object
meta.courier.deleted	boolean Флаг указывает на то, что курьер удален.
meta.courier.id	string Идентификатор курьера.
meta.courier.name	string Имя курьера.
meta.courier.number	string Номер курьера.
meta.courier_position	object
meta.courier_position.node	object Позиция курьера в виде индексов предыдущей и следующей точки маршрута. `{"prev": null, "next": null}` когда курьер нарушил последовательность посещения точек или маршрут пустой, `{"prev": null, "next": i}` когда курьер ещё не посетил ниодной точки, `{"prev": i, "next": null}` когда курьер посетил все точки на маршруте, `{"prev": i, "next": i+1}` когда курьер движется от точки i к точке i+1.
meta.courier_position.node.next	integer Индекс точки маршрута, которую курьер должен посетить следующей.
meta.courier_position.node.prev	integer Индекс последней посещённой курьером точки маршрута.
meta.date	string Дата маршрута, в формате YYYY-MM-DD.
meta.id	string Идентификатор маршрута.
meta.last_update_info	object
meta.last_update_info.courier_position	object
meta.last_update_info.courier_position.lat *	number Широта точки.
meta.last_update_info.courier_position.lon *	number Долгота точки.
meta.last_update_info.update_time	object
meta.last_update_info.update_time.text	string Локализованный текст.
meta.last_update_info.update_time.value	number Числовое представление значения.
meta.number	string Номер маршрута.
meta.planning_area	object
meta.planning_area.id	string Идентификатор зоны планирования.
meta.planning_area.time_zone	string Часовой пояс зоны планирования.
meta.planning_area.type	string Тип зоны планирование.
meta.routing_mode	string Способ передвижения. Возможные значения: `driving` - курьер управляет автомобилем. `truck` - курьер управляет грузовиком. `transit` - курьер пользуется общественным транспортом и ходит пешком. `walking` - курьер ходит пешком.
meta.total_transit_distance_m	number Общий пробег, в метрах.
nodes[]	array
nodes[].type	string Тип узла. Возможные значения: `depot` - склад. `garage` - гараж. `order` - заказ.
nodes[].types[]	array Тип и подтипы узла в виде массива строк. Последний - наиболее точный. Возможные типы: `depot` - склад. `garage` - гараж. `order` - заказ. Возможные подтипы заказа: `delivery`. `pickup`. `drop_off`. Пример: `["order", "pickup"]`
nodes[].value	object Описание элемента маршрута. Содержание зависит от типа узла.
nodes[].value.estimated_distance_left_m	number Расстояние в метрах, которое осталось проехать курьеру до точки заказа. Минимальное значение: `0`.
nodes[].value.estimated_service_time	object
nodes[].value.estimated_service_time.end	object
nodes[].value.estimated_service_time.end.text	string Локализованный текст.
nodes[].value.estimated_service_time.end.value	number Числовое представление значения.
nodes[].value.estimated_service_time.start	object
nodes[].value.estimated_service_time.start.text	string Локализованный текст.
nodes[].value.estimated_service_time.start.value	number Числовое представление значения.
nodes[].value.id	string Идентификатор склада.
nodes[].value.number	string Номер склада.
nodes[].value.point	object
nodes[].value.point.lat *	number Широта точки.
nodes[].value.point.lon *	number Долгота точки.
nodes[].value.related_orders[]	array
nodes[].value.related_orders[].action	string Действие, выполняемое над заказом: `delivery` — доставить в этот пункт назначения (может быть складом и drop-off заказом). `pickup` — погрузить для доставки в другой пункт назначения (можно погрузить со склада и pickup-заказа). Возможные значения delivery pickup
nodes[].value.related_orders[].id	string Идентификатор заказа.
nodes[].value.visit_time	object
nodes[].value.visit_time.text	string Локализованный текст.
nodes[].value.visit_time.value	number Числовое представление значения.
nodes[].value.estimated_distance_left_m	number Расстояние в метрах, которое осталось проехать курьеру до точки заказа. Минимальное значение: `0`.
nodes[].value.estimated_visit_time	object
nodes[].value.estimated_visit_time.end	object
nodes[].value.estimated_visit_time.end.text	string Локализованный текст.
nodes[].value.estimated_visit_time.end.value	number Числовое представление значения.
nodes[].value.estimated_visit_time.start	object
nodes[].value.estimated_visit_time.start.text	string Локализованный текст.
nodes[].value.estimated_visit_time.start.value	number Числовое представление значения.
nodes[].value.id	string Идентификатор гаража.
nodes[].value.number	string Номер гаража.
nodes[].value.point	object
nodes[].value.point.lat *	number Широта точки.
nodes[].value.point.lon *	number Долгота точки.
nodes[].value.visit_time	object
nodes[].value.visit_time.text	string Локализованный текст.
nodes[].value.visit_time.value	number Числовое представление значения.
nodes[].value.delivery_time	object
nodes[].value.delivery_time.text	string Локализованный текст.
nodes[].value.delivery_time.value	number Числовое представление значения.
nodes[].value.estimated_distance_left_m	number Расстояние в метрах, которое осталось проехать курьеру до точки заказа. Минимальное значение: `0`.
nodes[].value.estimated_service_time	object
nodes[].value.estimated_service_time.end	object
nodes[].value.estimated_service_time.end.text	string Локализованный текст.
nodes[].value.estimated_service_time.end.value	number Числовое представление значения.
nodes[].value.estimated_service_time.start	object
nodes[].value.estimated_service_time.start.text	string Локализованный текст.
nodes[].value.estimated_service_time.start.value	number Числовое представление значения.
nodes[].value.id	string Идентификатор заказа.
nodes[].value.number	string Номер заказа.
nodes[].value.point	object
nodes[].value.point.lat *	number Широта точки.
nodes[].value.point.lon *	number Долгота точки.
nodes[].value.related_orders[]	array
nodes[].value.related_orders[].action	string Действие, выполняемое над заказом: `delivery` — доставить в этот пункт назначения (может быть складом и drop-off заказом). `pickup` — погрузить для доставки в другой пункт назначения (можно погрузить со склада и pickup-заказа). Возможные значения delivery pickup
nodes[].value.related_orders[].id	string Идентификатор заказа.
nodes[].value.status	string Статус заказа.
nodes[].value.time_windows[]	array Массив временных окон заказа.
nodes[].value.time_windows[].end	object
nodes[].value.time_windows[].end.text	string Локализованный текст.
nodes[].value.time_windows[].end.value	number Числовое представление значения.
nodes[].value.time_windows[].start	object
nodes[].value.time_windows[].start.text	string Локализованный текст.
nodes[].value.time_windows[].start.value	number Числовое представление значения.
nodes[].value.time_zone	string Часовой пояс заказа в формате базы данных tz, например Europe/Moscow, Europe/Berlin, Asia/Irkutsk, Asia/Istanbul. Дополнительные примеры доступны по адресу https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. По умолчанию часовой пояс заказа рассчитывается на основе его координат.

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

Код 401

Ошибка авторизации. Отправьте правильный OAuth-токен в заголовке авторизации.

Код 403

У вас нет доступа к этому объекту.

Код 404

Указанного route_id не существует.

Код 422

Неправильный ввод.

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

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

route-info

routes

В этой статье

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

route-info

routes