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 Point Of Sale API

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

Punchh Point Of Sale 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 Point-of-Sale. 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 8 operations across 8 paths, and defines 14 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.

8 operations 8 paths 14 schemas 4 GET4 POST

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 8

Across 8 paths, the API surfaces 8 operations — 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Point Of Sale 8
GET
/api/pos/locations/configuration
Location Configuration
pos_location_config 2 params → 200
GET
/api/pos/meta
Program Meta
pos_program_meta 2 params → 200
POST
/api/pos/users
Create New User
pos_create_user 1 param body → 200
GET
/api/pos/users/search
User Look-up and Fetch Balance
pos_user_search 12 params → 200400404
POST
/api/pos/checkins
Create Check-in
pos_checkin 2 params body → 200
POST
/receipt_details
Store Receipt Details From POS
receipt_details 1 param body → 200400401
POST
/api/pos/transactions
Create Transaction
pos_create_transaction 2 params body → 200
GET
/api/pos/users/balance
Fetch Account Balance
get-api-pos-users-balance 1 param body → 200400404

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are balance (16 properties), account_balance (13 properties), multiple-redemptions (12 properties), selected_discount_amount (2 properties). Each schema is shown below with its type and property counts.

menu_items
array
The array contains one or more menu item objects added to an order. You send one of these arrays per API call. See [How To Send Menu Items to Punchh](/docs/dev…
user_subscriptions
array
The array object contains different subscriptions issued to the user.
selected_redeemables_card
array
This object is set for the single scan flow (SSF) for users that are on the Visit-based loyalty program. The selectedredeemablecards object shows one or more r…
multiple-redemptions
object
Lists the Punchh platform settings for multiple redemptions for the business. This object is returned in the API response if the multipleredemptionsenabled res…
12 properties
rewards
array
Shows the details of rewards in the user account.
subscriptions
array
This object is returned when the subscriptions feature is available for the business. In case a guest does not have active subscriptions, an empty object is re…
selected_subscriptions
array
This object is set only in the single scan flow (SSF). The selectedsubscriptions array object shows one or more user-selected subscriptions if the user would l…
selected_discount_amount
object
This object is set for the single scan flow (SSF) for users who are on the Banked Rewards loyalty program. The selecteddiscountamount object shows the banked c…
2 properties
balance
object
Account balance of the user
16 properties
selected_redeemables
array
This object is set for the single scan flow (SSF) for users that are on the Points Unlock Redeemables loyalty program. The selectedredeemables object shows one…
selected_rewards
array
This object is set only in the single scan flow (SSF). The selectedrewards object shows one or more user-selected rewards if the user would like to redeem them…
converted_category_balances
array
account_balance
object
The object contains the user's account balance details based on the program type of the business.
13 properties
selected_coupons
array
This object is set only in the single scan flow (SSF). The selectedcoupons object shows one or more Punchh coupon codes if the user would like to redeem them a…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

punchh-point-of-sale-api-openapi.yml Raw ↑

Other APIs Punchh publishes across the network.

Punchh POS API
Punchh Api2 API
Punchh Auth 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
Where this information came from

This is an independent, third-party profile of Punchh Point Of Sale 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.