get
https://api-cdn.yotpo.com/v3/storefront/stores//products//productData
This endpoint Retrieves Product-level data for a given product by product ID (domain_key). Product-level data can be used within your reviews widget.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
For example, you can use it to:
- Retrieve Smart Topics (AI-generated filters) - displayed as smart filters within your reviews widget.
- Retrieve AI review summary (AI-generated reviews summary per product) - displayed as CTA within your reviews widget.
- Retrieve Summary Highlights (Returns the highlights from 3 top reviews - chosen by AI) - displayed as part of the AI summary within your reviews widget.
- Retrieve the countries the product was reviewed from - displayed as smart filters within your reviews widget;
- Retrieve Custom Questions per product - displayed as smart filters within your reviews widget;
- Retrieve Metadata per product - displayed as smart filters within your reviews widget;
- Retrieve Variants per product - displayed as Variant filters within your reviews widget;
The endpoint accepts a query parameter called include, which specifies the type of data to retrieve. This parameter is a list that may include as indicated above:
Each of these is case-sensitive and allows you to control which sections of data are returned, helping to limit the size and scope of the response.
ImportantThe Include query param is required in order for this call to return a 200 result.
Expected Response
When the request is successful, you’ll receive a 200 OK status code, meaning the data retrieval was successful. Here’s what each part of the response data includes:
How to use this endpoint
- Requests for this endpoint are limited to 30,000 requests/minute, per IP address.
- Data is retrieved with a delay of 3 hours.