Gets multiple routes

  1. HTTP Request
  2. Path Parameters
  3. Query Parameters
  4. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 401
    3. Code 403
    4. Code 422
    5. Code 504

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.

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: 1.

page

integer

Page number where the entity is stored in the database. Each page contains 1000 entities arranged in ascending order.

Minimum value: 1.
Default value: 1.

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: 1.

page

integer

Page number where the entity is stored in the database. Each page contains 1000 entities arranged in ascending order.

Minimum value: 1.
Default value: 1.

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,
    "tracking_start_h": integer
  }
]
Copied to clipboard

Representation

Collapse all
Expand all

Fields

custom_fields[]

array

List of route custom fields. Max number of custom fields is 10.

custom_fields[].key

string

Key of custom field. Must correspond to one of route custom fields in company settings.

custom_fields[].value

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 IMEI of the GPS tracker installed on the vehicle on the route.

imei_str

string

String representation of numeric IMEI. Should be used in case integer overflow of numeric IMEI value in the programming language used. If defined in request, this takes precedence over the value of integer IMEI 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 date value, in the [d.]HH:MM:SS format. If specified, positions sent by GPS trackers and the app will be recorded only before the specified time.

route_start

string

Route start time relative to the date value, in the [d.]HH:MM:SS format. If specified:

  • Positions sent by GPS trackers and the app will be recorded only after route_start - tracking_start_h.
  • Order history START event will be added to order history only after the specified time.
  • Order status change SMS notification messages, if enabled, will be sent to clients only after the specified time.

routing_mode

string

Mode of routing. Possible values:

  • driving - courier drives a car.
  • truck - courier drives a truck.
  • transit - courier uses public transport and walks.
  • walking - courier walks.

tracking_start_h

integer

Route tracking will start tracking_start_h hours before route start. If route.route_start is specified, positions sent by GPS trackers and the app will be recorded only after route.route_start - route.tracking_start_h if route.tracking_start_h is specified, otherwise after route.route_start - company.tracking_start_h.

Minimum value: 0.
Maximum value: 24.

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.

custom_fields[]

array

List of route custom fields. Max number of custom fields is 10.

custom_fields[].key

string

Key of custom field. Must correspond to one of route custom fields in company settings.

custom_fields[].value

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 IMEI of the GPS tracker installed on the vehicle on the route.

imei_str

string

String representation of numeric IMEI. Should be used in case integer overflow of numeric IMEI value in the programming language used. If defined in request, this takes precedence over the value of integer IMEI 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 date value, in the [d.]HH:MM:SS format. If specified, positions sent by GPS trackers and the app will be recorded only before the specified time.

route_start

string

Route start time relative to the date value, in the [d.]HH:MM:SS format. If specified:

  • Positions sent by GPS trackers and the app will be recorded only after route_start - tracking_start_h.
  • Order history START event will be added to order history only after the specified time.
  • Order status change SMS notification messages, if enabled, will be sent to clients only after the specified time.

routing_mode

string

Mode of routing. Possible values:

  • driving - courier drives a car.
  • truck - courier drives a truck.
  • transit - courier uses public transport and walks.
  • walking - courier walks.

tracking_start_h

integer

Route tracking will start tracking_start_h hours before route start. If route.route_start is specified, positions sent by GPS trackers and the app will be recorded only after route.route_start - route.tracking_start_h if route.tracking_start_h is specified, otherwise after route.route_start - company.tracking_start_h.

Minimum value: 0.
Maximum value: 24.

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.

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.