alex-le/magento2-review-summary

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Magento 2 Review Summary REST API

v1.0.5 2020-05-15 14:00 UTC

This package is auto-updated.

Last update: 2021-10-15 17:49:24 UTC


README

Overview

Magento does not provide a REST API Endpoint to get the reviews/ratings from a product. This Module implements an endpoint to get the rating summary for a single product (by SKU).

Install

Use composer to install this module. From your Magento 2 folder run:

composer require alex-le/magento2-review-summary
php bin/magento setup:upgrade 

Usage

Create an API Token and provide access to Marketing -> User Content -> Reviews

Use the following API Endpoint:

Endpoint Request method
/V1/products/:sku/review-summary GET

Response Example:

{
    "summary": 60,
    "count": 3
}