Enabling a sales boost and setting bids
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
Launches a sales boost — creates and activates a campaign, adds products to it and assigns bids on them.
What does a campaign created via the API look like in the dashboard?
When using the query for the first time, Market: creates a single campaign for all business account stores, adds products with the specified rates to it, includes a pricing strategy for them, and launches promotion. Reusing the query will allow you to update the bids for the products in this campaign or add new ones. Read more about the pricing strategy in Yandex.Market Help for sellers.
If there is no product with the specified SKU, it will be ignored. If an item with this SKU appears in the catalog in the future, it will automatically be added to the campaign with the specified bid.
The request always works with the same campaign created via the API. If you delete it in your account, the Market will create a new one the next time you make a request. You will not be able to manage other campaigns via the API. A campaign created through the API always has the highest priority over the others — it cannot be changed.
Query execution includes the campaign and pricing strategy, if they have been disabled.
You can make other changes to the campaign created via the API in the dashboard:
- disable or enable the campaign.
- change its name.
- disable or enable the pricing strategy.
To stop the promotion of individual products and remove them from the campaign, pass a zero bid for them in the parameter bid
.
Read more about how the sales boost works in Yandex.Market Help for sellers.
You can find out the cost of a sales boost by making a request POST campaigns/{campaignId}/stats/orders. The amount is contained in the field bidFee
.
The data is not updated instantly
It takes up to a few minutes.
, Limit: 1,000 requests per minute |
---|
Request
PUT
https://api.partner.market.yandex.ru/businesses/{businessId}/bids
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
{
"bids": [
{
"sku": "string",
"bid": 570
}
]
}
Name |
Description |
bids* |
Type: SkuBidItemDTO[] A list of products and the bids to be placed on them for promotion. Min items: Max items: |
SkuBidItemDTO
A list of products and bids for them.
Name |
Description |
bid* |
Type: integer<int32> The bid value for the product from the parameter It is indicated as a percentage of the cost of the product and multiplied by 100. For example, the 5% rate is indicated as 500. Example: Min value: Max value: |
sku* |
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: |
Responses
200 OK
Everything worked out: the bids were set or updated. If necessary, new products have been added and a campaign has been launched.
Body
application/json
{
"status": "OK"
}
Name |
Description |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
ApiResponseStatusType
The type of response. Possible values:
OK
— there are no mistakes.ERROR
— an error occurred while processing the request.
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.