canonical: https://jentic.com/apis/flipdish.com/flipdish

# Flipdish API

The Flipdish API powers the Flipdish online ordering platform for restaurant and quick-service brands. It manages organizations, brands, properties (individual restaurant locations), sales channels (web, app, kiosk), menus, opening hours, VAT settings, audit logs, and webhooks. Menu management supports versioned menus, snoozes for temporarily unavailable items, and per-property publishing so a single brand can roll out menu changes location by location.

## For AI agents

Manage Flipdish brands, restaurant properties, sales channels, menus, opening hours, and webhooks for online ordering operations.

## Scope

Does not handle payment processing, delivery driver dispatch, or POS hardware - use for restaurant brand, property, sales-channel, menu, and webhook management only.

## Capabilities

- Create and update organizations, brands, and individual restaurant properties
- Publish or unpublish sales channels for web, app, and kiosk ordering on a per-property basis
- Manage versioned menus and roll out changes by promoting a draft menu to current
- Snooze and un-snooze menu items when ingredients run out without deleting them
- Configure opening hours and VAT rules per property to keep tax and availability accurate
- Read audit logs to track who changed which property, brand, or menu and when
- Register and manage webhooks to receive event notifications for orders and menu changes

## Use cases

### Multi-location menu rollout

Restaurant chains use the menu management endpoints to promote a draft menu to current for individual properties or for an entire brand. The `/menumanagement/orgs/{orgId}/menus/{menuId}/current` endpoint controls which version is live, and snoozes pause specific items at a single property without editing the master menu. This supports coordinated rollouts where a new menu launches at one location ahead of others.

Example prompt: Promote draft menu M42 to current for the Dublin property and snooze item ID 99 for the next 4 hours

### Restaurant property and channel onboarding

Operations teams onboard new restaurant locations by creating a property under an existing brand, configuring opening hours and VAT, and publishing sales channels for web, app, and kiosk ordering. The `/orgManagement/orgs/{orgId}/properties` endpoints handle the property lifecycle, while the salesChannels sub-resource publishes or archives each ordering surface.

Example prompt: Create a new property under brand B12 with opening hours and VAT, then publish web and app sales channels

### Order webhook integration

Restaurant ops platforms register webhooks against the Flipdish API to receive order events as they happen, then route them into kitchen displays, delivery dispatch, and analytics dashboards. The Webhooks tag exposes registration and management endpoints so subscriptions can be added, paused, or rotated when secrets change.

Example prompt: Register a webhook against order-created events for org O1 and store the secret in our vault

### AI agent restaurant operations assistant

An AI ops agent uses Flipdish through Jentic to react to live operating decisions: snoozing menu items when stock runs out, adjusting opening hours when a kitchen closes early, and listing audit-log entries when staff want to know who made a change. Jentic returns the right Flipdish operation per intent across the 49-endpoint surface.

Example prompt: Snooze menu item ID 504 across all properties of brand B7 until 23:00 tonight and post the audit log of all snoozes today

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/orgManagement/orgs/{orgId}/properties` | Create a new restaurant property |
| POST | `/orgManagement/orgs/{orgId}/properties/{propertyId}/salesChannels/{salesChannelId}/publish` | Publish a sales channel for a property |
| GET | `/menumanagement/orgs/{orgId}/menus/published` | List published menus |
| POST | `/menumanagement/orgs/{orgId}/menus/{menuId}/current` | Promote a menu version to current |
| POST | `/menumanagement/orgs/{orgId}/menus/{menuId}/snoozes` | Snooze a menu item temporarily |
| PUT | `/orgManagement/orgs/{orgId}/properties/{propertyId}/openingHours` | Update property opening hours |
| PUT | `/orgManagement/orgs/{orgId}/properties/{propertyId}/vat` | Update VAT settings for a property |

## Key resources

- **Orgs** — Top-level organization records that own brands, properties, and menus
- **Brands** — Restaurant brands that contain one or more physical properties
- **Properties** — Individual restaurant locations with opening hours, VAT, and sales channels
- **Sales Channels** — Per-property web, app, and kiosk ordering surfaces
- **Menus** — Versioned menu records, current-menu promotion, and per-item snoozes
- **Webhooks** — Subscriptions that deliver order and menu events to external systems
- **Audit** — Audit log entries for brand, property, and menu changes

## Why Jentic

- **Setup:** Wiring the Flipdish API by hand means running its OAuth2 flow for scoped tokens, walking the orgManagement and menumanagement path hierarchies across 49 endpoints, and handling retries yourself. Through Jentic you install once, import Flipdish from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Flipdish puts the org id in the URL path (`/orgManagement/orgs/{orgId}/...`), so a rule can pin your agent to one org: it can read that org's published menus and nothing else. You choose the operations it may call, so actions like publishing a sales channel or updating VAT are not included unless you add them.
- **Credential handling:** Your Flipdish OAuth2 credential is stored once, encrypted, by your own Jentic One instance and exchanged for a scoped access token at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'snooze a menu item' or 'get the published menu', and Jentic returns the matching Flipdish operation with its input schema so the agent calls the right endpoint without navigating the orgManagement and menumanagement hierarchies.

## Related APIs

- **Shopify Admin API** — Shopify is a general e-commerce platform rather than a restaurant-specific ordering system
- **Square API** — Square offers POS and ordering features for restaurants and retail
- **Stripe API** — Stripe processes the payment that a Flipdish order generates

## FAQ

### What authentication does the Flipdish API use?

The Flipdish API uses OAuth 2.0. Through Jentic, the OAuth client credentials are stored in the encrypted vault and exchanged for short-lived access tokens at execution time.

### Can I snooze a menu item with the Flipdish API?

Yes. POST to `/menumanagement/orgs/{orgId}/menus/{menuId}/snoozes` to mark an item as temporarily unavailable, and call `/menumanagement/orgs/{orgId}/menus/{menuId}/un-snoozes` to bring it back.

### How do I publish a new menu to a single restaurant property?

Promote the menu version using POST `/menumanagement/orgs/{orgId}/menus/{menuId}/current` scoped to the target property, then publish the relevant sales channels with `/orgManagement/orgs/{orgId}/properties/{propertyId}/salesChannels/{salesChannelId}/publish.`

### What are the rate limits for the Flipdish API?

Flipdish does not document a fixed rate limit in the spec. Limits are applied per organization and per token. Treat 429 responses as the source of truth and back off using the Retry-After header.

### How do I publish a sales channel through Jentic?

Search Jentic for 'publish a Flipdish sales channel', load the schema for `/orgManagement/orgs/{orgId}/properties/{propertyId}/salesChannels/{salesChannelId}/publish`, and execute. Install with pip install jentic and run it through Jentic One, the self-hosted execution layer.

### Can I receive order events as webhooks?

Yes. The Webhooks endpoints register and manage subscriptions for events such as new orders and menu updates, with the subscription secret rotated through the same endpoints.

### Can I limit what my agent is allowed to do with the Flipdish API?

Yes. Because you run Jentic One yourself and it is self-hosted, your own rules decide which Flipdish operations and credentials the agent may use. Since Flipdish carries the org id in the URL path (`/orgManagement/orgs/{orgId}/...`), a rule can pin the agent to a single organization so it only reads that org's published menus and nothing else. You choose the operations it may call, so write actions such as promoting a menu to current, publishing a sales channel, or updating VAT are excluded unless you explicitly add them.