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.

How to work with notifications

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/businesses/{businessId}/goods-feedback

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: 1

Query parameters

Name

Description

limit

Type: integer<int32>

The number of values per page.

Min value: 1
Example: 20

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 nextPageToken, received during the last request.

If set page_token and the request has parameters page and pageSize they are ignored.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json
{
    "feedbackIds": [
        0
    ],
    "dateTimeFrom": "2022-12-29T18:02:01Z",
    "dateTimeTo": "2022-12-29T18:02:01Z",
    "reactionStatus": "ALL",
    "ratingValues": [
        0
    ],
    "modelIds": [
        0
    ],
    "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 dateTimeTo dates.

dateTimeTo

Type: string<date-time>

End of the period. Not inclusive.

If the parameter is omitted, the current date is used.

feedbackIds

Type: integer<int64>[]

Review IDs.

, Do not use this field at the same time as other filters. If you want to use them, leave the field empty.
The review ID.

Min items: 1

Max items: 50

Unique items  

modelIds

Type: integer<int64>[]

Filter by product model ID.

You can get the model ID using one of the following requests:

Min items: 1

Max items: 20

Unique items  

paid

Type: boolean

Filter reviews for Plus points.

ratingValues

Type: integer<int32>[]

Product evaluation.

Min items: 1

Max items: 5

Unique items  

reactionStatus

Type: FeedbackReactionStatusType

Do I need to return only unread reviews? To do this, pass the value NEED_REACTION.

By default, all reviews are returned.

Enum: ALL, NEED_REACTION

FeedbackReactionStatusType

Response status to the review:

  • ALL — all reviews.

  • NEED_REACTION — reviews that need to be answered.

Type

Description

FeedbackReactionStatusType

Enum: ALL, NEED_REACTION

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,
                    "modelId": 0
                },
                "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

result

Type: GoodsFeedbackListDTO

A list of product reviews.

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

GoodsFeedbackListDTO

A list of product reviews.

Name

Description

feedbacks*

Type: GoodsFeedbackDTO[]

A list of reviews.
Product review.

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

ApiResponseStatusType

Enum: OK, ERROR

GoodsFeedbackDTO

Product review.

Name

Description

createdAt*

Type: string<date-time>

The date and time when the review was created.

feedbackId*

Type: integer<int64>

The review ID.

identifiers*

Type: GoodsFeedbackIdentifiersDTO

IDs that are associated with the review.

needReaction*

Type: boolean

Whether the review has been read.

Takes the value false If the store:

statistics*

Type: GoodsFeedbackStatisticsDTO

Statistical information about the review.

author

Type: string

The name of the review author.

description

Type: GoodsFeedbackDescriptionDTO

The text part of the review.

media

Type: GoodsFeedbackMediaDTO

Photos and videos.

ForwardScrollingPagerDTO

The ID of the next page.

Name

Description

nextPageToken

Type: string

ID of the next results page.

GoodsFeedbackIdentifiersDTO

IDs that are associated with the review.

Name

Description

modelId

Type: integer<int64>

The product model ID.

orderId

Type: integer<int64>

The order ID on the Market.

GoodsFeedbackStatisticsDTO

Statistical information about the review.

Name

Description

commentsCount*

Type: integer<int64>

The number of comments on the review.

Only responses to reviews are counted, not child comments.

rating*

Type: integer<int32>

Product evaluation.

Min value: 1

Max value: 5

paidAmount

Type: integer<int64>

The number of Plus points that the author received for the review.

recommended

Type: boolean

Whether this product is recommended.

GoodsFeedbackDescriptionDTO

The text part of the review.

Name

Description

advantages

Type: string

Description of the advantages of the product in the review.

comment

Type: string

A comment in the review.

disadvantages

Type: string

Description of the disadvantages of the product in the review.

GoodsFeedbackMediaDTO

Photos and videos.

Name

Description

photos

Type: string[]

Links to photos.

Min items: 1

Unique items  

videos

Type: string[]

Links to the video.

Min items: 1

Unique items  

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.