OpenAPI Specification
openapi: 3.0.3
info:
title: Flipdish API - Apps Accounts MenuOptionSets 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: MenuOptionSets
description: Operations for Menu Option Sets.
paths:
/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets:
get:
tags:
- MenuOptionSets
summary: Flipdish Get Menu Item Option Sets
operationId: GetMenuItemOptionSets
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: menuSectionItemId
in: path
description: Menu section item identifier
required: true
schema:
type: integer
format: int32
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiArrayResult_MenuItemOptionSet_'
examples:
GetMenuItemOptionSets200Example:
summary: Default GetMenuItemOptionSets 200 response
x-microcks-default: true
value:
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetMenuItemOptionSets400Example:
summary: Default GetMenuItemOptionSets 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:
GetMenuItemOptionSets401Example:
summary: Default GetMenuItemOptionSets 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:
GetMenuItemOptionSets403Example:
summary: Default GetMenuItemOptionSets 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:
GetMenuItemOptionSets404Example:
summary: Default GetMenuItemOptionSets 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:
GetMenuItemOptionSets500Example:
summary: Default GetMenuItemOptionSets 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 Item Option Sets via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- MenuOptionSets
summary: Flipdish Create Menu Item Option Set
operationId: CreateMenuItemOptionSet
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: menuSectionItemId
in: path
description: Menu section item identifier
required: true
schema:
type: integer
format: int32
example: 500123
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MenuItemOptionSetBase'
examples:
CreateMenuItemOptionSetRequestExample:
summary: Default CreateMenuItemOptionSet request
x-microcks-default: true
value:
Name: Example Name
IsMasterOptionSet: true
DisplayOrder: 1
MinSelectCount: 3
MaxSelectCount: 3
CellLayoutType: Small
PublicId: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
CreateMenuItemOptionSet200Example:
summary: Default CreateMenuItemOptionSet 200 response
x-microcks-default: true
value: {}
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_MenuItemOptionSet_'
examples:
CreateMenuItemOptionSet201Example:
summary: Default CreateMenuItemOptionSet 201 response
x-microcks-default: true
value:
Data:
MenuItemOptionSetId: 500123
ImageName: Example Name
ImageUrl: https://api.flipdish.co/example
MenuItemOptionSetItems: []
PublicId: 00000000-0000-0000-0000-000000000000
CatalogItemId: '500123'
Name: Example Name
IsMasterOptionSet: true
DisplayOrder: 1
MinSelectCount: 3
MaxSelectCount: 3
CellLayoutType: Small
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
CreateMenuItemOptionSet400Example:
summary: Default CreateMenuItemOptionSet 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:
CreateMenuItemOptionSet401Example:
summary: Default CreateMenuItemOptionSet 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:
CreateMenuItemOptionSet403Example:
summary: Default CreateMenuItemOptionSet 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:
CreateMenuItemOptionSet404Example:
summary: Default CreateMenuItemOptionSet 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:
CreateMenuItemOptionSet500Example:
summary: Default CreateMenuItemOptionSet 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 Item Option Set via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}:
get:
tags:
- MenuOptionSets
summary: Flipdish Get Menu Item Option Set by Id
operationId: GetMenuItemOptionSetById
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: menuSectionItemId
in: path
description: Menu section item identifier
required: true
schema:
type: integer
format: int32
example: 500123
- name: optionSetId
in: path
description: Menu item option set identifier
required: true
schema:
type: integer
format: int32
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_MenuItemOptionSet_'
examples:
GetMenuItemOptionSetById200Example:
summary: Default GetMenuItemOptionSetById 200 response
x-microcks-default: true
value:
Data:
MenuItemOptionSetId: 500123
ImageName: Example Name
ImageUrl: https://api.flipdish.co/example
MenuItemOptionSetItems: []
PublicId: 00000000-0000-0000-0000-000000000000
CatalogItemId: '500123'
Name: Example Name
IsMasterOptionSet: true
DisplayOrder: 1
MinSelectCount: 3
MaxSelectCount: 3
CellLayoutType: Small
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetMenuItemOptionSetById400Example:
summary: Default GetMenuItemOptionSetById 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:
GetMenuItemOptionSetById401Example:
summary: Default GetMenuItemOptionSetById 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:
GetMenuItemOptionSetById403Example:
summary: Default GetMenuItemOptionSetById 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:
GetMenuItemOptionSetById404Example:
summary: Default GetMenuItemOptionSetById 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:
GetMenuItemOptionSetById500Example:
summary: Default GetMenuItemOptionSetById 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 Item Option Set by Id via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- MenuOptionSets
summary: Flipdish Update Menu Item Option Set
operationId: UpdateMenuItemOptionSet
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: menuSectionItemId
in: path
description: Menu section item identifier
required: true
schema:
type: integer
format: int32
example: 500123
- name: optionSetId
in: path
description: Option set identifier
required: true
schema:
type: integer
format: int32
example: 500123
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MenuItemOptionSetBase'
examples:
UpdateMenuItemOptionSetRequestExample:
summary: Default UpdateMenuItemOptionSet request
x-microcks-default: true
value:
Name: Example Name
IsMasterOptionSet: true
DisplayOrder: 1
MinSelectCount: 3
MaxSelectCount: 3
CellLayoutType: Small
PublicId: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: OK
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateMenuItemOptionSet400Example:
summary: Default UpdateMenuItemOptionSet 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:
UpdateMenuItemOptionSet401Example:
summary: Default UpdateMenuItemOptionSet 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:
UpdateMenuItemOptionSet403Example:
summary: Default UpdateMenuItemOptionSet 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:
UpdateMenuItemOptionSet404Example:
summary: Default UpdateMenuItemOptionSet 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:
UpdateMenuItemOptionSet500Example:
summary: Default UpdateMenuItemOptionSet 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 Item Option Set via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- MenuOptionSets
summary: Flipdish Delete Menu Item Option Set
operationId: DeleteMenuItemOptionSet
parameters:
- name: menuId
in: path
description: Menu identifier
required: true
schema:
type: integer
format: int32
example: 500123
- name: menuSectionItemId
in: path
description: Menu section item 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: optionSetId
in: path
description: Option set 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:
DeleteMenuItemOptionSet400Example:
summary: Default DeleteMenuItemOptionSet 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:
DeleteMenuItemOptionSet401Example:
summary: Default DeleteMenuItemOptionSet 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:
DeleteMenuItemOptionSet403Example:
summary: Default DeleteMenuItemOptionSet 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:
DeleteMenuItemOptionSet404Example:
summary: Default DeleteMenuItemOptionSet 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:
DeleteMenuItemOptionSet500Example:
summary: Default DeleteMenuItemOptionSet 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 Item Option Set via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/image:
post:
tags:
- MenuOptionSets
summary: Flipdish Upload Option Set Image
operationId: UploadOptionSetImage
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: menuSectionItemId
in: path
description: Menu section item identifier
required: true
schema:
type: integer
format: int32
example: 500123
- name: optionSetId
in: path
description: Option set identifier
required: true
schema:
type: integer
format: int32
example: 500123
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
Image:
description: Option set image
type: string
format: binary
required:
- Image
examples:
UploadOptionSetImageRequestExample:
summary: Default UploadOptionSetImage request
x-microcks-default: true
value:
Image: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiStringResult'
examples:
UploadOptionSetImage200Example:
summary: Default UploadOptionSetImage 200 response
x-microcks-default: true
value:
Data: string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UploadOptionSetImage400Example:
summary: Default UploadOptionSetImage 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:
UploadOptionSetImage401Example:
summary: Default UploadOptionSetImage 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:
UploadOptionSetImage403Example:
summary: Default UploadOptionSetImage 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:
UploadOptionSetImage404Example:
summary: Default UploadOptionSetImage 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:
UploadOptionSetImage500Example:
summary: Default UploadOptionSetImage 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: Upload Option Set Image via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/image).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- MenuOptionSets
summary: Flipdish Delete Option Set Image
operationId: DeleteOptionSetImage
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
f
# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-menuoptionsets-api-openapi.yml