/
FL
flipdish
/
Flipdish Open API v1.0
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 36m ago · Updated 4d ago
v1
latest
Swagger 2.0
2026-08-04
592
853
2.7 MB
Accounts
18
get
/api/v1.0/accounts
put
/api/v1.0/accounts
post
/api/v1.0/accounts
get
/api/v1.0/accounts/timezones
put
/api/v1.0/accounts/password
post
/api/v1.0/accounts/password
put
/api/v1.0/accounts/password/pin
post
/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
Address
5
get
/api/v1.0/address/countries
get
/api/v1.0/app/{appId}/address/form
get
/api/v1.0/address/country/{countryCode}/form
post
/api/v1.0/address/templates
post
/api/v1.0/address/google
Apm
6
get
/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}
Apps
21
get
/api/v1.0/apps/{appId}
get
/api/v1.0/apps/{appId}/name
get
/api/v1.0/apps/supportedcountries
get
/api/v1.0/apps/{appId}/compliance
post
/api/v1.0/apps/{appId}/compliance
get
/api/v1.0/apps/{appId}/panacea/url
post
/api/v1.0/apps/{appId}/panacea/url
get
/api/v1.0/apps/{whitelabelId}/lookup
get
/api/v1.0/apps/{appId}/hostnamestatus
get
/api/v1.0/apps
post
/api/v1.0/apps
get
/api/v1.0/apps/{appId}/panacea/url/available
post
/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}/SendPushNotification/{customerId}
post
/api/v1.0/apps/{appId}/third-party-integrations
post
/api/v1.0/apps/{appId}/hostname
post
/api/v1.0/apps/{appId}/nextgenweb
AppStore
2
get
/api/v1.0/appstore/apps/{appStoreAppId}
get
/api/v1.0/appstore/apps
AppStoreConfigurations
9
get
/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}
put
/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}
delete
/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}
post
/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
AppStoreDeveloper
8
get
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/external_product
put
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/external_product
get
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/external_function_signing_key
put
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}
delete
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}
put
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/verification
post
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps
post
/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/logo
AppStoreEntitlements
1
get
/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/entitlements
AuditLogs
2
post
/api/v1.0/auditlogs/orders/{orderId}
post
/api/v1.0/auditlogs/stores/{storeId}
AuthorizationTokens
2
get
/api/v1.0/{appId}/authorizationtokens/{oauthAppId}
delete
/api/v1.0/{appId}/authorizationtokens/{key}
BankAccount
9
get
/api/v1.0/{appId}/bankaccounts
post
/api/v1.0/{appId}/bankaccounts
get
/api/v1.0/{appId}/bankaccounts/{bankAccountId}
post
/api/v1.0/{appId}/bankaccounts/{bankAccountId}
delete
/api/v1.0/{appId}/bankaccounts/{bankAccountId}
get
/api/v1.0/{appId}/bankaccounts/field-definitions
get
/api/v1.0/{appId}/bankaccounts/countries-field-definitions
post
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/state/{state}
post
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/store/{storeId}
Campaigns
10
get
/api/v1.0/{appId}/campaigns/loyalty
post
/api/v1.0/{appId}/campaigns/loyalty
get
/api/v1.0/{appId}/campaigns/retention
post
/api/v1.0/{appId}/campaigns/retention
get
/api/v1.0/{appId}/campaigns/loyalty/{storeId}
get
/api/v1.0/{appId}/campaigns/retention/{storeId}
get
/api/v1.0/{appId}/campaigns/stores
post
/api/v1.0/{appId}/campaigns/loyalty/{campaignId}
post
/api/v1.0/{appId}/campaigns/retention/{campaignId}
delete
/api/v1.0/{appId}/campaigns/{campaignId}
CardReaders
13
get
/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
post
/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
delete
/api/v1.0/{appId}/payments/terminals/stripe/unregister
delete
/api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/unpair
CatalogChanges
3
get
Get menu pending changes summaries by appId
get
Get menu pending changes from Catalog groups and items
post
Update menus with the pending changes from Catalog groups and items
CatalogGroups
6
get
Get group by Id
post
Update Catalog Group
get
Get paginated groups by app name id filtered by types
post
Create a Catalog Group
post
Archive Catalog Group
post
Duplicate Catalog Group
CatalogImages
1
post
Upload a Catalog Image
CatalogItems
6
get
Get item by Id
post
Update Catalog Item
get
Get paginated items by app name id filtered by types
post
Create a Catalog Item
post
Archive Catalog Item
post
Duplicate Catalog Item
CatalogProducts
6
get
Get Product by Id
post
Update Product
get
Get paginated products by app name id filtered by types
post
Create a Product
post
Archive Product
post
Duplicate Product
Channels
12
get
/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
delete
/api/v1.0/{appId}/channels/{channelId}/stores
get
/api/v1.0/{appId}/channels/{channelId}/assigned-stores
post
/api/v1.0/{appId}/channels/{channelId}/assign-appId
post
/api/v1.0/{appId}/channels/{channelId}/stores/{storeId}
delete
/api/v1.0/{appId}/channels/{channelId}/stores/{storeId}
post
/api/v1.0/{appId}/channels/assign-store
delete
/api/v1.0/{appId}/channels/unassign-store
Clients
3
get
/api/v1.0/clients/{clientId}
post
/api/v1.0/clients/{clientId}/stripecustomerid
post
/api/v1.0/clients/{clientId}/salesforcecontactid
ContentSecurityPolicy
1
post
/api/v1.0/csp/report
CrossSell
1
get
/api/v1.0/{appId}/crossSell/menuItems
Customers
4
get
/api/v1.0/{appId}/customers/{customerId}
post
/api/v1.0/{appId}/customers/{customerId}
get
/api/v1.0/{appId}/customers
post
/api/v1.0/{appId}/customers
DeliveryZone
4
get
/api/v1.0/stores/{storeId}/deliveryzones
post
/api/v1.0/stores/{storeId}/deliveryzones
post
/api/v1.0/stores/{storeId}/deliveryzones/{deliveryZoneId}
delete
/api/v1.0/stores/{storeId}/deliveryzones/{deliveryZoneId}
Device
4
get
/api/v1.0/{appId}/devices/device/{deviceModel}/{deviceId}
get
/api/v1.0/{appId}/devices/search
post
/api/v1.0/{appId}/devices/assign
post
/api/v1.0/{appId}/devices/enroll
Drivers
11
get
/api/v1.0/drivers/profile
post
/api/v1.0/drivers/profile
get
/api/v1.0/drivers/assignedstores
post
/api/v1.0/drivers/pin
post
/api/v1.0/drivers/login
post
/api/v1.0/drivers/token
delete
/api/v1.0/drivers/token
post
/api/v1.0/drivers/profile/image
delete
/api/v1.0/drivers/profile/image
post
/api/v1.0/drivers/stores/{storeId}/presence/{presence}
post
/api/v1.0/orders/{orderId}/tracking/{deliveryTrackingStatus}
Events
9
get
/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
Features
2
post
/api/v1.0/{appId}/features/enable
post
/api/v1.0/{appId}/features/disable
Files
1
get
/api/v1.0/{appId}/files/download/{fileId}
FirebaseApps
3
get
/api/v1.0/FirebaseApp/{whitelabelId}
post
/api/v1.0/FirebaseApp
delete
/api/v1.0/FirebaseApp/{whiteLabelId}
Fpm
4
get
/api/v1.0/{storeId}/fpm
post
/api/v1.0/{storeId}/fpm
delete
/api/v1.0/{storeId}/fpm
post
/api/v1.0/{storeId}/fpm/edit
FulfillmentStateConfiguration
6
get
/api/v1.0/{appId}/fulfillment/configuration/states
post
/api/v1.0/{appId}/fulfillment/configuration/states
get
/api/v1.0/{appId}/fulfillment/configuration/states_template
get
/api/v1.0/{appId}/fulfillment/configuration/states/{configId}
post
/api/v1.0/{appId}/fulfillment/configuration/states/{configId}
delete
/api/v1.0/{appId}/fulfillment/configuration/states/{configId}
Heartbeat
4
get
/api/v1.0/heartbeat
head
/api/v1.0/heartbeat
get
/api/v1.0/heartbeat/Hostname
head
/api/v1.0/heartbeat/Hostname
Home
4
get
/api/v1.0/{appId}/home
get
/api/v1.0/home/okta-portal
get
/api/v1.0/{appId}/home/stats
post
/api/v1.0/{appId}/home/{homeActionId}
Hydra
24
get
/api/v1.0/hydra/settings
get
/api/v1.0/hydra/ably_token
get
/api/v1.0/hydra/registration
get
/api/v1.0/{appId}/emvterminals
post
/api/v1.0/{appId}/emvterminals
get
/api/v1.0/{appId}/hydra/emvterminal
get
/api/v1.0/{appId}/kiosksettings/{deviceId}
post
/api/v1.0/{appId}/kiosksettings/{deviceId}
get
/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
post
/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
delete
/api/v1.0/{appId}/emvterminals/{id}
delete
/api/v1.0/{appId}/hydra/{deviceId}/registration
delete
/api/v1.0/{appId}/DetachStoreFromKiosk/{deviceId}/store/{storeId}
IntegrationMetadataCatalogue
1
get
/api/v1.0/integrationmetadatacatalogue/pixelpoint/stores/{storeId}/products
Intercom
1
get
/api/v1.0/intercom/userHash
Invoices
4
get
/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
KioskEntitlements
1
get
/api/v1.0/orgs/{orgId}/kiosk/entitlements
KioskIot
2
post
/api/v1.0/kioskiot/connect
post
/api/v1.0/{appId}/kioskiot/timeseries/query
Lightspeed
3
get
/api/v1.0/lightspeed/{storeId}/settings
post
/api/v1.0/lightspeed/{storeId}/settings
post
/api/v1.0/lightspeed/{storeId}/menu/generate
Location
5
post
/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
delete
/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/delete
LocationAreas
4
get
/api/v1.0/{appId}/stores/{storeId}/location-areas
post
/api/v1.0/{appId}/stores/{storeId}/location-areas
get
/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}
post
/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/update
LookerDashboard
1
get
/api/v1.0/{appId}/looker/dashboards
LookerSingleSignOn
1
get
/api/v1.0/{appId}/looker/sso
MenuOptionSetItems
8
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
Set Tax Rate on OptionSetItem
MenuOptionSets
7
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
31
get
Get menus by appId
post
Create a new menu
get
Get menu by identifier
post
Update menu
delete
Mark a Menu as Deleted
get
Get menus tax details
get
Get Menus Name
post
Set Menus Name
get
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
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
Lock/Unlock a Menu for Editing
post
Upload menu image
delete
Delete menu image
post
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
Create a new menu asynchronously
post
Re-arrange Sections within a Menu
post
Restore a Menu to a checkpoint
post
Bulk show/hide menu items or option set items
delete
Remove a Menus Tax Rate, can only remove a tax rate that does not have items/optionSetItems attached
MenuSectionItems
11
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
Create menu section items from a list of Catalog Items
post
Clone menu section item
post
Upload menu section item image
delete
Delete menu section item image
post
Set tax rate for menu item
post
Move an Item within a menu
MenuSections
11
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.
MenusNutritionInfo
6
get
Get menu nutrition by menuId
post
Add or update menu nutrition by identifier
delete
Delete menu nutrition information by menuId
get
Get allergens
post
Add or update menuitem nutrition info by menu item's publicId
post
Add or update menuitem optionsetitem nutrition info its publicId
MenusNutritionInfoV2
4
get
Get menu nutrition by menuId
get
Get allergens
post
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
MenuZones
11
get
Gets all the menu zones for a menu
post
Adds a new menu zone to a menu.
get
Gets a specific menu zone for a given zone id
put
Updates a menu zone.
delete
Deletes a menu zone.
put
Sets the description of a menu zone.
put
Flips the order of two menu zones.
put
Sets the name of a menu zone.
put
Assigns a zone to a menu section.
post
Uploads an image for a menu zone.
delete
Deletes a menu zone image.
MetafieldDefinitions
6
get
/api/v1.0/{appId}/metafields/definitions
get
/api/v1.0/{appId}/metafields/definitions/{ownerEntity}/{key}
post
/api/v1.0/{appId}/metafields/definitions/{ownerEntity}/{key}
get
/api/v1.0/{appId}/metafields/definitions/{ownerEntity}
post
/api/v1.0/{appId}/metafields/definitions/{ownerEntity}
get
/api/v1.0/{appId}/metafields/definitions/recommendations/{ownerEntity}
MobileApps
11
get
/api/v1.0/mobileapps/{appId}/submission/details
get
/api/v1.0/mobileapps/{appId}/saleschannel/details
get
/api/v1.0/mobileapps/{appId}/submission/{submissionId}/status
post
/api/v1.0/mobileapps/{appId}/submission/{submissionId}/status
get
/api/v1.0/mobileapps/{appId}/statistics
post
/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
OAuthClients
11
get
/api/v1.0/{appId}/oauthclients/appnames
get
/api/v1.0/{appId}/oauthclients/{oauthAppId}
post
/api/v1.0/{appId}/oauthclients/{oauthAppId}
delete
/api/v1.0/{appId}/oauthclients/{oauthAppId}
get
/api/v1.0/{appId}/oauthclients/{oauthAppId}/secret
get
/api/v1.0/{appId}/oauthclients/{oauthAppId}/accesstoken
get
/api/v1.0/{appId}/oauthclients/{oauthAppId}/redirecturis
post
/api/v1.0/{appId}/oauthclients/{oauthAppId}/redirecturis
get
/api/v1.0/{appId}/oauthclients
post
/api/v1.0/{appId}/oauthclients
delete
/api/v1.0/{appId}/oauthclients/{oauthAppId}/redirecturis/{uriId}
Onboarding
8
get
/api/v1.0/clients/{appId}/onboarding/config
post
/api/v1.0/clients/{appId}/onboarding/config
get
/api/v1.0/clients/{appId}/onboarding/configs
get
/api/v1.0/clients/{appId}/onboarding/stores/{storeId}
get
/api/v1.0/clients/{appId}/onboarding/stores
post
/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}
OrderBatches
2
get
/api/v1.0/{appId}/order-batches/{orderBatchId}
get
/api/v1.0/{appId}/order-batches
OrderBatchingConfiguration
2
get
/api/v1.0/stores/{storeId}/order-batching-configuration
post
/api/v1.0/stores/{storeId}/order-batching-configuration
Orders
15
get
/api/v1.0/orders/{id}
get
/api/v1.0/orders/{orderId}/deliveryinfo
post
/api/v1.0/orders/{orderId}/deliveryinfo
get
/api/v1.0/orders/{orderId}/fulfillment/state
post
/api/v1.0/orders/{orderId}/fulfillment/state
get
/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
post
/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
PaymentIntents
1
get
/api/v1.0/payment_intents/{paymentIntentId}
Payments
1
get
/api/v1.0/payments/payment/{orderId}/refundable
PayoutReports
10
get
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/overview
get
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/stores
get
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/orders
get
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/stores
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/refundedOrders
get
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/refundedOrders
get
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/properties
Payouts
7
get
/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
PayoutsExport
6
get
/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
ProcessingFeeConfigs
1
get
/api/v1.0/processingfeeconfigs
PushNotifications
4
get
/api/v1.0/{appId}/pushnotifications
post
/api/v1.0/{appId}/pushnotifications
post
/api/v1.0/{appId}/pushnotifications/{scheduledPushNotificationId}
delete
/api/v1.0/{appId}/pushnotifications/{scheduledPushNotificationId}
Receipts
1
get
/api/v1.0/receipts/{orderId}
RestaurantVouchersPayGreen
9
get
/api/v1.0/{appId}/restaurant-vouchers/paygreen
post
/api/v1.0/{appId}/restaurant-vouchers/paygreen
get
/api/v1.0/{appId}/restaurant-vouchers/paygreen/stores
get
/api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}
post
/api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}
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/{paygreenConfigurationId}
get
/api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}/available-configurations
Search
1
get
/api/v1.0/search/restaurants
SmsProviderCredentials
5
get
/api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials
get
/api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials/{serviceType}
post
/api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials/{serviceType}
delete
/api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials/{serviceType}
post
/api/v1.0/sms-providers/bulk-upsert
StoreGroups
8
get
/api/v1.0/storegroups/{storeGroupId}
post
/api/v1.0/storegroups/{storeGroupId}
delete
/api/v1.0/storegroups/{storeGroupId}
get
/api/v1.0/{appNameId}/storegroups
post
/api/v1.0/{appNameId}/storegroups
get
/api/v1.0/{appNameId}/storegroups/extended
post
/api/v1.0/storegroups/{storeGroupId}/CustomerMessages
post
/api/v1.0/{appId}/storegroups/{storeGroupId}/assignStores
StoreOrderCapacity
2
get
/api/v1.0/{appId}/storeordercapacity/{storeId}/{deliveryType}
post
/api/v1.0/{appId}/storeordercapacity/{storeId}
Stores
40
get
/api/v1.0/stores/{storeId}
post
/api/v1.0/stores/{storeId}
get
/api/v1.0/stores/{storeId}/feeConfig
get
/api/v1.0/stores/{storeId}/leadTimes
post
/api/v1.0/stores/{storeId}/leadTimes
get
/api/v1.0/stores/{storeId}/bankaccount
get
/api/v1.0/stores/{storeId}/servicecharge
post
/api/v1.0/stores/{storeId}/servicecharge
get
/api/v1.0/stores/{storeId}/feeConfig/deliveryZones
put
/api/v1.0/stores/{storeId}/feeConfig/deliveryZones
get
/api/v1.0/stores/{storeId}/endofdayreport
get
/api/v1.0/stores/{storeId}/availability/{deliveryType}
post
/api/v1.0/stores/{storeId}/availability/{deliveryType}
get
/api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}
post
/api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}
get
/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
post
/api/v1.0/stores/{storeId}/businesshoursoverrides
get
/api/v1.0/stores/{storeId}/processingfeeconfigs/{paymentAccountType}
get
/api/v1.0/stores
post
/api/v1.0/stores
get
/api/v1.0/{appId}/storevalidation/kiosk
get
/api/v1.0/{appId}/stores/header
get
/api/v1.0/{appId}/stores
post
/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/stores/{storeId}/collectionsettings
post
/api/v1.0/properties/{propertyId}/stores
delete
/api/v1.0/stores/{storeId}/businesshoursoverrides/{businessHoursOverrideId}
StripeCustomConnect
8
get
/api/v1.0/{appId}/customconnect/{storeId}
get
/api/v1.0/{appId}/customconnect/refresh-link
post
/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}
Stuart
4
get
/api/v1.0/stuart/settings/{storeId}
post
/api/v1.0/stuart/settings/{storeId}
get
/api/v1.0/stuart/jobs/{jobId}
delete
/api/v1.0/stuart/jobs/{jobId}
Subscriptions
3
get
/api/v1.0/{appId}/subscriptions/{subscriptionId}
get
/api/v1.0/{appId}/subscriptions/hasPaymentMethod
get
/api/v1.0/{appId}/subscriptions
Teammates
11
get
/api/v1.0/{appId}/teammates
post
/api/v1.0/{appId}/teammates
get
/api/v1.0/{appId}/teammates/{id}
post
/api/v1.0/{appId}/teammates/{id}
delete
/api/v1.0/{appId}/teammates/{id}
get
/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/teammates/mobile-redirect
post
/api/v1.0/teammates/acceptInvitations
post
/api/v1.0/{appId}/teammates/grantaccess
TerminalIot
1
post
/api/v1.0/terminaliot/connect
Tips
2
get
/api/v1.0/stores/{storeId}/tipconfig
post
/api/v1.0/stores/{storeId}/tipconfig
Users
32
get
/api/v1.0/users/roles
get
/api/v1.0/users/{userId}
get
/api/v1.0/users/{userId}/roles
get
/api/v1.0/users/{userId}/UserNotes
get
/api/v1.0/users/{userId}/orders/{orderId}
get
/api/v1.0/users/{userId}/RestaurantUserStores
get
/api/v1.0/users/{userId}/RestaurantUserAccounts
get
/api/v1.0/users/{userId}/previousordercount/{storeId}
get
/api/v1.0/users/searchFlipdishAccounts
get
/api/v1.0/users/{userId}/deliveryLocations
post
/api/v1.0/users/{userId}/deliveryLocations
get
/api/v1.0/users/{userId}/orders
get
/api/v1.0/users/{userId}/smsConversationItems
get
/api/v1.0/users/search
post
/api/v1.0/users/{userId}/sms
post
/api/v1.0/users/{userId}/ResetMfa
post
/api/v1.0/users/{userId}/AddUserNote
post
/api/v1.0/users/{userId}/AnonymizeUser
post
/api/v1.0/users/{userId}/SetCustomerName
post
/api/v1.0/users/{userId}/pushNotifications
post
/api/v1.0/users/{userId}/BlockUserPhoneNumber
post
/api/v1.0/users/{userId}/MarkUserAsFraudulent
post
/api/v1.0/users/{userId}/MarkUserAsSuspicious
post
/api/v1.0/users/{userId}/UnblockUserPhoneNumber
post
/api/v1.0/users/{userId}/AddUserToRole/{roleName}
post
/api/v1.0/users/{userId}/SetLanguage/{languageId}
post
/api/v1.0/users/{userId}/RemoveUserFromRole/{roleName}
post
/api/v1.0/users/{userId}/SetFlipdishAccountId/{accountId}
post
/api/v1.0/users/{userId}/RemoveFlipdishAccountId/{accountId}
post
/api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/hide
post
/api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/fields
post
/api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/coordinates
Vouchers
10
get
/api/v1.0/vouchers/{voucherId}
post
/api/v1.0/vouchers/{voucherId}
get
/api/v1.0/{appId}/vouchers/code/{code}
get
/api/v1.0/vouchers/{appId}/customer/{customerId}
get
/api/v1.0/{appId}/vouchers/{voucherId}/validity-periods
get
/api/v1.0/vouchers/stats/{voucherId}
get
/api/v1.0/{appId}/vouchers/summaries
post
/api/v1.0/vouchers/{appId}
post
/api/v1.0/{appId}/vouchers/{voucherId}/usage
post
/api/v1.0/{appId}/vouchers/{voucherId}/validity-periods-simplified
Webhooks
10
get
/api/v1.0/{appId}/webhooks/events
get
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions
post
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions
get
/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
put
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}
delete
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}
post
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events/{eventName}
delete
/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events/{eventName}
Website
8
get
/api/v1.0/{appId}/website/index
post
/api/v1.0/{appId}/website/index
get
/api/v1.0/{appId}/website/dnscheck
post
/api/v1.0/{appId}/website/testimonial
post
/api/v1.0/{appId}/website/image/{imageLocation}
post
/api/v1.0/{appId}/website/testimonial/{testimonialId}
delete
/api/v1.0/{appId}/website/testimonial/{testimonialId}
delete
/api/v1.0/{appId}/website/image/{imageId}
WhiteLabelBuilds
5
get
/api/v1.0/whitelabelbuilds/health
post
/api/v1.0/whitelabelbuilds/{appId}/android
post
/api/v1.0/whitelabelbuilds/ios/multiple
post
/api/v1.0/whitelabelbuilds/{appId}/ios
post
/api/v1.0/whitelabelbuilds/android/multiple
WhiteLabelConfig
10
get
/api/v1.0/whitelabelconfig/health
get
/api/v1.0/whitelabelconfig/id/{wlid}
get
/api/v1.0/whitelabelconfig/name/{appId}
get
/api/v1.0/whitelabelconfig/{appId}/general
post
/api/v1.0/whitelabelconfig/{appId}/general
get
/api/v1.0/whitelabelconfig/{appId}/appstore
post
/api/v1.0/whitelabelconfig/{appId}/appstore
get
/api/v1.0/whitelabelconfig/{appId}/playstore
post
/api/v1.0/whitelabelconfig/{appId}/playstore
post
/api/v1.0/whitelabelconfig/{appId}/app-store-icon
Accounts
get
/api/v1.0/accounts
Response
OK
RestApiResultAccountDetail
required
Rest api result
Data
AccountDetail
required
Account details