OpenAPI Specification
openapi: 3.0.3
info:
title: Flipdish API - Apps Accounts Stores API
version: v1.0
description: Flipdish Open API v1.0 — Apps operations. Flipdish is an online ordering and branded-app platform for restaurants and takeaways. This specification was derived from the official Flipdish Swagger document and grouped by resource domain.
contact:
name: Flipdish Support
email: help@flipdish.com
url: https://help.flipdish.com
x-generated-from: https://api.flipdish.co/swagger/docs/v1.0
x-last-validated: '2026-06-02'
servers:
- url: https://api.flipdish.co
description: Flipdish production API
security:
- oauth2:
- api
tags:
- name: Stores
description: Operations for Stores.
paths:
/api/v1.0/stores/{storeId}:
get:
tags:
- Stores
operationId: GetStoreById
parameters:
- name: storeId
in: path
required: true
schema:
type: integer
format: int32
description: The store id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_Store_'
examples:
GetStoreById200Example:
summary: Default GetStoreById 200 response
x-microcks-default: true
value:
Data:
StoreId: 500123
StoreGroupId: 500123
Address:
AddressId: 500123
Coordinates: {}
Line1: string
Postcode: string
City: string
CountryCode: IE
DisplayForCustomer: string
AddressFields: {}
SingleLineDisplay: string
TwoLinesDisplay:
- string
DeliveryZones: []
ApmPhoneNumber: '+353000000000'
PickupHours: []
DeliveryHours: []
MenuId: 500123
OrderConfirmationMessageOverrideDelivery: string
OrderConfirmationMessageOverridePickup: string
PrintoutLayoutType: Default
StoreNotes: []
MicrosoftTimeZone: string
IanaTimeZone: string
Currency: EUR
PreOrderDeliveryEnabled: true
PreOrderPickupEnabled: true
LogoUrl: https://api.flipdish.co/example
FraudPreventionStrategy: string
AppIds:
- string
PropertyId: '500123'
PhoneNumber: '+353000000000'
AlwaysAppearOpen: true
PreOrderEnabled: true
TakeOutEnabled: true
TableServiceEnabled: true
DineInEnabled: true
AllowPreOrdersAndTableService: true
PickupEnabled: true
DeliveryEnabled: true
CardOrderDeliveryEnabled: true
CashOrdersDeliveryEnabled: true
CardOrdersPickupEnabled: true
CashOrdersPickupEnabled: true
TipsEnabled: true
AutomaticallyAcceptOrders: true
OpenForDelivery: true
OpenForPickup: true
MinimumPickupOrderAmount: 12.5
RequireCustomerNameForPickup: true
GdprCustomerPhoneNumbers: true
RequireCustomerNameForDelivery: true
AllowChefNotes: true
EtaInPickupConfirmationSmsEnabled: true
EtaInDeliveryConfirmationSmsEnabled: true
IsArchived: true
IsPublished: true
Name: Example Name
EmailAddress: owner@example.com
StaffLanguage: string
SalesChannelTypes:
- Web
InheritanceConfigTypes:
- CollectionSettings
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreById400Example:
summary: Default GetStoreById 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreById401Example:
summary: Default GetStoreById 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreById403Example:
summary: Default GetStoreById 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreById404Example:
summary: Default GetStoreById 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreById500Example:
summary: Default GetStoreById 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Get Store by Id
description: Get Store by Id via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- Stores
operationId: UpdateStore
parameters:
- name: storeId
in: path
required: true
schema:
type: integer
format: int32
description: The store id path parameter.
example: 500123
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StoreBase'
examples:
UpdateStoreRequestExample:
summary: Default UpdateStore request
x-microcks-default: true
value:
PhoneNumber: '+353000000000'
AlwaysAppearOpen: true
PreOrderEnabled: true
TakeOutEnabled: true
TableServiceEnabled: true
DineInEnabled: true
AllowPreOrdersAndTableService: true
PickupEnabled: true
DeliveryEnabled: true
CardOrderDeliveryEnabled: true
CashOrdersDeliveryEnabled: true
CardOrdersPickupEnabled: true
CashOrdersPickupEnabled: true
TipsEnabled: true
AutomaticallyAcceptOrders: true
OpenForDelivery: true
OpenForPickup: true
MinimumPickupOrderAmount: 12.5
RequireCustomerNameForPickup: true
GdprCustomerPhoneNumbers: true
RequireCustomerNameForDelivery: true
AllowChefNotes: true
EtaInPickupConfirmationSmsEnabled: true
EtaInDeliveryConfirmationSmsEnabled: true
IsArchived: true
IsPublished: true
Name: Example Name
EmailAddress: owner@example.com
StaffLanguage: string
SalesChannelTypes:
- Web
InheritanceConfigTypes:
- CollectionSettings
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_Store_'
examples:
UpdateStore200Example:
summary: Default UpdateStore 200 response
x-microcks-default: true
value:
Data:
StoreId: 500123
StoreGroupId: 500123
Address:
AddressId: 500123
Coordinates: {}
Line1: string
Postcode: string
City: string
CountryCode: IE
DisplayForCustomer: string
AddressFields: {}
SingleLineDisplay: string
TwoLinesDisplay:
- string
DeliveryZones: []
ApmPhoneNumber: '+353000000000'
PickupHours: []
DeliveryHours: []
MenuId: 500123
OrderConfirmationMessageOverrideDelivery: string
OrderConfirmationMessageOverridePickup: string
PrintoutLayoutType: Default
StoreNotes: []
MicrosoftTimeZone: string
IanaTimeZone: string
Currency: EUR
PreOrderDeliveryEnabled: true
PreOrderPickupEnabled: true
LogoUrl: https://api.flipdish.co/example
FraudPreventionStrategy: string
AppIds:
- string
PropertyId: '500123'
PhoneNumber: '+353000000000'
AlwaysAppearOpen: true
PreOrderEnabled: true
TakeOutEnabled: true
TableServiceEnabled: true
DineInEnabled: true
AllowPreOrdersAndTableService: true
PickupEnabled: true
DeliveryEnabled: true
CardOrderDeliveryEnabled: true
CashOrdersDeliveryEnabled: true
CardOrdersPickupEnabled: true
CashOrdersPickupEnabled: true
TipsEnabled: true
AutomaticallyAcceptOrders: true
OpenForDelivery: true
OpenForPickup: true
MinimumPickupOrderAmount: 12.5
RequireCustomerNameForPickup: true
GdprCustomerPhoneNumbers: true
RequireCustomerNameForDelivery: true
AllowChefNotes: true
EtaInPickupConfirmationSmsEnabled: true
EtaInDeliveryConfirmationSmsEnabled: true
IsArchived: true
IsPublished: true
Name: Example Name
EmailAddress: owner@example.com
StaffLanguage: string
SalesChannelTypes:
- Web
InheritanceConfigTypes:
- CollectionSettings
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateStore400Example:
summary: Default UpdateStore 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateStore401Example:
summary: Default UpdateStore 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateStore403Example:
summary: Default UpdateStore 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateStore404Example:
summary: Default UpdateStore 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateStore409Example:
summary: Default UpdateStore 409 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateStore500Example:
summary: Default UpdateStore 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Update Store
description: Update Store via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/stores/{storeId}/feeConfig:
get:
tags:
- Stores
operationId: GetStoreFeeConfig
parameters:
- name: storeId
in: path
required: true
schema:
type: integer
format: int32
description: The store id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/StoreFeeConfig'
examples:
GetStoreFeeConfig200Example:
summary: Default GetStoreFeeConfig 200 response
x-microcks-default: true
value:
FeeConfigId: 500123
StoreId: 500123
StartTime: '2026-06-02T12:00:00Z'
PercentFeeCardOrders: 12.5
PercentFeeCashOrders: 12.5
PercentFeeCardOrdersWeb: 12.5
PercentFeeCashOrdersWeb: 12.5
PercentFeeCardOrdersKiosk: 12.5
PercentFeeCashOrdersKiosk: 12.5
FixedFeeCardOrdersKiosk: 12.5
FixedFeeCashOrdersKiosk: 12.5
PercentFeeCardOrdersKioskChargedToCustomerIncludingVat: 12.5
FixedFeeCardOrdersKioskChargedToCustomerIncludingVat: 12.5
PercentFeeCashOrdersKioskChargedToCustomerIncludingVat: 12.5
FixedFeeCashOrdersKioskChargedToCustomerIncludingVat: 12.5
FixedFeeCardOrders: 12.5
FixedFeeCashOrders: 12.5
PercentFeeCardOrdersChargedToCustomerIncludingVat: 12.5
FixedFeeCardOrdersChargedToCustomerIncludingVat: 12.5
PercentFeeCashOrdersChargedToCustomerIncludingVat: 12.5
FixedFeeCashOrdersChargedToCustomerIncludingVat: 12.5
PercentFeeTips: 12.5
PercentFeeTipsCollection: 12.5
PercentFeeTipsDelivery: 12.5
TaxRatePercent: 1.0
PercentFeeCardOrdersLocationService: 12.5
PercentFeeCashOrdersLocationService: 12.5
FixedFeeCardOrdersLocationService: 12.5
FixedFeeCashOrdersLocationService: 12.5
PercentFeeCardOrdersLocationServiceChargedToCustomerIncludingVat: 12.5
PercentFeeCashOrdersLocationServiceChargedToCustomerIncludingVat: 12.5
FixedFeeCardOrdersLocationServiceChargedToCustomerIncludingVat: 12.5
FixedFeeCashOrdersLocationServiceChargedToCustomerIncludingVat: 12.5
PercentFeeCardOrdersIngest: 12.5
PercentFeeCashOrdersIngest: 12.5
FixedFeeCardOrdersIngest: 12.5
FixedFeeCashOrdersIngest: 12.5
PercentFeeDelivery: 12.5
FixedFeeDelivery: 12.5
PercentFeeCardPosTransaction: 12.5
FixedFeeCardPosTransaction: 12.5
PercentFeeOrderWithGoogle: 12.5
FixedFeeOrderWithGoogle: 12.5
ShouldNotAutoIncreaseBefore: '2026-06-02T12:00:00Z'
Reason: string
PercentFeeCardOrdersPhoneAgent: 12.5
PercentFeeCashOrdersPhoneAgent: 12.5
FixedFeeCardOrdersPhoneAgent: 12.5
FixedFeeCashOrdersPhoneAgent: 12.5
PercentFeeCardOrdersPhoneAgentChargedToCustomerIncludingVat: 12.5
PercentFeeCashOrdersPhoneAgentChargedToCustomerIncludingVat: 12.5
FixedFeeCardOrdersPhoneAgentChargedToCustomerIncludingVat: 12.5
FixedFeeCashOrdersPhoneAgentChargedToCustomerIncludingVat: 12.5
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreFeeConfig400Example:
summary: Default GetStoreFeeConfig 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreFeeConfig401Example:
summary: Default GetStoreFeeConfig 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreFeeConfig403Example:
summary: Default GetStoreFeeConfig 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreFeeConfig404Example:
summary: Default GetStoreFeeConfig 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreFeeConfig500Example:
summary: Default GetStoreFeeConfig 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Get Store Fee Config
description: Get Store Fee Config via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/feeConfig).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/stores/{storeId}/leadTimes:
get:
tags:
- Stores
operationId: GetStoreLeadTimes
parameters:
- name: storeId
in: path
required: true
schema:
type: integer
format: int32
description: The store id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_OrderLeadTimes_'
examples:
GetStoreLeadTimes200Example:
summary: Default GetStoreLeadTimes 200 response
x-microcks-default: true
value:
Data:
LeadTimeMinutes: {}
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreLeadTimes400Example:
summary: Default GetStoreLeadTimes 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreLeadTimes401Example:
summary: Default GetStoreLeadTimes 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreLeadTimes403Example:
summary: Default GetStoreLeadTimes 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreLeadTimes404Example:
summary: Default GetStoreLeadTimes 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStoreLeadTimes500Example:
summary: Default GetStoreLeadTimes 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Get Store Lead Times
description: Get Store Lead Times via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/leadTimes).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- Stores
operationId: SetStoreLeadTimes
parameters:
- name: storeId
in: path
required: true
schema:
type: integer
format: int32
description: The store id path parameter.
example: 500123
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LeadTime'
examples:
SetStoreLeadTimesRequestExample:
summary: Default SetStoreLeadTimes request
x-microcks-default: true
value:
DispatchType: string
LeadTimeMinutes: 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_OrderLeadTimes_'
examples:
SetStoreLeadTimes200Example:
summary: Default SetStoreLeadTimes 200 response
x-microcks-default: true
value:
Data:
LeadTimeMinutes: {}
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
SetStoreLeadTimes400Example:
summary: Default SetStoreLeadTimes 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
SetStoreLeadTimes401Example:
summary: Default SetStoreLeadTimes 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
SetStoreLeadTimes403Example:
summary: Default SetStoreLeadTimes 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
SetStoreLeadTimes404Example:
summary: Default SetStoreLeadTimes 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
SetStoreLeadTimes500Example:
summary: Default SetStoreLeadTimes 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
# --- truncated at 32 KB (248 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-stores-api-openapi.yml