Gets depot visits of the route

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

Request

GET

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

Path parameters

Name

Description

company_id*

Type: integer

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

route_id*

Type: integer

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

Responses

200 OK

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

Body

application/json
[
    {
        "status": "string",
        "instance_id": 0
    }
]

DepotVisit[]

DepotVisit

Name

Description

instance_id

Type: integer

The ID of the depot visit involved in the route.

status

Type: string

The current depot visit status. Possible values:

  • unvisited
  • visited

401 Unauthorized

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

403 Forbidden

You do not have access to this object.