v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Product Star Rating

Retrieve the average star-rating and review count for a specific product by external_product_id.

get/v2/{account_id}/star_rating/products/{external_product_id}?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

Response

200

{"stackTrail":"paths:/v2/{account_id}/star_rating/products/{external_product_id}?access_token={access_token}:get:responses:200:content:application/json:schema:properties:pagination","oasType":"schema","type":"unknown"}

Example response

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "product_star_rating": {
    "external_product_id": "376700306",
    "average_score": 4.5,
    "total_reviews": 15527
  }
}