Information about the set rates
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 the bid values for the specified products.
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 businesses/{businessId}/bids.
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/info
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: |
Query parameters
Name |
Description |
limit |
Type: integer<int32> The number of values per page.
|
page_token |
Type: string ID of the results page. If the parameter is omitted, the first page is returned. We recommend transmitting the value of the output parameter If set |
Body
application/json
{
"skus": [
"string"
]
}
Name |
Description |
skus |
Type: string[] A list of products for which you need to get bid values. If the list is not specified, all products with bids are returned page by page. If a list is specified, the results are returned in one page, and the parameters are 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
Bid values for the specified products. The response includes only products for which bids are set.
Body
application/json
{
"status": "OK",
"result": {
"bids": [
{
"sku": "string",
"bid": 570
}
],
"paging": {
"nextPageToken": "string"
}
}
}
Name |
Description |
result |
Type: GetBidsInfoResponseDTO A list of products with the specified bids. |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
GetBidsInfoResponseDTO
A list of products with the specified bids.
Name |
Description |
bids* |
Type: SkuBidItemDTO[] The product list page. |
paging |
Type: ForwardScrollingPagerDTO The ID of the next page. |
ApiResponseStatusType
The type of response. Possible values:
OK
— there are no mistakes.ERROR
— an error occurred while processing the request.
Type |
Description |
Enum: |
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: |
ForwardScrollingPagerDTO
The ID of the next page.
Name |
Description |
nextPageToken |
Type: string ID of the next results page. |
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 of the 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.