Yotpo UGC API

These docs are moving to docs.yotpo.com on November 5. Your links will keep working and take you to the same page on the new site.

Quickstart

Show reviews on a product page in two calls

Storefront endpoints are public. Your store ID in the path is enough, so you can call them from server or browser code.

Try the quickstart Browse the API reference

cURLNo token needed

# 1. Reviews for a product
curl "https://api-cdn.yotpo.com/v3/storefront/store/YOUR_STORE_ID/product/YOUR_PRODUCT_ID/reviews?perPage=5"

# 2. Its star rating
curl "https://api-cdn.yotpo.com/v3/storefront/store/YOUR_STORE_ID/product/YOUR_PRODUCT_ID/ratings"

Example response

{
  "pagination": { "page": 1, "perPage": 5, "total": 128 },
  "bottomline": { "totalReview": 128, "averageScore": 4.6 },
  "reviews": [ { "score": 5, "title": "Fits perfectly", ... } ]
}

Build by use case

See all use cases

Recipe Show reviews on a product page Star rating and reviews for a headless storefront, in two public calls. Recipe Star ratings on category pages Ratings for every product card without calling the API per product. Recipe Search and filter reviews Free-text search, star, photo and topic filters for your reviews section. Recipe Collect reviews from your form Submit reviews and photos from your own form, from your server. Recipe Reviews for SEO and AI crawlers Put ratings and reviews in your page source for search engines and AI. Guide Build custom review widgets Ratings, review lists, search, galleries and review forms on the V1 and V3 APIs.

More Yotpo APIs

Core Orders, products, customers, collections and webhooks for every Yotpo product. core-api.yotpo.com Loyalty & Referrals Points, rewards, redemptions, VIP tiers and referrals. loyaltyapi.yotpo.com App partners Build an app on Yotpo and become a technology partner. develop.yotpo.com

Essentials

Authentication Get an access token and learn which calls need one. Errors Every status code, the error bodies, and when to retry. Testing your integration Which calls send emails or change data, and how to test safely. Guidelines & conventions Base URLs, pagination, rate limits and data freshness. Changelog The latest changes to the UGC API and its docs. llms.txt for AI tools Every page and endpoint in one file for Cursor, Claude and other assistants.