Commerce API
Getting Started
The Commerce API allows Online Ordering Solutions, POS systems and other Commerce Platforms to act as a Menu Source and Order Destination for Gett.
Data Flow
Your system is the source of truth for catalogs, store status, and order updates. Gett is the source of truth only for order creation.
| Data | Source of Truth | Direction | API |
|---|---|---|---|
| Catalog / Menu | Partner | Partner → Gett | POST /catalogset-notification |
| Store Status | Partner | Partner → Gett | POST /stores/{id}/status |
| Order Creation | Gett | Gett → Partner | placeOrder webhook |
| Order Updates | Partner | Partner → Gett | POST /orders/{id}/status |
High-Level Flow
- Catalog Notification: Notify us when a menu changes for a store.
- Catalog Pull: We download the
CatalogSetfrom your URL. - Order Placement: We call your
placeOrderwebhook when a customer pays. - Order Updates: You send status updates as orders progress.
- Store Status: Pause/resume stores in real-time.
Setup Prerequisites
- API Key: We issue you a key to authenticate your calls.
- Webhook Base URL: Where you host your order endpoints.
Authentication
Include your API key in all requests via the Authorization header using the Bearer scheme:
Code
What's Next
- Catalog Integration — Menu sync
- Order Webhooks — Receiving orders
- Order Status Updates — Sending updates
- Store Management — Pause/resume