Setup

To use the Reviews API, install the @wix/reviews package using npm or Yarn:

Copy
1
npm install @wix/reviews

or

Copy
1
yarn add @wix/reviews

Then import reviews from @wix/reviews:

Copy
1
import reviews from '@wix/reviews'
Was this helpful?
Yes
No

About the Reviews API

Developer Preview
APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.

With the Reviews API you can manage reviews for a site's services, content, or products. The review object holds the content of the review, a rating score, images or video media, and information about the author. Learn more about Wix Reviews.

The Wix Reviews API allows the site to:

  • Import reviews from other sites and export reviews to other sites.
  • Retrieve and display positive review data. Use the Media API to retrieve associated review media.
  • Retrieve negative review data enabling site owners to respond effectively.

Moderation

If moderation is turned on, reviews are checked for content that requires moderation. If moderation is required, the review remains pending until the site owner rejects or approves it in the site's Dashboard. The site owner can configure moderation settings in the site's Dashboard. Learn more about managing reviews.

Before you begin

It’s important to note the following points before starting to code:

  • Every review needs a contact. If the author is already listed as a contact, use either Create Review or Create Review and Contact. If the author is not yet a site contact, use Create Review and Contact.
  • A review author is limited to one review per entity. Duplicate reviews receive an error response.
  • Replying to a review is available only in the site owner's Dashboard.

Terminology

  • Entity: The entity to review. For example, a Wix Stores product.
  • Namespace: The Wix module that the Reviews API is integrated with. Currently only Wix Stores.
  • Rating: The rating score for the review item. An author can give a rating score between 1 and 5. The rating is displayed with the site review.
  • Helpfulness: Helpfulness is the overall helpfulness score calculated by subtracting Found Unhelpful from Found Helpful. Site visitors can indicate whether a review was helpful or not.
  • Reply: A direct reply to a review that was left on the site. The reply is displayed with the review.
Was this helpful?
Yes
No