Changing the statuses of multiple orders
The method is available for models: FBS, Express and DBS.
If you are using an API Key token, one of the accesses in the list is required to call the method
- inventory-and-order-processing — Order processing and inventory
- all-methods — Full account management
Changes the statuses of several orders.
Possible status changes:
- If the store has confirmed and prepared the order for shipment, then the order from the status
"status": "PROCESSING"and the processing stage"substatus": "STARTED"it needs to be converted to the status"status": "PROCESSING"and the processing stage"substatus": "READY_TO_SHIP". - If the store has confirmed the order, but cannot fulfill it (for example, the product is listed in the database, but is not in stock or does not have the desired color), then the order status
"status": "PROCESSING"and the processing stage"substatus": "STARTED"it needs to be converted to the status"status": "CANCELLED"with the reason for the cancellation of the order"substatus": "SHOP_FAILED". - If the store has prepared an order for shipment, but cannot complete it (for example, the last item was damaged or defective), then the order status is
"status": "PROCESSING"and the processing stage"substatus": "READY_TO_SHIP"it needs to be converted to the status"status": "CANCELLED"with the reason for the cancellation of the order"substatus": "SHOP_FAILED".
| ⚙️ Limit: 100,000 orders per hour |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/orders/status-update
Path parameters
|
Name |
Description |
|
campaignId* |
Type: integer<int64> The campaign ID. You can find it using a query GET v2/campaigns or find it in the seller's office on the Market — click on your account icon → Settings and in the menu on the left, select APIs and modules:
⚠️ Do not send the store ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports.
Min value: |
Body
application/json
{
"orders": [
{
"id": 0,
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED"
}
]
}
|
Name |
Description |
|
orders* |
Type: object[] The list of orders. Min items: Max items: |
Responses
200 OK
Information about updated order statuses is returned.
Body
application/json
{
"status": "OK",
"result": {
"orders": [
{
"id": 0,
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED",
"updateStatus": "OK",
"errorDetails": "string",
"operation": {
"id": "string",
"type": "ORDER_RECIPIENT_UPDATE"
}
}
]
}
}
|
Name |
Description |
||
|
status* |
Type: string The type of response. Possible values:
Enum: |
||
|
result |
Type: object
The list of orders whose status has been updated. |
400 Bad Request
The request contains incorrect data. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
401 Unauthorized
The authorization data is not specified in the request. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
403 Forbidden
The authorization data is incorrect or access to the resource is prohibited. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
404 Not Found
The requested resource was not found. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
420 Method Failure
The resource access limit has been exceeded. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
500 Internal Server Error
Internal error of the Market. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.