Получает информацию о запросе поиска товарного состава.

Получает информацию о запросе поиска товарного состава. Поиск товарного состава сделан асинхронным, так как может занимать много времени. Пользователь должен дождаться, когда статус операции будет либо success, либо error. Если статус запроса success, то результат поиска товарного состава можно получить с помощью GET /companies/{company_id}/orders/-/items:search/{search_id}/result.

Request

GET

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

Path parameters

Name

Description

company_id*

Type: integer<int64>

ID компании.

search_id*

Type: string

ID запроса на поиск товарного состава. Получается в ответе на запрос поиска товарного состава.

Responses

200 OK

Информация об асинхронной операции поиска товарного состава.

Body

application/json
{
    "status": "in_progress",
    "updated_at": {
        "value": 0,
        "text": "string"
    },
    "created_at": {
        "value": 0,
        "text": "string"
    }
}

Name

Description

created_at*

Type: OrderItemsSearchStatus_created_at

status*

Type: string

Статус обработки запроса. error: ошибка на стороне сервера. in_progress: обработка запроса в процессе, надо подождать некоторое время. success: поиск товарного состава успешно завершён.

Enum: in_progress, success, error

updated_at*

Type: OrderItemsSearchStatus_updated_at

OrderItemsSearchStatus_created_at

Name

Description

text*

Type: string

Время создания запроса в формате ISO 8601. Пример — '2018-09-06T10:15:00+00:00'.

value*

Type: number

UNIX timestamp создания запроса.

OrderItemsSearchStatus_updated_at

Name

Description

text*

Type: string

Время обновления запроса в формате ISO 8601. Пример — '2018-09-06T10:15:00+00:00'.

value*

Type: number

UNIX timestamp обновления запроса.

401 Unauthorized

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

403 Forbidden

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

422 Unprocessable Entity

Данный запрос не существует.

504 Gateway Timeout

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

Previous
Получает результат поиска товарного состава
Next
Обзор