Welcome to the Yotpo UGC API (V3)
V3 is the next generation of the UGC API, being built out incrementally, starting with storefront reviews: fast, CDN-backed read endpoints for displaying product and store reviews, ratings, filters, media, and review search on your storefront.
V3 currently covers storefront reviews. For everything else (creating reviews, Q&A, Visual UGC, coupons, metadata, and more), use V1, which remains fully supported.
Base URL
Storefront endpoints are served from a CDN for fast, cache-friendly reads:
https://api-cdn.yotpo.com/v3/storefrontAuthentication
Storefront endpoints are public, so no access token is needed. Your store ID in the path identifies the store, and you can call them from server or browser code:
curl "https://api-cdn.yotpo.com/v3/storefront/store/YOUR_STORE_ID/product/YOUR_PRODUCT_ID/reviews"Most V1 merchant endpoints, such as exporting reviews or managing review metadata, need an access token. See Authenticate and make your first call.
What's here today
- Product reviews: retrieve, search, and filter reviews for a product, including top reviews and review media
- Store reviews: retrieve and search site-level reviews
- Ratings & bottomlines: product rating bottomlines and all-product bottomline scores
Looking for something else?
- Backend store sync (products, orders, customers, webhooks) lives in the Core API
- All other UGC functionality is in V1 of this API. Switch versions in the top-left corner
- Loyalty & Referrals has its own API
Next steps
- Start with Retrieve product reviews
- Track what's new on the Changelog