Adds order items request for procesing
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 /api/v1/companies/{company_id}/orders/-/items-addings/{order_items_adding_id}.
Request
POST
https://courier.yandex.ru/api/v1/companies/{company_id}/orders/-/items-addings
Path parameters
|
Name |
Description |
|
company_id* |
Type: integer The ID of the company. |
Body
application/json
[
{
"order_id": 0,
"order_items": [
{
"number": "string",
"description": "string",
"price": "string",
"total_count": 0,
"code": "string"
}
]
}
]
OrderItemsPostRequest
|
Name |
Description |
|
order_id* |
Type: integer The ID of the order. |
|
order_items* |
Type: OrderItemsPostRequestElem[] Min items: |
OrderItemsPostRequestElem
|
Name |
Description |
|
description* |
Type: string Description of the item. Max length: |
|
number* |
Type: string Item number. It is the identifier of the item created by client. Must be unique within a single order. Min length: Max length: |
|
price* |
Type: string Цена одной единицы товара. Pattern: |
|
total_count* |
Type: integer Общее количество товаров. Min value: Max value: |
|
code |
Type: string Code, necessary for grouping same order items. Max length: |
Responses
202 Accepted
Request successfully queued.
Body
application/json
{
"order_items_adding_id": "string",
"message": "string"
}
|
Name |
Description |
|
message* |
Type: string Human-readable description of request result. |
|
order_items_adding_id* |
Type: string The ID of add items request. |
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.