For AI agents: visit https://develop.yotpo.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home Guides API Reference Changelog

Core API UGC API Loyalty API Help Center

API Reference

Core API UGC API Loyalty API Help Center

Home Guides API Reference Changelog

App Developer API

Getting Started
Table of Contents
Guidelines and Conventions
Changelog
Generate Access Tokenpost
Remove Applicationdel

Orders and Fulfillments

Introduction to Orders and Fulfillments
Retrieve Ordersget
Retrieve Order Fulfillmentsget
Update Order Fulfillmentpatch

Products

Introduction to Products
All Productsget
Product Dataget
Promoted Productsget
Retrieve Productsget
Retrieve product variantsget

Reviews

Introduction to Reviews
All Reviewsget
Product Reviewsget
Product Star Ratingget
Review by Review IDget
Top Reviewsget
Best Reviewspost
Best Sentencespost
Publish/Unpublish Reviewspost

Customers

Introduction to Customers
Create or Update Customerpatch
Retrieve Customersget
Retrieve Loyalty Customer Details by Emailpost

Loyalty & Referrals

Adjust Loyalty Customer Pointspost
Record Loyalty Customer Actionpost

Comments for Reviews

Create New Commentpost
Retrieve Existing Commentget
Update Existing Commentput
Delete Commentdel

Static HTML

Retrieve the Reviews Payload in HTML

Q&A

Retrieve All Questionsget
Retrieve Questions and Answers for a Product
Retrieve the Bottom Line for Questions and Answers
Vote on Answers

Visual UGC

Photos by Album
Product Images

Yotpo Webhooks

About Webhooks
Yotpo Events
Create targetpost
Retrieve targetsget
Retrieve target by IDget
Update targetpatch
Delete targetdel
Create filterpost
Retrieve filtersget
Retrieve filter by IDget
Update filterpatch
Delete filterdel
Store-level webhook subscriptions
App-level webhook subscriptions

Loyalty & Referrals Webhooks

Introduction to Loyalty Events
Coupon Earned (Awarded)
Coupon Earned (Redeemed)
Custom Reward Redeemed
Customer Birthday
Customer Birthday Captured
Customer Anniversary
Customer Anniversary Captured
Donation Created
Loyalty Opt In / Out
Points Changed
Points Earned
Points Reminder
Points Expiration Reminder
Redemption Below Threshold
Redemption Cancellation Request
Redemption Reminder
Referral Link Share
Referral Link Share (New)
Referral Share Reminder
Referral Product Share Link
Referral Product Share Reminder
Referral Completed
Referral Completed (New)
VIP Tier Earned
VIP Tier Lost
VIP Tier Status Changed
VIP Tier Expiration Reminder
Commerce Cloud Integration Disabled

Powered by

App Developer API

Changelog

See the API changelog for the latest changes and updates to Yotpo APIs.

Updated over 1 year ago

Guidelines and Conventions

Generate Access Token

Did this page help you?

Updated over 1 year ago

Guidelines and Conventions

Generate Access Token

Did this page help you?