{ "openapi": "3.0.3", "info": { "title": "Flipdish API - Marketing", "version": "v1.0", "description": "Flipdish Open API v1.0 \u2014 Marketing 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": "Campaigns", "description": "Operations for Campaigns." }, { "name": "CrossSell", "description": "Operations for Cross Sell." }, { "name": "PushNotifications", "description": "Operations for Push Notifications." }, { "name": "RestaurantVouchersPayGreen", "description": "Operations for Restaurant Vouchers Pay Green." }, { "name": "Vouchers", "description": "Operations for Vouchers." } ], "paths": { "/api/v1.0/{appId}/campaigns/loyalty": { "get": { "tags": [ "Campaigns" ], "operationId": "GetLoyaltyCampaignsForApp", "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_LoyaltyCampaign_" }, "examples": { "GetLoyaltyCampaignsForApp200Example": { "summary": "Default GetLoyaltyCampaignsForApp 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetLoyaltyCampaignsForApp400Example": { "summary": "Default GetLoyaltyCampaignsForApp 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": { "GetLoyaltyCampaignsForApp401Example": { "summary": "Default GetLoyaltyCampaignsForApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetLoyaltyCampaignsForApp403Example": { "summary": "Default GetLoyaltyCampaignsForApp 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": { "GetLoyaltyCampaignsForApp404Example": { "summary": "Default GetLoyaltyCampaignsForApp 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": { "GetLoyaltyCampaignsForApp500Example": { "summary": "Default GetLoyaltyCampaignsForApp 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 Loyalty Campaigns for App", "description": "Get Loyalty Campaigns for App via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/campaigns/loyalty).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Campaigns" ], "operationId": "CreateLoyaltyCampaign", "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/RestApiResult_LoyaltyCampaign_" }, "examples": { "CreateLoyaltyCampaign200Example": { "summary": "Default CreateLoyaltyCampaign 200 response", "x-microcks-default": true, "value": { "Data": { "CampaignId": 500123, "Statistics": { "VouchersIssued": 1, "VouchersRedeemed": 1, "Conversion": 1.0, "SalesGenerated": 1.0, "ReturnOfInvestment": 1.0 }, "Stores": [], "PublicId": "00000000-0000-0000-0000-000000000000", "OrdersBeforeReceivingVoucher": 1, "PercentDiscountAmount": 12.5, "MaxDiscount": 3, "RoundingStrategy": 1, "ShouldIncludeOrdersWithLoyaltyVoucher": true, "VoucherValidPeriodDays": 1, "IncludeDeliveryFee": true, "AutoApplyResultingVouchers": true, "IncludeExistingOrders": true, "IsEnabled": true, "StoreIds": [ 1 ], "AppId": "500123", "ForceDiscount": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateLoyaltyCampaign400Example": { "summary": "Default CreateLoyaltyCampaign 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": { "CreateLoyaltyCampaign401Example": { "summary": "Default CreateLoyaltyCampaign 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateLoyaltyCampaign403Example": { "summary": "Default CreateLoyaltyCampaign 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": { "CreateLoyaltyCampaign404Example": { "summary": "Default CreateLoyaltyCampaign 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": { "CreateLoyaltyCampaign500Example": { "summary": "Default CreateLoyaltyCampaign 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 Loyalty Campaign", "description": "Create Loyalty Campaign via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/campaigns/loyalty).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/campaigns/retention": { "get": { "tags": [ "Campaigns" ], "operationId": "GetRetentionCampaignsForApp", "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_RetentionCampaign_" }, "examples": { "GetRetentionCampaignsForApp200Example": { "summary": "Default GetRetentionCampaignsForApp 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRetentionCampaignsForApp400Example": { "summary": "Default GetRetentionCampaignsForApp 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": { "GetRetentionCampaignsForApp401Example": { "summary": "Default GetRetentionCampaignsForApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRetentionCampaignsForApp403Example": { "summary": "Default GetRetentionCampaignsForApp 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": { "GetRetentionCampaignsForApp404Example": { "summary": "Default GetRetentionCampaignsForApp 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": { "GetRetentionCampaignsForApp500Example": { "summary": "Default GetRetentionCampaignsForApp 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 Retention Campaigns for App", "description": "Get Retention Campaigns for App via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/campaigns/retention).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Campaigns" ], "operationId": "CreateRetentionCampaign", "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/RestApiResult_RetentionCampaign_" }, "examples": { "CreateRetentionCampaign200Example": { "summary": "Default CreateRetentionCampaign 200 response", "x-microcks-default": true, "value": { "Data": { "CampaignId": 500123, "Statistics": { "VouchersIssued": 1, "VouchersRedeemed": 1, "Conversion": 1.0, "SalesGenerated": 1.0, "ReturnOfInvestment": 1.0 }, "Stores": [], "PublicId": "00000000-0000-0000-0000-000000000000", "NotifyCustomerAfterMinutes": 1, "PercentDiscountAmount": 12.5, "MaxDiscount": 3, "LumpDiscountAmount": 12.5, "VoucherValidPeriodDays": 1, "IncludeDeliveryFee": true, "AutoApplyResultingVouchers": true, "IncludeExistingOrders": true, "IsEnabled": true, "StoreIds": [ 1 ], "AppId": "500123", "ForceDiscount": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateRetentionCampaign400Example": { "summary": "Default CreateRetentionCampaign 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": { "CreateRetentionCampaign401Example": { "summary": "Default CreateRetentionCampaign 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateRetentionCampaign403Example": { "summary": "Default CreateRetentionCampaign 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": { "CreateRetentionCampaign404Example": { "summary": "Default CreateRetentionCampaign 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": { "CreateRetentionCampaign500Example": { "summary": "Default CreateRetentionCampaign 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 Retention Campaign", "description": "Create Retention Campaign via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/campaigns/retention).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/campaigns/loyalty/{storeId}": { "get": { "tags": [ "Campaigns" ], "operationId": "GetLoyaltyCampaignsForStore", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_LoyaltyCampaign_" }, "examples": { "GetLoyaltyCampaignsForStore200Example": { "summary": "Default GetLoyaltyCampaignsForStore 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetLoyaltyCampaignsForStore400Example": { "summary": "Default GetLoyaltyCampaignsForStore 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": { "GetLoyaltyCampaignsForStore401Example": { "summary": "Default GetLoyaltyCampaignsForStore 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetLoyaltyCampaignsForStore403Example": { "summary": "Default GetLoyaltyCampaignsForStore 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": { "GetLoyaltyCampaignsForStore404Example": { "summary": "Default GetLoyaltyCampaignsForStore 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": { "GetLoyaltyCampaignsForStore500Example": { "summary": "Default GetLoyaltyCampaignsForStore 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 Loyalty Campaigns for Store", "description": "Get Loyalty Campaigns for Store via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/campaigns/loyalty/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/campaigns/retention/{storeId}": { "get": { "tags": [ "Campaigns" ], "operationId": "GetRetentionCampaignsForStore", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_RetentionCampaign_" }, "examples": { "GetRetentionCampaignsForStore200Example": { "summary": "Default GetRetentionCampaignsForStore 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRetentionCampaignsForStore400Example": { "summary": "Default GetRetentionCampaignsForStore 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": { "GetRetentionCampaignsForStore401Example": { "summary": "Default GetRetentionCampaignsForStore 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRetentionCampaignsForStore403Example": { "summary": "Default GetRetentionCampaignsForStore 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": { "GetRetentionCampaignsForStore404Example": { "summary": "Default GetRetentionCampaignsForStore 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": { "GetRetentionCampaignsForStore500Example": { "summary": "Default GetRetentionCampaignsForStore 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 Retention Campaigns for Store", "description": "Get Retention Campaigns for Store via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/campaigns/retention/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/campaigns/stores": { "get": { "tags": [ "Campaigns" ], "operationId": "GetStoreList", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "onlyPublished", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "The only published query parameter.", "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_StoreListItem_" }, "examples": { "GetStoreList200Example": { "summary": "Default GetStoreList 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreList400Example": { "summary": "Default GetStoreList 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": { "GetStoreList401Example": { "summary": "Default GetStoreList 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreList403Example": { "summary": "Default GetStoreList 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": { "GetStoreList404Example": { "summary": "Default GetStoreList 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": { "GetStoreList500Example": { "summary": "Default GetStoreList 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 List", "description": "Get Store List via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/campaigns/stores).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/campaigns/loyalty/{campaignId}": { "post": { "tags": [ "Campaigns" ], "operationId": "UpdateLoyaltyCampaign", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The campaign id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_LoyaltyCampaign_" }, "examples": { "UpdateLoyaltyCampaign200Example": { "summary": "Default UpdateLoyaltyCampaign 200 response", "x-microcks-default": true, "value": { "Data": { "CampaignId": 500123, "Statistics": { "VouchersIssued": 1, "VouchersRedeemed": 1, "Conversion": 1.0, "SalesGenerated": 1.0, "ReturnOfInvestment": 1.0 }, "Stores": [], "PublicId": "00000000-0000-0000-0000-000000000000", "OrdersBeforeReceivingVoucher": 1, "PercentDiscountAmount": 12.5, "MaxDiscount": 3, "RoundingStrategy": 1, "ShouldIncludeOrdersWithLoyaltyVoucher": true, "VoucherValidPeriodDays": 1, "IncludeDeliveryFee": true, "AutoApplyResultingVouchers": true, "IncludeExistingOrders": true, "IsEnabled": true, "StoreIds": [ 1 ], "AppId": "500123", "ForceDiscount": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateLoyaltyCampaign400Example": { "summary": "Default UpdateLoyaltyCampaign 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": { "UpdateLoyaltyCampaign401Example": { "summary": "Default UpdateLoyaltyCampaign 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateLoyaltyCampaign403Example": { "summary": "Default UpdateLoyaltyCampaign 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": { "UpdateLoyaltyCampaign404Example": { "summary": "Default UpdateLoyaltyCampaign 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": { "UpdateLoyaltyCampaign500Example": { "summary": "Default UpdateLoyaltyCampaign 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 Loyalty Campaign", "description": "Update Loyalty Campaign via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/campaigns/loyalty/{campaignId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/campaigns/retention/{campaignId}": { "post": { "tags": [ "Campaigns" ], "operationId": "UpdateRetentionCampaign", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The campaign id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_RetentionCampaign_" }, "examples": { "UpdateRetentionCampaign200Example": { "summary": "Default UpdateRetentionCampaign 200 response", "x-microcks-default": true, "value": { "Data": { "CampaignId": 500123, "Statistics": { "VouchersIssued": 1, "VouchersRedeemed": 1, "Conversion": 1.0, "SalesGenerated": 1.0, "ReturnOfInvestment": 1.0 }, "Stores": [], "PublicId": "00000000-0000-0000-0000-000000000000", "NotifyCustomerAfterMinutes": 1, "PercentDiscountAmount": 12.5, "MaxDiscount": 3, "LumpDiscountAmount": 12.5, "VoucherValidPeriodDays": 1, "IncludeDeliveryFee": true, "AutoApplyResultingVouchers": true, "IncludeExistingOrders": true, "IsEnabled": true, "StoreIds": [ 1 ], "AppId": "500123", "ForceDiscount": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateRetentionCampaign400Example": { "summary": "Default UpdateRetentionCampaign 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": { "UpdateRetentionCampaign401Example": { "summary": "Default UpdateRetentionCampaign 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateRetentionCampaign403Example": { "summary": "Default UpdateRetentionCampaign 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": { "UpdateRetentionCampaign404Example": { "summary": "Default UpdateRetentionCampaign 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": { "UpdateRetentionCampaign500Example": { "summary": "Default UpdateRetentionCampaign 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 Retention Campaign", "description": "Update Retention Campaign via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/campaigns/retention/{campaignId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/campaigns/{campaignId}": { "delete": { "tags": [ "Campaigns" ], "operationId": "RemoveCampaign", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The campaign id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RemoveCampaign400Example": { "summary": "Default RemoveCampaign 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": { "RemoveCampaign401Example": { "summary": "Default RemoveCampaign 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RemoveCampaign403Example": { "summary": "Default RemoveCampaign 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": { "RemoveCampaign404Example": { "summary": "Default RemoveCampaign 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": { "RemoveCampaign500Example": { "summary": "Default RemoveCampaign 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 Campaign", "description": "Remove Campaign via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/campaigns/{campaignId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/crossSell/menuItems": { "get": { "tags": [ "CrossSell" ], "operationId": "GetCrossSellMenuItems", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "menuId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The menu id query parameter.", "example": 500123 }, { "name": "menuItemId", "in": "query", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "description": "The menu item id query parameter.", "example": [ 500123 ] }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The limit query parameter.", "example": 1 }, { "name": "totalValue", "in": "query", "required": true, "schema": { "type": "number", "format": "double" }, "description": "The total value query parameter.", "example": 12.5 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_CrossSellMenuItems_" }, "examples": { "GetCrossSellMenuItems200Example": { "summary": "Default GetCrossSellMenuItems 200 response", "x-microcks-default": true, "value": { "Data": { "MenuItemIds": [ 1 ] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCrossSellMenuItems400Example": { "summary": "Default GetCrossSellMenuItems 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCrossSellMenuItems401Example": { "summary": "Default GetCrossSellMenuItems 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCrossSellMenuItems403Example": { "summary": "Default GetCrossSellMenuItems 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": { "GetCrossSellMenuItems500Example": { "summary": "Default GetCrossSellMenuItems 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 Cross Sell Menu Items", "description": "Get Cross Sell Menu Items via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/crossSell/menuItems).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/pushnotifications": { "get": { "tags": [ "PushNotifications" ], "operationId": "GetPushNotifications", "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 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult_PushNotificationResponse_" }, "examples": { "GetPushNotifications200Example": { "summary": "Default GetPushNotifications 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": { "GetPushNotifications400Example": { "summary": "Default GetPushNotifications 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPushNotifications401Example": { "summary": "Default GetPushNotifications 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPushNotifications403Example": { "summary": "Default GetPushNotifications 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": { "GetPushNotifications500Example": { "summary": "Default GetPushNotifications 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 Push Notifications", "description": "Get Push Notifications via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/pushnotifications).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "PushNotifications" ], "operationId": "SchedulePushNotification", "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/RestApiResult_PushNotificationResponse_" }, "examples": { "SchedulePushNotification200Example": { "summary": "Default SchedulePushNotification 200 response", "x-microcks-default": true, "value": { "Data": { "Sent": true, "ScheduledPushNotificationId": 500123, "ScheduledTime": "2026-06-02T12:00:00Z", "Title": "string", "Message": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SchedulePushNotification400Example": { "summary": "Default SchedulePushNotification 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SchedulePushNotification401Example": { "summary": "Default SchedulePushNotification 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SchedulePushNotification403Example": { "summary": "Default SchedulePushNotification 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": { "SchedulePushNotification500Example": { "summary": "Default SchedulePushNotification 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 Schedule Push Notification", "description": "Schedule Push Notification via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/pushnotifications).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/pushnotifications/{scheduledPushNotificationId}": { "post": { "tags": [ "PushNotifications" ], "operationId": "UpdatePushNotification", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "scheduledPushNotificationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The scheduled push notification id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_PushNotificationResponse_" }, "examples": { "UpdatePushNotification200Example": { "summary": "Default UpdatePushNotification 200 response", "x-microcks-default": true, "value": { "Data": { "Sent": true, "ScheduledPushNotificationId": 500123, "ScheduledTime": "2026-06-02T12:00:00Z", "Title": "string", "Message": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdatePushNotification400Example": { "summary": "Default UpdatePushNotification 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdatePushNotification401Example": { "summary": "Default UpdatePushNotification 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdatePushNotification403Example": { "summary": "Default UpdatePushNotification 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": { "UpdatePushNotification500Example": { "summary": "Default UpdatePushNotification 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 Push Notification", "description": "Update Push Notification via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/pushnotifications/{scheduledPushNotificationId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "PushNotifications" ], "operationId": "DeletePushNotification", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "scheduledPushNotificationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The scheduled push notification id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeletePushNotification400Example": { "summary": "Default DeletePushNotification 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeletePushNotification401Example": { "summary": "Default DeletePushNotification 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeletePushNotification403Example": { "summary": "Default DeletePushNotification 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": { "DeletePushNotification500Example": { "summary": "Default DeletePushNotification 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 Push Notification", "description": "Delete Push Notification via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/pushnotifications/{scheduledPushNotificationId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/restaurant-vouchers/paygreen": { "get": { "tags": [ "RestaurantVouchersPayGreen" ], "operationId": "GetPayGreenConfigurations", "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_RestaurantVoucherPayGreenConfiguration_" }, "examples": { "GetPayGreenConfigurations200Example": { "summary": "Default GetPayGreenConfigurations 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPayGreenConfigurations400Example": { "summary": "Default GetPayGreenConfigurations 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPayGreenConfigurations401Example": { "summary": "Default GetPayGreenConfigurations 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPayGreenConfigurations403Example": { "summary": "Default GetPayGreenConfigurations 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": { "GetPayGreenConfigurations500Example": { "summary": "Default GetPayGreenConfigurations 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 Pay Green Configurations", "description": "Get Pay Green Configurations via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/restaurant-vouchers/paygreen).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "RestaurantVouchersPayGreen" ], "operationId": "CreatePayGreenConfiguration", "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/CreatePayGreenConfigurationRequest" }, "examples": { "CreatePayGreenConfigurationRequestExample": { "summary": "Default CreatePayGreenConfiguration request", "x-microcks-default": true, "value": { "Name": "Example Name", "PayGreenId": "500123", "PayGreenPrivateKey": "string", "AssignedStores": [ 1 ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_RestaurantVoucherPayGreenConfiguration_" }, "examples": { "CreatePayGreenConfiguration200Example": { "summary": "Default CreatePayGreenConfiguration 200 response", "x-microcks-default": true, "value": { "Data": { "Name": "Example Name", "PayGreenId": "500123", "PayGreenConfigurationId": 500123, "AssignedStores": [] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreatePayGreenConfiguration400Example": { "summary": "Default CreatePayGreenConfiguration 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreatePayGreenConfiguration401Example": { "summary": "Default CreatePayGreenConfiguration 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreatePayGreenConfiguration403Example": { "summary": "Default CreatePayGreenConfiguration 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": { "CreatePayGreenConfiguration500Example": { "summary": "Default CreatePayGreenConfiguration 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 Pay Green Configuration", "description": "Create Pay Green Configuration via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/restaurant-vouchers/paygreen).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/restaurant-vouchers/paygreen/stores": { "get": { "tags": [ "RestaurantVouchersPayGreen" ], "operationId": "GetElegibleStores", "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_RestaurantVoucherEligibleStore_" }, "examples": { "GetElegibleStores200Example": { "summary": "Default GetElegibleStores 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetElegibleStores400Example": { "summary": "Default GetElegibleStores 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetElegibleStores401Example": { "summary": "Default GetElegibleStores 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetElegibleStores403Example": { "summary": "Default GetElegibleStores 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": { "GetElegibleStores500Example": { "summary": "Default GetElegibleStores 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 Elegible Stores", "description": "Get Elegible Stores via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/restaurant-vouchers/paygreen/stores).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}": { "get": { "tags": [ "RestaurantVouchersPayGreen" ], "operationId": "GetStorePayGreenConfiguration ", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_RestaurantVoucherPayGreenStoreConfiguration_" }, "examples": { "GetStorePayGreenConfiguration 200Example": { "summary": "Default GetStorePayGreenConfiguration 200 response", "x-microcks-default": true, "value": { "Data": { "Name": "Example Name", "Active": true, "PayGreenId": "500123", "PayGreenConfigurationId": 500123 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStorePayGreenConfiguration 400Example": { "summary": "Default GetStorePayGreenConfiguration 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStorePayGreenConfiguration 401Example": { "summary": "Default GetStorePayGreenConfiguration 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStorePayGreenConfiguration 403Example": { "summary": "Default GetStorePayGreenConfiguration 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": { "GetStorePayGreenConfiguration 500Example": { "summary": "Default GetStorePayGreenConfiguration 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 Pay Green Configuration", "description": "Get Store Pay Green Configuration via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "RestaurantVouchersPayGreen" ], "operationId": "UpdateStorePayGreenConfiguration ", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStorePayGreenConfigurationRequest" }, "examples": { "UpdateStorePayGreenConfiguration RequestExample": { "summary": "Default UpdateStorePayGreenConfiguration request", "x-microcks-default": true, "value": { "Active": true, "PayGreenConfigurationId": 500123 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_RestaurantVoucherPayGreenStoreConfiguration_" }, "examples": { "UpdateStorePayGreenConfiguration 200Example": { "summary": "Default UpdateStorePayGreenConfiguration 200 response", "x-microcks-default": true, "value": { "Data": { "Name": "Example Name", "Active": true, "PayGreenId": "500123", "PayGreenConfigurationId": 500123 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateStorePayGreenConfiguration 400Example": { "summary": "Default UpdateStorePayGreenConfiguration 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateStorePayGreenConfiguration 401Example": { "summary": "Default UpdateStorePayGreenConfiguration 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateStorePayGreenConfiguration 403Example": { "summary": "Default UpdateStorePayGreenConfiguration 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": { "UpdateStorePayGreenConfiguration 500Example": { "summary": "Default UpdateStorePayGreenConfiguration 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Update Store Pay Green Configuration", "description": "Update Store Pay Green Configuration via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/restaurant-vouchers/paygreen/{paygreenConfigurationId}": { "get": { "tags": [ "RestaurantVouchersPayGreen" ], "operationId": "ListPayGreenConfigurations", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "paygreenConfigurationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The paygreen configuration id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_RestaurantVoucherPayGreenConfiguration_" }, "examples": { "ListPayGreenConfigurations200Example": { "summary": "Default ListPayGreenConfigurations 200 response", "x-microcks-default": true, "value": { "Data": { "Name": "Example Name", "PayGreenId": "500123", "PayGreenConfigurationId": 500123, "AssignedStores": [] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ListPayGreenConfigurations400Example": { "summary": "Default ListPayGreenConfigurations 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ListPayGreenConfigurations401Example": { "summary": "Default ListPayGreenConfigurations 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ListPayGreenConfigurations403Example": { "summary": "Default ListPayGreenConfigurations 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": { "ListPayGreenConfigurations500Example": { "summary": "Default ListPayGreenConfigurations 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 List Pay Green Configurations", "description": "List Pay Green Configurations via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/restaurant-vouchers/paygreen/{paygreenConfigurationId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "RestaurantVouchersPayGreen" ], "operationId": "UpdatePayGreenConfiguration", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "paygreenConfigurationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The paygreen configuration id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePayGreenConfigurationRequest" }, "examples": { "UpdatePayGreenConfigurationRequestExample": { "summary": "Default UpdatePayGreenConfiguration request", "x-microcks-default": true, "value": { "Name": "Example Name", "AssignedStores": [ 1 ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_RestaurantVoucherPayGreenConfiguration_" }, "examples": { "UpdatePayGreenConfiguration200Example": { "summary": "Default UpdatePayGreenConfiguration 200 response", "x-microcks-default": true, "value": { "Data": { "Name": "Example Name", "PayGreenId": "500123", "PayGreenConfigurationId": 500123, "AssignedStores": [] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdatePayGreenConfiguration400Example": { "summary": "Default UpdatePayGreenConfiguration 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdatePayGreenConfiguration401Example": { "summary": "Default UpdatePayGreenConfiguration 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdatePayGreenConfiguration403Example": { "summary": "Default UpdatePayGreenConfiguration 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": { "UpdatePayGreenConfiguration500Example": { "summary": "Default UpdatePayGreenConfiguration 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 Pay Green Configuration", "description": "Update Pay Green Configuration via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/restaurant-vouchers/paygreen/{paygreenConfigurationId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "RestaurantVouchersPayGreen" ], "operationId": "DeletePayGreenConfiguration", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "paygreenConfigurationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The paygreen configuration id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DeletePayGreenConfiguration200Example": { "summary": "Default DeletePayGreenConfiguration 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeletePayGreenConfiguration400Example": { "summary": "Default DeletePayGreenConfiguration 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeletePayGreenConfiguration401Example": { "summary": "Default DeletePayGreenConfiguration 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeletePayGreenConfiguration403Example": { "summary": "Default DeletePayGreenConfiguration 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": { "DeletePayGreenConfiguration500Example": { "summary": "Default DeletePayGreenConfiguration 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 Pay Green Configuration", "description": "Delete Pay Green Configuration via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/restaurant-vouchers/paygreen/{paygreenConfigurationId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}/available-configurations": { "get": { "tags": [ "RestaurantVouchersPayGreen" ], "operationId": "GetStoreAvailablePayGreenConfigurations", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_RestaurantVoucherPayGreenConfigurationSummary_" }, "examples": { "GetStoreAvailablePayGreenConfigurations200Example": { "summary": "Default GetStoreAvailablePayGreenConfigurations 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreAvailablePayGreenConfigurations400Example": { "summary": "Default GetStoreAvailablePayGreenConfigurations 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreAvailablePayGreenConfigurations401Example": { "summary": "Default GetStoreAvailablePayGreenConfigurations 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoreAvailablePayGreenConfigurations403Example": { "summary": "Default GetStoreAvailablePayGreenConfigurations 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": { "GetStoreAvailablePayGreenConfigurations500Example": { "summary": "Default GetStoreAvailablePayGreenConfigurations 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 Available Pay Green Configurations", "description": "Get Store Available Pay Green Configurations via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}/available-configurations).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/vouchers/{voucherId}": { "get": { "tags": [ "Vouchers" ], "operationId": "GetVoucherById", "parameters": [ { "name": "voucherId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The voucher id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_VoucherWithStats_" }, "examples": { "GetVoucherById200Example": { "summary": "Default GetVoucherById 200 response", "x-microcks-default": true, "value": { "Data": { "TotalUsed": 12.5, "TotalCustomers": 12.5, "TotalAmountFromOrders": 12.5, "TotalDiscounted": 12.5, "AverageOrderSize": 1.0, "VoucherId": 500123, "Status": "Valid", "VoucherType": "PercentageDiscount", "Currency": "EUR", "StoreNames": [ "Example Name" ], "PromotionDetails": { "PromotionId": 500123, "Name": "Example Name", "PromotionAwards": [] }, "CreditNoteDetails": { "RemainingCredit": 1.0 }, "LumpDiscountDetails": { "DiscountAmount": 12.5 }, "PercentDiscountDetails": { "PercentageDiscount": 3, "MaxDiscountAmount": 12.5 }, "Code": "string", "Description": "string", "Stores": [ 1 ], "ValidOnOrdersOver": 1.0, "TakesPriority": true, "IsEnabled": true, "IsAutomaticallyApplied": true, "IncludeDeliveryFee": true, "IsValidForDeliveryOrders": true, "IsValidForPickupOrders": true, "IsValidForOrdersPayedOnline": true, "IsValidForOrdersPayedByCash": true, "IsValidForFirstOrderOnly": true, "IsValidOncePerCustomer": true, "IsValidOnlyOnce": true, "IsDiscoverable": true, "ForceDiscount": true, "StartDate": "2026-06-02T12:00:00Z", "ExpiryDate": "2026-06-02T12:00:00Z", "ChannelRestrictions": [ "Ios" ], "ValidityPeriods": [], "VoucherSubType": "None", "CustomerId": 500123, "MaxRedemptions": 1 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetVoucherById400Example": { "summary": "Default GetVoucherById 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": { "GetVoucherById401Example": { "summary": "Default GetVoucherById 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetVoucherById403Example": { "summary": "Default GetVoucherById 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": { "GetVoucherById404Example": { "summary": "Default GetVoucherById 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": { "GetVoucherById500Example": { "summary": "Default GetVoucherById 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 Voucher by Id", "description": "Get Voucher by Id via the Flipdish Open API v1.0 (GET /api/v1.0/vouchers/{voucherId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Vouchers" ], "operationId": "UpdateVoucher", "parameters": [ { "name": "voucherId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The voucher 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 ] }, { "name": "percentValue", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The percent value query parameter.", "example": 1 }, { "name": "lumpValue", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "The lump value query parameter.", "example": 1.0 }, { "name": "maxDiscountAmount", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "The max discount amount query parameter.", "example": 12.5 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVoucher" }, "examples": { "UpdateVoucherRequestExample": { "summary": "Default UpdateVoucher request", "x-microcks-default": true, "value": { "PromotionId": 500123, "PromotionName": "Example Name", "PromotionAwardMenuItemPublicIds": [ "00000000-0000-0000-0000-000000000000" ], "Code": "string", "Description": "string", "Stores": [ 1 ], "ValidOnOrdersOver": 1.0, "TakesPriority": true, "IsEnabled": true, "IsAutomaticallyApplied": true, "IncludeDeliveryFee": true, "IsValidForDeliveryOrders": true, "IsValidForPickupOrders": true, "IsValidForOrdersPayedOnline": true, "IsValidForOrdersPayedByCash": true, "IsValidForFirstOrderOnly": true, "IsValidOncePerCustomer": true, "IsValidOnlyOnce": true, "IsDiscoverable": true, "ForceDiscount": true, "StartDate": "2026-06-02T12:00:00Z", "ExpiryDate": "2026-06-02T12:00:00Z", "ChannelRestrictions": [ "Ios" ], "ValidityPeriods": [], "VoucherSubType": "None", "CustomerId": 500123, "MaxRedemptions": 1 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_VoucherWithStats_" }, "examples": { "UpdateVoucher200Example": { "summary": "Default UpdateVoucher 200 response", "x-microcks-default": true, "value": { "Data": { "TotalUsed": 12.5, "TotalCustomers": 12.5, "TotalAmountFromOrders": 12.5, "TotalDiscounted": 12.5, "AverageOrderSize": 1.0, "VoucherId": 500123, "Status": "Valid", "VoucherType": "PercentageDiscount", "Currency": "EUR", "StoreNames": [ "Example Name" ], "PromotionDetails": { "PromotionId": 500123, "Name": "Example Name", "PromotionAwards": [] }, "CreditNoteDetails": { "RemainingCredit": 1.0 }, "LumpDiscountDetails": { "DiscountAmount": 12.5 }, "PercentDiscountDetails": { "PercentageDiscount": 3, "MaxDiscountAmount": 12.5 }, "Code": "string", "Description": "string", "Stores": [ 1 ], "ValidOnOrdersOver": 1.0, "TakesPriority": true, "IsEnabled": true, "IsAutomaticallyApplied": true, "IncludeDeliveryFee": true, "IsValidForDeliveryOrders": true, "IsValidForPickupOrders": true, "IsValidForOrdersPayedOnline": true, "IsValidForOrdersPayedByCash": true, "IsValidForFirstOrderOnly": true, "IsValidOncePerCustomer": true, "IsValidOnlyOnce": true, "IsDiscoverable": true, "ForceDiscount": true, "StartDate": "2026-06-02T12:00:00Z", "ExpiryDate": "2026-06-02T12:00:00Z", "ChannelRestrictions": [ "Ios" ], "ValidityPeriods": [], "VoucherSubType": "None", "CustomerId": 500123, "MaxRedemptions": 1 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateVoucher400Example": { "summary": "Default UpdateVoucher 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": { "UpdateVoucher401Example": { "summary": "Default UpdateVoucher 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateVoucher403Example": { "summary": "Default UpdateVoucher 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": { "UpdateVoucher404Example": { "summary": "Default UpdateVoucher 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": { "UpdateVoucher500Example": { "summary": "Default UpdateVoucher 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 Voucher", "description": "Update Voucher via the Flipdish Open API v1.0 (POST /api/v1.0/vouchers/{voucherId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/vouchers/code/{code}": { "get": { "tags": [ "Vouchers" ], "operationId": "GetVoucherByCode", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The code path parameter.", "example": "string" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Voucher_" }, "examples": { "GetVoucherByCode200Example": { "summary": "Default GetVoucherByCode 200 response", "x-microcks-default": true, "value": { "Data": { "VoucherId": 500123, "Status": "Valid", "VoucherType": "PercentageDiscount", "Currency": "EUR", "StoreNames": [ "Example Name" ], "PromotionDetails": { "PromotionId": 500123, "Name": "Example Name", "PromotionAwards": [] }, "CreditNoteDetails": { "RemainingCredit": 1.0 }, "LumpDiscountDetails": { "DiscountAmount": 12.5 }, "PercentDiscountDetails": { "PercentageDiscount": 3, "MaxDiscountAmount": 12.5 }, "Code": "string", "Description": "string", "Stores": [ 1 ], "ValidOnOrdersOver": 1.0, "TakesPriority": true, "IsEnabled": true, "IsAutomaticallyApplied": true, "IncludeDeliveryFee": true, "IsValidForDeliveryOrders": true, "IsValidForPickupOrders": true, "IsValidForOrdersPayedOnline": true, "IsValidForOrdersPayedByCash": true, "IsValidForFirstOrderOnly": true, "IsValidOncePerCustomer": true, "IsValidOnlyOnce": true, "IsDiscoverable": true, "ForceDiscount": true, "StartDate": "2026-06-02T12:00:00Z", "ExpiryDate": "2026-06-02T12:00:00Z", "ChannelRestrictions": [ "Ios" ], "ValidityPeriods": [], "VoucherSubType": "None", "CustomerId": 500123, "MaxRedemptions": 1 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetVoucherByCode400Example": { "summary": "Default GetVoucherByCode 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": { "GetVoucherByCode401Example": { "summary": "Default GetVoucherByCode 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetVoucherByCode403Example": { "summary": "Default GetVoucherByCode 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": { "GetVoucherByCode404Example": { "summary": "Default GetVoucherByCode 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": { "GetVoucherByCode500Example": { "summary": "Default GetVoucherByCode 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 Voucher by Code", "description": "Get Voucher by Code via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/vouchers/code/{code}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/vouchers/{appId}/customer/{customerId}": { "get": { "tags": [ "Vouchers" ], "operationId": "GetVouchersByCustomerForApp", "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 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_VoucherSummary_" }, "examples": { "GetVouchersByCustomerForApp200Example": { "summary": "Default GetVouchersByCustomerForApp 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetVouchersByCustomerForApp400Example": { "summary": "Default GetVouchersByCustomerForApp 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": { "GetVouchersByCustomerForApp401Example": { "summary": "Default GetVouchersByCustomerForApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetVouchersByCustomerForApp403Example": { "summary": "Default GetVouchersByCustomerForApp 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": { "GetVouchersByCustomerForApp404Example": { "summary": "Default GetVouchersByCustomerForApp 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": { "GetVouchersByCustomerForApp500Example": { "summary": "Default GetVouchersByCustomerForApp 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 Vouchers by Customer for App", "description": "Get Vouchers by Customer for App via the Flipdish Open API v1.0 (GET /api/v1.0/vouchers/{appId}/customer/{customerId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/vouchers/{voucherId}/validity-periods": { "get": { "tags": [ "Vouchers" ], "operationId": "GetVoucherValidityPeriods", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "voucherId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The voucher id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetVoucherValidityPeriods400Example": { "summary": "Default GetVoucherValidityPeriods 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": { "GetVoucherValidityPeriods401Example": { "summary": "Default GetVoucherValidityPeriods 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetVoucherValidityPeriods403Example": { "summary": "Default GetVoucherValidityPeriods 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": { "GetVoucherValidityPeriods404Example": { "summary": "Default GetVoucherValidityPeriods 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": { "GetVoucherValidityPeriods500Example": { "summary": "Default GetVoucherValidityPeriods 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 Voucher Validity Periods", "description": "Get Voucher Validity Periods via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/vouchers/{voucherId}/validity-periods).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/vouchers/stats/{voucherId}": { "get": { "tags": [ "Vouchers" ], "operationId": "GetVoucherStatsById", "parameters": [ { "name": "voucherId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The voucher id path parameter.", "example": 500123 }, { "name": "aggregateDataBy", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "Daily", "Weekly", "Monthly" ] }, "description": "The aggregate data by query parameter.", "example": "Daily" }, { "name": "dataPointLimit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The data point limit query parameter.", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_VoucherDataPoint_" }, "examples": { "GetVoucherStatsById200Example": { "summary": "Default GetVoucherStatsById 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetVoucherStatsById400Example": { "summary": "Default GetVoucherStatsById 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": { "GetVoucherStatsById401Example": { "summary": "Default GetVoucherStatsById 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetVoucherStatsById403Example": { "summary": "Default GetVoucherStatsById 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": { "GetVoucherStatsById404Example": { "summary": "Default GetVoucherStatsById 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": { "GetVoucherStatsById500Example": { "summary": "Default GetVoucherStatsById 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 Voucher Stats by Id", "description": "Get Voucher Stats by Id via the Flipdish Open API v1.0 (GET /api/v1.0/vouchers/stats/{voucherId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/vouchers/summaries": { "get": { "tags": [ "Vouchers" ], "operationId": "GetVouchers", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "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": "searchCodes", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "description": "The search codes query parameter.", "example": [ "string" ] }, { "name": "statusSearch", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "Valid", "NotYetValid", "Expired", "Used", "Disabled" ] } }, "description": "The status search query parameter.", "example": [ "Valid" ] }, { "name": "typeSearch", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "PercentageDiscount", "LumpDiscount", "AddItem", "CreditNote", "FreeDelivery" ] } }, "description": "The type search query parameter.", "example": [ "PercentageDiscount" ] }, { "name": "subTypeSearch", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "None", "SignUp", "Loyalty", "Loyalty25", "Retention", "SecondaryRetention", "Custom" ] } }, "description": "The sub type search query parameter.", "example": [ "None" ] }, { "name": "storeIds", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "description": "The store ids query parameter.", "example": [ 1 ] }, { "name": "channelRestrictions", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "Ios", "Android", "Web", "Kiosk", "Pos", "Google" ] } }, "description": "The channel restrictions query parameter.", "example": [ "Ios" ] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult_VoucherSummary_" }, "examples": { "GetVouchers200Example": { "summary": "Default GetVouchers 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": { "GetVouchers400Example": { "summary": "Default GetVouchers 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": { "GetVouchers401Example": { "summary": "Default GetVouchers 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetVouchers403Example": { "summary": "Default GetVouchers 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": { "GetVouchers500Example": { "summary": "Default GetVouchers 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 Vouchers", "description": "Get Vouchers via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/vouchers/summaries).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/vouchers/{appId}": { "post": { "tags": [ "Vouchers" ], "operationId": "CreateVoucher", "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/CreateVoucher" }, "examples": { "CreateVoucherRequestExample": { "summary": "Default CreateVoucher request", "x-microcks-default": true, "value": { "VoucherType": "PercentageDiscount", "Promotion": { "Name": "Example Name", "MenuItemPublicIds": [ "00000000-0000-0000-0000-000000000000" ] }, "CreditNoteDetails": { "RemainingCredit": 1.0 }, "LumpDiscountDetails": { "DiscountAmount": 12.5 }, "PercentDiscountDetails": { "PercentageDiscount": 3, "MaxDiscountAmount": 12.5 }, "Code": "string", "Description": "string", "Stores": [ 1 ], "ValidOnOrdersOver": 1.0, "TakesPriority": true, "IsEnabled": true, "IsAutomaticallyApplied": true, "IncludeDeliveryFee": true, "IsValidForDeliveryOrders": true, "IsValidForPickupOrders": true, "IsValidForOrdersPayedOnline": true, "IsValidForOrdersPayedByCash": true, "IsValidForFirstOrderOnly": true, "IsValidOncePerCustomer": true, "IsValidOnlyOnce": true, "IsDiscoverable": true, "ForceDiscount": true, "StartDate": "2026-06-02T12:00:00Z", "ExpiryDate": "2026-06-02T12:00:00Z", "ChannelRestrictions": [ "Ios" ], "ValidityPeriods": [], "VoucherSubType": "None", "CustomerId": 500123, "MaxRedemptions": 1 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_VoucherWithStats_" }, "examples": { "CreateVoucher200Example": { "summary": "Default CreateVoucher 200 response", "x-microcks-default": true, "value": { "Data": { "TotalUsed": 12.5, "TotalCustomers": 12.5, "TotalAmountFromOrders": 12.5, "TotalDiscounted": 12.5, "AverageOrderSize": 1.0, "VoucherId": 500123, "Status": "Valid", "VoucherType": "PercentageDiscount", "Currency": "EUR", "StoreNames": [ "Example Name" ], "PromotionDetails": { "PromotionId": 500123, "Name": "Example Name", "PromotionAwards": [] }, "CreditNoteDetails": { "RemainingCredit": 1.0 }, "LumpDiscountDetails": { "DiscountAmount": 12.5 }, "PercentDiscountDetails": { "PercentageDiscount": 3, "MaxDiscountAmount": 12.5 }, "Code": "string", "Description": "string", "Stores": [ 1 ], "ValidOnOrdersOver": 1.0, "TakesPriority": true, "IsEnabled": true, "IsAutomaticallyApplied": true, "IncludeDeliveryFee": true, "IsValidForDeliveryOrders": true, "IsValidForPickupOrders": true, "IsValidForOrdersPayedOnline": true, "IsValidForOrdersPayedByCash": true, "IsValidForFirstOrderOnly": true, "IsValidOncePerCustomer": true, "IsValidOnlyOnce": true, "IsDiscoverable": true, "ForceDiscount": true, "StartDate": "2026-06-02T12:00:00Z", "ExpiryDate": "2026-06-02T12:00:00Z", "ChannelRestrictions": [ "Ios" ], "ValidityPeriods": [], "VoucherSubType": "None", "CustomerId": 500123, "MaxRedemptions": 1 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateVoucher400Example": { "summary": "Default CreateVoucher 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": { "CreateVoucher401Example": { "summary": "Default CreateVoucher 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateVoucher403Example": { "summary": "Default CreateVoucher 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": { "CreateVoucher404Example": { "summary": "Default CreateVoucher 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": { "CreateVoucher500Example": { "summary": "Default CreateVoucher 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 Voucher", "description": "Create Voucher via the Flipdish Open API v1.0 (POST /api/v1.0/vouchers/{appId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/vouchers/{voucherId}/usage": { "post": { "tags": [ "Vouchers" ], "operationId": "UpdateVoucherUsage", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "voucherId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The voucher id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVoucherUsage" }, "examples": { "UpdateVoucherUsageRequestExample": { "summary": "Default UpdateVoucherUsage request", "x-microcks-default": true, "value": { "IsUsed": true, "UsedByCustomerId": 500123, "TransactionKey": "string" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateVoucherUsage400Example": { "summary": "Default UpdateVoucherUsage 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": { "UpdateVoucherUsage401Example": { "summary": "Default UpdateVoucherUsage 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateVoucherUsage403Example": { "summary": "Default UpdateVoucherUsage 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": { "UpdateVoucherUsage404Example": { "summary": "Default UpdateVoucherUsage 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": { "UpdateVoucherUsage500Example": { "summary": "Default UpdateVoucherUsage 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 Voucher Usage", "description": "Update Voucher Usage via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/vouchers/{voucherId}/usage).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/vouchers/{voucherId}/validity-periods-simplified": { "post": { "tags": [ "Vouchers" ], "operationId": "SetVoucherValidityPeriodsSimplified", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "voucherId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The voucher id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetVoucherValidityPeriodsSimplifiedRequest" }, "examples": { "SetVoucherValidityPeriodsSimplifiedRequestExample": { "summary": "Default SetVoucherValidityPeriodsSimplified request", "x-microcks-default": true, "value": { "DaysOfWeek": [ "Sunday" ], "StartTime": "2026-06-02T12:00:00Z", "EndTime": "2026-06-02T12:00:00Z" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetVoucherValidityPeriodsSimplified400Example": { "summary": "Default SetVoucherValidityPeriodsSimplified 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": { "SetVoucherValidityPeriodsSimplified401Example": { "summary": "Default SetVoucherValidityPeriodsSimplified 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetVoucherValidityPeriodsSimplified403Example": { "summary": "Default SetVoucherValidityPeriodsSimplified 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": { "SetVoucherValidityPeriodsSimplified404Example": { "summary": "Default SetVoucherValidityPeriodsSimplified 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": { "SetVoucherValidityPeriodsSimplified500Example": { "summary": "Default SetVoucherValidityPeriodsSimplified 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 Voucher Validity Periods Simplified", "description": "Set Voucher Validity Periods Simplified via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/vouchers/{voucherId}/validity-periods-simplified).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } } }, "components": { "schemas": { "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 } } }, "CreatePayGreenConfigurationRequest": { "description": "CreatePayGreenConfigurationRequest.", "type": "object", "properties": { "Name": { "description": "Name.", "type": "string", "example": "Example Name" }, "PayGreenId": { "description": "PayGreenId.", "type": "string", "example": "500123" }, "PayGreenPrivateKey": { "description": "PayGreenPrivateKey.", "type": "string", "example": "string" }, "AssignedStores": { "description": "AssignedStores.", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] } } }, "CreatePromotion": { "description": "Create Promotion", "type": "object", "properties": { "Name": { "description": "Promotion Name", "type": "string", "example": "Example Name" }, "MenuItemPublicIds": { "description": "Promotion Menu Item Awards", "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "example": [ "00000000-0000-0000-0000-000000000000" ] } } }, "CreateVoucher": { "description": "Create Voucher", "type": "object", "properties": { "VoucherType": { "description": "Voucher Type", "enum": [ "PercentageDiscount", "LumpDiscount", "AddItem", "CreditNote", "FreeDelivery" ], "type": "string", "example": "PercentageDiscount" }, "Promotion": { "$ref": "#/components/schemas/CreatePromotion" }, "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 } } }, "CreditNoteDetails": { "description": "Credit note details", "type": "object", "properties": { "RemainingCredit": { "format": "double", "description": "Remaining credit", "type": "number", "example": 1.0 } } }, "CrossSellMenuItems": { "description": "Menu Items for Cross-Sell", "type": "object", "properties": { "MenuItemIds": { "description": "Menu Item Id's", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] } } }, "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'." } } } } }, "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 } } }, "LumpDiscountDetails": { "description": "Lump discount details", "type": "object", "properties": { "DiscountAmount": { "format": "double", "description": "Discount amount", "type": "number", "example": 12.5 } } }, "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 } } }, "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": [] } } }, "PushNotificationResponse": { "description": "Push Notification", "required": [ "Message" ], "type": "object", "properties": { "Sent": { "description": "Sent", "type": "boolean", "example": true }, "ScheduledPushNotificationId": { "format": "int32", "description": "Push notification identifier", "type": "integer", "example": 500123 }, "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" } } }, "RestApiArrayResult_LoyaltyCampaign_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/LoyaltyCampaign" }, "example": [] } } }, "RestApiArrayResult_RestaurantVoucherEligibleStore_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/RestaurantVoucherEligibleStore" }, "example": [] } } }, "RestApiArrayResult_RestaurantVoucherPayGreenConfigurationSummary_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/RestaurantVoucherPayGreenConfigurationSummary" }, "example": [] } } }, "RestApiArrayResult_RestaurantVoucherPayGreenConfiguration_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/RestaurantVoucherPayGreenConfiguration" }, "example": [] } } }, "RestApiArrayResult_RetentionCampaign_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/RetentionCampaign" }, "example": [] } } }, "RestApiArrayResult_StoreListItem_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/StoreListItem" }, "example": [] } } }, "RestApiArrayResult_VoucherDataPoint_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/VoucherDataPoint" }, "example": [] } } }, "RestApiArrayResult_VoucherSummary_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/VoucherSummary" }, "example": [] } } }, "RestApiPaginationResult_PushNotificationResponse_": { "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/PushNotificationResponse" }, "example": [] } } }, "RestApiPaginationResult_VoucherSummary_": { "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/VoucherSummary" }, "example": [] } } }, "RestApiResult_CrossSellMenuItems_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/CrossSellMenuItems" } } }, "RestApiResult_LoyaltyCampaign_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/LoyaltyCampaign" } } }, "RestApiResult_PushNotificationResponse_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/PushNotificationResponse" } } }, "RestApiResult_RestaurantVoucherPayGreenConfiguration_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/RestaurantVoucherPayGreenConfiguration" } } }, "RestApiResult_RestaurantVoucherPayGreenStoreConfiguration_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/RestaurantVoucherPayGreenStoreConfiguration" } } }, "RestApiResult_RetentionCampaign_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/RetentionCampaign" } } }, "RestApiResult_VoucherWithStats_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/VoucherWithStats" } } }, "RestApiResult_Voucher_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/Voucher" } } }, "RestaurantVoucherAssignedStore": { "description": "RestaurantVoucherAssignedStore.", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "StoreId.", "type": "integer", "example": 500123 }, "Name": { "description": "Name.", "type": "string", "example": "Example Name" }, "Active": { "description": "Active.", "type": "boolean", "example": true } } }, "RestaurantVoucherEligibleStore": { "description": "RestaurantVoucherEligibleStore.", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "StoreId.", "type": "integer", "example": 500123 }, "Name": { "description": "Name.", "type": "string", "example": "Example Name" } } }, "RestaurantVoucherPayGreenConfiguration": { "description": "RestaurantVoucherPayGreenConfiguration.", "type": "object", "properties": { "Name": { "description": "Name.", "type": "string", "example": "Example Name" }, "PayGreenId": { "description": "PayGreenId.", "type": "string", "example": "500123" }, "PayGreenConfigurationId": { "format": "int32", "description": "PayGreenConfigurationId.", "type": "integer", "example": 500123 }, "AssignedStores": { "description": "AssignedStores.", "type": "array", "items": { "$ref": "#/components/schemas/RestaurantVoucherAssignedStore" }, "example": [] } } }, "RestaurantVoucherPayGreenConfigurationSummary": { "description": "RestaurantVoucherPayGreenConfigurationSummary.", "type": "object", "properties": { "Name": { "description": "Name.", "type": "string", "example": "Example Name" }, "PayGreenConfigurationId": { "format": "int32", "description": "PayGreenConfigurationId.", "type": "integer", "example": 500123 } } }, "RestaurantVoucherPayGreenStoreConfiguration": { "description": "RestaurantVoucherPayGreenStoreConfiguration.", "type": "object", "properties": { "Name": { "description": "Name.", "type": "string", "example": "Example Name" }, "Active": { "description": "Active.", "type": "boolean", "example": true }, "PayGreenId": { "description": "PayGreenId.", "type": "string", "example": "500123" }, "PayGreenConfigurationId": { "format": "int32", "description": "PayGreenConfigurationId.", "type": "integer", "example": 500123 } } }, "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 } } }, "SetVoucherValidityPeriodsSimplifiedRequest": { "description": "Set the validity periods of a voucher.", "type": "object", "properties": { "DaysOfWeek": { "description": "Days of week when the voucher is valid", "type": "array", "items": { "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string" }, "example": [ "Sunday" ] }, "StartTime": { "description": "Start time of the day when the voucher is valid", "type": "string", "example": "2026-06-02T12:00:00Z" }, "EndTime": { "description": "End time of the day when the voucher is valid.\r\nIf the end time is before the start time, the end time is assumed to be the next day.", "type": "string", "example": "2026-06-02T12:00:00Z" } } }, "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" } } }, "StoreListItem": { "description": "Store id and name", "type": "object", "properties": { "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreName": { "description": "Store Name", "type": "string", "example": "Example Name" }, "StoreGroupId": { "format": "int32", "description": "Store Group Id", "type": "integer", "example": 500123 }, "StoreGroupName": { "description": "Store Group Name", "type": "string", "example": "Example Name" }, "HasLoyaltyCampaign": { "description": "Store has loyalty campaign", "type": "boolean", "example": true }, "HasRetentionCampaign": { "description": "Store has retention campaign", "type": "boolean", "example": true }, "IsPublished": { "description": "Is Published store", "type": "boolean", "example": true } } }, "UpdatePayGreenConfigurationRequest": { "description": "UpdatePayGreenConfigurationRequest.", "type": "object", "properties": { "Name": { "description": "Name.", "type": "string", "example": "Example Name" }, "AssignedStores": { "description": "AssignedStores.", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] } } }, "UpdateStorePayGreenConfigurationRequest": { "description": "UpdateStorePayGreenConfigurationRequest.", "type": "object", "properties": { "Active": { "description": "Active.", "type": "boolean", "example": true }, "PayGreenConfigurationId": { "format": "int32", "description": "PayGreenConfigurationId.", "type": "integer", "example": 500123 } } }, "UpdateVoucher": { "description": "Update Voucher", "type": "object", "properties": { "PromotionId": { "format": "int32", "description": "Promotion ID to update", "type": "integer", "example": 500123 }, "PromotionName": { "description": "The updated name of the promotion", "type": "string", "example": "Example Name" }, "PromotionAwardMenuItemPublicIds": { "description": "The updated menu items that the promotion awards", "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "example": [ "00000000-0000-0000-0000-000000000000" ] }, "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 } } }, "UpdateVoucherUsage": { "description": "Update Voucher Usage", "type": "object", "properties": { "IsUsed": { "description": "Flag indicating whether the voucher is used", "type": "boolean", "example": true }, "UsedByCustomerId": { "format": "int32", "description": "Indicates Customer that used the voucher.", "type": "integer", "nullable": true, "example": 500123 }, "TransactionKey": { "description": "An opaque string, to ensure idempotency. This allows for safely retrying requests without accidentally performing the same stamp operation twice. \r\nThis will typically contain the the ID of the sale order.", "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 } } }, "VoucherDataPoint": { "description": "A single data point in timeline graphs related to Vouchers", "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 } } }, "VoucherSummary": { "description": "Voucher Summary", "type": "object", "properties": { "VoucherId": { "format": "int32", "description": "Voucher Id", "type": "integer", "example": 500123 }, "Code": { "description": "Voucher Code", "type": "string", "example": "string" }, "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" }, "VoucherSubType": { "description": "Voucher Sub Type", "enum": [ "None", "SignUp", "Loyalty", "Loyalty25", "Retention", "SecondaryRetention", "Custom" ], "type": "string", "example": "None" }, "Description": { "description": "Voucher Description (Visible on printout)", "type": "string", "example": "string" }, "IsEnabled": { "description": "Is voucher enabled", "type": "boolean", "example": true }, "StoreNames": { "description": "Store names associated with this voucher", "type": "array", "items": { "type": "string" }, "example": [ "Example Name" ] }, "IsAvailableOnAllStores": { "description": "True if the voucher is available on all active stores in the app", "type": "boolean", "example": true } } }, "VoucherWithStats": { "description": "Voucher With Statistics", "type": "object", "properties": { "TotalUsed": { "format": "int32", "description": "Total times the voucher was used", "type": "integer", "nullable": true, "example": 12.5 }, "TotalCustomers": { "format": "int32", "description": "Total amount of customers who used this voucher", "type": "integer", "nullable": true, "example": 12.5 }, "TotalAmountFromOrders": { "format": "double", "description": "Total amount of money from orders", "type": "number", "nullable": true, "example": 12.5 }, "TotalDiscounted": { "format": "double", "description": "Total amount of money given away", "type": "number", "nullable": true, "example": 12.5 }, "AverageOrderSize": { "format": "double", "description": "Average Order Size", "type": "number", "nullable": true, "example": 1.0 }, "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 } } } }, "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" } } } } } } }