Skip to main content
GET
Get customer referral history

Query Parameters

page
integer
default:0

Zero-based page index (0..N)

Required range: x >= 0
size
integer
default:20

The size of the page to be returned

Required range: x >= 1
sort
string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

locale
string

Shopper's language code. Pending referrals get the note translated into this language when the store has a translation.

Response

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

createAt
string<date-time>
required
customerId
integer<int64>
required
referredEmailId
string
required
shop
string
required
status
enum<string>
required
Available options:
PENDING,
CLAIMED,
RECURRING
claimAt
string<date-time>
description
string
id
integer<int64>
orderCount
integer<int32>
pixelData
string
referralNote
string
referralRewarded
boolean
referralRuleId
integer<int64>
referredNote
string
referredRewarded
boolean