Punchh

Punchh Point Of Sale API

The Point Of Sale API from Punchh — 8 operation(s) for point of sale.

Documentation GitHub OpenAPI

Operations 8

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

GET /api/pos/locations/configuration Get a store location's POS configuration · Location Configuration #

Ask an LLM

“How does a POS terminal pull the loyalty settings for its own store location?”

“What keys does the register need to send to read its location configuration?”

Tell an agent

Fetch the loyalty configuration for this store location.

Get the POS location settings in language {Accept-Language}.

GET /api/pos/meta Get loyalty program details for the POS · Program Meta #

Ask an LLM

“What program type and redeemables does the register need to know about this loyalty program?”

“How quickly do program configuration changes show up at the POS?”

Tell an agent

Show the loyalty program meta for the POS.

Get the program type and redeemable list for the register.

POST /api/pos/users Enroll a new loyalty member at the register · Create New User #

Ask an LLM

“Can a cashier sign a guest up for loyalty right at the POS with just a phone number?”

“Can the POS trigger an opt-in SMS when enrolling a new member?”

Tell an agent

Enroll a new loyalty member with phone {phone}.

Sign up {first_name} {last_name} at the register with phone {phone} and email {email}.

GET /api/pos/users/search Look up a loyalty guest and their balance at the POS · User Look-up and Fetch Balance #

Ask an LLM

“How does the register find a guest's loyalty account by phone, email or QR code?”

“Can a cashier look up a guest with a drive-thru short code?”

Tell an agent

Look up the loyalty guest with phone {phone} and show their balance.

Find the guest for drive-thru code {drive_thru_code}.

POST /api/pos/checkins Award loyalty for an in-store check · Create Check-in #

Ask an LLM

“How does the POS credit a guest with points for a purchase they just made in store?”

“Is email required for a POS check-in when using the single-scan flow?”

Tell an agent

Create a POS check-in for {email} on transaction {transaction_no}: {receipt_amount} at {receipt_datetime}.

Check in single-scan code {single_scan_code} for transaction {transaction_no} paying {payable}.

POST /receipt_details Send receipt details from the POS · Store Receipt Details From POS #

Ask an LLM

“How do I push every receipt from my POS so guests can scan it later for points?”

“Can I void a receipt I already sent or mark one as a test?”

Tell an agent

Store receipt {transaction_no} with Punchh key {punchh_key} for {amount}.

Void stored receipt {transaction_no} by sending status {status}.

POST /api/pos/transactions Record a visit without earning loyalty · Create Transaction #

Ask an LLM

“Can I log a guest's store visit without giving them any points?”

“Which identifiers can tie a non-earning transaction to a guest?”

Tell an agent

Record a non-earning transaction {transaction_no} for {email} totaling {receipt_amount}.

Register a visit for phone {phone} on transaction {transaction_no} without awarding loyalty.

GET /api/pos/users/balance Fetch a guest's account balance and subscriptions · Fetch Account Balance #

Ask an LLM

“What points, rewards and subscription benefits does a guest have available at the register?”

“Can I filter the balance response to a specific discount type?”

Tell an agent

Fetch the account balance for user {user_id}.

Show user {user_id}'s balance with discounts of type {discount_type}.

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-point-of-sale-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-point-of-sale-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: POS Point Of Sale API
  version: '1.0'
  contact:
    name: Punchh Dev Support
    url: https://developers.punchh.com
  description: Punchh provides robust APIs for integrating POS (Point-of-Sale) terminals with its back end. The integration helps businesses to offer their customers loyalty programs directly from their POS systems.
servers:
- url: https://SERVER_NAME_GOES_HERE.punchh.com
tags:


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