Edits depot visit

Updates depot visit information by its ID.

Request

PATCH

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

Path parameters

Name

Description

company_id*

Type: integer

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

depot_visit_id*

Type: integer

Depot visit 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.

Body

application/json
{
    "status": "string"
}

Name

Description

status

Type: string

The current depot visit status. Possible values:

  • unvisited
  • visited

Responses

200 OK

Returns the updated depot visit.

Body

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

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 error. Make sure that the request header contains the correct OAuth token.

403 Forbidden

Error accessing the object. The user doesn't have the rights to access the object.

404 Not Found

Object search error. Object not found.

422 Unprocessable Entity

Incorrect input. The operation can't be performed.