Starts searching for order items

Starts searching for order items. You can get information about the request processing using a GET /companies/{company_id}/orders/-/items:search/{search_id}/status.

Request

POST

https://courier.yandex.ru/api/v1/companies/{company_id}/orders/-/items:search

Path parameters

Name

Description

company_id*

Type: integer

The ID of the company.

Body

application/json
{
    "route_id": "string",
    "route_date": "string"
}

Name

Description

route_date

Type: string<date>

The route's date in YYYY-MM-DD format. Cannot be specified together with other parameters at the same time.

route_id

Type: string

The ID of the route. Cannot be specified together with other parameters at the same time.

Responses

202 Accepted

Request successfully queued.

Body

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

Name

Description

search_id*

Type: string

The ID of order items request.

400 Bad Request

Invalid parameters were passed.

401 Unauthorized

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

403 Forbidden

You do not have access to this object.

504 Gateway Timeout

Server error during request processing.