Getting comments on a review

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 comments to the review, except for:

those that were deleted by users or Yandex.Market.
comments on deleted reviews.

You can also set up API notifications.

Yandex.Market will send you request when a new comment appears. 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 comments.

The comments 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/comments

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

{
    "feedbackId": 0,
    "commentIds": [
        0
    ]
}

Name

Description

commentIds

Type: integer<int64>[]

Comment IDs.

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

Min items: 1

Max items: 50

Unique items

feedbackId

Type: integer<int64>

The review ID.

Responses

200 OK

The tree of comments on the review.

Body

application/json

{
    "status": "OK",
    "result": {
        "comments": [
            {
                "id": 0,
                "text": "string",
                "canModify": false,
                "parentId": 0,
                "author": {
                    "type": "USER",
                    "name": "string"
                },
                "status": "PUBLISHED",
                "feedbackId": 0
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

result

Type: GoodsFeedbackCommentListDTO

Comments on the review.

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

GoodsFeedbackCommentListDTO

Comments on the review.

Name

Description

comments*

Type: GoodsFeedbackCommentDTO[]

A list of comments.
Comment on the 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`

GoodsFeedbackCommentDTO

Comment on the review.

Name	Description
feedbackId*	Type: integer<int64> The review ID.
id*	Type: integer<int64> ID of the review comment.
status*	Type: GoodsFeedbackCommentStatusType Comment status: `PUBLISHED` — published. `UNMODERATED` — not verified. `BANNED` — blocked. `DELETED` — deleted. Enum: `PUBLISHED`, `UNMODERATED`, `BANNED`, `DELETED`
text*	Type: string The text of the comment. Min length: `1` Max length: `4096`
author	Type: GoodsFeedbackCommentAuthorDTO Information about the comment's author.
canModify	Type: boolean Whether the seller can edit the comment or delete it.
parentId	Type: integer<int64> ID of the review comment.

ForwardScrollingPagerDTO

The ID of the next page.

Name

Description

nextPageToken

Type: string

ID of the next results page.

GoodsFeedbackCommentStatusType

Comment status:

PUBLISHED — published.
UNMODERATED — not verified.
BANNED — blocked.
DELETED — deleted.

Type	Description
GoodsFeedbackCommentStatusType	Enum: `PUBLISHED`, `UNMODERATED`, `BANNED`, `DELETED`

GoodsFeedbackCommentAuthorDTO

Information about the comment's author.

Name

Description

name

Type: string

The name of the author or the name of the cabinet.

type

Type: GoodsFeedbackCommentAuthorType

Type of author:

USER — the user.
BUSINESS — an office.

Enum: USER, BUSINESS

GoodsFeedbackCommentAuthorType

Type of author:

USER — the user.
BUSINESS — an office.

Type	Description
GoodsFeedbackCommentAuthorType	Enum: `USER`, `BUSINESS`

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

Was the article helpful?

All reviews

Adding/changing a comment