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

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

Request

GET

https://courier.yandex.ru/api/v1/companies/{company_id}/route-info

Path parameters

Name

Description

company_id*

Type: integer<int64>

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

Query parameters

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

Responses

200 OK

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

Body

application/json

[
    {
        "meta": {
            "id": "string",
            "number": "string",
            "company_id": "string",
            "date": "string",
            "routing_mode": "string",
            "courier": {
                "id": "string",
                "number": "string",
                "name": "string",
                "deleted": false
            },
            "planning_area": {
                "type": "string",
                "id": "string",
                "time_zone": "string"
            },
            "courier_position": {
                "node": {
                    "prev": 0,
                    "next": 0
                }
            },
            "total_transit_distance_m": 0,
            "last_update_info": {
                "update_time": {
                    "value": 0,
                    "text": "string"
                },
                "courier_position": {
                    "lat": 0,
                    "lon": 0,
                    "time": {
                        "value": 0,
                        "text": "string"
                    }
                }
            },
            "route_options": {
                "avoid_tolls": false,
                "avoid_unpaved": false,
                "avoid_poor_condition": false
            }
        },
        "nodes": [
            {
                "type": "string",
                "types": [
                    "string"
                ],
                "value": {
                    "id": "string",
                    "number": "string",
                    "estimated_service_time": {
                        "start": {
                            "value": 0,
                            "text": "string"
                        },
                        "end": {
                            "value": 0,
                            "text": "string"
                        }
                    },
                    "estimated_distance_left_m": 0,
                    "visit_time": {
                        "value": 0,
                        "text": "string"
                    },
                    "point": {
                        "lat": 0,
                        "lon": 0
                    },
                    "related_orders": [
                        {
                            "id": "string",
                            "action": "delivery"
                        }
                    ]
                }
            }
        ]
    }
]

RouteInfoItem[]

RouteInfoItem

Name

Description

RouteInfoMeta

Name	Description
company_id	Type: string ID компании, используемый в запросах к API Мониторинга.
courier	Type: RouteInfoMetaCourier
courier_position	Type: RouteInfoMetaCourierPosition
date	Type: string<date> Дата маршрута, в формате YYYY-MM-DD.
id	Type: string Идентификатор маршрута.
last_update_info	Type: RouteInfoMetaLastUpdateInfo
number	Type: string Номер маршрута.
planning_area	Type: RouteInfoMetaPlanningArea
route_options	Type: RouteInfoMetaRouteOptions
routing_mode	Type: string Способ передвижения. Возможные значения: `driving` - курьер управляет автомобилем. `truck` - курьер управляет грузовиком. `transit` - курьер пользуется общественным транспортом и ходит пешком. `walking` - курьер ходит пешком.
total_transit_distance_m	Type: number Общий пробег, в метрах.

RouteInfoNode

Элемент маршрута.

Name	Description
type	Type: string Тип узла. Возможные значения: `depot` - склад. `garage` - гараж. `order` - заказ.
types	Type: string[] Тип и подтипы узла в виде массива строк. Последний - наиболее точный. Возможные типы: `depot` - склад. `garage` - гараж. `order` - заказ. Возможные подтипы заказа: `delivery`. `pickup`. `drop_off`. Пример: `["order", "pickup"]`
value	Type: RouteInfoNodeDepot or RouteInfoNodeGarage or RouteInfoNodeOrder Описание элемента маршрута. Содержание зависит от типа узла.

RouteInfoMetaCourier

Name	Description
deleted	Type: boolean Флаг указывает на то, что курьер удален.
id	Type: string Идентификатор курьера.
name	Type: string Имя курьера.
number	Type: string Номер курьера.

RouteInfoMetaCourierPosition

Name

Description

node

Type: RouteInfoMetaCourierPosition_node

Позиция курьера в виде индексов предыдущей и следующей точки маршрута. {"prev": null, "next": null} когда курьер нарушил последовательность посещения точек или маршрут пустой, {"prev": null, "next": i} когда курьер ещё не посетил ниодной точки, {"prev": i, "next": null} когда курьер посетил все точки на маршруте, {"prev": i, "next": i+1} когда курьер движется от точки i к точке i+1.

