{ "openapi": "3.0.3", "info": { "title": "Flipdish API - Stores", "version": "v1.0", "description": "Flipdish Open API v1.0 \u2014 Stores 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": "Address", "description": "Operations for Address." }, { "name": "DeliveryZone", "description": "Operations for Delivery Zone." }, { "name": "Location", "description": "Operations for Location." }, { "name": "LocationAreas", "description": "Operations for Location Areas." }, { "name": "StoreGroups", "description": "Operations for Store Groups." }, { "name": "StoreOrderCapacity", "description": "Operations for Store Order Capacity." }, { "name": "Stores", "description": "Operations for Stores." } ], "paths": { "/api/v1.0/address/countries": { "get": { "tags": [ "Address" ], "operationId": "GetCountries", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The language query parameter.", "example": "string" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_CountryFormResponse_" }, "examples": { "GetCountries200Example": { "summary": "Default GetCountries 200 response", "x-microcks-default": true, "value": { "Data": { "Value": "string", "Label": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCountries400Example": { "summary": "Default GetCountries 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": { "GetCountries401Example": { "summary": "Default GetCountries 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": { "GetCountries403Example": { "summary": "Default GetCountries 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": { "GetCountries500Example": { "summary": "Default GetCountries 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 Countries", "description": "Get Countries via the Flipdish Open API v1.0 (GET /api/v1.0/address/countries).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/app/{appId}/address/form": { "get": { "tags": [ "Address" ], "operationId": "FormByApp", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The language query parameter.", "example": "string" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AddressFormResponse_" }, "examples": { "FormByApp200Example": { "summary": "Default FormByApp 200 response", "x-microcks-default": true, "value": { "Data": { "FormData": [], "CountryCode": "IE", "Language": "string", "DisplayFormat": { "OneLine": "string", "TwoLines": [ "string" ] } } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FormByApp400Example": { "summary": "Default FormByApp 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": { "FormByApp401Example": { "summary": "Default FormByApp 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": { "FormByApp403Example": { "summary": "Default FormByApp 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": { "FormByApp500Example": { "summary": "Default FormByApp 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 Form by App", "description": "Form by App via the Flipdish Open API v1.0 (GET /api/v1.0/app/{appId}/address/form).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/address/country/{countryCode}/form": { "get": { "tags": [ "Address" ], "operationId": "FormByCountry", "parameters": [ { "name": "countryCode", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The country code path parameter.", "example": "IE" }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The language query parameter.", "example": "string" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AddressFormResponse_" }, "examples": { "FormByCountry200Example": { "summary": "Default FormByCountry 200 response", "x-microcks-default": true, "value": { "Data": { "FormData": [], "CountryCode": "IE", "Language": "string", "DisplayFormat": { "OneLine": "string", "TwoLines": [ "string" ] } } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FormByCountry400Example": { "summary": "Default FormByCountry 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": { "FormByCountry401Example": { "summary": "Default FormByCountry 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": { "FormByCountry403Example": { "summary": "Default FormByCountry 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": { "FormByCountry500Example": { "summary": "Default FormByCountry 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 Form by Country", "description": "Form by Country via the Flipdish Open API v1.0 (GET /api/v1.0/address/country/{countryCode}/form).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/address/templates": { "post": { "tags": [ "Address" ], "operationId": "AddressTemplates", "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringResult" }, "examples": { "AddressTemplates200Example": { "summary": "Default AddressTemplates 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddressTemplates400Example": { "summary": "Default AddressTemplates 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": { "AddressTemplates401Example": { "summary": "Default AddressTemplates 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": { "AddressTemplates403Example": { "summary": "Default AddressTemplates 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": { "AddressTemplates500Example": { "summary": "Default AddressTemplates 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 Address Templates", "description": "Address Templates via the Flipdish Open API v1.0 (POST /api/v1.0/address/templates).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/address/google": { "post": { "tags": [ "Address" ], "operationId": "FormatGoogleAddress", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The language query parameter.", "example": "string" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleAddress" }, "examples": { "FormatGoogleAddressRequestExample": { "summary": "Default FormatGoogleAddress request", "x-microcks-default": true, "value": { "Results": [], "Result": { "Address_components": [], "Formatted_address": "string", "Geometry": { "Location": {}, "Location_type": "string", "Viewport": {} }, "Place_id": "500123", "Types": [ "string" ] }, "Status": "Active" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AddressFormResponse_" }, "examples": { "FormatGoogleAddress200Example": { "summary": "Default FormatGoogleAddress 200 response", "x-microcks-default": true, "value": { "Data": { "FormData": [], "CountryCode": "IE", "Language": "string", "DisplayFormat": { "OneLine": "string", "TwoLines": [ "string" ] } } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FormatGoogleAddress400Example": { "summary": "Default FormatGoogleAddress 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": { "FormatGoogleAddress401Example": { "summary": "Default FormatGoogleAddress 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": { "FormatGoogleAddress403Example": { "summary": "Default FormatGoogleAddress 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": { "FormatGoogleAddress500Example": { "summary": "Default FormatGoogleAddress 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 Format Google Address", "description": "Format Google Address via the Flipdish Open API v1.0 (POST /api/v1.0/address/google).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/deliveryzones": { "get": { "tags": [ "DeliveryZone" ], "operationId": "GetDeliveryZones", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_DeliveryZone_" }, "examples": { "GetDeliveryZones200Example": { "summary": "Default GetDeliveryZones 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetDeliveryZones400Example": { "summary": "Default GetDeliveryZones 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": { "GetDeliveryZones401Example": { "summary": "Default GetDeliveryZones 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": { "GetDeliveryZones403Example": { "summary": "Default GetDeliveryZones 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": { "GetDeliveryZones404Example": { "summary": "Default GetDeliveryZones 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": { "GetDeliveryZones500Example": { "summary": "Default GetDeliveryZones 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 Delivery Zones", "description": "Get Delivery Zones via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/deliveryzones).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "DeliveryZone" ], "operationId": "AddDeliveryZone", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_DeliveryZone_" }, "examples": { "AddDeliveryZone200Example": { "summary": "Default AddDeliveryZone 200 response", "x-microcks-default": true, "value": { "Data": { "Id": 500123, "FeeChargedToStore": 12.5, "DeliveryFee": 12.5, "MinimumDeliveryOrderAmount": 12.5, "WellKnownText": "string", "IsEnabled": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddDeliveryZone400Example": { "summary": "Default AddDeliveryZone 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": { "AddDeliveryZone401Example": { "summary": "Default AddDeliveryZone 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": { "AddDeliveryZone403Example": { "summary": "Default AddDeliveryZone 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": { "AddDeliveryZone404Example": { "summary": "Default AddDeliveryZone 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": { "AddDeliveryZone500Example": { "summary": "Default AddDeliveryZone 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 Add Delivery Zone", "description": "Add Delivery Zone via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/deliveryzones).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/deliveryzones/{deliveryZoneId}": { "post": { "tags": [ "DeliveryZone" ], "operationId": "UpdateDeliveryZone", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "deliveryZoneId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The delivery zone id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_DeliveryZone_" }, "examples": { "UpdateDeliveryZone200Example": { "summary": "Default UpdateDeliveryZone 200 response", "x-microcks-default": true, "value": { "Data": { "Id": 500123, "FeeChargedToStore": 12.5, "DeliveryFee": 12.5, "MinimumDeliveryOrderAmount": 12.5, "WellKnownText": "string", "IsEnabled": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateDeliveryZone400Example": { "summary": "Default UpdateDeliveryZone 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": { "UpdateDeliveryZone401Example": { "summary": "Default UpdateDeliveryZone 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": { "UpdateDeliveryZone403Example": { "summary": "Default UpdateDeliveryZone 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": { "UpdateDeliveryZone404Example": { "summary": "Default UpdateDeliveryZone 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": { "UpdateDeliveryZone500Example": { "summary": "Default UpdateDeliveryZone 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 Delivery Zone", "description": "Update Delivery Zone via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/deliveryzones/{deliveryZoneId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "DeliveryZone" ], "operationId": "RemoveDeliveryZone", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "deliveryZoneId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The delivery zone id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RemoveDeliveryZone400Example": { "summary": "Default RemoveDeliveryZone 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": { "RemoveDeliveryZone401Example": { "summary": "Default RemoveDeliveryZone 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": { "RemoveDeliveryZone403Example": { "summary": "Default RemoveDeliveryZone 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": { "RemoveDeliveryZone404Example": { "summary": "Default RemoveDeliveryZone 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": { "RemoveDeliveryZone500Example": { "summary": "Default RemoveDeliveryZone 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 Remove Delivery Zone", "description": "Remove Delivery Zone via the Flipdish Open API v1.0 (DELETE /api/v1.0/stores/{storeId}/deliveryzones/{deliveryZoneId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location": { "post": { "tags": [ "Location" ], "operationId": "CreateLocation", "parameters": [ { "name": "locationAreaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The location area id path parameter.", "example": 500123 }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateLocation" } }, "examples": { "CreateLocationRequestExample": { "summary": "Default CreateLocation request", "x-microcks-default": true, "value": [ { "LocationId": 500123, "LocationName": "Example Name", "DisplayOrder": 1, "ExternalLocationId": "500123" } ] } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CreateLocation200Example": { "summary": "Default CreateLocation 200 response", "x-microcks-default": true, "value": {} } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_LocationArea_Location_" }, "examples": { "CreateLocation201Example": { "summary": "Default CreateLocation 201 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateLocation400Example": { "summary": "Default CreateLocation 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": { "CreateLocation401Example": { "summary": "Default CreateLocation 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": { "CreateLocation403Example": { "summary": "Default CreateLocation 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": { "CreateLocation404Example": { "summary": "Default CreateLocation 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": { "CreateLocation500Example": { "summary": "Default CreateLocation 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 Location", "description": "Create Location via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/update": { "post": { "tags": [ "Location" ], "operationId": "UpdateLocation", "parameters": [ { "name": "locationAreaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The location area id path parameter.", "example": 500123 }, { "name": "locationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The location id path parameter.", "example": 500123 }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLocation" }, "examples": { "UpdateLocationRequestExample": { "summary": "Default UpdateLocation request", "x-microcks-default": true, "value": { "LocationId": 500123, "LocationName": "Example Name", "DisplayOrder": 1, "ExternalLocationId": "500123" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_LocationArea_Location_" }, "examples": { "UpdateLocation200Example": { "summary": "Default UpdateLocation 200 response", "x-microcks-default": true, "value": { "Data": { "LocationId": 500123, "LocationName": "Example Name", "DisplayOrder": 1, "ExternalLocationId": "500123", "IsDeleted": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateLocation400Example": { "summary": "Default UpdateLocation 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": { "UpdateLocation401Example": { "summary": "Default UpdateLocation 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": { "UpdateLocation403Example": { "summary": "Default UpdateLocation 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": { "UpdateLocation404Example": { "summary": "Default UpdateLocation 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": { "UpdateLocation500Example": { "summary": "Default UpdateLocation 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 Location", "description": "Update Location via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/update).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/move": { "post": { "tags": [ "Location" ], "operationId": "MoveLocation", "parameters": [ { "name": "locationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The location id path parameter.", "example": 500123 }, { "name": "locationAreaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The location area id path parameter.", "example": 500123 }, { "name": "newLocationAreaId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The new location area id query parameter.", "example": 500123 }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "MoveLocation200Example": { "summary": "Default MoveLocation 200 response", "x-microcks-default": true, "value": {} } } } } }, "204": { "description": "NoContent" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "MoveLocation400Example": { "summary": "Default MoveLocation 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": { "MoveLocation401Example": { "summary": "Default MoveLocation 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": { "MoveLocation403Example": { "summary": "Default MoveLocation 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": { "MoveLocation404Example": { "summary": "Default MoveLocation 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": { "MoveLocation500Example": { "summary": "Default MoveLocation 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 Move Location", "description": "Move Location via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/move).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/map-external": { "post": { "tags": [ "Location" ], "operationId": "MapLocationToExternalId", "parameters": [ { "name": "locationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The location id path parameter.", "example": 500123 }, { "name": "locationAreaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The location area id path parameter.", "example": 500123 }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "externalLocationId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The external location id query parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MappedLocation_" }, "examples": { "MapLocationToExternalId200Example": { "summary": "Default MapLocationToExternalId 200 response", "x-microcks-default": true, "value": { "Data": { "LocationId": 500123, "ExternalLocationId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "MapLocationToExternalId400Example": { "summary": "Default MapLocationToExternalId 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": { "MapLocationToExternalId401Example": { "summary": "Default MapLocationToExternalId 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": { "MapLocationToExternalId403Example": { "summary": "Default MapLocationToExternalId 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": { "MapLocationToExternalId404Example": { "summary": "Default MapLocationToExternalId 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": { "MapLocationToExternalId500Example": { "summary": "Default MapLocationToExternalId 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 Map Location to External Id", "description": "Map Location to External Id via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/map-external).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/delete": { "delete": { "tags": [ "Location" ], "operationId": "DeleteLocation", "parameters": [ { "name": "locationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The location id path parameter.", "example": 500123 }, { "name": "locationAreaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The location area id path parameter.", "example": 500123 }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DeleteLocation200Example": { "summary": "Default DeleteLocation 200 response", "x-microcks-default": true, "value": {} } } } } }, "204": { "description": "NoContent" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteLocation400Example": { "summary": "Default DeleteLocation 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": { "DeleteLocation401Example": { "summary": "Default DeleteLocation 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": { "DeleteLocation403Example": { "summary": "Default DeleteLocation 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": { "DeleteLocation404Example": { "summary": "Default DeleteLocation 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": { "DeleteLocation500Example": { "summary": "Default DeleteLocation 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 Delete Location", "description": "Delete Location via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/location/{locationId}/delete).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/stores/{storeId}/location-areas": { "get": { "tags": [ "LocationAreas" ], "operationId": "GetLocationAreasForStore", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_LocationAreaWithLocations_" }, "examples": { "GetLocationAreasForStore200Example": { "summary": "Default GetLocationAreasForStore 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetLocationAreasForStore400Example": { "summary": "Default GetLocationAreasForStore 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": { "GetLocationAreasForStore401Example": { "summary": "Default GetLocationAreasForStore 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": { "GetLocationAreasForStore403Example": { "summary": "Default GetLocationAreasForStore 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": { "GetLocationAreasForStore500Example": { "summary": "Default GetLocationAreasForStore 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 Location Areas for Store", "description": "Get Location Areas for Store via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/stores/{storeId}/location-areas).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "LocationAreas" ], "operationId": "CreateLocationArea", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLocationArea" }, "examples": { "CreateLocationAreaRequestExample": { "summary": "Default CreateLocationArea request", "x-microcks-default": true, "value": { "LocationAreaName": "Example Name" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CreateLocationArea200Example": { "summary": "Default CreateLocationArea 200 response", "x-microcks-default": true, "value": {} } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_LocationArea_" }, "examples": { "CreateLocationArea201Example": { "summary": "Default CreateLocationArea 201 response", "x-microcks-default": true, "value": { "Data": { "LocationAreaId": 500123, "StoreId": 500123, "LocationAreaName": "Example Name" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateLocationArea400Example": { "summary": "Default CreateLocationArea 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": { "CreateLocationArea401Example": { "summary": "Default CreateLocationArea 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": { "CreateLocationArea403Example": { "summary": "Default CreateLocationArea 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": { "CreateLocationArea404Example": { "summary": "Default CreateLocationArea 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": { "CreateLocationArea500Example": { "summary": "Default CreateLocationArea 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 Location Area", "description": "Create Location Area via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/stores/{storeId}/location-areas).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}": { "get": { "tags": [ "LocationAreas" ], "operationId": "GetLocationArea", "parameters": [ { "name": "locationAreaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The location area id path parameter.", "example": 500123 }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_LocationAreaWithLocations_" }, "examples": { "GetLocationArea200Example": { "summary": "Default GetLocationArea 200 response", "x-microcks-default": true, "value": { "Data": { "LocationAreaId": 500123, "StoreId": 500123, "LocationAreaName": "Example Name", "Locations": [], "IsDeleted": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetLocationArea400Example": { "summary": "Default GetLocationArea 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": { "GetLocationArea401Example": { "summary": "Default GetLocationArea 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": { "GetLocationArea403Example": { "summary": "Default GetLocationArea 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": { "GetLocationArea404Example": { "summary": "Default GetLocationArea 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": { "GetLocationArea500Example": { "summary": "Default GetLocationArea 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 Location Area", "description": "Get Location Area via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/update": { "post": { "tags": [ "LocationAreas" ], "operationId": "UpdateLocationArea", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "locationAreaId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The location area id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLocationArea" }, "examples": { "UpdateLocationAreaRequestExample": { "summary": "Default UpdateLocationArea request", "x-microcks-default": true, "value": { "LocationAreaId": 500123, "LocationAreaName": "Example Name", "IsDeleted": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_LocationArea_" }, "examples": { "UpdateLocationArea200Example": { "summary": "Default UpdateLocationArea 200 response", "x-microcks-default": true, "value": { "Data": { "LocationAreaId": 500123, "StoreId": 500123, "LocationAreaName": "Example Name" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateLocationArea400Example": { "summary": "Default UpdateLocationArea 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": { "UpdateLocationArea401Example": { "summary": "Default UpdateLocationArea 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": { "UpdateLocationArea403Example": { "summary": "Default UpdateLocationArea 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": { "UpdateLocationArea404Example": { "summary": "Default UpdateLocationArea 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": { "UpdateLocationArea500Example": { "summary": "Default UpdateLocationArea 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 Location Area", "description": "Update Location Area via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/update).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/storegroups/{storeGroupId}": { "get": { "tags": [ "StoreGroups" ], "operationId": "GetStoreGroup", "parameters": [ { "name": "storeGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store group id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_StoreGroup_" }, "examples": { "GetStoreGroup200Example": { "summary": "Default GetStoreGroup 200 response", "x-microcks-default": true, "value": { "Data": { "StoreGroupId": 500123, "GeneralRating": 1.0, "GeneralRatingCount": 3, "DeliveryMenuMessage": "string", "PickupMenuMessage": "string", "BrandIds": [ "string" ], "Name": "Example Name", "Currency": "EUR" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreGroup400Example": { "summary": "Default GetStoreGroup 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": { "GetStoreGroup401Example": { "summary": "Default GetStoreGroup 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": { "GetStoreGroup403Example": { "summary": "Default GetStoreGroup 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": { "GetStoreGroup404Example": { "summary": "Default GetStoreGroup 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": { "GetStoreGroup500Example": { "summary": "Default GetStoreGroup 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 Store Group", "description": "Get Store Group via the Flipdish Open API v1.0 (GET /api/v1.0/storegroups/{storeGroupId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "StoreGroups" ], "operationId": "UpdateStoreGroup", "parameters": [ { "name": "storeGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store group id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_StoreGroupBase_" }, "examples": { "UpdateStoreGroup200Example": { "summary": "Default UpdateStoreGroup 200 response", "x-microcks-default": true, "value": { "Data": { "Name": "Example Name", "Currency": "EUR" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateStoreGroup400Example": { "summary": "Default UpdateStoreGroup 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": { "UpdateStoreGroup401Example": { "summary": "Default UpdateStoreGroup 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": { "UpdateStoreGroup403Example": { "summary": "Default UpdateStoreGroup 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": { "UpdateStoreGroup404Example": { "summary": "Default UpdateStoreGroup 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": { "UpdateStoreGroup500Example": { "summary": "Default UpdateStoreGroup 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 Store Group", "description": "Update Store Group via the Flipdish Open API v1.0 (POST /api/v1.0/storegroups/{storeGroupId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "StoreGroups" ], "operationId": "RemoveStoreGroup", "parameters": [ { "name": "storeGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store group id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RemoveStoreGroup400Example": { "summary": "Default RemoveStoreGroup 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": { "RemoveStoreGroup401Example": { "summary": "Default RemoveStoreGroup 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": { "RemoveStoreGroup403Example": { "summary": "Default RemoveStoreGroup 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": { "RemoveStoreGroup404Example": { "summary": "Default RemoveStoreGroup 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": { "RemoveStoreGroup500Example": { "summary": "Default RemoveStoreGroup 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 Remove Store Group", "description": "Remove Store Group via the Flipdish Open API v1.0 (DELETE /api/v1.0/storegroups/{storeGroupId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appNameId}/storegroups": { "get": { "tags": [ "StoreGroups" ], "operationId": "GetStoreGroups", "parameters": [ { "name": "appNameId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app name id path parameter.", "example": "500123" }, { "name": "searchQuery", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The search query 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_StoreGroup_" }, "examples": { "GetStoreGroups200Example": { "summary": "Default GetStoreGroups 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": { "GetStoreGroups400Example": { "summary": "Default GetStoreGroups 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": { "GetStoreGroups401Example": { "summary": "Default GetStoreGroups 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": { "GetStoreGroups403Example": { "summary": "Default GetStoreGroups 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": { "GetStoreGroups500Example": { "summary": "Default GetStoreGroups 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 Store Groups", "description": "Get Store Groups via the Flipdish Open API v1.0 (GET /api/v1.0/{appNameId}/storegroups).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "StoreGroups" ], "operationId": "CreateStoreGroup", "parameters": [ { "name": "appNameId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app name id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_StoreGroup_" }, "examples": { "CreateStoreGroup200Example": { "summary": "Default CreateStoreGroup 200 response", "x-microcks-default": true, "value": { "Data": { "StoreGroupId": 500123, "GeneralRating": 1.0, "GeneralRatingCount": 3, "DeliveryMenuMessage": "string", "PickupMenuMessage": "string", "BrandIds": [ "string" ], "Name": "Example Name", "Currency": "EUR" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateStoreGroup400Example": { "summary": "Default CreateStoreGroup 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": { "CreateStoreGroup401Example": { "summary": "Default CreateStoreGroup 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": { "CreateStoreGroup403Example": { "summary": "Default CreateStoreGroup 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": { "CreateStoreGroup500Example": { "summary": "Default CreateStoreGroup 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 Store Group", "description": "Create Store Group via the Flipdish Open API v1.0 (POST /api/v1.0/{appNameId}/storegroups).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appNameId}/storegroups/extended": { "get": { "tags": [ "StoreGroups" ], "operationId": "GetStoreGroupsExtended", "parameters": [ { "name": "appNameId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app name id path parameter.", "example": "500123" }, { "name": "searchQuery", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The search query 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 }, { "name": "groupingRadius", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The grouping radius query parameter.", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult_StoreGroupExtended_" }, "examples": { "GetStoreGroupsExtended200Example": { "summary": "Default GetStoreGroupsExtended 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": { "GetStoreGroupsExtended400Example": { "summary": "Default GetStoreGroupsExtended 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": { "GetStoreGroupsExtended401Example": { "summary": "Default GetStoreGroupsExtended 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": { "GetStoreGroupsExtended403Example": { "summary": "Default GetStoreGroupsExtended 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": { "GetStoreGroupsExtended500Example": { "summary": "Default GetStoreGroupsExtended 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 Store Groups Extended", "description": "Get Store Groups Extended via the Flipdish Open API v1.0 (GET /api/v1.0/{appNameId}/storegroups/extended).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/storegroups/{storeGroupId}/CustomerMessages": { "post": { "tags": [ "StoreGroups" ], "operationId": "SetCustomerMessages", "parameters": [ { "name": "storeGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store group id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessages" }, "examples": { "SetCustomerMessagesRequestExample": { "summary": "Default SetCustomerMessages request", "x-microcks-default": true, "value": { "DeliveryMenuMessage": "string", "PickupMenuMessage": "string" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetCustomerMessages400Example": { "summary": "Default SetCustomerMessages 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": { "SetCustomerMessages401Example": { "summary": "Default SetCustomerMessages 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": { "SetCustomerMessages403Example": { "summary": "Default SetCustomerMessages 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": { "SetCustomerMessages404Example": { "summary": "Default SetCustomerMessages 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": { "SetCustomerMessages500Example": { "summary": "Default SetCustomerMessages 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 Set Customer Messages", "description": "Set Customer Messages via the Flipdish Open API v1.0 (POST /api/v1.0/storegroups/{storeGroupId}/CustomerMessages).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/storegroups/{storeGroupId}/assignStores": { "post": { "tags": [ "StoreGroups" ], "operationId": "AssignStoresToStoreGroup", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store group id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "examples": { "AssignStoresToStoreGroupRequestExample": { "summary": "Default AssignStoresToStoreGroup request", "x-microcks-default": true, "value": [ 1 ] } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AssignStoresToStoreGroup400Example": { "summary": "Default AssignStoresToStoreGroup 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": { "AssignStoresToStoreGroup401Example": { "summary": "Default AssignStoresToStoreGroup 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": { "AssignStoresToStoreGroup403Example": { "summary": "Default AssignStoresToStoreGroup 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": { "AssignStoresToStoreGroup404Example": { "summary": "Default AssignStoresToStoreGroup 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AssignStoresToStoreGroup500Example": { "summary": "Default AssignStoresToStoreGroup 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 Assign Stores to Store Group", "description": "Assign Stores to Store Group via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/storegroups/{storeGroupId}/assignStores).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/storeordercapacity/{storeId}/{deliveryType}": { "get": { "tags": [ "StoreOrderCapacity" ], "operationId": "GetStoreOrderCapacity", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "deliveryType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Delivery", "Pickup" ] }, "description": "The delivery type path parameter.", "example": "Delivery" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_StoreOrderCapacityConfig_" }, "examples": { "GetStoreOrderCapacity200Example": { "summary": "Default GetStoreOrderCapacity 200 response", "x-microcks-default": true, "value": { "Data": { "StoreId": 500123, "DeliveryType": "Delivery", "StoreIntervalInMinutes": 1, "OrderCapacityPeriods": [] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreOrderCapacity400Example": { "summary": "Default GetStoreOrderCapacity 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": { "GetStoreOrderCapacity401Example": { "summary": "Default GetStoreOrderCapacity 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": { "GetStoreOrderCapacity403Example": { "summary": "Default GetStoreOrderCapacity 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": { "GetStoreOrderCapacity500Example": { "summary": "Default GetStoreOrderCapacity 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 Store Order Capacity", "description": "Get Store Order Capacity via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/storeordercapacity/{storeId}/{deliveryType}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/storeordercapacity/{storeId}": { "post": { "tags": [ "StoreOrderCapacity" ], "operationId": "UpdateStoreOrderCapacityConfig", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "deliveryType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "Delivery", "Pickup" ] }, "description": "The delivery type query parameter.", "example": "Delivery" }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreOrderCapacityConfigEditModel" }, "examples": { "UpdateStoreOrderCapacityConfigRequestExample": { "summary": "Default UpdateStoreOrderCapacityConfig request", "x-microcks-default": true, "value": { "OrderCapacityPeriods": [] } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateStoreOrderCapacityConfig400Example": { "summary": "Default UpdateStoreOrderCapacityConfig 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": { "UpdateStoreOrderCapacityConfig401Example": { "summary": "Default UpdateStoreOrderCapacityConfig 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": { "UpdateStoreOrderCapacityConfig403Example": { "summary": "Default UpdateStoreOrderCapacityConfig 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": { "UpdateStoreOrderCapacityConfig404Example": { "summary": "Default UpdateStoreOrderCapacityConfig 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": { "UpdateStoreOrderCapacityConfig500Example": { "summary": "Default UpdateStoreOrderCapacityConfig 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 Store Order Capacity Config", "description": "Update Store Order Capacity Config via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/storeordercapacity/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}": { "get": { "tags": [ "Stores" ], "operationId": "GetStoreById", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Store_" }, "examples": { "GetStoreById200Example": { "summary": "Default GetStoreById 200 response", "x-microcks-default": true, "value": { "Data": { "StoreId": 500123, "StoreGroupId": 500123, "Address": { "AddressId": 500123, "Coordinates": {}, "Line1": "string", "Postcode": "string", "City": "string", "CountryCode": "IE", "DisplayForCustomer": "string", "AddressFields": {}, "SingleLineDisplay": "string", "TwoLinesDisplay": [ "string" ] }, "DeliveryZones": [], "ApmPhoneNumber": "+353000000000", "PickupHours": [], "DeliveryHours": [], "MenuId": 500123, "OrderConfirmationMessageOverrideDelivery": "string", "OrderConfirmationMessageOverridePickup": "string", "PrintoutLayoutType": "Default", "StoreNotes": [], "MicrosoftTimeZone": "string", "IanaTimeZone": "string", "Currency": "EUR", "PreOrderDeliveryEnabled": true, "PreOrderPickupEnabled": true, "LogoUrl": "https://api.flipdish.co/example", "FraudPreventionStrategy": "string", "AppIds": [ "string" ], "PropertyId": "500123", "PhoneNumber": "+353000000000", "AlwaysAppearOpen": true, "PreOrderEnabled": true, "TakeOutEnabled": true, "TableServiceEnabled": true, "DineInEnabled": true, "AllowPreOrdersAndTableService": true, "PickupEnabled": true, "DeliveryEnabled": true, "CardOrderDeliveryEnabled": true, "CashOrdersDeliveryEnabled": true, "CardOrdersPickupEnabled": true, "CashOrdersPickupEnabled": true, "TipsEnabled": true, "AutomaticallyAcceptOrders": true, "OpenForDelivery": true, "OpenForPickup": true, "MinimumPickupOrderAmount": 12.5, "RequireCustomerNameForPickup": true, "GdprCustomerPhoneNumbers": true, "RequireCustomerNameForDelivery": true, "AllowChefNotes": true, "EtaInPickupConfirmationSmsEnabled": true, "EtaInDeliveryConfirmationSmsEnabled": true, "IsArchived": true, "IsPublished": true, "Name": "Example Name", "EmailAddress": "owner@example.com", "StaffLanguage": "string", "SalesChannelTypes": [ "Web" ], "InheritanceConfigTypes": [ "CollectionSettings" ] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreById400Example": { "summary": "Default GetStoreById 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": { "GetStoreById401Example": { "summary": "Default GetStoreById 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": { "GetStoreById403Example": { "summary": "Default GetStoreById 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": { "GetStoreById404Example": { "summary": "Default GetStoreById 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": { "GetStoreById500Example": { "summary": "Default GetStoreById 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 Store by Id", "description": "Get Store by Id via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Stores" ], "operationId": "UpdateStore", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreBase" }, "examples": { "UpdateStoreRequestExample": { "summary": "Default UpdateStore request", "x-microcks-default": true, "value": { "PhoneNumber": "+353000000000", "AlwaysAppearOpen": true, "PreOrderEnabled": true, "TakeOutEnabled": true, "TableServiceEnabled": true, "DineInEnabled": true, "AllowPreOrdersAndTableService": true, "PickupEnabled": true, "DeliveryEnabled": true, "CardOrderDeliveryEnabled": true, "CashOrdersDeliveryEnabled": true, "CardOrdersPickupEnabled": true, "CashOrdersPickupEnabled": true, "TipsEnabled": true, "AutomaticallyAcceptOrders": true, "OpenForDelivery": true, "OpenForPickup": true, "MinimumPickupOrderAmount": 12.5, "RequireCustomerNameForPickup": true, "GdprCustomerPhoneNumbers": true, "RequireCustomerNameForDelivery": true, "AllowChefNotes": true, "EtaInPickupConfirmationSmsEnabled": true, "EtaInDeliveryConfirmationSmsEnabled": true, "IsArchived": true, "IsPublished": true, "Name": "Example Name", "EmailAddress": "owner@example.com", "StaffLanguage": "string", "SalesChannelTypes": [ "Web" ], "InheritanceConfigTypes": [ "CollectionSettings" ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Store_" }, "examples": { "UpdateStore200Example": { "summary": "Default UpdateStore 200 response", "x-microcks-default": true, "value": { "Data": { "StoreId": 500123, "StoreGroupId": 500123, "Address": { "AddressId": 500123, "Coordinates": {}, "Line1": "string", "Postcode": "string", "City": "string", "CountryCode": "IE", "DisplayForCustomer": "string", "AddressFields": {}, "SingleLineDisplay": "string", "TwoLinesDisplay": [ "string" ] }, "DeliveryZones": [], "ApmPhoneNumber": "+353000000000", "PickupHours": [], "DeliveryHours": [], "MenuId": 500123, "OrderConfirmationMessageOverrideDelivery": "string", "OrderConfirmationMessageOverridePickup": "string", "PrintoutLayoutType": "Default", "StoreNotes": [], "MicrosoftTimeZone": "string", "IanaTimeZone": "string", "Currency": "EUR", "PreOrderDeliveryEnabled": true, "PreOrderPickupEnabled": true, "LogoUrl": "https://api.flipdish.co/example", "FraudPreventionStrategy": "string", "AppIds": [ "string" ], "PropertyId": "500123", "PhoneNumber": "+353000000000", "AlwaysAppearOpen": true, "PreOrderEnabled": true, "TakeOutEnabled": true, "TableServiceEnabled": true, "DineInEnabled": true, "AllowPreOrdersAndTableService": true, "PickupEnabled": true, "DeliveryEnabled": true, "CardOrderDeliveryEnabled": true, "CashOrdersDeliveryEnabled": true, "CardOrdersPickupEnabled": true, "CashOrdersPickupEnabled": true, "TipsEnabled": true, "AutomaticallyAcceptOrders": true, "OpenForDelivery": true, "OpenForPickup": true, "MinimumPickupOrderAmount": 12.5, "RequireCustomerNameForPickup": true, "GdprCustomerPhoneNumbers": true, "RequireCustomerNameForDelivery": true, "AllowChefNotes": true, "EtaInPickupConfirmationSmsEnabled": true, "EtaInDeliveryConfirmationSmsEnabled": true, "IsArchived": true, "IsPublished": true, "Name": "Example Name", "EmailAddress": "owner@example.com", "StaffLanguage": "string", "SalesChannelTypes": [ "Web" ], "InheritanceConfigTypes": [ "CollectionSettings" ] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateStore400Example": { "summary": "Default UpdateStore 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": { "UpdateStore401Example": { "summary": "Default UpdateStore 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": { "UpdateStore403Example": { "summary": "Default UpdateStore 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": { "UpdateStore404Example": { "summary": "Default UpdateStore 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateStore409Example": { "summary": "Default UpdateStore 409 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateStore500Example": { "summary": "Default UpdateStore 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 Store", "description": "Update Store via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/feeConfig": { "get": { "tags": [ "Stores" ], "operationId": "GetStoreFeeConfig", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreFeeConfig" }, "examples": { "GetStoreFeeConfig200Example": { "summary": "Default GetStoreFeeConfig 200 response", "x-microcks-default": true, "value": { "FeeConfigId": 500123, "StoreId": 500123, "StartTime": "2026-06-02T12:00:00Z", "PercentFeeCardOrders": 12.5, "PercentFeeCashOrders": 12.5, "PercentFeeCardOrdersWeb": 12.5, "PercentFeeCashOrdersWeb": 12.5, "PercentFeeCardOrdersKiosk": 12.5, "PercentFeeCashOrdersKiosk": 12.5, "FixedFeeCardOrdersKiosk": 12.5, "FixedFeeCashOrdersKiosk": 12.5, "PercentFeeCardOrdersKioskChargedToCustomerIncludingVat": 12.5, "FixedFeeCardOrdersKioskChargedToCustomerIncludingVat": 12.5, "PercentFeeCashOrdersKioskChargedToCustomerIncludingVat": 12.5, "FixedFeeCashOrdersKioskChargedToCustomerIncludingVat": 12.5, "FixedFeeCardOrders": 12.5, "FixedFeeCashOrders": 12.5, "PercentFeeCardOrdersChargedToCustomerIncludingVat": 12.5, "FixedFeeCardOrdersChargedToCustomerIncludingVat": 12.5, "PercentFeeCashOrdersChargedToCustomerIncludingVat": 12.5, "FixedFeeCashOrdersChargedToCustomerIncludingVat": 12.5, "PercentFeeTips": 12.5, "PercentFeeTipsCollection": 12.5, "PercentFeeTipsDelivery": 12.5, "TaxRatePercent": 1.0, "PercentFeeCardOrdersLocationService": 12.5, "PercentFeeCashOrdersLocationService": 12.5, "FixedFeeCardOrdersLocationService": 12.5, "FixedFeeCashOrdersLocationService": 12.5, "PercentFeeCardOrdersLocationServiceChargedToCustomerIncludingVat": 12.5, "PercentFeeCashOrdersLocationServiceChargedToCustomerIncludingVat": 12.5, "FixedFeeCardOrdersLocationServiceChargedToCustomerIncludingVat": 12.5, "FixedFeeCashOrdersLocationServiceChargedToCustomerIncludingVat": 12.5, "PercentFeeCardOrdersIngest": 12.5, "PercentFeeCashOrdersIngest": 12.5, "FixedFeeCardOrdersIngest": 12.5, "FixedFeeCashOrdersIngest": 12.5, "PercentFeeDelivery": 12.5, "FixedFeeDelivery": 12.5, "PercentFeeCardPosTransaction": 12.5, "FixedFeeCardPosTransaction": 12.5, "PercentFeeOrderWithGoogle": 12.5, "FixedFeeOrderWithGoogle": 12.5, "ShouldNotAutoIncreaseBefore": "2026-06-02T12:00:00Z", "Reason": "string", "PercentFeeCardOrdersPhoneAgent": 12.5, "PercentFeeCashOrdersPhoneAgent": 12.5, "FixedFeeCardOrdersPhoneAgent": 12.5, "FixedFeeCashOrdersPhoneAgent": 12.5, "PercentFeeCardOrdersPhoneAgentChargedToCustomerIncludingVat": 12.5, "PercentFeeCashOrdersPhoneAgentChargedToCustomerIncludingVat": 12.5, "FixedFeeCardOrdersPhoneAgentChargedToCustomerIncludingVat": 12.5, "FixedFeeCashOrdersPhoneAgentChargedToCustomerIncludingVat": 12.5 } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreFeeConfig400Example": { "summary": "Default GetStoreFeeConfig 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": { "GetStoreFeeConfig401Example": { "summary": "Default GetStoreFeeConfig 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": { "GetStoreFeeConfig403Example": { "summary": "Default GetStoreFeeConfig 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": { "GetStoreFeeConfig404Example": { "summary": "Default GetStoreFeeConfig 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": { "GetStoreFeeConfig500Example": { "summary": "Default GetStoreFeeConfig 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 Store Fee Config", "description": "Get Store Fee Config via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/feeConfig).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/leadTimes": { "get": { "tags": [ "Stores" ], "operationId": "GetStoreLeadTimes", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_OrderLeadTimes_" }, "examples": { "GetStoreLeadTimes200Example": { "summary": "Default GetStoreLeadTimes 200 response", "x-microcks-default": true, "value": { "Data": { "LeadTimeMinutes": {} } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreLeadTimes400Example": { "summary": "Default GetStoreLeadTimes 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": { "GetStoreLeadTimes401Example": { "summary": "Default GetStoreLeadTimes 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": { "GetStoreLeadTimes403Example": { "summary": "Default GetStoreLeadTimes 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": { "GetStoreLeadTimes404Example": { "summary": "Default GetStoreLeadTimes 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": { "GetStoreLeadTimes500Example": { "summary": "Default GetStoreLeadTimes 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 Store Lead Times", "description": "Get Store Lead Times via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/leadTimes).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Stores" ], "operationId": "SetStoreLeadTimes", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadTime" }, "examples": { "SetStoreLeadTimesRequestExample": { "summary": "Default SetStoreLeadTimes request", "x-microcks-default": true, "value": { "DispatchType": "string", "LeadTimeMinutes": 1 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_OrderLeadTimes_" }, "examples": { "SetStoreLeadTimes200Example": { "summary": "Default SetStoreLeadTimes 200 response", "x-microcks-default": true, "value": { "Data": { "LeadTimeMinutes": {} } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetStoreLeadTimes400Example": { "summary": "Default SetStoreLeadTimes 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": { "SetStoreLeadTimes401Example": { "summary": "Default SetStoreLeadTimes 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": { "SetStoreLeadTimes403Example": { "summary": "Default SetStoreLeadTimes 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": { "SetStoreLeadTimes404Example": { "summary": "Default SetStoreLeadTimes 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": { "SetStoreLeadTimes500Example": { "summary": "Default SetStoreLeadTimes 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 Set Store Lead Times", "description": "Set Store Lead Times via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/leadTimes).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/bankaccount": { "get": { "tags": [ "Stores" ], "operationId": "GetBankAccountForStore", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AssignedBankAccount_" }, "examples": { "GetBankAccountForStore200Example": { "summary": "Default GetBankAccountForStore 200 response", "x-microcks-default": true, "value": { "Data": { "Id": 500123, "BankAccountName": "Example Name" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetBankAccountForStore400Example": { "summary": "Default GetBankAccountForStore 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": { "GetBankAccountForStore401Example": { "summary": "Default GetBankAccountForStore 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": { "GetBankAccountForStore403Example": { "summary": "Default GetBankAccountForStore 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": { "GetBankAccountForStore500Example": { "summary": "Default GetBankAccountForStore 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 Bank Account for Store", "description": "Get Bank Account for Store via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/bankaccount).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/servicecharge": { "get": { "tags": [ "Stores" ], "operationId": "GetStoreServiceCharge", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceCharge" }, "examples": { "GetStoreServiceCharge200Example": { "summary": "Default GetStoreServiceCharge 200 response", "x-microcks-default": true, "value": { "StoreId": 500123, "PercentageValue": 1.0, "Enabled": true, "IsOptional": true, "DisplayWithProcessingFee": true, "IncludesVouchers": true } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreServiceCharge400Example": { "summary": "Default GetStoreServiceCharge 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": { "GetStoreServiceCharge401Example": { "summary": "Default GetStoreServiceCharge 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": { "GetStoreServiceCharge403Example": { "summary": "Default GetStoreServiceCharge 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": { "GetStoreServiceCharge404Example": { "summary": "Default GetStoreServiceCharge 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": { "GetStoreServiceCharge500Example": { "summary": "Default GetStoreServiceCharge 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 Store Service Charge", "description": "Get Store Service Charge via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/servicecharge).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Stores" ], "operationId": "ConfigureStoreServiceCharge", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceCharge" }, "examples": { "ConfigureStoreServiceChargeRequestExample": { "summary": "Default ConfigureStoreServiceCharge request", "x-microcks-default": true, "value": { "StoreId": 500123, "PercentageValue": 1.0, "Enabled": true, "IsOptional": true, "DisplayWithProcessingFee": true, "IncludesVouchers": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_ServiceCharge_" }, "examples": { "ConfigureStoreServiceCharge200Example": { "summary": "Default ConfigureStoreServiceCharge 200 response", "x-microcks-default": true, "value": { "Data": { "StoreId": 500123, "PercentageValue": 1.0, "Enabled": true, "IsOptional": true, "DisplayWithProcessingFee": true, "IncludesVouchers": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ConfigureStoreServiceCharge400Example": { "summary": "Default ConfigureStoreServiceCharge 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": { "ConfigureStoreServiceCharge401Example": { "summary": "Default ConfigureStoreServiceCharge 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": { "ConfigureStoreServiceCharge403Example": { "summary": "Default ConfigureStoreServiceCharge 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ConfigureStoreServiceCharge500Example": { "summary": "Default ConfigureStoreServiceCharge 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 Configure Store Service Charge", "description": "Configure Store Service Charge via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/servicecharge).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/feeConfig/deliveryZones": { "get": { "tags": [ "Stores" ], "operationId": "GetStoreDeliveryFeeConfig", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_StoreDeliveryZoneFeeConfig_" }, "examples": { "GetStoreDeliveryFeeConfig200Example": { "summary": "Default GetStoreDeliveryFeeConfig 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreDeliveryFeeConfig400Example": { "summary": "Default GetStoreDeliveryFeeConfig 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreDeliveryFeeConfig401Example": { "summary": "Default GetStoreDeliveryFeeConfig 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": { "GetStoreDeliveryFeeConfig403Example": { "summary": "Default GetStoreDeliveryFeeConfig 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": { "GetStoreDeliveryFeeConfig500Example": { "summary": "Default GetStoreDeliveryFeeConfig 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 Store Delivery Fee Config", "description": "Get Store Delivery Fee Config via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/feeConfig/deliveryZones).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "put": { "tags": [ "Stores" ], "operationId": "PutStoreDeliveryFeeConfig", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreDeliveryZoneFeeConfigUpdateRequest" }, "examples": { "PutStoreDeliveryFeeConfigRequestExample": { "summary": "Default PutStoreDeliveryFeeConfig request", "x-microcks-default": true, "value": { "DeliveryZoneFees": [] } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "PutStoreDeliveryFeeConfig400Example": { "summary": "Default PutStoreDeliveryFeeConfig 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "PutStoreDeliveryFeeConfig401Example": { "summary": "Default PutStoreDeliveryFeeConfig 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": { "PutStoreDeliveryFeeConfig403Example": { "summary": "Default PutStoreDeliveryFeeConfig 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": { "PutStoreDeliveryFeeConfig500Example": { "summary": "Default PutStoreDeliveryFeeConfig 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 Put Store Delivery Fee Config", "description": "Put Store Delivery Fee Config via the Flipdish Open API v1.0 (PUT /api/v1.0/stores/{storeId}/feeConfig/deliveryZones).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/endofdayreport": { "get": { "tags": [ "Stores" ], "operationId": "GetEndOfDayReport", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "The date query parameter.", "example": "2026-06-02T12:00:00Z" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_StoreEndOfDayReport_" }, "examples": { "GetEndOfDayReport200Example": { "summary": "Default GetEndOfDayReport 200 response", "x-microcks-default": true, "value": { "Data": { "StoreId": 500123, "StoreName": "Example Name", "Currency": "EUR", "OrderCount": 3, "OrderValue": 1.0, "OrderValueExcludingDeliveryFees": 12.5, "CollectionOrderCount": 3, "CollectionCashOrderCount": 3, "CollectionPaidOnlineOrderCount": 3, "CollectionOrderValue": 1.0, "CollectionCashOrderValue": 1.0, "CollectionPaidOnlineOrderValue": 1.0, "DeliveryOrderCount": 3, "DeliveryCashOrderCount": 3, "DeliveryPaidOnlineOrderCount": 3, "DeliveryOrderValue": 1.0, "DeliveryCashOrderValue": 1.0, "DeliveryPaidOnlineOrderValue": 1.0, "PaidOnlineOrderCount": 3, "CashOrderCount": 3, "PaidOnlineOrderValue": 1.0, "CashOrderValue": 1.0, "PaidOnlineOrderValueExcludingDeliveryFees": 12.5, "CashOrderValueExcludingDeliveryFees": 12.5, "StartTime": "2026-06-02T12:00:00Z", "EndTime": "2026-06-02T12:00:00Z" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetEndOfDayReport400Example": { "summary": "Default GetEndOfDayReport 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": { "GetEndOfDayReport401Example": { "summary": "Default GetEndOfDayReport 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": { "GetEndOfDayReport403Example": { "summary": "Default GetEndOfDayReport 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": { "GetEndOfDayReport404Example": { "summary": "Default GetEndOfDayReport 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": { "GetEndOfDayReport500Example": { "summary": "Default GetEndOfDayReport 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 End of Day Report", "description": "Get End of Day Report via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/endofdayreport).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/availability/{deliveryType}": { "get": { "tags": [ "Stores" ], "operationId": "GetBusinessHours", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "deliveryType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Delivery", "Pickup" ] }, "description": "The delivery type path parameter.", "example": "Delivery" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_BusinessHoursPeriod_" }, "examples": { "GetBusinessHours200Example": { "summary": "Default GetBusinessHours 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetBusinessHours400Example": { "summary": "Default GetBusinessHours 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": { "GetBusinessHours401Example": { "summary": "Default GetBusinessHours 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": { "GetBusinessHours403Example": { "summary": "Default GetBusinessHours 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": { "GetBusinessHours500Example": { "summary": "Default GetBusinessHours 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 Business Hours", "description": "Get Business Hours via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/availability/{deliveryType}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Stores" ], "operationId": "SetBusinessHours", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "deliveryType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Delivery", "Pickup" ] }, "description": "The delivery type path parameter.", "example": "Delivery" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessHoursPeriodBase" }, "examples": { "SetBusinessHoursRequestExample": { "summary": "Default SetBusinessHours request", "x-microcks-default": true, "value": { "DayOfWeek": "Sunday", "StartTime": "2026-06-02T12:00:00Z", "Period": "string", "StartTimeEarly": "string", "PeriodEarly": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_BusinessHoursPeriod_" }, "examples": { "SetBusinessHours200Example": { "summary": "Default SetBusinessHours 200 response", "x-microcks-default": true, "value": { "Data": { "Early": { "StartTime": "2026-06-02T12:00:00Z", "Period": "string", "DayOfWeek": "Sunday" }, "Late": { "StartTime": "2026-06-02T12:00:00Z", "Period": "string", "DayOfWeek": "Sunday" }, "Ranges": [], "DayOfWeek": "Sunday", "StartTime": "2026-06-02T12:00:00Z", "Period": "string", "StartTimeEarly": "string", "PeriodEarly": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetBusinessHours400Example": { "summary": "Default SetBusinessHours 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": { "SetBusinessHours401Example": { "summary": "Default SetBusinessHours 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": { "SetBusinessHours403Example": { "summary": "Default SetBusinessHours 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetBusinessHours500Example": { "summary": "Default SetBusinessHours 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 Set Business Hours", "description": "Set Business Hours via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/availability/{deliveryType}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}": { "get": { "tags": [ "Stores" ], "operationId": "GetPreOrderConfig", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "deliveryType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Delivery", "Pickup" ] }, "description": "The delivery type path parameter.", "example": "Delivery" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_PreOrderConfig_" }, "examples": { "GetPreOrderConfig200Example": { "summary": "Default GetPreOrderConfig 200 response", "x-microcks-default": true, "value": { "Data": { "LeadTimeMinutes": 1, "IntervalMinutes": 1, "MaxOrderAheadDays": 1, "IncludeAsap": true, "IncludeMoreGranularInitialTime": true, "CutOffTimePreviousDayBasic": "string", "CutOffTimeCurrentDayBasic": "string", "PreOrderTimeDisplayType": "SingleTime", "AlwaysAppearOpen": true, "RequireExplicitSelectAlways": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPreOrderConfig400Example": { "summary": "Default GetPreOrderConfig 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": { "GetPreOrderConfig401Example": { "summary": "Default GetPreOrderConfig 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": { "GetPreOrderConfig403Example": { "summary": "Default GetPreOrderConfig 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": { "GetPreOrderConfig404Example": { "summary": "Default GetPreOrderConfig 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": { "GetPreOrderConfig500Example": { "summary": "Default GetPreOrderConfig 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 Pre Order Config", "description": "Get Pre Order Config via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Stores" ], "operationId": "UpdatePreOrderConfig", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "deliveryType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Delivery", "Pickup" ] }, "description": "The delivery type path parameter.", "example": "Delivery" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreOrderConfig" }, "examples": { "UpdatePreOrderConfigRequestExample": { "summary": "Default UpdatePreOrderConfig request", "x-microcks-default": true, "value": { "LeadTimeMinutes": 1, "IntervalMinutes": 1, "MaxOrderAheadDays": 1, "IncludeAsap": true, "IncludeMoreGranularInitialTime": true, "CutOffTimePreviousDayBasic": "string", "CutOffTimeCurrentDayBasic": "string", "PreOrderTimeDisplayType": "SingleTime", "AlwaysAppearOpen": true, "RequireExplicitSelectAlways": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_RestApiDefaultResponse_" }, "examples": { "UpdatePreOrderConfig200Example": { "summary": "Default UpdatePreOrderConfig 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdatePreOrderConfig400Example": { "summary": "Default UpdatePreOrderConfig 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": { "UpdatePreOrderConfig401Example": { "summary": "Default UpdatePreOrderConfig 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": { "UpdatePreOrderConfig403Example": { "summary": "Default UpdatePreOrderConfig 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": { "UpdatePreOrderConfig500Example": { "summary": "Default UpdatePreOrderConfig 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 Pre Order Config", "description": "Update Pre Order Config via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}/preview": { "get": { "tags": [ "Stores" ], "operationId": "GetPreOrderPreview", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "deliveryType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Delivery", "Pickup" ] }, "description": "The delivery type path parameter.", "example": "Delivery" }, { "name": "preOrderConfig.leadTimeMinutes", "in": "query", "description": "Lead Time in Minutes", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "preOrderConfig.intervalMinutes", "in": "query", "description": "Interval in minutes", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "preOrderConfig.maxOrderAheadDays", "in": "query", "description": "Max Days to order ahead", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "preOrderConfig.includeAsap", "in": "query", "description": "Show ASAP as option", "required": false, "schema": { "type": "boolean" }, "example": true }, { "name": "preOrderConfig.includeMoreGranularInitialTime", "in": "query", "description": "Granual Init' Time", "required": false, "schema": { "type": "boolean" }, "example": true }, { "name": "preOrderConfig.cutOffTimePreviousDayBasic", "in": "query", "description": "Cut off time previous day", "required": false, "x-nullable": true, "schema": { "type": "string" }, "example": "string" }, { "name": "preOrderConfig.cutOffTimeCurrentDayBasic", "in": "query", "description": "Cut off time current day", "required": false, "x-nullable": true, "schema": { "type": "string" }, "example": "string" }, { "name": "preOrderConfig.preOrderTimeDisplayType", "in": "query", "description": "Type of time displayed.", "required": false, "schema": { "type": "string", "enum": [ "SingleTime", "StartAndEndTime", "DayOnly" ] }, "example": "SingleTime" }, { "name": "preOrderConfig.alwaysAppearOpen", "in": "query", "description": "Specifies whether a customer can pre-order outside the store opening hours or not.", "required": false, "schema": { "type": "boolean" }, "example": true }, { "name": "preOrderConfig.requireExplicitSelectAlways", "in": "query", "description": "Force customer to select collection time.", "required": false, "schema": { "type": "boolean" }, "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_PreOrderTime_" }, "examples": { "GetPreOrderPreview200Example": { "summary": "Default GetPreOrderPreview 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPreOrderPreview400Example": { "summary": "Default GetPreOrderPreview 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": { "GetPreOrderPreview401Example": { "summary": "Default GetPreOrderPreview 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": { "GetPreOrderPreview403Example": { "summary": "Default GetPreOrderPreview 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": { "GetPreOrderPreview500Example": { "summary": "Default GetPreOrderPreview 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 Pre Order Preview", "description": "Get Pre Order Preview via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}/preview).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/processingfeeconfigs": { "get": { "tags": [ "Stores" ], "operationId": "GetProcessingFeeConfigsByStoreId", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "appNameId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The app name id query parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_ProcessingFeeConfig_" }, "examples": { "GetProcessingFeeConfigsByStoreId200Example": { "summary": "Default GetProcessingFeeConfigsByStoreId 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetProcessingFeeConfigsByStoreId400Example": { "summary": "Default GetProcessingFeeConfigsByStoreId 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": { "GetProcessingFeeConfigsByStoreId401Example": { "summary": "Default GetProcessingFeeConfigsByStoreId 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": { "GetProcessingFeeConfigsByStoreId403Example": { "summary": "Default GetProcessingFeeConfigsByStoreId 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": { "GetProcessingFeeConfigsByStoreId500Example": { "summary": "Default GetProcessingFeeConfigsByStoreId 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 Processing Fee Configs by Store Id", "description": "Get Processing Fee Configs by Store Id via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/processingfeeconfigs).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/stores/stats": { "get": { "tags": [ "Stores" ], "operationId": "GetStoreNetSales", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "query", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "description": "The store id query parameter.", "example": [ 500123 ] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_StoreStatistics_" }, "examples": { "GetStoreNetSales200Example": { "summary": "Default GetStoreNetSales 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreNetSales400Example": { "summary": "Default GetStoreNetSales 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": { "GetStoreNetSales401Example": { "summary": "Default GetStoreNetSales 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": { "GetStoreNetSales403Example": { "summary": "Default GetStoreNetSales 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": { "GetStoreNetSales500Example": { "summary": "Default GetStoreNetSales 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 Store Net Sales", "description": "Get Store Net Sales via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/stores/stats).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/businesshoursoverrides": { "get": { "tags": [ "Stores" ], "operationId": "GetBusinessHoursOverrideByStoreId", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "The after query parameter.", "example": "2026-06-02T12:00:00Z" }, { "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_BusinessHoursOverride_" }, "examples": { "GetBusinessHoursOverrideByStoreId200Example": { "summary": "Default GetBusinessHoursOverrideByStoreId 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": { "GetBusinessHoursOverrideByStoreId400Example": { "summary": "Default GetBusinessHoursOverrideByStoreId 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": { "GetBusinessHoursOverrideByStoreId401Example": { "summary": "Default GetBusinessHoursOverrideByStoreId 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": { "GetBusinessHoursOverrideByStoreId403Example": { "summary": "Default GetBusinessHoursOverrideByStoreId 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": { "GetBusinessHoursOverrideByStoreId404Example": { "summary": "Default GetBusinessHoursOverrideByStoreId 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": { "GetBusinessHoursOverrideByStoreId500Example": { "summary": "Default GetBusinessHoursOverrideByStoreId 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 Business Hours Override by Store Id", "description": "Get Business Hours Override by Store Id via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/businesshoursoverrides).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Stores" ], "operationId": "CreateBusinessHoursOverrideByStoreId", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessHoursOverrideBase" }, "examples": { "CreateBusinessHoursOverrideByStoreIdRequestExample": { "summary": "Default CreateBusinessHoursOverrideByStoreId request", "x-microcks-default": true, "value": { "DeliveryType": "Delivery", "StartTime": "2026-06-02T12:00:00Z", "EndTime": "2026-06-02T12:00:00Z", "Type": "Open" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_BusinessHoursOverride_" }, "examples": { "CreateBusinessHoursOverrideByStoreId200Example": { "summary": "Default CreateBusinessHoursOverrideByStoreId 200 response", "x-microcks-default": true, "value": { "Data": { "BusinessHoursOverrideId": 500123, "DeliveryType": "Delivery", "StartTime": "2026-06-02T12:00:00Z", "EndTime": "2026-06-02T12:00:00Z", "Type": "Open" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateBusinessHoursOverrideByStoreId400Example": { "summary": "Default CreateBusinessHoursOverrideByStoreId 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": { "CreateBusinessHoursOverrideByStoreId401Example": { "summary": "Default CreateBusinessHoursOverrideByStoreId 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": { "CreateBusinessHoursOverrideByStoreId403Example": { "summary": "Default CreateBusinessHoursOverrideByStoreId 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": { "CreateBusinessHoursOverrideByStoreId404Example": { "summary": "Default CreateBusinessHoursOverrideByStoreId 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": { "CreateBusinessHoursOverrideByStoreId500Example": { "summary": "Default CreateBusinessHoursOverrideByStoreId 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 Business Hours Override by Store Id", "description": "Create Business Hours Override by Store Id via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/businesshoursoverrides).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/processingfeeconfigs/{paymentAccountType}": { "get": { "tags": [ "Stores" ], "operationId": "GetProcessingFeeConfigsByStoreIdAndPaymentAccountType", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "paymentAccountType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Card", "Cash", "Ideal", "Bancontact", "Giropay", "Eps", "Emv", "PayPal", "PayGreen", "GoogleWalletToken" ] }, "description": "The payment account type path parameter.", "example": "Card" }, { "name": "appNameId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The app name id query parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_ProcessingFeeConfig_" }, "examples": { "GetProcessingFeeConfigsByStoreIdAndPaymentAccountType200Example": { "summary": "Default GetProcessingFeeConfigsByStoreIdAndPaymentAccountType 200 response", "x-microcks-default": true, "value": { "Data": { "StoreId": 500123, "PaymentAccountType": "Card", "PercentFee": 12.5, "FixedFee": 12.5 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetProcessingFeeConfigsByStoreIdAndPaymentAccountType400Example": { "summary": "Default GetProcessingFeeConfigsByStoreIdAndPaymentAccountType 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": { "GetProcessingFeeConfigsByStoreIdAndPaymentAccountType401Example": { "summary": "Default GetProcessingFeeConfigsByStoreIdAndPaymentAccountType 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": { "GetProcessingFeeConfigsByStoreIdAndPaymentAccountType403Example": { "summary": "Default GetProcessingFeeConfigsByStoreIdAndPaymentAccountType 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": { "GetProcessingFeeConfigsByStoreIdAndPaymentAccountType500Example": { "summary": "Default GetProcessingFeeConfigsByStoreIdAndPaymentAccountType 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 Processing Fee Configs by Store Id and Payment Account Type", "description": "Get Processing Fee Configs by Store Id and Payment Account Type via the Flipdish Open API v1.0 (GET /api/v1.0/stores/{storeId}/processingfeeconfigs/{paymentAccountType}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores": { "get": { "tags": [ "Stores" ], "operationId": "GetStores", "parameters": [ { "name": "searchQuery", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The search query 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 }, { "name": "storeGroupId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The store group id query parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult_Store_" }, "examples": { "GetStores200Example": { "summary": "Default GetStores 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": { "GetStores400Example": { "summary": "Default GetStores 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": { "GetStores401Example": { "summary": "Default GetStores 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": { "GetStores403Example": { "summary": "Default GetStores 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": { "GetStores500Example": { "summary": "Default GetStores 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 Stores", "description": "Get Stores via the Flipdish Open API v1.0 (GET /api/v1.0/stores).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Stores" ], "operationId": "CreateStore", "parameters": [ { "name": "storeGroupId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store group id query parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Store_" }, "examples": { "CreateStore200Example": { "summary": "Default CreateStore 200 response", "x-microcks-default": true, "value": { "Data": { "StoreId": 500123, "StoreGroupId": 500123, "Address": { "AddressId": 500123, "Coordinates": {}, "Line1": "string", "Postcode": "string", "City": "string", "CountryCode": "IE", "DisplayForCustomer": "string", "AddressFields": {}, "SingleLineDisplay": "string", "TwoLinesDisplay": [ "string" ] }, "DeliveryZones": [], "ApmPhoneNumber": "+353000000000", "PickupHours": [], "DeliveryHours": [], "MenuId": 500123, "OrderConfirmationMessageOverrideDelivery": "string", "OrderConfirmationMessageOverridePickup": "string", "PrintoutLayoutType": "Default", "StoreNotes": [], "MicrosoftTimeZone": "string", "IanaTimeZone": "string", "Currency": "EUR", "PreOrderDeliveryEnabled": true, "PreOrderPickupEnabled": true, "LogoUrl": "https://api.flipdish.co/example", "FraudPreventionStrategy": "string", "AppIds": [ "string" ], "PropertyId": "500123", "PhoneNumber": "+353000000000", "AlwaysAppearOpen": true, "PreOrderEnabled": true, "TakeOutEnabled": true, "TableServiceEnabled": true, "DineInEnabled": true, "AllowPreOrdersAndTableService": true, "PickupEnabled": true, "DeliveryEnabled": true, "CardOrderDeliveryEnabled": true, "CashOrdersDeliveryEnabled": true, "CardOrdersPickupEnabled": true, "CashOrdersPickupEnabled": true, "TipsEnabled": true, "AutomaticallyAcceptOrders": true, "OpenForDelivery": true, "OpenForPickup": true, "MinimumPickupOrderAmount": 12.5, "RequireCustomerNameForPickup": true, "GdprCustomerPhoneNumbers": true, "RequireCustomerNameForDelivery": true, "AllowChefNotes": true, "EtaInPickupConfirmationSmsEnabled": true, "EtaInDeliveryConfirmationSmsEnabled": true, "IsArchived": true, "IsPublished": true, "Name": "Example Name", "EmailAddress": "owner@example.com", "StaffLanguage": "string", "SalesChannelTypes": [ "Web" ], "InheritanceConfigTypes": [ "CollectionSettings" ] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateStore400Example": { "summary": "Default CreateStore 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": { "CreateStore401Example": { "summary": "Default CreateStore 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": { "CreateStore403Example": { "summary": "Default CreateStore 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": { "CreateStore404Example": { "summary": "Default CreateStore 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": { "CreateStore500Example": { "summary": "Default CreateStore 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 Store", "description": "Create Store via the Flipdish Open API v1.0 (POST /api/v1.0/stores).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/storevalidation/kiosk": { "get": { "tags": [ "Stores" ], "operationId": "GetStoresByStoreIdWithValidations", "parameters": [ { "name": "storeId", "in": "query", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "description": "The store id query parameter.", "example": [ 500123 ] }, { "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 }, { "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/RestApiPaginationResult_StoreValidationConfig_" }, "examples": { "GetStoresByStoreIdWithValidations200Example": { "summary": "Default GetStoresByStoreIdWithValidations 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": { "GetStoresByStoreIdWithValidations400Example": { "summary": "Default GetStoresByStoreIdWithValidations 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": { "GetStoresByStoreIdWithValidations401Example": { "summary": "Default GetStoresByStoreIdWithValidations 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": { "GetStoresByStoreIdWithValidations403Example": { "summary": "Default GetStoresByStoreIdWithValidations 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": { "GetStoresByStoreIdWithValidations500Example": { "summary": "Default GetStoresByStoreIdWithValidations 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 Stores by Store Id with Validations", "description": "Get Stores by Store Id with Validations via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/storevalidation/kiosk).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/stores/header": { "get": { "tags": [ "Stores" ], "operationId": "GetStoreHeadersByAppId", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeNameQuery", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The store name query query parameter.", "example": "Example Name" }, { "name": "salesChannelType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Web", "App", "Kiosk", "Pos", "None" ] }, "description": "The sales channel type query parameter.", "example": "Web" }, { "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_StoreHeader_" }, "examples": { "GetStoreHeadersByAppId200Example": { "summary": "Default GetStoreHeadersByAppId 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": { "GetStoreHeadersByAppId400Example": { "summary": "Default GetStoreHeadersByAppId 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": { "GetStoreHeadersByAppId401Example": { "summary": "Default GetStoreHeadersByAppId 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": { "GetStoreHeadersByAppId403Example": { "summary": "Default GetStoreHeadersByAppId 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": { "GetStoreHeadersByAppId500Example": { "summary": "Default GetStoreHeadersByAppId 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 Store Headers by App Id", "description": "Get Store Headers by App Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/stores/header).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/stores": { "get": { "tags": [ "Stores" ], "operationId": "GetStoresByAppId", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "searchQuery", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The search query query parameter.", "example": "string" }, { "name": "salesChannelType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Web", "App", "Kiosk", "Pos", "None" ] }, "description": "The sales channel type query parameter.", "example": "Web" }, { "name": "excludeUnpublished", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "The exclude unpublished query parameter.", "example": true }, { "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_Store_" }, "examples": { "GetStoresByAppId200Example": { "summary": "Default GetStoresByAppId 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": { "GetStoresByAppId400Example": { "summary": "Default GetStoresByAppId 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": { "GetStoresByAppId401Example": { "summary": "Default GetStoresByAppId 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": { "GetStoresByAppId403Example": { "summary": "Default GetStoresByAppId 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": { "GetStoresByAppId500Example": { "summary": "Default GetStoresByAppId 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 Stores by App Id", "description": "Get Stores by App Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/stores).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/clone": { "post": { "tags": [ "Stores" ], "operationId": "CloneStore", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreCloneSettings" }, "examples": { "CloneStoreRequestExample": { "summary": "Default CloneStore request", "x-microcks-default": true, "value": { "TargetStoreGroupId": 500123 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Store_" }, "examples": { "CloneStore200Example": { "summary": "Default CloneStore 200 response", "x-microcks-default": true, "value": { "Data": { "StoreId": 500123, "StoreGroupId": 500123, "Address": { "AddressId": 500123, "Coordinates": {}, "Line1": "string", "Postcode": "string", "City": "string", "CountryCode": "IE", "DisplayForCustomer": "string", "AddressFields": {}, "SingleLineDisplay": "string", "TwoLinesDisplay": [ "string" ] }, "DeliveryZones": [], "ApmPhoneNumber": "+353000000000", "PickupHours": [], "DeliveryHours": [], "MenuId": 500123, "OrderConfirmationMessageOverrideDelivery": "string", "OrderConfirmationMessageOverridePickup": "string", "PrintoutLayoutType": "Default", "StoreNotes": [], "MicrosoftTimeZone": "string", "IanaTimeZone": "string", "Currency": "EUR", "PreOrderDeliveryEnabled": true, "PreOrderPickupEnabled": true, "LogoUrl": "https://api.flipdish.co/example", "FraudPreventionStrategy": "string", "AppIds": [ "string" ], "PropertyId": "500123", "PhoneNumber": "+353000000000", "AlwaysAppearOpen": true, "PreOrderEnabled": true, "TakeOutEnabled": true, "TableServiceEnabled": true, "DineInEnabled": true, "AllowPreOrdersAndTableService": true, "PickupEnabled": true, "DeliveryEnabled": true, "CardOrderDeliveryEnabled": true, "CashOrdersDeliveryEnabled": true, "CardOrdersPickupEnabled": true, "CashOrdersPickupEnabled": true, "TipsEnabled": true, "AutomaticallyAcceptOrders": true, "OpenForDelivery": true, "OpenForPickup": true, "MinimumPickupOrderAmount": 12.5, "RequireCustomerNameForPickup": true, "GdprCustomerPhoneNumbers": true, "RequireCustomerNameForDelivery": true, "AllowChefNotes": true, "EtaInPickupConfirmationSmsEnabled": true, "EtaInDeliveryConfirmationSmsEnabled": true, "IsArchived": true, "IsPublished": true, "Name": "Example Name", "EmailAddress": "owner@example.com", "StaffLanguage": "string", "SalesChannelTypes": [ "Web" ], "InheritanceConfigTypes": [ "CollectionSettings" ] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CloneStore400Example": { "summary": "Default CloneStore 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": { "CloneStore401Example": { "summary": "Default CloneStore 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": { "CloneStore403Example": { "summary": "Default CloneStore 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": { "CloneStore404Example": { "summary": "Default CloneStore 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": { "CloneStore500Example": { "summary": "Default CloneStore 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 Clone Store", "description": "Clone Store via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/clone).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/address": { "post": { "tags": [ "Stores" ], "operationId": "UpdateStoreAddress", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreAddressBase" }, "examples": { "UpdateStoreAddressRequestExample": { "summary": "Default UpdateStoreAddress request", "x-microcks-default": true, "value": { "Line1": "string", "Postcode": "string", "City": "string", "CountryCode": "IE", "DisplayForCustomer": "string", "AddressFields": {}, "SingleLineDisplay": "string", "TwoLinesDisplay": [ "string" ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_StoreAddress_" }, "examples": { "UpdateStoreAddress200Example": { "summary": "Default UpdateStoreAddress 200 response", "x-microcks-default": true, "value": { "Data": { "AddressId": 500123, "Coordinates": { "Latitude": 1.0, "Longitude": 1.0 }, "Line1": "string", "Postcode": "string", "City": "string", "CountryCode": "IE", "DisplayForCustomer": "string", "AddressFields": {}, "SingleLineDisplay": "string", "TwoLinesDisplay": [ "string" ] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateStoreAddress400Example": { "summary": "Default UpdateStoreAddress 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": { "UpdateStoreAddress401Example": { "summary": "Default UpdateStoreAddress 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": { "UpdateStoreAddress403Example": { "summary": "Default UpdateStoreAddress 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": { "UpdateStoreAddress404Example": { "summary": "Default UpdateStoreAddress 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": { "UpdateStoreAddress500Example": { "summary": "Default UpdateStoreAddress 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 Store Address", "description": "Update Store Address via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/address).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/archive": { "post": { "tags": [ "Stores" ], "operationId": "ArchiveStore", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ArchiveStore400Example": { "summary": "Default ArchiveStore 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": { "ArchiveStore401Example": { "summary": "Default ArchiveStore 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": { "ArchiveStore403Example": { "summary": "Default ArchiveStore 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": { "ArchiveStore404Example": { "summary": "Default ArchiveStore 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": { "ArchiveStore500Example": { "summary": "Default ArchiveStore 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 Archive Store", "description": "Archive Store via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/archive).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/publish": { "post": { "tags": [ "Stores" ], "operationId": "PublishStore", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "PublishStore400Example": { "summary": "Default PublishStore 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": { "PublishStore401Example": { "summary": "Default PublishStore 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": { "PublishStore403Example": { "summary": "Default PublishStore 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": { "PublishStore404Example": { "summary": "Default PublishStore 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": { "PublishStore500Example": { "summary": "Default PublishStore 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 Publish Store", "description": "Publish Store via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/publish).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/unpublish": { "post": { "tags": [ "Stores" ], "operationId": "UnpublishStore", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UnpublishStore400Example": { "summary": "Default UnpublishStore 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": { "UnpublishStore401Example": { "summary": "Default UnpublishStore 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": { "UnpublishStore403Example": { "summary": "Default UnpublishStore 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": { "UnpublishStore404Example": { "summary": "Default UnpublishStore 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": { "UnpublishStore500Example": { "summary": "Default UnpublishStore 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 Unpublish Store", "description": "Unpublish Store via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/unpublish).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/addressform": { "post": { "tags": [ "Stores" ], "operationId": "UpdateStoreAddressForm", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UpdateStoreAddressForm200Example": { "summary": "Default UpdateStoreAddressForm 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateStoreAddressForm400Example": { "summary": "Default UpdateStoreAddressForm 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": { "UpdateStoreAddressForm401Example": { "summary": "Default UpdateStoreAddressForm 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": { "UpdateStoreAddressForm403Example": { "summary": "Default UpdateStoreAddressForm 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": { "UpdateStoreAddressForm500Example": { "summary": "Default UpdateStoreAddressForm 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 Store Address Form", "description": "Update Store Address Form via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/addressform).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/menu/{menuId}": { "post": { "tags": [ "Stores" ], "operationId": "AssignMenu", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "menuId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The menu id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_RestApiDefaultResponse_" }, "examples": { "AssignMenu200Example": { "summary": "Default AssignMenu 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AssignMenu400Example": { "summary": "Default AssignMenu 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": { "AssignMenu401Example": { "summary": "Default AssignMenu 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": { "AssignMenu403Example": { "summary": "Default AssignMenu 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": { "AssignMenu500Example": { "summary": "Default AssignMenu 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 Assign Menu", "description": "Assign Menu via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/menu/{menuId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/propertyId/{propertyId}": { "post": { "tags": [ "Stores" ], "operationId": "Stores_SetPropertyId", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "propertyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The property id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stores_SetPropertyId200Example": { "summary": "Default Stores_SetPropertyId 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Stores_SetPropertyId400Example": { "summary": "Default Stores_SetPropertyId 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": { "Stores_SetPropertyId401Example": { "summary": "Default Stores_SetPropertyId 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": { "Stores_SetPropertyId403Example": { "summary": "Default Stores_SetPropertyId 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": { "Stores_SetPropertyId500Example": { "summary": "Default Stores_SetPropertyId 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 Stores_Set Property Id", "description": "Stores_Set Property Id via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/propertyId/{propertyId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/address/coordinates": { "post": { "tags": [ "Stores" ], "operationId": "UpdateStoreAddressCoordinates", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "appNameId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The app name id query parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Coordinates" }, "examples": { "UpdateStoreAddressCoordinatesRequestExample": { "summary": "Default UpdateStoreAddressCoordinates request", "x-microcks-default": true, "value": { "Latitude": 1.0, "Longitude": 1.0 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Coordinates_" }, "examples": { "UpdateStoreAddressCoordinates200Example": { "summary": "Default UpdateStoreAddressCoordinates 200 response", "x-microcks-default": true, "value": { "Data": { "Latitude": 1.0, "Longitude": 1.0 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateStoreAddressCoordinates400Example": { "summary": "Default UpdateStoreAddressCoordinates 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": { "UpdateStoreAddressCoordinates401Example": { "summary": "Default UpdateStoreAddressCoordinates 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": { "UpdateStoreAddressCoordinates403Example": { "summary": "Default UpdateStoreAddressCoordinates 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": { "UpdateStoreAddressCoordinates404Example": { "summary": "Default UpdateStoreAddressCoordinates 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": { "UpdateStoreAddressCoordinates500Example": { "summary": "Default UpdateStoreAddressCoordinates 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 Store Address Coordinates", "description": "Update Store Address Coordinates via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/address/coordinates).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/properties/{propertyId}/stores/{storeId}/supportedSalesChannels": { "post": { "tags": [ "Stores" ], "operationId": "SupportedSalesChannelsTypes", "parameters": [ { "name": "propertyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The property id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "enum": [ "Web", "App", "Kiosk", "Pos", "None" ], "type": "string" } }, "examples": { "SupportedSalesChannelsTypesRequestExample": { "summary": "Default SupportedSalesChannelsTypes request", "x-microcks-default": true, "value": [ "Web" ] } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SupportedSalesChannelsTypes400Example": { "summary": "Default SupportedSalesChannelsTypes 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": { "SupportedSalesChannelsTypes401Example": { "summary": "Default SupportedSalesChannelsTypes 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": { "SupportedSalesChannelsTypes403Example": { "summary": "Default SupportedSalesChannelsTypes 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": { "SupportedSalesChannelsTypes404Example": { "summary": "Default SupportedSalesChannelsTypes 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SupportedSalesChannelsTypes500Example": { "summary": "Default SupportedSalesChannelsTypes 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 Supported Sales Channels Types", "description": "Supported Sales Channels Types via the Flipdish Open API v1.0 (POST /api/v1.0/properties/{propertyId}/stores/{storeId}/supportedSalesChannels).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}/enabled": { "post": { "tags": [ "Stores" ], "operationId": "SetPreOrdeEnabled", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "deliveryType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Delivery", "Pickup" ] }, "description": "The delivery type path parameter.", "example": "Delivery" }, { "name": "enabled", "in": "query", "required": true, "schema": { "type": "boolean" }, "description": "The enabled query parameter.", "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_RestApiDefaultResponse_" }, "examples": { "SetPreOrdeEnabled200Example": { "summary": "Default SetPreOrdeEnabled 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetPreOrdeEnabled400Example": { "summary": "Default SetPreOrdeEnabled 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": { "SetPreOrdeEnabled401Example": { "summary": "Default SetPreOrdeEnabled 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": { "SetPreOrdeEnabled403Example": { "summary": "Default SetPreOrdeEnabled 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": { "SetPreOrdeEnabled500Example": { "summary": "Default SetPreOrdeEnabled 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 Set Pre Orde Enabled", "description": "Set Pre Orde Enabled via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/preorderconfig/{deliveryType}/enabled).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/collectionsettings": { "post": { "tags": [ "Stores" ], "operationId": "SetStoreCollectionSettings", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "inheritFromProperty", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "The inherit from property query parameter.", "example": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreCollectionSettings" }, "examples": { "SetStoreCollectionSettingsRequestExample": { "summary": "Default SetStoreCollectionSettings request", "x-microcks-default": true, "value": { "PickupEnabled": true, "MinimumPickupOrderAmount": 12.5, "RequireCustomerNameForPickup": true, "CashOrdersPickupEnabled": true, "LeadTimeMinutes": 1, "EtaInPickupConfirmationSmsEnabled": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_RestApiDefaultResponse_" }, "examples": { "SetStoreCollectionSettings200Example": { "summary": "Default SetStoreCollectionSettings 200 response", "x-microcks-default": true, "value": { "Data": { "Data": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetStoreCollectionSettings400Example": { "summary": "Default SetStoreCollectionSettings 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": { "SetStoreCollectionSettings401Example": { "summary": "Default SetStoreCollectionSettings 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": { "SetStoreCollectionSettings403Example": { "summary": "Default SetStoreCollectionSettings 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetStoreCollectionSettings409Example": { "summary": "Default SetStoreCollectionSettings 409 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetStoreCollectionSettings500Example": { "summary": "Default SetStoreCollectionSettings 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 Set Store Collection Settings", "description": "Set Store Collection Settings via the Flipdish Open API v1.0 (POST /api/v1.0/stores/{storeId}/collectionsettings).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/properties/{propertyId}/stores": { "post": { "tags": [ "Stores" ], "operationId": "CreateStoreInProperty", "parameters": [ { "name": "storeGroupId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store group id query parameter.", "example": 500123 }, { "name": "propertyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The property id path parameter.", "example": "500123" }, { "name": "autoAssignMenu", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "The auto assign menu query parameter.", "example": true } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Store_" }, "examples": { "CreateStoreInProperty200Example": { "summary": "Default CreateStoreInProperty 200 response", "x-microcks-default": true, "value": { "Data": { "StoreId": 500123, "StoreGroupId": 500123, "Address": { "AddressId": 500123, "Coordinates": {}, "Line1": "string", "Postcode": "string", "City": "string", "CountryCode": "IE", "DisplayForCustomer": "string", "AddressFields": {}, "SingleLineDisplay": "string", "TwoLinesDisplay": [ "string" ] }, "DeliveryZones": [], "ApmPhoneNumber": "+353000000000", "PickupHours": [], "DeliveryHours": [], "MenuId": 500123, "OrderConfirmationMessageOverrideDelivery": "string", "OrderConfirmationMessageOverridePickup": "string", "PrintoutLayoutType": "Default", "StoreNotes": [], "MicrosoftTimeZone": "string", "IanaTimeZone": "string", "Currency": "EUR", "PreOrderDeliveryEnabled": true, "PreOrderPickupEnabled": true, "LogoUrl": "https://api.flipdish.co/example", "FraudPreventionStrategy": "string", "AppIds": [ "string" ], "PropertyId": "500123", "PhoneNumber": "+353000000000", "AlwaysAppearOpen": true, "PreOrderEnabled": true, "TakeOutEnabled": true, "TableServiceEnabled": true, "DineInEnabled": true, "AllowPreOrdersAndTableService": true, "PickupEnabled": true, "DeliveryEnabled": true, "CardOrderDeliveryEnabled": true, "CashOrdersDeliveryEnabled": true, "CardOrdersPickupEnabled": true, "CashOrdersPickupEnabled": true, "TipsEnabled": true, "AutomaticallyAcceptOrders": true, "OpenForDelivery": true, "OpenForPickup": true, "MinimumPickupOrderAmount": 12.5, "RequireCustomerNameForPickup": true, "GdprCustomerPhoneNumbers": true, "RequireCustomerNameForDelivery": true, "AllowChefNotes": true, "EtaInPickupConfirmationSmsEnabled": true, "EtaInDeliveryConfirmationSmsEnabled": true, "IsArchived": true, "IsPublished": true, "Name": "Example Name", "EmailAddress": "owner@example.com", "StaffLanguage": "string", "SalesChannelTypes": [ "Web" ], "InheritanceConfigTypes": [ "CollectionSettings" ] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateStoreInProperty400Example": { "summary": "Default CreateStoreInProperty 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": { "CreateStoreInProperty401Example": { "summary": "Default CreateStoreInProperty 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": { "CreateStoreInProperty403Example": { "summary": "Default CreateStoreInProperty 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": { "CreateStoreInProperty404Example": { "summary": "Default CreateStoreInProperty 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": { "CreateStoreInProperty500Example": { "summary": "Default CreateStoreInProperty 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 Store in Property", "description": "Create Store in Property via the Flipdish Open API v1.0 (POST /api/v1.0/properties/{propertyId}/stores).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stores/{storeId}/businesshoursoverrides/{businessHoursOverrideId}": { "delete": { "tags": [ "Stores" ], "operationId": "DeleteBusinessHoursOverride", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "businessHoursOverrideId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The business hours override id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_RestApiDefaultResponse_" }, "examples": { "DeleteBusinessHoursOverride200Example": { "summary": "Default DeleteBusinessHoursOverride 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteBusinessHoursOverride400Example": { "summary": "Default DeleteBusinessHoursOverride 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": { "DeleteBusinessHoursOverride401Example": { "summary": "Default DeleteBusinessHoursOverride 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": { "DeleteBusinessHoursOverride403Example": { "summary": "Default DeleteBusinessHoursOverride 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": { "DeleteBusinessHoursOverride500Example": { "summary": "Default DeleteBusinessHoursOverride 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 Delete Business Hours Override", "description": "Delete Business Hours Override via the Flipdish Open API v1.0 (DELETE /api/v1.0/stores/{storeId}/businesshoursoverrides/{businessHoursOverrideId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } } }, "components": { "schemas": { "AddressFormDisplayFormat": { "type": "object", "properties": { "OneLine": { "type": "string", "example": "string" }, "TwoLines": { "type": "array", "items": { "type": "string" }, "example": [ "string" ] } } }, "AddressFormResponse": { "description": "A response of a dyanmic form definition.", "type": "object", "properties": { "FormData": { "description": "List of field definitions.", "type": "array", "items": { "$ref": "#/components/schemas/DynamicFormField" }, "example": [] }, "CountryCode": { "description": "ISO two letter code.", "type": "string", "example": "IE" }, "Language": { "description": "ISO culture code.", "type": "string", "example": "string" }, "DisplayFormat": { "$ref": "#/components/schemas/AddressFormDisplayFormat" } } }, "AssignedBankAccount": { "description": "Assigned to Store Bank Account", "type": "object", "properties": { "Id": { "format": "int32", "description": "Id of Bank Account", "type": "integer", "example": 500123 }, "BankAccountName": { "description": "Name of Bank Account", "type": "string", "example": "Example Name" } } }, "BusinessHoursOverride": { "description": "", "required": [ "StartTime", "EndTime" ], "type": "object", "properties": { "BusinessHoursOverrideId": { "format": "int32", "description": "Unique identifier", "type": "integer", "example": 500123 }, "DeliveryType": { "description": "Delivery or Pickup", "enum": [ "Delivery", "Pickup" ], "type": "string", "example": "Delivery" }, "StartTime": { "format": "date-time", "description": "Date and time in ISO 8601 format.", "type": "string", "example": "2026-06-02T12:00:00Z" }, "EndTime": { "format": "date-time", "description": "Date and time in ISO 8601 format.", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Type": { "description": "Open, Closed or ClosedAllowPreOrders", "enum": [ "Open", "Closed", "ClosedAllowPreOrders" ], "type": "string", "example": "Open" } } }, "BusinessHoursOverrideBase": { "description": "", "required": [ "StartTime", "EndTime" ], "type": "object", "properties": { "DeliveryType": { "description": "Delivery or Pickup", "enum": [ "Delivery", "Pickup" ], "type": "string", "example": "Delivery" }, "StartTime": { "format": "date-time", "description": "Date and time in ISO 8601 format.", "type": "string", "example": "2026-06-02T12:00:00Z" }, "EndTime": { "format": "date-time", "description": "Date and time in ISO 8601 format.", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Type": { "description": "Open, Closed or ClosedAllowPreOrders", "enum": [ "Open", "Closed", "ClosedAllowPreOrders" ], "type": "string", "example": "Open" } } }, "BusinessHoursPeriod": { "description": "Business hours period", "type": "object", "properties": { "Early": { "$ref": "#/components/schemas/Range" }, "Late": { "$ref": "#/components/schemas/Range" }, "Ranges": { "description": "Ranges", "type": "array", "items": { "$ref": "#/components/schemas/Range" }, "example": [] }, "DayOfWeek": { "description": "Day of week", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "example": "Sunday" }, "StartTime": { "description": "Start time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Period": { "description": "Period", "type": "string", "example": "string" }, "StartTimeEarly": { "description": "Start time early", "type": "string", "example": "string" }, "PeriodEarly": { "description": "Period early", "type": "string", "example": "string" } } }, "BusinessHoursPeriodBase": { "description": "Business hours period", "type": "object", "properties": { "DayOfWeek": { "description": "Day of week", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "example": "Sunday" }, "StartTime": { "description": "Start time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Period": { "description": "Period", "type": "string", "example": "string" }, "StartTimeEarly": { "description": "Start time early", "type": "string", "example": "string" }, "PeriodEarly": { "description": "Period early", "type": "string", "example": "string" } } }, "Coordinates": { "description": "Coordinates", "type": "object", "properties": { "Latitude": { "format": "double", "description": "Latitude", "type": "number", "example": 1.0 }, "Longitude": { "format": "double", "description": "Longitude", "type": "number", "example": 1.0 } } }, "CountryFormResponse": { "description": "Country", "type": "object", "properties": { "Value": { "description": "ISO two letter code.", "type": "string", "example": "string" }, "Label": { "description": "Label", "type": "string", "example": "string" } } }, "CreateLocation": { "description": "Input model for creating a Location", "type": "object", "properties": { "LocationId": { "format": "int32", "description": "Location Id", "type": "integer", "example": 500123 }, "LocationName": { "description": "Descriptive LocationArea name", "type": "string", "example": "Example Name" }, "DisplayOrder": { "format": "int32", "description": "The order that the Location should be displayed on the screen", "type": "integer", "example": 1 }, "ExternalLocationId": { "description": "Id of the Location on an external system", "type": "string", "example": "500123" } } }, "CreateLocationArea": { "description": "Input model for creating a LocationArea", "required": [ "LocationAreaName" ], "type": "object", "properties": { "LocationAreaName": { "description": "Descriptive LocationArea name", "type": "string", "example": "Example Name" } } }, "CustomerMessages": { "description": "Delivery and pickup menu messages for a customer", "type": "object", "properties": { "DeliveryMenuMessage": { "description": "Delivery menu message", "type": "string", "example": "string" }, "PickupMenuMessage": { "description": "Pickup menu message", "type": "string", "example": "string" } } }, "DeliveryZone": { "description": "Delivery Zone", "type": "object", "properties": { "Id": { "format": "int32", "description": "Delivery Fee Area Id", "type": "integer", "example": 500123 }, "FeeChargedToStore": { "format": "double", "description": "Delivery Fee charged to store", "type": "number", "nullable": true, "example": 12.5 }, "DeliveryFee": { "format": "double", "description": "Delivery fee (will not be set below 0)", "type": "number", "example": 12.5 }, "MinimumDeliveryOrderAmount": { "format": "double", "description": "Minimum delivery order amount (will not be set below 0)", "type": "number", "example": 12.5 }, "WellKnownText": { "description": "Spatial data in Well Known Text format\r\nWe also support CIRCLE((0 0, 200)) - (centerLong centerLat, radius in m)", "type": "string", "example": "string" }, "IsEnabled": { "description": "Is delivery zone enabled", "type": "boolean", "example": true } } }, "DynamicFormField": { "type": "object", "properties": { "Identifier": { "type": "string", "example": "string" }, "Label": { "type": "string", "example": "string" }, "Placeholder": { "type": "string", "example": "string" }, "Rules": { "$ref": "#/components/schemas/DynamicFormRules" }, "Mapping": { "type": "object", "additionalProperties": { "type": "string" } }, "Modifiers": { "type": "array", "items": { "type": "string" }, "example": [ "string" ] }, "Value": { "type": "object" }, "Scopes": { "type": "string", "example": "string" } } }, "DynamicFormFieldOption": { "type": "object", "properties": { "Display": { "type": "string", "example": "string" }, "Value": { "type": "string", "example": "string" } } }, "DynamicFormRule": { "type": "object", "properties": { "Value": { "type": "object" }, "Message": { "type": "string", "example": "string" }, "Scopes": { "type": "string", "example": "string" } } }, "DynamicFormRules": { "type": "object", "properties": { "MaxLength": { "$ref": "#/components/schemas/DynamicFormRule" }, "MinLength": { "$ref": "#/components/schemas/DynamicFormRule" }, "Required": { "$ref": "#/components/schemas/DynamicFormRule" }, "Pattern": { "$ref": "#/components/schemas/DynamicFormRule" }, "Predefined": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicFormFieldOption" }, "example": [] } } }, "FlipdishError": { "type": "object", "description": "Standard Flipdish API error response. Errors are returned as a JSON object with a human-readable message and a programmatic error code (see https://developers.flipdish.com/docs/error-handling).", "properties": { "error": { "type": "object", "description": "Error detail object.", "properties": { "errorMessage": { "type": "string", "description": "Descriptive explanation of the issue.", "example": "Invalid or missing parameters." }, "errorCode": { "type": "string", "description": "Unique identifier for programmatic error handling.", "example": "BadRequest" }, "details": { "type": "string", "description": "Additional context returned in non-production environments.", "example": "Validation failed for field 'storeId'." } } } } }, "GoogleAddress": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/components/schemas/GoogleAddressResult" }, "example": [] }, "Result": { "$ref": "#/components/schemas/GoogleAddressResult" }, "Status": { "type": "string", "example": "Active" } } }, "GoogleAddressComponent": { "type": "object", "properties": { "Long_name": { "type": "string", "example": "Example Name" }, "Short_name": { "type": "string", "example": "Example Name" }, "Types": { "type": "array", "items": { "type": "string" }, "example": [ "string" ] } } }, "GoogleAddressResult": { "type": "object", "properties": { "Address_components": { "type": "array", "items": { "$ref": "#/components/schemas/GoogleAddressComponent" }, "example": [] }, "Formatted_address": { "type": "string", "example": "string" }, "Geometry": { "$ref": "#/components/schemas/GoogleGeometry" }, "Place_id": { "type": "string", "example": "500123" }, "Types": { "type": "array", "items": { "type": "string" }, "example": [ "string" ] } } }, "GoogleCoordinates": { "type": "object", "properties": { "Lat": { "format": "float", "type": "number", "example": 1.0 }, "Lng": { "format": "float", "type": "number", "example": 1.0 } } }, "GoogleGeometry": { "type": "object", "properties": { "Location": { "$ref": "#/components/schemas/GoogleLocation" }, "Location_type": { "type": "string", "example": "string" }, "Viewport": { "$ref": "#/components/schemas/GoogleViewport" } } }, "GoogleLocation": { "type": "object", "properties": { "Lat": { "format": "float", "type": "number", "example": 1.0 }, "Lng": { "format": "float", "type": "number", "example": 1.0 } } }, "GoogleViewport": { "type": "object", "properties": { "Northeast": { "$ref": "#/components/schemas/GoogleCoordinates" }, "Southwest": { "$ref": "#/components/schemas/GoogleCoordinates" } } }, "GroupedCoordinates": { "description": "Describes coordinates that have a group", "type": "object", "properties": { "Latitude": { "format": "double", "description": "Latitude of this coordinate", "type": "number", "example": 1.0 }, "Longitude": { "format": "double", "description": "Longitude of this coordinate", "type": "number", "example": 1.0 }, "Count": { "format": "int32", "description": "Count of members in the group", "type": "integer", "example": 3 } } }, "LeadTime": { "description": "", "required": [ "DispatchType", "LeadTimeMinutes" ], "type": "object", "properties": { "DispatchType": { "description": "There are two valid values for this field - `collection` and `delivery`.", "type": "string", "example": "string" }, "LeadTimeMinutes": { "format": "int32", "description": "This must be a positive integer.", "type": "integer", "example": 1 } } }, "LocationArea": { "description": "Represents a LocationArea", "type": "object", "properties": { "LocationAreaId": { "format": "int32", "description": "Id of the LocationArea", "type": "integer", "example": 500123 }, "StoreId": { "format": "int32", "description": "Id of the Store that this LocationArea belongs to", "type": "integer", "example": 500123 }, "LocationAreaName": { "description": "Descriptive LocationArea name", "type": "string", "example": "Example Name" } } }, "LocationAreaWithLocations": { "description": "Represents a LocationArea and its Location list", "required": [ "LocationAreaId", "StoreId", "LocationAreaName" ], "type": "object", "properties": { "LocationAreaId": { "format": "int32", "description": "Id of the LocationArea", "type": "integer", "example": 500123 }, "StoreId": { "format": "int32", "description": "Id of the Store that this LocationArea belongs to", "type": "integer", "example": 500123 }, "LocationAreaName": { "description": "Descriptive LocationArea name", "type": "string", "example": "Example Name" }, "Locations": { "description": "List of Locations that belongs to this Location Area", "type": "array", "items": { "$ref": "#/components/schemas/LocationArea_Location" }, "example": [] }, "IsDeleted": { "description": "Returns if the LocationArea is deleted or not", "type": "boolean", "example": true } } }, "LocationArea_Location": { "description": "Representation of a Location i.e: (Table, Hotel Room, Car Park, etc )", "required": [ "LocationId", "LocationName", "DisplayOrder" ], "type": "object", "properties": { "LocationId": { "format": "int32", "description": "Id of the Location", "type": "integer", "example": 500123 }, "LocationName": { "description": "Name of the Location", "type": "string", "example": "Example Name" }, "DisplayOrder": { "format": "int32", "description": "The order that the Location should be displayed on the screen", "type": "integer", "example": 1 }, "ExternalLocationId": { "description": "Id of the Location on an external system", "type": "string", "example": "500123" }, "IsDeleted": { "description": "Shows if the Location is deleted or not", "type": "boolean", "example": true } } }, "MappedLocation": { "description": "Representation of a Location and its External Mapping", "required": [ "LocationId", "ExternalLocationId" ], "type": "object", "properties": { "LocationId": { "format": "int32", "description": "Id of the Location", "type": "integer", "example": 500123 }, "ExternalLocationId": { "description": "Id of the Location on an external system", "type": "string", "example": "500123" } } }, "OrderLeadTimes": { "description": "When orders are accepted, and no lead time is specified by the operator, this is the lead time that will be\r\napplied to the order.", "type": "object", "properties": { "LeadTimeMinutes": { "description": "Mapping from the type of order to, to the default lead time that will be applied to those orders.\r\nThe lead time is an integer number of minutes.", "type": "object", "additionalProperties": { "format": "int32", "type": "integer" } } } }, "PreOrderConfig": { "description": "Pre Order Config", "type": "object", "properties": { "LeadTimeMinutes": { "format": "int32", "description": "Lead Time in Minutes", "type": "integer", "example": 1 }, "IntervalMinutes": { "format": "int32", "description": "Interval in minutes", "type": "integer", "example": 1 }, "MaxOrderAheadDays": { "format": "int32", "description": "Max Days to order ahead", "type": "integer", "example": 1 }, "IncludeAsap": { "description": "Show ASAP as option", "type": "boolean", "example": true }, "IncludeMoreGranularInitialTime": { "description": "Granual Init' Time", "type": "boolean", "example": true }, "CutOffTimePreviousDayBasic": { "description": "Cut off time previous day", "type": "string", "nullable": true, "example": "string" }, "CutOffTimeCurrentDayBasic": { "description": "Cut off time current day", "type": "string", "nullable": true, "example": "string" }, "PreOrderTimeDisplayType": { "description": "Type of time displayed.", "enum": [ "SingleTime", "StartAndEndTime", "DayOnly" ], "type": "string", "example": "SingleTime" }, "AlwaysAppearOpen": { "description": "Specifies whether a customer can pre-order outside the store opening hours or not.", "type": "boolean", "example": true }, "RequireExplicitSelectAlways": { "description": "Force customer to select collection time.", "type": "boolean", "example": true } } }, "PreOrderTime": { "description": "Time order can be placed", "type": "object", "properties": { "StartTime": { "format": "date-time", "description": "Start Time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "EndTime": { "format": "date-time", "description": "End Time", "type": "string", "example": "2026-06-02T12:00:00Z" } } }, "ProcessingFeeConfig": { "description": "Processing fee config", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "PaymentAccountType": { "description": "Payment account type", "enum": [ "Card", "Cash", "Ideal", "Bancontact", "Giropay", "Eps", "Emv", "PayPal", "PayGreen", "GoogleWalletToken" ], "type": "string", "example": "Card" }, "PercentFee": { "format": "double", "description": "Percent fee to customer, including VAT", "type": "number", "example": 12.5 }, "FixedFee": { "format": "double", "description": "Fixed fee to customer, including VAT", "type": "number", "example": 12.5 } } }, "Range": { "description": "A class that represents a single opening period in a day.\r\nThis starts 'StartTime' after midnight and runs for a 'Period'\r\nafter that, on the given DayOfWeek.", "type": "object", "properties": { "StartTime": { "description": "Start time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Period": { "description": "Period", "type": "string", "example": "string" }, "DayOfWeek": { "description": "Day of week", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "example": "Sunday" } } }, "RestApiArrayResult_BusinessHoursPeriod_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/BusinessHoursPeriod" }, "example": [] } } }, "RestApiArrayResult_DeliveryZone_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/DeliveryZone" }, "example": [] } } }, "RestApiArrayResult_LocationAreaWithLocations_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/LocationAreaWithLocations" }, "example": [] } } }, "RestApiArrayResult_LocationArea_Location_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/LocationArea_Location" }, "example": [] } } }, "RestApiArrayResult_PreOrderTime_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/PreOrderTime" }, "example": [] } } }, "RestApiArrayResult_ProcessingFeeConfig_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/ProcessingFeeConfig" }, "example": [] } } }, "RestApiArrayResult_RestApiDefaultResponse_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "example": [] } } }, "RestApiArrayResult_StoreDeliveryZoneFeeConfig_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/StoreDeliveryZoneFeeConfig" }, "example": [] } } }, "RestApiArrayResult_StoreStatistics_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/StoreStatistics" }, "example": [] } } }, "RestApiDefaultResponse": { "description": "Rest api default response", "type": "object", "properties": { "Data": { "description": "Data string", "type": "string", "readOnly": true, "example": "string" } } }, "RestApiPaginationResult_BusinessHoursOverride_": { "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/BusinessHoursOverride" }, "example": [] } } }, "RestApiPaginationResult_StoreGroupExtended_": { "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/StoreGroupExtended" }, "example": [] } } }, "RestApiPaginationResult_StoreGroup_": { "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/StoreGroup" }, "example": [] } } }, "RestApiPaginationResult_StoreHeader_": { "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/StoreHeader" }, "example": [] } } }, "RestApiPaginationResult_StoreValidationConfig_": { "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/StoreValidationConfig" }, "example": [] } } }, "RestApiPaginationResult_Store_": { "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/Store" }, "example": [] } } }, "RestApiResult_AddressFormResponse_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AddressFormResponse" } } }, "RestApiResult_AssignedBankAccount_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AssignedBankAccount" } } }, "RestApiResult_BusinessHoursOverride_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessHoursOverride" } } }, "RestApiResult_BusinessHoursPeriod_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessHoursPeriod" } } }, "RestApiResult_Coordinates_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/Coordinates" } } }, "RestApiResult_CountryFormResponse_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/CountryFormResponse" } } }, "RestApiResult_DeliveryZone_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/DeliveryZone" } } }, "RestApiResult_LocationAreaWithLocations_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/LocationAreaWithLocations" } } }, "RestApiResult_LocationArea_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/LocationArea" } } }, "RestApiResult_LocationArea_Location_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/LocationArea_Location" } } }, "RestApiResult_MappedLocation_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MappedLocation" } } }, "RestApiResult_OrderLeadTimes_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/OrderLeadTimes" } } }, "RestApiResult_PreOrderConfig_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/PreOrderConfig" } } }, "RestApiResult_ProcessingFeeConfig_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ProcessingFeeConfig" } } }, "RestApiResult_RestApiDefaultResponse_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/RestApiDefaultResponse" } } }, "RestApiResult_ServiceCharge_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ServiceCharge" } } }, "RestApiResult_StoreAddress_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/StoreAddress" } } }, "RestApiResult_StoreEndOfDayReport_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/StoreEndOfDayReport" } } }, "RestApiResult_StoreGroupBase_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/StoreGroupBase" } } }, "RestApiResult_StoreGroup_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/StoreGroup" } } }, "RestApiResult_StoreOrderCapacityConfig_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/StoreOrderCapacityConfig" } } }, "RestApiResult_Store_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/Store" } } }, "RestApiStringResult": { "description": "Rest api string result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Data string", "type": "string", "example": "string" } } }, "ServiceCharge": { "description": "Store Service Charge", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "Store identifier", "type": "integer", "example": 500123 }, "PercentageValue": { "format": "double", "description": "The Default Service Charge Value", "type": "number", "example": 1.0 }, "Enabled": { "description": "Enable Service Charge for store true(on) / false(off)", "type": "boolean", "example": true }, "IsOptional": { "description": "Sets the service charge to be optional", "type": "boolean", "example": true }, "DisplayWithProcessingFee": { "description": "Display service charge together with processing fee", "type": "boolean", "example": true }, "IncludesVouchers": { "description": "If true, will include voucher value in calculation \r\ni.e 10E order with 1E service charge and 5E voucher would have service charge at 0.5E", "type": "boolean", "example": true } } }, "Store": { "description": "Store", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "Store identifier", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group id to which this store belongs", "type": "integer", "example": 500123 }, "Address": { "$ref": "#/components/schemas/StoreAddress" }, "DeliveryZones": { "description": "Delivery zones", "type": "array", "items": { "$ref": "#/components/schemas/DeliveryZone" }, "example": [] }, "ApmPhoneNumber": { "description": "Automated Phone Marketing number", "type": "string", "example": "+353000000000" }, "PickupHours": { "description": "Pickup hours", "type": "array", "items": { "$ref": "#/components/schemas/BusinessHoursPeriod" }, "example": [] }, "DeliveryHours": { "description": "Delivery hours", "type": "array", "items": { "$ref": "#/components/schemas/BusinessHoursPeriod" }, "example": [] }, "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "OrderConfirmationMessageOverrideDelivery": { "description": "Overridden confirmation message for delivery orders", "type": "string", "example": "string" }, "OrderConfirmationMessageOverridePickup": { "description": "Overridden confirmation message for pickup orders", "type": "string", "example": "string" }, "PrintoutLayoutType": { "description": "Printout layout", "enum": [ "Default", "Centra", "SmallChefNotes", "SmallChefNotesAndCentra" ], "type": "string", "nullable": true, "example": "Default" }, "StoreNotes": { "description": "Store notes", "type": "array", "items": { "$ref": "#/components/schemas/StoreNote" }, "example": [] }, "MicrosoftTimeZone": { "description": "Microsoft Time Zone Index Values (https://msdn.microsoft.com/en-us/library/ms912391)\r\n(Editable through store coordinate change)", "type": "string", "example": "string" }, "IanaTimeZone": { "description": "IANA Time Zone (https://www.iana.org/time-zones)\r\n(Editable through store coordinate change)", "type": "string", "example": "string" }, "Currency": { "description": "Currency (derived from Store Group)", "enum": [ "EUR", "USD", "GBP", "CAD", "AUD", "DJF", "ZAR", "ETB", "AED", "BHD", "DZD", "EGP", "IQD", "JOD", "KWD", "LBP", "LYD", "MAD", "OMR", "QAR", "SAR", "SYP", "TND", "YER", "CLP", "INR", "AZN", "RUB", "BYN", "BGN", "NGN", "BDT", "CNY", "BAM", "CZK", "DKK", "CHF", "MVR", "BTN", "XCD", "BZD", "HKD", "IDR", "JMD", "MYR", "NZD", "PHP", "SGD", "TTD", "XDR", "ARS", "BOB", "COP", "CRC", "CUP", "DOP", "GTQ", "HNL", "MXN", "NIO", "PAB", "PEN", "PYG", "UYU", "VEF", "IRR", "XOF", "CDF", "XAF", "HTG", "ILS", "HRK", "HUF", "AMD", "ISK", "JPY", "GEL", "KZT", "KHR", "KRW", "KGS", "LAK", "MKD", "MNT", "BND", "MMK", "NOK", "NPR", "PKR", "PLN", "AFN", "BRL", "MDL", "RON", "RWF", "SEK", "LKR", "SOS", "ALL", "RSD", "KES", "TJS", "THB", "ERN", "TMT", "BWP", "TRY", "UAH", "UZS", "VND", "MOP", "TWD", "BMD" ], "type": "string", "example": "EUR" }, "PreOrderDeliveryEnabled": { "description": "Is PerOrder Enabled for Delivery", "type": "boolean", "example": true }, "PreOrderPickupEnabled": { "description": "Is PerOrder Enabled for Pickup", "type": "boolean", "example": true }, "LogoUrl": { "description": "Url for logo image", "type": "string", "example": "https://api.flipdish.co/example" }, "FraudPreventionStrategy": { "description": "Fraud Prevention Strategy", "type": "string", "example": "string" }, "AppIds": { "description": "Store's app ids", "type": "array", "items": { "type": "string" }, "example": [ "string" ] }, "PropertyId": { "description": "Property Id", "type": "string", "example": "500123" }, "PhoneNumber": { "description": "Phone number", "type": "string", "example": "+353000000000" }, "AlwaysAppearOpen": { "description": "True if the store always appears open", "type": "boolean", "example": true }, "PreOrderEnabled": { "description": "True if the store accepts pre-orders", "type": "boolean", "example": true }, "TakeOutEnabled": { "description": "True if the store accepts take-out orders", "type": "boolean", "example": true }, "TableServiceEnabled": { "description": "True if the store has table service", "type": "boolean", "example": true }, "DineInEnabled": { "description": "True if the store accepts dine-in orders", "type": "boolean", "example": true }, "AllowPreOrdersAndTableService": { "description": "True if both pre-orders and talbe service can be enabled", "type": "boolean", "example": true }, "PickupEnabled": { "description": "True if the store accepts pickup orders", "type": "boolean", "example": true }, "DeliveryEnabled": { "description": "True if the store accepts delivery orders", "type": "boolean", "example": true }, "CardOrderDeliveryEnabled": { "description": "True if the store accepts card payment for delivery orders", "type": "boolean", "example": true }, "CashOrdersDeliveryEnabled": { "description": "True if the store accepts cash payment for delivery orders", "type": "boolean", "example": true }, "CardOrdersPickupEnabled": { "description": "True if the store accepts card payment for pickup orders", "type": "boolean", "example": true }, "CashOrdersPickupEnabled": { "description": "True if the store accepts cash payment for pickup orders", "type": "boolean", "example": true }, "TipsEnabled": { "description": "True if the store accepts tips", "type": "boolean", "example": true }, "AutomaticallyAcceptOrders": { "description": "True if the stores orders are automatically accepted in Flipdish", "type": "boolean", "example": true }, "OpenForDelivery": { "description": "True if the store is open for delivery", "type": "boolean", "example": true }, "OpenForPickup": { "description": "True if the store is open for pickup", "type": "boolean", "example": true }, "MinimumPickupOrderAmount": { "format": "double", "description": "Minimum pickup order amount", "type": "number", "example": 12.5 }, "RequireCustomerNameForPickup": { "description": "True if customer name required for pickup orders", "type": "boolean", "example": true }, "GdprCustomerPhoneNumbers": { "description": "Mask your customers phone numbers printed on receipts and reduce the amout of personally identifiable customer information that is exposed.", "type": "boolean", "example": true }, "RequireCustomerNameForDelivery": { "description": "True if customer name required for delivery orders", "type": "boolean", "example": true }, "AllowChefNotes": { "description": "True if the customer is allowed enter custom notes with their orders", "type": "boolean", "example": true }, "EtaInPickupConfirmationSmsEnabled": { "description": "True if order confirmation sms includes estimated time when order will be ready for collection", "type": "boolean", "example": true }, "EtaInDeliveryConfirmationSmsEnabled": { "description": "True if order confirmation sms includes estimated time when order will delivered", "type": "boolean", "example": true }, "IsArchived": { "description": "Is the Store Archived", "type": "boolean", "example": true }, "IsPublished": { "description": "Is the Store Published", "type": "boolean", "example": true }, "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "EmailAddress": { "description": "Email address (visible to customers)", "maxLength": 100, "minLength": 0, "type": "string", "example": "owner@example.com" }, "StaffLanguage": { "description": "Staff Language (used for communication with the staff)\r\nEmails, Printouts etc", "type": "string", "example": "string" }, "SalesChannelTypes": { "description": "Sales Channel Types", "type": "array", "items": { "enum": [ "Web", "App", "Kiosk", "Pos", "None" ], "type": "string" }, "example": [ "Web" ] }, "InheritanceConfigTypes": { "description": "Inheritance Config Types", "type": "array", "items": { "enum": [ "CollectionSettings" ], "type": "string" }, "example": [ "CollectionSettings" ] } } }, "StoreAddress": { "description": "Store address", "type": "object", "properties": { "AddressId": { "format": "int32", "description": "Address identifier", "type": "integer", "example": 500123 }, "Coordinates": { "$ref": "#/components/schemas/Coordinates" }, "Line1": { "description": "Address line 1", "type": "string", "example": "string" }, "Postcode": { "description": "Postcode", "type": "string", "example": "string" }, "City": { "description": "City", "type": "string", "example": "string" }, "CountryCode": { "description": "Country code (ISO-alpha2)", "maxLength": 2, "minLength": 0, "type": "string", "example": "IE" }, "DisplayForCustomer": { "description": "Display for customer", "type": "string", "example": "string" }, "AddressFields": { "description": "Dyanmic field/value pairs, defined by the form assigned to the given country code.", "type": "object", "additionalProperties": { "type": "object" } }, "SingleLineDisplay": { "description": "Single line display i18n, may be empty for not supported countries", "type": "string", "example": "string" }, "TwoLinesDisplay": { "description": "Two line display i18n, may be empty for not supported countries", "type": "array", "items": { "type": "string" }, "example": [ "string" ] } } }, "StoreAddressBase": { "description": "Store address base", "type": "object", "properties": { "Line1": { "description": "Address line 1", "type": "string", "example": "string" }, "Postcode": { "description": "Postcode", "type": "string", "example": "string" }, "City": { "description": "City", "type": "string", "example": "string" }, "CountryCode": { "description": "Country code (ISO-alpha2)", "maxLength": 2, "minLength": 0, "type": "string", "example": "IE" }, "DisplayForCustomer": { "description": "Display for customer", "type": "string", "example": "string" }, "AddressFields": { "description": "Dyanmic field/value pairs, defined by the form assigned to the given country code.", "type": "object", "additionalProperties": { "type": "object" } }, "SingleLineDisplay": { "description": "Single line display i18n, may be empty for not supported countries", "type": "string", "example": "string" }, "TwoLinesDisplay": { "description": "Two line display i18n, may be empty for not supported countries", "type": "array", "items": { "type": "string" }, "example": [ "string" ] } } }, "StoreBase": { "description": "Store Base", "type": "object", "properties": { "PhoneNumber": { "description": "Phone number", "type": "string", "example": "+353000000000" }, "AlwaysAppearOpen": { "description": "True if the store always appears open", "type": "boolean", "example": true }, "PreOrderEnabled": { "description": "True if the store accepts pre-orders", "type": "boolean", "example": true }, "TakeOutEnabled": { "description": "True if the store accepts take-out orders", "type": "boolean", "example": true }, "TableServiceEnabled": { "description": "True if the store has table service", "type": "boolean", "example": true }, "DineInEnabled": { "description": "True if the store accepts dine-in orders", "type": "boolean", "example": true }, "AllowPreOrdersAndTableService": { "description": "True if both pre-orders and talbe service can be enabled", "type": "boolean", "example": true }, "PickupEnabled": { "description": "True if the store accepts pickup orders", "type": "boolean", "example": true }, "DeliveryEnabled": { "description": "True if the store accepts delivery orders", "type": "boolean", "example": true }, "CardOrderDeliveryEnabled": { "description": "True if the store accepts card payment for delivery orders", "type": "boolean", "example": true }, "CashOrdersDeliveryEnabled": { "description": "True if the store accepts cash payment for delivery orders", "type": "boolean", "example": true }, "CardOrdersPickupEnabled": { "description": "True if the store accepts card payment for pickup orders", "type": "boolean", "example": true }, "CashOrdersPickupEnabled": { "description": "True if the store accepts cash payment for pickup orders", "type": "boolean", "example": true }, "TipsEnabled": { "description": "True if the store accepts tips", "type": "boolean", "example": true }, "AutomaticallyAcceptOrders": { "description": "True if the stores orders are automatically accepted in Flipdish", "type": "boolean", "example": true }, "OpenForDelivery": { "description": "True if the store is open for delivery", "type": "boolean", "example": true }, "OpenForPickup": { "description": "True if the store is open for pickup", "type": "boolean", "example": true }, "MinimumPickupOrderAmount": { "format": "double", "description": "Minimum pickup order amount", "type": "number", "example": 12.5 }, "RequireCustomerNameForPickup": { "description": "True if customer name required for pickup orders", "type": "boolean", "example": true }, "GdprCustomerPhoneNumbers": { "description": "Mask your customers phone numbers printed on receipts and reduce the amout of personally identifiable customer information that is exposed.", "type": "boolean", "example": true }, "RequireCustomerNameForDelivery": { "description": "True if customer name required for delivery orders", "type": "boolean", "example": true }, "AllowChefNotes": { "description": "True if the customer is allowed enter custom notes with their orders", "type": "boolean", "example": true }, "EtaInPickupConfirmationSmsEnabled": { "description": "True if order confirmation sms includes estimated time when order will be ready for collection", "type": "boolean", "example": true }, "EtaInDeliveryConfirmationSmsEnabled": { "description": "True if order confirmation sms includes estimated time when order will delivered", "type": "boolean", "example": true }, "IsArchived": { "description": "Is the Store Archived", "type": "boolean", "example": true }, "IsPublished": { "description": "Is the Store Published", "type": "boolean", "example": true }, "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "EmailAddress": { "description": "Email address (visible to customers)", "maxLength": 100, "minLength": 0, "type": "string", "example": "owner@example.com" }, "StaffLanguage": { "description": "Staff Language (used for communication with the staff)\r\nEmails, Printouts etc", "type": "string", "example": "string" }, "SalesChannelTypes": { "description": "Sales Channel Types", "type": "array", "items": { "enum": [ "Web", "App", "Kiosk", "Pos", "None" ], "type": "string" }, "example": [ "Web" ] }, "InheritanceConfigTypes": { "description": "Inheritance Config Types", "type": "array", "items": { "enum": [ "CollectionSettings" ], "type": "string" }, "example": [ "CollectionSettings" ] } } }, "StoreCloneSettings": { "description": "Settings for cloning a store", "type": "object", "properties": { "TargetStoreGroupId": { "format": "int32", "description": "If specified will clone to a specific store group, otherwise will clone to the store group of the Store which is being cloned", "type": "integer", "nullable": true, "example": 500123 } } }, "StoreCollectionSettings": { "description": "Store Collection Settings", "required": [ "PickupEnabled", "MinimumPickupOrderAmount", "RequireCustomerNameForPickup", "CashOrdersPickupEnabled", "LeadTimeMinutes", "EtaInPickupConfirmationSmsEnabled" ], "type": "object", "properties": { "PickupEnabled": { "description": "True if the store accepts pickup orders", "type": "boolean", "example": true }, "MinimumPickupOrderAmount": { "format": "double", "description": "Minimum pickup order amount", "type": "number", "example": 12.5 }, "RequireCustomerNameForPickup": { "description": "True if customer name required for pickup orders", "type": "boolean", "example": true }, "CashOrdersPickupEnabled": { "description": "True if the store accepts cash payment for pickup orders", "type": "boolean", "example": true }, "LeadTimeMinutes": { "format": "int32", "description": "Auto accept lead time for collection orders", "type": "integer", "example": 1 }, "EtaInPickupConfirmationSmsEnabled": { "description": "True if order confirmation sms includes estimated time when order will be ready for collection", "type": "boolean", "example": true } } }, "StoreConfig": { "description": "StoreConfig.", "type": "object", "properties": { "PickupEnabled": { "description": "True if the store accepts pickup orders", "type": "boolean", "example": true }, "BankAccountAttached": { "description": "True if the store has a Bank Account attached", "type": "boolean", "example": true }, "MenuAssigned": { "description": "True if the store is assigned to a Menu", "type": "boolean", "example": true }, "HasFullAddress": { "description": "True if the store has a valid Address", "type": "boolean", "example": true }, "PickupHours": { "description": "True if the store has Pickup hours", "type": "boolean", "example": true }, "IsPublished": { "description": "Is the Store Published", "type": "boolean", "example": true } } }, "StoreDataPoint": { "description": "Store Data Point", "type": "object", "properties": { "Day": { "format": "date-time", "description": "Day", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Value": { "format": "double", "description": "Value for the day", "type": "number", "example": 1.0 } } }, "StoreDeliveryZoneFeeConfig": { "description": "Store delivery zone fee config", "type": "object", "properties": { "DeliveryZoneId": { "format": "int32", "description": "ID of the delivery zone this fee corresponds to", "type": "integer", "example": 500123 }, "Fee": { "format": "double", "description": "Fee for delivery within this zone", "type": "number", "example": 12.5 } } }, "StoreDeliveryZoneFeeConfigUpdateRequest": { "description": "Request to update store delivery zone fee config", "type": "object", "properties": { "DeliveryZoneFees": { "description": "Delivery zone fees to update", "type": "array", "items": { "$ref": "#/components/schemas/StoreDeliveryZoneFeeConfig" }, "example": [] } } }, "StoreEndOfDayReport": { "description": "Store end of day report", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreName": { "description": "Store name", "type": "string", "example": "Example Name" }, "Currency": { "description": "Currency", "enum": [ "EUR", "USD", "GBP", "CAD", "AUD", "DJF", "ZAR", "ETB", "AED", "BHD", "DZD", "EGP", "IQD", "JOD", "KWD", "LBP", "LYD", "MAD", "OMR", "QAR", "SAR", "SYP", "TND", "YER", "CLP", "INR", "AZN", "RUB", "BYN", "BGN", "NGN", "BDT", "CNY", "BAM", "CZK", "DKK", "CHF", "MVR", "BTN", "XCD", "BZD", "HKD", "IDR", "JMD", "MYR", "NZD", "PHP", "SGD", "TTD", "XDR", "ARS", "BOB", "COP", "CRC", "CUP", "DOP", "GTQ", "HNL", "MXN", "NIO", "PAB", "PEN", "PYG", "UYU", "VEF", "IRR", "XOF", "CDF", "XAF", "HTG", "ILS", "HRK", "HUF", "AMD", "ISK", "JPY", "GEL", "KZT", "KHR", "KRW", "KGS", "LAK", "MKD", "MNT", "BND", "MMK", "NOK", "NPR", "PKR", "PLN", "AFN", "BRL", "MDL", "RON", "RWF", "SEK", "LKR", "SOS", "ALL", "RSD", "KES", "TJS", "THB", "ERN", "TMT", "BWP", "TRY", "UAH", "UZS", "VND", "MOP", "TWD", "BMD" ], "type": "string", "example": "EUR" }, "OrderCount": { "format": "int32", "description": "Order Count", "type": "integer", "example": 3 }, "OrderValue": { "format": "double", "description": "Order Value", "type": "number", "example": 1.0 }, "OrderValueExcludingDeliveryFees": { "format": "double", "description": "Order Value Excluding Delivery Fees", "type": "number", "example": 12.5 }, "CollectionOrderCount": { "format": "int32", "description": "Collection Order Count", "type": "integer", "example": 3 }, "CollectionCashOrderCount": { "format": "int32", "description": "Collection Cash Order Count", "type": "integer", "example": 3 }, "CollectionPaidOnlineOrderCount": { "format": "int32", "description": "Collection Paid Online Order Count", "type": "integer", "example": 3 }, "CollectionOrderValue": { "format": "double", "description": "Collection Order Value", "type": "number", "example": 1.0 }, "CollectionCashOrderValue": { "format": "double", "description": "Collection Cash Order Value", "type": "number", "example": 1.0 }, "CollectionPaidOnlineOrderValue": { "format": "double", "description": "Collection Paid Online Order Value", "type": "number", "example": 1.0 }, "DeliveryOrderCount": { "format": "int32", "description": "Delivery Order Count", "type": "integer", "example": 3 }, "DeliveryCashOrderCount": { "format": "int32", "description": "Delivery Cash Order Count", "type": "integer", "example": 3 }, "DeliveryPaidOnlineOrderCount": { "format": "int32", "description": "Delivery Paid Online Order Count", "type": "integer", "example": 3 }, "DeliveryOrderValue": { "format": "double", "description": "Delivery Order Value", "type": "number", "example": 1.0 }, "DeliveryCashOrderValue": { "format": "double", "description": "Delivery Cash Order Value", "type": "number", "example": 1.0 }, "DeliveryPaidOnlineOrderValue": { "format": "double", "description": "Delivery Paid Online Order Value", "type": "number", "example": 1.0 }, "PaidOnlineOrderCount": { "format": "int32", "description": "Paid Online Order Count", "type": "integer", "example": 3 }, "CashOrderCount": { "format": "int32", "description": "Cash Order Count", "type": "integer", "example": 3 }, "PaidOnlineOrderValue": { "format": "double", "description": "Paid Online Order Value", "type": "number", "example": 1.0 }, "CashOrderValue": { "format": "double", "description": "Cash Order Value", "type": "number", "example": 1.0 }, "PaidOnlineOrderValueExcludingDeliveryFees": { "format": "double", "description": "Paid Online Order Value Excluding Delivery Fees", "type": "number", "example": 12.5 }, "CashOrderValueExcludingDeliveryFees": { "format": "double", "description": "Cash Order Value Excluding Delivery Fees", "type": "number", "example": 12.5 }, "StartTime": { "format": "date-time", "description": "Start Time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "EndTime": { "format": "date-time", "description": "End Time", "type": "string", "example": "2026-06-02T12:00:00Z" } } }, "StoreFeeConfig": { "description": "", "type": "object", "properties": { "FeeConfigId": { "format": "int32", "description": "", "type": "integer", "example": 500123 }, "StoreId": { "format": "int32", "description": "", "type": "integer", "example": 500123 }, "StartTime": { "format": "date-time", "description": "", "type": "string", "example": "2026-06-02T12:00:00Z" }, "PercentFeeCardOrders": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "PercentFeeCashOrders": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "PercentFeeCardOrdersWeb": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "PercentFeeCashOrdersWeb": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "PercentFeeCardOrdersKiosk": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "PercentFeeCashOrdersKiosk": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "FixedFeeCardOrdersKiosk": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "FixedFeeCashOrdersKiosk": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "PercentFeeCardOrdersKioskChargedToCustomerIncludingVat": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "FixedFeeCardOrdersKioskChargedToCustomerIncludingVat": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "PercentFeeCashOrdersKioskChargedToCustomerIncludingVat": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "FixedFeeCashOrdersKioskChargedToCustomerIncludingVat": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "FixedFeeCardOrders": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "FixedFeeCashOrders": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "PercentFeeCardOrdersChargedToCustomerIncludingVat": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "FixedFeeCardOrdersChargedToCustomerIncludingVat": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "PercentFeeCashOrdersChargedToCustomerIncludingVat": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "FixedFeeCashOrdersChargedToCustomerIncludingVat": { "format": "double", "description": "", "type": "number", "example": 12.5 }, "PercentFeeTips": { "format": "double", "description": "Gets or sets the percent fee tips.", "type": "number", "example": 12.5 }, "PercentFeeTipsCollection": { "format": "double", "description": "Gets or sets the percent fee tips for collection.", "type": "number", "example": 12.5 }, "PercentFeeTipsDelivery": { "format": "double", "description": "Gets or sets the percent fee tips for delivery.", "type": "number", "example": 12.5 }, "TaxRatePercent": { "format": "double", "description": "Gets or sets the tax rate percent.", "type": "number", "example": 1.0 }, "PercentFeeCardOrdersLocationService": { "format": "double", "description": "Gets or sets the percent fee card orders location service.", "type": "number", "example": 12.5 }, "PercentFeeCashOrdersLocationService": { "format": "double", "description": "Gets or sets the percent fee cash orders location service.", "type": "number", "example": 12.5 }, "FixedFeeCardOrdersLocationService": { "format": "double", "description": "Gets or sets the fixed fee card orders location service.", "type": "number", "example": 12.5 }, "FixedFeeCashOrdersLocationService": { "format": "double", "description": "Gets or sets the fixed fee cash orders location service.", "type": "number", "example": 12.5 }, "PercentFeeCardOrdersLocationServiceChargedToCustomerIncludingVat": { "format": "double", "description": "Gets or sets the percent fee card orders location service charged to customer including vat.", "type": "number", "example": 12.5 }, "PercentFeeCashOrdersLocationServiceChargedToCustomerIncludingVat": { "format": "double", "description": "Gets or sets the percent fee cash orders location service charged to customer including vat.", "type": "number", "example": 12.5 }, "FixedFeeCardOrdersLocationServiceChargedToCustomerIncludingVat": { "format": "double", "description": "Gets or sets the fixed fee card orders location service charged to customer including vat.", "type": "number", "example": 12.5 }, "FixedFeeCashOrdersLocationServiceChargedToCustomerIncludingVat": { "format": "double", "description": "Gets or sets the fixed fee cash orders location service charged to customer including vat.", "type": "number", "example": 12.5 }, "PercentFeeCardOrdersIngest": { "format": "double", "description": "Gets or sets the percent fee card orders ingest.", "type": "number", "nullable": true, "example": 12.5 }, "PercentFeeCashOrdersIngest": { "format": "double", "description": "Gets or sets the percent fee cash orders ingest.", "type": "number", "nullable": true, "example": 12.5 }, "FixedFeeCardOrdersIngest": { "format": "double", "description": "Gets or sets the fixed fee card orders ingest.", "type": "number", "nullable": true, "example": 12.5 }, "FixedFeeCashOrdersIngest": { "format": "double", "description": "Gets or sets the fixed fee cash orders ingest.", "type": "number", "nullable": true, "example": 12.5 }, "PercentFeeDelivery": { "format": "double", "description": "Gets or sets the percent fee for delivery orders.", "type": "number", "example": 12.5 }, "FixedFeeDelivery": { "format": "double", "description": "Gets or sets the fixed fee for delivery orders.", "type": "number", "example": 12.5 }, "PercentFeeCardPosTransaction": { "format": "double", "description": "Gets or sets the percent fee for POS transactions.", "type": "number", "example": 12.5 }, "FixedFeeCardPosTransaction": { "format": "double", "description": "Gets or sets the fixed fee for POS transactions.", "type": "number", "example": 12.5 }, "PercentFeeOrderWithGoogle": { "format": "double", "description": "Additional percentage fee charged on orders submitted through Order With Google", "type": "number", "example": 12.5 }, "FixedFeeOrderWithGoogle": { "format": "double", "description": "Additional fixed fee charged on orders submitted through Order With Google", "type": "number", "example": 12.5 }, "ShouldNotAutoIncreaseBefore": { "format": "date-time", "description": "Should not auto increase fees before this date", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "Reason": { "description": "Reason for the last fee change (optional)", "type": "string", "example": "string" }, "PercentFeeCardOrdersPhoneAgent": { "format": "double", "description": "Gets or sets the percent fee card orders phone agent.", "type": "number", "example": 12.5 }, "PercentFeeCashOrdersPhoneAgent": { "format": "double", "description": "Gets or sets the percent fee cash orders phone agent.", "type": "number", "example": 12.5 }, "FixedFeeCardOrdersPhoneAgent": { "format": "double", "description": "Gets or sets the fixed fee card orders phone agent.", "type": "number", "example": 12.5 }, "FixedFeeCashOrdersPhoneAgent": { "format": "double", "description": "Gets or sets the fixed fee cash orders phone agent.", "type": "number", "example": 12.5 }, "PercentFeeCardOrdersPhoneAgentChargedToCustomerIncludingVat": { "format": "double", "description": "Gets or sets the percent fee card orders phone agent charged to customer including vat.", "type": "number", "example": 12.5 }, "PercentFeeCashOrdersPhoneAgentChargedToCustomerIncludingVat": { "format": "double", "description": "Gets or sets the percent fee cash orders phone agent charged to customer including vat.", "type": "number", "example": 12.5 }, "FixedFeeCardOrdersPhoneAgentChargedToCustomerIncludingVat": { "format": "double", "description": "Gets or sets the fixed fee card orders phone agent charged to customer including vat.", "type": "number", "example": 12.5 }, "FixedFeeCashOrdersPhoneAgentChargedToCustomerIncludingVat": { "format": "double", "description": "Gets or sets the fixed fee cash orders phone agent charged to customer including vat.", "type": "number", "example": 12.5 } } }, "StoreGroup": { "description": "Store Group", "type": "object", "properties": { "StoreGroupId": { "format": "int32", "description": "Unique Store Group Identifier", "type": "integer", "example": 500123 }, "GeneralRating": { "format": "double", "description": "Store Group rating", "type": "number", "nullable": true, "example": 1.0 }, "GeneralRatingCount": { "format": "int32", "description": "Store Group rating count", "type": "integer", "example": 3 }, "DeliveryMenuMessage": { "description": "Delivery menu message", "type": "string", "example": "string" }, "PickupMenuMessage": { "description": "Pickup menu message", "type": "string", "example": "string" }, "BrandIds": { "description": "List of brand ids (AppIds) that are associated with this store group", "type": "array", "items": { "type": "string" }, "example": [ "string" ] }, "Name": { "description": "Store Group Name", "type": "string", "example": "Example Name" }, "Currency": { "description": "Currency used by the stores in this group", "enum": [ "EUR", "USD", "GBP", "CAD", "AUD", "DJF", "ZAR", "ETB", "AED", "BHD", "DZD", "EGP", "IQD", "JOD", "KWD", "LBP", "LYD", "MAD", "OMR", "QAR", "SAR", "SYP", "TND", "YER", "CLP", "INR", "AZN", "RUB", "BYN", "BGN", "NGN", "BDT", "CNY", "BAM", "CZK", "DKK", "CHF", "MVR", "BTN", "XCD", "BZD", "HKD", "IDR", "JMD", "MYR", "NZD", "PHP", "SGD", "TTD", "XDR", "ARS", "BOB", "COP", "CRC", "CUP", "DOP", "GTQ", "HNL", "MXN", "NIO", "PAB", "PEN", "PYG", "UYU", "VEF", "IRR", "XOF", "CDF", "XAF", "HTG", "ILS", "HRK", "HUF", "AMD", "ISK", "JPY", "GEL", "KZT", "KHR", "KRW", "KGS", "LAK", "MKD", "MNT", "BND", "MMK", "NOK", "NPR", "PKR", "PLN", "AFN", "BRL", "MDL", "RON", "RWF", "SEK", "LKR", "SOS", "ALL", "RSD", "KES", "TJS", "THB", "ERN", "TMT", "BWP", "TRY", "UAH", "UZS", "VND", "MOP", "TWD", "BMD" ], "type": "string", "example": "EUR" } } }, "StoreGroupBase": { "description": "Update Store Group", "type": "object", "properties": { "Name": { "description": "Store Group Name", "type": "string", "example": "Example Name" }, "Currency": { "description": "Currency used by the stores in this group", "enum": [ "EUR", "USD", "GBP", "CAD", "AUD", "DJF", "ZAR", "ETB", "AED", "BHD", "DZD", "EGP", "IQD", "JOD", "KWD", "LBP", "LYD", "MAD", "OMR", "QAR", "SAR", "SYP", "TND", "YER", "CLP", "INR", "AZN", "RUB", "BYN", "BGN", "NGN", "BDT", "CNY", "BAM", "CZK", "DKK", "CHF", "MVR", "BTN", "XCD", "BZD", "HKD", "IDR", "JMD", "MYR", "NZD", "PHP", "SGD", "TTD", "XDR", "ARS", "BOB", "COP", "CRC", "CUP", "DOP", "GTQ", "HNL", "MXN", "NIO", "PAB", "PEN", "PYG", "UYU", "VEF", "IRR", "XOF", "CDF", "XAF", "HTG", "ILS", "HRK", "HUF", "AMD", "ISK", "JPY", "GEL", "KZT", "KHR", "KRW", "KGS", "LAK", "MKD", "MNT", "BND", "MMK", "NOK", "NPR", "PKR", "PLN", "AFN", "BRL", "MDL", "RON", "RWF", "SEK", "LKR", "SOS", "ALL", "RSD", "KES", "TJS", "THB", "ERN", "TMT", "BWP", "TRY", "UAH", "UZS", "VND", "MOP", "TWD", "BMD" ], "type": "string", "example": "EUR" } } }, "StoreGroupExtended": { "description": "Store Group Extended", "type": "object", "properties": { "TotalStores": { "format": "int32", "description": "Total Amount of Stores", "type": "integer", "example": 12.5 }, "GroupedCoordinates": { "description": "Grouped store coordinates", "type": "array", "items": { "$ref": "#/components/schemas/GroupedCoordinates" }, "example": [] }, "StoreHeaders": { "description": "Store Headers associated with Store Group", "type": "array", "items": { "$ref": "#/components/schemas/StoreHeader" }, "example": [] }, "StoreGroupId": { "format": "int32", "description": "Unique Store Group Identifier", "type": "integer", "example": 500123 }, "GeneralRating": { "format": "double", "description": "Store Group rating", "type": "number", "nullable": true, "example": 1.0 }, "GeneralRatingCount": { "format": "int32", "description": "Store Group rating count", "type": "integer", "example": 3 }, "DeliveryMenuMessage": { "description": "Delivery menu message", "type": "string", "example": "string" }, "PickupMenuMessage": { "description": "Pickup menu message", "type": "string", "example": "string" }, "BrandIds": { "description": "List of brand ids (AppIds) that are associated with this store group", "type": "array", "items": { "type": "string" }, "example": [ "string" ] }, "Name": { "description": "Store Group Name", "type": "string", "example": "Example Name" }, "Currency": { "description": "Currency used by the stores in this group", "enum": [ "EUR", "USD", "GBP", "CAD", "AUD", "DJF", "ZAR", "ETB", "AED", "BHD", "DZD", "EGP", "IQD", "JOD", "KWD", "LBP", "LYD", "MAD", "OMR", "QAR", "SAR", "SYP", "TND", "YER", "CLP", "INR", "AZN", "RUB", "BYN", "BGN", "NGN", "BDT", "CNY", "BAM", "CZK", "DKK", "CHF", "MVR", "BTN", "XCD", "BZD", "HKD", "IDR", "JMD", "MYR", "NZD", "PHP", "SGD", "TTD", "XDR", "ARS", "BOB", "COP", "CRC", "CUP", "DOP", "GTQ", "HNL", "MXN", "NIO", "PAB", "PEN", "PYG", "UYU", "VEF", "IRR", "XOF", "CDF", "XAF", "HTG", "ILS", "HRK", "HUF", "AMD", "ISK", "JPY", "GEL", "KZT", "KHR", "KRW", "KGS", "LAK", "MKD", "MNT", "BND", "MMK", "NOK", "NPR", "PKR", "PLN", "AFN", "BRL", "MDL", "RON", "RWF", "SEK", "LKR", "SOS", "ALL", "RSD", "KES", "TJS", "THB", "ERN", "TMT", "BWP", "TRY", "UAH", "UZS", "VND", "MOP", "TWD", "BMD" ], "type": "string", "example": "EUR" } } }, "StoreHeader": { "description": "Represents the most basic store information, used mostly for searches", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "Store identifier", "type": "integer", "example": 500123 }, "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "Category": { "description": "Name", "type": "string", "example": "string" } } }, "StoreNote": { "description": "Store note", "type": "object", "properties": { "UserId": { "format": "int32", "description": "User identifier", "type": "integer", "example": 500123 }, "CreateTime": { "format": "date-time", "description": "Create time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Note": { "description": "Note", "type": "string", "example": "string" } } }, "StoreOrderCapacityConfig": { "description": "Represents one store's order capacity configuration", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "Store identifier", "type": "integer", "example": 500123 }, "DeliveryType": { "description": "Signifies whether the order capacity configuration is for Delivery / Pickup", "enum": [ "Delivery", "Pickup" ], "type": "string", "example": "Delivery" }, "StoreIntervalInMinutes": { "format": "int32", "description": "Store Interval - time between orders, e.g. 10 minutes between each order time available to customer", "type": "integer", "example": 1 }, "OrderCapacityPeriods": { "description": "Order capacity periods", "type": "array", "items": { "$ref": "#/components/schemas/StoreOrderCapacityPeriod" }, "example": [] } } }, "StoreOrderCapacityConfigEditModel": { "description": "Represents one store's order capacity configuration edit", "type": "object", "properties": { "OrderCapacityPeriods": { "description": "Order capacity periods", "type": "array", "items": { "$ref": "#/components/schemas/StoreOrderCapacityPeriod" }, "example": [] } } }, "StoreOrderCapacityPeriod": { "description": "Represents a single order capacity period", "type": "object", "properties": { "MaxOrderNumberPerStoreInterval": { "format": "int32", "description": "The maximum number of orders per each store order interval in this order capacity period.\r\nE.g. for a period from 9:00 till 11:00, if the store's interval is 10 minutes, and MaxOrderNumberPerStoreInterval is set to 5,\r\nit means that within each 10-minute interval between 9:00 and 11:00 (i.e. 9:00-9:10, 9:10-9:20, .. , 10:50-11:00) it will be possible to\r\nrequest at most 5 orders.", "type": "integer", "example": 3 }, "DayOfTheWeek": { "description": "Day of the week the period pertains to", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "example": "Sunday" }, "PeriodStartHour": { "format": "int32", "description": "The hour the period starts at", "type": "integer", "example": 1 }, "PeriodStartMinutes": { "format": "int32", "description": "The minutes after the hour the period starts at", "type": "integer", "example": 1 }, "PeriodEndHour": { "format": "int32", "description": "The hour the period ends at", "type": "integer", "example": 1 }, "PeriodEndMinutes": { "format": "int32", "description": "The minutes after the hour the period ends at", "type": "integer", "example": 1 } } }, "StoreStatistics": { "description": "Store statistics", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "Data": { "description": "Store Data Points", "type": "array", "items": { "$ref": "#/components/schemas/StoreDataPoint" }, "example": [] } } }, "StoreValidationConfig": { "description": "Hey", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "Store identifier", "type": "integer", "example": 500123 }, "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "IsValid": { "description": "Is Store Valid for Kiosk", "type": "boolean", "example": true }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "example": 500123 }, "ConfigValidation": { "$ref": "#/components/schemas/StoreConfig" } } }, "UpdateLocationArea": { "description": "Input model for updating a LocationArea", "required": [ "LocationAreaId", "LocationAreaName" ], "type": "object", "properties": { "LocationAreaId": { "format": "int32", "description": "Location Area Id", "type": "integer", "example": 500123 }, "LocationAreaName": { "description": "Descriptive LocationArea name", "type": "string", "example": "Example Name" }, "IsDeleted": { "description": "Sets if the Location Area should be soft deleted or not", "type": "boolean", "example": true } } } }, "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" } } } } } } }