{ "openapi": "3.0.3", "info": { "title": "Flipdish API - Platform", "version": "v1.0", "description": "Flipdish Open API v1.0 \u2014 Platform 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": "Apm", "description": "Operations for Apm." }, { "name": "AuditLogs", "description": "Operations for Audit Logs." }, { "name": "AuthorizationTokens", "description": "Operations for Authorization Tokens." }, { "name": "Clients", "description": "Operations for Clients." }, { "name": "ContentSecurityPolicy", "description": "Operations for Content Security Policy." }, { "name": "Events", "description": "Operations for Events." }, { "name": "Features", "description": "Operations for Features." }, { "name": "Files", "description": "Operations for Files." }, { "name": "Fpm", "description": "Operations for Fpm." }, { "name": "Home", "description": "Operations for Home." }, { "name": "Hydra", "description": "Operations for Hydra." }, { "name": "Intercom", "description": "Operations for Intercom." }, { "name": "Lightspeed", "description": "Operations for Lightspeed." }, { "name": "LookerDashboard", "description": "Operations for Looker Dashboard." }, { "name": "LookerSingleSignOn", "description": "Operations for Looker Single Sign On." }, { "name": "OAuthClients", "description": "Operations for OAuth Clients." }, { "name": "Onboarding", "description": "Operations for Onboarding." }, { "name": "Search", "description": "Operations for Search." }, { "name": "SmsProviderCredentials", "description": "Operations for Sms Provider Credentials." }, { "name": "Stuart", "description": "Operations for Stuart." }, { "name": "Webhooks", "description": "Operations for Webhooks." } ], "paths": { "/api/v1.0/{appId}/apm/status": { "get": { "tags": [ "Apm" ], "operationId": "GetApmStatus", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_ApmStatus_" }, "examples": { "GetApmStatus200Example": { "summary": "Default GetApmStatus 200 response", "x-microcks-default": true, "value": { "Data": { "IsApmEnabled": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetApmStatus400Example": { "summary": "Default GetApmStatus 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": { "GetApmStatus401Example": { "summary": "Default GetApmStatus 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": { "GetApmStatus403Example": { "summary": "Default GetApmStatus 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": { "GetApmStatus500Example": { "summary": "Default GetApmStatus 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 Apm Status", "description": "Get Apm Status via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/apm/status).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/apm/statistics": { "get": { "tags": [ "Apm" ], "operationId": "GetBasicStatistics", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "query", "required": false, "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/RestApiResult_ApmStatistics_" }, "examples": { "GetBasicStatistics200Example": { "summary": "Default GetBasicStatistics 200 response", "x-microcks-default": true, "value": { "Data": { "EstimatedMinutesSaved": 1, "EstimatedMinutesCouldSaved": 1, "CurrencyData": [] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetBasicStatistics400Example": { "summary": "Default GetBasicStatistics 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": { "GetBasicStatistics401Example": { "summary": "Default GetBasicStatistics 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": { "GetBasicStatistics403Example": { "summary": "Default GetBasicStatistics 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": { "GetBasicStatistics500Example": { "summary": "Default GetBasicStatistics 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 Basic Statistics", "description": "Get Basic Statistics via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/apm/statistics).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/apm/statistics/calendar": { "get": { "tags": [ "Apm" ], "operationId": "GetCalendarWeekStatistics", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "query", "required": false, "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_ApmHourlyDataPoint_" }, "examples": { "GetCalendarWeekStatistics200Example": { "summary": "Default GetCalendarWeekStatistics 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCalendarWeekStatistics400Example": { "summary": "Default GetCalendarWeekStatistics 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": { "GetCalendarWeekStatistics401Example": { "summary": "Default GetCalendarWeekStatistics 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": { "GetCalendarWeekStatistics403Example": { "summary": "Default GetCalendarWeekStatistics 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": { "GetCalendarWeekStatistics500Example": { "summary": "Default GetCalendarWeekStatistics 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 Calendar Week Statistics", "description": "Get Calendar Week Statistics via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/apm/statistics/calendar).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/apm/calls": { "get": { "tags": [ "Apm" ], "operationId": "GetPaginatedCallList", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path 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": "storeId", "in": "query", "required": false, "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/RestApiPaginationResult_PhoneCall_" }, "examples": { "GetPaginatedCallList200Example": { "summary": "Default GetPaginatedCallList 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": { "GetPaginatedCallList400Example": { "summary": "Default GetPaginatedCallList 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": { "GetPaginatedCallList401Example": { "summary": "Default GetPaginatedCallList 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": { "GetPaginatedCallList403Example": { "summary": "Default GetPaginatedCallList 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": { "GetPaginatedCallList500Example": { "summary": "Default GetPaginatedCallList 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 Paginated Call List", "description": "Get Paginated Call List via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/apm/calls).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/apm/statistics/calls/{aggregateDataBy}": { "get": { "tags": [ "Apm" ], "operationId": "GetCallsStatistics", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "aggregateDataBy", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Daily", "Weekly", "Monthly" ] }, "description": "The aggregate data by path parameter.", "example": "Daily" }, { "name": "dataPointLimit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The data point limit query parameter.", "example": 1 }, { "name": "storeId", "in": "query", "required": false, "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_ApmDataPoint_" }, "examples": { "GetCallsStatistics200Example": { "summary": "Default GetCallsStatistics 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCallsStatistics400Example": { "summary": "Default GetCallsStatistics 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": { "GetCallsStatistics401Example": { "summary": "Default GetCallsStatistics 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": { "GetCallsStatistics403Example": { "summary": "Default GetCallsStatistics 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": { "GetCallsStatistics500Example": { "summary": "Default GetCallsStatistics 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 Calls Statistics", "description": "Get Calls Statistics via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/apm/statistics/calls/{aggregateDataBy}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/apm/statistics/orders/{aggregateDataBy}": { "get": { "tags": [ "Apm" ], "operationId": "GetOrderStatistics", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "aggregateDataBy", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Daily", "Weekly", "Monthly" ] }, "description": "The aggregate data by path parameter.", "example": "Daily" }, { "name": "dataPointLimit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The data point limit query parameter.", "example": 1 }, { "name": "storeId", "in": "query", "required": false, "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_ApmCurrencyDataPoint_" }, "examples": { "GetOrderStatistics200Example": { "summary": "Default GetOrderStatistics 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetOrderStatistics400Example": { "summary": "Default GetOrderStatistics 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": { "GetOrderStatistics401Example": { "summary": "Default GetOrderStatistics 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": { "GetOrderStatistics403Example": { "summary": "Default GetOrderStatistics 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": { "GetOrderStatistics500Example": { "summary": "Default GetOrderStatistics 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 Order Statistics", "description": "Get Order Statistics via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/apm/statistics/orders/{aggregateDataBy}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/auditlogs/orders/{orderId}": { "post": { "tags": [ "AuditLogs" ], "operationId": "AddOrderAuditLog", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The order id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddOrderAuditLog400Example": { "summary": "Default AddOrderAuditLog 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": { "AddOrderAuditLog401Example": { "summary": "Default AddOrderAuditLog 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": { "AddOrderAuditLog403Example": { "summary": "Default AddOrderAuditLog 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": { "AddOrderAuditLog500Example": { "summary": "Default AddOrderAuditLog 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 Order Audit Log", "description": "Add Order Audit Log via the Flipdish Open API v1.0 (POST /api/v1.0/auditlogs/orders/{orderId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/auditlogs/stores/{storeId}": { "post": { "tags": [ "AuditLogs" ], "operationId": "AddStoreAuditLogEvent", "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" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddStoreAuditLogEvent400Example": { "summary": "Default AddStoreAuditLogEvent 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": { "AddStoreAuditLogEvent401Example": { "summary": "Default AddStoreAuditLogEvent 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": { "AddStoreAuditLogEvent403Example": { "summary": "Default AddStoreAuditLogEvent 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": { "AddStoreAuditLogEvent500Example": { "summary": "Default AddStoreAuditLogEvent 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 Store Audit Log Event", "description": "Add Store Audit Log Event via the Flipdish Open API v1.0 (POST /api/v1.0/auditlogs/stores/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/authorizationtokens/{oauthAppId}": { "get": { "tags": [ "AuthorizationTokens" ], "operationId": "GetAuthorizationTokens", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path 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_OAuthTokenModel_" }, "examples": { "GetAuthorizationTokens200Example": { "summary": "Default GetAuthorizationTokens 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": { "GetAuthorizationTokens400Example": { "summary": "Default GetAuthorizationTokens 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": { "GetAuthorizationTokens401Example": { "summary": "Default GetAuthorizationTokens 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAuthorizationTokens403Example": { "summary": "Default GetAuthorizationTokens 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": { "GetAuthorizationTokens404Example": { "summary": "Default GetAuthorizationTokens 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": { "GetAuthorizationTokens500Example": { "summary": "Default GetAuthorizationTokens 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 Authorization Tokens", "description": "Get Authorization Tokens via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/authorizationtokens/{oauthAppId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/authorizationtokens/{key}": { "delete": { "tags": [ "AuthorizationTokens" ], "operationId": "RevokeToken", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The key path parameter.", "example": "string" }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RevokeToken400Example": { "summary": "Default RevokeToken 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": { "RevokeToken401Example": { "summary": "Default RevokeToken 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RevokeToken403Example": { "summary": "Default RevokeToken 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": { "RevokeToken404Example": { "summary": "Default RevokeToken 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": { "RevokeToken500Example": { "summary": "Default RevokeToken 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 Revoke Token", "description": "Revoke Token via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/authorizationtokens/{key}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/clients/{clientId}": { "get": { "tags": [ "Clients" ], "operationId": "GetClient", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The client id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetClient400Example": { "summary": "Default GetClient 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": { "GetClient401Example": { "summary": "Default GetClient 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": { "GetClient403Example": { "summary": "Default GetClient 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": { "GetClient404Example": { "summary": "Default GetClient 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": { "GetClient500Example": { "summary": "Default GetClient 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 Client", "description": "Get Client via the Flipdish Open API v1.0 (GET /api/v1.0/clients/{clientId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/clients/{clientId}/stripecustomerid": { "post": { "tags": [ "Clients" ], "operationId": "SetStripeCustomerId", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The client id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetStripeCustomerId400Example": { "summary": "Default SetStripeCustomerId 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": { "SetStripeCustomerId401Example": { "summary": "Default SetStripeCustomerId 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": { "SetStripeCustomerId403Example": { "summary": "Default SetStripeCustomerId 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": { "SetStripeCustomerId404Example": { "summary": "Default SetStripeCustomerId 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": { "SetStripeCustomerId500Example": { "summary": "Default SetStripeCustomerId 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 Stripe Customer Id", "description": "Set Stripe Customer Id via the Flipdish Open API v1.0 (POST /api/v1.0/clients/{clientId}/stripecustomerid).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/clients/{clientId}/salesforcecontactid": { "post": { "tags": [ "Clients" ], "operationId": "SetSalesForceContactId", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The client id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetSalesForceContactId400Example": { "summary": "Default SetSalesForceContactId 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": { "SetSalesForceContactId401Example": { "summary": "Default SetSalesForceContactId 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": { "SetSalesForceContactId403Example": { "summary": "Default SetSalesForceContactId 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": { "SetSalesForceContactId404Example": { "summary": "Default SetSalesForceContactId 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": { "SetSalesForceContactId500Example": { "summary": "Default SetSalesForceContactId 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 Sales Force Contact Id", "description": "Set Sales Force Contact Id via the Flipdish Open API v1.0 (POST /api/v1.0/clients/{clientId}/salesforcecontactid).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/csp/report": { "post": { "tags": [ "ContentSecurityPolicy" ], "operationId": "ContentSecurityPolicy_Report", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CspReportRequest" }, "examples": { "ContentSecurityPolicy_ReportRequestExample": { "summary": "Default ContentSecurityPolicy_Report request", "x-microcks-default": true, "value": { "Csp-report": { "Document-uri": "https://api.flipdish.co/example", "Referrer": "string", "Violated-directive": "string", "Effective-directive": "string", "Original-policy": "string", "Blocked-uri": "https://api.flipdish.co/example", "Status-code": 1 } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "ContentSecurityPolicy_Report200Example": { "summary": "Default ContentSecurityPolicy_Report 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ContentSecurityPolicy_Report400Example": { "summary": "Default ContentSecurityPolicy_Report 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": { "ContentSecurityPolicy_Report401Example": { "summary": "Default ContentSecurityPolicy_Report 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": { "ContentSecurityPolicy_Report403Example": { "summary": "Default ContentSecurityPolicy_Report 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": { "ContentSecurityPolicy_Report500Example": { "summary": "Default ContentSecurityPolicy_Report 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 Content Security Policy_Report", "description": "Content Security Policy_Report via the Flipdish Open API v1.0 (POST /api/v1.0/csp/report).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/events/{eventId}": { "get": { "tags": [ "Events" ], "operationId": "GetEventsById", "parameters": [ { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The event id path parameter.", "example": "500123" }, { "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/EventSearchResult" }, "examples": { "GetEventsById200Example": { "summary": "Default GetEventsById 200 response", "x-microcks-default": true, "value": { "AppCreatedEvent": [], "AppUpdatedEvent": [], "AnalyticsClientEvent": [], "OrderAcceptedEvent": [], "OrderDispatchedEvent": [], "OrderCustomerTrackingCreatedEvent": [], "OrderDeliveryTrackingStatusUpdatedEvent": [], "OrderBatchPublishedEvent": [], "OrderCreatedEvent": [], "OrderRatingUpdatedEvent": [], "OrderRefundedEvent": [], "OrderRejectedEvent": [], "OrderTipUpdatedEvent": [], "OrderTerminalNotifications": [], "StoreCreatedEvent": [], "StoreDeletedEvent": [], "StoreAddressUpdatedEvent": [], "StoreKioskSettingUpdatedEvent": [], "DeliveryZoneCreatedEvent": [], "DeliveryZoneUpdatedEvent": [], "DeliveryZoneDeletedEvent": [], "StoreOpeningHoursUpdatedEvent": [], "StoreMenuAssignedEvent": [], "StoreBusinessHoursOverrideCreatedEvent": [], "StoreBusinessHoursOverrideDeletedEvent": [], "StoreArchivedEvent": [], "StoreUnarchivedEvent": [], "StorePublishedEvent": [], "StoreUnpublishedEvent": [], "StoreUpdatedEvent": [], "StorePreOrderConfigUpdatedEvent": [], "StoreLogoCreatedEvent": [], "StoreLogoUpdatedEvent": [], "StoreLogoDeletedEvent": [], "MenuCreatedEvent": [], "MenuAsyncCreationCompletedEvent": [], "MenuUpdatedEvent": [], "MenuUploadedEvent": [], "MenuBulkEditEvent": [], "MenuSectionCreatedEvent": [], "MenuSectionUpdatedEvent": [], "MenuSectionDeletedEvent": [], "MenuSectionItemCreatedEvent": [], "MenuSectionItemUpdatedEvent": [], "MenuSectionItemDeletedEvent": [], "MenuItemOptionSetCreatedEvent": [], "MenuItemOptionSetUpdatedEvent": [], "MenuItemOptionSetDeletedEvent": [], "MenuItemOptionSetItemCreatedEvent": [], "MenuItemOptionSetItemUpdatedEvent": [], "MenuItemOptionSetItemDeletedEvent": [], "MenuCheckpointCreatedEvent": [], "StoreGroupCreatedEvent": [], "StoreGroupUpdatedEvent": [], "StoreGroupDeletedEvent": [], "CustomerCreatedEvent": [], "CustomerUpdatedEvent": [], "CustomerConsentUpdatedEvent": [], "WebhookSubscriptionCreatedEvent": [], "WebhookSubscriptionUpdatedEvent": [], "WebhookSubscriptionDeletedEvent": [], "PrinterTurnedOnEvent": [], "PrinterTurnedOffEvent": [], "PrinterAssignedToStoreEvent": [], "PrinterUnassignedFromStoreEvent": [], "PhoneCallStartedEvent": [], "PhoneCallEndedEvent": [], "TelephonyConfigUpdatedEvent": [], "ChannelStoresUpdatedEvent": [], "LoyaltyCampaignCreatedEvent": [], "LoyaltyCampaignDeletedEvent": [], "LoyaltyCampaignUpdatedEvent": [], "RetentionCampaignCreatedEvent": [], "RetentionCampaignDeletedEvent": [], "RetentionCampaignUpdatedEvent": [], "SmsReceivedEvent": [], "UserLoginEvent": [], "UserCreatedEvent": [], "UserUpdatedEvent": [], "UserDeletedEvent": [], "UserCreatedPasswordEvent": [], "UserAnsweredSignupQuestionsEvent": [], "VoucherCreatedEvent": [], "VoucherUpdatedEvent": [], "VoucherDeletedEvent": [], "VoucherAppliedEvent": [], "TeammateInviteSentEvent": [], "TeammateInviteAcceptedEvent": [], "TeammateUpdatedEvent": [], "TeammateDeletedEvent": [], "BankAccountCreatedEvent": [], "BankAccountUpdatedEvent": [], "BankAccountDeletedEvent": [], "BankAccountAssignedEvent": [], "HydraAssignedEvent": [], "HydraRequestResetEvent": [], "HydraStoreAssignedEvent": [], "HydraStoreUnassignedEvent": [], "HydraSettingChangedEvent": [], "HydraUnAssignedEvent": [], "HydraConnectionStatusChangedEvent": [], "KioskBluetoothPairingModeEvent": [], "KioskBluetoothUnpairingModeEvent": [], "KioskBluetoothTerminalUnpairedEvent": [], "KioskTerminalActionStateChangedEvent": [], "KioskBluetoothTerminalUpdatedEvent": [], "KioskBluetoothTerminalInitiateUpdateCheckEvent": [], "KioskBluetoothInstallUpdateInitiateEvent": [], "KioskBluetoothTerminalCancelUpdateEvent": [], "KioskBluetoothTerminalFirmwareVersionStatusEvent": [], "KioskBluetoothTerminalInstallationStatusEvent": [], "PushNotificationScheduledEvent": [], "PushNotificationSentEvent": [], "PushNotificationDeletedEvent": [], "DnsVerifiedEvent": [], "CertificateCreatedEvent": [], "CertificateRenewedEvent": [], "WebsiteVanityUrlUpdatedEvent": [], "WebsiteUpdatedEvent": [], "OrderCapacityUpdatedEvent": [], "ExternalStoreEvent": [], "OrderFulfillmentStatusUpdatedEvent": [], "AppStoreConfigCreatedEvent": [], "AppStoreConfigUpdatedEvent": [], "AppStoreConfigDeletedEvent": [], "AppStoreSubscriptionChangeJobUpdatedEvent": [], "CatalogItemCreatedEvent": [], "CatalogItemUpdatedEvent": [], "CatalogItemArchivedEvent": [], "CatalogGroupCreatedEvent": [], "CatalogGroupUpdatedEvent": [], "CatalogGroupArchivedEvent": [], "StoreTipUpdatedEvent": [], "LocationAreaCreatedEvent": [], "LocationAreaUpdatedEvent": [], "LocationCreatedEvent": [], "LocationDeletedEvent": [], "StoreServiceChargeUpdatedEvent": [], "MobileAppsSubmissionStatusUpdatedEvent": [], "MobileAppsSubmissionUpdatedEvent": [], "StoreFeeConfigUpdatedEvent": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetEventsById400Example": { "summary": "Default GetEventsById 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": { "GetEventsById401Example": { "summary": "Default GetEventsById 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": { "GetEventsById403Example": { "summary": "Default GetEventsById 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": { "GetEventsById500Example": { "summary": "Default GetEventsById 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 Events by Id", "description": "Get Events by Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/{eventId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/events/menu/{menuId}": { "get": { "tags": [ "Events" ], "operationId": "GetMenuEvents", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "menuId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The menu id path parameter.", "example": 500123 }, { "name": "limit", "in": "query", "description": "The maximum elements to return", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "page", "in": "query", "description": "The index of the page to return, starting by 1", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "start", "in": "query", "description": "Start date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "end", "in": "query", "description": "End date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "orderId", "in": "query", "description": "Events that have Order Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "query", "description": "Events that have Store Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeIdList", "in": "query", "description": "Events that have Store Id List", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "example": [ 1 ] }, { "name": "storeGroupId", "in": "query", "description": "Events that have Store Group Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userId", "in": "query", "description": "Events that have User Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuId", "in": "query", "description": "Events that have Menu Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "campaignId", "in": "query", "description": "Events that have Campaign Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userEmail", "in": "query", "description": "Events that have User Email", "required": false, "schema": { "type": "string" }, "example": "owner@example.com" }, { "name": "userName", "in": "query", "description": "Events that have User Name", "required": false, "schema": { "type": "string" }, "example": "Example Name" }, { "name": "voucherCode", "in": "query", "description": "Events that have voucher code", "required": false, "schema": { "type": "string" }, "example": "string" }, { "name": "eventType", "in": "query", "description": "Events that have event type\\s", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "string" ] }, { "name": "flipdishEventId", "in": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored.", "required": false, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiEventSearchPaginationResult" }, "examples": { "GetMenuEvents200Example": { "summary": "Default GetMenuEvents 200 response", "x-microcks-default": true, "value": { "Data": { "AppCreatedEvent": [], "AppUpdatedEvent": [], "AnalyticsClientEvent": [], "OrderAcceptedEvent": [], "OrderDispatchedEvent": [], "OrderCustomerTrackingCreatedEvent": [], "OrderDeliveryTrackingStatusUpdatedEvent": [], "OrderBatchPublishedEvent": [], "OrderCreatedEvent": [], "OrderRatingUpdatedEvent": [], "OrderRefundedEvent": [], "OrderRejectedEvent": [], "OrderTipUpdatedEvent": [], "OrderTerminalNotifications": [], "StoreCreatedEvent": [], "StoreDeletedEvent": [], "StoreAddressUpdatedEvent": [], "StoreKioskSettingUpdatedEvent": [], "DeliveryZoneCreatedEvent": [], "DeliveryZoneUpdatedEvent": [], "DeliveryZoneDeletedEvent": [], "StoreOpeningHoursUpdatedEvent": [], "StoreMenuAssignedEvent": [], "StoreBusinessHoursOverrideCreatedEvent": [], "StoreBusinessHoursOverrideDeletedEvent": [], "StoreArchivedEvent": [], "StoreUnarchivedEvent": [], "StorePublishedEvent": [], "StoreUnpublishedEvent": [], "StoreUpdatedEvent": [], "StorePreOrderConfigUpdatedEvent": [], "StoreLogoCreatedEvent": [], "StoreLogoUpdatedEvent": [], "StoreLogoDeletedEvent": [], "MenuCreatedEvent": [], "MenuAsyncCreationCompletedEvent": [], "MenuUpdatedEvent": [], "MenuUploadedEvent": [], "MenuBulkEditEvent": [], "MenuSectionCreatedEvent": [], "MenuSectionUpdatedEvent": [], "MenuSectionDeletedEvent": [], "MenuSectionItemCreatedEvent": [], "MenuSectionItemUpdatedEvent": [], "MenuSectionItemDeletedEvent": [], "MenuItemOptionSetCreatedEvent": [], "MenuItemOptionSetUpdatedEvent": [], "MenuItemOptionSetDeletedEvent": [], "MenuItemOptionSetItemCreatedEvent": [], "MenuItemOptionSetItemUpdatedEvent": [], "MenuItemOptionSetItemDeletedEvent": [], "MenuCheckpointCreatedEvent": [], "StoreGroupCreatedEvent": [], "StoreGroupUpdatedEvent": [], "StoreGroupDeletedEvent": [], "CustomerCreatedEvent": [], "CustomerUpdatedEvent": [], "CustomerConsentUpdatedEvent": [], "WebhookSubscriptionCreatedEvent": [], "WebhookSubscriptionUpdatedEvent": [], "WebhookSubscriptionDeletedEvent": [], "PrinterTurnedOnEvent": [], "PrinterTurnedOffEvent": [], "PrinterAssignedToStoreEvent": [], "PrinterUnassignedFromStoreEvent": [], "PhoneCallStartedEvent": [], "PhoneCallEndedEvent": [], "TelephonyConfigUpdatedEvent": [], "ChannelStoresUpdatedEvent": [], "LoyaltyCampaignCreatedEvent": [], "LoyaltyCampaignDeletedEvent": [], "LoyaltyCampaignUpdatedEvent": [], "RetentionCampaignCreatedEvent": [], "RetentionCampaignDeletedEvent": [], "RetentionCampaignUpdatedEvent": [], "SmsReceivedEvent": [], "UserLoginEvent": [], "UserCreatedEvent": [], "UserUpdatedEvent": [], "UserDeletedEvent": [], "UserCreatedPasswordEvent": [], "UserAnsweredSignupQuestionsEvent": [], "VoucherCreatedEvent": [], "VoucherUpdatedEvent": [], "VoucherDeletedEvent": [], "VoucherAppliedEvent": [], "TeammateInviteSentEvent": [], "TeammateInviteAcceptedEvent": [], "TeammateUpdatedEvent": [], "TeammateDeletedEvent": [], "BankAccountCreatedEvent": [], "BankAccountUpdatedEvent": [], "BankAccountDeletedEvent": [], "BankAccountAssignedEvent": [], "HydraAssignedEvent": [], "HydraRequestResetEvent": [], "HydraStoreAssignedEvent": [], "HydraStoreUnassignedEvent": [], "HydraSettingChangedEvent": [], "HydraUnAssignedEvent": [], "HydraConnectionStatusChangedEvent": [], "KioskBluetoothPairingModeEvent": [], "KioskBluetoothUnpairingModeEvent": [], "KioskBluetoothTerminalUnpairedEvent": [], "KioskTerminalActionStateChangedEvent": [], "KioskBluetoothTerminalUpdatedEvent": [], "KioskBluetoothTerminalInitiateUpdateCheckEvent": [], "KioskBluetoothInstallUpdateInitiateEvent": [], "KioskBluetoothTerminalCancelUpdateEvent": [], "KioskBluetoothTerminalFirmwareVersionStatusEvent": [], "KioskBluetoothTerminalInstallationStatusEvent": [], "PushNotificationScheduledEvent": [], "PushNotificationSentEvent": [], "PushNotificationDeletedEvent": [], "DnsVerifiedEvent": [], "CertificateCreatedEvent": [], "CertificateRenewedEvent": [], "WebsiteVanityUrlUpdatedEvent": [], "WebsiteUpdatedEvent": [], "OrderCapacityUpdatedEvent": [], "ExternalStoreEvent": [], "OrderFulfillmentStatusUpdatedEvent": [], "AppStoreConfigCreatedEvent": [], "AppStoreConfigUpdatedEvent": [], "AppStoreConfigDeletedEvent": [], "AppStoreSubscriptionChangeJobUpdatedEvent": [], "CatalogItemCreatedEvent": [], "CatalogItemUpdatedEvent": [], "CatalogItemArchivedEvent": [], "CatalogGroupCreatedEvent": [], "CatalogGroupUpdatedEvent": [], "CatalogGroupArchivedEvent": [], "StoreTipUpdatedEvent": [], "LocationAreaCreatedEvent": [], "LocationAreaUpdatedEvent": [], "LocationCreatedEvent": [], "LocationDeletedEvent": [], "StoreServiceChargeUpdatedEvent": [], "MobileAppsSubmissionStatusUpdatedEvent": [], "MobileAppsSubmissionUpdatedEvent": [], "StoreFeeConfigUpdatedEvent": [] }, "Page": 1, "Limit": 1, "TotalRecordCount": 12.5 } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetMenuEvents400Example": { "summary": "Default GetMenuEvents 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": { "GetMenuEvents401Example": { "summary": "Default GetMenuEvents 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": { "GetMenuEvents403Example": { "summary": "Default GetMenuEvents 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": { "GetMenuEvents500Example": { "summary": "Default GetMenuEvents 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 Menu Events", "description": "Get Menu Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/menu/{menuId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/events/user/{userId}": { "get": { "tags": [ "Events" ], "operationId": "GetUserEvents", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 }, { "name": "limit", "in": "query", "description": "The maximum elements to return", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "page", "in": "query", "description": "The index of the page to return, starting by 1", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "start", "in": "query", "description": "Start date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "end", "in": "query", "description": "End date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "orderId", "in": "query", "description": "Events that have Order Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "query", "description": "Events that have Store Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeIdList", "in": "query", "description": "Events that have Store Id List", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "example": [ 1 ] }, { "name": "storeGroupId", "in": "query", "description": "Events that have Store Group Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userId", "in": "query", "description": "Events that have User Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuId", "in": "query", "description": "Events that have Menu Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "campaignId", "in": "query", "description": "Events that have Campaign Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userEmail", "in": "query", "description": "Events that have User Email", "required": false, "schema": { "type": "string" }, "example": "owner@example.com" }, { "name": "userName", "in": "query", "description": "Events that have User Name", "required": false, "schema": { "type": "string" }, "example": "Example Name" }, { "name": "voucherCode", "in": "query", "description": "Events that have voucher code", "required": false, "schema": { "type": "string" }, "example": "string" }, { "name": "eventType", "in": "query", "description": "Events that have event type\\s", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "string" ] }, { "name": "flipdishEventId", "in": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored.", "required": false, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiEventSearchPaginationResult" }, "examples": { "GetUserEvents200Example": { "summary": "Default GetUserEvents 200 response", "x-microcks-default": true, "value": { "Data": { "AppCreatedEvent": [], "AppUpdatedEvent": [], "AnalyticsClientEvent": [], "OrderAcceptedEvent": [], "OrderDispatchedEvent": [], "OrderCustomerTrackingCreatedEvent": [], "OrderDeliveryTrackingStatusUpdatedEvent": [], "OrderBatchPublishedEvent": [], "OrderCreatedEvent": [], "OrderRatingUpdatedEvent": [], "OrderRefundedEvent": [], "OrderRejectedEvent": [], "OrderTipUpdatedEvent": [], "OrderTerminalNotifications": [], "StoreCreatedEvent": [], "StoreDeletedEvent": [], "StoreAddressUpdatedEvent": [], "StoreKioskSettingUpdatedEvent": [], "DeliveryZoneCreatedEvent": [], "DeliveryZoneUpdatedEvent": [], "DeliveryZoneDeletedEvent": [], "StoreOpeningHoursUpdatedEvent": [], "StoreMenuAssignedEvent": [], "StoreBusinessHoursOverrideCreatedEvent": [], "StoreBusinessHoursOverrideDeletedEvent": [], "StoreArchivedEvent": [], "StoreUnarchivedEvent": [], "StorePublishedEvent": [], "StoreUnpublishedEvent": [], "StoreUpdatedEvent": [], "StorePreOrderConfigUpdatedEvent": [], "StoreLogoCreatedEvent": [], "StoreLogoUpdatedEvent": [], "StoreLogoDeletedEvent": [], "MenuCreatedEvent": [], "MenuAsyncCreationCompletedEvent": [], "MenuUpdatedEvent": [], "MenuUploadedEvent": [], "MenuBulkEditEvent": [], "MenuSectionCreatedEvent": [], "MenuSectionUpdatedEvent": [], "MenuSectionDeletedEvent": [], "MenuSectionItemCreatedEvent": [], "MenuSectionItemUpdatedEvent": [], "MenuSectionItemDeletedEvent": [], "MenuItemOptionSetCreatedEvent": [], "MenuItemOptionSetUpdatedEvent": [], "MenuItemOptionSetDeletedEvent": [], "MenuItemOptionSetItemCreatedEvent": [], "MenuItemOptionSetItemUpdatedEvent": [], "MenuItemOptionSetItemDeletedEvent": [], "MenuCheckpointCreatedEvent": [], "StoreGroupCreatedEvent": [], "StoreGroupUpdatedEvent": [], "StoreGroupDeletedEvent": [], "CustomerCreatedEvent": [], "CustomerUpdatedEvent": [], "CustomerConsentUpdatedEvent": [], "WebhookSubscriptionCreatedEvent": [], "WebhookSubscriptionUpdatedEvent": [], "WebhookSubscriptionDeletedEvent": [], "PrinterTurnedOnEvent": [], "PrinterTurnedOffEvent": [], "PrinterAssignedToStoreEvent": [], "PrinterUnassignedFromStoreEvent": [], "PhoneCallStartedEvent": [], "PhoneCallEndedEvent": [], "TelephonyConfigUpdatedEvent": [], "ChannelStoresUpdatedEvent": [], "LoyaltyCampaignCreatedEvent": [], "LoyaltyCampaignDeletedEvent": [], "LoyaltyCampaignUpdatedEvent": [], "RetentionCampaignCreatedEvent": [], "RetentionCampaignDeletedEvent": [], "RetentionCampaignUpdatedEvent": [], "SmsReceivedEvent": [], "UserLoginEvent": [], "UserCreatedEvent": [], "UserUpdatedEvent": [], "UserDeletedEvent": [], "UserCreatedPasswordEvent": [], "UserAnsweredSignupQuestionsEvent": [], "VoucherCreatedEvent": [], "VoucherUpdatedEvent": [], "VoucherDeletedEvent": [], "VoucherAppliedEvent": [], "TeammateInviteSentEvent": [], "TeammateInviteAcceptedEvent": [], "TeammateUpdatedEvent": [], "TeammateDeletedEvent": [], "BankAccountCreatedEvent": [], "BankAccountUpdatedEvent": [], "BankAccountDeletedEvent": [], "BankAccountAssignedEvent": [], "HydraAssignedEvent": [], "HydraRequestResetEvent": [], "HydraStoreAssignedEvent": [], "HydraStoreUnassignedEvent": [], "HydraSettingChangedEvent": [], "HydraUnAssignedEvent": [], "HydraConnectionStatusChangedEvent": [], "KioskBluetoothPairingModeEvent": [], "KioskBluetoothUnpairingModeEvent": [], "KioskBluetoothTerminalUnpairedEvent": [], "KioskTerminalActionStateChangedEvent": [], "KioskBluetoothTerminalUpdatedEvent": [], "KioskBluetoothTerminalInitiateUpdateCheckEvent": [], "KioskBluetoothInstallUpdateInitiateEvent": [], "KioskBluetoothTerminalCancelUpdateEvent": [], "KioskBluetoothTerminalFirmwareVersionStatusEvent": [], "KioskBluetoothTerminalInstallationStatusEvent": [], "PushNotificationScheduledEvent": [], "PushNotificationSentEvent": [], "PushNotificationDeletedEvent": [], "DnsVerifiedEvent": [], "CertificateCreatedEvent": [], "CertificateRenewedEvent": [], "WebsiteVanityUrlUpdatedEvent": [], "WebsiteUpdatedEvent": [], "OrderCapacityUpdatedEvent": [], "ExternalStoreEvent": [], "OrderFulfillmentStatusUpdatedEvent": [], "AppStoreConfigCreatedEvent": [], "AppStoreConfigUpdatedEvent": [], "AppStoreConfigDeletedEvent": [], "AppStoreSubscriptionChangeJobUpdatedEvent": [], "CatalogItemCreatedEvent": [], "CatalogItemUpdatedEvent": [], "CatalogItemArchivedEvent": [], "CatalogGroupCreatedEvent": [], "CatalogGroupUpdatedEvent": [], "CatalogGroupArchivedEvent": [], "StoreTipUpdatedEvent": [], "LocationAreaCreatedEvent": [], "LocationAreaUpdatedEvent": [], "LocationCreatedEvent": [], "LocationDeletedEvent": [], "StoreServiceChargeUpdatedEvent": [], "MobileAppsSubmissionStatusUpdatedEvent": [], "MobileAppsSubmissionUpdatedEvent": [], "StoreFeeConfigUpdatedEvent": [] }, "Page": 1, "Limit": 1, "TotalRecordCount": 12.5 } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserEvents400Example": { "summary": "Default GetUserEvents 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": { "GetUserEvents401Example": { "summary": "Default GetUserEvents 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": { "GetUserEvents403Example": { "summary": "Default GetUserEvents 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": { "GetUserEvents500Example": { "summary": "Default GetUserEvents 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 User Events", "description": "Get User Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/user/{userId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/events/order/{orderId}": { "get": { "tags": [ "Events" ], "operationId": "GetOrderEvents", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The order id path parameter.", "example": 500123 }, { "name": "limit", "in": "query", "description": "The maximum elements to return", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "page", "in": "query", "description": "The index of the page to return, starting by 1", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "start", "in": "query", "description": "Start date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "end", "in": "query", "description": "End date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "orderId", "in": "query", "description": "Events that have Order Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "query", "description": "Events that have Store Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeIdList", "in": "query", "description": "Events that have Store Id List", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "example": [ 1 ] }, { "name": "storeGroupId", "in": "query", "description": "Events that have Store Group Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userId", "in": "query", "description": "Events that have User Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuId", "in": "query", "description": "Events that have Menu Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "campaignId", "in": "query", "description": "Events that have Campaign Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userEmail", "in": "query", "description": "Events that have User Email", "required": false, "schema": { "type": "string" }, "example": "owner@example.com" }, { "name": "userName", "in": "query", "description": "Events that have User Name", "required": false, "schema": { "type": "string" }, "example": "Example Name" }, { "name": "voucherCode", "in": "query", "description": "Events that have voucher code", "required": false, "schema": { "type": "string" }, "example": "string" }, { "name": "eventType", "in": "query", "description": "Events that have event type\\s", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "string" ] }, { "name": "flipdishEventId", "in": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored.", "required": false, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiEventSearchPaginationResult" }, "examples": { "GetOrderEvents200Example": { "summary": "Default GetOrderEvents 200 response", "x-microcks-default": true, "value": { "Data": { "AppCreatedEvent": [], "AppUpdatedEvent": [], "AnalyticsClientEvent": [], "OrderAcceptedEvent": [], "OrderDispatchedEvent": [], "OrderCustomerTrackingCreatedEvent": [], "OrderDeliveryTrackingStatusUpdatedEvent": [], "OrderBatchPublishedEvent": [], "OrderCreatedEvent": [], "OrderRatingUpdatedEvent": [], "OrderRefundedEvent": [], "OrderRejectedEvent": [], "OrderTipUpdatedEvent": [], "OrderTerminalNotifications": [], "StoreCreatedEvent": [], "StoreDeletedEvent": [], "StoreAddressUpdatedEvent": [], "StoreKioskSettingUpdatedEvent": [], "DeliveryZoneCreatedEvent": [], "DeliveryZoneUpdatedEvent": [], "DeliveryZoneDeletedEvent": [], "StoreOpeningHoursUpdatedEvent": [], "StoreMenuAssignedEvent": [], "StoreBusinessHoursOverrideCreatedEvent": [], "StoreBusinessHoursOverrideDeletedEvent": [], "StoreArchivedEvent": [], "StoreUnarchivedEvent": [], "StorePublishedEvent": [], "StoreUnpublishedEvent": [], "StoreUpdatedEvent": [], "StorePreOrderConfigUpdatedEvent": [], "StoreLogoCreatedEvent": [], "StoreLogoUpdatedEvent": [], "StoreLogoDeletedEvent": [], "MenuCreatedEvent": [], "MenuAsyncCreationCompletedEvent": [], "MenuUpdatedEvent": [], "MenuUploadedEvent": [], "MenuBulkEditEvent": [], "MenuSectionCreatedEvent": [], "MenuSectionUpdatedEvent": [], "MenuSectionDeletedEvent": [], "MenuSectionItemCreatedEvent": [], "MenuSectionItemUpdatedEvent": [], "MenuSectionItemDeletedEvent": [], "MenuItemOptionSetCreatedEvent": [], "MenuItemOptionSetUpdatedEvent": [], "MenuItemOptionSetDeletedEvent": [], "MenuItemOptionSetItemCreatedEvent": [], "MenuItemOptionSetItemUpdatedEvent": [], "MenuItemOptionSetItemDeletedEvent": [], "MenuCheckpointCreatedEvent": [], "StoreGroupCreatedEvent": [], "StoreGroupUpdatedEvent": [], "StoreGroupDeletedEvent": [], "CustomerCreatedEvent": [], "CustomerUpdatedEvent": [], "CustomerConsentUpdatedEvent": [], "WebhookSubscriptionCreatedEvent": [], "WebhookSubscriptionUpdatedEvent": [], "WebhookSubscriptionDeletedEvent": [], "PrinterTurnedOnEvent": [], "PrinterTurnedOffEvent": [], "PrinterAssignedToStoreEvent": [], "PrinterUnassignedFromStoreEvent": [], "PhoneCallStartedEvent": [], "PhoneCallEndedEvent": [], "TelephonyConfigUpdatedEvent": [], "ChannelStoresUpdatedEvent": [], "LoyaltyCampaignCreatedEvent": [], "LoyaltyCampaignDeletedEvent": [], "LoyaltyCampaignUpdatedEvent": [], "RetentionCampaignCreatedEvent": [], "RetentionCampaignDeletedEvent": [], "RetentionCampaignUpdatedEvent": [], "SmsReceivedEvent": [], "UserLoginEvent": [], "UserCreatedEvent": [], "UserUpdatedEvent": [], "UserDeletedEvent": [], "UserCreatedPasswordEvent": [], "UserAnsweredSignupQuestionsEvent": [], "VoucherCreatedEvent": [], "VoucherUpdatedEvent": [], "VoucherDeletedEvent": [], "VoucherAppliedEvent": [], "TeammateInviteSentEvent": [], "TeammateInviteAcceptedEvent": [], "TeammateUpdatedEvent": [], "TeammateDeletedEvent": [], "BankAccountCreatedEvent": [], "BankAccountUpdatedEvent": [], "BankAccountDeletedEvent": [], "BankAccountAssignedEvent": [], "HydraAssignedEvent": [], "HydraRequestResetEvent": [], "HydraStoreAssignedEvent": [], "HydraStoreUnassignedEvent": [], "HydraSettingChangedEvent": [], "HydraUnAssignedEvent": [], "HydraConnectionStatusChangedEvent": [], "KioskBluetoothPairingModeEvent": [], "KioskBluetoothUnpairingModeEvent": [], "KioskBluetoothTerminalUnpairedEvent": [], "KioskTerminalActionStateChangedEvent": [], "KioskBluetoothTerminalUpdatedEvent": [], "KioskBluetoothTerminalInitiateUpdateCheckEvent": [], "KioskBluetoothInstallUpdateInitiateEvent": [], "KioskBluetoothTerminalCancelUpdateEvent": [], "KioskBluetoothTerminalFirmwareVersionStatusEvent": [], "KioskBluetoothTerminalInstallationStatusEvent": [], "PushNotificationScheduledEvent": [], "PushNotificationSentEvent": [], "PushNotificationDeletedEvent": [], "DnsVerifiedEvent": [], "CertificateCreatedEvent": [], "CertificateRenewedEvent": [], "WebsiteVanityUrlUpdatedEvent": [], "WebsiteUpdatedEvent": [], "OrderCapacityUpdatedEvent": [], "ExternalStoreEvent": [], "OrderFulfillmentStatusUpdatedEvent": [], "AppStoreConfigCreatedEvent": [], "AppStoreConfigUpdatedEvent": [], "AppStoreConfigDeletedEvent": [], "AppStoreSubscriptionChangeJobUpdatedEvent": [], "CatalogItemCreatedEvent": [], "CatalogItemUpdatedEvent": [], "CatalogItemArchivedEvent": [], "CatalogGroupCreatedEvent": [], "CatalogGroupUpdatedEvent": [], "CatalogGroupArchivedEvent": [], "StoreTipUpdatedEvent": [], "LocationAreaCreatedEvent": [], "LocationAreaUpdatedEvent": [], "LocationCreatedEvent": [], "LocationDeletedEvent": [], "StoreServiceChargeUpdatedEvent": [], "MobileAppsSubmissionStatusUpdatedEvent": [], "MobileAppsSubmissionUpdatedEvent": [], "StoreFeeConfigUpdatedEvent": [] }, "Page": 1, "Limit": 1, "TotalRecordCount": 12.5 } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetOrderEvents400Example": { "summary": "Default GetOrderEvents 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": { "GetOrderEvents401Example": { "summary": "Default GetOrderEvents 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": { "GetOrderEvents403Example": { "summary": "Default GetOrderEvents 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": { "GetOrderEvents500Example": { "summary": "Default GetOrderEvents 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 Order Events", "description": "Get Order Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/order/{orderId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/events/store/{storeId}": { "get": { "tags": [ "Events" ], "operationId": "GetStoreEvents", "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": "limit", "in": "query", "description": "The maximum elements to return", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "page", "in": "query", "description": "The index of the page to return, starting by 1", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "start", "in": "query", "description": "Start date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "end", "in": "query", "description": "End date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "orderId", "in": "query", "description": "Events that have Order Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "query", "description": "Events that have Store Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeIdList", "in": "query", "description": "Events that have Store Id List", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "example": [ 1 ] }, { "name": "storeGroupId", "in": "query", "description": "Events that have Store Group Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userId", "in": "query", "description": "Events that have User Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuId", "in": "query", "description": "Events that have Menu Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "campaignId", "in": "query", "description": "Events that have Campaign Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userEmail", "in": "query", "description": "Events that have User Email", "required": false, "schema": { "type": "string" }, "example": "owner@example.com" }, { "name": "userName", "in": "query", "description": "Events that have User Name", "required": false, "schema": { "type": "string" }, "example": "Example Name" }, { "name": "voucherCode", "in": "query", "description": "Events that have voucher code", "required": false, "schema": { "type": "string" }, "example": "string" }, { "name": "eventType", "in": "query", "description": "Events that have event type\\s", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "string" ] }, { "name": "flipdishEventId", "in": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored.", "required": false, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiEventSearchPaginationResult" }, "examples": { "GetStoreEvents200Example": { "summary": "Default GetStoreEvents 200 response", "x-microcks-default": true, "value": { "Data": { "AppCreatedEvent": [], "AppUpdatedEvent": [], "AnalyticsClientEvent": [], "OrderAcceptedEvent": [], "OrderDispatchedEvent": [], "OrderCustomerTrackingCreatedEvent": [], "OrderDeliveryTrackingStatusUpdatedEvent": [], "OrderBatchPublishedEvent": [], "OrderCreatedEvent": [], "OrderRatingUpdatedEvent": [], "OrderRefundedEvent": [], "OrderRejectedEvent": [], "OrderTipUpdatedEvent": [], "OrderTerminalNotifications": [], "StoreCreatedEvent": [], "StoreDeletedEvent": [], "StoreAddressUpdatedEvent": [], "StoreKioskSettingUpdatedEvent": [], "DeliveryZoneCreatedEvent": [], "DeliveryZoneUpdatedEvent": [], "DeliveryZoneDeletedEvent": [], "StoreOpeningHoursUpdatedEvent": [], "StoreMenuAssignedEvent": [], "StoreBusinessHoursOverrideCreatedEvent": [], "StoreBusinessHoursOverrideDeletedEvent": [], "StoreArchivedEvent": [], "StoreUnarchivedEvent": [], "StorePublishedEvent": [], "StoreUnpublishedEvent": [], "StoreUpdatedEvent": [], "StorePreOrderConfigUpdatedEvent": [], "StoreLogoCreatedEvent": [], "StoreLogoUpdatedEvent": [], "StoreLogoDeletedEvent": [], "MenuCreatedEvent": [], "MenuAsyncCreationCompletedEvent": [], "MenuUpdatedEvent": [], "MenuUploadedEvent": [], "MenuBulkEditEvent": [], "MenuSectionCreatedEvent": [], "MenuSectionUpdatedEvent": [], "MenuSectionDeletedEvent": [], "MenuSectionItemCreatedEvent": [], "MenuSectionItemUpdatedEvent": [], "MenuSectionItemDeletedEvent": [], "MenuItemOptionSetCreatedEvent": [], "MenuItemOptionSetUpdatedEvent": [], "MenuItemOptionSetDeletedEvent": [], "MenuItemOptionSetItemCreatedEvent": [], "MenuItemOptionSetItemUpdatedEvent": [], "MenuItemOptionSetItemDeletedEvent": [], "MenuCheckpointCreatedEvent": [], "StoreGroupCreatedEvent": [], "StoreGroupUpdatedEvent": [], "StoreGroupDeletedEvent": [], "CustomerCreatedEvent": [], "CustomerUpdatedEvent": [], "CustomerConsentUpdatedEvent": [], "WebhookSubscriptionCreatedEvent": [], "WebhookSubscriptionUpdatedEvent": [], "WebhookSubscriptionDeletedEvent": [], "PrinterTurnedOnEvent": [], "PrinterTurnedOffEvent": [], "PrinterAssignedToStoreEvent": [], "PrinterUnassignedFromStoreEvent": [], "PhoneCallStartedEvent": [], "PhoneCallEndedEvent": [], "TelephonyConfigUpdatedEvent": [], "ChannelStoresUpdatedEvent": [], "LoyaltyCampaignCreatedEvent": [], "LoyaltyCampaignDeletedEvent": [], "LoyaltyCampaignUpdatedEvent": [], "RetentionCampaignCreatedEvent": [], "RetentionCampaignDeletedEvent": [], "RetentionCampaignUpdatedEvent": [], "SmsReceivedEvent": [], "UserLoginEvent": [], "UserCreatedEvent": [], "UserUpdatedEvent": [], "UserDeletedEvent": [], "UserCreatedPasswordEvent": [], "UserAnsweredSignupQuestionsEvent": [], "VoucherCreatedEvent": [], "VoucherUpdatedEvent": [], "VoucherDeletedEvent": [], "VoucherAppliedEvent": [], "TeammateInviteSentEvent": [], "TeammateInviteAcceptedEvent": [], "TeammateUpdatedEvent": [], "TeammateDeletedEvent": [], "BankAccountCreatedEvent": [], "BankAccountUpdatedEvent": [], "BankAccountDeletedEvent": [], "BankAccountAssignedEvent": [], "HydraAssignedEvent": [], "HydraRequestResetEvent": [], "HydraStoreAssignedEvent": [], "HydraStoreUnassignedEvent": [], "HydraSettingChangedEvent": [], "HydraUnAssignedEvent": [], "HydraConnectionStatusChangedEvent": [], "KioskBluetoothPairingModeEvent": [], "KioskBluetoothUnpairingModeEvent": [], "KioskBluetoothTerminalUnpairedEvent": [], "KioskTerminalActionStateChangedEvent": [], "KioskBluetoothTerminalUpdatedEvent": [], "KioskBluetoothTerminalInitiateUpdateCheckEvent": [], "KioskBluetoothInstallUpdateInitiateEvent": [], "KioskBluetoothTerminalCancelUpdateEvent": [], "KioskBluetoothTerminalFirmwareVersionStatusEvent": [], "KioskBluetoothTerminalInstallationStatusEvent": [], "PushNotificationScheduledEvent": [], "PushNotificationSentEvent": [], "PushNotificationDeletedEvent": [], "DnsVerifiedEvent": [], "CertificateCreatedEvent": [], "CertificateRenewedEvent": [], "WebsiteVanityUrlUpdatedEvent": [], "WebsiteUpdatedEvent": [], "OrderCapacityUpdatedEvent": [], "ExternalStoreEvent": [], "OrderFulfillmentStatusUpdatedEvent": [], "AppStoreConfigCreatedEvent": [], "AppStoreConfigUpdatedEvent": [], "AppStoreConfigDeletedEvent": [], "AppStoreSubscriptionChangeJobUpdatedEvent": [], "CatalogItemCreatedEvent": [], "CatalogItemUpdatedEvent": [], "CatalogItemArchivedEvent": [], "CatalogGroupCreatedEvent": [], "CatalogGroupUpdatedEvent": [], "CatalogGroupArchivedEvent": [], "StoreTipUpdatedEvent": [], "LocationAreaCreatedEvent": [], "LocationAreaUpdatedEvent": [], "LocationCreatedEvent": [], "LocationDeletedEvent": [], "StoreServiceChargeUpdatedEvent": [], "MobileAppsSubmissionStatusUpdatedEvent": [], "MobileAppsSubmissionUpdatedEvent": [], "StoreFeeConfigUpdatedEvent": [] }, "Page": 1, "Limit": 1, "TotalRecordCount": 12.5 } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreEvents400Example": { "summary": "Default GetStoreEvents 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": { "GetStoreEvents401Example": { "summary": "Default GetStoreEvents 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": { "GetStoreEvents403Example": { "summary": "Default GetStoreEvents 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": { "GetStoreEvents500Example": { "summary": "Default GetStoreEvents 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 Events", "description": "Get Store Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/store/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/events/customer/{customerId}": { "get": { "tags": [ "Events" ], "operationId": "GetCustomerEvents", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The customer id path parameter.", "example": 500123 }, { "name": "limit", "in": "query", "description": "The maximum elements to return", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "page", "in": "query", "description": "The index of the page to return, starting by 1", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "start", "in": "query", "description": "Start date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "end", "in": "query", "description": "End date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "orderId", "in": "query", "description": "Events that have Order Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "query", "description": "Events that have Store Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeIdList", "in": "query", "description": "Events that have Store Id List", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "example": [ 1 ] }, { "name": "storeGroupId", "in": "query", "description": "Events that have Store Group Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userId", "in": "query", "description": "Events that have User Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuId", "in": "query", "description": "Events that have Menu Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "campaignId", "in": "query", "description": "Events that have Campaign Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userEmail", "in": "query", "description": "Events that have User Email", "required": false, "schema": { "type": "string" }, "example": "owner@example.com" }, { "name": "userName", "in": "query", "description": "Events that have User Name", "required": false, "schema": { "type": "string" }, "example": "Example Name" }, { "name": "voucherCode", "in": "query", "description": "Events that have voucher code", "required": false, "schema": { "type": "string" }, "example": "string" }, { "name": "eventType", "in": "query", "description": "Events that have event type\\s", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "string" ] }, { "name": "flipdishEventId", "in": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored.", "required": false, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiEventSearchPaginationResult" }, "examples": { "GetCustomerEvents200Example": { "summary": "Default GetCustomerEvents 200 response", "x-microcks-default": true, "value": { "Data": { "AppCreatedEvent": [], "AppUpdatedEvent": [], "AnalyticsClientEvent": [], "OrderAcceptedEvent": [], "OrderDispatchedEvent": [], "OrderCustomerTrackingCreatedEvent": [], "OrderDeliveryTrackingStatusUpdatedEvent": [], "OrderBatchPublishedEvent": [], "OrderCreatedEvent": [], "OrderRatingUpdatedEvent": [], "OrderRefundedEvent": [], "OrderRejectedEvent": [], "OrderTipUpdatedEvent": [], "OrderTerminalNotifications": [], "StoreCreatedEvent": [], "StoreDeletedEvent": [], "StoreAddressUpdatedEvent": [], "StoreKioskSettingUpdatedEvent": [], "DeliveryZoneCreatedEvent": [], "DeliveryZoneUpdatedEvent": [], "DeliveryZoneDeletedEvent": [], "StoreOpeningHoursUpdatedEvent": [], "StoreMenuAssignedEvent": [], "StoreBusinessHoursOverrideCreatedEvent": [], "StoreBusinessHoursOverrideDeletedEvent": [], "StoreArchivedEvent": [], "StoreUnarchivedEvent": [], "StorePublishedEvent": [], "StoreUnpublishedEvent": [], "StoreUpdatedEvent": [], "StorePreOrderConfigUpdatedEvent": [], "StoreLogoCreatedEvent": [], "StoreLogoUpdatedEvent": [], "StoreLogoDeletedEvent": [], "MenuCreatedEvent": [], "MenuAsyncCreationCompletedEvent": [], "MenuUpdatedEvent": [], "MenuUploadedEvent": [], "MenuBulkEditEvent": [], "MenuSectionCreatedEvent": [], "MenuSectionUpdatedEvent": [], "MenuSectionDeletedEvent": [], "MenuSectionItemCreatedEvent": [], "MenuSectionItemUpdatedEvent": [], "MenuSectionItemDeletedEvent": [], "MenuItemOptionSetCreatedEvent": [], "MenuItemOptionSetUpdatedEvent": [], "MenuItemOptionSetDeletedEvent": [], "MenuItemOptionSetItemCreatedEvent": [], "MenuItemOptionSetItemUpdatedEvent": [], "MenuItemOptionSetItemDeletedEvent": [], "MenuCheckpointCreatedEvent": [], "StoreGroupCreatedEvent": [], "StoreGroupUpdatedEvent": [], "StoreGroupDeletedEvent": [], "CustomerCreatedEvent": [], "CustomerUpdatedEvent": [], "CustomerConsentUpdatedEvent": [], "WebhookSubscriptionCreatedEvent": [], "WebhookSubscriptionUpdatedEvent": [], "WebhookSubscriptionDeletedEvent": [], "PrinterTurnedOnEvent": [], "PrinterTurnedOffEvent": [], "PrinterAssignedToStoreEvent": [], "PrinterUnassignedFromStoreEvent": [], "PhoneCallStartedEvent": [], "PhoneCallEndedEvent": [], "TelephonyConfigUpdatedEvent": [], "ChannelStoresUpdatedEvent": [], "LoyaltyCampaignCreatedEvent": [], "LoyaltyCampaignDeletedEvent": [], "LoyaltyCampaignUpdatedEvent": [], "RetentionCampaignCreatedEvent": [], "RetentionCampaignDeletedEvent": [], "RetentionCampaignUpdatedEvent": [], "SmsReceivedEvent": [], "UserLoginEvent": [], "UserCreatedEvent": [], "UserUpdatedEvent": [], "UserDeletedEvent": [], "UserCreatedPasswordEvent": [], "UserAnsweredSignupQuestionsEvent": [], "VoucherCreatedEvent": [], "VoucherUpdatedEvent": [], "VoucherDeletedEvent": [], "VoucherAppliedEvent": [], "TeammateInviteSentEvent": [], "TeammateInviteAcceptedEvent": [], "TeammateUpdatedEvent": [], "TeammateDeletedEvent": [], "BankAccountCreatedEvent": [], "BankAccountUpdatedEvent": [], "BankAccountDeletedEvent": [], "BankAccountAssignedEvent": [], "HydraAssignedEvent": [], "HydraRequestResetEvent": [], "HydraStoreAssignedEvent": [], "HydraStoreUnassignedEvent": [], "HydraSettingChangedEvent": [], "HydraUnAssignedEvent": [], "HydraConnectionStatusChangedEvent": [], "KioskBluetoothPairingModeEvent": [], "KioskBluetoothUnpairingModeEvent": [], "KioskBluetoothTerminalUnpairedEvent": [], "KioskTerminalActionStateChangedEvent": [], "KioskBluetoothTerminalUpdatedEvent": [], "KioskBluetoothTerminalInitiateUpdateCheckEvent": [], "KioskBluetoothInstallUpdateInitiateEvent": [], "KioskBluetoothTerminalCancelUpdateEvent": [], "KioskBluetoothTerminalFirmwareVersionStatusEvent": [], "KioskBluetoothTerminalInstallationStatusEvent": [], "PushNotificationScheduledEvent": [], "PushNotificationSentEvent": [], "PushNotificationDeletedEvent": [], "DnsVerifiedEvent": [], "CertificateCreatedEvent": [], "CertificateRenewedEvent": [], "WebsiteVanityUrlUpdatedEvent": [], "WebsiteUpdatedEvent": [], "OrderCapacityUpdatedEvent": [], "ExternalStoreEvent": [], "OrderFulfillmentStatusUpdatedEvent": [], "AppStoreConfigCreatedEvent": [], "AppStoreConfigUpdatedEvent": [], "AppStoreConfigDeletedEvent": [], "AppStoreSubscriptionChangeJobUpdatedEvent": [], "CatalogItemCreatedEvent": [], "CatalogItemUpdatedEvent": [], "CatalogItemArchivedEvent": [], "CatalogGroupCreatedEvent": [], "CatalogGroupUpdatedEvent": [], "CatalogGroupArchivedEvent": [], "StoreTipUpdatedEvent": [], "LocationAreaCreatedEvent": [], "LocationAreaUpdatedEvent": [], "LocationCreatedEvent": [], "LocationDeletedEvent": [], "StoreServiceChargeUpdatedEvent": [], "MobileAppsSubmissionStatusUpdatedEvent": [], "MobileAppsSubmissionUpdatedEvent": [], "StoreFeeConfigUpdatedEvent": [] }, "Page": 1, "Limit": 1, "TotalRecordCount": 12.5 } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCustomerEvents400Example": { "summary": "Default GetCustomerEvents 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": { "GetCustomerEvents401Example": { "summary": "Default GetCustomerEvents 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": { "GetCustomerEvents403Example": { "summary": "Default GetCustomerEvents 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": { "GetCustomerEvents500Example": { "summary": "Default GetCustomerEvents 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 Customer Events", "description": "Get Customer Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/customer/{customerId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/events/whitelabel/{whitelabelId}": { "get": { "tags": [ "Events" ], "operationId": "GetWhiteLabelEvents", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "whitelabelId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The whitelabel id path parameter.", "example": 500123 }, { "name": "limit", "in": "query", "description": "The maximum elements to return", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "page", "in": "query", "description": "The index of the page to return, starting by 1", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "start", "in": "query", "description": "Start date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "end", "in": "query", "description": "End date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "orderId", "in": "query", "description": "Events that have Order Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "query", "description": "Events that have Store Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeIdList", "in": "query", "description": "Events that have Store Id List", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "example": [ 1 ] }, { "name": "storeGroupId", "in": "query", "description": "Events that have Store Group Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userId", "in": "query", "description": "Events that have User Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuId", "in": "query", "description": "Events that have Menu Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "campaignId", "in": "query", "description": "Events that have Campaign Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userEmail", "in": "query", "description": "Events that have User Email", "required": false, "schema": { "type": "string" }, "example": "owner@example.com" }, { "name": "userName", "in": "query", "description": "Events that have User Name", "required": false, "schema": { "type": "string" }, "example": "Example Name" }, { "name": "voucherCode", "in": "query", "description": "Events that have voucher code", "required": false, "schema": { "type": "string" }, "example": "string" }, { "name": "eventType", "in": "query", "description": "Events that have event type\\s", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "string" ] }, { "name": "flipdishEventId", "in": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored.", "required": false, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiEventSearchPaginationResult" }, "examples": { "GetWhiteLabelEvents200Example": { "summary": "Default GetWhiteLabelEvents 200 response", "x-microcks-default": true, "value": { "Data": { "AppCreatedEvent": [], "AppUpdatedEvent": [], "AnalyticsClientEvent": [], "OrderAcceptedEvent": [], "OrderDispatchedEvent": [], "OrderCustomerTrackingCreatedEvent": [], "OrderDeliveryTrackingStatusUpdatedEvent": [], "OrderBatchPublishedEvent": [], "OrderCreatedEvent": [], "OrderRatingUpdatedEvent": [], "OrderRefundedEvent": [], "OrderRejectedEvent": [], "OrderTipUpdatedEvent": [], "OrderTerminalNotifications": [], "StoreCreatedEvent": [], "StoreDeletedEvent": [], "StoreAddressUpdatedEvent": [], "StoreKioskSettingUpdatedEvent": [], "DeliveryZoneCreatedEvent": [], "DeliveryZoneUpdatedEvent": [], "DeliveryZoneDeletedEvent": [], "StoreOpeningHoursUpdatedEvent": [], "StoreMenuAssignedEvent": [], "StoreBusinessHoursOverrideCreatedEvent": [], "StoreBusinessHoursOverrideDeletedEvent": [], "StoreArchivedEvent": [], "StoreUnarchivedEvent": [], "StorePublishedEvent": [], "StoreUnpublishedEvent": [], "StoreUpdatedEvent": [], "StorePreOrderConfigUpdatedEvent": [], "StoreLogoCreatedEvent": [], "StoreLogoUpdatedEvent": [], "StoreLogoDeletedEvent": [], "MenuCreatedEvent": [], "MenuAsyncCreationCompletedEvent": [], "MenuUpdatedEvent": [], "MenuUploadedEvent": [], "MenuBulkEditEvent": [], "MenuSectionCreatedEvent": [], "MenuSectionUpdatedEvent": [], "MenuSectionDeletedEvent": [], "MenuSectionItemCreatedEvent": [], "MenuSectionItemUpdatedEvent": [], "MenuSectionItemDeletedEvent": [], "MenuItemOptionSetCreatedEvent": [], "MenuItemOptionSetUpdatedEvent": [], "MenuItemOptionSetDeletedEvent": [], "MenuItemOptionSetItemCreatedEvent": [], "MenuItemOptionSetItemUpdatedEvent": [], "MenuItemOptionSetItemDeletedEvent": [], "MenuCheckpointCreatedEvent": [], "StoreGroupCreatedEvent": [], "StoreGroupUpdatedEvent": [], "StoreGroupDeletedEvent": [], "CustomerCreatedEvent": [], "CustomerUpdatedEvent": [], "CustomerConsentUpdatedEvent": [], "WebhookSubscriptionCreatedEvent": [], "WebhookSubscriptionUpdatedEvent": [], "WebhookSubscriptionDeletedEvent": [], "PrinterTurnedOnEvent": [], "PrinterTurnedOffEvent": [], "PrinterAssignedToStoreEvent": [], "PrinterUnassignedFromStoreEvent": [], "PhoneCallStartedEvent": [], "PhoneCallEndedEvent": [], "TelephonyConfigUpdatedEvent": [], "ChannelStoresUpdatedEvent": [], "LoyaltyCampaignCreatedEvent": [], "LoyaltyCampaignDeletedEvent": [], "LoyaltyCampaignUpdatedEvent": [], "RetentionCampaignCreatedEvent": [], "RetentionCampaignDeletedEvent": [], "RetentionCampaignUpdatedEvent": [], "SmsReceivedEvent": [], "UserLoginEvent": [], "UserCreatedEvent": [], "UserUpdatedEvent": [], "UserDeletedEvent": [], "UserCreatedPasswordEvent": [], "UserAnsweredSignupQuestionsEvent": [], "VoucherCreatedEvent": [], "VoucherUpdatedEvent": [], "VoucherDeletedEvent": [], "VoucherAppliedEvent": [], "TeammateInviteSentEvent": [], "TeammateInviteAcceptedEvent": [], "TeammateUpdatedEvent": [], "TeammateDeletedEvent": [], "BankAccountCreatedEvent": [], "BankAccountUpdatedEvent": [], "BankAccountDeletedEvent": [], "BankAccountAssignedEvent": [], "HydraAssignedEvent": [], "HydraRequestResetEvent": [], "HydraStoreAssignedEvent": [], "HydraStoreUnassignedEvent": [], "HydraSettingChangedEvent": [], "HydraUnAssignedEvent": [], "HydraConnectionStatusChangedEvent": [], "KioskBluetoothPairingModeEvent": [], "KioskBluetoothUnpairingModeEvent": [], "KioskBluetoothTerminalUnpairedEvent": [], "KioskTerminalActionStateChangedEvent": [], "KioskBluetoothTerminalUpdatedEvent": [], "KioskBluetoothTerminalInitiateUpdateCheckEvent": [], "KioskBluetoothInstallUpdateInitiateEvent": [], "KioskBluetoothTerminalCancelUpdateEvent": [], "KioskBluetoothTerminalFirmwareVersionStatusEvent": [], "KioskBluetoothTerminalInstallationStatusEvent": [], "PushNotificationScheduledEvent": [], "PushNotificationSentEvent": [], "PushNotificationDeletedEvent": [], "DnsVerifiedEvent": [], "CertificateCreatedEvent": [], "CertificateRenewedEvent": [], "WebsiteVanityUrlUpdatedEvent": [], "WebsiteUpdatedEvent": [], "OrderCapacityUpdatedEvent": [], "ExternalStoreEvent": [], "OrderFulfillmentStatusUpdatedEvent": [], "AppStoreConfigCreatedEvent": [], "AppStoreConfigUpdatedEvent": [], "AppStoreConfigDeletedEvent": [], "AppStoreSubscriptionChangeJobUpdatedEvent": [], "CatalogItemCreatedEvent": [], "CatalogItemUpdatedEvent": [], "CatalogItemArchivedEvent": [], "CatalogGroupCreatedEvent": [], "CatalogGroupUpdatedEvent": [], "CatalogGroupArchivedEvent": [], "StoreTipUpdatedEvent": [], "LocationAreaCreatedEvent": [], "LocationAreaUpdatedEvent": [], "LocationCreatedEvent": [], "LocationDeletedEvent": [], "StoreServiceChargeUpdatedEvent": [], "MobileAppsSubmissionStatusUpdatedEvent": [], "MobileAppsSubmissionUpdatedEvent": [], "StoreFeeConfigUpdatedEvent": [] }, "Page": 1, "Limit": 1, "TotalRecordCount": 12.5 } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetWhiteLabelEvents400Example": { "summary": "Default GetWhiteLabelEvents 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": { "GetWhiteLabelEvents401Example": { "summary": "Default GetWhiteLabelEvents 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": { "GetWhiteLabelEvents403Example": { "summary": "Default GetWhiteLabelEvents 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": { "GetWhiteLabelEvents500Example": { "summary": "Default GetWhiteLabelEvents 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 White Label Events", "description": "Get White Label Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/whitelabel/{whitelabelId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/events/order": { "get": { "tags": [ "Events" ], "operationId": "GetOrderEventsByCustomer", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "customerId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The customer id query parameter.", "example": 500123 }, { "name": "limit", "in": "query", "description": "The maximum elements to return", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "page", "in": "query", "description": "The index of the page to return, starting by 1", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "start", "in": "query", "description": "Start date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "end", "in": "query", "description": "End date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "orderId", "in": "query", "description": "Events that have Order Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "query", "description": "Events that have Store Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeIdList", "in": "query", "description": "Events that have Store Id List", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "example": [ 1 ] }, { "name": "storeGroupId", "in": "query", "description": "Events that have Store Group Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userId", "in": "query", "description": "Events that have User Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuId", "in": "query", "description": "Events that have Menu Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "campaignId", "in": "query", "description": "Events that have Campaign Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userEmail", "in": "query", "description": "Events that have User Email", "required": false, "schema": { "type": "string" }, "example": "owner@example.com" }, { "name": "userName", "in": "query", "description": "Events that have User Name", "required": false, "schema": { "type": "string" }, "example": "Example Name" }, { "name": "voucherCode", "in": "query", "description": "Events that have voucher code", "required": false, "schema": { "type": "string" }, "example": "string" }, { "name": "eventType", "in": "query", "description": "Events that have event type\\s", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "string" ] }, { "name": "flipdishEventId", "in": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored.", "required": false, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiEventSearchPaginationResult" }, "examples": { "GetOrderEventsByCustomer200Example": { "summary": "Default GetOrderEventsByCustomer 200 response", "x-microcks-default": true, "value": { "Data": { "AppCreatedEvent": [], "AppUpdatedEvent": [], "AnalyticsClientEvent": [], "OrderAcceptedEvent": [], "OrderDispatchedEvent": [], "OrderCustomerTrackingCreatedEvent": [], "OrderDeliveryTrackingStatusUpdatedEvent": [], "OrderBatchPublishedEvent": [], "OrderCreatedEvent": [], "OrderRatingUpdatedEvent": [], "OrderRefundedEvent": [], "OrderRejectedEvent": [], "OrderTipUpdatedEvent": [], "OrderTerminalNotifications": [], "StoreCreatedEvent": [], "StoreDeletedEvent": [], "StoreAddressUpdatedEvent": [], "StoreKioskSettingUpdatedEvent": [], "DeliveryZoneCreatedEvent": [], "DeliveryZoneUpdatedEvent": [], "DeliveryZoneDeletedEvent": [], "StoreOpeningHoursUpdatedEvent": [], "StoreMenuAssignedEvent": [], "StoreBusinessHoursOverrideCreatedEvent": [], "StoreBusinessHoursOverrideDeletedEvent": [], "StoreArchivedEvent": [], "StoreUnarchivedEvent": [], "StorePublishedEvent": [], "StoreUnpublishedEvent": [], "StoreUpdatedEvent": [], "StorePreOrderConfigUpdatedEvent": [], "StoreLogoCreatedEvent": [], "StoreLogoUpdatedEvent": [], "StoreLogoDeletedEvent": [], "MenuCreatedEvent": [], "MenuAsyncCreationCompletedEvent": [], "MenuUpdatedEvent": [], "MenuUploadedEvent": [], "MenuBulkEditEvent": [], "MenuSectionCreatedEvent": [], "MenuSectionUpdatedEvent": [], "MenuSectionDeletedEvent": [], "MenuSectionItemCreatedEvent": [], "MenuSectionItemUpdatedEvent": [], "MenuSectionItemDeletedEvent": [], "MenuItemOptionSetCreatedEvent": [], "MenuItemOptionSetUpdatedEvent": [], "MenuItemOptionSetDeletedEvent": [], "MenuItemOptionSetItemCreatedEvent": [], "MenuItemOptionSetItemUpdatedEvent": [], "MenuItemOptionSetItemDeletedEvent": [], "MenuCheckpointCreatedEvent": [], "StoreGroupCreatedEvent": [], "StoreGroupUpdatedEvent": [], "StoreGroupDeletedEvent": [], "CustomerCreatedEvent": [], "CustomerUpdatedEvent": [], "CustomerConsentUpdatedEvent": [], "WebhookSubscriptionCreatedEvent": [], "WebhookSubscriptionUpdatedEvent": [], "WebhookSubscriptionDeletedEvent": [], "PrinterTurnedOnEvent": [], "PrinterTurnedOffEvent": [], "PrinterAssignedToStoreEvent": [], "PrinterUnassignedFromStoreEvent": [], "PhoneCallStartedEvent": [], "PhoneCallEndedEvent": [], "TelephonyConfigUpdatedEvent": [], "ChannelStoresUpdatedEvent": [], "LoyaltyCampaignCreatedEvent": [], "LoyaltyCampaignDeletedEvent": [], "LoyaltyCampaignUpdatedEvent": [], "RetentionCampaignCreatedEvent": [], "RetentionCampaignDeletedEvent": [], "RetentionCampaignUpdatedEvent": [], "SmsReceivedEvent": [], "UserLoginEvent": [], "UserCreatedEvent": [], "UserUpdatedEvent": [], "UserDeletedEvent": [], "UserCreatedPasswordEvent": [], "UserAnsweredSignupQuestionsEvent": [], "VoucherCreatedEvent": [], "VoucherUpdatedEvent": [], "VoucherDeletedEvent": [], "VoucherAppliedEvent": [], "TeammateInviteSentEvent": [], "TeammateInviteAcceptedEvent": [], "TeammateUpdatedEvent": [], "TeammateDeletedEvent": [], "BankAccountCreatedEvent": [], "BankAccountUpdatedEvent": [], "BankAccountDeletedEvent": [], "BankAccountAssignedEvent": [], "HydraAssignedEvent": [], "HydraRequestResetEvent": [], "HydraStoreAssignedEvent": [], "HydraStoreUnassignedEvent": [], "HydraSettingChangedEvent": [], "HydraUnAssignedEvent": [], "HydraConnectionStatusChangedEvent": [], "KioskBluetoothPairingModeEvent": [], "KioskBluetoothUnpairingModeEvent": [], "KioskBluetoothTerminalUnpairedEvent": [], "KioskTerminalActionStateChangedEvent": [], "KioskBluetoothTerminalUpdatedEvent": [], "KioskBluetoothTerminalInitiateUpdateCheckEvent": [], "KioskBluetoothInstallUpdateInitiateEvent": [], "KioskBluetoothTerminalCancelUpdateEvent": [], "KioskBluetoothTerminalFirmwareVersionStatusEvent": [], "KioskBluetoothTerminalInstallationStatusEvent": [], "PushNotificationScheduledEvent": [], "PushNotificationSentEvent": [], "PushNotificationDeletedEvent": [], "DnsVerifiedEvent": [], "CertificateCreatedEvent": [], "CertificateRenewedEvent": [], "WebsiteVanityUrlUpdatedEvent": [], "WebsiteUpdatedEvent": [], "OrderCapacityUpdatedEvent": [], "ExternalStoreEvent": [], "OrderFulfillmentStatusUpdatedEvent": [], "AppStoreConfigCreatedEvent": [], "AppStoreConfigUpdatedEvent": [], "AppStoreConfigDeletedEvent": [], "AppStoreSubscriptionChangeJobUpdatedEvent": [], "CatalogItemCreatedEvent": [], "CatalogItemUpdatedEvent": [], "CatalogItemArchivedEvent": [], "CatalogGroupCreatedEvent": [], "CatalogGroupUpdatedEvent": [], "CatalogGroupArchivedEvent": [], "StoreTipUpdatedEvent": [], "LocationAreaCreatedEvent": [], "LocationAreaUpdatedEvent": [], "LocationCreatedEvent": [], "LocationDeletedEvent": [], "StoreServiceChargeUpdatedEvent": [], "MobileAppsSubmissionStatusUpdatedEvent": [], "MobileAppsSubmissionUpdatedEvent": [], "StoreFeeConfigUpdatedEvent": [] }, "Page": 1, "Limit": 1, "TotalRecordCount": 12.5 } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetOrderEventsByCustomer400Example": { "summary": "Default GetOrderEventsByCustomer 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": { "GetOrderEventsByCustomer401Example": { "summary": "Default GetOrderEventsByCustomer 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": { "GetOrderEventsByCustomer403Example": { "summary": "Default GetOrderEventsByCustomer 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": { "GetOrderEventsByCustomer500Example": { "summary": "Default GetOrderEventsByCustomer 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 Order Events by Customer", "description": "Get Order Events by Customer via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/order).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/events": { "get": { "tags": [ "Events" ], "operationId": "GetEvents", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "whiteLabelId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The white label id query parameter.", "example": 500123 }, { "name": "customerId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The customer id query parameter.", "example": 500123 }, { "name": "limit", "in": "query", "description": "The maximum elements to return", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "page", "in": "query", "description": "The index of the page to return, starting by 1", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "start", "in": "query", "description": "Start date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "end", "in": "query", "description": "End date", "required": false, "x-nullable": true, "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-02T12:00:00Z" }, { "name": "orderId", "in": "query", "description": "Events that have Order Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeId", "in": "query", "description": "Events that have Store Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "storeIdList", "in": "query", "description": "Events that have Store Id List", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "example": [ 1 ] }, { "name": "storeGroupId", "in": "query", "description": "Events that have Store Group Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userId", "in": "query", "description": "Events that have User Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "menuId", "in": "query", "description": "Events that have Menu Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "campaignId", "in": "query", "description": "Events that have Campaign Id", "required": false, "x-nullable": true, "schema": { "type": "integer", "format": "int32" }, "example": 500123 }, { "name": "userEmail", "in": "query", "description": "Events that have User Email", "required": false, "schema": { "type": "string" }, "example": "owner@example.com" }, { "name": "userName", "in": "query", "description": "Events that have User Name", "required": false, "schema": { "type": "string" }, "example": "Example Name" }, { "name": "voucherCode", "in": "query", "description": "Events that have voucher code", "required": false, "schema": { "type": "string" }, "example": "string" }, { "name": "eventType", "in": "query", "description": "Events that have event type\\s", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "string" ] }, { "name": "flipdishEventId", "in": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored.", "required": false, "schema": { "type": "string" }, "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiEventSearchPaginationResult" }, "examples": { "GetEvents200Example": { "summary": "Default GetEvents 200 response", "x-microcks-default": true, "value": { "Data": { "AppCreatedEvent": [], "AppUpdatedEvent": [], "AnalyticsClientEvent": [], "OrderAcceptedEvent": [], "OrderDispatchedEvent": [], "OrderCustomerTrackingCreatedEvent": [], "OrderDeliveryTrackingStatusUpdatedEvent": [], "OrderBatchPublishedEvent": [], "OrderCreatedEvent": [], "OrderRatingUpdatedEvent": [], "OrderRefundedEvent": [], "OrderRejectedEvent": [], "OrderTipUpdatedEvent": [], "OrderTerminalNotifications": [], "StoreCreatedEvent": [], "StoreDeletedEvent": [], "StoreAddressUpdatedEvent": [], "StoreKioskSettingUpdatedEvent": [], "DeliveryZoneCreatedEvent": [], "DeliveryZoneUpdatedEvent": [], "DeliveryZoneDeletedEvent": [], "StoreOpeningHoursUpdatedEvent": [], "StoreMenuAssignedEvent": [], "StoreBusinessHoursOverrideCreatedEvent": [], "StoreBusinessHoursOverrideDeletedEvent": [], "StoreArchivedEvent": [], "StoreUnarchivedEvent": [], "StorePublishedEvent": [], "StoreUnpublishedEvent": [], "StoreUpdatedEvent": [], "StorePreOrderConfigUpdatedEvent": [], "StoreLogoCreatedEvent": [], "StoreLogoUpdatedEvent": [], "StoreLogoDeletedEvent": [], "MenuCreatedEvent": [], "MenuAsyncCreationCompletedEvent": [], "MenuUpdatedEvent": [], "MenuUploadedEvent": [], "MenuBulkEditEvent": [], "MenuSectionCreatedEvent": [], "MenuSectionUpdatedEvent": [], "MenuSectionDeletedEvent": [], "MenuSectionItemCreatedEvent": [], "MenuSectionItemUpdatedEvent": [], "MenuSectionItemDeletedEvent": [], "MenuItemOptionSetCreatedEvent": [], "MenuItemOptionSetUpdatedEvent": [], "MenuItemOptionSetDeletedEvent": [], "MenuItemOptionSetItemCreatedEvent": [], "MenuItemOptionSetItemUpdatedEvent": [], "MenuItemOptionSetItemDeletedEvent": [], "MenuCheckpointCreatedEvent": [], "StoreGroupCreatedEvent": [], "StoreGroupUpdatedEvent": [], "StoreGroupDeletedEvent": [], "CustomerCreatedEvent": [], "CustomerUpdatedEvent": [], "CustomerConsentUpdatedEvent": [], "WebhookSubscriptionCreatedEvent": [], "WebhookSubscriptionUpdatedEvent": [], "WebhookSubscriptionDeletedEvent": [], "PrinterTurnedOnEvent": [], "PrinterTurnedOffEvent": [], "PrinterAssignedToStoreEvent": [], "PrinterUnassignedFromStoreEvent": [], "PhoneCallStartedEvent": [], "PhoneCallEndedEvent": [], "TelephonyConfigUpdatedEvent": [], "ChannelStoresUpdatedEvent": [], "LoyaltyCampaignCreatedEvent": [], "LoyaltyCampaignDeletedEvent": [], "LoyaltyCampaignUpdatedEvent": [], "RetentionCampaignCreatedEvent": [], "RetentionCampaignDeletedEvent": [], "RetentionCampaignUpdatedEvent": [], "SmsReceivedEvent": [], "UserLoginEvent": [], "UserCreatedEvent": [], "UserUpdatedEvent": [], "UserDeletedEvent": [], "UserCreatedPasswordEvent": [], "UserAnsweredSignupQuestionsEvent": [], "VoucherCreatedEvent": [], "VoucherUpdatedEvent": [], "VoucherDeletedEvent": [], "VoucherAppliedEvent": [], "TeammateInviteSentEvent": [], "TeammateInviteAcceptedEvent": [], "TeammateUpdatedEvent": [], "TeammateDeletedEvent": [], "BankAccountCreatedEvent": [], "BankAccountUpdatedEvent": [], "BankAccountDeletedEvent": [], "BankAccountAssignedEvent": [], "HydraAssignedEvent": [], "HydraRequestResetEvent": [], "HydraStoreAssignedEvent": [], "HydraStoreUnassignedEvent": [], "HydraSettingChangedEvent": [], "HydraUnAssignedEvent": [], "HydraConnectionStatusChangedEvent": [], "KioskBluetoothPairingModeEvent": [], "KioskBluetoothUnpairingModeEvent": [], "KioskBluetoothTerminalUnpairedEvent": [], "KioskTerminalActionStateChangedEvent": [], "KioskBluetoothTerminalUpdatedEvent": [], "KioskBluetoothTerminalInitiateUpdateCheckEvent": [], "KioskBluetoothInstallUpdateInitiateEvent": [], "KioskBluetoothTerminalCancelUpdateEvent": [], "KioskBluetoothTerminalFirmwareVersionStatusEvent": [], "KioskBluetoothTerminalInstallationStatusEvent": [], "PushNotificationScheduledEvent": [], "PushNotificationSentEvent": [], "PushNotificationDeletedEvent": [], "DnsVerifiedEvent": [], "CertificateCreatedEvent": [], "CertificateRenewedEvent": [], "WebsiteVanityUrlUpdatedEvent": [], "WebsiteUpdatedEvent": [], "OrderCapacityUpdatedEvent": [], "ExternalStoreEvent": [], "OrderFulfillmentStatusUpdatedEvent": [], "AppStoreConfigCreatedEvent": [], "AppStoreConfigUpdatedEvent": [], "AppStoreConfigDeletedEvent": [], "AppStoreSubscriptionChangeJobUpdatedEvent": [], "CatalogItemCreatedEvent": [], "CatalogItemUpdatedEvent": [], "CatalogItemArchivedEvent": [], "CatalogGroupCreatedEvent": [], "CatalogGroupUpdatedEvent": [], "CatalogGroupArchivedEvent": [], "StoreTipUpdatedEvent": [], "LocationAreaCreatedEvent": [], "LocationAreaUpdatedEvent": [], "LocationCreatedEvent": [], "LocationDeletedEvent": [], "StoreServiceChargeUpdatedEvent": [], "MobileAppsSubmissionStatusUpdatedEvent": [], "MobileAppsSubmissionUpdatedEvent": [], "StoreFeeConfigUpdatedEvent": [] }, "Page": 1, "Limit": 1, "TotalRecordCount": 12.5 } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetEvents400Example": { "summary": "Default GetEvents 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": { "GetEvents401Example": { "summary": "Default GetEvents 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": { "GetEvents403Example": { "summary": "Default GetEvents 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": { "GetEvents500Example": { "summary": "Default GetEvents 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 Events", "description": "Get Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/features/enable": { "post": { "tags": [ "Features" ], "operationId": "EnableFeatures", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringArrayResult" }, "examples": { "EnableFeatures200Example": { "summary": "Default EnableFeatures 200 response", "x-microcks-default": true, "value": { "Data": [ "string" ] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "EnableFeatures400Example": { "summary": "Default EnableFeatures 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": { "EnableFeatures401Example": { "summary": "Default EnableFeatures 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": { "EnableFeatures403Example": { "summary": "Default EnableFeatures 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": { "EnableFeatures500Example": { "summary": "Default EnableFeatures 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 Enable Features", "description": "Enable Features via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/features/enable).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/features/disable": { "post": { "tags": [ "Features" ], "operationId": "DisableFeatures", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringArrayResult" }, "examples": { "DisableFeatures200Example": { "summary": "Default DisableFeatures 200 response", "x-microcks-default": true, "value": { "Data": [ "string" ] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DisableFeatures400Example": { "summary": "Default DisableFeatures 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": { "DisableFeatures401Example": { "summary": "Default DisableFeatures 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": { "DisableFeatures403Example": { "summary": "Default DisableFeatures 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": { "DisableFeatures500Example": { "summary": "Default DisableFeatures 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 Disable Features", "description": "Disable Features via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/features/disable).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/files/download/{fileId}": { "get": { "tags": [ "Files" ], "operationId": "DownloadFile", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The file id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_FileDownloadResult_" }, "examples": { "DownloadFile200Example": { "summary": "Default DownloadFile 200 response", "x-microcks-default": true, "value": { "Data": { "FileUrl": "https://api.flipdish.co/example" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DownloadFile400Example": { "summary": "Default DownloadFile 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": { "DownloadFile401Example": { "summary": "Default DownloadFile 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": { "DownloadFile403Example": { "summary": "Default DownloadFile 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": { "DownloadFile500Example": { "summary": "Default DownloadFile 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 Download File", "description": "Download File via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/files/download/{fileId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{storeId}/fpm": { "get": { "tags": [ "Fpm" ], "operationId": "GetFpmForStore", "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/TelephonyConfig" }, "examples": { "GetFpmForStore200Example": { "summary": "Default GetFpmForStore 200 response", "x-microcks-default": true, "value": { "TelephonyConfigId": 500123, "ApmEnabled": true, "Type": "PreRecorded", "ConsentEnabled": true, "PhoneNumber": "+353000000000", "SendAppLinkSms": true, "UseCustomAppLinkSmsMessage": true, "UseCustomVoiceMessage": true, "AppLinkSmsMessage": "https://api.flipdish.co/example", "ResendApmMessageAfterDays": 1 } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetFpmForStore400Example": { "summary": "Default GetFpmForStore 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": { "GetFpmForStore401Example": { "summary": "Default GetFpmForStore 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": { "GetFpmForStore403Example": { "summary": "Default GetFpmForStore 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": { "GetFpmForStore404Example": { "summary": "Default GetFpmForStore 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": { "GetFpmForStore500Example": { "summary": "Default GetFpmForStore 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 Fpm for Store", "description": "Get Fpm for Store via the Flipdish Open API v1.0 (GET /api/v1.0/{storeId}/fpm).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Fpm" ], "operationId": "CreateFpmForStore", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "phoneNumber", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The phone number query parameter.", "example": "+353000000000" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CreateFpmForStore200Example": { "summary": "Default CreateFpmForStore 200 response", "x-microcks-default": true, "value": {} } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TelephonyConfig" }, "examples": { "CreateFpmForStore201Example": { "summary": "Default CreateFpmForStore 201 response", "x-microcks-default": true, "value": { "TelephonyConfigId": 500123, "ApmEnabled": true, "Type": "PreRecorded", "ConsentEnabled": true, "PhoneNumber": "+353000000000", "SendAppLinkSms": true, "UseCustomAppLinkSmsMessage": true, "UseCustomVoiceMessage": true, "AppLinkSmsMessage": "https://api.flipdish.co/example", "ResendApmMessageAfterDays": 1 } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateFpmForStore400Example": { "summary": "Default CreateFpmForStore 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": { "CreateFpmForStore401Example": { "summary": "Default CreateFpmForStore 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": { "CreateFpmForStore403Example": { "summary": "Default CreateFpmForStore 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": { "CreateFpmForStore500Example": { "summary": "Default CreateFpmForStore 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 Fpm for Store", "description": "Create Fpm for Store via the Flipdish Open API v1.0 (POST /api/v1.0/{storeId}/fpm).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Fpm" ], "operationId": "DeleteFpmForStore", "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": { "DeleteFpmForStore400Example": { "summary": "Default DeleteFpmForStore 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": { "DeleteFpmForStore401Example": { "summary": "Default DeleteFpmForStore 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": { "DeleteFpmForStore403Example": { "summary": "Default DeleteFpmForStore 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": { "DeleteFpmForStore404Example": { "summary": "Default DeleteFpmForStore 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": { "DeleteFpmForStore500Example": { "summary": "Default DeleteFpmForStore 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 Fpm for Store", "description": "Delete Fpm for Store via the Flipdish Open API v1.0 (DELETE /api/v1.0/{storeId}/fpm).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{storeId}/fpm/edit": { "post": { "tags": [ "Fpm" ], "operationId": "EditFpmForStore", "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/TelephonyConfig" }, "examples": { "EditFpmForStoreRequestExample": { "summary": "Default EditFpmForStore request", "x-microcks-default": true, "value": { "TelephonyConfigId": 500123, "ApmEnabled": true, "Type": "PreRecorded", "ConsentEnabled": true, "PhoneNumber": "+353000000000", "SendAppLinkSms": true, "UseCustomAppLinkSmsMessage": true, "UseCustomVoiceMessage": true, "AppLinkSmsMessage": "https://api.flipdish.co/example", "ResendApmMessageAfterDays": 1 } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "EditFpmForStore400Example": { "summary": "Default EditFpmForStore 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": { "EditFpmForStore401Example": { "summary": "Default EditFpmForStore 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": { "EditFpmForStore403Example": { "summary": "Default EditFpmForStore 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": { "EditFpmForStore404Example": { "summary": "Default EditFpmForStore 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": { "EditFpmForStore500Example": { "summary": "Default EditFpmForStore 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 Edit Fpm for Store", "description": "Edit Fpm for Store via the Flipdish Open API v1.0 (POST /api/v1.0/{storeId}/fpm/edit).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/home": { "get": { "tags": [ "Home" ], "operationId": "GetHomeActions", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_HomeAction_" }, "examples": { "GetHomeActions200Example": { "summary": "Default GetHomeActions 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetHomeActions400Example": { "summary": "Default GetHomeActions 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": { "GetHomeActions401Example": { "summary": "Default GetHomeActions 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": { "GetHomeActions403Example": { "summary": "Default GetHomeActions 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": { "GetHomeActions404Example": { "summary": "Default GetHomeActions 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": { "GetHomeActions500Example": { "summary": "Default GetHomeActions 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 Home Actions", "description": "Get Home Actions via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/home).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/home/okta-portal": { "get": { "tags": [ "Home" ], "operationId": "GetOktaPortalFeatureFlag", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_OktaPortalFeatureFlag_" }, "examples": { "GetOktaPortalFeatureFlag200Example": { "summary": "Default GetOktaPortalFeatureFlag 200 response", "x-microcks-default": true, "value": { "Data": { "OktaPortalEnabled": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetOktaPortalFeatureFlag400Example": { "summary": "Default GetOktaPortalFeatureFlag 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": { "GetOktaPortalFeatureFlag401Example": { "summary": "Default GetOktaPortalFeatureFlag 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": { "GetOktaPortalFeatureFlag403Example": { "summary": "Default GetOktaPortalFeatureFlag 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": { "GetOktaPortalFeatureFlag404Example": { "summary": "Default GetOktaPortalFeatureFlag 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": { "GetOktaPortalFeatureFlag500Example": { "summary": "Default GetOktaPortalFeatureFlag 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 Okta Portal Feature Flag", "description": "Get Okta Portal Feature Flag via the Flipdish Open API v1.0 (GET /api/v1.0/home/okta-portal).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/home/stats": { "get": { "tags": [ "Home" ], "operationId": "GetHomeStatistics", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_HomeStatistics_" }, "examples": { "GetHomeStatistics200Example": { "summary": "Default GetHomeStatistics 200 response", "x-microcks-default": true, "value": { "Data": { "TotalMoneySaved": [] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetHomeStatistics400Example": { "summary": "Default GetHomeStatistics 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": { "GetHomeStatistics401Example": { "summary": "Default GetHomeStatistics 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": { "GetHomeStatistics403Example": { "summary": "Default GetHomeStatistics 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": { "GetHomeStatistics500Example": { "summary": "Default GetHomeStatistics 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 Home Statistics", "description": "Get Home Statistics via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/home/stats).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/home/{homeActionId}": { "post": { "tags": [ "Home" ], "operationId": "CompleteHomeAction", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "homeActionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The home action id path parameter.", "example": 500123 }, { "name": "isDismissed", "in": "query", "required": true, "schema": { "type": "boolean" }, "description": "The is dismissed query parameter.", "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CompleteHomeAction200Example": { "summary": "Default CompleteHomeAction 200 response", "x-microcks-default": true, "value": {} } } } } }, "204": { "description": "NoContent" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CompleteHomeAction400Example": { "summary": "Default CompleteHomeAction 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": { "CompleteHomeAction401Example": { "summary": "Default CompleteHomeAction 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": { "CompleteHomeAction403Example": { "summary": "Default CompleteHomeAction 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": { "CompleteHomeAction404Example": { "summary": "Default CompleteHomeAction 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": { "CompleteHomeAction500Example": { "summary": "Default CompleteHomeAction 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 Complete Home Action", "description": "Complete Home Action via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/home/{homeActionId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/hydra/settings": { "get": { "tags": [ "Hydra" ], "operationId": "GetSettings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_HydraConfig_" }, "examples": { "GetSettings200Example": { "summary": "Default GetSettings 200 response", "x-microcks-default": true, "value": { "Data": { "MinimumVersion": "string", "PaymentOptions": [ "Online" ], "DeviceSettings": { "Volume": 1, "FontSize": 1.0, "Brightness": 1 }, "Version": "string", "BuildNumber": "string", "GitSha": "string", "GitBranch": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSettings400Example": { "summary": "Default GetSettings 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": { "GetSettings401Example": { "summary": "Default GetSettings 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": { "GetSettings403Example": { "summary": "Default GetSettings 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": { "GetSettings404Example": { "summary": "Default GetSettings 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": { "GetSettings500Example": { "summary": "Default GetSettings 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 Settings", "description": "Get Settings via the Flipdish Open API v1.0 (GET /api/v1.0/hydra/settings).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/hydra/ably_token": { "get": { "tags": [ "Hydra" ], "operationId": "GetAblyToken", "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAblyToken400Example": { "summary": "Default GetAblyToken 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": { "GetAblyToken401Example": { "summary": "Default GetAblyToken 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": { "GetAblyToken403Example": { "summary": "Default GetAblyToken 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": { "GetAblyToken404Example": { "summary": "Default GetAblyToken 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": { "GetAblyToken500Example": { "summary": "Default GetAblyToken 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 Ably Token", "description": "Get Ably Token via the Flipdish Open API v1.0 (GET /api/v1.0/hydra/ably_token).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/hydra/registration": { "get": { "tags": [ "Hydra" ], "operationId": "GetRegistration", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_HydraStatus_" }, "examples": { "GetRegistration200Example": { "summary": "Default GetRegistration 200 response", "x-microcks-default": true, "value": { "Data": { "AppId": "500123", "StoreIds": [ 1 ], "IsRegistered": true, "PinCode": 1, "Images": [ "string" ], "UserType": "Kiosk" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRegistration400Example": { "summary": "Default GetRegistration 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": { "GetRegistration401Example": { "summary": "Default GetRegistration 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": { "GetRegistration403Example": { "summary": "Default GetRegistration 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": { "GetRegistration404Example": { "summary": "Default GetRegistration 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": { "GetRegistration500Example": { "summary": "Default GetRegistration 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 Registration", "description": "Get Registration via the Flipdish Open API v1.0 (GET /api/v1.0/hydra/registration).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/emvterminals": { "get": { "tags": [ "Hydra" ], "operationId": "Hydra_GetEmvsForAppId", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_EmvTerminalWithAssignments_" }, "examples": { "Hydra_GetEmvsForAppId200Example": { "summary": "Default Hydra_GetEmvsForAppId 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Hydra_GetEmvsForAppId400Example": { "summary": "Default Hydra_GetEmvsForAppId 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": { "Hydra_GetEmvsForAppId401Example": { "summary": "Default Hydra_GetEmvsForAppId 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": { "Hydra_GetEmvsForAppId403Example": { "summary": "Default Hydra_GetEmvsForAppId 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": { "Hydra_GetEmvsForAppId500Example": { "summary": "Default Hydra_GetEmvsForAppId 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 Hydra_Get Emvs for App Id", "description": "Hydra_Get Emvs for App Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/emvterminals).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Hydra" ], "operationId": "Hydra_CreateEmv", "parameters": [ { "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/EmvTerminal" }, "examples": { "Hydra_CreateEmvRequestExample": { "summary": "Default Hydra_CreateEmv request", "x-microcks-default": true, "value": { "EmvTerminalId": 500123, "TerminalId": "500123", "Url": "https://api.flipdish.co/example", "Token": "string", "SoftwareHouseId": "500123", "InstallerId": "500123" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Hydra_CreateEmv200Example": { "summary": "Default Hydra_CreateEmv 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Hydra_CreateEmv400Example": { "summary": "Default Hydra_CreateEmv 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": { "Hydra_CreateEmv401Example": { "summary": "Default Hydra_CreateEmv 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": { "Hydra_CreateEmv403Example": { "summary": "Default Hydra_CreateEmv 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": { "Hydra_CreateEmv500Example": { "summary": "Default Hydra_CreateEmv 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 Hydra_Create Emv", "description": "Hydra_Create Emv via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/emvterminals).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/hydra/emvterminal": { "get": { "tags": [ "Hydra" ], "operationId": "GetEMVTerminalDetails", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_PaymentTerminalDetails_" }, "examples": { "GetEMVTerminalDetails200Example": { "summary": "Default GetEMVTerminalDetails 200 response", "x-microcks-default": true, "value": { "Data": { "TerminalId": "500123", "Status": "Active", "Currency": "EUR", "Uri": "https://api.flipdish.co/example" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetEMVTerminalDetails400Example": { "summary": "Default GetEMVTerminalDetails 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": { "GetEMVTerminalDetails401Example": { "summary": "Default GetEMVTerminalDetails 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": { "GetEMVTerminalDetails403Example": { "summary": "Default GetEMVTerminalDetails 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": { "GetEMVTerminalDetails404Example": { "summary": "Default GetEMVTerminalDetails 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": { "GetEMVTerminalDetails500Example": { "summary": "Default GetEMVTerminalDetails 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 EMV Terminal Details", "description": "Get EMV Terminal Details via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/hydra/emvterminal).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/kiosksettings/{deviceId}": { "get": { "tags": [ "Hydra" ], "operationId": "GetKioskSettings", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The device id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_KioskSettings_" }, "examples": { "GetKioskSettings200Example": { "summary": "Default GetKioskSettings 200 response", "x-microcks-default": true, "value": { "Data": { "HideLogoFromFrontPage": true, "TwoColumnMenuLayout": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetKioskSettings400Example": { "summary": "Default GetKioskSettings 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": { "GetKioskSettings401Example": { "summary": "Default GetKioskSettings 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": { "GetKioskSettings403Example": { "summary": "Default GetKioskSettings 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": { "GetKioskSettings500Example": { "summary": "Default GetKioskSettings 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 Kiosk Settings", "description": "Get Kiosk Settings via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/kiosksettings/{deviceId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Hydra" ], "operationId": "UpdateKioskSettings", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The device id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KioskSettings" }, "examples": { "UpdateKioskSettingsRequestExample": { "summary": "Default UpdateKioskSettings request", "x-microcks-default": true, "value": { "HideLogoFromFrontPage": true, "TwoColumnMenuLayout": true } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateKioskSettings400Example": { "summary": "Default UpdateKioskSettings 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": { "UpdateKioskSettings401Example": { "summary": "Default UpdateKioskSettings 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": { "UpdateKioskSettings403Example": { "summary": "Default UpdateKioskSettings 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": { "UpdateKioskSettings500Example": { "summary": "Default UpdateKioskSettings 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 Kiosk Settings", "description": "Update Kiosk Settings via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/kiosksettings/{deviceId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/kioskcashsettings/{deviceId}": { "get": { "tags": [ "Hydra" ], "operationId": "GetKioskCashPaymentSettings", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The device id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_KioskCashPaymentSettings_" }, "examples": { "GetKioskCashPaymentSettings200Example": { "summary": "Default GetKioskCashPaymentSettings 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetKioskCashPaymentSettings400Example": { "summary": "Default GetKioskCashPaymentSettings 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": { "GetKioskCashPaymentSettings401Example": { "summary": "Default GetKioskCashPaymentSettings 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": { "GetKioskCashPaymentSettings403Example": { "summary": "Default GetKioskCashPaymentSettings 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": { "GetKioskCashPaymentSettings500Example": { "summary": "Default GetKioskCashPaymentSettings 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 Kiosk Cash Payment Settings", "description": "Get Kiosk Cash Payment Settings via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/kioskcashsettings/{deviceId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/hydra/emvorderstate/{orderId}": { "get": { "tags": [ "Hydra" ], "operationId": "GetEmvOrderState", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The order id path parameter.", "example": 500123 }, { "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/RestApiResult_PaymentTerminalTransactionDetails_" }, "examples": { "GetEmvOrderState200Example": { "summary": "Default GetEmvOrderState 200 response", "x-microcks-default": true, "value": { "Data": { "CardSchemeName": "Example Name", "DateOfExpiry": "2026-06-02T12:00:00Z", "AuthCode": "string", "TransactionResult": "string", "PrimaryAccountNumber": "string", "CardholderVerificationMethod": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetEmvOrderState400Example": { "summary": "Default GetEmvOrderState 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": { "GetEmvOrderState401Example": { "summary": "Default GetEmvOrderState 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": { "GetEmvOrderState403Example": { "summary": "Default GetEmvOrderState 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": { "GetEmvOrderState404Example": { "summary": "Default GetEmvOrderState 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": { "GetEmvOrderState500Example": { "summary": "Default GetEmvOrderState 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 Emv Order State", "description": "Get Emv Order State via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/hydra/emvorderstate/{orderId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/hydra/{deviceType}/{deviceId}": { "get": { "tags": [ "Hydra" ], "operationId": "GetAttachedDevice", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "deviceType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Kiosk", "Terminal", "LegacyPrinter" ] }, "description": "The device type path parameter.", "example": "Kiosk" }, { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The device id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_HydraDeviceDetails_" }, "examples": { "GetAttachedDevice200Example": { "summary": "Default GetAttachedDevice 200 response", "x-microcks-default": true, "value": { "Data": { "HydraConfigId": 500123, "DeviceId": "500123", "SerialNumber": "string", "DeviceType": "Kiosk", "Status": "Online", "DeviceName": "Example Name", "StoreNames": [], "LastPollUtc": "2026-06-02T12:00:00Z", "Version": "string", "BuildNumber": "string", "GitSha": "string", "GitBranch": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAttachedDevice400Example": { "summary": "Default GetAttachedDevice 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": { "GetAttachedDevice401Example": { "summary": "Default GetAttachedDevice 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": { "GetAttachedDevice403Example": { "summary": "Default GetAttachedDevice 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": { "GetAttachedDevice404Example": { "summary": "Default GetAttachedDevice 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": { "GetAttachedDevice500Example": { "summary": "Default GetAttachedDevice 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 Attached Device", "description": "Get Attached Device via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/hydra/{deviceType}/{deviceId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/hydra/{deviceType}/list": { "get": { "tags": [ "Hydra" ], "operationId": "GetAttachedDevices", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "deviceType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Kiosk", "Terminal", "LegacyPrinter" ] }, "description": "The device type path parameter.", "example": "Kiosk" }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The page index query parameter.", "example": 1 }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The page size query parameter.", "example": 1 }, { "name": "storeId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The store id query parameter.", "example": 500123 }, { "name": "deviceName", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The device name query parameter.", "example": "Example Name" }, { "name": "deviceSerial", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The device serial query parameter.", "example": "string" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult_HydraDeviceDetails_" }, "examples": { "GetAttachedDevices200Example": { "summary": "Default GetAttachedDevices 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": { "GetAttachedDevices400Example": { "summary": "Default GetAttachedDevices 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": { "GetAttachedDevices401Example": { "summary": "Default GetAttachedDevices 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": { "GetAttachedDevices403Example": { "summary": "Default GetAttachedDevices 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": { "GetAttachedDevices404Example": { "summary": "Default GetAttachedDevices 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": { "GetAttachedDevices500Example": { "summary": "Default GetAttachedDevices 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 Attached Devices", "description": "Get Attached Devices via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/hydra/{deviceType}/list).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/hydra/registration": { "post": { "tags": [ "Hydra" ], "operationId": "Register", "parameters": [ { "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/HydraRegistrationRequest" }, "examples": { "RegisterRequestExample": { "summary": "Default Register request", "x-microcks-default": true, "value": { "StoreIds": [ 1 ], "DeviceName": "Example Name", "PinCode": 1 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_HydraStatus_" }, "examples": { "Register200Example": { "summary": "Default Register 200 response", "x-microcks-default": true, "value": { "Data": { "AppId": "500123", "StoreIds": [ 1 ], "IsRegistered": true, "PinCode": 1, "Images": [ "string" ], "UserType": "Kiosk" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Register400Example": { "summary": "Default Register 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": { "Register401Example": { "summary": "Default Register 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": { "Register403Example": { "summary": "Default Register 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": { "Register404Example": { "summary": "Default Register 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": { "Register500Example": { "summary": "Default Register 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 Register", "description": "Register via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/hydra/registration).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/hydra/cancelemvpayment/{orderId}": { "post": { "tags": [ "Hydra" ], "operationId": "CancelEmvPayment", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The order id path parameter.", "example": 500123 }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CancelEmvPayment400Example": { "summary": "Default CancelEmvPayment 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": { "CancelEmvPayment401Example": { "summary": "Default CancelEmvPayment 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": { "CancelEmvPayment403Example": { "summary": "Default CancelEmvPayment 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": { "CancelEmvPayment404Example": { "summary": "Default CancelEmvPayment 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": { "CancelEmvPayment500Example": { "summary": "Default CancelEmvPayment 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 Cancel Emv Payment", "description": "Cancel Emv Payment via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/hydra/cancelemvpayment/{orderId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/hydra/{deviceId}/attach/{storeId}": { "post": { "tags": [ "Hydra" ], "operationId": "AttachStoreToTerminal", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The device 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_HydraStatus_" }, "examples": { "AttachStoreToTerminal200Example": { "summary": "Default AttachStoreToTerminal 200 response", "x-microcks-default": true, "value": { "Data": { "AppId": "500123", "StoreIds": [ 1 ], "IsRegistered": true, "PinCode": 1, "Images": [ "string" ], "UserType": "Kiosk" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AttachStoreToTerminal400Example": { "summary": "Default AttachStoreToTerminal 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": { "AttachStoreToTerminal401Example": { "summary": "Default AttachStoreToTerminal 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": { "AttachStoreToTerminal403Example": { "summary": "Default AttachStoreToTerminal 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": { "AttachStoreToTerminal404Example": { "summary": "Default AttachStoreToTerminal 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": { "AttachStoreToTerminal500Example": { "summary": "Default AttachStoreToTerminal 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 Attach Store to Terminal", "description": "Attach Store to Terminal via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/hydra/{deviceId}/attach/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/hydra/{deviceId}/detach/{storeId}": { "post": { "tags": [ "Hydra" ], "operationId": "DetachStoreFromTerminal", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The device 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_HydraStatus_" }, "examples": { "DetachStoreFromTerminal200Example": { "summary": "Default DetachStoreFromTerminal 200 response", "x-microcks-default": true, "value": { "Data": { "AppId": "500123", "StoreIds": [ 1 ], "IsRegistered": true, "PinCode": 1, "Images": [ "string" ], "UserType": "Kiosk" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DetachStoreFromTerminal400Example": { "summary": "Default DetachStoreFromTerminal 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": { "DetachStoreFromTerminal401Example": { "summary": "Default DetachStoreFromTerminal 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": { "DetachStoreFromTerminal403Example": { "summary": "Default DetachStoreFromTerminal 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": { "DetachStoreFromTerminal404Example": { "summary": "Default DetachStoreFromTerminal 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": { "DetachStoreFromTerminal500Example": { "summary": "Default DetachStoreFromTerminal 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 Detach Store from Terminal", "description": "Detach Store from Terminal via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/hydra/{deviceId}/detach/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/hydra/emvterminal/unassign/{hydraConfigId}": { "post": { "tags": [ "Hydra" ], "operationId": "UnassignEmv", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "hydraConfigId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The hydra config id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UnassignEmv400Example": { "summary": "Default UnassignEmv 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": { "UnassignEmv401Example": { "summary": "Default UnassignEmv 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": { "UnassignEmv403Example": { "summary": "Default UnassignEmv 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": { "UnassignEmv500Example": { "summary": "Default UnassignEmv 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 Unassign Emv", "description": "Unassign Emv via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/hydra/emvterminal/unassign/{hydraConfigId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/AttachStoreToKiosk/{deviceId}/store/{storeId}": { "post": { "tags": [ "Hydra" ], "operationId": "AttachStoreToKiosk", "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": "deviceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The device id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_HydraStatus_" }, "examples": { "AttachStoreToKiosk200Example": { "summary": "Default AttachStoreToKiosk 200 response", "x-microcks-default": true, "value": { "Data": { "AppId": "500123", "StoreIds": [ 1 ], "IsRegistered": true, "PinCode": 1, "Images": [ "string" ], "UserType": "Kiosk" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AttachStoreToKiosk400Example": { "summary": "Default AttachStoreToKiosk 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": { "AttachStoreToKiosk401Example": { "summary": "Default AttachStoreToKiosk 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": { "AttachStoreToKiosk403Example": { "summary": "Default AttachStoreToKiosk 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": { "AttachStoreToKiosk404Example": { "summary": "Default AttachStoreToKiosk 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": { "AttachStoreToKiosk500Example": { "summary": "Default AttachStoreToKiosk 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 Attach Store to Kiosk", "description": "Attach Store to Kiosk via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/AttachStoreToKiosk/{deviceId}/store/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/hydra/emvterminal/assign/{hydraConfigId}/{emvTerminalId}": { "post": { "tags": [ "Hydra" ], "operationId": "AssignEmv", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "hydraConfigId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The hydra config id path parameter.", "example": 500123 }, { "name": "emvTerminalId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The emv terminal id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AssignEmv400Example": { "summary": "Default AssignEmv 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": { "AssignEmv401Example": { "summary": "Default AssignEmv 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": { "AssignEmv403Example": { "summary": "Default AssignEmv 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": { "AssignEmv500Example": { "summary": "Default AssignEmv 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 Emv", "description": "Assign Emv via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/hydra/emvterminal/assign/{hydraConfigId}/{emvTerminalId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/hydra/{deviceId}/login": { "post": { "tags": [ "Hydra" ], "operationId": "LoginWithDeviceId", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The device id path parameter.", "example": "500123" }, { "name": "hydraUserType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Kiosk", "Terminal", "LegacyPrinter" ] }, "description": "The hydra user type query parameter.", "example": "Kiosk" }, { "name": "serialNumber", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The serial number query parameter.", "example": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "LoginWithDeviceId400Example": { "summary": "Default LoginWithDeviceId 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": { "LoginWithDeviceId401Example": { "summary": "Default LoginWithDeviceId 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": { "LoginWithDeviceId403Example": { "summary": "Default LoginWithDeviceId 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": { "LoginWithDeviceId404Example": { "summary": "Default LoginWithDeviceId 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": { "LoginWithDeviceId500Example": { "summary": "Default LoginWithDeviceId 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 Login with Device Id", "description": "Login with Device Id via the Flipdish Open API v1.0 (POST /api/v1.0/hydra/{deviceId}/login).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/kioskupdatecashsettings": { "post": { "tags": [ "Hydra" ], "operationId": "UpdateKioskCashVisibilitySettings", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The device id query parameter.", "example": "500123" }, { "name": "isCashEnabled", "in": "query", "required": true, "schema": { "type": "boolean" }, "description": "The is cash enabled query parameter.", "example": true } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateKioskCashVisibilitySettings400Example": { "summary": "Default UpdateKioskCashVisibilitySettings 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": { "UpdateKioskCashVisibilitySettings401Example": { "summary": "Default UpdateKioskCashVisibilitySettings 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": { "UpdateKioskCashVisibilitySettings403Example": { "summary": "Default UpdateKioskCashVisibilitySettings 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": { "UpdateKioskCashVisibilitySettings404Example": { "summary": "Default UpdateKioskCashVisibilitySettings 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": { "UpdateKioskCashVisibilitySettings500Example": { "summary": "Default UpdateKioskCashVisibilitySettings 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 Kiosk Cash Visibility Settings", "description": "Update Kiosk Cash Visibility Settings via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/kioskupdatecashsettings).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/emvterminals/{id}": { "delete": { "tags": [ "Hydra" ], "operationId": "Hydra_DeleteEmv", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Hydra_DeleteEmv200Example": { "summary": "Default Hydra_DeleteEmv 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Hydra_DeleteEmv400Example": { "summary": "Default Hydra_DeleteEmv 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": { "Hydra_DeleteEmv401Example": { "summary": "Default Hydra_DeleteEmv 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": { "Hydra_DeleteEmv403Example": { "summary": "Default Hydra_DeleteEmv 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": { "Hydra_DeleteEmv500Example": { "summary": "Default Hydra_DeleteEmv 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 Hydra_Delete Emv", "description": "Hydra_Delete Emv via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/emvterminals/{id}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/hydra/{deviceId}/registration": { "delete": { "tags": [ "Hydra" ], "operationId": "UnAssign", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The device id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UnAssign400Example": { "summary": "Default UnAssign 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": { "UnAssign401Example": { "summary": "Default UnAssign 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": { "UnAssign403Example": { "summary": "Default UnAssign 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": { "UnAssign404Example": { "summary": "Default UnAssign 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": { "UnAssign500Example": { "summary": "Default UnAssign 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 Un Assign", "description": "Un Assign via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/hydra/{deviceId}/registration).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/DetachStoreFromKiosk/{deviceId}/store/{storeId}": { "delete": { "tags": [ "Hydra" ], "operationId": "Hydra_DetachStoreFromKiosk", "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": "deviceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The device id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_HydraStatus_" }, "examples": { "Hydra_DetachStoreFromKiosk200Example": { "summary": "Default Hydra_DetachStoreFromKiosk 200 response", "x-microcks-default": true, "value": { "Data": { "AppId": "500123", "StoreIds": [ 1 ], "IsRegistered": true, "PinCode": 1, "Images": [ "string" ], "UserType": "Kiosk" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Hydra_DetachStoreFromKiosk400Example": { "summary": "Default Hydra_DetachStoreFromKiosk 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": { "Hydra_DetachStoreFromKiosk401Example": { "summary": "Default Hydra_DetachStoreFromKiosk 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": { "Hydra_DetachStoreFromKiosk403Example": { "summary": "Default Hydra_DetachStoreFromKiosk 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": { "Hydra_DetachStoreFromKiosk404Example": { "summary": "Default Hydra_DetachStoreFromKiosk 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": { "Hydra_DetachStoreFromKiosk500Example": { "summary": "Default Hydra_DetachStoreFromKiosk 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 Hydra_Detach Store from Kiosk", "description": "Hydra_Detach Store from Kiosk via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/DetachStoreFromKiosk/{deviceId}/store/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/intercom/userHash": { "get": { "tags": [ "Intercom" ], "operationId": "UserHash", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_IntercomUserHash_" }, "examples": { "UserHash200Example": { "summary": "Default UserHash 200 response", "x-microcks-default": true, "value": { "Data": { "UserHash": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UserHash400Example": { "summary": "Default UserHash 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": { "UserHash401Example": { "summary": "Default UserHash 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": { "UserHash403Example": { "summary": "Default UserHash 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": { "UserHash500Example": { "summary": "Default UserHash 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 User Hash", "description": "User Hash via the Flipdish Open API v1.0 (GET /api/v1.0/intercom/userHash).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/lightspeed/{storeId}/settings": { "get": { "tags": [ "Lightspeed" ], "operationId": "Lightspeed_GetStoreSettings", "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_LightspeedSettings_" }, "examples": { "Lightspeed_GetStoreSettings200Example": { "summary": "Default Lightspeed_GetStoreSettings 200 response", "x-microcks-default": true, "value": { "Data": { "CompanyId": "500123", "UseOAuth": true, "Enabled": true, "EstimatedMinutesForDelivery": 1, "EstimatedMinutesForCollection": 1, "GeographicLocation": "string", "Establishment": true, "VoucherId": "500123", "DeliveryFeeId": "500123", "ProcessingFeeId": "500123", "PriceType": "Default", "MenuId": 500123, "CollectionTableId": 500123, "DeliveryTableId": 500123, "CollectionTableIds": {}, "DeliveryTableIds": {}, "UseTaxInclusivePrices": true, "SkipStatusCheckAndAcceptOrderAfterSending": true, "SendTableNumberToTableId": true, "AddChefNoteToProduct": true, "ChefNoteItemId": "500123", "ChefNoteModifierId": "500123", "ServiceChargeId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Lightspeed_GetStoreSettings400Example": { "summary": "Default Lightspeed_GetStoreSettings 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": { "Lightspeed_GetStoreSettings401Example": { "summary": "Default Lightspeed_GetStoreSettings 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": { "Lightspeed_GetStoreSettings403Example": { "summary": "Default Lightspeed_GetStoreSettings 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": { "Lightspeed_GetStoreSettings404Example": { "summary": "Default Lightspeed_GetStoreSettings 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": { "Lightspeed_GetStoreSettings500Example": { "summary": "Default Lightspeed_GetStoreSettings 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 Lightspeed_Get Store Settings", "description": "Lightspeed_Get Store Settings via the Flipdish Open API v1.0 (GET /api/v1.0/lightspeed/{storeId}/settings).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Lightspeed" ], "operationId": "Lightspeed_SaveStoreSettings", "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/LightspeedSettings" }, "examples": { "Lightspeed_SaveStoreSettingsRequestExample": { "summary": "Default Lightspeed_SaveStoreSettings request", "x-microcks-default": true, "value": { "CompanyId": "500123", "UseOAuth": true, "Enabled": true, "EstimatedMinutesForDelivery": 1, "EstimatedMinutesForCollection": 1, "GeographicLocation": "string", "Establishment": true, "VoucherId": "500123", "DeliveryFeeId": "500123", "ProcessingFeeId": "500123", "PriceType": "Default", "MenuId": 500123, "CollectionTableId": 500123, "DeliveryTableId": 500123, "CollectionTableIds": {}, "DeliveryTableIds": {}, "UseTaxInclusivePrices": true, "SkipStatusCheckAndAcceptOrderAfterSending": true, "SendTableNumberToTableId": true, "AddChefNoteToProduct": true, "ChefNoteItemId": "500123", "ChefNoteModifierId": "500123", "ServiceChargeId": "500123" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_LightspeedSettings_" }, "examples": { "Lightspeed_SaveStoreSettings200Example": { "summary": "Default Lightspeed_SaveStoreSettings 200 response", "x-microcks-default": true, "value": { "Data": { "CompanyId": "500123", "UseOAuth": true, "Enabled": true, "EstimatedMinutesForDelivery": 1, "EstimatedMinutesForCollection": 1, "GeographicLocation": "string", "Establishment": true, "VoucherId": "500123", "DeliveryFeeId": "500123", "ProcessingFeeId": "500123", "PriceType": "Default", "MenuId": 500123, "CollectionTableId": 500123, "DeliveryTableId": 500123, "CollectionTableIds": {}, "DeliveryTableIds": {}, "UseTaxInclusivePrices": true, "SkipStatusCheckAndAcceptOrderAfterSending": true, "SendTableNumberToTableId": true, "AddChefNoteToProduct": true, "ChefNoteItemId": "500123", "ChefNoteModifierId": "500123", "ServiceChargeId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Lightspeed_SaveStoreSettings400Example": { "summary": "Default Lightspeed_SaveStoreSettings 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": { "Lightspeed_SaveStoreSettings401Example": { "summary": "Default Lightspeed_SaveStoreSettings 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": { "Lightspeed_SaveStoreSettings403Example": { "summary": "Default Lightspeed_SaveStoreSettings 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": { "Lightspeed_SaveStoreSettings500Example": { "summary": "Default Lightspeed_SaveStoreSettings 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 Lightspeed_Save Store Settings", "description": "Lightspeed_Save Store Settings via the Flipdish Open API v1.0 (POST /api/v1.0/lightspeed/{storeId}/settings).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/lightspeed/{storeId}/menu/generate": { "post": { "tags": [ "Lightspeed" ], "operationId": "Lightspeed_GenerateMenu", "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": { "type": "object" }, "examples": { "Lightspeed_GenerateMenu200Example": { "summary": "Default Lightspeed_GenerateMenu 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Lightspeed_GenerateMenu400Example": { "summary": "Default Lightspeed_GenerateMenu 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": { "Lightspeed_GenerateMenu401Example": { "summary": "Default Lightspeed_GenerateMenu 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": { "Lightspeed_GenerateMenu403Example": { "summary": "Default Lightspeed_GenerateMenu 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": { "Lightspeed_GenerateMenu500Example": { "summary": "Default Lightspeed_GenerateMenu 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 Lightspeed_Generate Menu", "description": "Lightspeed_Generate Menu via the Flipdish Open API v1.0 (POST /api/v1.0/lightspeed/{storeId}/menu/generate).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/looker/dashboards": { "get": { "tags": [ "LookerDashboard" ], "operationId": "LookerDashboard.GetAll", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "LookerDashboard.GetAll400Example": { "summary": "Default LookerDashboard.GetAll 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": { "LookerDashboard.GetAll401Example": { "summary": "Default LookerDashboard.GetAll 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": { "LookerDashboard.GetAll403Example": { "summary": "Default LookerDashboard.GetAll 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": { "LookerDashboard.GetAll500Example": { "summary": "Default LookerDashboard.GetAll 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 Looker Dashboard.Get All", "description": "Looker Dashboard.Get All via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/looker/dashboards).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/looker/sso": { "get": { "tags": [ "LookerSingleSignOn" ], "operationId": "GetSSOEndpoint", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "embedPath", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The embed path query parameter.", "example": "string" }, { "name": "filters", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The filters query parameter.", "example": "string" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardEmbed" }, "examples": { "GetSSOEndpoint200Example": { "summary": "Default GetSSOEndpoint 200 response", "x-microcks-default": true, "value": { "EmbedUrl": "https://api.flipdish.co/example" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSSOEndpoint400Example": { "summary": "Default GetSSOEndpoint 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": { "GetSSOEndpoint401Example": { "summary": "Default GetSSOEndpoint 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": { "GetSSOEndpoint403Example": { "summary": "Default GetSSOEndpoint 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": { "GetSSOEndpoint500Example": { "summary": "Default GetSSOEndpoint 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 SSO Endpoint", "description": "Get SSO Endpoint via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/looker/sso).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/oauthclients/appnames": { "get": { "tags": [ "OAuthClients" ], "operationId": "OAuthClients_GetApplications", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "OAuthClients_GetApplications200Example": { "summary": "Default OAuthClients_GetApplications 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "OAuthClients_GetApplications400Example": { "summary": "Default OAuthClients_GetApplications 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": { "OAuthClients_GetApplications401Example": { "summary": "Default OAuthClients_GetApplications 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": { "OAuthClients_GetApplications403Example": { "summary": "Default OAuthClients_GetApplications 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": { "OAuthClients_GetApplications500Example": { "summary": "Default OAuthClients_GetApplications 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 O Auth Clients_Get Applications", "description": "O Auth Clients_Get Applications via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/oauthclients/appnames).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/oauthclients/{oauthAppId}": { "get": { "tags": [ "OAuthClients" ], "operationId": "GetOAuthClientByClientId", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "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/RestApiResult_OAuthApp_" }, "examples": { "GetOAuthClientByClientId200Example": { "summary": "Default GetOAuthClientByClientId 200 response", "x-microcks-default": true, "value": { "Data": { "OauthAppId": "6364835077453070787486", "OauthAppName": "My OAuth App", "OwnerUserId": 12345, "LogoUri": "https://domain.com/mylogo.png", "Flow": 2, "AccessTokenLifetime": 3600, "AbsoluteRefreshTokenLifetime": 2592000 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetOAuthClientByClientId400Example": { "summary": "Default GetOAuthClientByClientId 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": { "GetOAuthClientByClientId401Example": { "summary": "Default GetOAuthClientByClientId 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetOAuthClientByClientId403Example": { "summary": "Default GetOAuthClientByClientId 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": { "GetOAuthClientByClientId404Example": { "summary": "Default GetOAuthClientByClientId 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": { "GetOAuthClientByClientId500Example": { "summary": "Default GetOAuthClientByClientId 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 O Auth Client by Client Id", "description": "Get O Auth Client by Client Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/oauthclients/{oauthAppId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "OAuthClients" ], "operationId": "UpdateOAuthApp", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateOAuthApp400Example": { "summary": "Default UpdateOAuthApp 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": { "UpdateOAuthApp401Example": { "summary": "Default UpdateOAuthApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateOAuthApp403Example": { "summary": "Default UpdateOAuthApp 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": { "UpdateOAuthApp404Example": { "summary": "Default UpdateOAuthApp 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": { "UpdateOAuthApp500Example": { "summary": "Default UpdateOAuthApp 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 O Auth App", "description": "Update O Auth App via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/oauthclients/{oauthAppId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "OAuthClients" ], "operationId": "DeleteOAuthApp", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteOAuthApp400Example": { "summary": "Default DeleteOAuthApp 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": { "DeleteOAuthApp401Example": { "summary": "Default DeleteOAuthApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteOAuthApp403Example": { "summary": "Default DeleteOAuthApp 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": { "DeleteOAuthApp500Example": { "summary": "Default DeleteOAuthApp 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 O Auth App", "description": "Delete O Auth App via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/oauthclients/{oauthAppId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/oauthclients/{oauthAppId}/secret": { "get": { "tags": [ "OAuthClients" ], "operationId": "GetOAuthClientSecret", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "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/RestApiStringResult" }, "examples": { "GetOAuthClientSecret200Example": { "summary": "Default GetOAuthClientSecret 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetOAuthClientSecret400Example": { "summary": "Default GetOAuthClientSecret 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": { "GetOAuthClientSecret401Example": { "summary": "Default GetOAuthClientSecret 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetOAuthClientSecret403Example": { "summary": "Default GetOAuthClientSecret 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": { "GetOAuthClientSecret404Example": { "summary": "Default GetOAuthClientSecret 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": { "GetOAuthClientSecret500Example": { "summary": "Default GetOAuthClientSecret 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 O Auth Client Secret", "description": "Get O Auth Client Secret via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/oauthclients/{oauthAppId}/secret).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/oauthclients/{oauthAppId}/accesstoken": { "get": { "tags": [ "OAuthClients" ], "operationId": "GetOauthAccessToken", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "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/RestApiStringResult" }, "examples": { "GetOauthAccessToken200Example": { "summary": "Default GetOauthAccessToken 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetOauthAccessToken400Example": { "summary": "Default GetOauthAccessToken 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": { "GetOauthAccessToken401Example": { "summary": "Default GetOauthAccessToken 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetOauthAccessToken403Example": { "summary": "Default GetOauthAccessToken 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": { "GetOauthAccessToken500Example": { "summary": "Default GetOauthAccessToken 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 Oauth Access Token", "description": "Get Oauth Access Token via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/oauthclients/{oauthAppId}/accesstoken).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/oauthclients/{oauthAppId}/redirecturis": { "get": { "tags": [ "OAuthClients" ], "operationId": "GetRedirectUris", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "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/RestApiArrayResult_OauthClientRedirectUri_" }, "examples": { "GetRedirectUris200Example": { "summary": "Default GetRedirectUris 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRedirectUris400Example": { "summary": "Default GetRedirectUris 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": { "GetRedirectUris401Example": { "summary": "Default GetRedirectUris 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRedirectUris403Example": { "summary": "Default GetRedirectUris 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": { "GetRedirectUris500Example": { "summary": "Default GetRedirectUris 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 Redirect Uris", "description": "Get Redirect Uris via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/oauthclients/{oauthAppId}/redirecturis).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "OAuthClients" ], "operationId": "AddRedirectUri", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_OauthClientRedirectUri_" }, "examples": { "AddRedirectUri200Example": { "summary": "Default AddRedirectUri 200 response", "x-microcks-default": true, "value": { "Data": { "Id": 500123, "Uri": "https://api.flipdish.co/example" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddRedirectUri400Example": { "summary": "Default AddRedirectUri 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": { "AddRedirectUri401Example": { "summary": "Default AddRedirectUri 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddRedirectUri403Example": { "summary": "Default AddRedirectUri 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": { "AddRedirectUri500Example": { "summary": "Default AddRedirectUri 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 Redirect Uri", "description": "Add Redirect Uri via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/oauthclients/{oauthAppId}/redirecturis).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/oauthclients": { "get": { "tags": [ "OAuthClients" ], "operationId": "GetOAuthApps", "parameters": [ { "name": "oauthAppName", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The oauth app name query parameter.", "example": "Example Name" }, { "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/RestApiArrayResult_OAuthApp_" }, "examples": { "GetOAuthApps200Example": { "summary": "Default GetOAuthApps 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetOAuthApps400Example": { "summary": "Default GetOAuthApps 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": { "GetOAuthApps401Example": { "summary": "Default GetOAuthApps 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetOAuthApps403Example": { "summary": "Default GetOAuthApps 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": { "GetOAuthApps404Example": { "summary": "Default GetOAuthApps 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": { "GetOAuthApps500Example": { "summary": "Default GetOAuthApps 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 O Auth Apps", "description": "Get O Auth Apps via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/oauthclients).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "OAuthClients" ], "operationId": "CreateOAuthApp", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateOAuthApp400Example": { "summary": "Default CreateOAuthApp 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": { "CreateOAuthApp401Example": { "summary": "Default CreateOAuthApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateOAuthApp403Example": { "summary": "Default CreateOAuthApp 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": { "CreateOAuthApp500Example": { "summary": "Default CreateOAuthApp 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 O Auth App", "description": "Create O Auth App via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/oauthclients).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/oauthclients/{oauthAppId}/redirecturis/{uriId}": { "delete": { "tags": [ "OAuthClients" ], "operationId": "RemoveRedirectUri", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "uriId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The uri id path parameter.", "example": 500123 }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RemoveRedirectUri400Example": { "summary": "Default RemoveRedirectUri 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": { "RemoveRedirectUri401Example": { "summary": "Default RemoveRedirectUri 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RemoveRedirectUri403Example": { "summary": "Default RemoveRedirectUri 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": { "RemoveRedirectUri500Example": { "summary": "Default RemoveRedirectUri 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 Redirect Uri", "description": "Remove Redirect Uri via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/oauthclients/{oauthAppId}/redirecturis/{uriId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/clients/{appId}/onboarding/config": { "get": { "tags": [ "Onboarding" ], "operationId": "Onboarding_GetOnboardingConfig", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Onboarding_GetOnboardingConfig200Example": { "summary": "Default Onboarding_GetOnboardingConfig 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Onboarding_GetOnboardingConfig400Example": { "summary": "Default Onboarding_GetOnboardingConfig 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": { "Onboarding_GetOnboardingConfig401Example": { "summary": "Default Onboarding_GetOnboardingConfig 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": { "Onboarding_GetOnboardingConfig403Example": { "summary": "Default Onboarding_GetOnboardingConfig 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": { "Onboarding_GetOnboardingConfig500Example": { "summary": "Default Onboarding_GetOnboardingConfig 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 Onboarding_Get Onboarding Config", "description": "Onboarding_Get Onboarding Config via the Flipdish Open API v1.0 (GET /api/v1.0/clients/{appId}/onboarding/config).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Onboarding" ], "operationId": "Onboarding_UpdateOnboardingConfig", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Onboarding_UpdateOnboardingConfig200Example": { "summary": "Default Onboarding_UpdateOnboardingConfig 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Onboarding_UpdateOnboardingConfig400Example": { "summary": "Default Onboarding_UpdateOnboardingConfig 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": { "Onboarding_UpdateOnboardingConfig401Example": { "summary": "Default Onboarding_UpdateOnboardingConfig 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": { "Onboarding_UpdateOnboardingConfig403Example": { "summary": "Default Onboarding_UpdateOnboardingConfig 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": { "Onboarding_UpdateOnboardingConfig500Example": { "summary": "Default Onboarding_UpdateOnboardingConfig 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 Onboarding_Update Onboarding Config", "description": "Onboarding_Update Onboarding Config via the Flipdish Open API v1.0 (POST /api/v1.0/clients/{appId}/onboarding/config).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/clients/{appId}/onboarding/configs": { "get": { "tags": [ "Onboarding" ], "operationId": "Onboarding_GetOnboardingConfigs", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Onboarding_GetOnboardingConfigs200Example": { "summary": "Default Onboarding_GetOnboardingConfigs 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Onboarding_GetOnboardingConfigs400Example": { "summary": "Default Onboarding_GetOnboardingConfigs 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": { "Onboarding_GetOnboardingConfigs401Example": { "summary": "Default Onboarding_GetOnboardingConfigs 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": { "Onboarding_GetOnboardingConfigs403Example": { "summary": "Default Onboarding_GetOnboardingConfigs 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": { "Onboarding_GetOnboardingConfigs500Example": { "summary": "Default Onboarding_GetOnboardingConfigs 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 Onboarding_Get Onboarding Configs", "description": "Onboarding_Get Onboarding Configs via the Flipdish Open API v1.0 (GET /api/v1.0/clients/{appId}/onboarding/configs).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/clients/{appId}/onboarding/stores/{storeId}": { "get": { "tags": [ "Onboarding" ], "operationId": "Onboarding_GetOnboardingItems", "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": "milestoneId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The milestone id query parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Onboarding_GetOnboardingItems200Example": { "summary": "Default Onboarding_GetOnboardingItems 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Onboarding_GetOnboardingItems400Example": { "summary": "Default Onboarding_GetOnboardingItems 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": { "Onboarding_GetOnboardingItems401Example": { "summary": "Default Onboarding_GetOnboardingItems 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": { "Onboarding_GetOnboardingItems403Example": { "summary": "Default Onboarding_GetOnboardingItems 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": { "Onboarding_GetOnboardingItems500Example": { "summary": "Default Onboarding_GetOnboardingItems 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 Onboarding_Get Onboarding Items", "description": "Onboarding_Get Onboarding Items via the Flipdish Open API v1.0 (GET /api/v1.0/clients/{appId}/onboarding/stores/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/clients/{appId}/onboarding/stores": { "get": { "tags": [ "Onboarding" ], "operationId": "Onboarding_GetOnboardingItemsV2", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The store id query parameter.", "example": 500123 }, { "name": "milestoneId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The milestone id query parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Onboarding_GetOnboardingItemsV2200Example": { "summary": "Default Onboarding_GetOnboardingItemsV2 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Onboarding_GetOnboardingItemsV2400Example": { "summary": "Default Onboarding_GetOnboardingItemsV2 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": { "Onboarding_GetOnboardingItemsV2401Example": { "summary": "Default Onboarding_GetOnboardingItemsV2 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": { "Onboarding_GetOnboardingItemsV2403Example": { "summary": "Default Onboarding_GetOnboardingItemsV2 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": { "Onboarding_GetOnboardingItemsV2500Example": { "summary": "Default Onboarding_GetOnboardingItemsV2 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 Onboarding_Get Onboarding Items V2", "description": "Onboarding_Get Onboarding Items V2 via the Flipdish Open API v1.0 (GET /api/v1.0/clients/{appId}/onboarding/stores).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/clients/{appId}/onboarding/config/{configId}": { "post": { "tags": [ "Onboarding" ], "operationId": "Onboarding_UpdateOnboardingConfigById", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "configId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The config id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Onboarding_UpdateOnboardingConfigById200Example": { "summary": "Default Onboarding_UpdateOnboardingConfigById 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Onboarding_UpdateOnboardingConfigById400Example": { "summary": "Default Onboarding_UpdateOnboardingConfigById 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": { "Onboarding_UpdateOnboardingConfigById401Example": { "summary": "Default Onboarding_UpdateOnboardingConfigById 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": { "Onboarding_UpdateOnboardingConfigById403Example": { "summary": "Default Onboarding_UpdateOnboardingConfigById 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": { "Onboarding_UpdateOnboardingConfigById500Example": { "summary": "Default Onboarding_UpdateOnboardingConfigById 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 Onboarding_Update Onboarding Config by Id", "description": "Onboarding_Update Onboarding Config by Id via the Flipdish Open API v1.0 (POST /api/v1.0/clients/{appId}/onboarding/config/{configId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/clients/{appId}/onboarding/stores/{storeId}/items/{onboardingItemId}": { "post": { "tags": [ "Onboarding" ], "operationId": "Onboarding_UpdateOnboardingItem", "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": "onboardingItemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The onboarding item id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Onboarding_UpdateOnboardingItem200Example": { "summary": "Default Onboarding_UpdateOnboardingItem 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Onboarding_UpdateOnboardingItem400Example": { "summary": "Default Onboarding_UpdateOnboardingItem 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": { "Onboarding_UpdateOnboardingItem401Example": { "summary": "Default Onboarding_UpdateOnboardingItem 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": { "Onboarding_UpdateOnboardingItem403Example": { "summary": "Default Onboarding_UpdateOnboardingItem 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": { "Onboarding_UpdateOnboardingItem500Example": { "summary": "Default Onboarding_UpdateOnboardingItem 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 Onboarding_Update Onboarding Item", "description": "Onboarding_Update Onboarding Item via the Flipdish Open API v1.0 (POST /api/v1.0/clients/{appId}/onboarding/stores/{storeId}/items/{onboardingItemId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/clients/{appId}/onboarding/stores/items/{onboardingItemId}": { "post": { "tags": [ "Onboarding" ], "operationId": "Onboarding_UpdateOnboardingItemV2", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "onboardingItemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The onboarding item id path parameter.", "example": 500123 }, { "name": "storeId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The store id query parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Onboarding_UpdateOnboardingItemV2200Example": { "summary": "Default Onboarding_UpdateOnboardingItemV2 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Onboarding_UpdateOnboardingItemV2400Example": { "summary": "Default Onboarding_UpdateOnboardingItemV2 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": { "Onboarding_UpdateOnboardingItemV2401Example": { "summary": "Default Onboarding_UpdateOnboardingItemV2 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": { "Onboarding_UpdateOnboardingItemV2403Example": { "summary": "Default Onboarding_UpdateOnboardingItemV2 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": { "Onboarding_UpdateOnboardingItemV2500Example": { "summary": "Default Onboarding_UpdateOnboardingItemV2 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 Onboarding_Update Onboarding Item V2", "description": "Onboarding_Update Onboarding Item V2 via the Flipdish Open API v1.0 (POST /api/v1.0/clients/{appId}/onboarding/stores/items/{onboardingItemId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/search/restaurants": { "get": { "tags": [ "Search" ], "operationId": "SearchRestaurants", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The query query parameter.", "example": "string" }, { "name": "countryId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The country id query parameter.", "example": "500123" }, { "name": "includeArchivedStores", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "NonArchivedOnly", "ArchivedOnly", "Both" ] }, "description": "The include archived stores query parameter.", "example": "NonArchivedOnly" }, { "name": "searchType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "WhiteLabelConfigInfo", "WhiteLabelConfigVirtualRestaurantInfo", "WhiteLabelConfigPhysicalRestaurantInfo", "WhiteLabelConfigPhysicalRestaurantAddressInfo" ] }, "description": "The search type query parameter.", "example": "WhiteLabelConfigInfo" }, { "name": "publishedStatus", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "AllStores", "Published", "Unpublished" ] }, "description": "The published status query parameter.", "example": "AllStores" }, { "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_Restaurant_" }, "examples": { "SearchRestaurants200Example": { "summary": "Default SearchRestaurants 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": { "SearchRestaurants400Example": { "summary": "Default SearchRestaurants 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": { "SearchRestaurants401Example": { "summary": "Default SearchRestaurants 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": { "SearchRestaurants403Example": { "summary": "Default SearchRestaurants 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": { "SearchRestaurants500Example": { "summary": "Default SearchRestaurants 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 Search Restaurants", "description": "Search Restaurants via the Flipdish Open API v1.0 (GET /api/v1.0/search/restaurants).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials": { "get": { "tags": [ "SmsProviderCredentials" ], "operationId": "GetBrandSmsProviderCredentials", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The org id path parameter.", "example": "500123" }, { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The brand id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_SmsProviderCredential_" }, "examples": { "GetBrandSmsProviderCredentials200Example": { "summary": "Default GetBrandSmsProviderCredentials 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetBrandSmsProviderCredentials400Example": { "summary": "Default GetBrandSmsProviderCredentials 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": { "GetBrandSmsProviderCredentials401Example": { "summary": "Default GetBrandSmsProviderCredentials 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": { "GetBrandSmsProviderCredentials403Example": { "summary": "Default GetBrandSmsProviderCredentials 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": { "GetBrandSmsProviderCredentials500Example": { "summary": "Default GetBrandSmsProviderCredentials 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 Brand Sms Provider Credentials", "description": "Get Brand Sms Provider Credentials via the Flipdish Open API v1.0 (GET /api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials/{serviceType}": { "get": { "tags": [ "SmsProviderCredentials" ], "operationId": "GetBrandSmsProviderCredentialByServiceType", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The org id path parameter.", "example": "500123" }, { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The brand id path parameter.", "example": "500123" }, { "name": "serviceType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Nexmo", "Twilio", "Default", "MessageBird" ] }, "description": "The service type path parameter.", "example": "Nexmo" }, { "name": "withFallback", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "The with fallback query parameter.", "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_SmsProviderCredential_" }, "examples": { "GetBrandSmsProviderCredentialByServiceType200Example": { "summary": "Default GetBrandSmsProviderCredentialByServiceType 200 response", "x-microcks-default": true, "value": { "Data": { "OrgId": "500123", "BrandId": "500123", "SmsServiceType": "Nexmo", "SenderId": "500123", "Username": "Example Name", "AuthToken": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetBrandSmsProviderCredentialByServiceType400Example": { "summary": "Default GetBrandSmsProviderCredentialByServiceType 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": { "GetBrandSmsProviderCredentialByServiceType401Example": { "summary": "Default GetBrandSmsProviderCredentialByServiceType 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": { "GetBrandSmsProviderCredentialByServiceType403Example": { "summary": "Default GetBrandSmsProviderCredentialByServiceType 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": { "GetBrandSmsProviderCredentialByServiceType500Example": { "summary": "Default GetBrandSmsProviderCredentialByServiceType 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 Brand Sms Provider Credential by Service Type", "description": "Get Brand Sms Provider Credential by Service Type via the Flipdish Open API v1.0 (GET /api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials/{serviceType}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "SmsProviderCredentials" ], "operationId": "SmsProviderCredentialUpdate", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The org id path parameter.", "example": "500123" }, { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The brand id path parameter.", "example": "500123" }, { "name": "serviceType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Nexmo", "Twilio", "Default", "MessageBird" ] }, "description": "The service type path parameter.", "example": "Nexmo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmsProviderCredentialUpdateRequest" }, "examples": { "SmsProviderCredentialUpdateRequestExample": { "summary": "Default SmsProviderCredentialUpdate request", "x-microcks-default": true, "value": { "SenderId": "500123", "Username": "Example Name", "AuthToken": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_SmsProviderCredential_" }, "examples": { "SmsProviderCredentialUpdate200Example": { "summary": "Default SmsProviderCredentialUpdate 200 response", "x-microcks-default": true, "value": { "Data": { "OrgId": "500123", "BrandId": "500123", "SmsServiceType": "Nexmo", "SenderId": "500123", "Username": "Example Name", "AuthToken": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SmsProviderCredentialUpdate400Example": { "summary": "Default SmsProviderCredentialUpdate 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": { "SmsProviderCredentialUpdate401Example": { "summary": "Default SmsProviderCredentialUpdate 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": { "SmsProviderCredentialUpdate403Example": { "summary": "Default SmsProviderCredentialUpdate 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": { "SmsProviderCredentialUpdate500Example": { "summary": "Default SmsProviderCredentialUpdate 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 Sms Provider Credential Update", "description": "Sms Provider Credential Update via the Flipdish Open API v1.0 (POST /api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials/{serviceType}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "SmsProviderCredentials" ], "operationId": "SmsProviderCredentialDelete", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The org id path parameter.", "example": "500123" }, { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The brand id path parameter.", "example": "500123" }, { "name": "serviceType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Nexmo", "Twilio", "Default", "MessageBird" ] }, "description": "The service type path parameter.", "example": "Nexmo" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_SmsProviderCredential_" }, "examples": { "SmsProviderCredentialDelete200Example": { "summary": "Default SmsProviderCredentialDelete 200 response", "x-microcks-default": true, "value": { "Data": { "OrgId": "500123", "BrandId": "500123", "SmsServiceType": "Nexmo", "SenderId": "500123", "Username": "Example Name", "AuthToken": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SmsProviderCredentialDelete400Example": { "summary": "Default SmsProviderCredentialDelete 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": { "SmsProviderCredentialDelete401Example": { "summary": "Default SmsProviderCredentialDelete 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": { "SmsProviderCredentialDelete403Example": { "summary": "Default SmsProviderCredentialDelete 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": { "SmsProviderCredentialDelete500Example": { "summary": "Default SmsProviderCredentialDelete 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 Sms Provider Credential Delete", "description": "Sms Provider Credential Delete via the Flipdish Open API v1.0 (DELETE /api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials/{serviceType}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/sms-providers/bulk-upsert": { "post": { "tags": [ "SmsProviderCredentials" ], "operationId": "SmsProviderCredentialsBulkUpsert", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmsProviderCredential" } }, "examples": { "SmsProviderCredentialsBulkUpsertRequestExample": { "summary": "Default SmsProviderCredentialsBulkUpsert request", "x-microcks-default": true, "value": [ { "OrgId": "500123", "BrandId": "500123", "SmsServiceType": "Nexmo", "SenderId": "500123", "Username": "Example Name", "AuthToken": "string" } ] } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_SmsProviderCredential_" }, "examples": { "SmsProviderCredentialsBulkUpsert200Example": { "summary": "Default SmsProviderCredentialsBulkUpsert 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SmsProviderCredentialsBulkUpsert400Example": { "summary": "Default SmsProviderCredentialsBulkUpsert 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": { "SmsProviderCredentialsBulkUpsert401Example": { "summary": "Default SmsProviderCredentialsBulkUpsert 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": { "SmsProviderCredentialsBulkUpsert403Example": { "summary": "Default SmsProviderCredentialsBulkUpsert 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": { "SmsProviderCredentialsBulkUpsert500Example": { "summary": "Default SmsProviderCredentialsBulkUpsert 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 Sms Provider Credentials Bulk Upsert", "description": "Sms Provider Credentials Bulk Upsert via the Flipdish Open API v1.0 (POST /api/v1.0/sms-providers/bulk-upsert).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stuart/settings/{storeId}": { "get": { "tags": [ "Stuart" ], "operationId": "Stuart_GetStuartSettings", "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_StuartSettings_" }, "examples": { "Stuart_GetStuartSettings200Example": { "summary": "Default Stuart_GetStuartSettings 200 response", "x-microcks-default": true, "value": { "Data": { "ClientId": "500123", "ClientSecret": "string", "Enabled": true, "WebhookUrlBasicAuthentication": "string", "OverrideWebhookUrl": true, "MinutesToPickupBeforeThanDeliveryTime": 1, "PackageType": "Xsmall", "TransportType": "Bike", "CancelOrderIfStuartCancelDelivery": true, "TransportPrices": { "Bike": 1.0, "Cargobike": 1.0, "Cargobikexl": 1.0, "Motorbike": 1.0, "Motorbikexl": 1.0, "Car": 1.0, "Van": 1.0 } } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Stuart_GetStuartSettings400Example": { "summary": "Default Stuart_GetStuartSettings 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": { "Stuart_GetStuartSettings401Example": { "summary": "Default Stuart_GetStuartSettings 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": { "Stuart_GetStuartSettings403Example": { "summary": "Default Stuart_GetStuartSettings 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": { "Stuart_GetStuartSettings404Example": { "summary": "Default Stuart_GetStuartSettings 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": { "Stuart_GetStuartSettings500Example": { "summary": "Default Stuart_GetStuartSettings 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 Stuart_Get Stuart Settings", "description": "Stuart_Get Stuart Settings via the Flipdish Open API v1.0 (GET /api/v1.0/stuart/settings/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Stuart" ], "operationId": "Stuart_PostStuartSettings", "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/StuartSettings" }, "examples": { "Stuart_PostStuartSettingsRequestExample": { "summary": "Default Stuart_PostStuartSettings request", "x-microcks-default": true, "value": { "ClientId": "500123", "ClientSecret": "string", "Enabled": true, "WebhookUrlBasicAuthentication": "string", "OverrideWebhookUrl": true, "MinutesToPickupBeforeThanDeliveryTime": 1, "PackageType": "Xsmall", "TransportType": "Bike", "CancelOrderIfStuartCancelDelivery": true, "TransportPrices": { "Bike": 1.0, "Cargobike": 1.0, "Cargobikexl": 1.0, "Motorbike": 1.0, "Motorbikexl": 1.0, "Car": 1.0, "Van": 1.0 } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stuart_PostStuartSettings200Example": { "summary": "Default Stuart_PostStuartSettings 200 response", "x-microcks-default": true, "value": {} } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_StuartSettings_" }, "examples": { "Stuart_PostStuartSettings201Example": { "summary": "Default Stuart_PostStuartSettings 201 response", "x-microcks-default": true, "value": { "Data": { "ClientId": "500123", "ClientSecret": "string", "Enabled": true, "WebhookUrlBasicAuthentication": "string", "OverrideWebhookUrl": true, "MinutesToPickupBeforeThanDeliveryTime": 1, "PackageType": "Xsmall", "TransportType": "Bike", "CancelOrderIfStuartCancelDelivery": true, "TransportPrices": { "Bike": 1.0, "Cargobike": 1.0, "Cargobikexl": 1.0, "Motorbike": 1.0, "Motorbikexl": 1.0, "Car": 1.0, "Van": 1.0 } } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Stuart_PostStuartSettings400Example": { "summary": "Default Stuart_PostStuartSettings 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": { "Stuart_PostStuartSettings401Example": { "summary": "Default Stuart_PostStuartSettings 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": { "Stuart_PostStuartSettings403Example": { "summary": "Default Stuart_PostStuartSettings 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": { "Stuart_PostStuartSettings500Example": { "summary": "Default Stuart_PostStuartSettings 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 Stuart_Post Stuart Settings", "description": "Stuart_Post Stuart Settings via the Flipdish Open API v1.0 (POST /api/v1.0/stuart/settings/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/stuart/jobs/{jobId}": { "get": { "tags": [ "Stuart" ], "operationId": "Stuart_GetJob", "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The job id path parameter.", "example": 500123 }, { "name": "storeId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id query parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_JobResponse_" }, "examples": { "Stuart_GetJob200Example": { "summary": "Default Stuart_GetJob 200 response", "x-microcks-default": true, "value": { "Data": { "Id": 500123, "CreatedAt": "2026-06-02T12:00:00Z", "Status": "Active", "PackageType": "string", "TransportType": "string", "AssignmentCode": "string", "PickupAt": "2026-06-02T12:00:00Z", "DropoffAt": "2026-06-02T12:00:00Z", "Comment": "string", "Distance": 1.0, "Duration": 1, "Deliveries": [], "Pricing": { "Currency": "EUR", "TaxPercentage": 1.0, "PriceTaxIncluded": 12.5, "PriceTaxExcluded": 12.5, "TaxAmount": 12.5, "InvoiceUrl": "https://api.flipdish.co/example" }, "Driver": { "Id": 500123, "DisplayName": "Example Name", "Phone": "+353000000000", "PictureUrl": "https://api.flipdish.co/example", "TransportType": "string", "Latitude": 1.0, "Longitude": 1.0 } } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Stuart_GetJob400Example": { "summary": "Default Stuart_GetJob 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": { "Stuart_GetJob401Example": { "summary": "Default Stuart_GetJob 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": { "Stuart_GetJob403Example": { "summary": "Default Stuart_GetJob 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": { "Stuart_GetJob500Example": { "summary": "Default Stuart_GetJob 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 Stuart_Get Job", "description": "Stuart_Get Job via the Flipdish Open API v1.0 (GET /api/v1.0/stuart/jobs/{jobId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Stuart" ], "operationId": "Stuart_CancelJob", "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The job id path parameter.", "example": 500123 }, { "name": "storeId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id query parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stuart_CancelJob200Example": { "summary": "Default Stuart_CancelJob 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Stuart_CancelJob400Example": { "summary": "Default Stuart_CancelJob 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": { "Stuart_CancelJob401Example": { "summary": "Default Stuart_CancelJob 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": { "Stuart_CancelJob403Example": { "summary": "Default Stuart_CancelJob 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": { "Stuart_CancelJob500Example": { "summary": "Default Stuart_CancelJob 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 Stuart_Cancel Job", "description": "Stuart_Cancel Job via the Flipdish Open API v1.0 (DELETE /api/v1.0/stuart/jobs/{jobId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/webhooks/events": { "get": { "tags": [ "Webhooks" ], "operationId": "GetWebhookEventNames", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringArrayResult" }, "examples": { "GetWebhookEventNames200Example": { "summary": "Default GetWebhookEventNames 200 response", "x-microcks-default": true, "value": { "Data": [ "string" ] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetWebhookEventNames400Example": { "summary": "Default GetWebhookEventNames 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": { "GetWebhookEventNames401Example": { "summary": "Default GetWebhookEventNames 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": { "GetWebhookEventNames403Example": { "summary": "Default GetWebhookEventNames 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": { "GetWebhookEventNames500Example": { "summary": "Default GetWebhookEventNames 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 Webhook Event Names", "description": "Get Webhook Event Names via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/webhooks/events).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions": { "get": { "tags": [ "Webhooks" ], "operationId": "GetWebhookSubscriptions", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path 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_WebhookSubscription_" }, "examples": { "GetWebhookSubscriptions200Example": { "summary": "Default GetWebhookSubscriptions 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": { "GetWebhookSubscriptions400Example": { "summary": "Default GetWebhookSubscriptions 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": { "GetWebhookSubscriptions401Example": { "summary": "Default GetWebhookSubscriptions 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": { "GetWebhookSubscriptions403Example": { "summary": "Default GetWebhookSubscriptions 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": { "GetWebhookSubscriptions500Example": { "summary": "Default GetWebhookSubscriptions 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 Webhook Subscriptions", "description": "Get Webhook Subscriptions via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Webhooks" ], "operationId": "CreateWebhookSubscription", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "Created WebhookSubscription identifier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiIntegerResult" }, "examples": { "CreateWebhookSubscription200Example": { "summary": "Default CreateWebhookSubscription 200 response", "x-microcks-default": true, "value": { "Data": 1 } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateWebhookSubscription400Example": { "summary": "Default CreateWebhookSubscription 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": { "CreateWebhookSubscription401Example": { "summary": "Default CreateWebhookSubscription 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": { "CreateWebhookSubscription403Example": { "summary": "Default CreateWebhookSubscription 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": { "CreateWebhookSubscription500Example": { "summary": "Default CreateWebhookSubscription 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 Webhook Subscription", "description": "Create Webhook Subscription via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events": { "get": { "tags": [ "Webhooks" ], "operationId": "GetWebhookEventNamesBySubscriptionId", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "webhookSubscriptionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The webhook subscription id path parameter.", "example": 500123 }, { "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/RestApiStringArrayResult" }, "examples": { "GetWebhookEventNamesBySubscriptionId200Example": { "summary": "Default GetWebhookEventNamesBySubscriptionId 200 response", "x-microcks-default": true, "value": { "Data": [ "string" ] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetWebhookEventNamesBySubscriptionId400Example": { "summary": "Default GetWebhookEventNamesBySubscriptionId 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": { "GetWebhookEventNamesBySubscriptionId401Example": { "summary": "Default GetWebhookEventNamesBySubscriptionId 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": { "GetWebhookEventNamesBySubscriptionId403Example": { "summary": "Default GetWebhookEventNamesBySubscriptionId 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": { "GetWebhookEventNamesBySubscriptionId500Example": { "summary": "Default GetWebhookEventNamesBySubscriptionId 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 Webhook Event Names by Subscription Id", "description": "Get Webhook Event Names by Subscription Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events/{eventName}/test": { "get": { "tags": [ "Webhooks" ], "operationId": "GetWebhookEventSample", "parameters": [ { "name": "eventName", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The event name path parameter.", "example": "Example Name" }, { "name": "version", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The version query parameter.", "example": "string" }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "webhookSubscriptionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The webhook subscription id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventSample" }, "examples": { "GetWebhookEventSample200Example": { "summary": "Default GetWebhookEventSample 200 response", "x-microcks-default": true, "value": { "Type": "string", "CreateTime": "2026-06-02T12:00:00Z", "Body": { "EventName": "Example Name", "FlipdishEventId": "00000000-0000-0000-0000-000000000000", "CreateTime": "2026-06-02T12:00:00Z", "Position": 1, "AppId": "500123", "OrgId": "500123", "IpAddress": "string", "ActivityId": "500123", "ActivityType": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetWebhookEventSample400Example": { "summary": "Default GetWebhookEventSample 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": { "GetWebhookEventSample401Example": { "summary": "Default GetWebhookEventSample 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": { "GetWebhookEventSample403Example": { "summary": "Default GetWebhookEventSample 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": { "GetWebhookEventSample500Example": { "summary": "Default GetWebhookEventSample 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 Webhook Event Sample", "description": "Get Webhook Event Sample via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events/{eventName}/test).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/logs": { "get": { "tags": [ "Webhooks" ], "operationId": "GetWebhookLogs", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "webhookSubscriptionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The webhook subscription id path parameter.", "example": 500123 }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" }, "description": "The start query parameter.", "example": "2026-06-02T12:00:00Z" }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" }, "description": "The end 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 }, { "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_WebhookLog_" }, "examples": { "GetWebhookLogs200Example": { "summary": "Default GetWebhookLogs 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": { "GetWebhookLogs400Example": { "summary": "Default GetWebhookLogs 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": { "GetWebhookLogs401Example": { "summary": "Default GetWebhookLogs 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": { "GetWebhookLogs403Example": { "summary": "Default GetWebhookLogs 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": { "GetWebhookLogs500Example": { "summary": "Default GetWebhookLogs 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 Webhook Logs", "description": "Get Webhook Logs via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/logs).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}": { "put": { "tags": [ "Webhooks" ], "operationId": "UpdateWebhookSubscription", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "webhookSubscriptionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The webhook subscription id path parameter.", "example": 500123 }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateWebhookSubscription400Example": { "summary": "Default UpdateWebhookSubscription 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": { "UpdateWebhookSubscription401Example": { "summary": "Default UpdateWebhookSubscription 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": { "UpdateWebhookSubscription403Example": { "summary": "Default UpdateWebhookSubscription 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": { "UpdateWebhookSubscription500Example": { "summary": "Default UpdateWebhookSubscription 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 Webhook Subscription", "description": "Update Webhook Subscription via the Flipdish Open API v1.0 (PUT /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Webhooks" ], "operationId": "DeleteWebhookSubscription", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "webhookSubscriptionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The webhook subscription id path parameter.", "example": 500123 }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteWebhookSubscription400Example": { "summary": "Default DeleteWebhookSubscription 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": { "DeleteWebhookSubscription401Example": { "summary": "Default DeleteWebhookSubscription 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": { "DeleteWebhookSubscription403Example": { "summary": "Default DeleteWebhookSubscription 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": { "DeleteWebhookSubscription500Example": { "summary": "Default DeleteWebhookSubscription 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 Webhook Subscription", "description": "Delete Webhook Subscription via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events/{eventName}": { "post": { "tags": [ "Webhooks" ], "operationId": "CreateWebhookSubscriptionEventNames", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "webhookSubscriptionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The webhook subscription id path parameter.", "example": 500123 }, { "name": "eventName", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The event name path parameter.", "example": "Example Name" }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateWebhookSubscriptionEventNames400Example": { "summary": "Default CreateWebhookSubscriptionEventNames 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": { "CreateWebhookSubscriptionEventNames401Example": { "summary": "Default CreateWebhookSubscriptionEventNames 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": { "CreateWebhookSubscriptionEventNames403Example": { "summary": "Default CreateWebhookSubscriptionEventNames 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": { "CreateWebhookSubscriptionEventNames409Example": { "summary": "Default CreateWebhookSubscriptionEventNames 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": { "CreateWebhookSubscriptionEventNames500Example": { "summary": "Default CreateWebhookSubscriptionEventNames 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 Webhook Subscription Event Names", "description": "Create Webhook Subscription Event Names via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events/{eventName}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Webhooks" ], "operationId": "DeleteWebhookSubscriptionEventName", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "webhookSubscriptionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The webhook subscription id path parameter.", "example": 500123 }, { "name": "eventName", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The event name path parameter.", "example": "Example Name" }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteWebhookSubscriptionEventName400Example": { "summary": "Default DeleteWebhookSubscriptionEventName 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": { "DeleteWebhookSubscriptionEventName401Example": { "summary": "Default DeleteWebhookSubscriptionEventName 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": { "DeleteWebhookSubscriptionEventName403Example": { "summary": "Default DeleteWebhookSubscriptionEventName 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": { "DeleteWebhookSubscriptionEventName500Example": { "summary": "Default DeleteWebhookSubscriptionEventName 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 Webhook Subscription Event Name", "description": "Delete Webhook Subscription Event Name via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events/{eventName}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } } }, "components": { "schemas": { "AccountFieldKeyValuePair": { "description": "Represents one populated account field (its key and value)", "type": "object", "properties": { "Key": { "description": "Depending on the Key, the field's value will be stored in a different field in PayeeBankAccountData", "enum": [ "Iban", "AccountNumber", "RoutingNumber", "BSB", "BranchCode", "BankCode", "InstitutionNumber", "TransitNumber", "ClearingCode", "IfscCode", "Clabe", "SortCode", "Swift" ], "type": "string", "example": "Iban" }, "Value": { "description": "The value of the field", "type": "string", "example": "string" } } }, "AnalyticsClientEvent": { "description": "Client Analytics event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "EventType": { "description": "Type of the event", "type": "string", "example": "string" }, "AppType": { "description": "Type of the app the event is coming from", "type": "string", "example": "string" }, "Metadata": { "description": "JSON Metadata", "type": "string", "example": "string" }, "UserId": { "format": "int32", "description": "User Id", "type": "integer", "nullable": true, "example": 500123 }, "Latitude": { "format": "double", "description": "Latitude of the event", "type": "number", "nullable": true, "example": 1.0 }, "Longitude": { "format": "double", "description": "Longitude of the event", "type": "number", "nullable": true, "example": 1.0 }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "ApmCurrencyDataPoint": { "description": "A single data point in timeline graphs related to APM", "type": "object", "properties": { "PeriodStart": { "format": "date-time", "description": "Date from which the data point starts", "type": "string", "example": "2026-06-02T12:00:00Z" }, "PeriodLengthInDays": { "format": "int32", "description": "The length in days that this data point covers", "type": "integer", "example": 1 }, "CurrencyData": { "description": "The values of this data point", "type": "array", "items": { "$ref": "#/components/schemas/CurrencyData" }, "example": [] } } }, "ApmDataPoint": { "description": "A single data point in timeline graphs related to APM", "type": "object", "properties": { "PeriodStart": { "format": "date-time", "description": "Date from which the data point starts", "type": "string", "example": "2026-06-02T12:00:00Z" }, "PeriodLengthInDays": { "format": "int32", "description": "The length in days that this data point covers", "type": "integer", "example": 1 }, "Value": { "format": "int32", "description": "The value of this data point", "type": "integer", "example": 1 } } }, "ApmHourlyDataPoint": { "description": "Provides an average value for a single hour of day of the week", "type": "object", "properties": { "Day": { "description": "Day of the week", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "example": "Sunday" }, "Hour": { "format": "int32", "description": "Hour in the day", "type": "integer", "example": 1 }, "TotalValue": { "format": "int32", "description": "Total Value", "type": "integer", "example": 12.5 } } }, "ApmStatistics": { "description": "APM Statistics", "type": "object", "properties": { "EstimatedMinutesSaved": { "format": "int32", "description": "Total amount of time spent with APM", "type": "integer", "example": 1 }, "EstimatedMinutesCouldSaved": { "format": "int32", "description": "Total amount of time that could be saved", "type": "integer", "example": 1 }, "CurrencyData": { "description": "Currency based data", "type": "array", "items": { "$ref": "#/components/schemas/StatisticsCurrencyDataPoint" }, "example": [] } } }, "ApmStatus": { "description": "APM status", "type": "object", "properties": { "IsApmEnabled": { "description": "Indicates if APM is active or otherwise", "type": "boolean", "example": true } } }, "App": { "description": "App", "type": "object", "properties": { "AppId": { "description": "App Identifier", "type": "string", "example": "500123" }, "HasIosApp": { "description": "Has iOS app in Apple App Store. This is readonly.", "type": "boolean", "example": true }, "IosAppStoreUrl": { "description": "IOS App Store URL", "type": "string", "example": "https://api.flipdish.co/example" }, "HasAndroidApp": { "description": "Has Android app in Google Play Store. This is readonly.", "type": "boolean", "example": true }, "AndroidPlayStoreUrl": { "description": "Android Play Store URL", "type": "string", "example": "https://api.flipdish.co/example" }, "DisplayDeliveryRestaurantScreen": { "description": "Display delivery restaurant screen", "type": "boolean", "example": true }, "LogoImageUrl": { "description": "Application Logo.", "type": "string", "example": "https://api.flipdish.co/example" }, "Languages": { "description": "Languages that have been selected to be available to customers.", "type": "array", "items": { "$ref": "#/components/schemas/Language" }, "example": [] }, "AvailableAppLanguages": { "description": "Lists all languages that are supported by Flipdish.", "type": "array", "items": { "$ref": "#/components/schemas/Language" }, "example": [] }, "AppAccessLevel": { "description": "App access level for the logged in user", "enum": [ "None", "Owner", "StoreOwner", "PropertyOwner", "ManagedOwner", "Integrator", "PropertyManager", "StoreManager", "StoreStaff", "StoreReadOnlyAccess", "FinanceManger", "Onboarding", "Support" ], "type": "string", "example": "None" }, "AppResourceSet": { "description": "Constitutes a list of available resources", "type": "array", "items": { "enum": [ "ViewApp", "CreateApp", "UpdateApp", "ViewAppName", "EditAppAssets", "EditAppFeatures", "ViewTeammates", "EditTeammates", "CreateTeammateOwner", "CreateTeammateManagedOwner", "CreateTeammateStoreOwner", "CreateTeammateStoreManager", "CreateTeammateStoreStaff", "CreateTeammateStoreReadAccess", "CreateTeammateFinanceManager", "CreateTeammateIntegrator", "CreateTeammateOnboarding", "CreateTeammatePropertyManager", "CreateTeammatePropertyOwner", "ViewApmConfigurations", "EditApmConfigurations", "ViewCampaignsConfigurations", "CreateCampaignsConfigurations", "UpdateCampaignsConfigurations", "DeleteCampaignsConfigurations", "StampLoyaltyCardAgainstCampaignsConfigurations", "ViewDevelopersSettings", "EditDevelopersSettings", "ViewOrders", "UpdateOrdersAccept", "UpdateOrdersReject", "UpdateOrdersRefund", "UpdateOrdersDispatch", "ViewStores", "CreateStores", "EditStores", "ViewStoresOpeningHours", "UpdateStoresOpenForCollectionOrDelivery", "UpdateStoresOpeningHours", "ViewStoresOpeningHoursOverride", "EditStoresOpeningHoursOverride", "EditStoresOpeningHoursOverrideTemporary", "UpdateStoresName", "EditStoreKioskSettings", "EditStoreOrderCapacity", "ArchiveStores", "PublishStores", "UpdatePrinterTerminalsAssign", "UpdatePrinterTerminalsToggle", "EditStoreNotifications", "ViewStoreGroups", "CreateStoreGroups", "UpdateStoreGroups", "DeleteStoreGroups", "ViewDeliveryZones", "CreateDeliveryZones", "UpdateDeliveryZones", "DeleteDeliveryZones", "ViewMenu", "CreateMenu", "UpdateMenu", "DeleteMenu", "UpdateMenuLock", "UpdateMenuItemsHideTemporarily", "EditMenuImage", "ViewVouchers", "EditVouchers", "ViewWebsiteContent", "EditWebsiteContent", "ViewWebsiteDnsVerified", "ViewWebsiteCertificateCreated", "ViewWebsiteCertificateRenewed", "ViewBankAccounts", "CreateBankAccounts", "UpdateBankAccounts", "UpdateBankAccountsAssign", "ViewAssignedBankAccount", "VerifyBankAccounts", "ViewServiceChargeConfigurations", "EditServiceChargeConfigurations", "EditStoreDeliveryZoneFees", "EditStoreDeliveryFeesLimited", "ViewHydraConfig", "UpdateHydraConfigManage", "InitiateBluetoothPairingMode", "DeleteTerminal", "ViewKioskTelemetry", "ViewCustomers", "EditCustomers", "CreateCustomers", "CreateCatalogElements", "UpdateCatalogElements", "ViewCatalogElements", "DeleteCatalogElements", "ViewMetafieldDefinitions", "CreateMetafieldDefinitions", "UpdateMetafieldDefinitions", "DeleteMetafieldDefinitions", "UpdateMetafields", "ViewCatalogMenuChanges", "PublishCatalogMenuChanges", "ViewAppStatistics", "ViewApmStatistics", "ViewCampaignsStatistics", "ViewCustomerStatistics", "ViewLiveStatistics", "ViewOrderStatistics", "ViewSalesStatistics", "ViewSalesEndOfDayStatistics", "ViewVouchersStatistics", "DownloadCustomerCsvExport", "ViewApmAuditLogs", "ViewStoreAuditLogs", "ViewMenuAuditLogs", "ViewBankAccountAuditLogs", "ViewFeeConfigurationsAuditLogs", "ViewOrdersAuditLogs", "ViewVouchersAuditLogs", "ViewUserEventsAuditLogs", "ViewCampaignsAuditLogs", "ViewTeammatesAuditLogs", "ViewAppAuditLogs", "ViewCustomerAuditLogs", "ViewPrinterAuditLogs", "ViewHydraAuditLogs", "ViewPushNotificationAuditLogs", "ViewStripeCustomConnectedAccountAuditLogs", "ViewKioskBluetoothDeviceAuditLogs", "ViewExternalAuditLogs", "CreateExternalAuditLogEvents", "ViewCatalogAuditLogs", "ViewOrderFulfillmentAuditLogs", "ViewChannelAuditLogs", "ViewAppStoreAuditLogs", "SendPushNotificationToCustomer", "InviteDriverToApp", "GetDriverForApp", "RemoveDriverFromApp", "AssignDriverToOrder", "UnassignDriverFromOrder", "UpdateOrdersDeliveryTrackingStatus", "UpdateOrderFulfillmentStatus", "ViewFulfillmentStatesConfiguration", "CreateFulfillmentStatesConfiguration", "UpdateFulfillmentStatesConfiguration", "DeleteFulfillmentStatesConfiguration", "ViewPayouts", "ViewChannels", "ViewOnboarding", "UpdateOnboarding", "ViewClientDevices", "UpdateClientDevices", "EnrollClientDevices", "AssignClientDevices", "ViewClientAuditLogs", "CreateAppStoreAppConfiguration", "ViewAppStoreAppConfiguration", "UpdateAppStoreAppConfiguration", "DeleteAppStoreAppConfiguration", "UpdateAppStoreAppConfigurationSettings", "CreateAppStoreSubscription", "UpdateAppStoreSubscription", "DeleteAppStoreSubscription", "ViewSalesChannels", "EditSalesChannels", "ViewPayGreenWhiteLabelConfiguration", "CreatePayGreenWhiteLabelConfiguration", "UpdatePayGreenWhiteLabelConfiguration", "UpdatePayGreenStoreConfiguration", "ViewSubscriptions", "ViewInvoices", "EditAccountsBills", "ViewAccountsBills", "EditAccountsCategories", "ViewAccountsCategories", "EditAccountsCreditAccounts", "ViewAccountsCreditAccounts", "EditAccountsCreditBooks", "ViewAccountsCreditBooks", "EditAccountsExpenses", "ViewAccountsExpenses", "EditAccountsTransactionAccounts", "ViewAccountsTransactionAccounts", "EditDocumentExplorer", "ViewDocumentExplorer", "ViewInventoryReports", "EditInventoryPurchaseOrders", "ViewInventoryPurchaseOrders", "EditInventoryStockItems", "ViewInventoryStockItems", "EditInventorySupplier", "ViewInventorySupplier", "EditInventoryTrackingProfiles", "ViewInventoryTrackingProfiles", "ViewPayrollReports", "EditPayrollHoliday", "ViewPayrollHoliday", "EditPayrollRota", "ViewPayrollRota", "EditPayrollStaff", "ViewPayrollStaff", "ViewSalesReports", "ViewCostReports", "ViewMenuReports" ], "type": "string" }, "example": [ "ViewApp" ] }, "Features": { "description": "Feature flags. These cannot be set by 3rd parties.", "type": "array", "items": { "type": "string" }, "example": [ "string" ] }, "MapCenter": { "$ref": "#/components/schemas/Coordinates" }, "MapNorthEast": { "$ref": "#/components/schemas/Coordinates" }, "MapSouthWest": { "$ref": "#/components/schemas/Coordinates" }, "GoogleMapsApiKeyWeb": { "description": "Key to be passed with Google Maps requests", "type": "string", "example": "string" }, "OrgId": { "description": "Org Id", "type": "string", "example": "500123" }, "SmsRestaurantName": { "description": "SMS Restaurant Name", "type": "string", "example": "Example Name" }, "WebToAppRedirect": { "description": "Web to App Redirect settings", "enum": [ "NoRedirect", "RedirectOnce", "RedirectAlways", "SuggestPwa", "ForcePwa" ], "type": "string", "example": "NoRedirect" }, "Name": { "description": "App name. \r\nThis is used in various places on the Apple App Store, Google Play Store, mobile apps and websites.", "type": "string", "example": "Example Name" }, "HostName": { "description": "HostName on which the web-ordering system is allowed to be hosted or that a Flipdish website is hosted on.", "type": "string", "example": "Example Name" }, "MainColor": { "description": "Main color of the web / Android / iOS applications", "type": "string", "example": "string" }, "KioskPrimaryColour": { "description": "Primary colour used on the Kiosk", "type": "string", "example": "string" }, "ApplicationCategory": { "description": "Application Category", "enum": [ "Restaurant", "Cafe", "Convenience" ], "type": "string", "example": "Restaurant" }, "IsPanaceaEnabled": { "description": "Panacea is the term used for websites that are hosted on the my.flipdish.com domain. This value is true when the App's website is hosted on this domain.\r\nThe alternative to using Panacea websites is to use a custom domain.", "type": "boolean", "example": true }, "PanaceaVanityUrl": { "description": "In case of IsPanaceaEnabled is true, the app can be accessed via https://my.flipdish.com/{PanaceaVanityUrl}", "type": "string", "example": "https://api.flipdish.co/example" }, "CookieConsentPromptEnabled": { "description": "Cookie Consent Prompt Enabled", "type": "boolean", "example": true }, "CountryId": { "description": "Country identifier in ISO 3166-1 alpha-2 format. \r\nThis code is set automatically based on the locations of the Stores in the App. \r\n\r\nThe App Country is used \r\n - to determine how to parse mobile phone numbers that are entered in their local numbering format\r\n - to determine if country specific payment methods should be offered\r\n - in various fraud checks", "maxLength": 2, "minLength": 0, "type": "string", "example": "500123" } } }, "AppCreatedEvent": { "description": "Application created event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "AppName": { "description": "App Name", "type": "string", "example": "Example Name" }, "CountryId": { "description": "Country Id", "type": "string", "example": "500123" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "AccountId": { "description": "Salesforce Account Id", "type": "string", "example": "500123" }, "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "AppStoreConfigCreatedEvent": { "description": "AppStore Config Created event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "AppStoreAppId": { "description": "App Store App Id", "type": "string", "example": "500123" }, "AppStoreAppConfigurationId": { "description": "App Store Configuration Id", "type": "string", "example": "500123" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "AppStoreConfigDeletedEvent": { "description": "AppStore Config Deleted event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "AppStoreAppId": { "description": "App Store Id", "type": "string", "example": "500123" }, "AppStoreAppConfigurationId": { "description": "App Store Configuration Id", "type": "string", "example": "500123" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "AppStoreConfigUpdatedEvent": { "description": "AppStore Config Updated event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "AppStoreAppId": { "description": "App Store Id", "type": "string", "example": "500123" }, "AppStoreAppConfiguration": { "$ref": "#/components/schemas/UpdateAppStoreAppConfigurationWebhookDTO" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "AppStoreSubscriptionChangeJobUpdatedEvent": { "description": "Subscription change job status updated event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "AppStoreAppId": { "description": "App Store Id", "type": "string", "example": "500123" }, "Status": { "description": "Status", "type": "string", "example": "Active" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "AppUpdatedEvent": { "description": "Application updated event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Changes": { "description": "A summary of changes made", "type": "string", "example": "string" }, "AppName": { "description": "App Name", "type": "string", "example": "Example Name" }, "CountryId": { "description": "Country Id", "type": "string", "example": "500123" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "App": { "$ref": "#/components/schemas/App" }, "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "BankAccount": { "description": "BANK ACCOUNT", "type": "object", "properties": { "Id": { "format": "int32", "description": "Id of this account", "type": "integer", "example": 500123 }, "AccountName": { "description": "Name of this account", "type": "string", "example": "Example Name" }, "Iban": { "description": "IBAN of this account", "type": "string", "example": "string" }, "Swift": { "description": "SWIFT of this bank account", "type": "string", "example": "string" }, "PopulatedAccountFields": { "description": "A list of one or more populated account fields (field key-value pairs).\r\nIf this list contains at least one item, the Iban, Swift and NationalClearingCode fields should be ignored.", "type": "array", "items": { "$ref": "#/components/schemas/AccountFieldKeyValuePair" }, "example": [] }, "AccountState": { "description": "Status of Account", "enum": [ "Unverified", "AwatingVerification", "Verified", "Grandfathered" ], "type": "string", "example": "Unverified" }, "StoreNames": { "description": "Store Names that are attached to this account", "type": "array", "items": { "type": "string" }, "example": [ "Example Name" ] }, "StoreIds": { "description": "Store Ids that are attached to this account", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "BankAddress": { "description": "Address lf the bank", "type": "string", "example": "string" }, "BankCountryCode": { "description": "CountryCode of the Bank Account", "type": "string", "example": "IE" }, "AccountHolderAddress": { "description": "Account Holders Address", "type": "string", "example": "string" }, "AccountHolderCountryCode": { "description": "Account Holders Country Code", "type": "string", "example": "IE" }, "VatNumber": { "description": "Account Holders Vat Number", "type": "string", "example": "string" }, "StripeAccountId": { "description": "Stripe Id of the connected account", "type": "string", "example": "500123" } } }, "BankAccountAssignedEvent": { "description": "", "type": "object", "properties": { "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "BankAccount": { "$ref": "#/components/schemas/BankAccount" }, "Description": { "description": "Event description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "BankAccountCreatedEvent": { "description": "", "type": "object", "properties": { "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "BankAccount": { "$ref": "#/components/schemas/BankAccount" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "BankAccountDeletedEvent": { "description": "", "type": "object", "properties": { "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "BankAccount": { "$ref": "#/components/schemas/BankAccount" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "BankAccountUpdatedEvent": { "description": "", "type": "object", "properties": { "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "BankAccount": { "$ref": "#/components/schemas/BankAccount" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "BluetoothTerminalStatus": { "description": "Status of the bluetooth terminal", "type": "object", "properties": { "SerialNumber": { "description": "Serial Number", "type": "string", "example": "string" }, "SoftwareVersion": { "description": "Software Version", "type": "string", "example": "string" }, "DeviceType": { "description": "Device Type", "enum": [ "CHIPPER_2X", "COTS_DEVICE", "VERIFONE_P400", "WISEPAD_3", "WISEPOS_E" ], "type": "string", "example": "CHIPPER_2X" }, "Status": { "description": "Device Status", "enum": [ "Not_Connected", "Connecting", "Connected", "Online", "Offline" ], "type": "string", "example": "Not_Connected" }, "BatteryLevel": { "format": "float", "description": "Indication of the battery level from 0 to 1", "type": "number", "nullable": true, "example": 1.0 }, "UpdateTime": { "format": "date-time", "description": "Last time the status was updated", "type": "string", "example": "2026-06-02T12:00:00Z" }, "ReaderId": { "description": "ReaderId for Stripe Terminal", "type": "string", "example": "500123" } } }, "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" } } }, "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" } } }, "CampaignStatistics": { "description": "Campaign statistics", "type": "object", "properties": { "VouchersIssued": { "format": "int32", "description": "Deprecated. Number of issued vouchers.\r\nThis field is always zero.", "type": "integer", "example": 1 }, "VouchersRedeemed": { "format": "int32", "description": "Deprecated. Number of redeemed vouchers. This field is always zero.\r\nThis field is always zero.", "type": "integer", "example": 1 }, "Conversion": { "format": "double", "description": "Deprecated. Conversion of campaign (VouchersIssued / VouchersRedeemed).\r\nThis field is always zero.", "type": "number", "example": 1.0 }, "SalesGenerated": { "format": "double", "description": "Deprecated.\r\nSales generated by campaign (TotalAmount - FeeChargedToCustomer ie. the discounted sale value).\r\nThis field is always zero.", "type": "number", "example": 1.0 }, "ReturnOfInvestment": { "format": "double", "description": "Deprecated.\r\nReturn of investment of campaign (TotalAmount / DiscountAmount).\r\nThis field is always zero.", "type": "number", "example": 1.0 } } }, "CatalogGroupArchivedEvent": { "description": "", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Group": { "$ref": "#/components/schemas/Group" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "CatalogGroupCreatedEvent": { "description": "", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Group": { "$ref": "#/components/schemas/Group" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "CatalogGroupReference": { "description": "Reference to an existing {Flipdish.Menus.PublicModels.V1.Catalog.Groups.Group}", "required": [ "CatalogGroupId", "GroupType" ], "type": "object", "properties": { "Group": { "$ref": "#/components/schemas/Group" }, "CatalogGroupId": { "description": "Identifier of the ProductId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "CatalogItemId": { "description": "Identifier of the ProductId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "GroupType": { "description": "Type of the SupProduct", "enum": [ "ModifierGroup" ], "type": "string", "example": "ModifierGroup" } } }, "CatalogGroupUpdatedEvent": { "description": "", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Group": { "$ref": "#/components/schemas/Group" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "CatalogItem": { "description": "CatalogItem", "required": [ "ItemType", "Sku", "Name", "Price" ], "type": "object", "properties": { "CatalogItemId": { "description": "Unique catalog Item id", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "IsArchived": { "description": "Returns true if the item is archived", "type": "boolean", "example": true }, "Groups": { "description": "Collection of groups associated with this item", "type": "array", "items": { "$ref": "#/components/schemas/CatalogGroupReference" }, "example": [] }, "Metafields": { "description": "Collection of metafields", "type": "array", "items": { "$ref": "#/components/schemas/Metafield" }, "example": [] }, "ItemType": { "description": "Type of item (Product, Modifier, etc)", "enum": [ "Product", "Modifier" ], "type": "string", "example": "Product" }, "Sku": { "description": "Stock Keeping Unit (SKU)", "maxLength": 30, "minLength": 0, "type": "string", "example": "string" }, "Name": { "description": "Item name", "maxLength": 300, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Item description", "maxLength": 3000, "minLength": 0, "type": "string", "example": "string" }, "Price": { "format": "double", "description": "Item price", "minimum": 0, "type": "number", "example": 12.5 }, "ImageFileName": { "description": "Image File Name", "maxLength": 512, "minLength": 0, "type": "string", "example": "Example Name" }, "Alcohol": { "description": "item contains alcohol", "type": "boolean", "example": true } } }, "CatalogItemArchivedEvent": { "description": "", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "CatalogItem": { "$ref": "#/components/schemas/CatalogItem" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "CatalogItemCreatedEvent": { "description": "", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "CatalogItem": { "$ref": "#/components/schemas/CatalogItem" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "CatalogItemUpdatedEvent": { "description": "", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "CatalogItem": { "$ref": "#/components/schemas/CatalogItem" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "CertificateCreatedEvent": { "description": "The DNS for the Hostname verified", "type": "object", "properties": { "Hostname": { "description": "Description", "type": "string", "example": "Example Name" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "CertificateRenewedEvent": { "description": "The DNS for the Hostname verified", "type": "object", "properties": { "Hostname": { "description": "Description", "type": "string", "example": "Example Name" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "Channel": { "description": "Channel.", "type": "object", "properties": { "ChannelId": { "format": "int32", "description": "Channel Id", "type": "integer", "example": 500123 }, "TranslationKey": { "description": "Channel TranslationKey", "type": "string", "example": "string" }, "Source": { "description": "Channel Source", "enum": [ "Internal", "External" ], "type": "string", "example": "Internal" }, "LogoUri": { "description": "Channel Logo URl", "type": "string", "example": "https://api.flipdish.co/example" }, "Available": { "description": "Channel is Available or not", "type": "boolean", "example": true }, "MaintainedExternally": { "description": "Channel is Maintained Externally or not", "type": "boolean", "example": true } } }, "ChannelStoresUpdatedEvent": { "description": "Channel Stores Updated Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "ChannelId": { "format": "int32", "description": "ID of the channel", "type": "integer", "example": 500123 }, "StoreIds": { "description": "List of store ids", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "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 } } }, "CreateMetadata": { "description": "Create metadata", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "Store identifier", "type": "integer", "example": 500123 }, "Key": { "description": "Metadata key (Unique identifier)", "maxLength": 128, "minLength": 0, "type": "string", "example": "string" }, "Value": { "description": "Metadata value", "maxLength": 4000, "minLength": 0, "type": "string", "example": "string" } } }, "CreditNoteDetails": { "description": "Credit note details", "type": "object", "properties": { "RemainingCredit": { "format": "double", "description": "Remaining credit", "type": "number", "example": 1.0 } } }, "CspReport": { "type": "object", "properties": { "Document-uri": { "type": "string", "example": "https://api.flipdish.co/example" }, "Referrer": { "type": "string", "example": "string" }, "Violated-directive": { "type": "string", "example": "string" }, "Effective-directive": { "type": "string", "example": "string" }, "Original-policy": { "type": "string", "example": "string" }, "Blocked-uri": { "type": "string", "example": "https://api.flipdish.co/example" }, "Status-code": { "format": "int32", "type": "integer", "example": 1 } } }, "CspReportRequest": { "type": "object", "properties": { "Csp-report": { "$ref": "#/components/schemas/CspReport" } } }, "CurrencyData": { "description": "A single currency data piece, with no date", "type": "object", "properties": { "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" }, "Value": { "format": "double", "description": "Value", "type": "number", "example": 1.0 } } }, "CustomerConsentUpdatedEvent": { "description": "Customer consent updated", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "Enabled": { "description": "Enabled", "type": "boolean", "example": true }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "CustomerCreatedEvent": { "description": "Customer created event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "CustomerDeliveryTrackingOrder": { "description": "Defines the order data required for customer driver tracking", "type": "object", "properties": { "OrderId": { "format": "int32", "description": "Order Id", "type": "integer", "example": 500123 }, "Address": { "description": "Pretified address string in country format", "type": "string", "example": "string" }, "DeliveryNotes": { "description": "Delivery Notes", "type": "string", "example": "string" }, "StorePhoneNumber": { "description": "Phone number of the store", "type": "string", "example": "+353000000000" }, "AppIconUrl": { "description": "App Icon of the store", "type": "string", "example": "https://api.flipdish.co/example" }, "OrderTrackingCode": { "description": "Order Tracking Code", "type": "string", "example": "string" }, "PaymentMethodDescription": { "description": "Payment method description i.e Cash/Card/iDeal/Paypal", "type": "string", "example": "string" }, "LastFourDigits": { "description": "Last 4 digits of the card if applicable otherwise null", "type": "string", "example": "string" }, "OrderLines": { "description": "Order lines of the order", "type": "array", "items": { "$ref": "#/components/schemas/CustomerDeliveryTrackingOrderLine" }, "example": [] }, "TotalAmount": { "format": "double", "description": "Total amount for the order including tax", "type": "number", "example": 12.5 }, "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" }, "Latitude": { "format": "double", "description": "Customer Location Latitude", "type": "number", "example": 1.0 }, "Longitude": { "format": "double", "description": "Customer Location Longitude", "type": "number", "example": 1.0 }, "Placed": { "format": "date-time", "description": "Order placed time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "RequestedFor": { "format": "date-time", "description": "Order requested for", "type": "string", "example": "2026-06-02T12:00:00Z" }, "DriverId": { "format": "int32", "description": "Driver Id", "type": "integer", "nullable": true, "example": 500123 }, "DriverName": { "description": "Driver Name", "type": "string", "example": "Example Name" }, "DriverImage": { "description": "Driver Image", "type": "string", "example": "string" }, "EstimatedMinutesForDelivery": { "format": "int32", "description": "", "type": "integer", "example": 1 } } }, "CustomerDeliveryTrackingOrderLine": { "description": "Defines an order line for driver tracking", "type": "object", "properties": { "ItemName": { "description": "Item name from the order", "type": "string", "example": "Example Name" }, "SelectedOptions": { "description": "Selected option names", "type": "array", "items": { "type": "string" }, "example": [ "string" ] } } }, "CustomerSummary": { "description": "Customer summary", "type": "object", "properties": { "Id": { "format": "int32", "description": "Customer identifier", "type": "integer", "example": 500123 }, "Name": { "description": "Customer name", "type": "string", "example": "Example Name" }, "EmailAddress": { "description": "Customer email address", "type": "string", "example": "owner@example.com" }, "PhoneNumberLocalFormat": { "description": "Customer local phone number", "type": "string", "example": "2026-06-02T12:00:00Z" }, "PhoneNumber": { "description": "Customer phone number", "type": "string", "example": "+353000000000" }, "LanguagePreference": { "description": "Preferred language of the consumer", "type": "string", "example": "string" } } }, "CustomerUpdatedEvent": { "description": "Customer updated event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "DashboardEmbed": { "description": "SSO Embed URL Information", "type": "object", "properties": { "EmbedUrl": { "description": "SSO URL generated by Flipdish to embed Looker dashboard", "maxLength": 2048, "minLength": 0, "type": "string", "example": "https://api.flipdish.co/example" } } }, "DeliveryLocation": { "description": "Delivery location", "type": "object", "properties": { "Coordinates": { "$ref": "#/components/schemas/Coordinates" }, "Building": { "description": "Building", "type": "string", "example": "string" }, "Street": { "description": "Street", "type": "string", "example": "string" }, "Town": { "description": "Town", "type": "string", "example": "string" }, "PostCode": { "description": "Post code", "type": "string", "example": "string" }, "DeliveryInstructions": { "description": "Delivery instructions", "type": "string", "example": "string" }, "PrettyAddressString": { "description": "Formatted, pretty address string", "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 } } }, "DeliveryZoneCreatedEvent": { "description": "Delivery Zone Created Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "DeliveryZone": { "$ref": "#/components/schemas/DeliveryZone" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "DeliveryZoneDeletedEvent": { "description": "Delivery Zone Deleted Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "DeliveryZone": { "$ref": "#/components/schemas/DeliveryZone" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "DeliveryZoneUpdatedEvent": { "description": "Delivery Zone Updated Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "DeliveryZone": { "$ref": "#/components/schemas/DeliveryZone" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "DeviceSettings": { "description": "Device settings for Hydra", "required": [ "Volume", "FontSize", "Brightness" ], "type": "object", "properties": { "Volume": { "format": "int32", "description": "Gets or sets the device volume", "maximum": 10, "minimum": 0, "type": "integer", "example": 1 }, "FontSize": { "format": "double", "description": "Gets or sets the font size used on the device", "maximum": 100, "minimum": 1, "type": "number", "example": 1.0 }, "Brightness": { "format": "int32", "description": "Gets or sets the display brightness on the device", "maximum": 100, "minimum": 0, "type": "integer", "example": 1 } } }, "DnsVerifiedEvent": { "description": "The DNS for the Hostname verified", "type": "object", "properties": { "Hostname": { "description": "Description", "type": "string", "example": "Example Name" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "EmvNotificationEvent": { "description": "Order Terminal Notification", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Notification": { "description": "Notification Sent", "type": "string", "example": "string" }, "Order": { "$ref": "#/components/schemas/Order" }, "TerminalId": { "description": "TerminalId", "type": "string", "example": "500123" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "ExpDate": { "description": "Expirey Date", "type": "string", "example": "2026-06-02T12:00:00Z" }, "CardType": { "description": "Card Type", "type": "string", "example": "string" }, "PaymentMethod": { "description": "Payment Method", "type": "string", "example": "string" }, "AccountNumber": { "description": "Masked Account Number", "type": "string", "example": "string" }, "AuthCode": { "description": "Auth Code", "type": "string", "example": "string" }, "ProviderMessage": { "description": "Payment Provider Message", "type": "string", "example": "string" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "EmvTerminal": { "description": "EMV Payment Terminal", "type": "object", "properties": { "EmvTerminalId": { "format": "int32", "description": "Flipdish Identifier of Terminal", "type": "integer", "example": 500123 }, "TerminalId": { "description": "External Identifier of Terminal", "type": "string", "example": "500123" }, "Url": { "description": "URL at which terminal can be accessed", "type": "string", "example": "https://api.flipdish.co/example" }, "Token": { "description": "TOKEN required to access terminal", "type": "string", "example": "string" }, "SoftwareHouseId": { "description": "Identifies us to Provider", "type": "string", "example": "500123" }, "InstallerId": { "description": "Identifies installer of terminal", "type": "string", "example": "500123" } } }, "EmvTerminalWithAssignments": { "description": "EMV Payment Terminal", "type": "object", "properties": { "EmvTerminalId": { "description": "Flipdish Internal identifier of the Terminal", "type": "string", "example": "500123" }, "TerminalId": { "description": "External Identifier of the Terminal", "type": "string", "example": "500123" }, "IsAssignedToHydraDevice": { "description": "true if the terminal is assigned to a hydra device (e.g. a kiosk)", "type": "boolean", "example": true }, "HydraConfigId": { "format": "int32", "description": "hydra device id (null if the terminal is not assigned to any hydra device)", "type": "integer", "nullable": true, "example": 500123 }, "HydraDeviceId": { "description": "external hydra device id (null if the terminal is not assigned to any hydra device)", "type": "string", "example": "500123" }, "HydraName": { "description": "hydra device name (null if the terminal is not assigned to any hydra device)", "type": "string", "example": "Example Name" } } }, "EventSearchResult": { "description": "", "type": "object", "properties": { "AppCreatedEvent": { "description": "App Created Event", "type": "array", "items": { "$ref": "#/components/schemas/AppCreatedEvent" }, "example": [] }, "AppUpdatedEvent": { "description": "App Updated Event", "type": "array", "items": { "$ref": "#/components/schemas/AppUpdatedEvent" }, "example": [] }, "AnalyticsClientEvent": { "description": "Client Analytics events", "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsClientEvent" }, "example": [] }, "OrderAcceptedEvent": { "description": "Order accepted events", "type": "array", "items": { "$ref": "#/components/schemas/OrderAcceptedEvent" }, "example": [] }, "OrderDispatchedEvent": { "description": "Order dispatched events", "type": "array", "items": { "$ref": "#/components/schemas/OrderDispatchedEvent" }, "example": [] }, "OrderCustomerTrackingCreatedEvent": { "description": "Order delivery tracking created events", "type": "array", "items": { "$ref": "#/components/schemas/OrderCustomerTrackingCreatedEvent" }, "example": [] }, "OrderDeliveryTrackingStatusUpdatedEvent": { "description": "Order delivery tracking updated events", "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryTrackingStatusUpdatedEvent" }, "example": [] }, "OrderBatchPublishedEvent": { "description": "Order Batch published event", "type": "array", "items": { "$ref": "#/components/schemas/OrderBatchPublishedEvent" }, "example": [] }, "OrderCreatedEvent": { "description": "Order created events", "type": "array", "items": { "$ref": "#/components/schemas/OrderCreatedEvent" }, "example": [] }, "OrderRatingUpdatedEvent": { "description": "Order rating updated events", "type": "array", "items": { "$ref": "#/components/schemas/OrderRatingUpdatedEvent" }, "example": [] }, "OrderRefundedEvent": { "description": "Order refunded events", "type": "array", "items": { "$ref": "#/components/schemas/OrderRefundedEvent" }, "example": [] }, "OrderRejectedEvent": { "description": "Order rejected events", "type": "array", "items": { "$ref": "#/components/schemas/OrderRejectedEvent" }, "example": [] }, "OrderTipUpdatedEvent": { "description": "Order tip updated events", "type": "array", "items": { "$ref": "#/components/schemas/OrderTipUpdatedEvent" }, "example": [] }, "OrderTerminalNotifications": { "description": "Order Terminal Notification events", "type": "array", "items": { "$ref": "#/components/schemas/EmvNotificationEvent" }, "example": [] }, "StoreCreatedEvent": { "description": "Store created events", "type": "array", "items": { "$ref": "#/components/schemas/StoreCreatedEvent" }, "example": [] }, "StoreDeletedEvent": { "description": "Store deleted events", "type": "array", "items": { "$ref": "#/components/schemas/StoreDeletedEvent" }, "example": [] }, "StoreAddressUpdatedEvent": { "description": "Store address updated events", "type": "array", "items": { "$ref": "#/components/schemas/StoreAddressUpdatedEvent" }, "example": [] }, "StoreKioskSettingUpdatedEvent": { "description": "Store kiosk setting updated events", "type": "array", "items": { "$ref": "#/components/schemas/StoreKioskSettingUpdatedEvent" }, "example": [] }, "DeliveryZoneCreatedEvent": { "description": "Store delivery zone created events", "type": "array", "items": { "$ref": "#/components/schemas/DeliveryZoneCreatedEvent" }, "example": [] }, "DeliveryZoneUpdatedEvent": { "description": "Store delivery zone updated events", "type": "array", "items": { "$ref": "#/components/schemas/DeliveryZoneUpdatedEvent" }, "example": [] }, "DeliveryZoneDeletedEvent": { "description": "Store delivery zone deleted events", "type": "array", "items": { "$ref": "#/components/schemas/DeliveryZoneDeletedEvent" }, "example": [] }, "StoreOpeningHoursUpdatedEvent": { "description": "Store opening hours updated events", "type": "array", "items": { "$ref": "#/components/schemas/StoreOpeningHoursUpdatedEvent" }, "example": [] }, "StoreMenuAssignedEvent": { "description": "Store opening hours updated events", "type": "array", "items": { "$ref": "#/components/schemas/StoreMenuAssignedEvent" }, "example": [] }, "StoreBusinessHoursOverrideCreatedEvent": { "description": "Store business hours override created events", "type": "array", "items": { "$ref": "#/components/schemas/StoreBusinessHoursOverrideCreatedEvent" }, "example": [] }, "StoreBusinessHoursOverrideDeletedEvent": { "description": "Store business hours override deleted events", "type": "array", "items": { "$ref": "#/components/schemas/StoreBusinessHoursOverrideDeletedEvent" }, "example": [] }, "StoreArchivedEvent": { "description": "Store archived events", "type": "array", "items": { "$ref": "#/components/schemas/StoreArchivedEvent" }, "example": [] }, "StoreUnarchivedEvent": { "description": "Store unarchived events", "type": "array", "items": { "$ref": "#/components/schemas/StoreUnarchivedEvent" }, "example": [] }, "StorePublishedEvent": { "description": "Store published events", "type": "array", "items": { "$ref": "#/components/schemas/StorePublishedEvent" }, "example": [] }, "StoreUnpublishedEvent": { "description": "Store unpublished events", "type": "array", "items": { "$ref": "#/components/schemas/StoreUnpublishedEvent" }, "example": [] }, "StoreUpdatedEvent": { "description": "Store updated events", "type": "array", "items": { "$ref": "#/components/schemas/StoreUpdatedEvent" }, "example": [] }, "StorePreOrderConfigUpdatedEvent": { "description": "Store updated events", "type": "array", "items": { "$ref": "#/components/schemas/StorePreOrderConfigUpdatedEvent" }, "example": [] }, "StoreLogoCreatedEvent": { "description": "Store logo created events", "type": "array", "items": { "$ref": "#/components/schemas/StoreLogoCreatedEvent" }, "example": [] }, "StoreLogoUpdatedEvent": { "description": "Store logo updated events", "type": "array", "items": { "$ref": "#/components/schemas/StoreLogoUpdatedEvent" }, "example": [] }, "StoreLogoDeletedEvent": { "description": "Store logo deleted events", "type": "array", "items": { "$ref": "#/components/schemas/StoreLogoDeletedEvent" }, "example": [] }, "MenuCreatedEvent": { "description": "Menu created events", "type": "array", "items": { "$ref": "#/components/schemas/MenuCreatedEvent" }, "example": [] }, "MenuAsyncCreationCompletedEvent": { "description": "Menu async creation completed events", "type": "array", "items": { "$ref": "#/components/schemas/MenuAsyncCreationCompletedEvent" }, "example": [] }, "MenuUpdatedEvent": { "description": "Menu updated events", "type": "array", "items": { "$ref": "#/components/schemas/MenuUpdatedEvent" }, "example": [] }, "MenuUploadedEvent": { "description": "Menu uploaded events", "type": "array", "items": { "$ref": "#/components/schemas/MenuUploadedEvent" }, "example": [] }, "MenuBulkEditEvent": { "description": "Menu bulk events", "type": "array", "items": { "$ref": "#/components/schemas/MenuBulkEditEvent" }, "example": [] }, "MenuSectionCreatedEvent": { "description": "Menu section created events", "type": "array", "items": { "$ref": "#/components/schemas/MenuSectionCreatedEvent" }, "example": [] }, "MenuSectionUpdatedEvent": { "description": "Menu section updated events", "type": "array", "items": { "$ref": "#/components/schemas/MenuSectionUpdatedEvent" }, "example": [] }, "MenuSectionDeletedEvent": { "description": "Menu section deleted events", "type": "array", "items": { "$ref": "#/components/schemas/MenuSectionDeletedEvent" }, "example": [] }, "MenuSectionItemCreatedEvent": { "description": "Menu section item created events", "type": "array", "items": { "$ref": "#/components/schemas/MenuSectionItemCreatedEvent" }, "example": [] }, "MenuSectionItemUpdatedEvent": { "description": "Menu section item updated events", "type": "array", "items": { "$ref": "#/components/schemas/MenuSectionItemUpdatedEvent" }, "example": [] }, "MenuSectionItemDeletedEvent": { "description": "Menu section item deleted events", "type": "array", "items": { "$ref": "#/components/schemas/MenuSectionItemDeletedEvent" }, "example": [] }, "MenuItemOptionSetCreatedEvent": { "description": "Menu item option set created events", "type": "array", "items": { "$ref": "#/components/schemas/MenuItemOptionSetCreatedEvent" }, "example": [] }, "MenuItemOptionSetUpdatedEvent": { "description": "Menu item option set updated events", "type": "array", "items": { "$ref": "#/components/schemas/MenuItemOptionSetUpdatedEvent" }, "example": [] }, "MenuItemOptionSetDeletedEvent": { "description": "Menu item option set deleted events", "type": "array", "items": { "$ref": "#/components/schemas/MenuItemOptionSetDeletedEvent" }, "example": [] }, "MenuItemOptionSetItemCreatedEvent": { "description": "Menu item option set item created events", "type": "array", "items": { "$ref": "#/components/schemas/MenuItemOptionSetItemCreatedEvent" }, "example": [] }, "MenuItemOptionSetItemUpdatedEvent": { "description": "Menu item option set item updated events", "type": "array", "items": { "$ref": "#/components/schemas/MenuItemOptionSetItemUpdatedEvent" }, "example": [] }, "MenuItemOptionSetItemDeletedEvent": { "description": "Menu item option set item deleted events", "type": "array", "items": { "$ref": "#/components/schemas/MenuItemOptionSetItemDeletedEvent" }, "example": [] }, "MenuCheckpointCreatedEvent": { "description": "Menu checkpoint created event", "type": "array", "items": { "$ref": "#/components/schemas/MenuCheckpointCreatedEvent" }, "example": [] }, "StoreGroupCreatedEvent": { "description": "Store group created events", "type": "array", "items": { "$ref": "#/components/schemas/StoreGroupCreatedEvent" }, "example": [] }, "StoreGroupUpdatedEvent": { "description": "Store group updated events", "type": "array", "items": { "$ref": "#/components/schemas/StoreGroupUpdatedEvent" }, "example": [] }, "StoreGroupDeletedEvent": { "description": "Store group deleted events", "type": "array", "items": { "$ref": "#/components/schemas/StoreGroupDeletedEvent" }, "example": [] }, "CustomerCreatedEvent": { "description": "Customer created events", "type": "array", "items": { "$ref": "#/components/schemas/CustomerCreatedEvent" }, "example": [] }, "CustomerUpdatedEvent": { "description": "Customer updated events", "type": "array", "items": { "$ref": "#/components/schemas/CustomerUpdatedEvent" }, "example": [] }, "CustomerConsentUpdatedEvent": { "description": "Customer consent updated events", "type": "array", "items": { "$ref": "#/components/schemas/CustomerConsentUpdatedEvent" }, "example": [] }, "WebhookSubscriptionCreatedEvent": { "description": "Webhook subscription created events", "type": "array", "items": { "$ref": "#/components/schemas/WebhookSubscriptionCreatedEvent" }, "example": [] }, "WebhookSubscriptionUpdatedEvent": { "description": "Webhook subscription updated events", "type": "array", "items": { "$ref": "#/components/schemas/WebhookSubscriptionUpdatedEvent" }, "example": [] }, "WebhookSubscriptionDeletedEvent": { "description": "Webhook subscription deleted events", "type": "array", "items": { "$ref": "#/components/schemas/WebhookSubscriptionDeletedEvent" }, "example": [] }, "PrinterTurnedOnEvent": { "description": "Printer turned ON event", "type": "array", "items": { "$ref": "#/components/schemas/PrinterTurnedOnEvent" }, "example": [] }, "PrinterTurnedOffEvent": { "description": "Printer turned OFF event", "type": "array", "items": { "$ref": "#/components/schemas/PrinterTurnedOffEvent" }, "example": [] }, "PrinterAssignedToStoreEvent": { "description": "Printer assigned to store event", "type": "array", "items": { "$ref": "#/components/schemas/PrinterAssignedToStoreEvent" }, "example": [] }, "PrinterUnassignedFromStoreEvent": { "description": "Printer unassigned from store event", "type": "array", "items": { "$ref": "#/components/schemas/PrinterUnassignedFromStoreEvent" }, "example": [] }, "PhoneCallStartedEvent": { "description": "Phone call started event", "type": "array", "items": { "$ref": "#/components/schemas/PhoneCallStartedEvent" }, "example": [] }, "PhoneCallEndedEvent": { "description": "Phone call ended event", "type": "array", "items": { "$ref": "#/components/schemas/PhoneCallEndedEvent" }, "example": [] }, "TelephonyConfigUpdatedEvent": { "description": "Telephony config updated event", "type": "array", "items": { "$ref": "#/components/schemas/TelephonyConfigUpdatedEvent" }, "example": [] }, "ChannelStoresUpdatedEvent": { "description": "Channel stores updated event", "type": "array", "items": { "$ref": "#/components/schemas/ChannelStoresUpdatedEvent" }, "example": [] }, "LoyaltyCampaignCreatedEvent": { "description": "Loyalty campaign created event", "type": "array", "items": { "$ref": "#/components/schemas/LoyaltyCampaignCreatedEvent" }, "example": [] }, "LoyaltyCampaignDeletedEvent": { "description": "Loyalty campaign deleted event", "type": "array", "items": { "$ref": "#/components/schemas/LoyaltyCampaignDeletedEvent" }, "example": [] }, "LoyaltyCampaignUpdatedEvent": { "description": "Loyalty campaign updated event", "type": "array", "items": { "$ref": "#/components/schemas/LoyaltyCampaignUpdatedEvent" }, "example": [] }, "RetentionCampaignCreatedEvent": { "description": "Retention campaign created event", "type": "array", "items": { "$ref": "#/components/schemas/RetentionCampaignCreatedEvent" }, "example": [] }, "RetentionCampaignDeletedEvent": { "description": "Retention campaign deleted event", "type": "array", "items": { "$ref": "#/components/schemas/RetentionCampaignDeletedEvent" }, "example": [] }, "RetentionCampaignUpdatedEvent": { "description": "Retention campaign updated event", "type": "array", "items": { "$ref": "#/components/schemas/RetentionCampaignUpdatedEvent" }, "example": [] }, "SmsReceivedEvent": { "description": "Sms received event", "type": "array", "items": { "$ref": "#/components/schemas/SmsReceivedEvent" }, "example": [] }, "UserLoginEvent": { "description": "User login event", "type": "array", "items": { "$ref": "#/components/schemas/UserLoginEvent" }, "example": [] }, "UserCreatedEvent": { "description": "User created event", "type": "array", "items": { "$ref": "#/components/schemas/UserCreatedEvent" }, "example": [] }, "UserUpdatedEvent": { "description": "User updated event", "type": "array", "items": { "$ref": "#/components/schemas/UserUpdatedEvent" }, "example": [] }, "UserDeletedEvent": { "description": "User deleted event", "type": "array", "items": { "$ref": "#/components/schemas/UserDeletedEvent" }, "example": [] }, "UserCreatedPasswordEvent": { "description": "User password created event", "type": "array", "items": { "$ref": "#/components/schemas/UserPasswordCreatedEvent" }, "example": [] }, "UserAnsweredSignupQuestionsEvent": { "description": "User answered signup questions event", "type": "array", "items": { "$ref": "#/components/schemas/UserAnsweredSignupQuestionsEvent" }, "example": [] }, "VoucherCreatedEvent": { "description": "Voucher created event", "type": "array", "items": { "$ref": "#/components/schemas/VoucherCreatedEvent" }, "example": [] }, "VoucherUpdatedEvent": { "description": "Voucher updated event", "type": "array", "items": { "$ref": "#/components/schemas/VoucherUpdatedEvent" }, "example": [] }, "VoucherDeletedEvent": { "description": "Voucher deleted event", "type": "array", "items": { "$ref": "#/components/schemas/VoucherDeletedEvent" }, "example": [] }, "VoucherAppliedEvent": { "description": "Voucher applied event", "type": "array", "items": { "$ref": "#/components/schemas/VoucherAppliedEvent" }, "example": [] }, "TeammateInviteSentEvent": { "description": "Teammate invite sent event", "type": "array", "items": { "$ref": "#/components/schemas/TeammateInviteSentEvent" }, "example": [] }, "TeammateInviteAcceptedEvent": { "description": "Teammate invite accepted event", "type": "array", "items": { "$ref": "#/components/schemas/TeammateInviteAcceptedEvent" }, "example": [] }, "TeammateUpdatedEvent": { "description": "Teammate updated event", "type": "array", "items": { "$ref": "#/components/schemas/TeammateUpdatedEvent" }, "example": [] }, "TeammateDeletedEvent": { "description": "Teammate deleted event", "type": "array", "items": { "$ref": "#/components/schemas/TeammateDeletedEvent" }, "example": [] }, "BankAccountCreatedEvent": { "description": "Bank account created event", "type": "array", "items": { "$ref": "#/components/schemas/BankAccountCreatedEvent" }, "example": [] }, "BankAccountUpdatedEvent": { "description": "Bank account updated event", "type": "array", "items": { "$ref": "#/components/schemas/BankAccountUpdatedEvent" }, "example": [] }, "BankAccountDeletedEvent": { "description": "Bank account updated event", "type": "array", "items": { "$ref": "#/components/schemas/BankAccountDeletedEvent" }, "example": [] }, "BankAccountAssignedEvent": { "description": "Bank account assigned event", "type": "array", "items": { "$ref": "#/components/schemas/BankAccountAssignedEvent" }, "example": [] }, "HydraAssignedEvent": { "description": "Hydra assigned event", "type": "array", "items": { "$ref": "#/components/schemas/HydraAssignedEvent" }, "example": [] }, "HydraRequestResetEvent": { "description": "Hydra reset requested event", "type": "array", "items": { "$ref": "#/components/schemas/HydraRequestResetEvent" }, "example": [] }, "HydraStoreAssignedEvent": { "description": "Hydra store assigned event", "type": "array", "items": { "$ref": "#/components/schemas/HydraStoreAssignedEvent" }, "example": [] }, "HydraStoreUnassignedEvent": { "description": "Hydra store unassigned", "type": "array", "items": { "$ref": "#/components/schemas/HydraStoreUnassignedEvent" }, "example": [] }, "HydraSettingChangedEvent": { "description": "Hydra settings changed event", "type": "array", "items": { "$ref": "#/components/schemas/HydraSettingChangedEvent" }, "example": [] }, "HydraUnAssignedEvent": { "description": "Hydra un-assigned event", "type": "array", "items": { "$ref": "#/components/schemas/HydraUnAssignedEvent" }, "example": [] }, "HydraConnectionStatusChangedEvent": { "description": "Hydra connection state change", "type": "array", "items": { "$ref": "#/components/schemas/HydraConnectionStatusChangedEvent" }, "example": [] }, "KioskBluetoothPairingModeEvent": { "description": "Bluetooth Pairing Mode initiated", "type": "array", "items": { "$ref": "#/components/schemas/KioskBluetoothPairingModeEvent" }, "example": [] }, "KioskBluetoothUnpairingModeEvent": { "description": "Bluetooth Unpairing Mode initiated", "type": "array", "items": { "$ref": "#/components/schemas/KioskBluetoothUnpairingModeEvent" }, "example": [] }, "KioskBluetoothTerminalUnpairedEvent": { "description": "Bluetooth Terminal Unpaired with Kiosk", "type": "array", "items": { "$ref": "#/components/schemas/KioskBluetoothTerminalUnpairedEvent" }, "example": [] }, "KioskTerminalActionStateChangedEvent": { "description": "Terminal actionstate change", "type": "array", "items": { "$ref": "#/components/schemas/KioskTerminalActionStateChangedEvent" }, "example": [] }, "KioskBluetoothTerminalUpdatedEvent": { "description": "Bluetooth Terminal Updated", "type": "array", "items": { "$ref": "#/components/schemas/KioskBluetoothTerminalUpdatedEvent" }, "example": [] }, "KioskBluetoothTerminalInitiateUpdateCheckEvent": { "description": "Trigger bluetooth payment terminal update checker", "type": "array", "items": { "$ref": "#/components/schemas/KioskBluetoothTerminalInitiateUpdateCheckEvent" }, "example": [] }, "KioskBluetoothInstallUpdateInitiateEvent": { "description": "Bluetooth Terminal Initiate Update", "type": "array", "items": { "$ref": "#/components/schemas/KioskBluetoothInstallUpdateInitiateEvent" }, "example": [] }, "KioskBluetoothTerminalCancelUpdateEvent": { "description": "Bluetooth Terminal Cancel Update Install", "type": "array", "items": { "$ref": "#/components/schemas/KioskBluetoothTerminalCancelUpdateEvent" }, "example": [] }, "KioskBluetoothTerminalFirmwareVersionStatusEvent": { "description": "Bluetooth Payment Terminal Firmware Version Status Info", "type": "array", "items": { "$ref": "#/components/schemas/KioskBluetoothTerminalFirmwareVersionStatusEvent" }, "example": [] }, "KioskBluetoothTerminalInstallationStatusEvent": { "description": "Bluetooth Terminal Update Installation Status", "type": "array", "items": { "$ref": "#/components/schemas/KioskBluetoothTerminalInstallationStatusEvent" }, "example": [] }, "PushNotificationScheduledEvent": { "description": "Push notification scheduled event", "type": "array", "items": { "$ref": "#/components/schemas/PushNotificationScheduledEvent" }, "example": [] }, "PushNotificationSentEvent": { "description": "Push notification sent event", "type": "array", "items": { "$ref": "#/components/schemas/PushNotificationSentEvent" }, "example": [] }, "PushNotificationDeletedEvent": { "description": "Push notification deleted event", "type": "array", "items": { "$ref": "#/components/schemas/PushNotificationDeletedEvent" }, "example": [] }, "DnsVerifiedEvent": { "description": "DNS Verified", "type": "array", "items": { "$ref": "#/components/schemas/DnsVerifiedEvent" }, "example": [] }, "CertificateCreatedEvent": { "description": "Certificate created", "type": "array", "items": { "$ref": "#/components/schemas/CertificateCreatedEvent" }, "example": [] }, "CertificateRenewedEvent": { "description": "Certificate renewed", "type": "array", "items": { "$ref": "#/components/schemas/CertificateRenewedEvent" }, "example": [] }, "WebsiteVanityUrlUpdatedEvent": { "description": "Panacea vanity url updated", "type": "array", "items": { "$ref": "#/components/schemas/WebsiteVanityUrlUpdatedEvent" }, "example": [] }, "WebsiteUpdatedEvent": { "description": "Website updated", "type": "array", "items": { "$ref": "#/components/schemas/WebsiteUpdatedEvent" }, "example": [] }, "OrderCapacityUpdatedEvent": { "description": "Order capacity config updated", "type": "array", "items": { "$ref": "#/components/schemas/OrderCapacityConfigUpdatedEvent" }, "example": [] }, "ExternalStoreEvent": { "description": "External event", "type": "array", "items": { "$ref": "#/components/schemas/ExternalStoreEvent" }, "example": [] }, "OrderFulfillmentStatusUpdatedEvent": { "description": "Fulfillment status updated event", "type": "array", "items": { "$ref": "#/components/schemas/OrderFulfillmentStatusUpdatedEvent" }, "example": [] }, "AppStoreConfigCreatedEvent": { "description": "App Store Config Created", "type": "array", "items": { "$ref": "#/components/schemas/AppStoreConfigCreatedEvent" }, "example": [] }, "AppStoreConfigUpdatedEvent": { "description": "App Store Config Updated", "type": "array", "items": { "$ref": "#/components/schemas/AppStoreConfigUpdatedEvent" }, "example": [] }, "AppStoreConfigDeletedEvent": { "description": "App Store Config Deleted", "type": "array", "items": { "$ref": "#/components/schemas/AppStoreConfigDeletedEvent" }, "example": [] }, "AppStoreSubscriptionChangeJobUpdatedEvent": { "description": "App Store Subscription Change Job Updated", "type": "array", "items": { "$ref": "#/components/schemas/AppStoreSubscriptionChangeJobUpdatedEvent" }, "example": [] }, "CatalogItemCreatedEvent": { "description": "Catalog Item Created", "type": "array", "items": { "$ref": "#/components/schemas/CatalogItemCreatedEvent" }, "example": [] }, "CatalogItemUpdatedEvent": { "description": "Catalog Item Updated", "type": "array", "items": { "$ref": "#/components/schemas/CatalogItemUpdatedEvent" }, "example": [] }, "CatalogItemArchivedEvent": { "description": "Catalog Item Archived", "type": "array", "items": { "$ref": "#/components/schemas/CatalogItemArchivedEvent" }, "example": [] }, "CatalogGroupCreatedEvent": { "description": "Catalog Group Created", "type": "array", "items": { "$ref": "#/components/schemas/CatalogGroupCreatedEvent" }, "example": [] }, "CatalogGroupUpdatedEvent": { "description": "Catalog Group Updated", "type": "array", "items": { "$ref": "#/components/schemas/CatalogGroupUpdatedEvent" }, "example": [] }, "CatalogGroupArchivedEvent": { "description": "Catalog Group Archived", "type": "array", "items": { "$ref": "#/components/schemas/CatalogGroupArchivedEvent" }, "example": [] }, "StoreTipUpdatedEvent": { "description": "Store Tip Updated Event", "type": "array", "items": { "$ref": "#/components/schemas/StoreTipUpdatedEvent" }, "example": [] }, "LocationAreaCreatedEvent": { "description": "LocationArea created event", "type": "array", "items": { "$ref": "#/components/schemas/LocationAreaCreatedEvent" }, "example": [] }, "LocationAreaUpdatedEvent": { "description": "LocationArea updated event", "type": "array", "items": { "$ref": "#/components/schemas/LocationAreaUpdatedEvent" }, "example": [] }, "LocationCreatedEvent": { "description": "Location created event", "type": "array", "items": { "$ref": "#/components/schemas/LocationCreatedEvent" }, "example": [] }, "LocationDeletedEvent": { "description": "Location deleted event", "type": "array", "items": { "$ref": "#/components/schemas/LocationDeletedEvent" }, "example": [] }, "StoreServiceChargeUpdatedEvent": { "description": "Service Charge Updated Event", "type": "array", "items": { "$ref": "#/components/schemas/StoreServiceChargeUpdatedEvent" }, "example": [] }, "MobileAppsSubmissionStatusUpdatedEvent": { "description": "Mobile Submission Status Updated Event", "type": "array", "items": { "$ref": "#/components/schemas/MobileAppsSubmissionStatusUpdatedEvent" }, "example": [] }, "MobileAppsSubmissionUpdatedEvent": { "description": "Mobile Submission Updated Event", "type": "array", "items": { "$ref": "#/components/schemas/MobileAppsSubmissionUpdatedEvent" }, "example": [] }, "StoreFeeConfigUpdatedEvent": { "description": "Store Fee Config Updated Event", "type": "array", "items": { "$ref": "#/components/schemas/StoreFeeConfigUpdatedEvent" }, "example": [] } } }, "ExternalStoreEvent": { "description": "External event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "DescriptionFormat": { "description": "Description with format placeholders", "type": "string", "example": "2026-06-02T12:00:00Z" }, "DescriptionFields": { "description": "Description with format placeholders", "type": "string", "example": "string" }, "DescriptionId": { "description": "Description", "type": "string", "example": "500123" }, "Ref1": { "description": "Ref (reference field)", "type": "string", "example": "string" }, "Ref2": { "description": "Ref2 (reference field)", "type": "string", "example": "string" }, "Ref3": { "description": "Ref3 (reference field)", "type": "string", "example": "string" }, "Ref4": { "description": "Ref4 (reference field)", "type": "string", "example": "string" }, "OrderId": { "format": "int32", "description": "Order Id", "type": "integer", "nullable": true, "example": 500123 }, "Tags": { "description": "Tags", "type": "array", "items": { "type": "string" }, "example": [ "string" ] }, "FieldChanges": { "description": "Field changes list", "type": "array", "items": { "$ref": "#/components/schemas/FieldChangeInformation" }, "example": [] }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "FeeSummary": { "description": "Fee Summary", "type": "object", "properties": { "FeeAmount": { "format": "double", "description": "Fee amount", "type": "number", "example": 12.5 }, "PercentageRate": { "format": "double", "description": "Percentage rate", "type": "number", "example": 1.0 }, "PerTransactionFee": { "format": "double", "description": "Per transaction fee", "type": "number", "example": 12.5 } } }, "FieldChangeInformation": { "description": "Change information for a field", "type": "object", "properties": { "Path": { "description": "Path (hierarchy)", "type": "string", "example": "string" }, "Name": { "description": "Name of field", "type": "string", "example": "Example Name" }, "Key": { "description": "Key (code) of field", "type": "string", "example": "string" }, "OldValue": { "description": "Old value", "type": "string", "example": "string" }, "NewValue": { "description": "New value", "type": "string", "example": "string" } } }, "FileDownloadResult": { "description": "File Download Result", "type": "object", "properties": { "FileUrl": { "description": "URL of the file", "type": "string", "example": "https://api.flipdish.co/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'." } } } } }, "FlipdishEventBase": { "description": "Base Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "Group": { "description": "CatalogGroup", "required": [ "GroupType", "Sku", "Name" ], "type": "object", "properties": { "CatalogGroupId": { "description": "Unique catalog group id", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "CatalogItemId": { "description": "Unique catalog item id", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "IsArchived": { "description": "Returns true if the group is archived", "type": "boolean", "example": true }, "MinSelectCount": { "format": "int32", "description": "Minimum number of items that the user has to select", "type": "integer", "example": 3 }, "MaxSelectCount": { "format": "int32", "description": "Maximum number of items that the user has to select", "type": "integer", "nullable": true, "example": 3 }, "Products": { "description": "Collection of items associated with this product", "type": "array", "items": { "$ref": "#/components/schemas/ProductReference" }, "example": [] }, "Metafields": { "description": "Collection of metafields", "type": "array", "items": { "$ref": "#/components/schemas/Metafield" }, "example": [] }, "GroupType": { "description": "Type of group (ModifierGroup, etc)", "enum": [ "ModifierGroup" ], "type": "string", "example": "ModifierGroup" }, "Sku": { "description": "Stock Keeping Unit (SKU)", "maxLength": 30, "minLength": 0, "type": "string", "example": "string" }, "Name": { "description": "Group name", "maxLength": 300, "minLength": 0, "type": "string", "example": "Example Name" }, "AutogenerateDisplayText": { "description": "Autogenerate display text in ordering applications", "type": "boolean", "example": true }, "ImageFileName": { "description": "Image File Name", "maxLength": 512, "minLength": 0, "type": "string", "example": "Example Name" } } }, "GroupReference": { "description": "Reference to an existing {Flipdish.Menus.PublicModels.V1.Catalog.Groups.Group}", "required": [ "CatalogItemId", "GroupType" ], "type": "object", "properties": { "Group": { "$ref": "#/components/schemas/Group" }, "CatalogItemId": { "description": "Identifier of the ProductId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "GroupType": { "description": "Type of the SupProduct", "enum": [ "ModifierGroup" ], "type": "string", "example": "ModifierGroup" } } }, "HomeAction": { "description": "", "type": "object", "properties": { "HomeActionId": { "format": "int32", "description": "", "type": "integer", "example": 500123 }, "HomeActionType": { "description": "Type of Action", "enum": [ "Portal", "External" ], "type": "string", "example": "Portal" }, "Order": { "format": "int32", "description": "", "type": "integer", "example": 1 }, "TitleKey": { "description": "", "type": "string", "example": "string" }, "ActionKey": { "description": "", "type": "string", "example": "string" }, "DescriptionKey": { "description": "", "type": "string", "example": "string" }, "Action": { "description": "", "type": "string", "example": "string" }, "Dismissible": { "description": "", "type": "boolean", "example": true } } }, "HomeStatistics": { "description": "Home statitstics", "type": "object", "properties": { "TotalMoneySaved": { "description": "Money saved", "type": "array", "items": { "$ref": "#/components/schemas/CurrencyData" }, "example": [] } } }, "HydraAssignedEvent": { "description": "Hydra assigned event", "type": "object", "properties": { "User": { "$ref": "#/components/schemas/UserEventInfo" }, "HydraStatus": { "$ref": "#/components/schemas/HydraStatus" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "HydraConfig": { "description": "Hydra configuration", "required": [ "MinimumVersion", "PaymentOptions", "DeviceSettings" ], "type": "object", "properties": { "MinimumVersion": { "description": "Minimum version", "type": "string", "example": "string" }, "PaymentOptions": { "description": "Payment options", "type": "array", "items": { "enum": [ "Online", "Emv", "Counter" ], "type": "string" }, "example": [ "Online" ] }, "DeviceSettings": { "$ref": "#/components/schemas/DeviceSettings" }, "Version": { "description": "Version of the device", "type": "string", "example": "string" }, "BuildNumber": { "description": "Build number of the device", "type": "string", "example": "string" }, "GitSha": { "description": "SHA of the commit", "type": "string", "example": "string" }, "GitBranch": { "description": "Build branch", "type": "string", "example": "string" } } }, "HydraConnectionStatusChangedEvent": { "description": "Hydra Connection Status Changed Event", "type": "object", "properties": { "DeviceId": { "description": "Hydra Device Id", "type": "string", "example": "500123" }, "HydraDeviceStatus": { "description": "Hydra Device Status", "enum": [ "Online", "PossiblyOffline", "Offline" ], "type": "string", "example": "Online" }, "PollTime": { "format": "date-time", "description": "Hydra Last Poll Time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "HydraDeviceDetails": { "description": "Hydra device details", "type": "object", "properties": { "HydraConfigId": { "format": "int32", "description": "Flipdish internal device identifier", "type": "integer", "example": 500123 }, "DeviceId": { "description": "Device Id", "type": "string", "example": "500123" }, "SerialNumber": { "description": "Serial Number", "type": "string", "example": "string" }, "DeviceType": { "description": "Type of the device", "enum": [ "Kiosk", "Terminal", "LegacyPrinter" ], "type": "string", "example": "Kiosk" }, "Status": { "description": "Status of the device", "enum": [ "Online", "PossiblyOffline", "Offline" ], "type": "string", "example": "Online" }, "DeviceName": { "description": "Device Name", "type": "string", "example": "Example Name" }, "StoreNames": { "description": "Store Names", "type": "array", "items": { "$ref": "#/components/schemas/HydraStoreData" }, "example": [] }, "LastPollUtc": { "format": "date-time", "description": "Last poll time in UTC", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "Version": { "description": "Version of the device", "type": "string", "example": "string" }, "BuildNumber": { "description": "Build number of the device", "type": "string", "example": "string" }, "GitSha": { "description": "SHA of the commit", "type": "string", "example": "string" }, "GitBranch": { "description": "Build branch", "type": "string", "example": "string" } } }, "HydraRegistrationRequest": { "description": "Hydra registration result", "required": [ "StoreIds", "DeviceName" ], "type": "object", "properties": { "StoreIds": { "description": "Stores to assign the hydra", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "DeviceName": { "description": "Hydra device name", "type": "string", "example": "Example Name" }, "PinCode": { "format": "int32", "description": "6 digit PIN code (not starting with zero).", "maximum": 999999, "minimum": 100000, "type": "integer", "example": 1 } } }, "HydraRequestResetEvent": { "description": "Hydra request reset event", "type": "object", "properties": { "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "HydraSettingChangedEvent": { "description": "Hydra settings changed", "type": "object", "properties": { "User": { "$ref": "#/components/schemas/UserEventInfo" }, "HydraConfig": { "$ref": "#/components/schemas/HydraConfig" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "HydraStatus": { "description": "Hydra status", "required": [ "AppId", "IsRegistered" ], "type": "object", "properties": { "AppId": { "description": "", "type": "string", "example": "500123" }, "StoreIds": { "description": "Store to assign the hydra", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "IsRegistered": { "description": "The device has been already registered", "type": "boolean", "example": true }, "PinCode": { "format": "int32", "description": "6 digit PIN code (not starting with zero).", "maximum": 999999, "minimum": 100000, "type": "integer", "nullable": true, "example": 1 }, "Images": { "description": "Hydra images (covers)", "type": "array", "items": { "type": "string" }, "example": [ "string" ] }, "UserType": { "description": "Hydra User Type", "enum": [ "Kiosk", "Terminal", "LegacyPrinter" ], "type": "string", "example": "Kiosk" } } }, "HydraStoreAssignedEvent": { "description": "Hydra store\\s assigned event", "type": "object", "properties": { "User": { "$ref": "#/components/schemas/UserEventInfo" }, "StoreIds": { "description": "Store\\s to assign hydra to", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "HydraStoreData": { "description": "Store Data", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "Id of the store", "type": "integer", "example": 500123 }, "StoreName": { "description": "Name of the store", "type": "string", "example": "Example Name" } } }, "HydraStoreUnassignedEvent": { "description": "Hydra store\\s unassigned event", "type": "object", "properties": { "User": { "$ref": "#/components/schemas/UserEventInfo" }, "StoreIds": { "description": "Store\\s to unassign hydra from", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "HydraUnAssignedEvent": { "description": "Hydra unassigned event", "type": "object", "properties": { "User": { "$ref": "#/components/schemas/UserEventInfo" }, "HydraStatus": { "$ref": "#/components/schemas/HydraStatus" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "IntercomUserHash": { "description": "Intercom user hash", "type": "object", "properties": { "UserHash": { "description": "User hash", "type": "string", "example": "string" } } }, "JobAddress": { "description": "Job Address", "type": "object", "properties": { "Street": { "description": "Street", "type": "string", "example": "string" }, "Postcode": { "description": "Postcode", "type": "string", "example": "string" }, "City": { "description": "City", "type": "string", "example": "string" }, "Country": { "description": "Country", "type": "string", "example": "IE" }, "Zone": { "description": "Zone", "type": "string", "example": "string" }, "FormattedAddress": { "description": "Formatted Address", "type": "string", "example": "string" } } }, "JobCancellation": { "description": "Job Cancellation", "type": "object", "properties": { "CanceledBy": { "description": "Canceled By", "type": "string", "example": "string" }, "ReasonKey": { "description": "Reason Key", "type": "string", "example": "string" }, "Comment": { "description": "Comment", "type": "string", "example": "string" } } }, "JobContact": { "description": "Job Contact", "type": "object", "properties": { "Firstname": { "description": "Firstname", "type": "string", "example": "Example Name" }, "Lastname": { "description": "Lastname", "type": "string", "example": "Example Name" }, "Phone": { "description": "Phone", "type": "string", "example": "+353000000000" }, "Email": { "description": "Email", "type": "string", "example": "owner@example.com" }, "Company": { "description": "Company", "type": "string", "example": "string" }, "CompanyName": { "description": "Company Name", "type": "string", "example": "Example Name" } } }, "JobDelivery": { "description": "Job Delivery", "type": "object", "properties": { "Id": { "format": "int32", "description": "Id", "type": "integer", "example": 500123 }, "Status": { "description": "Status", "type": "string", "example": "Active" }, "PickedAt": { "description": "Picked At", "type": "string", "example": "2026-06-02T12:00:00Z" }, "DeliveredAt": { "description": "Delivered At", "type": "string", "example": "2026-06-02T12:00:00Z" }, "TrackingUrl": { "description": "Tracking Url", "type": "string", "example": "https://api.flipdish.co/example" }, "ClientReference": { "description": "Client Reference", "type": "string", "example": "string" }, "PackageDescription": { "description": "Package Description", "type": "string", "example": "string" }, "PackageType": { "description": "Package Type", "type": "string", "example": "string" }, "Pickup": { "$ref": "#/components/schemas/JobDeliveryDetail" }, "Dropoff": { "$ref": "#/components/schemas/JobDeliveryDetail" }, "Eta": { "$ref": "#/components/schemas/JobEta" }, "Cancellation": { "$ref": "#/components/schemas/JobCancellation" }, "Proof": { "$ref": "#/components/schemas/JobProof" } } }, "JobDeliveryDetail": { "description": "Job Delivery Detail", "type": "object", "properties": { "Id": { "format": "int32", "description": "Id", "type": "integer", "example": 500123 }, "Latitude": { "format": "double", "description": "Latitude", "type": "number", "nullable": true, "example": 1.0 }, "Longitude": { "format": "double", "description": "Longitude", "type": "number", "nullable": true, "example": 1.0 }, "Comment": { "description": "Comment", "type": "string", "example": "string" }, "Address": { "$ref": "#/components/schemas/JobAddress" }, "Contact": { "$ref": "#/components/schemas/JobContact" } } }, "JobDriver": { "description": "Job Driver", "type": "object", "properties": { "Id": { "format": "int32", "description": "Id", "type": "integer", "example": 500123 }, "DisplayName": { "description": "Display Name", "type": "string", "example": "Example Name" }, "Phone": { "description": "Phone", "type": "string", "example": "+353000000000" }, "PictureUrl": { "description": "Picture Url", "type": "string", "example": "https://api.flipdish.co/example" }, "TransportType": { "description": "Transport Type", "type": "string", "example": "string" }, "Latitude": { "format": "double", "description": "Latitude", "type": "number", "nullable": true, "example": 1.0 }, "Longitude": { "format": "double", "description": "Longitude", "type": "number", "nullable": true, "example": 1.0 } } }, "JobEta": { "description": "Job Eta", "type": "object", "properties": { "Pickup": { "description": "Pickup", "type": "string", "example": "string" }, "Dropoff": { "description": "Dropoff", "type": "string", "example": "string" } } }, "JobPricing": { "description": "Job Pricing", "type": "object", "properties": { "Currency": { "description": "Currency", "type": "string", "example": "EUR" }, "TaxPercentage": { "format": "double", "description": "Tax Percentage", "type": "number", "nullable": true, "example": 1.0 }, "PriceTaxIncluded": { "format": "double", "description": "Price Tax Included", "type": "number", "nullable": true, "example": 12.5 }, "PriceTaxExcluded": { "format": "double", "description": "Price Tax Excluded", "type": "number", "nullable": true, "example": 12.5 }, "TaxAmount": { "format": "double", "description": "Tax Amount", "type": "number", "nullable": true, "example": 12.5 }, "InvoiceUrl": { "description": "Invoice Url", "type": "string", "example": "https://api.flipdish.co/example" } } }, "JobProof": { "description": "Job Proof", "type": "object", "properties": { "SignatureUrl": { "description": "Signature Url", "type": "string", "example": "https://api.flipdish.co/example" } } }, "JobResponse": { "description": "Job Response", "type": "object", "properties": { "Id": { "format": "int32", "description": "Id", "type": "integer", "example": 500123 }, "CreatedAt": { "format": "date-time", "description": "Created At", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "Status": { "description": "Status", "type": "string", "example": "Active" }, "PackageType": { "description": "Package Type", "type": "string", "example": "string" }, "TransportType": { "description": "Transport Type", "type": "string", "example": "string" }, "AssignmentCode": { "description": "Assignment Code", "type": "string", "example": "string" }, "PickupAt": { "description": "Pickup At", "type": "string", "example": "2026-06-02T12:00:00Z" }, "DropoffAt": { "description": "Dropoff At", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Comment": { "description": "Comment", "type": "string", "example": "string" }, "Distance": { "format": "double", "description": "Distance", "type": "number", "nullable": true, "example": 1.0 }, "Duration": { "format": "int32", "description": "Duration", "type": "integer", "nullable": true, "example": 1 }, "Deliveries": { "description": "Deliveries", "type": "array", "items": { "$ref": "#/components/schemas/JobDelivery" }, "example": [] }, "Pricing": { "$ref": "#/components/schemas/JobPricing" }, "Driver": { "$ref": "#/components/schemas/JobDriver" } } }, "KioskBluetoothInstallUpdateInitiateEvent": { "description": "Kiosk bluetooth Initiate Install Update Event", "type": "object", "properties": { "DeviceId": { "description": "Device Id of the Kiosk", "type": "string", "example": "500123" }, "BluetoothTerminalType": { "description": "Terminal Type", "enum": [ "CHIPPER_2X", "COTS_DEVICE", "VERIFONE_P400", "WISEPAD_3", "WISEPOS_E" ], "type": "string", "example": "CHIPPER_2X" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "KioskBluetoothPairingModeEvent": { "description": "Kiosk Bluetooth Pairing mode initiated", "type": "object", "properties": { "DeviceId": { "description": "Device Id of the Kiosk", "type": "string", "example": "500123" }, "BluetoothTerminalType": { "description": "Terminal Type", "enum": [ "CHIPPER_2X", "COTS_DEVICE", "VERIFONE_P400", "WISEPAD_3", "WISEPOS_E" ], "type": "string", "example": "CHIPPER_2X" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "KioskBluetoothTerminalCancelUpdateEvent": { "description": "Kiosk bluetooth Cancel Update Install Event", "type": "object", "properties": { "DeviceId": { "description": "Device Id of the Kiosk", "type": "string", "example": "500123" }, "BluetoothTerminalType": { "description": "Terminal Type", "enum": [ "CHIPPER_2X", "COTS_DEVICE", "VERIFONE_P400", "WISEPAD_3", "WISEPOS_E" ], "type": "string", "example": "CHIPPER_2X" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "KioskBluetoothTerminalFirmwareVersionStatusEvent": { "description": "Kiosk Stripe Terminal Update info received event", "type": "object", "properties": { "DeviceId": { "description": "Device Id of the Kiosk", "type": "string", "example": "500123" }, "SerialNumber": { "description": "Serial Number of the device", "type": "string", "example": "string" }, "HasFirmwareUpdate": { "description": "Indicates if Payment Terminal has Firmware Update", "type": "boolean", "example": true }, "HasConfigUpdate": { "description": "Indicates if Payment Terminal has Config Update", "type": "boolean", "example": true }, "HasKeyUpdate": { "description": "Indicates if Payment Terminal has Key Update", "type": "boolean", "example": true }, "UpdateTimeEstimate": { "description": "ETA to install the update", "enum": [ "LessThanOneMinute", "OneToTwoMinutes", "TwoToFiveMinutes", "FiveToFifteenMinutes" ], "type": "string", "example": "LessThanOneMinute" }, "UserEventInfo": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "KioskBluetoothTerminalInitiateUpdateCheckEvent": { "description": "Kiosk bluetooth trigger update check event", "type": "object", "properties": { "DeviceId": { "description": "Device Id of the Kiosk", "type": "string", "example": "500123" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "KioskBluetoothTerminalInstallationStatusEvent": { "description": "Kiosk bluetooth terminal Installation Status", "type": "object", "properties": { "DeviceId": { "description": "Device Id of the Kiosk", "type": "string", "example": "500123" }, "BluetoothTerminalType": { "description": "Terminal Type", "enum": [ "CHIPPER_2X", "COTS_DEVICE", "VERIFONE_P400", "WISEPAD_3", "WISEPOS_E" ], "type": "string", "example": "CHIPPER_2X" }, "BluetoothTerminalSerialNumber": { "description": "Serial number of the terminal", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Progress": { "format": "int32", "description": "Update Install Progress for Card Reader", "type": "integer", "nullable": true, "example": 1 }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "KioskBluetoothTerminalUnpairedEvent": { "description": "Kiosk Bluetooth Unpairing mode initiated", "type": "object", "properties": { "DeviceId": { "description": "Device Id of the Kiosk", "type": "string", "example": "500123" }, "BluetoothTerminalType": { "description": "Terminal Type", "enum": [ "CHIPPER_2X", "COTS_DEVICE", "VERIFONE_P400", "WISEPAD_3", "WISEPOS_E" ], "type": "string", "example": "CHIPPER_2X" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "KioskBluetoothTerminalUpdatedEvent": { "description": "Kiosk bluetooth terminal unpaired", "type": "object", "properties": { "DeviceId": { "description": "Device Id of the Kiosk", "type": "string", "example": "500123" }, "BluetoothTerminalType": { "description": "Terminal Type", "enum": [ "CHIPPER_2X", "COTS_DEVICE", "VERIFONE_P400", "WISEPAD_3", "WISEPOS_E" ], "type": "string", "example": "CHIPPER_2X" }, "BluetoothTerminalSerialNumber": { "description": "Serial number of the terminal", "type": "string", "example": "string" }, "BluetoothTerminalStatus": { "$ref": "#/components/schemas/BluetoothTerminalStatus" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "KioskBluetoothUnpairingModeEvent": { "description": "Kiosk Bluetooth Unpairing mode initiated", "type": "object", "properties": { "DeviceId": { "description": "Device Id of the Kiosk", "type": "string", "example": "500123" }, "BluetoothTerminalType": { "description": "Terminal Type", "enum": [ "CHIPPER_2X", "COTS_DEVICE", "VERIFONE_P400", "WISEPAD_3", "WISEPOS_E" ], "type": "string", "example": "CHIPPER_2X" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "KioskCashPaymentSettings": { "description": "Get Cash Payment Settings for a UserId", "type": "object", "properties": { "IsCashVisibleToCustomer": { "description": "false :disable cash on kiosk\r\ntrue :enable cash on kiosk", "type": "boolean", "example": true }, "UserId": { "format": "int32", "description": "HydraUser ID of the Device", "type": "integer", "example": 500123 } } }, "KioskSettings": { "description": "Kiosk level settings", "type": "object", "properties": { "HideLogoFromFrontPage": { "description": "Hide logo from front page", "type": "boolean", "example": true }, "TwoColumnMenuLayout": { "description": "2 Column Menu Layout", "type": "boolean", "example": true } } }, "KioskTerminalActionStateChangedEvent": { "description": "Kiosk Terminal action state changed", "type": "object", "properties": { "ReaderId": { "description": "Card reader id", "type": "string", "example": "500123" }, "BluetoothTerminalType": { "description": "Terminal type", "enum": [ "CHIPPER_2X", "COTS_DEVICE", "VERIFONE_P400", "WISEPAD_3", "WISEPOS_E" ], "type": "string", "example": "CHIPPER_2X" }, "ActionState": { "description": "Action state. success or fail", "type": "string", "example": "string" }, "FailureCode": { "description": "Failure code if processing is failed", "type": "string", "example": "string" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "Language": { "description": "Sorted Language", "type": "object", "properties": { "LanguageId": { "description": "ISO 639-1 Language Code", "type": "string", "example": "500123" }, "DisplayOrder": { "format": "int32", "description": "Display Order", "type": "integer", "example": 1 }, "Name": { "description": "Language Name", "type": "string", "example": "Example Name" }, "Enabled": { "description": "Is the language enabled for use.", "type": "boolean", "example": true } } }, "LightspeedSettings": { "description": "Ligthspeed store settings", "type": "object", "properties": { "CompanyId": { "description": "Company Id", "type": "string", "example": "500123" }, "UseOAuth": { "description": "Use OAuth for authentication", "type": "boolean", "example": true }, "Enabled": { "description": "Enabled", "type": "boolean", "example": true }, "EstimatedMinutesForDelivery": { "format": "int32", "description": "Estimated minutes for delivery", "type": "integer", "example": 1 }, "EstimatedMinutesForCollection": { "format": "int32", "description": "Estimated minutes for collection", "type": "integer", "example": 1 }, "GeographicLocation": { "description": "Geographic location (euc1, nae1, euw2, ....))", "type": "string", "example": "string" }, "Establishment": { "description": "Is the CompanyId an establishment (kind of the store of a group of store)", "type": "boolean", "example": true }, "VoucherId": { "description": "The Lightspeed voucher identifier to map with our", "type": "string", "example": "500123" }, "DeliveryFeeId": { "description": "The Lightspeed delivery fee identifier to map with our", "type": "string", "example": "500123" }, "ProcessingFeeId": { "description": "The Lightspeed processing fee identifier to map with our", "type": "string", "example": "500123" }, "PriceType": { "description": "Which price to choose from Lightspeed menu", "enum": [ "Default", "Takeaway", "Delivery" ], "type": "string", "nullable": true, "example": "Default" }, "MenuId": { "format": "int32", "description": "The menu id of the store", "type": "integer", "example": 500123 }, "CollectionTableId": { "format": "int32", "description": "Collection Table ID to send orders", "type": "integer", "nullable": true, "example": 500123 }, "DeliveryTableId": { "format": "int32", "description": "Delivery Table ID to send orders", "type": "integer", "nullable": true, "example": 500123 }, "CollectionTableIds": { "description": "Collection Table IDs to send orders to", "type": "object", "additionalProperties": { "type": "string" } }, "DeliveryTableIds": { "description": "Delivery Table IDs to send orders to", "type": "object", "additionalProperties": { "type": "string" } }, "UseTaxInclusivePrices": { "description": "Exclude tax", "type": "boolean", "example": true }, "SkipStatusCheckAndAcceptOrderAfterSending": { "description": "WARNING: only use this option if the Liteserver is not synchronizing within max 5 minutes with Lightspeed cloud!", "type": "boolean", "example": true }, "SendTableNumberToTableId": { "description": "Send Table Number to Table Id", "type": "boolean", "example": true }, "AddChefNoteToProduct": { "description": "Add ChefNote To Product", "type": "boolean", "example": true }, "ChefNoteItemId": { "description": "The Lightspeed Chef Note Item Id to map", "type": "string", "example": "500123" }, "ChefNoteModifierId": { "description": "The Lightspeed Chef Note Modifier Id to map", "type": "string", "example": "500123" }, "ServiceChargeId": { "description": "The Lightspeed Service Charge Id to map", "type": "string", "example": "500123" } } }, "LocationAreaCreatedEvent": { "description": "Event for logging creating of LocationAreas", "type": "object", "properties": { "LocationAreaId": { "description": "LocationArea Id", "type": "string", "example": "500123" }, "LocationAreaName": { "description": "LocationArea name", "type": "string", "example": "Example Name" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "LocationAreaUpdatedEvent": { "description": "Event for logging updates of LocationAreas", "type": "object", "properties": { "LocationAreaId": { "description": "LocationArea Id", "type": "string", "example": "500123" }, "LocationAreaName": { "description": "LocationArea Name", "type": "string", "example": "Example Name" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "LocationCreatedEvent": { "description": "Event for logging the creating of Locations", "type": "object", "properties": { "LocationId": { "format": "int32", "description": "Location Location Id", "type": "integer", "example": 500123 }, "LocationName": { "description": "Location LocationName", "type": "string", "example": "Example Name" }, "DisplayOrder": { "format": "int32", "description": "Location DisplayOrder", "type": "integer", "example": 1 }, "ExternalLocationId": { "description": "Location ExternalLocationId", "type": "string", "example": "500123" }, "LocationAreaId": { "format": "int32", "description": "Location LocationAreaId", "type": "integer", "example": 500123 }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "LocationDeletedEvent": { "description": "Event for logging the deleting of Locations", "type": "object", "properties": { "LocationId": { "format": "int32", "description": "Location Id", "type": "integer", "example": 500123 }, "LocationName": { "description": "Location Name", "type": "string", "example": "Example Name" }, "DisplayOrder": { "format": "int32", "description": "Location DisplayOrder", "type": "integer", "example": 1 }, "ExternalLocationId": { "description": "Location ExternalLocationId", "type": "string", "example": "500123" }, "LocationAreaId": { "format": "int32", "description": "LocationAreaId", "type": "integer", "example": 500123 }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "LoyaltyCampaign": { "description": "Loyalty campaign", "type": "object", "properties": { "CampaignId": { "format": "int32", "description": "Id of campaign", "type": "integer", "example": 500123 }, "Statistics": { "$ref": "#/components/schemas/CampaignStatistics" }, "Stores": { "description": "Stores this campaign applies to with campaign start time in Utc", "type": "array", "items": { "$ref": "#/components/schemas/StoreCampaignStartTime" }, "example": [] }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "OrdersBeforeReceivingVoucher": { "format": "int32", "description": "Number of orders customer needs to make, before receiving voucher", "type": "integer", "example": 1 }, "PercentDiscountAmount": { "format": "int32", "description": "Discount amount in percents", "maximum": 100, "minimum": 1, "type": "integer", "nullable": true, "example": 12.5 }, "MaxDiscount": { "format": "double", "description": "Maximum discount for percentage discounts", "minimum": 0, "type": "number", "nullable": true, "example": 3 }, "RoundingStrategy": { "format": "int32", "description": "Controls how the loyalty voucher's amount is rounded", "maximum": 2, "minimum": 0, "type": "integer", "nullable": true, "example": 1 }, "ShouldIncludeOrdersWithLoyaltyVoucher": { "description": "Controls whether we should include orders with loyalty vouchers in the campaign calculation", "type": "boolean", "nullable": true, "example": true }, "VoucherValidPeriodDays": { "format": "int32", "description": "Number of days for which the voucher will be valid.", "maximum": 300, "minimum": 1, "type": "integer", "example": 1 }, "IncludeDeliveryFee": { "description": "Discount will include delivery fee", "type": "boolean", "example": true }, "AutoApplyResultingVouchers": { "description": "Automatically apply resulting vouchers", "type": "boolean", "example": true }, "IncludeExistingOrders": { "description": "Campaign will apply to existing orders", "type": "boolean", "example": true }, "IsEnabled": { "description": "Is campaign enabled", "type": "boolean", "example": true }, "StoreIds": { "description": "Ids of stores this campaign applies to", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "AppId": { "description": "The app that this campaign belongs to.", "type": "string", "example": "500123" }, "ForceDiscount": { "description": "Controls whether the voucher generated from this campaign will override discount exclusions", "type": "boolean", "example": true } } }, "LoyaltyCampaignCreatedEvent": { "description": "Loyalty campaign created event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "LoyaltyCampaign": { "$ref": "#/components/schemas/LoyaltyCampaign" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "LoyaltyCampaignDeletedEvent": { "description": "Loyalty campaign deleted event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "LoyaltyCampaign": { "$ref": "#/components/schemas/LoyaltyCampaign" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "LoyaltyCampaignUpdatedEvent": { "description": "Loyalty campaign updated event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "LoyaltyCampaign": { "$ref": "#/components/schemas/LoyaltyCampaign" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "LumpDiscountDetails": { "description": "Lump discount details", "type": "object", "properties": { "DiscountAmount": { "format": "double", "description": "Discount amount", "type": "number", "example": 12.5 } } }, "MaskedPhoneNumber": { "description": "Represents a masked phone number", "type": "object", "properties": { "IsEnabled": { "description": "Defines if the feature is enabled", "type": "boolean", "example": true }, "PhoneNumber": { "description": "Defines the phone number to call", "type": "string", "example": "+353000000000" }, "Code": { "description": "Defines the code to enter", "type": "string", "example": "string" } } }, "Menu": { "description": "Menu", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "ModifiedTime": { "format": "date-time", "description": "Last modified time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "VersionNumber": { "format": "int32", "description": "Menu version", "type": "integer", "example": 3 }, "ImageName": { "description": "Image Name", "type": "string", "example": "Example Name" }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" }, "Name": { "description": "Name of Menu, only shown in portal", "type": "string", "example": "Example Name" }, "Locked": { "description": "Locked: is menu locked against modifcation", "type": "boolean", "example": true }, "MenuSections": { "description": "Menu sections (startes, main etc)", "type": "array", "items": { "$ref": "#/components/schemas/MenuSection" }, "example": [] }, "TaxRates": { "description": "Menu tax rates", "type": "array", "items": { "$ref": "#/components/schemas/MenuTaxRate" }, "example": [] }, "AppId": { "description": "Identifier of App the menu is attached to", "type": "string", "example": "500123" }, "DisplaySectionLinks": { "description": "Display menu section link on UI", "type": "boolean", "example": true }, "MenuSectionBehaviour": { "description": "Menu section behaviour", "enum": [ "ExpandSingle", "ExpandMultiple" ], "type": "string", "example": "ExpandSingle" }, "TaxType": { "description": "Tax type", "enum": [ "IncludedInBasePrice", "ExcludedFromBasePrice" ], "type": "string", "example": "IncludedInBasePrice" }, "IsIntegrated": { "description": "Flag to indicate if the menu is integrated (contains metadata)", "type": "boolean", "example": true } } }, "MenuAsyncCreationCompletedEvent": { "description": "Menu async creation completed event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Menu": { "$ref": "#/components/schemas/Menu" }, "Success": { "description": "Flag indicating if the menu creation was successful", "type": "boolean", "example": true }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuBulkEditEvent": { "description": "Menu bulk event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "MenuName": { "description": "Menu Name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Item": { "description": "Product", "type": "string", "example": "string" }, "InstanceCount": { "format": "int32", "description": "Quantity of product", "type": "integer", "example": 3 }, "IsAvailable": { "description": "Visibility of the item", "type": "boolean", "example": true }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "MenuId": { "format": "int32", "description": "The menu Id", "type": "integer", "example": 500123 }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuCheckpointCreatedEvent": { "description": "", "type": "object", "properties": { "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Menu": { "$ref": "#/components/schemas/Menu" }, "MenuId": { "format": "int32", "description": "Menu Id", "type": "integer", "example": 500123 }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuCreatedEvent": { "description": "Menu created event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Menu": { "$ref": "#/components/schemas/Menu" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuItemOptionSet": { "description": "Menu item option set", "type": "object", "properties": { "MenuItemOptionSetId": { "format": "int32", "description": "Menu item option set identifier", "type": "integer", "example": 500123 }, "ImageName": { "description": "Image Name", "type": "string", "example": "Example Name" }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" }, "MenuItemOptionSetItems": { "description": "Option set items", "type": "array", "items": { "$ref": "#/components/schemas/MenuItemOptionSetItem" }, "example": [] }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CatalogItemId": { "description": "Catalog item Id when the OptionSet is associated to a Product", "type": "string", "example": "500123" }, "Name": { "description": "Menu item option set name", "maxLength": 4000, "minLength": 0, "type": "string", "example": "Example Name" }, "IsMasterOptionSet": { "description": "Is master option set. This can affect the layout of the options in the menu displayed to the customer. Usually it is true if the option could be considerd a standalone item as opposed to an addition (\"with ketchup\") or modifier (\"large\").", "type": "boolean", "example": true }, "DisplayOrder": { "format": "int32", "description": "Display order. Displayed in ascending order.", "type": "integer", "example": 1 }, "MinSelectCount": { "format": "int32", "description": "Minimum items must be selected", "type": "integer", "example": 3 }, "MaxSelectCount": { "format": "int32", "description": "Maximum number of items can be selected", "type": "integer", "example": 3 }, "CellLayoutType": { "description": "Small | Medium | Large\r\nAffects the layout of the menu.", "enum": [ "Small", "Medium", "Large", "HiddenImage" ], "type": "string", "example": "Small" } } }, "MenuItemOptionSetCreatedEvent": { "description": "", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "MenuItemOptionSet": { "$ref": "#/components/schemas/MenuItemOptionSet" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuItemOptionSetDeletedEvent": { "description": "", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "MenuItemOptionSet": { "$ref": "#/components/schemas/MenuItemOptionSet" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuItemOptionSetItem": { "description": "Menu item option set item", "type": "object", "properties": { "MenuItemOptionSetItemId": { "format": "int32", "description": "Menu item option set item identifier", "type": "integer", "example": 500123 }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Metadata": { "description": "List of metadata", "type": "array", "items": { "$ref": "#/components/schemas/CreateMetadata" }, "example": [] }, "NextMenuItemOptionSetId": { "format": "int32", "description": "if null, next option set is next. if -1, this is the final option set", "type": "integer", "nullable": true, "example": 500123 }, "CatalogItemId": { "description": "Catalog item Id when the OptionSet is associated to a Product", "type": "string", "example": "500123" }, "TaxRateName": { "description": "Tax rate name", "type": "string", "example": "Example Name" }, "TaxRateId": { "format": "int32", "description": "TaxRateId.", "type": "integer", "nullable": true, "example": 500123 }, "TaxValue": { "format": "double", "description": "TaxValue.", "type": "number", "example": 1.0 }, "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "Price": { "format": "double", "description": "Price", "type": "number", "example": 12.5 }, "DepositReturnFee": { "format": "double", "description": "An optional fee that can be added to the price of the item.", "type": "number", "nullable": true, "example": 12.5 }, "IsAvailable": { "description": "Is available", "type": "boolean", "example": true }, "DisplayOrder": { "format": "int32", "description": "Display order. Displayed in ascending order.", "type": "integer", "example": 1 }, "CellLayoutType": { "description": "Small | Medium | Large\r\nAffects the layout of the menu.", "enum": [ "Small", "Medium", "Large", "HiddenImage" ], "type": "string", "example": "Small" }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" } } }, "MenuItemOptionSetItemCreatedEvent": { "description": "", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "MenuItemOptionSetItem": { "$ref": "#/components/schemas/MenuItemOptionSetItem" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuItemOptionSetItemDeletedEvent": { "description": "", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "MenuItemOptionSetItem": { "$ref": "#/components/schemas/MenuItemOptionSetItem" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuItemOptionSetItemUpdatedEvent": { "description": "", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "MenuItemOptionSetItem": { "$ref": "#/components/schemas/MenuItemOptionSetItem" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuItemOptionSetUpdatedEvent": { "description": "", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "MenuItemOptionSet": { "$ref": "#/components/schemas/MenuItemOptionSet" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuSection": { "description": "Menu section", "type": "object", "properties": { "MenuSectionId": { "format": "int32", "description": "Menu section identifier", "type": "integer", "example": 500123 }, "MenuItems": { "description": "Menu items", "type": "array", "items": { "$ref": "#/components/schemas/MenuSectionItem" }, "example": [] }, "MenuSectionAvailability": { "$ref": "#/components/schemas/MenuSectionAvailability" }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ImageName": { "description": "Image Name", "type": "string", "example": "Example Name" }, "Name": { "description": "Name", "maxLength": 4000, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "maxLength": 4000, "minLength": 0, "type": "string", "example": "string" }, "DisplayOrder": { "format": "int32", "description": "Display order", "type": "integer", "example": 1 }, "IsAvailable": { "description": "Is available", "type": "boolean", "example": true }, "IsHiddenFromCustomers": { "description": "Is hidden from customer. Perhaps when the item is out of stock.", "type": "boolean", "example": true }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" } } }, "MenuSectionAvailability": { "description": "Menu section availability", "type": "object", "properties": { "AvailableTimes": { "description": "Available times", "type": "array", "items": { "$ref": "#/components/schemas/BusinessHoursPeriod" }, "example": [] }, "AvailabilityMode": { "description": "Availability mode", "enum": [ "DisplayAlways", "DisplayBasedOnTimes", "DisplayAlwaysStartCollapsed", "DisplayAlwaysStartCollapsedBasedOnTimes" ], "type": "string", "nullable": true, "example": "DisplayAlways" } } }, "MenuSectionCreatedEvent": { "description": "", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "MenuSection": { "$ref": "#/components/schemas/MenuSection" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuSectionDeletedEvent": { "description": "", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "MenuSection": { "$ref": "#/components/schemas/MenuSection" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuSectionItem": { "description": "Menu item", "type": "object", "properties": { "ActualPrice": { "format": "double", "description": "Actual price - the minimum price possible when all required option set items prices are included.", "type": "number", "example": 12.5 }, "MenuItemOptionSets": { "description": "Menu item option sets", "type": "array", "items": { "$ref": "#/components/schemas/MenuItemOptionSet" }, "example": [] }, "DailySpecialHours": { "description": "Daily special hours", "type": "array", "items": { "$ref": "#/components/schemas/BusinessHoursPeriod" }, "example": [] }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "TaxRateName": { "description": "Tax rate name", "type": "string", "example": "Example Name" }, "TaxRateId": { "format": "int32", "description": "TaxRate", "type": "integer", "nullable": true, "example": 500123 }, "TaxValue": { "format": "double", "description": "TaxValue - the tax associated with this item, based on TaxRate / TaxType and Currency (currency determines decimal point precision)", "type": "number", "example": 1.0 }, "ExcludeFromVoucherDiscounting": { "description": "If true, the item is excluded from voucher discount calculations", "type": "boolean", "example": true }, "Metadata": { "description": "List of metadata", "type": "array", "items": { "$ref": "#/components/schemas/CreateMetadata" }, "example": [] }, "CatalogItemId": { "description": "Catalog item Id when the Item is associated to a Product", "type": "string", "example": "500123" }, "Name": { "description": "Menu item name (like \"Korma\")", "maxLength": 4000, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Description (like \"A lovely dish from the east\")", "maxLength": 4000, "minLength": 0, "type": "string", "example": "string" }, "SpicinessRating": { "description": "Spiciness rating", "enum": [ "NotRated", "Mild", "Medium", "Hot" ], "type": "string", "example": "NotRated" }, "Price": { "format": "double", "description": "Price - this is only used when there is no master option set and should be set to 0 if a master option set exists.", "type": "number", "example": 12.5 }, "DepositReturnFee": { "format": "double", "description": "An optional fee that can be added to the price of the item.", "type": "number", "nullable": true, "example": 12.5 }, "DisplayOrder": { "format": "int32", "description": "Display order", "type": "integer", "example": 1 }, "Alcohol": { "description": "To be set true if the item or an option of the item contains an alcoholic drink.", "type": "boolean", "example": true }, "IsAvailable": { "description": "True if we accept orders for this item still", "type": "boolean", "example": true }, "CellLayoutType": { "description": "Small | Medium | Large\r\nAffects the layout of the menu.", "enum": [ "Small", "Medium", "Large", "HiddenImage" ], "type": "string", "example": "Small" }, "DisableVouchers": { "description": "If true, then vouchers won't be applied for this item", "type": "boolean", "example": true }, "ImageName": { "description": "Image url", "type": "string", "example": "Example Name" }, "ImageUrl": { "description": "Image url", "type": "string", "example": "https://api.flipdish.co/example" }, "MenuItemId": { "format": "int32", "description": "Menu Item Id", "type": "integer", "example": 500123 } } }, "MenuSectionItemCreatedEvent": { "description": "", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "MenuSectionItem": { "$ref": "#/components/schemas/MenuSectionItem" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuSectionItemDeletedEvent": { "description": "", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "Description": { "description": "Event description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "MenuSectionItem": { "$ref": "#/components/schemas/MenuSectionItem" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuSectionItemUpdatedEvent": { "description": "", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "Description": { "description": "Event description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "MenuSectionItem": { "$ref": "#/components/schemas/MenuSectionItem" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuSectionUpdatedEvent": { "description": "", "type": "object", "properties": { "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "Description": { "description": "Event description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "MenuSection": { "$ref": "#/components/schemas/MenuSection" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuTaxRate": { "description": "Tax Rates Associated with a Menu", "type": "object", "properties": { "TaxRateId": { "format": "int32", "description": "Id of Tax Rate", "type": "integer", "example": 500123 }, "Name": { "description": "Name of Tax Rate", "maxLength": 2048, "minLength": 0, "type": "string", "example": "Example Name" }, "Rate": { "format": "double", "description": "In Percentage", "type": "number", "example": 1.0 } } }, "MenuUpdatedEvent": { "description": "Menu updated event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Menu": { "$ref": "#/components/schemas/Menu" }, "MenuId": { "format": "int32", "description": "Menu Id", "type": "integer", "example": 500123 }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MenuUploadedEvent": { "description": "Menu uploaded event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Menu": { "$ref": "#/components/schemas/Menu" }, "InstanceEventCount": { "description": "Quantity of events", "type": "string", "example": "string" }, "MenuId": { "format": "int32", "description": "The menu Id", "type": "integer", "example": 500123 }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "Metafield": { "description": "Metafield", "required": [ "Key", "Value" ], "type": "object", "properties": { "Key": { "description": "Key of the metafield.\r\nAllowed characters: lowercase letters, numbers, hyphen, underscore and dot", "type": "string", "example": "string" }, "Value": { "description": "Value of the metafield.", "type": "string", "example": "string" } } }, "MobileAppsSubmissionStatus": { "description": "Mobile Apps Status", "type": "object", "properties": { "MobileAppsSubmissionStatusId": { "format": "int32", "description": "Mobile Apps Submission Status Id", "type": "integer", "example": 500123 }, "MobileAppsSubmissionId": { "format": "int32", "description": "Mobile Apps Submission Id", "type": "integer", "example": 500123 }, "Type": { "description": "Mobile Type", "enum": [ "None", "Android", "IOS" ], "type": "string", "example": "None" }, "AppStatus": { "description": "Mobile App Status", "enum": [ "None", "Published", "Unpublished" ], "type": "string", "example": "None" }, "UpdateStatus": { "description": "Mobile App Status", "enum": [ "None", "Submitted", "InReview", "Rejected", "Approved", "Published" ], "type": "string", "example": "None" }, "LastUpdateStatusTime": { "format": "date-time", "description": "Mobile LastUpdateStatusTime", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "CreateTime": { "format": "date-time", "description": "Mobile CreateTime", "type": "string", "example": "2026-06-02T12:00:00Z" }, "UpdateTime": { "format": "date-time", "description": "Mobile UpdateTime", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "Notes": { "description": "Mobile Notes", "type": "string", "example": "string" } } }, "MobileAppsSubmissionStatusUpdatedEvent": { "description": "Mobile Apps event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "MobileAppsSubmissionStatus": { "$ref": "#/components/schemas/MobileAppsSubmissionStatus" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "MobileAppsSubmissionUpdatedEvent": { "description": "Mobile Apps event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "OAuthApp": { "description": "Oauth client (also knowns as 'app')", "type": "object", "properties": { "OauthAppId": { "description": "OAuth App Identifier", "type": "string", "example": "500123" }, "OauthAppName": { "description": "OAuth App Name", "type": "string", "example": "Example Name" }, "OwnerUserId": { "format": "int32", "description": "OAuth App owner user identifier", "type": "integer", "example": 500123 }, "LogoUri": { "description": "OAuth App logo uri", "type": "string", "example": "https://api.flipdish.co/example" }, "Flow": { "description": "Supported OpenID Connect flows", "enum": [ "AuthorizationCode", "Implicit", "Hybrid", "ClientCredentials" ], "type": "string", "nullable": true, "example": "AuthorizationCode" }, "RefreshTokenUsage": { "description": "ReUse: the refresh token handle will stay the same when refreshing tokens \r\nOneTime: the refresh token handle will be updated when refreshing tokens", "enum": [ "ReUse", "OneTimeOnly" ], "type": "string", "nullable": true, "example": "ReUse" }, "AccessTokenLifetime": { "format": "int32", "description": "Timem it takes for the IdentityToken to expire in seconds", "type": "integer", "nullable": true, "example": 1 }, "AbsoluteRefreshTokenLifetime": { "format": "int32", "description": "Maximum lifetime of a refresh token in seconds", "type": "integer", "nullable": true, "example": 1 } }, "example": { "OauthAppId": "6364835077453070787486", "OauthAppName": "My OAuth App", "OwnerUserId": 12345, "LogoUri": "https://domain.com/mylogo.png", "Flow": 2, "AccessTokenLifetime": 3600, "AbsoluteRefreshTokenLifetime": 2592000 } }, "OAuthTokenModel": { "description": "OAuth token model", "type": "object", "properties": { "Key": { "description": "Identitifier key", "type": "string", "example": "string" }, "TokenType": { "description": "Token type", "type": "string", "example": "string" }, "SubjectId": { "description": "Oauth subject identifier", "type": "string", "example": "500123" }, "ClientId": { "description": "Oauth client identifier", "type": "string", "example": "500123" }, "Expiry": { "format": "date-time", "description": "Token expiry", "type": "string", "example": "2026-06-02T12:00:00Z" } } }, "OauthClientRedirectUri": { "description": "OAuth client redirect uri", "type": "object", "properties": { "Id": { "format": "int32", "description": "Redirect uri identifier", "type": "integer", "example": 500123 }, "Uri": { "description": "Redirect uri", "type": "string", "example": "https://api.flipdish.co/example" } } }, "OktaPortalFeatureFlag": { "description": "Okta Portal Feature Flag Value", "type": "object", "properties": { "OktaPortalEnabled": { "description": "Feature flag backend_portal_enableOktaWebApi value", "type": "boolean", "example": true } } }, "Order": { "description": "Order", "type": "object", "properties": { "Store": { "$ref": "#/components/schemas/StoreSummary" }, "Customer": { "$ref": "#/components/schemas/CustomerSummary" }, "Voucher": { "$ref": "#/components/schemas/OrderVoucherSummary" }, "Fees": { "$ref": "#/components/schemas/FeeSummary" }, "OrderItems": { "description": "Ordered items", "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" }, "example": [] }, "DeliveryLocation": { "$ref": "#/components/schemas/DeliveryLocation" }, "CustomerLocation": { "$ref": "#/components/schemas/Coordinates" }, "MaskedPhoneNumber": { "$ref": "#/components/schemas/MaskedPhoneNumber" }, "DropOffLocationId": { "format": "int32", "description": "Represents table service drop off location", "type": "integer", "nullable": true, "example": 500123 }, "DropOffLocation": { "description": "Represents table service drop off location", "type": "string", "example": "string" }, "AcceptedFor": { "format": "date-time", "description": "Time store has accepted the order for", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "InFraudZone": { "description": "Was order made within a fraud zone", "type": "boolean", "example": true }, "UnusualHighValueOrder": { "description": "Is order of unusually high value", "type": "boolean", "example": true }, "RejectedByUserId": { "format": "int32", "description": "Id of user who rejected order, if available", "type": "integer", "nullable": true, "example": 500123 }, "ChannelOrderId": { "description": "ChannelOrderId from external channel", "type": "string", "example": "500123" }, "ChannelOrderDisplayId": { "description": "ChannelOrderDisplayId from external channel", "type": "string", "example": "500123" }, "Channel": { "$ref": "#/components/schemas/Channel" }, "OrderDropOffLocation": { "$ref": "#/components/schemas/OrderDropOffLocation" }, "FulfillmentStatus": { "$ref": "#/components/schemas/OrderFulfillmentStatusBase" }, "OrderBatchInfo": { "$ref": "#/components/schemas/OrderBatchSummary" }, "TaxItems": { "description": "A collection of tax items on the order.", "type": "array", "items": { "$ref": "#/components/schemas/TaxItem" }, "example": [] }, "CreatedCampaignVoucherId": { "format": "int32", "description": "The id of the campaign voucher that was created from this order", "type": "integer", "nullable": true, "example": 500123 }, "OrderId": { "format": "int32", "description": "Order identifier", "type": "integer", "example": 500123 }, "LocalOrderId": { "description": "Local order Id. This is used for displaying a \"shorter\" order ID for customers (eg. Kiosk orders)", "type": "string", "example": "500123" }, "DeliveryType": { "description": "Delivery type", "enum": [ "Delivery", "Pickup" ], "type": "string", "example": "Delivery" }, "PickupLocationType": { "description": "Pickup location type", "enum": [ "TakeOut", "TableService", "DineIn" ], "type": "string", "example": "TakeOut" }, "TableServiceCatagory": { "description": "Pickup location type", "enum": [ "Generic", "Villa", "House", "Room", "Area", "Table", "ParkingBay", "Gate", "DriveThrough", "Team" ], "type": "string", "nullable": true, "example": "Generic" }, "TipAmount": { "format": "double", "description": "Tip amount", "type": "number", "example": 12.5 }, "DeliveryAmount": { "format": "double", "description": "Delivery amount", "type": "number", "example": 12.5 }, "OrderItemsAmount": { "format": "double", "description": "Ordered items amount", "type": "number", "example": 12.5 }, "ServiceChargeAmount": { "format": "double", "description": "Service Charge Amount", "type": "number", "example": 12.5 }, "ServiceChargePercentage": { "format": "double", "description": "Service Charge Percentage", "type": "number", "example": 1.0 }, "Amount": { "format": "double", "description": "This is the sum of the OrderItemsAmount, DeliveryAmount, TipAmount and Voucher.Amount (which is usually negative) and OnlineOrderingFee for cash orders.\r\nIt does not include the OnlineOrderingFee in the case of card orders as this fee is charged by Flipdish directly to the customer.", "type": "number", "example": 12.5 }, "ProcessingFee": { "format": "double", "description": "This contains the online ordering processing fee. For card payments this is charged directly to the customer and for cash orders it is paid by the customer to the store. It is tax inclusive.", "type": "number", "example": 12.5 }, "PaymentAccountType": { "description": "Payment account type", "enum": [ "Card", "Cash", "Ideal", "Bancontact", "Giropay", "Eps", "Emv", "PayPal", "PayGreen", "GoogleWalletToken" ], "type": "string", "example": "Card" }, "PaymentAccountDescription": { "description": "Payment account description (like Visa ****2371 or Apple Pay. or Cash)", "type": "string", "example": "string" }, "OrderState": { "description": "Order state", "enum": [ "Created", "PlacedCanBeCancelled", "ReadyToProcess", "AcceptedByRestaurant", "Dispatched", "Delivered", "Cancelled", "ManualReview", "RejectedByStore", "RejectedByFlipdish", "RejectedAutomatically", "RejectedAfterBeingAccepted", "AcceptedAndRefunded", "PendingPayment" ], "type": "string", "example": "Created" }, "IsPreOrder": { "description": "Is pre-order", "type": "boolean", "example": true }, "PlacedTime": { "format": "date-time", "description": "Order placed time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "RequestedForTime": { "format": "date-time", "description": "Order requested for", "type": "string", "example": "2026-06-02T12:00:00Z" }, "ChefNote": { "description": "Chef note", "type": "string", "example": "string" }, "AppType": { "description": "Used app type", "enum": [ "Unknown", "Ios", "Android", "Web", "Kiosk", "Pos", "TelephoneCall", "Sms", "PwaAndroid", "PwaIos", "Google" ], "type": "string", "example": "Unknown" }, "UserRating": { "format": "int32", "description": "User rating", "type": "integer", "nullable": true, "example": 1 }, "PaymentStatus": { "description": "Status of the payment", "enum": [ "Paid", "Unpaid", "Refunded", "PartiallyRefunded", "Disputed" ], "type": "string", "example": "Paid" }, "RejectionReason": { "description": "Rejection reason. Can have value if the order is rejected.", "enum": [ "TooBusy", "FoodUnavailable", "UnableToDeliver", "UnknownAddress", "UnknownReason", "TooSoon", "TimeUnavailable", "DontDeliverToArea", "StoreUncontactable" ], "type": "string", "nullable": true, "example": "TooBusy" }, "RefundedAmount": { "format": "double", "description": "Amount refunded to customer.", "type": "number", "nullable": true, "example": 12.5 }, "DeliveryTrackingStatus": { "description": "Delivery tracking status", "enum": [ "Unassigned", "Unaccepted", "Accepted", "Carrying", "OnTheWay", "ArrivedAtLocation", "Delivered", "CannotDeliver" ], "type": "string", "nullable": true, "example": "Unassigned" }, "DriverId": { "format": "int32", "description": "Assigned driver identifier", "type": "integer", "nullable": true, "example": 500123 }, "TotalTax": { "format": "double", "description": "Total tax applied to order", "type": "number", "example": 12.5 }, "OrderTrackingCode": { "description": "Unique, 6 character long alpha numeric code for tracking.", "type": "string", "example": "string" }, "DeliveryFeeAreaId": { "format": "int32", "description": "Delivery area identifier", "type": "integer", "nullable": true, "example": 500123 }, "ReceiptCode": { "description": "Code used to view the order's receipt", "type": "string", "example": "string" }, "TotalDepositReturnFeeAmount": { "format": "double", "description": "This contains the total deposit return fee amount for the order.", "type": "number", "example": 12.5 } } }, "OrderAcceptedEvent": { "description": "Order Accepted Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "OrderAcceptedTime": { "format": "date-time", "description": "Order Accepted Time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Order": { "$ref": "#/components/schemas/Order" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "OrderBatchPublishedEvent": { "description": "Order Batch Published Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "OrderBatchId": { "format": "int32", "description": "Order Batch Id", "type": "integer", "example": 500123 }, "StoreId": { "format": "int32", "description": "Store id the order batch belogs to", "type": "integer", "example": 500123 }, "OrderIds": { "description": "Orders' ids on the batch", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "OrderBatchSummary": { "description": "Order batch info", "type": "object", "properties": { "Id": { "format": "int32", "description": "Order batch id", "type": "integer", "example": 500123 }, "DisplayCode": { "description": "Order batch 6-sign human readable code", "type": "string", "example": "string" }, "CreateTime": { "format": "date-time", "description": "Batch creation date and time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "IsPublished": { "description": "If the batch is already published", "type": "boolean", "example": true } } }, "OrderCapacityConfigUpdatedEvent": { "description": "Store's Order Capacity Configuration Updated", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Id of the store whose order capacity configuration has been updated", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "OrderCapacityConfig": { "$ref": "#/components/schemas/StoreOrderCapacityConfigEditModel" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "OrderCreatedEvent": { "description": "Order Created Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "OrderCreatedTime": { "format": "date-time", "description": "Order Created Time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Order": { "$ref": "#/components/schemas/Order" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "OrderCustomerTrackingCreatedEvent": { "description": "", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Order": { "$ref": "#/components/schemas/CustomerDeliveryTrackingOrder" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "OrderDeliveryTrackingStatusUpdatedEvent": { "description": "", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Order": { "$ref": "#/components/schemas/Order" }, "DeliveryIntegrationName": { "description": "Delivery integration name", "type": "string", "example": "Example Name" }, "DeliveryErrorMessage": { "description": "Delivery error message (optional)", "type": "string", "example": "string" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "OrderDispatchedEvent": { "description": "Order Dispatched Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "OrderDispatchedTime": { "format": "date-time", "description": "Order Rejected Time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Order": { "$ref": "#/components/schemas/Order" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "OrderDropOffLocation": { "description": "OrderDropOffLocation.", "type": "object", "properties": { "OrderId": { "format": "int32", "description": "OrderId.", "type": "integer", "example": 500123 }, "LocationName": { "description": "LocationName.", "type": "string", "example": "Example Name" }, "LocationAreaName": { "description": "LocationAreaName.", "type": "string", "example": "Example Name" }, "LocationId": { "format": "int32", "description": "LocationId.", "type": "integer", "example": 500123 }, "LocationAreaId": { "format": "int32", "description": "LocationAreaId.", "type": "integer", "example": 500123 }, "ExternalLocationId": { "description": "ExternalLocationId.", "type": "string", "example": "500123" } } }, "OrderFulfillmentStatusBase": { "description": "Fulfillment Status Information", "type": "object", "properties": { "StatusId": { "description": "Fulfillment Status Id", "type": "string", "example": "500123" }, "StatusName": { "description": "Fulfillment Status Name", "type": "string", "example": "Example Name" }, "Icon": { "description": "Status Icon", "type": "string", "example": "string" } } }, "OrderFulfillmentStatusUpdatedEvent": { "description": "Fulfillment status updated event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "Description": { "description": "Description", "type": "string", "example": "string" }, "OrderId": { "format": "int32", "description": "Order Id", "type": "integer", "nullable": true, "example": 500123 }, "StatusName": { "description": "Fulfillment status name", "type": "string", "example": "Example Name" }, "StatusId": { "description": "Fulfillment status ID", "type": "string", "example": "500123" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "OrderItem": { "description": "Order item", "type": "object", "properties": { "OrderItemOptions": { "description": "Option list", "type": "array", "items": { "$ref": "#/components/schemas/OrderItemOption" }, "example": [] }, "Metadata": { "description": "Metadata", "type": "object", "additionalProperties": { "type": "string" } }, "MenuItemPublicId": { "format": "uuid", "description": "Public id of the Menu Item", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "MenuSectionName": { "description": "Menu section name", "type": "string", "example": "Example Name" }, "MenuSectionDisplayOrder": { "format": "int32", "description": "Menu section display order", "type": "integer", "example": 1 }, "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Price": { "format": "double", "description": "Price", "type": "number", "example": 12.5 }, "TaxAmount": { "format": "double", "description": "Tax currency amount", "type": "number", "example": 12.5 }, "PriceIncludingOptionSetItems": { "format": "double", "description": "Price including option set items", "type": "number", "example": 12.5 }, "MenuItemId": { "format": "int32", "description": "Menu item identifier", "type": "integer", "example": 500123 }, "MenuItemDisplayOrder": { "format": "int32", "description": "Menu item display order", "type": "integer", "example": 1 }, "IsAvailable": { "description": "Is available", "type": "boolean", "example": true }, "DepositReturnFee": { "format": "double", "description": "Deposit return fee", "type": "number", "nullable": true, "example": 12.5 } } }, "OrderItemOption": { "description": "Order item option", "type": "object", "properties": { "Metadata": { "description": "Metadata", "type": "object", "additionalProperties": { "type": "string" } }, "MenuItemOptionPublicId": { "format": "uuid", "description": "Public id of the Menu Item Option", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "MenuItemOptionId": { "format": "int32", "description": "Menu item option identifier", "type": "integer", "example": 500123 }, "IsMasterOptionSetItem": { "description": "Is master option set item", "type": "boolean", "example": true }, "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "Price": { "format": "double", "description": "Price", "type": "number", "example": 12.5 }, "TaxAmount": { "format": "double", "description": "Tax currency amount", "type": "number", "example": 12.5 }, "MenuItemOptionDisplayOrder": { "format": "int32", "description": "Menu item option display order", "type": "integer", "example": 1 }, "MenuItemOptionSetDisplayOrder": { "format": "int32", "description": "Menu item option set display order", "type": "integer", "example": 1 }, "DepositReturnFee": { "format": "double", "description": "Deposit return fee", "type": "number", "nullable": true, "example": 12.5 } } }, "OrderRatingUpdatedEvent": { "description": "Order Rating Update Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Rating": { "format": "int32", "description": "New User Rating", "type": "integer", "nullable": true, "example": 1 }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Order": { "$ref": "#/components/schemas/Order" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "OrderRefundedEvent": { "description": "Order Refunded Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "RefundedAmount": { "format": "double", "description": "The amount refunded", "type": "number", "example": 12.5 }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Order": { "$ref": "#/components/schemas/Order" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "OrderRejectedEvent": { "description": "Order Rejected Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "OrderRejectedTime": { "format": "date-time", "description": "Order Rejected Time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Reason": { "description": "Reason for Rejection", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Order": { "$ref": "#/components/schemas/Order" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "OrderTipUpdatedEvent": { "description": "Order Tip Update Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "TipAmount": { "format": "double", "description": "Tip Amount", "type": "number", "example": 12.5 }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Order": { "$ref": "#/components/schemas/Order" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "OrderVoucherSummary": { "description": "Voucher summary", "type": "object", "properties": { "VoucherId": { "format": "int32", "description": "Voucher ID", "type": "integer", "example": 500123 }, "Name": { "description": "Voucher name", "type": "string", "example": "Example Name" }, "Description": { "description": "Voucher description", "type": "string", "example": "string" }, "Code": { "description": "Voucher code", "type": "string", "example": "string" }, "Amount": { "format": "double", "description": "Voucher amount", "type": "number", "example": 12.5 }, "Type": { "description": "Voucher type", "enum": [ "PercentageDiscount", "LumpDiscount", "AddItem", "CreditNote", "FreeDelivery" ], "type": "string", "example": "PercentageDiscount" }, "SubType": { "description": "Voucher sub type", "enum": [ "None", "SignUp", "Loyalty", "Loyalty25", "Retention", "SecondaryRetention", "Custom" ], "type": "string", "example": "None" } } }, "PaymentTerminalDetails": { "description": "Details of Payment Terminal", "type": "object", "properties": { "TerminalId": { "description": "Terminal Id (tid)", "type": "string", "example": "500123" }, "Status": { "description": "Status of Terminal", "type": "string", "example": "Active" }, "Currency": { "description": "Currency configured on the terminal", "type": "string", "example": "EUR" }, "Uri": { "description": "Location to Device", "type": "string", "example": "https://api.flipdish.co/example" } } }, "PaymentTerminalTransactionDetails": { "description": "Details of Payment Terminal Transaction", "type": "object", "properties": { "CardSchemeName": { "description": "Card Type", "type": "string", "example": "Example Name" }, "DateOfExpiry": { "description": "Expirey Date on Card", "type": "string", "example": "2026-06-02T12:00:00Z" }, "AuthCode": { "description": "AuthCode", "type": "string", "example": "string" }, "TransactionResult": { "description": "State of Request, \"PENDING\" is not yet completed", "type": "string", "example": "string" }, "PrimaryAccountNumber": { "description": "Masked PAN", "type": "string", "example": "string" }, "CardholderVerificationMethod": { "description": "Type of Verification.", "type": "string", "example": "string" } } }, "PercentDiscountDetails": { "description": "Percent discount details", "type": "object", "properties": { "PercentageDiscount": { "format": "int32", "description": "Percentage discount", "type": "integer", "example": 3 }, "MaxDiscountAmount": { "format": "double", "description": "The maximum amount that the percentage discount value can be.\r\nIf not set then there is no maximum.\r\nIf set to e.g. 20 euro, and the percentage discount is 25%, and the order total is 100 euro, then the discount will be 20 euro (not 25 euro).", "type": "number", "nullable": true, "example": 12.5 } } }, "PhoneCall": { "description": "Phone call", "type": "object", "properties": { "PhoneCallId": { "format": "int32", "description": "Phone call id", "type": "integer", "example": 500123 }, "CallSid": { "description": "Twilio Call SID", "type": "string", "example": "500123" }, "TimeOfCall": { "format": "date-time", "description": "Time of the call", "type": "string", "example": "2026-06-02T12:00:00Z" }, "TimeOfCallLocal": { "format": "date-time", "description": "Time of the call, local to the store to which the call was made", "type": "string", "example": "2026-06-02T12:00:00Z" }, "StoreId": { "format": "int32", "description": "ID of the store that the call was TO", "type": "integer", "example": 500123 }, "StoreName": { "description": "Name of the store that the call was TO", "type": "string", "example": "Example Name" }, "CallerName": { "description": "Name of the caller", "type": "string", "example": "Example Name" }, "CallerUserId": { "format": "int32", "description": "UserID of the caller", "type": "integer", "example": 500123 }, "CallerNumber": { "description": "Phone number of the caller", "type": "string", "example": "string" }, "CallLengthInSeconds": { "format": "int32", "description": "The amount of time the call took", "type": "integer", "example": 1 }, "CallStatus": { "description": "The status of the call", "enum": [ "Queued", "Ringing", "InProgress", "Completed", "Failed", "Busy", "NoAnswer", "Unknown", "Canceled" ], "type": "string", "example": "Queued" } } }, "PhoneCallEndedEvent": { "description": "Phone call ended event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "PhoneCall": { "$ref": "#/components/schemas/PhoneCall" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "PhoneCallStartedEvent": { "description": "Phone call started event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "PhoneCall": { "$ref": "#/components/schemas/PhoneCall" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "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 } } }, "Printer": { "description": "Printer", "type": "object", "properties": { "SerialNumber": { "description": "Unique serial number of the printer", "type": "string", "example": "string" }, "LastPollTime": { "format": "date-time", "description": "Date and time when the printer last polled Flipdish for new orders.", "type": "string", "example": "2026-06-02T12:00:00Z" } } }, "PrinterAssignedToStoreEvent": { "description": "Printer assigned to store event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Printer": { "$ref": "#/components/schemas/Printer" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "PrinterTurnedOffEvent": { "description": "Printer turned off event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Printer": { "$ref": "#/components/schemas/Printer" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "PrinterTurnedOnEvent": { "description": "Printer turned on event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Printer": { "$ref": "#/components/schemas/Printer" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "PrinterUnassignedFromStoreEvent": { "description": "Printer assigned from store event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Printer": { "$ref": "#/components/schemas/Printer" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "Product": { "description": "Product", "required": [ "ProductType", "Sku", "Name", "Price" ], "type": "object", "properties": { "CatalogItemId": { "description": "Unique catalog Item id", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "IsArchived": { "description": "Returns true if the item is archived", "type": "boolean", "example": true }, "Groups": { "description": "Collection of groups associated with this item", "type": "array", "items": { "$ref": "#/components/schemas/GroupReference" }, "example": [] }, "Metafields": { "description": "Collection of metafields", "type": "array", "items": { "$ref": "#/components/schemas/Metafield" }, "example": [] }, "ProductType": { "description": "Type of item (Product, Modifier, etc)", "enum": [ "Product", "Modifier" ], "type": "string", "example": "Product" }, "Sku": { "description": "Stock Keeping Unit (SKU)", "maxLength": 30, "minLength": 0, "type": "string", "example": "string" }, "Name": { "description": "Product name", "maxLength": 300, "minLength": 0, "type": "string", "example": "Example Name" }, "Description": { "description": "Product description", "maxLength": 3000, "minLength": 0, "type": "string", "example": "string" }, "Price": { "format": "double", "description": "Product price", "minimum": 0, "type": "number", "example": 12.5 }, "ImageFileName": { "description": "Image File Name", "maxLength": 512, "minLength": 0, "type": "string", "example": "Example Name" }, "Alcohol": { "description": "Product contains alcohol", "type": "boolean", "example": true } } }, "ProductReference": { "description": "Catalog Item associated", "required": [ "CatalogItemId", "ProductType" ], "type": "object", "properties": { "Item": { "$ref": "#/components/schemas/Product" }, "Product": { "$ref": "#/components/schemas/Product" }, "CatalogItemId": { "description": "Identifier of the CatalogItemId to use as SubProduct", "maxLength": 30, "minLength": 0, "type": "string", "example": "500123" }, "ProductType": { "description": "Type of the SupProduct", "enum": [ "Product", "Modifier" ], "type": "string", "example": "Product" }, "PreselectedQuantity": { "format": "int32", "description": "Quantity of the modifier that will be set when the parent product is placed in the basket", "type": "integer", "example": 3 } } }, "PromotionAward": { "description": "Promotion", "type": "object", "properties": { "PromotionAwardId": { "format": "int32", "description": "Promotion Award Id", "type": "integer", "example": 500123 }, "MenuItemPublicId": { "format": "uuid", "description": "The public id of the menu item that will be awarded", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "PromotionDetails": { "description": "Promotion", "type": "object", "properties": { "PromotionId": { "format": "int32", "description": "Promotion Id", "type": "integer", "example": 500123 }, "Name": { "description": "The name of the promotion", "type": "string", "example": "Example Name" }, "PromotionAwards": { "description": "The items that this promotion will award", "type": "array", "items": { "$ref": "#/components/schemas/PromotionAward" }, "example": [] } } }, "PushNotificationDeletedEvent": { "description": "", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "", "type": "string", "example": "string" }, "PushNotification": { "$ref": "#/components/schemas/PushNotificationRequest" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "PushNotificationRequest": { "description": "Push Notification Details", "required": [ "Message" ], "type": "object", "properties": { "ScheduledTime": { "format": "date-time", "description": "UTC Time at which to send the push notification", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Title": { "description": "Title of the notification", "type": "string", "example": "string" }, "Message": { "description": "Message of the notification", "type": "string", "example": "string" } } }, "PushNotificationScheduledEvent": { "description": "", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "", "type": "string", "example": "string" }, "PushNotification": { "$ref": "#/components/schemas/PushNotificationRequest" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "PushNotificationSentEvent": { "description": "", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "PushNotification": { "$ref": "#/components/schemas/PushNotificationRequest" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "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_ApmCurrencyDataPoint_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/ApmCurrencyDataPoint" }, "example": [] } } }, "RestApiArrayResult_ApmDataPoint_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/ApmDataPoint" }, "example": [] } } }, "RestApiArrayResult_ApmHourlyDataPoint_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/ApmHourlyDataPoint" }, "example": [] } } }, "RestApiArrayResult_EmvTerminalWithAssignments_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/EmvTerminalWithAssignments" }, "example": [] } } }, "RestApiArrayResult_HomeAction_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/HomeAction" }, "example": [] } } }, "RestApiArrayResult_KioskCashPaymentSettings_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/KioskCashPaymentSettings" }, "example": [] } } }, "RestApiArrayResult_OAuthApp_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/OAuthApp" }, "example": [] } } }, "RestApiArrayResult_OauthClientRedirectUri_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/OauthClientRedirectUri" }, "example": [] } } }, "RestApiArrayResult_SmsProviderCredential_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/SmsProviderCredential" }, "example": [] } } }, "RestApiEventSearchPaginationResult": { "description": "", "required": [ "Data", "Page", "Limit", "TotalRecordCount" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EventSearchResult" }, "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 } } }, "RestApiIntegerResult": { "description": "Rest api integer result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "format": "int32", "description": "Data integer", "type": "integer", "example": 1 } } }, "RestApiPaginationResult_HydraDeviceDetails_": { "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/HydraDeviceDetails" }, "example": [] } } }, "RestApiPaginationResult_OAuthTokenModel_": { "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/OAuthTokenModel" }, "example": [] } } }, "RestApiPaginationResult_PhoneCall_": { "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/PhoneCall" }, "example": [] } } }, "RestApiPaginationResult_Restaurant_": { "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/Restaurant" }, "example": [] } } }, "RestApiPaginationResult_WebhookLog_": { "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/WebhookLog" }, "example": [] } } }, "RestApiPaginationResult_WebhookSubscription_": { "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/WebhookSubscription" }, "example": [] } } }, "RestApiResult_ApmStatistics_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ApmStatistics" } } }, "RestApiResult_ApmStatus_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ApmStatus" } } }, "RestApiResult_FileDownloadResult_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/FileDownloadResult" } } }, "RestApiResult_HomeStatistics_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/HomeStatistics" } } }, "RestApiResult_HydraConfig_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/HydraConfig" } } }, "RestApiResult_HydraDeviceDetails_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/HydraDeviceDetails" } } }, "RestApiResult_HydraStatus_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/HydraStatus" } } }, "RestApiResult_IntercomUserHash_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/IntercomUserHash" } } }, "RestApiResult_JobResponse_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/JobResponse" } } }, "RestApiResult_KioskSettings_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/KioskSettings" } } }, "RestApiResult_LightspeedSettings_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/LightspeedSettings" } } }, "RestApiResult_OAuthApp_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/OAuthApp" } } }, "RestApiResult_OauthClientRedirectUri_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/OauthClientRedirectUri" } } }, "RestApiResult_OktaPortalFeatureFlag_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/OktaPortalFeatureFlag" } } }, "RestApiResult_PaymentTerminalDetails_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/PaymentTerminalDetails" } } }, "RestApiResult_PaymentTerminalTransactionDetails_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/PaymentTerminalTransactionDetails" } } }, "RestApiResult_SmsProviderCredential_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/SmsProviderCredential" } } }, "RestApiResult_StuartSettings_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/StuartSettings" } } }, "RestApiStringArrayResult": { "description": "Rest api string array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Data string array", "type": "array", "items": { "type": "string" }, "example": [ "string" ] } } }, "RestApiStringResult": { "description": "Rest api string result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Data string", "type": "string", "example": "string" } } }, "Restaurant": { "description": "Restaurant search result", "type": "object", "properties": { "WhiteLabelConfigs": { "description": "Collection of white label configurations", "type": "array", "items": { "$ref": "#/components/schemas/WhiteLabelConfig" }, "example": [] }, "VirtualRestaurantId": { "format": "int32", "description": "Virtual restaurant identifier", "type": "integer", "example": 500123 }, "VirtualRestaurantName": { "description": "Virtual restaurant name", "type": "string", "example": "Example Name" }, "VirtualRestaurantUrl": { "description": "Virtual restaurant URL", "type": "string", "example": "https://api.flipdish.co/example" }, "PhysicalRestaurantId": { "format": "int32", "description": "Physical restaurant identifier", "type": "integer", "example": 500123 }, "PhysicalRestaurantName": { "description": "Physical restaurant name", "type": "string", "example": "Example Name" }, "PhysicalRestaurantAddress": { "description": "Physical restaurant address", "type": "string", "example": "string" }, "MenuId": { "format": "int32", "description": "Menu identifier", "type": "integer", "example": 500123 }, "IsArchived": { "description": "Indicates if the restaurant is archived", "type": "boolean", "example": true }, "IsPublished": { "description": "Indicates if the restaurant is published", "type": "boolean", "example": true }, "FlipdishStripeCustomConnectedAccounts": { "description": "List of Flipdish Stripe custom connected account identifiers", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 3 ] } } }, "RetentionCampaign": { "description": "Retention campaign", "type": "object", "properties": { "CampaignId": { "format": "int32", "description": "Id of campaign", "type": "integer", "example": 500123 }, "Statistics": { "$ref": "#/components/schemas/CampaignStatistics" }, "Stores": { "description": "Stores this campaign applies to with campaign start time in Utc", "type": "array", "items": { "$ref": "#/components/schemas/StoreCampaignStartTime" }, "example": [] }, "PublicId": { "format": "uuid", "description": "Permanent reference to the item.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "NotifyCustomerAfterMinutes": { "format": "int32", "description": "Time in minutes, after which customer will receive retention voucher if he/she does not order", "maximum": 2147483647, "minimum": 1440, "type": "integer", "example": 1 }, "PercentDiscountAmount": { "format": "int32", "description": "Discount amount in percents", "maximum": 100, "minimum": 1, "type": "integer", "nullable": true, "example": 12.5 }, "MaxDiscount": { "format": "double", "description": "Maximum discount for percentage discounts", "minimum": 0, "type": "number", "nullable": true, "example": 3 }, "LumpDiscountAmount": { "format": "double", "description": "Discount amount in sum of money", "maximum": 2147483647, "minimum": 0, "type": "number", "nullable": true, "example": 12.5 }, "VoucherValidPeriodDays": { "format": "int32", "description": "Number of days for which the voucher will be valid.", "maximum": 300, "minimum": 1, "type": "integer", "example": 1 }, "IncludeDeliveryFee": { "description": "Discount will include delivery fee", "type": "boolean", "example": true }, "AutoApplyResultingVouchers": { "description": "Automatically apply resulting vouchers", "type": "boolean", "example": true }, "IncludeExistingOrders": { "description": "Campaign will apply to existing orders", "type": "boolean", "example": true }, "IsEnabled": { "description": "Is campaign enabled", "type": "boolean", "example": true }, "StoreIds": { "description": "Ids of stores this campaign applies to", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "AppId": { "description": "The app that this campaign belongs to.", "type": "string", "example": "500123" }, "ForceDiscount": { "description": "Controls whether the voucher generated from this campaign will override discount exclusions", "type": "boolean", "example": true } } }, "RetentionCampaignCreatedEvent": { "description": "Retention campaign created event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "RetentionCampaign": { "$ref": "#/components/schemas/RetentionCampaign" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "RetentionCampaignDeletedEvent": { "description": "Retention campaign deleted event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "RetentionCampaign": { "$ref": "#/components/schemas/RetentionCampaign" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "RetentionCampaignUpdatedEvent": { "description": "Retention campaign updated event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "RetentionCampaign": { "$ref": "#/components/schemas/RetentionCampaign" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "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 } } }, "Setting": { "type": "object", "properties": { "Key": { "type": "string", "example": "string" }, "Value": { "type": "string", "example": "string" } } }, "SmsInfo": { "description": "Sms Info", "type": "object", "properties": { "From": { "description": "Origin phone number", "type": "string", "example": "string" }, "To": { "description": "Destination phone number", "type": "string", "example": "string" }, "Text": { "description": "Text message", "type": "string", "example": "string" } } }, "SmsProviderCredential": { "description": "SmsProviderCredential.", "type": "object", "properties": { "OrgId": { "description": "OrgId.", "type": "string", "example": "500123" }, "BrandId": { "description": "BrandId.", "type": "string", "example": "500123" }, "SmsServiceType": { "description": "SmsServiceType.", "enum": [ "Nexmo", "Twilio", "Default", "MessageBird" ], "type": "string", "example": "Nexmo" }, "SenderId": { "description": "SenderId.", "type": "string", "example": "500123" }, "Username": { "description": "Username.", "type": "string", "example": "Example Name" }, "AuthToken": { "description": "AuthToken.", "type": "string", "example": "string" } } }, "SmsProviderCredentialUpdateRequest": { "description": "SmsProviderCredentialUpdateRequest.", "type": "object", "properties": { "SenderId": { "description": "SenderId.", "type": "string", "example": "500123" }, "Username": { "description": "Username.", "type": "string", "example": "Example Name" }, "AuthToken": { "description": "AuthToken.", "type": "string", "example": "string" } } }, "SmsReceivedEvent": { "description": "Sms received event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "SmsInfo": { "$ref": "#/components/schemas/SmsInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StatisticsCurrencyDataPoint": { "description": "A single currency data point, with no date", "type": "object", "properties": { "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" }, "UserCount": { "format": "int32", "description": "Amount of users for this currency", "type": "integer", "example": 3 }, "OrderCount": { "format": "int32", "description": "Amount of orders for this currency", "type": "integer", "example": 3 }, "OrderValue": { "format": "double", "description": "Value of orders for this currency", "type": "number", "example": 1.0 } } }, "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" ] } } }, "StoreAddressUpdatedEvent": { "description": "Store Address Updated Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreAddress": { "$ref": "#/components/schemas/StoreAddress" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreArchivedEvent": { "description": "Store Archived Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "readOnly": true, "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Store": { "$ref": "#/components/schemas/Store" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreBusinessHoursOverrideCreatedEvent": { "description": "Store Business Hours Override Created", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "BusinessHoursOverride": { "$ref": "#/components/schemas/BusinessHoursOverride" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreBusinessHoursOverrideDeletedEvent": { "description": "Store Business Hours Override Deleted", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "BusinessHoursOverride": { "$ref": "#/components/schemas/BusinessHoursOverride" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreCampaignStartTime": { "description": "Store campaign start time", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "TsStart": { "format": "date-time", "description": "Campaign start time in Utc", "type": "string", "example": "2026-06-02T12:00:00Z" } } }, "StoreCreatedEvent": { "description": "Store Created Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Store": { "$ref": "#/components/schemas/Store" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreDeletedEvent": { "description": "Store Deleted Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "readOnly": true, "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Store": { "$ref": "#/components/schemas/Store" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "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 } } }, "StoreFeeConfigUpdatedEvent": { "description": "Fee Config Updated Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Changes": { "description": "Diff between before and after", "type": "string", "example": "string" }, "StoreFeeConfig": { "$ref": "#/components/schemas/StoreFeeConfig" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "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" } } }, "StoreGroupCreatedEvent": { "description": "Store Group Created Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreGroupId": { "format": "int32", "description": "Store Group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreGroup": { "$ref": "#/components/schemas/StoreGroup" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreGroupDeletedEvent": { "description": "Store Group Deleted Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreGroupId": { "format": "int32", "description": "Store Group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreGroup": { "$ref": "#/components/schemas/StoreGroup" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreGroupUpdatedEvent": { "description": "Store Group Updated Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreGroupId": { "format": "int32", "description": "Store Group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreGroup": { "$ref": "#/components/schemas/StoreGroup" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreKioskSetting": { "description": "Store Kiosk Settings", "type": "object", "properties": { "KioskSettingId": { "format": "int32", "description": "Kiosk setting id", "type": "integer", "example": 500123 }, "KioskName": { "description": "Store kiosk name", "type": "string", "example": "Example Name" }, "RequireCustomerName": { "description": "Require customer name flag", "type": "boolean", "example": true }, "RequireCustomerPhoneNumber": { "description": "Require customer phone number flag", "type": "boolean", "example": true }, "RequestCustomerPhoneNumber": { "description": "Request customer phone number flag (Option to Skip)", "type": "boolean", "example": true }, "RequestTableNumber": { "description": "Request table number flag", "type": "boolean", "example": true }, "OfferDineInOrTakeawayOption": { "description": "Offer Dine-In/Takeaway option flag", "type": "boolean", "example": true }, "PhysicalRestaurantId": { "format": "int32", "description": "Physical restaurant id", "type": "integer", "example": 500123 }, "HydraConfigId": { "format": "int32", "description": "Hydra config id", "type": "integer", "example": 500123 } } }, "StoreKioskSettingUpdatedEvent": { "description": "Store kiosk setting updated", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreKioskSetting": { "$ref": "#/components/schemas/StoreKioskSetting" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreLogoCreatedEvent": { "description": "Store logo created", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "StoreId": { "format": "int32", "description": "ID of store that the logo has been added to", "type": "integer", "example": 500123 }, "LogoUrl": { "description": "Url of logo", "type": "string", "example": "https://api.flipdish.co/example" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreLogoDeletedEvent": { "description": "Store logo deleted", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "StoreId": { "format": "int32", "description": "ID of store that the logo has been added to", "type": "integer", "example": 500123 }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreLogoUpdatedEvent": { "description": "Store logo updated", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "StoreId": { "format": "int32", "description": "ID of store that the logo has been added to", "type": "integer", "example": 500123 }, "LogoUrl": { "description": "Url of logo", "type": "string", "example": "https://api.flipdish.co/example" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreMenuAssignedEvent": { "description": "Menu Assigned To Store Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "MenuId": { "format": "int32", "description": "MenuId Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "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" } } }, "StoreOpeningHoursUpdatedEvent": { "description": "Store Opening Hours Updated Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "DeliveryType": { "description": "Type of opening hours Delivery / Pickup", "enum": [ "Delivery", "Pickup" ], "type": "string", "example": "Delivery" }, "DeliveryTypeString": { "description": "Type of opening hours Delivery / Pickup as a string", "enum": [ "Delivery", "Pickup" ], "type": "string", "example": "Delivery" }, "BusinessHoursPeriodOld": { "$ref": "#/components/schemas/BusinessHoursPeriod" }, "BusinessHoursPeriod": { "$ref": "#/components/schemas/BusinessHoursPeriod" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "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 } } }, "StorePreOrderConfigUpdatedEvent": { "description": "Store Pre order config updated", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "PreOrderConfig": { "$ref": "#/components/schemas/PreOrderConfig" }, "OldPreOrderConfig": { "$ref": "#/components/schemas/PreOrderConfig" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StorePublishedEvent": { "description": "Store Published Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "readOnly": true, "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Store": { "$ref": "#/components/schemas/Store" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreServiceChargeUpdatedEvent": { "description": "Service Charge Updated Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "ServiceCharge": { "$ref": "#/components/schemas/ServiceCharge" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreSummary": { "description": "Store summary", "type": "object", "properties": { "Id": { "format": "int32", "description": "Store identifier", "type": "integer", "example": 500123 }, "Name": { "description": "Store name", "type": "string", "example": "Example Name" }, "MenuId": { "format": "int32", "description": "Stores menu identifier", "type": "integer", "example": 500123 }, "MenuPublishId": { "format": "uuid", "description": "Stores menu publish GUID", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Metadata": { "description": "Store metadata", "type": "object", "additionalProperties": { "type": "string" } }, "Currency": { "description": "Currency which used by the Store", "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" }, "Coordinates": { "$ref": "#/components/schemas/Coordinates" }, "StoreTimezone": { "description": "Timezone of store", "type": "string", "example": "string" }, "StoreIanaTimezone": { "description": "IANA Timezone of store", "type": "string", "example": "string" }, "StoreGroupId": { "format": "int32", "description": "Store group id of store", "type": "integer", "example": 500123 }, "TaxId": { "description": "VAT number or generic Tax ID of the store", "type": "string", "example": "500123" }, "PrettyAddress": { "description": "Address of the store", "type": "string", "example": "string" }, "CountryCode": { "description": "Country code of the store address (ISO 3166-1 alpha-2)", "type": "string", "example": "IE" }, "PropertyId": { "description": "Property identifier", "type": "string", "example": "500123" } } }, "StoreTipUpdatedEvent": { "description": "Store Tip Updated", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Config": { "$ref": "#/components/schemas/UpdateTipConfiguration" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreUnarchivedEvent": { "description": "Store Unarchived Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "readOnly": true, "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Store": { "$ref": "#/components/schemas/Store" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreUnpublishedEvent": { "description": "Store Unpublished Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "readOnly": true, "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Store": { "$ref": "#/components/schemas/Store" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StoreUpdatedEvent": { "description": "Store Updated Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "OrgId": { "description": "Organisation Id", "type": "string", "example": "500123" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreGroupId": { "format": "int32", "description": "Store group Id", "type": "integer", "readOnly": true, "example": 500123 }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Store": { "$ref": "#/components/schemas/Store" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "StuartSettings": { "description": "Stuart settings", "type": "object", "properties": { "ClientId": { "description": "Client Id", "type": "string", "example": "500123" }, "ClientSecret": { "description": "Client Secret", "type": "string", "example": "string" }, "Enabled": { "description": "Enabled", "type": "boolean", "example": true }, "WebhookUrlBasicAuthentication": { "description": "Webhook url to settle in the Stuart portal", "type": "string", "example": "string" }, "OverrideWebhookUrl": { "description": "Override Flipdish Webhook Url", "type": "boolean", "example": true }, "MinutesToPickupBeforeThanDeliveryTime": { "format": "int32", "description": "MinutesToPickupBeforeThanDeliveryTime", "type": "integer", "nullable": true, "example": 1 }, "PackageType": { "description": "Package type", "enum": [ "Xsmall", "Small", "Medium", "Large", "Xlarge" ], "type": "string", "nullable": true, "example": "Xsmall" }, "TransportType": { "description": "Transport type", "enum": [ "Bike", "Cargobike", "Cargobikexl", "Motorbike", "Motorbikexl", "Car", "Van" ], "type": "string", "nullable": true, "example": "Bike" }, "CancelOrderIfStuartCancelDelivery": { "description": "Determines if Flipdish order should be cancel when Stuart cancels delivery", "type": "boolean", "example": true }, "TransportPrices": { "description": "If the order exceeds are certain amount this configuration will determine a new vehicle type", "type": "object", "properties": { "Bike": { "format": "double", "type": "number" }, "Cargobike": { "format": "double", "type": "number" }, "Cargobikexl": { "format": "double", "type": "number" }, "Motorbike": { "format": "double", "type": "number" }, "Motorbikexl": { "format": "double", "type": "number" }, "Car": { "format": "double", "type": "number" }, "Van": { "format": "double", "type": "number" } } } } }, "TaxItem": { "description": "A collection of tax items on the order.", "type": "object", "properties": { "Name": { "description": "The name of the tax item.", "type": "string", "example": "Example Name" }, "Rate": { "format": "double", "description": "The tax rate applied to the item.", "type": "number", "example": 1.0 }, "Amount": { "format": "double", "description": "The amount of tax applied to the item.", "type": "number", "example": 12.5 } } }, "Teammate": { "description": "", "type": "object", "properties": { "TeammateId": { "description": "Unique indentifier", "type": "string", "example": "500123" }, "UserId": { "format": "int32", "description": "User ID of the teammate", "type": "integer", "nullable": true, "example": 500123 }, "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "LastActivity": { "format": "date-time", "description": "Last activity", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "AppId": { "description": "Access level is for this App", "type": "string", "example": "500123" }, "InvitationStatus": { "description": "Invitation status", "enum": [ "Pending", "Accepted", "Expired" ], "type": "string", "example": "Pending" }, "Email": { "description": "Email address", "type": "string", "example": "owner@example.com" }, "AppAccessLevel": { "description": "App access level", "enum": [ "None", "Owner", "StoreOwner", "PropertyOwner", "ManagedOwner", "Integrator", "PropertyManager", "StoreManager", "StoreStaff", "StoreReadOnlyAccess", "FinanceManger", "Onboarding", "Support" ], "type": "string", "example": "None" }, "HasAccessToAllStores": { "description": "The user has access to all stores for the app (including new stores that added later)", "type": "boolean", "example": true }, "StoreIds": { "description": "Store IDs the user has access to (if HasAccessToAllStores is false)", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "PropertyIds": { "description": "Property Ids the user has access to (if HasAccessToAllStores is false)", "type": "array", "items": { "type": "string" }, "example": [ "string" ] } } }, "TeammateDeletedEvent": { "description": "", "type": "object", "properties": { "Teammate": { "$ref": "#/components/schemas/Teammate" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "TeammateInviteAcceptedEvent": { "description": "", "type": "object", "properties": { "Teammate": { "$ref": "#/components/schemas/Teammate" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "TeammateInviteSentEvent": { "description": "", "type": "object", "properties": { "Teammate": { "$ref": "#/components/schemas/Teammate" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "TeammateUpdatedEvent": { "description": "", "type": "object", "properties": { "Teammate": { "$ref": "#/components/schemas/Teammate" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "TelephonyConfig": { "description": "Phone call", "type": "object", "properties": { "TelephonyConfigId": { "format": "int32", "description": "ID of the phone call", "type": "integer", "example": 500123 }, "ApmEnabled": { "description": "APM enabled flag", "type": "boolean", "example": true }, "Type": { "description": "Type of telephony service", "enum": [ "PreRecorded", "VoiceAI" ], "type": "string", "example": "PreRecorded" }, "ConsentEnabled": { "description": "Consent enabled flag", "type": "boolean", "example": true }, "PhoneNumber": { "description": "APM phone number of the store", "type": "string", "example": "+353000000000" }, "SendAppLinkSms": { "description": "Send app link SMS flag", "type": "boolean", "example": true }, "UseCustomAppLinkSmsMessage": { "description": "Use custom app link SMS message flag", "type": "boolean", "example": true }, "UseCustomVoiceMessage": { "description": "Use custom voice message flag", "type": "boolean", "example": true }, "AppLinkSmsMessage": { "description": "App link SMS message", "type": "string", "example": "https://api.flipdish.co/example" }, "ResendApmMessageAfterDays": { "format": "int32", "description": "Amount of days to resend APM message", "type": "integer", "example": 1 } } }, "TelephonyConfigUpdatedEvent": { "description": "Telephony Config Updated Event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "TelephonyConfig": { "$ref": "#/components/schemas/TelephonyConfig" }, "PropertyId": { "description": "Property Id", "type": "string", "example": "500123" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "UpdateAppStoreAppConfigurationWebhookDTO": { "required": [ "Id", "IsEnabled" ], "type": "object", "properties": { "Id": { "type": "string", "example": "500123" }, "IsEnabled": { "type": "boolean", "example": true }, "StoreIds": { "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "Settings": { "type": "array", "items": { "$ref": "#/components/schemas/Setting" }, "example": [] } } }, "UpdateTipConfiguration": { "description": "Describes the configuration of tipping", "type": "object", "properties": { "IsEnabled": { "description": "Are tips enabled?", "type": "boolean", "example": true }, "AllowCustomTips": { "description": "Are custom tips allowed?", "type": "boolean", "example": true }, "AllowRoundUp": { "description": "Is round up allowed?", "type": "boolean", "example": true }, "AllowEmojis": { "description": "Are emojis allowed?", "type": "boolean", "example": true }, "Percentages": { "description": "Ordered list of tip breakpoints (smallest -> largest)", "type": "array", "items": { "format": "double", "type": "number" }, "example": [ 1.0 ] }, "DefaultPercentage": { "format": "double", "description": "Defines a default percentage, it must be in the list of Percentages", "type": "number", "nullable": true, "example": 1.0 } } }, "UserAnsweredSignupQuestionsEvent": { "description": "User answered signup questions event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "SignupAnswers": { "description": "The users answers", "type": "string", "example": "string" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "UserCreatedEvent": { "description": "User created event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "UserDeletedEvent": { "description": "User deleted event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "UserEventInfo": { "description": "User Event Info", "type": "object", "properties": { "UserId": { "format": "int32", "description": "User Id", "type": "integer", "example": 500123 }, "UserName": { "description": "User Name", "type": "string", "example": "Example Name" }, "UserPhoneNumber": { "description": "User Phone Number", "type": "string", "example": "+353000000000" }, "UserEmail": { "description": "User Email", "type": "string", "example": "owner@example.com" } } }, "UserLoginEvent": { "description": "User login event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "UserPasswordCreatedEvent": { "description": "User created password event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "UserUpdatedEvent": { "description": "User updated event", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "ValidityPeriod": { "description": "ValidityPeriod.", "type": "object", "properties": { "DayOfWeek": { "description": "DayOfWeek.", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "example": "Sunday" }, "StartTime": { "description": "StartTime.", "type": "string", "example": "2026-06-02T12:00:00Z" }, "EndTime": { "description": "EndTime.", "type": "string", "example": "2026-06-02T12:00:00Z" } } }, "Voucher": { "description": "Voucher", "type": "object", "properties": { "VoucherId": { "format": "int32", "description": "Voucher Id", "type": "integer", "example": 500123 }, "Status": { "description": "Voucher Status", "enum": [ "Valid", "NotYetValid", "Expired", "Used", "Disabled" ], "type": "string", "example": "Valid" }, "VoucherType": { "description": "Voucher Type", "enum": [ "PercentageDiscount", "LumpDiscount", "AddItem", "CreditNote", "FreeDelivery" ], "type": "string", "example": "PercentageDiscount" }, "Currency": { "description": "Currency of the voucher", "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" }, "StoreNames": { "description": "Stores that this voucher applies to", "type": "array", "items": { "type": "string" }, "example": [ "Example Name" ] }, "PromotionDetails": { "$ref": "#/components/schemas/PromotionDetails" }, "CreditNoteDetails": { "$ref": "#/components/schemas/CreditNoteDetails" }, "LumpDiscountDetails": { "$ref": "#/components/schemas/LumpDiscountDetails" }, "PercentDiscountDetails": { "$ref": "#/components/schemas/PercentDiscountDetails" }, "Code": { "description": "Voucher Code", "type": "string", "example": "string" }, "Description": { "description": "Voucher Description (Visible on printout)", "type": "string", "example": "string" }, "Stores": { "description": "Stores that this voucher applies to", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "ValidOnOrdersOver": { "format": "double", "description": "Valid on orders on or above", "type": "number", "example": 1.0 }, "TakesPriority": { "description": "Takes priority", "type": "boolean", "example": true }, "IsEnabled": { "description": "Is voucher enabled", "type": "boolean", "example": true }, "IsAutomaticallyApplied": { "description": "Is voucher automatically applied", "type": "boolean", "example": true }, "IncludeDeliveryFee": { "description": "Include delivery fees", "type": "boolean", "example": true }, "IsValidForDeliveryOrders": { "description": "Valid for delivery orders", "type": "boolean", "example": true }, "IsValidForPickupOrders": { "description": "Valid for pickup orders", "type": "boolean", "example": true }, "IsValidForOrdersPayedOnline": { "description": "Valid for orders payed online", "type": "boolean", "example": true }, "IsValidForOrdersPayedByCash": { "description": "Valid for orders payed in cash", "type": "boolean", "example": true }, "IsValidForFirstOrderOnly": { "description": "Valid only on the first order by the customer", "type": "boolean", "example": true }, "IsValidOncePerCustomer": { "description": "Valid once per customer", "type": "boolean", "example": true }, "IsValidOnlyOnce": { "description": "Valid only once, by any customer (once used cannot be used again by any other customer)", "type": "boolean", "example": true }, "IsDiscoverable": { "description": "Enables the voucher to be offered in the Voucher Discoverability feature", "type": "boolean", "example": true }, "ForceDiscount": { "description": "Force the discount to be applied which bypasses some menu restrictions", "type": "boolean", "example": true }, "StartDate": { "format": "date-time", "description": "Voucher Starts On (Time in UTC)", "type": "string", "example": "2026-06-02T12:00:00Z" }, "ExpiryDate": { "format": "date-time", "description": "Voucher Expires On (Time in UTC)", "type": "string", "example": "2026-06-02T12:00:00Z" }, "ChannelRestrictions": { "description": "Limit the channels this voucher can be used on", "type": "array", "items": { "enum": [ "Ios", "Android", "Web", "Kiosk", "Pos", "Google" ], "type": "string" }, "example": [ "Ios" ] }, "ValidityPeriods": { "description": "Periods in which the voucher is valid.\r\nAn empty list means the voucher is valid at all times.\r\nWhen updating the voucher, if this is set to null, the validity periods won't be updated.", "type": "array", "items": { "$ref": "#/components/schemas/ValidityPeriod" }, "example": [] }, "VoucherSubType": { "description": "Voucher Subtype", "enum": [ "None", "SignUp", "Loyalty", "Loyalty25", "Retention", "SecondaryRetention", "Custom" ], "type": "string", "example": "None" }, "CustomerId": { "format": "int32", "description": "Customer UserID", "type": "integer", "nullable": true, "example": 500123 }, "MaxRedemptions": { "format": "int32", "description": "Maximum number of times the voucher can be redeemed (used)", "type": "integer", "nullable": true, "example": 1 } } }, "VoucherAppliedEvent": { "description": "Voucher Applied Event", "type": "object", "properties": { "VoucherId": { "format": "int32", "description": "Voucher Id", "type": "integer", "example": 500123 }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "OrderId": { "format": "int32", "description": "Order id", "type": "integer", "example": 500123 }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "VoucherCreatedEvent": { "description": "Voucher Created Event", "type": "object", "properties": { "VoucherId": { "format": "int32", "description": "Voucher Id", "type": "integer", "example": 500123 }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Voucher": { "$ref": "#/components/schemas/Voucher" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "VoucherDeletedEvent": { "description": "Voucher Deleted Event", "type": "object", "properties": { "VoucherId": { "format": "int32", "description": "Voucher Id", "type": "integer", "example": 500123 }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Voucher": { "$ref": "#/components/schemas/Voucher" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "VoucherUpdatedEvent": { "description": "Voucher Updated Event", "type": "object", "properties": { "VoucherId": { "format": "int32", "description": "Voucher Id", "type": "integer", "example": 500123 }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Voucher": { "$ref": "#/components/schemas/Voucher" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "WebhookEventSample": { "description": "Sample payload of a webhook event", "type": "object", "properties": { "Type": { "description": "Event name", "type": "string", "example": "string" }, "CreateTime": { "format": "date-time", "description": "Sample event creation date and time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Body": { "$ref": "#/components/schemas/FlipdishEventBase" } } }, "WebhookLog": { "description": "Webhook log", "type": "object", "properties": { "WebhookSubscriptionOwnerUserId": { "format": "int32", "description": "Webhook subscription owner user identifier", "type": "integer", "example": 500123 }, "EventCreated": { "description": "Event created", "type": "string", "example": "string" }, "WebhookTriggered": { "description": "Webhook triggered", "type": "string", "example": "string" }, "WebhookEventName": { "description": "Webhook event name", "type": "string", "example": "Example Name" }, "WebhookSubscriptionCallbackUrl": { "description": "Webhook subscription callback url", "type": "string", "example": "https://api.flipdish.co/example" }, "HttpResponseStatusCode": { "description": "Received HTTP repsonse status HTTP code", "type": "string", "example": "Active" }, "HttpResponseStatus": { "description": "Received HTTP repsonse status", "type": "string", "example": "Active" }, "RequestHeaders": { "description": "Request headers", "type": "string", "example": "string" }, "RequestBody": { "description": "Request body", "type": "string", "example": "string" }, "ResponseHeaders": { "description": "Received response headers", "type": "string", "example": "string" }, "ResponseBody": { "description": "Received response body", "type": "string", "example": "string" }, "Duration": { "description": "Duration of HTTP request", "type": "string", "example": "string" }, "RetryCount": { "format": "int32", "description": "Retry count", "type": "integer", "example": 3 }, "FlipdishWebhookId": { "format": "uuid", "description": "Flipdish webhook identifier", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Version": { "description": "Flipdish webhook version", "type": "string", "example": "string" } } }, "WebhookSubscription": { "description": "Webhook subscription", "type": "object", "properties": { "Id": { "format": "int32", "description": "Webhook subscription identifier", "type": "integer", "example": 500123 }, "OwnerUserId": { "format": "int32", "description": "Webhook subscription owner user identifier", "type": "integer", "example": 500123 }, "Version": { "description": "Webhook subscription owner user identifier", "type": "string", "example": "string" }, "EventNames": { "description": "Webhook subscription event names", "type": "array", "items": { "type": "string" }, "example": [ "Example Name" ] }, "CallbackUrl": { "description": "Callback url. Flipdish system POST messages to this url.", "type": "string", "example": "https://api.flipdish.co/example" }, "Enabled": { "description": "Is webhook subscription enabled.", "type": "boolean", "example": true }, "VerifyToken": { "description": "This is your token which will be in the Header of each POST request from Flipdish with name: X-Verify-Token.", "type": "string", "example": "string" } } }, "WebhookSubscriptionCreatedEvent": { "description": "", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "WebhookSubscriptionEventInfo": { "$ref": "#/components/schemas/WebhookSubscriptionEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "WebhookSubscriptionDeletedEvent": { "description": "", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "WebhookSubscriptionEventInfo": { "$ref": "#/components/schemas/WebhookSubscriptionEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "WebhookSubscriptionEventInfo": { "description": "", "type": "object", "properties": { "OwnerUserId": { "format": "int32", "description": "Webhook subscription owner user identifier", "type": "integer", "example": 500123 }, "WebhookSubscriptionId": { "format": "int32", "description": "Webhook subscription identifier", "type": "integer", "example": 500123 }, "ClientId": { "description": "Oauth client identifier", "type": "string", "example": "500123" }, "CallbackUrl": { "description": "Webhook callback url", "type": "string", "example": "https://api.flipdish.co/example" } } }, "WebhookSubscriptionUpdatedEvent": { "description": "", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "WebhookSubscriptionEventInfo": { "$ref": "#/components/schemas/WebhookSubscriptionEventInfo" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "WebsiteUpdatedEvent": { "description": "WebsiteUpdatedEvent", "type": "object", "properties": { "AppNameId": { "description": "App Name id of the whitelabel of the website", "type": "string", "example": "500123" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "Description": { "description": "Description of event", "type": "string", "example": "string" }, "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "WebsiteVanityUrlUpdatedEvent": { "description": "Website vanity url", "type": "object", "properties": { "EventName": { "description": "The event name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "User": { "$ref": "#/components/schemas/UserEventInfo" }, "VanityUrl": { "description": "New vanity url", "type": "string", "example": "https://api.flipdish.co/example" }, "FlipdishEventId": { "format": "uuid", "description": "The identitfier of the event", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreateTime": { "format": "date-time", "description": "The time of creation of the event", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Position": { "format": "int32", "description": "Position", "type": "integer", "example": 1 }, "AppId": { "description": "App id", "type": "string", "example": "500123" }, "OrgId": { "description": "Org id", "type": "string", "example": "500123" }, "IpAddress": { "description": "Ip Address", "type": "string", "example": "string" }, "ActivityId": { "description": "Activity Id", "type": "string", "example": "500123" }, "ActivityType": { "description": "Activity Type", "type": "string", "example": "string" } } }, "WhiteLabelConfig": { "description": "White label configuration details", "type": "object", "properties": { "WhiteLabelId": { "format": "int32", "description": "White label identifier", "type": "integer", "example": 500123 }, "WhiteLabelName": { "description": "White label name", "type": "string", "example": "Example Name" }, "CountryId": { "description": "Country identifier", "type": "string", "example": "500123" }, "AppNameId": { "description": "App id", "type": "string", "example": "500123" }, "Website": { "description": "Website URL", "type": "string", "example": "string" }, "PanaceaVanityUrl": { "description": "Panacea vanity URL", "type": "string", "example": "https://api.flipdish.co/example" } } } }, "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" } } } } } } }