Customer Review

Create a product review

Creates a review for a product on behalf of the authenticated customer. Review starts in pending status until approved by admin.

post/reviews

Request

Headers

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring
Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring
Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring
Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Request body

product_idinteger required

ID of the product being reviewed

titlestring required

Short review title

commentstring required

Full review body

ratinginteger required

Star rating (1-5)

namestring required

Reviewer display name

emailstring email

Optional: reviewer email (for guests)

attachmentsstring

Optional: JSON-encoded attachment metadata

Example request

{
  "product_id": 2,
  "title": "Great product",
  "comment": "Works exactly as described, highly recommended.",
  "rating": 5,
  "name": "John Doe",
  "email": "john@example.com"
}

Response

Review created. Starts in pending status until an admin approves it.

Changes

No recorded changes to this operation across all 13 revisions of this API.