Skip to content

Get Customer Review ​

Retrieve detailed information for a specific product review submitted by the authenticated customer. Customers can only access their own reviews.

Endpoint ​

GET /api/shop/customer-reviews/{id}

Request Headers ​

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

Path Parameters ​

ParameterTypeRequiredDescription
idintegerYesCustomer review ID

Response Fields (200 OK) ​

One review written by the authenticated customer. Product and customer are path references, not nested objects.

FieldTypeDescription
idintegerReview ID.
namestringDisplay name submitted with the review.
title / commentstringReview text.
ratingintegerStar rating, 1 to 5.
statusstringpending, approved, or disapproved.
productstringPath of the reviewed product, e.g. /api/shop/products/127.
customerstringPath of the author — always the authenticated customer.
createdAt / updatedAtstringISO 8601 timestamps.

A review written by someone else answers 404, the same as an ID that does not exist. The message names the ID that was asked for, so do not surface it verbatim as proof the review is missing store-wide.

Use Cases ​

  • Detail view in "my reviews" — read one row to render an edit form, then submit through Update Product Review, which addresses the same review at /api/shop/reviews/{id}.
  • Poll for approval — re-read after submission to see status move from pending to approved.

Best Practices ​

  • Prefer the list endpoint for a review history — this returns the same fields for one row, so a "my reviews" page is one call, not one per review.
  • Remember the write path is a different route — reading is /api/shop/customer-reviews/{id}, but editing and deleting go to /api/shop/reviews/{id}.

Released under the MIT License.