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 Auth API

The Auth API from Punchh — 14 operation(s) for auth.

Punchh Auth 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 Authentication. 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 16 operations across 14 paths, and defines 8 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.

16 operations 14 paths 8 schemas 3 DELETE5 GET6 POST2 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 16

Across 14 paths, the API surfaces 16 operations — 3 DELETE, 5 GET, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Auth 16
POST
/api/auth/redemptions/online_order
Create Online Redemption (Redemptions 1.0)
sso_create_online_redemption 5 params body → 200401412422
POST
/api/auth/redemptions
Fetch Redemption Code (Redemptions 1.0)
sso_fetch_redemption_code 5 params body → 200401412422
DELETE
/api/auth/redemptions
Void Processed Redemption (Redemptions 1.0)
sso_void_processed_redemption 5 params body → 202
GET
/api/auth/redemptions/applicable_offers
Applicable Offers (Redemptions 1.0)
sso_applicable_offers 5 params body → 200401412422
POST
/api/auth/discounts/auto_select
Auto Redemption (Redemptions 2.0)
post-api-auth-discounts-auto_select 6 params body → 200400404422
POST
/api/auth/discounts/select
Add Selection to Discount Basket (Redemptions 2.0)
sso_create_online_redemption 6 params body → 200400404422
DELETE
/api/auth/discounts/unselect
Remove Item From Discount Basket (Redemptions 2.0)
delete-api-auth-discounts-unselect 6 params body → 200400404422
GET
/api/auth/discounts/active
Get Active Discount Basket (Redemptions 2.0)
get-api-auth-discounts-active 6 params body → 200404422
POST
/api/auth/batch_redemptions
Batch Redemption Process (Redemptions 2.0)
sso_create_online_redemption 6 params body → 200400404422
DELETE
/api/auth/batch_redemptions/{redemption_ref}
Void Redemption (Redemptions 2.0)
delete-api-auth-batch_redemptions 6 params body → 202400404410422
PUT
/api/auth/discounts/unlock
Unlock Discount Basket (Redemptions 2.0)
put-api-auth-discounts-unlock 5 params body → 200404422
GET
/api/auth/subscriptions
Fetch Active Purchasable Subscription Plans
post-api-auth-subscriptions 4 params body → 200400412422
POST
/api/auth/subscriptions
Purchase Subscription
post-api-auth-subscriptions 5 params body → 200400401412422
PUT
/api/auth/subscriptions/cancel
Cancel Subscription (Turn off Auto Renewal)
put-api-auth-subscriptions 5 params body → 200400401412422
GET
/api/auth/user_subscriptions
Fetch Subscription Plans for a User
post-api-auth-user-subscriptions 6 params body → 200401412422
GET
/api/auth/subscription_meta
Subscription Meta
get-api-auth-subscription_meta 4 params body → 200422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed is discount_details (14 properties). Each schema is shown below with its type and property counts.

menu_items
array
This object used in the API request contains one or more menu items added to an order. See [How To Send Menu Items to Punchh](/docs/dev-portal-online-ordering/…
discount_distribution_items
array
An array containing details of how the applied discount is distributed across individual menu items. Each object represents one line item that receives a porti…
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 [Auto Redemption](/docs/dev-portal-online-ordering/d3e1d4293ad65-auto-redemption-redemptions-2-0)…
14 properties
discount_basket_items
array
List of discounts. In the case of the [Auto Redemption](/docs/dev-portal-online-ordering/d3e1d4293ad65-auto-redemption-redemptions-2-0) and [Get Active Discoun…
line_items
array
List of line items
qualified_items
array
List of qualified items
Subscription-Cancellation-Reasons
array
Different cancellation reasons that the business has configured and guests can select from within the mobile app while cancelling a subscription.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

punchh-auth-api-openapi.yml Raw ↑

Other APIs Punchh publishes across the network.

Punchh POS API
Punchh Api2 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 Auth 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.