How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Punchh Api2 API

The Api2 API from Punchh — 26 operation(s) for api2.

Punchh Api2 API is one of 46 APIs that Punchh publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 26 JSON Schema definitions.

Tagged areas include Api2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a JSON-LD context, and 26 JSON Schemas.

This API exposes 33 operations across 26 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://SERVER_NAME_GOES_HERE.punchh.com.

33 operations 26 paths 34 schemas 2 DELETE9 GET4 PATCH17 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{server_name}.punchh.com
Resource Areas
1

Paths & Operations 33

Across 26 paths, the API surfaces 33 operations — 2 DELETE, 9 GET, 4 PATCH, 17 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Api2 33
DELETE
/api2/mobile/redemptions/{redemption_id}
Cancel Redemption (Redemptions 1.0)
delete-api2-mobile-redemptions 8 params body → 200404422
POST
/api2/mobile/redemptions/banked_currency
Create Redemption Using Banked Currency (Redemptions 1.0)
mobile_create_redemption_using_banked_currency 7 params body → 200400
POST
/api2/mobile/redemptions/visits
Create Redemption Using Visits (Redemptions 1.0)
mobile_create_redemption_using_visits 7 params body → 200400
POST
/api2/mobile/redemptions/redeemable
Create Redemption Using Redeemable (Redemptions 1.0)
mobile_create_redemption_using_redeemable 7 params body → 200400
POST
/api2/mobile/redemptions/reward
Create Redemption Using Reward ID (Redemptions 1.0)
mobile_create_redemption_using_reward_id 7 params body → 200400
GET
/api2/mobile/redemptions/applicable_offers
List Applicable Offers (Redemptions 1.0)
mobile_list_applicable_offers 6 params body → 200400
POST
/api2/mobile/discounts/select
Add Selection to Discount Basket (Redemptions 2.0)
sso_create_online_redemption 7 params body → 200400404422
DELETE
/api2/mobile/discounts/unselect
Remove Item From Discount Basket (Redemptions 2.0)
delete-api-auth-discounts-unselect 7 params body → 200400404422
GET
/api2/mobile/discounts/active
Get Active Discount Basket (Redemptions 2.0)
get-api-auth-discounts-active 7 params body → 200404422
POST
/api2/mobile/single_scan_tokens
Get Access Code (Redemptions 2.0)
post-api-mobile-single_scan_tokens 6 params body → 200400422
GET
/api2/mobile/subscriptions
Fetch Active Purchasable Subscription Plans
post-api2-mobile-subscriptions 4 params body → 200400412422
POST
/api2/mobile/subscriptions
Purchase Subscription
post-api2-mobile-users-subscriptions 6 params body → 200400401412422
GET
/api2/mobile/user_subscriptions
Fetch Subscription Plans for a User
post-api2-mobile-subscriptions 7 params body → 200400401412422
POST
/api2/mobile/redemptions/subscription
Generate a Redemption Code for Subscription Redemption
post-api2-mobile-redemptions-subscription 7 params body → 200400401412422
PUT
/api2/mobile/subscriptions/cancel
Cancel Subscription (Turn off Auto Renewal)
put-api2-mobile-subscriptions-cancel 6 params body → 200400401412422
GET
/api2/dashboard/segments
Get Segment List
get-api2-segment-list 3 params body → 200400422
GET
/api2/dashboard/redeemables
Get Redeemable List
get-api2-redeemable-list 3 params body → 200400422
POST
/api2/dashboard/campaigns
Commit Redeemable Distribution
post-api2-redeemable-distribution 3 params body → 200400404422
POST
/api2/dashboard/users/support_gifting
Asynchronous Support Gifting
post-api2-dashboard-users-support_gifting 3 params body → 202401422
POST
/api2/dashboard/users/support
Support Gifting to a User
dashboard_support_gifting_to_user 3 params body → 201401422
GET
/api2/dashboard/offers/lis
Get Line Item Selector (LIS) List
get-api2-dashboard-offers-lis 3 params body → 200400401403
POST
/api2/dashboard/offers/lis
Create Line Item Selector (LIS)
post-api2-dashboard-offers-lis 3 params body → 200400401403
PATCH
/api2/dashboard/offers/lis
Update Line Item Selector (LIS)
patch-api2-dashboard-offers-lis 3 params body → 200400401403
GET
/api2/dashboard/offers/qc
Get Qualification Criteria (QC) List
get-api2-dashboard-offers-qc 3 params body → 200400401403
POST
/api2/dashboard/offers/qc
Create Qualification Criteria (QC)
post-api2-dashboard-offers-qc 3 params body → 200400401403
PATCH
/api2/dashboard/offers/qc
Update Qualification Criteria (QC)
patch-api2-dashboard-offers-qc 3 params body → 200401403
GET
/api2/dashboard/offers/redeemable
Get Redeemable List
get-api2-dashboard-offers-redeemable 3 params body → 200400401403422
POST
/api2/dashboard/offers/redeemable
Create Redeemable
post-api2-dashboard-offers-redeemable 3 params body → 200400401403422
PATCH
/api2/dashboard/offers/redeemable
Update Redeemable
patch-api2-dashboard-offers-redeemable 3 params body → 200400401403
POST
/api2/dashboard/offers/upload_redeemable_image
Upload Redeemable Image
post-api2-dashboard-offers-upload_redeemable_image 3 params body → 200400401403
POST
/api2/dashboard/subscriptions/purchase
Purchase Subscription
post-api2-dashboard-subscriptions-purchase 3 params body → 201400401406422
POST
/api2/dashboard/subscriptions/renew
Renew Subscription
post-api2-dashboard-subscription 3 params body → 200401406422
PATCH
/api2/dashboard/subscriptions/cancel
Cancel Subscription (Turn off Auto Renewal)
patch-api2-dashboard-subscriptions-cancel 3 params body → 200401406422

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are redeemable_redeeming_criterion (21 properties), discount_details (14 properties), redemption_details (14 properties), qc_line_item_selector (6 properties). Each schema is shown below with its type and property counts.

