Jump to Content

Home Guides API Reference

Home Guides API Reference

v1.0

Home Guides API Reference Log In

v1.0

Flipdish Orders

Application config
- Get app configget
Customer account
Payment accounts
Restaurants
Delivery locations
Orders

Flipdish Open API v1.0

Accounts
Address
Apm
Apps
AppStore
- /api/v1.0/appstore/apps/{appStoreAppId}get
- /api/v1.0/appstore/appsget
AppStoreConfigurations
AppStoreDeveloper
AppStoreSubscriptions
AuditLogs
- /api/v1.0/auditlogs/orders/{orderId}post
- /api/v1.0/auditlogs/stores/{storeId}post
AuthorizationTokens
- /api/v1.0/{appId}/authorizationtokens/{oauthAppId}get
- /api/v1.0/{appId}/authorizationtokens/{key}delete
BankAccount
Campaigns
CardReaders
CatalogChanges
CatalogGroups
CatalogImages
- Upload a Catalog Imagepost
CatalogItems
CatalogProducts
Channels
ChannelsStoreMapping
- /api/v1.0/{appId}/channels/storemappingsget
- /api/v1.0/{appId}/channels/storemappingspost
Clients
ContentSecurityPolicy
- /api/v1.0/csp/reportpost
CrossSell
- /api/v1.0/{appId}/crossSell/menuItemsget
Customers
DeliveryZone
Device
Events
Features
- /api/v1.0/{appId}/features/enablepost
- /api/v1.0/{appId}/features/disablepost
Files
- /api/v1.0/{appId}/files/download/{fileId}get
FirebaseApps
- /api/v1.0/FirebaseApp/{whitelabelId}get
- /api/v1.0/FirebaseApppost
Fpm
- /api/v1.0/{storeId}/fpm/editpost
- /api/v1.0/{storeId}/fpmpost
FulfillmentStateConfiguration
GoogleFoodOrderPrototype
- /api/v1.0/{appId}/googleorderpost
- /api/v1.0/{appId}/googleorder/{orderId}/submitpost
Heartbeat
Home
HttpRequestResponseLogs
- /api/v1.0/{appId}/interactions/logsget
Hydra
Intercom
- /api/v1.0/intercom/userHashget
Invoices
- /api/v1.0/{appId}/invoicesget
KioskIot
- /api/v1.0/kioskiot/connectpost
- /api/v1.0/{appId}/kioskiot/timeseries/querypost
Lightspeed
Location
LocationAreas
LookerDashboard
- /api/v1.0/{appId}/looker/dashboardsget
LookerSingleSignOn
- /api/v1.0/{appId}/looker/ssoget
MenuOptionSetItems
MenuOptionSets
Menus
MenuSectionItems
MenuSections
MenusNutritionInfo
MenusNutritionInfoV2
MenuZones
MetafieldDefinitions
MobileApps
OAuthClients
Onboarding
OrderBatches
- /api/v1.0/{appId}/order-batches/{orderBatchId}get
- /api/v1.0/{appId}/order-batchesget
OrderBatchingConfiguration
- /api/v1.0/stores/{storeId}/order-batching-configurationget
- /api/v1.0/stores/{storeId}/order-batching-configurationpost
OrderIngest
- /api/v1.0/{appNameId}/order-ingest/submitpost
Orders
PaymentIntents
- /api/v1.0/payment_intents/{paymentIntentId}get
Payments
- /api/v1.0/payments/payment/{orderId}/refundableget
PayoutReports
Payouts
PayoutsExport
ProcessingFeeConfigs
- /api/v1.0/processingfeeconfigsget
PushNotifications
Receipts
- /api/v1.0/receipts/{orderId}get
RestaurantVouchersPayGreen
StoreGroups
StoreOrderCapacity
- /api/v1.0/{appId}/storeordercapacity/{storeId}/{deliveryType}get
- /api/v1.0/{appId}/storeordercapacity/{storeId}post
Stores
StripeCustomConnect
StripeCustomConnectAdmin
- /api/v1.0/customconnect/initialize-bank-accountpost
Stuart
Subscriptions
Teammates
TerminalIot
- /api/v1.0/terminaliot/connectpost
Tips
- /api/v1.0/stores/{storeId}/tipconfigget
- /api/v1.0/stores/{storeId}/tipconfigpost
Users
- /api/v1.0/users/rolesget
- /api/v1.0/users/{userId}/previousordercount/{storeId}get
Vouchers
Webhooks
Website

Flipdish Reporting V1

CsvApi
- If successful will redirect to a download fileget
CustomerApi
CustomerManagementApi
DeliveryZoneApi
- Returns all delivery zones associated with the queryget
HealthCheck
- If successful will return HTTP Success 200 and health status of ElasticSearchget
OrderApi
StoresApi
- Returns top X stores that match the queryget
VoucherApi
- Returns top X vouchers that match the queryget

