Punchh

Punchh Locations API

The Locations API from Punchh — 9 operation(s) for locations.

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

GET /api2/mobile/locations/configuration Get a store location's configuration · Location Configuration #

Ask an LLM

“What configuration does a store location expose to the app or POS?”

“Can I read a location's settings using its location key?”

Tell an agent

Get the configuration for location key {location_key}.

Show this store's location configuration.

POST /api2/mobile/locations/{location_key}/diagnostic_logs Send POS diagnostic logs for a location · Diagnostic Logs #

Ask an LLM

“How do I report POS terminal diagnostics for a store to the loyalty platform?”

“Can I attach the POS type and MAC address when sending diagnostic logs?”

Tell an agent

Send diagnostic logs for location key {location_key}.

Log a {pos_type} terminal issue at location {location_key}: {description}.

GET /api2/mobile/locations/search Find nearby store locations · Search Locations #

Ask an LLM

“Which restaurant locations are closest to a guest's GPS position?”

“Can I search store locations by part of their name?”

Tell an agent

Find stores near latitude {latitude} and longitude {longitude}.

Search locations whose name contains {name_like}, up to {max} results.

GET /api2/dashboard/locations List a business's locations · Get Locations List #

Ask an LLM

“How do I get all store locations and their details for a business?”

“Can I page through locations or filter them by store number?”

Tell an agent

List locations starting from location {location_id}.

Get the location with store number {store_number}.

POST /api2/dashboard/locations Create a store location · Create Location #

Ask an LLM

“What admin permission do I need to add a new store location?”

“Can I add a new restaurant location to the loyalty program by API?”

Tell an agent

Create a new store location with {location}.

Add a restaurant location to the business.

PATCH /api2/dashboard/locations Edit a store location · Update Location #

Ask an LLM

“Can I change a store location's details after it was created?”

“Is there a way to turn on the weekly redemption report for one location?”

Tell an agent

Update location {location_id} with {location}.

Turn the weekly redemption report to {enabled} for store {store_number}.

DELETE /api2/dashboard/locations Delete a store location immediately · Delete Location #

Ask an LLM

“How do I remove a closed store location from the business right away?”

“Can I delete a location using its store number instead of its ID?”

Tell an agent destructive · confirm first

Delete location {location_id} now.

Remove the store with number {store_number} from the business.

GET /api2/dashboard/location_groups List location groups and their stores · Get Location Group List #

Ask an LLM

“Which location groups exist and which stores are in each?”

“Can one store belong to more than one location group?”

Tell an agent

List all location groups in the business.

Show the stores in location group {location_group_id}.

POST /api2/dashboard/location_groups Create a location group · Create Location Group #

Ask an LLM

“How do I group stores together, for example by region?”

“Does a new location group need a first location when it's created?”

Tell an agent

Create location group {name} starting with location {location_id}.

Make a new group named {name} with store {store_number}.

DELETE /api2/dashboard/location_groups Delete a location group · Delete Location Group #

Ask an LLM

“Does deleting a location group also delete its stores?”

“How do I remove a location group I no longer use?”

Tell an agent destructive · confirm first

Delete location group {location_group_id}.

Remove the group {location_group_id} but keep its stores.

PATCH /api2/dashboard/location_groups Rename a location group · Update Location Group #

Ask an LLM

“Can I rename an existing location group?”

“What can be changed on a location group after it is created?”

Tell an agent

Rename location group {location_group_id} to {name}.

Change the name of group {location_group_id} to {name}.

POST /api2/dashboard/location_groups/add_location Add a store to a location group · Add Location to Location Group #

Ask an LLM

“How do I add another store to an existing location group?”

“Can I add a location to a group by its store number?”

Tell an agent

Add location {location_id} to group {location_group_id}.

Put store {store_number} into location group {location_group_id}.

DELETE /api2/dashboard/location_groups/remove_location Remove a store from a location group · Delete Location From a Location Group #

Ask an LLM

“Can I take a store out of a location group without deleting the store?”

“What happens to a location after it's removed from a group?”

Tell an agent destructive · confirm first

Remove location {location_id} from group {location_group_id}.

Take store {store_number} out of location group {location_group_id}.

PATCH /api2/dashboard/business_admins/authorizations Grant an admin access to stores · Allow Admin To Access a Location or Location Group #

Ask an LLM

“How do I let a business admin manage a specific store or location group?”

“Can an admin be given access by store number?”

Tell an agent

Grant admin {admin_id} access to {business_admins}.

Allow admin {admin_id} to manage additional locations.

DELETE /api2/dashboard/business_admins/authorizations Revoke an admin's access to stores · Revoke Admin Access From a Location or Location Group #

Ask an LLM

“How do I stop a business admin from managing a particular store?”

“Can I remove an admin's access to a whole location group?”

Tell an agent destructive · confirm first

Revoke admin {admin_id}'s access to {business_admins}.

Take away store access for admin {admin_id}.

DELETE /api2/dashboard/locations/destroy_async Queue a store location for deletion · Delete Location Async #

Ask an LLM

“Is there a background way to delete a location that has a lot of data?”

“Can location deletion be queued instead of done immediately?”

Tell an agent destructive · confirm first

Queue location {location_id} for asynchronous deletion.

Schedule deletion of location {location_id}, store {store_number}, in the background.

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-locations-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 Locations API
  version: '1.0'
  description: 'Operations tagged Locations across 2 of this provider''s published API definitions: punchh-mobile-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 (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/openapi/punchh-locations-api-openapi.yml

Punchh Locations 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