LoyaltyActivity

A read-only log entry of something that occurred within a Member's Loyalty Enrollment. Examples may include initial Member enrollment, point credits, transactions (for points), point expirations, reward purchases, etc.

created_at
Type: stringFormat: date-time

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
description
Type: string

A longer description that may provide additional context regarding this Loyalty Activity (e.g. the name of the Reward that was purchased).
enrollment_id
Type: integer

The ID of the Loyalty Enrollment this Activity occurred for.
id
Type: integer

Integer numbers.
point_credit
Type: integer

If applicable, how many points were credited to the Enrollment in association with this Activity.
point_debit
Type: integer

If applicable, how many points were deducted from the Enrollment in association with this Activity.
reward_state_id
Type: integer

If applicable, the ID of a Sparkfly Loyalty Reward State associated with the Activity (e.g. Reward State Voided).
transaction_id
Type: integer

If applicable, the ID of a Sparkfly Transaction record associated with the Activity.
type
Type: stringenum

A short description that categorizes Loyalty Activities by the type of activity that occurred. The specified values should not be considered comprehensive.
values
- member_enrolled
- points_credited
- points_debited
- points_expired
- reward_purchased
updated_at
Type: stringFormat: date-time

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Examples

{
  "id": 0,
  "loyalty_enrollment_id": 0,
  "type": "member_enrolled",
  "point_credit": 0,
  "point_debit": 0,
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}