RouteInfoMetaLastUpdateInfo

Name

Description

courier_position

Type: RouteInfoMetaLastUpdateInfo_courier_position

update_time

Type: LocalizedValue

Время обновления.

RouteInfoMetaPlanningArea

Name	Description
id	Type: string Номер зоны планирования.
time_zone	Type: string Часовой пояс зоны планирования.
type	Type: string Тип зоны планирование.

RouteInfoMetaRouteOptions

Name	Description
avoid_poor_condition	Type: boolean Не использовать дороги в плохом состоянии, если это возможно (только для режимов `driving` и `truck`). Default:
avoid_tolls	Type: boolean Не использовать платные дороги, если это возможно (только для режимов `driving` и `truck`). Подробнее Default:
avoid_unpaved	Type: boolean Не использовать дороги без твердого покрытия, если это возможно (только для режимов `driving` и `truck`). Default:

RouteInfoNodeDepot

Name	Description
estimated_distance_left_m	Type: number Расстояние в метрах, которое осталось проехать курьеру до точки заказа. Min value: `0`
estimated_service_time	Type: RouteInfoWindow Предполагаемое время обслуживания на складе.
id	Type: string Идентификатор склада.
number	Type: string Номер склада.
point	Type: Point
related_orders	Type: RelatedOrdersById[]
visit_time	Type: LocalizedValue Время посещения склада.

RouteInfoNodeGarage

Name	Description
estimated_distance_left_m	Type: number Расстояние в метрах, которое осталось проехать курьеру до точки заказа. Min value: `0`
estimated_visit_time	Type: RouteInfoWindow Предполагаемое время прибытия в гараж.
id	Type: string Идентификатор гаража.
number	Type: string Номер гаража.
point	Type: Point
visit_time	Type: LocalizedValue Время посещения гаража.

RouteInfoNodeOrder

Name	Description
delivery_time	Type: LocalizedValue Фактическое время доставки заказа.
estimated_distance_left_m	Type: number Расстояние в метрах, которое осталось проехать курьеру до точки заказа. Min value: `0`
estimated_service_time	Type: RouteInfoWindow Предполагаемое время обслуживания заказа.
id	Type: string Идентификатор заказа.
number	Type: string Номер заказа.
point	Type: Point
related_orders	Type: RelatedOrdersById[]
status	Type: string Статус заказа.
time_windows	Type: RouteInfoWindow[] Массив временных окон заказа.
time_zone	Type: string Часовой пояс заказа в формате базы данных tz, например Europe/Moscow, Europe/Berlin, Asia/Irkutsk, Asia/Istanbul. Дополнительные примеры доступны по адресу https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. По умолчанию часовой пояс заказа рассчитывается на основе его координат.

RouteInfoMetaCourierPosition_node

Name

Description

Type: integer

Индекс точки маршрута, которую курьер должен посетить следующей.

Type: integer

Индекс последней посещённой курьером точки маршрута.

RouteInfoMetaLastUpdateInfo_courier_position

Name	Description
lat*	Type: number<float> Широта точки.
lon*	Type: number<float> Долгота точки.
time	Type: LocalizedValue Время позиции курьера.

LocalizedValue

Name

Description

text

Type: string

Локализованный текст.

value

Type: number

Числовое представление значения.

RouteInfoWindow

Name

Description

end

Type: LocalizedValue

Конечное значение окна.

start

Type: LocalizedValue

Начальное значение окна.

Point

Name

Description

lat*

Type: number<float>

Широта точки.

lon*

Type: number<float>

Долгота точки.

RelatedOrdersById

Name

Description

action

Type: string

Действие, выполняемое над заказом: * delivery — доставить в этот пункт назначения (может быть складом, гаражом и drop-off заказом). * pickup — погрузить для доставки в другой пункт назначения (можно погрузить со склада, гаража и pickup-заказа).

Enum: delivery, pickup

Type: string

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

401 Unauthorized

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

403 Forbidden

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

404 Not Found

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

422 Unprocessable Entity

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

Was the article helpful?

Обзор