Review Object


A Review object includes all of the details related to the review of an entity. An entity is a specific resource to be reviewed, for example, a store product. You can manage existing reviews, create new reviews, and retrieve reviews. Read more about reviews in this tutorial.

Properties
namespacestring

Review namespace. Currently integrated with Wix Stores, as stores.


entityIdstringmaxLength 36

ID of the entity to review. For example, a Wix Stores product ID.


idstringRead-onlyformat GUID

Review ID.


contentobject

Review content.


createdDatestringRead-onlyformat date-time

Date and time the review was created.


updatedDatestringRead-onlyformat date-time

Date and time the review was updated.


authorobject

Author of the review.


replyobjectRead-only

Reply to the review.


foundHelpfulintegerRead-only

Number of site visitors who found the review helpful.


foundUnhelpfulintegerRead-only

Number of site visitors who found the review unhelpful.


helpfulnessintegerRead-only

Helpfulness score.

Calculated by subtracting foundUnhelpful from foundHelpful.


moderationobjectRead-only

Moderation status of the review.


revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the review is updated. To prevent conflicting changes, the current revision must be passed when updating the review. Ignored when creating a review.


verifiedbooleanRead-only

Indicates whether the review has been verified through a Verify Product Purchase call to the Review Product catalog SPI.


originobjectRead-only

Provides information about the origin of the review. Organic reviews are created by site visitors or members. App reviews are created by apps even though a site visitor or member is the author of the review. Apps can not create or update organic reviews.


reviewDatestringformat date-time

Date and time when the review was written. This should match created_date, except for reviews imported from another system.


relevanceScorenumberRead-onlyformat double

Platform-calculated score of review's relevance to the item. Used to sort reviews by relevance.


publishCountintegerRead-only

Counts the number of times a review has been published. Reviews require approval before publishing, unless moderation is disabled. When moderation is disabled, reviews are automatically approved and published.

Was this helpful?
Yes
No