Skip to content

Get Product Review

Retrieve detailed information for a specific product review.

Endpoint

GET /api/shop/reviews/{reviewId}

Request Headers

HeaderRequiredDescription
Content-TypeYesapplication/json
X-STOREFRONT-KEYYesYour storefront API key

Path Parameters

ParameterTypeRequiredDescription
reviewIdintegerYesThe review to read. No product ID is part of the path.

Response Fields (200 OK)

FieldTypeDescription
idintegerReview ID.
namestringDisplay name the reviewer submitted.
titlestringReview headline.
commentstringReview body.
ratingintegerStar rating, 1 to 5.
statusstringpending or approved.
createdAt / updatedAtstringISO 8601 timestamps.

The product and customer behind a review are not part of this payload — there is no productId, no customerId, and no reviewer email. Helpfulness voting does not exist in the storefront API, so there are no vote counts either.

This endpoint is public and is not filtered by status: a pending review is readable by ID even though it is absent from the default product listing.

Use Cases

  • Read back a just-submitted review — the create response returns the ID, and this fetches the stored row without having to filter the product listing by status.
  • Deep link to one review — a "permalink" route can render from this single call.

Best Practices

  • Do not use it to build a review list — the payload names neither the product nor the author, so listing per product is Get Product Reviews.
  • Check status before displaying publicly — the endpoint hands back pending rows too, so a page that renders whatever it fetches can leak unapproved content.

Released under the MIT License.