Gett Commerce Partner API
Gett Commerce Partner API
API for Commerce Partners (POS, Aggregators, Online Ordering Solutions) to integrate with the Gett Network.
Data Flow
Your system is the source of truth for catalogs; Gett is the source of truth for order creation.
| Data | Source of Truth | Direction | API |
|---|---|---|---|
| Catalog / Menu | Partner | Partner → Gett | POST /catalogset-notification |
| Order Creation | Gett | Gett → Partner | Webhooks (validateOrder, placeOrder) |
Integration Lifecycle
- Sync Catalog — Host CatalogSet JSON, notify Gett when menus change (pull model)
- Receive Orders — Implement webhook endpoints for order validation and placement
- Manage Store Status — Pause and resume stores via the API as availability changes
Order Webhooks
Gett POSTs two signed webhooks (Standard Webhooks signature + an Idempotency-Key) to your Webhook Base URL:
{baseUrl}/validate— price & availability check. Respond with the order including server-computedamountsand anyerrors.{baseUrl}/place— place the order. When Gett tokenizes the customer's saved card on your behalf, the body carries apaymentToken— a single-use payment-method nonce (e.g. a Braintree nonce) for you to charge with your own processor account. It is omitted when you tokenize the card on your side.
Authentication
Include your API key in all requests via the Authorization header using the Bearer scheme:
Code
Setup Prerequisites
- API Key — Gett provisions your partner account and issues your first API key during onboarding (contact Partner Support); it is not self-serve. Manage and rotate keys in the Developer Portal afterward.
- Webhook Base URL — Where you host your order validation and placement endpoints
Tags
Catalog
Catalog synchronization using a pull model. You host the CatalogSet JSON on a publicly accessible URL (e.g., S3, CloudFront), then notify Gett when it changes. Gett asynchronously downloads and processes the update.
The CatalogSet format is identical to the Marketfront API — a normalized dictionary structure with catalogs, sections, items, and modifier groups.
Best practices:
- Treat every push as a full replacement (no partial patches)
- Keep item IDs stable across updates to preserve analytics and favorites
- Validate your JSON against the schema before notifying — invalid references cause ingestion failures
Store Status
Pause and resume individual stores. Pausing removes a store from discovery and rejects new orders until it resumes; supply a future UTC
resumeAt to schedule an automatic resume, or omit it to pause indefinitely.
Fulfillment capability (delivery/pickup) and operating hours are not set here — hours travel in your CatalogSet, and delivery/pickup flags are configured per store by Gett.Webhooks
catalogSyncFailed
Catalog Sync Failed
POST
catalogSyncSucceeded
Catalog Sync Succeeded
POST
placeOrder
Place Order
POST
validateOrder
Validate Order
POST