Product Reviews

Retrieve product reviews for a specific product using the external_product_id.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Product ID

Note that in some parts of the API, product_id may be referred to as external_product_id

Product Reviews - Response Attributes

AttributeDescription
idThe review ID
scoreThe star-rating score where 5 is a 5-star rating ⭐⭐⭐⭐⭐
votes_upThe number of shoppers who voted up for this review 👍
votes_downThe number of shoppers who voted down for this review 👎
contentThe textual review content
titleThe title of the review
created_atThe timestamp generated upon review creation
verified_buyerThe status of the reviewer. Verified buyers are buyers who created their review via Mail After Purchase
source_review_idThe review id by source
custom_fieldsCustom review form fields. Nested parameters include the form title,form_id,value, and field type
images_data
userUser data. Nested parameters include the user id, display _name, social_image, and email
product
user_idThe unique identifier of the reviewer who submitted the review
product_idThe unique product identifier of the product reviewed
commentThe comment left on the review
external_product_idThe external product id of the product reviewed
publishedThe published or unpublished state of the review as defined by the include_unpublished_reviews param.
Path Params
string
required

Your account's API app key

string
required

The external_product_id value. Can be retrieved using All Reviews

Query Params
string
required

Your Yotpo access token. Click here to learn how to generate one

int32

The page number of the paginated response

int32

The number of reviews you want to retrieve

int32

Filter by star rating score

boolean

Pass a value of true to get all reviews including unpublished reviews. Pass a value of false (default) to get just the published reviews.

string

Indicates if the review comes from an incentivized source (for example, a product sampling company)

string
enum

The type of incentive provided for the review

Allowed:
Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json