Getting reviews of the seller's products
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
- communication — Customer communication
- all-methods — Full account management
- all-methods:read-only — View all data
Returns reviews of the seller's products using the specified filters. Exception: reviews that were deleted by customers or the Market.
You can also set up API notifications.
Yandex.Market will send you request when there is a new review. And full information about it can be obtained using this method.
The results are returned page by page, one page contains no more than 50 reviews.
The reviews are arranged in the order of publication, so you can send a specific page ID to page_token if you have received it before.
| ⚙️ Limit: 1,000 requests per hour |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/businesses/{businessId}/goods-feedback
Path parameters
|
Name |
Description |
|
businessId* |
Type: integer<int64> Cabinet ID. To find out, use the request GET v2/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.
Min value: |
|
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
{
"feedbackIds": [
0
],
"dateTimeFrom": "2020-02-02T14:30:30+03:00",
"dateTimeTo": "2020-02-02T14:30:30+03:00",
"reactionStatus": "ALL",
"ratingValues": [
0
],
"offerIds": [
"string"
],
"paid": false
}
|
Name |
Description |
|
dateTimeFrom |
Type: string<date-time> The beginning of the period. Not inclusive. If the parameter is omitted, the information is returned 6 months before the date specified in The maximum interval is 6 months. Example: |
|
dateTimeTo |
Type: string<date-time> End of the period. Not inclusive. If the parameter is omitted, the current date is used. The maximum interval is 6 months. Example: |
|
feedbackIds |
Type: integer[] Review IDs. ⚠️ Do not use this field at the same time as other filters. If you want to use them, leave the field empty.
Min items: Max items: Unique items |
|
offerIds |
Type: string[] Filter by product ID.
Usage rules SKU:
SKU 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. Warning Spaces at the beginning and end of the value are automatically deleted. For example, What is SKU and how to assign it Min length: Max length: Pattern: Min items: Max items: Unique items |
|
paid |
Type: boolean Filter reviews for Plus points. |
|
ratingValues |
Type: integer[] Product evaluation. Min items: Max items: Unique items |
|
reactionStatus |
Type: string Response status to the review:
Enum: |
Responses
200 OK
A list of reviews.
Body
application/json
{
"status": "OK",
"result": {
"feedbacks": [
{
"feedbackId": 0,
"createdAt": "2022-12-29T18:02:01Z",
"needReaction": false,
"identifiers": {
"orderId": 0,
"offerId": "string"
},
"author": "string",
"description": {
"advantages": "string",
"disadvantages": "string",
"comment": "string"
},
"media": {
"photos": [
"string"
],
"videos": [
"string"
]
},
"statistics": {
"rating": 0,
"commentsCount": 0,
"recommended": false,
"paidAmount": 0
}
}
],
"paging": {
"nextPageToken": "string"
}
}
}
|
Name |
Description |
||||||
|
status* |
Type: string The type of response. Possible values:
Enum: |
||||||
|
result |
Type: object
A list of product reviews. |
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: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
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: object[] A list of errors. Min items: |
|
status |
Type: string 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: object[] A list of errors. Min items: |
|
status |
Type: string 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: object[] A list of errors. Min items: |
|
status |
Type: string 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: object[] A list of errors. Min items: |
|
status |
Type: string 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: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.