Overview of POS API Certification Tutorials - Conceptual Modules
The POS API certification tutorials are a set of conceptual modules that help you learn how to integrate your POS system with the Punchh server using the Punchh POS APIs. The POS integration with Punchh allows you to offer the Punchh loyalty program to your guests from your POS.
Information Architecture
The POS tutorials have a consistent look and feel to help you quickly navigate and find the information in the modules. Each module contains the following main sections:
- Goal
- Prerequisites
- Use Cases and Context
- Workflow
- Best Practices
- Related Topics
Many modules also include example code (e.g., cURL and Python) that shows how to construct the related API calls.
Tutorial Modules - Sequence and Goals
The tutorial modules are based on the general flow of POS integration. In general, the sequence of the POS modules depicts the order in which you need to call the POS API endpoints to implement the Punchh loyalty program, as shown in the following table.
| Tutorial Module | Goal |
| Module 1: Location Configuration and Program Meta | Fetch the business loyalty program and POS location-specific configurations from the Punchh platform onto the POS device. |
| Module 2: Create User | Create a new loyalty guest user on the POS device. |
| Module 3: User Look-up | Look up a loyalty guest in the Punchh server using email, phone number, QR code, redemption code, or loyalty card number to retrieve guest data and assign the user to the check or transaction. |
| Module 4: Show Account Balance After Look-up | Display the proper guest account balance during look-up. |
| Module 5: Show Offers and Rewards After Look-up | Look up and display offers and rewards at the POS. |
| Module 6: Redemptions | Implement Redemptions 2.0 (new redemptions framework) or Redemptions 1.0 (legacy redemptions framework) based on the requirements of the business. |
| Module 7: Check-in | Create a check-in for a loyalty guest and send check-in details to Punchh. |
| Module 8a: Receipt Details | Send receipt details to the Punchh system to store the full details of a transaction generated at POS. |
| Module 8b: Updating/Voiding Transactions | Update the details of a transaction or cancel the transaction. |
| Module 9: Print Check | Show on the printed receipt the location-specific information configured for the store in the Punchh platform. |
| Module 10: Handling POS Disconnections | Handle the processing of transactions in a queue at the POS in the event of a network outage. |
Certification Process
Punchh provides APIs that third-party developers can consume to integrate their POS and kiosk systems with the Punchh server to offer Punchh loyalty services to their customers. Punchh also supports certification of third-party developed integrations for the POS and kiosk systems.
See Certification - POS for the POS certification process and Certification - Kiosk for the kiosk certification process. These topics list the certification prerequisites and test cases for testing your implementation.