redemption_details
object
The redemptiondetails object returns information about a redemption done by a user.
14 properties
menu-items
array
This object used in the API request contains one or more menu items added to an order. It is mandatory to provide an array of menu items. See [How To Send Menu…
Menu-items
array
Returns a list of menu items in the API response
discount_details
object
List of a discount's defining attributes. In the case of the [Get Active Discount Basket](/docs/dev-portal-mobile/1d4f01cf7aa32-get-active-discount-basket-rede…
14 properties
discount_basket_items
array
List of discounts. In the case of the [Get Active Discount Basket](/docs/dev-portal-mobile/1d4f01cf7aa32-get-active-discount-basket-redemptions-2-0) API, the o…
lis_results
object
1 property
qc_item_qualifiers_input
array
Lists the items that must be present on the check to meet the qualification criteria. The processing function is triggered only if the receipt satisfies all of…
warnings_line_item_filters
array
List of warnings related to line item filters
meta
object
Shows pagination information
3 properties
redeemable_lag_duration
object
This object specifies the duration before the redeemable is gifted to the guest.
2 properties
qc_line_item_selector
object
Shows the details of the line item selector (LIS) associated with the qualification criteria (QC)
6 properties
warnings_item_filter_expressions_operator
array
List of warnings related to the item filter expressions operator
item_qualifiers
array
List of items qualifiers associated with the qualification criteria (QC). The object lists the items that must be present on the check to meet the QC. The proc…
lis_data_output
object
2 properties
qc_line_item_filters_input
array
Lists the items to be discounted by using filters to select applicable menu items. Leave the filter empty to apply the discount to all menu items. If multiple…
warnings_qualifying_expressions_operator
array
List of warnings related to the qualifying expressions operator
redeemable_alternate_locale_name
array
An object representing the redeemable name in multiple languages
warnings_discount_evaluation_strategy
array
List of warnings related to the discount evaluation strategy
warnings_item_qualifiers
array
List of warnings related to item qualifiers
warnings_receipt_qualifiers
array
List of warnings related to receipt qualifiers
modifiers
object
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.
3 properties
redeemable_alternate_locale_description
array
An object representing the redeemable description in multiple languages
base_items
object
When building a new line item selector (LIS), you will define a base item, a modifier, or both. A base item is the 'main' item. For example, a hamburger.
1 property
aggregator_grouping_attributes
object
Attributes that have to be matched to aggregate menu items. All menu items with identical attributes are treated as the same, and the total quantity is the sum…
5 properties
lis_data_input
object
1 property 1 required
receipt_qualifiers
array
Lists the receipt rules that are used to check for information that must (or must not be) present on a guest's receipt in order to satisfy conditions for the q…
redeemable_template
object
This object contains customizable messaging for the redemption process.
3 properties
qc_data_input
object
1 property 1 required
qc_data_output
object
2 properties
redeemable_redeeming_criterion
object
This object contains information about the qualification criteria that will be created and attached to the redeemable. It is required when qualifiertype is set…
21 properties 1 required
redeemable_data_output
object
2 properties
redeemable_data_input
object
1 property 1 required
redeemable_recurrence_schedule
object
Specifies how many times this redeemable should be awarded to the guest, along with the frequency
2 properties
redeemable_results
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

punchh-api2-api-openapi.yml Raw ↑

Other APIs Punchh publishes across the network.

Punchh POS API
Punchh Auth API
Punchh Badges API
Punchh Beacons API
Punchh Business Admin Users API
Punchh Business Migration Users API
Punchh Challenges API
Punchh Check In API
Punchh Check Ins API
Punchh Check User Balance API
Punchh Collectibles API
Punchh Coupons API
Where this information came from

This is an independent, third-party profile of Punchh Api2 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.