Anteprima ordine

POST

order

preview

Anteprima ordine

curl --request POST \
  --url https://app.xmenu.it/api/order/preview \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "client": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "phone": "<string>"
  },
  "dmethod": "<string>",
  "details": [
    {
      "product": {
        "uid": "<string>"
      },
      "quantity": 123,
      "notes": "<string>",
      "options": [
        {
          "uid": "<string>",
          "values": [
            {
              "uid": "<string>",
              "quantity": 123
            }
          ]
        }
      ]
    }
  ],
  "subrestaurant_uid": "<string>",
  "language": "<string>",
  "payment_method_sub": "<string>",
  "notes": "<string>"
}
'

import requests

url = "https://app.xmenu.it/api/order/preview"

payload = {
    "client": {
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>",
        "phone": "<string>"
    },
    "dmethod": "<string>",
    "details": [
        {
            "product": { "uid": "<string>" },
            "quantity": 123,
            "notes": "<string>",
            "options": [
                {
                    "uid": "<string>",
                    "values": [
                        {
                            "uid": "<string>",
                            "quantity": 123
                        }
                    ]
                }
            ]
        }
    ],
    "subrestaurant_uid": "<string>",
    "language": "<string>",
    "payment_method_sub": "<string>",
    "notes": "<string>"
}
headers = {
    "X-Client-Id": "<api-key>",
    "X-Client-Secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-Id': '<api-key>',
    'X-Client-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    client: {
      first_name: '<string>',
      last_name: '<string>',
      email: '<string>',
      phone: '<string>'
    },
    dmethod: '<string>',
    details: [
      {
        product: {uid: '<string>'},
        quantity: 123,
        notes: '<string>',
        options: [{uid: '<string>', values: [{uid: '<string>', quantity: 123}]}]
      }
    ],
    subrestaurant_uid: '<string>',
    language: '<string>',
    payment_method_sub: '<string>',
    notes: '<string>'
  })
};

