v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

All Products

Retrieve paginated product data for your entire product catalog by account_id. This call will return product metrics such as product id, external_product_id, average_score, total_reviews, product images and more.

get/v2/{account_id}/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

pagestring

The page number of a paginated response

countstring

The number of products to return per page

Response

200

Example response

{
  "status": {
    "code": 200,
    "message": "ok"
  },
  "pagination": {
    "page": 1,
    "count": 10,
    "total": 13
  },
  "products": {
    "products": [
      {
        "id": 819,
        "external_product_id": "1",
        "name": "vlad frog",
        "url": "https://yotpo.com/go/f1XKPqNY",
        "created_at": "2012-08-21T10:16:08.000Z",
        "updated_at": "2017-11-01T07:03:49.000Z",
        "average_score": 5,
        "total_reviews": 1,
        "category": {
          "id": 1,
          "name": "Electronics"
        }
      }
    ]
  }
}