Event - Redemptions
This includes user redemptions create/update events triggered as they happen in the Punchh system.
{
"updated_at": "2020-06-08T05:27:23Z",
"created_at": "2020-06-08T05:27:23Z",
"business_uuid": "BUSINESS_UUID_GOES_HERE",
"content_id": "CONTENT_ID_GOES_HERE",
"timestamp": 1591594104,
"business_id": 548,
"event_name": "redemptions",
"event_type": "",
"action": "create",
"payload": {
"additional_properties": "{}",
"bar_code": null,
"channel": "POS",
"created_at": "2023-05-29T17:54:40Z",
"expired_at": null,
"expiring_on": "2020-09-29T19:54:40Z",
"force_message": null,
"internal_tracking_code": "1725845",
"location_id": 311031,
"location_name": "ADDRESS_GOES_HERE",
"points_requested": 10,
"redeemable_id": 493,
"redeemable_name": "test2",
"redeemable_properties": null,
"redeemed_points": null,
"redemption_code": {
"business_id": 548,
"business_uuid": "BUSINESS_UUID_GOES_HERE",
"created_at": "2023-01-31T07:46:07Z",
"discount": 10,
"employee_id": null,
"location_id": 311031,
"processed_at": null,
"receipt_amount": null,
"receipt_datetime": null,
"redeemable_id": 493,
"redeemed_menu_items": [
{
"item_amount": 13.86,
"item_name": "Whiterice",
"item_qty": 1,
"menu_family": "800",
"menu_item_id": "22",
"menu_item_type": "M",
"menu_major_group": "152",
"serial_number": "1"
},
{
"item_amount": 7.86,
"item_name": "Brownrice",
"item_qty": 1,
"menu_family": "800",
"menu_item_id": "3418",
"menu_item_type": "M",
"menu_major_group": "152",
"serial_number": "2"
}
],
"redemption_code_id": 1111,
"status": "redeemable",
"subtotal_amount": null,
"transaction_no": null,
"updated_at": "2020-09-29T17:54:41Z"
},
"redemption_code_id": 1111,
"redemption_code_pass": null,
"redemption_id": 149207972,
"redemption_status": "redeemable",
"redemption_type": "RewardRedemption",
"reward_id": 592777297,
"store_number": "401",
"updated_at": "2020-09-29T17:54:40Z",
"user": {
"email": "test@example.com",
"first_name": "FIRST_NAME_GOES_HERE",
"last_name": "LAST_NAME_GOES_HERE",
"secondary_email": null,
"phone": null,
"unsubscribed": false,
"marketing_email_subscription": true,
"marketing_pn_subscription": true,
"sms_subscription": false,
"unsubscribe_reason": null,
"last_activity_at": "2020-06-08T05:27:23Z",
"user_status": "active",
"account_balance": {
"user_id": 111111111,
"banked_currency": null,
"current_membership_level_name": "Silver Level",
"last_visit": null,
"loyalty_points": 0,
"net_balance": 10,
"net_debits": 0,
"pending_points": 0,
"total_credits": 10,
"total_debits": "0.0",
"total_lifetime_points": 10,
"total_point_credits": 10,
"total_redeemable_visits": null,
"total_visits": 0,
"unbanked_points": null,
"unredeemed_cards": null
},
"user_id": 111111111
}
}
}
Meta Fields
Meta Fields are common attributes such as content_id, timestamp, etc. that are returned in event responses, providing additional information about events. Click here to view the descriptions of the attributes.
Response Parameters
| additional_properties | String | Redemption met keys populated in case of configured |
| bar_code | String | Barcode generated for the order |
| business_id | Integer | Business ID |
| channel | String | Redemption channel (i.e., POS, online order) |
| expired_at | Date_time | Redemption code expired at timestamp |
| expiring_on | Date_time | Redemption code expiring on timestamp |
| force_message | String | Message in case of force redeem |
| internal_tracking_code | Integer | Redemption_tracking_code generated for the offer (i.e., reward or redeemable or banked reward) |
| location_id | Integer | Location ID |
| location_name | String | Name of the location where redemption happened |
| points_requested | Float | Points requested to be redeemed on the order |
| redeemable_id | Integer | Redeemable ID |
| redeemable_name | String | Name of the redeemable |
| redeemable_properties | String | Properties (e.g., “Merchandise”, “Food Item”, etc.) that can be added to a particular redeemable |
| redeemed_points | Float | Dollar value of the discount the user wants to redeem from banked rewards |
| redemption_code_id | Integer | Redemption code ID generated for the offer by Punchh (i.e., reward or redeemable or banked reward) |
| redemption_id | Integer | Unique redemption ID generated in Punchh for a redemption |
| redemption_status | String | Status of the redemption (i.e., redeemed, expired, redeemable, transferred, force_redeemed, cancelled) |
| redemption_type | String | Type of redemption (i.e., BankedRewardRedemption, RedeemableRedemption, Redemption, RewardRedemption) |
| redemption_code_pass | Object | Redemption code associated with the redemption pass. Users can redeem this code for a specific offer, discount, or reward. The redemption code pass is stored in an Apple Wallet application on mobile devices for easy access and use. |
| redemption_code_pass.apple_pass_design_id | Identifier for the specific design template used to create the Apple Pass associated with the redemption code | |
| redemption_code_pass.apple_pass_id | String | Unique identifier of the Apple Pass in Punchh |
| redemption_code_pass.business_id | String | Business identification at the Punchh platform |
| redemption_code_pass.business_uuid | String | UUID of the business configured in the Punchh platform. This code is used for POS integration. |
| redemption_code_pass.created_at | Date_time | Date and time when the redemption pass was created |
| redemption_code_pass.owner_id | String | User ID of the owner of the pass in Punchh |
| redemption_code_pass.owner_type | String | Specifies the owner type of the pass in Punchh. Possible values: - User - Pass is owned directly by a user - Redemption - Pass is tied to a redemption - Null - Pass has no owner |
| redemption_code_pass.pass_type_identifier | String | Apple Pass identifier name |
| redemption_code_pass.serial_number | String | Unique serial number assigned to each Apple Pass |
| redemption_code_pass.type | String | Type or category of the pass |
| redemption_code_pass.updated_at | Date_time | Date and time when the pass was updated |
| redemption_code | Object | Redemption code associated with the redemption. |
| redemption_code.business_id | Integer | Business ID in Punchh |
| redemption_code.discount | Float | Discount allowed for the redemption as per configured qualification criteria |
| redemption_code.location_id | Integer | Location ID for the location where redemption happened |
| redemption_code_processed_at | Date_time | Timestamp when the redemption was processed |
| redemption_code.receipt_amount | Float | Receipt amount (ideally should be same as subtotal amount) |
| redemption_code.receipt_datetime | Date_time | Receipt date/time for the order |
| redemption_code.redeemable_id | Integer | Redeemable ID of the offer |
| redemption_code.redeemed_menu_items | Object | See the menu_items object in Event - Check-in - Gift and Loyalty |
| redemption_code.redemption_code_id | Integer | Redemption code ID generated in Punchh |
| redemption_code.status | String | Status of the redemption code (i.e., processed, expired, redeemable, cancelled) |
| redemption_code.subtotal_amount | Float | Subtotal amount of the receipt |
| redemption_code.transaction_no | String | Transaction number of the order |
| redemption_code.business_uuid | String | UUID of the business configured in the Punchh platform. This code is used for POS integration. |
| redemption_code.employee_id | String | Employee ID |
| redemption_code.revenue_code | String | Name used by a POS system that identifies the method by which an order is fulfilled (e.g., dine-in, to-go/take-out, call-in pickup, call-in deliver, etc). Some POS calls this Revenue Center, Order Method, Order Mode, etc. The values assigned here should reflect the fulfillment method rather than the location within the restaurant where the order was taken (e.g., not bar, patio, dining room, etc.). |
| redemption_code.revenue_id | String | The ID used by a POS system that identifies the method by which an order is fulfilled. Example: 1 for dine-in; 2 for to-go/take out; 3 for call-in pickup; 4 for call-in deliver, etc. Some POS calls this revenue center, order method, order mode, etc. The values assigned here should reflect the fulfillment method rather than the location within the restaurant where the order was taken (e.g., not bar, patio, dining room, etc.). |
| redemption_code.created_at | Date_time | Date and time when the redemption code was created |
| redemption_code.updated_at | Date_time | Date and time when the redemption code was updated |
| reward_id | Integer | Reward ID in case of reward redemption |
| store_number | String | Store number of the location where redemption happened |
| transferred_to_id | Integer | ID of the transfer type (i.e., campaign ID in case of social cause campaign) |
| transferred_to_type | String | Type of transfer (i.e., social cause campaign) |
| user_id | Integer | User ID generated in Punchh |
| User | Object | See the user object in Event - Rewards Expiry Reminder |
| user.account_balance | Object | See the account_balance object in Event - Guest |
| web | Boolean | Whether the redemption is via iFrame or not |
| created_at | Date_time | Date and time when the redemption was created |
| updated_at | Date_time | Date and time when the redemption was updated |
| admin_id | Integer | Unique ID assigned to the business admin |