Gets route info

Gets a list of route info and its orders.

Request

GET

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

Path parameters

Name

Description

company_id*

Type: integer<int64>

The ID of the company that is used in requests to the Track & Trace API.

Query parameters

Name	Description
courier_id	Type: integer<int64> The ID of the courier that is used in requests to the Track & Trace API.
date	Type: string<date> Date when route is active (started and not finished) in YYYY-MM-DD format.
depot_id	Type: integer<int64> The ID of the depot that is used in requests to the Track & Trace API. Min value: `1`
page	Type: integer Page number where the entity is stored in the database. Each page contains per_page entities arranged in ascending route. Default: `1` Min value: `1`
per_page	Type: integer<int32> Number of routes per page. Default: `100` Min value: `1` Max value: `2000`
route_id	Type: integer<int64> The ID of the route that is used in requests to the Track & Trace API. Min value: `1`
with_prolongation	Type: boolean `false` - use `route_finish_s` or last order time-window for filtering by date, `true` - use prolonged route finish time. Default: `false`

Responses

200 OK

Returns a list of route info and its orders.

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 The ID of the company that is used in requests to the Track & Trace API.
courier	Type: RouteInfoMetaCourier
courier_position	Type: RouteInfoMetaCourierPosition
date	Type: string<date> The route's date in YYYY-MM-DD format.
id	Type: string Route identifier.
last_update_info	Type: RouteInfoMetaLastUpdateInfo
number	Type: string Route number.
planning_area	Type: RouteInfoMetaPlanningArea
route_options	Type: RouteInfoMetaRouteOptions
routing_mode	Type: string Transportation method. Possible values: `driving` - courier drives a car. `truck` - courier drives a truck. `transit` - courier uses public transport and walks. `walking` - courier walks.
total_transit_distance_m	Type: number Total transit distance, meters.

RouteInfoNode

Element of a route.

Name	Description
type	Type: string Node type. Possible values: `depot`. `garage`. `order`.
types	Type: string[] Node type and subtypes in a list of strings. Most accurate last. Possible types: `depot`. `garage`. `order`. Possible order subtypes: `delivery`. `pickup`. `drop_off`. Example: `["order", "pickup"]`
value	Type: RouteInfoNodeDepot or RouteInfoNodeGarage or RouteInfoNodeOrder Description of the route node. Content depends on a node type.

RouteInfoMetaCourier

Name	Description
deleted	Type: boolean Flag shows that courier is deleted.
id	Type: string Courier identifier.
name	Type: string Courier name.
number	Type: string Courier number.

RouteInfoMetaCourierPosition

Name

Description

node

Type: RouteInfoMetaCourierPosition_node

Courier position in prev and next node index. {"prev": null, "next": null} for courier violated the route or empty route, {"prev": null, "next": i} for the start of the route, {"prev": i, "next": null} for the end of the route, {"prev": i, "next": i+1} when courier goes from i node to i+1.

RouteInfoMetaLastUpdateInfo

Name

Description

courier_position

Type: RouteInfoMetaLastUpdateInfo_courier_position

update_time

Type: LocalizedValue

Update time.

RouteInfoMetaPlanningArea

Name	Description
id	Type: string Planning area identifier.
time_zone	Type: string Time zone of planning area.
type	Type: string Planning area type.

RouteInfoMetaRouteOptions

Name	Description
avoid_poor_condition	Type: boolean Do not use poor condition roads if possible (only for `driving` and `truck` routing modes). Default: `false`
avoid_tolls	Type: boolean Do not use toll roads if possible (only for `driving` and `truck` routing modes). More information Default: `false`
avoid_unpaved	Type: boolean Do not use unpaved roads if possible (only for `driving` and `truck` routing modes). Default: `false`

RouteInfoNodeDepot

Name	Description
estimated_distance_left_m	Type: number The distance in meters that the courier has to travel to the point of order. Min value: `0`
estimated_service_time	Type: RouteInfoWindow Estimated service time.
id	Type: string Depot identifier.
number	Type: string Depot number.
point	Type: Point
related_orders	Type: RelatedOrdersById[]
visit_time	Type: LocalizedValue Visit time.

RouteInfoNodeGarage

Name	Description
estimated_distance_left_m	Type: number The distance in meters that the courier has to travel to the point of order. Min value: `0`
estimated_visit_time	Type: RouteInfoWindow Estimated visit time.
id	Type: string Garage identifier.
number	Type: string Garage number.
point	Type: Point
visit_time	Type: LocalizedValue Visit time.

RouteInfoNodeOrder

Name	Description
delivery_time	Type: LocalizedValue Actual delivery time.
estimated_distance_left_m	Type: number The distance in meters that the courier has to travel to the point of order. Min value: `0`
estimated_service_time	Type: RouteInfoWindow Estimated service time.
id	Type: string Order identifier.
number	Type: string Order number.
point	Type: Point
related_orders	Type: RelatedOrdersById[]
status	Type: string Order status.
time_windows	Type: RouteInfoWindow[] Array of order's time windows.
time_zone	Type: string Time zone of order in tz database format, for example Europe/Moscow, Europe/Berlin, Asia/Irkutsk, Asia/Istanbul. Visit https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for more examples. It's calculated based on orders coordinates.

RouteInfoMetaCourierPosition_node

Name

Description

Type: integer

Index of route node courier must visit next.

Type: integer

Index of route node last visited by courier.

RouteInfoMetaLastUpdateInfo_courier_position

Name	Description
lat*	Type: number<float> Location latitude.
lon*	Type: number<float> Location longitude.
time	Type: LocalizedValue Courier position time.

LocalizedValue

Name

Description

text

Type: string

Localized text.

value

Type: number

Numeric representation of a value.

RouteInfoWindow

Name

Description

end

Type: LocalizedValue

End value of a window.

start

Type: LocalizedValue

Starting value of a window.

Point

Name

Description

lat*

Type: number<float>

Location latitude.

lon*

Type: number<float>

Location longitude.

RelatedOrdersById

Name

Description

action

Type: string

The action performed on the order: * delivery — deliver to this destination (can be a depot, garage and drop-off order). * pickup — load for delivery to another destination (it can be loaded from the depot, garage and pickup order).

Enum: delivery, pickup

Type: string

Order ID.

401 Unauthorized

Authorization failed. Send the correct OAuth token in the authorization header.

403 Forbidden

You do not have access to this object.

404 Not Found

Provided route_id does not exist.

422 Unprocessable Entity

Incorrect input.

Was the article helpful?

Overview