Prices for product promotion
The method is available for all models.
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
- all-methods — Full account management
- all-methods:read-only — View all data
Do not use it, it may lead to errors. You can get information about prices using the "Market Prices" report.
The method is only for some stores
This method is only suitable for those stores that set prices for goods in rubles.
Returns prices for the promotion of products that you place on the Market.
The products for which prices need to be obtained are transmitted in the body of the POST request.
The prices for the promotion depend on the prices set for products by other stores. If several stores supply the same product, the lower-priced product is sold on the Market first. When the low-price product runs out, the higher-price product will start selling.
The output data contains several prices for each product, corresponding to different types of promotion.
You can set prices for products using a request. POST campaigns/{campaignId}/offer-prices/updates or in other ways: for example, specify them in a file with a directory. You can also use strategies to automatically set recommended prices or minimum prices on the Market.
Detailed information about automatic price management is provided in the Help of the Market for sellers.
, Limit: 100,000 products per hour |
---|
Request
POST
https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices/suggestions
Path parameters
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.
Min value: |
Body
application/json
{
"offers": [
{
"offerId": "string",
"marketSku": 0
}
]
}
Name |
Description |
offers* |
Type: SuggestOfferPriceDTO[] The list of products. Max items: |
SuggestOfferPriceDTO
The product for which you need to get prices for promotion.
Name |
Description |
marketSku |
Type: integer<int64> The ID of the product card on the Market. Min value: |
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: |
Responses
200 OK
A list of prices for promotion on the Market.
Body
application/json
{
"status": "OK",
"result": {
"offers": [
{
"marketSku": 0,
"offerId": "string",
"priceSuggestion": [
{
"type": "BUYBOX",
"price": 0
}
]
}
]
}
}
Name |
Description |
result |
Type: SuggestPricesResultDTO The result of a price request for promotion. |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
SuggestPricesResultDTO
The result of a price request for promotion.
Name |
Description |
offers* |
Type: PriceSuggestOfferDTO[] A list of products with prices for promotion. |
ApiResponseStatusType
The type of response. Possible values:
OK
— there are no mistakes.ERROR
— an error occurred while processing the request.
Type |
Description |
Enum: |
PriceSuggestOfferDTO
An item with prices for promotion.
Name |
Description |
marketSku |
Type: integer<int64> The ID of the product card on the Market. Min value: |
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: |
priceSuggestion |
Type: PriceSuggestDTO[] Prices for promotion.
Min items: |
PriceSuggestDTO
The type of price.
Name |
Description |
price |
Type: number The price is in rubles. |
type |
Type: PriceSuggestType The type of price. Enum: |
PriceSuggestType
Price type:
BUYBOX
— the lowest price for the product at which it is currently being sold. This price is updated in real time. If you set the price lower, your offer will start showing. If for this value in the parameterprice
the price shown is the same as yours, which means that your product is already being shown in the window. If other sellers besides you sell this product at the same price, their offers will also be displayed along with yours in turn.DEFAULT_OFFER
— the price recommended by the Market, which attracts buyers. It is calculated only for popular products on the service and is updated every four hours.MIN_PRICE_MARKET
— the minimum price on the Market. The lowest price among all product offers on the Market in all regions, including those that are not visible in the showcase. This price is updated in real time and provides more impressions on the Market than the lowest or recommended price.
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.