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

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

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

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

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

Идентификатор родительского комментария parentId возвращается только для ответов на другие комментарии, но не для ответов на отзывы.

Вы также можете настроить 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

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

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer

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

Min value: 1

page_token

Type: string

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

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

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

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

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json
{
  "feedbackId": 0,
  "commentIds": [
    0
  ]
}

Name

Description

commentIds

Type: GoodsFeedbackCommentId[] | null

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

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

Min items: 1

Max items: 50

Unique items: true

Example
[
  0
]

feedbackId

Type: GoodsFeedbackId

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

Example: 0

GoodsFeedbackId

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

Type: integer

GoodsFeedbackCommentId

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

Type: integer

Responses

200 OK

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

Body

application/json
{
  "status": "OK",
  "result": {
    "comments": [
      {
        "id": 0,
        "text": "example",
        "canModify": true,
        "parentId": 0,
        "author": {},
        "status": "PUBLISHED",
        "feedbackId": 0
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    result

    Type: GoodsFeedbackCommentListDTO

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

    Example
    {
  "comments": [
    {
      "id": 0,
      "text": "example",
      "canModify": true,
      "parentId": 0,
      "author": {
        "type": "USER",
        "name": "example"
      },
      "status": "PUBLISHED",
      "feedbackId": 0
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}
    Example
    {
  "result": {
    "comments": [
      {
        "id": 0,
        "text": "example",
        "canModify": true,
        "parentId": 0,
        "author": {
          "type": "USER",
          "name": "example"
        },
        "status": "PUBLISHED",
        "feedbackId": 0
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR
Example
{
  "status": "OK"
}

GoodsFeedbackCommentText

Текст комментария.

Не должен содержать контакты магазина и ссылки на сайты, кроме Маркета.

Type: string

Min length: 1

Max length: 4096

Example: example

GoodsFeedbackCommentAuthorType

Тип автора:

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

Type: string

Enum: USER, BUSINESS

GoodsFeedbackCommentAuthorDTO

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

Name

Description

name

Type: string

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

Example: example

type

Type: GoodsFeedbackCommentAuthorType

Тип автора:

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

Enum: USER, BUSINESS
Example
{
  "type": "USER",
  "name": "example"
}

GoodsFeedbackCommentStatusType

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

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

Type: string

Enum: PUBLISHED, UNMODERATED, BANNED, DELETED

GoodsFeedbackCommentDTO

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

Name

Description

feedbackId

Type: GoodsFeedbackId

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

Example: 0

id

Type: GoodsFeedbackCommentId

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

Example: 0

status

Type: GoodsFeedbackCommentStatusType

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

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

Enum: PUBLISHED, UNMODERATED, BANNED, DELETED

text

Type: GoodsFeedbackCommentText

Текст комментария.

Не должен содержать контакты магазина и ссылки на сайты, кроме Маркета.

Min length: 1

Max length: 4096

Example: example

author

Type: GoodsFeedbackCommentAuthorDTO

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

Example
{
  "type": "USER",
  "name": "example"
}

canModify

Type: boolean

Может ли продавец изменять комментарий или удалять его.

parentId

Type: integer

Идентификатор родительского комментария.
Example
{
  "id": 0,
  "text": "example",
  "canModify": true,
  "parentId": 0,
  "author": {
    "type": "USER",
    "name": "example"
  },
  "status": "PUBLISHED",
  "feedbackId": 0
}

ForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

Example: example
Example
{
  "nextPageToken": "example"
}

GoodsFeedbackCommentListDTO

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

Name

Description

comments

Type: GoodsFeedbackCommentDTO[]

Список комментариев.

Example
[
  {
    "id": 0,
    "text": "example",
    "canModify": true,
    "parentId": 0,
    "author": {
      "type": "USER",
      "name": "example"
    },
    "status": "PUBLISHED",
    "feedbackId": 0
  }
]

paging

Type: ForwardScrollingPagerDTO

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

Example
{
  "nextPageToken": "example"
}
Example
{
  "comments": [
    {
      "id": 0,
      "text": "example",
      "canModify": true,
      "parentId": 0,
      "author": {
        "type": "USER",
        "name": "example"
      },
      "status": "PUBLISHED",
      "feedbackId": 0
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}

400 Bad Request

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

ApiErrorDTO

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

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

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

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

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

401 Unauthorized

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

403 Forbidden

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

404 Not Found

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

420 Method Failure

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

500 Internal Server Error

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

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

Предыдущая
Все отзывы
Следующая
Добавление/изменение комментария