Analytics API

ChangeType1

Specifies the exact action the caused the change.

This is not an exhaustive list. New types can be introduced without notice, and undocumented types may be returned. You MUST deal with unknown types, by either ignoring any types you do not know how to handle, or falling back to area-specific properties.

Values

  • earned_from_order

    Points have been earned from a shop order

  • earned_from_subscription

    Points have been earned for a subscription order.

  • redeemed_towards_order

    Points have been redeemed for a discount on a shop order

  • redeemed_towards_subscription

    Points have been redeemed for a discount on a subscription cycle

  • vendible_redemption

    Points have been redeemed for vending a specific promotional offer (“vendible”)

  • manual_correction

    Points have been updated by customer support

  • bulk_manual_correction

    Points have been updated by customer support or as part of a bulk promotion

  • import

    Points have been imported from a prior loyalty system

  • import_adjustment

    Adjustment record for points previously imported from a prior loyalty system

  • earned_for_backdated_order

    Points have been awarded as a backdated award for an order made before the launch of the loyalty program

  • earned_from_source

    Points have been earned using one of the “Ways to Earn Points” (aka Point Sources)

  • earned_as_referree

    Points have been earned for being referred.

  • earned_as_referrer

    Points have been earned for referring a new customer.

  • birthday_gift

    Points have been earned as a birthday gift.

  • earned_as_reward

    Points have been earned as a tier/achivement/promo reward.

  • earned_by_voting

    Points have been earned as a reward for voting.

  • order_refund

    Points have been deducted for a refunded or canceled order.

  • points_expired

    Unused points have been deducted after expiration.

  • tier_acquired

    The customer has advanced to a higher tier.

  • tier_expired

    The customer has reverted to a lower tier because of tier or points expiration.

  • tier_manual

    The customer has been moved to another tier by customer support.

  • tier_automatic

    The customer has been moved to another tier by custom automation rules.

  • tier_import

    The customer has been assigned a tier from a prior loyalty system.

  • achievement_unlocked

    The customer has unlocked an achievement.

  • achievement_used

    The customer has used an achievement's benefit, and the achievement can be used again.

  • achievement_used_up

    The customer has used an achievement's benefit, and the achievement's benefit is no longer available (the achievement is now locked again).

  • achievement_expired

    The achievement's benefit has expired or is no longer available without an explicit customer's action, and the achievement is now locked again.

  • achievement_manually_granted

    The achievement has been unlocked by customer support.

  • achievement_manually_revoked

    The achievement has been locked by customer support.

Previous
ChangeArea1