# Home

## Overview

- [Home](https://developers.partech.com/)

## Commerce Engines

- [PAR Ordering Overview](https://developers.partech.com/commerce-engines/par-ordering)
- [PAR POS Overview](https://developers.partech.com/commerce-engines/par-pos)

## Engagement Tools

- [PAR Punchh Overview](https://developers.partech.com/engagement-tools/par-punchh)

## Operations Tools

- [Operations Tools Overview](https://developers.partech.com/operations-tools/par-ops)

## Docs

- [Scalar Docs](https://developers.partech.com/docs/dev-portal-developer-resources)
- [Punchh API Certification - Kiosk](https://developers.partech.com/docs/dev-portal-developer-resources/certification/kiosk): PAR Punchh Kiosk - Loyalty Feature Matrix (Online Ordering)
- [Punchh API Certification - Loyalty Pay](https://developers.partech.com/docs/dev-portal-developer-resources/certification/loyalty-pay): PAR Punchh Loyalty Pay - Mobile SSO Feature Matrix
- [Punchh API Certification - Mobile SSO](https://developers.partech.com/docs/dev-portal-developer-resources/certification/mobile-sso): PAR Punchh Mobile SSO - Loyalty Integration Feature Matrix
- [Punchh API Certification - Offers Ingestion](https://developers.partech.com/docs/dev-portal-developer-resources/certification/offers-ingestion): Offers Ingestion Data Sequence Diagram
- [Punchh API Certification - Online Ordering](https://developers.partech.com/docs/dev-portal-developer-resources/certification/online-ordering): PAR Punchh Online Ordering - Loyalty Feature Matrix
- [Punchh API Certification - Overview](https://developers.partech.com/docs/dev-portal-developer-resources/certification/overview)
- [Punchh API Certification - Pay-on-the-Go](https://developers.partech.com/docs/dev-portal-developer-resources/certification/pay-on-the-go): PAR Punchh Pay-on-the-Go - Loyalty Feature Matrix
- [Punchh API Certification - POS](https://developers.partech.com/docs/dev-portal-developer-resources/certification/pos): PAR Punchh POS (Point-of-Sale) - Loyalty Feature Matrix
- [Punchh API Certification - Single Scan Flow](https://developers.partech.com/docs/dev-portal-developer-resources/certification/single-scan-flow): PAR Punchh Single Scan Flow - Mobile SSO Feature Matrix
- [Punchh API Certification - SMS](https://developers.partech.com/docs/dev-portal-developer-resources/certification/sms): PAR Punchh SMS & Text-To-Join - Loyalty Feature Matrix
- [Advanced Authentication Developer Guide](https://developers.partech.com/docs/dev-portal-developer-resources/developer-guides/advanced-auth-developer-guide): Advanced Authentication is a PAR Punchh Platform feature that enables the use of third-party authentication services to authenticate with PAR applications. It also enables password-less authentication
- [Loyalty Pay Developer Guide](https://developers.partech.com/docs/dev-portal-developer-resources/developer-guides/loyalty-pay-developer-guide): Loyalty Pay is a growing set of digital wallet features and functionality that can help your brand increase loyalty acquisitions, engagement, frequency, and spending. Loyalty Pay's features make it ea
- [Offers Ingestion Developer Guide](https://developers.partech.com/docs/dev-portal-developer-resources/developer-guides/offers-ingestion-developer-guide): Offers Ingestion is a PAR Punchh Platform feature and functionality that can help your brand manage offers. Offers Ingestion's features make it easier for platform applications to provision and monito
- [Olo Promo Specs 2.0: Supported APIs](https://developers.partech.com/docs/dev-portal-developer-resources/developer-guides/promo-specs-2-0): Olo's Promo Specs 2.0 (PS 2.0) define the API specifications for the ordering experience. These API specs will work as a standard across all loyalty vendors for Olo. Loyalty vendors need to send the d
- [Redemptions 2.0 - Discount Basket Locking](https://developers.partech.com/docs/dev-portal-developer-resources/developer-guides/redemptions-2-0-basket-locking): In a Redemptions 2.0 implementation with Punchh, discount basket locking is required to allow vendors to maintain control of the discount basket while processing transactions.
- [Location Services Integrations](https://developers.partech.com/docs/dev-portal-developer-resources/getting-started/kiosk): Location services integrations are used to gather information about store locations using various data sources including Punchh. The key Punchh use cases that drive this behavior are:
- [Mobile Application / Website / Agency Integrations](https://developers.partech.com/docs/dev-portal-developer-resources/getting-started/mobile-app-website-agency): Mobile applications are used to take orders in the mobile application, apply redemptions and discounts, and then transfer order processing to an online ordering system or to a POS system for order com
- [CDP / CRM / Offers / Segments Integrations](https://developers.partech.com/docs/dev-portal-developer-resources/getting-started/offers-ingestion): CDP / CRM integrations aggregate data from various sources into a common data-storage repository. From there, applications driven by customer data can be run. From Punchh there are the following sourc
- [Online Ordering Integrations](https://developers.partech.com/docs/dev-portal-developer-resources/getting-started/online-ordering): Online ordering systems are used to take orders online, apply redemptions and discounts, and pay for the order. They are hosted on the back-end computing of a brand, and the user interface is run on t
- [Overview of Punchh API Integrations](https://developers.partech.com/docs/dev-portal-developer-resources/getting-started/overview): As a software developer, where do I start?
- [POS / Kiosk / Pay-on-the-Go Integrations](https://developers.partech.com/docs/dev-portal-developer-resources/getting-started/pos-kiosk-pay-on-the-go): Point-of-sale (POS), kiosk, and pay-on-the-go systems are used to take orders in the store, apply redemptions and discounts, and pay for the order. They are on dedicated hardware devices in the store
- [Punchh API and Product FAQs](https://developers.partech.com/docs/dev-portal-developer-resources/punchh-api-and-product-faqs): If you encounter a "Captcha verification failed" error message, it may be due to Cloudflare not having the base URL whitelisted or the headers and signature are not sent in our accepted format for aut
- [Punchh API Security Guidelines](https://developers.partech.com/docs/dev-portal-developer-resources/punchh-api-security-guidelines): These guidelines are intended to clarify onboarding procedures for all partners and customers that Punchh integrates with. The guidelines are mainly targeted at ensuring consistency across all partner
- [Punchh Base URIs - Overview](https://developers.partech.com/docs/dev-portal-developer-resources/punchh-base-uris): You will need to use Punchh base URIs when making APIs calls to the Punchh server in sandbox and production environments. If you do not know which environment to use, contact your Punchh representativ
- [Punchh Offers and Program Types](https://developers.partech.com/docs/dev-portal-developer-resources/punchh-offers-and-program-types): At Punchh, offers is the umbrella term for all types of loyalty "goodies" offered to guests, such as a coupon, a reward that is unlocked at a set number of points, the completion of a visit-based card
- [Overview of Punchh Developer Tool Pack](https://developers.partech.com/docs/dev-portal-developer-resources/tool-pack/overview)
- [Overview of Punchh API Postman Collections](https://developers.partech.com/docs/dev-portal-developer-resources/tool-pack/postman-collections): PAR Punchh maintains a set of publicly available API collections on the Postman website. The PAR Tech APIs (Official) master workspace contains a set of curated Punchh API collections, with an associa
- [POS Punchh Key & Barcode Generator](https://developers.partech.com/docs/dev-portal-developer-resources/tool-pack/sample-applications/pos-barcode-generator): The POS Punchh Key & Barcode Generator enables developers and testers to generate valid barcodes for the various point-of-sale (POS) terminal systems with which Punchh integrates. It embodies the four
- [Punchh x-pch-digest Generator](https://developers.partech.com/docs/dev-portal-developer-resources/tool-pack/sample-applications/x-pch-digest-generator): The Punchh x-pch-digest Generator enables developers to generate valid x-pch-digest signatures used for client authentication for Mobile and Online Ordering APIs.
- [Getting Started With PAR Integrations](https://developers.partech.com/docs/dev-portal-developer-resources/welcome): PAR integrations require varying levels of procedural steps to be completed as part of the release process with an integration partner. The following describes the process to integrate with PAR:
- [Overview of Punchh Developer Welcome Pack](https://developers.partech.com/docs/dev-portal-developer-resources/welcome-pack-overview)
- [Getting Started With Mobile API Integrations](https://developers.partech.com/docs/dev-portal-mobile): Punchh provides a robust platform for offering loyalty programs to customers. When a business integrates with the Punchh system, the Punchh APIs become instrumental in executing loyalty programs for e
- [Make Your First Mobile API Call](https://developers.partech.com/docs/dev-portal-mobile/additional-topics/firstmobileapicall): You can call APIs using any suitable API test client. In the following sections, we use Postman to invoke the Punchh APIs. The response to every API call made in Postman under a chosen environment (in
- [Headers and Caching](https://developers.partech.com/docs/dev-portal-mobile/additional-topics/headers-caching): The API will set the following HTTP response headers to values useful to developers:
- [Implementing SMS Marketing](https://developers.partech.com/docs/dev-portal-mobile/additional-topics/implementing-sms-marketing): Businesses can have guests opt in to receive SMS messages, which can be sent to guests to quickly deliver information. When a guest is created and the send_compliance_sms parameter is sent in the mobi
- [Migration Flows](https://developers.partech.com/docs/dev-portal-mobile/additional-topics/mobile-migration-flow): 1. When a user signs up in the Punchh system, a welcome screen will ask the user if the user belongs to an old loyalty program. The user can say either yes or no.
- [Redirects](https://developers.partech.com/docs/dev-portal-mobile/additional-topics/mobile-redirects): The Punchh API uses HTTP redirection where appropriate. Clients should assume that any request may result in a redirection. Receiving an HTTP redirection is not an error, and clients should follow tha
- [Notifications and Badges Count](https://developers.partech.com/docs/dev-portal-mobile/additional-topics/notifications-badgecounts): The following use cases explain how badge counts are handled within the mobile app and the sequence of API calls.
- [Push Notifications](https://developers.partech.com/docs/dev-portal-mobile/additional-topics/notifications-push): Push notifications are used to update the user about any activity that is organized by the business and applicable to the user. Various notifications are sent to the user for various events. These not
- [Generating x-pch-digest Header for Mobile APIs](https://developers.partech.com/docs/dev-portal-mobile/additional-topics/signature-sha256): The x-pch-digest is a header that must be included with most Punchh mobile API calls. The x-pch-digest header adds another layer of security to the API calls between your application and the Punchh se
- [Style JSON for Rich Messages](https://developers.partech.com/docs/dev-portal-mobile/additional-topics/style-json-for-rich-messages): The style JSON determines how the different elements of a received rich message are rendered in the app.
- [Maintain Unique Device ID for Mobile Devices](https://developers.partech.com/docs/dev-portal-mobile/additional-topics/uniquedeviceids): You can maintain a unique Punchh device ID for mobile devices (iOS and Android) to ensure that once-per-device validation is respected for features and functionalities in the Punchh platform. A simple
- [User Agent](https://developers.partech.com/docs/dev-portal-mobile/additional-topics/user-agent): All API requests MUST include a valid User-Agent header. This allows us to contact you if there are problems. Requests with no User-Agent header will be rejected.
- [User Authentication](https://developers.partech.com/docs/dev-portal-mobile/additional-topics/user-authentication): The Sign In API call requires an e-mail address or a phone number (as user name) and a password. This exchange should be over HTTPS only. In response, API returns the user record including the token t
- [Mobile API](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api): Punchh provides a robust platform for offering loyalty programs to customers. When a business integrates its back-end with the Punchh server, the Punchh APIs become instrumental in executing loyalty p
- [List Challenges](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/challenges/get/api2/mobile/challenges): Lists challenges available for a business. The Challenges feature must be enabled for the business in the Punchh platform. If not enabled, the API will return a 422 Unprocessable Entity error. Contact
- [Fetch Challenge Details](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/challenges/get/api2/mobile/challenges/id): Lists specific challenge details available for a business. The Challenges feature must be enabled for the business in the Punchh platform. If not enabled, the API will return a 422 Unprocessable Entit
- [Transaction Details](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/check-ins/get/api2/mobile/checkins/transactions): Returns the details of a particular transaction using the transaction ID
- [Create Loyalty Check-in by Barcode](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/check-ins/post/api2/mobile/checkins/barcode): Creates a loyalty check-in for a user when the user scans/enters the barcode printed on an order receipt. The user can scan the barcode using the mobile app of the business or enter the barcode on the
- [Generate Loyalty Short Code](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/drive-thru/post/api2/mobile/drivethru_code): Generates a short code from the mobile app, which the loyalty user can share verbally at the drive-thru window, enabling faster and more convenient account look-up at the POS.
- [Create Feedback](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/feedback/post/api2/mobile/feedbacks): Creates feedback in the system based on the message and/or rating provided by a user
- [Delete Gift Card](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/delete/api2/mobile/gift_cards/uuid): Removes a gift card from a user's app so that it will not be returned in API responses under the gift card list for a user, but does not delete it from the Punchh system
- [Revoke Sharing](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/delete/api2/mobile/gift_cards/uuid/revoke): If a user has shared a gift card with another user, this API enables the user to revoke the sharing rights.
- [Fetch Gift Cards](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/get/api2/mobile/gift_cards): Returns all of the active gift cards of a user
- [Fetch Gift Card Balance](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/get/api2/mobile/gift_cards/uuid/balance): Returns the details of a specified gift card
- [Get Gift Card EPIN](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/get/api2/mobile/gift_cards/uuid/epin): Returns the generated EPIN for a gift card
- [Fetch Gift Card Transaction History](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/get/api2/mobile/gift_cards/uuid/history): Returns the transaction history of a specified gift card
- [Consolidate Gift Cards](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/patch/api2/mobile/gift_cards/uuid/consolidate): Enables a user to transfer the entire balance of a gift card to another gift card.
- [Import Physical Gift Card](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/post/api2/mobile/gift_cards): Imports a user's physical gift card into the app. The physical gift card is added to the Punchh system.
- [Gift a Gift Card](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/post/api2/mobile/gift_cards/gift): Enables a user to gift a gift card to another user
- [Purchase Gift Card](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/post/api2/mobile/gift_cards/purchase): Enables a user to purchase a gift card using the app of a business
- [Reload Gift Card](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/post/api2/mobile/gift_cards/uuid/reload): Enables a user to add to the balance of an existing gift card using the app of a business
- [Share Gift Card](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/post/api2/mobile/gift_cards/uuid/share): Enables a user to share a gift card with another user
- [Tip via Gift Card](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/post/api2/mobile/gift_cards/uuid/tip): Enables a user to leave a tip (gratuity) using a gift card
- [Transfer Gift Card or Balance](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/post/api2/mobile/gift_cards/uuid/transfer): Transfers an entire gift card or partial amount from one user to another user
- [Update Gift Card](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/gift-cards/put/api2/mobile/gift_cards/uuid): Enables a gift card owner to update the name, design, and preference of a gift card
- [Generate OTP Token](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/migration/post/api2/mobile/verify_token): Generates and mails the verification one-time password (OTP) token used in the secure migration flow.
- [Verify OTP Token](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/migration/put/api2/mobile/verify_token): Verifies the one-time password (OTP) token used in the secure migration flow
- [Fetch User Notifications](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/notifications/get/api2/mobile/notifications): Returns the details of notifications received by a user
- [Mark Offers As Read](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/offers/put/api2/mobile/offers/mark_read): Marks specific offers that have been read by a user:
- [Delete a Saved Payment Card](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/payment-cards/delete/api2/mobile/payment_cards/payment_card_uuid): Enables a user to delete a selected payment card from the mobile application
- [Fetch All Saved Payment Cards](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/payment-cards/get/api2/mobile/payment_cards): Enables a user to fetch all saved payment cards
- [Create a Payment Card](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/payment-cards/post/api2/mobile/payment_cards): Creates and saves a payment card for a user. This API is triggered when the user saves the payment card on the mobile application.
- [Update a Saved Payment Card](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/payment-cards/put/api2/mobile/payment_cards/payment_card_uuid): Enables a user to update the nickname and preferred status of a saved payment card
- [Fetch Client Token](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/payments/get/api2/mobile/secure_tokens/service): Returns a secure client token that can be used for different services, such as gift cards, online ordering, etc.
- [Generate Single Scan Code or Short Code](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/single-scan-code/post/api2/mobile/single_scan_tokens): This API facilitates the single-scan flow functionality, allowing a user to generate a single-scan code from the mobile app for making a payment, redeeming a discount, adding a tip, or any combination
- [Get Social Cause Campaigns](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/social-cause-campaign/get/api2/mobile/social_causes): Returns the list of active social cause campaigns created in a business
- [Social Cause Campaign Details](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/social-cause-campaign/get/api2/mobile/social_causes/social_cause_id): Fetches donation details for a user based on the selected social cause campaign
- [Create Donation](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/social-cause-campaign/post/api2/mobile/social_causes): Creates a donation for a user based on the selected social cause campaign
- [Fetch User Survey](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/surveys/get/api2/mobile/survey_details): Returns the URL of a user's available survey
- [Fetch User Balance](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/users/get/api2/mobile/users/balance): Displays user information regarding active redemptions, notifications, badges, balance, etc.
- [Log in With Apple](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/users/post/api2/mobile/apple_registrations): A user can sign in with Apple using a random email ID generated by Apple.
- [Sign up / Register](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/users/post/api2/mobile/users): Registers a user's profile on the app of a business
- [Log in With Facebook](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/users/post/api2/mobile/users/connect_with_facebook): This API is invoked when a user registers on a business app using Facebook ID, email address, first name, last name, etc.
- [Forgot Password](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/users/post/api2/mobile/users/forgot_password): Sends an email to a user with a reset password link. This API is invoked when a user initiates the forgot password flow on the app of a business.
- [Log in With Google](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/users/post/api2/mobile/users/google_sign_in): Enables mobile application users to log in using Google Sign-in.
- [Sign in](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/users/post/api2/mobile/users/login): Logs a user into the app of a business and returns the user's information in the response
- [Update User Profile](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-api/tag/users/put/api2/mobile/users): Updates a user's profile details.
- [Mobile Redemptions 1.0 (Legacy) API](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-redemptions-1-0-legacy-api): For more information, see Online Ordering Module 5 - Redemptions.
- [Get Active Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-redemptions-2-0-new-api/get/api2/mobile/discounts/active): Advertises which content types the client is able to understand
- [Add Selection to Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-redemptions-2-0-new-api/post/api2/mobile/discounts/select): Set this header to application/json.
- [Get Access Code (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-mobile/apis/mobile-redemptions-2-0-new-api/post/api2/mobile/single_scan_tokens): This API returns the single-scan code containing a UUID string in the API response. The loyalty user can use the single-scan code to pay, earn, and redeem a reward/offer with a single scan at the POS
- [Subscription API](https://developers.partech.com/docs/dev-portal-mobile/apis/subscription-api): Subscriptions is an add-on Punchh loyalty product that allows businesses to create subscription plans to generate up-front revenue and offers benefits in addition to the standard benefits that unsubsc
- [Fetch Active Purchasable Subscription Plans](https://developers.partech.com/docs/dev-portal-mobile/apis/subscription-api/get/api2/mobile/subscriptions): This API returns all of the active subscription plans that are purchasable using the mobile app and have their end time in the future.
- [Fetch Subscription Plans for a User](https://developers.partech.com/docs/dev-portal-mobile/apis/subscription-api/get/api2/mobile/user_subscriptions): This API returns the subscriptions attached to a guest's profile. While the response can be filtered based on "status" and "past_subscriptions", the default response will include subscriptions that ar
- [Generate a Redemption Code for Subscription Redemption](https://developers.partech.com/docs/dev-portal-mobile/apis/subscription-api/post/api2/mobile/redemptions/subscription): This API generates a subscription-related redemption code within the mobile application. Using this API, guests can generate the subscription-related redemption code from the mobile application and us
- [Purchase Subscription](https://developers.partech.com/docs/dev-portal-mobile/apis/subscription-api/post/api2/mobile/subscriptions): This API supports the purchase of a subscription plan created in the Punchh platform.
- [Cancel Subscription (Turn off Auto Renewal)](https://developers.partech.com/docs/dev-portal-mobile/apis/subscription-api/put/api2/mobile/subscriptions/cancel): This API allows the user to cancel an active subscription (turn off auto renewal for the subscription). This is a soft cancellation wherein the benefits remain valid until the end time of the subscrip
- [Getting Started With Online Ordering API Integrations](https://developers.partech.com/docs/dev-portal-online-ordering): The Punchh Auth API provides user-management functions such as login, registration, forgot password, and connect with Facebook for users on the Punchh loyalty platform. Punchh has a comprehensive set
- [Schema](https://developers.partech.com/docs/dev-portal-online-ordering/additional-topics/auth-ap-ischema): The Punchh API is a RESTful API over HTTPS. A valid authentication signature through HTTP header x-pch-digest must be included with all requests. Our API uses industry standard SSL/TLS encryption and
- [Certification - Online Ordering](https://developers.partech.com/docs/dev-portal-online-ordering/additional-topics/certification-onlineordering): Punchh has a process for integrating partners with the Punchh loyalty platform. For necessary API keys, as well as additional setup or integration information, reach out to your Punchh representative.
- [Make Your First SSO API Call](https://developers.partech.com/docs/dev-portal-online-ordering/additional-topics/firstssocall): Punchh provides a robust platform for offering loyalty programs to customers. When a business integrates its back-end with the Punchh server, the Punchh APIs become instrumental in executing loyalty p
- [Getting Started With Online Ordering APIs](https://developers.partech.com/docs/dev-portal-online-ordering/additional-topics/gettingstartedwithonlineordering): Redeem a card, reward, or discount specified by the discount_type paramater against a receipt.
- [Getting Started With SSO APIs](https://developers.partech.com/docs/dev-portal-online-ordering/additional-topics/gettingstartedwithsso): The Punchh Auth API provides user-management functions such as login, registration, forgot password, and connect with Facebook for users on the Punchh loyalty platform.
- [How To Send Menu Items to Punchh](https://developers.partech.com/docs/dev-portal-online-ordering/additional-topics/menu-items): You send menu item data to Punchh on two occasions:
- [SAML Single Sign-on](https://developers.partech.com/docs/dev-portal-online-ordering/additional-topics/saml-sso): Security Assertion Markup Language (SAML) is an open standard for exchanging authentication and authorization data between parties, in particular an identity provider and a service provider (such as t
- [SSO Flow for Web and Mobile](https://developers.partech.com/docs/dev-portal-online-ordering/additional-topics/ssoflow): Punchh offers multiple methods for logging in and signing up loyalty users across POS, online ordering, and mobile app channels. Punchh users are available across all channels, meaning that if a loyal
- [User Agent](https://developers.partech.com/docs/dev-portal-online-ordering/additional-topics/user-agent): All API requests MUST include a valid User-Agent header. This allows us to contact you if there are problems. Requests with no User-Agent header will be rejected.
- [Generating x-pch-digest Header for Online Ordering APIs](https://developers.partech.com/docs/dev-portal-online-ordering/additional-topics/x-pch-digest-sha-1): The x-pch-digest is a header that must be included with most Punchh online ordering API calls. The x-pch-digest header adds another layer of security to the API calls between your application and the
- [Online Ordering and SSO API](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api): The Punchh SSO API endpoints provide user-management functions such as login, registration, forgot password, and connect with Facebook for users on the Punchh loyalty platform. You can also fetch user
- [Create Loyalty Check-in](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/check-in/post/api/auth/checkins/online_order): Creates a loyalty check-in for an online order against a given receipt. Requires menu items and parameters to be sent.
- [Update Loyalty Check-in](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/check-in/put/api/auth/checkins/online_order): Updates a loyalty check-in in the pending state based on external_uid. Requires all parameters to be sent again (no deltas).
- [Fetch Account Balance of User](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/check-user-balance/get/api/auth/checkins/balance): Returns account balance details of a guest, such as banked_rewards, membership_level, net_balance, net_debits, pending_points, points_balance, signup_anniversary_day, total_credits, total_debits, tota
- [Fetch Available Offers](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/rewards/get/api/auth/offers): Fetches available offers or offer details of a user. This request returns how many offers are available to the user.
- [Fetch User Information](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/user-management/get/api/auth/users): Returns the user's details including birthday, anniversary, gender, zip code, etc.
- [Change Password](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/user-management/patch/api/auth/users/change_password): Changes the user's password without using the current password
- [Forgot Password](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/user-management/post/api/auth/users/forgot_password): Triggers the forgot password email sent to the user's email address containing the password reset link.
- [Update User Information](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/user-management/put/api/auth/users): Updates details in the user profile, such as first name, last name, birthday, anniversary, or change password.
- [Create New User](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/user-sign-up-and-sso/post/api/auth/customers.json): Sign up a new user by using information such as email, first name, last name, birthday, anniversary, password, etc. This will create/register the new user in the Punchh system.
- [Log in With Email and Password](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/user-sign-up-and-sso/post/api/auth/customers/sign_in): Log in a user with the user's email address and password information.
- [Create SSO Access Token](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/user-sign-up-and-sso/post/api/auth/sso): Generates authentication token using the security token.
- [Log in With Apple](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/user-sign-up-and-sso/post/api/auth/users/connect_with_apple): A user can sign in with Apple using a random email ID generated by Apple on the web. The generated authorization code corresponds to each redirect URI as provided in the redirect_uri request parameter
- [Log in With Facebook](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/user-sign-up-and-sso/post/api/auth/users/connect_with_facebook): This API is invoked when a user registers on a business app using Facebook ID, email address, first name, last name, etc. On success, the API returns the user's profile details.
- [Log in With Google](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/user-sign-up-and-sso/post/api/auth/users/connect_with_google): This API enables users to log in using Google Sign-in on the Web.
- [Get SSO Token](https://developers.partech.com/docs/dev-portal-online-ordering/apis/online-ordering-and-sso-api/tag/user-sign-up-and-sso/post/oauth/token): Retrieves a client instance-level access token from your redirect URI after a successful user login through the Punchh-hosted authentication form. After you retrieve the client-level access token from
- [OO Redemptions 1.0 (Legacy) API](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-redemptions-1-0-legacy-api): For more information, see Online Ordering Module 5: Redemptions.
- [Void Processed Redemption (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-redemptions-1-0-legacy-api/delete/api/auth/redemptions): Voids a processed redemption. After a redemption is voided successfully, the offer tied to the redemption is returned to the guest's account.
- [Applicable Offers (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-redemptions-1-0-legacy-api/get/api/auth/redemptions/applicable_offers): Returns all applicable rewards available to the user per the items added to the check
- [Create Online Redemption (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-redemptions-1-0-legacy-api/post/api/auth/redemptions/online_order): Redeems a card, reward, redeemable, or discount specified in the discount_type parameter against a receipt.
- [OO Redemptions 2.0 (New) API](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-redemptions-2-0-new-api): The Redemptions 2.0 protocol has been designed to replace the legacy Redemptions 1.0 endpoints. The new protocol allows for the following features:
- [Void Redemption (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-redemptions-2-0-new-api/delete/api/auth/batch_redemptions/redemption_ref): Voids the complete discount basket. The value of redemption_ref must be appended to the URL path. You can get the redemption_ref value from the Get Active Discount Basket API response.
- [Remove Item From Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-redemptions-2-0-new-api/delete/api/auth/discounts/unselect): Delete one or more discounts from a discount basket.
- [Get Active Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-redemptions-2-0-new-api/get/api/auth/discounts/active): Advertises which content types the client is able to understand
- [Batch Redemption Process (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-redemptions-2-0-new-api/post/api/auth/batch_redemptions): Evaluates the validity of all inputs and commits the redemption.
- [Auto Redemption (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-redemptions-2-0-new-api/post/api/auth/discounts/auto_select): Note: Auto-redemption currently supports only subscriptions and non-points-based rewards.
- [Add Selection to Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-redemptions-2-0-new-api/post/api/auth/discounts/select): The signature for the API call
- [Unlock Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-redemptions-2-0-new-api/put/api/auth/discounts/unlock): When reward locking is enabled in the Punchh Platform, the guest's discount basket must be locked. An external ID will be required to lock the discount basket to prevent other channels from creating s
- [OO Subscription API](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-subscription-api): Subscriptions is an add-on Punchh loyalty product that allows businesses to create subscription plans to generate up-front revenue and offers benefits in addition to the standard benefits that unsubsc
- [Subscription Meta](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-subscription-api/get/api/auth/subscription_meta): Returns subscription cancellation reasons, which are configured in the Punchh platform under Wallet and Passes > Subscription Cancellation Reasons.
- [Fetch Active Purchasable Subscription Plans](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-subscription-api/get/api/auth/subscriptions): This API allows online ordering vendors to get a list of all subscription plans that are available for purchase.
- [Fetch Subscription Plans for a User](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-subscription-api/get/api/auth/user_subscriptions): This API returns the subscriptions attached to a guest's profile. While the response can be filtered based on "status" and "past_subscriptions", the default response will include subscriptions that ar
- [Purchase Subscription](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-subscription-api/post/api/auth/subscriptions): This API supports the purchase of a subscription plan created in the Punchh platform.
- [Cancel Subscription (Turn off Auto Renewal)](https://developers.partech.com/docs/dev-portal-online-ordering/apis/oo-subscription-api/put/api/auth/subscriptions/cancel): This API allows the end user to cancel an active subscription (turn off auto renewal for the subscription). This is a soft cancellation wherein the benefits remain valid until the end time of the subs
- [Online Ordering API Certification Tutorial - Module 1a: Create User](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/1a-create-user): Create a new loyalty guest user in the online ordering system of a business via the website or mobile app.
- [Online Ordering API Certification Tutorial - Module 1b: Complete Sign-up for a POS "Dummy" Account](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/1b-create-user-pos): Create and sign in a user via the online ordering system whose account was initially created at the POS.
- [Online Ordering API Certification Tutorial - Module 2: Sign-in](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/2-sign-in): Sign in a user via the online ordering system of a business via the website or mobile app.
- [Online Ordering API Certification Tutorial - Module 3a: Show Offers in Guest Account](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/3a-show-offers): Look up information about offers available to a user so that the offers can be displayed in the online ordering system of a business via the website or mobile app.
- [Online Ordering API Certification Tutorial - Module 3b: Show Account Balance](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/3b-show-account-balance): Look up the account balance information of a user so that it can be displayed in the online ordering system of a business via the website or mobile app.
- [Online Ordering API Certification Tutorial - Module 4: Update User Profile](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/4-update-user-profile): Update the values of fields in the profile of a loyalty guest user in the online ordering system of a business via the website or mobile app.
- [Online Ordering API Certification Tutorial - Module 5a: Process/Create Redemption  (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/5-redemptions/1-0/process-create-redemption): Redemptions 1.0 - Process redemptions with the appropriate reward type.
- [Online Ordering API Certification Tutorial - Module 5b: Show Applicable Offers  (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/5-redemptions/1-0/show-applicable-offers): Redemptions 1.0 - Display available offers based on a user's current cart.
- [Online Ordering API Certification Tutorial - Module 5c: Voiding Redemptions (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/5-redemptions/1-0/voiding-redemptions): Redemptions 1.0 - Void a redemption that has already been processed/committed.
- [Online Ordering API Certification Tutorial - Module 5a: Process an Auto-Redemption (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/5-redemptions/2-0/auto-redemption): Redemptions 2.0 - Add a discount to the discount basket automatically.
- [Online Ordering API Certification Tutorial - Module 5d: Process/Create a Batch Redemption (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/5-redemptions/2-0/batch-redemption): Redemptions 2.0 - Process a batch redemption with the appropriate discount type(s).
- [Online Ordering API Certification Tutorial - Module 5c: Get the Active Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/5-redemptions/2-0/get-active-discount-basket): Redemptions 2.0 - Get a list of discounts that have been selected by a guest.
- [Online Ordering API Certification Tutorial - Module 5b: Manage Items in the Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/5-redemptions/2-0/manage-discount-basket): Redemptions 2.0 - Add items to or remove items from a guest’s discount basket.
- [Online Ordering API Certification Tutorial - Module 5e: Void the Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/5-redemptions/2-0/void-discount-basket): Redemptions 2.0 - Void the complete discount basket.
- [Online Ordering API Certification Tutorial - Module 5: Redemptions Overview](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/5-redemptions/overview): When implementing redemptions for your business, you need to determine whether to use Redemptions 1.0 (legacy Punchh redemptions framework) or Redemptions 2.0 (new Punchh redemptions framework). Any n
- [Online Ordering API Certification Tutorial - Module 6: Check-in](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/6-check-in): Create a check-in for a loyalty guest and send check-in details to Punchh to grant the customer a visit or loyalty points.
- [Online Ordering API Certification Tutorial - Module 7: Updating/Voiding Transactions](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/modules/7-updating-voiding-transactions): Update the details of a transaction or cancel the transaction if “Pending Check-ins” is enabled.
- [Overview of Online Ordering API Certification Tutorials](https://developers.partech.com/docs/dev-portal-online-ordering/tutorials/overview): The online ordering API certification tutorials are a set of conceptual modules that help you learn how to integrate your online ordering system with the Punchh server using the Punchh online ordering
- [Getting Started With Platform Functions API Integrations](https://developers.partech.com/docs/dev-portal-platform-functions): This documentation is intended to provide comprehensive information for admin users of the Punchh platform. Many of the settings and available actions are dependent upon an appropriate level of access
- [Campaigns](https://developers.partech.com/docs/dev-portal-platform-functions/additional-topics/campaigns): Segments, gifts, and campaigns are the key elements of the business marketing capabilities in the Punchh platform:
- [Punchh Dynamic Coupon Code Generation](https://developers.partech.com/docs/dev-portal-platform-functions/additional-topics/dynamic-coupon-code-generation): A coupon code is a unique code that can be used by a single user (either single use or multiple use). The Punchh framework is used to generate coupon codes, and these codes can be processed within a m
- [Custom Segment APIs](https://developers.partech.com/docs/dev-portal-platform-functions/additional-topics/gettingstartedwithcustomsegment): The following collection of API endpoints can be used to create, update, and delete custom segments. Also, guests can be added to, deleted from, and searched in a particular custom segment.
- [Getting Started With Location Configuration API](https://developers.partech.com/docs/dev-portal-platform-functions/additional-topics/gettingstartedwithlocations): The Location Configuration API gives business admin users a simple and flexible way to list, create, update, and delete business locations without having to log in to the Punchh platform.
- [Getting Started With Business Migration User API](https://developers.partech.com/docs/dev-portal-platform-functions/additional-topics/gettingstartedwithmigration): The Business Migration User API gives business admin users a simple and flexible way to create, update, and delete business migration users without having to log in to the Punchh platform.
- [Make Your First Platform Function API Call](https://developers.partech.com/docs/dev-portal-platform-functions/additional-topics/makeyourfirstplatformcall): Punchh provides a robust platform for offering loyalty programs to customers. When a business integrates its back-end with the Punchh server, the Punchh APIs become instrumental in executing loyalty p
- [Offers Ingestion Management](https://developers.partech.com/docs/dev-portal-platform-functions/additional-topics/offers-ingestion-api): The Offers Ingestion APIs allow businesses to bulk create or update offers on the Punchh platform, significantly reducing the time and effort required for manual entry. The APIs offer scalability by s
- [User Agent](https://developers.partech.com/docs/dev-portal-platform-functions/additional-topics/user-agent): All API requests MUST include a valid User-Agent header. This allows us to contact you if there are problems. Requests with no User-Agent header will be rejected.
- [User Acquisition Via eClub](https://developers.partech.com/docs/dev-portal-platform-functions/additional-topics/useracquisitionviaeclub): Many businesses like to start engaging with their guests immediately, or even engage with potential guests to let them know about the business and what it can offer to them. eClub is one of many chann
- [Get Redeemable List](https://developers.partech.com/docs/dev-portal-platform-functions/apis/headless-offers-api/get/api2/dashboard/redeemables): Pulls a list of offers available and defined on Punchh, allowing for browsing/selecting of Punchh offers natively in an external platform. Redeemable search is on a business level, and the request can
- [Support Gifting to a User](https://developers.partech.com/docs/dev-portal-platform-functions/apis/headless-offers-api/post/api2/dashboard/users/support): The Support Gifting API enables administrators (such as restaurant managers, support staff, or corporate team members) to grant users different types of rewards (e.g., redeemables, points, etc.). It i
- [Asynchronous Support Gifting](https://developers.partech.com/docs/dev-portal-platform-functions/apis/headless-offers-api/post/api2/dashboard/users/support_gifting): Allows an admin to gift a single entity (points, visits, currency or rewards) to a specific user. This API can handle higher volumes of support gifting requests, as it processes them in the background
- [Get Line Item Selector (LIS) List](https://developers.partech.com/docs/dev-portal-platform-functions/apis/offers-ingestion-api/get/api2/dashboard/offers/lis): Pulls a list of line item selectors available and defined at the business level.
- [Get Qualification Criteria (QC) List](https://developers.partech.com/docs/dev-portal-platform-functions/apis/offers-ingestion-api/get/api2/dashboard/offers/qc): Pulls a list of all qualification criteria (QC) available and defined at the business level.
- [Modifiers (Object)](https://developers.partech.com/docs/dev-portal-platform-functions/apis/offers-ingestion-api/models/modifiers): A modifier is an item that may accompany a base item. For example, if the base item is a hamburger, a modifier could be pepper jack cheese.
- [Update Line Item Selector (LIS)](https://developers.partech.com/docs/dev-portal-platform-functions/apis/offers-ingestion-api/patch/api2/dashboard/offers/lis): Allows a business to update one or more Line Item Selectors. You can bulk update a maximum of 20 line item selectors per API call. If the request input contains more than 20 LIS, only the first 20 are
- [Update Qualification Criteria (QC)](https://developers.partech.com/docs/dev-portal-platform-functions/apis/offers-ingestion-api/patch/api2/dashboard/offers/qc): Allows a business to update one or more qualification criteria. The same validations as those in the Create Qualification Criteria API will apply. You can bulk update a maximum of 20 qualification cri
- [Update Redeemable](https://developers.partech.com/docs/dev-portal-platform-functions/apis/offers-ingestion-api/patch/api2/dashboard/offers/redeemable): Allows a business to update one or more redeemables. You can bulk update a maximum of 20 redeemables per API call. If the request input contains more than 20 redeemables, only the first 20 are created
- [Create Line Item Selector (LIS)](https://developers.partech.com/docs/dev-portal-platform-functions/apis/offers-ingestion-api/post/api2/dashboard/offers/lis): Allows a business to define one or more line item selectors (LIS). You can bulk create a maximum of 20 line item selectors per API call. If the request input contains more than 20 LIS, only the first
- [Create Qualification Criteria (QC)](https://developers.partech.com/docs/dev-portal-platform-functions/apis/offers-ingestion-api/post/api2/dashboard/offers/qc): Allows a business to define one or more qualification criteria (QC). You can bulk create a maximum of 20 qualification criteria per API call. If the request input contains more than 20 QC, only the fi
- [Create Redeemable](https://developers.partech.com/docs/dev-portal-platform-functions/apis/offers-ingestion-api/post/api2/dashboard/offers/redeemable): Allows a business to define one or more redeemables. You can bulk create a maximum of 20 redeemables per API call. If the request input contains more than 20 redeemables, only the first 20 are created
- [Upload Redeemable Image](https://developers.partech.com/docs/dev-portal-platform-functions/apis/offers-ingestion-api/post/api2/dashboard/offers/upload_redeemable_image): Allows a business to upload images for redeemables in bulk by first uploading them to a server or network and then providing the image URL in the API request. The maximum allowed image size is 500 KB.
- [User (Object)](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/models/User): Includes details about the users who are registered on a particular business
- [Get Admin Roles List](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/business-admin-users/get/api2/dashboard/roles): Returns the list of roles created in a business
- [Delete Business Migration User](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/business-migration-users/delete/api2/dashboard/migration_users/ID): Deletes a business migration user from the Punchh system. Append the value of the migration_user_id parameter to the endpoint path.
- [Update Business Migration User](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/business-migration-users/patch/api2/dashboard/migration_users/ID): Updates a business migration user in the Punchh system. The user attributes in the Create Business Migration User API can be updated by invoking the Update Business Migration User API. Append the valu
- [Create Business Migration User](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/business-migration-users/post/api2/dashboard/migration_users): Creates a business migration user in the system
- [Delete a Custom Segment](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/custom-segments/delete/api2/dashboard/custom_segments): Deletes a custom segment from the database
- [Remove User From a Custom Segment](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/custom-segments/delete/api2/dashboard/custom_segments/members): Removes a user from a custom segment. Either email or user_id should be provided in the request; user_id will be preferred if both are provided.
- [List All Custom Segments](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/custom-segments/get/api2/dashboard/custom_segments): Returns a list of all custom segments created by a business
- [Search If User Exists in a Custom Segment](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/custom-segments/get/api2/dashboard/custom_segments/members): Determines if a specific user belongs to a custom segment. Either email or user_id should be provided in the request to search for the user; user_id will be preferred if both are provided.
- [Update a Custom Segment](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/custom-segments/patch/api2/dashboard/custom_segments): Updates the name and/or description of a custom segment
- [Create a Custom Segment](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/custom-segments/post/api2/dashboard/custom_segments): Creates an empty custom segment for a business. Users have to be added later to an empty segment.
- [Add User to a Custom Segment](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/custom-segments/post/api2/dashboard/custom_segments/members): Adds a user to a custom segment. Either email or user_id should be provided in the request; user_id will be preferred if both are provided.
- [eClub Guest Upload](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/eclub/post/api2/dashboard/eclub_guests): Allows you to upload a list of eClub guests along with their details
- [Create Franchisee](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/franchisee/post/api2/dashboard/franchisees): Allows a business admin user to create franchisees for accessible locations
- [Delete Location Group](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/locations/delete/api2/dashboard/location_groups): Deletes a location group. Deleting a location group does not delete the locations that make up the location group.
- [Delete Location From a Location Group](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/locations/delete/api2/dashboard/location_groups/remove_location): Removes a location from a location group. This does not delete the location from the business.
- [Delete Location](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/locations/delete/api2/dashboard/locations): Deletes a business location from the database
- [Get Location Group List](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/locations/get/api2/dashboard/location_groups): Returns a list of all location groups in the business, including details about the specific locations in each location group. A location in a business can belong to multiple location groups.
- [Get Locations List](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/locations/get/api2/dashboard/locations): Returns a list of locations and their details. The page and per request parameters determine the page(s) returned and the number of locations returned per page.
- [Update Location Group](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/locations/patch/api2/dashboard/location_groups): Updates the name of an existing location group
- [Update Location](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/locations/patch/api2/dashboard/locations): Edits a location in the database
- [Create Location Group](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/locations/post/api2/dashboard/location_groups): Creates a location group with one location. More locations can be included by using the Add Location to Location Group API.
- [Add Location to Location Group](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/locations/post/api2/dashboard/location_groups/add_location): Adds a location to an existing location group
- [Create Location](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/locations/post/api2/dashboard/locations): Creates a location in the database
- [Force Redeem](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/redemptions/post/api2/dashboard/redemptions/force_redeem): The Force Redemption API allows administrators (e.g., restaurant managers, support staff, or corporate team members) to override normal redemption flows and manually or programmatically redeem an offe
- [Delete a User](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/users/delete/api2/dashboard/users): Marks a deactivated user for deletion from the Punchh platform
- [Unban a User](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/users/delete/api2/dashboard/users/ban): Removes a user ban to resume check-ins, redemptions, emails, etc.
- [Deactivate a User](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/users/delete/api2/dashboard/users/deactivate): Deactivates a user in the Punchh system to disallow check-ins, redemptions, emails etc.
- [Ban a User](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/users/post/api2/dashboard/users/ban): Bans a user in the Punchh system to disallow check-ins, redemptions, emails, etc.
- [Reactivate a User](https://developers.partech.com/docs/dev-portal-platform-functions/apis/platform-functions-api/tag/users/post/api2/dashboard/users/reactivate): Reactivates a user to resume check-ins, redemptions, emails, etc.
- [Subscription API](https://developers.partech.com/docs/dev-portal-platform-functions/apis/subscription-api): Subscriptions is an add-on Punchh loyalty product that allows businesses to create subscription plans to generate up-front revenue and offers benefits in addition to the standard benefits that unsubsc
- [Cancel Subscription (Turn off Auto Renewal)](https://developers.partech.com/docs/dev-portal-platform-functions/apis/subscription-api/patch/api2/dashboard/subscriptions/cancel): This API can be used to cancel an active subscripition.
- [Purchase Subscription](https://developers.partech.com/docs/dev-portal-platform-functions/apis/subscription-api/post/api2/dashboard/subscriptions/purchase): This API allows third-party platforms (e.g., middleware that interfaces with the mobile app of the business) to purchase a new subscription plan in the Punchh platform without the need for guests to b
- [Renew Subscription](https://developers.partech.com/docs/dev-portal-platform-functions/apis/subscription-api/post/api2/dashboard/subscriptions/renew): This API allows the business to renew subscriptions by making back-end calls on the designated date of renewal registered on the business end.
- [Getting Started With POS API Integrations](https://developers.partech.com/docs/dev-portal-pos): Loyalty programs have been proven to increase the number of return visits from participants. Integrating the loyalty system with the point of sale streamlines the process of identifying loyalty custom
- [Implement Apple Wallet Pass Integration With POS](https://developers.partech.com/docs/dev-portal-pos/additional-topics/applepassintegrationwithpos): This page provides the information required to integrate Apple Wallet Passes with your POS system.
- [Implement Google Wallet Pass Integration With POS](https://developers.partech.com/docs/dev-portal-pos/additional-topics/implement-google-pass-integration-with-pos): This page provides the information required to integrate Google Wallet Passes with your POS system.
- [Certification - Kiosk](https://developers.partech.com/docs/dev-portal-pos/additional-topics/kioskcertification): This page provides all relevant information required during the certification process.
- [Make Your First POS API Call](https://developers.partech.com/docs/dev-portal-pos/additional-topics/make-first-pos-call): The information provided on this page allows developers to make API calls to the Punchh server in production and test environments.
- [How To Send Menu Items to Punchh](https://developers.partech.com/docs/dev-portal-pos/additional-topics/menu-items): You send menu item data to Punchh on two occasions:
- [Pending Points Feature Overview](https://developers.partech.com/docs/dev-portal-pos/additional-topics/pendingpoints): In some business scenarios such as dine-in, guests get hold of a receipt before it is truly finalized. Guests may get points/visits by scanning the barcode on the receipt that is not yet complete, or
- [POS Payments](https://developers.partech.com/docs/dev-portal-pos/additional-topics/pos-payments): With the Punchh single scan flow (SSF) functionality, a guest uses a credit card to "Earn & Pay" or "Earn, Redeem, & Pay" with a single scan on a business’s Punchh app.
- [Certification - POS](https://developers.partech.com/docs/dev-portal-pos/additional-topics/poscertification): This page provides all relevant information required during the certification process.
- [POS Check Details](https://developers.partech.com/docs/dev-portal-pos/additional-topics/poscheckdetailsguide): This topic provides information about the behavior of check details in the Punchh system.
- [Implement the Punchh Barcode and QR Code Algorithm](https://developers.partech.com/docs/dev-portal-pos/additional-topics/punchhbarcodealgorithm): Punchh recommends printing QR codes instead of barcodes because QR codes support more store locations than the EAN 13 barcode limit of 8192 locations. However, some POS printers do not support QR code
- [Single Scan Flow](https://developers.partech.com/docs/dev-portal-pos/additional-topics/single-scan-flow): Punchh single scan flow allows a user to earn points for purchases, redeem rewards, and pay using a gift card, credit card, or saved credit card (recurring) added to the mobile app, all in one scan of
- [POS API Endpoints](https://developers.partech.com/docs/dev-portal-pos/apis/pos-api): Punchh provides robust APIs for integrating POS (Point-of-Sale) terminals with its back end. The integration helps businesses to offer their customers loyalty programs directly from their POS systems.
- [Void/Cancel Payment](https://developers.partech.com/docs/dev-portal-pos/apis/pos-api/tag/payments/delete/api/pos/payments): The Void/Cancel Payments API voids the payment request.
- [Get Payment Status](https://developers.partech.com/docs/dev-portal-pos/apis/pos-api/tag/payments/get/api/pos/payments/status): The Get Payment Status API retrieves the correct status and response message to know how to handle the next step (e.g., success--apply payment, cancel--payment cancelled by user, etc.).
- [Create Payment](https://developers.partech.com/docs/dev-portal-pos/apis/pos-api/tag/payments/post/api/pos/payments): The Create Payment API commits the payment via the PAR Payment Services Gateway.
- [Refund Payment](https://developers.partech.com/docs/dev-portal-pos/apis/pos-api/tag/payments/post/api/pos/payments/refund): After an accepted/processed payment, you can use the Refund Payments API to refund the payment.
- [Update Payment Status](https://developers.partech.com/docs/dev-portal-pos/apis/pos-api/tag/payments/put/api/pos/payments): The Update Payment Status API updates the payment status in the Punchh platform after the POS marks the payment as complete.
- [Location Configuration](https://developers.partech.com/docs/dev-portal-pos/apis/pos-api/tag/point-of-sale/get/api/pos/locations/configuration): Get the configuration for a location using a unique API key (i.e., location key).
- [Program Meta](https://developers.partech.com/docs/dev-portal-pos/apis/pos-api/tag/point-of-sale/get/api/pos/meta): Get information about business-level data, such as program type, platform configurations, list of redeemables (in case of points unlock redeemable program), etc.
- [User Look-up and Fetch Balance](https://developers.partech.com/docs/dev-portal-pos/apis/pos-api/tag/point-of-sale/get/api/pos/users/search): This API looks up a loyalty guest using an identifier to retrieve guest data and to assign the user to the check or transaction.
- [Create Check-in](https://developers.partech.com/docs/dev-portal-pos/apis/pos-api/tag/point-of-sale/post/api/pos/checkins): Creates a check-in for a customer.
- [Create New User](https://developers.partech.com/docs/dev-portal-pos/apis/pos-api/tag/point-of-sale/post/api/pos/users): This API creates a new user account by using phone or email or card (at least one of them).
- [Store Receipt Details From POS](https://developers.partech.com/docs/dev-portal-pos/apis/pos-api/tag/point-of-sale/post/receipt_details): This API call requires the API key as well as the business key to be sent in the HTTP Authorization header in the following format:
- [Redemptions 1.0 (Legacy) API Endpoints](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-1-0-legacy-api): For more information, see POS Module 6 - Redemptions.
- [Void Redemption (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-1-0-legacy-api/delete/api/pos/redemptions): Voids a processed redemption. After a redemption is voided successfully, the offer tied to the redemption is returned to the guest's account.
- [Void Multiple Redemptions (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-1-0-legacy-api/delete/api/pos/redemptions/multiple_destroy): Deletes processed multiple redemptions at once and returns the reward to the user.
- [Create Redemption (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-1-0-legacy-api/post/api/pos/redemptions): Redeems a card, reward, redeemable, or discount specified in the discount_type parameter against a receipt. Every request must have phone, email, card_number, or redemption_code as a parameter.
- [Applicable Offers (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-1-0-legacy-api/post/api/pos/redemptions/applicable_offers): Returns applicable offers based on the check details.
- [Possible Redemptions (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-1-0-legacy-api/post/api/pos/redemptions/possible): Use this API to verify that a redemption can be applied on a given check.
- [Redemptions 2.0 (New) API Endpoints](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-2-0-new-api): The Redemptions 2.0 protocol has been designed to replace the legacy Redemptions 1.0 endpoints. The new protocol allows for the following features:
- [Void Redemption (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-2-0-new-api/delete/api/pos/batch_redemptions/redemption_ref): Voids the complete discount basket. The value of redemption_ref must be appended to the URL path. You can get the redemption_ref value from the Get Active Discount Basket API response.
- [Remove Item From Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-2-0-new-api/delete/api/pos/discounts/unselect): Set this header to application/json.
- [Get Active Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-2-0-new-api/get/api/pos/discounts/active): This is a combination of unique API location key as well as business key (UUID) as the Authorization header.
- [Find User (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-2-0-new-api/get/api/pos/users/find): This API endpoint is used for guest user identification. Both lookup_field and lookup_value are passed as request parameters to look up the user account. The response includes user profile information
- [Batch Redemption Process (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-2-0-new-api/post/api/pos/batch_redemptions): Evaluates the validity of all inputs and commits the redemption.
- [Auto Redemption (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-2-0-new-api/post/api/pos/discounts/auto_select): Note: Auto-redemption currently supports only subscriptions and non-points-based rewards.
- [Discount Look-up (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-2-0-new-api/post/api/pos/discounts/lookup): You can use this API endpoint to:
- [Add Selection to Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-2-0-new-api/post/api/pos/discounts/select): Set this header to application/json.
- [Unlock Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/apis/redemptions-2-0-new-api/put/api/pos/discounts/unlock): When reward locking is enabled in the Punchh Platform, the guest's discount basket must be locked. An external ID will be required to lock the discount basket to prevent other channels from creating s
- [Changelog](https://developers.partech.com/docs/dev-portal-pos/changelog): Introducing AI chat in docs. Ask questions and get in-depth help across documentation for all Partech products.
- [POS API Certification Tutorial - Module 1: Location Configuration and Program Meta - Concepts](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/1-location-configuration-and-program-meta): Fetch the business loyalty program and POS location-specific configurations from the Punchh platform onto the POS device.
- [POS API Certification Tutorial - Module 1: Location Configuration and Program Meta - Example Scenarios](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/1-location-configuration-and-program-meta/training-exercises): 1. Configure each POS store to call the Program Meta API and the Location Configuration API at the start-up of the POS system using the business key and the location key generated for the specific POS
- [POS API Certification Tutorial - Module 10: Handling POS Disconnections - Concepts](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/10-handling-pos-disconnections): Handle the processing of transactions in a queue at the POS in the event of a network outage.
- [POS API Certification Tutorial - Module 10: Handling POS Disconnections - Example Scenarios](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/10-handling-pos-disconnections/training-exercises): You must have read the scenario assumptions.
- [POS API Certification Tutorial - Module 2: Create User - Concepts](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/2-create-user): Create a new loyalty guest user on the POS device.
- [POS API Certification Tutorial - Module 2: Create User - Example Scenarios](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/2-create-user/training-exercises): 1. The guest visits the POS store and wants to become a loyalty member.
- [POS API Certification Tutorial - Module 3: User Look-up - Concepts](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/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.
- [POS API Certification Tutorial - Module 3: User Look-up - Example Scenarios](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/3-user-look-up/training-exercises): You must have read the scenario assumptions.
- [POS API Certification Tutorial - Module 4: Show Account Balance After Look-up - Concepts](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/4a-show-account-balance-after-look-up): Display the proper guest account balance during look-up.
- [POS API Certification Tutorial - Module 4: Show Account Balance After Look-up - Example Scenarios](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/4a-show-account-balance-after-look-up/training-exercises): 1. Use the program meta local copy that you saved on the POS to perform the Program Meta look-up, and note the program_type and points_conversion_type parameters. Note: This step is to verify the corr
- [POS API Certification Tutorial - Module 5: Show Offers and Rewards After Look-up - Concepts](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/5-show-offers-and-rewards-after-look-up): Look up and display offers and rewards at the POS.
- [POS API Certification Tutorial - Module 5: Show Offers and Rewards After Look-up - Example Scenarios](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/5-show-offers-and-rewards-after-look-up/training-exercises): 1. Make a call to the Program Meta API to fetch a business loyalty program or fetch the program type that you stored locally on the POS.
- [POS API Certification Tutorial - Module 6a: Show Applicable Offers - Concepts (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/6-redemptions/1-0/6a-show-applicable-offers): Redemptions 1.0 - Display available offers based on current check details.
- [POS API Certification Tutorial - Module 6a: Show Applicable Offers - Example Scenarios (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/6-redemptions/1-0/6a-show-applicable-offers/training-exercises): You must have read the scenario assumptions.
- [POS API Certification Tutorial - Module 6b: Process/Create Redemption - Concepts (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/6-redemptions/1-0/6b-process-create-redemption): Redemptions 1.0 - Process redemptions with the appropriate reward type.
- [POS API Certification Tutorial: Module 6b: Process/Create Redemption - Example Scenarios (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/6-redemptions/1-0/6b-process-create-redemption/training-exercises): 1. Determine the redemption type (redeemable, reward, card completion, redemption code, discount amount, and fuel rewards) by first performing a user look-up with the User Look-up and Fetch Balance AP
- [POS API Certification Tutorial - Module 6c: Voiding Redemptions - Concepts (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/6-redemptions/1-0/6c-voiding-redemptions): Redemptions 1.0 - Void processed redemptions.
- [POS API Certification Tutorial - Module 6c: Voiding Redemptions - Example Scenarios (Redemptions 1.0)](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/6-redemptions/1-0/6c-voiding-redemptions/training-exercises): 1. After successfully creating a redemption with the Create Redemption API, get the redemption_id from the Create Redemption API response.
- [POS API Certification Tutorial - Module 6b: Process an Auto-Redemption (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/6-redemptions/2-0/auto-redemption): Redemptions 2.0 - Add a discount to the discount basket automatically.
- [POS API Certification Tutorial - Module 6e: Process/Create a Batch Redemption (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/6-redemptions/2-0/batch-redemption): Redemptions 2.0 - Process a batch redemption with the appropriate discount type(s).
- [POS API Certification Tutorial - Module 6a: Find a User (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/6-redemptions/2-0/find-user): Redemptions 2.0 - Look up a guest account.
- [POS API Certification Tutorial - Module 6c: Look up Discounts (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/6-redemptions/2-0/look-up-discount): Redemptions 2.0 - Look up a guest's available discount(s) in the loyalty account.
- [POS API Certification Tutorial - Module 6d: Manage Items in the Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/6-redemptions/2-0/manage-discount-basket): Redemptions 2.0 - Add items to or remove items from a guest’s discount basket.
- [POS API Certification Tutorial - Module 6f: Void the Discount Basket (Redemptions 2.0)](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/6-redemptions/2-0/void-discount-basket): Redemptions 2.0 - Void the complete discount basket.
- [POS API Certification Tutorial - Module 6: Redemptions Overview](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/6-redemptions/overview): When implementing redemptions for your business, you need to determine whether to use Redemptions 1.0 (legacy Punchh redemptions framework) or Redemptions 2.0 (new Punchh redemptions framework). Any n
- [POS API Certification Tutorial - Module 7: Check-in - Concepts](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/7-check-in): Create a check-in for a loyalty guest and send check-in details to Punchh.
- [POS API Certification Tutorial - Module 7: Check-in - Example Scenarios](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/7-check-in/training-exercises): 1. After a check is closed and paid and redemptions (if any) are successfully processed, create a check-in for the guest by sending details to the Create Checkin API. Note: If the transaction is not a
- [POS API Certification Tutorial - Module 8a: Receipt Details - Concepts](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/8a-receipt-details): Send receipt details to the Punchh system to store the full details of a transaction generated at POS.
- [POS API Certification Tutorial - Module 8a: Receipt Details - Example Scenarios](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/8a-receipt-details/training-exercises): After a check is closed and paid, do one of the following:
- [POS API Certification Tutorial - Module 8b: Updating/Voiding Transactions - Concepts](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/8b-updating-voiding-transactions): Update the details of a transaction or cancel the transaction.
- [POS API Certification Tutorial - Module 8b: Updating/Voiding Transactions - Example Scenarios](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/8b-updating-voiding-transactions/training-exercises): After completing a transaction and sending its receipt details in the Receipt Details API call to Punchh, you can update the details in the receipt by submitting another full Receipt Details call with
- [POS API Certification Tutorial - Module 9: Print Check - Concepts](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/9-print-check): Show on the printed receipt the location-specific information configured for the store in the Punchh platform.
- [POS API Certification Tutorial - Module 9: Print Check - Example Scenarios](https://developers.partech.com/docs/dev-portal-pos/tutorials/modules/9-print-check/training-exercises): The POS usually prints the receipt after the check is paid and closed and the POS sends receipt details for the transaction to Punchh using the Receipt Details API. The Location Configuration API lets
- [Overview of POS API Certification Tutorials - Conceptual Modules](https://developers.partech.com/docs/dev-portal-pos/tutorials/overview/introduction): 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 Punc
- [Overview of POS API Certification Tutorials - Example Scenarios Modules](https://developers.partech.com/docs/dev-portal-pos/tutorials/overview/training-exercises): 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 scenar
- [Events Framework - Overview of Webhooks Manager](https://developers.partech.com/docs/dev-portal-webhooks-manager): Large restaurant brands and almost all retailers have various business systems/clouds in their enterprise visualization (CRM, marketing, eCommerce, analytics, ERP, etc.)  rather than one system servin
- [Braze Event - Coupon Redemptions](https://developers.partech.com/docs/dev-portal-webhooks-manager/adapters/braze/coupon-redemption): This includes events where a coupon is redeemed in the Punchh system. These events are triggered as they happen in the Punchh system.
- [Braze Event - Coupon Issuance - Unlock Type](https://developers.partech.com/docs/dev-portal-webhooks-manager/adapters/braze/coupon-unlock): This includes events where a coupon is gifted/issued in the Punchh system. These events are triggered as they happen in the Punchh system.
- [Braze Event - Gift Check-in](https://developers.partech.com/docs/dev-portal-webhooks-manager/adapters/braze/gift-checkin): This includes user gift check-in events triggered as they happen in the Punchh system.
- [Braze Event - Guest](https://developers.partech.com/docs/dev-portal-webhooks-manager/adapters/braze/guest): This includes user create/update events triggered as they happen in the Punchh system.
- [Braze Event - Loyalty Check-in](https://developers.partech.com/docs/dev-portal-webhooks-manager/adapters/braze/loyalty-checkin): This includes user loyalty check-in events triggered as they happen in the Punchh system.
- [Braze Event - Post Check-in Campaign Gift](https://developers.partech.com/docs/dev-portal-webhooks-manager/adapters/braze/marketing-notification/post-check-in-campaign-notification): This includes information about post-check-in campaign gift events triggered as they happen in the Punchh system.
- [Braze Webhooks Adapter Overview](https://developers.partech.com/docs/dev-portal-webhooks-manager/adapters/braze/overview): Braze is a Customer Engagement Platform that powers customer-centric interactions between consumers and brands in real time, enabling brands to create and manage communications that are tailored to in
- [Braze Event - Redemptions](https://developers.partech.com/docs/dev-portal-webhooks-manager/adapters/braze/redemptions): This includes user redemptions create/update events triggered as they happen in the Punchh system.
- [Braze Event - Rewards](https://developers.partech.com/docs/dev-portal-webhooks-manager/adapters/braze/rewards): This includes user rewards gifted/issued events triggered as they happen in the Punchh system based on configuration or activity.
- [Braze Event - Pending Check-ins](https://developers.partech.com/docs/dev-portal-webhooks-manager/adapters/braze/transactional-notification/pending-check-in): This event is generated when any check-in goes into the pending state if the Pending point duration feature is enabled for the business. These events are triggered as they happen in the Punchh system
- [mParticle Webhooks Adapter Overview](https://developers.partech.com/docs/dev-portal-webhooks-manager/adapters/mparticle/overview): mParticle is a Customer Engagement Platform that powers customer-centric interactions between consumers and brands in real time, enabling brands to create and manage communications that are tailored t
- [mParticle Event - Rewards](https://developers.partech.com/docs/dev-portal-webhooks-manager/adapters/mparticle/rewards): This includes user rewards gifted/issued events triggered as they happen in the Punchh system based on configuration or activity.
- [mParticle Event - Transactional Notifications](https://developers.partech.com/docs/dev-portal-webhooks-manager/adapters/mparticle/transactional-notifications): Transactional Notifications events are triggered at the user level for any transactional activity. These events are further categorized by event types in the payload, such as points_expiry, reward_exp
- [Configuration](https://developers.partech.com/docs/dev-portal-webhooks-manager/configuration): Webhooks management will need to be enabled for your business in the Punchh platform. Contact your Punchh representative to update this Punchh platform configuration.
- [Event - Check-in - Gift and Loyalty](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/check-in-gift-and-loyalty): This includes create/update user loyalty check-in events triggered as they happen in the Punchh system.
- [Event - Coupon Issuance - Discount Type](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/coupon-issuance-discount-type): This includes events where a coupon is gifted/issued in the Punchh system triggered as a result of any configuration or activity against a user.
- [Event - Coupon Issuance - Unlock Type](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/coupon-issuance-unlock-type): This includes events where a coupon is gifted/issued in the Punchh system, triggered as a result of any configuration or activity against a user.
- [Event - Coupon Redemption](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/coupon-redemption): This includes events where a coupon is redeemed in the Punchh system triggered as a result of any configuration or activity against a user.
- [Event - Guest](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/guest): This includes user create, update, and delete events triggered as they happen in the Punchh system.
- [Event - Anniversary Campaign](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/marketing-notifications/anniversary-campaign): This includes information about anniversary campaign events triggered as they happen in the Punchh system.
- [Event - Challenge Campaign](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/marketing-notifications/challenge-campaign): This includes information about challenge campaign events triggered as they happen in the Punchh system.
- [Event - Compression Campaign](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/marketing-notifications/compression-campaign): This includes information about compression campaign events triggered as they happen in the Punchh system.
- [Event - Coupon Campaign](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/marketing-notifications/coupon-campaign): This includes information about coupon campaign events triggered as they happen in the Punchh system.
- [Event - Post Check-in Campaign Gift](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/marketing-notifications/post-check-in-campaign-gift): This includes information about post check-in campaign gift events triggered as they happen in the Punchh system.
- [Event - Sign-up Campaign](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/marketing-notifications/signup-campaign): This includes information about sign-up campaign events triggered as they happen in the Punchh system.
- [Event - Social Cause Campaign](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/marketing-notifications/social-cause-campaign): This includes information about social cause campaign events triggered as they happen in the Punchh system.
- [Event - Redeemables](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/redeemables): This includes business-level information for redeemable events triggered as they happen in the Punchh system.
- [Event - Redemptions](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/redemptions): This includes user redemptions create/update events triggered as they happen in the Punchh system.
- [Event - Rewards](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/rewards): This includes user rewards gifted/issued events triggered as they happen in the Punchh system based on configuration or activity.
- [Event - Bumped Membership Level](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/bumped-membership-level): This event is generated when a guest's membership level gets bumped. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Business Migration Notification](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/business-migration-notification): This event is generated when a guest in the Awaiting Migration list signs up for the loyalty program and is successfully identified by the Punchh system. These events are triggered as they happen in t
- [Event - Card Completion](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/card-completion): This event is generated when a guest's loyalty card gets completed. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Check-in Retry Fail](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/check-in-retry-fail): This event is generated after the check-in retry attempt is unsuccessful. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Check-in Retry Success](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/check-in-retry-success): This event is generated after the check-in retry attempt is successful. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Check-in Void](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/check-in-void): This event is generated when a notification is sent to a guest after the POS canceled the guest's check-in. These events are triggered as they happen in the Punchh system based on configuration. The p
- [Event - Coupon Expiry Reminder](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/coupon-expiry-reminder): This event is generated a configured number of days before the expiry of the guest's coupon. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Currency Expiry Reminder](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/currency-expiry-reminder): This event is generated when a notification is sent to a guest when their rewards are about to expire. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - eClub Registration](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/eclub-registration): This event is generated when a guest enrolls for eClub using Punchh's widget. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Email Confirmation](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/email-confirmation): This event is generated when a new guest creates an account through the mobile app using their email address. The guest will receive a notification prompting verification. These events are triggered a
- [Event - Feedback Reply](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/feedback-reply): This event is generated when a feedback reply message is sent to a guest by the business. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Game Reward Notification](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/game-reward-notification): This event is generated when guests earn a reward by playing a game. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Gift Card Auto Reload](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/gift-card-auto-reload): This event is generated when a user's gift card is auto reloaded. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Gift Card Auto Reload Disabled](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/gift-card-auto-reload-disabled): This event is generated when the gift card auto reload setting is disabled for the business in the Punchh platform. Contact your Punchh representative to update this Punchh platform configuration. The
- [Event - Gift Card Auto Reload Enabled](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/gift-card-auto-reload-enabled): This event is generated when the gift card auto reload setting is enabled for the business in the Punchh platform. Contact your Punchh representative to update this Punchh platform configuration. Thes
- [Event - Gift Card Auto Reload Payment Error](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/gift-card-auto-reload-payment-error): This event is generated when a gift card auto-reload fails due to an error in payment processing. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Gift Card Auto Reload Reminder](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/gift-card-auto-reload-reminder): This event is generated when Punchh sends a reminder to auto reload the user's gift card with the default amount set in the Punchh platform when the gift card balance falls below the threshold amount.
- [Event - Gift Card Gifted](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/gift-card-gifted): This event is generated when one guest gives a gift card to another guest. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Gift Card Post Payment Error](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/gift-card-post-payment-error): This event is generated when a payment is completed but an error occurs while updating the amount. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Gift Card Purchased](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/gift-card-purchased): This event is generated when a gift card is purchased for self-use. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Gift Card Received](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/gift-card-received): This includes user gift card received events triggered as they happen in the Punchh system based on configuration.
- [Event - Gift Card Redeemed](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/gift-card-redeemed): This event is generated when a guest redeems a gift card by making a payment using the gift card at the POS. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Gift Card Reloaded](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/gift-card-reloaded): This event is generated when a gift card is reloaded by a guest. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Gift Card Shared](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/gift-card-shared): This event is triggered when a gift card is shared with a guest. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Gift Card Sharing Revoked](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/gift-card-sharing-revoked): This event is generated when a guest's sharing right on a gift card is revoked. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Gift Card Transferred](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/gift-card-transferred): This event is generated when a gift card or amount is transferred to a guest. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Invalid Receipt](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/invalid-receipt): This event is generated when Punchh determines a receipt to be invalid after the guest uploads a receipt image. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Invitation Accepted](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/invitation-accepted): This event is generated when a guest invites another user to join the guest's loyalty program. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Invitation Revoked](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/invitation-revoked): This event is generated when a user joins the loyalty program via invitation from an existing guest and then the invitation is canceled by the inviter. These events are triggered as they happen in the
- [Event - Login From New Device](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/login-from-new-device): This event is generated when a new device is detected after the guest logs in from a different device. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Loyalty Transfer](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/loyalty-transfer): This event is generated when a guest receives a loyalty transfer from another guest. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Migration Verification](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/migration-verification): This event is generated when a message is sent to the guest for migration verification with the migration code. This includes user migration verification events triggered as they happen in the Punchh
- [Event - Payment Card Expired](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/payment-card-expired): This event is triggered when the guest's payment card expires. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Payment Card Expiry Reminder](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/payment-card-expiry-reminder): This event is triggered a configured number of days before the guest's payment card expires. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Payment Refunded](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/payment-refunded): This event is generated when a payment is refunded to a guest who reloads an amount to a gift card, but for some reason it does not go through and the amount is not credited to the card. This includes
- [Event - Pending Check-in](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/pending-check-in): This event is generated when any check-in goes into the pending state for a business for which the pending points duration feature is enabled. These events are triggered as they happen in the Punchh s
- [Event - Points Expiry](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/points-expiry): This event is generated when the points of a user are expired. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Points Expiry Reminder](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/points-expiry-reminder): This event is generated when a message is sent to remind a guest that the guest's check-ins are about to expire. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Points to Reward](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/points-to-reward): This event occurs when the points earned by a guest are converted to banked rewards. To generate the event, the Punchh platform must be configured to notify guests via push notification when points ar
- [Event - POS Scanner Check-in](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/pos-scanner-checkin): This event is generated after a customer check-in is completed at the POS or via Online Ordering. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Redeemable Unlocked](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/redeemable-unlocked): This event is generated when a redeemable gets unlocked for a guest. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Redemption Applied](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/redemption-applied): This event is generated when a redemption gets applied. These events are triggered as they happen in the Punchh system based on configuration.
- [Reset Passcode Instruction](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/reset-passcode-instruction): This event is generated when the reset passcode instruction is sent to a guest. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Reset Password Instruction](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/reset-password-instruction): This event is generated when the reset password instruction is sent to a guest. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Reward Notification](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/reward-notification): This event is generated when a guest earns a redeemable. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Rewards Expiry Reminder](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/rewards-expiry-reminder): This event is generated a configured number of days before the expiry of a guest's redeemable. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Update Check-in](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/update-check-in): This event is generated when points are updated because receipt details are updated in the Punchh system. This includes user update check-in events triggered as they happen in the Punchh system based
- [Event - User Notification](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/user-notification): This event is generated when a guest signs up in the Punchh system via the mobile app. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - Visits Expiry Reminder](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/visits-expiry-reminder): This event is generated before a guest's visit is about to expire. These events are triggered as they happen in the Punchh system based on configuration.
- [Event - WiFi Registration](https://developers.partech.com/docs/dev-portal-webhooks-manager/events/transactional-notifications/wifi-registration): This event is generated when a guest registers via WiFi. These events are triggered as they happen in the Punchh system based on configuration.
- [Frequently Asked Questions](https://developers.partech.com/docs/dev-portal-webhooks-manager/faqs): 1. Create a GET method of your receiver webhook server, which supports authentication. Must return 200 for verification and health check purposes. For details, see What are the GET request requirement
- [Meta Fields](https://developers.partech.com/docs/dev-portal-webhooks-manager/meta-fields): Note: All Punchh integer ID fields in models should be able to handle 64-bit integers (int64) sent in payloads.
- [Generic SMS Partner Integration Guide](https://developers.partech.com/docs/dev-portal-webhooks-manager/sms-integration-guide): This guide explains how to integrate an SMS partner with the Punchh loyalty platform. This guide is intended for businesses that use a Generic SMS Partner adapter where a third-party SMS provider mana
- [Webhook Delivery - Error Handling and Retry Logic](https://developers.partech.com/docs/dev-portal-webhooks-manager/webhook-delivery): An ideal system would have the order/sequence of the webhooks published in the same sequence as when actions/events happen. Punchh does not guarantee the delivery of events in the sequence in which th
- [Introduction](https://developers.partech.com/docs/eo-api): For an overview of the workflow, see External Orders API 2.0.
- [External Orders API](https://developers.partech.com/docs/eo-api/apis/external-orders-api-2): Link connects PAR’s ordering platform to your marketplace (MP).
- [Guest Identity Service (GIS) — Overview](https://developers.partech.com/docs/identity-service): The Guest Identity Service (GIS) provides a public, front-end facing API for user authentication and identity management. It supports legacy email/password authentication flows, social login (Google,
- [Advanced Authentication](https://developers.partech.com/docs/identity-service/advanced-authentication): Punchh now supports Advanced Authentication for user login on both web and mobile applications. These APIs are designed to provide secure, efficient, and user-friendly login experiences. It ensures hi
- [Refresh Token](https://developers.partech.com/docs/identity-service/apis/gis/tag/advanced-authentication/post/api2/password_less/refresh_token): Generates a new access token and refresh token for a user using the refresh token
- [Send OTP](https://developers.partech.com/docs/identity-service/apis/gis/tag/advanced-authentication/post/api2/password_less/token): Triggers an email or SMS to send an OTP (One-Time Password) depending on the communication channel (Email, SMS or both) configured for the business on the Punchh platform.
- [Verify Token](https://developers.partech.com/docs/identity-service/apis/gis/tag/advanced-authentication/post/api2/password_less/verify): Verifies the OTP token that the user provides for authentication. In the API request, use the same values for phone_ext, phone, and/or email provided in the Send OTP API request to generate the OTP; o
- [Passkey Authentication](https://developers.partech.com/docs/identity-service/passkey-authentication): Passkey authentication provides a phishing-resistant, passwordless sign-in experience for guests using WebAuthn / FIDO2. Instead of password or one-time password (OTP), guests authenticate with a plat
- [Introduction](https://developers.partech.com/docs/ordering-api): PAR Ordering provides a customizable online ordering platform tailored for modern restaurant brands. Unlike legacy systems, our solution enhances user experience, enabling restaurants to create unique
- [API Basics](https://developers.partech.com/docs/ordering-api/api-basics): PAR Ordering APIs are organized around REST. The API has predictable resource-oriented endpoints, returns JSON-encoded responses, accepts JSON bodies for POST / PUT requests, and uses standard HTTP re
- [API Changelog](https://developers.partech.com/docs/ordering-api/api-changelog): The API Changelog documents all breaking changes from one API version to another. Please consult the changelog when upgrading your integration to a newer API version.
- [API Roadmap](https://developers.partech.com/docs/ordering-api/api-roadmap): The Ordering APIs is available for general use, take the next step in unlocking its potential. Reach out to our Onboarding Team or Customer Success Team today to kickstart your journey with the produc
- [First Steps](https://developers.partech.com/docs/ordering-api/first-steps): We're excited to see you kick off your integration to PAR Ordering!
- [Ordering API](https://developers.partech.com/docs/ordering-api/guides/apis/ordering): OrderingAPI
- [Allergen](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/Allergen): Menu item allergen id. Allergens schema here.
- [AutoCompleteAddressDetail](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/AutoCompleteAddressDetail): Array of Autocomplete address results
- [ComboMealForMainComboItem](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/ComboMealForMainComboItem): Unique identifier for the given combo meal.
- [ComboMealForMainComboItemDetailed](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/ComboMealForMainComboItemDetailed): UUID of Combo meal`
- [Area](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/CommonArea): See Areas reference
- [OrderType](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/CommonOrderType): Order Types that are configured for the Venue
- [CommonServingTime](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/CommonServingTime): See Serving Times reference
- [Timezone](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/CommonTimezone): Timezone Name - please refer to PHP Timezones for full list of supported timezones.
- [CommonVenue](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/CommonVenue): Venue object
- [CustomerAccountToken](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/CustomerAccountToken): Integer numbers.
- [Demographics](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/Demographics): Demographics type - birth date - 1, identification number - 2, company name - 3;
- [DiscountItemGroup](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/DiscountItemGroup): Unique identifier for the given discount group.
- [GetCustomerStoredPaymentMethod](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/GetCustomerStoredPaymentMethod): ID of the stored payment method - will be used to initialize payment
- [InitApplicationAvailablePaymentMethods](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/InitApplicationAvailablePaymentMethods): Array of Payment Methods that have been enabled for the Brand
- [InitApplicationPaymentProcessors](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/InitApplicationPaymentProcessors): UUID of instance of Payment Processor for Brand
- [ManualLocationInput](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/ManualLocationInput): Array of ManualLocationInputs that have been configured in the CMS / Management Center for the Brand
- [MenuItem](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/MenuItem): Menu Item UUID
- [ModifierGroupForMenuItem](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/ModifierGroupForMenuItem): The object describing all the modifier groups that can be applied to the selected combo
- [OrderCalculateMenuItem](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/OrderCalculateMenuItem): Customer comment on menu item
- [SocialSignUpToken](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/models/SocialSignUpToken): Time-to-live for Refresh Token (in seconds)
- [DELETE Customer Account](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/delete/customer-accounts/customer_account_id): Customer Account UUID
- [DELETE Customer Account vehicle](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/delete/customer-accounts/customer_account_id/vehicles/vehicle_id): Endpoint will delete customer vehicle
- [GET Receipts](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/get/customer-accounts/customer_id/receipts): Endpoint will return all receipts
- [GET Invalidate Login](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/get/customers/invalidate-login): Accept header
- [GET Customers refresh](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/get/customers/refresh): Endpoint call will do a customer token regenration.
- [GET Legal Agreement Acceptances Check](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/get/legal-agreement-acceptances/check): Endpoint will check legal agreement acceptances
- [POST Create Customer Accounts Vehicle](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/post/customer-accounts/customer_account_id/vehicles): Endpoint will create customer accounts vehicle
- [POST Check Email](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/post/customers/check-email): This endpoint will checks if an email address for a customer for a specific brand already exists.
- [POST Check Phone Number](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/post/customers/check-phone-number): Checks if a phone number for a customer for a specific brand already exists
- [POST Verify Phone Number Update](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/post/customers/customer_id/verify-phone-number-update): Vefiry phone number update
- [POST Passwordless Login](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/post/customers/login): Endpoint will provide customer account login using passwordless code
- [POST Passwordless Request](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/post/customers/passwordless-request): This endpoint will check if the customer exists and, if it does, create or update the passwordless request and send the login confirmation code; else, create a new passwordless request and send the si
- [POST Register](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/post/customers/register): Endpoint will handle a registration request for the application.
- [POST Legal Agreement Acceptances Create](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/post/legal-agreement-acceptances): Accept header
- [PUT Customer Account Update](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/put/customer-accounts/customer_account_id): This endpoint will do a customer account update for the given customer account UUID
- [PUT Verify Email Update](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/customer-account-routes/put/customer-accounts/customer_account_id/verify-email-update): Endpoint will do a customer account email update based on the confirmation code.
- [GET DLC integrations](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/loyalty/get/brands/brand_id/dlc-integrations): Get DLC integrations for Brand
- [GET Loyalty program](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/loyalty/get/dlc-service/loyalty-program): Get Loyalty program test
- [GET Categories and their Subcategories](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/menu/get/venues/venue_id/menus/menu_id/categories): Fetch Categories with their Subcategories (and their Serving Times).
- [POST Generate OAuth Client Token](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/oauth/post/oauth/tokens): Generate oauth client token
- [GET Customer Accounts Vehicle](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/orders/get/customer-accounts/customer_account_id/vehicles): Endpoint will return customer account vehicle for the provided customer account
- [POST Promise Quote Create](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/orders/post/dispatch-service/quotes): The endpoint will return the estimated delivery time if the delivery is available.
- [POST Create Order](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/orders/post/orders): Create Order
- [POST Order calculation](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/orders/post/orders/calculate): Calculate amount for the order
- [POST Order Check Item availability](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/orders/post/orders/check-item-availability): Check ordering availability for the list of menu items
- [POST Orders Pickup Times](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/orders/post/orders/pickup-times): Endpoint will return pickup time for the order
- [GET Customer Stored Payment Method by UUID](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/payment-methods-related-routes/get/customers/customer_account_id/stored-payment-methods): Endpoint will return stored payment methods for the given customer.
- [POST Generate Token Payment Processor](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/payment-methods-related-routes/post/payment-processors/generate-tokens): Accept header
- [POST Init Payment](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/payment-methods-related-routes/post/payment-processors/init-payment): Endpoint will initialize payment transaction for the given payment processor
- [GET Customer Account Loyalty](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/punchh/get/dlc-service/customer-account-loyalty): GET dlc service customer account loyalty
- [GET DLC Service Loyalty Promotions](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/punchh/get/dlc-service/loyalty-promotions): GET dlc service loyalty promotions
- [GET DLC Service Loyalty Rewards](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/punchh/get/dlc-service/loyalty-rewards): GET dlc service loyalty rewards
- [GET Manual Locations Inputs](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/venue/get/manual-location-inputs): Accept header
- [POST Autocomplete address](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/venue/post/autocomplete-addresses): Endpoint will return addresses for the given input
- [POST Autocomplete address details](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/venue/post/autocomplete-addresses/details): Endpoint will return location details for the given address_id, longitude and latitude.
- [POST Delivery Venues](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/venue/post/delivery/venues): Find delivery venues
- [POST Directory search](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/venue/post/directory/search): Results per page. Recommend value: 15
- [POST Init application](https://developers.partech.com/docs/ordering-api/guides/apis/ordering/tag/venue/post/init-application): Initial loading of the brand-specific and application-specific settings to initialize the flow
- [Application Initialization](https://developers.partech.com/docs/ordering-api/guides/application-initialization): In order to show the correct options to your guest in the ordering flow based on the configurations made for the Brand, we suggest that you make a call for brand details either during your app startup
- [Customer Sign In Flow](https://developers.partech.com/docs/ordering-api/guides/customer-account/customer-sign-in-flow): PAR Ordering Ecosystem has two different Sign-in/Sign-up flows:
- [Customer Sign-Up Flow](https://developers.partech.com/docs/ordering-api/guides/customer-account/customer-sign-up-flow): If by checking does the customer account already exist in the system we determine that new customer is accessing the platform, it should be taken into the Sign-up flow.
- [How to Modify Customer Account](https://developers.partech.com/docs/ordering-api/guides/customer-account/how-to-modify-customer-account): Ensure that the customer is authenticated before making a request to update the customer account.
- [How to Refresh Customer Token](https://developers.partech.com/docs/ordering-api/guides/customer-account/how-to-refresh-customer-token): Once the customer is logged in the token is generated and the customer has to use that token to access app pages and content. The time to live of the token is 24 minutes (1440 seconds), after 24 minut
- [How to Remove Customer Account](https://developers.partech.com/docs/ordering-api/guides/customer-account/how-to-remove-customer-account): The Customer Account Deletion API endpoint allows users to request the permanent deletion of their account and associated data from the application. This operation is irreversible and will remove all
- [SSO-Accounts-Synchronization-Guide](https://developers.partech.com/docs/ordering-api/guides/customer-account/sso-accounts-synchronization-guide): Many of the custom ordering applications are created when the Brand already has a customer base, or it is possible that the brand uses a single identity provider to log in their customers into differe
- [External Discounts](https://developers.partech.com/docs/ordering-api/guides/loyalty/external-loyalty-providers/external-discounts): For brands that use loyalty providers that are not integrated with PAR Ordering, our APIs allow for their discounts to be applied to a cart via secure machine-to-machine communication.
- [Fetch Loyalty Platform Information](https://developers.partech.com/docs/ordering-api/guides/loyalty/loyalty-platform-integration): A brand can be configured to either work with MENU’s loyalty platform or with our integration with Punchh.
- [Fetch Loyalty Related Customer Information](https://developers.partech.com/docs/ordering-api/guides/loyalty/punchh/customer-account-loyalty): For displaying the points and/or credits available to a customer, as well as in-store and kiosk identification scan codes, the /dlc-service/customer-account-loyalty endpoint is called.
- [Fetch Loyalty Program Information](https://developers.partech.com/docs/ordering-api/guides/loyalty/punchh/loyalty-program-information): If your brand is set up to use the Punchh loyalty integration, specific loyalty program details can be fetched by calling the /dlc-service/loyalty-program endpoint needs to be called.
- [Use Rewards, Offers, Customer Credits, and Promo Codes](https://developers.partech.com/docs/ordering-api/guides/loyalty/punchh/rewards-offers-customer-credits): To fetch loyalty rewards available for customers, make an HTTP GET request to the following endpoint:/dlc-service/loyalty-rewards
- [Limited-time-products-(LTO)](https://developers.partech.com/docs/ordering-api/guides/menu/limited-time-products-lto): LTO
- [Menu v2 Concept](https://developers.partech.com/docs/ordering-api/guides/menu/menu-v2-concept): When we realized how complex menus really are, we started building tools to make setup and management easier across multiple channels. A well-structured menu needs categories, items, modifiers, modifi
- [Display Nested Menus](https://developers.partech.com/docs/ordering-api/guides/menu/menu-v2-nested-modifier-groups): This guide will show you how to fetch and display the menu to your customers.
- [MenuQL](https://developers.partech.com/docs/ordering-api/guides/menu/menuql-guidelines): MenuQL is PAR Ordering's proprietary menu query language. It was developed to offer a performant and efficient way to pull the menu. Using MenuQL you can specify which types of resources and specific
- [Pre-Ordering](https://developers.partech.com/docs/ordering-api/guides/menu/pre-ordering): Preordering is a critical component for business operations with specialized ingredients or long lead times. This feature allows brands to create ordering and delivery windows for customers to place o
- [Secret Menus](https://developers.partech.com/docs/ordering-api/guides/menu/secret-menus): The Secret Menus feature enables Brands to offer exclusive, hidden menus or menu items that are not visible to the general public on online ordering channels. These items can only be accessed by custo
- [Server Side Cart](https://developers.partech.com/docs/ordering-api/guides/ordering/cart-2-0/server-side-cart): With the implimentation of Menu v2, the Server-Side Cart API provides a robust and secure way to manage shopping cart functionality on your ordering platforms. This API enables you to create and manip
- [Create Order](https://developers.partech.com/docs/ordering-api/guides/ordering/legacy/create-order): Pre-requisite: Order menu items and discounts selected, payment confirmed
- [Ordering Flow](https://developers.partech.com/docs/ordering-api/guides/ordering/legacy/ordering-flow): Pre-requisite: Store is selected as part of store selection flow specific to order type (Dine in, Pre-order or Takeaway, Delivery, Foodspot)
- [Place order for Catering Delivery](https://developers.partech.com/docs/ordering-api/guides/ordering/place-order-for-catering-delivery): This guide will show you how to develop a flow that enables your customers to place an order for Catering Delivery (see Order Types for more information).
- [Place order for Catering Pickup](https://developers.partech.com/docs/ordering-api/guides/ordering/place-order-for-catering-pickup): This guide will show you how to develop a flow that enables your customers to place an order for Catering Pickup (see Order Types for more information).
- [Place order for Curbside](https://developers.partech.com/docs/ordering-api/guides/ordering/place-order-for-curbside): This guide will show you how to develop a flow that enables your customers to place an order for Curbside pickup (see Order Types for more information).
- [Place order for Delivery](https://developers.partech.com/docs/ordering-api/guides/ordering/place-order-for-delivery): This guide will show you how to develop a flow that enables your customers to place an order for Delivery (see Order Types for more information).
- [Place order for Dine-in (FS)](https://developers.partech.com/docs/ordering-api/guides/ordering/place-order-for-dine-in-fs): The Dine-in (FS) orders are only available for ASAP ordering for the customers that are already in the restaurant.
- [Place order for Dine in (QS) or Takeout](https://developers.partech.com/docs/ordering-api/guides/ordering/place-order-for-dine-in-qs-or-takeout): This guide will show you how to develop a flow that enables your customers to place an order for Dine-in (QS) or Takeout (see Order Types for more information).
- [Place Order For Drive Thru](https://developers.partech.com/docs/ordering-api/guides/ordering/place-order-for-drive-thru): This guide will show you how to develop a flow that enables your customers to place an order for Drive Thru (see Order Types for more information).
- [Place Order For Takeout](https://developers.partech.com/docs/ordering-api/guides/ordering/place-order-for-takeout): This guide will show you how to develop a flow that enables your customers to place an order for Takeout (see Order Types for more information).
- [Re-Ordering](https://developers.partech.com/docs/ordering-api/guides/ordering/re-ordering): This guide will show you how to develop a flow that enables your customers to repeat their previous orders with identical specifications or modify them to accommodate slight variations. Notably, the o
- [Scheduled Ordering](https://developers.partech.com/docs/ordering-api/guides/ordering/schedule-ordering): This guide will show you how to develop a flow that enables your customers to place an order for a future date & time.
- [Tip](https://developers.partech.com/docs/ordering-api/guides/ordering/tip): This guide will show you how to develop a flow where user can add a tip to their order.
- [Webhooks Order Status Updates](https://developers.partech.com/docs/ordering-api/guides/ordering/webhooks-order-status-updates): Once the order has been created in Menu ecosystem, it is important to track the order status updates to notify the customer respectively.
- [Make a Payment](https://developers.partech.com/docs/ordering-api/guides/payment/make-a-payment): This guide will show you how to develop a flow that enables your customers to make a payment and place their order.
- [Adyen Overview](https://developers.partech.com/docs/ordering-api/guides/payment/payment-processors/adyen): In order to connect your Brand to your Adyen account for processing eCommerce payments (from Mobile, Web and select External Channels), there is configuration that is required to be set up in your Ady
- [Adyen Android implementation guide](https://developers.partech.com/docs/ordering-api/guides/payment/payment-processors/adyen/mobile/android): payment_processor_type_id: 11
- [Adyen iOS implementation guide](https://developers.partech.com/docs/ordering-api/guides/payment/payment-processors/adyen/mobile/ios): payment_processor_type_id: 11
- [Adyen - Web implementation guide](https://developers.partech.com/docs/ordering-api/guides/payment/payment-processors/adyen/web): For using the Adyen payment processor, we suggest you implement your custom payment form that will have empty HTML div tags acting as placeholder where Adyen SDK will inject iframe elements. Because o
- [PAR-Pay](https://developers.partech.com/docs/ordering-api/guides/payment/payment-processors/par-pay): payment_processor_type_id: 32
- [Store Payment Method](https://developers.partech.com/docs/ordering-api/guides/payment/store-payment-method): This guide is going to show you how to develop a flow that allows your customers to store a payment method to their account.
- [Areas](https://developers.partech.com/docs/ordering-api/guides/references/areas): An Area is a virtual or physical destination to which orders are placed.
- [Error Codes](https://developers.partech.com/docs/ordering-api/guides/references/error-codes)
- [Glossary](https://developers.partech.com/docs/ordering-api/guides/references/glossary)
- [Order Statuses](https://developers.partech.com/docs/ordering-api/guides/references/order-statuses)
- [Order Types](https://developers.partech.com/docs/ordering-api/guides/references/order-types)
- [Payment Processors & Payment Methods](https://developers.partech.com/docs/ordering-api/guides/references/payment-processors-and-payment-methods): List of all supported payment processors and payment methods. Payment method and payment processor UUIDs can be obtained from the response of the init-application call.
- [Reordering-Validation-Check-Codes](https://developers.partech.com/docs/ordering-api/guides/references/reordering-validation-check-codes)
- [Serving Times](https://developers.partech.com/docs/ordering-api/guides/references/serving-times): Serving Times define on which days or dates, as well as at which time, a resource is available. Serving Times can be applied to Venues, in order to define the location's opening hours, or Subcategorie
- [States](https://developers.partech.com/docs/ordering-api/guides/references/states): State defines the current status of a resource instance, for example defining whether a Venue is enabled or disabled. State is found across many different PAR Ordering resources and can be used to det
- [Select a Store for Delivery or Catering Delivery](https://developers.partech.com/docs/ordering-api/guides/store-finder/select-a-store-for-delivery): This guide explains how to build a flow to select a Venue (Store / Location) for Delivery or Catering Delivery.
- [Select a Store for Pick up (Dine-in, Takeout, Drive Thru or Catering Pickup)](https://developers.partech.com/docs/ordering-api/guides/store-finder/select-a-store-for-dine-in-takeout): This guide explains how to build a Store Finder experience that allows your customer to start their ordering process for Dine-in, Takeout, Drive Thru or Catering Pickup.
- [PAR Pay Service API — Overview](https://developers.partech.com/docs/par-pay): The PAR Pay Service API provides a unified interface for processing credit card and gift card payment transactions. It enables merchants and integrators to handle the full payment lifecycle — from aut
- [Apple Pay Integration with PAR Pay](https://developers.partech.com/docs/par-pay/apple-pay/apple-pay-integration): Apple Pay is a secure, tokenized payment method that enables customers to complete transactions using payment cards provisioned on their Apple devices.
- [Apple Pay Onboarding — Aurus](https://developers.partech.com/docs/par-pay/apple-pay/apple-pay-onboarding-aurus): This guide covers the onboarding procedure for enabling Apple Pay with the Aurus payment gateway. It includes generating the required Apple Pay certificates, converting them into the formats required
- [Apple Pay Onboarding — Spreedly](https://developers.partech.com/docs/par-pay/apple-pay/apple-pay-onboarding-spreedly): This guide covers the onboarding procedure for enabling Apple Pay with the Spreedly payment gateway. It includes generating certificate signing requests (CSRs) using Spreedly APIs, completing certific
- [Typical Credit Card Payment Flow](https://developers.partech.com/docs/par-pay/credit-card-payment-flow): The credit card payment flow supports two approaches: a two-step Preauthorize + Capture flow for scenarios where you need to hold funds before finalizing (e.g., tab-based or fulfillment-dependent orde
- [Typical Gift Card Flow](https://developers.partech.com/docs/par-pay/gift-card-flow): The gift card flow covers the full lifecycle of a gift card — from issuance through to redemption, reloads, balance inquiries, balance transfers, refunds, sharing, gifting, and combining. Cards can be
- [Google Pay Integration with PAR Pay](https://developers.partech.com/docs/par-pay/google-pay/google-pay-integration): Google Pay is a secure, tokenized payment method that enables customers to complete transactions using cards provisioned on their Google accounts and devices. PAR Pay supports Google Pay as part of it
- [Typical Health Check Flow](https://developers.partech.com/docs/par-pay/health-check-flow): The health check endpoints allow you to monitor the PAR Pay service's availability and readiness. Use the Health endpoint for a quick liveness check to confirm the service is running, and the Readines
- [🚀 PAR POS Cloud APIs](https://developers.partech.com/docs/parpos-cloud-apis): Developer portal for PAR POS Cloud REST and SOAP APIs.
- [Using SOAP APIs](https://developers.partech.com/docs/parpos-cloud-apis/soap): PAR POS is a SOAP-based API service. All data is structured via XML, but you can consume the WSDLs (Web Service Description Language) for each PAR POS Service and generate classes using a WSDL to Clas
- [Best Practices and FAQs](https://developers.partech.com/docs/parpos-cloud-apis/soap/bestpracticeandfaqs): This information provides guidance to avoid common mistakes during new integrations with the PAR POS API, based on actual support cases from vendor and customer integration teams.
- [Contact Us](https://developers.partech.com/docs/parpos-cloud-apis/soap/contactus): If you need further assistance, please feel free to reach out to API Support at: api.support@partech.com to open a new case with us.
- [Getting Started - PAR Ordering to Third Party Integration With POS](https://developers.partech.com/docs/pos-next): This guide helps PARTech development partners integrate their POS systems with the PAR Ordering dispatch system. The integration uses RESTful APIs secured with JWT-based authentication and HMAC-SHA256
- [PAR Ordering API - Endpoint Reference Topics](https://developers.partech.com/docs/pos-next/apis/pos-next): Integration API for PAR POS Next Online Ordering system.
- [Asynchronous Responses Handling (202 Accepted)](https://developers.partech.com/docs/pos-next/asynchronous-responses): 202 Accepted is an exceptional case and should only be used when absolutely nx₹ecessary. The normal expectation is immediate responses (200 OK) even for multiple concurrent requests.
- [Error Handling](https://developers.partech.com/docs/pos-next/error-codes): Handle common HTTP status codes:
- [Integration Checklist](https://developers.partech.com/docs/pos-next/integration-checklist)
- [Complete Integration Flow](https://developers.partech.com/docs/pos-next/integration-flow): End-to-end flow from menu sync to order completion:
- [Authentication](https://developers.partech.com/docs/pos-next/integration-requirements/authentication): PAR Ordering dispatch system sends JWT tokens in the Authorization header for all API requests:
- [Base URL Configuration](https://developers.partech.com/docs/pos-next/integration-requirements/base-url-configuration): Your API base URL (where you will host the endpoints you implement) is configured in the PAR Ordering dispatch system configuration. All endpoints are relative to this base URL.
- [DateTime Format](https://developers.partech.com/docs/pos-next/integration-requirements/datetime-format): All datetime fields must use the following format in UTC:
- [ID Mapping Requirement](https://developers.partech.com/docs/pos-next/integration-requirements/id-mapping-requirement): PAR Ordering provides SharedId, OrganizationId, and LocationId values. You must map these PAR-provided IDs to your internal business/brand or location identifiers.
- [Payload Signing](https://developers.partech.com/docs/pos-next/integration-requirements/payload-signing): All order requests and responses must include an HMAC SHA256 signature in the x-pch-digest header to ensure payload integrity.
- [Order Lifecycle](https://developers.partech.com/docs/pos-next/order-lifecycle): The order processing follows a two-phase approach: Validate first, then Submit.