mParticle Event - Redemptions
This includes user redemptions create/update events triggered as they happen in the Punchh system.
{
"source_request_id": null,
"events": [
{
"data": {
"product_action": {
"action": "checkout",
"transaction_id": "2711",
"total_amount": 10,
"tax_amount": 0,
"shipping_amount": 0,
"coupon_code": null,
"products": [
{
"id": "18057",
"name": "White rice",
"price": 9,
"quantity": 1,
"custom_attributes": {
"menu_family": "800",
"menu_item_type": "M",
"menu_major_group": "152",
"serial_number": "1"
}
}
]
},
"event_name": "eCommerce - Checkout",
"custom_event_type": "checkout",
"custom_attributes": {
"bar_code": "08769941206",
"channel": "POS",
"created_at": "2021-04-30T11:57:34Z",
"event_action": "create",
"event_name": "redemptions",
"event_type": "",
"expiring_on": "2021-04-30T15:57:34Z",
"internal_tracking_code": "7917837",
"location_id": "106",
"location_name": "Punchh Location - 001",
"points_requested": "100",
"redeemable_id": "59",
"redeemable_name": "$2 OFF",
"redeemed_points": "2",
"redemption_code_discount": "2",
"redemption_code_employee_id": "1254",
"redemption_code_id": "5273",
"redemption_code_location_id": "106",
"redemption_code_processed_at": "2021-04-30T11:57:34Z",
"redemption_code_receipt_amount": "10.00",
"redemption_code_receipt_datetime": "2018-11-28 02:13:00 -0800",
"redemption_code_status": "processed",
"redemption_code_subtotal_amount": "9.00",
"redemption_code_transaction_no": "3502762306",
"redemption_id": "2711",
"redemption_status": "redeemed",
"redemption_type": "RedeemableRedemption",
"store_number": "3478",
"updated_at": "2021-04-30T11:57:34Z",
"user_id": "5851"
}
},
"event_type": "commerce_event"
}
],
"user_attributes": {
"Punchh_account_balance_current_membership_level_name": "Gold",
"Punchh_account_balance_loyalty_points": "0",
"Punchh_account_balance_net_balance": "0",
"Punchh_account_balance_net_debits": "200",
"Punchh_account_balance_pending_points": "0",
"Punchh_account_balance_total_credits": "200",
"Punchh_account_balance_total_debits": "200.0",
"Punchh_account_balance_total_lifetime_points": "200",
"Punchh_account_balance_total_point_credits": "200",
"Punchh_account_balance_total_visits": "0",
"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-04-30T11:57:34Z",
"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": "test01@example.com",
"Punchh_signup_channel": "MobileEmail",
"Punchh_sms_subscription": "False",
"Punchh_unsubscribed": "False",
"Punchh_user_id": "5851",
"Punchh_user_status": "active",
"Punchh_email_confirmation_url": "URL_GOES_HERE"
},
"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
| Events | ||
|---|---|---|
| data.product_action.products.id | String | ID of the product |
| data.product_action.products.name | String | Name of the product |
| data.product_action.products.price | String | Price of the product |
| data.product_action.products.quantity | String | Quantity of the product |
| data.product_action.products.custom_attributes | String | See the menu_items object in Event - Check-in - Gift and Loyalty |
| data.custom_attributes.redemption_code_discount | Float | See redemption_code.discount parameter description in the table in the Response Parameters section in Event - Redemptions for the description of the parameter |
| data.custom_attributes.redemption_code_employee_id | String | See redemption_code.employee_id parameter description in the table in the Response Parameters section in Event - Redemptions for the description of the parameter |
| data.custom_attributes.redemption_code_id | Integer | See redemption_code.id parameter description in the table in the Response Parameters section in Event - Redemptions for the description of the parameter |
| data.custom_attributes.redemption_code_location_id | Integer | See redemption_code.location_id parameter description in the table in the Response Parameters section in Event - Redemptions for the description of the parameter |
| data.custom_attributes.redemption_code_processed_at | Date_time | See redemption_code.processed_at parameter description in the table in the Response Parameters section in Event - Redemptions for the description of the parameter |
| data.custom_attributes.redemption_code_receipt_amount | Float | See redemption_code.receipt_amount parameter description in the table in the Response Parameters section in Event - Redemptions for the description of the parameter |
| data.custom_attributes.redemption_code_receipt_datetime | Date_time | See redemption_code.receipt_datetime parameter description in the table in the Response Parameters section in Event - Redemptions for the description of the parameter |
| data.custom_attributes.redemption_code_status | String | See redemption_code.status parameter description in the table in the Response Parameters section in Event - Redemptions for the description of the parameter |
| data.custom_attributes.redemption_code_subtotal_amount | Float | See redemption_code.subtotal_amount parameter description in the table in the Response Parameters section in Event - Redemptions for the description of the parameter |
| data.custom_attributes.redemption_code_transaction_no | String | See redemption_code.transaction_no parameter description in the table in the Response Parameters section in Event - Redemptions for the description of the parameter |
| redemption_code_type | See redemption_code_pass.type parameter description in the table in the Response Parameters section in Event - Redemptions for the description of the parameter |
|
| 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 - Redemptions 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.