Gets depot visits of the route

  1. HTTP Request
  2. Path Parameters
  3. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 401
    3. Code 403

Gets a list of depot visits in the order they are located in the route.

HTTP Request

GET https://courier.yandex.ru/api/v1/companies/{company_id}/routes/{route_id}/depot-visits

Path Parameters

company_id *

integer

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

route_id *

integer

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

company_id *

integer

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

route_id *

integer

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

Responses

Code 200

Returns a list of depot visits in the order they are located in the route.

[
  {
    "instance_id": integer,
    "status": string
  }
]
Copied to clipboard

Representation

Collapse all
Expand all

Fields

status

string

The current depot visit status. Possible values:

  • unvisited
  • visited

instance_id

integer

The ID of the depot visit involved in the route.

status

string

The current depot visit status. Possible values:

  • unvisited
  • visited

instance_id

integer

The ID of the depot visit involved in the route.

Code 401

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

Code 403

You do not have access to this object.