List locations

GET

/locations

Cursor-paginated. A key restricted to certain locations sees only those; limit above the maximum is clamped, not rejected, and the response states the effective limit.

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

Query Parameters

limit

Page size. Clamped to the maximum (100 by default, PUBLIC_API_MAX_PAGE_SIZE) rather than rejected.

Type

integer

Minimum

1

cursor

Opaque cursor from a previous response's next_cursor. Absent next_cursor (null) means the end.

Type

string

Responses

List locations

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"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"

  

  

}

  

],

  

"next_cursor": "eyJjIjoiMjAyNi0wOC0wNVQxMDoxNTowMC4wMDBaIiwiaSI6ImNpbl9kb2NzZml4dHVyZTAwMDEifQ",

  

"limit": 25

}

GET

/locations

Samples

Powered by VitePress OpenAPI