Jump to Content

Guides API Reference

Core API UGC API App Developer API Help Center

Core API UGC API App Developer API Help Center

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
- Record a Customer Actionpost
- Adjust a Customer's Point Balancepost
Customers
Point Redemptions
- Create Redemptionpost
- Approve Redemption Cancellationpost
Redemption Options
Referrals
- Identify Referrerpost
- Send Referral Emailspost
Campaigns
- Get Active Campaignsget
Orders
- Create Orderpost
Refunds
- Create Refundpost
VIP Tiers
- Fetch VIP Tiersget
Privacy
- Data existsget
- User dataget

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 Product Share Link
Referral Product Share Reminder
Referral Completed
VIP Tier Earned
VIP Tier Lost
VIP Tier Status Changed
Commerce Cloud Integration Disabled
Customer Anniversary Captured

Powered by

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
- Record a Customer Actionpost
- Adjust a Customer's Point Balancepost
Customers
Point Redemptions
- Create Redemptionpost
- Approve Redemption Cancellationpost
Redemption Options
Referrals
- Identify Referrerpost
- Send Referral Emailspost
Campaigns
- Get Active Campaignsget
Orders
- Create Orderpost
Refunds
- Create Refundpost
VIP Tiers
- Fetch VIP Tiersget
Privacy
- Data existsget
- User dataget

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 Product Share Link
Referral Product Share Reminder
Referral Completed
VIP Tier Earned
VIP Tier Lost
VIP Tier Status Changed
Commerce Cloud Integration Disabled
Customer Anniversary Captured

Powered by

Create/Remove Redemptions

Use the following methods to control on-site redemption usability.