LoyaltyRewardState

A Reward that has been issued to a Member's Loyalty Enrollment.

When updating, already existing fields omitted from the payload will generally not be deleted unless otherwise specified.

  • reward_id
    Type: integer
    required

    Integer numbers.

  • created_at
    Type: stringFormat: date-time
    read-only

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

  • enrollment_id
    Type: integer
    read-only

    Integer numbers.

  • external_ref_id
    Type: string
  • id
    Type: integer
    read-only

    Integer numbers.

  • issued_point_value
    Type: integer
    min:  
    1

    How many Points were deducted from an Enrollment to purchase the Reward. This field is only required and should be set by the user for Variable Point Value Offer Rewards. For all other Reward types, this field will be set to the point value of the Reward at the time of issuance.

  • offer_state_id
    Type: integer
    read-only

    Offer State created when issuing a Sparkfly Offer Reward.

  • status
    Type: stringenum
    read-only
    values
    • pending
    • fulfilling
    • fulfilled
    • completed
    • voided
  • updated_at
    Type: stringFormat: date-time
    read-only

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