Improved

All Yotpo API docs are now in one place

The Yotpo API docs now live together at docs.yotpo.com. One search and one sidebar cover every API:

  • Yotpo API V3: Core (products, orders, customers), Reviews storefront, Loyalty V3, privacy requests and webhooks
  • Loyalty API (V2): customers, points, redemptions and referrals
  • Reviews API (V1): reviews, Q&A, Visual UGC and the other Reviews features
  • App partners: building an app that Yotpo merchants install
  • Core API V1 (legacy)

What's new:

  • One way to authenticate on api.yotpo.com. A single access token works for V3, Reviews V1 and Core V1, sent in the X-Yotpo-Token header. See About authentication.
  • One page per topic. Errors, Testing your integration and What you can build each cover every API on one page.
  • App partners notes on shared endpoints. Reference pages for shared endpoints, such as Retrieve orders, show app partners the URL and token to use.
  • Every webhook event in one list. See Webhook events.
  • Endpoints the widgets already use, now documented. Promoted products, star distribution, Visual UGC gallery media, the AI review summary, answered questions for a product, retrieving and updating questions and answers, and Loyalty referral programs.
  • One page per endpoint. Where a Reviews V1 endpoint has a V3 equivalent, the V1 page is hidden and points to the V3 page. Old links to those pages still work.
  • LLM schema shows the HTML it returns. Retrieve LLM schema HTML for a product now shows the <div id="yotpo-reviews-section-data"> HTML block the endpoint returns, not a JSON-LD example. Its code samples now skip products with no reviews.
  • Fixed: the App partners Update an Answer path now includes {answer_id}.

Links to apidocs.yotpo.com, core-api.yotpo.com, loyaltyapi.yotpo.com and develop.yotpo.com redirect to the matching page here. The APIs themselves haven't changed.