Adds items associated with the order (synchronously)

Adds items associated with the order (synchronously). Used for small amount items in order.

Request

POST

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

Path parameters

Name

Description

company_id*

Type: integer<int64>

The ID of the company.

order_id*

Type: integer<int64>

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

Body

application/json

[
    {
        "number": "string",
        "description": "string",
        "price": "string",
        "total_count": 0,
        "code": "string"
    }
]

OrderItemsCreate[]

OrderItemsCreate

Name	Description
description*	Type: string Description of the item. Max length: `1023`
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>\|</code>[1-9][0-9]*)(\.[0-9]{1,4})?$`
total_count*	Type: integer<int32> Общее количество товаров. Min value: `1`
code	Type: string Code, necessary for grouping same order items. Max length: `300`

Responses

200 OK

Success.

Body

application/json

[
    {
        "number": "string",
        "description": "string",
        "price": "string",
        "total_count": 0,
        "id": "string",
        "undelivered_count": 0,
        "comment": "string",
        "code": "string"
    }
]

OrderItemGet[]

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>\|</code>[1-9][0-9]*)(\.[0-9]{1,4})?$`
total_count*	Type: integer<int32> Общее количество товаров. Min value: `1`
undelivered_count*	Type: integer<int32> Количество недоставленных товаров. Min value: `0`
code	Type: string Code, necessary for grouping same order items. Max length: `300`
comment	Type: string Comment. Max length: `1023`

400 Bad Request

Invalid parameters were passed.

401 Unauthorized

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

403 Forbidden

You do not have access to this object.

422 Unprocessable Entity

Incorrect input.

504 Gateway Timeout

Server error during request processing.

Adds items associated with the order (synchronously)

Request

Path parameters

Body

OrderItemsCreate

Responses

200 OK

Body

OrderItemGet

400 Bad Request

401 Unauthorized

403 Forbidden

422 Unprocessable Entity

504 Gateway Timeout

Was the article helpful?