Jump to Content

Home Guides API Reference

Home Guides API Reference

v1.0

Home Guides API Reference Log In

API Reference

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
AppStoreEntitlements
- /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/entitlementsget
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
Hydra
Intercom
- /api/v1.0/intercom/userHashget
Invoices
KioskEntitlements
- /api/v1.0/{appId}/kiosk/entitlementsget
- /api/v1.0/orgs/{orgId}/kiosk/entitlementsget
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

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
AppStoreEntitlements
- /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/entitlementsget
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
Hydra
Intercom
- /api/v1.0/intercom/userHashget
Invoices
KioskEntitlements
- /api/v1.0/{appId}/kiosk/entitlementsget
- /api/v1.0/orgs/{orgId}/kiosk/entitlementsget
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

Powered by

Uploads an image for a menu zone.

post https://api.flipdish.co/api/v1.0/menus/{menuId}/zones/{menuZoneId}/image

Language

Credentials

OAuth2

Bearer

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