fetch('https://app.xmenu.it/api/order/preview', 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/order/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'client' => [
        'first_name' => '<string>',
        'last_name' => '<string>',
        'email' => '<string>',
        'phone' => '<string>'
    ],
    'dmethod' => '<string>',
    'details' => [
        [
                'product' => [
                                'uid' => '<string>'
                ],
                'quantity' => 123,
                'notes' => '<string>',
                'options' => [
                                [
                                                                'uid' => '<string>',
                                                                'values' => [
                                                                                                                                [
                                                                                                                                                                                                                                                                'uid' => '<string>',
                                                                                                                                                                                                                                                                'quantity' => 123
                                                                                                                                ]
                                                                ]
                                ]
                ]
        ]
    ],
    'subrestaurant_uid' => '<string>',
    'language' => '<string>',
    'payment_method_sub' => '<string>',
    'notes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Client-Id: <api-key>",
    "X-Client-Secret: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.xmenu.it/api/order/preview"

	payload := strings.NewReader("{\n  \"client\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"dmethod\": \"<string>\",\n  \"details\": [\n    {\n      \"product\": {\n        \"uid\": \"<string>\"\n      },\n      \"quantity\": 123,\n      \"notes\": \"<string>\",\n      \"options\": [\n        {\n          \"uid\": \"<string>\",\n          \"values\": [\n            {\n              \"uid\": \"<string>\",\n              \"quantity\": 123\n            }\n          ]\n        }\n      ]\n    }\n  ],\n  \"subrestaurant_uid\": \"<string>\",\n  \"language\": \"<string>\",\n  \"payment_method_sub\": \"<string>\",\n  \"notes\": \"<string>\"\n}")

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

	req.Header.Add("X-Client-Id", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.xmenu.it/api/order/preview")
  .header("X-Client-Id", "<api-key>")
  .header("X-Client-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"client\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"dmethod\": \"<string>\",\n  \"details\": [\n    {\n      \"product\": {\n        \"uid\": \"<string>\"\n      },\n      \"quantity\": 123,\n      \"notes\": \"<string>\",\n      \"options\": [\n        {\n          \"uid\": \"<string>\",\n          \"values\": [\n            {\n              \"uid\": \"<string>\",\n              \"quantity\": 123\n            }\n          ]\n        }\n      ]\n    }\n  ],\n  \"subrestaurant_uid\": \"<string>\",\n  \"language\": \"<string>\",\n  \"payment_method_sub\": \"<string>\",\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.xmenu.it/api/order/preview")

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

request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"client\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"dmethod\": \"<string>\",\n  \"details\": [\n    {\n      \"product\": {\n        \"uid\": \"<string>\"\n      },\n      \"quantity\": 123,\n      \"notes\": \"<string>\",\n      \"options\": [\n        {\n          \"uid\": \"<string>\",\n          \"values\": [\n            {\n              \"uid\": \"<string>\",\n              \"quantity\": 123\n            }\n          ]\n        }\n      ]\n    }\n  ],\n  \"subrestaurant_uid\": \"<string>\",\n  \"language\": \"<string>\",\n  \"payment_method_sub\": \"<string>\",\n  \"notes\": \"<string>\"\n}"

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

{
  "success": true,
  "error": "<string>",
  "message": "<string>",
  "order": {
    "total": 123,
    "delivery_fee": 123,
    "pickup_date": "2023-11-07T05:31:56Z",
    "delivery_date": "2023-11-07T05:31:56Z",
    "coupon": {
      "code": "<string>",
      "description": "<string>",
      "discount": 123,
      "auto": true
    }
  }
}

write:orders

Autorizzazioni

X-Client-Id

string

header

obbligatorio

Client ID per l'autenticazione API Client (deve essere usato insieme al Client Secret)

X-Client-Secret

string

header

obbligatorio

Client Secret per l'autenticazione API Client (deve essere usato insieme al Client ID)

Corpo

application/json

client

object

obbligatorio

Show child attributes

dmethod

string

obbligatorio

Modalità di consegna:

0 = ritiro presso il punto vendita
1 = consegna a domicilio
0t = al tavolo
20 = ritiro presso punto di ritiro
0e-{id} = evento (dove {id} è l'ID dell'evento)
dcf-{id} = modalità personalizzata (dove {id} è l'ID della modalità)

payment_method

enum<string>

obbligatorio

Metodo di pagamento:

cash = contanti
invoice = fattura
external = gestito esternamente

Opzioni disponibili:

cash,

invoice,

external

details

object[]

obbligatorio

Articoli dell'ordine (prodotti con quantità/opzioni)

Show child attributes

subrestaurant_uid

string

Identificatore punto vendita. Obbligatorio per ristoranti multi-locale

language

string

Codice lingua ISO 639-1; di default viene utilizzato quello impostato nelle impostazioni del ristorante

pickup

object

Dati ritiro. Obbligatorio per dmethod=0

Show child attributes

delivery

object

Dati consegna. Obbligatorio per dmethod=1

Show child attributes

payment_method_sub

string

Sotto-metodo di pagamento. Obbligatorio se payment_method=cash

coupon

object

Coupon da applicare all'ordine.

Show child attributes

notes

string

Note generali ordine

creator

enum<string>

Origine ordine:

customer = ordine online effettuato dal cliente (default)
restaurant = ordine telefonico gestito dal ristorante per conto del cliente

Opzioni disponibili:

customer,

restaurant

Risposta

Risposta anteprima ordine

success

boolean

obbligatorio

Risultato dell'operazione: true se l'ordine è valido, false se è fallita

error

string

Codice errore se la validazione è fallita (stessi codici della creazione ordine, esclusi quelli generati durante l'inoltro dell'ordine). Valori possibili:

VALIDATION_ERROR = i dati della richiesta non hanno superato la validazione (parametri mancanti o non validi, orario di ritiro/consegna scelto non più disponibile, locale chiuso, importo minimo d'ordine non raggiunto, ...) - vedi il campo message per i dettagli
PRODUCT_NOT_FOUND = prodotto non trovato
PRODUCT_NOT_AVAILABLE = prodotto non disponibile
PRODUCT_ERROR = errore durante l'aggiunta del prodotto all'ordine - vedi il campo message per i dettagli
OPTION_VALUE_NOT_FOUND = valore opzione non trovato
INVALID_ADDRESS = indirizzo non valido, incompleto o non trovato
ADDRESS_NOT_SERVED = indirizzo fuori dalla zona di servizio
DELIVERY_NOT_AVAILABLE = servizio di consegna non disponibile
EXTERNAL_SERVICE_ERROR = il servizio esterno di geocodifica/calcolo distanze è temporaneamente non disponibile
COUPON_ERROR = errore di applicazione coupon
SUBRESTAURANT_NOT_FOUND = locale non trovato

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

message

string

Descrizione leggibile dell'errore se la validazione è fallita

order

object

Preventivo dell'ordine calcolato (presente solo se success = true). Nessun ordine viene creato.

Show child attributes

Anteprima ordine

curl --request POST \
  --url https://app.xmenu.it/api/order/preview \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "client": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "phone": "<string>"
  },
  "dmethod": "<string>",
  "details": [
    {
      "product": {
        "uid": "<string>"
      },
      "quantity": 123,
      "notes": "<string>",
      "options": [
        {
          "uid": "<string>",
          "values": [
            {
              "uid": "<string>",
              "quantity": 123
            }
          ]
        }
      ]
    }
  ],
  "subrestaurant_uid": "<string>",
  "language": "<string>",
  "payment_method_sub": "<string>",
  "notes": "<string>"
}
'

import requests

url = "https://app.xmenu.it/api/order/preview"

payload = {
    "client": {
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>",
        "phone": "<string>"
    },
    "dmethod": "<string>",
    "details": [
        {
            "product": { "uid": "<string>" },
            "quantity": 123,
            "notes": "<string>",
            "options": [
                {
                    "uid": "<string>",
                    "values": [
                        {
                            "uid": "<string>",
                            "quantity": 123
                        }
                    ]
                }
            ]
        }
    ],
    "subrestaurant_uid": "<string>",
    "language": "<string>",
    "payment_method_sub": "<string>",
    "notes": "<string>"
}
headers = {
    "X-Client-Id": "<api-key>",
    "X-Client-Secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-Id': '<api-key>',
    'X-Client-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    client: {
      first_name: '<string>',
      last_name: '<string>',
      email: '<string>',
      phone: '<string>'
    },
    dmethod: '<string>',
    details: [
      {
        product: {uid: '<string>'},
        quantity: 123,
        notes: '<string>',
        options: [{uid: '<string>', values: [{uid: '<string>', quantity: 123}]}]
      }
    ],
    subrestaurant_uid: '<string>',
    language: '<string>',
    payment_method_sub: '<string>',
    notes: '<string>'
  })
};

