Skip to main content
GET
Elenco categorie

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)

page
integer
obbligatorio

Numero di pagina da recuperare

Intervallo richiesto: x >= 1
pagesize
integer
predefinito:100

Numero di risultati per pagina (max: 100)

Intervallo richiesto: 1 <= x <= 100
visible
enum<integer>
predefinito:1

Filtro per sole categorie visibili (0 = tutte, 1 = solo categorie non nascoste)

Opzioni disponibili:
0,
1
q
string

Query di ricerca per filtrare le categorie per nome

Risposta

Risposta con elenco categorie

success
boolean
obbligatorio

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

page
integer
obbligatorio

Numero di pagina corrente

pagesize
integer
obbligatorio

Numero massimo di elementi per pagina

total_count
integer
obbligatorio

Numero totale di risultati disponibili

more
boolean
obbligatorio

Indica se sono disponibili altre pagine

error
string

Codice errore se l'operazione è fallita.

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

message
string

Descrizione leggibile dell'errore se l'operazione è fallita

categories
object[]

Elenco categorie