Choose your API

Yotpo API V3 Sync orders, products and customers, plus storefront reviews, Loyalty V3, privacy requests and webhooks. Core, storefront and Loyalty V3 Reviews & UGC Reviews, ratings, Q&A and visual content for any storefront or backend. Reviews API (V1) Loyalty & Referrals Points, rewards, redemptions, VIP tiers and referrals. Loyalty API (V2) App partners Build an app on Yotpo and become a technology partner. App partners API

V3 quickstart

Make your first call in two steps

Exchange your API secret for an access token on your server, then send it in the X-Yotpo-Token header on every call.

Try the quickstart Browse the API reference

cURLServer side only

# 1. Get an access token
curl -X POST "https://api.yotpo.com/core/v3/stores/YOUR_STORE_ID/access_tokens" \
  -H "Content-Type: application/json" \
  -d '{"secret": "YOUR_API_SECRET"}'

# 2. List your products
curl "https://api.yotpo.com/core/v3/stores/YOUR_STORE_ID/products?limit=5" \
  -H "X-Yotpo-Token: YOUR_ACCESS_TOKEN"

Example response

{
  "products": [
    { "yotpo_id": 1153559455, "external_id": "23234", "name": "Minimal Surfboard", ... }
  ],
  "pagination": { "next_page_info": "eyJpZEN1cnNvciI6..." }
}

Build by use case

See all use cases

Recipe Sync orders for review requests Send an order and its fulfillment so Yotpo can ask the shopper for a review. Recipe Sync your catalog and customers Create products and customers keyed by your own IDs, safe to re-run. Recipe Get events with webhooks Receive review and loyalty events at your endpoint instead of polling. Reference Send an order in one call Order, customer, products and fulfillments together, with missing products created for you. Guide Webhook events and payloads Every review and loyalty event, with an example payload for each. Guide Migrate from V1 Move V1 purchase and product calls to their V3 equivalents.

Essentials

Authentication Get an access token and send it in the X-Yotpo-Token header. Errors Every status code, the error bodies, and when to retry. Testing your integration Which calls email shoppers or can't be undone, and how to test safely. Guidelines & conventions Base URL, pagination, data formats and rate limits. Changelog The latest changes to the Yotpo APIs and their docs. Use these docs in AI tools Connect the API docs MCP to Claude, Cursor or VS Code, or point any assistant at llms.txt.

200The segment.

401Unauthorized. The X-Yotpo-Token is invalid or expired. Generate a new access token. The body is plain text.

403Forbidden. The X-Yotpo-Token header is missing, or the token belongs to a different store than store_id.

404No segment with this ID in this store. The body is plain text.

429Too many requests. These endpoints allow 5 requests per second per store. Wait for the number of seconds in the Retry-After header, then retry.

500Unexpected server error. Retry with exponential backoff. If it keeps failing, contact Yotpo support with the request time and store ID.