Sign in

v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Product Reviews

Retrieve product reviews for a specific product using the external_product_id.

get/v2/{account_id}/products/{external_product_id}/reviews?access_token={access_token}

Path parameters

account_idstring required

Your account's API app key

external_product_idstring required

The external_product_id value. Can be retrieved using All Reviews

Query parameters

access_tokenstring required

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

pageinteger

The page number of the paginated response

countinteger

The number of reviews you want to retrieve

starinteger

Filter by star rating score

include_unpublished_reviewsboolean

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

is_incentivizedstring

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

incentive_type'free_product' | 'coupon' | 'loyalty_points' | 'paid_ promotion' | 'employee_review' | 'other'

The type of incentive provided for the review

Response

200

OR

Example response

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "pagination": {
    "page": 1,
    "count": 2,
    "total": 239
  },
  "reviews": {
    "reviews": [
      {
        "id": "59353719",
        "score": 5,
        "content": "Received this pillow with the purchase of our king-size bed. Wish the offer had been available when we purchased a queen size bed for our guest room months earlier.. yes, we love the beds too!",
        "title": "Great pillow!",
        "created_at": "2018-02-06T02:57:29.000Z",
        "verified_buyer": true,
        "custom_fields": {
          "--9728": {
            "title": "Age",
            "form_id": 207,
            "value": "55 or older",
            "field_type": "SingleChoice"
          },
          "--9729": {
            "title": "Sleep position",
            "form_id": 207,
            "value": "On my side",
            "field_type": "SingleChoice"
          },
          "--9730": {
            "title": "Hours of Sleep",
            "form_id": 207,
            "value": "7 to 9 hours",
            "field_type": "SingleChoice"
          }
        },
        "user": {
          "id": 16101346,
          "display_name": "Florence K.",
          "social_image": "https://ddcfq0gxiontw.cloudfront.net/images/anonymous_user.png",
          "email": "Flora@email.com"
        },
        "user_id": 16101364,
        "product_id": 35421767,
        "external_product_id": "51594874628",
        "published": true
      }
    ]
  }
}