Jump to Content
Home
Guides
API Reference
Home
Guides
API Reference
v1.0
Home
Guides
API Reference
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
API Reference
/api/v1.0/stuart/jobs/{jobId}
Search
JUMP TO
Flipdish Orders
Application config
Get app config
get
Customer account
Request login SMS code
post
Login with SMS code
post
Get account details
get
Log off
get
Payment accounts
Get payment accounts
get
Create card payment account
post
Set default payment account
post
Delete payment account
delete
Restaurants
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
get
Delivery locations
Get delivery locations
get
Create delivery location
post
Update delivery location
put
Delete delivery location
delete
Orders
Create order
post
Apply voucher code to order
post
Submit order
get
Flipdish Open API v1.0
Accounts
/api/v1.0/accounts
get
/api/v1.0/accounts
put
/api/v1.0/accounts
post
/api/v1.0/accounts/timezones
get
/api/v1.0/accounts/password
put
/api/v1.0/accounts/password
post
/api/v1.0/accounts/password/pin
put
/api/v1.0/accounts/pin
post
/api/v1.0/accounts/login
post
/api/v1.0/accounts/logout
post
/api/v1.0/accounts/login/pin
post
/api/v1.0/accounts/login/sso
post
/api/v1.0/accounts/basic-account
post
/api/v1.0/accounts/passwordreset
post
/api/v1.0/accounts/password/resetpin
post
/api/v1.0/accounts/recaptcha
post
/api/v1.0/accounts/signupstep/{signupStepAction}/skip
post
/api/v1.0/accounts/signupstep/{signupStepAction}/answer
post
Address
/api/v1.0/address/countries
get
/api/v1.0/app/{appId}/address/form
get
/api/v1.0/address/country/{countryCode}/form
get
/api/v1.0/address/templates
post
/api/v1.0/address/google
post
Apm
/api/v1.0/{appId}/apm/status
get
/api/v1.0/{appId}/apm/statistics
get
/api/v1.0/{appId}/apm/statistics/calendar
get
/api/v1.0/{appId}/apm/calls
get
/api/v1.0/{appId}/apm/statistics/calls/{aggregateDataBy}
get
/api/v1.0/{appId}/apm/statistics/orders/{aggregateDataBy}
get
Apps
/api/v1.0/apps/{appId}
get
/api/v1.0/apps/supportedcountries
get
/api/v1.0/apps/{appId}/compliance
get
/api/v1.0/apps/{appId}/compliance
post
/api/v1.0/apps/{appId}/panacea/url
get
/api/v1.0/apps/{appId}/panacea/url
post
/api/v1.0/apps/{whitelabelId}/lookup
get
/api/v1.0/apps/{appId}/hostnamestatus
get
/api/v1.0/apps
get
/api/v1.0/apps
post
/api/v1.0/apps/{appId}/panacea/url/available
get
/api/v1.0/apps/{appId}/logo
post
/api/v1.0/apps/{appId}/config
post
/api/v1.0/apps/{appId}/appstorename
post
/api/v1.0/apps/{appId}/orgId/{orgId}
post
/api/v1.0/apps/{appId}/config/languages
post
/api/v1.0/apps/{appId}/hostname
post
/api/v1.0/apps/{appId}/nextgenweb
post
AppStore
/api/v1.0/appstore/apps/{appStoreAppId}
get
/api/v1.0/appstore/apps
get
AppStoreConfigurations
/api/v1.0/{appId}/appstore/apps
get
/api/v1.0/{appId}/appstore/apps/{appStoreAppId}
get
/api/v1.0/appstore/oauthresponse/{appStoreAppId}/responsecode
get
/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}
get
/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}
put
/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}
delete
/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config
post
/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}/action
post
/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}/updatesettings
post
AppStoreDeveloper
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/external_product
get
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/external_product
put
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/external_function_signing_key
get
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}
put
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}
delete
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/verification
put
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps
post
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/logo
post
AppStoreEntitlements
/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/entitlements
get
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
/api/v1.0/{appId}/bankaccounts
get
/api/v1.0/{appId}/bankaccounts
post
/api/v1.0/{appId}/bankaccounts/{bankAccountId}
get
/api/v1.0/{appId}/bankaccounts/{bankAccountId}
post
/api/v1.0/{appId}/bankaccounts/{bankAccountId}
delete
/api/v1.0/{appId}/bankaccounts/field-definitions
get
/api/v1.0/{appId}/bankaccounts/countries-field-definitions
get
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/state/{state}
post
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/store/{storeId}
post
Campaigns
/api/v1.0/{appId}/campaigns/loyalty
get
/api/v1.0/{appId}/campaigns/loyalty
post
/api/v1.0/{appId}/campaigns/retention
get
/api/v1.0/{appId}/campaigns/retention
post
/api/v1.0/{appId}/campaigns/loyalty/{storeId}
get
/api/v1.0/{appId}/campaigns/retention/{storeId}
get
/api/v1.0/{appId}/campaigns/stores
get
/api/v1.0/{appId}/campaigns/loyalty/{campaignId}
post
/api/v1.0/{appId}/campaigns/retention/{campaignId}
post
/api/v1.0/{appId}/campaigns/{campaignId}
delete
CardReaders
/api/v1.0/{appId}/stripeterminal/connectiontoken
get
/api/v1.0/{appId}/payments/terminals/stripe/{readerId}
get
/api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/status
get
/api/v1.0/{appId}/stripeterminal/location
post
/api/v1.0/{appId}/payments/terminals/stripe/register
post
/api/v1.0/{appId}/payments/terminals/stripe/{readerId}/cancel_action
post
/api/v1.0/{appId}/payments/terminals/stripe/{readerId}/processPaymentIntent
post
/api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/{terminalType}/pair
post
/api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/{terminalType}/cancelUpdate
post
/api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/{terminalType}/installUpdate
post
/api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/{terminalType}/checkForUpdate
post
/api/v1.0/{appId}/payments/terminals/stripe/unregister
delete
/api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/unpair
delete
CatalogChanges
Get menu pending changes summaries by appId
get
Get menu pending changes from Catalog groups and items
get
Update menus with the pending changes from Catalog groups and items
post
CatalogGroups
Get group by Id
get
Update Catalog Group
post
Get paginated groups by app name id filtered by types
get
Create a Catalog Group
post
Archive Catalog Group
post
Duplicate Catalog Group
post
CatalogImages
Upload a Catalog Image
post
CatalogItems
Get item by Id
get
Update Catalog Item
post
Get paginated items by app name id filtered by types
get
Create a Catalog Item
post
Archive Catalog Item
post
Duplicate Catalog Item
post
CatalogProducts
Get Product by Id
get
Update Product
post
Get paginated products by app name id filtered by types
get
Create a Product
post
Archive Product
post
Duplicate Product
post
Channels
/api/v1.0/{appId}/channels
get
/api/v1.0/{appId}/channels/{id}
get
/api/v1.0/{appId}/channels/assigned-channels
get
/api/v1.0/{appId}/channels/available-channels
get
/api/v1.0/{appId}/channels/{channelId}/stores
get
/api/v1.0/{appId}/channels/{channelId}/stores
delete
/api/v1.0/{appId}/channels/{channelId}/assigned-stores
get
/api/v1.0/{appId}/channels/{channelId}/assign-appId
post
/api/v1.0/{appId}/channels/{channelId}/stores/{storeId}
post
/api/v1.0/{appId}/channels/{channelId}/stores/{storeId}
delete
/api/v1.0/{appId}/channels/assign-store
post
/api/v1.0/{appId}/channels/unassign-store
delete
ChannelsStoreMapping
/api/v1.0/{appId}/channels/storemappings
get
/api/v1.0/{appId}/channels/storemappings
post
Clients
/api/v1.0/clients/{clientId}
get
/api/v1.0/clients/{clientId}/stripecustomerid
post
/api/v1.0/clients/{clientId}/salesforcecontactid
post
ContentSecurityPolicy
/api/v1.0/csp/report
post
CrossSell
/api/v1.0/{appId}/crossSell/menuItems
get
Customers
/api/v1.0/{appId}/customers/{customerId}
get
/api/v1.0/{appId}/customers/{customerId}
post
/api/v1.0/{appId}/customers
post
DeliveryZone
/api/v1.0/stores/{storeId}/deliveryzones
get
/api/v1.0/stores/{storeId}/deliveryzones
post
/api/v1.0/stores/{storeId}/deliveryzones/{deliveryZoneId}
post
/api/v1.0/stores/{storeId}/deliveryzones/{deliveryZoneId}
delete
Device
/api/v1.0/{appId}/devices/device/{deviceModel}/{deviceId}
get
/api/v1.0/{appId}/devices/search
get
/api/v1.0/{appId}/devices/assign
post
/api/v1.0/{appId}/devices/enroll
post
Events
/api/v1.0/{appId}/events/{eventId}
get
/api/v1.0/{appId}/events/menu/{menuId}
get
/api/v1.0/{appId}/events/user/{userId}
get
/api/v1.0/{appId}/events/order/{orderId}
get
/api/v1.0/{appId}/events/store/{storeId}
get
/api/v1.0/{appId}/events/customer/{customerId}
get
/api/v1.0/{appId}/events/whitelabel/{whitelabelId}
get
/api/v1.0/{appId}/events/order
get
/api/v1.0/{appId}/events
get
Features
/api/v1.0/{appId}/features/enable
post
/api/v1.0/{appId}/features/disable
post
Files
/api/v1.0/{appId}/files/download/{fileId}
get
FirebaseApps
/api/v1.0/FirebaseApp/{whitelabelId}
get
/api/v1.0/FirebaseApp
post
/api/v1.0/FirebaseApp/{whiteLabelId}
delete
Fpm
/api/v1.0/{storeId}/fpm/edit
post
/api/v1.0/{storeId}/fpm
post
FulfillmentStateConfiguration
/api/v1.0/{appId}/fulfillment/configuration/states
get
/api/v1.0/{appId}/fulfillment/configuration/states
post
/api/v1.0/{appId}/fulfillment/configuration/states_template
get
/api/v1.0/{appId}/fulfillment/configuration/states/{configId}
get
/api/v1.0/{appId}/fulfillment/configuration/states/{configId}
post
/api/v1.0/{appId}/fulfillment/configuration/states/{configId}
delete
GoogleFoodOrderPrototype
/api/v1.0/{appId}/googleorder
post
/api/v1.0/{appId}/googleorder/{orderId}/submit
post
Heartbeat
/api/v1.0/heartbeat
get
/api/v1.0/heartbeat
head
/api/v1.0/heartbeat/Hostname
get
/api/v1.0/heartbeat/Hostname
head
Home
/api/v1.0/{appId}/home
get
/api/v1.0/home/okta-portal
get
/api/v1.0/{appId}/home/stats
get
/api/v1.0/{appId}/home/{homeActionId}
post
Hydra
/api/v1.0/hydra/settings
get
/api/v1.0/hydra/ably_token
get
/api/v1.0/hydra/registration
get
/api/v1.0/{appId}/emvterminals
get
/api/v1.0/{appId}/emvterminals
post
/api/v1.0/{appId}/hydra/emvterminal
get
/api/v1.0/{appId}/kiosksettings/{deviceId}
get
/api/v1.0/{appId}/kiosksettings/{deviceId}
post
/api/v1.0/{appId}/kioskcashsettings/{deviceId}
get
/api/v1.0/{appId}/hydra/emvorderstate/{orderId}
get
/api/v1.0/{appId}/hydra/{deviceType}/{deviceId}
get
/api/v1.0/{appId}/hydra/{deviceType}/list
get
/api/v1.0/{appId}/hydra/registration
post
/api/v1.0/{appId}/hydra/cancelemvpayment/{orderId}
post
/api/v1.0/{appId}/hydra/{deviceId}/attach/{storeId}
post
/api/v1.0/{appId}/hydra/{deviceId}/detach/{storeId}
post
/api/v1.0/{appId}/hydra/emvterminal/unassign/{hydraConfigId}
post
/api/v1.0/{appId}/AttachStoreToKiosk/{deviceId}/store/{storeId}
post
/api/v1.0/{appId}/hydra/emvterminal/assign/{hydraConfigId}/{emvTerminalId}
post
/api/v1.0/hydra/{deviceId}/login
post
/api/v1.0/{appId}/kioskupdatecashsettings
post
/api/v1.0/{appId}/emvterminals/{id}
delete
/api/v1.0/{appId}/hydra/{deviceId}/registration
delete
/api/v1.0/{appId}/DetachStoreFromKiosk/{deviceId}/store/{storeId}
delete
Intercom
/api/v1.0/intercom/userHash
get
Invoices
/api/v1.0/{appId}/invoices/InvoicePdf
get
/api/v1.0/{appId}/invoices/ListInvoices
get
/api/v1.0/{appId}/invoices
get
/api/v1.0/{appId}/invoices/ListSubscriptionInvoices
get
KioskEntitlements
/api/v1.0/orgs/{orgId}/kiosk/entitlements
get
KioskIot
/api/v1.0/kioskiot/connect
post
/api/v1.0/{appId}/kioskiot/timeseries/query
post
Lightspeed
/api/v1.0/lightspeed/{storeId}/settings
get
/api/v1.0/lightspeed/{storeId}/settings
post
/api/v1.0/lightspeed/{storeId}/menu/generate
post
Location
/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location
post
/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/update
post
/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/move
post
/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/map-external
post
/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/delete
delete
LocationAreas
/api/v1.0/{appId}/stores/{storeId}/location-areas
get
/api/v1.0/{appId}/stores/{storeId}/location-areas
post
/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}
get
/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/update
post
LookerDashboard
/api/v1.0/{appId}/looker/dashboards
get
LookerSingleSignOn
/api/v1.0/{appId}/looker/sso
get
MenuOptionSetItems
Get menu item option set items
get
Create menu item option set item
post
Get menu item option set item by identifier
get
Update menu item option set item
post
Delete menu item option set item
delete
Upload menu item option set item image
post
Delete menu item option set item image
delete
Set Tax Rate on OptionSetItem
post
MenuOptionSets
Get menu item option sets
get
Create menu item option set
post
Get menu item option set by identifier
get
Update menu item option set
post
Delete menu item option set
delete
Upload menu item option set image
post
Delete option set image
delete
Menus
Get menus by appId
get
Create a new menu
post
Get menu by identifier
get
Update menu
post
Mark a Menu as Deleted
delete
Get menus tax details
get
Get Menus Name
get
Set Menus Name
post
Get menus store names
get
Get a Menus Checkpoints
get
Get all menu metadata by menu ID and store ID
get
Get bulk show/hide menu items and option set items
get
Get menu item metadata
get
Update menu item metadata
put
Get menu item metadata by key
get
Delete menu item metadata
delete
Get menu item option set item metadata by key
get
Update menu item option set item metadata
put
Create a new menu from xlsx file.
post
Lock/Unlock a Menu for Editing
post
Create a new menu asynchronously
post
Upload menu image
post
Delete menu image
delete
Add/Update a Tax Rate
post
Clone a menu, (without attaching stores)
post
Set if tax shows for a Menu
post
Set the type of Tax on a Menu
post
Re-arrange Sections within a Menu
post
Restore a Menu to a checkpoint
post
Bulk show/hide menu items or option set items
post
Remove a Menus Tax Rate, can only remove a tax rate that does not have items/optionSetItems attached
delete
MenuSectionItems
Get menu items
get
Create menu section item
post
Get menu item by identifier
get
Update menu section item
post
Delete menu section item
delete
Create menu section items from a list of Catalog Items
post
Clone menu section item
post
Upload menu section item image
post
Delete menu section item image
delete
Set tax rate for menu item
post
Move an Item within a menu
post
MenuSections
Get menu sections
get
Create menu section
post
Get menu section by identifier
get
Update menu section
post
Delete menu section
delete
Clone menu section
post
Upload menu section image
post
Delete menu section image
delete
Create menu availability type
post
Re-arrange Items within a Section
post
Set/update menu section availability hours.
post
MenusNutritionInfo
Get menu nutrition by menuId
get
Add or update menu nutrition by identifier
post
Delete menu nutrition information by menuId
delete
Get allergens
get
Add or update menuitem nutrition info by menu item's publicId
post
Add or update menuitem optionsetitem nutrition info its publicId
post
MenusNutritionInfoV2
Get menu nutrition by menuId
get
Get allergens
get
Add or update menuitem nutrition info by menu item's publicId
post
Add or update menuitem option set item's nutrition info by its publicId
post
MenuZones
Gets all the menu zones for a menu
get
Adds a new menu zone to a menu.
post
Gets a specific menu zone for a given zone id
get
Updates a menu zone.
put
Deletes a menu zone.
delete
Sets the description of a menu zone.
put
Flips the order of two menu zones.
put
Sets the name of a menu zone.
put
Sets a zone to a menu section.
put
Uploads an image for a menu zone.
post
Deletes a menu zone image.
delete
MetafieldDefinitions
/api/v1.0/{appId}/metafields/definitions
get
/api/v1.0/{appId}/metafields/definitions/{ownerEntity}/{key}
get
/api/v1.0/{appId}/metafields/definitions/{ownerEntity}/{key}
post
/api/v1.0/{appId}/metafields/definitions/{ownerEntity}
get
/api/v1.0/{appId}/metafields/definitions/{ownerEntity}
post
/api/v1.0/{appId}/metafields/definitions/recommendations/{ownerEntity}
get
MobileApps
/api/v1.0/mobileapps/{appId}/submission/details
get
/api/v1.0/mobileapps/{appId}/saleschannel/details
get
/api/v1.0/mobileapps/{appId}/submission/{submissionId}/status
get
/api/v1.0/mobileapps/{appId}/submission/{submissionId}/status
post
/api/v1.0/mobileapps/{appId}/statistics
get
/api/v1.0/mobileapps/{appId}/submission
post
/api/v1.0/mobileapps/{appId}/resubmission
post
/api/v1.0/mobileapps/{appId}/saleschannel
post
/api/v1.0/mobileapps/{appId}/submission/image
post
/api/v1.0/mobileapps/{appId}/submission/{submissionId}/publish
post
/api/v1.0/mobileapps/{appId}/submission/{submissionId}/unpublish
post
OAuthClients
/api/v1.0/{appId}/oauthclients/appnames
get
/api/v1.0/{appId}/oauthclients/{oauthAppId}
get
/api/v1.0/{appId}/oauthclients/{oauthAppId}
post
/api/v1.0/{appId}/oauthclients/{oauthAppId}
delete
/api/v1.0/{appId}/oauthclients/{oauthAppId}/secret
get
/api/v1.0/{appId}/oauthclients/{oauthAppId}/accesstoken
get
/api/v1.0/{appId}/oauthclients/{oauthAppId}/redirecturis
get
/api/v1.0/{appId}/oauthclients/{oauthAppId}/redirecturis
post
/api/v1.0/{appId}/oauthclients
get
/api/v1.0/{appId}/oauthclients
post
/api/v1.0/{appId}/oauthclients/{oauthAppId}/redirecturis/{uriId}
delete
Onboarding
/api/v1.0/clients/{appId}/onboarding/config
get
/api/v1.0/clients/{appId}/onboarding/config
post
/api/v1.0/clients/{appId}/onboarding/configs
get
/api/v1.0/clients/{appId}/onboarding/stores/{storeId}
get
/api/v1.0/clients/{appId}/onboarding/stores
get
/api/v1.0/clients/{appId}/onboarding/config/{configId}
post
/api/v1.0/clients/{appId}/onboarding/stores/{storeId}/items/{onboardingItemId}
post
/api/v1.0/clients/{appId}/onboarding/stores/items/{onboardingItemId}
post
OrderBatches
/api/v1.0/{appId}/order-batches/{orderBatchId}
get
/api/v1.0/{appId}/order-batches
get
OrderBatchingConfiguration
/api/v1.0/stores/{storeId}/order-batching-configuration
get
/api/v1.0/stores/{storeId}/order-batching-configuration
post
OrderIngest
/api/v1.0/{appNameId}/order-ingest/submit
post
Orders
/api/v1.0/orders/{id}
get
/api/v1.0/orders/{orderId}/deliveryinfo
get
/api/v1.0/orders/{orderId}/deliveryinfo
post
/api/v1.0/orders/{orderId}/fulfillment/state
get
/api/v1.0/orders/{orderId}/fulfillment/state
post
/api/v1.0/orders/{orderId}/fulfillment/state/details
get
/api/v1.0/{appId}/orders/fulfillmentstatuses
get
/api/v1.0/{appId}/orders/ready_to_process
get
/api/v1.0/orders
get
/api/v1.0/{appId}/orders/summaries
get
/api/v1.0/{appId}/orders/summariesNew
get
/api/v1.0/orders/{id}/accept
post
/api/v1.0/orders/{id}/refund
post
/api/v1.0/orders/{id}/reject
post
/api/v1.0/orders/{id}/dispatch
post
PaymentIntents
/api/v1.0/payment_intents/{paymentIntentId}
get
Payments
/api/v1.0/payments/payment/{orderId}/refundable
get
PayoutReports
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/overview
get
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/orders
get
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/details
get
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/possales
get
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/chargebacks
get
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/ledgerentries
get
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/refundedOrders
get
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/refundedOrders
get
Payouts
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}
get
/api/v1.0/{appId}/payouts/summaries
get
/api/v1.0/{appId}/payouts
get
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/orders
get
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/refunds
get
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/chargebacks
get
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/othercharges
get
PayoutsExport
/api/v1.0/{appId}/payouts/export
get
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/export
get
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/orders/export
get
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/refunds/export
get
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/chargebacks/export
get
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/othercharges/export
get
ProcessingFeeConfigs
/api/v1.0/processingfeeconfigs
get
PushNotifications
/api/v1.0/{appId}/pushnotifications
get
/api/v1.0/{appId}/pushnotifications
post
/api/v1.0/{appId}/pushnotifications/{scheduledPushNotificationId}
post
/api/v1.0/{appId}/pushnotifications/{scheduledPushNotificationId}
delete
Receipts
/api/v1.0/receipts/{orderId}
get
RestaurantVouchersPayGreen
/api/v1.0/{appId}/restaurant-vouchers/paygreen
get
/api/v1.0/{appId}/restaurant-vouchers/paygreen
post
/api/v1.0/{appId}/restaurant-vouchers/paygreen/stores
get
/api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}
get
/api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}
post
/api/v1.0/{appId}/restaurant-vouchers/paygreen/{paygreenConfigurationId}
get
/api/v1.0/{appId}/restaurant-vouchers/paygreen/{paygreenConfigurationId}
post
/api/v1.0/{appId}/restaurant-vouchers/paygreen/{paygreenConfigurationId}
delete
/api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}/available-configurations
get
StoreGroups
/api/v1.0/storegroups/{storeGroupId}
get
/api/v1.0/storegroups/{storeGroupId}
post
/api/v1.0/storegroups/{storeGroupId}
delete
/api/v1.0/{appNameId}/storegroups
get
/api/v1.0/{appNameId}/storegroups
post
/api/v1.0/{appNameId}/storegroups/extended
get
/api/v1.0/storegroups/{storeGroupId}/CustomerMessages
post
/api/v1.0/{appId}/storegroups/{storeGroupId}/assignStores
post
StoreOrderCapacity
/api/v1.0/{appId}/storeordercapacity/{storeId}/{deliveryType}
get
/api/v1.0/{appId}/storeordercapacity/{storeId}
post
Stores
/api/v1.0/stores/{storeId}
get
/api/v1.0/stores/{storeId}
post
/api/v1.0/stores/{storeId}/feeConfig
get
/api/v1.0/stores/{storeId}/leadTimes
get
/api/v1.0/stores/{storeId}/leadTimes
post
/api/v1.0/stores/{storeId}/bankaccount
get
/api/v1.0/stores/{storeId}/servicecharge
get
/api/v1.0/stores/{storeId}/servicecharge
post
/api/v1.0/stores/{storeId}/feeConfig/deliveryZones
get
/api/v1.0/stores/{storeId}/feeConfig/deliveryZones
put
/api/v1.0/stores/{storeId}/endofdayreport
get
/api/v1.0/stores/{storeId}/availability/{deliveryType}
get
/api/v1.0/stores/{storeId}/availability/{deliveryType}
post
/api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}
get
/api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}
post
/api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}/preview
get
/api/v1.0/stores/{storeId}/processingfeeconfigs
get
/api/v1.0/{appId}/stores/stats
get
/api/v1.0/stores/{storeId}/businesshoursoverrides
get
/api/v1.0/stores/{storeId}/businesshoursoverrides
post
/api/v1.0/stores/{storeId}/processingfeeconfigs/{paymentAccountType}
get
/api/v1.0/stores
get
/api/v1.0/stores
post
/api/v1.0/{appId}/stores
get
/api/v1.0/{appId}/storevalidation/kiosk
get
/api/v1.0/{appId}/stores/header
get
/api/v1.0/stores/{storeId}/clone
post
/api/v1.0/stores/{storeId}/address
post
/api/v1.0/stores/{storeId}/archive
post
/api/v1.0/stores/{storeId}/publish
post
/api/v1.0/stores/{storeId}/unpublish
post
/api/v1.0/stores/{storeId}/addressform
post
/api/v1.0/stores/{storeId}/menu/{menuId}
post
/api/v1.0/stores/{storeId}/propertyId/{propertyId}
post
/api/v1.0/stores/{storeId}/address/coordinates
post
/api/v1.0/properties/{propertyId}/stores/{storeId}/supportedSalesChannels
post
/api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}/enabled
post
/api/v1.0/properties/{propertyId}/stores
post
/api/v1.0/stores/{storeId}/businesshoursoverrides/{businessHoursOverrideId}
delete
StripeCustomConnect
/api/v1.0/{appId}/customconnect/{storeId}
get
/api/v1.0/{appId}/customconnect/refresh-link
get
/api/v1.0/{appId}/customconnect/verification-status
get
/api/v1.0/{appId}/customconnect/bank-account
post
/api/v1.0/{appId}/customconnect/{bankAccountId}/create-update-account
post
/api/v1.0/{appId}/customconnect/bank-account/{bankAccountId}/businesstype
post
/api/v1.0/{appId}/customconnect/{bankAccountId}/update-bank-account-details
post
/api/v1.0/{appId}/customconnect/{stripeConnectedAccountId}/create-account-link
post
/api/v1.0/{appId}/customconnect/update-payout-schedule/{stripeConnectedAccountId}/{interval}
post
StripeCustomConnectAdmin
/api/v1.0/customconnect/initialize-bank-account
post
Stuart
/api/v1.0/stuart/settings/{storeId}
get
/api/v1.0/stuart/settings/{storeId}
post
/api/v1.0/stuart/jobs/{jobId}
get
/api/v1.0/stuart/jobs/{jobId}
delete
Subscriptions
/api/v1.0/{appId}/subscriptions/{subscriptionId}
get
/api/v1.0/{appId}/subscriptions/hasPaymentMethod
get
/api/v1.0/{appId}/subscriptions
get
Teammates
/api/v1.0/{appId}/teammates
get
/api/v1.0/{appId}/teammates
post
/api/v1.0/{appId}/teammates/{id}
get
/api/v1.0/{appId}/teammates/{id}
post
/api/v1.0/{appId}/teammates/{id}
delete
/api/v1.0/teammates/pending-invitations
get
/api/v1.0/{appId}/teammates/accept/{otc}
get
/api/v1.0/{appId}/teammates/redeem/{otc}
get
/api/v1.0/{appId}/teammates/grantaccess
post
TerminalIot
/api/v1.0/terminaliot/connect
post
Tips
/api/v1.0/stores/{storeId}/tipconfig
get
/api/v1.0/stores/{storeId}/tipconfig
post
Users
/api/v1.0/users/roles
get
/api/v1.0/users/{userId}/previousordercount/{storeId}
get
Vouchers
/api/v1.0/vouchers/{voucherId}
get
/api/v1.0/vouchers/{voucherId}
post
/api/v1.0/{appId}/vouchers/{voucherId}/validity-periods
get
/api/v1.0/vouchers/stats/{voucherId}
get
/api/v1.0/{appId}/vouchers/summaries
get
/api/v1.0/vouchers/{appId}
post
/api/v1.0/{appId}/vouchers/{voucherId}/usage
post
/api/v1.0/{appId}/vouchers/{voucherId}/validity-periods-simplified
post
Webhooks
/api/v1.0/{appId}/webhooks/events
get
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions
get
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions
post
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events
get
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events/{eventName}/test
get
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/logs
get
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}
put
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}
delete
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events/{eventName}
post
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events/{eventName}
delete
Website
/api/v1.0/{appId}/website/index
get
/api/v1.0/{appId}/website/index
post
/api/v1.0/{appId}/website/dnscheck
get
/api/v1.0/{appId}/website/testimonial
post
/api/v1.0/{appId}/website/image/{imageLocation}
post
/api/v1.0/{appId}/website/testimonial/{testimonialId}
post
/api/v1.0/{appId}/website/testimonial/{testimonialId}
delete
/api/v1.0/{appId}/website/image/{imageId}
delete
Flipdish Reporting V1
CsvApi
If successful will redirect to a download file
get
CustomerApi
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
get
CustomerManagementApi
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
get
DeliveryZoneApi
Returns all delivery zones associated with the query
get
HealthCheck
If successful will return HTTP Success 200 and health status of ElasticSearch
get
OrderApi
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
get
StoresApi
Returns top X stores that match the query
get
VoucherApi
Returns top X vouchers that match the query
get
Powered by
/api/v1.0/stuart/jobs/{jobId}
get
https://api.flipdish.co/api/v1.0/stuart/jobs/
{jobId}
Language
Shell
Node
C#
Ruby
JavaScript
Credentials
OAuth2
OAuth2
Bearer
RESPONSE
Click
Try It!
to start a request and see the response here!
