Check-in (Object)
- barType: string
_code Barcode printed on the receipt
- checkinType: integer
_id ID of the loyalty check-in made by the user
- createdType: string
_at Date/time when the check-in was created in the system, in ISO 8601 format
- currentType: string | null
_membership _level Membership level of the user
- expiringType: stringFormat: date
_on Date when points earned in the loyalty check-in will expire
- externalType: string
_uid External unique identifier of the check-in
- firstType: string | boolean
_checkin Whether it is the first check-in at the business or not
- giftedType: string | null
_tier The user's currently active gifted tier, such as "Gold Level".
Note:
- When in the Program Meta API,
membership_tier_boostis set toenabledordisabled_keep_active, the response includesgifted_tierandmembership_tier_expiry_at. - The
gifted_tierandmembership_tier_expiry_atare 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_boostis set todisabled,gifted_tierandmembership_tier_expiry_atare omitted from the response.
- When in the Program Meta API,
- locationType: integer
_id ID of the location associated with the loyalty check-in
- membershipType: string | nullFormat: date-time
_tier _expiry _at The date and time when the gifted tier expires, in ISO 8601 format.
Note:
- When in the Program Meta API,
membership_tier_boostis set toenabledordisabled_keep_active, the response includesgifted_tierandmembership_tier_expiry_at. - The
gifted_tierandmembership_tier_expiry_atare 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_boostis set todisabled,gifted_tierandmembership_tier_expiry_atare omitted from the response.
- When in the Program Meta API,
- pendingType: integer
_points Number of pending points
- pendingType: boolean
_refresh Whether check-in is pending refresh or not
- pointsType: integer
_earned Number of points earned in the loyalty check-in
- storeType: string
_number The store number where the check-in occurred
