Gets the items associated with the order.

  1. HTTP Request
  2. Path Parameters
  3. Query Parameters
  4. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 400
    3. Code 401
    4. Code 403
    5. Code 422
    6. Code 504

Gets the items associated with the order.

HTTP Request

GET https://courier.yandex.ru/api/v1/companies/{company_id}/orders/{order_id}/items\
?page_token={string}\
&max_results={integer}

Path Parameters

company_id *

integer

The ID of the company.

order_id *

integer

Order ID that is used in requests to the Track & Trace API.

company_id *

integer

The ID of the company.

order_id *

integer

Order ID that is used in requests to the Track & Trace API.

Query Parameters

page_token

string

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

max_results

integer

Maximum number of entities to be returned.

Minimum value: 1.
Maximum value: 100.
Default value: 100.

page_token

string

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

max_results

integer

Maximum number of entities to be returned.

Minimum value: 1.
Maximum value: 100.
Default value: 100.

Responses

Code 200

Success.

{
  "next_page_token": string,
  "results": [
    {
      "comment": string,
      "description": string,
      "id": string,
      "number": string,
      "price": string,
      "total_count": integer,
      "undelivered_count": integer
    }
  ]
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

next_page_token

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.

results[] *

array

results[].comment

string

Comment.

results[].description *

string

Description of the item.

results[].id *

string

ID of the item.

results[].number *

string

Item number. It is the identifier of the item created by client. Must be unique within a single order.

results[].price *

string

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

results[].total_count *

integer

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

Minimum value: 1.

results[].undelivered_count *

integer

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

Minimum value: 0.

next_page_token

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.

results[] *

array

results[].comment

string

Comment.

results[].description *

string

Description of the item.

results[].id *

string

ID of the item.

results[].number *

string

Item number. It is the identifier of the item created by client. Must be unique within a single order.

results[].price *

string

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

results[].total_count *

integer

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

Minimum value: 1.

results[].undelivered_count *

integer

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

Minimum value: 0.

Code 400

Invalid parameters were passed.

Code 401

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

Code 403

You do not have access to this object.

Code 422

Incorrect input.

Code 504

Server error during request processing.