Skip to content

Product Reviews

Inspect product reviews and update their moderation status.

Fields

idstringUnique identifier of the resource.
titlestringOptional review title, up to 200 characters.
statusenumModeration status: pending (default), approved or rejected; only approved reviews appear publicly.pending · approved · rejected
productNamestringProduct name saved when the review was created.
isVerifiedPurchasebooleantrue when the buyer reviewed through their order; admin-created reviews are false.
ratingintegerStar rating from 1 to 5.
contentstringReview text, up to 4000 characters.
reviewerNamestringName shown for the reviewer, up to 200 characters.
See all 16 fields
reviewerEmailstringReviewer email address; never shown in the storefront.
approvedAtstringWhen the review was approved; null unless status is approved.
approvedBystringID of the user who approved the review; null unless approved.
createdOnstringTimestamp when the resource was created, in ISO 8601.
updatedOnstringTimestamp when the resource was last modified, in ISO 8601.
productIdstringID of the reviewed product.
customerIdstringID of the customer who wrote the review; null when not linked.
orderIdstringID of the order the review refers to; null when not linked.

Operations

MethodEndpointOperation
GET/v1/catalog/product-reviewsList product reviews
GET/v1/catalog/product-reviews/{reviewId}Get product review
PATCH/v1/catalog/product-reviews/{reviewId}/statusUpdate review status

Last updated: