Welcome

The UGC API V3 — storefront reviews, rebuilt on a CDN.

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/storefront

Authentication

Send your access token on every request in the X-Yotpo-Token header:

curl "https://api-cdn.yotpo.com/v3/storefront/store/YOUR_STORE_ID/product/YOUR_PRODUCT_ID/reviews" \
  -H "X-Yotpo-Token: YOUR_ACCESS_TOKEN"

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
  • LLM schema — structured review HTML for AI and SEO surfaces

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