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

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

Request

GET

https://courier.yandex.ru/api/v1/companies/{company_id}/orders/{order_id}/items

Path parameters

Name

Description

company_id*

Type: integer<int64>

ID компании.

order_id*

Type: integer<int64>

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

Query parameters

Name

Description

max_results

Type: integer<int32>

Максимальное количество объектов, которые должны быть возвращены.

Default: 100

Min value: 1

Max value: 100

page_token

Type: string

Токен страницы, может быть либо опущен, либо равен next_page_token из тела предыдущего ответа.

Responses

200 OK

Успех.

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

Если присутствует, то есть следующая страница, и чтобы получить следующую страницу, этот URL-адрес можно вызвать с помощью page_token, который равен этому полю.

OrderItemGet

Name	Description
description*	Type: string Описание товара. Max length: `1023`
id*	Type: string ID товара.
number*	Type: string Номер товара. Идентификатор товара, созданный клиентом. Должен быть уникальным в рамках одного заказа. Min length: `1` Max length: `80`
price*	Type: string Price of one item. Pattern: `^(0<code>\|</code>[1-9][0-9]*)(\.[0-9]{1,4})?$`
total_count*	Type: integer<int32> Total count of items. Min value: `1`
undelivered_count*	Type: integer<int32> Count of undelivered items. Min value: `0`
code	Type: string Артикул позиции в заказе для группировки одинаковых товаров. Max length: `300`
comment	Type: string Комментарий. Max length: `1023`

400 Bad Request

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

401 Unauthorized

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

403 Forbidden

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

422 Unprocessable Entity

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

504 Gateway Timeout

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

Was the article helpful?

Удаляет весь товарный состав заказа

Добавляет товарный состав заказа (синхронно)