Skip to main content

Affiliate

KeyTypeDescription
idIntegerthe unique identifier for the affiliate link.
urlstringthe affiliate link itself. When users access this URL and make a purchase, the associated affiliate is credited with the referral.
referralstringthe referral code associated with the affiliate link. It helps track which affiliate referred the user.
affiliate_idIntegerthe unique identifier for the affiliate. It links the affiliate to the affiliate link.
expiration_dateDatetimethe date and time when the affiliate link will expire, after which it may no longer be valid for tracking referrals.
affiliateobjectan object containing detailed information about the affiliate, including their name, email, phone number, and various other attributes related to their account.
history_countintegerthe number of times the affiliate link has been used or resulted in referrals.
created_atDatetimethe date and time when the affiliate link was created.

User Affiliate Resource

KeyTypeDescription
idIntegera unique identifier for the user's profile.
nameStringthe user's first name.
last_nameStringthe user's last name.
emailStringthe user's email address.
imageStringthe user's profile picture or image URL.
phoneStringthe user's phone number.
phone_verifiedBooleana flag indicating if the user's phone number has been verified or not.
birthdateStringthe user's birthday in the format of YYYY-MM-DD.
tokenTextthe user's authentication token used for accessing protected resources.
rateIntegerthe user's rating in the platform.
total_pointsIntegerthe total number of points the user has earned in the platform.
is_goldBooleana flag indicating if the user is a gold member or not.
spentIntegerthe total amount of money the user has spent in the platform.
gold_amountIntegerthe amount of gold the user currently has.
points_to_goldIntegerthe number of points required to convert to gold.
points_to_expireIntegerthe number of points that will expire soon.
referalStringthe user's referral code.
primary_addressObjectthe user's primary address.
next_expiration_dateStringthe date when the next point expiration will occur.
ex_rate_ptsIntegerthe exchange rate of points.
ex_rate_egpIntegerthe exchange rate of Egyptian pounds (EGP).
ex_rate_goldIntegerthe exchange rate of gold.
refer_pointsIntegerthe number of points earned through referrals.
pending_daysIntegerthe number of pending days for point approval.
is_affiliateBooleana flag indicating if the user is an affiliate or not.
areaObjectthe user's area.
branchObjectthe user's branch.
is_guestBooleana flag indicating if the user is a guest or not.
latStringthe user's latitude coordinate.
lngStringthe user's longitude coordinate.
wallet_balanceStringthe user's current balance in their wallet.
user_wallet_historyObjectan array of the user's wallet transaction history..