mParticle Event - Loyalty Check-in
This includes user loyalty check-in events triggered as they happen in the Punchh system.
{
"source_request_id": null,
"events": [
{
"data": {
"product_action": {
"action": "checkout",
"transaction_id": "26153",
"total_amount": 22.8600006103516,
"tax_amount": 0,
"shipping_amount": 0,
"coupon_code": null,
"products": [
{
"id": "3419",
"name": "White rice",
"price": 2,
"quantity": 1,
"custom_attributes": {
"menu_family": "800",
"menu_item_type": "M",
"menu_major_group": "152",
"serial_number": "1"
}
},
{
"id": "3418",
"name": "Brown rice",
"price": 7.86,
"quantity": 1,
"custom_attributes": {
"menu_family": "800",
"menu_item_type": "M",
"menu_major_group": "152",
"serial_number": "2"
}
}
]
},
"event_name": "eCommerce - Checkout",
"custom_event_type": "checkout",
"timestamp_unixtime_ms": "1621001451221",
"event_id": "4272242131884770869",
"custom_attributes": {
"approved": "true",
"bar_code": "BARCODE_GOES_HERE",
"campaign_id": "18",
"campaign_name": "Post Checkin - Message",
"campaign_type": "PostCheckinCampaign",
"channel": "OnlineOrder",
"checkin_id": "26153",
"checkin_type": "PosCheckin",
"created_at": "2021-05-14T14:09:07Z",
"earnable_amount": "22.86",
"event_action": "create",
"event_name": "checkins",
"event_type": "loyalty",
"expiring_on": "2021-05-19",
"external_uid": "",
"first_punchh_at_business": "false",
"first_punchh_at_location": "false",
"free_punchh_campaign_id": "18",
"location_id": "110",
"location_name": "Franhcisee Location",
"pending_refresh": "false",
"points_earned": "23",
"points_spent": "0",
"punchh_key": "PUNCHH_KEY_GOES_HERE",
"receipt_amount": "22.86",
"receipt_date": "2021-04-30T18:39:42Z",
"redemption_id": "0",
"status": "loyalty",
"store_number": "4487",
"transaction_no": "1424881017",
"updated_at": "2021-05-14T14:09:07Z"
}
},
"event_type": "commerce_event"
}
],
"user_attributes": {
"Punchh_account_balance_current_membership_level_name": "Silver Level",
"Punchh_account_balance_last_visit": "2021-05-14T14:09:07Z",
"Punchh_account_balance_loyalty_points": "69",
"Punchh_account_balance_net_balance": "69",
"Punchh_account_balance_net_debits": "0",
"Punchh_account_balance_pending_points": "0",
"Punchh_account_balance_total_credits": "69",
"Punchh_account_balance_total_debits": "0.0",
"Punchh_account_balance_total_lifetime_points": "69",
"Punchh_account_balance_total_point_credits": "69",
"Punchh_account_balance_total_visits": "3",
"Punchh_business_id": "6",
"Punchh_email": "test@example.com",
"Punchh_first_name": "FIRST_NAME_GOES_HERE",
"Punchh_gender": "Male",
"Punchh_guest_type": "Loyalty",
"Punchh_last_activity_at": "2021-05-14T14:09:07Z",
"Punchh_last_name": "LAST_NAME_GOES_HERE",
"Punchh_marketing_email_opt_in": "True",
"Punchh_marketing_email_subscription": "True",
"Punchh_marketing_pn_opt_in": "True",
"Punchh_marketing_pn_subscription": "True",
"Punchh_secondary_email": "test1@example.com",
"Punchh_signup_channel": "MobileEmail",
"Punchh_sms_subscription": "False",
"Punchh_unsubscribed": "False",
"Punchh_user_id": "5852",
"Punchh_user_status": "active",
"Punchh_address": "Mi Road",
"Punchh_city": "Jaipur",
"Punchh_confirmation_sent_at": "2021-04-30T12:09:12Z",
"Punchh_created_at": "2021-04-30T12:09:12Z",
"Punchh_current_sign_in_at": "2021-04-30T12:09:12Z",
"Punchh_current_sign_in_ip": "10.77.41.237",
"Punchh_invite_code": "RohieEc574",
"Punchh_joined_at": "2021-04-30T12:09:12Z",
"Punchh_last_sign_in_at": "2021-04-30T12:09:12Z",
"Punchh_last_sign_in_ip": "10.77.41.237",
"Punchh_last_user_agent": "MyRewards/2.0/2 (x86_64; iOS 10.3; Scale/2.00)",
"Punchh_referral_code": "Rohcyd4778",
"Punchh_referred_by_id": "5785",
"Punchh_state": "Rajasthan",
"Punchh_terms_and_conditions_opt_in": "True",
"Punchh_updated_at": "2021-04-30T12:09:12Z",
"Punchh_zip_code": "302012",
"Punchh_favorite_location": [
"107"
],
"Punchh_favorite_store_numbers": [
"4456"
]
},
"deleted_user_attributes": null,
"user_identities": {
"email": "test@example.com"
},
"environment": "development",
"ip": "",
"integration_attributes": null,
"source_info": {
"channel": "partner",
"partner": "Punchh",
"replay_request_id": null,
"replay_job_id": null,
"is_historical": false
}
}
Response Parameters
| Event Name | Type | Description |
|---|---|---|
| data.products.id | String | ID of the product |
| data.products.name | String | Name of the product |
| data.products.price | String | Price of the product |
| data.products.quantity | String | Quantity of the product |
| data.products.custom_attributes | String | See the menu_items object in Event - Check-in - Gift and Loyalty |
| data.custom_attributes.event_action | String | Operation associated with the event (e.g., create/update/delete for user, POS/console/online for check-ins, etc.) |
| data.custom_attributes.event_name | String | Name of the event, such as user, check-ins, redemption, etc. |
| data.custom_attributes.event_type | String | Type of the event (e.g., gift or loyalty for check-ins, etc.) |
See the table in the Response Parameters section of Event - Check-in - Gift and Loyalty for descriptions of the parameters in the custom_attributes object.
See the table in the Response Parameters section of mParticle Event - Guest for descriptions of the parameters in the user_attributes object.