What you can build

Most partner apps combine a few of the paths below. Paths marked app token run on your server with the access token you get when a merchant installs your app. Paths marked public use storefront endpoints that need only the merchant's store ID, so you can call them from browser code.

Install your app and make your first call (app token)

Every integration starts here: the merchant installs your app, you exchange the install code for an access token, and you call the merchant's store.

• Start with: Authenticating with OAuth 2.0, then Generate Access Token.
• Then: send the token in the X-Yotpo-Token header. Working with entity identifiers explains how to go from the merchant's product or order IDs to Yotpo IDs.
• Handle errors and test safely: Errors and Testing your integration.
• Before launch: support both ways to uninstall, your own button (Remove Application) and the uninstall event from Yotpo (Yotpo Events). Then certify and launch your integration.

Show reviews and star ratings on a storefront (public)

Render the merchant's reviews in your own components: product pages, category pages, search results, mobile apps and recommendation widgets.

• Start with: Display product reviews on a product page and Show star ratings across a category page (recipes).
• Add: Search and filter reviews, Show an AI review summary and smart topics, Show a featured reviews carousel.
• Guides: Search & Merchandising, Product Recommendations, Mobile Apps.
• Reference: Retrieve product reviews, Retrieve bottomline scores, and the rest of the Reviews Storefront section.

Show loyalty points on product pages (public)

Show "Earn X points" for each product and variant, based on the merchant's loyalty earning rules.

• Start with: Show loyalty points on a product page (recipe).
• Reference: Product Potential Points. For points that include a signed-in shopper's VIP tier, Authenticated Product Potential Points.

Make reviews readable by search engines and AI crawlers (public)

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

• Start with: Add review content for AI crawlers (recipe).
• Reference: Retrieve LLM schema.

Bring reviews and Q&A into your platform (app token)

Use review content in emails and flows, show it next to customer records, or analyze it in a BI tool or CDP.

• Guides: Email Marketing & Communications, Service Desk & CRM Integrations, BI, Analytics, and CDP.
• Reference: All Reviews, Product Reviews, Top Reviews, Best Reviews, Best Sentences, Retrieve All Questions, Create New Comment.

React to events with webhooks (app token)

Get review, loyalty and app events as they happen instead of polling.

• Start with: About Webhooks: create a target and a filter once for your app, then a subscription per store.
• Events: Yotpo Events for reviews and app uninstalls, Introduction to Loyalty Events for points, rewards, referrals and VIP tiers.
• Reference: Create target, Create filter, Create store subscription.

Read orders, products and customers (app token)

Read the merchant's store data, and update fulfillments so review requests go out at the right time.

• Guides: Shipping & Returns, Common Objects.
• Reference: Retrieve Orders, Retrieve Order Fulfillments, Update Order Fulfillment, Retrieve Products, Retrieve Customers, Create or Update Customer.

Reward loyalty actions (app token)

Award points for actions that happen in your product, and show shoppers their balance and referral link.

• Guides: On-site Engagement & Lead Capture, Influencer & Affiliate Marketing.
• Reference: Record Loyalty Customer Action, Adjust Loyalty Customer Points, Retrieve Loyalty Customer Details by Email.