Vai al contenuto principale
GET
/
account
/
subrestaurants
Elenco locali
curl --request GET \
  --url https://app.xmenu.it/api/account/subrestaurants \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "subrestaurants": [
    {
      "uid": "<string>",
      "name": "<string>",
      "at": "<string>",
      "code": "<string>",
      "address": "<string>",
      "city": "<string>",
      "province": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "phone": "<string>",
      "email": "<string>"
    }
  ],
  "error": "<string>",
  "message": "<string>"
}

Autorizzazioni

​
X-Api-Key
string
header
obbligatorio

Chiave API del ristorante. Può essere ottenuta da Strumenti > Accesso API nella dashboard xMenu.

Parametri della query

​
restuid
string

Identificatore univoco ristorante (non necessario con autenticazione via X-Client-Id)

​
visible
enum<integer>
predefinito:1

Filtro per soli locali visibili (0 = tutti, 1 = solo locali non nascosti)

Opzioni disponibili:
0,
1

Risposta

Risposta con elenco locali

​
success
boolean
obbligatorio

Risultato dell'operazione: true se ha avuto successo, false se è fallita

​
subrestaurants
object[]

Elenco locali (presente se success = true)

​
error
string

Codice errore se l'operazione è fallita.

Vedi Codici errore per i codici errore generali che possono verificarsi.

​
message
string

Descrizione leggibile dell'errore se l'operazione è fallita