Get Product Reviews
Retrieve reviews and ratings for a specific product. By default only approved reviews are returned; pass the status parameter to fetch a different status.
Endpoint
GET /api/shop/products/{productId}/reviewsRequest Headers
| Header | Required | Description |
|---|---|---|
Content-Type | Yes | application/json |
X-STOREFRONT-KEY | Yes | Your storefront API key |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
productId | integer | Yes | Product ID |
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
status | string | approved | Filter by status (approved, pending). Omit to get approved reviews only. |
rating | integer | – | Filter by star rating (1–5). |
page | integer | 1 | Page number (1-based). |
per_page | integer | 30 | Reviews per page. Alias: limit. Maximum 50. |
Filtered request examples
GET /api/shop/products/1/reviews?rating=5
GET /api/shop/products/1/reviews?status=pending
GET /api/shop/products/1/reviews?status=approved&rating=4
GET /api/shop/products/1/reviews?per_page=10&page=2Approved by default — overridable
A storefront product page shows only approved reviews, so this endpoint returns status=approved when no status is supplied. To build moderation or preview tooling, request a specific status explicitly (e.g. ?status=pending).
Response (200 OK)
Returns a JSON array of review objects.
| Field | Type | Description |
|---|---|---|
id | integer | Review ID |
name | string | Reviewer display name |
title | string | Review title |
rating | integer | Rating (1–5 stars) |
comment | string | Review body |
status | string | Review status (approved, pending) |
createdAt | string | Review creation date (ISO 8601) |
updatedAt | string | Last update date (ISO 8601) |
Pagination
Pagination metadata is returned in response headers (not the body):
| Header | Description |
|---|---|
X-Total-Count | Total reviews matching the filters |
X-Page | Current page |
X-Per-Page | Reviews per page |
X-Total-Pages | Total page count |
Use Cases
- Display approved product reviews on detail pages
- Filter reviews by rating
- Paginate through a product's reviews
- Build review moderation tooling (
?status=pending)