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

HTTP-запрос

GET https://courier.yandex.ru/api/v1/companies/{company_id}/route-plan-info\
?start_date={string}\
&end_date={string}\
&depot_id={integer}\
&page={integer}\
&per_page={integer}

Path-параметры

company_id *

integer

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

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

Query-параметры

start_date	string Фильтрация маршрутов по дате. Маршруты с датой большей или равной указанной будут включены в вывод. Формат YYYY-MM-DD.
end_date	string Фильтрация маршрутов по дате. Маршруты с датой меньшей или равной указанной дате будут включены в вывод. Формат YYYY-MM-DD.
depot_id	integer Фильтрация маршрутов по ID склада. Минимальное значение: `1`.
page	integer Номер страницы в базе данных. Каждая страница содержит per_page маршрутов, упорядоченных по возрастанию ID маршрута. Минимальное значение: `1`. Значение по умолчанию: `1`.
per_page	integer Количество маршрутов на страницу. Минимальное значение: `1`. Максимальное значение: `2000`. Значение по умолчанию: `100`.

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

Ответы

Код 200

Возвращает список маршрутов с метриками плана.

[
  {
    "date": string,
    "id": integer,
    "number": string,
    "plan_metrics": {
      "orders_count": number,
      "total_duration": {
        "text": string,
        "value": number
      },
      "total_transit_distance_m": number
    }
  }
]
Скопировано

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

Свернуть всё

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

Поля

date	string Дата исполнения маршрута в формате YYYY-MM-DD.
id	integer ID маршрута, используемый в запросах к API Мониторинга.
number	string Номер маршрута.
plan_metrics	object
plan_metrics.orders_count	number Количество заказов в маршруте.
plan_metrics.total_duration	object
plan_metrics.total_duration.text	string Локализованный текст.
plan_metrics.total_duration.value	number Числовое представление значения.
plan_metrics.total_transit_distance_m	number Общий пробег, в метрах.

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

Код 401

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

Код 403

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

Код 404

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

Код 422

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