Flipdish website screenshot

Flipdish

Flipdish is an online ordering and branded-app platform that gives restaurants and takeaways their own websites, mobile apps, kiosks, and order-management tools to take direct, commission-friendly orders. For developers and integration partners, Flipdish exposes a REST API (Flipdish Open API v1.0, base URL https://api.flipdish.co) documented in its Developer Hub, covering stores, orders, menus, catalog, customers, vouchers and campaigns, payouts and payments, apps and channels, devices, and platform resources, plus webhook/event subscriptions. Authentication uses OAuth 2.0 (implicit grant for first-party portal apps; client-credentials for server-to-server App Store apps). A Swagger specification at https://api.flipdish.co/swagger/docs/v1.0 and pre-generated SDKs (C#, Java, PHP, JavaScript, TypeScript, plus a SignalR realtime client) are published from the flipdishbytes GitHub org.

10 APIs 0 Features
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

APIs

Flipdish Apps & Channels API

Manage apps, mobile apps, App Store configurations, white-label config and builds, websites, and sales channels.

Flipdish Catalog API

Manage catalog groups, items, products, images, changes, and metafield definitions.

Flipdish Customers & Accounts API

Manage customers, platform users, teammates, accounts, and delivery drivers.

Flipdish Devices API

Manage card readers, kiosk and terminal IoT devices, and device heartbeats.

Flipdish Marketing API

Run marketing campaigns, vouchers, cross-sell, and push notifications.

Flipdish Menus API

Build and maintain menus, sections, items, option sets, zones, and nutrition information.

Flipdish Orders API

Retrieve, batch, and manage orders, tips, and fulfillment state configuration for online ordering.

Flipdish Payments & Payouts API

Handle payouts, payout reports, bank accounts, Stripe Custom Connect, invoices, payments, and subscriptions.

Flipdish Platform API

Cross-cutting platform surface: webhooks, events, OAuth clients, authorization tokens, audit logs, onboarding, features, and integrations.

Flipdish Stores API

Manage stores, store groups, locations, delivery zones, and store order capacity across a Flipdish brand.

Collections

Flipdish API - Apps

OPEN

Flipdish API - Catalog

OPEN

Flipdish API - Customers

OPEN

Flipdish API - Devices

OPEN

Flipdish API - Marketing

OPEN

Flipdish API - Menus

OPEN

Flipdish API - Orders

OPEN

Flipdish API - Payments

OPEN

Flipdish API - Platform

OPEN

Flipdish API - Stores

OPEN

Pricing Plans

Flipdish Plans Pricing

3 plans

PLANS

Rate Limits

Flipdish Rate Limits

2 limits

RATE LIMITS

FinOps

Flipdish Finops

FINOPS

Semantic Vocabularies

Flipdish Apps Context

30 classes · 273 properties

JSON-LD

Flipdish Catalog Context

27 classes · 33 properties

JSON-LD

Flipdish Customers Context

30 classes · 214 properties

JSON-LD

Flipdish Devices Context

14 classes · 35 properties

JSON-LD

Flipdish Marketing Context

27 classes · 98 properties

JSON-LD

Flipdish Menus Context

30 classes · 95 properties

JSON-LD

Flipdish Orders Context

30 classes · 163 properties

JSON-LD

Flipdish Payments Context

30 classes · 259 properties

JSON-LD

Flipdish Platform Context

30 classes · 520 properties

JSON-LD

Flipdish Stores Context

30 classes · 224 properties

JSON-LD

API Governance Rules

Flipdish API Rules

28 rules · 10 errors 11 warnings 7 info

SPECTRAL

JSON Structure

Apps App Config Sales Channel Structure

4 properties

JSON STRUCTURE

Apps App Config Update Model Structure

10 properties

JSON STRUCTURE

Apps App General Config Model Structure

15 properties

JSON STRUCTURE

Apps App Store App Configuration Structure

27 properties

JSON STRUCTURE

Apps App Store App Configuration Summary Structure

12 properties

JSON STRUCTURE

Apps App Store App Structure

23 properties

JSON STRUCTURE

Apps App Store App Summary Structure

10 properties

JSON STRUCTURE

Apps App Store App Support Info Structure

6 properties

JSON STRUCTURE

Apps App Store Config Model Structure

15 properties

JSON STRUCTURE

Apps App Structure

28 properties

JSON STRUCTURE

Apps Channel Structure

6 properties

JSON STRUCTURE

Apps Create App Store App Structure

18 properties

JSON STRUCTURE

Apps Execute Configuration Action Result Structure

4 properties

JSON STRUCTURE

Apps Field Group Structure

5 properties

JSON STRUCTURE

Apps Field Structure

10 properties

JSON STRUCTURE

Apps Firebase App Structure

4 properties

JSON STRUCTURE

Apps Index Page Base Structure

14 properties

JSON STRUCTURE

Apps Index Page Structure

16 properties

JSON STRUCTURE

Apps Mobile Apps Statistics Structure

9 properties

JSON STRUCTURE

Apps Mobile Apps Submission Details Structure

8 properties

JSON STRUCTURE

Apps Mobile Apps Submission Status Structure

9 properties

JSON STRUCTURE

Apps Mobile Apps Submission Structure

6 properties

JSON STRUCTURE

Apps Play Store Config Model Structure

13 properties

JSON STRUCTURE

Apps Stream Structure

8 properties

JSON STRUCTURE

Apps Supported Country Structure

10 properties

JSON STRUCTURE

Apps Update App Store App Structure

18 properties

JSON STRUCTURE

Apps Update Mobile Apps Submission Status Structure

6 properties

JSON STRUCTURE

Apps White Label Asset Model Structure

5 properties

JSON STRUCTURE

Apps White Label Color Scheme Model Structure

14 properties

JSON STRUCTURE

Apps White Label Config Model Structure

108 properties

JSON STRUCTURE

Catalog Catalog Group Reference Structure

4 properties

JSON STRUCTURE

Catalog Catalog Item Structure

11 properties

JSON STRUCTURE

Catalog Create Catalog Group Reference Structure

3 properties

JSON STRUCTURE

Catalog Create Catalog Item Structure

9 properties

JSON STRUCTURE

Catalog Create Group Reference Structure

2 properties

JSON STRUCTURE

Catalog Create Group Structure

9 properties

JSON STRUCTURE

Catalog Create Metafield Definition Structure

8 properties

JSON STRUCTURE

Catalog Create Product Reference Structure

3 properties

JSON STRUCTURE

Catalog Create Product Structure

9 properties

JSON STRUCTURE

Catalog Group Reference Structure

3 properties

JSON STRUCTURE

Catalog Group Structure

12 properties

JSON STRUCTURE

Catalog Metafield Definition Recommendation Structure

7 properties

JSON STRUCTURE

Catalog Metafield Definition Structure

8 properties

JSON STRUCTURE

Catalog Metafield Structure

2 properties

JSON STRUCTURE

Catalog Owner Entity Configuration Structure

2 properties

JSON STRUCTURE

Catalog Pending Menu Changes Structure

2 properties

JSON STRUCTURE

Catalog Pending Menu Changes Summaries Structure

2 properties

JSON STRUCTURE

Catalog Product Reference Structure

5 properties

JSON STRUCTURE

Catalog Product Structure

11 properties

JSON STRUCTURE

Catalog Publish Menu Changes Structure

2 properties

JSON STRUCTURE

Catalog Update Catalog Group Reference Structure

3 properties

JSON STRUCTURE

Catalog Update Catalog Item Structure

8 properties

JSON STRUCTURE

Catalog Update Group Reference Structure

2 properties

JSON STRUCTURE

Catalog Update Group Structure

8 properties

JSON STRUCTURE

Catalog Update Metafield Definition Structure

3 properties

JSON STRUCTURE

Catalog Update Product Reference Structure

3 properties

JSON STRUCTURE

Catalog Update Product Structure

8 properties

JSON STRUCTURE

Customers Account Detail Base Structure

6 properties

JSON STRUCTURE

Customers Account Detail Structure

11 properties

JSON STRUCTURE

Customers App Install Structure

10 properties

JSON STRUCTURE

Customers Channel Structure

6 properties

JSON STRUCTURE

Customers Create Account Model Structure

6 properties

JSON STRUCTURE

Customers Create User Delivery Location Request Structure

8 properties

JSON STRUCTURE

Customers Customer Structure

7 properties

JSON STRUCTURE

Customers Customer Summary Structure

6 properties

JSON STRUCTURE

Customers Delivery Location Structure

7 properties

JSON STRUCTURE

Customers Language Structure

4 properties

JSON STRUCTURE

Customers Order Batch Summary Structure

4 properties

JSON STRUCTURE

Customers Order Drop Off Location Structure

6 properties

JSON STRUCTURE

Customers Order Item Option Structure

10 properties

JSON STRUCTURE

Customers Order Item Structure

14 properties

JSON STRUCTURE

Customers Order Structure

53 properties

JSON STRUCTURE

Customers Order Voucher Summary Structure

7 properties

JSON STRUCTURE

Customers Password Reset Model Structure

5 properties

JSON STRUCTURE

Customers Payment Account Structure

9 properties

JSON STRUCTURE

Customers Pending Invitation Structure

4 properties

JSON STRUCTURE

Customers Store Summary Structure

14 properties

JSON STRUCTURE

Customers Teammate Base Structure

4 properties

JSON STRUCTURE

Customers Teammate Structure

11 properties

JSON STRUCTURE

Customers User Delivery Location Admin Structure

10 properties

JSON STRUCTURE

Customers User Info Structure

27 properties

JSON STRUCTURE

Customers User Monthly Commission Structure

5 properties

JSON STRUCTURE

Customers User Note Structure

7 properties

JSON STRUCTURE

Customers User Order Summary Structure

11 properties

JSON STRUCTURE

Customers User Search Structure

9 properties

JSON STRUCTURE

Customers User Sms Chat Item Structure

5 properties

JSON STRUCTURE

Customers User White Label Config Structure

5 properties

JSON STRUCTURE

Devices Bluetooth Terminal Status Structure

7 properties

JSON STRUCTURE

Devices Card Reader Registration Request Structure

2 properties

JSON STRUCTURE

Devices Card Reader Structure

8 properties

JSON STRUCTURE

Devices Client Device Assign Enrolled Device Structure

2 properties

JSON STRUCTURE

Devices Client Device Enroll Structure

3 properties

JSON STRUCTURE

Devices Client Device Structure

3 properties

JSON STRUCTURE

Devices Client Device Summary Structure

3 properties

JSON STRUCTURE

Devices Geo Point Request Structure

2 properties

JSON STRUCTURE

Devices Kiosk Entitlements Result Structure

2 properties

JSON STRUCTURE

Devices Reader Action State Info Structure

4 properties

JSON STRUCTURE

Devices Telemetry Series Property Structure

5 properties

JSON STRUCTURE

Devices Telemetry Series Query Parameters Structure

4 properties

JSON STRUCTURE

Devices Telemetry Series Result Structure

2 properties

JSON STRUCTURE

Devices Un Register Card Reader Request Structure

2 properties

JSON STRUCTURE

Marketing Campaign Statistics Structure

5 properties

JSON STRUCTURE

Marketing Create Pay Green Configuration Request Structure

4 properties

JSON STRUCTURE

Marketing Create Promotion Structure

2 properties

JSON STRUCTURE

Marketing Create Voucher Structure

29 properties

JSON STRUCTURE

Marketing Loyalty Campaign Structure

17 properties

JSON STRUCTURE

Marketing Percent Discount Details Structure

2 properties

JSON STRUCTURE

Marketing Promotion Award Structure

2 properties

JSON STRUCTURE

Marketing Promotion Details Structure

3 properties

JSON STRUCTURE

Marketing Push Notification Response Structure

5 properties

JSON STRUCTURE

Marketing Restaurant Voucher Assigned Store Structure

3 properties

JSON STRUCTURE

Marketing Restaurant Voucher Eligible Store Structure

2 properties

JSON STRUCTURE

Marketing Restaurant Voucher Pay Green Configuration Structure

4 properties

JSON STRUCTURE

Marketing Restaurant Voucher Pay Green Configuration Summary Structure

2 properties

JSON STRUCTURE

Marketing Restaurant Voucher Pay Green Store Configuration Structure

4 properties

JSON STRUCTURE

Marketing Retention Campaign Structure

16 properties

JSON STRUCTURE

Marketing Set Voucher Validity Periods Simplified Request Structure

3 properties

JSON STRUCTURE

Marketing Store Campaign Start Time Structure

2 properties

JSON STRUCTURE

Marketing Store List Item Structure

7 properties

JSON STRUCTURE

Marketing Update Pay Green Configuration Request Structure

2 properties

JSON STRUCTURE

Marketing Update Store Pay Green Configuration Request Structure

2 properties

JSON STRUCTURE

Marketing Update Voucher Structure

27 properties

JSON STRUCTURE

Marketing Update Voucher Usage Structure

3 properties

JSON STRUCTURE

Marketing Validity Period Structure

3 properties

JSON STRUCTURE

Marketing Voucher Data Point Structure

3 properties

JSON STRUCTURE

Marketing Voucher Structure

33 properties

JSON STRUCTURE

Marketing Voucher Summary Structure

9 properties

JSON STRUCTURE

Marketing Voucher With Stats Structure

38 properties

JSON STRUCTURE

Menus Allergen Structure

3 properties

JSON STRUCTURE

Menus Business Hours Period Base Structure

5 properties

JSON STRUCTURE

Menus Business Hours Period Structure

8 properties

JSON STRUCTURE

Menus Create Full Menu Item Option Set Item Structure

12 properties

JSON STRUCTURE

Menus Create Full Menu Item Option Set Structure

9 properties

JSON STRUCTURE

Menus Create Full Menu Section Item Structure

18 properties

JSON STRUCTURE

Menus Create Full Menu Section Structure

10 properties

JSON STRUCTURE

Menus Create Full Menu Structure

8 properties

JSON STRUCTURE

Menus Create Metadata Structure

3 properties

JSON STRUCTURE

Menus Http Posted File Base Structure

4 properties

JSON STRUCTURE

Menus Menu Base Structure

4 properties

JSON STRUCTURE

Menus Menu Checkpoint Structure

4 properties

JSON STRUCTURE

Menus Menu Element Edit Response Structure

7 properties

JSON STRUCTURE

Menus Menu Element List Response Structure

5 properties

JSON STRUCTURE

Menus Menu Item Option Set Base Structure

7 properties

JSON STRUCTURE

Menus Menu Item Option Set Item Base Structure

8 properties

JSON STRUCTURE

Menus Menu Item Option Set Item Structure

15 properties

JSON STRUCTURE

Menus Menu Item Option Set Structure

12 properties

JSON STRUCTURE

Menus Menu Nutrition Info Header Structure

3 properties

JSON STRUCTURE

Menus Menu Section Base Structure

8 properties

JSON STRUCTURE

Menus Menu Section Item Base Structure

15 properties

JSON STRUCTURE

Menus Menu Section Item Structure

23 properties

JSON STRUCTURE

Menus Menu Section Structure

11 properties

JSON STRUCTURE

Menus Menu Structure

14 properties

JSON STRUCTURE

Menus Menu Summary Structure

8 properties

JSON STRUCTURE

Menus Menu Tax Details Structure

5 properties

JSON STRUCTURE

Menus Menu Tax Rate Structure

3 properties

JSON STRUCTURE

Menus Menu Zone Structure

7 properties

JSON STRUCTURE

Menus Metadata Structure

3 properties

JSON STRUCTURE

Menus Stream Structure

8 properties

JSON STRUCTURE

Orders Channel Structure

6 properties

JSON STRUCTURE

Orders Coordinates Structure

2 properties

JSON STRUCTURE

Orders Create Fulfillment States Configuration Structure

5 properties

JSON STRUCTURE

Orders Customer Summary Structure

6 properties

JSON STRUCTURE

Orders Delivery Location Structure

7 properties

JSON STRUCTURE

Orders Fee Summary Structure

3 properties

JSON STRUCTURE

Orders Fulfillent Status Action Item Structure

2 properties

JSON STRUCTURE

Orders Fulfillment States Configuration Structure

7 properties

JSON STRUCTURE

Orders Fulfillment States Configuration Summary Structure

5 properties

JSON STRUCTURE

Orders Fulfillment Status Configuration Item Structure

15 properties

JSON STRUCTURE

Orders Masked Phone Number Structure

3 properties

JSON STRUCTURE

Orders Order Batch Structure

5 properties

JSON STRUCTURE

Orders Order Batch Summary Structure

4 properties

JSON STRUCTURE

Orders Order Delivery Information Base Structure

7 properties

JSON STRUCTURE

Orders Order Delivery Information Structure

8 properties

JSON STRUCTURE

Orders Order Drop Off Location Structure

6 properties

JSON STRUCTURE

Orders Order Fulfillment Status Base Structure

3 properties

JSON STRUCTURE

Orders Order Fulfillment Status Structure

4 properties

JSON STRUCTURE

Orders Order Fulfillment Status With Configuration Actions Structure

6 properties

JSON STRUCTURE

Orders Order Item Option Structure

10 properties

JSON STRUCTURE

Orders Order Item Structure

14 properties

JSON STRUCTURE

Orders Order Structure

53 properties

JSON STRUCTURE

Orders Order Summary Structure

28 properties

JSON STRUCTURE

Orders Order Voucher Summary Structure

7 properties

JSON STRUCTURE

Orders Refund Structure

3 properties

JSON STRUCTURE

Orders Store Summary Structure

14 properties

JSON STRUCTURE

Orders Tax Item Structure

3 properties

JSON STRUCTURE

Orders Tip Configuration Structure

7 properties

JSON STRUCTURE

Orders Update Fulfillment States Configuration Structure

6 properties

JSON STRUCTURE

Orders Update Tip Configuration Structure

6 properties

JSON STRUCTURE

Payments Account Field Definition Structure

7 properties

JSON STRUCTURE

Payments Bank Account Detail Structure

19 properties

JSON STRUCTURE

Payments Bank Account Details Update Request Structure

12 properties

JSON STRUCTURE

Payments Bank Account Summary Structure

16 properties

JSON STRUCTURE

Payments Flipdish Fees Details Structure

9 properties

JSON STRUCTURE

Payments Get Receipt By Order Id Query Response Structure

10 properties

JSON STRUCTURE

Payments Payout Chargeback Structure

9 properties

JSON STRUCTURE

Payments Payout Detail Structure

14 properties

JSON STRUCTURE

Payments Payout Order Structure

22 properties

JSON STRUCTURE

Payments Payout Other Charge Structure

8 properties

JSON STRUCTURE

Payments Payout Refund Structure

11 properties

JSON STRUCTURE

Payments Payout Report3 Details Adjustments Structure

21 properties

JSON STRUCTURE

Payments Payout Report3 Details Flipdish Fees Structure

31 properties

JSON STRUCTURE

Payments Payout Report3 Details Revenue Structure

8 properties

JSON STRUCTURE

Payments Payout Report3 Details Summary Structure

8 properties

JSON STRUCTURE

Payments Payout Report3 Overview Header Structure

13 properties

JSON STRUCTURE

Payments Payout Report3 Refunded Order Structure

9 properties

JSON STRUCTURE

Payments Payout Report3 Store Payout Structure

8 properties

JSON STRUCTURE

Payments Payout Store Structure

12 properties

JSON STRUCTURE

Payments Payout Structure

45 properties

JSON STRUCTURE

Payments Previous Order Item Structure

7 properties

JSON STRUCTURE

Payments Previous Order Structure

24 properties

JSON STRUCTURE

Payments Revenue Adjustments Details Structure

8 properties

JSON STRUCTURE

Payments Revenue Detail Structure

13 properties

JSON STRUCTURE

Payments Stripe Connected Account Info Structure

7 properties

JSON STRUCTURE

Payments Stripe Connected Account Structure

8 properties

JSON STRUCTURE

Payments Subscription Invoice Structure

11 properties

JSON STRUCTURE

Payments Subscription Structure

14 properties

JSON STRUCTURE

Payments Subscription Summary Structure

10 properties

JSON STRUCTURE

Payments Upcoming Invoice Structure

8 properties

JSON STRUCTURE

Platform Analytics Client Event Structure

15 properties

JSON STRUCTURE

Platform App Created Event Structure

14 properties

JSON STRUCTURE

Platform App Structure

28 properties

JSON STRUCTURE

Platform App Updated Event Structure

15 properties

JSON STRUCTURE

Platform Bank Account Structure

14 properties

JSON STRUCTURE

Platform Customer Delivery Tracking Order Structure

19 properties

JSON STRUCTURE

Platform Delivery Zone Created Event Structure

14 properties

JSON STRUCTURE

Platform Delivery Zone Deleted Event Structure

14 properties

JSON STRUCTURE

Platform Delivery Zone Updated Event Structure

14 properties

JSON STRUCTURE

Platform Emv Notification Event Structure

19 properties

JSON STRUCTURE

Platform Event Search Result Structure

141 properties

JSON STRUCTURE

Platform External Store Event Structure

22 properties

JSON STRUCTURE

Platform Job Response Structure

14 properties

JSON STRUCTURE

Platform Kiosk Bluetooth Terminal Firmware Version Status Event Structure

16 properties

JSON STRUCTURE

Platform Kiosk Bluetooth Terminal Installation Status Event Structure

14 properties

JSON STRUCTURE

Platform Kiosk Bluetooth Terminal Updated Event Structure

14 properties

JSON STRUCTURE

Platform Lightspeed Settings Structure

23 properties

JSON STRUCTURE

Platform Location Created Event Structure

14 properties

JSON STRUCTURE

Platform Loyalty Campaign Structure

17 properties

JSON STRUCTURE

Platform Menu Bulk Edit Event Structure

16 properties

JSON STRUCTURE

Platform Menu Item Option Set Item Structure

15 properties

JSON STRUCTURE

Platform Menu Section Item Structure

23 properties

JSON STRUCTURE

Platform Order Structure

53 properties

JSON STRUCTURE

Platform Retention Campaign Structure

16 properties

JSON STRUCTURE

Platform Store Fee Config Structure

53 properties

JSON STRUCTURE

Platform Store Fee Config Updated Event Structure

15 properties

JSON STRUCTURE

Platform Store Opening Hours Updated Event Structure

17 properties

JSON STRUCTURE

Platform Store Structure

52 properties

JSON STRUCTURE

Platform Voucher Structure

33 properties

JSON STRUCTURE

Platform Webhook Log Structure

15 properties

JSON STRUCTURE

Stores Address Form Response Structure

4 properties

JSON STRUCTURE

Stores Business Hours Override Base Structure

4 properties

JSON STRUCTURE

Stores Business Hours Override Structure

5 properties

JSON STRUCTURE

Stores Business Hours Period Base Structure

5 properties

JSON STRUCTURE

Stores Business Hours Period Structure

8 properties

JSON STRUCTURE

Stores Create Location Structure

4 properties

JSON STRUCTURE

Stores Delivery Zone Structure

6 properties

JSON STRUCTURE

Stores Dynamic Form Field Structure

8 properties

JSON STRUCTURE

Stores Dynamic Form Rule Structure

3 properties

JSON STRUCTURE

Stores Dynamic Form Rules Structure

5 properties

JSON STRUCTURE

Stores Google Address Result Structure

5 properties

JSON STRUCTURE

Stores Google Address Structure

3 properties

JSON STRUCTURE

Stores Location Area Location Structure

5 properties

JSON STRUCTURE

Stores Location Area With Locations Structure

5 properties

JSON STRUCTURE

Stores Pre Order Config Structure

10 properties

JSON STRUCTURE

Stores Processing Fee Config Structure

4 properties

JSON STRUCTURE

Stores Service Charge Structure

6 properties

JSON STRUCTURE

Stores Store Address Base Structure

8 properties

JSON STRUCTURE

Stores Store Address Structure

10 properties

JSON STRUCTURE

Stores Store Base Structure

31 properties

JSON STRUCTURE

Stores Store Collection Settings Structure

6 properties

JSON STRUCTURE

Stores Store Config Structure

6 properties

JSON STRUCTURE

Stores Store End Of Day Report Structure

26 properties

JSON STRUCTURE

Stores Store Fee Config Structure

53 properties

JSON STRUCTURE

Stores Store Group Extended Structure

11 properties

JSON STRUCTURE

Stores Store Group Structure

8 properties

JSON STRUCTURE

Stores Store Order Capacity Config Structure

4 properties

JSON STRUCTURE

Stores Store Order Capacity Period Structure

6 properties

JSON STRUCTURE

Stores Store Structure

52 properties

JSON STRUCTURE

Stores Store Validation Config Structure

5 properties

JSON STRUCTURE

Example Payloads

Apps App Config Sales Channel Example

4 fields

EXAMPLE

Apps App Config Update Model Example

10 fields

EXAMPLE

Apps App Example

28 fields

EXAMPLE

Apps App General Config Model Example

15 fields

EXAMPLE

Apps App Store App Configuration Example

27 fields

EXAMPLE

Apps App Store App Configuration Summary Example

12 fields

EXAMPLE

Apps App Store App Example

23 fields

EXAMPLE

Apps App Store App Summary Example

10 fields

EXAMPLE

Apps App Store App Support Info Example

6 fields

EXAMPLE

Apps App Store Config Model Example

15 fields

EXAMPLE

Apps Channel Example

6 fields

EXAMPLE

Apps Create App Store App Example

18 fields

EXAMPLE

Apps Execute Configuration Action Result Example

4 fields

EXAMPLE

Apps Field Example

10 fields

EXAMPLE

Apps Field Group Example

5 fields

EXAMPLE

Apps Firebase App Example

4 fields

EXAMPLE

Apps Index Page Base Example

14 fields

EXAMPLE

Apps Index Page Example

16 fields

EXAMPLE

Apps Mobile Apps Statistics Example

9 fields

EXAMPLE

Apps Mobile Apps Submission Details Example

8 fields

EXAMPLE

Apps Mobile Apps Submission Example

6 fields

EXAMPLE

Apps Mobile Apps Submission Status Example

9 fields

EXAMPLE

Apps Play Store Config Model Example

13 fields

EXAMPLE

Apps Stream Example

8 fields

EXAMPLE

Apps Supported Country Example

10 fields

EXAMPLE

Apps Update App Store App Example

18 fields

EXAMPLE

Apps Update Mobile Apps Submission Status Example

6 fields

EXAMPLE

Apps White Label Asset Model Example

5 fields

EXAMPLE

Apps White Label Color Scheme Model Example

14 fields

EXAMPLE

Apps White Label Config Model Example

108 fields

EXAMPLE

Catalog Catalog Group Reference Example

4 fields

EXAMPLE

Catalog Catalog Item Example

11 fields

EXAMPLE

Catalog Create Catalog Group Reference Example

3 fields

EXAMPLE

Catalog Create Catalog Item Example

9 fields

EXAMPLE

Catalog Create Group Example

9 fields

EXAMPLE

Catalog Create Group Reference Example

2 fields

EXAMPLE

Catalog Create Metafield Definition Example

8 fields

EXAMPLE

Catalog Create Product Example

9 fields

EXAMPLE

Catalog Create Product Reference Example

3 fields

EXAMPLE

Catalog Group Example

12 fields

EXAMPLE

Catalog Group Reference Example

3 fields

EXAMPLE

Catalog Metafield Definition Example

8 fields

EXAMPLE

Catalog Metafield Definition Recommendation Example

7 fields

EXAMPLE

Catalog Metafield Example

2 fields

EXAMPLE

Catalog Owner Entity Configuration Example

2 fields

EXAMPLE

Catalog Pending Menu Changes Example

2 fields

EXAMPLE

Catalog Pending Menu Changes Summaries Example

2 fields

EXAMPLE

Catalog Product Example

11 fields

EXAMPLE

Catalog Product Reference Example

5 fields

EXAMPLE

Catalog Publish Menu Changes Example

2 fields

EXAMPLE

Catalog Update Catalog Group Reference Example

3 fields

EXAMPLE

Catalog Update Catalog Item Example

8 fields

EXAMPLE

Catalog Update Group Example

8 fields

EXAMPLE

Catalog Update Group Reference Example

2 fields

EXAMPLE

Catalog Update Metafield Definition Example

3 fields

EXAMPLE

Catalog Update Product Example

8 fields

EXAMPLE

Catalog Update Product Reference Example

3 fields

EXAMPLE

Customers Account Detail Base Example

6 fields

EXAMPLE

Customers Account Detail Example

11 fields

EXAMPLE

Customers App Install Example

10 fields

EXAMPLE

Customers Channel Example

6 fields

EXAMPLE

Customers Create Account Model Example

6 fields

EXAMPLE

Customers Create User Delivery Location Request Example

8 fields

EXAMPLE

Customers Customer Example

7 fields

EXAMPLE

Customers Customer Summary Example

6 fields

EXAMPLE

Customers Delivery Location Example

7 fields

EXAMPLE

Customers Language Example

4 fields

EXAMPLE

Customers Order Batch Summary Example

4 fields

EXAMPLE

Customers Order Drop Off Location Example

6 fields

EXAMPLE

Customers Order Example

53 fields

EXAMPLE

Customers Order Item Example

14 fields

EXAMPLE

Customers Order Item Option Example

10 fields

EXAMPLE

Customers Order Voucher Summary Example

7 fields

EXAMPLE

Customers Password Reset Model Example

5 fields

EXAMPLE

Customers Payment Account Example

9 fields

EXAMPLE

Customers Pending Invitation Example

4 fields

EXAMPLE

Customers Store Summary Example

14 fields

EXAMPLE

Customers Teammate Base Example

4 fields

EXAMPLE

Customers Teammate Example

11 fields

EXAMPLE

Customers User Delivery Location Admin Example

10 fields

EXAMPLE

Customers User Info Example

27 fields

EXAMPLE

Customers User Monthly Commission Example

5 fields

EXAMPLE

Customers User Note Example

7 fields

EXAMPLE

Customers User Order Summary Example

11 fields

EXAMPLE

Customers User Search Example

9 fields

EXAMPLE

Customers User Sms Chat Item Example

5 fields

EXAMPLE

Customers User White Label Config Example

5 fields

EXAMPLE

Devices Bluetooth Terminal Status Example

7 fields

EXAMPLE

Devices Card Reader Example

8 fields

EXAMPLE

Devices Card Reader Registration Request Example

2 fields

EXAMPLE

Devices Client Device Assign Enrolled Device Example

2 fields

EXAMPLE

Devices Client Device Enroll Example

3 fields

EXAMPLE

Devices Client Device Example

3 fields

EXAMPLE

Devices Client Device Summary Example

3 fields

EXAMPLE

Devices Geo Point Request Example

2 fields

EXAMPLE

Devices Kiosk Entitlements Result Example

2 fields

EXAMPLE

Devices Reader Action State Info Example

4 fields

EXAMPLE

Devices Telemetry Series Property Example

5 fields

EXAMPLE

Devices Telemetry Series Query Parameters Example

4 fields

EXAMPLE

Devices Telemetry Series Result Example

2 fields

EXAMPLE

Devices Un Register Card Reader Request Example

2 fields

EXAMPLE

Marketing Campaign Statistics Example

5 fields

EXAMPLE

Marketing Create Pay Green Configuration Request Example

4 fields

EXAMPLE

Marketing Create Promotion Example

2 fields

EXAMPLE

Marketing Create Voucher Example

29 fields

EXAMPLE

Marketing Loyalty Campaign Example

17 fields

EXAMPLE

Marketing Percent Discount Details Example

2 fields

EXAMPLE

Marketing Promotion Award Example

2 fields

EXAMPLE

Marketing Promotion Details Example

3 fields

EXAMPLE

Marketing Push Notification Response Example

5 fields

EXAMPLE

Marketing Restaurant Voucher Assigned Store Example

3 fields

EXAMPLE

Marketing Restaurant Voucher Eligible Store Example

2 fields

EXAMPLE

Marketing Restaurant Voucher Pay Green Configuration Example

4 fields

EXAMPLE

Marketing Restaurant Voucher Pay Green Configuration Summary Example

2 fields

EXAMPLE

Marketing Restaurant Voucher Pay Green Store Configuration Example

4 fields

EXAMPLE

Marketing Retention Campaign Example

16 fields

EXAMPLE

Marketing Set Voucher Validity Periods Simplified Request Example

3 fields

EXAMPLE

Marketing Store Campaign Start Time Example

2 fields

EXAMPLE

Marketing Store List Item Example

7 fields

EXAMPLE

Marketing Update Pay Green Configuration Request Example

2 fields

EXAMPLE

Marketing Update Store Pay Green Configuration Request Example

2 fields

EXAMPLE

Marketing Update Voucher Example

27 fields

EXAMPLE

Marketing Update Voucher Usage Example

3 fields

EXAMPLE

Marketing Validity Period Example

3 fields

EXAMPLE

Marketing Voucher Data Point Example

3 fields

EXAMPLE

Marketing Voucher Example

33 fields

EXAMPLE

Marketing Voucher Summary Example

9 fields

EXAMPLE

Marketing Voucher With Stats Example

38 fields

EXAMPLE

Menus Allergen Example

3 fields

EXAMPLE

Menus Business Hours Period Base Example

5 fields

EXAMPLE

Menus Business Hours Period Example

8 fields

EXAMPLE

Menus Create Full Menu Example

8 fields

EXAMPLE

Menus Create Full Menu Item Option Set Example

9 fields

EXAMPLE

Menus Create Full Menu Item Option Set Item Example

12 fields

EXAMPLE

Menus Create Full Menu Section Example

10 fields

EXAMPLE

Menus Create Full Menu Section Item Example

18 fields

EXAMPLE

Menus Create Metadata Example

3 fields

EXAMPLE

Menus Http Posted File Base Example

4 fields

EXAMPLE

Menus Menu Base Example

4 fields

EXAMPLE

Menus Menu Checkpoint Example

4 fields

EXAMPLE

Menus Menu Element Edit Response Example

7 fields

EXAMPLE

Menus Menu Element List Response Example

5 fields

EXAMPLE

Menus Menu Example

14 fields

EXAMPLE

Menus Menu Item Option Set Base Example

7 fields

EXAMPLE

Menus Menu Item Option Set Example

12 fields

EXAMPLE

Menus Menu Item Option Set Item Base Example

8 fields

EXAMPLE

Menus Menu Item Option Set Item Example

15 fields

EXAMPLE

Menus Menu Nutrition Info Header Example

3 fields

EXAMPLE

Menus Menu Section Base Example

8 fields

EXAMPLE

Menus Menu Section Example

11 fields

EXAMPLE

Menus Menu Section Item Base Example

15 fields

EXAMPLE

Menus Menu Section Item Example

23 fields

EXAMPLE

Menus Menu Summary Example

8 fields

EXAMPLE

Menus Menu Tax Details Example

5 fields

EXAMPLE

Menus Menu Tax Rate Example

3 fields

EXAMPLE

Menus Menu Zone Example

7 fields

EXAMPLE

Menus Metadata Example

3 fields

EXAMPLE

Menus Stream Example

8 fields

EXAMPLE

Orders Channel Example

6 fields

EXAMPLE

Orders Coordinates Example

2 fields

EXAMPLE

Orders Create Fulfillment States Configuration Example

5 fields

EXAMPLE

Orders Customer Summary Example

6 fields

EXAMPLE

Orders Delivery Location Example

7 fields

EXAMPLE

Orders Fee Summary Example

3 fields

EXAMPLE

Orders Fulfillent Status Action Item Example

2 fields

EXAMPLE

Orders Fulfillment States Configuration Example

7 fields

EXAMPLE

Orders Fulfillment States Configuration Summary Example

5 fields

EXAMPLE

Orders Fulfillment Status Configuration Item Example

15 fields

EXAMPLE

Orders Masked Phone Number Example

3 fields

EXAMPLE

Orders Order Batch Example

5 fields

EXAMPLE

Orders Order Batch Summary Example

4 fields

EXAMPLE

Orders Order Delivery Information Base Example

7 fields

EXAMPLE

Orders Order Delivery Information Example

8 fields

EXAMPLE

Orders Order Drop Off Location Example

6 fields

EXAMPLE

Orders Order Example

53 fields

EXAMPLE

Orders Order Fulfillment Status Base Example

3 fields

EXAMPLE

Orders Order Fulfillment Status Example

4 fields

EXAMPLE

Orders Order Fulfillment Status With Configuration Actions Example

6 fields

EXAMPLE

Orders Order Item Example

14 fields

EXAMPLE

Orders Order Item Option Example

10 fields

EXAMPLE

Orders Order Summary Example

28 fields

EXAMPLE

Orders Order Voucher Summary Example

7 fields

EXAMPLE

Orders Refund Example

3 fields

EXAMPLE

Orders Store Summary Example

14 fields

EXAMPLE

Orders Tax Item Example

3 fields

EXAMPLE

Orders Tip Configuration Example

7 fields

EXAMPLE

Orders Update Fulfillment States Configuration Example

6 fields

EXAMPLE

Orders Update Tip Configuration Example

6 fields

EXAMPLE

Payments Account Field Definition Example

7 fields

EXAMPLE

Payments Bank Account Detail Example

19 fields

EXAMPLE

Payments Bank Account Details Update Request Example

12 fields

EXAMPLE

Payments Bank Account Summary Example

16 fields

EXAMPLE

Payments Flipdish Fees Details Example

9 fields

EXAMPLE

Payments Get Receipt By Order Id Query Response Example

10 fields

EXAMPLE

Payments Payout Chargeback Example

9 fields

EXAMPLE

Payments Payout Detail Example

14 fields

EXAMPLE

Payments Payout Example

45 fields

EXAMPLE

Payments Payout Order Example

22 fields

EXAMPLE

Payments Payout Other Charge Example

8 fields

EXAMPLE

Payments Payout Refund Example

11 fields

EXAMPLE

Payments Payout Report3 Details Adjustments Example

21 fields

EXAMPLE

Payments Payout Report3 Details Flipdish Fees Example

31 fields

EXAMPLE

Payments Payout Report3 Details Revenue Example

8 fields

EXAMPLE

Payments Payout Report3 Details Summary Example

8 fields

EXAMPLE

Payments Payout Report3 Overview Header Example

13 fields

EXAMPLE

Payments Payout Report3 Refunded Order Example

9 fields

EXAMPLE

Payments Payout Report3 Store Payout Example

8 fields

EXAMPLE

Payments Payout Store Example

12 fields

EXAMPLE

Payments Previous Order Example

24 fields

EXAMPLE

Payments Previous Order Item Example

7 fields

EXAMPLE

Payments Revenue Adjustments Details Example

8 fields

EXAMPLE

Payments Revenue Detail Example

13 fields

EXAMPLE

Payments Stripe Connected Account Example

8 fields

EXAMPLE

Payments Stripe Connected Account Info Example

7 fields

EXAMPLE

Payments Subscription Example

14 fields

EXAMPLE

Payments Subscription Invoice Example

11 fields

EXAMPLE

Payments Subscription Summary Example

10 fields

EXAMPLE

Payments Upcoming Invoice Example

8 fields

EXAMPLE

Platform Analytics Client Event Example

15 fields

EXAMPLE

Platform App Created Event Example

14 fields

EXAMPLE

Platform App Example

28 fields

EXAMPLE

Platform App Updated Event Example

15 fields

EXAMPLE

Platform Bank Account Example

14 fields

EXAMPLE

Platform Customer Delivery Tracking Order Example

19 fields

EXAMPLE

Platform Delivery Zone Created Event Example

14 fields

EXAMPLE

Platform Delivery Zone Deleted Event Example

14 fields

EXAMPLE

Platform Delivery Zone Updated Event Example

14 fields

EXAMPLE

Platform Emv Notification Event Example

19 fields

EXAMPLE

Platform Event Search Result Example

141 fields

EXAMPLE

Platform External Store Event Example

22 fields

EXAMPLE

Platform Job Response Example

14 fields

EXAMPLE

Platform Kiosk Bluetooth Terminal Firmware Version Status Event Example

16 fields

EXAMPLE

Platform Kiosk Bluetooth Terminal Installation Status Event Example

14 fields

EXAMPLE

Platform Kiosk Bluetooth Terminal Updated Event Example

14 fields

EXAMPLE

Platform Lightspeed Settings Example

23 fields

EXAMPLE

Platform Location Created Event Example

14 fields

EXAMPLE

Platform Loyalty Campaign Example

17 fields

EXAMPLE

Platform Menu Bulk Edit Event Example

16 fields

EXAMPLE

Platform Menu Item Option Set Item Example

15 fields

EXAMPLE

Platform Menu Section Item Example

23 fields

EXAMPLE

Platform Order Example

53 fields

EXAMPLE

Platform Retention Campaign Example

16 fields

EXAMPLE

Platform Store Example

52 fields

EXAMPLE

Platform Store Fee Config Example

53 fields

EXAMPLE

Platform Store Fee Config Updated Event Example

15 fields

EXAMPLE

Platform Store Opening Hours Updated Event Example

17 fields

EXAMPLE

Platform Voucher Example

33 fields

EXAMPLE

Platform Webhook Log Example

15 fields

EXAMPLE

Stores Address Form Response Example

4 fields

EXAMPLE

Stores Business Hours Override Base Example

4 fields

EXAMPLE

Stores Business Hours Override Example

5 fields

EXAMPLE

Stores Business Hours Period Base Example

5 fields

EXAMPLE

Stores Business Hours Period Example

8 fields

EXAMPLE

Stores Create Location Example

4 fields

EXAMPLE

Stores Delivery Zone Example

6 fields

EXAMPLE

Stores Dynamic Form Field Example

8 fields

EXAMPLE

Stores Dynamic Form Rule Example

3 fields

EXAMPLE

Stores Dynamic Form Rules Example

5 fields

EXAMPLE

Stores Google Address Example

3 fields

EXAMPLE

Stores Google Address Result Example

5 fields

EXAMPLE

Stores Location Area Location Example

5 fields

EXAMPLE

Stores Location Area With Locations Example

5 fields

EXAMPLE

Stores Pre Order Config Example

10 fields

EXAMPLE

Stores Processing Fee Config Example

4 fields

EXAMPLE

Stores Service Charge Example

6 fields

EXAMPLE

Stores Store Address Base Example

8 fields

EXAMPLE

Stores Store Address Example

10 fields

EXAMPLE

Stores Store Base Example

31 fields

EXAMPLE

Stores Store Collection Settings Example

6 fields

EXAMPLE

Stores Store Config Example

6 fields

EXAMPLE

Stores Store End Of Day Report Example

26 fields

EXAMPLE

Stores Store Example

52 fields

EXAMPLE

Stores Store Fee Config Example

53 fields

EXAMPLE

Stores Store Group Example

8 fields

EXAMPLE

Stores Store Group Extended Example

11 fields

EXAMPLE

Stores Store Order Capacity Config Example

4 fields

EXAMPLE

Stores Store Order Capacity Period Example

6 fields

EXAMPLE

Stores Store Validation Config Example

5 fields

EXAMPLE

Resources

🔗
Website
Website
🔗
Documentation
Documentation
🔗
APIReference
APIReference
🚀
GettingStarted
GettingStarted
🔑
Authentication
Authentication
🔗
OpenAPI
OpenAPI
💰
Pricing
Pricing
📝
Signup
Signup
🔗
Login
Login
💬
Support
Support
📰
Blog
Blog
👥
GitHubOrganization
GitHubOrganization
👥
SDK Organization
GitHubOrganization
📦
.NET SDK
SDKs
📦
.NET Core SDK
SDKs
📦
Java SDK
SDKs
📦
PHP SDK
SDKs
📦
JavaScript SDK
SDKs
📦
TypeScript SDK
SDKs
📦
TypeScript SignalR Realtime Client
SDKs
💻
Integration Examples
CodeExamples
🔧
Flipdish Spectral Ruleset (API Design Guide)
Tools
🔗
LlmsText
LlmsText
🔗
LinkedIn
LinkedIn
🔗
X
X
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps
🔗
Rules
Rules
🔗
Vocabulary
Vocabulary

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: Flipdish API - Stores
  version: v1.0
request:
  auth:
    type: oauth2
    flow: client_credentials
    accessTokenUrl: https://api.flipdish.co/identity/connect/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Address
    type: folder
  items:
  - info:
      name: Flipdish Get Countries
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/address/countries
      params:
      - name: language
        value: string
        type: query
        description: The language query parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Countries via the Flipdish Open API v1.0 (GET /api/v1.0/address/countries).
  - info:
      name: Flipdish Form by App
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/app/:appId/address/form
      params:
      - name: appId
        value: '500123'
        type: path
        description: The app id path parameter.
      - name: language
        value: string
        type: query
        description: The language query parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Form by App via the Flipdish Open API v1.0 (GET /api/v1.0/app/{appId}/address/form).
  - info:
      name: Flipdish Form by Country
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/address/country/:countryCode/form
      params:
      - name: countryCode
        value: IE
        type: path
        description: The country code path parameter.
      - name: language
        value: string
        type: query
        description: The language query parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Form by Country via the Flipdish Open API v1.0 (GET /api/v1.0/address/country/{countryCode}/form).
  - info:
      name: Flipdish Address Templates
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/address/templates
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Address Templates via the Flipdish Open API v1.0 (POST /api/v1.0/address/templates).
  - info:
      name: Flipdish Format Google Address
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/address/google
      params:
      - name: language
        value: string
        type: query
        description: The language query parameter.
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Format Google Address via the Flipdish Open API v1.0 (POST /api/v1.0/address/google).
- info:
    name: DeliveryZone
    type: folder
  items:
  - info:
      name: Flipdish Get Delivery Zones
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/deliveryzones
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Delivery Zones via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/deliveryzones).
  - info:
      name: Flipdish Add Delivery Zone
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/deliveryzones
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Add Delivery Zone via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/deliveryzones).
  - info:
      name: Flipdish Update Delivery Zone
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/deliveryzones/:deliveryZoneId
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      - name: deliveryZoneId
        value: '500123'
        type: path
        description: The delivery zone id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Update Delivery Zone via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/deliveryzones/{deliveryZoneId}).
  - info:
      name: Flipdish Remove Delivery Zone
      type: http
    http:
      method: DELETE
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/deliveryzones/:deliveryZoneId
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      - name: deliveryZoneId
        value: '500123'
        type: path
        description: The delivery zone id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Remove Delivery Zone via the Flipdish Open API v1.0 (DELETE /api/v1.0/stores/{storeId}/deliveryzones/{deliveryZoneId}).
