Skip to content

Get Customer Review

About

The customerReview query retrieves a single product review by its ID for the authenticated customer. Customers can only access their own reviews. Use this query to:

  • Display detailed review information
  • Show the full review text and rating
  • Check the approval status of a specific review
  • Load a review for detailed viewing in the customer dashboard

Authentication

This query requires customer authentication:

  • Authenticated customers: Provide a valid customer authentication token in the Authorization header. Obtain this token via the Customer Login API.
Authorization: Bearer <accessToken>
X-STOREFRONT-KEY: <storefrontKey>

Arguments

ArgumentTypeRequiredDescription
idID!✅ YesThe IRI identifier of the customer review (e.g. /api/shop/customer-reviews/1).

Possible Returns

FieldTypeDescription
idID!IRI identifier (e.g. /api/shop/customer-reviews/1).
_idInt!Numeric database ID.
titleString!Review title.
commentString!Review body text.
ratingInt!Star rating (1–5).
statusString!Review status: pending, approved, or rejected.
nameString!Reviewer display name.
productProduct!Associated product with id, _id, sku.
customerCustomer!Customer who wrote the review with id, _id.
createdAtDateTime!ISO 8601 creation timestamp.
updatedAtDateTime!ISO 8601 last update timestamp.

Error Responses

ErrorCause
UnauthenticatedMissing or invalid Bearer token
Customer review ID is requiredID not provided for single-item query
Customer review with ID ":id" not foundReview doesn't exist or doesn't belong to the customer

Use Cases

  • Display individual review details in customer account
  • Show review with full context and approval status
  • Load specific review for viewing or tracking
  • Check if a submitted review has been approved

Released under the MIT License.