OpenAPI Specification
openapi: 3.0.3
info:
title: Flipdish API - Apps Accounts MobileApps 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: MobileApps
description: Operations for Mobile Apps.
paths:
/api/v1.0/mobileapps/{appId}/submission/details:
get:
tags:
- MobileApps
operationId: GetSubmissionDetails
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_MobileAppsSubmissionDetails_'
examples:
GetSubmissionDetails200Example:
summary: Default GetSubmissionDetails 200 response
x-microcks-default: true
value:
Data:
MobileAppsSubmissionId: 500123
AppName: Example Name
AppDescription: string
AppShortDescription: string
Keywords:
- string
AppLogoUrl: https://api.flipdish.co/example
AutoPublish: true
Status: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetSubmissionDetails400Example:
summary: Default GetSubmissionDetails 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:
GetSubmissionDetails401Example:
summary: Default GetSubmissionDetails 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:
GetSubmissionDetails403Example:
summary: Default GetSubmissionDetails 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:
GetSubmissionDetails404Example:
summary: Default GetSubmissionDetails 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:
GetSubmissionDetails500Example:
summary: Default GetSubmissionDetails 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 Submission Details
description: Get Submission Details via the Flipdish Open API v1.0 (GET /api/v1.0/mobileapps/{appId}/submission/details).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/mobileapps/{appId}/saleschannel/details:
get:
tags:
- MobileApps
operationId: GetAppConfigSalesChannel
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_AppConfigSalesChannel_'
examples:
GetAppConfigSalesChannel200Example:
summary: Default GetAppConfigSalesChannel 200 response
x-microcks-default: true
value:
Data:
EmailRequestMode: DoNotRequest
WebToAppRedirect: NoRedirect
AddressEntryType: MapFirst
DisplayDeliveryRestaurantListScreen: true
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetAppConfigSalesChannel400Example:
summary: Default GetAppConfigSalesChannel 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:
GetAppConfigSalesChannel401Example:
summary: Default GetAppConfigSalesChannel 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:
GetAppConfigSalesChannel403Example:
summary: Default GetAppConfigSalesChannel 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:
GetAppConfigSalesChannel404Example:
summary: Default GetAppConfigSalesChannel 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:
GetAppConfigSalesChannel500Example:
summary: Default GetAppConfigSalesChannel 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 App Config Sales Channel
description: Get App Config Sales Channel via the Flipdish Open API v1.0 (GET /api/v1.0/mobileapps/{appId}/saleschannel/details).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/mobileapps/{appId}/submission/{submissionId}/status:
get:
tags:
- MobileApps
operationId: GetSubmissionStatus
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: submissionId
in: path
required: true
schema:
type: integer
format: int32
description: The submission id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_MobileAppsSubmissionStatus_'
examples:
GetSubmissionStatus200Example:
summary: Default GetSubmissionStatus 200 response
x-microcks-default: true
value:
Data:
MobileAppsSubmissionStatusId: 500123
MobileAppsSubmissionId: 500123
Type: None
AppStatus: None
UpdateStatus: None
LastUpdateStatusTime: '2026-06-02T12:00:00Z'
CreateTime: '2026-06-02T12:00:00Z'
UpdateTime: '2026-06-02T12:00:00Z'
Notes: string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetSubmissionStatus400Example:
summary: Default GetSubmissionStatus 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:
GetSubmissionStatus401Example:
summary: Default GetSubmissionStatus 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:
GetSubmissionStatus403Example:
summary: Default GetSubmissionStatus 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:
GetSubmissionStatus404Example:
summary: Default GetSubmissionStatus 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:
GetSubmissionStatus500Example:
summary: Default GetSubmissionStatus 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 Submission Status
description: Get Submission Status via the Flipdish Open API v1.0 (GET /api/v1.0/mobileapps/{appId}/submission/{submissionId}/status).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- MobileApps
operationId: UpdateSubmissionStatus
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: submissionId
in: path
required: true
schema:
type: integer
format: int32
description: The submission id path parameter.
example: 500123
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMobileAppsSubmissionStatus'
examples:
UpdateSubmissionStatusRequestExample:
summary: Default UpdateSubmissionStatus request
x-microcks-default: true
value:
MobileAppsSubmissionStatusId: 500123
Type: None
AppStatus: None
UpdateStatus: None
LastUpdateStatusTime: '2026-06-02T12:00:00Z'
Notes: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_UpdateMobileAppsSubmissionStatus_'
examples:
UpdateSubmissionStatus200Example:
summary: Default UpdateSubmissionStatus 200 response
x-microcks-default: true
value:
Data:
MobileAppsSubmissionStatusId: 500123
Type: None
AppStatus: None
UpdateStatus: None
LastUpdateStatusTime: '2026-06-02T12:00:00Z'
Notes: string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateSubmissionStatus400Example:
summary: Default UpdateSubmissionStatus 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:
UpdateSubmissionStatus401Example:
summary: Default UpdateSubmissionStatus 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:
UpdateSubmissionStatus403Example:
summary: Default UpdateSubmissionStatus 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:
UpdateSubmissionStatus404Example:
summary: Default UpdateSubmissionStatus 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:
UpdateSubmissionStatus500Example:
summary: Default UpdateSubmissionStatus 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 Submission Status
description: Update Submission Status via the Flipdish Open API v1.0 (POST /api/v1.0/mobileapps/{appId}/submission/{submissionId}/status).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/mobileapps/{appId}/statistics:
get:
tags:
- MobileApps
operationId: GetStatistics
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: platformTypes
in: query
required: true
explode: true
schema:
type: array
items:
type: string
enum:
- None
- Android
- IOS
description: The platform types query parameter.
example:
- None
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiArrayResult_MobileAppsStatistics_'
examples:
GetStatistics200Example:
summary: Default GetStatistics 200 response
x-microcks-default: true
value:
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetStatistics400Example:
summary: Default GetStatistics 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:
GetStatistics401Example:
summary: Default GetStatistics 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:
GetStatistics403Example:
summary: Default GetStatistics 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:
GetStatistics404Example:
summary: Default GetStatistics 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:
GetStatistics500Example:
summary: Default GetStatistics 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 Statistics
description: Get Statistics via the Flipdish Open API v1.0 (GET /api/v1.0/mobileapps/{appId}/statistics).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/mobileapps/{appId}/submission:
post:
tags:
- MobileApps
operationId: Submission
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
requestBody:
required: false
content: {}
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_MobileAppsSubmission_'
examples:
Submission200Example:
summary: Default Submission 200 response
x-microcks-default: true
value:
Data:
SubmissionId: 500123
AppName: Example Name
AppDescription: string
AppShortDescription: string
Keywords:
- string
AutoPublish: true
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Submission400Example:
summary: Default Submission 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:
Submission401Example:
summary: Default Submission 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:
Submission403Example:
summary: Default Submission 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:
Submission404Example:
summary: Default Submission 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:
Submission500Example:
summary: Default Submission 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 Submission
description: Submission via the Flipdish Open API v1.0 (POST /api/v1.0/mobileapps/{appId}/submission).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/mobileapps/{appId}/resubmission:
post:
tags:
- MobileApps
operationId: Resubmission
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
requestBody:
required: false
content: {}
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_MobileAppsSubmission_'
examples:
Resubmission200Example:
summary: Default Resubmission 200 response
x-microcks-default: true
value:
Data:
SubmissionId: 500123
AppName: Example Name
AppDescription: string
AppShortDescription: string
Keywords:
- string
AutoPublish: true
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Resubmission400Example:
summary: Default Resubmission 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:
Resubmission401Example:
summary: Default Resubmission 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:
Resubmission403Example:
summary: Default Resubmission 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:
Resubmission404Example:
summary: Default Resubmission 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:
Resubmission500Example:
summary: Default Resubmission 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 Resubmission
description: Resubmission via
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-mobileapps-api-openapi.yml