Получает товарный состав заказа.

HTTP-запрос

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

Path-параметры

company_id *	integer ID компании.
order_id *	integer ID заказа, используемый в запросах к API Мониторинга.

* Обязательный параметр

Query-параметры

page_token	string Токен страницы, может быть либо опущен, либо равен next_page_token из тела предыдущего ответа.
max_results	integer Максимальное количество объектов, которые должны быть возвращены. Минимальное значение: `1`. Максимальное значение: `100`. Значение по умолчанию: `100`.

* Обязательный параметр

Ответы

Код 200

Успех.

{
  "next_page_token": string,
  "results": [
    {
      "comment": string,
      "description": string,
      "id": string,
      "number": string,
      "price": string,
      "total_count": integer,
      "undelivered_count": integer
    }
  ]
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

next_page_token	string Если присутствует, то есть следующая страница, и, чтобы получить следующую страницу, этот URL-адрес можно вызвать с помощью page_token, который равен этому полю.
results[] *	array
results[].comment	string Комментарий.
results[].description *	string Описание товара.
results[].id *	string ID товара.
results[].number *	string Номер товара. Идентификатор товара, созданный клиентом. Должен быть уникальным в рамках одного заказа.
results[].price *	string Price of one item.
results[].total_count *	integer Total count of items. Минимальное значение: `1`.
results[].undelivered_count *	integer Count of undelivered items. Минимальное значение: `0`.

* Обязательный параметр

Код 400

Недопустимые параметры были переданы.

Код 401

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

Код 403

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

Код 422

Неправильный ввод.

Код 504

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