Flipdish Open API v1.0

Gets the current account detailget
[PRIVATE API] Returns true if APM is enabled on at least one store in an applicationget
Get the application configurationget
Get app store app detailsget
Get list of app store apps which have been configuredget
Get authorization tokensget
Get List of BankAccounts for WLget
Gets list of stores for appget
Get Connection Token For a Stripe Terminalget
Get group by Idget
Upload a Catalog Imagepost
Get item by Idget
/api/v1.0/{appId}/channelsget
/api/v1.0/csp/reportpost
Get customer of an app by Idget
[PRIVATE] Get drivers by Appget
Get all the delivery zones associated with a storeget
Get driver profileget
Get event by Id For technical reasons, the number of records returned is limited to 100.get
Get file from storageget
/api/v1.0/heartbeatget
[PRIVATE API] Get Home Actionsget
Get API interaction logsget
[Private]get
Get the IoT connection parameters for telemetry and commands No input parameters since authenticated hydra user defines contextpost
[For Kiosk use only] Get all stores connected to a Kioskget
/api/v1.0/lightspeed/{storeId}/settingsget
/api/v1.0/{appId}/looker/sso/CustomerReportingget
Get menu item option set itemsget
Get menu item option setsget
[PRIVATE API]Get menus by appIdget
Get menu itemsget
Get menu sectionsget
Get OwnerEntity Configurations which contain information to manage Metafield Definitionsget
/api/v1.0/{appId}/oauthclients/appnamesget
/api/v1.0/clients/{appId}/onboarding/stores/{storeId}get
Provides an ability to ingest a 3rd party order into Flipdish ecosystempost
Get order by IDget
Returns payment refund information related to the order with the order idget
Get Payout details broken down by Storeget
Export payouts as CSVget
Get processing fee configs by store identifiersget
Get paginated products by app name id filtered by product typesget
[PRIVATE] Push notification to cutomersget
Returns a Store Groupsget
Get store's order capacity configurationget
Get store by identifierget
/api/v1.0/{appId}/customconnect/refresh-linkget
Get stuart settings for a storeget
Get all teammatesget
Get role namesget
Update account with name and languageput
[PRIVATE API] Get Basic Statisticsget
Get all supported countries.get
Update app store appput
Get list of app store app configurations for one app store appget
Revoke tokendelete
Create a new Bank Account and attach to this Apppost
Gets loyalty campaigns for appget
Get the status of the bluetooth terminalget
Update Catalog Grouppost
Update Catalog Itempost
/api/v1.0/{appId}/channels/{id}get
Update customer of an app by Idpost
[PRIVATE] Invite driverpost
Adds a delivery zone to the store idpost
Update driver profilepost
Get menu events For technical reasons, the number of records returned is limited to 100.get
/api/v1.0/heartbeathead
[PRIVATE API] Get Home Statisticsget
/api/v1.0/hydra/registrationget
Get all kiosk settings associated with a storeget
/api/v1.0/lightspeed/{storeId}/settingspost
Create menu item option set itempost
Create menu item option setpost
Create a new menu. If request body is empty, the system will create a menu with default items.post
Create menu section itempost
Create menu sectionpost
Get a Metafield Definition for the specified owner entity and key.get
Get OAuth App by identifierget
/api/v1.0/clients/{appId}/onboarding/stores/{storeId}/items/{onboardingItemId}post
Get order delivery informationget
Get list of payout summariesget
Export payout's details as CSVget
Archive a product. If the product is used in Menus, the related MenuItems will be marked as deletedpost
[PRIVATE] Push notification to cutomerspost
Updates Store Grouppost
Create or update a store's order capacity configurationpost
Update store by identifierpost
Gets the current verification status of the given connected accountget
Set stuart settings for a storepost
Create teammate and send an invite.post
/api/v1.0/users/{userId}/previousordercount/{storeId}get
Create account with email address and store namepost
[PRIVATE API] Get Calendar statisticsget
Get the application compliance configurationget
Delete app store appdelete
Get app store app configurationget
Get BankAccount Detail by Idget
Creates loyalty campaignpost
Get Location ID for Stripe Terminalpost
Get paginated groups by app name id filtered by typesget
Get paginated items by app name id filtered by typesget
Returns a list of sales channels that are assigned to a given whitelabelget
Assign driver to multiple orderspost
Updates the existing delivery zonepost
Get stores for driverget
Get user events For technical reasons, the number of records returned is limited to 100.get
/api/v1.0/heartbeat/Hostnameget
[PRIVATE API] Complete Home Actionpost
List EMV terminals belonging to the given AppNameIdget
/api/v1.0/{appId}/kiosksettings/cashpost
/api/v1.0/lightspeed/{storeId}/menu/generatepost
Get menu item option set item by identifierget
Get menu item option set by identifierget
Get menu by identifierget
Get menu item by identifierget
Get menu section by identifierget
Update a Metafield Definitionpost
Update OAuth Apppost
Add/update delivery-related information to an orderpost
Get list of payoutsget
Export a list of payout's orders as CSVget
Duplicate a productpost
[PRIVATE] Update the push notificationpost
Deletes a Store Group Can only remove a store group if there is no stores attached to the groupdelete
Get Stores Bank Account Idget
Create a new Bank Account and Stripe connected accountpost
Get start job detailsget
Get a teammates by email addressget
[PRIVATE API] Get timezones localised to users languageget
[PRIVATE API] Get paginated APM call listget
Set the application compliance configurationpost
Get list of app store app summariesget
Update app store app configurationput
Update BankAccountpost
Gets retention campaigns for appget
Get Authorization Key for Stripe Terminalpost
Create a Catalog Grouppost
Create a Catalog Itempost
Returns a list of sales channels that are not yet assigned to a given whitelabelget
[PRIVATE] Assign driver to orderpost
Removes the existing delivery zonedelete
[PRIVATE] Request an SMS to be sent to the driver with their login codepost
Get order events For technical reasons, the number of records returned is limited to 100.get
/api/v1.0/heartbeat/Hostnamehead
[PRIVATE API] Complete Home Actionpost
[Private]post
Update menu item option set itempost
Update menu item option setpost
Update menupost
Update menu section itempost
Update menu sectionpost
Get Metafield Definitions for the specified owner entity.get
Delete OAuth Appdelete
Get orders by filterget
Get list of payout's ordersget
Export a list of payout's refunds as CSVget
[PRIVATE] Push notification to cutomersdelete
Returns a paginated list of Store Groupsget
Retrieve Store Service Chargeget
Create or update a Stripe connected account associated with the bank account of bankAccountIdpost
Cancel a stuart jobdelete
Update teammates (this method does not support Deltas!)post
Change passwordput
[PRIVATE API] Get Calls Statisticsget
Get panacea vanity url. This sets the URL which the Panacea website is available at. ie. my.flipdish.com/[vanityurl]get
Create app store apppost
Delete app store app configurationdelete
Delete BankAccountdelete
Creates retention campaignpost
Initiate stripe terminal pairing modepost
Archive Catalog Grouppost
Upload a Catalog Item Imagepost
Returns a list of store ids attached to the given channel type for the specified app.get
[PRIVATE] Unassign driver from appdelete
[PRIVATE] Login with phone number and pinpost
Get store events For technical reasons, the number of records returned is limited to 100.get
[Private]get
Delete menu item option set itemdelete
Delete menu item option setdelete
[PRIVATE API]Mark a Menu as Deleteddelete
Delete menu section itemdelete
Delete menu sectiondelete
Create a Metafield Definitionpost
Get OAuth App secret keyget
[PRIVATE API] Get summary of orders by filterget
Get list of payout's refundsget
Export a list of payout's chargebacks as CSVget
Creates a Store Group It will be attached to an existing Apppost
Configure Store Service Charge; Idempotent Operationpost
Update bank account's BusinessType and create a Stripe Connected Accountpost
Delete teammatedelete
Reset password with token.post
[PRIVATE API] Get Order Statistics (Value of Orders)get
Set panacea vanity urlpost
Update app store app verificationput
Create app store app configurationpost
Get bank account fields definitionsget
Gets loyalty campaigns for storeget
Cancel currently initiated install update for bluetooth terminalpost
Duplicate Catalog Grouppost
Delete a CatalogItem Imagedelete
Detaches all the stores from the given sales channel.delete
[PRIVATE] Unassign driver from orderdelete
Add driver tokenpost
Get customer events For technical reasons, the number of records returned is limited to 100.get
Get the status of Cash Payment Methon on Kisokget
Upload menu item option set item imagepost
Upload menu item option set imagepost
[PRIVATE API]Get menus tax detailsget
Create menu section items from a list of Productspost
Clone menu sectionpost
Get OwnerEntity Definition Recommendationsget
Get OAuth access token for Appget
Accept orderpost
Get list of payout's chargebacksget
Export a list of payout's other charges as CSVget
[PRIVATE API] Returns a paginated list of Extended Store Groupsget
Get store end of day reportget
Update bank account detailspost
Redeem one-time code from invitationget
Change passwordput
Get the application hostname DNS delegation states for A and CNAME records.get
Upload the app store app logo \ iconpost
Get bank account fields definitionsget
Gets retention campaigns for storeget
Initiate Kiosk Update Install for bluetooth terminalpost
Archive Catalog Itempost
Returns a list of store that are assigned to the given sales channel.get
Delete driver tokendelete
Get WhiteLabel events For technical reasons, the number of records returned is limited to 100.get
[Private]get
Delete menu item option set item imagedelete
Delete option set imagedelete
[PRIVATE API]Get Menus Nameget
Create menu section items from a list of Catalog Itemspost
Upload menu section imagepost
Get OAuth App redirect urisget
Refund orderpost
Get list of payout's other chargesget
Get Business hoursget
Gets a single-use Stripe URL for the given accountpost
Request login PIN. The server sends the PIN to the email address.post
Get Appsget
[PRIVATE API] Update State of Bank Accountpost
Updates loyalty campaignpost
Trigger check for Bluetooth device update on Kioskpost
Duplicate Catalog Itempost
/api/v1.0/{appId}/channels/channelstoresget
Set driver profile image and returns it's urlpost
Get order events by customer For technical reasons, the number of records returned is limited to 100.get
[Private]get
[Private API] Set Tax Rate on OptionSetItempost
[PRIVATE API]Set Menus Namepost
Clone menu section itempost
Delete menu section imagedelete
Create OAuth App redirect uripost
Reject orderpost
Set Business hourspost
Login with username and passwordpost
Is panacea vanity url availableget
[PRIVATE API] Attach Bank Account to Storepost
Updates retention campaignpost
Unpair the currently paired stripe terminaldelete
/api/v1.0/{appId}/channels/channelstorespost
Delete driver profile imagedelete
Get events For technical reasons, the number of records returned is limited to 100.get
[Private]get
[PRIVATE API]Get menus store namesget
Upload menu section item imagepost
Create menu availability typepost
Get all OAuth Appsget
Dispatch orderpost
Get the pre order config for a store, by typeget
Log out. It removes Flipdish authorization Cookie.post
Get Appsget
Deletes a campaigndelete
Assign a given AppId to a Sales Channelpost
/api/v1.0/drivers/stores/{storeId}/presence/{presence}post
[Private]post
[PRIVATE API]Get a Menus Checkpointsget
Delete menu section item imagedelete
Re-arrange Items within a Sectionpost
Create OAuth Apppost
UPDATE pre order config for a store, by typepost
Login with username and passwordpost
Set the application logo \ iconpost
Attachs the specified store to the given sales channel.post
Change delivery tracking status and return the updated status.post
/api/v1.0/{appId}/hydra/cancelemvpayment/{orderId}post
Get all menu metadata by menu ID and store IDget
[PRIVATE API]Move an Item within a menupost
Set/update menu section availability hours.post
Delete OAuth App redirect uridelete
Get the Preview times of the pre-order configurationget
Request password reset. Flipdish system will send a token via email.post
Gain Support access to a given AppIdpost
Detaches the specified store from the given sales channel.delete
[Private]post
/api/v1.0/menus/{menuId}/bulkshowhide/listget
[PRIVATE API]Move an Item within a menupost
Get processing fee configs by store identifierget
Skip a signup questionpost
Set the application configurationpost
Assign a Store to a Sales Channelpost
[Private]post
Get menu item metadataget
Get all stores by app name idget
Answer a signup questionpost
Set the application languagespost
Unassign a Store from a Sales Channelpost
Unassign the currently assigned EMV terminal from a kioskpost
Update menu item metadataput
Get stores statistics by app name id and storeIdsget
Set the application hostname.post
[Private]post
Get menu item metadata by keyget
Get business hours overrides by store identifierget
Assign an EMV terminal to a kioskpost
Delete menu item metadatadelete
Create Business Hours Override for a storepost
[Private]post
Get menu item option set item metadata by keyget
Get all stores by app name idget
Update the Cash Payment Methon Visiability on Kisokpost
Update menu item option set item metadataput
Get processing fee configs by store identifierget
[Private]delete
Create a new menu from xlsx file.post
Get all stores, excluding archived onesget
[Private]delete
[PRIVATE API]Lock/Unlock a Menu for Editingpost
Create store with Store Group identifierpost
[Private]delete
Upload menu imagepost
Clone store with store clone settingspost
Delete menu imagedelete
Update store addresspost
[PRIVATE API]Add/Update a Tax Ratepost
Archive storepost
[PRIVATE API]Clone a menu, (without attaching stores)post
Publish storepost
[PRIVATE API]Set if tax shows for a Menupost
Unpublish storepost
[PRIVATE API]Set the type of Tax on a Menupost
Assign Menu to Storepost
[PRIVATE API]Re-arrange Sections within a Menupost
Update store address coordinatespost
[PRIVATE API]Restore a Menu to a checkpointpost
UPDATE pre order config for a store, by typepost
/api/v1.0/menus/{menuId}/bulkshowhidepost
Delete Business Hours Override for a storedelete
[PRIVATE API]Remove a Menus Tax Rate, can only remove a tax rate that does not have items/optionSetItems attacheddelete
Vouchers
Webhooks
Website

