Punchh

Punchh Api2 API

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

GitHub OpenAPI

Operations 33

DELETE /api2/mobile/redemptions/{redemption_id} Cancel Redemption (Redemptions 1.0) #
POST /api2/mobile/redemptions/banked_currency Create Redemption Using Banked Currency (Redemptions 1.0) #
POST /api2/mobile/redemptions/visits Create Redemption Using Visits (Redemptions 1.0) #
POST /api2/mobile/redemptions/redeemable Create Redemption Using Redeemable (Redemptions 1.0) #
POST /api2/mobile/redemptions/reward Create Redemption Using Reward ID (Redemptions 1.0) #
GET /api2/mobile/redemptions/applicable_offers List Applicable Offers (Redemptions 1.0) #
POST /api2/mobile/discounts/select Add Selection to Discount Basket (Redemptions 2.0) #
DELETE /api2/mobile/discounts/unselect Remove Item From Discount Basket (Redemptions 2.0) #
GET /api2/mobile/discounts/active Get Active Discount Basket (Redemptions 2.0) #
POST /api2/mobile/single_scan_tokens Get Access Code (Redemptions 2.0) #
GET /api2/mobile/subscriptions Fetch Active Purchasable Subscription Plans #
POST /api2/mobile/subscriptions Purchase Subscription #
GET /api2/mobile/user_subscriptions Fetch Subscription Plans for a User #
POST /api2/mobile/redemptions/subscription Generate a Redemption Code for Subscription Redemption #
PUT /api2/mobile/subscriptions/cancel Cancel Subscription (Turn off Auto Renewal) #
GET /api2/dashboard/segments Get Segment List #
GET /api2/dashboard/redeemables Get Redeemable List #
POST /api2/dashboard/campaigns Commit Redeemable Distribution #
POST /api2/dashboard/users/support_gifting Asynchronous Support Gifting #
POST /api2/dashboard/users/support Support Gifting to a User #
GET /api2/dashboard/offers/lis Get Line Item Selector (LIS) List #
POST /api2/dashboard/offers/lis Create Line Item Selector (LIS) #
PATCH /api2/dashboard/offers/lis Update Line Item Selector (LIS) #
GET /api2/dashboard/offers/qc Get Qualification Criteria (QC) List #
POST /api2/dashboard/offers/qc Create Qualification Criteria (QC) #
PATCH /api2/dashboard/offers/qc Update Qualification Criteria (QC) #
GET /api2/dashboard/offers/redeemable Get Redeemable List #
POST /api2/dashboard/offers/redeemable Create Redeemable #
PATCH /api2/dashboard/offers/redeemable Update Redeemable #
POST /api2/dashboard/offers/upload_redeemable_image Upload Redeemable Image #
POST /api2/dashboard/subscriptions/purchase Purchase Subscription #
POST /api2/dashboard/subscriptions/renew Renew Subscription #
PATCH /api2/dashboard/subscriptions/cancel Cancel Subscription (Turn off Auto Renewal) #

Documentation

📖
Documentation
https://developers.partech.com/docs/dev-portal-mobile
📖
APIReference
https://developers.partech.com/docs/dev-portal-mobile
📖
GettingStarted
https://developers.partech.com/docs/dev-portal-mobile/make-your-first-mobile-api-call
📖
Documentation
https://developers.partech.com/docs/dev-portal-online-ordering
📖
APIReference
https://developers.partech.com/docs/dev-portal-online-ordering
📖
GettingStarted
https://developers.partech.com/docs/dev-portal-online-ordering/make-your-first-sso-api-call
📖
Documentation
https://developers.partech.com/docs/dev-portal-platform-functions
📖
APIReference
https://developers.partech.com/docs/dev-portal-platform-functions
📖
GettingStarted
https://developers.partech.com/docs/dev-portal-platform-functions/make-your-first-platform-function-api-call
📖
Documentation
https://developers.partech.com/docs/dev-portal-pos
📖
APIReference
https://developers.partech.com/docs/dev-portal-pos
📖
GettingStarted
https://developers.partech.com/docs/dev-portal-pos/make-your-first-pos-api-call

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/openapi/punchh-api2-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-access-token-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-create-user-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-login-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-mark-offers-read-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-transaction-details-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-transaction-details-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-update-user-profile-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-user-session-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-access-token-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-create-user-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-login-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-mark-offers-read-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-transaction-details-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-transaction-details-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-update-user-profile-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-user-session-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-checkin-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-checkin-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-redemption-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-redemption-response-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-checkin-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-checkin-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-redemption-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-redemption-response-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/platform-functions-redeemable-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/platform-functions-redeemable-structure.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-access-token-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-create-user-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-login-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-mark-offers-read-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-transaction-details-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-transaction-details-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-update-user-profile-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-user-session-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-ld/punchh-mobile-context.jsonld
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-mobile.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-mobile.opencollection.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-checkin-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-checkin-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-redemption-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-redemption-response-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-ld/punchh-online-ordering-context.jsonld
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-online-ordering.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-online-ordering.opencollection.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/platform-functions-redeemable-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-ld/punchh-platform-functions-context.jsonld
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-platform-functions.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-platform-functions.opencollection.json

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-api2-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

punchh-api2-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Punchh Api2 API
  contact:
    name: Punchh Dev Support
    url: https://developers.punchh.com
  version: '1.0'
  description: 'Operations tagged Api2 across 6 of this provider''s published API definitions: punchh-mobile-redemptions-legacy-openapi.yml, punchh-mobile-redemptions-v2-openapi.yml, punchh-mobile-subscription-openapi.yml, punchh-platform-functions-headless-offers-openapi.yml, punchh-platform-functions-offers-ingestion-openapi.yml, punchh-platform-functions-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 (449 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/openapi/punchh-api2-api-openapi.yml