Loyalty API

Type

CustomerReferralStats3

Customer-facing referral counters and totals.

Kind Type
Used in CustomerBalance3, CustomerReferrals2, LoggedOutBalance1

Properties

  • invited integer required

    Number of referrals in invited status.

  • qualified integer required

    Number of referrals in qualified status.

  • approved integer required

    Number of approved referrals.

  • rejected integer required

    Number of rejected referrals.

  • earned_pts integer required

    Number of points the customer has earned from referrals.

  • earned_amount monetary required

    Amount the customer has earned from referrals as direct monetary rewards.

  • points_balance integer required

    The customer's current loyalty points balance.

  • points_earned_total integer required

    Total loyalty points the customer has earned across the program.

Previous
CustomerIdentity1