Quickstart

Call a merchant's store in two steps

When a merchant installs your app, Yotpo sends a one-time code and their store ID to your redirect URL. Swap the code for an access token, then call the store's data.

Read the OAuth guide Browse the API reference

cURLToken per merchant store

# 1. Exchange the install code for an access token
curl -X POST "https://developers.yotpo.com/v2/oauth2/token" \
  -H "Content-Type: application/json" \
  -d '{"grant_type": "authorization_code",
       "client_id": "YOUR_APP_ID",
       "client_secret": "YOUR_APP_SECRET",
       "redirect_uri": "YOUR_REDIRECT_URI",
       "code": "YOUR_INSTALL_CODE"}'

# 2. List the merchant's products
curl "https://developers.yotpo.com/core/v3/stores/YOUR_STORE_ID/products?limit=5" \
  -H "X-Yotpo-Token: YOUR_ACCESS_TOKEN"

Example response

{
  "products": [ { "yotpo_id": 12345, "external_id": "SKU-001", "name": "Example product", ... } ],
  "pagination": { "next_page_info": "eyJjdXJzb3Ii..." }
}

Build by use case

See all use cases

Guide Email marketing Ratings, top reviews and review-based segments in campaigns and flows. Guide Service desk and CRM Moderate reviews and show review history on each customer profile. Guide Search and merchandising Star ratings, top reviews and rating filters in search results. Guide Product recommendations Star ratings, top reviews and customer photos in recommendations. Guide BI, analytics and CDP Tie review data to your KPIs, segments and custom reports. Guide Shipping and returns Time review requests to delivery and show ratings on tracking pages.

More Yotpo APIs

Reviews & UGC Reviews, ratings, Q&A and visual content for storefronts and backends. apidocs.yotpo.com 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

Essentials

Register your app Open a test account and get your app ID and secret. Authentication The OAuth 2.0 install flow, access tokens and uninstalls. Guidelines & conventions Data format, pagination, rate limits and parameter formats. Webhooks Get store and app events, including the uninstall event. Certify and launch Get your integration reviewed and listed for merchants. llms.txt for AI tools The page and endpoint index for Cursor, Claude and other assistants.

200The store's earning rules.

401Missing or invalid access token. Send a valid token in the X-Yotpo-Token header.

403The token isn't for this store: the store_id in the path belongs to a store your app isn't installed on.