What you can build

Every integration starts the same way: generate an access token, then send it in the X-Yotpo-Token header. After that, pick the path that matches what you're building.

Sync orders so review requests go out

Send each order and its fulfillment. Yotpo sends review requests only after a fulfillment with status: success and a fulfillment_date.

• Start with: Sync an order and its fulfillment
• Go deeper: Order custom properties (including suppress_review_request), Idempotency for safe retries
• Reference: Create order, Update order, Create order fulfillment, Retrieve orders

📘

Sending everything in one call

Send aggregated order info takes the order, customer, products and fulfillments in a single request, and creates products that don't exist yet.

Sync your product catalog

Products come first: orders and reviews refer to them by external_id.

• Start with: Initial store sync
• Go deeper: Product identifiers, Working with entity identifiers
• Reference: Create product, Update product, Retrieve products, Create product variant, Create collection, Add product to collection

Sync customers

Customers are created or updated by external_id or email, so the same call is safe to re-run in a sync job.

• Start with: Initial store sync (step 2)
• Go deeper: Customer properties, including the Reviews and Loyalty summaries
• Reference: Create or update customer, Retrieve customers

React to events with webhooks

Get review and loyalty events pushed to your HTTPS endpoint instead of polling.

• Start with: Set up webhooks end to end
• Go deeper: About webhooks, Ignoring duplicate events, Topics and payloads
• Reference: Create target, Create filter, Create subscription, Retrieve subscriptions

Migrate from the V1 API

Move V1 purchase and product calls to their V3 equivalents.

• Start with: Migrating from V1 to V3
• Go deeper: About authentication, Orders, Products
• Reference: Generate access token, Create order, Create product