Magento 2 Product Review API
ayasoftware/magento2-review-api
Implements REST WebAPI endpoints for product reviews — create, update, search and fetch reviews with ratings — filling a gap in Magento's native API, with a dedicated ACL resource.
Build Tests
Code Quality
Tested on Magento 2.4.9
Recent Test History
Each release is tested against the latest Magento version at that time.
Top Contributors
View Leaderboard
Share This Module's Status
README
Loaded from GitHubOverview
Currently, Magento 2 does not provide the REST API for the Reviews Extension of the products. This module implement WebAPI for product reviews (partially)
Tested compatibility target: Magento Open Source / Adobe Commerce 2.4.8 with PHP 8.3 and 8.4.
Module allow:
- Get one review
- Create review with ratings
- Update review with ratings
- Search reviews
- Get product reviews
| Resource | Request method | Description |
|---|---|---|
| /V1/reviews/:id | GET | Get one review |
| /V1/reviews/:id | PUT | Update review |
| /V1/reviews/:id | DELETE | Delete review |
| /V1/reviews/ | POST | Create review |
| /V1/reviews/ | GET | Search reviews |
| /V1/products/:sku/reviews | GET | Get product reviews |
ACL
The module exposes a custom Magento ACL resource:
Ayasoftware_ReviewApi::reviewapiAyasoftware_ReviewApi::reviews
Docs for adding a new review with ratings
Install
To install this module please use composer dependency manager. In Your Magento2 folder please do execute:
composer require ayasoftware/magento2-review-api
php bin/magento setup:upgrade
This content is fetched directly from the module's GitHub repository. We are not the authors of this content and take no responsibility for its accuracy, completeness, or any consequences arising from its use.