Adds items associated with the order (sinchronously).

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

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

HTTP Request

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

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.

Request Body

[
  {
    "description": string,
    "number": string,
    "price": string,
    "total_count": integer
  }
]
Copied to clipboard

Representation

Collapse all
Expand all

Fields

description *

string

Description of the item.

number *

string

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

price *

string

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

total_count *

integer

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

Minimum value: 1.

description *

string

Description of the item.

number *

string

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

price *

string

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

total_count *

integer

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

Minimum value: 1.

Responses

Code 200

Success.

[
  {
    "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

comment

string

Comment.

description *

string

Description of the item.

id *

string

ID of the item.

number *

string

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

price *

string

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

total_count *

integer

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

Minimum value: 1.

undelivered_count *

integer

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

Minimum value: 0.

comment

string

Comment.

description *

string

Description of the item.

id *

string

ID of the item.

number *

string

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

price *

string

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

total_count *

integer

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

Minimum value: 1.

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.