| Previous Topic | Next Topic |
|---|---|
| Overview of POS API Certification Tutorials - Conceptual Modules | POS Module 1: Location Configuration and Program Meta - Concepts |
Overview of POS API Certification Tutorials - Example Scenarios Modules
The POS API example scenarios modules include real-world business scenarios that help you learn how a business can integrate a POS system with the Punchh server using the Punchh POS APIs. These scenarios (the business, roles, employees, names, transactions, menu items, customers, rewards, etc.) are fictitious; any resemblance or similarity to actual people, places, or things is coincidental.
Objectives
Each POS API example scenario module includes the following sections:
- General Tasks: Describes the workflow for the relevant API(s)
- Possible Scenario: Tells the story line using the personas listed in the "Roles" section below
- Code Sample: Request and response for the relevant API(s)
Business Profile
Central Punchh Coffee
Number of locations: 13
Program types: Banked rewards
Roles
| Persona | Name | Tasks/Activities | Notes |
| POS Integrator | Phoebe | Gets the location key and the business key from the Punchh representative and configures the POS to use these keys in the Authorization header when making a request to the Punchh API server. | |
| Punchh Representative | Gunther | Provides the business key and location key. | |
| Customer with a loyalty account (email) | Janice | Identifies at the POS using her email address. The POS performs a user look-up using her email address and shows available offers. | Email address: janice@example.com |
| Customer with a loyalty account (phone) | Monica | Identifies at the POS using her phone number. The POS performs a user look-up using her phone number. She asks the POS operator to void a purchase/redemption. | Phone number: 212-555-6578 |
| Customer with a loyalty account (long QR code) | Joey | N/A | Not used in scenarios |
| Customer with a loyalty account (card number) | Chandler | N/A | Not used in scenarios |
| Customer without a loyalty account, but wants to create one | Ross | Asks the POS operator to create a loyalty user account, assign a check, and void a transaction mistake. | Phone number: 212-555-4626 |
| A customer without a loyalty account, but doesn’t want to create one | Mike | Creates a transaction without a check-in. | |
| Cashier / POS Operator | Rachel | Involved in all scenarios. |
Menu
Drinks (served iced or hot, $1 to upgrade to a large)
Latte - $4
Mocha - $5
Americano - $3.50
Matcha Latte - $5
Food
Avocado Toast - $8
Blueberry Scone - $3
Chocolate Chip Cookie - $2
Rewards
1 point for every dollar spent
25 points = 1 dollar