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.

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.

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.

favorite=true

string

Retrieve only starred images.

favorite=false

string

Retrieve only unstarred images.

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.

Responses

How to use this endpoint

200200

400400