Powered by

Flipdish Orders

Application config
- Get app configget
Customer account
Payment accounts
Restaurants
Delivery locations
Orders

Flipdish Open API v1.0

Accounts
Address
Apm
Apps
AppStore
- /api/v1.0/appstore/apps/{appStoreAppId}get
- /api/v1.0/appstore/appsget
AppStoreConfigurations
AppStoreDeveloper
AppStoreSubscriptions
AuditLogs
- /api/v1.0/auditlogs/orders/{orderId}post
- /api/v1.0/auditlogs/stores/{storeId}post
AuthorizationTokens
- /api/v1.0/{appId}/authorizationtokens/{oauthAppId}get
- /api/v1.0/{appId}/authorizationtokens/{key}delete
BankAccount
Campaigns
CardReaders
CatalogChanges
CatalogGroups
CatalogImages
- Upload a Catalog Imagepost
CatalogItems
CatalogProducts
Channels
ChannelsStoreMapping
- /api/v1.0/{appId}/channels/storemappingsget
- /api/v1.0/{appId}/channels/storemappingspost
Clients
ContentSecurityPolicy
- /api/v1.0/csp/reportpost
CrossSell
- /api/v1.0/{appId}/crossSell/menuItemsget
Customers
DeliveryZone
Device
Events
Features
- /api/v1.0/{appId}/features/enablepost
- /api/v1.0/{appId}/features/disablepost
Files
- /api/v1.0/{appId}/files/download/{fileId}get
FirebaseApps
- /api/v1.0/FirebaseApp/{whitelabelId}get
- /api/v1.0/FirebaseApppost
Fpm
- /api/v1.0/{storeId}/fpm/editpost
- /api/v1.0/{storeId}/fpmpost
FulfillmentStateConfiguration
GoogleFoodOrderPrototype
- /api/v1.0/{appId}/googleorderpost
- /api/v1.0/{appId}/googleorder/{orderId}/submitpost
Heartbeat
Home
HttpRequestResponseLogs
- /api/v1.0/{appId}/interactions/logsget
Hydra
Intercom
- /api/v1.0/intercom/userHashget
Invoices
- /api/v1.0/{appId}/invoicesget
KioskIot
- /api/v1.0/kioskiot/connectpost
- /api/v1.0/{appId}/kioskiot/timeseries/querypost
Lightspeed
Location
LocationAreas
LookerDashboard
- /api/v1.0/{appId}/looker/dashboardsget
LookerSingleSignOn
- /api/v1.0/{appId}/looker/ssoget
MenuOptionSetItems
MenuOptionSets
Menus
MenuSectionItems
MenuSections
MenusNutritionInfo
MenusNutritionInfoV2
MenuZones
MetafieldDefinitions
MobileApps
OAuthClients
Onboarding
OrderBatches
- /api/v1.0/{appId}/order-batches/{orderBatchId}get
- /api/v1.0/{appId}/order-batchesget
OrderBatchingConfiguration
- /api/v1.0/stores/{storeId}/order-batching-configurationget
- /api/v1.0/stores/{storeId}/order-batching-configurationpost
OrderIngest
- /api/v1.0/{appNameId}/order-ingest/submitpost
Orders
PaymentIntents
- /api/v1.0/payment_intents/{paymentIntentId}get
Payments
- /api/v1.0/payments/payment/{orderId}/refundableget
PayoutReports
Payouts
PayoutsExport
ProcessingFeeConfigs
- /api/v1.0/processingfeeconfigsget
PushNotifications
Receipts
- /api/v1.0/receipts/{orderId}get
RestaurantVouchersPayGreen
StoreGroups
StoreOrderCapacity
- /api/v1.0/{appId}/storeordercapacity/{storeId}/{deliveryType}get
- /api/v1.0/{appId}/storeordercapacity/{storeId}post
Stores
StripeCustomConnect
StripeCustomConnectAdmin
- /api/v1.0/customconnect/initialize-bank-accountpost
Stuart
Subscriptions
Teammates
TerminalIot
- /api/v1.0/terminaliot/connectpost
Tips
- /api/v1.0/stores/{storeId}/tipconfigget
- /api/v1.0/stores/{storeId}/tipconfigpost
Users
- /api/v1.0/users/rolesget
- /api/v1.0/users/{userId}/previousordercount/{storeId}get
Vouchers
Webhooks
Website

