Product images

get

https://api.yotpo.com/v1/widget/{store_id}/albums/product/{product_id}

Use this endpoint to retrieve images curated to product albums.
For Instagram media, the post object includes post_id and post_link. Use post_id to group media from the same Instagram post. For older media, post_id is null, so use post_link for grouping instead.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

👍
How to use this endpoint

For example responses, click the relevant status code on the right.

📘
Instagram media
For Instagram media, the post object includes post_id and post_link. Use post_id to group media from the same Instagram post. For older media, post_id is null, so group by post_link instead.

Path Params

store_id

string

required

The store ID

product_id

string

required

The unique product identifier.

Query Params

page

int32

Defaults to 1

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

per_page

int32

Defaults to 10

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

from_date

date-time

Optional. Filter images updated on or after this date. Format: 2022-01-01 or 2022-01-01T00:00:00. Results are sorted by updated_at ascending. Can be used alone, with to_date, or omitted. Returns 400 Bad Request if date format is invalid or if from_date is after to_date.

to_date

date-time

Optional. Filter images updated on or before this date. Format: 2022-01-01 or 2022-01-01T00:00:00. Results are sorted by updated_at ascending. Can be used alone, with from_date, or omitted. Returns 400 Bad Request if date format is invalid or if from_date is after to_date.

favorite

boolean

Set to true to return only starred images or false for only unstarred images. Omit to return both. If the album has no starred images, true returns 404 Album not found.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

How to use this endpoint

Instagram media

200200

400400