Jump to Content
Guides
API Reference
API reference
Core API
UGC API
Loyalty API
Help Center
API Reference
Search
API reference
Core API
UGC API
Loyalty API
Help Center
API Reference
Guidelines and Conventions
All
Pages
Start typing to search…
JUMP TO
App Developer API
Getting Started
Table of Contents
Guidelines and Conventions
Changelog
Generate Access Token
post
Remove Application
del
Orders and Fulfillments
Introduction to Orders and Fulfillments
Retrieve Orders
get
Retrieve Order Fulfillments
get
Update Order Fulfillment
patch
Products
Introduction to Products
All Products
get
Product Data
get
Promoted Products
get
Retrieve Products
get
Retrieve product variants
get
Reviews
Introduction to Reviews
All Reviews
get
Product Reviews
get
Product Star Rating
get
Review by Review ID
get
Top Reviews
get
Best Reviews
post
Best Sentences
post
Publish/Unpublish Reviews
post
Customers
Introduction to Customers
Create or Update Customer
patch
Create or Update Custom Customer Event
patch
Retrieve Customers
get
Retrieve Customer Details by Email
get
Retrieve Customer Details by Date
get
Retrieve Loyalty Customer Details by Email
post
Audience Management
Introduction to audience management
Create or update subscriber
post
Get Lists
get
Create List
post
Add contacts to List
post
Remove contacts from List
post
Get Segments API endpoint
get
Yotpo SMS & EMail Analytics
About SMS & Email Analytics APIs
Explore
Dimensions
get
Measures
get
Source
Campaigns
get
Automations
get
Flows
get
Aggregations
get
Loyalty & Referrals
Adjust Loyalty Customer Points
post
Record Loyalty Customer Action
post
Comments for Reviews
Create New Comment
post
Retrieve Existing Comment
get
Update Existing Comment
put
Delete Comment
del
Static HTML
Retrieve the Reviews Payload in HTML
Q&A
Retrieve All Questions
get
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 target
post
Retrieve targets
get
Retrieve target by ID
get
Update target
patch
Delete target
del
Create filter
post
Retrieve filters
get
Retrieve filter by ID
get
Update filter
patch
Delete filter
del
Store-level webhook subscriptions
Create store subscription
post
Retrieve store subscriptions
get
Retrieve store subscription by ID
get
Update store subscription
patch
Delete store subscription
del
App-level webhook subscriptions
Create app subscription
post
Retrieve app subscriptions
get
Retrieve app subscription by ID
get
Update app subscription
patch
Delete app subscription
del
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
Redemption Below Threshold
Redemption Cancellation Request
Redemption Reminder
Referral Link Share
Referral Share Reminder
Referral Product Share Link
Referral Product Share Reminder
Referral Completed
VIP Tier Earned
VIP Tier Lost
VIP Tier Status Changed
Commerce Cloud Integration Disabled
Powered by
Guidelines and Conventions
Ask AI
