Product reviews are a great way for customers to provide free and unique content to your site to help other customers purchase products, and to let you as a merchant know which products may need to be reviewed. This area of the API allows you to manage how a review for a product is managed.
The following pre-requisites will be necessary to accomplish the goals of this article:
- General understanding of REST and API’s
If you haven’t already done so, you should probably have a development environment ready to development against, complete with Hotcakes installed and configured.
REST API Endpoints for Product Reviews
There are a handful of REST API endpoints that allow you to display or manage various aspects of product reviews. Those endpoints are detailed below.
|ProductReviewsByProduct||List of ProductReviewDTO||Returns a list of all of the reviews that were created for the specified product.|
|ProductReviewsCreate||ProductReviewDTO||Creates a new product review for a product in the store.|
|ProductReviewsDelete||Boolean||Permanently deletes a product review from the store. This should only be done as a last resort.|
|ProductReviewsFind||ProductReviewDTO||Allows you to find a specified product review using its unique ID or Bvin.|
|ProductReviewsFindAll||List of ProductReviewDTO||Allows you to return all of the reviews in the store.|
|ProductReviewsUpdate||ProductReviewDTO||Updates the specified product review using the product review object provided.|