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: 100

Min value: 1

Max value: 100

page_token

Type: string

Pagination token, can either be omitted or equal to next_page_token from the body of previos response.

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 page_token, which is equal to this field.

OrderItemGet

Name

Description

description*

Type: string

Description of the item.

Max length: 1023

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: 1

Max length: 80

price*

Type: string

Цена одной единицы товара.

Pattern: ^(0<code>&#124;</code>[1-9][0-9]*)(\.[0-9]{1,4})?$

total_count*

Type: integer

Общее количество товаров.

Min value: 1

Max value: 2147483647

undelivered_count*

Type: integer

Количество недоставленных товаров.

Min value: 0

Max value: 2147483647

code

Type: string

Code, necessary for grouping same order items.

Max length: 300

comment

Type: string

Comment.

Max length: 1023

400 Bad Request

Deprecated

Invalid parameters were passed.

401 Unauthorized

Deprecated

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

403 Forbidden

Deprecated

You do not have access to this object.

422 Unprocessable Entity

Deprecated

Incorrect input.

504 Gateway Timeout

Deprecated

Server error during request processing.

Previous
Deletes all items associated with the order
Next
Adds items associated with the order (synchronously)