Gets the items associated with the order
Gets the items associated with the order.
Request
GET
https://courier.yandex.ru/api/v1/companies/{company_id}/orders/{order_id}/items
Path parameters
|
Name |
Description |
|
company_id* |
Type: integer The ID of the company. |
|
order_id* |
Type: integer Order ID that is used in requests to the Track & Trace API. |
Query parameters
|
Name |
Description |
|
max_results |
Type: integer Maximum number of entities to be returned. Default: Min value: Max value: |
|
page_token |
Type: string Pagination token, can either be omitted or equal to |
Responses
200 OK
Success.
Body
application/json
{
"next_page_token": "string",
"results": [
{
"number": "string",
"description": "string",
"price": "string",
"total_count": 0,
"id": "string",
"undelivered_count": 0,
"comment": "string",
"code": "string"
}
]
}
|
Name |
Description |
|
results* |
Type: OrderItemGet[] |
|
next_page_token |
Type: string If present, then there is a next page, and, to get the next page, this url can be called with |
OrderItemGet
|
Name |
Description |
|
description* |
Type: string Description of the item. Max length: |
|
id* |
Type: string ID of the item. |
|
number* |
Type: string Item number. It is the identifier of the item created by client. Must be unique within a single order. Min length: Max length: |
|
price* |
Type: string Цена одной единицы товара. Pattern: |
|
total_count* |
Type: integer Общее количество товаров. Min value: Max value: |
|
undelivered_count* |
Type: integer Количество недоставленных товаров. Max value: |
|
code |
Type: string Code, necessary for grouping same order items. Max length: |
|
comment |
Type: string Comment. Max length: |
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.
422 Unprocessable Entity
Incorrect input.
504 Gateway Timeout
Server error during request processing.