- info:
    name: Location
    type: folder
  items:
  - info:
      name: Flipdish Create Location
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/:appId/stores/:storeId/location-areas/:locationAreaId/location
      params:
      - name: locationAreaId
        value: '500123'
        type: path
        description: The location area id path parameter.
      - name: appId
        value: '500123'
        type: path
        description: The app id path parameter.
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Create Location via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location).
  - info:
      name: Flipdish Update Location
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/:appId/stores/:storeId/location-areas/:locationAreaId/location/:locationId/update
      params:
      - name: locationAreaId
        value: '500123'
        type: path
        description: The location area id path parameter.
      - name: locationId
        value: '500123'
        type: path
        description: The location id path parameter.
      - name: appId
        value: '500123'
        type: path
        description: The app id path parameter.
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Update Location via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/update).
  - info:
      name: Flipdish Move Location
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/:appId/stores/:storeId/location-areas/:locationAreaId/location/:locationId/move
      params:
      - name: locationId
        value: '500123'
        type: path
        description: The location id path parameter.
      - name: locationAreaId
        value: '500123'
        type: path
        description: The location area id path parameter.
      - name: newLocationAreaId
        value: '500123'
        type: query
        description: The new location area id query parameter.
      - name: appId
        value: '500123'
        type: path
        description: The app id path parameter.
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Move Location via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/move).
  - info:
      name: Flipdish Map Location to External Id
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/:appId/stores/:storeId/location-areas/:locationAreaId/location/:locationId/map-external
      params:
      - name: locationId
        value: '500123'
        type: path
        description: The location id path parameter.
      - name: locationAreaId
        value: '500123'
        type: path
        description: The location area id path parameter.
      - name: appId
        value: '500123'
        type: path
        description: The app id path parameter.
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      - name: externalLocationId
        value: '500123'
        type: query
        description: The external location id query parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Map Location to External Id via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/map-external).
  - info:
      name: Flipdish Delete Location
      type: http
    http:
      method: DELETE
      url: https://api.flipdish.co/api/v1.0/:appId/stores/:storeId/location-areas/:locationAreaId/location/:locationId/delete
      params:
      - name: locationId
        value: '500123'
        type: path
        description: The location id path parameter.
      - name: locationAreaId
        value: '500123'
        type: path
        description: The location area id path parameter.
      - name: appId
        value: '500123'
        type: path
        description: The app id path parameter.
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Delete Location via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/delete).
- info:
    name: LocationAreas
    type: folder
  items:
  - info:
      name: Flipdish Get Location Areas for Store
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/:appId/stores/:storeId/location-areas
      params:
      - name: appId
        value: '500123'
        type: path
        description: The app id path parameter.
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Location Areas for Store via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/stores/{storeId}/location-areas).
  - info:
      name: Flipdish Create Location Area
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/:appId/stores/:storeId/location-areas
      params:
      - name: appId
        value: '500123'
        type: path
        description: The app id path parameter.
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Create Location Area via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/stores/{storeId}/location-areas).
  - info:
      name: Flipdish Get Location Area
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/:appId/stores/:storeId/location-areas/:locationAreaId
      params:
      - name: locationAreaId
        value: '500123'
        type: path
        description: The location area id path parameter.
      - name: appId
        value: '500123'
        type: path
        description: The app id path parameter.
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Location Area via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}).
  - info:
      name: Flipdish Update Location Area
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/:appId/stores/:storeId/location-areas/:locationAreaId/update
      params:
      - name: appId
        value: '500123'
        type: path
        description: The app id path parameter.
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      - name: locationAreaId
        value: '500123'
        type: path
        description: The location area id path parameter.
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Update Location Area via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/update).
- info:
    name: StoreGroups
    type: folder
  items:
  - info:
      name: Flipdish Get Store Group
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/storegroups/:storeGroupId
      params:
      - name: storeGroupId
        value: '500123'
        type: path
        description: The store group id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Store Group via the Flipdish Open API v1.0 (GET /api/v1.0/storegroups/{storeGroupId}).
  - info:
      name: Flipdish Update Store Group
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/storegroups/:storeGroupId
      params:
      - name: storeGroupId
        value: '500123'
        type: path
        description: The store group id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Update Store Group via the Flipdish Open API v1.0 (POST /api/v1.0/storegroups/{storeGroupId}).
  - info:
      name: Flipdish Remove Store Group
      type: http
    http:
      method: DELETE
      url: https://api.flipdish.co/api/v1.0/storegroups/:storeGroupId
      params:
      - name: storeGroupId
        value: '500123'
        type: path
        description: The store group id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Remove Store Group via the Flipdish Open API v1.0 (DELETE /api/v1.0/storegroups/{storeGroupId}).
  - info:
      name: Flipdish Get Store Groups
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/:appNameId/storegroups
      params:
      - name: appNameId
        value: '500123'
        type: path
        description: The app name id path parameter.
      - name: searchQuery
        value: string
        type: query
        description: The search query query parameter.
      - name: page
        value: '1'
        type: query
        description: The page query parameter.
      - name: limit
        value: '1'
        type: query
        description: The limit query parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Store Groups via the Flipdish Open API v1.0 (GET /api/v1.0/{appNameId}/storegroups).
  - info:
      name: Flipdish Create Store Group
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/:appNameId/storegroups
      params:
      - name: appNameId
        value: '500123'
        type: path
        description: The app name id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Create Store Group via the Flipdish Open API v1.0 (POST /api/v1.0/{appNameId}/storegroups).
  - info:
      name: Flipdish Get Store Groups Extended
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/:appNameId/storegroups/extended
      params:
      - name: appNameId
        value: '500123'
        type: path
        description: The app name id path parameter.
      - name: searchQuery
        value: string
        type: query
        description: The search query query parameter.
      - name: page
        value: '1'
        type: query
        description: The page query parameter.
      - name: limit
        value: '1'
        type: query
        description: The limit query parameter.
      - name: groupingRadius
        value: '1'
        type: query
        description: The grouping radius query parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Store Groups Extended via the Flipdish Open API v1.0 (GET /api/v1.0/{appNameId}/storegroups/extended).
  - info:
      name: Flipdish Set Customer Messages
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/storegroups/:storeGroupId/CustomerMessages
      params:
      - name: storeGroupId
        value: '500123'
        type: path
        description: The store group id path parameter.
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Set Customer Messages via the Flipdish Open API v1.0 (POST /api/v1.0/storegroups/{storeGroupId}/CustomerMessages).
  - info:
      name: Flipdish Assign Stores to Store Group
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/:appId/storegroups/:storeGroupId/assignStores
      params:
      - name: appId
        value: '500123'
        type: path
        description: The app id path parameter.
      - name: storeGroupId
        value: '500123'
        type: path
        description: The store group id path parameter.
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Assign Stores to Store Group via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/storegroups/{storeGroupId}/assignStores).
- info:
    name: StoreOrderCapacity
    type: folder
  items:
  - info:
      name: Flipdish Get Store Order Capacity
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/:appId/storeordercapacity/:storeId/:deliveryType
      params:
      - name: appId
        value: '500123'
        type: path
        description: The app id path parameter.
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      - name: deliveryType
        value: Delivery
        type: path
        description: The delivery type path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Store Order Capacity via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/storeordercapacity/{storeId}/{deliveryType}).
  - info:
      name: Flipdish Update Store Order Capacity Config
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/:appId/storeordercapacity/:storeId
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      - name: deliveryType
        value: Delivery
        type: query
        description: The delivery type query parameter.
      - name: appId
        value: '500123'
        type: path
        description: The app id path parameter.
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Update Store Order Capacity Config via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/storeordercapacity/{storeId}).
- info:
    name: Stores
    type: folder
  items:
  - info:
      name: Flipdish Get Store by Id
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/stores/:storeId
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Store by Id via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}).
  - info:
      name: Flipdish Update Store
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/stores/:storeId
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Update Store via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}).
  - info:
      name: Flipdish Get Store Fee Config
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/feeConfig
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Store Fee Config via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/feeConfig).
  - info:
      name: Flipdish Get Store Lead Times
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/leadTimes
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Store Lead Times via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/leadTimes).
  - info:
      name: Flipdish Set Store Lead Times
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/leadTimes
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Set Store Lead Times via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/leadTimes).
  - info:
      name: Flipdish Get Bank Account for Store
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/bankaccount
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Bank Account for Store via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/bankaccount).
  - info:
      name: Flipdish Get Store Service Charge
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/servicecharge
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Store Service Charge via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/servicecharge).
  - info:
      name: Flipdish Configure Store Service Charge
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/servicecharge
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Configure Store Service Charge via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/servicecharge).
  - info:
      name: Flipdish Get Store Delivery Fee Config
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/feeConfig/deliveryZones
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Store Delivery Fee Config via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/feeConfig/deliveryZones).
  - info:
      name: Flipdish Put Store Delivery Fee Config
      type: http
    http:
      method: PUT
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/feeConfig/deliveryZones
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Put Store Delivery Fee Config via the Flipdish Open API v1.0 (PUT /api/v1.0/stores/{storeId}/feeConfig/deliveryZones).
  - info:
      name: Flipdish Get End of Day Report
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/endofdayreport
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      - name: date
        value: '2026-06-02T12:00:00Z'
        type: query
        description: The date query parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get End of Day Report via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/endofdayreport).
  - info:
      name: Flipdish Get Business Hours
      type: http
    http:
      method: GET
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/availability/:deliveryType
      params:
      - name: storeId
        value: '500123'
        type: path
        description: The store id path parameter.
      - name: deliveryType
        value: Delivery
        type: path
        description: The delivery type path parameter.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.flipdish.co/identity/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Get Business Hours via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/availability/{deliveryType}).
  - info:
      name: Flipdish Set Business Hours
      type: http
    http:
      method: POST
      url: https://api.flipdish.co/api/v1.0/stores/:storeId/availabil

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/apis.yml