Applica coupon - xMenu API Doc

POST

/

coupon

/

apply

Applica coupon

curl --request POST \
  --url https://app.xmenu.it/api/coupon/apply \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'POST', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://app.xmenu.it/api/coupon/apply', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.xmenu.it/api/coupon/apply",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.xmenu.it/api/coupon/apply"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.xmenu.it/api/coupon/apply")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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

Show child attributes

order

object

Risultato dell'applicazione di un coupon a un ordine

Show child attributes

Applica coupon

curl --request POST \
  --url https://app.xmenu.it/api/coupon/apply \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'POST', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://app.xmenu.it/api/coupon/apply', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.xmenu.it/api/coupon/apply",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.xmenu.it/api/coupon/apply"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.xmenu.it/api/coupon/apply")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
  }
}