Punchh

Punchh Check In API

The Check-in API from Punchh — 3 operation(s) for check-in.

Documentation GitHub OpenAPI

Operations 6

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/checkins/online_order Award loyalty for an online order · Create Loyalty Check-in #

Ask an LLM

“How does a signed-in guest earn points for an online order?”

“Can an online order check-in be created in a pending state and committed later?”

Tell an agent

Check in online order {transaction_no} ({external_uid}) at store {store_number}: {receipt_amount}, paid {payable}, at {receipt_datetime}.

Grant points for online order {transaction_no} at store {store_number} in state {state}.

PUT /api/auth/checkins/online_order Update a pending online order check-in · Update Loyalty Check-in #

Ask an LLM

“How do I change the details of an online order check-in that's still pending?”

“Do I resend the whole order or just the changes when updating a check-in?”

Tell an agent

Update pending check-in {external_uid} to a receipt amount of {receipt_amount}.

Resend the full order for pending check-in {external_uid} with items {menu_items}.

DELETE /api/auth/checkins Void a pending loyalty check-in · Void Loyalty Check-in #

Ask an LLM

“How do I cancel a pending check-in when an online order is abandoned?”

“Can a pending loyalty check-in be voided by its external ID?”

Tell an agent destructive · confirm first

Void pending check-in {external_uid}.

Cancel the loyalty check-in {external_uid} before it's committed.

POST /api/auth/checkins Check a guest in by store number (legacy) · Create Loyalty Check-in (OLD) #

Ask an LLM

“Is there an older endpoint that checks a guest in using only a store number?”

“Which check-in endpoint is deprecated in favor of the receipt-based one?”

Tell an agent

Use the old check-in endpoint to check in the guest at store {store_number}.

Create a legacy store-number check-in at {store_number} for user token {access_token}.

GET /api/auth/checkins Look up a check-in by its external ID · Fetch a Check-in by External ID #

Ask an LLM

“How do I retrieve a loyalty check-in using the ID my ordering system assigned?”

“Can I see the details of a check-in I created earlier?”

Tell an agent

Fetch the check-in with external ID {external_uid}.

Show me check-in {external_uid}.

POST /api2/dashboard/checkins Create a check-in without the guest's token · Create Loyalty Check-in #

Ask an LLM

“How can I award points for a future-dated order when I don't have the guest's access token?”

“Can I identify the guest by email or phone when creating a check-in from the back end?”

Tell an agent

Admin check-in for {email}: order {transaction_no} at store {store_number}, {receipt_amount}, paid {payable}, {receipt_datetime}, ref {external_uid}.

From the dashboard, award user {user_id} for order {transaction_no} at store {store_number}.

Documentation

https://developers.partech.com/docs/dev-portal-mobile

https://developers.partech.com/docs/dev-portal-mobile

https://developers.partech.com/docs/dev-portal-mobile/make-your-first-mobile-api-call

https://developers.partech.com/docs/dev-portal-online-ordering

https://developers.partech.com/docs/dev-portal-online-ordering

https://developers.partech.com/docs/dev-portal-online-ordering/make-your-first-sso-api-call

https://developers.partech.com/docs/dev-portal-platform-functions

https://developers.partech.com/docs/dev-portal-platform-functions

https://developers.partech.com/docs/dev-portal-platform-functions/make-your-first-platform-function-api-call

https://developers.partech.com/docs/dev-portal-pos

https://developers.partech.com/docs/dev-portal-pos

https://developers.partech.com/docs/dev-portal-pos/make-your-first-pos-api-call

Specifications

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/openapi/punchh-check-in-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-access-token-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-create-user-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-login-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-mark-offers-read-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-transaction-details-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-transaction-details-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-update-user-profile-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-user-session-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-access-token-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-create-user-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-login-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-mark-offers-read-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-transaction-details-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-transaction-details-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-update-user-profile-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-user-session-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-checkin-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-checkin-response-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-redemption-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-redemption-response-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-checkin-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-checkin-response-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-redemption-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-redemption-response-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/platform-functions-redeemable-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/platform-functions-redeemable-structure.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-access-token-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-create-user-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-login-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-mark-offers-read-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-transaction-details-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-transaction-details-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-update-user-profile-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-user-session-example.json

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

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-mobile.opencollection.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-checkin-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-checkin-response-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-redemption-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-redemption-response-example.json

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

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-online-ordering.opencollection.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/platform-functions-redeemable-example.json

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

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:punchh-check-in-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 Check In API
  version: '1.0'
  description: 'Operations tagged Check-in across 2 of this provider''s published API definitions: punchh-online-ordering-sso-api-openapi.yml, punchh-platform-functions-api-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 (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/openapi/punchh-check-in-api-openapi.yml