Entities

Review

Review entity - components, queries, links, and related actions

Your storefront encounters the Review entity when displaying user-submitted product reviews. Reviews are not fetched directly; they arrive through the ProductReviews link on a Product. Each Review carries a rating, author information, and the review body.

Components

Base

ReviewBase

base
Creation date, optional title, short content preview, and rating.
createdAt
unknownrequired
title
string
shortContent
stringrequired
rating
number

A rating between 1 and 5. That's the most common rating scale. No other scale is supported at the moment. Decimals are allowed.

min1max5

Reviewer

ReviewReviewer

reviewer
Author information: display name, anonymous flag, and optional avatar image.
name
stringrequired

The name of the reviewer. If anonymous, this may be an empty string.

isAnonymous
boolean

Whether the reviewer is anonymous.

Content

ReviewContent

content
The full review body text. May contain HTML.
string
  • Product - The product this review was submitted for.