What you can build

Most integrations fall into one of the paths below. Storefront paths use the public V3 storefront endpoints and need no token. Merchant paths run on your server and need an access token (see Authenticate and make your first call).

Show reviews and star ratings on a product page

Fetch a product's star rating and a page of reviews, and render them in your own components. This is the usual starting point for headless storefronts.

Start with: Display product reviews on a product page (recipe, 2 calls, no token).
Go deeper: Show star ratings and Fetch and render product reviews in the custom widgets guide.
Reference: Retrieve product reviews, Retrieve product rating bottomline.

Show star ratings on category pages

Show a rating on every product card without calling the API once per product.

Start with: Show star ratings across a category page (recipe).
Go deeper: Ratings across a category or collection page, including how to cache ratings on your server.
Reference: Retrieve bottomline scores.

Let shoppers search and filter reviews

Add free-text search, star filters, photo filters, and topic chips to your reviews section.

Start with: Search and filter reviews (recipe).
Go deeper: Filter and search in the custom widgets guide.
Reference: Search product reviews, Retrieve product filters.

Show an AI review summary and featured reviews

Display Yotpo's AI-generated summary and topics above your reviews, or a carousel of top reviews on a product page or home page.

Start with: Show an AI review summary and smart topics or Show a featured reviews carousel (recipes).
Go deeper: AI summary and smart topics and Featured reviews carousel.
Reference: Retrieve product data, Retrieve top product reviews.

Collect reviews from your own form

Submit reviews and photos from a form you build, and let shoppers vote reviews helpful. Send these calls from your server.

Start with: Create a review (recipe).
Go deeper: Collect reviews and votes: validation, bot protection, photos, and votes.
Reference: Create review, Upload images with reviews, Upvote or downvote reviews.

Make reviews readable by search engines and AI crawlers

Put ratings and reviews in your page source so search engines and AI assistants can read them.

Start with: Add review content for AI crawlers (recipe).
Go deeper: SEO: make reviews readable by crawlers, including Product structured data.
Reference: Retrieve LLM schema HTML for a product.

Export reviews to your own systems

Pull all of your store's reviews into a data warehouse, CRM, or support tool. Add deleted=true to include deleted reviews. Runs on your server with an access token.

Start with: Authenticate and make your first call.
Then: Retrieve all reviews. Page through with page and count (up to 100 per page), and use since_updated_at to fetch only what changed.
Also useful: Retrieve bottom line for all products for ratings per product.

Handle privacy requests

Check whether Yotpo holds a shopper's data, export it, or delete it in response to a privacy request.

Start with: About Privacy API.
Reference: Data exists, User data, GDPR Delete.

More you can build

Questions and answers: show and collect product Q&A. See About Q&A.
Visual UGC galleries: Instagram and imported media, albums, and product galleries. See About Visual UGC.
Review insights: topics and sentiment across your reviews. See About Insights API.
Not sure where to start? Read Guidelines & Conventions for base URLs, pagination, rate limits, and errors.
Before you go live: read Errors for how to handle each status code, and Testing your integration for which calls send emails or change data permanently.