Gets multiple routes

Returns information about routes stored in the database.

Request

GET

https://courier.yandex.ru/api/v1/companies/{company_id}/routes

Path parameters

Name

Description

company_id*

Type: integer

Company ID used in requests to the Track & Trace API.

Query parameters

Name

Description

date

Type: string<date>

Delivery date in YYYY-MM-DD format.

depot_id

Type: integer

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

Min value: 1

number

Type: string

Unique route number that matches the number in the delivery company's database.

page

Type: integer

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

Default: 1

Min value: 1

Responses

200 OK

The list of routes was received.

Body

application/json
[
    {
        "custom_fields": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "date": "string",
        "id": 0,
        "imei": 0,
        "rented_courier_id": "string",
        "imei_str": "string",
        "number": "string",
        "route_start": "string",
        "route_finish": "string",
        "routing_mode": "string",
        "tracking_start_h": 0,
        "courier_violated_route": false,
        "company_id": 0,
        "courier_id": 0,
        "depot_id": 0,
        "track_start_timestamp": 0
    }
]

RouteWithTrackStartTimestamp[]

RouteWithTrackStartTimestamp

Name

Description

company_id

Type: integer

Company ID used in requests to the Track & Trace API.

courier_id

Type: integer

ID of the courier who delivers items on the route.

courier_violated_route

Type: boolean

Indicates if a courier visits orders' locations in the order that is different from the predefined order sequence.

custom_fields

Type: CustomField[]

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

Max items: 10

Min items: 0

date

Type: string<date>

The date of the route in YYYY-MM-DD format. Cannot be changed if there are orders on route.

depot_id

Type: integer

ID of the depot where the route starts.

id

Type: integer

Route ID used in requests to the Track & Trace API.

imei

Type: integer

The number of the GPS tracker installed on the vehicle on the route.

imei_str

Type: 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

Type: string

Route number. Used for syncing with the delivery company's system.

rented_courier_id

Type: string

Rented courier ID used in requests to the Track & Trace API.

route_finish

Type: 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

Type: 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

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.

track_start_timestamp

Type: integer

The time of the first position of the route track (UNIX timestamp).

tracking_start_h

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

Min value: 0

Max value: 24

CustomField

Name

Description

key

Type: string

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

Max length: 255

value

Type: string

Value of custom field.

Max length: 255

401 Unauthorized

Deprecated

Authorization error. Make sure that the request header contains the correct OAuth token.

403 Forbidden

Deprecated

You do not have access to this object.

422 Unprocessable Entity

Deprecated

Incorrect input. The operation can't be performed.

504 Gateway Timeout

Deprecated

Error working with the API. Repeat the request.

Previous
Overview
Next
Adds a route