Appearance
Update a location
PATCH
/locations/{id}
The shop's own record of a site: its name, its address and whether staff must enter a PIN there. A location cannot be CREATED over the API — the platform is pay-then-provision, so a new site is bought in the dashboard — and active is not a field here: enable and disable are explicit actions below, because "disabled by the merchant" and "blocked for non-renewal" are different states and one boolean cannot hold both.
Authorizations
ApiKeyBearer
A shop-scoped API key created in the dashboard and shown exactly once. An MCP tmk_ key presented here returns a 401 that names the mistake.
Type
HTTP (bearer)
Parameters
Header Parameters
Idempotency-Key
Makes a retry safe: a repeat with the same key and body replays the stored response; the same key with a different body is a 409. Keys are remembered for 24h (IDEMPOTENCY_DEDUPE_WINDOW_HOURS). A request without the header is processed normally.
Type
string
Max Length
255Path Parameters
id*
An opaque id. The API never promises an id format.
Type
Requiredstring
Request Body
application/json
JSON "name": "Via Roma 1", "address": "Via Roma 1", "city": "Milano", "postal_code": "20121", "country_code": "IT", "lat": 45.4642, "lon": 9.19, "require_staff_pin": false
{
}
Responses
Update a location
application/json
JSON "id": "loc_docsfixture0001", "name": "Via Roma 1", "address": "Via Roma 1", "city": "Milano", "postal_code": "20121", "country_code": "IT", "lat": 45.4642, "lon": 9.19, "require_staff_pin": false, "active": true, "disabled_at": null, "created_at": "2026-08-05T10:15:00.000Z", "updated_at": "2026-09-04T10:15:00.000Z"
{
}
PATCH
/locations/{id}