Offers Ingestion Management
Overview
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 simultaneously handling large volumes of offers, ensuring the platform can support growing business demands without performance issues. Faster offer creation enables businesses to quickly respond to market trends and customer demands, improving competitive advantage.
Requirements
To call this API, the offers ingestion option must be enabled for the business on the Punchh platform. Contact your Punchh representative to update this Punchh platform configuration.
Offers Ingestion API Endpoints
Using the Offers Ingestion API endpoints, you can create and update in bulk and list line item selectors (LIS), qualification criteria (QC), and redeemables.
| API Endpoint Name/Path | Description |
|---|---|
| Get Line Item Selector List GET {server-name}/api2/dashboard/offers/lis |
Pulls a list of line item selectors available and defined at the business level |
| Create Line Item Selector POST {server-name}/api2/dashboard/offers/lis |
Allows a business to define one or more line item selectors |
| Update Line Item Selector PATCH {server-name}/api2/dashboard/offers/lis |
Allows a business to update one or more line item selectors |
| Get Qualification Criteria List GET {server-name}/api2/dashboard/offers/qc |
Pulls a list of all qualification criteria available and defined at the business level |
| Create Qualification Criteria POST {server-name}/api2/dashboard/offers/qc |
Allows a business to define one or more qualification criteria |
| Update Qualification Criteria PATCH {server-name}/api2/dashboard/offers/qc |
Allows a business to update one or more qualification criteria |
| Get Redeemable List GET {server-name}/api2/dashboard/offers/redeemable |
Pulls a list of all redeemables available and defined at the business level |
| Create Redeemable POST {server-name}/api2/dashboard/offers/redeemable |
Allows a business to define one or more redeemables |
| Update Redeemable PATCH {server-name}/api2/dashboard/offers/redeemable |
Allows a business to update one or more redeemables |
| Upload Redeemable Image POST {server-name}/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 |
Offers Ingestion API Workflow
1. A business uses the Create Line Item Selector (LIS) API to create line item selectors with unique external IDs. Once successfully created, each LIS is stored in the Punchh database.
2. The business uses the Create Qualification Criteria (QC) API to create qualification criteria with unique external IDs. Once successfully created, the qualification criteria are stored in the Punchh database.
3. When creating qualification criteria, the external ID of an existing line item selector is sent in the Create Qualification Criteria (QC) API request to associate the line item selectors with the qualification criteria.
4. The business uses the Create Redeemable API to create redeemables with unique external IDs. Once successfully created, each redeemable is stored in the Punchh database.
5. When creating a redeemable, the external ID of existing qualification criteria is sent in the Create Redeemable API to associate the qualification criteria with the redeemable.
Tracking Creation of LIS, QC, and Redeemables Using External Identifiers
The external_id parameter sent in the API payload tracks whether entities (LIS, QC, and redeemables) are successfully created or not in the Punchh system. This external_id will be saved in Punchh, allowing external systems to:
- Identify and track the creation status (success or failure) of each entity.
- Use the external ID to perform operations like search and update.