Check-in (Object)

  • Barcode printed on the receipt

  • ID of the loyalty check-in made by the user

  • Date/time when the check-in was created in the system, in ISO 8601 format

  • Membership level of the user

  • Date when points earned in the loyalty check-in will expire

  • External unique identifier of the check-in

  • Whether it is the first check-in at the business or not

  • The user's currently active gifted tier, such as "Gold Level".

    Note:

    • When in the Program Meta API, membership_tier_boost is set to enabled or disabled_keep_active, the response includes gifted_tier and membership_tier_expiry_at.
    • The gifted_tier and membership_tier_expiry_at are returned with null values when the gifted tier is lower than the user's current operative tier, the gifted tier has expired, or the gifted tier is the same as the user's current operative tier.
    • When membership_tier_boost is set to disabled, gifted_tier and membership_tier_expiry_at are omitted from the response.
  • ID of the location associated with the loyalty check-in

  • The date and time when the gifted tier expires, in ISO 8601 format.

    Note:

    • When in the Program Meta API, membership_tier_boost is set to enabled or disabled_keep_active, the response includes gifted_tier and membership_tier_expiry_at.
    • The gifted_tier and membership_tier_expiry_at are returned with null values when the gifted tier is lower than the user's current operative tier, the gifted tier has expired, or the gifted tier is the same as the user's current operative tier.
    • When membership_tier_boost is set to disabled, gifted_tier and membership_tier_expiry_at are omitted from the response.
  • Number of pending points

  • Whether check-in is pending refresh or not

  • Number of points earned in the loyalty check-in

  • The store number where the check-in occurred