DEPRECATED API PLANNED FOR Q42023
Migrating from Order API v2
Récupère la liste des commandes du restaurant

Permet de récupérer la liste des commandes du restaurant

Attention : les prix sont en centimes

Order

AttributTypeNullable ?Commentaires
idEntier (Unique)NONId de la commande
externalIdStringOUIID externe (potentiellement celui du partenaire)
prefixDeviceStringOUIPréfixe du device qui a créé la commande
numberEntierNONNuméro de la commande (pas forcément unique)
nameString (MaxLenght: 32)OUINom de la commande
statusStringNONValeur possibles :
"CANCELED", "IN_PROGRESS", "CLOSED"
nbCustomersEntierNONNombre de couverts
commentStringOUICommentaire sur la commande
openDateDate (Format: "yyyy-mm-dd hh:mm:ss")NONDate de la commande (Exemple: "2014-12-31 23:59:59")

Default: NOW()
tableIdEntierOUIId de la table
waiterIdEntierOUIId de la waiter
waiterNameStringOUINom du serveur
currentBillEntierNONMontant total de la commande
currentPayedAmountEntierNONMontant total déjà payé
isPrinterBoolean-Est-ce que le ticket à déjà été imprimé
typeEntierNONType de la commande (bitmask)
1 => ORDER
2 => BOOKING
isBookingBoolean-Est-ce que la commande est (ou était) une réservation
linesListe de OrderLine-Ligne de commandes (produits, prix, quantité, ...)
paymentsListe de Payment-Paiements
customerCustomer-Compte du client

OrderLine

AttributTypeNullable ?Commentaires
idEntier (Unique)NONId de la ligne
productIdEntierOUIId du produit
quantityEntierNONQuantité
nameString (MaxLenght: 31)NONNom du produit
priceEntierNONPrix du total de la ligne en centimes (généralement prix du produit x quantité)
discountAmountEntierNONMontant de la remise sur le produit (min: 0, max: price)
taxDecimal (2,2)NONTVA de la ligne
commentString (MaxLenght: 255)OUICommentaire de la ligne
statusStringNONStatus de la ligne. Valeurs possibles:
"CANCELED", "DELETED", "WAITING", "IN_PROGRESS", "DONE"
dateDateNONDate de la ligne (Exemple: "2014-12-31 23:59:59")

Default: NOW()
positionEntierOUIPosition de la ligne par rapport a son envoie (optionnel)
extraLinesListe de OrderExtraLine-Extras (suppléments et options)
nbPayedEntierNONQuantité de la ligne payée

OrderExtraLine

AttributTypeNullable ?Commentaire
idEntier (Unique)NONId de la ligne d'extra
extraIdEntierOUIId de l'extra
nameString (MaxLenght: 31)NONNom de l'extra
priceEntierNONPrix de l'exta
taxDecimal (2,2)NONTax de l'extra

Payment

AttributTypeNullable ?Commentaires
idEntier (Unique)NONId du paiement
amountEntierNONMontant du paiement en centimes
typeStringNONType du paiement. Valeurs possibles (peut être modifié) :
"CASH", "CASH_BACK", "CARD", "BANK_CHECK", "TICKET_RESTAURANT", "DISCOUNT"
statusStringNON"REFUSED", "ACCEPTED", "CANCELED"
dateDate (Format: "yyyy-mm-dd hh:mm:ss")NONDate du paiement.
Default: NOW()
deviceIdEntierOUIId du device qui a effectué ou modifié le paiement
Language
Click Try It! to start a request and see the response here!