Vai al contenuto principale

Riferimento API

API degli ordini

API degli ordini

L'API degli ordini gestisce la creazione degli ordini (pubblica, per i clienti) e la gestione degli ordini (autenticata, per i ristoratori). Il componente aggiuntivo Ordering Suite deve essere attivo per il ristorante.

POST /api/orders

Crea un nuovo ordine. È un endpoint pubblico utilizzato dai clienti che ordinano dal menu.

Autenticazione: pubblica (nessun token richiesto)

Limite di frequenza: 5 richieste al minuto per IP

Corpo della richiesta

{
  "restaurantId": "uuid",
  "tableId": "uuid",
  "items": [
    {
      "menuItemId": "uuid",
      "quantity": 2
    },
    {
      "menuItemId": "uuid",
      "quantity": 1
    }
  ]
}

Risposta (201 Created)

{
  "success": true,
  "data": {
    "id": "uuid",
    "status": "PENDING",
    "tableLabel": "Table 5",
    "items": [...],
    "createdAt": "2026-02-19T14:30:00Z"
  }
}

GET /api/orders

Recupera tutti gli ordini del suo ristorante. Supporta il filtro per stato.

Autenticazione: obbligatoria (token Bearer)

Parametri di query

  • status — Filtra per stato dell'ordine (ad es. ?status=PENDING)

Risposta (200 OK)

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "status": "PENDING",
      "tableLabel": "Table 5",
      "items": [...],
      "createdAt": "2026-02-19T14:30:00Z"
    }
  ]
}

GET /api/orders/[id]

Recupera un singolo ordine. Questo endpoint supporta un accesso in doppia modalità:

  • Autenticato (titolare): restituisce i dati completi dell'ordine, inclusi tutti i campi.
  • Pubblico (cliente): restituisce un numero limitato di campi (stato, articoli, etichetta del tavolo). Richiede il parametro di query restaurantId.

PATCH /api/orders/[id]

Aggiorna lo stato di un ordine. Utilizzato dai ristoratori per far avanzare gli ordini lungo il ciclo di vita.

Autenticazione: obbligatoria (token Bearer)

Corpo della richiesta

{
  "status": "CONFIRMED"
}

Transizioni di stato valide: da PENDING a CONFIRMED, da CONFIRMED a PREPARING, da PREPARING a READY, da READY a SERVED. Gli ordini possono essere impostati su CANCELLED a partire da PENDING o CONFIRMED.