v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Promoted Products

Yotpo's smart algorithm automatically promotes your most popular products by purchase date, star rating, number of reviews, and manually selected products. <a href="https://support.yotpo.com/en/article/promoted-products-in-the-reviews-widget-2446379" target="_blank">Promoted Products</a> are a great way to showcase your most popular or complementary products for better exposure.

get/v2/{account_id}/promoted_products?access_token={access_token}

Path parameters

account_idstring required

Your account's API app key

Query parameters

access_tokenstring required

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

Response

200

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

Example response

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "promoted_products": {
    "products": [
      {
        "external_product_id": "377700207",
        "type": "MostBought",
        "position": 1
      }
    ]
  }
}