{ "openapi": "3.0.3", "info": { "title": "Flipdish API - Catalog", "version": "v1.0", "description": "Flipdish Open API v1.0 \u2014 Catalog 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": "CatalogChanges", "description": "Operations for Catalog Changes." }, { "name": "CatalogGroups", "description": "Operations for Catalog Groups." }, { "name": "CatalogImages", "description": "Operations for Catalog Images." }, { "name": "CatalogItems", "description": "Operations for Catalog Items." }, { "name": "CatalogProducts", "description": "Operations for Catalog Products." }, { "name": "MetafieldDefinitions", "description": "Operations for Metafield Definitions." } ], "paths": { "/api/v1.0/{appId}/menus/catalog-changes/summaries": { "get": { "tags": [ "CatalogChanges" ], "summary": "Flipdish Get Pending Menu Changes Summaries", "operationId": "GetPendingMenuChangesSummaries", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_PendingMenuChangesSummaries_" }, "examples": { "GetPendingMenuChangesSummaries200Example": { "summary": "Default GetPendingMenuChangesSummaries 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPendingMenuChangesSummaries400Example": { "summary": "Default GetPendingMenuChangesSummaries 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": { "GetPendingMenuChangesSummaries401Example": { "summary": "Default GetPendingMenuChangesSummaries 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": { "GetPendingMenuChangesSummaries403Example": { "summary": "Default GetPendingMenuChangesSummaries 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": { "GetPendingMenuChangesSummaries500Example": { "summary": "Default GetPendingMenuChangesSummaries 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 Pending Menu Changes Summaries via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/menus/catalog-changes/summaries).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/menus/catalog-changes": { "get": { "tags": [ "CatalogChanges" ], "summary": "Flipdish Get Pending Menu Changes", "description": "Get Pending Menu Changes via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/menus/catalog-changes).", "operationId": "GetPendingMenuChanges", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "menuId", "in": "query", "description": "The menu id query parameter.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "catalogItemId", "in": "query", "description": "The catalog item id query parameter.", "required": false, "schema": { "type": "string" }, "example": "500123" }, { "name": "page", "in": "query", "description": "The page query parameter.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "limit", "in": "query", "description": "The limit query parameter.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult_PendingMenuChanges_" }, "examples": { "GetPendingMenuChanges200Example": { "summary": "Default GetPendingMenuChanges 200 response", "x-microcks-default": true, "value": { "Page": 1, "Limit": 1, "TotalRecordCount": 12.5, "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPendingMenuChanges400Example": { "summary": "Default GetPendingMenuChanges 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": { "GetPendingMenuChanges401Example": { "summary": "Default GetPendingMenuChanges 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": { "GetPendingMenuChanges403Example": { "summary": "Default GetPendingMenuChanges 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": { "GetPendingMenuChanges500Example": { "summary": "Default GetPendingMenuChanges 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/{appId}/menus/catalog-changes/publish": { "post": { "tags": [ "CatalogChanges" ], "summary": "Flipdish Publish Pending Menu Changes", "description": "Publish Pending Menu Changes via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/menus/catalog-changes/publish).", "operationId": "PublishPendingMenuChanges", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishMenuChanges" }, "examples": { "PublishPendingMenuChangesRequestExample": { "summary": "Default PublishPendingMenuChanges request", "x-microcks-default": true, "value": { "CatalogItemId": "500123", "MenuIds": [ 1 ] } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "PublishPendingMenuChanges400Example": { "summary": "Default PublishPendingMenuChanges 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": { "PublishPendingMenuChanges401Example": { "summary": "Default PublishPendingMenuChanges 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": { "PublishPendingMenuChanges403Example": { "summary": "Default PublishPendingMenuChanges 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": { "PublishPendingMenuChanges404Example": { "summary": "Default PublishPendingMenuChanges 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": { "PublishPendingMenuChanges500Example": { "summary": "Default PublishPendingMenuChanges 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/{appId}/catalog/groups/{catalogItemId}": { "get": { "tags": [ "CatalogGroups" ], "summary": "Flipdish Get Group by Id", "description": "Get Group by Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/catalog/groups/{catalogItemId}).", "operationId": "GetGroupById", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "catalogItemId", "in": "path", "description": "The catalog item id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" }, "examples": { "GetGroupById200Example": { "summary": "Default GetGroupById 200 response", "x-microcks-default": true, "value": { "CatalogGroupId": "500123", "CatalogItemId": "500123", "IsArchived": true, "MinSelectCount": 3, "MaxSelectCount": 3, "Products": [], "Metafields": [], "GroupType": "ModifierGroup", "Sku": "string", "Name": "Example Name", "AutogenerateDisplayText": true, "ImageFileName": "Example Name" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetGroupById400Example": { "summary": "Default GetGroupById 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": { "GetGroupById401Example": { "summary": "Default GetGroupById 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": { "GetGroupById403Example": { "summary": "Default GetGroupById 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": { "GetGroupById500Example": { "summary": "Default GetGroupById 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" } }, "post": { "tags": [ "CatalogGroups" ], "summary": "Flipdish Update Group", "description": "Update Group via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/catalog/groups/{catalogItemId}).", "operationId": "UpdateGroup", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "catalogItemId", "in": "path", "description": "The catalog item id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGroup" }, "examples": { "UpdateGroupRequestExample": { "summary": "Default UpdateGroup request", "x-microcks-default": true, "value": { "Sku": "string", "Name": "Example Name", "AutogenerateDisplayText": true, "ImageFileName": "Example Name", "MinSelectCount": 3, "MaxSelectCount": 3, "Products": [], "Metafields": [] } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateGroup400Example": { "summary": "Default UpdateGroup 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": { "UpdateGroup401Example": { "summary": "Default UpdateGroup 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": { "UpdateGroup403Example": { "summary": "Default UpdateGroup 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": { "UpdateGroup404Example": { "summary": "Default UpdateGroup 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": { "UpdateGroup500Example": { "summary": "Default UpdateGroup 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/{appId}/catalog/groups": { "get": { "tags": [ "CatalogGroups" ], "summary": "Flipdish Get Groups", "description": "Get Groups via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/catalog/groups).", "operationId": "GetGroups", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "groupTypes", "in": "query", "description": "The group types query parameter.", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ModifierGroup" ] } }, "example": [ "ModifierGroup" ] }, { "name": "searchTerm", "in": "query", "description": "The search term query parameter.", "required": false, "schema": { "type": "string" }, "example": "string" }, { "name": "page", "in": "query", "description": "The page query parameter.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "limit", "in": "query", "description": "The limit query parameter.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult_Group_" }, "examples": { "GetGroups200Example": { "summary": "Default GetGroups 200 response", "x-microcks-default": true, "value": { "Page": 1, "Limit": 1, "TotalRecordCount": 12.5, "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetGroups400Example": { "summary": "Default GetGroups 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": { "GetGroups401Example": { "summary": "Default GetGroups 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": { "GetGroups403Example": { "summary": "Default GetGroups 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": { "GetGroups500Example": { "summary": "Default GetGroups 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" } }, "post": { "tags": [ "CatalogGroups" ], "summary": "Flipdish Create Group", "description": "Create Group via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/catalog/groups).", "operationId": "CreateGroup", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGroup" }, "examples": { "CreateGroupRequestExample": { "summary": "Default CreateGroup request", "x-microcks-default": true, "value": { "MinSelectCount": 3, "MaxSelectCount": 3, "Products": [], "Metafields": [], "GroupType": "ModifierGroup", "Sku": "string", "Name": "Example Name", "AutogenerateDisplayText": true, "ImageFileName": "Example Name" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Group_" }, "examples": { "CreateGroup200Example": { "summary": "Default CreateGroup 200 response", "x-microcks-default": true, "value": { "Data": { "CatalogGroupId": "500123", "CatalogItemId": "500123", "IsArchived": true, "MinSelectCount": 3, "MaxSelectCount": 3, "Products": [], "Metafields": [], "GroupType": "ModifierGroup", "Sku": "string", "Name": "Example Name", "AutogenerateDisplayText": true, "ImageFileName": "Example Name" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateGroup400Example": { "summary": "Default CreateGroup 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": { "CreateGroup401Example": { "summary": "Default CreateGroup 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": { "CreateGroup403Example": { "summary": "Default CreateGroup 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": { "CreateGroup500Example": { "summary": "Default CreateGroup 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/{appId}/catalog/groups/{catalogItemId}/archive": { "post": { "tags": [ "CatalogGroups" ], "summary": "Flipdish Archive Group", "description": "Archive Group via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/catalog/groups/{catalogItemId}/archive).", "operationId": "ArchiveGroup", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "catalogItemId", "in": "path", "description": "The catalog item id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ArchiveGroup400Example": { "summary": "Default ArchiveGroup 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": { "ArchiveGroup401Example": { "summary": "Default ArchiveGroup 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": { "ArchiveGroup403Example": { "summary": "Default ArchiveGroup 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": { "ArchiveGroup404Example": { "summary": "Default ArchiveGroup 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": { "ArchiveGroup500Example": { "summary": "Default ArchiveGroup 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/{appId}/catalog/groups/{catalogItemId}/duplicate": { "post": { "tags": [ "CatalogGroups" ], "summary": "Flipdish Duplicate Group", "description": "Duplicate Group via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/catalog/groups/{catalogItemId}/duplicate).", "operationId": "DuplicateGroup", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "catalogItemId", "in": "path", "description": "The catalog item id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DuplicateGroup400Example": { "summary": "Default DuplicateGroup 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": { "DuplicateGroup401Example": { "summary": "Default DuplicateGroup 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": { "DuplicateGroup403Example": { "summary": "Default DuplicateGroup 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": { "DuplicateGroup404Example": { "summary": "Default DuplicateGroup 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": { "DuplicateGroup500Example": { "summary": "Default DuplicateGroup 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/{appId}/catalog/images": { "post": { "tags": [ "CatalogImages" ], "summary": "Flipdish Upload Catalog Image", "description": "Upload Catalog Image via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/catalog/images).", "operationId": "UploadCatalogImage", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Image": { "description": "Catalog image", "type": "string", "format": "binary" } }, "required": [ "Image" ] }, "examples": { "UploadCatalogImageRequestExample": { "summary": "Default UploadCatalogImage request", "x-microcks-default": true, "value": { "Image": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogImage" }, "examples": { "UploadCatalogImage200Example": { "summary": "Default UploadCatalogImage 200 response", "x-microcks-default": true, "value": { "ImageUri": "https://api.flipdish.co/example" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadCatalogImage400Example": { "summary": "Default UploadCatalogImage 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": { "UploadCatalogImage401Example": { "summary": "Default UploadCatalogImage 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": { "UploadCatalogImage403Example": { "summary": "Default UploadCatalogImage 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": { "UploadCatalogImage500Example": { "summary": "Default UploadCatalogImage 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/{appId}/catalog/items/{catalogItemId}": { "get": { "tags": [ "CatalogItems" ], "summary": "Flipdish Get Catalog Item by Id", "description": "Get Catalog Item by Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/catalog/items/{catalogItemId}).", "operationId": "GetCatalogItemById", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "catalogItemId", "in": "path", "description": "The catalog item id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogItem" }, "examples": { "GetCatalogItemById200Example": { "summary": "Default GetCatalogItemById 200 response", "x-microcks-default": true, "value": { "CatalogItemId": "500123", "IsArchived": true, "Groups": [], "Metafields": [], "ItemType": "Product", "Sku": "string", "Name": "Example Name", "Description": "string", "Price": 12.5, "ImageFileName": "Example Name", "Alcohol": true } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCatalogItemById400Example": { "summary": "Default GetCatalogItemById 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": { "GetCatalogItemById401Example": { "summary": "Default GetCatalogItemById 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": { "GetCatalogItemById403Example": { "summary": "Default GetCatalogItemById 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": { "GetCatalogItemById500Example": { "summary": "Default GetCatalogItemById 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" } }, "post": { "tags": [ "CatalogItems" ], "summary": "Flipdish Update Catalog Item", "description": "Update Catalog Item via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/catalog/items/{catalogItemId}).", "operationId": "UpdateCatalogItem", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "catalogItemId", "in": "path", "description": "The catalog item id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCatalogItem" }, "examples": { "UpdateCatalogItemRequestExample": { "summary": "Default UpdateCatalogItem request", "x-microcks-default": true, "value": { "Sku": "string", "Name": "Example Name", "Description": "string", "Price": 12.5, "ImageFileName": "Example Name", "Alcohol": true, "Groups": [], "Metafields": [] } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateCatalogItem400Example": { "summary": "Default UpdateCatalogItem 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": { "UpdateCatalogItem401Example": { "summary": "Default UpdateCatalogItem 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": { "UpdateCatalogItem403Example": { "summary": "Default UpdateCatalogItem 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": { "UpdateCatalogItem404Example": { "summary": "Default UpdateCatalogItem 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": { "UpdateCatalogItem500Example": { "summary": "Default UpdateCatalogItem 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/{appId}/catalog/items": { "get": { "tags": [ "CatalogItems" ], "summary": "Flipdish Get Items", "description": "Get Items via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/catalog/items).", "operationId": "GetItems", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "itemTypes", "in": "query", "description": "The item types query parameter.", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "Product", "Modifier" ] } }, "example": [ "Product" ] }, { "name": "searchTerm", "in": "query", "description": "The search term query parameter.", "required": false, "schema": { "type": "string" }, "example": "string" }, { "name": "page", "in": "query", "description": "The page query parameter.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "limit", "in": "query", "description": "The limit query parameter.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult_CatalogItem_" }, "examples": { "GetItems200Example": { "summary": "Default GetItems 200 response", "x-microcks-default": true, "value": { "Page": 1, "Limit": 1, "TotalRecordCount": 12.5, "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetItems400Example": { "summary": "Default GetItems 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": { "GetItems401Example": { "summary": "Default GetItems 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": { "GetItems403Example": { "summary": "Default GetItems 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": { "GetItems500Example": { "summary": "Default GetItems 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" } }, "post": { "tags": [ "CatalogItems" ], "summary": "Flipdish Create Catalog Item", "description": "Create Catalog Item via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/catalog/items).", "operationId": "CreateCatalogItem", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCatalogItem" }, "examples": { "CreateCatalogItemRequestExample": { "summary": "Default CreateCatalogItem request", "x-microcks-default": true, "value": { "Groups": [], "Metafields": [], "ItemType": "Product", "Sku": "string", "Name": "Example Name", "Description": "string", "Price": 12.5, "ImageFileName": "Example Name", "Alcohol": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_CatalogItem_" }, "examples": { "CreateCatalogItem200Example": { "summary": "Default CreateCatalogItem 200 response", "x-microcks-default": true, "value": { "Data": { "CatalogItemId": "500123", "IsArchived": true, "Groups": [], "Metafields": [], "ItemType": "Product", "Sku": "string", "Name": "Example Name", "Description": "string", "Price": 12.5, "ImageFileName": "Example Name", "Alcohol": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateCatalogItem400Example": { "summary": "Default CreateCatalogItem 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": { "CreateCatalogItem401Example": { "summary": "Default CreateCatalogItem 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": { "CreateCatalogItem403Example": { "summary": "Default CreateCatalogItem 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": { "CreateCatalogItem500Example": { "summary": "Default CreateCatalogItem 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/{appId}/catalog/items/{catalogItemId}/archive": { "post": { "tags": [ "CatalogItems" ], "summary": "Flipdish Archive Catalog Item", "description": "Archive Catalog Item via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/catalog/items/{catalogItemId}/archive).", "operationId": "ArchiveCatalogItem", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "catalogItemId", "in": "path", "description": "The catalog item id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ArchiveCatalogItem400Example": { "summary": "Default ArchiveCatalogItem 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": { "ArchiveCatalogItem401Example": { "summary": "Default ArchiveCatalogItem 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": { "ArchiveCatalogItem403Example": { "summary": "Default ArchiveCatalogItem 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": { "ArchiveCatalogItem404Example": { "summary": "Default ArchiveCatalogItem 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": { "ArchiveCatalogItem500Example": { "summary": "Default ArchiveCatalogItem 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/{appId}/catalog/items/{catalogItemId}/duplicate": { "post": { "tags": [ "CatalogItems" ], "summary": "Flipdish Duplicate Catalog Item", "description": "Duplicate Catalog Item via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/catalog/items/{catalogItemId}/duplicate).", "operationId": "DuplicateCatalogItem", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "catalogItemId", "in": "path", "description": "The catalog item id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DuplicateCatalogItem400Example": { "summary": "Default DuplicateCatalogItem 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": { "DuplicateCatalogItem401Example": { "summary": "Default DuplicateCatalogItem 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": { "DuplicateCatalogItem403Example": { "summary": "Default DuplicateCatalogItem 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": { "DuplicateCatalogItem404Example": { "summary": "Default DuplicateCatalogItem 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": { "DuplicateCatalogItem500Example": { "summary": "Default DuplicateCatalogItem 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/{appId}/catalog/products/{catalogItemId}": { "get": { "tags": [ "CatalogProducts" ], "summary": "Flipdish Get Product by Id", "description": "Get Product by Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/catalog/products/{catalogItemId}).", "operationId": "GetProductById", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "catalogItemId", "in": "path", "description": "The catalog item id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" }, "examples": { "GetProductById200Example": { "summary": "Default GetProductById 200 response", "x-microcks-default": true, "value": { "CatalogItemId": "500123", "IsArchived": true, "Groups": [], "Metafields": [], "ProductType": "Product", "Sku": "string", "Name": "Example Name", "Description": "string", "Price": 12.5, "ImageFileName": "Example Name", "Alcohol": true } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetProductById400Example": { "summary": "Default GetProductById 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": { "GetProductById401Example": { "summary": "Default GetProductById 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": { "GetProductById403Example": { "summary": "Default GetProductById 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": { "GetProductById500Example": { "summary": "Default GetProductById 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" } }, "post": { "tags": [ "CatalogProducts" ], "summary": "Flipdish Update Product", "description": "Update Product via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/catalog/products/{catalogItemId}).", "operationId": "UpdateProduct", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "catalogItemId", "in": "path", "description": "The catalog item id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProduct" }, "examples": { "UpdateProductRequestExample": { "summary": "Default UpdateProduct request", "x-microcks-default": true, "value": { "Sku": "string", "Name": "Example Name", "Description": "string", "Price": 12.5, "ImageFileName": "Example Name", "Alcohol": true, "Groups": [], "Metafields": [] } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateProduct400Example": { "summary": "Default UpdateProduct 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": { "UpdateProduct401Example": { "summary": "Default UpdateProduct 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": { "UpdateProduct403Example": { "summary": "Default UpdateProduct 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": { "UpdateProduct404Example": { "summary": "Default UpdateProduct 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": { "UpdateProduct500Example": { "summary": "Default UpdateProduct 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/{appId}/catalog/products": { "get": { "tags": [ "CatalogProducts" ], "summary": "Flipdish Get Products", "description": "Get Products via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/catalog/products).", "operationId": "GetProducts", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "productTypes", "in": "query", "description": "The product types query parameter.", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "Product", "Modifier" ] } }, "example": [ "Product" ] }, { "name": "searchTerm", "in": "query", "description": "The search term query parameter.", "required": false, "schema": { "type": "string" }, "example": "string" }, { "name": "page", "in": "query", "description": "The page query parameter.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "limit", "in": "query", "description": "The limit query parameter.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult_Product_" }, "examples": { "GetProducts200Example": { "summary": "Default GetProducts 200 response", "x-microcks-default": true, "value": { "Page": 1, "Limit": 1, "TotalRecordCount": 12.5, "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetProducts400Example": { "summary": "Default GetProducts 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": { "GetProducts401Example": { "summary": "Default GetProducts 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": { "GetProducts403Example": { "summary": "Default GetProducts 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": { "GetProducts500Example": { "summary": "Default GetProducts 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" } }, "post": { "tags": [ "CatalogProducts" ], "summary": "Flipdish Create Product", "description": "Create Product via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/catalog/products).", "operationId": "CreateProduct", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProduct" }, "examples": { "CreateProductRequestExample": { "summary": "Default CreateProduct request", "x-microcks-default": true, "value": { "Groups": [], "Metafields": [], "ProductType": "Product", "Sku": "string", "Name": "Example Name", "Description": "string", "Price": 12.5, "ImageFileName": "Example Name", "Alcohol": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Product_" }, "examples": { "CreateProduct200Example": { "summary": "Default CreateProduct 200 response", "x-microcks-default": true, "value": { "Data": { "CatalogItemId": "500123", "IsArchived": true, "Groups": [], "Metafields": [], "ProductType": "Product", "Sku": "string", "Name": "Example Name", "Description": "string", "Price": 12.5, "ImageFileName": "Example Name", "Alcohol": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateProduct400Example": { "summary": "Default CreateProduct 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": { "CreateProduct401Example": { "summary": "Default CreateProduct 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": { "CreateProduct403Example": { "summary": "Default CreateProduct 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": { "CreateProduct500Example": { "summary": "Default CreateProduct 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/{appId}/catalog/products/{catalogItemId}/archive": { "post": { "tags": [ "CatalogProducts" ], "summary": "Flipdish Archive Product", "description": "Archive Product via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/catalog/products/{catalogItemId}/archive).", "operationId": "ArchiveProduct", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "catalogItemId", "in": "path", "description": "The catalog item id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ArchiveProduct400Example": { "summary": "Default ArchiveProduct 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": { "ArchiveProduct401Example": { "summary": "Default ArchiveProduct 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": { "ArchiveProduct403Example": { "summary": "Default ArchiveProduct 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": { "ArchiveProduct404Example": { "summary": "Default ArchiveProduct 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": { "ArchiveProduct500Example": { "summary": "Default ArchiveProduct 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/{appId}/catalog/products/{catalogItemId}/duplicate": { "post": { "tags": [ "CatalogProducts" ], "summary": "Flipdish Duplicate Product", "description": "Duplicate Product via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/catalog/products/{catalogItemId}/duplicate).", "operationId": "DuplicateProduct", "parameters": [ { "name": "appId", "in": "path", "description": "The app id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" }, { "name": "catalogItemId", "in": "path", "description": "The catalog item id path parameter.", "required": true, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DuplicateProduct400Example": { "summary": "Default DuplicateProduct 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": { "DuplicateProduct401Example": { "summary": "Default DuplicateProduct 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": { "DuplicateProduct403Example": { "summary": "Default DuplicateProduct 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": { "DuplicateProduct404Example": { "summary": "Default DuplicateProduct 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": { "DuplicateProduct500Example": { "summary": "Default DuplicateProduct 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/{appId}/metafields/definitions": { "get": { "tags": [ "MetafieldDefinitions" ], "operationId": "GetOwnerEntityConfigurations", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnerEntityConfigurations" }, "examples": { "GetOwnerEntityConfigurations200Example": { "summary": "Default GetOwnerEntityConfigurations 200 response", "x-microcks-default": true, "value": { "Configurations": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetOwnerEntityConfigurations400Example": { "summary": "Default GetOwnerEntityConfigurations 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": { "GetOwnerEntityConfigurations401Example": { "summary": "Default GetOwnerEntityConfigurations 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": { "GetOwnerEntityConfigurations403Example": { "summary": "Default GetOwnerEntityConfigurations 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": { "GetOwnerEntityConfigurations500Example": { "summary": "Default GetOwnerEntityConfigurations 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Owner Entity Configurations", "description": "Get Owner Entity Configurations via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/metafields/definitions).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/metafields/definitions/{ownerEntity}/{key}": { "get": { "tags": [ "MetafieldDefinitions" ], "operationId": "GetMetafieldDefinitionByKey", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "ownerEntity", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "CatalogItem", "CatalogGroup", "Menu" ] }, "description": "The owner entity path parameter.", "example": "CatalogItem" }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The key path parameter.", "example": "string" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MetafieldDefinition_" }, "examples": { "GetMetafieldDefinitionByKey200Example": { "summary": "Default GetMetafieldDefinitionByKey 200 response", "x-microcks-default": true, "value": { "Data": { "IsReadOnly": true, "OwnerEntity": "CatalogItem", "Key": "string", "ValueType": "Boolean", "Name": "Example Name", "Description": "string", "Behaviors": [ "SendToOrder" ], "MetafieldDefinitionRecommendationId": 500123 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMetafieldDefinitionByKey400Example": { "summary": "Default GetMetafieldDefinitionByKey 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": { "GetMetafieldDefinitionByKey401Example": { "summary": "Default GetMetafieldDefinitionByKey 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": { "GetMetafieldDefinitionByKey403Example": { "summary": "Default GetMetafieldDefinitionByKey 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": { "GetMetafieldDefinitionByKey500Example": { "summary": "Default GetMetafieldDefinitionByKey 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Metafield Definition by Key", "description": "Get Metafield Definition by Key via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/metafields/definitions/{ownerEntity}/{key}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "MetafieldDefinitions" ], "operationId": "UpdateMetafieldDefinition", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "ownerEntity", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "CatalogItem", "CatalogGroup", "Menu" ] }, "description": "The owner entity path parameter.", "example": "CatalogItem" }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The key path parameter.", "example": "string" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMetafieldDefinition" }, "examples": { "UpdateMetafieldDefinitionRequestExample": { "summary": "Default UpdateMetafieldDefinition request", "x-microcks-default": true, "value": { "Name": "Example Name", "Description": "string", "Behaviors": [ "SendToOrder" ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MetafieldDefinition_" }, "examples": { "UpdateMetafieldDefinition200Example": { "summary": "Default UpdateMetafieldDefinition 200 response", "x-microcks-default": true, "value": { "Data": { "IsReadOnly": true, "OwnerEntity": "CatalogItem", "Key": "string", "ValueType": "Boolean", "Name": "Example Name", "Description": "string", "Behaviors": [ "SendToOrder" ], "MetafieldDefinitionRecommendationId": 500123 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateMetafieldDefinition400Example": { "summary": "Default UpdateMetafieldDefinition 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": { "UpdateMetafieldDefinition401Example": { "summary": "Default UpdateMetafieldDefinition 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": { "UpdateMetafieldDefinition403Example": { "summary": "Default UpdateMetafieldDefinition 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": { "UpdateMetafieldDefinition500Example": { "summary": "Default UpdateMetafieldDefinition 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Update Metafield Definition", "description": "Update Metafield Definition via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/metafields/definitions/{ownerEntity}/{key}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/metafields/definitions/{ownerEntity}": { "get": { "tags": [ "MetafieldDefinitions" ], "operationId": "GetMetafieldDefinitions", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "ownerEntity", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "CatalogItem", "CatalogGroup", "Menu" ] }, "description": "The owner entity path parameter.", "example": "CatalogItem" }, { "name": "searchTerm", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The search term query parameter.", "example": "string" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The page query parameter.", "example": 1 }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The limit query parameter.", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult_MetafieldDefinition_" }, "examples": { "GetMetafieldDefinitions200Example": { "summary": "Default GetMetafieldDefinitions 200 response", "x-microcks-default": true, "value": { "Page": 1, "Limit": 1, "TotalRecordCount": 12.5, "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMetafieldDefinitions400Example": { "summary": "Default GetMetafieldDefinitions 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": { "GetMetafieldDefinitions401Example": { "summary": "Default GetMetafieldDefinitions 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": { "GetMetafieldDefinitions403Example": { "summary": "Default GetMetafieldDefinitions 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": { "GetMetafieldDefinitions500Example": { "summary": "Default GetMetafieldDefinitions 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Metafield Definitions", "description": "Get Metafield Definitions via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/metafields/definitions/{ownerEntity}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "MetafieldDefinitions" ], "operationId": "CreateMetafieldDefinition", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "ownerEntity", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "CatalogItem", "CatalogGroup", "Menu" ] }, "description": "The owner entity path parameter.", "example": "CatalogItem" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMetafieldDefinition" }, "examples": { "CreateMetafieldDefinitionRequestExample": { "summary": "Default CreateMetafieldDefinition request", "x-microcks-default": true, "value": { "IsReadOnly": true, "OwnerEntity": "CatalogItem", "Key": "string", "ValueType": "Boolean", "Name": "Example Name", "Description": "string", "Behaviors": [ "SendToOrder" ], "MetafieldDefinitionRecommendationId": 500123 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MetafieldDefinition_" }, "examples": { "CreateMetafieldDefinition200Example": { "summary": "Default CreateMetafieldDefinition 200 response", "x-microcks-default": true, "value": { "Data": { "IsReadOnly": true, "OwnerEntity": "CatalogItem", "Key": "string", "ValueType": "Boolean", "Name": "Example Name", "Description": "string", "Behaviors": [ "SendToOrder" ], "MetafieldDefinitionRecommendationId": 500123 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateMetafieldDefinition400Example": { "summary": "Default CreateMetafieldDefinition 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": { "CreateMetafieldDefinition401Example": { "summary": "Default CreateMetafieldDefinition 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": { "CreateMetafieldDefinition403Example": { "summary": "Default CreateMetafieldDefinition 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": { "CreateMetafieldDefinition500Example": { "summary": "Default CreateMetafieldDefinition 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Create Metafield Definition", "description": "Create Metafield Definition via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/metafields/definitions/{ownerEntity}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/metafields/definitions/recommendations/{ownerEntity}": { "get": { "tags": [ "MetafieldDefinitions" ], "operationId": "GetOwnerEntityRecommendations", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "ownerEntity", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "CatalogItem", "CatalogGroup", "Menu" ] }, "description": "The owner entity path parameter.", "example": "CatalogItem" }, { "name": "searchTerm", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The search term query parameter.", "example": "string" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The page query parameter.", "example": 1 }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The limit query parameter.", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult_MetafieldDefinitionRecommendation_" }, "examples": { "GetOwnerEntityRecommendations200Example": { "summary": "Default GetOwnerEntityRecommendations 200 response", "x-microcks-default": true, "value": { "Page": 1, "Limit": 1, "TotalRecordCount": 12.5, "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetOwnerEntityRecommendations400Example": { "summary": "Default GetOwnerEntityRecommendations 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": { "GetOwnerEntityRecommendations401Example": { "summary": "Default GetOwnerEntityRecommendations 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": { "GetOwnerEntityRecommendations403Example": { "summary": "Default GetOwnerEntityRecommendations 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": { "GetOwnerEntityRecommendations500Example": { "summary": "Default GetOwnerEntityRecommendations 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Owner Entity Recommendations", "description": "Get Owner Entity Recommendations via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/metafields/definitions/recommendations/{ownerEntity}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } } }, "components": { "schemas": { "CatalogGroupReference": { "description": "Reference to an existing {Flipdish.Menus.PublicModels.V1.Catalog.Groups.Group}", "required": [ "CatalogGroupId", "GroupType" ], "type": "object", "properties": { "Group": { "$ref": "#/components/schemas/Group" }, "CatalogGroupId": { "description": "Identifier of the ProductId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "CatalogItemId": { "description": "Identifier of the ProductId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "GroupType": { "description": "Type of the SupProduct", "enum": [ "ModifierGroup" ], "type": "string", "example": "ModifierGroup" } } }, "CatalogImage": { "description": "Catalog Image", "type": "object", "properties": { "ImageUri": { "description": "Unique catalog Item id", "type": "string", "example": "https://api.flipdish.co/example" } } }, "CatalogItem": { "description": "CatalogItem", "required": [ "ItemType", "Sku", "Name", "Price" ], "type": "object", "properties": { "CatalogItemId": { "description": "Unique catalog Item id", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "IsArchived": { "description": "Returns true if the item is archived", "type": "boolean", "example": true }, "Groups": { "description": "Collection of groups associated with this item", "type": "array", "items": { "$ref": "#/components/schemas/CatalogGroupReference" }, "example": [] }, "Metafields": { "description": "Collection of metafields", "type": "array", "items": { "$ref": "#/components/schemas/Metafield" }, "example": [] }, "ItemType": { "description": "Type of item (Product, Modifier, etc)", "enum": [ "Product", "Modifier" ], "type": "string", "example": "Product" }, "Sku": { "description": "Stock Keeping Unit (SKU)", "maxLength": 30, "minLength": 0, "type": "string", "example": "string" }, "Name": { "description": "Item name", "maxLength": 300, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Item description", "maxLength": 3000, "minLength": 0, "type": "string", "example": "string" }, "Price": { "format": "double", "description": "Item price", "minimum": 0, "type": "number", "example": 12.5 }, "ImageFileName": { "description": "Image File Name", "maxLength": 512, "minLength": 0, "type": "string", "example": "Example Name" }, "Alcohol": { "description": "item contains alcohol", "type": "boolean", "example": true } } }, "CreateCatalogGroupReference": { "description": "Information to create a reference to a {Flipdish.Menus.PublicModels.V1.Catalog.Groups.Group}", "required": [ "CatalogGroupId", "GroupType" ], "type": "object", "properties": { "CatalogGroupId": { "description": "Identifier of the ProductId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "CatalogItemId": { "description": "Identifier of the ProductId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "GroupType": { "description": "Type of the SupProduct", "enum": [ "ModifierGroup" ], "type": "string", "example": "ModifierGroup" } } }, "CreateCatalogItem": { "description": "Create a Catalog Item", "required": [ "ItemType", "Sku", "Name", "Price" ], "type": "object", "properties": { "Groups": { "description": "Collection of groups associated with this item", "type": "array", "items": { "$ref": "#/components/schemas/CreateCatalogGroupReference" }, "example": [] }, "Metafields": { "description": "Collection of metafields", "type": "array", "items": { "$ref": "#/components/schemas/Metafield" }, "example": [] }, "ItemType": { "description": "Type of item (Product, Modifier, etc)", "enum": [ "Product", "Modifier" ], "type": "string", "example": "Product" }, "Sku": { "description": "Stock Keeping Unit (SKU)", "maxLength": 30, "minLength": 0, "type": "string", "example": "string" }, "Name": { "description": "Item name", "maxLength": 300, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Item description", "maxLength": 3000, "minLength": 0, "type": "string", "example": "string" }, "Price": { "format": "double", "description": "Item price", "minimum": 0, "type": "number", "example": 12.5 }, "ImageFileName": { "description": "Image File Name", "maxLength": 512, "minLength": 0, "type": "string", "example": "Example Name" }, "Alcohol": { "description": "item contains alcohol", "type": "boolean", "example": true } } }, "CreateGroup": { "description": "Create a Catalog Group", "required": [ "GroupType", "Sku", "Name" ], "type": "object", "properties": { "MinSelectCount": { "format": "int32", "description": "Minimum number of items that the user has to select", "type": "integer", "example": 3 }, "MaxSelectCount": { "format": "int32", "description": "Maximum number of items that the user has to select", "type": "integer", "nullable": true, "example": 3 }, "Products": { "description": "Collection of items associated with this group", "type": "array", "items": { "$ref": "#/components/schemas/CreateProductReference" }, "example": [] }, "Metafields": { "description": "Collection of metafields", "type": "array", "items": { "$ref": "#/components/schemas/Metafield" }, "example": [] }, "GroupType": { "description": "Type of group (ModifierGroup, etc)", "enum": [ "ModifierGroup" ], "type": "string", "example": "ModifierGroup" }, "Sku": { "description": "Stock Keeping Unit (SKU)", "maxLength": 30, "minLength": 0, "type": "string", "example": "string" }, "Name": { "description": "Group name", "maxLength": 300, "minLength": 0, "type": "string", "example": "Example Name" }, "AutogenerateDisplayText": { "description": "Autogenerate display text in ordering applications", "type": "boolean", "example": true }, "ImageFileName": { "description": "Image File Name", "maxLength": 512, "minLength": 0, "type": "string", "example": "Example Name" } } }, "CreateGroupReference": { "description": "Information to create a reference to a {System.Text.RegularExpressions.Group}", "required": [ "CatalogItemId", "GroupType" ], "type": "object", "properties": { "CatalogItemId": { "description": "Identifier of the ProductId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "GroupType": { "description": "Type of the SupProduct", "enum": [ "ModifierGroup" ], "type": "string", "example": "ModifierGroup" } } }, "CreateMetafieldDefinition": { "description": "Information to create a {Flipdish.Metafields.PublicModels.V1.MetafieldDefinition}", "required": [ "Key", "Name" ], "type": "object", "properties": { "IsReadOnly": { "description": "Indicates if a definition can be edited or not", "type": "boolean", "example": true }, "OwnerEntity": { "description": "The Metafield will extend the specified {Flipdish.Metafields.PublicModels.V1.MetafieldDefinitionBase.OwnerEntity}", "enum": [ "CatalogItem", "CatalogGroup", "Menu" ], "type": "string", "example": "CatalogItem" }, "Key": { "description": "Key of the metafield.\r\nThe key must have two parts, separated by a dot. The first part acts as a category, for organizational purposes.\r\nThe parts can be composed of lowercase letters, numbers, hyphen and underscore", "type": "string", "example": "string" }, "ValueType": { "description": "The excepted type for the Value field", "enum": [ "Boolean", "Json", "SingleLineString", "MultiLineString" ], "type": "string", "example": "Boolean" }, "Name": { "description": "Field Name", "type": "string", "example": "Example Name" }, "Description": { "description": "Field Description", "type": "string", "example": "string" }, "Behaviors": { "description": "Enable Metafield Behaviors", "type": "array", "items": { "enum": [ "SendToOrder", "SendToMenu" ], "type": "string" }, "example": [ "SendToOrder" ] }, "MetafieldDefinitionRecommendationId": { "format": "int32", "description": "Metafield Recommendation Id", "type": "integer", "nullable": true, "example": 500123 } } }, "CreateProduct": { "description": "Create a Catalog Item", "required": [ "ProductType", "Sku", "Name", "Price" ], "type": "object", "properties": { "Groups": { "description": "Collection of groups associated with this item", "type": "array", "items": { "$ref": "#/components/schemas/CreateGroupReference" }, "example": [] }, "Metafields": { "description": "Collection of metafields", "type": "array", "items": { "$ref": "#/components/schemas/Metafield" }, "example": [] }, "ProductType": { "description": "Type of item (Product, Modifier, etc)", "enum": [ "Product", "Modifier" ], "type": "string", "example": "Product" }, "Sku": { "description": "Stock Keeping Unit (SKU)", "maxLength": 30, "minLength": 0, "type": "string", "example": "string" }, "Name": { "description": "Product name", "maxLength": 300, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Product description", "maxLength": 3000, "minLength": 0, "type": "string", "example": "string" }, "Price": { "format": "double", "description": "Product price", "minimum": 0, "type": "number", "example": 12.5 }, "ImageFileName": { "description": "Image File Name", "maxLength": 512, "minLength": 0, "type": "string", "example": "Example Name" }, "Alcohol": { "description": "Product contains alcohol", "type": "boolean", "example": true } } }, "CreateProductReference": { "description": "Information to create a reference to a {Flipdish.Menus.PublicModels.V1.Catalog.Product}", "required": [ "CatalogItemId", "ProductType" ], "type": "object", "properties": { "CatalogItemId": { "description": "Identifier of the CatalogItemId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "ProductType": { "description": "Type of the SupProduct", "enum": [ "Product", "Modifier" ], "type": "string", "example": "Product" }, "PreselectedQuantity": { "format": "int32", "description": "Quantity of the modifier that will be set when the parent product is placed in the basket", "type": "integer", "example": 3 } } }, "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'." } } } } }, "Group": { "description": "CatalogGroup", "required": [ "GroupType", "Sku", "Name" ], "type": "object", "properties": { "CatalogGroupId": { "description": "Unique catalog group id", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "CatalogItemId": { "description": "Unique catalog item id", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "IsArchived": { "description": "Returns true if the group is archived", "type": "boolean", "example": true }, "MinSelectCount": { "format": "int32", "description": "Minimum number of items that the user has to select", "type": "integer", "example": 3 }, "MaxSelectCount": { "format": "int32", "description": "Maximum number of items that the user has to select", "type": "integer", "nullable": true, "example": 3 }, "Products": { "description": "Collection of items associated with this product", "type": "array", "items": { "$ref": "#/components/schemas/ProductReference" }, "example": [] }, "Metafields": { "description": "Collection of metafields", "type": "array", "items": { "$ref": "#/components/schemas/Metafield" }, "example": [] }, "GroupType": { "description": "Type of group (ModifierGroup, etc)", "enum": [ "ModifierGroup" ], "type": "string", "example": "ModifierGroup" }, "Sku": { "description": "Stock Keeping Unit (SKU)", "maxLength": 30, "minLength": 0, "type": "string", "example": "string" }, "Name": { "description": "Group name", "maxLength": 300, "minLength": 0, "type": "string", "example": "Example Name" }, "AutogenerateDisplayText": { "description": "Autogenerate display text in ordering applications", "type": "boolean", "example": true }, "ImageFileName": { "description": "Image File Name", "maxLength": 512, "minLength": 0, "type": "string", "example": "Example Name" } } }, "GroupReference": { "description": "Reference to an existing {Flipdish.Menus.PublicModels.V1.Catalog.Groups.Group}", "required": [ "CatalogItemId", "GroupType" ], "type": "object", "properties": { "Group": { "$ref": "#/components/schemas/Group" }, "CatalogItemId": { "description": "Identifier of the ProductId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "GroupType": { "description": "Type of the SupProduct", "enum": [ "ModifierGroup" ], "type": "string", "example": "ModifierGroup" } } }, "Metafield": { "description": "Metafield", "required": [ "Key", "Value" ], "type": "object", "properties": { "Key": { "description": "Key of the metafield.\r\nAllowed characters: lowercase letters, numbers, hyphen, underscore and dot", "type": "string", "example": "string" }, "Value": { "description": "Value of the metafield.", "type": "string", "example": "string" } } }, "MetafieldDefinition": { "description": "Metafield Definition", "required": [ "Key", "Name" ], "type": "object", "properties": { "IsReadOnly": { "description": "Indicates if a definition can be edited or not", "type": "boolean", "example": true }, "OwnerEntity": { "description": "The Metafield will extend the specified {Flipdish.Metafields.PublicModels.V1.MetafieldDefinitionBase.OwnerEntity}", "enum": [ "CatalogItem", "CatalogGroup", "Menu" ], "type": "string", "example": "CatalogItem" }, "Key": { "description": "Key of the metafield.\r\nThe key must have two parts, separated by a dot. The first part acts as a category, for organizational purposes.\r\nThe parts can be composed of lowercase letters, numbers, hyphen and underscore", "type": "string", "example": "string" }, "ValueType": { "description": "The excepted type for the Value field", "enum": [ "Boolean", "Json", "SingleLineString", "MultiLineString" ], "type": "string", "example": "Boolean" }, "Name": { "description": "Field Name", "type": "string", "example": "Example Name" }, "Description": { "description": "Field Description", "type": "string", "example": "string" }, "Behaviors": { "description": "Enable Metafield Behaviors", "type": "array", "items": { "enum": [ "SendToOrder", "SendToMenu" ], "type": "string" }, "example": [ "SendToOrder" ] }, "MetafieldDefinitionRecommendationId": { "format": "int32", "description": "Metafield Recommendation Id", "type": "integer", "nullable": true, "example": 500123 } } }, "MetafieldDefinitionRecommendation": { "description": "OwnerEntity Metafield Definition Recommendation", "required": [ "Key", "Name" ], "type": "object", "properties": { "OwnerEntity": { "description": "The Metafield will extend the specified {Flipdish.Metafields.PublicModels.V1.MetafieldDefinitionBase.OwnerEntity}", "enum": [ "CatalogItem", "CatalogGroup", "Menu" ], "type": "string", "example": "CatalogItem" }, "Key": { "description": "Key of the metafield.\r\nThe key must have two parts, separated by a dot. The first part acts as a category, for organizational purposes.\r\nThe parts can be composed of lowercase letters, numbers, hyphen and underscore", "type": "string", "example": "string" }, "ValueType": { "description": "The excepted type for the Value field", "enum": [ "Boolean", "Json", "SingleLineString", "MultiLineString" ], "type": "string", "example": "Boolean" }, "Name": { "description": "Field Name", "type": "string", "example": "Example Name" }, "Description": { "description": "Field Description", "type": "string", "example": "string" }, "Behaviors": { "description": "Enable Metafield Behaviors", "type": "array", "items": { "enum": [ "SendToOrder", "SendToMenu" ], "type": "string" }, "example": [ "SendToOrder" ] }, "MetafieldDefinitionRecommendationId": { "format": "int32", "description": "Metafield Recommendation Id", "type": "integer", "nullable": true, "example": 500123 } } }, "OwnerEntityConfiguration": { "description": "OwnerEntity information to configure its {Flipdish.Metafields.PublicModels.V1.MetafieldDefinition}s", "type": "object", "properties": { "OwnerEntity": { "description": "Owner Entity", "enum": [ "CatalogItem", "CatalogGroup", "Menu" ], "type": "string", "example": "CatalogItem" }, "AllowedBehaviors": { "description": "", "type": "array", "items": { "enum": [ "SendToOrder", "SendToMenu" ], "type": "string" }, "example": [ "SendToOrder" ] } } }, "OwnerEntityConfigurations": { "description": "Owner Entity Configurations", "type": "object", "properties": { "Configurations": { "description": "Owner Entity Configuration", "type": "array", "items": { "$ref": "#/components/schemas/OwnerEntityConfiguration" }, "example": [] } } }, "PendingMenuChanges": { "description": "Pending Menu Changes", "type": "object", "properties": { "CatalogItemId": { "description": "Unique catalog item id", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "MenuId": { "format": "int32", "description": "Unique menu id", "type": "integer", "example": 500123 } } }, "PendingMenuChangesSummaries": { "description": "Pending menu changes summaries", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu id", "type": "integer", "example": 500123 }, "TotalPendingChanges": { "format": "int32", "description": "Sum of pending changes per menu id", "type": "integer", "example": 12.5 } } }, "Product": { "description": "Product", "required": [ "ProductType", "Sku", "Name", "Price" ], "type": "object", "properties": { "CatalogItemId": { "description": "Unique catalog Item id", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "IsArchived": { "description": "Returns true if the item is archived", "type": "boolean", "example": true }, "Groups": { "description": "Collection of groups associated with this item", "type": "array", "items": { "$ref": "#/components/schemas/GroupReference" }, "example": [] }, "Metafields": { "description": "Collection of metafields", "type": "array", "items": { "$ref": "#/components/schemas/Metafield" }, "example": [] }, "ProductType": { "description": "Type of item (Product, Modifier, etc)", "enum": [ "Product", "Modifier" ], "type": "string", "example": "Product" }, "Sku": { "description": "Stock Keeping Unit (SKU)", "maxLength": 30, "minLength": 0, "type": "string", "example": "string" }, "Name": { "description": "Product name", "maxLength": 300, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Product description", "maxLength": 3000, "minLength": 0, "type": "string", "example": "string" }, "Price": { "format": "double", "description": "Product price", "minimum": 0, "type": "number", "example": 12.5 }, "ImageFileName": { "description": "Image File Name", "maxLength": 512, "minLength": 0, "type": "string", "example": "Example Name" }, "Alcohol": { "description": "Product contains alcohol", "type": "boolean", "example": true } } }, "ProductReference": { "description": "Catalog Item associated", "required": [ "CatalogItemId", "ProductType" ], "type": "object", "properties": { "Item": { "$ref": "#/components/schemas/Product" }, "Product": { "$ref": "#/components/schemas/Product" }, "CatalogItemId": { "description": "Identifier of the CatalogItemId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "ProductType": { "description": "Type of the SupProduct", "enum": [ "Product", "Modifier" ], "type": "string", "example": "Product" }, "PreselectedQuantity": { "format": "int32", "description": "Quantity of the modifier that will be set when the parent product is placed in the basket", "type": "integer", "example": 3 } } }, "PublishMenuChanges": { "description": "Publish Menu Changes", "type": "object", "properties": { "CatalogItemId": { "description": "Optional Catalog item id", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "MenuIds": { "description": "Optional Collection of Menu id", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] } } }, "RestApiArrayResult_PendingMenuChangesSummaries_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/PendingMenuChangesSummaries" }, "example": [] } } }, "RestApiPaginationResult_CatalogItem_": { "description": "Rest api pagination result", "required": [ "Page", "Limit", "TotalRecordCount", "Data" ], "type": "object", "properties": { "Page": { "format": "int32", "description": "Current page index", "type": "integer", "example": 1 }, "Limit": { "format": "int32", "description": "Current page size", "type": "integer", "example": 1 }, "TotalRecordCount": { "format": "int32", "description": "Total record count", "type": "integer", "example": 12.5 }, "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/CatalogItem" }, "example": [] } } }, "RestApiPaginationResult_Group_": { "description": "Rest api pagination result", "required": [ "Page", "Limit", "TotalRecordCount", "Data" ], "type": "object", "properties": { "Page": { "format": "int32", "description": "Current page index", "type": "integer", "example": 1 }, "Limit": { "format": "int32", "description": "Current page size", "type": "integer", "example": 1 }, "TotalRecordCount": { "format": "int32", "description": "Total record count", "type": "integer", "example": 12.5 }, "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/Group" }, "example": [] } } }, "RestApiPaginationResult_MetafieldDefinitionRecommendation_": { "description": "Rest api pagination result", "required": [ "Page", "Limit", "TotalRecordCount", "Data" ], "type": "object", "properties": { "Page": { "format": "int32", "description": "Current page index", "type": "integer", "example": 1 }, "Limit": { "format": "int32", "description": "Current page size", "type": "integer", "example": 1 }, "TotalRecordCount": { "format": "int32", "description": "Total record count", "type": "integer", "example": 12.5 }, "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/MetafieldDefinitionRecommendation" }, "example": [] } } }, "RestApiPaginationResult_MetafieldDefinition_": { "description": "Rest api pagination result", "required": [ "Page", "Limit", "TotalRecordCount", "Data" ], "type": "object", "properties": { "Page": { "format": "int32", "description": "Current page index", "type": "integer", "example": 1 }, "Limit": { "format": "int32", "description": "Current page size", "type": "integer", "example": 1 }, "TotalRecordCount": { "format": "int32", "description": "Total record count", "type": "integer", "example": 12.5 }, "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/MetafieldDefinition" }, "example": [] } } }, "RestApiPaginationResult_PendingMenuChanges_": { "description": "Rest api pagination result", "required": [ "Page", "Limit", "TotalRecordCount", "Data" ], "type": "object", "properties": { "Page": { "format": "int32", "description": "Current page index", "type": "integer", "example": 1 }, "Limit": { "format": "int32", "description": "Current page size", "type": "integer", "example": 1 }, "TotalRecordCount": { "format": "int32", "description": "Total record count", "type": "integer", "example": 12.5 }, "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/PendingMenuChanges" }, "example": [] } } }, "RestApiPaginationResult_Product_": { "description": "Rest api pagination result", "required": [ "Page", "Limit", "TotalRecordCount", "Data" ], "type": "object", "properties": { "Page": { "format": "int32", "description": "Current page index", "type": "integer", "example": 1 }, "Limit": { "format": "int32", "description": "Current page size", "type": "integer", "example": 1 }, "TotalRecordCount": { "format": "int32", "description": "Total record count", "type": "integer", "example": 12.5 }, "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/Product" }, "example": [] } } }, "RestApiResult_CatalogItem_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/CatalogItem" } } }, "RestApiResult_Group_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/Group" } } }, "RestApiResult_MetafieldDefinition_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MetafieldDefinition" } } }, "RestApiResult_Product_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/Product" } } }, "UpdateCatalogGroupReference": { "description": "Data to update a {Flipdish.Menus.PublicModels.V1.Catalog.Items.CatalogGroupReference}", "required": [ "CatalogGroupId", "GroupType" ], "type": "object", "properties": { "CatalogGroupId": { "description": "Identifier of the ProductId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "CatalogItemId": { "description": "Identifier of the ProductId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "GroupType": { "description": "Type of the SupProduct", "enum": [ "ModifierGroup" ], "type": "string", "example": "ModifierGroup" } } }, "UpdateCatalogItem": { "description": "Update Catalog Item", "type": "object", "properties": { "Sku": { "description": "Stock Keeping Unit (SKU)", "maxLength": 30, "minLength": 0, "type": "string", "example": "string" }, "Name": { "description": "Product name", "maxLength": 300, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Product description", "maxLength": 3000, "minLength": 0, "type": "string", "example": "string" }, "Price": { "format": "double", "description": "Product price", "minimum": 0, "type": "number", "nullable": true, "example": 12.5 }, "ImageFileName": { "description": "Image File Name", "maxLength": 512, "minLength": 0, "type": "string", "example": "Example Name" }, "Alcohol": { "description": "Product contains alcohol", "type": "boolean", "nullable": true, "example": true }, "Groups": { "description": "Collection of groups associated with this item", "type": "array", "items": { "$ref": "#/components/schemas/UpdateCatalogGroupReference" }, "example": [] }, "Metafields": { "description": "Collection of metafields", "type": "array", "items": { "$ref": "#/components/schemas/Metafield" }, "example": [] } } }, "UpdateGroup": { "description": "Update Catalog Group", "type": "object", "properties": { "Sku": { "description": "Stock Keeping Unit (SKU)", "maxLength": 30, "minLength": 0, "type": "string", "example": "string" }, "Name": { "description": "Group name", "maxLength": 300, "minLength": 0, "type": "string", "example": "Example Name" }, "AutogenerateDisplayText": { "description": "Autogenerate display text in ordering applications", "type": "boolean", "nullable": true, "example": true }, "ImageFileName": { "description": "Image File Name", "maxLength": 512, "minLength": 0, "type": "string", "example": "Example Name" }, "MinSelectCount": { "format": "int32", "description": "Minimum number of items that the user has to select", "type": "integer", "nullable": true, "example": 3 }, "MaxSelectCount": { "format": "int32", "description": "Maximum number of items that the user has to select", "type": "integer", "nullable": true, "example": 3 }, "Products": { "description": "Collection of items associated with this group", "type": "array", "items": { "$ref": "#/components/schemas/UpdateProductReference" }, "example": [] }, "Metafields": { "description": "Collection of metafields", "type": "array", "items": { "$ref": "#/components/schemas/Metafield" }, "example": [] } } }, "UpdateGroupReference": { "description": "Data to update a {Flipdish.Menus.PublicModels.V1.Catalog.Products.GroupReference}", "required": [ "CatalogItemId", "GroupType" ], "type": "object", "properties": { "CatalogItemId": { "description": "Identifier of the ProductId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "GroupType": { "description": "Type of the SupProduct", "enum": [ "ModifierGroup" ], "type": "string", "example": "ModifierGroup" } } }, "UpdateMetafieldDefinition": { "description": "Information to update a {Flipdish.Metafields.PublicModels.V1.MetafieldDefinition}", "type": "object", "properties": { "Name": { "description": "Field Name", "type": "string", "example": "Example Name" }, "Description": { "description": "Field Description", "type": "string", "example": "string" }, "Behaviors": { "description": "Enable Metafield Behaviors", "type": "array", "items": { "enum": [ "SendToOrder", "SendToMenu" ], "type": "string" }, "example": [ "SendToOrder" ] } } }, "UpdateProduct": { "description": "Update Product", "type": "object", "properties": { "Sku": { "description": "Stock Keeping Unit (SKU)", "maxLength": 30, "minLength": 0, "type": "string", "example": "string" }, "Name": { "description": "Product name", "maxLength": 300, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Product description", "maxLength": 3000, "minLength": 0, "type": "string", "example": "string" }, "Price": { "format": "double", "description": "Product price", "minimum": 0, "type": "number", "nullable": true, "example": 12.5 }, "ImageFileName": { "description": "Image File Name", "maxLength": 512, "minLength": 0, "type": "string", "example": "Example Name" }, "Alcohol": { "description": "Product contains alcohol", "type": "boolean", "nullable": true, "example": true }, "Groups": { "description": "Collection of groups associated with this item", "type": "array", "items": { "$ref": "#/components/schemas/UpdateGroupReference" }, "example": [] }, "Metafields": { "description": "Collection of metafields", "type": "array", "items": { "$ref": "#/components/schemas/Metafield" }, "example": [] } } }, "UpdateProductReference": { "description": "Data to update a {Flipdish.Menus.PublicModels.V1.Catalog.Groups.UpdateProductReference}", "required": [ "CatalogItemId", "ProductType" ], "type": "object", "properties": { "CatalogItemId": { "description": "Identifier of the CatalogItemId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "ProductType": { "description": "Type of the SupProduct", "enum": [ "Product", "Modifier" ], "type": "string", "example": "Product" }, "PreselectedQuantity": { "format": "int32", "description": "Quantity of the modifier that will be set when the parent product is placed in the basket", "type": "integer", "example": 3 } } } }, "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" } } } } } } }