Removing products from the promotion
The method is available for all models.
Not yet available for Market Yandex Go sellers.
If you are using an API Key token, one of the accesses in the list is required to call the method
- pricing — Manage prices
- promotion — Product promotion
- all-methods — Full account management
Removes products from the promotion.
The changes begin to take effect within 4-6 hours.
, Limit: 10,000 requests per hour |
---|
Request
POST
https://api.partner.market.yandex.ru/businesses/{businessId}/promos/offers/delete
Path parameters
Name |
Description |
businessId* |
Type: integer<int64> Cabinet ID. To find out, use the request GET campaigns. ℹ️ What is a cabinet and a store on the Market?
Min value: |
Body
application/json
{
"promoId": "string",
"deleteAllOffers": false,
"offerIds": [
"string"
]
}
Name |
Description |
promoId* |
Type: string The ID of the promotion. |
deleteAllOffers |
Type: boolean To remove all products from the promotion and no longer participate in it, pass the value |
offerIds |
Type: string[] Products that need to be removed from the promotion. SKU Usage Rules:
The SKU of the product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers. What is a SKU and how to assign it Min length: Max length: Pattern: Min items: Max items: Unique items |
Responses
200 OK
The result of removing products from the promotion.
Body
application/json
{
"status": "OK",
"result": {
"rejectedOffers": [
{
"offerId": "string",
"reason": "OFFER_DOES_NOT_EXIST"
}
]
}
}
Name |
Description |
result |
Type: DeletePromoOffersResultDTO The result of removing products from the promotion. Returned only if the parameter was passed in the request. |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
DeletePromoOffersResultDTO
The result of removing products from the promotion.
Returned only if the parameter was passed in the request. offerIds
.
Name |
Description |
rejectedOffers |
Type: RejectedPromoOfferDeleteDTO[] Products that were deleted with errors. It is refunded only if there are such items.
Min items: |
ApiResponseStatusType
The type of response. Possible values:
OK
— there are no mistakes.ERROR
— an error occurred while processing the request.
Type |
Description |
Enum: |
RejectedPromoOfferDeleteDTO
Information about the product and errors that appeared when it was deleted.
Name |
Description |
offerId* |
Type: string Your SKU is the product identifier in your system. SKU Usage Rules:
The SKU of the product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers. What is a SKU and how to assign it Min length: Max length: Pattern: |
reason* |
Type: RejectedPromoOfferDeleteReasonType Error description:
Enum: |
RejectedPromoOfferDeleteReasonType
Error description:
OFFER_DOES_NOT_EXIST
— there is no product with such a SKU in the cabinet.
Type |
Description |
Enum: |
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: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
ApiErrorDTO
The general error format.
Name |
Description |
code* |
Type: string The error code. |
message |
Type: string Description of the error. |
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: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType 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: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType 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: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType 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: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType 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: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.