Sign in

v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Retrieve Products

Retrieves a list of all of the store's products. You can use this endpoint to resolve the Yotpo product ID in order to update it.

get/core/v3/stores/{store_id}/products

Path parameters

store_idstring required

The store ID (app_key)

Query parameters

access_tokenstring required

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

page_infostring

Encoded page info

limitinteger

Defines how many results will be returned per page. Can be any number between 1 and 100.

external_idsstring

Return only entities specified by a comma-separated (without spaces) list of external IDs. The argument must be <a href="https://www.urlencoder.io/learn" target="_blank">URL encoded</a>. Max 100 IDs. Can't come with page_info or limit.

Response

200

OR

Example response

{
  "products": [
    {
      "yotpo_id": 12345,
      "external_id": "ex001",
      "name": "minimal surfboard",
      "description": "A great surfboard!",
      "status": "active",
      "url": "http://www.waverider.com/products/minimalsurfboard",
      "is_valid_url": true,
      "image_url": "http://www.waverider.com/products/minimalsurfboard/images/1.jpg",
      "price": 750,
      "compare_at_price": 800,
      "currency": "USD",
      "inventory_quantity": 10,
      "group_name": "surfboards",
      "brand": "Waverider",
      "sku": "xxxxx",
      "mpn": "xxxxx",
      "gtins": [
        {
          "declared_type": "UPC",
          "value": "742833102466"
        }
      ],
      "custom_properties": {
        "is_blocklisted": true,
        "review_form_tag": "surfboard"
      },
      "created_at": "2020-09-08T08:43:27Z",
      "updated_at": "2020-10-08T08:43:27Z"
    }
  ]
}