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 the product with the specified SKU no, it will be ignored. If there is a product in the catalog in the future with this SKU it will be automatically 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 v2/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/v2/businesses/{businessId}/bids
Path parameters
|
Name |
Description |
|
businessId |
Type: integer Cabinet ID. To find out, use the request GET v2/campaigns. ℹ️ What is a cabinet and a store on the Market? Min value: |
Body
application/json
{
"bids": [
{
"sku": "example",
"bid": 570
}
]
}
|
Name |
Description |
||||
|
bids |
Type: object[]
A list of products and the bids to be placed on them for promotion. Min items: Max items: Example |
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"
}
Type: object
400 Bad Request
The request contains incorrect data. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
401 Unauthorized
The authorization data is not specified in the request. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
403 Forbidden
The authorization data is incorrect or access to the resource is prohibited. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
404 Not Found
The requested resource was not found. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
420 Method Failure
The resource access limit has been exceeded. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
500 Internal Server Error
Internal error of the Market. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
pathParams:
- description: "Cabinet ID. To find out, use the request [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md).\n\nℹ️ [What is a cabinet and a store on the Market?](https://yandex.ru/support/marketplace/account/introduction.html)\n"
name: businessId
in: path
required: true
schema:
type: integer
format: int64
minimum: 1
searchParams: []
headers: []
body: |-
{
"bids": [
{
"sku": "example",
"bid": 570
}
]
}
schema:
description: description.
type: object
required:
- bids
properties:
bids:
description: A list of products and the bids to be placed on them for promotion.
type: array
minItems: 1
maxItems: 1500
items:
description: A list of products and bids for them.
type: object
required:
- sku
- bid
properties:
sku:
description: "Your SKU —\_the product ID in your system.\n\nUsage rules SKU:\n\n* For each product SKU there must be one.\n\n* Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.\n\nSKU 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](https://yandex.ru/support2/marketplace/ru/assortment/operations/edit-sku).\n\n{% note warning %}\n\nSpaces at the beginning and end of the value are automatically deleted. For example, `\" SKU123 \"` and `\"SKU123\"` they will be treated as identical values.\n\n{% endnote %}\n\n[What is SKU and how to assign it](https://yandex.ru/support/marketplace/assortment/add/index.html#fields)\n"
type: string
pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$
x-transform: trim
minLength: 1
maxLength: 255
bid:
description: The value of the bid.
type: integer
format: int32
minimum: 0
maximum: 9999
example: 570
bodyType: application/json
method: put
security:
- type: apiKey
name: 'Api-Key'
in: header
- type: oauth2
x-inline: true
flows:
implicit:
authorizationUrl: https://oauth.yandex.ru/authorize
scopes:
market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/businesses/{businessId}/bids
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.