Skip to content

Product review GraphQL

Served by ProductReviewModule on commercetools.

Each operation has its own page with its arguments, an example and the engines that serve it. The types link to their fields on the product review types page.

Operations

OperationDescriptionServed by
productReviewCreateMutationReview a delivered line of one of the signed-in buyer's orders, once per line.commercetools
productReviewPhotoUploadMutationA signed URL to upload one photo of a review to, which the buyer's browser PUTs the file to before naming its photoId in productReviewCreate.commercetools

Types

TypeDescription
OrderLineReviewObjectWhether the buyer can review one line of their order, or how they did
ProductReviewObjectA buyer's review of a product
ProductReviewCreateErrorUnion
ProductReviewCreateInputInput object
ProductReviewCreateResponseObject
ProductReviewErrorObject
ProductReviewErrorCodeTypeEnum
ProductReviewFitCountObjectHow many approved reviews found the size one way
ProductReviewFitTypeEnumHow a buyer found the size of what they bought
ProductReviewPhotoObjectA photo a review shows
ProductReviewPhotoUploadObjectA signed URL to PUT one review photo to, before it is named in productReviewCreate
ProductReviewPhotoUploadErrorUnion
ProductReviewPhotoUploadResponseObject
ProductReviewRatingCountObjectHow many approved reviews gave one rating
ProductReviewResultObject
ProductReviewSortTypeEnum
ProductReviewStatusTypeEnumWhere a review is in moderation

Fields on other types

This domain adds these fields to types that another domain defines.

Order

FieldTypeDescription
lineReviews[OrderLineReview!]!One entry per line of the order, for writing a review from it

Product

FieldTypeDescription
reviewDistribution[ProductReviewRatingCount!]!How many approved reviews gave each rating, from 5 down to 1, including ratings nobody gave
reviewFitDistribution[ProductReviewFitCount!]!How many approved reviews found the size each way, in the order of ProductReviewFitType, including ways nobody chose. All zero where buyers are not asked.
reviewListProductReviewResult!The approved reviews of the productArguments: page, pageSize, rating, sort