Removing items from an order or reducing their number
The method is available for the DBS model.
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
If you work according to the model FBS
Use the method PUT v2/campaigns/{campaignId}/orders/{orderId}/boxes.
Deletes one or more items from the order if the store cannot deliver them all.
The order must have the status "status": "PROCESSING" the processing stage "substatus": "STARTED". The composition cannot be changed after the transfer of the status "substatus": "READY_TO_SHIP".
Reduce the number of identical products
Pass the updated value in the parameter count.
Delete an item from an order
Pass the value 0 in the parameter count or don't pass it on item.
You cannot delete or reduce the quantity of an item if it:
- added by special offer;
- amounts to 99% of the order value;
- the only product in the order.
In this case, cancel the order. — in the method PUT v2/campaigns/{campaignId}/orders/{orderId}/status send the order status CANCELLED with the reason for cancellation SHOP_FAILED.
How will the money be refunded
If the customer paid for the product at checkout, the Market will refund the money for the items removed from the order within two days:
-
when paying with a bank card — from the moment when the store transfers the order to the status
SHIPPED; -
when paying via Apple Pay or Google Pay — from the moment when the store removes the product from the order.
| ⚙️ Limit: 100,000 requests per hour |
|---|
Request
PUT
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/orders/{orderId}/items
Path parameters
|
Name |
Description |
|
campaignId* |
Type: integer<int64> The store's 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:
⚠️ It does not match the store's ID (which is indicated in the merchant's account on the Market next to the store's name and in some reports). It is linked to the store one-to-one. Does not apply to advertising campaigns.
Min value: |
|
orderId* |
Type: integer<int64> The order ID. |
Body
application/json
{
"items": [
{
"id": 0,
"count": 0,
"instances": [
{
"cis": "string",
"uin": "string",
"rnpt": "string",
"gtd": "string",
"countryCode": "RU"
}
]
}
],
"reason": "PARTNER_REQUESTED_REMOVE"
}
|
Name |
Description |
|
items* |
Type: object[] The list of products in the order. If the store has not provided information about the product in the input data, it will be removed from the order. Required parameter.
If the store has not provided information about the product in the input data, it will be removed from the order. Required parameter. Min items: |
|
reason |
Type: string The reason why the order composition has been updated:
Enum: |
Responses
200 OK
Yandex. Market has successfully processed your request. No output is expected.
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 in Yandex. 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.
Meaning cis must match the regular expression ^(?=.{1,256}$)\u001D?(\(?01\)?\d{14}\(?21\)?([!-~]{6,8}|[!-~]{13}|[!-~]{20})(\u001D\(?240\)?.{1,30})?\u001D\(?9[1,3]\)?.+)$.
Without the cryptotail — ^(?=[!-~]{1,256}$)(\(?01\)?\d{14}\(?21\)?(.{6,8}|.{13}|.{20}))$.