Flipdish Reporting V1

CsvApi
- If successful will redirect to a download fileget
CustomerApi
CustomerManagementApi
DeliveryZoneApi
- Returns all delivery zones associated with the queryget
HealthCheck
- If successful will return HTTP Success 200 and health status of ElasticSearchget
OrderApi
StoresApi
- Returns top X stores that match the queryget
VoucherApi
- Returns top X vouchers that match the queryget

Flipdish Open API v1.0

Gets the current account detailget
[PRIVATE API] Returns true if APM is enabled on at least one store in an applicationget
Get the application configurationget
Get app store app detailsget
Get list of app store apps which have been configuredget
Get authorization tokensget
Get List of BankAccounts for WLget
Gets list of stores for appget
Get Connection Token For a Stripe Terminalget
Get group by Idget
Upload a Catalog Imagepost
Get item by Idget
/api/v1.0/{appId}/channelsget
/api/v1.0/csp/reportpost
Get customer of an app by Idget
[PRIVATE] Get drivers by Appget
Get all the delivery zones associated with a storeget
Get driver profileget
Get event by Id For technical reasons, the number of records returned is limited to 100.get
Get file from storageget
/api/v1.0/heartbeatget
[PRIVATE API] Get Home Actionsget
Get API interaction logsget
[Private]get
Get the IoT connection parameters for telemetry and commands No input parameters since authenticated hydra user defines contextpost
[For Kiosk use only] Get all stores connected to a Kioskget
/api/v1.0/lightspeed/{storeId}/settingsget
/api/v1.0/{appId}/looker/sso/CustomerReportingget
Get menu item option set itemsget
Get menu item option setsget
[PRIVATE API]Get menus by appIdget
Get menu itemsget
Get menu sectionsget
Get OwnerEntity Configurations which contain information to manage Metafield Definitionsget
/api/v1.0/{appId}/oauthclients/appnamesget
/api/v1.0/clients/{appId}/onboarding/stores/{storeId}get
Provides an ability to ingest a 3rd party order into Flipdish ecosystempost
Get order by IDget
Returns payment refund information related to the order with the order idget
Get Payout details broken down by Storeget
Export payouts as CSVget
Get processing fee configs by store identifiersget
Get paginated products by app name id filtered by product typesget
[PRIVATE] Push notification to cutomersget
Returns a Store Groupsget
Get store's order capacity configurationget
Get store by identifierget
/api/v1.0/{appId}/customconnect/refresh-linkget
Get stuart settings for a storeget
Get all teammatesget
Get role namesget
Update account with name and languageput
[PRIVATE API] Get Basic Statisticsget
Get all supported countries.get
Update app store appput
Get list of app store app configurations for one app store appget
Revoke tokendelete
Create a new Bank Account and attach to this Apppost
Gets loyalty campaigns for appget
Get the status of the bluetooth terminalget
Update Catalog Grouppost
Update Catalog Itempost
/api/v1.0/{appId}/channels/{id}get
Update customer of an app by Idpost
[PRIVATE] Invite driverpost
Adds a delivery zone to the store idpost
Update driver profilepost
Get menu events For technical reasons, the number of records returned is limited to 100.get
/api/v1.0/heartbeathead
[PRIVATE API] Get Home Statisticsget
/api/v1.0/hydra/registrationget
Get all kiosk settings associated with a storeget
/api/v1.0/lightspeed/{storeId}/settingspost
Create menu item option set itempost
Create menu item option setpost
Create a new menu. If request body is empty, the system will create a menu with default items.post
Create menu section itempost
Create menu sectionpost
Get a Metafield Definition for the specified owner entity and key.get
Get OAuth App by identifierget
/api/v1.0/clients/{appId}/onboarding/stores/{storeId}/items/{onboardingItemId}post
Get order delivery informationget
Get list of payout summariesget
Export payout's details as CSVget
Archive a product. If the product is used in Menus, the related MenuItems will be marked as deletedpost
[PRIVATE] Push notification to cutomerspost
Updates Store Grouppost
Create or update a store's order capacity configurationpost
Update store by identifierpost
Gets the current verification status of the given connected accountget
Set stuart settings for a storepost
Create teammate and send an invite.post
/api/v1.0/users/{userId}/previousordercount/{storeId}get
Create account with email address and store namepost
[PRIVATE API] Get Calendar statisticsget
Get the application compliance configurationget
Delete app store appdelete
Get app store app configurationget
Get BankAccount Detail by Idget
Creates loyalty campaignpost
Get Location ID for Stripe Terminalpost
Get paginated groups by app name id filtered by typesget
Get paginated items by app name id filtered by typesget
Returns a list of sales channels that are assigned to a given whitelabelget
Assign driver to multiple orderspost
Updates the existing delivery zonepost
Get stores for driverget
Get user events For technical reasons, the number of records returned is limited to 100.get
/api/v1.0/heartbeat/Hostnameget
[PRIVATE API] Complete Home Actionpost
List EMV terminals belonging to the given AppNameIdget
/api/v1.0/{appId}/kiosksettings/cashpost
/api/v1.0/lightspeed/{storeId}/menu/generatepost
Get menu item option set item by identifierget
Get menu item option set by identifierget
Get menu by identifierget
Get menu item by identifierget
Get menu section by identifierget
Update a Metafield Definitionpost
Update OAuth Apppost
Add/update delivery-related information to an orderpost
Get list of payoutsget
Export a list of payout's orders as CSVget
Duplicate a productpost
[PRIVATE] Update the push notificationpost
Deletes a Store Group Can only remove a store group if there is no stores attached to the groupdelete
Get Stores Bank Account Idget
Create a new Bank Account and Stripe connected accountpost
Get start job detailsget
Get a teammates by email addressget
[PRIVATE API] Get timezones localised to users languageget
[PRIVATE API] Get paginated APM call listget
Set the application compliance configurationpost
Get list of app store app summariesget
Update app store app configurationput
Update BankAccountpost
Gets retention campaigns for appget
Get Authorization Key for Stripe Terminalpost
Create a Catalog Grouppost
Create a Catalog Itempost
Returns a list of sales channels that are not yet assigned to a given whitelabelget
[PRIVATE] Assign driver to orderpost
Removes the existing delivery zonedelete
[PRIVATE] Request an SMS to be sent to the driver with their login codepost
Get order events For technical reasons, the number of records returned is limited to 100.get
/api/v1.0/heartbeat/Hostnamehead
[PRIVATE API] Complete Home Actionpost
[Private]post
Update menu item option set itempost
Update menu item option setpost
Update menupost
Update menu section itempost
Update menu sectionpost
Get Metafield Definitions for the specified owner entity.get
Delete OAuth Appdelete
Get orders by filterget
Get list of payout's ordersget
Export a list of payout's refunds as CSVget
[PRIVATE] Push notification to cutomersdelete
Returns a paginated list of Store Groupsget
Retrieve Store Service Chargeget
Create or update a Stripe connected account associated with the bank account of bankAccountIdpost
Cancel a stuart jobdelete
Update teammates (this method does not support Deltas!)post
Change passwordput
[PRIVATE API] Get Calls Statisticsget
Get panacea vanity url. This sets the URL which the Panacea website is available at. ie. my.flipdish.com/[vanityurl]get
Create app store apppost
Delete app store app configurationdelete
Delete BankAccountdelete
Creates retention campaignpost
Initiate stripe terminal pairing modepost
Archive Catalog Grouppost
Upload a Catalog Item Imagepost
Returns a list of store ids attached to the given channel type for the specified app.get
[PRIVATE] Unassign driver from appdelete
[PRIVATE] Login with phone number and pinpost
Get store events For technical reasons, the number of records returned is limited to 100.get
[Private]get
Delete menu item option set itemdelete
Delete menu item option setdelete
[PRIVATE API]Mark a Menu as Deleteddelete
Delete menu section itemdelete
Delete menu sectiondelete
Create a Metafield Definitionpost
Get OAuth App secret keyget
[PRIVATE API] Get summary of orders by filterget
Get list of payout's refundsget
Export a list of payout's chargebacks as CSVget
Creates a Store Group It will be attached to an existing Apppost
Configure Store Service Charge; Idempotent Operationpost
Update bank account's BusinessType and create a Stripe Connected Accountpost
Delete teammatedelete
Reset password with token.post
[PRIVATE API] Get Order Statistics (Value of Orders)get
Set panacea vanity urlpost
Update app store app verificationput
Create app store app configurationpost
Get bank account fields definitionsget
Gets loyalty campaigns for storeget
Cancel currently initiated install update for bluetooth terminalpost
Duplicate Catalog Grouppost
Delete a CatalogItem Imagedelete
Detaches all the stores from the given sales channel.delete
[PRIVATE] Unassign driver from orderdelete
Add driver tokenpost
Get customer events For technical reasons, the number of records returned is limited to 100.get
Get the status of Cash Payment Methon on Kisokget
Upload menu item option set item imagepost
Upload menu item option set imagepost
[PRIVATE API]Get menus tax detailsget
Create menu section items from a list of Productspost
Clone menu sectionpost
Get OwnerEntity Definition Recommendationsget
Get OAuth access token for Appget
Accept orderpost
Get list of payout's chargebacksget
Export a list of payout's other charges as CSVget
[PRIVATE API] Returns a paginated list of Extended Store Groupsget
Get store end of day reportget
Update bank account detailspost
Redeem one-time code from invitationget
Change passwordput
Get the application hostname DNS delegation states for A and CNAME records.get
Upload the app store app logo \ iconpost
Get bank account fields definitionsget
Gets retention campaigns for storeget
Initiate Kiosk Update Install for bluetooth terminalpost
Archive Catalog Itempost
Returns a list of store that are assigned to the given sales channel.get
Delete driver tokendelete
Get WhiteLabel events For technical reasons, the number of records returned is limited to 100.get
[Private]get
Delete menu item option set item imagedelete
Delete option set imagedelete
[PRIVATE API]Get Menus Nameget
Create menu section items from a list of Catalog Itemspost
Upload menu section imagepost
Get OAuth App redirect urisget
Refund orderpost
Get list of payout's other chargesget
Get Business hoursget
Gets a single-use Stripe URL for the given accountpost
Request login PIN. The server sends the PIN to the email address.post
Get Appsget
[PRIVATE API] Update State of Bank Accountpost
Updates loyalty campaignpost
Trigger check for Bluetooth device update on Kioskpost
Duplicate Catalog Itempost
/api/v1.0/{appId}/channels/channelstoresget
Set driver profile image and returns it's urlpost
Get order events by customer For technical reasons, the number of records returned is limited to 100.get
[Private]get
[Private API] Set Tax Rate on OptionSetItempost
[PRIVATE API]Set Menus Namepost
Clone menu section itempost
Delete menu section imagedelete
Create OAuth App redirect uripost
Reject orderpost
Set Business hourspost
Login with username and passwordpost
Is panacea vanity url availableget
[PRIVATE API] Attach Bank Account to Storepost
Updates retention campaignpost
Unpair the currently paired stripe terminaldelete
/api/v1.0/{appId}/channels/channelstorespost
Delete driver profile imagedelete
Get events For technical reasons, the number of records returned is limited to 100.get
[Private]get
[PRIVATE API]Get menus store namesget
Upload menu section item imagepost
Create menu availability typepost
Get all OAuth Appsget
Dispatch orderpost
Get the pre order config for a store, by typeget
Log out. It removes Flipdish authorization Cookie.post
Get Appsget
Deletes a campaigndelete
Assign a given AppId to a Sales Channelpost
/api/v1.0/drivers/stores/{storeId}/presence/{presence}post
[Private]post
[PRIVATE API]Get a Menus Checkpointsget
Delete menu section item imagedelete
Re-arrange Items within a Sectionpost
Create OAuth Apppost
UPDATE pre order config for a store, by typepost
Login with username and passwordpost
Set the application logo \ iconpost
Attachs the specified store to the given sales channel.post
Change delivery tracking status and return the updated status.post
/api/v1.0/{appId}/hydra/cancelemvpayment/{orderId}post
Get all menu metadata by menu ID and store IDget
[PRIVATE API]Move an Item within a menupost
Set/update menu section availability hours.post
Delete OAuth App redirect uridelete
Get the Preview times of the pre-order configurationget
Request password reset. Flipdish system will send a token via email.post
Gain Support access to a given AppIdpost
Detaches the specified store from the given sales channel.delete
[Private]post
/api/v1.0/menus/{menuId}/bulkshowhide/listget
[PRIVATE API]Move an Item within a menupost
Get processing fee configs by store identifierget
Skip a signup questionpost
Set the application configurationpost
Assign a Store to a Sales Channelpost
[Private]post
Get menu item metadataget
Get all stores by app name idget
Answer a signup questionpost
Set the application languagespost
Unassign a Store from a Sales Channelpost
Unassign the currently assigned EMV terminal from a kioskpost
Update menu item metadataput
Get stores statistics by app name id and storeIdsget
Set the application hostname.post
[Private]post
Get menu item metadata by keyget
Get business hours overrides by store identifierget
Assign an EMV terminal to a kioskpost
Delete menu item metadatadelete
Create Business Hours Override for a storepost
[Private]post
Get menu item option set item metadata by keyget
Get all stores by app name idget
Update the Cash Payment Methon Visiability on Kisokpost
Update menu item option set item metadataput
Get processing fee configs by store identifierget
[Private]delete
Create a new menu from xlsx file.post
Get all stores, excluding archived onesget
[Private]delete
[PRIVATE API]Lock/Unlock a Menu for Editingpost
Create store with Store Group identifierpost
[Private]delete
Upload menu imagepost
Clone store with store clone settingspost
Delete menu imagedelete
Update store addresspost
[PRIVATE API]Add/Update a Tax Ratepost
Archive storepost
[PRIVATE API]Clone a menu, (without attaching stores)post
Publish storepost
[PRIVATE API]Set if tax shows for a Menupost
Unpublish storepost
[PRIVATE API]Set the type of Tax on a Menupost
Assign Menu to Storepost
[PRIVATE API]Re-arrange Sections within a Menupost
Update store address coordinatespost
[PRIVATE API]Restore a Menu to a checkpointpost
UPDATE pre order config for a store, by typepost
/api/v1.0/menus/{menuId}/bulkshowhidepost
Delete Business Hours Override for a storedelete
[PRIVATE API]Remove a Menus Tax Rate, can only remove a tax rate that does not have items/optionSetItems attacheddelete
Vouchers
Webhooks
Website

Powered by

Gets all the menu zones for a menu

get https://api.flipdish.co/api/v1.0/menus/{menuId}/zones

Language

Authorization

OAuth2

Bearer

Click Try It! to start a request and see the response here!