younifyd
Menu

Product Images

Product images

GET/v1/widget/{app_key}/albums/product/{product_id}

Use it in a workflow

  1. Add a step and choose the Yotpo connector.
  2. Pick the Product Images action (under Reviews & Ratings).
  3. Fill in the fields below, then reference the result from later steps as {{productImages.response.data}}.

Request

Path parameters

app_keystringrequired

The store ID

product_idstringrequired

The unique product identifier.

Query parameters

pageinteger (int32)

The page number of a paginated response. Must be greater than zero. Default: 1

Default 1

per_pageinteger (int32)

The number of results to return per page. Maximum 56 per page.

Default 10

favorite=truestring

Retrieve only starred images.

favorite=falsestring

Retrieve only unstarred images.

Response

Returns 200 with an object. Read it in later steps with {{productImages.response.data.<field>}}.

statusobject
codeinteger

Default 0

messagestring
responseobject
paginationobject3 fields
imagesarray<object>11 fields
json
{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "response": {
    "pagination": {
      "page": 1,
      "per_page": 3,
      "total": 0
    },
    "images": [
      {
        "source": "instagram",
        "image_id": "5acc67ab4e904b4f68197b7e",
        "low_resolution_image_url": "//scontent.cdninstagram.com/vp/768b1d9ebd06f60cf12c7847821fbd6d/5B681B7F/t51.2885-15/s320x320/e35/20986874_695325423991497_2749685599597232128_n.jpg",
        "original_image_url": "//scontent.cdninstagram.com/vp/d7ec5f13b54c190010edc3a3511aa348/5B686E3C/t51.2885-15/s640x640/sh0.08/e35/20986874_695325423991497_2749685599597232128_n.jpg",
        "image_url": "//scontent.cdninstagram.com/vp/8548e36d016cdafb184ecad8237aaf8f/5B59C938/t51.2885-15/s150x150/e35/20986874_695325423991497_2749685599597232128_n.jpg",
        "medium_image_url": "//cdn-yotpo-images-production.yotpo.com/Review/208866404/141437668/medium.jpg?1603967988",
        "external_media_id": "1587020048554520701_27693384",
        "tagged_products": [
          {
            "id": 23626629,
            "name": "Athletic T-Shirt",
            "domain_key": "8",
            "product_link": "https://yotpo.com/go/n78k812O",
            "product_url": "https://yotpos-demo-store-2.myshopify.com/products/athletic",
            "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/23827967/18687701/square.jpg?1499177862",
            "score": null,
            "reviews_count": null
          }
        ],
        "media_type": "image",
        "permission_request_status": "approved",
        "post": {
          "profile_picture": "https://scontent.cdninstagram.com/vp/071f4a200310eb9eec2beaa53c7eb810/5B5D8455/t51.2885-19/s150x150/10598276_885098761603741_1222504716_a.jpg",
          "username": "pakalupapito",
          "location_name": "Yotpo",
          "created_time": "2017-08-22T13:12:34.000+00:00",
          "hashtags": [
            "movingday"
          ],
          "content": "",
          "votes_up": 0,
          "votes_down": 0
        }
      }
    ]
  }
}

Need more? See the Yotpo guide for connection setup and behaviour shared by every action.