Getting reviews of the seller's products

Info

Console

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

Path parameters

Name

Description

businessId

Type: integer

Cabinet ID. To find out, use the request GET v2/campaigns.

ℹ️ What is a cabinet and a store on the Market?

Min value: 1

Query parameters

Name

Description

limit

Type: integer

The number of values per page.

Min value: 1

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": "2020-02-02T14:30:30+03:00",
  "dateTimeTo": "2020-02-02T14:30:30+03:00",
  "updatedDateFrom": "2020-02-02T14:30:30+03:00",
  "updatedDateTo": "2020-02-02T14:30:30+03:00",
  "reactionStatus": "ALL",
  "ratingValues": [
    0
  ],
  "modelIds": [
    0
  ],
  "offerIds": [
    "example"
  ],
  "paid": true
}

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. The maximum interval is 6 months. Example: `2020-02-02T14:30:30+03:00`
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: `2020-02-02T14:30:30+03:00`
feedbackIds	Type: integer[] \| null 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: `1` Max items: `50` Unique items: `true` Example `[ 0 ]`
offerIds	Type: string[] \| null Filter by product ID. Min items: `1` Max items: `20` Unique items: `true` Example `[ "example" ]`
paid	Type: boolean Filter reviews for Plus points.
ratingValues	Type: integer[] \| null Product evaluation. Min items: `1` Max items: `5` Unique items: `true` Example `[ 0 ]`
reactionStatus	Type: string Response status to the review: `ALL` — all reviews. `NEED_REACTION` — reviews to respond to. Enum: `ALL`, `NEED_REACTION`

Responses

200 OK

A list of reviews.

Body

application/json

{
  "status": "OK",
  "result": {
    "feedbacks": [
      {
        "feedbackId": 0,
        "createdAt": "2025-01-01T00:00:00Z",
        "needReaction": true,
        "identifiers": {},
        "author": "example",
        "description": {},
        "media": {},
        "statistics": {}
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

Type: object

All of 2 types

Type: object
status

Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: object

feedbacks

Type: object[]

createdAt

Type: string<date-time>

The date and time when the review was created.

Example: 2025-01-01T00:00:00Z

feedbackId

Type: integer

The review ID.

identifiers

Type: object

offerId

Type: string

Your SKU — the product ID in your system.

Usage rules SKU:

For each product SKU there must be one.
Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

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, " SKU123 " and "SKU123" they will be treated as identical values.

What is SKU and how to assign it

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

Example: example

orderId

Type: integer

The order ID on the Market.

IDs that are associated with the review.

Example

{
  "orderId": 0,
  "offerId": "example"
}

needReaction

Type: boolean

Whether the review has been read.

Takes the value false If the store:

I read the review in the seller's office on the Market.
Marked the review as read — method POST v2/businesses/{businessId}/goods-feedback/skip-reaction.
Left a comment on the review — method POST v2/businesses/{businessId}/goods-feedback/comments/update.

statistics

Type: object

commentsCount	Type: integer The number of comments on the review. Only responses to reviews are counted, not child comments.
rating	Type: integer Product evaluation. Min value: `1` Max value: `5`
paidAmount	Type: integer The number of Plus points that the author received for the review.
recommended	Type: boolean Whether this product is recommended.

Statistical information about the review.

Example

{
  "rating": 1,
  "commentsCount": 0,
  "recommended": true,
  "paidAmount": 0
}

author

Type: string

The name of the review author.

Example: example

description

Type: object

advantages

Type: string

Description of the advantages of the product in the review.

Example: example

comment

Type: string

A comment in the review.

Example: example

disadvantages

Type: string

Description of the disadvantages of the product in the review.

Example: example

The text part of the review.

Example

{
  "advantages": "example",
  "disadvantages": "example",
  "comment": "example"
}

media

Type: object

photos

Type: string[] | null

Links to photos.

Min items: 1

Unique items: true

Example

[
  "example"
]

videos

Type: string[] | null

Links to the video.

Min items: 1

Unique items: true

Example

[
  "example"
]

Photos and videos.

Example

{
  "photos": [
    "example"
  ],
  "videos": [
    "example"
  ]
}

A list of reviews.

Example

[
  {
    "feedbackId": 0,
    "createdAt": "2025-01-01T00:00:00Z",
    "needReaction": true,
    "identifiers": {
      "orderId": 0,
      "offerId": "example"
    },
    "author": "example",
    "description": {
      "advantages": "example",
      "disadvantages": "example",
      "comment": "example"
    },
    "media": {
      "photos": [
        "example"
      ],
      "videos": [
        "example"
      ]
    },
    "statistics": {
      "rating": 1,
      "commentsCount": 0,
      "recommended": true,
      "paidAmount": 0
    }
  }
]

paging

Type: object

nextPageToken

Type: string

ID of the next results page.

Example: example

The ID of the next page.

Example

{
  "nextPageToken": "example"
}

A list of product reviews.

Example

{
  "feedbacks": [
    {
      "feedbackId": 0,
      "createdAt": "2025-01-01T00:00:00Z",
      "needReaction": true,
      "identifiers": {
        "orderId": 0,
        "offerId": "example"
      },
      "author": "example",
      "description": {
        "advantages": "example",
        "disadvantages": "example",
        "comment": "example"
      },
      "media": {
        "photos": [
          "example"
        ],
        "videos": [
          "example"
        ]
      },
      "statistics": {
        "rating": 1,
        "commentsCount": 0,
        "recommended": true,
        "paidAmount": 0
      }
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}

Example

{
  "result": {
    "feedbacks": [
      {
        "feedbackId": 0,
        "createdAt": "2025-01-01T00:00:00Z",
        "needReaction": true,
        "identifiers": {
          "orderId": 0,
          "offerId": "example"
        },
        "author": "example",
        "description": {
          "advantages": "example",
          "disadvantages": "example",
          "comment": "example"
        },
        "media": {
          "photos": [
            null
          ],
          "videos": [
            null
          ]
        },
        "statistics": {
          "rating": 1,
          "commentsCount": 0,
          "recommended": true,
          "paidAmount": 0
        }
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

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": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

404 Not Found

The requested resource was not found. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Was the article helpful?

Getting a given report or document

Comments on the review