Skip to main content

/api/lite/products/reviews

Получение отзывов

/api/lite/products/reviews

Возвращает отзывы на товары. Отзывы отсортированы по дате создания, начиная с новых.

Фильтрация

?productId=1030  - для фильтрации по идентификатору товара

?status=NEW - для фильтрации по статусу отзыва

 

Пейджинация

Для пейджинации используются параметры page и size: size - отзывов на странице, page - номер страницы.

Пример: /api/lite/products/reviews?page=0&size=200

Если параметры не переданы, то дефолтные значения page=0&size=100

Также, для отображение пейджинации следует анализировать параметр recordsTotal, возвращающий общее количество записей (с учетом примененной фильтрации, если она есть).

Поле Тип / формат Описание
id string Идентификатор отзыва. 
product object Информация о товаре
   id string Идентификатор товара
   shortName string Название товара
   images array Изображения товара
      url string Ссылка на изображение
      id string Имя файла
      pos double Позиция
createTs datetime Время создания отзыва
customerName string

Имя автора отзыва
content string

Текст отзыва
score decimal

Оценка (от 1 до 5)
status enum

Статус отзыва

  • NEW
  • CONFIRMED
  • DELETED

Пример результата запроса:

{
    "success": true,
    "recordsTotal": 1,
    "reviews": [
        {
            "id": "e7951e18-8ee3-61b2-b616-018331a8fb06",
            "product": {
                "id": "1030",
                "shortName": "Масло для бороды Бунтарь - Дамаск",
                "images": [
                    {
                        "url": "https://storage.yandexcloud.net/images-k2c/aff3c7f1-8b7c-47ea-a3a9-e9a52e476c12.jpg",
                        "id": "aff3c7f1-8b7c-47ea-a3a9-e9a52e476c12.jpg",
                        "pos": "10000.000000000000000"
                    }
                ]
            },
            "createTs": "2020-08-07 19:35:36",
            "customerName": "Петя",
            "content": "текст отзыва",
            "score": 5,
            "status": "NEW"
        }
    ]
}

 

Редактирование отзывов

/api/lite/products/reviews

Редактирует отзыв.

Пример запроса

{
    "id": "6c62461f-fcf4-c388-c3b4-e09971590d6b",
	"customerName": "Петя",
	"content": "текст отзыва",
	"status": "CONFIRMED"
}

В ответ возвращается

Успех:

{
    "success": true,
    "review": {
        "id": "6c62461f-fcf4-c388-c3b4-e09971590d6b",
        "product": {
          	"id": "1030",
          	"shortName": "Масло для бороды Бунтарь - Дамаск",
          	"images": [
                {
                  "url": "https://storage.yandexcloud.net/images-k2c/aff3c7f1-8b7c-47ea-a3a9-e9a52e476c12.jpg",
                  "id": "aff3c7f1-8b7c-47ea-a3a9-e9a52e476c12.jpg",
                  "pos": "10000.000000000000000"
                }
          	]
        },
        "createTs": "2020-08-07 18:53:46",
        "customerName": "Петя",
        "content": "текст отзыва",
        "score": 5,
        "status": "CONFIRMED"
    }
}

Ошибка:

{
    "success": false,
    "errors": [
        {
            "code": 0,
            "message": "Текст ошибки"
        }
    ]
}
Наверх