POS Type: | Hunger Rush (Revention) | ||||
Punchh POS API Value | Punchh API description | Punchh Usage Explanation | POS Data Element Mapping | POS Data Element Notes | Status |
cc_last4 | The last 4 digits of the cc number for use to allow associating of non-punchh users with transactions for future linking when the user joins loyalty | Not populating | Not populating | 1.POS status confirmed | |
employee_id | The employee ID in the POS that serviced the check for that transaction. | The employee may change over the life of the transaction (Example bartender transfers check to server then a cashier closes the check). The currently active employee servicing the POS order when the Punchh API call is made is the value that should be sent to Punchh in the API call | Not populating | Not populating | 3.POS status confirmed |
employee_name | The employee name in the POS that serviced the check for that transaction. | The employee may change over the life of the transaction (Example bartender transfers check to server then a cashier closes the check). The currently active employee servicing the POS order when the Punchh API call is made is the value that should be sent to Punchh in the API call | EmpName | The Employee who took the order. For online orders this will be assigend to employee "Online Orders" | 1.POS status confirmed |
menu_items: | JSON Item containing details for a single menu item. Menu items may reflect a sales item in the POS (Type M), a Discount (Type D or Type M with a negative item_amount, a Payment (Type P) or Taxes (Type T) | It is important when sending check details that all available items when totaled follow the punchh balancing formula | |||
item_name | Text value of item name as sent to the Guest Check | ItemName/Name | Depending on Sizes and Styles, itemName may also include sizeName, styleName. Name as defined in data elements other than LtyOrdItem. | 1.POS status confirmed | |
item_qty | Numeric value of the qty of the item as represented on this single menu item on the guest check | (If item is type D, this qty will ALWAYS be evaluated as a negative value. | Qty | Qty value defined in respective data elements. | 1.POS status confirmed |
item_amount | Price of the item as represented on the POS guest check | (If item is type D, this qty will ALWAYS be evaluated as a negative value. | Price/Amount | Price/Amount value defined in respective data elements. | 1.POS status confirmed |
menu_item_type | M = Menu item. May also represent a line item that is a discount. | Nothing | POS status not yet confirmed | ||
menu_item_id | Menu item ID as represented in the item database on the POS | ItemName/Name | Depending on Sizes and Styles, itemName may also include sizeName, styleName. Name as defined in data elements other than LtyOrdItem. | 1.POS status confirmed | |
menu_family | A menu item MUST have enforced singular membership in the POS data group type that is passed in the menu_family field to Punchh. This ensures that every time a menu item is sent to Punchh, it will ALWAYS have the same value passed in the menu_family field. | In the event that there is not a group ing data element on the POS that enforces that each menu item is member of ONLY one group, then this Punchh data field should be populated with the same value that is passed to the Punchh menu_major_group field. | ReportGroup | GroupName/Name/Menuname value defined in respective data elements. | 1.POS status confirmed |
menu_major_group | A menu item MUST have singular membership in the POS group that is passed in the menu_major_group field to Punchh. This ensures that every time a menu item is sent to Punchh, it will ALWAYS have the same value passed in the menu_major_group field. | In the event that there is not a group paradigm on the POS that enforces that each menu item is member of ONLY one group, then this Punchh data field should be left empty. | Menu Group Name | GroupName/Name/Menuname value defined in respective data elements. | 1.POS status confirmed |
serial_number | Serial Numbers are assigned to Menu Items on a receipt. A Main Item (such as pizza) may have serial number "1.0" and the associated modifiers (such as "Extra Cheese", "Olives" and "Jalapenos") may have serial numbers "1.01", "1.02" and "1.03" respectively. The numbering explains that particular items are modifiers associated with the main one. | Sening .1 modifiers | Calculated dynamically on the fly. | 1.POS status confirmed | |
subtotal_amount | Same as receipt_amount. For historical reasons, send this parameter along with receipt_amount in API requests. | POS SubTotal | 1.POS status confirmed | ||
receipt_amount | Order amount before any taxes (Sum of all amounts minus any discounts). This is the amount upon which loyalty points/visits are granted when there are not any earning qualification criteria rules in place in the Punchh portal. | Value to this parameter should be same as that of subtotal_amount. E.g., order amount is $10, parameters receipt_amount and subtotal_amount will hold the value 10. Say if $2 discount has been applied on the same order, subtotal_amount will become 8. | POS SubTotal | 1.POS status confirmed | |
payable | Final amount that user actually pays including taxes will be sent as payable | Not populating | Not populating | 3.POS status confirmed | |
transaction_no | POS Transaction Number | OrdNumber / ReferenceID | 1.POS status confirmed | ||
external_uid | Unique UID generated by your system, we use this to prevent duplicates in case same transaction get triggered twice. | Not populating | Not populating | 3.POS status confirmed | |
channel | Possible values: online_order, pos,web, mobile, dashboard, chatbot | This is the source of where the order originated when it was received by Punchh API | Not populating | Not populating | POS status not yet confirmed |
revenue_id | This should be a reference to the type of order. | ID Value of the for the POS function that defines how the order is fulfilled | OrdType | OrdType of the Order | POS status not yet confirmed |
revenue_code | This should be a reference to the type of order. | Text Value of the for the POS function that defines on the order is fulfilled | Not populating | Not populating | POS status not yet confirmed |
store_number | Location's Store identification number | This ID should match the Punchh location POS ID as set in Punchh portal | Not populating | Not populating | POS status not yet confirmed |
state | 3.POS status confirmed | ||||
pos_type | Type of POS integration is running on | Not populating | Not populating | POS status not yet confirmed | |
punchh_key | Punchh Key / Bar Code | For each transaction (check/ticket/etc.) this unique number must not repeat for a min of 90 days, ideally 180 days or forever. | Barcode | 1.POS status confirmed | |
pos_version | Version of the POS. May also include integration version information too | Not populating | Not populating | POS status not yet confirmed |
Hunger Rush (Revention) POS API Data Mapping
Scott Morgan
Updated
