Vai al contenuto principale
POST
/
order
/
create
Creazione ordine
curl --request POST \
  --url https://app.xmenu.it/api/order/create \
  --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>",
  "payment_method": "cash",
  "details": [
    {
      "product": {
        "uid": "<string>"
      },
      "quantity": 123,
      "notes": "<string>",
      "options": [
        {
          "uid": "<string>",
          "values": [
            {
              "uid": "<string>",
              "quantity": 123
            }
          ]
        }
      ]
    }
  ],
  "subrestaurant_uid": "<string>",
  "language": "<string>",
  "pickup": {
    "date": "2023-11-07T05:31:56Z"
  },
  "delivery": {
    "date": "2023-11-07T05:31:56Z",
    "address": {
      "place_id": "<string>",
      "doorbell": "<string>",
      "floor": "<string>"
    }
  },
  "payment_method_sub": "<string>",
  "coupon": {},
  "notes": "<string>",
  "creator": "customer"
}
'
{
  "success": true,
  "error": "<string>",
  "message": "<string>",
  "order": {
    "uid": "<string>",
    "token": "<string>",
    "order_number": "<string>",
    "total": 123,
    "date": "2023-11-07T05:31:56Z",
    "confirmed": true,
    "delivery_fee": 123,
    "pickup_date": "2023-11-07T05:31:56Z",
    "delivery_date": "2023-11-07T05:31:56Z"
  }
}
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
​
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)

​
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

​
delivery
object

Dati consegna. Obbligatorio per dmethod=1

​
payment_method_sub
string

Sotto-metodo di pagamento. Obbligatorio se payment_method=cash

​
coupon
object

Applicazione codice sconto

​
notes
string

Note generali ordine

​
creator
enum<string>

Origine ordine:

  • customer = cliente (default)
  • restaurant = ristorante
Opzioni disponibili:
customer,
restaurant

Risposta

Risposta creazione ordine

​
success
boolean
obbligatorio

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

​
error
string

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

  • PRODUCT_NOT_FOUND = prodotto non trovato
  • PRODUCT_NOT_AVAILABLE = prodotto non disponibile
  • OPTION_NOT_FOUND = opzione non trovata
  • OPTION_VALUE_NOT_FOUND = valore opzione non trovato
  • INVALID_ADDRESS = indirizzo non valido o fuori zona
  • COUPON_ERROR = errore di applicazione coupon
  • SUBRESTAURANT_NOT_FOUND = locale non trovato

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

​
message
string

Descrizione leggibile dell'errore se l'operazione è fallita

​
order
object

Dati dell'ordine creato (presente solo se success = true)