☰ Μενού · Συμβάντα
Αναφορά API
Συμβάντα
Κάθε τύπος συμβάντος, τι τον προκαλεί και τι περιέχει το data.object.
JSON
{
"id": "evt_5a1f0c9e2b7d4e3f81a0c6d2",
"object": "event",
"type": "order.created",
"created": 1791310488,
"livemode": true,
"data": {
"object": {
"object": "order",
"id": "0c69a81c-0fbc-4333-b26c-789566b9bea4",
"number": 10,
"status": "new",
"table": "7",
...
}
}
}| Τύπος | Πότε στέλνεται | data.object |
|---|---|---|
| member.created | Ένας πελάτης εγγράφηκε μέσω του API, για παράδειγμα από ταμείο ή kiosk. | member |
| member.updated | Άλλαξε το προφίλ ή ο αριθμός κάρτας. | member |
| member.scanned | Μια συσκευή κάλεσε POST /v1/scans και το μέλος βρέθηκε. | scan |
| transaction.completed | Καταχωρίστηκε απόδειξη μέσω του API, από οποιαδήποτε σύνδεση της επιχείρησης. | transaction |
| transaction.voided | Ακυρώθηκε μια απόδειξη. | transaction |
| transaction.refunded | Επιστράφηκε μέρος μιας απόδειξης. | refund |
| balance.adjusted | Προστέθηκε ή αφαιρέθηκε cashback χειροκίνητα. | adjustment |
| visit.created | Καταγράφηκε επίσκεψη με POST /v1/visits. | visit |
| reward.unlocked | Συμπληρώθηκε μια κάρτα σφραγίδων. | reward |
| reward.redeemed | Δόθηκε μια επιβράβευση σφραγίδων. | reward |
| order.created | Ένας πελάτης έστειλε παραγγελία από το QR μενού. | order |
| order.updated | Μια παραγγελία άλλαξε κατάσταση. Περιέχει το previous_status. | order |
| menu.updated | Άλλαξαν πιάτα μέσω του API. | menu_change |
| test.ping | Πατήσατε Δοκιμή ή καλέσατε το endpoint δοκιμής. | ping |
Τα συμβάντα στέλνονται για αλλαγές που γίνονται μέσω του API. Οι αλλαγές από την εφαρμογή ταμείου της ίδιας της επιχείρησης δεν στέλνονται ακόμη· διαβάστε τες με GET /v1/members/{member}/history. Θα προστεθούν περισσότεροι τύποι. Αγνοήστε τους τύπους που δεν γνωρίζετε. Η παράδοση, οι υπογραφές και οι επαναλήψεις περιγράφονται στον οδηγό Webhooks.