--- metadata: - name: generator content: Diplodoc Platform v5.55.0 alternate: - https://yandex.com/dev/market/partner-api/doc/en/step-by-step/boost.md - https://yandex.com/dev/market/partner-api/doc/ru/step-by-step/boost.md - https://yandex.com/dev/market/partner-api/doc/zh/step-by-step/boost.md - href: en/step-by-step/boost.md type: text/markdown title: Markdown version - href: ../llms.txt type: text/markdown title: llms.txt --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/market/partner-api/doc/en/llms.txt # Working with a sales boost You can use the API to launch a sales boost — create and enable a single campaign for all business account stores, add products to it and set bids for them. Manage such a campaign — add, update, delete, and receive bids on products — you can only use the API. 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. Read more about the pricing strategy in [Yandex.Market Help for sellers](https://yandex.ru/support/marketplace/marketing/campaigns.html#price-strategy). You will not be able to manage the campaigns that you created in your account via the API. ## How to get the recommended rates {#recommendations} To find out the recommended rates, make a request [POST v2/businesses/{businessId}/bids/recommendations](https://yandex.com/dev/market/partner-api/doc/en/reference/bids/getBidsRecommendations.md). ```mermaid %%{ init: { 'theme': 'base', 'themeVariables': { 'primaryColor': '#FDF3E8', 'primaryTextColor': '#000000', 'primaryBorderColor': '#BA9C80', 'lineColor': '#BA9C80', 'secondaryColor': '#94E1C4', 'tertiaryColor': '#F84E57', 'noteBkgColor': '#FED58D' } } }%% sequenceDiagram participant Merchant as Your store participant Market as Yandex Market rect rgb(251, 243, 232) note right of Merchant: Getting recommended bids Merchant ->>+ Market: POST v2/businesses/{businessId}/bids/recommendations Market ->> Market: Compiles a list
of recommended bids. Market -->>- Merchant: OK: list of recommended bids. end ``` ## How to create a campaign {#new-boost} Send information about the products (SKU) and their bids using a query [PUT v2/businesses/{businessId}/bids](https://yandex.com/dev/market/partner-api/doc/en/reference/bids/putBidsForBusiness.md). A new campaign is created the first time a request is used, or when it is repeated if you deleted a previously created campaign through the API in your account. ```mermaid %%{ init: { 'theme': 'base', 'themeVariables': { 'primaryColor': '#FDF3E8', 'primaryTextColor': '#000000', 'primaryBorderColor': '#BA9C80', 'lineColor': '#BA9C80', 'secondaryColor': '#94E1C4', 'tertiaryColor': '#F84E57', 'noteBkgColor': '#FED58D' } } }%% sequenceDiagram participant Merchant as Your store participant Market as Yandex Market rect rgb(251, 243, 232) note right of Merchant: Transfer of product information and their bids Merchant ->>+ Market: PUT v2/businesses/{businessId}/bids Market ->> Market: Creates a campaign,
adds products to it
with specified bids,
enables pricing strategy for them
and starts promotion. Market -->>- Merchant: OK end ``` ## How to get the set rates {#get-bids} To find out the values of the bids set via the API, make a request [POST v2/businesses/{businessId}/bids/info](https://yandex.com/dev/market/partner-api/doc/en/reference/bids/getBidsInfoForBusiness.md). {% note warning "You will not be able to get information on campaigns created in the cabinet." %} The response returns only the values of the rates that you set through the request. [PUT v2/businesses/{businessId}/bids](https://yandex.com/dev/market/partner-api/doc/en/reference/bids/putBidsForBusiness.md). {% endnote %} ```mermaid %%{ init: { 'theme': 'base', 'themeVariables': { 'primaryColor': '#FDF3E8', 'primaryTextColor': '#000000', 'primaryBorderColor': '#BA9C80', 'lineColor': '#BA9C80', 'secondaryColor': '#94E1C4', 'tertiaryColor': '#F84E57', 'noteBkgColor': '#FED58D' } } }%% sequenceDiagram participant Merchant as Your store participant Market as Yandex Market rect rgb(251, 243, 232) note right of Merchant: Getting the values of set bids Merchant ->> Market: POST v2/businesses/{businessId}/bids/info Market -->> Merchant: OK: list of set bids. end ``` ## How to change campaign data {#change-boost} You can update bids, add or remove products from a campaign created via the API using a request. [PUT v2/businesses/{businessId}/bids](https://yandex.com/dev/market/partner-api/doc/en/reference/bids/putBidsForBusiness.md). You can perform several actions in one request. — for example, add new products to the campaign and delete the old ones. ### Update bids {#change-bids} To update the bids for the products in the created campaign, make a request [PUT v2/businesses/{businessId}/bids](https://yandex.com/dev/market/partner-api/doc/en/reference/bids/putBidsForBusiness.md), where pass the new bid values. ```mermaid %%{ init: { 'theme': 'base', 'themeVariables': { 'primaryColor': '#FDF3E8', 'primaryTextColor': '#000000', 'primaryBorderColor': '#BA9C80', 'lineColor': '#BA9C80', 'secondaryColor': '#94E1C4', 'tertiaryColor': '#F84E57', 'noteBkgColor': '#FED58D' } } }%% sequenceDiagram participant Merchant as Your store participant Market as Yandex Market rect rgb(251, 243, 232) note right of Merchant: Bid updates Merchant ->>+ Market: Product and bid information
PUT v2/businesses/{businessId}/bids Market ->> Market: Updates bid information
for campaign products. Market -->>- Merchant: OK end ``` ### Add new products to the campaign {#add-goods} To add new products to the campaign, make a request [PUT v2/businesses/{businessId}/bids](https://yandex.com/dev/market/partner-api/doc/en/reference/bids/putBidsForBusiness.md), where to send information about new products (SKU) and their bids. ```mermaid %%{ init: { 'theme': 'base', 'themeVariables': { 'primaryColor': '#FDF3E8', 'primaryTextColor': '#000000', 'primaryBorderColor': '#BA9C80', 'lineColor': '#BA9C80', 'secondaryColor': '#94E1C4', 'tertiaryColor': '#F84E57', 'noteBkgColor': '#FED58D' } } }%% sequenceDiagram participant Merchant as Your store participant Market as Yandex Market rect rgb(251, 243, 232) note right of Merchant: Adding new products Merchant ->>+ Market: Information about new products and their bids
PUT v2/businesses/{businessId}/bids Market ->> Market: Adds to the campaign
information about new products
and their bids. Market -->>- Merchant: OK end ``` ### Remove products from the campaign {#delete-goods} To stop the promotion of certain products, make a request [PUT v2/businesses/{businessId}/bids](https://yandex.com/dev/market/partner-api/doc/en/reference/bids/putBidsForBusiness.md), where pass the zero bid in the field `bid` for those products that need to be removed from the campaign. ```mermaid %%{ init: { 'theme': 'base', 'themeVariables': { 'primaryColor': '#FDF3E8', 'primaryTextColor': '#000000', 'primaryBorderColor': '#BA9C80', 'lineColor': '#BA9C80', 'secondaryColor': '#94E1C4', 'tertiaryColor': '#F84E57', 'noteBkgColor': '#FED58D' } } }%% sequenceDiagram participant Merchant as Your store participant Market as Yandex Market rect rgb(251, 243, 232) note right of Merchant: Removing products from the campaign Merchant ->>+ Market: Product information,
to be removed from the campaign
PUT v2/businesses/{businessId}/bids Market ->> Market: Stops promotion
and removes specified products
from the campaign. Market -->>- Merchant: OK end ``` ## How to get a sales boost report {#get-report} For information on how to receive reports, see [step-by-step instructions](https://yandex.com/dev/market/partner-api/doc/en/step-by-step/reports.md).