API Overview

The Flipdish API is a REST API that lets you programmatically manage orgs, menus, sales, store operations, audit logs, and webhooks on the Flipdish platform. The current API version is v3.0. Consumer Orders endpoints remain available on v1.0.

Base URL

All API requests should be made to:

https://api.flipdish.co

Authentication

The Flipdish API uses OAuth2 client credentials for authentication. See Getting Started with Flipdish API for a step-by-step walkthrough of creating your Flipdish App and obtaining an access token.

API Resources

Resource	Description	API Reference
Org Management	Create and manage orgs	View endpoints
Menu Management	Create, update, and publish menus	View endpoints
Sales	Query sales (orders that have been accepted by the kitchen)	View endpoints
Consumer Orders	Place and track customer orders (v1.0)	View endpoints
Operations Updates	Publish menus and manage store operations	View endpoints
Audit Logs	Query audit log entries	View endpoints
Webhook Subscriptions	Create and manage webhook subscriptions	View endpoints
Webhook Events	Event schemas for real-time notifications	View schemas

📘
Orders vs Sales
An order is the customer's request to buy; a sale is the merchant's accepted transaction. Once an order is accepted and committed for fulfilment, it becomes a sale — the record that operations, finance, and reporting systems use. Consumer Orders remain on v1.0; Sales endpoints are available on v3.0.

Common Integration Scenarios

Property, Brand and Sales Channel Management — Manage your org's properties, brands, and sales channels via the Org Management API.
Menu Management — Create and publish menus programmatically. See Menu Structure v3.0.
Webhooks — Receive real-time event notifications when things happen in your account. See Subscribe to Flipdish Events.
POS Integration — Receive orders, map menus, and sync with your point-of-sale system. See Build a POS Integration.

SDKs

v3.0 Client Libraries

Org Management (TypeScript/JavaScript) — @flipdish/orgmanagement

v1.0 Client Libraries (Consumer Orders)

These libraries cover the v1.0 API surface, including Consumer Orders endpoints:

.NET — NuGet package | GitHub
JavaScript — npm package | GitHub
TypeScript (Node.js) — npm package | GitHub

For installation and usage examples, see Flipdish SDK.

Error Handling

The API returns structured JSON error responses with errorMessage and errorCode fields, along with standard HTTP status codes. See Error Handling for response formats and status codes.

What's Next

Get credentials — Create your Flipdish App and request an access token.
Explore the API — Browse the interactive API Reference to see all available endpoints.
Set up webhooks — Subscribe to events to receive real-time notifications.
Build your integration — Follow a use-case guide for step-by-step instructions.

Need Help?

If you need assistance, email us at [email protected].