Types > ProductReview
Commerce APITypesProductReview
ProductReview

Description

Topic: Product Reviews

Fields

answers: [ProductReviewAnswer]

Answers for this review

Expandable

Permission bit: "product_review_answers.read"


average_score: Float!

Average review score, from 0 to 9 (inclusive, both ends)

Example: 7.09


created_at: String!

The date and time when the review was created, RFC 3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


customer: Customer

Author of the review

Expandable

Permission bit: "customers.read"


detected_language: InfoLanguage

Language detected for this review

Expandable


email_message: Message


flag_count: Int!

Number of times this review was flagged

Example: 5


flag_ignore: Boolean!

Whether flagging actions are ignored

Example: false


id: String!

Unique review identifier. See also: Unique Identifiers

Example: "re_EQzGqWoY"


image_files: [File]

Image files for this review

Expandable

Permission bit: "files.read"


no_count: Int!

Number of times this review was voted no

Example: 5


product: Product

Product this review is for

Expandable

Permission bit: "products.read"


rating: Int!

Rating based on yes/no votes (yes_count minus no_count)

Example: -6


recommended: StorefrontCustomerVote!

Whether customer voted or not and how


scores: [ProductReviewScore!]!


status: ApprovalStatus!

Publishing approval status


survey_answers: [ProductReviewSurveyAnswer!]!


text: String!

Text of the review

Example: "Great product!"


title: String!

Title of the review

Example: "Amazing!"


updated_at: String!

The date and time when the review was last updated, RFC 3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


verified_purchase: Boolean!

Whether customer has completed orders with given product or not

Example: false


yes_count: Int!

Number of times this review was voted yes

Example: 5


Used By

Mutations

productReviewsCreate, productReviewsModify

Queries

productReviews

Types

ProductReviewAnswer, ProductReviewExpandableItems, ProductReviewPage, ProductReviewSearchResult, UnifiedSearchResult

Preview (typescript)

Loading module