Adds order items request for procesing.

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

Adds order items request for procesing. In case of success, specified items will be added to specified orders. You can get information about the request processing using a GET /companies/{company_id}/orders/-/items-addings/{order_items_adding_id}

HTTP Request

POST https://courier.yandex.ru/companies/{company_id}/orders/-/items-addings

Path Parameters

company_id *

integer

The ID of the company.

company_id *

integer

The ID of the company.

Request Body

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

Representation

Collapse all
Expand all

Fields

order_id *

integer

The ID of the order.

order_items[] *

array

order_items[].description *

string

Description of the item.

order_items[].number *

string

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

order_items[].price *

string

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

order_items[].total_count *

integer

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

Minimum value: 1.

order_id *

integer

The ID of the order.

order_items[] *

array

order_items[].description *

string

Description of the item.

order_items[].number *

string

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

order_items[].price *

string

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

order_items[].total_count *

integer

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

Minimum value: 1.

Responses

Code 202

Request successfully queued.

{
  "message": string,
  "order_items_adding_id": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

message *

string

Human-readable description of request result.

order_items_adding_id *

string

The ID of add items request.

message *

string

Human-readable description of request result.

order_items_adding_id *

string

The ID of add items request.

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.