Flipdish
Home
Guides
API Reference
{{user.name}}
Log In
Welcome to the Flipdish developer hub. You'll find comprehensive guides and documentation to help you start working with Flipdish as quickly as possible, as well as support if you get stuck. Let's jump right in!
>
POS integration quick start guide
>
Driver dispatch integration quick start guide
If you need assistance, please email us at
[email protected]
v1.0
Home
Guides
Recipes
API Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
Guides
API Reference
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Documentation
Getting Started with Flipdish API
Flipdish SDK
Menu Structure
User Agents
Webhooks
Using webhooks
Creating webhooks
Webhook events
Customer webhook events
Menu webhook events
Order webhook events
Store webhook events
Webhook subscription webhook events
Flipdish API
API Reference
Accessing logs
Menu editing
Menu Sections
Menu Section Items
Menu Option Sets
Menu Option Set Items
How to
Build a Flipdish Client with WPF
Build a POS Integration
Tips for building a POS integration
Driver dispatch integration
Automate store creation and setup
Models
Definitions
StoreDeletedEvent
PhoneCall
PrinterTurnedOffEvent
PrinterTurnedOnEvent
OauthClientRedirectUri
OAuthClient
PhoneCallStartedEvent
Printer
CampaignCreatedEvent
Menu
MenuBase
MenuCreatedEvent
HttpRequestAndResponseLog
LoyaltyCampaign
MenuSectionItemBase
MenuUpdatedEvent
EventSearchResult
Coordinates
StoreNote
StoreOpeningHoursUpdatedEvent
CreateAccount
PhoneCallStartedEvent
Printer
PrinterTurnedOffEvent
PrinterUnassignedFromStoreEvent
Range
LoyaltyCampaignCreatedEvent
Order
RetentionCampaignDeletedEvent
RetentionCampaignUpdatedEvent
Accept
BusinessHoursPeriod
CardWithToken
CreateAccountModel
CustomerCreatedEvent
CustomerSummary
CustomerUpdatedEvent
DeliveryFeeArea
DeliveryLocation
HttpRequestAndResponseLog
LoginModel
LoyaltyCampaignCreatedEvent
Menu
MenuBase
MenuItemOptionSetItem
MenuSectionAvailability
MenuSectionBase
MenuUpdatedEvent
Metadata
OauthClientRedirectUri
OAuthTokenModel
Order
OrderAcceptedEvent
OrderCreatedEvent
OrderItem
OrderItemOption
OrderRatingUpdatedEvent
OrderRejectedEvent
OrderTipUpdatedEvent
PhoneCallEndedEvent
PrinterAssignedToStoreEvent
PrinterTurnedOffEvent
Range
Refund
RestApiEventSearchPaginationResult
RestApiUnauthorizedResult
RetentionCampaignUpdatedEvent
ChangePasswordModel
Coordinates
FeeSummary
MenuItemOptionSetBase
MenuSectionItemBase
PhoneCallStartedEvent
Printer
RestApiForbiddenResult
RestApiStringResult
SearchCriteria
StoreAddressBase
StoreDeliveryZoneUpdatedEvent
StoreUpdatedEvent
BusinessHoursPeriod
CustomerCreatedEvent
CustomerSummary
DeliveryFeeArea
DeliveryLocation
LoyaltyCampaign
MenuBase
MenuItemOptionSetItemBase
MenuSection
MenuSectionItem
OAuthTokenModel
OrderItemOption
OrderTipUpdatedEvent
PasswordResetModel
PhoneCall
PrinterTurnedOnEvent
PrinterUnassignedFromStoreEvent
RestApiDefaultResponse
RetentionCampaignDeletedEvent
Store
UserEventInfo
LoyaltyCampaignDeletedEvent
LoyaltyCampaignUpdatedEvent
MenuSectionBase
OrderRatingUpdatedEvent
RestApiUnauthorizedResult
SearchCriteria
SmsInfo
StoreAddressBase
StoreCreatedEvent
StoreDeletedEvent
StoreSummary
UserCreatedEvent
UserDeletedEvent
ValidationErrorResult
Voucher
WebhookLog
WebhookSubscription
WebhookSubscriptionCreatedEvent
WebhookSubscriptionDeletedEvent
WebhookSubscriptionEventInfo
CardWithToken
LoyaltyCampaignUpdatedEvent
Menu
MenuBase
OrderAcceptedEvent
OrderCreatedEvent
PrinterAssignedToStoreEvent
OrderRejectedEvent
SubscriptionBase
Menu
Reject
HttpRequestAndResponseLog
PredefinedAnswer
Printer
StoreAddressBase
StoreCreatedEvent
CustomerSummary
LoyaltyCampaignDeletedEvent
LoyaltyCampaignUpdatedEvent
MenuSectionBase
Accept
WebhookLog
WebhookSubscription
DeliveryLocation
EventSearchResult
StoreCreatedEvent
EventSearchResult
Range
Refund
CreateAccountModel
CustomerConsentUpdatedEvent
DeliveryFeeArea
DeliveryLocation
EventSearchResult
FeeSummary
HttpRequestAndResponseLog
LoginModel
LoyaltyCampaign
LoyaltyCampaignCreatedEvent
LoyaltyCampaignUpdatedEvent
MenuCreatedEvent
MenuBase
MenuCreatedEvent
Reject
RestApiForbiddenResult
RestApiIntegerResult
OrderTipUpdatedEvent
SmsInfo
UserEventInfo
Printer
DeliveryFeeArea
Documentation
Getting Started with Flipdish API
Flipdish SDK
Menu Structure
User Agents
Webhooks
Using webhooks
Creating webhooks
Webhook events
Customer webhook events
Menu webhook events
Order webhook events
Store webhook events
Webhook subscription webhook events
Flipdish API
API Reference
Accessing logs
Menu editing
Menu Sections
Menu Section Items
Menu Option Sets
Menu Option Set Items
How to
Build a Flipdish Client with WPF
Build a POS Integration
Tips for building a POS integration
Driver dispatch integration
Automate store creation and setup
Models
Definitions
StoreDeletedEvent
PhoneCall
PrinterTurnedOffEvent
PrinterTurnedOnEvent
OauthClientRedirectUri
OAuthClient
PhoneCallStartedEvent
Printer
CampaignCreatedEvent
Menu
MenuBase
MenuCreatedEvent
HttpRequestAndResponseLog
LoyaltyCampaign
MenuSectionItemBase
MenuUpdatedEvent
EventSearchResult
Coordinates
StoreNote
StoreOpeningHoursUpdatedEvent
CreateAccount
PhoneCallStartedEvent
Printer
PrinterTurnedOffEvent
PrinterUnassignedFromStoreEvent
Range
LoyaltyCampaignCreatedEvent
Order
RetentionCampaignDeletedEvent
RetentionCampaignUpdatedEvent
Accept
BusinessHoursPeriod
CardWithToken
CreateAccountModel
CustomerCreatedEvent
CustomerSummary
CustomerUpdatedEvent
DeliveryFeeArea
DeliveryLocation
HttpRequestAndResponseLog
LoginModel
LoyaltyCampaignCreatedEvent
Menu
MenuBase
MenuItemOptionSetItem
MenuSectionAvailability
MenuSectionBase
MenuUpdatedEvent
Metadata
OauthClientRedirectUri
OAuthTokenModel
Order
OrderAcceptedEvent
OrderCreatedEvent
OrderItem
OrderItemOption
OrderRatingUpdatedEvent
OrderRejectedEvent
OrderTipUpdatedEvent
PhoneCallEndedEvent
PrinterAssignedToStoreEvent
PrinterTurnedOffEvent
Range
Refund
RestApiEventSearchPaginationResult
RestApiUnauthorizedResult
RetentionCampaignUpdatedEvent
ChangePasswordModel
Coordinates
FeeSummary
MenuItemOptionSetBase
MenuSectionItemBase
PhoneCallStartedEvent
Printer
RestApiForbiddenResult
RestApiStringResult
SearchCriteria
StoreAddressBase
StoreDeliveryZoneUpdatedEvent
StoreUpdatedEvent
BusinessHoursPeriod
CustomerCreatedEvent
CustomerSummary
DeliveryFeeArea
DeliveryLocation
LoyaltyCampaign
MenuBase
MenuItemOptionSetItemBase
MenuSection
MenuSectionItem
OAuthTokenModel
OrderItemOption
OrderTipUpdatedEvent
PasswordResetModel
PhoneCall
PrinterTurnedOnEvent
PrinterUnassignedFromStoreEvent
RestApiDefaultResponse
RetentionCampaignDeletedEvent
Store
UserEventInfo
LoyaltyCampaignDeletedEvent
LoyaltyCampaignUpdatedEvent
MenuSectionBase
OrderRatingUpdatedEvent
RestApiUnauthorizedResult
SearchCriteria
SmsInfo
StoreAddressBase
StoreCreatedEvent
StoreDeletedEvent
StoreSummary
UserCreatedEvent
UserDeletedEvent
ValidationErrorResult
Voucher
WebhookLog
WebhookSubscription
WebhookSubscriptionCreatedEvent
WebhookSubscriptionDeletedEvent
WebhookSubscriptionEventInfo
CardWithToken
LoyaltyCampaignUpdatedEvent
Menu
MenuBase
OrderAcceptedEvent
OrderCreatedEvent
PrinterAssignedToStoreEvent
OrderRejectedEvent
SubscriptionBase
Menu
Reject
HttpRequestAndResponseLog
PredefinedAnswer
Printer
StoreAddressBase
StoreCreatedEvent
CustomerSummary
LoyaltyCampaignDeletedEvent
LoyaltyCampaignUpdatedEvent
MenuSectionBase
Accept
WebhookLog
WebhookSubscription
DeliveryLocation
EventSearchResult
StoreCreatedEvent
EventSearchResult
Range
Refund
CreateAccountModel
CustomerConsentUpdatedEvent
DeliveryFeeArea
DeliveryLocation
EventSearchResult
FeeSummary
HttpRequestAndResponseLog
LoginModel
LoyaltyCampaign
LoyaltyCampaignCreatedEvent
LoyaltyCampaignUpdatedEvent
MenuCreatedEvent
MenuBase
MenuCreatedEvent
Reject
RestApiForbiddenResult
RestApiIntegerResult
OrderTipUpdatedEvent
SmsInfo
UserEventInfo
Printer
DeliveryFeeArea
Flipdish Orders
Application config
get
Get app config
Customer account
post
Request login SMS code
post
Login with SMS code
get
Get account details
get
Log off
Payment accounts
get
Get payment accounts
post
Create card payment account
post
Set default payment account
delete
Delete payment account
Restaurants
get
Get list of pickup/collection restaurants summaries
get
Get pickup/collection restaurant detail
get
Get list of delivery restaurant summaries
get
Get delivery restaurant detail
Delivery locations
get
Get delivery locations
post
Create delivery location
put
Update delivery location
delete
Delete delivery location
Orders
post
Create order
post
Apply voucher code to order
get
Submit order
Flipdish Open API v1.0
Accounts
get
Gets the current account detail
put
Update account with name and language
post
Create account with email address and store name
get
[PRIVATE API] Get timezones localised to users language
put
Change password
post
Reset password with token.
put
Change password
post
Request login PIN. The server sends the PIN to the email address.
post
Login with username and password
post
Log out. It removes Flipdish authorization Cookie.
post
Login with username and password
post
Request password reset. Flipdish system will send a token via email.
post
Skip a signup question
post
Answer a signup question
Apm
get
[PRIVATE API] Returns true if APM is enabled on at least one store in an application
get
[PRIVATE API] Get Basic Statistics
get
[PRIVATE API] Get Calendar statistics
get
[PRIVATE API] Get paginated APM call list
get
[PRIVATE API] Get Calls Statistics
get
[PRIVATE API] Get Order Statistics (Value of Orders)
Apps
get
Get the application configuration
get
Get the application configuration
get
Get the application compliance configuration
post
Set the application compliance configuration
get
Get panacea vanity url
post
Set panacea vanity url
get
Get the application hostname DNS delegation states for A and CNAME records.
get
Get Apps
get
Is panacea vanity url available
post
Set the application logo \ icon
post
Set the application configuration
post
Set the application languages
post
Set the application hostname.
AuthorizationTokens
get
Get authorization tokens
delete
Revoke token
BankAccount
get
Get List of BankAccounts for WL
post
Create a new Bank Account and attach to this App
get
Get BankAccount Detail by Id
post
Update BankAccount
delete
Delete BankAccount
get
Get bank account fields definitions
get
Get bank account fields definitions
post
[PRIVATE API] Update State of Bank Account
post
[PRIVATE API] Attach Bank Account to Store
Campaigns
get
Gets list of stores for app
get
Gets loyalty campaigns for app
post
Creates loyalty campaign
get
Gets retention campaigns for app
post
Creates retention campaign
get
Gets loyalty campaigns for store
get
Gets retention campaigns for store
post
Updates loyalty campaign
post
Updates retention campaign
delete
Deletes a campaign
ContentSecurityPolicy
post
/api/v1.0/csp/report
Customers
get
Get customer of an app by Id
post
Update customer of an app by Id
DeliveryTracking
get
[PRIVATE] Get drivers by App
post
[PRIVATE] Invite driver
post
Assign driver to multiple orders
post
[PRIVATE] Assign driver to order
delete
[PRIVATE] Unassign driver from app
delete
[PRIVATE] Unassign driver from order
DeliveryZone
get
Get all the delivery zones associated with a store
post
Adds a delivery zone to the store id
post
Updates the existing delivery zone
delete
Removes the existing delivery zone
Drivers
get
Get driver profile
post
Update driver profile
get
Get stores for driver
post
[PRIVATE] Request an SMS to be sent to the driver with their login code
post
[PRIVATE] Login with phone number and pin
post
Add driver token
delete
Delete driver token
post
Set driver profile image and returns it's url
delete
Delete driver profile image
post
/api/v1.0/drivers/stores/{storeId}/presence/{presence}
post
Change delivery tracking status and return the updated status.
Events
get
Get event by Id For technical reasons, the number of records returned is limited to 100.
get
Get menu events For technical reasons, the number of records returned is limited to 100.
get
Get user events For technical reasons, the number of records returned is limited to 100.
get
Get order events For technical reasons, the number of records returned is limited to 100.
get
Get store events For technical reasons, the number of records returned is limited to 100.
get
Get customer events For technical reasons, the number of records returned is limited to 100.
get
Get WhiteLabel events For technical reasons, the number of records returned is limited to 100.
get
Get order events by customer For technical reasons, the number of records returned is limited to 100.
get
Get events For technical reasons, the number of records returned is limited to 100.
Heartbeat
get
/api/v1.0/heartbeat
head
/api/v1.0/heartbeat
get
/api/v1.0/heartbeat/Hostname
head
/api/v1.0/heartbeat/Hostname
Home
get
[PRIVATE API] Get Home Actions
get
[PRIVATE API] Get Home Statistics
post
[PRIVATE API] Complete Home Action
post
[PRIVATE API] Complete Home Action
HttpRequestResponseLogs
get
Get API interaction logs
Hydra
get
[Private]
get
/api/v1.0/hydra/registration
get
List EMV terminals belonging to the given AppNameId
post
[Private]
get
[Private]
get
[Private]
get
[Private]
post
[Private]
post
/api/v1.0/{appId}/hydra/cancelemvpayment/{orderId}
post
[Private]
post
[Private]
post
Unassign the currently assigned EMV terminal from a kiosk
post
Assign an EMV terminal to a kiosk
post
[Private]
delete
[Private]
delete
[Private]
Lightspeed
get
/api/v1.0/lightspeed/{storeId}/settings
post
/api/v1.0/lightspeed/{storeId}/settings
post
/api/v1.0/lightspeed/{storeId}/menu/generate
MenuOptionSetItems
get
Get menu item option set items
post
Create menu item option set item
get
Get menu item option set item by identifier
post
Update menu item option set item
delete
Delete menu item option set item
post
Upload menu item option set item image
delete
Delete menu item option set item image
post
[Private API] Set Tax Rate on OptionSetItem
MenuOptionSets
get
Get menu item option sets
post
Create menu item option set
get
Get menu item option set by identifier
post
Update menu item option set
delete
Delete menu item option set
post
Upload menu item option set image
delete
Delete option set image
Menus
get
[PRIVATE API]Get menus by appId
post
Create a new menu. If request body is empty, the system will create a menu with default items.
get
Get menu by identifier
post
Update menu
delete
[PRIVATE API]Mark a Menu as Deleted
get
[PRIVATE API]Get menus tax details
get
[PRIVATE API]Get menus store names
get
[PRIVATE API]Get a Menus Checkpoints
get
Get all menu metadata by menu ID and store ID
get
Get menu item metadata
put
Update menu item metadata
get
Get menu item metadata by key
delete
Delete menu item metadata
get
Get menu item option set item metadata by key
put
Update menu item option set item metadata
post
Create a new menu from xlsx file.
post
[PRIVATE API]Lock/Unlock a Menu for Editing
post
[PRIVATE API]Set Menus Name
post
Upload menu image
delete
Delete menu image
post
[PRIVATE API]Add/Update a Tax Rate
post
[PRIVATE API]Clone a menu, (without attaching stores)
post
[PRIVATE API]Set if tax shows for a Menu
post
[PRIVATE API]Set the type of Tax on a Menu
post
[PRIVATE API]Re-arrange Sections within a Menu
post
[PRIVATE API]Restore a Menu to a checkpoint
delete
[PRIVATE API]Remove a Menus Tax Rate, can only remove a tax rate that does not have items/optionSetItems attached
MenuSectionItems
get
Get menu items
post
Create menu section item
get
Get menu item by identifier
post
Update menu section item
delete
Delete menu section item
post
Clone menu section item
post
Upload menu section item image
delete
Delete menu section item image
post
[PRIVATE API]Move an Item within a menu
post
[PRIVATE API]Move an Item within a menu
MenuSections
get
Get menu sections
post
Create menu section
get
Get menu section by identifier
post
Update menu section
delete
Delete menu section
post
Clone menu section
post
Upload menu section image
delete
Delete menu section image
post
Create menu availability type
post
Re-arrange Items within a Section
post
Set/update menu section availability hours.
OAuthClients
get
/api/v1.0/{appId}/oauthclients/appnames
get
Get OAuth App by identifier
post
Update OAuth App
delete
Delete OAuth App
get
Get OAuth App secret key
get
Get OAuth access token for App
get
Get OAuth App redirect uris
post
Create OAuth App redirect uri
get
Get all OAuth Apps
post
Create OAuth App
delete
Delete OAuth App redirect uri
Orders
get
Get order by ID
get
Get orders by filter
get
[PRIVATE API] Get summary of orders by filter
post
Accept order
post
Refund order
post
Reject order
post
Dispatch order
Payouts
get
Get Payout details broken down by Store
get
Get list of payout summaries
get
Get list of payouts
get
Get list of payout's orders
get
Get list of payout's refunds
get
Get list of payout's chargebacks
get
Get list of payout's other charges
ProcessingFeeConfigs
get
Get processing fee configs by store identifiers
PushNotifications
get
[PRIVATE] Push notification to cutomers
post
[PRIVATE] Push notification to cutomers
post
[PRIVATE] Update the push notification
delete
[PRIVATE] Push notification to cutomers
StoreGroups
get
Returns a Store Groups
post
Updates Store Group
delete
Deletes a Store Group Can only remove a store group if there is no stores attached to the group
get
Returns a paginated list of Store Groups
post
Creates a Store Group It will be attached to an existing App
get
[PRIVATE API] Returns a paginated list of Extended Store Groups
StoreOrderCapacity
get
Get store's order capacity configuration
post
Create or update a store's order capacity configuration
Stores
get
Get store by identifier
post
Update store by identifier
get
Get Stores Bank Account Id
get
Get store end of day report
get
Get Business hours
post
Set Business hours
get
Get the pre order config for a store, by type
post
UPDATE pre order config for a store, by type
get
Get the Preview times of the pre-order configuration
get
Get processing fee configs by store identifier
get
Get all stores by app name id
get
Get stores statistics by app name id and storeIds
get
Get business hours overrides by store identifier
post
Create Business Hours Override for a store
get
Get all stores by app name id
get
Get processing fee configs by store identifier
get
Get all stores, excluding archived ones
post
Create store with Store Group identifier
post
Clone store with store clone settings
post
Update store address
post
Archive store
post
Publish store
post
Unpublish store
post
Assign Menu to Store
post
Update store address coordinates
post
UPDATE pre order config for a store, by type
delete
Delete Business Hours Override for a store
StripeCustomConnect
get
/api/v1.0/{appId}/customconnect/refresh-link
get
Gets the current verification status of the given connected account
post
Create a new Bank Account and Stripe connected account
post
Create or update a Stripe connected account associated with the bank account of bankAccountId
post
Update bank account's BusinessType and create a Stripe Connected Account
post
Update bank account details
post
Gets a single-use Stripe URL for the given account
Stuart
get
Get stuart settings for a store
post
Set stuart settings for a store
get
Get start job details
delete
Cancel a stuart job
Teammates
get
Get all teammates
post
Create teammate and send an invite.
get
Get a teammates by email address
post
Update teammates (this method does not support Deltas!)
delete
Delete teammate
get
Redeem one-time code from invitation
Users
get
Get role names
get
/api/v1.0/users/{userId}/previousordercount/{storeId}
Vouchers
get
[PRIVATE API] Get voucher by identifier
post
[PRIVATE API] Updates voucher
get
[PRIVATE API] Get voucher stats by identifier
get
[PRIVATE API] Get vouchers summaries for App Id
post
[PRIVATE API] Create voucher
Webhooks
get
Get all webhook subscription event names
get
Get all webhook subscriptions by your Oauth App id
post
Create a webhook subscription for you Oauth App
get
Get your webhook subscriptions selected event names
get
Get a sample event from a webhook subscription
get
Get logs for your webhook subscription
put
Update a webhook subscription object
delete
Delete you webhook subscription
post
Add event name to your webhook subscription
delete
Remove event name to your webhook subscription
Website
get
Get Index Configuration
post
Set Index Configuration
get
Triggers a Check DNS Process
post
Add a testimonial
post
Upload Website Image
post
Edit a testimonial
delete
Delete a testimonial
delete
Delete Website Image
Flipdish Reporting V1
AdminApi
post
Modifies the visibility of the parameter
post
Modifies the visibility of the parameter
CsvApi
get
If successful will redirect to a download file
CustomerApi
get
Returns customers of the app to which you have access
get
Returns customer overview of the whitelabel accessible by the user role
get
Returns the list of orders for a particular customer
get
Returns the name, phone number and email
CustomerManagementApi
get
Returns customers of the app to which you have access
get
Returns customer overview of the whitelabel accessible by the user role
get
Returns the list of orders for a particular customer
get
Returns the name, phone number and email
DeliveryZoneApi
get
Returns all delivery zones associated with the query
MaintenancePrivateApi
post
/maintenance/remap/{domain}
post
/maintenance/reindex/{domain}
OrderApi
get
Returns orders overview based on the query
get
Returns orders heatmap
get
Returns orders by store
get
Returns orders by store
get
Returns orders per platform
get
Returns orders per platform
get
Returns orders per platform
get
Returns rejected orders by store
get
Returns the list of orders
get
Returns the list of rejected orders
StoresApi
get
Returns top X stores that match the query
VoucherApi
get
Returns top X vouchers that match the query
Powered by