fetch('https://app.xmenu.it/api/order/preview', 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/order/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'client' => [
        'first_name' => '<string>',
        'last_name' => '<string>',
        'email' => '<string>',
        'phone' => '<string>'
    ],
    'dmethod' => '<string>',
    'details' => [
        [
                'product' => [
                                'uid' => '<string>'
                ],
                'quantity' => 123,
                'notes' => '<string>',
                'options' => [
                                [
                                                                'uid' => '<string>',
                                                                'values' => [
                                                                                                                                [
                                                                                                                                                                                                                                                                'uid' => '<string>',
                                                                                                                                                                                                                                                                'quantity' => 123
                                                                                                                                ]
                                                                ]
                                ]
                ]
        ]
    ],
    'subrestaurant_uid' => '<string>',
    'language' => '<string>',
    'payment_method_sub' => '<string>',
    'notes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Client-Id: <api-key>",
    "X-Client-Secret: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.xmenu.it/api/order/preview"

	payload := strings.NewReader("{\n  \"client\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"dmethod\": \"<string>\",\n  \"details\": [\n    {\n      \"product\": {\n        \"uid\": \"<string>\"\n      },\n      \"quantity\": 123,\n      \"notes\": \"<string>\",\n      \"options\": [\n        {\n          \"uid\": \"<string>\",\n          \"values\": [\n            {\n              \"uid\": \"<string>\",\n              \"quantity\": 123\n            }\n          ]\n        }\n      ]\n    }\n  ],\n  \"subrestaurant_uid\": \"<string>\",\n  \"language\": \"<string>\",\n  \"payment_method_sub\": \"<string>\",\n  \"notes\": \"<string>\"\n}")

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

	req.Header.Add("X-Client-Id", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.xmenu.it/api/order/preview")
  .header("X-Client-Id", "<api-key>")
  .header("X-Client-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"client\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"dmethod\": \"<string>\",\n  \"details\": [\n    {\n      \"product\": {\n        \"uid\": \"<string>\"\n      },\n      \"quantity\": 123,\n      \"notes\": \"<string>\",\n      \"options\": [\n        {\n          \"uid\": \"<string>\",\n          \"values\": [\n            {\n              \"uid\": \"<string>\",\n              \"quantity\": 123\n            }\n          ]\n        }\n      ]\n    }\n  ],\n  \"subrestaurant_uid\": \"<string>\",\n  \"language\": \"<string>\",\n  \"payment_method_sub\": \"<string>\",\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.xmenu.it/api/order/preview")

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

request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"client\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"dmethod\": \"<string>\",\n  \"details\": [\n    {\n      \"product\": {\n        \"uid\": \"<string>\"\n      },\n      \"quantity\": 123,\n      \"notes\": \"<string>\",\n      \"options\": [\n        {\n          \"uid\": \"<string>\",\n          \"values\": [\n            {\n              \"uid\": \"<string>\",\n              \"quantity\": 123\n            }\n          ]\n        }\n      ]\n    }\n  ],\n  \"subrestaurant_uid\": \"<string>\",\n  \"language\": \"<string>\",\n  \"payment_method_sub\": \"<string>\",\n  \"notes\": \"<string>\"\n}"

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

{
  "success": true,
  "error": "<string>",
  "message": "<string>",
  "order": {
    "total": 123,
    "delivery_fee": 123,
    "pickup_date": "2023-11-07T05:31:56Z",
    "delivery_date": "2023-11-07T05:31:56Z",
    "coupon": {
      "code": "<string>",
      "description": "<string>",
      "discount": 123,
      "auto": true
    }
  }
}

Panoramica

Notifiche ordini

Notifiche menu

Notifiche clienti

Azioni ordine

Azioni coupon

Info account

Consultazione menu

Importazione menu

Anagrafica clienti

Consultazione ordini

Inserimento ordine

Notifiche push (singolo invio)

Notifiche push

Autorizzazioni

Corpo

Risposta