Gets order items search request status.
Gets order items request information. Order items search is asynchronously, as it can take a long time. The user must wait for the operation status to be either success or error. In case of request status is success, order items search result can be obtained using a 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 The ID of the company. |
|
search_id* |
Type: string The ID of order items request. It is obtained in response to a request to search for order items. |
Responses
200 OK
Information about the asynchronous operation of order items search.
Body
application/json
{
"status": "in_progress",
"updated_at": {
"value": 0,
"text": "string"
},
"created_at": {
"value": 0,
"text": "string"
}
}
|
Name |
Description |
|
created_at* |
|
|
status* |
Type: string Status of request processing. Enum: |
|
updated_at* |
OrderItemsSearchStatus_created_at
|
Name |
Description |
|
text* |
Type: string The time of request creation, in ISO 8601 format. Example — '2018-09-06T10:15:00+00:00'. |
|
value* |
Type: number<integer> UNIX timestamp of request creation. |
OrderItemsSearchStatus_updated_at
|
Name |
Description |
|
text* |
Type: string The time of request update, in ISO 8601 format. Example — '2018-09-06T10:15:00+00:00'. |
|
value* |
Type: number<integer> UNIX timestamp of request update. |
401 Unauthorized
Authorization failed. Send the correct OAuth token in the authorization header.
403 Forbidden
You do not have access to this object.
422 Unprocessable Entity
This request does not exist.
504 Gateway Timeout
Server error during request processing.