Gets multiple routes
Returns information about routes stored in the database.
HTTP Request
GET https://courier.yandex.ru/api/v1/companies/{company_id}/routes\
?number={string}\
&date={string}\
&depot_id={integer}\
&page={integer}
Path Parameters
company_id * | integer Company ID used in requests to the Track & Trace API. |
company_id * | integer Company ID used in requests to the Track & Trace API. |
* Required parameter
Query Parameters
number | string Unique route number that matches the number in the delivery company's database. |
date | string Delivery date in YYYY-MM-DD format. |
depot_id | integer The ID of the depot that is used in requests to the Track & Trace API. Minimum value: |
page | integer Page number where the entity is stored in the database. Each page contains 1000 entities arranged in ascending order. Minimum value: |
number | string Unique route number that matches the number in the delivery company's database. |
date | string Delivery date in YYYY-MM-DD format. |
depot_id | integer The ID of the depot that is used in requests to the Track & Trace API. Minimum value: |
page | integer Page number where the entity is stored in the database. Each page contains 1000 entities arranged in ascending order. Minimum value: |
* Required parameter
Responses
Code 200
The list of routes was received.
[ { "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 } ]
Copied to clipboard
Representation
Fields
custom_fields[] | array List of route custom fields. Max number of custom fields is 10. |
custom_fields[]. | string Key of custom field. Must correspond to one of route custom fields in company settings. |
custom_fields[]. | string Value of custom field. |
date | string The date of the route in YYYY-MM-DD format. Cannot be changed if there are orders on route. |
id | integer Route ID used in requests to the Track & Trace API. |
imei | integer The number of the GPS tracker installed on the vehicle on the route. |
imei_str | string String representation of numeric number of a GPS tracker. Should be used in case integer overflow of numeric number of a GPS tracker value in the programming language used. If defined in request, this takes precedence over the value of integer number of a GPS tracker field. |
number | string Route number. Used for syncing with the delivery company's system. |
rented_courier_id | string Rented courier ID used in requests to the Track & Trace API. |
route_finish | string Route finish time relative to the |
route_start | string Route start time relative to the
|
routing_mode | string Transportation method. Possible values:
|
tracking_start_h | integer Route tracking will start Minimum value: |
company_id | integer Company ID used in requests to the Track & Trace API. |
courier_id | integer ID of the courier who delivers items on the route. |
courier_violated_route | boolean Indicates if a courier visits orders' locations in the order that is different from the predefined order sequence. |
depot_id | integer ID of the depot where the route starts. |
track_start_timestamp | integer The time of the first position of the route track (UNIX timestamp). |
custom_fields[] | array List of route custom fields. Max number of custom fields is 10. |
custom_fields[]. | string Key of custom field. Must correspond to one of route custom fields in company settings. |
custom_fields[]. | string Value of custom field. |
date | string The date of the route in YYYY-MM-DD format. Cannot be changed if there are orders on route. |
id | integer Route ID used in requests to the Track & Trace API. |
imei | integer The number of the GPS tracker installed on the vehicle on the route. |
imei_str | string String representation of numeric number of a GPS tracker. Should be used in case integer overflow of numeric number of a GPS tracker value in the programming language used. If defined in request, this takes precedence over the value of integer number of a GPS tracker field. |
number | string Route number. Used for syncing with the delivery company's system. |
rented_courier_id | string Rented courier ID used in requests to the Track & Trace API. |
route_finish | string Route finish time relative to the |
route_start | string Route start time relative to the
|
routing_mode | string Transportation method. Possible values:
|
tracking_start_h | integer Route tracking will start Minimum value: |
company_id | integer Company ID used in requests to the Track & Trace API. |
courier_id | integer ID of the courier who delivers items on the route. |
courier_violated_route | boolean Indicates if a courier visits orders' locations in the order that is different from the predefined order sequence. |
depot_id | integer ID of the depot where the route starts. |
track_start_timestamp | integer The time of the first position of the route track (UNIX timestamp). |
* Required parameter
Code 401
Authorization error. Make sure that the request header contains the correct OAuth token.
Code 403
You do not have access to this object.
Code 422
Incorrect input. The operation can't be performed.
Code 504
Error working with the API. Repeat the request.