Skip to content

Get Customer Reviews

Retrieve a paginated list of product reviews submitted by the authenticated customer. This is a read-only, customer-scoped resource — customers can only see their own reviews.

Endpoint

GET /api/shop/customer-reviews

Request Headers

HeaderRequiredDescription
Content-TypeYesapplication/json
X-STOREFRONT-KEYYesYour storefront API key
AuthorizationYesBearer token (customer login required)

Query Parameters

ParameterTypeDefaultDescription
statusstring-Filter by review status (pending, approved, rejected)
ratinginteger-Filter by star rating (15)

Response Fields (200 OK)

FieldTypeDescription
idintegerReview ID
titlestringReview title
commentstringReview body text
ratingintegerStar rating (1–5)
statusstringReview status: pending, approved, or rejected
namestringReviewer display name
productobjectAssociated product (nested resource)
customerobjectCustomer who wrote the review (nested resource)
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last update timestamp

Status Values

StatusDescription
pendingAwaiting approval
approvedPublished on storefront
rejectedNot published

Filters

bash
# Get approved reviews only
GET /api/shop/customer-reviews?status=approved

# Get 5-star reviews only
GET /api/shop/customer-reviews?rating=5

# Get approved 5-star reviews
GET /api/shop/customer-reviews?status=approved&rating=5

# Get pending reviews
GET /api/shop/customer-reviews?status=pending

# Get rejected reviews
GET /api/shop/customer-reviews?status=rejected

Use Cases

  • Display customer's review history in account dashboard
  • Show pending reviews awaiting approval
  • Filter reviews by rating or status
  • Build review management UI for customers

Released under the MIT License.