Loyalty & Referrals

Core API
UGC API
App Developer API
Help Center

Welcome to Yotpo's Loyalty and Referrals Developer Hub

Welcome to the Loyalty and Referrals developer hub. You'll find comprehensive guides and documentation to help you start working with Loyalty and Referrals as quickly as possible!

API Reference Guides

HomeGuidesRecipesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs

Implementation Guides

Custom/Generic Implementation

How-to Guides

Creating the "Earning Loyalty Points" Section
Creating Loyalty Redemption
Adding Point Balance, Referral Links, and Rewards Popup

Implementation Guides

Custom/Generic Implementation

How-to Guides

Creating the "Earning Loyalty Points" Section
Creating Loyalty Redemption
Adding Point Balance, Referral Links, and Rewards Popup

Loyalty and Referrals

Getting Started
Authentication

Markup

Campaigns
Redemption Options
Customer Details
Referral Program
- Sharing
- Popup
Products
- Display Points Earned Per Product
- Buy Products With Points

Javascript SDK

Intro to Loyalty Javascript SDK
Events
Get Customer Details
Refresh Customer Details
Get Active Campaigns
Get Active Redemption Options
Get VIP Tier Data
Get Customer Share Referral Link (By medium)
Show Popups
Capture Newsletter Signup
Send Referral Emails
- swellAPI.identifyReferrer()
- swellAPI.sendReferralEmails()
Populate Redemption Options
Set Relative Path URL
Add/Remove Shopify Tag
Loyalty Opt In/Out
Create/Remove Redemptions

API Reference

Intro to API Reference
Actions
- post
  Record a Customer Action
Customers
Point Redemptions
- post
  Create Redemption
- post
  Approve Redemption Cancellation
Redemption Options
Referrals
- post
  Identify Referrer
- post
  Send Referral Emails
Campaigns
- get
  Get Active Campaigns
Orders
- post
  Create Order
Refunds
- post
  Create Refund
VIP Tiers
- get
  Fetch VIP Tiers
Privacy
- get
  Data exists
- get
  User data

Webhook Events

Intro to Webhook 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 Completed
VIP Tier Earned
VIP Tier Lost
VIP Tier Status Changed

Powered by