Создаёт запрос на поиск товарного состава

Создаёт запрос на поиск товарного состава. Получить информацию о процессе обработки запроса можно с помощью 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<int64>

ID компании.

Body

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

Name

Description

route_date

Type: string<date>

Дата маршрута, в формате YYYY-MM-DD. Не может быть одновременно указана вместе с другими параметрами.

route_id

Type: string

ID маршрута. Не может быть одновременно указано вместе с другими параметрами.

Responses

202 Accepted

Запрос успешно добавлен в обработку.

Body

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

Name

Description

search_id*

Type: string

ID запроса на поиск товарного состава.

400 Bad Request

Недопустимые параметры.

401 Unauthorized

Ошибка авторизации. Отправьте правильный OAuth-токен в заголовке авторизации.

403 Forbidden

У вас нет доступа к этому объекту.

504 Gateway Timeout

Ошибка сервера при обработке запроса.