Gets order sequence

Gets predefined order sequence from the route.

Request

GET

https://courier.yandex.ru/api/v1/companies/{company_id}/routes/{route_id}/order-sequence

Path parameters

Name

Description

company_id*

Type: integer<int64>

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

route_id*

Type: integer<int64>

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

Responses

200 OK

Returns list of order IDs.

Body

application/json
{
    "order_ids": [
        4789,
        4790,
        5245
    ],
    "order_numbers": [
        "order_num_1",
        "order_num_2",
        "order_num_3"
    ]
}

Name

Description

order_ids*

Type: integer[]

Example: 4789,4790,5245

order_numbers*

Type: string[]

Example: order_num_1,order_num_2,order_num_3

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

No object found.

Previous
Sets route nodes and their sequence in the route
Next
Sets the order of deliveries in the route