Vai al contenuto principale
GET
/
menu
/
categories
Elenco categorie
curl --request GET \
  --url https://app.xmenu.it/api/menu/categories \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "page": 123,
  "pagesize": 123,
  "total_count": 123,
  "more": true,
  "error": "<string>",
  "message": "<string>",
  "categories": [
    {
      "uid": "<string>",
      "name": "<string>",
      "description": "<string>",
      "image": "<string>",
      "products_count": 123,
      "url": "<string>",
      "hidden": true,
      "position": 123,
      "subrestaurant_uids": [
        "<string>"
      ],
      "ext_id": "<string>",
      "options": [
        {
          "uid": "<string>",
          "name": "<string>",
          "short_name": "<string>",
          "type": "single",
          "min_selectable": 123,
          "max_selectable": 123,
          "max_quantity": 123,
          "note": "<string>",
          "hidden": true,
          "position": 123,
          "primary": true,
          "first_default": true,
          "show_caption": true,
          "print_caption": true,
          "subrestaurant_uids": [
            "<string>"
          ],
          "ext_id": "<string>",
          "option_values": [
            {
              "uid": "<string>",
              "name": "<string>",
              "short_name": "<string>",
              "price_operator": "+",
              "price_operand": 123,
              "hidden": true,
              "position": 123,
              "checked_default": true,
              "subrestaurant_uids": [
                "<string>"
              ],
              "ext_id": "<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)

​
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