v1

latestOpenAPI 3.0.12026-07-21191548.4 KB
Referrals

Get customer referral history

get/loyalty/cp/api/customer-referrals

Query parameters

pageinteger
sizeinteger
sortstring[]

Pagination parameters (page number, size, sort)

Response

Customer referrals retrieved successfully with pagination headers (X-Total-Count, Link)

claimAtstring date-time
createAtstring date-time required
customerIdinteger required
descriptionstring
idinteger
pixelDatastring
referralNotestring
referralRewardedboolean
referralRuleIdinteger
referredEmailIdstring required
referredNotestring
referredRewardedboolean
shopstring required
status'PENDING' | 'CLAIMED' | 'RECURRING' required