Получение комментариев к отзыву

Info

Console

Метод доступен для всех моделей.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

communication — Общение с покупателями
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Возвращает комментарии к отзыву, кроме:

тех, которые удалили пользователи или Маркет;
комментариев к удаленным отзывам.

Вы также можете настроить API-уведомления

Маркет отправит вам запрос, когда появится новый комментарий. А полную информацию о нем можно получить с помощью этого метода.

Как работать с уведомлениями

Результаты возвращаются постранично, одна страница содержит не более 50 комментариев.

Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.

⚙️ Лимит: 1 000 запросов в час

Request

POST

https://api.partner.market.yandex.ru/v2/businesses/{businessId}/goods-feedback/comments

Path parameters

Name

Description

businessId*

Type: integer<int64>

Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

Количество значений на одной странице.

Min value: 1
Example: 20

page_token

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуем передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры page и pageSize, они игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json

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

Name

Description

commentIds

Type: integer<int64>[]

Идентификаторы комментариев.

⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым.
Идентификатор комментария к отзыву.

Min items: 1

Max items: 50

Unique items

feedbackId

Type: integer<int64>

Идентификатор отзыва.

Responses

200 OK

Дерево комментариев к отзыву.

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

status*

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

result

Type: GoodsFeedbackCommentListDTO

Комментарии к отзыву.

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

GoodsFeedbackCommentListDTO

Комментарии к отзыву.

Name

Description

comments*

Type: GoodsFeedbackCommentDTO[]

Список комментариев.
Комментарий к отзыву.

paging

Type: ForwardScrollingPagerDTO

Идентификатор следующей страницы.

GoodsFeedbackCommentDTO

Комментарий к отзыву.

Name	Description
feedbackId*	Type: integer<int64> Идентификатор отзыва.
id*	Type: integer<int64> Идентификатор комментария к отзыву.
status*	Type: GoodsFeedbackCommentStatusType Статус комментария: `PUBLISHED` — опубликован. `UNMODERATED` — не проверен. `BANNED` — заблокирован. `DELETED` — удален. Enum: `PUBLISHED`, `UNMODERATED`, `BANNED`, `DELETED`
text*	Type: string Текст комментария. Не должен содержать контакты магазина и ссылки на сайты, кроме Маркета. Min length: `1` Max length: `4096`
author	Type: GoodsFeedbackCommentAuthorDTO Информация об авторе комментария.
canModify	Type: boolean Может ли продавец изменять комментарий или удалять его.
parentId	Type: integer<int64> Идентификатор комментария к отзыву.

ForwardScrollingPagerDTO

Идентификатор следующей страницы.

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

GoodsFeedbackCommentStatusType

Статус комментария:

PUBLISHED — опубликован.
UNMODERATED — не проверен.
BANNED — заблокирован.
DELETED — удален.

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

GoodsFeedbackCommentAuthorDTO

Информация об авторе комментария.

Name

Description

name

Type: string

Имя автора или название кабинета.

type

Type: GoodsFeedbackCommentAuthorType

Тип автора:

USER — пользователь.
BUSINESS — кабинет.

Enum: USER, BUSINESS

GoodsFeedbackCommentAuthorType

Тип автора:

USER — пользователь.
BUSINESS — кабинет.

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

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

Была ли статья полезна?

Все отзывы

Добавление/изменение комментария