Getting Started with the Commerce API

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

1. Catalog Notification: Notify us when a menu changes for a store.
2. Catalog Pull: We download the CatalogSet from your URL.
3. Order Placement: We call your placeOrder webhook when a customer pays.
4. Order Updates: You send status updates as orders progress.
5. Store Status: Pause/resume stores in real-time.

Setup Prerequisites

1. API Key: We issue you a key to authenticate your calls.
2. Webhook Base URL: Where you host your order endpoints.

Authentication

Include your API Key in all requests:

X-API-Key: YOUR_API_KEY

What's Next

• Order Booster Onboarding — Register stores
• Catalog Integration — Menu sync
• Order Webhooks — Receiving orders
• Order Status Updates — Sending updates
• Store Management — Pause/resume