Specify items for return

Specify items for return.

Request

POST

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

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
[
    {
        "item_id": "string",
        "undelivered_count": 0,
        "comment": "string"
    }
]

OrderItemReturn[]

OrderItemReturn

Name

Description

item_id*

Type: string

ID of the item.

undelivered_count*

Type: integer<int32>

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

Min value: 0

comment

Type: string

Comment.

Max length: 1023

Responses

200 OK

Success.

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.