Recommended bids for specified products
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
- pricing:read-only — View prices
- promotion — Product promotion
- promotion:read-only — View promotion information
- all-methods — Full account management
- all-methods:read-only — View all data
Returns recommended bids for specified products, which provides your offers with a certain percentage of impressions and additional promotion tools.
One recommended bid or several may be returned for a single product. In the second case, different bids are intended to achieve a different percentage of impressions and obtain additional promotion tools.
If the product has just been added to the catalog, but is not yet on sale, there will be no recommended bid for it.
A single request can contain a maximum of 1,500 products.
, Limit: 1,000 requests per minute |
---|
Request
POST
https://api.partner.market.yandex.ru/businesses/{businessId}/bids/recommendations
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
{
"skus": [
"string"
]
}
Name |
Description |
skus* |
Type: string[] A list of products for which you need to get recommendations on rates.
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
Recommended bids for the specified products.
Body
application/json
{
"status": "OK",
"result": {
"recommendations": [
{
"sku": "string",
"bid": 570,
"bidRecommendations": [
{
"bid": 570,
"showPercent": 0,
"benefits": [
"BESTS"
]
}
],
"priceRecommendations": [
{
"campaignId": 0,
"price": 0
}
]
}
]
}
}
Name |
Description |
result |
Type: GetBidsRecommendationsResponseDTO A list of products with recommended rates. |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
GetBidsRecommendationsResponseDTO
A list of products with recommended rates.
Name |
Description |
recommendations* |
Type: SkuBidRecommendationItemDTO[] A list of products with recommended rates. |
ApiResponseStatusType
The type of response. Possible values:
OK
— there are no mistakes.ERROR
— an error occurred while processing the request.
Type |
Description |
Enum: |
SkuBidRecommendationItemDTO
A list of products with recommended rates.
Name |
Description |
bid* |
Type: integer<int32> The value of the recommended bid 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. The response is not empty. Don't pay attention to this field. 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: |
bidRecommendations |
Type: BidRecommendationItemDTO[] A list of recommended bids with the corresponding impression shares and available additional promotion tools. The higher the bid, the greater the share of impressions it helps to get and the more additional promotion tools are available.
Min items: |
priceRecommendations ⦸
|
Type: PriceRecommendationItemDTO[] Recommended prices. Min items: |
BidRecommendationItemDTO
The recommended bid, the possible percentage of impressions, and the additional promotion tools available.
Name |
Description |
bid* |
Type: integer<int32> The value of the recommended bid 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: |
showPercent* |
Type: integer<int64> The percentage of impressions. Min value: Max value: |
benefits |
Type: BenefitType[] A list of available subsidies. To get the necessary promotion tool, set the bid that will be recommended for this tool or higher.
Enum: Min items: Unique items |
PriceRecommendationItemDTO
The recommended price.
Name |
Description |
campaignId* |
Type: integer<int64> The campaign ID. You can find it using a query GET campaigns or find it in the seller's office on the Market — click on the name of your business and go to the page:
, Do not send the store ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports. |
price* |
Type: number<decimal> The recommended price for the product. In order for the promotion to work well, the price of the product should not be higher than this value. More information about recommended prices Min value: |
BenefitType
Types of additional promotion tools:
BESTS
— participation in the "Best Sellers of the Market" campaign.SPLIT_0_0_4
— the possibility of payment with a Split for a period of 4 months.SPLIT_0_0_6
— the possibility of paying with a Split for a period of 6 months.SPLIT_0_0_12
— the possibility of payment with a Split for a period of 12 months.MARKET_SUBSIDY_1_4
— discount from the Market from 1 to 4%.MARKET_SUBSIDY_5_9
— discount from the Market from 5 to 9%.MARKET_SUBSIDY_10
— discount from the Market starting from 10%.
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.