Получает товарный состав заказа.
Получает товарный состав заказа.
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 Максимальное количество объектов, которые должны быть возвращены. Минимальное значение: |
page_token | string Токен страницы, может быть либо опущен, либо равен next_page_token из тела предыдущего ответа. |
max_results | integer Максимальное количество объектов, которые должны быть возвращены. Минимальное значение: |
* Обязательный параметр
Ответы
Код 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[]. | string Комментарий. |
results[]. | string Описание товара. |
results[]. | string ID товара. |
results[]. | string Номер товара. Идентификатор товара, созданный клиентом. Должен быть уникальным в рамках одного заказа. |
results[]. | string Price of one item. |
results[]. | integer Total count of items. Минимальное значение: |
results[]. | integer Count of undelivered items. Минимальное значение: |
next_page_token | string Если присутствует, то есть следующая страница, и, чтобы получить следующую страницу, этот URL-адрес можно вызвать с помощью page_token, который равен этому полю. |
results[] * | array |
results[]. | string Комментарий. |
results[]. | string Описание товара. |
results[]. | string ID товара. |
results[]. | string Номер товара. Идентификатор товара, созданный клиентом. Должен быть уникальным в рамках одного заказа. |
results[]. | string Price of one item. |
results[]. | integer Total count of items. Минимальное значение: |
results[]. | integer Count of undelivered items. Минимальное значение: |
* Обязательный параметр
Код 400
Недопустимые параметры были переданы.
Код 401
Ошибка авторизации. Отправьте правильный OAuth-токен в заголовке авторизации.
Код 403
У вас нет доступа к этому объекту.
Код 422
Неправильный ввод.
Код 504
Ошибка сервера при обработке запроса.