• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index
You are viewing an old version of the API
LoyaltyEvent

Provides information about a loyalty event.

For more information, see Search for Balance-Changing Loyalty Events.

Properties
Name Description
id
string
Required

Read only The Square-assigned ID of the loyalty event.

Min Length 1
type
string
Required

Read only The type of the loyalty event.
created_at
string
Required

Read only The timestamp when the event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Min Length 1
accumulate_points
LoyaltyEventAccumulatePoints

Read only Provides metadata when the event type is ACCUMULATE_POINTS.
create_reward
LoyaltyEventCreateReward

Read only Provides metadata when the event type is CREATE_REWARD.
redeem_reward
LoyaltyEventRedeemReward

Read only Provides metadata when the event type is REDEEM_REWARD.
delete_reward
LoyaltyEventDeleteReward

Read only Provides metadata when the event type is DELETE_REWARD.
adjust_points
LoyaltyEventAdjustPoints

Read only Provides metadata when the event type is ADJUST_POINTS.
loyalty_account_id
string
Required

Read only The ID of the loyalty account associated with the event.

Min Length 1 Max Length 36
location_id
string

Read only The ID of the location where the event occurred.
source
string
Required

Read only Defines whether the event was generated by the Square Point of Sale.
expire_points
LoyaltyEventExpirePoints

Read only Provides metadata when the event type is EXPIRE_POINTS.
other_event
LoyaltyEventOther

Read only Provides metadata when the event type is OTHER.
accumulate_promotion_points
LoyaltyEventAccumulatePromotionPoints

Read only Provides metadata when the event type is ACCUMULATE_PROMOTION_POINTS.