Получение отзывов о товарах продавца

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

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

{
    "feedbackIds": [
        0
    ],
    "dateTimeFrom": "2022-12-29T18:02:01Z",
    "dateTimeTo": "2022-12-29T18:02:01Z",
    "reactionStatus": "ALL",
    "ratingValues": [
        0
    ],
    "modelIds": [
        0
    ],
    "offerIds": [
        "string"
    ],
    "paid": false
}

Name	Description
dateTimeFrom	Type: string<date-time> Начало периода. Не включительно. Если параметр не указан, возвращается информация за 6 месяцев до указанной в `dateTimeTo` даты. Максимальный интервал 6 месяцев.
dateTimeTo	Type: string<date-time> Конец периода. Не включительно. Если параметр не указан, используется текущая дата. Максимальный интервал 6 месяцев.
feedbackIds	Type: integer[] Идентификаторы отзывов. ⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. Идентификатор отзыва. Min items: `1` Max items: `50` Unique items
modelIds ⦸	Type: integer[] Фильтр по идентификатору модели товара. Получить идентификатор модели можно с помощью одного из запросов: POST v2/businesses/{businessId}/offer-mappings; POST v2/businesses/{businessId}/offer-cards. Min items: `1` Max items: `20` Unique items
offerIds	Type: string[] Фильтр по идентификатору товара. Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU: У каждого товара SKU должен быть свой. Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Что такое SKU и как его назначать Min length: `1` Max length: `255` Pattern: `^(?=.\S.)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$` Min items: `1` Max items: `20` Unique items
paid	Type: boolean Фильтр отзывов за баллы Плюса.
ratingValues	Type: integer[] Оценка товара. Min items: `1` Max items: `5` Unique items
reactionStatus	Type: FeedbackReactionStatusType Нужно ли вернуть только непрочитанные отзывы. Для этого передайте значение `NEED_REACTION`. По умолчанию возвращаются все отзывы. Enum: `ALL`, `NEED_REACTION`

FeedbackReactionStatusType

Статус реакции на отзыв:

ALL — все отзывы.
NEED_REACTION — отзывы, на которые нужно ответить.

Type	Description
FeedbackReactionStatusType	Enum: `ALL`, `NEED_REACTION`

Responses

200 OK

Список отзывов.

Body

application/json

{
    "status": "OK",
    "result": {
        "feedbacks": [
            {
                "feedbackId": 0,
                "createdAt": "2022-12-29T18:02:01Z",
                "needReaction": false,
                "identifiers": {
                    "orderId": 0,
                    "modelId": 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: ApiResponseStatusType

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

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

Enum: OK, ERROR

result

Type: GoodsFeedbackListDTO

Список отзывов о товарах.

ApiResponseStatusType

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

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

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

GoodsFeedbackListDTO

Список отзывов о товарах.

Name

Description

feedbacks*

Type: GoodsFeedbackDTO[]

Список отзывов.
Отзыв о товаре.

paging

Type: ForwardScrollingPagerDTO

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

GoodsFeedbackDTO

Отзыв о товаре.

Name	Description
createdAt*	Type: string<date-time> Дата и время создания отзыва.
feedbackId*	Type: integer<int64> Идентификатор отзыва.
identifiers*	Type: GoodsFeedbackIdentifiersDTO Идентификаторы, которые связаны с отзывом.
needReaction*	Type: boolean Прочитан ли отзыв. Принимает значение `false`, если магазин: Прочитал отзыв в кабинете продавца на Маркете. Отметил отзыв прочитанным — метод POST v2/businesses/{businessId}/goods-feedback/skip-reaction. Оставил комментарий к отзыву — метод POST v2/businesses/{businessId}/goods-feedback/comments/update.
statistics*	Type: GoodsFeedbackStatisticsDTO Статистическая информация по отзыву.
author	Type: string Имя автора отзыва.
description	Type: GoodsFeedbackDescriptionDTO Текстовая часть отзыва.
media	Type: GoodsFeedbackMediaDTO Фотографии и видео.

ForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

GoodsFeedbackIdentifiersDTO

Идентификаторы, которые связаны с отзывом.

Name	Description
modelId ⦸	Type: integer<int64> Идентификатор модели товара.
offerId	Type: string Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU: У каждого товара SKU должен быть свой. Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Что такое SKU и как его назначать Min length: `1` Max length: `255` Pattern: `^(?=.\S.)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$`
orderId	Type: integer<int64> Идентификатор заказа на Маркете.

GoodsFeedbackStatisticsDTO

Статистическая информация по отзыву.

Name	Description
commentsCount*	Type: integer<int64> Количество комментариев к отзыву. Учитываются только ответы на отзывы, а не дочерние комментарии.
rating*	Type: integer<int32> Оценка товара. Min value: `1` Max value: `5`
paidAmount	Type: integer<int64> Количество баллов Плюса, которое автор получил за отзыв.
recommended	Type: boolean Рекомендуют ли этот товар.

GoodsFeedbackDescriptionDTO

Текстовая часть отзыва.

Name	Description
advantages	Type: string Описание плюсов товара в отзыве.
comment	Type: string Комментарий в отзыве.
disadvantages	Type: string Описание минусов товара в отзыве.

GoodsFeedbackMediaDTO

Фотографии и видео.

Name

Description

photos

Type: string[]

Ссылки на фотографии.

Min items: 1

Unique items

videos

Type: string[]

Ссылки на видео.

Min items: 1

Unique items

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

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

Получение заданного отчета или документа

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