OpenAPI Specification
openapi: 3.0.3
info:
title: Flipdish API - Apps Accounts MenuSections 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: MenuSections
description: Operations for Menu Sections.
paths:
/api/v1.0/menus/{menuId}/sections:
get:
tags:
- MenuSections
summary: Flipdish Get Menu Sections
operationId: GetMenuSections
parameters:
- name: menuId
in: path
description: Menu identifier
required: true
schema:
type: integer
format: int32
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiArrayResult_MenuSection_'
examples:
GetMenuSections200Example:
summary: Default GetMenuSections 200 response
x-microcks-default: true
value:
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetMenuSections400Example:
summary: Default GetMenuSections 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:
GetMenuSections401Example:
summary: Default GetMenuSections 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:
GetMenuSections403Example:
summary: Default GetMenuSections 403 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:
GetMenuSections500Example:
summary: Default GetMenuSections 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
description: Get Menu Sections via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/sections).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- MenuSections
summary: Flipdish Create Menu Section
operationId: CreateMenuSection
parameters:
- name: menuId
in: path
description: Menu identifier
required: true
schema:
type: integer
format: int32
example: 500123
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MenuSectionBase'
examples:
CreateMenuSectionRequestExample:
summary: Default CreateMenuSection request
x-microcks-default: true
value:
Name: Example Name
Description: string
DisplayOrder: 1
IsAvailable: true
IsHiddenFromCustomers: true
ImageUrl: https://api.flipdish.co/example
MenuSectionId: 500123
PublicId: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
CreateMenuSection200Example:
summary: Default CreateMenuSection 200 response
x-microcks-default: true
value: {}
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_MenuSection_'
examples:
CreateMenuSection201Example:
summary: Default CreateMenuSection 201 response
x-microcks-default: true
value:
Data:
MenuSectionId: 500123
MenuItems: []
MenuSectionAvailability:
AvailableTimes: []
AvailabilityMode: DisplayAlways
PublicId: 00000000-0000-0000-0000-000000000000
ImageName: Example Name
Name: Example Name
Description: string
DisplayOrder: 1
IsAvailable: true
IsHiddenFromCustomers: true
ImageUrl: https://api.flipdish.co/example
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
CreateMenuSection400Example:
summary: Default CreateMenuSection 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:
CreateMenuSection401Example:
summary: Default CreateMenuSection 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:
CreateMenuSection403Example:
summary: Default CreateMenuSection 403 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:
CreateMenuSection500Example:
summary: Default CreateMenuSection 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
description: Create Menu Section via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/menus/{menuId}/sections/{menuSectionId}:
get:
tags:
- MenuSections
summary: Flipdish Get Menu Section by Id
operationId: GetMenuSectionById
parameters:
- name: menuId
in: path
description: Menu identifier
required: true
schema:
type: integer
format: int32
example: 500123
- name: menuSectionId
in: path
description: Menu section identifier
required: true
schema:
type: integer
format: int32
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_MenuSection_'
examples:
GetMenuSectionById200Example:
summary: Default GetMenuSectionById 200 response
x-microcks-default: true
value:
Data:
MenuSectionId: 500123
MenuItems: []
MenuSectionAvailability:
AvailableTimes: []
AvailabilityMode: DisplayAlways
PublicId: 00000000-0000-0000-0000-000000000000
ImageName: Example Name
Name: Example Name
Description: string
DisplayOrder: 1
IsAvailable: true
IsHiddenFromCustomers: true
ImageUrl: https://api.flipdish.co/example
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetMenuSectionById400Example:
summary: Default GetMenuSectionById 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:
GetMenuSectionById401Example:
summary: Default GetMenuSectionById 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:
GetMenuSectionById403Example:
summary: Default GetMenuSectionById 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:
GetMenuSectionById404Example:
summary: Default GetMenuSectionById 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:
GetMenuSectionById500Example:
summary: Default GetMenuSectionById 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
description: Get Menu Section by Id via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- MenuSections
summary: Flipdish Update Menu Section
operationId: UpdateMenuSection
parameters:
- name: menuId
in: path
description: Menu identifier
required: true
schema:
type: integer
format: int32
example: 500123
- name: menuSectionId
in: path
description: Menu section identifier
required: true
schema:
type: integer
format: int32
example: 500123
- name: undoAfter
in: query
description: An optional time period, in hours, after which the hide-section operation will be undone.
required: false
schema:
type: number
format: double
example: 1.0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MenuSectionBase'
examples:
UpdateMenuSectionRequestExample:
summary: Default UpdateMenuSection request
x-microcks-default: true
value:
Name: Example Name
Description: string
DisplayOrder: 1
IsAvailable: true
IsHiddenFromCustomers: true
ImageUrl: https://api.flipdish.co/example
MenuSectionId: 500123
PublicId: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: OK
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateMenuSection400Example:
summary: Default UpdateMenuSection 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:
UpdateMenuSection401Example:
summary: Default UpdateMenuSection 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:
UpdateMenuSection403Example:
summary: Default UpdateMenuSection 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:
UpdateMenuSection404Example:
summary: Default UpdateMenuSection 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:
UpdateMenuSection500Example:
summary: Default UpdateMenuSection 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
description: Update Menu Section via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- MenuSections
summary: Flipdish Delete Menu Section
operationId: DeleteMenuSection
parameters:
- name: menuId
in: path
description: Menu identifier
required: true
schema:
type: integer
format: int32
example: 500123
- name: menuSectionId
in: path
description: Menu section identifier
required: true
schema:
type: integer
format: int32
example: 500123
responses:
'200':
description: OK
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
DeleteMenuSection400Example:
summary: Default DeleteMenuSection 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:
DeleteMenuSection401Example:
summary: Default DeleteMenuSection 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:
DeleteMenuSection403Example:
summary: Default DeleteMenuSection 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:
DeleteMenuSection404Example:
summary: Default DeleteMenuSection 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:
DeleteMenuSection500Example:
summary: Default DeleteMenuSection 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
description: Delete Menu Section via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/menus/{menuId}/sections/{menuSectionId}/clone:
post:
tags:
- MenuSections
summary: Flipdish Clone Menu Section
operationId: CloneMenuSection
parameters:
- name: menuId
in: path
description: Menu identifier
required: true
schema:
type: integer
format: int32
example: 500123
- name: menuSectionId
in: path
description: Menu section identifier
required: true
schema:
type: integer
format: int32
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_MenuSection_'
examples:
CloneMenuSection200Example:
summary: Default CloneMenuSection 200 response
x-microcks-default: true
value:
Data:
MenuSectionId: 500123
MenuItems: []
MenuSectionAvailability:
AvailableTimes: []
AvailabilityMode: DisplayAlways
PublicId: 00000000-0000-0000-0000-000000000000
ImageName: Example Name
Name: Example Name
Description: string
DisplayOrder: 1
IsAvailable: true
IsHiddenFromCustomers: true
ImageUrl: https://api.flipdish.co/example
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
CloneMenuSection400Example:
summary: Default CloneMenuSection 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:
CloneMenuSection401Example:
summary: Default CloneMenuSection 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:
CloneMenuSection403Example:
summary: Default CloneMenuSection 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:
CloneMenuSection404Example:
summary: Default CloneMenuSection 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:
CloneMenuSection500Example:
summary: Default CloneMenuSection 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
description: Clone Menu Section via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/clone).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/menus/{menuId}/sections/{menuSectionId}/image:
post:
tags:
- MenuSections
summary: Flipdish Upload Menu Section Image
operationId: UploadMenuSectionImage
parameters:
- name: menuId
in: path
description: Menu identifier
required: true
schema:
type: integer
format: int32
example: 500123
- name: menuSectionId
in: path
description: Menu section identifier
required: true
schema:
type: integer
format: int32
example: 500123
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
Image:
description: Menu section image
type: string
format: binary
required:
- Image
examples:
UploadMenuSectionImageRequestExample:
summary: Default UploadMenuSectionImage request
x-microcks-default: true
value:
Image: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiStringResult'
examples:
UploadMenuSectionImage200Example:
summary: Default UploadMenuSectionImage 200 response
x-microcks-default: true
value:
Data: string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UploadMenuSectionImage400Example:
summary: Default UploadMenuSectionImage 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:
UploadMenuSectionImage401Example:
summary: Default UploadMenuSectionImage 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:
UploadMenuSectionImage403Example:
summary: Default UploadMenuSectionImage 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:
UploadMenuSectionImage404Example:
summary: Default UploadMenuSectionImage 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:
UploadMenuSectionImage500Example:
summary: Default UploadMenuSectionImage 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 (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-menusections-api-openapi.yml