Complete reference for the Zippin Cloud API and Gateway API used by the store.
| Method | Endpoint | Description |
|---|
| GET | /v2/stores/:id/qr | Generate QR code for store entry |
| GET | /v2/stores/:id/skus | List all SKUs for a store |
| GET | /v2/stores/:id/categories | Product categories |
| GET | /v2/stores/:id/shelves | Shelf configuration and planogram |
| GET | /v2/stores/:id/carts | Active and recent carts |
| GET | /v2/stores/:id/carts/:cartId | Cart details with items |
| GET | /v2/stores/:id/sessions | Active shopping sessions |
| POST | /v2/stores/:id/entry | Request store entry authorization |
| POST | /v2/stores/:id/charges | Submit charges for processed cart |
| Method | Endpoint | Description |
|---|
| GET | /api/status | RPi status, door state, card reader |
| GET | /api/occupancy | Current count, max capacity |
| GET | /api/stats?period=1h | Entries, denied, latency, peak occupancy |
| GET | /api/alerts | Active alerts on RPi |
| GET | /api/metrics | Prometheus-format metrics |
| GET | /api/config | RPi configuration and version |
| Event | Direction | Description |
|---|
| Cart Submission | Zippin → Receipt API | Cart finalized, items listed, charges submitted |
| Entry Notification | RPi → Zippin Cloud | User scanned badge, authorization requested |
| QR Validation | RPi → Zippin Cloud | QR code scanned and validated for entry |
| Watchdog Heartbeat | RPi → Zippin Cloud | Periodic health signal from gateway |
