{ "openapi": "3.0.3", "info": { "title": "Flipdish API - Menus", "version": "v1.0", "description": "Flipdish Open API v1.0 \u2014 Menus 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": "MenuOptionSetItems", "description": "Operations for Menu Option Set Items." }, { "name": "MenuOptionSets", "description": "Operations for Menu Option Sets." }, { "name": "MenuSectionItems", "description": "Operations for Menu Section Items." }, { "name": "MenuSections", "description": "Operations for Menu Sections." }, { "name": "MenuZones", "description": "Operations for Menu Zones." }, { "name": "Menus", "description": "Operations for Menus." }, { "name": "MenusNutritionInfo", "description": "Operations for Menus Nutrition Info." }, { "name": "MenusNutritionInfoV2", "description": "Operations for Menus Nutrition Info V2." } ], "paths": { "/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems": { "get": { "tags": [ "MenuOptionSetItems" ], "summary": "Flipdish Get Menu Item Option Set Items", "operationId": "GetMenuItemOptionSetItems", "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 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_MenuItemOptionSetItem_" }, "examples": { "GetMenuItemOptionSetItems200Example": { "summary": "Default GetMenuItemOptionSetItems 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuItemOptionSetItems400Example": { "summary": "Default GetMenuItemOptionSetItems 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": { "GetMenuItemOptionSetItems401Example": { "summary": "Default GetMenuItemOptionSetItems 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": { "GetMenuItemOptionSetItems403Example": { "summary": "Default GetMenuItemOptionSetItems 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": { "GetMenuItemOptionSetItems404Example": { "summary": "Default GetMenuItemOptionSetItems 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": { "GetMenuItemOptionSetItems500Example": { "summary": "Default GetMenuItemOptionSetItems 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 Items via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "MenuOptionSetItems" ], "summary": "Flipdish Add Menu Item Option Set Item", "operationId": "AddMenuItemOptionSetItem", "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/MenuItemOptionSetItemBase" }, "examples": { "AddMenuItemOptionSetItemRequestExample": { "summary": "Default AddMenuItemOptionSetItem request", "x-microcks-default": true, "value": { "Name": "Example Name", "Price": 12.5, "DepositReturnFee": 12.5, "IsAvailable": true, "DisplayOrder": 1, "CellLayoutType": "Small", "ImageUrl": "https://api.flipdish.co/example", "PublicId": "00000000-0000-0000-0000-000000000000" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "AddMenuItemOptionSetItem200Example": { "summary": "Default AddMenuItemOptionSetItem 200 response", "x-microcks-default": true, "value": {} } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MenuItemOptionSetItem_" }, "examples": { "AddMenuItemOptionSetItem201Example": { "summary": "Default AddMenuItemOptionSetItem 201 response", "x-microcks-default": true, "value": { "Data": { "MenuItemOptionSetItemId": 500123, "PublicId": "00000000-0000-0000-0000-000000000000", "Metadata": [], "NextMenuItemOptionSetId": 500123, "CatalogItemId": "500123", "TaxRateName": "Example Name", "TaxRateId": 500123, "TaxValue": 1.0, "Name": "Example Name", "Price": 12.5, "DepositReturnFee": 12.5, "IsAvailable": true, "DisplayOrder": 1, "CellLayoutType": "Small", "ImageUrl": "https://api.flipdish.co/example" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddMenuItemOptionSetItem400Example": { "summary": "Default AddMenuItemOptionSetItem 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": { "AddMenuItemOptionSetItem401Example": { "summary": "Default AddMenuItemOptionSetItem 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": { "AddMenuItemOptionSetItem403Example": { "summary": "Default AddMenuItemOptionSetItem 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": { "AddMenuItemOptionSetItem404Example": { "summary": "Default AddMenuItemOptionSetItem 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": { "AddMenuItemOptionSetItem500Example": { "summary": "Default AddMenuItemOptionSetItem 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": "Add Menu Item Option Set Item via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId}": { "get": { "tags": [ "MenuOptionSetItems" ], "summary": "Flipdish Get Menu Item Option Set Item by Id", "operationId": "GetMenuItemOptionSetItemById", "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 }, { "name": "menuItemOptionSetItemId", "in": "path", "description": "Option set item identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MenuItemOptionSetItem_" }, "examples": { "GetMenuItemOptionSetItemById200Example": { "summary": "Default GetMenuItemOptionSetItemById 200 response", "x-microcks-default": true, "value": { "Data": { "MenuItemOptionSetItemId": 500123, "PublicId": "00000000-0000-0000-0000-000000000000", "Metadata": [], "NextMenuItemOptionSetId": 500123, "CatalogItemId": "500123", "TaxRateName": "Example Name", "TaxRateId": 500123, "TaxValue": 1.0, "Name": "Example Name", "Price": 12.5, "DepositReturnFee": 12.5, "IsAvailable": true, "DisplayOrder": 1, "CellLayoutType": "Small", "ImageUrl": "https://api.flipdish.co/example" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuItemOptionSetItemById400Example": { "summary": "Default GetMenuItemOptionSetItemById 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": { "GetMenuItemOptionSetItemById401Example": { "summary": "Default GetMenuItemOptionSetItemById 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": { "GetMenuItemOptionSetItemById403Example": { "summary": "Default GetMenuItemOptionSetItemById 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": { "GetMenuItemOptionSetItemById404Example": { "summary": "Default GetMenuItemOptionSetItemById 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": { "GetMenuItemOptionSetItemById500Example": { "summary": "Default GetMenuItemOptionSetItemById 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 Item by Id via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "MenuOptionSetItems" ], "summary": "Flipdish Update Menu Item Option Set Item", "operationId": "UpdateMenuItemOptionSetItem", "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 }, { "name": "menuItemOptionSetItemId", "in": "path", "description": "Option set item 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/MenuItemOptionSetItemBase" }, "examples": { "UpdateMenuItemOptionSetItemRequestExample": { "summary": "Default UpdateMenuItemOptionSetItem request", "x-microcks-default": true, "value": { "Name": "Example Name", "Price": 12.5, "DepositReturnFee": 12.5, "IsAvailable": true, "DisplayOrder": 1, "CellLayoutType": "Small", "ImageUrl": "https://api.flipdish.co/example", "PublicId": "00000000-0000-0000-0000-000000000000" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateMenuItemOptionSetItem400Example": { "summary": "Default UpdateMenuItemOptionSetItem 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": { "UpdateMenuItemOptionSetItem401Example": { "summary": "Default UpdateMenuItemOptionSetItem 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": { "UpdateMenuItemOptionSetItem403Example": { "summary": "Default UpdateMenuItemOptionSetItem 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": { "UpdateMenuItemOptionSetItem404Example": { "summary": "Default UpdateMenuItemOptionSetItem 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": { "UpdateMenuItemOptionSetItem500Example": { "summary": "Default UpdateMenuItemOptionSetItem 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 Item via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "MenuOptionSetItems" ], "summary": "Flipdish Remove Menu Item Option Set Item", "operationId": "RemoveMenuItemOptionSetItem", "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 }, { "name": "menuItemOptionSetItemId", "in": "path", "description": "Option set item 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": { "RemoveMenuItemOptionSetItem400Example": { "summary": "Default RemoveMenuItemOptionSetItem 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": { "RemoveMenuItemOptionSetItem401Example": { "summary": "Default RemoveMenuItemOptionSetItem 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": { "RemoveMenuItemOptionSetItem403Example": { "summary": "Default RemoveMenuItemOptionSetItem 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": { "RemoveMenuItemOptionSetItem404Example": { "summary": "Default RemoveMenuItemOptionSetItem 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": { "RemoveMenuItemOptionSetItem500Example": { "summary": "Default RemoveMenuItemOptionSetItem 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": "Remove Menu Item Option Set Item via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId}/image": { "post": { "tags": [ "MenuOptionSetItems" ], "summary": "Flipdish Upload Option Set Item Image", "operationId": "UploadOptionSetItemImage", "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 }, { "name": "menuItemOptionSetItemId", "in": "path", "description": "Option set item identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Image": { "description": "Option set item image", "type": "string", "format": "binary" } }, "required": [ "Image" ] }, "examples": { "UploadOptionSetItemImageRequestExample": { "summary": "Default UploadOptionSetItemImage request", "x-microcks-default": true, "value": { "Image": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringResult" }, "examples": { "UploadOptionSetItemImage200Example": { "summary": "Default UploadOptionSetItemImage 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadOptionSetItemImage400Example": { "summary": "Default UploadOptionSetItemImage 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": { "UploadOptionSetItemImage401Example": { "summary": "Default UploadOptionSetItemImage 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": { "UploadOptionSetItemImage403Example": { "summary": "Default UploadOptionSetItemImage 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": { "UploadOptionSetItemImage404Example": { "summary": "Default UploadOptionSetItemImage 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": { "UploadOptionSetItemImage500Example": { "summary": "Default UploadOptionSetItemImage 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 Item Image via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId}/image).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "MenuOptionSetItems" ], "summary": "Flipdish Delete Option Set Item Image", "operationId": "DeleteOptionSetItemImage", "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 }, { "name": "menuItemOptionSetItemId", "in": "path", "description": "Option set item 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": { "DeleteOptionSetItemImage400Example": { "summary": "Default DeleteOptionSetItemImage 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": { "DeleteOptionSetItemImage401Example": { "summary": "Default DeleteOptionSetItemImage 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": { "DeleteOptionSetItemImage403Example": { "summary": "Default DeleteOptionSetItemImage 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": { "DeleteOptionSetItemImage404Example": { "summary": "Default DeleteOptionSetItemImage 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": { "DeleteOptionSetItemImage500Example": { "summary": "Default DeleteOptionSetItemImage 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 Option Set Item Image via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId}/image).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId}/taxrate/{taxRateId}": { "post": { "tags": [ "MenuOptionSetItems" ], "summary": "Flipdish Set Option Set Item Tax", "operationId": "SetOptionSetItemTax", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuSectionId", "in": "path", "description": "The menu section id path parameter.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuSectionItemId", "in": "path", "description": "The menu section item id path parameter.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "optionSetId", "in": "path", "description": "The option set id path parameter.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuItemOptionSetItemId", "in": "path", "description": "Option set item identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "taxRateId", "in": "path", "description": "Tax Rate to use", "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": { "SetOptionSetItemTax400Example": { "summary": "Default SetOptionSetItemTax 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": { "SetOptionSetItemTax401Example": { "summary": "Default SetOptionSetItemTax 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": { "SetOptionSetItemTax403Example": { "summary": "Default SetOptionSetItemTax 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": { "SetOptionSetItemTax500Example": { "summary": "Default SetOptionSetItemTax 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": "Set Option Set Item Tax via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/optionsetitems/{menuItemOptionSetItemId}/taxrate/{taxRateId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/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", "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 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteOptionSetImage400Example": { "summary": "Default DeleteOptionSetImage 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": { "DeleteOptionSetImage401Example": { "summary": "Default DeleteOptionSetImage 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": { "DeleteOptionSetImage403Example": { "summary": "Default DeleteOptionSetImage 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": { "DeleteOptionSetImage404Example": { "summary": "Default DeleteOptionSetImage 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": { "DeleteOptionSetImage500Example": { "summary": "Default DeleteOptionSetImage 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 Option Set Image via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/optionsets/{optionSetId}/image).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/menus": { "get": { "tags": [ "Menus" ], "summary": "Flipdish Get Menus by App Id", "operationId": "GetMenusByAppId", "parameters": [ { "name": "appId", "in": "path", "description": "Get Menus for this appId", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_MenuSummary_" }, "examples": { "GetMenusByAppId200Example": { "summary": "Default GetMenusByAppId 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenusByAppId400Example": { "summary": "Default GetMenusByAppId 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": { "GetMenusByAppId401Example": { "summary": "Default GetMenusByAppId 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": { "GetMenusByAppId403Example": { "summary": "Default GetMenusByAppId 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": { "GetMenusByAppId404Example": { "summary": "Default GetMenusByAppId 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": { "GetMenusByAppId409Example": { "summary": "Default GetMenusByAppId 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": { "GetMenusByAppId500Example": { "summary": "Default GetMenusByAppId 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 Menus by App Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/menus).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Menus" ], "summary": "Flipdish Create New Menu for App", "description": "Create New Menu for App via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/menus).", "operationId": "CreateNewMenuForApp", "parameters": [ { "name": "appId", "in": "path", "description": "App identifier", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFullMenu" }, "examples": { "CreateNewMenuForAppRequestExample": { "summary": "Default CreateNewMenuForApp request", "x-microcks-default": true, "value": { "Name": "Example Name", "ImageUrl": "https://api.flipdish.co/example", "MenuSections": [], "TaxRates": [], "DisplaySectionLinks": true, "MenuSectionBehaviour": "ExpandSingle", "TaxType": "IncludedInBasePrice", "IsIntegrated": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "format": "int32", "type": "integer" }, "examples": { "CreateNewMenuForApp200Example": { "summary": "Default CreateNewMenuForApp 200 response", "x-microcks-default": true, "value": 1 } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateNewMenuForApp400Example": { "summary": "Default CreateNewMenuForApp 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": { "CreateNewMenuForApp401Example": { "summary": "Default CreateNewMenuForApp 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": { "CreateNewMenuForApp403Example": { "summary": "Default CreateNewMenuForApp 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": { "CreateNewMenuForApp500Example": { "summary": "Default CreateNewMenuForApp 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "deprecated": true, "security": [ { "oauth2": [ "api" ] } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}": { "get": { "tags": [ "Menus" ], "summary": "Flipdish Get Menu by Id", "operationId": "GetMenuById", "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/RestApiResult_Menu_" }, "examples": { "GetMenuById200Example": { "summary": "Default GetMenuById 200 response", "x-microcks-default": true, "value": { "Data": { "MenuId": 500123, "ModifiedTime": "2026-06-02T12:00:00Z", "VersionNumber": 3, "ImageName": "Example Name", "ImageUrl": "https://api.flipdish.co/example", "Name": "Example Name", "Locked": true, "MenuSections": [], "TaxRates": [], "AppId": "500123", "DisplaySectionLinks": true, "MenuSectionBehaviour": "ExpandSingle", "TaxType": "IncludedInBasePrice", "IsIntegrated": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuById400Example": { "summary": "Default GetMenuById 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": { "GetMenuById401Example": { "summary": "Default GetMenuById 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": { "GetMenuById403Example": { "summary": "Default GetMenuById 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": { "GetMenuById404Example": { "summary": "Default GetMenuById 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": { "GetMenuById409Example": { "summary": "Default GetMenuById 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": { "GetMenuById500Example": { "summary": "Default GetMenuById 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 by Id via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Menus" ], "summary": "Flipdish Update Menu", "operationId": "UpdateMenu", "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/MenuBase" }, "examples": { "UpdateMenuRequestExample": { "summary": "Default UpdateMenu request", "x-microcks-default": true, "value": { "DisplaySectionLinks": true, "MenuSectionBehaviour": "ExpandSingle", "TaxType": "IncludedInBasePrice", "IsIntegrated": true } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateMenu400Example": { "summary": "Default UpdateMenu 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": { "UpdateMenu401Example": { "summary": "Default UpdateMenu 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": { "UpdateMenu403Example": { "summary": "Default UpdateMenu 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": { "UpdateMenu404Example": { "summary": "Default UpdateMenu 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": { "UpdateMenu500Example": { "summary": "Default UpdateMenu 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 via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Menus" ], "summary": "Flipdish Delete Menu", "operationId": "DeleteMenu", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu 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": { "DeleteMenu400Example": { "summary": "Default DeleteMenu 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": { "DeleteMenu401Example": { "summary": "Default DeleteMenu 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": { "DeleteMenu403Example": { "summary": "Default DeleteMenu 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": { "DeleteMenu404Example": { "summary": "Default DeleteMenu 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": { "DeleteMenu500Example": { "summary": "Default DeleteMenu 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 via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/tax": { "get": { "tags": [ "Menus" ], "summary": "Flipdish Get Menu Tax Details", "operationId": "GetMenuTaxDetails", "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_MenuTaxDetails_" }, "examples": { "GetMenuTaxDetails200Example": { "summary": "Default GetMenuTaxDetails 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuTaxDetails400Example": { "summary": "Default GetMenuTaxDetails 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": { "GetMenuTaxDetails401Example": { "summary": "Default GetMenuTaxDetails 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": { "GetMenuTaxDetails403Example": { "summary": "Default GetMenuTaxDetails 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": { "GetMenuTaxDetails404Example": { "summary": "Default GetMenuTaxDetails 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": { "GetMenuTaxDetails500Example": { "summary": "Default GetMenuTaxDetails 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 Tax Details via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/tax).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/name": { "get": { "tags": [ "Menus" ], "summary": "Flipdish Get Menu Name", "operationId": "GetMenuName", "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": { "type": "string" }, "examples": { "GetMenuName200Example": { "summary": "Default GetMenuName 200 response", "x-microcks-default": true, "value": "string" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuName400Example": { "summary": "Default GetMenuName 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": { "GetMenuName401Example": { "summary": "Default GetMenuName 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": { "GetMenuName403Example": { "summary": "Default GetMenuName 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": { "GetMenuName404Example": { "summary": "Default GetMenuName 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": { "GetMenuName500Example": { "summary": "Default GetMenuName 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 Name via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/name).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Menus" ], "summary": "Flipdish Set Menu Name", "operationId": "SetMenuName", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "string" }, "examples": { "SetMenuNameRequestExample": { "summary": "Default SetMenuName request", "x-microcks-default": true, "value": "string" } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetMenuName400Example": { "summary": "Default SetMenuName 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": { "SetMenuName401Example": { "summary": "Default SetMenuName 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": { "SetMenuName403Example": { "summary": "Default SetMenuName 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": { "SetMenuName404Example": { "summary": "Default SetMenuName 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": { "SetMenuName500Example": { "summary": "Default SetMenuName 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": "Set Menu Name via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/name).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/stores": { "get": { "tags": [ "Menus" ], "summary": "Flipdish Get Menu Store Names", "operationId": "GetMenuStoreNames", "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_MenuStoreNames_" }, "examples": { "GetMenuStoreNames200Example": { "summary": "Default GetMenuStoreNames 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuStoreNames400Example": { "summary": "Default GetMenuStoreNames 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": { "GetMenuStoreNames401Example": { "summary": "Default GetMenuStoreNames 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": { "GetMenuStoreNames403Example": { "summary": "Default GetMenuStoreNames 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": { "GetMenuStoreNames404Example": { "summary": "Default GetMenuStoreNames 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": { "GetMenuStoreNames409Example": { "summary": "Default GetMenuStoreNames 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": { "GetMenuStoreNames500Example": { "summary": "Default GetMenuStoreNames 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 Store Names via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/stores).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/checkpoints": { "get": { "tags": [ "Menus" ], "summary": "Flipdish Get Menus Checkpoints", "operationId": "GetMenusCheckpoints", "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_MenuCheckpoint_" }, "examples": { "GetMenusCheckpoints200Example": { "summary": "Default GetMenusCheckpoints 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenusCheckpoints400Example": { "summary": "Default GetMenusCheckpoints 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": { "GetMenusCheckpoints401Example": { "summary": "Default GetMenusCheckpoints 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": { "GetMenusCheckpoints403Example": { "summary": "Default GetMenusCheckpoints 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": { "GetMenusCheckpoints500Example": { "summary": "Default GetMenusCheckpoints 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 Menus Checkpoints via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/checkpoints).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/metadata/store/{storeId}": { "get": { "tags": [ "Menus" ], "summary": "Flipdish Get All Menu Metadata by Menu Id and Store Id", "operationId": "GetAllMenuMetadataByMenuIdAndStoreId", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "path", "description": "Store identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_AllMetadataResult_" }, "examples": { "GetAllMenuMetadataByMenuIdAndStoreId200Example": { "summary": "Default GetAllMenuMetadataByMenuIdAndStoreId 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAllMenuMetadataByMenuIdAndStoreId400Example": { "summary": "Default GetAllMenuMetadataByMenuIdAndStoreId 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": { "GetAllMenuMetadataByMenuIdAndStoreId401Example": { "summary": "Default GetAllMenuMetadataByMenuIdAndStoreId 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": { "GetAllMenuMetadataByMenuIdAndStoreId403Example": { "summary": "Default GetAllMenuMetadataByMenuIdAndStoreId 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": { "GetAllMenuMetadataByMenuIdAndStoreId404Example": { "summary": "Default GetAllMenuMetadataByMenuIdAndStoreId 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": { "GetAllMenuMetadataByMenuIdAndStoreId409Example": { "summary": "Default GetAllMenuMetadataByMenuIdAndStoreId 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": { "GetAllMenuMetadataByMenuIdAndStoreId500Example": { "summary": "Default GetAllMenuMetadataByMenuIdAndStoreId 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 All Menu Metadata by Menu Id and Store Id via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/metadata/store/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/bulkshowhide/list": { "get": { "tags": [ "Menus" ], "summary": "Flipdish Menus_Get Menu Bulk Show Hide", "operationId": "Menus_GetMenuBulkShowHide", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu id", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "isAvailable", "in": "query", "description": "Is available flag", "required": true, "schema": { "type": "boolean" }, "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_MenuElementListResponse_" }, "examples": { "Menus_GetMenuBulkShowHide200Example": { "summary": "Default Menus_GetMenuBulkShowHide 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Menus_GetMenuBulkShowHide400Example": { "summary": "Default Menus_GetMenuBulkShowHide 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": { "Menus_GetMenuBulkShowHide401Example": { "summary": "Default Menus_GetMenuBulkShowHide 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": { "Menus_GetMenuBulkShowHide403Example": { "summary": "Default Menus_GetMenuBulkShowHide 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": { "Menus_GetMenuBulkShowHide500Example": { "summary": "Default Menus_GetMenuBulkShowHide 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": "Menus_Get Menu Bulk Show Hide via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/bulkshowhide/list).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/menuitem/{menuItemId}/metadata/store/{storeId}": { "get": { "tags": [ "Menus" ], "summary": "Flipdish Get Menu Item Metadata", "operationId": "GetMenuItemMetadata", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "path", "description": "Store identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuItemId", "in": "path", "description": "Menu item identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_Metadata_" }, "examples": { "GetMenuItemMetadata200Example": { "summary": "Default GetMenuItemMetadata 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuItemMetadata400Example": { "summary": "Default GetMenuItemMetadata 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": { "GetMenuItemMetadata401Example": { "summary": "Default GetMenuItemMetadata 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": { "GetMenuItemMetadata403Example": { "summary": "Default GetMenuItemMetadata 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": { "GetMenuItemMetadata404Example": { "summary": "Default GetMenuItemMetadata 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": { "GetMenuItemMetadata409Example": { "summary": "Default GetMenuItemMetadata 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": { "GetMenuItemMetadata500Example": { "summary": "Default GetMenuItemMetadata 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 Metadata via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/menuitem/{menuItemId}/metadata/store/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "put": { "tags": [ "Menus" ], "summary": "Flipdish Set Menu Item Metadata", "operationId": "SetMenuItemMetadata", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "path", "description": "Store identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuItemId", "in": "path", "description": "Menu item identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetMenuItemMetadata400Example": { "summary": "Default SetMenuItemMetadata 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": { "SetMenuItemMetadata401Example": { "summary": "Default SetMenuItemMetadata 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": { "SetMenuItemMetadata403Example": { "summary": "Default SetMenuItemMetadata 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": { "SetMenuItemMetadata404Example": { "summary": "Default SetMenuItemMetadata 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": { "SetMenuItemMetadata409Example": { "summary": "Default SetMenuItemMetadata 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": { "SetMenuItemMetadata500Example": { "summary": "Default SetMenuItemMetadata 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": "Set Menu Item Metadata via the Flipdish Open API v1.0 (PUT /api/v1.0/menus/{menuId}/menuitem/{menuItemId}/metadata/store/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/menuitem/{menuItemId}/metadata/{key}/store/{storeId}": { "get": { "tags": [ "Menus" ], "summary": "Flipdish Get Menu Item Metadata by Key", "operationId": "GetMenuItemMetadataByKey", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "path", "description": "Store identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuItemId", "in": "path", "description": "Menu item identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "key", "in": "path", "description": "Metadata key", "required": true, "schema": { "type": "string" }, "example": "string" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Metadata_" }, "examples": { "GetMenuItemMetadataByKey200Example": { "summary": "Default GetMenuItemMetadataByKey 200 response", "x-microcks-default": true, "value": { "Data": { "MenuEntityId": 500123, "Key": "string", "Value": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuItemMetadataByKey400Example": { "summary": "Default GetMenuItemMetadataByKey 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": { "GetMenuItemMetadataByKey401Example": { "summary": "Default GetMenuItemMetadataByKey 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": { "GetMenuItemMetadataByKey403Example": { "summary": "Default GetMenuItemMetadataByKey 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": { "GetMenuItemMetadataByKey404Example": { "summary": "Default GetMenuItemMetadataByKey 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": { "GetMenuItemMetadataByKey409Example": { "summary": "Default GetMenuItemMetadataByKey 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": { "GetMenuItemMetadataByKey500Example": { "summary": "Default GetMenuItemMetadataByKey 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 Metadata by Key via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/menuitem/{menuItemId}/metadata/{key}/store/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Menus" ], "summary": "Flipdish Delete Menu Item Metadata", "operationId": "DeleteMenuItemMetadata", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "path", "description": "Store identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuItemId", "in": "path", "description": "Menu item identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "key", "in": "path", "description": "Metadata key", "required": true, "schema": { "type": "string" }, "example": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteMenuItemMetadata400Example": { "summary": "Default DeleteMenuItemMetadata 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": { "DeleteMenuItemMetadata401Example": { "summary": "Default DeleteMenuItemMetadata 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": { "DeleteMenuItemMetadata403Example": { "summary": "Default DeleteMenuItemMetadata 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": { "DeleteMenuItemMetadata404Example": { "summary": "Default DeleteMenuItemMetadata 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": { "DeleteMenuItemMetadata409Example": { "summary": "Default DeleteMenuItemMetadata 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": { "DeleteMenuItemMetadata500Example": { "summary": "Default DeleteMenuItemMetadata 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 Metadata via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/menuitem/{menuItemId}/metadata/{key}/store/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/optionsetitem/{optionSetItemId}/metadata/store/{storeId}": { "get": { "tags": [ "Menus" ], "summary": "Flipdish Get Menu Item Option Set Item Metadata", "operationId": "GetMenuItemOptionSetItemMetadata", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "path", "description": "Store identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "optionSetItemId", "in": "path", "description": "Menu item option set item identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Metadata_" }, "examples": { "GetMenuItemOptionSetItemMetadata200Example": { "summary": "Default GetMenuItemOptionSetItemMetadata 200 response", "x-microcks-default": true, "value": { "Data": { "MenuEntityId": 500123, "Key": "string", "Value": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuItemOptionSetItemMetadata400Example": { "summary": "Default GetMenuItemOptionSetItemMetadata 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": { "GetMenuItemOptionSetItemMetadata401Example": { "summary": "Default GetMenuItemOptionSetItemMetadata 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": { "GetMenuItemOptionSetItemMetadata403Example": { "summary": "Default GetMenuItemOptionSetItemMetadata 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": { "GetMenuItemOptionSetItemMetadata404Example": { "summary": "Default GetMenuItemOptionSetItemMetadata 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": { "GetMenuItemOptionSetItemMetadata409Example": { "summary": "Default GetMenuItemOptionSetItemMetadata 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": { "GetMenuItemOptionSetItemMetadata500Example": { "summary": "Default GetMenuItemOptionSetItemMetadata 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 Item Metadata via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/optionsetitem/{optionSetItemId}/metadata/store/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "put": { "tags": [ "Menus" ], "summary": "Flipdish Set Menu Item Option Set Item Metadata", "operationId": "SetMenuItemOptionSetItemMetadata", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "path", "description": "Store identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "optionSetItemId", "in": "path", "description": "Menu item option set item identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetMenuItemOptionSetItemMetadata400Example": { "summary": "Default SetMenuItemOptionSetItemMetadata 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": { "SetMenuItemOptionSetItemMetadata401Example": { "summary": "Default SetMenuItemOptionSetItemMetadata 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": { "SetMenuItemOptionSetItemMetadata403Example": { "summary": "Default SetMenuItemOptionSetItemMetadata 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": { "SetMenuItemOptionSetItemMetadata404Example": { "summary": "Default SetMenuItemOptionSetItemMetadata 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": { "SetMenuItemOptionSetItemMetadata409Example": { "summary": "Default SetMenuItemOptionSetItemMetadata 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": { "SetMenuItemOptionSetItemMetadata500Example": { "summary": "Default SetMenuItemOptionSetItemMetadata 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": "Set Menu Item Option Set Item Metadata via the Flipdish Open API v1.0 (PUT /api/v1.0/menus/{menuId}/optionsetitem/{optionSetItemId}/metadata/store/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/menus/xlsx": { "post": { "tags": [ "Menus" ], "summary": "Flipdish Upload New Menu for App", "operationId": "UploadNewMenuForApp", "parameters": [ { "name": "appId", "in": "path", "description": "App identifier", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Menu": { "description": "Uploaded xlsx menu", "type": "string", "format": "binary" } }, "required": [ "Menu" ] }, "examples": { "UploadNewMenuForAppRequestExample": { "summary": "Default UploadNewMenuForApp request", "x-microcks-default": true, "value": { "Menu": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "format": "int32", "type": "integer" }, "examples": { "UploadNewMenuForApp200Example": { "summary": "Default UploadNewMenuForApp 200 response", "x-microcks-default": true, "value": 1 } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadNewMenuForApp400Example": { "summary": "Default UploadNewMenuForApp 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": { "UploadNewMenuForApp401Example": { "summary": "Default UploadNewMenuForApp 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": { "UploadNewMenuForApp403Example": { "summary": "Default UploadNewMenuForApp 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": { "UploadNewMenuForApp500Example": { "summary": "Default UploadNewMenuForApp 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 New Menu for App via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/menus/xlsx).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/lock": { "post": { "tags": [ "Menus" ], "summary": "Flipdish Set Menu Lock", "operationId": "SetMenuLock", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "boolean" }, "examples": { "SetMenuLockRequestExample": { "summary": "Default SetMenuLock request", "x-microcks-default": true, "value": true } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetMenuLock400Example": { "summary": "Default SetMenuLock 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": { "SetMenuLock401Example": { "summary": "Default SetMenuLock 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": { "SetMenuLock403Example": { "summary": "Default SetMenuLock 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": { "SetMenuLock404Example": { "summary": "Default SetMenuLock 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": { "SetMenuLock500Example": { "summary": "Default SetMenuLock 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": "Set Menu Lock via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/lock).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/image": { "post": { "tags": [ "Menus" ], "summary": "Flipdish Upload Menu Image", "operationId": "UploadMenuImage", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Image": { "description": "Menu image", "type": "string", "format": "binary" } }, "required": [ "Image" ] }, "examples": { "UploadMenuImageRequestExample": { "summary": "Default UploadMenuImage request", "x-microcks-default": true, "value": { "Image": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringResult" }, "examples": { "UploadMenuImage200Example": { "summary": "Default UploadMenuImage 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadMenuImage400Example": { "summary": "Default UploadMenuImage 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": { "UploadMenuImage401Example": { "summary": "Default UploadMenuImage 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": { "UploadMenuImage403Example": { "summary": "Default UploadMenuImage 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": { "UploadMenuImage404Example": { "summary": "Default UploadMenuImage 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": { "UploadMenuImage500Example": { "summary": "Default UploadMenuImage 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 Menu Image via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/image).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Menus" ], "summary": "Flipdish Delete Menu Image", "operationId": "DeleteMenuImage", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu 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": { "DeleteMenuImage400Example": { "summary": "Default DeleteMenuImage 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": { "DeleteMenuImage401Example": { "summary": "Default DeleteMenuImage 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": { "DeleteMenuImage403Example": { "summary": "Default DeleteMenuImage 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": { "DeleteMenuImage404Example": { "summary": "Default DeleteMenuImage 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": { "DeleteMenuImage500Example": { "summary": "Default DeleteMenuImage 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 Image via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/image).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/taxrate": { "post": { "tags": [ "Menus" ], "summary": "Flipdish Menus_Upsert Tax Rate", "operationId": "Menus_UpsertTaxRate", "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/MenuTaxRate" }, "examples": { "Menus_UpsertTaxRateRequestExample": { "summary": "Default Menus_UpsertTaxRate request", "x-microcks-default": true, "value": { "TaxRateId": 500123, "Name": "Example Name", "Rate": 1.0 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuTaxRate" }, "examples": { "Menus_UpsertTaxRate200Example": { "summary": "Default Menus_UpsertTaxRate 200 response", "x-microcks-default": true, "value": { "TaxRateId": 500123, "Name": "Example Name", "Rate": 1.0 } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Menus_UpsertTaxRate400Example": { "summary": "Default Menus_UpsertTaxRate 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": { "Menus_UpsertTaxRate401Example": { "summary": "Default Menus_UpsertTaxRate 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": { "Menus_UpsertTaxRate403Example": { "summary": "Default Menus_UpsertTaxRate 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": { "Menus_UpsertTaxRate500Example": { "summary": "Default Menus_UpsertTaxRate 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": "Menus_Upsert Tax Rate via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/taxrate).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/clone/{newName}": { "post": { "tags": [ "Menus" ], "summary": "Flipdish Create Draft Menu from Existing Menu", "operationId": "CreateDraftMenuFromExistingMenu", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "newName", "in": "path", "description": "Name of the new Menu", "required": true, "schema": { "type": "string" }, "example": "Example Name" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Menu_" }, "examples": { "CreateDraftMenuFromExistingMenu200Example": { "summary": "Default CreateDraftMenuFromExistingMenu 200 response", "x-microcks-default": true, "value": { "Data": { "MenuId": 500123, "ModifiedTime": "2026-06-02T12:00:00Z", "VersionNumber": 3, "ImageName": "Example Name", "ImageUrl": "https://api.flipdish.co/example", "Name": "Example Name", "Locked": true, "MenuSections": [], "TaxRates": [], "AppId": "500123", "DisplaySectionLinks": true, "MenuSectionBehaviour": "ExpandSingle", "TaxType": "IncludedInBasePrice", "IsIntegrated": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateDraftMenuFromExistingMenu400Example": { "summary": "Default CreateDraftMenuFromExistingMenu 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": { "CreateDraftMenuFromExistingMenu401Example": { "summary": "Default CreateDraftMenuFromExistingMenu 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": { "CreateDraftMenuFromExistingMenu403Example": { "summary": "Default CreateDraftMenuFromExistingMenu 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": { "CreateDraftMenuFromExistingMenu404Example": { "summary": "Default CreateDraftMenuFromExistingMenu 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": { "CreateDraftMenuFromExistingMenu409Example": { "summary": "Default CreateDraftMenuFromExistingMenu 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": { "CreateDraftMenuFromExistingMenu500Example": { "summary": "Default CreateDraftMenuFromExistingMenu 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 Draft Menu from Existing Menu via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/clone/{newName}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/tax/show/{show}": { "post": { "tags": [ "Menus" ], "summary": "Flipdish Menus_Set Display on Menu Tax", "operationId": "Menus_SetDisplayOnMenuTax", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "show", "in": "path", "description": "Boolean show or dont show tax (Exclusive tax type can only ever be TRUE)", "required": true, "schema": { "type": "boolean" }, "example": true } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Menus_SetDisplayOnMenuTax400Example": { "summary": "Default Menus_SetDisplayOnMenuTax 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": { "Menus_SetDisplayOnMenuTax401Example": { "summary": "Default Menus_SetDisplayOnMenuTax 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": { "Menus_SetDisplayOnMenuTax403Example": { "summary": "Default Menus_SetDisplayOnMenuTax 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": { "Menus_SetDisplayOnMenuTax500Example": { "summary": "Default Menus_SetDisplayOnMenuTax 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": "Menus_Set Display on Menu Tax via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/tax/show/{show}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/tax/type/{type}": { "post": { "tags": [ "Menus" ], "summary": "Flipdish Menus_Update Tax Type", "operationId": "Menus_UpdateTaxType", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "type", "in": "path", "description": "Type of Tax", "required": true, "schema": { "type": "string", "enum": [ "IncludedInBasePrice", "ExcludedFromBasePrice" ] }, "example": "IncludedInBasePrice" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Menus_UpdateTaxType400Example": { "summary": "Default Menus_UpdateTaxType 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": { "Menus_UpdateTaxType401Example": { "summary": "Default Menus_UpdateTaxType 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": { "Menus_UpdateTaxType403Example": { "summary": "Default Menus_UpdateTaxType 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": { "Menus_UpdateTaxType500Example": { "summary": "Default Menus_UpdateTaxType 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": "Menus_Update Tax Type via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/tax/type/{type}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/menus/async": { "post": { "tags": [ "Menus" ], "summary": "Flipdish Create New Menu Async", "description": "Create New Menu Async via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/menus/async).", "operationId": "CreateNewMenuAsync", "parameters": [ { "name": "appId", "in": "path", "description": "App id", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "orgId", "in": "query", "description": "Org id", "required": false, "schema": { "type": "string" }, "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFullMenu" }, "examples": { "CreateNewMenuAsyncRequestExample": { "summary": "Default CreateNewMenuAsync request", "x-microcks-default": true, "value": { "Name": "Example Name", "ImageUrl": "https://api.flipdish.co/example", "MenuSections": [], "TaxRates": [], "DisplaySectionLinks": true, "MenuSectionBehaviour": "ExpandSingle", "TaxType": "IncludedInBasePrice", "IsIntegrated": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CreateNewMenuAsync200Example": { "summary": "Default CreateNewMenuAsync 200 response", "x-microcks-default": true, "value": {} } } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "format": "int32", "type": "integer" }, "examples": { "CreateNewMenuAsync202Example": { "summary": "Default CreateNewMenuAsync 202 response", "x-microcks-default": true, "value": 1 } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateNewMenuAsync400Example": { "summary": "Default CreateNewMenuAsync 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": { "CreateNewMenuAsync401Example": { "summary": "Default CreateNewMenuAsync 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": { "CreateNewMenuAsync403Example": { "summary": "Default CreateNewMenuAsync 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": { "CreateNewMenuAsync500Example": { "summary": "Default CreateNewMenuAsync 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/sectiondisplayorders": { "post": { "tags": [ "Menus" ], "summary": "Flipdish Menus_Set Item Display Orders", "operationId": "Menus_SetItemDisplayOrders", "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/MenuObjectDisplayOrders" }, "examples": { "Menus_SetItemDisplayOrdersRequestExample": { "summary": "Default Menus_SetItemDisplayOrders request", "x-microcks-default": true, "value": { "DisplayOrders": [] } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Menus_SetItemDisplayOrders400Example": { "summary": "Default Menus_SetItemDisplayOrders 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": { "Menus_SetItemDisplayOrders401Example": { "summary": "Default Menus_SetItemDisplayOrders 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": { "Menus_SetItemDisplayOrders403Example": { "summary": "Default Menus_SetItemDisplayOrders 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": { "Menus_SetItemDisplayOrders500Example": { "summary": "Default Menus_SetItemDisplayOrders 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": "Menus_Set Item Display Orders via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sectiondisplayorders).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/checkpoints/{checkpointId}/restore": { "post": { "tags": [ "Menus" ], "summary": "Flipdish Restore a Menu Checkpoint", "operationId": "Restore a Menu Checkpoint", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "checkpointId", "in": "path", "description": "Checkpoint to restore menu to", "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": { "Restore a Menu Checkpoint400Example": { "summary": "Default Restore a Menu Checkpoint 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": { "Restore a Menu Checkpoint401Example": { "summary": "Default Restore a Menu Checkpoint 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": { "Restore a Menu Checkpoint403Example": { "summary": "Default Restore a Menu Checkpoint 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": { "Restore a Menu Checkpoint500Example": { "summary": "Default Restore a Menu Checkpoint 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": "Restore a Menu Checkpoint via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/checkpoints/{checkpointId}/restore).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/bulkshowhide": { "post": { "tags": [ "Menus" ], "summary": "Flipdish Menus_Show Hide Bulk Items", "operationId": "Menus_ShowHideBulkItems", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu id", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "isAvailable", "in": "query", "description": "Is available flag", "required": true, "schema": { "type": "boolean" }, "example": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MenuElementHide" } }, "examples": { "Menus_ShowHideBulkItemsRequestExample": { "summary": "Default Menus_ShowHideBulkItems request", "x-microcks-default": true, "value": [ { "MenuElementId": 500123, "MenuElementType": "Item" } ] } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_MenuElementEditResponse_" }, "examples": { "Menus_ShowHideBulkItems200Example": { "summary": "Default Menus_ShowHideBulkItems 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Menus_ShowHideBulkItems400Example": { "summary": "Default Menus_ShowHideBulkItems 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": { "Menus_ShowHideBulkItems401Example": { "summary": "Default Menus_ShowHideBulkItems 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": { "Menus_ShowHideBulkItems403Example": { "summary": "Default Menus_ShowHideBulkItems 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": { "Menus_ShowHideBulkItems500Example": { "summary": "Default Menus_ShowHideBulkItems 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": "Menus_Show Hide Bulk Items via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/bulkshowhide).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/tax/{taxId}": { "delete": { "tags": [ "Menus" ], "summary": "Flipdish Menus_Delete Tax Rate", "operationId": "Menus_DeleteTaxRate", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "taxId", "in": "path", "description": "Id of Menu Tax to be removed", "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": { "Menus_DeleteTaxRate400Example": { "summary": "Default Menus_DeleteTaxRate 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": { "Menus_DeleteTaxRate401Example": { "summary": "Default Menus_DeleteTaxRate 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": { "Menus_DeleteTaxRate403Example": { "summary": "Default Menus_DeleteTaxRate 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": { "Menus_DeleteTaxRate500Example": { "summary": "Default Menus_DeleteTaxRate 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": "Menus_Delete Tax Rate via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/tax/{taxId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems": { "get": { "tags": [ "MenuSectionItems" ], "summary": "Flipdish Get Menu Items", "operationId": "GetMenuItems", "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/RestApiArrayResult_MenuSectionItem_" }, "examples": { "GetMenuItems200Example": { "summary": "Default GetMenuItems 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuItems400Example": { "summary": "Default GetMenuItems 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": { "GetMenuItems401Example": { "summary": "Default GetMenuItems 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": { "GetMenuItems403Example": { "summary": "Default GetMenuItems 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": { "GetMenuItems404Example": { "summary": "Default GetMenuItems 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": { "GetMenuItems500Example": { "summary": "Default GetMenuItems 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 Items via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "MenuSectionItems" ], "summary": "Flipdish Create Menu Section Item", "operationId": "CreateMenuSectionItem", "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": { "$ref": "#/components/schemas/MenuSectionItemBase" }, "examples": { "CreateMenuSectionItemRequestExample": { "summary": "Default CreateMenuSectionItem request", "x-microcks-default": true, "value": { "Name": "Example Name", "Description": "string", "SpicinessRating": "NotRated", "Price": 12.5, "DepositReturnFee": 12.5, "DisplayOrder": 1, "Alcohol": true, "IsAvailable": true, "CellLayoutType": "Small", "DisableVouchers": true, "ImageName": "Example Name", "ImageUrl": "https://api.flipdish.co/example", "MenuItemId": 500123, "ExcludeFromVoucherDiscounting": true, "PublicId": "00000000-0000-0000-0000-000000000000" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CreateMenuSectionItem200Example": { "summary": "Default CreateMenuSectionItem 200 response", "x-microcks-default": true, "value": {} } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MenuSectionItem_" }, "examples": { "CreateMenuSectionItem201Example": { "summary": "Default CreateMenuSectionItem 201 response", "x-microcks-default": true, "value": { "Data": { "ActualPrice": 12.5, "MenuItemOptionSets": [], "DailySpecialHours": [], "PublicId": "00000000-0000-0000-0000-000000000000", "TaxRateName": "Example Name", "TaxRateId": 500123, "TaxValue": 1.0, "ExcludeFromVoucherDiscounting": true, "Metadata": [], "CatalogItemId": "500123", "Name": "Example Name", "Description": "string", "SpicinessRating": "NotRated", "Price": 12.5, "DepositReturnFee": 12.5, "DisplayOrder": 1, "Alcohol": true, "IsAvailable": true, "CellLayoutType": "Small", "DisableVouchers": true, "ImageName": "Example Name", "ImageUrl": "https://api.flipdish.co/example", "MenuItemId": 500123 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateMenuSectionItem400Example": { "summary": "Default CreateMenuSectionItem 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": { "CreateMenuSectionItem401Example": { "summary": "Default CreateMenuSectionItem 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": { "CreateMenuSectionItem403Example": { "summary": "Default CreateMenuSectionItem 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": { "CreateMenuSectionItem404Example": { "summary": "Default CreateMenuSectionItem 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": { "CreateMenuSectionItem500Example": { "summary": "Default CreateMenuSectionItem 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 Item via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}": { "get": { "tags": [ "MenuSectionItems" ], "summary": "Flipdish Get Menu Item by Id", "operationId": "GetMenuItemById", "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 item identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MenuSectionItem_" }, "examples": { "GetMenuItemById200Example": { "summary": "Default GetMenuItemById 200 response", "x-microcks-default": true, "value": { "Data": { "ActualPrice": 12.5, "MenuItemOptionSets": [], "DailySpecialHours": [], "PublicId": "00000000-0000-0000-0000-000000000000", "TaxRateName": "Example Name", "TaxRateId": 500123, "TaxValue": 1.0, "ExcludeFromVoucherDiscounting": true, "Metadata": [], "CatalogItemId": "500123", "Name": "Example Name", "Description": "string", "SpicinessRating": "NotRated", "Price": 12.5, "DepositReturnFee": 12.5, "DisplayOrder": 1, "Alcohol": true, "IsAvailable": true, "CellLayoutType": "Small", "DisableVouchers": true, "ImageName": "Example Name", "ImageUrl": "https://api.flipdish.co/example", "MenuItemId": 500123 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuItemById400Example": { "summary": "Default GetMenuItemById 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": { "GetMenuItemById401Example": { "summary": "Default GetMenuItemById 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": { "GetMenuItemById403Example": { "summary": "Default GetMenuItemById 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": { "GetMenuItemById404Example": { "summary": "Default GetMenuItemById 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": { "GetMenuItemById500Example": { "summary": "Default GetMenuItemById 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 by Id via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "MenuSectionItems" ], "summary": "Flipdish Update Menu Section Item", "operationId": "UpdateMenuSectionItem", "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": "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/MenuSectionItemBase" }, "examples": { "UpdateMenuSectionItemRequestExample": { "summary": "Default UpdateMenuSectionItem request", "x-microcks-default": true, "value": { "Name": "Example Name", "Description": "string", "SpicinessRating": "NotRated", "Price": 12.5, "DepositReturnFee": 12.5, "DisplayOrder": 1, "Alcohol": true, "IsAvailable": true, "CellLayoutType": "Small", "DisableVouchers": true, "ImageName": "Example Name", "ImageUrl": "https://api.flipdish.co/example", "MenuItemId": 500123, "ExcludeFromVoucherDiscounting": true, "PublicId": "00000000-0000-0000-0000-000000000000" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateMenuSectionItem400Example": { "summary": "Default UpdateMenuSectionItem 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": { "UpdateMenuSectionItem401Example": { "summary": "Default UpdateMenuSectionItem 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": { "UpdateMenuSectionItem403Example": { "summary": "Default UpdateMenuSectionItem 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": { "UpdateMenuSectionItem404Example": { "summary": "Default UpdateMenuSectionItem 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": { "UpdateMenuSectionItem500Example": { "summary": "Default UpdateMenuSectionItem 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 Item via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "MenuSectionItems" ], "summary": "Flipdish Delete Menu Section Item", "operationId": "DeleteMenuSectionItem", "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" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteMenuSectionItem400Example": { "summary": "Default DeleteMenuSectionItem 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": { "DeleteMenuSectionItem401Example": { "summary": "Default DeleteMenuSectionItem 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": { "DeleteMenuSectionItem403Example": { "summary": "Default DeleteMenuSectionItem 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": { "DeleteMenuSectionItem404Example": { "summary": "Default DeleteMenuSectionItem 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": { "DeleteMenuSectionItem500Example": { "summary": "Default DeleteMenuSectionItem 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 Item via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/add-catalogitems": { "post": { "tags": [ "MenuSectionItems" ], "summary": "Flipdish Create Menu Section Item from Catalog Items", "description": "Create Menu Section Item from Catalog Items via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/add-catalogitems).", "operationId": "CreateMenuSectionItemFromCatalogItems", "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": { "$ref": "#/components/schemas/CreateMenuSectionItemFromCatalogItems" }, "examples": { "CreateMenuSectionItemFromCatalogItemsRequestExample": { "summary": "Default CreateMenuSectionItemFromCatalogItems request", "x-microcks-default": true, "value": { "MenuCatalogItems": [] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CreateMenuSectionItemFromCatalogItems200Example": { "summary": "Default CreateMenuSectionItemFromCatalogItems 200 response", "x-microcks-default": true, "value": {} } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_CreatedMenuSectionItems_" }, "examples": { "CreateMenuSectionItemFromCatalogItems201Example": { "summary": "Default CreateMenuSectionItemFromCatalogItems 201 response", "x-microcks-default": true, "value": { "Data": { "MenuSectionItems": [] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateMenuSectionItemFromCatalogItems400Example": { "summary": "Default CreateMenuSectionItemFromCatalogItems 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": { "CreateMenuSectionItemFromCatalogItems401Example": { "summary": "Default CreateMenuSectionItemFromCatalogItems 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": { "CreateMenuSectionItemFromCatalogItems403Example": { "summary": "Default CreateMenuSectionItemFromCatalogItems 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": { "CreateMenuSectionItemFromCatalogItems404Example": { "summary": "Default CreateMenuSectionItemFromCatalogItems 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": { "CreateMenuSectionItemFromCatalogItems500Example": { "summary": "Default CreateMenuSectionItemFromCatalogItems 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/clone": { "post": { "tags": [ "MenuSectionItems" ], "summary": "Flipdish Clone Menu Section Item", "operationId": "CloneMenuSectionItem", "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/RestApiResult_MenuSectionItem_" }, "examples": { "CloneMenuSectionItem200Example": { "summary": "Default CloneMenuSectionItem 200 response", "x-microcks-default": true, "value": { "Data": { "ActualPrice": 12.5, "MenuItemOptionSets": [], "DailySpecialHours": [], "PublicId": "00000000-0000-0000-0000-000000000000", "TaxRateName": "Example Name", "TaxRateId": 500123, "TaxValue": 1.0, "ExcludeFromVoucherDiscounting": true, "Metadata": [], "CatalogItemId": "500123", "Name": "Example Name", "Description": "string", "SpicinessRating": "NotRated", "Price": 12.5, "DepositReturnFee": 12.5, "DisplayOrder": 1, "Alcohol": true, "IsAvailable": true, "CellLayoutType": "Small", "DisableVouchers": true, "ImageName": "Example Name", "ImageUrl": "https://api.flipdish.co/example", "MenuItemId": 500123 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CloneMenuSectionItem400Example": { "summary": "Default CloneMenuSectionItem 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": { "CloneMenuSectionItem401Example": { "summary": "Default CloneMenuSectionItem 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": { "CloneMenuSectionItem403Example": { "summary": "Default CloneMenuSectionItem 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": { "CloneMenuSectionItem404Example": { "summary": "Default CloneMenuSectionItem 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": { "CloneMenuSectionItem500Example": { "summary": "Default CloneMenuSectionItem 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 Item via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/clone).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/image": { "post": { "tags": [ "MenuSectionItems" ], "summary": "Flipdish Upload Menu Section Item Image", "operationId": "UploadMenuSectionItemImage", "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": { "type": "object", "properties": { "Image": { "description": "Menu section item image", "type": "string", "format": "binary" } }, "required": [ "Image" ] }, "examples": { "UploadMenuSectionItemImageRequestExample": { "summary": "Default UploadMenuSectionItemImage request", "x-microcks-default": true, "value": { "Image": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringResult" }, "examples": { "UploadMenuSectionItemImage200Example": { "summary": "Default UploadMenuSectionItemImage 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadMenuSectionItemImage400Example": { "summary": "Default UploadMenuSectionItemImage 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": { "UploadMenuSectionItemImage401Example": { "summary": "Default UploadMenuSectionItemImage 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": { "UploadMenuSectionItemImage403Example": { "summary": "Default UploadMenuSectionItemImage 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": { "UploadMenuSectionItemImage404Example": { "summary": "Default UploadMenuSectionItemImage 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": { "UploadMenuSectionItemImage500Example": { "summary": "Default UploadMenuSectionItemImage 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 Menu Section Item Image via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/image).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "MenuSectionItems" ], "summary": "Flipdish Delete Menu Section Item Image", "operationId": "DeleteMenuSectionItemImage", "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" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteMenuSectionItemImage400Example": { "summary": "Default DeleteMenuSectionItemImage 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": { "DeleteMenuSectionItemImage401Example": { "summary": "Default DeleteMenuSectionItemImage 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": { "DeleteMenuSectionItemImage403Example": { "summary": "Default DeleteMenuSectionItemImage 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": { "DeleteMenuSectionItemImage404Example": { "summary": "Default DeleteMenuSectionItemImage 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": { "DeleteMenuSectionItemImage500Example": { "summary": "Default DeleteMenuSectionItemImage 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 Item Image via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/image).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/taxrate/{taxRateId}": { "post": { "tags": [ "MenuSectionItems" ], "summary": "Flipdish Set Section Item Tax", "operationId": "SetSectionItemTax", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuSectionId", "in": "path", "description": "Section to put item in (will usually be original section)", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuSectionItemId", "in": "path", "description": "ID of Item to be moved", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "taxRateId", "in": "path", "description": "tax rate to be set against item", "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": { "SetSectionItemTax400Example": { "summary": "Default SetSectionItemTax 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": { "SetSectionItemTax401Example": { "summary": "Default SetSectionItemTax 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": { "SetSectionItemTax403Example": { "summary": "Default SetSectionItemTax 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": { "SetSectionItemTax500Example": { "summary": "Default SetSectionItemTax 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": "Set Section Item Tax via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/taxrate/{taxRateId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/setorder/{destinationDisplayOrder}": { "post": { "tags": [ "MenuSectionItems" ], "summary": "Flipdish Move Menu Item", "operationId": "MoveMenuItem", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuSectionId", "in": "path", "description": "Section to put item in (will usually be original section)", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuSectionItemId", "in": "path", "description": "ID of Item to be moved", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "destinationDisplayOrder", "in": "path", "description": "New Display Order of item", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "MoveMenuItem400Example": { "summary": "Default MoveMenuItem 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": { "MoveMenuItem401Example": { "summary": "Default MoveMenuItem 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": { "MoveMenuItem403Example": { "summary": "Default MoveMenuItem 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": { "MoveMenuItem500Example": { "summary": "Default MoveMenuItem 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": "Move Menu Item via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/setorder/{destinationDisplayOrder}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/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'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "description": "Upload Menu Section Image via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/image).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "MenuSections" ], "summary": "Flipdish Delete Menu Section Image", "operationId": "DeleteMenuSectionImage", "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": { "DeleteMenuSectionImage400Example": { "summary": "Default DeleteMenuSectionImage 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": { "DeleteMenuSectionImage401Example": { "summary": "Default DeleteMenuSectionImage 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": { "DeleteMenuSectionImage403Example": { "summary": "Default DeleteMenuSectionImage 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": { "DeleteMenuSectionImage404Example": { "summary": "Default DeleteMenuSectionImage 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": { "DeleteMenuSectionImage500Example": { "summary": "Default DeleteMenuSectionImage 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 Image via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/image).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/sections/{menuSectionId}/availability": { "post": { "tags": [ "MenuSections" ], "summary": "Flipdish Create Menu Section Availability", "operationId": "CreateMenuSectionAvailability", "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": { "$ref": "#/components/schemas/MenuSectionAvailabilityBase" }, "examples": { "CreateMenuSectionAvailabilityRequestExample": { "summary": "Default CreateMenuSectionAvailability request", "x-microcks-default": true, "value": { "AvailabilityMode": "DisplayAlways" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CreateMenuSectionAvailability200Example": { "summary": "Default CreateMenuSectionAvailability 200 response", "x-microcks-default": true, "value": {} } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MenuSectionAvailability_" }, "examples": { "CreateMenuSectionAvailability201Example": { "summary": "Default CreateMenuSectionAvailability 201 response", "x-microcks-default": true, "value": { "Data": { "AvailableTimes": [], "AvailabilityMode": "DisplayAlways" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateMenuSectionAvailability400Example": { "summary": "Default CreateMenuSectionAvailability 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": { "CreateMenuSectionAvailability401Example": { "summary": "Default CreateMenuSectionAvailability 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": { "CreateMenuSectionAvailability403Example": { "summary": "Default CreateMenuSectionAvailability 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": { "CreateMenuSectionAvailability500Example": { "summary": "Default CreateMenuSectionAvailability 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 Availability via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/availability).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitemdisplayorders": { "post": { "tags": [ "MenuSections" ], "summary": "Flipdish Menu Sections_Set Item Display Orders", "operationId": "MenuSections_SetItemDisplayOrders", "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": { "$ref": "#/components/schemas/MenuObjectDisplayOrders" }, "examples": { "MenuSections_SetItemDisplayOrdersRequestExample": { "summary": "Default MenuSections_SetItemDisplayOrders request", "x-microcks-default": true, "value": { "DisplayOrders": [] } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "MenuSections_SetItemDisplayOrders400Example": { "summary": "Default MenuSections_SetItemDisplayOrders 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": { "MenuSections_SetItemDisplayOrders401Example": { "summary": "Default MenuSections_SetItemDisplayOrders 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": { "MenuSections_SetItemDisplayOrders403Example": { "summary": "Default MenuSections_SetItemDisplayOrders 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": { "MenuSections_SetItemDisplayOrders500Example": { "summary": "Default MenuSections_SetItemDisplayOrders 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": "Menu Sections_Set Item Display Orders via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitemdisplayorders).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/sections/{menuSectionId}/availability/times/{dayOfWeek}": { "post": { "tags": [ "MenuSections" ], "summary": "Flipdish Create Menu Availability for Day", "operationId": "CreateMenuAvailabilityForDay", "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": "dayOfWeek", "in": "path", "description": "Day of the week", "required": true, "schema": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "example": "Sunday" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessHoursPeriodBase" }, "examples": { "CreateMenuAvailabilityForDayRequestExample": { "summary": "Default CreateMenuAvailabilityForDay request", "x-microcks-default": true, "value": { "DayOfWeek": "Sunday", "StartTime": "2026-06-02T12:00:00Z", "Period": "string", "StartTimeEarly": "string", "PeriodEarly": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CreateMenuAvailabilityForDay200Example": { "summary": "Default CreateMenuAvailabilityForDay 200 response", "x-microcks-default": true, "value": {} } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_BusinessHoursPeriod_" }, "examples": { "CreateMenuAvailabilityForDay201Example": { "summary": "Default CreateMenuAvailabilityForDay 201 response", "x-microcks-default": true, "value": { "Data": { "Early": { "StartTime": "2026-06-02T12:00:00Z", "Period": "string", "DayOfWeek": "Sunday" }, "Late": { "StartTime": "2026-06-02T12:00:00Z", "Period": "string", "DayOfWeek": "Sunday" }, "Ranges": [], "DayOfWeek": "Sunday", "StartTime": "2026-06-02T12:00:00Z", "Period": "string", "StartTimeEarly": "string", "PeriodEarly": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateMenuAvailabilityForDay400Example": { "summary": "Default CreateMenuAvailabilityForDay 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": { "CreateMenuAvailabilityForDay401Example": { "summary": "Default CreateMenuAvailabilityForDay 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": { "CreateMenuAvailabilityForDay403Example": { "summary": "Default CreateMenuAvailabilityForDay 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": { "CreateMenuAvailabilityForDay500Example": { "summary": "Default CreateMenuAvailabilityForDay 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 Availability for Day via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/availability/times/{dayOfWeek}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/nutrition": { "get": { "tags": [ "MenusNutritionInfo" ], "summary": "Flipdish Get Menu Nutrition Info by Menu Id", "operationId": "GetMenuNutritionInfoByMenuId", "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/RestApiResult_NutritionInfo_" }, "examples": { "GetMenuNutritionInfoByMenuId200Example": { "summary": "Default GetMenuNutritionInfoByMenuId 200 response", "x-microcks-default": true, "value": { "Data": { "Version": "string", "MenuItems": [], "MenuItemOptionSetItems": [] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuNutritionInfoByMenuId400Example": { "summary": "Default GetMenuNutritionInfoByMenuId 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuNutritionInfoByMenuId401Example": { "summary": "Default GetMenuNutritionInfoByMenuId 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": { "GetMenuNutritionInfoByMenuId403Example": { "summary": "Default GetMenuNutritionInfoByMenuId 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": { "GetMenuNutritionInfoByMenuId404Example": { "summary": "Default GetMenuNutritionInfoByMenuId 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": { "GetMenuNutritionInfoByMenuId409Example": { "summary": "Default GetMenuNutritionInfoByMenuId 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": { "GetMenuNutritionInfoByMenuId500Example": { "summary": "Default GetMenuNutritionInfoByMenuId 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 Nutrition Info by Menu Id via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/nutrition).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "MenusNutritionInfo" ], "summary": "Flipdish Add or Update Menu Nutrition Info by Menu Id", "operationId": "AddOrUpdateMenuNutritionInfoByMenuId", "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/RestApiResult_MenuNutritionInfoHeader_" }, "examples": { "AddOrUpdateMenuNutritionInfoByMenuId200Example": { "summary": "Default AddOrUpdateMenuNutritionInfoByMenuId 200 response", "x-microcks-default": true, "value": { "Data": { "MenuId": 500123, "NutritionInfoVersionGuid": "00000000-0000-0000-0000-000000000000", "AbsoluteUrl": "https://api.flipdish.co/example" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddOrUpdateMenuNutritionInfoByMenuId400Example": { "summary": "Default AddOrUpdateMenuNutritionInfoByMenuId 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddOrUpdateMenuNutritionInfoByMenuId401Example": { "summary": "Default AddOrUpdateMenuNutritionInfoByMenuId 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": { "AddOrUpdateMenuNutritionInfoByMenuId403Example": { "summary": "Default AddOrUpdateMenuNutritionInfoByMenuId 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": { "AddOrUpdateMenuNutritionInfoByMenuId404Example": { "summary": "Default AddOrUpdateMenuNutritionInfoByMenuId 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": { "AddOrUpdateMenuNutritionInfoByMenuId409Example": { "summary": "Default AddOrUpdateMenuNutritionInfoByMenuId 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": { "AddOrUpdateMenuNutritionInfoByMenuId500Example": { "summary": "Default AddOrUpdateMenuNutritionInfoByMenuId 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": "Add or Update Menu Nutrition Info by Menu Id via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/nutrition).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "MenusNutritionInfo" ], "summary": "Flipdish Delete Menu Nutrition Info by Menu Id", "operationId": "DeleteMenuNutritionInfoByMenuId", "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": { "type": "object" }, "examples": { "DeleteMenuNutritionInfoByMenuId200Example": { "summary": "Default DeleteMenuNutritionInfoByMenuId 200 response", "x-microcks-default": true, "value": {} } } } } }, "204": { "description": "NoContent" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteMenuNutritionInfoByMenuId400Example": { "summary": "Default DeleteMenuNutritionInfoByMenuId 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteMenuNutritionInfoByMenuId401Example": { "summary": "Default DeleteMenuNutritionInfoByMenuId 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": { "DeleteMenuNutritionInfoByMenuId403Example": { "summary": "Default DeleteMenuNutritionInfoByMenuId 403 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": { "DeleteMenuNutritionInfoByMenuId409Example": { "summary": "Default DeleteMenuNutritionInfoByMenuId 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": { "DeleteMenuNutritionInfoByMenuId500Example": { "summary": "Default DeleteMenuNutritionInfoByMenuId 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 Nutrition Info by Menu Id via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/nutrition).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/menus/nutrition/allergens": { "get": { "tags": [ "MenusNutritionInfo" ], "summary": "Flipdish Get Allergens", "operationId": "GetAllergens", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "languageId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The language id query parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_Allergen_" }, "examples": { "GetAllergens200Example": { "summary": "Default GetAllergens 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAllergens400Example": { "summary": "Default GetAllergens 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAllergens401Example": { "summary": "Default GetAllergens 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": { "GetAllergens403Example": { "summary": "Default GetAllergens 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": { "GetAllergens404Example": { "summary": "Default GetAllergens 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": { "GetAllergens409Example": { "summary": "Default GetAllergens 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": { "GetAllergens500Example": { "summary": "Default GetAllergens 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 Allergens via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/menus/nutrition/allergens).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/menuItem/{publicId}/nutrition": { "post": { "tags": [ "MenusNutritionInfo" ], "summary": "Flipdish Add or Update Menu Item Nutrition Info", "operationId": "AddOrUpdateMenuItemNutritionInfo", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "publicId", "in": "path", "description": "Menu item's publicId", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MenuNutritionInfoHeader_" }, "examples": { "AddOrUpdateMenuItemNutritionInfo200Example": { "summary": "Default AddOrUpdateMenuItemNutritionInfo 200 response", "x-microcks-default": true, "value": { "Data": { "MenuId": 500123, "NutritionInfoVersionGuid": "00000000-0000-0000-0000-000000000000", "AbsoluteUrl": "https://api.flipdish.co/example" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddOrUpdateMenuItemNutritionInfo400Example": { "summary": "Default AddOrUpdateMenuItemNutritionInfo 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddOrUpdateMenuItemNutritionInfo401Example": { "summary": "Default AddOrUpdateMenuItemNutritionInfo 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": { "AddOrUpdateMenuItemNutritionInfo403Example": { "summary": "Default AddOrUpdateMenuItemNutritionInfo 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": { "AddOrUpdateMenuItemNutritionInfo404Example": { "summary": "Default AddOrUpdateMenuItemNutritionInfo 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": { "AddOrUpdateMenuItemNutritionInfo409Example": { "summary": "Default AddOrUpdateMenuItemNutritionInfo 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": { "AddOrUpdateMenuItemNutritionInfo500Example": { "summary": "Default AddOrUpdateMenuItemNutritionInfo 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": "Add or Update Menu Item Nutrition Info via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/menuItem/{publicId}/nutrition).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/menuItemOption/{publicId}/nutrition": { "post": { "tags": [ "MenusNutritionInfo" ], "summary": "Flipdish Add or Update Menu Item Option Set Item Nutrition Info", "operationId": "AddOrUpdateMenuItemOptionSetItemNutritionInfo", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "publicId", "in": "path", "description": "Menu item's publicId", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MenuNutritionInfoHeader_" }, "examples": { "AddOrUpdateMenuItemOptionSetItemNutritionInfo200Example": { "summary": "Default AddOrUpdateMenuItemOptionSetItemNutritionInfo 200 response", "x-microcks-default": true, "value": { "Data": { "MenuId": 500123, "NutritionInfoVersionGuid": "00000000-0000-0000-0000-000000000000", "AbsoluteUrl": "https://api.flipdish.co/example" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddOrUpdateMenuItemOptionSetItemNutritionInfo400Example": { "summary": "Default AddOrUpdateMenuItemOptionSetItemNutritionInfo 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddOrUpdateMenuItemOptionSetItemNutritionInfo401Example": { "summary": "Default AddOrUpdateMenuItemOptionSetItemNutritionInfo 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": { "AddOrUpdateMenuItemOptionSetItemNutritionInfo403Example": { "summary": "Default AddOrUpdateMenuItemOptionSetItemNutritionInfo 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": { "AddOrUpdateMenuItemOptionSetItemNutritionInfo404Example": { "summary": "Default AddOrUpdateMenuItemOptionSetItemNutritionInfo 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": { "AddOrUpdateMenuItemOptionSetItemNutritionInfo409Example": { "summary": "Default AddOrUpdateMenuItemOptionSetItemNutritionInfo 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": { "AddOrUpdateMenuItemOptionSetItemNutritionInfo500Example": { "summary": "Default AddOrUpdateMenuItemOptionSetItemNutritionInfo 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": "Add or Update Menu Item Option Set Item Nutrition Info via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/menuItemOption/{publicId}/nutrition).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/menus/{menuId}/nutritionv2": { "get": { "tags": [ "MenusNutritionInfoV2" ], "summary": "Flipdish Get Menu Nutrition Info V2 by Menu Id", "operationId": "GetMenuNutritionInfoV2ByMenuId", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "languageId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The language id query parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_NutritionInfoV2_" }, "examples": { "GetMenuNutritionInfoV2ByMenuId200Example": { "summary": "Default GetMenuNutritionInfoV2ByMenuId 200 response", "x-microcks-default": true, "value": { "Data": { "MenuItems": [], "MenuItemOptionSetItems": [], "ImageBaseUrl": "https://api.flipdish.co/example" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuNutritionInfoV2ByMenuId400Example": { "summary": "Default GetMenuNutritionInfoV2ByMenuId 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuNutritionInfoV2ByMenuId401Example": { "summary": "Default GetMenuNutritionInfoV2ByMenuId 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": { "GetMenuNutritionInfoV2ByMenuId403Example": { "summary": "Default GetMenuNutritionInfoV2ByMenuId 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": { "GetMenuNutritionInfoV2ByMenuId404Example": { "summary": "Default GetMenuNutritionInfoV2ByMenuId 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": { "GetMenuNutritionInfoV2ByMenuId409Example": { "summary": "Default GetMenuNutritionInfoV2ByMenuId 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": { "GetMenuNutritionInfoV2ByMenuId500Example": { "summary": "Default GetMenuNutritionInfoV2ByMenuId 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 Nutrition Info V2 by Menu Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/menus/{menuId}/nutritionv2).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/menus/nutritionv2/allergens": { "get": { "tags": [ "MenusNutritionInfoV2" ], "summary": "Flipdish Get Allergens V2", "operationId": "GetAllergensV2", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "languageId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The language id query parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_Allergen_" }, "examples": { "GetAllergensV2200Example": { "summary": "Default GetAllergensV2 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAllergensV2400Example": { "summary": "Default GetAllergensV2 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAllergensV2401Example": { "summary": "Default GetAllergensV2 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": { "GetAllergensV2403Example": { "summary": "Default GetAllergensV2 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": { "GetAllergensV2404Example": { "summary": "Default GetAllergensV2 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": { "GetAllergensV2409Example": { "summary": "Default GetAllergensV2 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": { "GetAllergensV2500Example": { "summary": "Default GetAllergensV2 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 Allergens V2 via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/menus/nutritionv2/allergens).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/menus/{menuId}/menuItem/{publicId}/nutritionv2": { "post": { "tags": [ "MenusNutritionInfoV2" ], "summary": "Flipdish Add or Update Menu Item Nutrition Info V2", "operationId": "AddOrUpdateMenuItemNutritionInfoV2", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "publicId", "in": "path", "description": "Menu item's publicId", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "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": { "type": "object" }, "examples": { "AddOrUpdateMenuItemNutritionInfoV2200Example": { "summary": "Default AddOrUpdateMenuItemNutritionInfoV2 200 response", "x-microcks-default": true, "value": {} } } } } }, "204": { "description": "NoContent" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddOrUpdateMenuItemNutritionInfoV2400Example": { "summary": "Default AddOrUpdateMenuItemNutritionInfoV2 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": { "AddOrUpdateMenuItemNutritionInfoV2401Example": { "summary": "Default AddOrUpdateMenuItemNutritionInfoV2 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": { "AddOrUpdateMenuItemNutritionInfoV2403Example": { "summary": "Default AddOrUpdateMenuItemNutritionInfoV2 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": { "AddOrUpdateMenuItemNutritionInfoV2500Example": { "summary": "Default AddOrUpdateMenuItemNutritionInfoV2 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": "Add or Update Menu Item Nutrition Info V2 via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/menus/{menuId}/menuItem/{publicId}/nutritionv2).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/menus/{menuId}/menuItemOption/{publicId}/nutritionv2": { "post": { "tags": [ "MenusNutritionInfoV2" ], "summary": "Flipdish Add or Update Menu Item Option Set Item Nutrition Info V2", "operationId": "AddOrUpdateMenuItemOptionSetItemNutritionInfoV2", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu identifier", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "publicId", "in": "path", "description": "Menu item option set item's publicId", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "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": { "type": "object" }, "examples": { "AddOrUpdateMenuItemOptionSetItemNutritionInfoV2200Example": { "summary": "Default AddOrUpdateMenuItemOptionSetItemNutritionInfoV2 200 response", "x-microcks-default": true, "value": {} } } } } }, "204": { "description": "NoContent" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddOrUpdateMenuItemOptionSetItemNutritionInfoV2400Example": { "summary": "Default AddOrUpdateMenuItemOptionSetItemNutritionInfoV2 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": { "AddOrUpdateMenuItemOptionSetItemNutritionInfoV2401Example": { "summary": "Default AddOrUpdateMenuItemOptionSetItemNutritionInfoV2 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": { "AddOrUpdateMenuItemOptionSetItemNutritionInfoV2403Example": { "summary": "Default AddOrUpdateMenuItemOptionSetItemNutritionInfoV2 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": { "AddOrUpdateMenuItemOptionSetItemNutritionInfoV2500Example": { "summary": "Default AddOrUpdateMenuItemOptionSetItemNutritionInfoV2 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": "Add or Update Menu Item Option Set Item Nutrition Info V2 via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/menus/{menuId}/menuItemOption/{publicId}/nutritionv2).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/zones": { "get": { "tags": [ "MenuZones" ], "summary": "Flipdish Get Menu Zones for Menu Id", "operationId": "GetMenuZonesForMenuId", "parameters": [ { "name": "menuId", "in": "path", "description": "The menu id to load zones for", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_MenuZone_" }, "examples": { "GetMenuZonesForMenuId200Example": { "summary": "Default GetMenuZonesForMenuId 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuZonesForMenuId400Example": { "summary": "Default GetMenuZonesForMenuId 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": { "GetMenuZonesForMenuId401Example": { "summary": "Default GetMenuZonesForMenuId 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": { "GetMenuZonesForMenuId403Example": { "summary": "Default GetMenuZonesForMenuId 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": { "GetMenuZonesForMenuId500Example": { "summary": "Default GetMenuZonesForMenuId 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 Zones for Menu Id via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/zones).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "MenuZones" ], "summary": "Flipdish Add Menu Zone", "operationId": "AddMenuZone", "parameters": [ { "name": "menuId", "in": "path", "description": "The menu id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuZone" }, "examples": { "AddMenuZoneRequestExample": { "summary": "Default AddMenuZone request", "x-microcks-default": true, "value": { "MenuZoneId": 500123, "MenuId": 500123, "Name": "Example Name", "Description": "string", "ImageName": "Example Name", "DisplayOrder": 1, "ImageUrl": "https://api.flipdish.co/example" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MenuZone_" }, "examples": { "AddMenuZone200Example": { "summary": "Default AddMenuZone 200 response", "x-microcks-default": true, "value": { "Data": { "MenuZoneId": 500123, "MenuId": 500123, "Name": "Example Name", "Description": "string", "ImageName": "Example Name", "DisplayOrder": 1, "ImageUrl": "https://api.flipdish.co/example" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddMenuZone400Example": { "summary": "Default AddMenuZone 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": { "AddMenuZone401Example": { "summary": "Default AddMenuZone 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": { "AddMenuZone403Example": { "summary": "Default AddMenuZone 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": { "AddMenuZone500Example": { "summary": "Default AddMenuZone 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": "Add Menu Zone via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/zones).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/zones/{menuZoneId}": { "get": { "tags": [ "MenuZones" ], "summary": "Flipdish Get Menu Zone", "operationId": "GetMenuZone", "parameters": [ { "name": "menuId", "in": "path", "description": "The menu id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuZoneId", "in": "path", "description": "The menu zone id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MenuZone_" }, "examples": { "GetMenuZone200Example": { "summary": "Default GetMenuZone 200 response", "x-microcks-default": true, "value": { "Data": { "MenuZoneId": 500123, "MenuId": 500123, "Name": "Example Name", "Description": "string", "ImageName": "Example Name", "DisplayOrder": 1, "ImageUrl": "https://api.flipdish.co/example" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuZone400Example": { "summary": "Default GetMenuZone 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": { "GetMenuZone401Example": { "summary": "Default GetMenuZone 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": { "GetMenuZone403Example": { "summary": "Default GetMenuZone 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": { "GetMenuZone404Example": { "summary": "Default GetMenuZone 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": { "GetMenuZone500Example": { "summary": "Default GetMenuZone 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 Zone via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/zones/{menuZoneId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "put": { "tags": [ "MenuZones" ], "summary": "Flipdish Update Menu Zone", "operationId": "UpdateMenuZone", "parameters": [ { "name": "menuId", "in": "path", "description": "The menu id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuZoneId", "in": "path", "description": "The menu zone id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuZone" }, "examples": { "UpdateMenuZoneRequestExample": { "summary": "Default UpdateMenuZone request", "x-microcks-default": true, "value": { "MenuZoneId": 500123, "MenuId": 500123, "Name": "Example Name", "Description": "string", "ImageName": "Example Name", "DisplayOrder": 1, "ImageUrl": "https://api.flipdish.co/example" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateMenuZone400Example": { "summary": "Default UpdateMenuZone 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": { "UpdateMenuZone401Example": { "summary": "Default UpdateMenuZone 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": { "UpdateMenuZone403Example": { "summary": "Default UpdateMenuZone 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": { "UpdateMenuZone404Example": { "summary": "Default UpdateMenuZone 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": { "UpdateMenuZone500Example": { "summary": "Default UpdateMenuZone 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 Zone via the Flipdish Open API v1.0 (PUT /api/v1.0/menus/{menuId}/zones/{menuZoneId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "MenuZones" ], "summary": "Flipdish Delete Menu Zone", "operationId": "DeleteMenuZone", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuZoneId", "in": "path", "description": "The menu zone id.", "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": { "DeleteMenuZone400Example": { "summary": "Default DeleteMenuZone 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": { "DeleteMenuZone401Example": { "summary": "Default DeleteMenuZone 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": { "DeleteMenuZone403Example": { "summary": "Default DeleteMenuZone 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": { "DeleteMenuZone404Example": { "summary": "Default DeleteMenuZone 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": { "DeleteMenuZone500Example": { "summary": "Default DeleteMenuZone 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 Zone via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/zones/{menuZoneId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/zones/{menuZoneId}/description": { "put": { "tags": [ "MenuZones" ], "summary": "Flipdish Set Menu Zone Description", "operationId": "SetMenuZoneDescription", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuZoneId", "in": "path", "description": "The zone id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "string" }, "examples": { "SetMenuZoneDescriptionRequestExample": { "summary": "Default SetMenuZoneDescription request", "x-microcks-default": true, "value": "string" } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetMenuZoneDescription400Example": { "summary": "Default SetMenuZoneDescription 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": { "SetMenuZoneDescription401Example": { "summary": "Default SetMenuZoneDescription 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": { "SetMenuZoneDescription403Example": { "summary": "Default SetMenuZoneDescription 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": { "SetMenuZoneDescription404Example": { "summary": "Default SetMenuZoneDescription 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": { "SetMenuZoneDescription500Example": { "summary": "Default SetMenuZoneDescription 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": "Set Menu Zone Description via the Flipdish Open API v1.0 (PUT /api/v1.0/menus/{menuId}/zones/{menuZoneId}/description).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/zones/{menuZoneId}/flip/{menuZoneI2}": { "put": { "tags": [ "MenuZones" ], "summary": "Flipdish Flip Menu Zones", "operationId": "FlipMenuZones", "parameters": [ { "name": "menuId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The menu id path parameter.", "example": 500123 }, { "name": "menuZoneId", "in": "path", "description": "Source.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuZoneI2", "in": "path", "description": "Destination.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FlipMenuZones400Example": { "summary": "Default FlipMenuZones 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": { "FlipMenuZones401Example": { "summary": "Default FlipMenuZones 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": { "FlipMenuZones403Example": { "summary": "Default FlipMenuZones 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": { "FlipMenuZones404Example": { "summary": "Default FlipMenuZones 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": { "FlipMenuZones500Example": { "summary": "Default FlipMenuZones 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": "Flip Menu Zones via the Flipdish Open API v1.0 (PUT /api/v1.0/menus/{menuId}/zones/{menuZoneId}/flip/{menuZoneI2}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/zones/{menuZoneId}/name/{menuZoneName}": { "put": { "tags": [ "MenuZones" ], "summary": "Flipdish Set Menu Zone Name", "operationId": "SetMenuZoneName", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuZoneId", "in": "path", "description": "The menu zone id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuZoneName", "in": "path", "description": "The new name.", "required": true, "schema": { "type": "string" }, "example": "Example Name" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetMenuZoneName400Example": { "summary": "Default SetMenuZoneName 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": { "SetMenuZoneName401Example": { "summary": "Default SetMenuZoneName 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": { "SetMenuZoneName403Example": { "summary": "Default SetMenuZoneName 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": { "SetMenuZoneName404Example": { "summary": "Default SetMenuZoneName 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": { "SetMenuZoneName500Example": { "summary": "Default SetMenuZoneName 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": "Set Menu Zone Name via the Flipdish Open API v1.0 (PUT /api/v1.0/menus/{menuId}/zones/{menuZoneId}/name/{menuZoneName}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/zones/{menuZoneId}/section/{menuSectionId}": { "put": { "tags": [ "MenuZones" ], "summary": "Flipdish Set Menu Section Menu Zone", "operationId": "SetMenuSectionMenuZone", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuZoneId", "in": "path", "description": "The menu id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuSectionId", "in": "path", "description": "The menu section id.", "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": { "SetMenuSectionMenuZone400Example": { "summary": "Default SetMenuSectionMenuZone 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": { "SetMenuSectionMenuZone401Example": { "summary": "Default SetMenuSectionMenuZone 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": { "SetMenuSectionMenuZone403Example": { "summary": "Default SetMenuSectionMenuZone 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": { "SetMenuSectionMenuZone404Example": { "summary": "Default SetMenuSectionMenuZone 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": { "SetMenuSectionMenuZone500Example": { "summary": "Default SetMenuSectionMenuZone 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": "Set Menu Section Menu Zone via the Flipdish Open API v1.0 (PUT /api/v1.0/menus/{menuId}/zones/{menuZoneId}/section/{menuSectionId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/menus/{menuId}/zones/{menuZoneId}/image": { "post": { "tags": [ "MenuZones" ], "summary": "Flipdish Upload Menu Zone Image", "operationId": "UploadMenuZoneImage", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuZoneId", "in": "path", "description": "The zone id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HttpPostedFileBase" } }, "examples": { "UploadMenuZoneImageRequestExample": { "summary": "Default UploadMenuZoneImage request", "x-microcks-default": true, "value": [ { "ContentLength": 1, "ContentType": "string", "FileName": "Example Name", "InputStream": { "CanRead": true, "CanSeek": true, "CanTimeout": true, "CanWrite": true, "Length": 1, "Position": 1, "ReadTimeout": 1, "WriteTimeout": 1 } } ] } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadMenuZoneImage400Example": { "summary": "Default UploadMenuZoneImage 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": { "UploadMenuZoneImage401Example": { "summary": "Default UploadMenuZoneImage 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": { "UploadMenuZoneImage403Example": { "summary": "Default UploadMenuZoneImage 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": { "UploadMenuZoneImage500Example": { "summary": "Default UploadMenuZoneImage 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 Menu Zone Image via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/zones/{menuZoneId}/image).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "MenuZones" ], "summary": "Flipdish Delete Menu Zone Image", "operationId": "DeleteMenuZoneImage", "parameters": [ { "name": "menuId", "in": "path", "description": "Menu id.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuZoneId", "in": "path", "description": "The zone Id/", "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": { "DeleteMenuZoneImage400Example": { "summary": "Default DeleteMenuZoneImage 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": { "DeleteMenuZoneImage401Example": { "summary": "Default DeleteMenuZoneImage 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": { "DeleteMenuZoneImage403Example": { "summary": "Default DeleteMenuZoneImage 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": { "DeleteMenuZoneImage404Example": { "summary": "Default DeleteMenuZoneImage 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": { "DeleteMenuZoneImage500Example": { "summary": "Default DeleteMenuZoneImage 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 Zone Image via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/zones/{menuZoneId}/image).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } } }, "components": { "schemas": { "AllMetadataResult": { "description": "", "type": "object", "properties": { "MenuItemMetadata": { "description": "Menu item metadata", "type": "array", "items": { "$ref": "#/components/schemas/Metadata" }, "example": [] }, "MenuItemOptionSetItemMetadata": { "description": "Menu item optionset item metadata", "type": "array", "items": { "$ref": "#/components/schemas/Metadata" }, "example": [] } } }, "Allergen": { "description": "Allergen.", "type": "object", "properties": { "AllergenId": { "description": "A unique identifier for the allergen", "type": "string", "example": "500123" }, "LocalizedName": { "description": "Localized name of the allergen", "type": "string", "example": "Example Name" }, "IconUrl": { "description": "Url to the icon for the allergen", "type": "string", "example": "https://api.flipdish.co/example" } } }, "BusinessHoursPeriod": { "description": "Business hours period", "type": "object", "properties": { "Early": { "$ref": "#/components/schemas/Range" }, "Late": { "$ref": "#/components/schemas/Range" }, "Ranges": { "description": "Ranges", "type": "array", "items": { "$ref": "#/components/schemas/Range" }, "example": [] }, "DayOfWeek": { "description": "Day of week", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "example": "Sunday" }, "StartTime": { "description": "Start time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Period": { "description": "Period", "type": "string", "example": "string" }, "StartTimeEarly": { "description": "Start time early", "type": "string", "example": "string" }, "PeriodEarly": { "description": "Period early", "type": "string", "example": "string" } } }, "BusinessHoursPeriodBase": { "description": "Business hours period", "type": "object", "properties": { "DayOfWeek": { "description": "Day of week", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "example": "Sunday" }, "StartTime": { "description": "Start time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Period": { "description": "Period", "type": "string", "example": "string" }, "StartTimeEarly": { "description": "Start time early", "type": "string", "example": "string" }, "PeriodEarly": { "description": "Period early", "type": "string", "example": "string" } } }, "CreateFullMenu": { "description": "Create menu object", "type": "object", "properties": { "Name": { "description": "Name of Menu, only shown in portal", "maxLength": 255, "minLength": 0, "type": "string", "example": "Example Name" }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" }, "MenuSections": { "description": "Menu sections (starters, main etc)", "type": "array", "items": { "$ref": "#/components/schemas/CreateFullMenuSection" }, "example": [] }, "TaxRates": { "description": "Menu tax rates", "type": "array", "items": { "$ref": "#/components/schemas/CreateMenuTaxRate" }, "example": [] }, "DisplaySectionLinks": { "description": "Display menu section link on UI", "type": "boolean", "example": true }, "MenuSectionBehaviour": { "description": "Menu section behaviour", "enum": [ "ExpandSingle", "ExpandMultiple" ], "type": "string", "example": "ExpandSingle" }, "TaxType": { "description": "Tax type", "enum": [ "IncludedInBasePrice", "ExcludedFromBasePrice" ], "type": "string", "example": "IncludedInBasePrice" }, "IsIntegrated": { "description": "Flag to indicate if the menu is integrated (contains metadata)", "type": "boolean", "example": true } } }, "CreateFullMenuItemOptionSet": { "description": "Create menu item option set", "type": "object", "properties": { "MenuItemOptionSetId": { "format": "int32", "description": "Menu item option set identifier", "type": "integer", "example": 500123 }, "MenuItemOptionSetItems": { "description": "Option set items", "type": "array", "items": { "$ref": "#/components/schemas/CreateFullMenuItemOptionSetItem" }, "example": [] }, "Name": { "description": "Menu item option set name", "maxLength": 4000, "minLength": 0, "type": "string", "example": "Example Name" }, "IsMasterOptionSet": { "description": "Is master option set. This can affect the layout of the options in the menu displayed to the customer. Usually it is true if the option could be considerd a standalone item as opposed to an addition (\"with ketchup\") or modifier (\"large\").", "type": "boolean", "example": true }, "DisplayOrder": { "format": "int32", "description": "Display order. Displayed in ascending order.", "type": "integer", "example": 1 }, "MinSelectCount": { "format": "int32", "description": "Minimum items must be selected", "type": "integer", "example": 3 }, "MaxSelectCount": { "format": "int32", "description": "Maximum number of items can be selected", "type": "integer", "example": 3 }, "CellLayoutType": { "description": "Small | Medium | Large\r\nAffects the layout of the menu.", "enum": [ "Small", "Medium", "Large", "HiddenImage" ], "type": "string", "example": "Small" }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateFullMenuItemOptionSetItem": { "description": "Create menu item option set item", "type": "object", "properties": { "MenuItemOptionSetItemId": { "format": "int32", "description": "Menu item option set item identifier", "type": "integer", "example": 500123 }, "Metadata": { "description": "List of metadata", "type": "array", "items": { "$ref": "#/components/schemas/CreateMetadata" }, "example": [] }, "TaxRateName": { "description": "Tax rate name", "type": "string", "example": "Example Name" }, "NextMenuItemOptionSetId": { "format": "int32", "description": "if null, next option set is next. if -1, this is the final option set", "type": "integer", "nullable": true, "example": 500123 }, "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "Price": { "format": "double", "description": "Price", "type": "number", "example": 12.5 }, "DepositReturnFee": { "format": "double", "description": "An optional fee that can be added to the price of the item.", "type": "number", "nullable": true, "example": 12.5 }, "IsAvailable": { "description": "Is available", "type": "boolean", "example": true }, "DisplayOrder": { "format": "int32", "description": "Display order. Displayed in ascending order.", "type": "integer", "example": 1 }, "CellLayoutType": { "description": "Small | Medium | Large\r\nAffects the layout of the menu.", "enum": [ "Small", "Medium", "Large", "HiddenImage" ], "type": "string", "example": "Small" }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateFullMenuSection": { "description": "Create menu section", "type": "object", "properties": { "MenuSectionAvailability": { "$ref": "#/components/schemas/MenuSectionAvailability" }, "MenuItems": { "description": "Menu items", "type": "array", "items": { "$ref": "#/components/schemas/CreateFullMenuSectionItem" }, "example": [] }, "Name": { "description": "Name", "maxLength": 4000, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "maxLength": 4000, "minLength": 0, "type": "string", "example": "string" }, "DisplayOrder": { "format": "int32", "description": "Display order", "type": "integer", "example": 1 }, "IsAvailable": { "description": "Is available", "type": "boolean", "example": true }, "IsHiddenFromCustomers": { "description": "Is hidden from customer. Perhaps when the item is out of stock.", "type": "boolean", "example": true }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" }, "MenuSectionId": { "format": "int32", "description": "Menu Section Id", "type": "integer", "example": 500123 }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateFullMenuSectionItem": { "description": "Create menu section item", "type": "object", "properties": { "MenuItemOptionSets": { "description": "Menu item option sets", "type": "array", "items": { "$ref": "#/components/schemas/CreateFullMenuItemOptionSet" }, "example": [] }, "Metadata": { "description": "List of metadata", "type": "array", "items": { "$ref": "#/components/schemas/CreateMetadata" }, "example": [] }, "TaxRateName": { "description": "Tax rate name", "type": "string", "example": "Example Name" }, "Name": { "description": "Menu item name (like \"Korma\")", "maxLength": 4000, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Description (like \"A lovely dish from the east\")", "maxLength": 4000, "minLength": 0, "type": "string", "example": "string" }, "SpicinessRating": { "description": "Spiciness rating", "enum": [ "NotRated", "Mild", "Medium", "Hot" ], "type": "string", "example": "NotRated" }, "Price": { "format": "double", "description": "Price - this is only used when there is no master option set and should be set to 0 if a master option set exists.", "type": "number", "example": 12.5 }, "DepositReturnFee": { "format": "double", "description": "An optional fee that can be added to the price of the item.", "type": "number", "nullable": true, "example": 12.5 }, "DisplayOrder": { "format": "int32", "description": "Display order", "type": "integer", "example": 1 }, "Alcohol": { "description": "To be set true if the item or an option of the item contains an alcoholic drink.", "type": "boolean", "example": true }, "IsAvailable": { "description": "True if we accept orders for this item still", "type": "boolean", "example": true }, "CellLayoutType": { "description": "Small | Medium | Large\r\nAffects the layout of the menu.", "enum": [ "Small", "Medium", "Large", "HiddenImage" ], "type": "string", "example": "Small" }, "DisableVouchers": { "description": "If true, then vouchers won't be applied for this item", "type": "boolean", "example": true }, "ImageName": { "description": "Image url", "type": "string", "example": "Example Name" }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" }, "MenuItemId": { "format": "int32", "description": "Menu Item Id", "type": "integer", "example": 500123 }, "ExcludeFromVoucherDiscounting": { "description": "If true, the item is excluded from voucher discount calculations", "type": "boolean", "example": true }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateMenuSectionItemFromCatalogItems": { "description": "Add CatalogItems to a Menu", "required": [ "MenuCatalogItems" ], "type": "object", "properties": { "MenuCatalogItems": { "description": "List of CatalogItems to add to the section", "type": "array", "items": { "$ref": "#/components/schemas/MenuCatalogItem" }, "example": [] } } }, "CreateMenuTaxRate": { "description": "Tax Rates Associated with a Menu", "type": "object", "properties": { "Name": { "description": "Name of Tax Rate", "maxLength": 2048, "minLength": 0, "type": "string", "example": "Example Name" }, "Rate": { "format": "double", "description": "In Percentage", "type": "number", "example": 1.0 } } }, "CreateMetadata": { "description": "Create metadata", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "Store identifier", "type": "integer", "example": 500123 }, "Key": { "description": "Metadata key (Unique identifier)", "maxLength": 128, "minLength": 0, "type": "string", "example": "string" }, "Value": { "description": "Metadata value", "maxLength": 4000, "minLength": 0, "type": "string", "example": "string" } } }, "CreatedMenuSectionItems": { "description": "Response for the creation of multiple Menu Section Items", "type": "object", "properties": { "MenuSectionItems": { "description": "Created Menu Section Items", "type": "array", "items": { "$ref": "#/components/schemas/MenuSectionItem" }, "example": [] } } }, "FlipdishError": { "type": "object", "description": "Standard Flipdish API error response. Errors are returned as a JSON object with a human-readable message and a programmatic error code (see https://developers.flipdish.com/docs/error-handling).", "properties": { "error": { "type": "object", "description": "Error detail object.", "properties": { "errorMessage": { "type": "string", "description": "Descriptive explanation of the issue.", "example": "Invalid or missing parameters." }, "errorCode": { "type": "string", "description": "Unique identifier for programmatic error handling.", "example": "BadRequest" }, "details": { "type": "string", "description": "Additional context returned in non-production environments.", "example": "Validation failed for field 'storeId'." } } } } }, "HttpPostedFileBase": { "type": "object", "properties": { "ContentLength": { "format": "int32", "type": "integer", "readOnly": true, "example": 1 }, "ContentType": { "type": "string", "readOnly": true, "example": "string" }, "FileName": { "type": "string", "readOnly": true, "example": "Example Name" }, "InputStream": { "$ref": "#/components/schemas/Stream" } } }, "Menu": { "description": "Menu", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "ModifiedTime": { "format": "date-time", "description": "Last modified time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "VersionNumber": { "format": "int32", "description": "Menu version", "type": "integer", "example": 3 }, "ImageName": { "description": "Image Name", "type": "string", "example": "Example Name" }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" }, "Name": { "description": "Name of Menu, only shown in portal", "type": "string", "example": "Example Name" }, "Locked": { "description": "Locked: is menu locked against modifcation", "type": "boolean", "example": true }, "MenuSections": { "description": "Menu sections (startes, main etc)", "type": "array", "items": { "$ref": "#/components/schemas/MenuSection" }, "example": [] }, "TaxRates": { "description": "Menu tax rates", "type": "array", "items": { "$ref": "#/components/schemas/MenuTaxRate" }, "example": [] }, "AppId": { "description": "Identifier of App the menu is attached to", "type": "string", "example": "500123" }, "DisplaySectionLinks": { "description": "Display menu section link on UI", "type": "boolean", "example": true }, "MenuSectionBehaviour": { "description": "Menu section behaviour", "enum": [ "ExpandSingle", "ExpandMultiple" ], "type": "string", "example": "ExpandSingle" }, "TaxType": { "description": "Tax type", "enum": [ "IncludedInBasePrice", "ExcludedFromBasePrice" ], "type": "string", "example": "IncludedInBasePrice" }, "IsIntegrated": { "description": "Flag to indicate if the menu is integrated (contains metadata)", "type": "boolean", "example": true } } }, "MenuBase": { "description": "Menu base", "type": "object", "properties": { "DisplaySectionLinks": { "description": "Display menu section link on UI", "type": "boolean", "example": true }, "MenuSectionBehaviour": { "description": "Menu section behaviour", "enum": [ "ExpandSingle", "ExpandMultiple" ], "type": "string", "example": "ExpandSingle" }, "TaxType": { "description": "Tax type", "enum": [ "IncludedInBasePrice", "ExcludedFromBasePrice" ], "type": "string", "example": "IncludedInBasePrice" }, "IsIntegrated": { "description": "Flag to indicate if the menu is integrated (contains metadata)", "type": "boolean", "example": true } } }, "MenuCatalogItem": { "description": "Information to add a CatalogItem to a Menu", "required": [ "CatalogItemId" ], "type": "object", "properties": { "CatalogItemId": { "description": "Product Id to the product to add as Menu Item", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "CellLayoutType": { "description": "Small | Medium | Large | HiddenImage\r\nAffects the layout of the menu.", "enum": [ "Small", "Medium", "Large", "HiddenImage" ], "type": "string", "example": "Small" } } }, "MenuCheckpoint": { "description": "Menu Checkpoint", "type": "object", "properties": { "MenuCheckpointId": { "format": "int32", "description": "Identifier of Menu Checkpoint", "type": "integer", "example": 500123 }, "Time": { "format": "date-time", "description": "Time of creation of checkpoint", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Name": { "description": "Name of checkpoint", "type": "string", "example": "Example Name" }, "Url": { "description": "Url that points to Serialized Checkpoint", "type": "string", "example": "https://api.flipdish.co/example" } } }, "MenuElementEditResponse": { "description": "Response with any menu elements that had issues being hidden/shown", "type": "object", "properties": { "SectionName": { "description": "Section name", "type": "string", "example": "Example Name" }, "ItemName": { "description": "Item name", "type": "string", "example": "Example Name" }, "OptionSetName": { "description": "Option Set name", "type": "string", "example": "Example Name" }, "OptionSetItemName": { "description": "Element name", "type": "string", "example": "Example Name" }, "MenuElementId": { "format": "int32", "description": "Holds the information for the A and CNAME Records of a domain.", "type": "integer", "example": 500123 }, "MenuElementType": { "description": "Type of menu element", "enum": [ "Item", "OptionSetItem" ], "type": "string", "example": "Item" }, "ValidationCode": { "description": "Validation message for menu element issue", "enum": [ "Success", "MinimumCountViolation", "MasterOptionSetViolation", "IncorrectElementTypeInMenu", "DBFailed" ], "type": "string", "example": "Success" } } }, "MenuElementHide": { "description": "Menu element hide", "type": "object", "properties": { "MenuElementId": { "format": "int32", "description": "id of the menu item or menu option set item", "type": "integer", "example": 500123 }, "MenuElementType": { "description": "Type of menu element", "enum": [ "Item", "OptionSetItem" ], "type": "string", "example": "Item" } } }, "MenuElementListItemResponse": { "description": "Response with any menu elements that had issues being hidden/shown", "type": "object", "properties": { "MenuElementId": { "format": "int32", "description": "Holds the information for the A and CNAME Records of a domain.", "type": "integer", "example": 500123 }, "MenuElementType": { "description": "Type of menu element", "enum": [ "Item", "OptionSetItem" ], "type": "string", "example": "Item" } } }, "MenuElementListResponse": { "description": "Response with any menu elements that had issues being hidden/shown", "type": "object", "properties": { "MenuName": { "description": "Menu Name", "type": "string", "example": "Example Name" }, "MenuElementName": { "description": "Menu Item Name", "type": "string", "example": "Example Name" }, "InstanceCount": { "format": "int32", "description": "Menu Item Count", "type": "integer", "example": 3 }, "IsAvailable": { "description": "Menu Item is hide or unhide", "type": "boolean", "example": true }, "Items": { "description": "List of Items", "type": "array", "items": { "$ref": "#/components/schemas/MenuElementListItemResponse" }, "example": [] } } }, "MenuItemOptionSet": { "description": "Menu item option set", "type": "object", "properties": { "MenuItemOptionSetId": { "format": "int32", "description": "Menu item option set identifier", "type": "integer", "example": 500123 }, "ImageName": { "description": "Image Name", "type": "string", "example": "Example Name" }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" }, "MenuItemOptionSetItems": { "description": "Option set items", "type": "array", "items": { "$ref": "#/components/schemas/MenuItemOptionSetItem" }, "example": [] }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CatalogItemId": { "description": "Catalog item Id when the OptionSet is associated to a Product", "type": "string", "example": "500123" }, "Name": { "description": "Menu item option set name", "maxLength": 4000, "minLength": 0, "type": "string", "example": "Example Name" }, "IsMasterOptionSet": { "description": "Is master option set. This can affect the layout of the options in the menu displayed to the customer. Usually it is true if the option could be considerd a standalone item as opposed to an addition (\"with ketchup\") or modifier (\"large\").", "type": "boolean", "example": true }, "DisplayOrder": { "format": "int32", "description": "Display order. Displayed in ascending order.", "type": "integer", "example": 1 }, "MinSelectCount": { "format": "int32", "description": "Minimum items must be selected", "type": "integer", "example": 3 }, "MaxSelectCount": { "format": "int32", "description": "Maximum number of items can be selected", "type": "integer", "example": 3 }, "CellLayoutType": { "description": "Small | Medium | Large\r\nAffects the layout of the menu.", "enum": [ "Small", "Medium", "Large", "HiddenImage" ], "type": "string", "example": "Small" } } }, "MenuItemOptionSetBase": { "description": "Menu item option set", "type": "object", "properties": { "Name": { "description": "Menu item option set name", "maxLength": 4000, "minLength": 0, "type": "string", "example": "Example Name" }, "IsMasterOptionSet": { "description": "Is master option set. This can affect the layout of the options in the menu displayed to the customer. Usually it is true if the option could be considerd a standalone item as opposed to an addition (\"with ketchup\") or modifier (\"large\").", "type": "boolean", "example": true }, "DisplayOrder": { "format": "int32", "description": "Display order. Displayed in ascending order.", "type": "integer", "example": 1 }, "MinSelectCount": { "format": "int32", "description": "Minimum items must be selected", "type": "integer", "example": 3 }, "MaxSelectCount": { "format": "int32", "description": "Maximum number of items can be selected", "type": "integer", "example": 3 }, "CellLayoutType": { "description": "Small | Medium | Large\r\nAffects the layout of the menu.", "enum": [ "Small", "Medium", "Large", "HiddenImage" ], "type": "string", "example": "Small" }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "MenuItemOptionSetItem": { "description": "Menu item option set item", "type": "object", "properties": { "MenuItemOptionSetItemId": { "format": "int32", "description": "Menu item option set item identifier", "type": "integer", "example": 500123 }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Metadata": { "description": "List of metadata", "type": "array", "items": { "$ref": "#/components/schemas/CreateMetadata" }, "example": [] }, "NextMenuItemOptionSetId": { "format": "int32", "description": "if null, next option set is next. if -1, this is the final option set", "type": "integer", "nullable": true, "example": 500123 }, "CatalogItemId": { "description": "Catalog item Id when the OptionSet is associated to a Product", "type": "string", "example": "500123" }, "TaxRateName": { "description": "Tax rate name", "type": "string", "example": "Example Name" }, "TaxRateId": { "format": "int32", "description": "TaxRateId.", "type": "integer", "nullable": true, "example": 500123 }, "TaxValue": { "format": "double", "description": "TaxValue.", "type": "number", "example": 1.0 }, "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "Price": { "format": "double", "description": "Price", "type": "number", "example": 12.5 }, "DepositReturnFee": { "format": "double", "description": "An optional fee that can be added to the price of the item.", "type": "number", "nullable": true, "example": 12.5 }, "IsAvailable": { "description": "Is available", "type": "boolean", "example": true }, "DisplayOrder": { "format": "int32", "description": "Display order. Displayed in ascending order.", "type": "integer", "example": 1 }, "CellLayoutType": { "description": "Small | Medium | Large\r\nAffects the layout of the menu.", "enum": [ "Small", "Medium", "Large", "HiddenImage" ], "type": "string", "example": "Small" }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" } } }, "MenuItemOptionSetItemBase": { "description": "Menu item option set item", "type": "object", "properties": { "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "Price": { "format": "double", "description": "Price", "type": "number", "example": 12.5 }, "DepositReturnFee": { "format": "double", "description": "An optional fee that can be added to the price of the item.", "type": "number", "nullable": true, "example": 12.5 }, "IsAvailable": { "description": "Is available", "type": "boolean", "example": true }, "DisplayOrder": { "format": "int32", "description": "Display order. Displayed in ascending order.", "type": "integer", "example": 1 }, "CellLayoutType": { "description": "Small | Medium | Large\r\nAffects the layout of the menu.", "enum": [ "Small", "Medium", "Large", "HiddenImage" ], "type": "string", "example": "Small" }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "MenuNutritionInfoHeader": { "description": "MenuNutritionInfoHeader.", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu Id", "type": "integer", "example": 500123 }, "NutritionInfoVersionGuid": { "format": "uuid", "description": "Nutrition information version guid (generated every time the nutrition information is updated)", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "AbsoluteUrl": { "description": "Absolute URL of the nutrition information json file", "type": "string", "example": "https://api.flipdish.co/example" } } }, "MenuObjectDisplayOrders": { "description": "Collection of Display Orders for a Menu Object (Menu Section / Menu Items / Option Sets etc)", "type": "object", "properties": { "DisplayOrders": { "description": "List of Objects and their new Display Orders", "type": "array", "items": { "$ref": "#/components/schemas/ObjectDisplayOrder" }, "example": [] } } }, "MenuSection": { "description": "Menu section", "type": "object", "properties": { "MenuSectionId": { "format": "int32", "description": "Menu section identifier", "type": "integer", "example": 500123 }, "MenuItems": { "description": "Menu items", "type": "array", "items": { "$ref": "#/components/schemas/MenuSectionItem" }, "example": [] }, "MenuSectionAvailability": { "$ref": "#/components/schemas/MenuSectionAvailability" }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ImageName": { "description": "Image Name", "type": "string", "example": "Example Name" }, "Name": { "description": "Name", "maxLength": 4000, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "maxLength": 4000, "minLength": 0, "type": "string", "example": "string" }, "DisplayOrder": { "format": "int32", "description": "Display order", "type": "integer", "example": 1 }, "IsAvailable": { "description": "Is available", "type": "boolean", "example": true }, "IsHiddenFromCustomers": { "description": "Is hidden from customer. Perhaps when the item is out of stock.", "type": "boolean", "example": true }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" } } }, "MenuSectionAvailability": { "description": "Menu section availability", "type": "object", "properties": { "AvailableTimes": { "description": "Available times", "type": "array", "items": { "$ref": "#/components/schemas/BusinessHoursPeriod" }, "example": [] }, "AvailabilityMode": { "description": "Availability mode", "enum": [ "DisplayAlways", "DisplayBasedOnTimes", "DisplayAlwaysStartCollapsed", "DisplayAlwaysStartCollapsedBasedOnTimes" ], "type": "string", "nullable": true, "example": "DisplayAlways" } } }, "MenuSectionAvailabilityBase": { "description": "Menu section availability", "type": "object", "properties": { "AvailabilityMode": { "description": "Availability mode", "enum": [ "DisplayAlways", "DisplayBasedOnTimes", "DisplayAlwaysStartCollapsed", "DisplayAlwaysStartCollapsedBasedOnTimes" ], "type": "string", "nullable": true, "example": "DisplayAlways" } } }, "MenuSectionBase": { "description": "Menu section", "type": "object", "properties": { "Name": { "description": "Name", "maxLength": 4000, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "maxLength": 4000, "minLength": 0, "type": "string", "example": "string" }, "DisplayOrder": { "format": "int32", "description": "Display order", "type": "integer", "example": 1 }, "IsAvailable": { "description": "Is available", "type": "boolean", "example": true }, "IsHiddenFromCustomers": { "description": "Is hidden from customer. Perhaps when the item is out of stock.", "type": "boolean", "example": true }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" }, "MenuSectionId": { "format": "int32", "description": "Menu Section Id", "type": "integer", "example": 500123 }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "MenuSectionItem": { "description": "Menu item", "type": "object", "properties": { "ActualPrice": { "format": "double", "description": "Actual price - the minimum price possible when all required option set items prices are included.", "type": "number", "example": 12.5 }, "MenuItemOptionSets": { "description": "Menu item option sets", "type": "array", "items": { "$ref": "#/components/schemas/MenuItemOptionSet" }, "example": [] }, "DailySpecialHours": { "description": "Daily special hours", "type": "array", "items": { "$ref": "#/components/schemas/BusinessHoursPeriod" }, "example": [] }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "TaxRateName": { "description": "Tax rate name", "type": "string", "example": "Example Name" }, "TaxRateId": { "format": "int32", "description": "TaxRate", "type": "integer", "nullable": true, "example": 500123 }, "TaxValue": { "format": "double", "description": "TaxValue - the tax associated with this item, based on TaxRate / TaxType and Currency (currency determines decimal point precision)", "type": "number", "example": 1.0 }, "ExcludeFromVoucherDiscounting": { "description": "If true, the item is excluded from voucher discount calculations", "type": "boolean", "example": true }, "Metadata": { "description": "List of metadata", "type": "array", "items": { "$ref": "#/components/schemas/CreateMetadata" }, "example": [] }, "CatalogItemId": { "description": "Catalog item Id when the Item is associated to a Product", "type": "string", "example": "500123" }, "Name": { "description": "Menu item name (like \"Korma\")", "maxLength": 4000, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Description (like \"A lovely dish from the east\")", "maxLength": 4000, "minLength": 0, "type": "string", "example": "string" }, "SpicinessRating": { "description": "Spiciness rating", "enum": [ "NotRated", "Mild", "Medium", "Hot" ], "type": "string", "example": "NotRated" }, "Price": { "format": "double", "description": "Price - this is only used when there is no master option set and should be set to 0 if a master option set exists.", "type": "number", "example": 12.5 }, "DepositReturnFee": { "format": "double", "description": "An optional fee that can be added to the price of the item.", "type": "number", "nullable": true, "example": 12.5 }, "DisplayOrder": { "format": "int32", "description": "Display order", "type": "integer", "example": 1 }, "Alcohol": { "description": "To be set true if the item or an option of the item contains an alcoholic drink.", "type": "boolean", "example": true }, "IsAvailable": { "description": "True if we accept orders for this item still", "type": "boolean", "example": true }, "CellLayoutType": { "description": "Small | Medium | Large\r\nAffects the layout of the menu.", "enum": [ "Small", "Medium", "Large", "HiddenImage" ], "type": "string", "example": "Small" }, "DisableVouchers": { "description": "If true, then vouchers won't be applied for this item", "type": "boolean", "example": true }, "ImageName": { "description": "Image url", "type": "string", "example": "Example Name" }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" }, "MenuItemId": { "format": "int32", "description": "Menu Item Id", "type": "integer", "example": 500123 } } }, "MenuSectionItemBase": { "description": "Menu item", "type": "object", "properties": { "Name": { "description": "Menu item name (like \"Korma\")", "maxLength": 4000, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Description (like \"A lovely dish from the east\")", "maxLength": 4000, "minLength": 0, "type": "string", "example": "string" }, "SpicinessRating": { "description": "Spiciness rating", "enum": [ "NotRated", "Mild", "Medium", "Hot" ], "type": "string", "example": "NotRated" }, "Price": { "format": "double", "description": "Price - this is only used when there is no master option set and should be set to 0 if a master option set exists.", "type": "number", "example": 12.5 }, "DepositReturnFee": { "format": "double", "description": "An optional fee that can be added to the price of the item.", "type": "number", "nullable": true, "example": 12.5 }, "DisplayOrder": { "format": "int32", "description": "Display order", "type": "integer", "example": 1 }, "Alcohol": { "description": "To be set true if the item or an option of the item contains an alcoholic drink.", "type": "boolean", "example": true }, "IsAvailable": { "description": "True if we accept orders for this item still", "type": "boolean", "example": true }, "CellLayoutType": { "description": "Small | Medium | Large\r\nAffects the layout of the menu.", "enum": [ "Small", "Medium", "Large", "HiddenImage" ], "type": "string", "example": "Small" }, "DisableVouchers": { "description": "If true, then vouchers won't be applied for this item", "type": "boolean", "example": true }, "ImageName": { "description": "Image url", "type": "string", "example": "Example Name" }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" }, "MenuItemId": { "format": "int32", "description": "Menu Item Id", "type": "integer", "example": 500123 }, "ExcludeFromVoucherDiscounting": { "description": "If true, the item is excluded from voucher discount calculations", "type": "boolean", "example": true }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "MenuStoreNames": { "description": "Menu Store Names", "type": "object", "properties": { "StoreNames": { "description": "Names of stores associated with menu", "type": "array", "items": { "type": "string" }, "example": [ "Example Name" ] } } }, "MenuSummary": { "description": "Menu Summary", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "ModifiedTime": { "format": "date-time", "description": "Last modified time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "VersionNumber": { "format": "int32", "description": "Menu version", "type": "integer", "example": 3 }, "MenuUrl": { "description": "Menu Url", "type": "string", "example": "https://api.flipdish.co/example" }, "Name": { "description": "Name of Menu, only shown in portal", "type": "string", "example": "Example Name" }, "Locked": { "description": "Locked: is menu locked against modifcation", "type": "boolean", "example": true }, "StoreNames": { "description": "List of stores names which are associated with this menu", "type": "array", "items": { "type": "string" }, "example": [ "Example Name" ] }, "IsIntegrated": { "description": "Flag to indicate if the menu is integrated (contains metadata)", "type": "boolean", "example": true } } }, "MenuTaxDetails": { "description": "Tax information for Menu", "type": "object", "properties": { "TaxRates": { "description": "Tax Rates", "type": "array", "items": { "$ref": "#/components/schemas/MenuTaxRate" }, "example": [] }, "DisplayTax": { "description": "Display tax for Menu", "type": "boolean", "example": true }, "TaxType": { "description": "TaxType", "enum": [ "IncludedInBasePrice", "ExcludedFromBasePrice" ], "type": "string", "example": "IncludedInBasePrice" }, "ItemTaxes": { "description": "ItemIds and TaxIds", "type": "object", "additionalProperties": { "format": "int32", "type": "integer" } }, "SetItemTaxes": { "description": "SetItemIds and TaxIds", "type": "object", "additionalProperties": { "format": "int32", "type": "integer" } } } }, "MenuTaxRate": { "description": "Tax Rates Associated with a Menu", "type": "object", "properties": { "TaxRateId": { "format": "int32", "description": "Id of Tax Rate", "type": "integer", "example": 500123 }, "Name": { "description": "Name of Tax Rate", "maxLength": 2048, "minLength": 0, "type": "string", "example": "Example Name" }, "Rate": { "format": "double", "description": "In Percentage", "type": "number", "example": 1.0 } } }, "MenuZone": { "description": "MenuZone.", "type": "object", "properties": { "MenuZoneId": { "format": "int32", "description": "MenuZoneId.", "type": "integer", "example": 500123 }, "MenuId": { "format": "int32", "description": "MenuId.", "type": "integer", "example": 500123 }, "Name": { "description": "Name.", "type": "string", "example": "Example Name" }, "Description": { "description": "Description.", "type": "string", "example": "string" }, "ImageName": { "description": "ImageName.", "type": "string", "example": "Example Name" }, "DisplayOrder": { "format": "int32", "description": "DisplayOrder.", "type": "integer", "example": 1 }, "ImageUrl": { "description": "ImageUrl.", "type": "string", "example": "https://api.flipdish.co/example" } } }, "Metadata": { "description": "Metadata", "type": "object", "properties": { "MenuEntityId": { "format": "int32", "description": "Menu entity identifier (eg: MenuItemId, MenuItemOptionSetItemId)", "type": "integer", "example": 500123 }, "Key": { "description": "Metadata key (Unique identifier)", "maxLength": 128, "minLength": 0, "type": "string", "example": "string" }, "Value": { "description": "Metadata value", "maxLength": 4000, "minLength": 0, "type": "string", "example": "string" } } }, "NutritionInfo": { "description": "Menu Nutrition Information", "type": "object", "properties": { "Version": { "description": "Version of the nutrition information model", "maxLength": 30, "minLength": 0, "type": "string", "example": "string" }, "MenuItems": { "description": "List of menu item nutrition infos", "type": "array", "items": { "$ref": "#/components/schemas/NutritionInfoMenuItem" }, "example": [] }, "MenuItemOptionSetItems": { "description": "List of menu item option set nutrition infos", "type": "array", "items": { "$ref": "#/components/schemas/NutritionInfoMenuOptionSetItem" }, "example": [] } } }, "NutritionInfoLabel": { "description": "NutritionInfoLabel.", "type": "object", "properties": { "Name": { "description": "Name of the allergen / ingredient", "type": "string", "example": "Example Name" }, "Values": { "description": "Optional list of values for the allergen / ingredient", "type": "array", "items": { "type": "string" }, "example": [ "string" ] }, "IconUrl": { "description": "Url to the icon for the allergen / ingredient", "type": "string", "example": "https://api.flipdish.co/example" } } }, "NutritionInfoMenuItem": { "description": "NutritionInfoMenuItem.", "type": "object", "properties": { "PublicId": { "format": "uuid", "description": "Menu item public id", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Labels": { "description": "List of Nutrition Info Labels for this menu item", "type": "array", "items": { "$ref": "#/components/schemas/NutritionInfoLabel" }, "example": [] } } }, "NutritionInfoMenuOptionSetItem": { "description": "NutritionInfoMenuOptionSetItem.", "type": "object", "properties": { "PublicId": { "format": "uuid", "description": "Menu item option set item public id", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Labels": { "description": "List of Nutrition Info Labels for this menu item option set item", "type": "array", "items": { "$ref": "#/components/schemas/NutritionInfoLabel" }, "example": [] } } }, "NutritionInfoV2": { "description": "Menu Nutrition Information. Version 2 (localized).", "type": "object", "properties": { "MenuItems": { "description": "List of menu item nutrition infos", "type": "array", "items": { "$ref": "#/components/schemas/NutritionInfoV2Item" }, "example": [] }, "MenuItemOptionSetItems": { "description": "List of menu item option set nutrition infos", "type": "array", "items": { "$ref": "#/components/schemas/NutritionInfoV2Item" }, "example": [] }, "ImageBaseUrl": { "description": "Base url for allergen images", "type": "string", "example": "https://api.flipdish.co/example" } } }, "NutritionInfoV2Allergen": { "description": "NutritionInfoV2Allergen.", "type": "object", "properties": { "AllergenId": { "description": "AllergenId (unique string identifier)", "type": "string", "example": "500123" }, "LocalizedName": { "description": "Localized allergen name", "type": "string", "example": "Example Name" }, "ImageName": { "description": "Name of the image file. Append it to ImageBaseUrl to get the full URL", "type": "string", "example": "Example Name" } } }, "NutritionInfoV2Item": { "description": "NutritionInfoV2Item.", "type": "object", "properties": { "PublicId": { "format": "uuid", "description": "Menu item or menu item option set item public id", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Allergens": { "description": "List of allergens for this item", "type": "array", "items": { "$ref": "#/components/schemas/NutritionInfoV2Allergen" }, "example": [] } } }, "ObjectDisplayOrder": { "description": "", "type": "object", "properties": { "Id": { "format": "int32", "description": "ID of object to be ordered", "type": "integer", "example": 500123 }, "DisplayOrder": { "format": "int32", "description": "New Display order", "type": "integer", "example": 1 } } }, "Range": { "description": "A class that represents a single opening period in a day.\r\nThis starts 'StartTime' after midnight and runs for a 'Period'\r\nafter that, on the given DayOfWeek.", "type": "object", "properties": { "StartTime": { "description": "Start time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Period": { "description": "Period", "type": "string", "example": "string" }, "DayOfWeek": { "description": "Day of week", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "example": "Sunday" } } }, "RestApiArrayResult_AllMetadataResult_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/AllMetadataResult" }, "example": [] } } }, "RestApiArrayResult_Allergen_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/Allergen" }, "example": [] } } }, "RestApiArrayResult_MenuCheckpoint_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/MenuCheckpoint" }, "example": [] } } }, "RestApiArrayResult_MenuElementEditResponse_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/MenuElementEditResponse" }, "example": [] } } }, "RestApiArrayResult_MenuElementListResponse_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/MenuElementListResponse" }, "example": [] } } }, "RestApiArrayResult_MenuItemOptionSetItem_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/MenuItemOptionSetItem" }, "example": [] } } }, "RestApiArrayResult_MenuItemOptionSet_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/MenuItemOptionSet" }, "example": [] } } }, "RestApiArrayResult_MenuSectionItem_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/MenuSectionItem" }, "example": [] } } }, "RestApiArrayResult_MenuSection_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/MenuSection" }, "example": [] } } }, "RestApiArrayResult_MenuStoreNames_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/MenuStoreNames" }, "example": [] } } }, "RestApiArrayResult_MenuSummary_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/MenuSummary" }, "example": [] } } }, "RestApiArrayResult_MenuTaxDetails_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/MenuTaxDetails" }, "example": [] } } }, "RestApiArrayResult_MenuZone_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/MenuZone" }, "example": [] } } }, "RestApiArrayResult_Metadata_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/Metadata" }, "example": [] } } }, "RestApiResult_BusinessHoursPeriod_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessHoursPeriod" } } }, "RestApiResult_CreatedMenuSectionItems_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/CreatedMenuSectionItems" } } }, "RestApiResult_MenuItemOptionSetItem_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MenuItemOptionSetItem" } } }, "RestApiResult_MenuItemOptionSet_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MenuItemOptionSet" } } }, "RestApiResult_MenuNutritionInfoHeader_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MenuNutritionInfoHeader" } } }, "RestApiResult_MenuSectionAvailability_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MenuSectionAvailability" } } }, "RestApiResult_MenuSectionItem_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MenuSectionItem" } } }, "RestApiResult_MenuSection_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MenuSection" } } }, "RestApiResult_MenuZone_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MenuZone" } } }, "RestApiResult_Menu_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/Menu" } } }, "RestApiResult_Metadata_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/Metadata" } } }, "RestApiResult_NutritionInfoV2_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NutritionInfoV2" } } }, "RestApiResult_NutritionInfo_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NutritionInfo" } } }, "RestApiStringResult": { "description": "Rest api string result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Data string", "type": "string", "example": "string" } } }, "Stream": { "type": "object", "properties": { "CanRead": { "type": "boolean", "readOnly": true, "example": true }, "CanSeek": { "type": "boolean", "readOnly": true, "example": true }, "CanTimeout": { "type": "boolean", "readOnly": true, "example": true }, "CanWrite": { "type": "boolean", "readOnly": true, "example": true }, "Length": { "format": "int64", "type": "integer", "readOnly": true, "example": 1 }, "Position": { "format": "int64", "type": "integer", "example": 1 }, "ReadTimeout": { "format": "int32", "type": "integer", "example": 1 }, "WriteTimeout": { "format": "int32", "type": "integer", "example": 1 } } } }, "securitySchemes": { "oauth2": { "type": "oauth2", "description": "OAuth 2.0. Implicit grant for first-party portal apps; client credentials grant for server-to-server App Store apps (exchange Client ID + Secret Key for a bearer access token).", "flows": { "implicit": { "authorizationUrl": "https://api.flipdish.co/identity/connect/authorize", "scopes": { "api": "Access to the Flipdish API" } }, "clientCredentials": { "tokenUrl": "https://api.flipdish.co/identity/connect/token", "scopes": { "api": "Access to the Flipdish API" } } } } } } }