Vai al contenuto principale
POST
/
coupon
/
apply
Applica coupon
curl --request POST \
  --url https://app.xmenu.it/api/coupon/apply \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "message": "<string>",
  "coupon": {
    "code": "<string>",
    "discount_perc": 123,
    "quantity": 123,
    "order_min": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "valid_weekdays": [
      3
    ],
    "valid_email": "<string>"
  },
  "order": {
    "discount": 123,
    "total": 123
  }
}

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
obbligatorio

Identificatore univoco ristorante

​
code
string
obbligatorio

Codice del coupon da riscattare

​
total
number
obbligatorio

Importo totale dell'ordine su cui applicare il coupon

Risposta

Risposta applicazione coupon

​
success
boolean
obbligatorio

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

​
error
string

Codice errore se l'operazione è fallita. Valori possibili:

  • NOT_FOUND = Coupon non trovato
  • CANNOT_APPLY = Impossibile riscattare il coupon (non esistente o non valido - vedi campo message per dettagli)

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

​
message
string

Descrizione leggibile dell'errore se l'operazione è fallita

​
coupon
object

Oggetto coupon con dettagli sul codice sconto

​
order
object

Risultato dell'applicazione di un coupon a un ordine