List Locations
GET /v1/nextrestaurant/locations
List published locations
Every published location with its public details. Unpublished locations are
never returned. The id here is what the menu and order endpoints need.
Request
GET https://your-site.example/api/index.php/v1/nextrestaurant/locations
Responses
200 — The published locations.
{
"data": [
{
"id": 1,
"code": "MAIN",
"title": "Downtown Bistro",
"currency": "USD",
"timezone": "America/Chicago",
"service_modes": [
"dine_in",
"takeaway",
"delivery",
"qr"
],
"opening_hours": {
"mon": {
"open": "11:00",
"close": "22:00"
},
"sat": {
"open": "10:00",
"close": "23:30"
}
},
"tax_rate": 8.25
},
{
"id": 2,
"code": "RIVER",
"title": "Riverside Grill",
"currency": "USD",
"timezone": "America/Chicago",
"service_modes": [
"dine_in",
"takeaway",
"delivery",
"qr"
],
"opening_hours": {
"mon": {
"open": "11:00",
"close": "22:00"
}
},
"tax_rate": 8.25
}
]
}
| Field | Type | Meaning |
|---|---|---|
data[].id |
integer |
(int64) |
data[].code |
string |
Your short branch code. |
data[].title |
string |
|
data[].currency |
string |
ISO 4217 currency code. |
data[].timezone |
string |
IANA timezone name. |
data[].service_modes[] |
string[] |
Which ways this branch serves guests. One of dine_in, takeaway, delivery, qr. |
data[].opening_hours |
object |
Keyed mon–sun. A day that is absent, null or empty means closed. |
data[].tax_rate |
number\|null |
Percentage, e.g. 8.25 for 8.25%. |
Errors
| Status | Code | When |
|---|---|---|
401 |
INVALID_TOKEN |
The token is missing, wrong, or none has been generated. |
403 |
MODULE_DISABLED |
This module is disabled. |
403 |
API_DISABLED |
API is disabled |
Examples
curl
curl -s "https://your-site.example/api/index.php/v1/nextrestaurant/locations" \
-H "Authorization: Bearer $API_TOKEN"