get https://app.tillersystems.com/api/orders
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
| Attribut | Type | Nullable ? | Commentaires |
|---|---|---|---|
| id | Entier (Unique) | NON | Id de la commande |
| externalId | String | OUI | ID externe (potentiellement celui du partenaire) |
| prefixDevice | String | OUI | Préfixe du device qui a créé la commande |
| number | Entier | NON | Numéro de la commande (pas forcément unique) |
| name | String (MaxLenght: 32) | OUI | Nom de la commande |
| status | String | NON | Valeur possibles : "CANCELED", "IN_PROGRESS", "CLOSED" |
| nbCustomers | Entier | NON | Nombre de couverts |
| comment | String | OUI | Commentaire sur la commande |
| openDate | Date (Format: "yyyy-mm-dd hh:mm:ss") | NON | Date de la commande (Exemple: "2014-12-31 23:59:59") Default: NOW() |
| tableId | Entier | OUI | Id de la table |
| waiterId | Entier | OUI | Id de la waiter |
| waiterName | String | OUI | Nom du serveur |
| currentBill | Entier | NON | Montant total de la commande |
| currentPayedAmount | Entier | NON | Montant total déjà payé |
| isPrinter | Boolean | - | Est-ce que le ticket à déjà été imprimé |
| type | Entier | NON | Type de la commande (bitmask) 1 => ORDER 2 => BOOKING |
| isBooking | Boolean | - | Est-ce que la commande est (ou était) une réservation |
| lines | Liste de OrderLine | - | Ligne de commandes (produits, prix, quantité, ...) |
| payments | Liste de Payment | - | Paiements |
| customer | Customer | - | Compte du client |
OrderLine
| Attribut | Type | Nullable ? | Commentaires |
|---|---|---|---|
| id | Entier (Unique) | NON | Id de la ligne |
| productId | Entier | OUI | Id du produit |
| quantity | Entier | NON | Quantité |
| name | String (MaxLenght: 31) | NON | Nom du produit |
| price | Entier | NON | Prix du total de la ligne en centimes (généralement prix du produit x quantité) |
| discountAmount | Entier | NON | Montant de la remise sur le produit (min: 0, max: price) |
| tax | Decimal (2,2) | NON | TVA de la ligne |
| comment | String (MaxLenght: 255) | OUI | Commentaire de la ligne |
| status | String | NON | Status de la ligne. Valeurs possibles: "CANCELED", "DELETED", "WAITING", "IN_PROGRESS", "DONE" |
| date | Date | NON | Date de la ligne (Exemple: "2014-12-31 23:59:59") Default: NOW() |
| position | Entier | OUI | Position de la ligne par rapport a son envoie (optionnel) |
| extraLines | Liste de OrderExtraLine | - | Extras (suppléments et options) |
| nbPayed | Entier | NON | Quantité de la ligne payée |
OrderExtraLine
| Attribut | Type | Nullable ? | Commentaire |
|---|---|---|---|
| id | Entier (Unique) | NON | Id de la ligne d'extra |
| extraId | Entier | OUI | Id de l'extra |
| name | String (MaxLenght: 31) | NON | Nom de l'extra |
| price | Entier | NON | Prix de l'exta |
| tax | Decimal (2,2) | NON | Tax de l'extra |
Payment
| Attribut | Type | Nullable ? | Commentaires |
|---|---|---|---|
| id | Entier (Unique) | NON | Id du paiement |
| amount | Entier | NON | Montant du paiement en centimes |
| type | String | NON | Type du paiement. Valeurs possibles (peut être modifié) : "CASH", "CASH_BACK", "CARD", "BANK_CHECK", "TICKET_RESTAURANT", "DISCOUNT" |
| status | String | NON | "REFUSED", "ACCEPTED", "CANCELED" |
| date | Date (Format: "yyyy-mm-dd hh:mm:ss") | NON | Date du paiement. Default: NOW() |
| deviceId | Entier | OUI | Id du device qui a effectué ou modifié le paiement |
