Punchh

Punchh Auth API

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

Documentation GitHub OpenAPI

Operations 16

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/auth/redemptions/online_order Redeem a reward against an online order receipt · Create Online Redemption (Redemptions 1.0) #

Ask an LLM

“How does an online ordering site apply a guest's reward or redemption code to a checkout under the older Redemptions 1.0 flow?”

“Which discount types can be redeemed against an online order receipt?”

Tell an agent

Redeem reward {reward_id} on online order {transaction_no} at store {store_number} for {receipt_amount} at {receipt_datetime}.

Apply coupon code {redemption_code} as discount type {discount_type} to online order {transaction_no} at store {store_number}.

POST /api/auth/redemptions Generate a redemption code to use at the POS · Fetch Redemption Code (Redemptions 1.0) #

Ask an LLM

“How do I get a tracking code a guest can show at the register to redeem a reward?”

“Can a redemption code be created from banked currency instead of a specific reward?”

Tell an agent

Fetch a POS redemption code for reward {reward_id}.

Generate a redemption code worth {redeemed_points} of banked currency at store {store_number}.

DELETE /api/auth/redemptions Void a processed Redemptions 1.0 redemption · Void Processed Redemption (Redemptions 1.0) #

Ask an LLM

“Can I reverse a redemption that has already been processed and give the offer back to the guest?”

“Are there time limits on voiding a coupon or promo redemption?”

Tell an agent destructive · confirm first

Void processed redemption {redemption_id} because {reason}.

Void the redemption tied to code {redemption_code} and return the offer to the guest.

GET /api/auth/redemptions/applicable_offers List rewards that apply to an online check · Applicable Offers (Redemptions 1.0) #

Ask an LLM

“Which of the guest's rewards can be used on the items in this online order?”

“Does the ordering channel affect which rewards qualify for a check?”

Tell an agent

List rewards applicable to a {receipt_amount} check on channel {channel} placed at {receipt_datetime}.

Show which rewards apply to this check at store {store_number}.

POST /api/auth/discounts/auto_select Auto-fill the discount basket for an order · Auto Redemption (Redemptions 2.0) #

Ask an LLM

“Can the best discount be queued in the guest's basket automatically when auto-redemption is on?”

“How does auto redemption decide which discount to pick for a check?”

Tell an agent

Auto-select discounts for a {receipt_amount} order at {receipt_datetime}.

Run auto redemption on order {transaction_no} and lock the basket with {external_uid}.

POST /api/auth/discounts/select Add chosen discounts to the guest's basket · Add Selection to Discount Basket (Redemptions 2.0) #

Ask an LLM

“How does an online ordering site add a guest's chosen reward to their discount basket?”

“Is a new discount basket created if the guest doesn't have an active one?”

Tell an agent

Add discounts {discount_basket_items_attributes} to the guest's online discount basket.

Select discounts {discount_basket_items_attributes} into the basket locked by {external_uid}.

DELETE /api/auth/discounts/unselect Remove discounts from the online discount basket · Remove Item From Discount Basket (Redemptions 2.0) #

Ask an LLM

“Can a guest drop a reward from their discount basket before checking out online?”

“Do I need the lock ID to remove items from a locked discount basket?”

Tell an agent destructive · confirm first

Remove items {discount_basket_item_ids} from the guest's discount basket.

Unselect basket items {discount_basket_item_ids} using lock {external_uid}.

GET /api/auth/discounts/active View the guest's current discount basket · Get Active Discount Basket (Redemptions 2.0) #

Ask an LLM

“What rewards has the guest already put in their discount basket?”

“Will an expired discount still show up in the active basket?”

Tell an agent

Show the guest's active discount basket.

Get the active discount basket locked with {external_uid}.

POST /api/auth/batch_redemptions Commit the discount basket against a receipt · Batch Redemption Process (Redemptions 2.0) #

Ask an LLM

“How do I finalize all the discounts in a guest's basket when the order is placed?”

“Can I preview possible redemptions before committing the batch?”

Tell an agent

Commit the batch redemption for order {transaction_no} at store {store_number}: {line_items}, {receipt_amount} at {receipt_datetime}.

Process the discount basket redemption at store {store_number} for line items {line_items}.

DELETE /api/auth/batch_redemptions/{redemption_ref} Void an entire discount basket redemption · Void Redemption (Redemptions 2.0) #

Ask an LLM

“How do I void every discount redeemed in a Redemptions 2.0 basket at once?”

“Where do I get the redemption reference needed to void a batch?”

Tell an agent destructive · confirm first

Void the whole discount basket with reference {redemption_ref}.

Reverse batch redemption {redemption_ref} for the guest.

PUT /api/auth/discounts/unlock Unlock a locked discount basket · Unlock Discount Basket (Redemptions 2.0) #

Ask an LLM

“How do I release a guest's discount basket that another channel locked?”

“What does it mean when a discount basket is locked by reward locking?”

Tell an agent

Unlock the discount basket held by {external_uid}.

Release the basket lock {external_uid} so other channels can edit it.

GET /api/auth/subscriptions List subscription plans for sale online · Fetch Active Purchasable Subscription Plans #

Ask an LLM

“What subscription plans can my online ordering site offer for purchase?”

“Which plans are currently purchasable for this business?”

Tell an agent

List the subscription plans available to purchase online.

Show the purchasable plans for client {client}.

POST /api/auth/subscriptions Buy a subscription plan for a signed-in guest · Purchase Subscription #

Ask an LLM

“How does an online ordering vendor purchase a subscription for a guest?”

“Can a guest pay for a subscription with a saved card?”

Tell an agent

Purchase plan {plan_id} for {purchase_price} from {start_time} to {end_time}, auto renew {auto_renewal}, for guest token {authentication_token}.

Buy subscription plan {plan_id} with saved card {payment_card_uuid}.

PUT /api/auth/subscriptions/cancel Cancel a guest's subscription renewal online · Cancel Subscription (Turn off Auto Renewal) #

Ask an LLM

“How can a guest turn off auto renewal for a subscription from the ordering site?”

“Can the guest choose between a soft and hard cancellation?”

Tell an agent destructive · confirm first

Cancel subscription {subscription_id} as {cancellation_type} with reason {cancellation_reason_id} and feedback {cancellation_feedback}.

Soft-cancel subscription {subscription_id} using reason {cancellation_reason_id}; feedback: {cancellation_feedback}; type {cancellation_type}.

GET /api/auth/user_subscriptions List a guest's subscriptions · Fetch Subscription Plans for a User #

Ask an LLM

“Which subscriptions are attached to this guest's profile?”

“Can I include past subscriptions when listing a guest's plans?”

Tell an agent

Show the subscriptions held by the guest.

List the guest's subscriptions with filter {filter}.

GET /api/auth/subscription_meta Get subscription cancellation reasons · Subscription Meta #

Ask an LLM

“What cancellation reasons can a guest pick from when ending a subscription?”

“Why would subscription meta return no cancellation reasons?”

Tell an agent

Get the configured subscription cancellation reasons.

Fetch subscription meta for client {client}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/punchh:punchh-auth-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Punchh Auth API
  contact:
    name: Punchh Dev Support
    url: https://developers.punchh.com
  version: '1.0'
  description: 'Operations tagged Auth across 3 of this provider''s published API definitions: punchh-online-ordering-redemptions-legacy-openapi.yml, punchh-online-ordering-redemptions-v2-openapi.yml, punchh-online-ordering-subscription-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://SERVER_NAME_GOES_HERE.punchh.com
tags:


# --- truncated at 32 KB (193 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/openapi/punchh-auth-api-openapi.yml

Punchh Auth API

Operations 16

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification