Edits depot visit

  1. HTTP Request
  2. Path Parameters
  3. Request Body
    1. Representation
    2. Fields
  4. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 401
    3. Code 403
    4. Code 404
    5. Code 422

Updates depot visit information by its ID.

HTTP Request

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

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.

depot_visit_id *

integer

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

depot_visit_id *

integer

Depot visit ID used in requests to the Track & Trace API.

Request Body

{
  "status": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

status

string

The current depot visit status. Possible values:

  • unvisited
  • visited

status

string

The current depot visit status. Possible values:

  • unvisited
  • visited

Responses

Code 200

Returns the updated depot visit.

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

Code 403

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

Code 404

Object search error. Object not found.

Code 422

Incorrect input. The operation can't be performed.