{ "openapi": "3.0.3", "info": { "title": "Flipdish API - Customers", "version": "v1.0", "description": "Flipdish Open API v1.0 \u2014 Customers 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": "Accounts", "description": "Operations for Accounts." }, { "name": "Customers", "description": "Operations for Customers." }, { "name": "Drivers", "description": "Operations for Drivers." }, { "name": "Teammates", "description": "Operations for Teammates." }, { "name": "Users", "description": "Operations for Users." } ], "paths": { "/api/v1.0/accounts": { "get": { "tags": [ "Accounts" ], "operationId": "GetAccountDetails", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AccountDetail_" }, "examples": { "GetAccountDetails200Example": { "summary": "Default GetAccountDetails 200 response", "x-microcks-default": true, "value": { "Data": { "Email": "owner@example.com", "SignupSteps": [], "IsVerified": true, "IsSelfServeUser": true, "AccountId": 500123, "Name": "Example Name", "Language": "string", "TimeZoneInfoId": "500123", "DisplayTimesInUserLocalTimeZone": true, "ShowHiddenFeatures": true, "CreatedAt": "2026-06-02T12:00:00Z" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAccountDetails400Example": { "summary": "Default GetAccountDetails 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAccountDetails401Example": { "summary": "Default GetAccountDetails 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAccountDetails403Example": { "summary": "Default GetAccountDetails 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": { "GetAccountDetails500Example": { "summary": "Default GetAccountDetails 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 Account Details", "description": "Get Account Details via the Flipdish Open API v1.0 (GET /api/v1.0/accounts).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "put": { "tags": [ "Accounts" ], "operationId": "UpdateAccount", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountDetailBase" }, "examples": { "UpdateAccountRequestExample": { "summary": "Default UpdateAccount request", "x-microcks-default": true, "value": { "Name": "Example Name", "Language": "string", "TimeZoneInfoId": "500123", "DisplayTimesInUserLocalTimeZone": true, "ShowHiddenFeatures": true, "CreatedAt": "2026-06-02T12:00:00Z" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAccount400Example": { "summary": "Default UpdateAccount 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAccount401Example": { "summary": "Default UpdateAccount 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAccount403Example": { "summary": "Default UpdateAccount 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": { "UpdateAccount500Example": { "summary": "Default UpdateAccount 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 Account", "description": "Update Account via the Flipdish Open API v1.0 (PUT /api/v1.0/accounts).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Accounts" ], "operationId": "CreateAccount", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountModel" }, "examples": { "CreateAccountRequestExample": { "summary": "Default CreateAccount request", "x-microcks-default": true, "value": { "Email": "owner@example.com", "StoreName": "Example Name", "LanguageId": "500123", "Rid": 500123, "Cid": "500123", "RecaptchaToken": "string" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateAccount400Example": { "summary": "Default CreateAccount 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateAccount401Example": { "summary": "Default CreateAccount 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateAccount403Example": { "summary": "Default CreateAccount 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": { "CreateAccount500Example": { "summary": "Default CreateAccount 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 Account", "description": "Create Account via the Flipdish Open API v1.0 (POST /api/v1.0/accounts).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/accounts/timezones": { "get": { "tags": [ "Accounts" ], "operationId": "GetLocalisedTimeZones", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_LocalisedTimeZone_" }, "examples": { "GetLocalisedTimeZones200Example": { "summary": "Default GetLocalisedTimeZones 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetLocalisedTimeZones400Example": { "summary": "Default GetLocalisedTimeZones 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetLocalisedTimeZones401Example": { "summary": "Default GetLocalisedTimeZones 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetLocalisedTimeZones403Example": { "summary": "Default GetLocalisedTimeZones 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": { "GetLocalisedTimeZones500Example": { "summary": "Default GetLocalisedTimeZones 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 Localised Time Zones", "description": "Get Localised Time Zones via the Flipdish Open API v1.0 (GET /api/v1.0/accounts/timezones).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/accounts/password": { "put": { "tags": [ "Accounts" ], "operationId": "ChangePassword", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordModel" }, "examples": { "ChangePasswordRequestExample": { "summary": "Default ChangePassword request", "x-microcks-default": true, "value": { "OldPassword": "string", "NewPassword": "string" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ChangePassword400Example": { "summary": "Default ChangePassword 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ChangePassword401Example": { "summary": "Default ChangePassword 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ChangePassword403Example": { "summary": "Default ChangePassword 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ChangePassword409Example": { "summary": "Default ChangePassword 409 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ChangePassword500Example": { "summary": "Default ChangePassword 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 Change Password", "description": "Change Password via the Flipdish Open API v1.0 (PUT /api/v1.0/accounts/password).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Accounts" ], "operationId": "PasswordResetWithToken", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordResetModel" }, "examples": { "PasswordResetWithTokenRequestExample": { "summary": "Default PasswordResetWithToken request", "x-microcks-default": true, "value": { "TokenId": "500123", "Email": "owner@example.com", "Password": "string", "PasswordConfirmation": "string", "Token": "string" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "PasswordResetWithToken400Example": { "summary": "Default PasswordResetWithToken 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "PasswordResetWithToken401Example": { "summary": "Default PasswordResetWithToken 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "PasswordResetWithToken403Example": { "summary": "Default PasswordResetWithToken 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": { "PasswordResetWithToken500Example": { "summary": "Default PasswordResetWithToken 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 Password Reset with Token", "description": "Password Reset with Token via the Flipdish Open API v1.0 (POST /api/v1.0/accounts/password).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/accounts/password/pin": { "put": { "tags": [ "Accounts" ], "operationId": "ChangePasswordWithPin", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPasswordWithPinModel" }, "examples": { "ChangePasswordWithPinRequestExample": { "summary": "Default ChangePasswordWithPin request", "x-microcks-default": true, "value": { "Pin": 1, "NewPassword": "string", "RecaptchaToken": "string" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ChangePasswordWithPin400Example": { "summary": "Default ChangePasswordWithPin 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ChangePasswordWithPin401Example": { "summary": "Default ChangePasswordWithPin 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ChangePasswordWithPin403Example": { "summary": "Default ChangePasswordWithPin 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ChangePasswordWithPin409Example": { "summary": "Default ChangePasswordWithPin 409 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ChangePasswordWithPin500Example": { "summary": "Default ChangePasswordWithPin 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 Change Password with Pin", "description": "Change Password with Pin via the Flipdish Open API v1.0 (PUT /api/v1.0/accounts/password/pin).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/accounts/pin": { "post": { "tags": [ "Accounts" ], "operationId": "RequestLoginPin", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestLoginPinModel" }, "examples": { "RequestLoginPinRequestExample": { "summary": "Default RequestLoginPin request", "x-microcks-default": true, "value": { "Email": "owner@example.com" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestLoginPinResponse" }, "examples": { "RequestLoginPin200Example": { "summary": "Default RequestLoginPin 200 response", "x-microcks-default": true, "value": { "LoginPinSentViaEmail": true, "ForceOktaLogin": true } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RequestLoginPin400Example": { "summary": "Default RequestLoginPin 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RequestLoginPin401Example": { "summary": "Default RequestLoginPin 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RequestLoginPin403Example": { "summary": "Default RequestLoginPin 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": { "RequestLoginPin500Example": { "summary": "Default RequestLoginPin 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 Request Login Pin", "description": "Request Login Pin via the Flipdish Open API v1.0 (POST /api/v1.0/accounts/pin).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/accounts/login": { "post": { "tags": [ "Accounts" ], "operationId": "Login", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginModel" }, "examples": { "LoginRequestExample": { "summary": "Default Login request", "x-microcks-default": true, "value": { "Email": "owner@example.com", "Password": "string" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Login400Example": { "summary": "Default Login 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Login401Example": { "summary": "Default Login 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Login403Example": { "summary": "Default Login 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": { "Login500Example": { "summary": "Default Login 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Login", "description": "Login via the Flipdish Open API v1.0 (POST /api/v1.0/accounts/login).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/accounts/logout": { "post": { "tags": [ "Accounts" ], "operationId": "Logout", "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Logout400Example": { "summary": "Default Logout 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Logout401Example": { "summary": "Default Logout 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Logout403Example": { "summary": "Default Logout 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": { "Logout500Example": { "summary": "Default Logout 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 Logout", "description": "Logout via the Flipdish Open API v1.0 (POST /api/v1.0/accounts/logout).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/accounts/login/pin": { "post": { "tags": [ "Accounts" ], "operationId": "LoginWithPin", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginWithPinModel" }, "examples": { "LoginWithPinRequestExample": { "summary": "Default LoginWithPin request", "x-microcks-default": true, "value": { "Email": "owner@example.com", "Pin": 1 } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "LoginWithPin400Example": { "summary": "Default LoginWithPin 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "LoginWithPin401Example": { "summary": "Default LoginWithPin 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "LoginWithPin403Example": { "summary": "Default LoginWithPin 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": { "LoginWithPin500Example": { "summary": "Default LoginWithPin 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Login with Pin", "description": "Login with Pin via the Flipdish Open API v1.0 (POST /api/v1.0/accounts/login/pin).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/accounts/login/sso": { "post": { "tags": [ "Accounts" ], "operationId": "LoginSso", "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "LoginSso400Example": { "summary": "Default LoginSso 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "LoginSso401Example": { "summary": "Default LoginSso 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "LoginSso403Example": { "summary": "Default LoginSso 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": { "LoginSso500Example": { "summary": "Default LoginSso 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Login Sso", "description": "Login Sso via the Flipdish Open API v1.0 (POST /api/v1.0/accounts/login/sso).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/accounts/basic-account": { "post": { "tags": [ "Accounts" ], "operationId": "CreateBasicAccount", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBasicAccountModel" }, "examples": { "CreateBasicAccountRequestExample": { "summary": "Default CreateBasicAccount request", "x-microcks-default": true, "value": { "StoreName": "Example Name", "LanguageId": "500123" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "CreateBasicAccount200Example": { "summary": "Default CreateBasicAccount 200 response", "x-microcks-default": true, "value": "string" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateBasicAccount400Example": { "summary": "Default CreateBasicAccount 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateBasicAccount401Example": { "summary": "Default CreateBasicAccount 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateBasicAccount403Example": { "summary": "Default CreateBasicAccount 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": { "CreateBasicAccount500Example": { "summary": "Default CreateBasicAccount 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 Basic Account", "description": "Create Basic Account via the Flipdish Open API v1.0 (POST /api/v1.0/accounts/basic-account).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/accounts/passwordreset": { "post": { "tags": [ "Accounts" ], "operationId": "RequestPasswordReset", "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RequestPasswordReset400Example": { "summary": "Default RequestPasswordReset 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RequestPasswordReset401Example": { "summary": "Default RequestPasswordReset 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RequestPasswordReset403Example": { "summary": "Default RequestPasswordReset 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": { "RequestPasswordReset500Example": { "summary": "Default RequestPasswordReset 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 Request Password Reset", "description": "Request Password Reset via the Flipdish Open API v1.0 (POST /api/v1.0/accounts/passwordreset).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/accounts/password/resetpin": { "post": { "tags": [ "Accounts" ], "operationId": "SendPinForPasswordReset", "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestPasswordResetPinResponse" }, "examples": { "SendPinForPasswordReset200Example": { "summary": "Default SendPinForPasswordReset 200 response", "x-microcks-default": true, "value": { "PasswordResetPinSentViaEmail": true } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SendPinForPasswordReset400Example": { "summary": "Default SendPinForPasswordReset 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SendPinForPasswordReset401Example": { "summary": "Default SendPinForPasswordReset 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SendPinForPasswordReset403Example": { "summary": "Default SendPinForPasswordReset 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": { "SendPinForPasswordReset500Example": { "summary": "Default SendPinForPasswordReset 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 Send Pin for Password Reset", "description": "Send Pin for Password Reset via the Flipdish Open API v1.0 (POST /api/v1.0/accounts/password/resetpin).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/accounts/recaptcha": { "post": { "tags": [ "Accounts" ], "operationId": "RecaptchaValidate", "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The token query parameter.", "example": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RecaptchaValidate400Example": { "summary": "Default RecaptchaValidate 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RecaptchaValidate401Example": { "summary": "Default RecaptchaValidate 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RecaptchaValidate403Example": { "summary": "Default RecaptchaValidate 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": { "RecaptchaValidate500Example": { "summary": "Default RecaptchaValidate 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 Recaptcha Validate", "description": "Recaptcha Validate via the Flipdish Open API v1.0 (POST /api/v1.0/accounts/recaptcha).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/accounts/signupstep/{signupStepAction}/skip": { "post": { "tags": [ "Accounts" ], "operationId": "SkipSignupStep", "parameters": [ { "name": "signupStepAction", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Question", "StoreLocation", "PaymentSubscription", "StoreName" ] }, "description": "The signup step action path parameter.", "example": "Question" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SkipSignupStep400Example": { "summary": "Default SkipSignupStep 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SkipSignupStep401Example": { "summary": "Default SkipSignupStep 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SkipSignupStep403Example": { "summary": "Default SkipSignupStep 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": { "SkipSignupStep500Example": { "summary": "Default SkipSignupStep 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 Skip Signup Step", "description": "Skip Signup Step via the Flipdish Open API v1.0 (POST /api/v1.0/accounts/signupstep/{signupStepAction}/skip).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/accounts/signupstep/{signupStepAction}/answer": { "post": { "tags": [ "Accounts" ], "operationId": "AnswerSignUpQuestion", "parameters": [ { "name": "signupStepAction", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Question", "StoreLocation", "PaymentSubscription", "StoreName" ] }, "description": "The signup step action path parameter.", "example": "Question" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "format": "int32", "type": "integer" }, "examples": { "AnswerSignUpQuestionRequestExample": { "summary": "Default AnswerSignUpQuestion request", "x-microcks-default": true, "value": 1 } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AnswerSignUpQuestion400Example": { "summary": "Default AnswerSignUpQuestion 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AnswerSignUpQuestion401Example": { "summary": "Default AnswerSignUpQuestion 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AnswerSignUpQuestion403Example": { "summary": "Default AnswerSignUpQuestion 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": { "AnswerSignUpQuestion500Example": { "summary": "Default AnswerSignUpQuestion 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 Answer Sign Up Question", "description": "Answer Sign Up Question via the Flipdish Open API v1.0 (POST /api/v1.0/accounts/signupstep/{signupStepAction}/answer).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/customers/{customerId}": { "get": { "tags": [ "Customers" ], "operationId": "GetCustomerById", "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/RestApiResult_Customer_" }, "examples": { "GetCustomerById200Example": { "summary": "Default GetCustomerById 200 response", "x-microcks-default": true, "value": { "Data": { "CustomerId": 500123, "Name": "Example Name", "RegistrationDate": "2026-06-02T12:00:00Z", "PhoneNumber": "+353000000000", "CashOrdersEnabled": true, "CardOrdersEnabled": true, "MarketingEnabled": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCustomerById400Example": { "summary": "Default GetCustomerById 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCustomerById401Example": { "summary": "Default GetCustomerById 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCustomerById403Example": { "summary": "Default GetCustomerById 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": { "GetCustomerById500Example": { "summary": "Default GetCustomerById 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Customer by Id", "description": "Get Customer by Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/customers/{customerId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Customers" ], "operationId": "UpdateCustomerById", "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 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerUpdateModel" }, "examples": { "UpdateCustomerByIdRequestExample": { "summary": "Default UpdateCustomerById request", "x-microcks-default": true, "value": { "CashOrdersEnabled": true, "CardOrdersEnabled": true, "MarketingEnabled": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Customer_" }, "examples": { "UpdateCustomerById200Example": { "summary": "Default UpdateCustomerById 200 response", "x-microcks-default": true, "value": { "Data": { "CustomerId": 500123, "Name": "Example Name", "RegistrationDate": "2026-06-02T12:00:00Z", "PhoneNumber": "+353000000000", "CashOrdersEnabled": true, "CardOrdersEnabled": true, "MarketingEnabled": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateCustomerById400Example": { "summary": "Default UpdateCustomerById 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateCustomerById401Example": { "summary": "Default UpdateCustomerById 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateCustomerById403Example": { "summary": "Default UpdateCustomerById 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": { "UpdateCustomerById500Example": { "summary": "Default UpdateCustomerById 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 Customer by Id", "description": "Update Customer by Id via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/customers/{customerId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/customers": { "get": { "tags": [ "Customers" ], "operationId": "GetCustomers", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "phoneNumber", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The phone number query parameter.", "example": "+353000000000" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Customers_" }, "examples": { "GetCustomers200Example": { "summary": "Default GetCustomers 200 response", "x-microcks-default": true, "value": { "Data": { "Items": [] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCustomers400Example": { "summary": "Default GetCustomers 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCustomers401Example": { "summary": "Default GetCustomers 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCustomers403Example": { "summary": "Default GetCustomers 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": { "GetCustomers500Example": { "summary": "Default GetCustomers 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 Customers", "description": "Get Customers via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/customers).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Customers" ], "operationId": "CreateCustomer", "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/CustomerCreateModel" }, "examples": { "CreateCustomerRequestExample": { "summary": "Default CreateCustomer request", "x-microcks-default": true, "value": { "PhoneNumber": "+353000000000", "AppType": "Unknown", "Name": "Example Name" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Customer_" }, "examples": { "CreateCustomer200Example": { "summary": "Default CreateCustomer 200 response", "x-microcks-default": true, "value": { "Data": { "CustomerId": 500123, "Name": "Example Name", "RegistrationDate": "2026-06-02T12:00:00Z", "PhoneNumber": "+353000000000", "CashOrdersEnabled": true, "CardOrdersEnabled": true, "MarketingEnabled": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateCustomer400Example": { "summary": "Default CreateCustomer 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateCustomer401Example": { "summary": "Default CreateCustomer 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateCustomer403Example": { "summary": "Default CreateCustomer 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": { "CreateCustomer500Example": { "summary": "Default CreateCustomer 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 Customer", "description": "Create Customer via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/customers).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/drivers/profile": { "get": { "tags": [ "Drivers" ], "operationId": "Drivers_GetDriverProfile", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Drivers_GetDriverProfile200Example": { "summary": "Default Drivers_GetDriverProfile 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_GetDriverProfile400Example": { "summary": "Default Drivers_GetDriverProfile 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_GetDriverProfile401Example": { "summary": "Default Drivers_GetDriverProfile 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_GetDriverProfile403Example": { "summary": "Default Drivers_GetDriverProfile 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "410": { "description": "Gone" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_GetDriverProfile500Example": { "summary": "Default Drivers_GetDriverProfile 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 Drivers_Get Driver Profile", "description": "Drivers_Get Driver Profile via the Flipdish Open API v1.0 (GET /api/v1.0/drivers/profile).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Drivers" ], "operationId": "Drivers_UpdateDriverProfile", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDriverProfileModel" }, "examples": { "Drivers_UpdateDriverProfileRequestExample": { "summary": "Default Drivers_UpdateDriverProfile request", "x-microcks-default": true, "value": { "Name": "Example Name" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Drivers_UpdateDriverProfile200Example": { "summary": "Default Drivers_UpdateDriverProfile 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_UpdateDriverProfile400Example": { "summary": "Default Drivers_UpdateDriverProfile 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_UpdateDriverProfile401Example": { "summary": "Default Drivers_UpdateDriverProfile 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_UpdateDriverProfile403Example": { "summary": "Default Drivers_UpdateDriverProfile 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": { "Drivers_UpdateDriverProfile500Example": { "summary": "Default Drivers_UpdateDriverProfile 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 Drivers_Update Driver Profile", "description": "Drivers_Update Driver Profile via the Flipdish Open API v1.0 (POST /api/v1.0/drivers/profile).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/drivers/assignedstores": { "get": { "tags": [ "Drivers" ], "operationId": "Drivers_GetStoresForDriver", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Drivers_GetStoresForDriver200Example": { "summary": "Default Drivers_GetStoresForDriver 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_GetStoresForDriver400Example": { "summary": "Default Drivers_GetStoresForDriver 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_GetStoresForDriver401Example": { "summary": "Default Drivers_GetStoresForDriver 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_GetStoresForDriver403Example": { "summary": "Default Drivers_GetStoresForDriver 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "410": { "description": "Gone" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_GetStoresForDriver500Example": { "summary": "Default Drivers_GetStoresForDriver 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 Drivers_Get Stores for Driver", "description": "Drivers_Get Stores for Driver via the Flipdish Open API v1.0 (GET /api/v1.0/drivers/assignedstores).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/drivers/pin": { "post": { "tags": [ "Drivers" ], "operationId": "Drivers_DriverRequestLoginCodeSms", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRequestLoginPinModel" }, "examples": { "Drivers_DriverRequestLoginCodeSmsRequestExample": { "summary": "Default Drivers_DriverRequestLoginCodeSms request", "x-microcks-default": true, "value": { "PhoneNumber": "+353000000000" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Drivers_DriverRequestLoginCodeSms200Example": { "summary": "Default Drivers_DriverRequestLoginCodeSms 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_DriverRequestLoginCodeSms400Example": { "summary": "Default Drivers_DriverRequestLoginCodeSms 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_DriverRequestLoginCodeSms401Example": { "summary": "Default Drivers_DriverRequestLoginCodeSms 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_DriverRequestLoginCodeSms403Example": { "summary": "Default Drivers_DriverRequestLoginCodeSms 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "410": { "description": "Gone" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_DriverRequestLoginCodeSms500Example": { "summary": "Default Drivers_DriverRequestLoginCodeSms 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 Drivers_Driver Request Login Code Sms", "description": "Drivers_Driver Request Login Code Sms via the Flipdish Open API v1.0 (POST /api/v1.0/drivers/pin).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/drivers/login": { "post": { "tags": [ "Drivers" ], "operationId": "Drivers_DriverLogin", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverLoginModel" }, "examples": { "Drivers_DriverLoginRequestExample": { "summary": "Default Drivers_DriverLogin request", "x-microcks-default": true, "value": { "PhoneNumber": "+353000000000", "Code": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Drivers_DriverLogin200Example": { "summary": "Default Drivers_DriverLogin 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_DriverLogin400Example": { "summary": "Default Drivers_DriverLogin 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_DriverLogin401Example": { "summary": "Default Drivers_DriverLogin 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_DriverLogin403Example": { "summary": "Default Drivers_DriverLogin 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "410": { "description": "Gone" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_DriverLogin500Example": { "summary": "Default Drivers_DriverLogin 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 Drivers_Driver Login", "description": "Drivers_Driver Login via the Flipdish Open API v1.0 (POST /api/v1.0/drivers/login).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/drivers/token": { "post": { "tags": [ "Drivers" ], "operationId": "Drivers_AddDriverNotificationToken", "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Drivers_AddDriverNotificationToken200Example": { "summary": "Default Drivers_AddDriverNotificationToken 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_AddDriverNotificationToken400Example": { "summary": "Default Drivers_AddDriverNotificationToken 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_AddDriverNotificationToken401Example": { "summary": "Default Drivers_AddDriverNotificationToken 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_AddDriverNotificationToken403Example": { "summary": "Default Drivers_AddDriverNotificationToken 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "410": { "description": "Gone" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_AddDriverNotificationToken500Example": { "summary": "Default Drivers_AddDriverNotificationToken 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 Drivers_Add Driver Notification Token", "description": "Drivers_Add Driver Notification Token via the Flipdish Open API v1.0 (POST /api/v1.0/drivers/token).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Drivers" ], "operationId": "Drivers_RemoveDriverNotificationToken", "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Drivers_RemoveDriverNotificationToken200Example": { "summary": "Default Drivers_RemoveDriverNotificationToken 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_RemoveDriverNotificationToken400Example": { "summary": "Default Drivers_RemoveDriverNotificationToken 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_RemoveDriverNotificationToken401Example": { "summary": "Default Drivers_RemoveDriverNotificationToken 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_RemoveDriverNotificationToken403Example": { "summary": "Default Drivers_RemoveDriverNotificationToken 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "410": { "description": "Gone" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_RemoveDriverNotificationToken500Example": { "summary": "Default Drivers_RemoveDriverNotificationToken 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 Drivers_Remove Driver Notification Token", "description": "Drivers_Remove Driver Notification Token via the Flipdish Open API v1.0 (DELETE /api/v1.0/drivers/token).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/drivers/profile/image": { "post": { "tags": [ "Drivers" ], "operationId": "Drivers_SetDriverProfileImage", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Drivers_SetDriverProfileImage200Example": { "summary": "Default Drivers_SetDriverProfileImage 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_SetDriverProfileImage400Example": { "summary": "Default Drivers_SetDriverProfileImage 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_SetDriverProfileImage401Example": { "summary": "Default Drivers_SetDriverProfileImage 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_SetDriverProfileImage403Example": { "summary": "Default Drivers_SetDriverProfileImage 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "410": { "description": "Gone" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_SetDriverProfileImage500Example": { "summary": "Default Drivers_SetDriverProfileImage 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 Drivers_Set Driver Profile Image", "description": "Drivers_Set Driver Profile Image via the Flipdish Open API v1.0 (POST /api/v1.0/drivers/profile/image).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Drivers" ], "operationId": "Drivers_DeleteDriverProfileImage", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Drivers_DeleteDriverProfileImage200Example": { "summary": "Default Drivers_DeleteDriverProfileImage 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_DeleteDriverProfileImage400Example": { "summary": "Default Drivers_DeleteDriverProfileImage 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_DeleteDriverProfileImage401Example": { "summary": "Default Drivers_DeleteDriverProfileImage 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_DeleteDriverProfileImage403Example": { "summary": "Default Drivers_DeleteDriverProfileImage 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "410": { "description": "Gone" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_DeleteDriverProfileImage500Example": { "summary": "Default Drivers_DeleteDriverProfileImage 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 Drivers_Delete Driver Profile Image", "description": "Drivers_Delete Driver Profile Image via the Flipdish Open API v1.0 (DELETE /api/v1.0/drivers/profile/image).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/drivers/stores/{storeId}/presence/{presence}": { "post": { "tags": [ "Drivers" ], "operationId": "Drivers_SetDriverPresenceForStore", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 }, { "name": "presence", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Offline", "Online" ] }, "description": "The presence path parameter.", "example": "Offline" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Drivers_SetDriverPresenceForStore200Example": { "summary": "Default Drivers_SetDriverPresenceForStore 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_SetDriverPresenceForStore400Example": { "summary": "Default Drivers_SetDriverPresenceForStore 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_SetDriverPresenceForStore401Example": { "summary": "Default Drivers_SetDriverPresenceForStore 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_SetDriverPresenceForStore403Example": { "summary": "Default Drivers_SetDriverPresenceForStore 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "410": { "description": "Gone" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_SetDriverPresenceForStore500Example": { "summary": "Default Drivers_SetDriverPresenceForStore 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 Drivers_Set Driver Presence for Store", "description": "Drivers_Set Driver Presence for Store via the Flipdish Open API v1.0 (POST /api/v1.0/drivers/stores/{storeId}/presence/{presence}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/orders/{orderId}/tracking/{deliveryTrackingStatus}": { "post": { "tags": [ "Drivers" ], "operationId": "Drivers_UpdateDeliveryTrackingStatus", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The order id path parameter.", "example": 500123 }, { "name": "deliveryTrackingStatus", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Unassigned", "Unaccepted", "Accepted", "Carrying", "OnTheWay", "ArrivedAtLocation", "Delivered", "CannotDeliver" ] }, "description": "The delivery tracking status path parameter.", "example": "Unassigned" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Drivers_UpdateDeliveryTrackingStatus200Example": { "summary": "Default Drivers_UpdateDeliveryTrackingStatus 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_UpdateDeliveryTrackingStatus400Example": { "summary": "Default Drivers_UpdateDeliveryTrackingStatus 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_UpdateDeliveryTrackingStatus401Example": { "summary": "Default Drivers_UpdateDeliveryTrackingStatus 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_UpdateDeliveryTrackingStatus403Example": { "summary": "Default Drivers_UpdateDeliveryTrackingStatus 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "410": { "description": "Gone" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Drivers_UpdateDeliveryTrackingStatus500Example": { "summary": "Default Drivers_UpdateDeliveryTrackingStatus 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 Drivers_Update Delivery Tracking Status", "description": "Drivers_Update Delivery Tracking Status via the Flipdish Open API v1.0 (POST /api/v1.0/orders/{orderId}/tracking/{deliveryTrackingStatus}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/teammates": { "get": { "tags": [ "Teammates" ], "operationId": "GetTeammatesByAppId", "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_Teammate_" }, "examples": { "GetTeammatesByAppId200Example": { "summary": "Default GetTeammatesByAppId 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetTeammatesByAppId400Example": { "summary": "Default GetTeammatesByAppId 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetTeammatesByAppId401Example": { "summary": "Default GetTeammatesByAppId 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetTeammatesByAppId403Example": { "summary": "Default GetTeammatesByAppId 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": { "GetTeammatesByAppId404Example": { "summary": "Default GetTeammatesByAppId 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": { "GetTeammatesByAppId500Example": { "summary": "Default GetTeammatesByAppId 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 Teammates by App Id", "description": "Get Teammates by App Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/teammates).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Teammates" ], "operationId": "CreateTeammate", "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_Teammate_" }, "examples": { "CreateTeammate200Example": { "summary": "Default CreateTeammate 200 response", "x-microcks-default": true, "value": { "Data": { "TeammateId": "500123", "UserId": 500123, "Name": "Example Name", "LastActivity": "2026-06-02T12:00:00Z", "AppId": "500123", "InvitationStatus": "Pending", "Email": "owner@example.com", "AppAccessLevel": "None", "HasAccessToAllStores": true, "StoreIds": [ 1 ], "PropertyIds": [ "string" ] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateTeammate400Example": { "summary": "Default CreateTeammate 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateTeammate401Example": { "summary": "Default CreateTeammate 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateTeammate403Example": { "summary": "Default CreateTeammate 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": { "CreateTeammate404Example": { "summary": "Default CreateTeammate 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": { "CreateTeammate500Example": { "summary": "Default CreateTeammate 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 Teammate", "description": "Create Teammate via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/teammates).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/teammates/{id}": { "get": { "tags": [ "Teammates" ], "operationId": "GetTeammateByAppIdAndTeammateId", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Teammate_" }, "examples": { "GetTeammateByAppIdAndTeammateId200Example": { "summary": "Default GetTeammateByAppIdAndTeammateId 200 response", "x-microcks-default": true, "value": { "Data": { "TeammateId": "500123", "UserId": 500123, "Name": "Example Name", "LastActivity": "2026-06-02T12:00:00Z", "AppId": "500123", "InvitationStatus": "Pending", "Email": "owner@example.com", "AppAccessLevel": "None", "HasAccessToAllStores": true, "StoreIds": [ 1 ], "PropertyIds": [ "string" ] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetTeammateByAppIdAndTeammateId400Example": { "summary": "Default GetTeammateByAppIdAndTeammateId 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetTeammateByAppIdAndTeammateId401Example": { "summary": "Default GetTeammateByAppIdAndTeammateId 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetTeammateByAppIdAndTeammateId403Example": { "summary": "Default GetTeammateByAppIdAndTeammateId 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": { "GetTeammateByAppIdAndTeammateId404Example": { "summary": "Default GetTeammateByAppIdAndTeammateId 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": { "GetTeammateByAppIdAndTeammateId500Example": { "summary": "Default GetTeammateByAppIdAndTeammateId 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 Teammate by App Id and Teammate Id", "description": "Get Teammate by App Id and Teammate Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/teammates/{id}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Teammates" ], "operationId": "UpdateTeammate", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeammateBase" }, "examples": { "UpdateTeammateRequestExample": { "summary": "Default UpdateTeammate request", "x-microcks-default": true, "value": { "AppAccessLevel": "None", "HasAccessToAllStores": true, "StoreIds": [ 1 ], "PropertyIds": [ "string" ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Teammate_" }, "examples": { "UpdateTeammate200Example": { "summary": "Default UpdateTeammate 200 response", "x-microcks-default": true, "value": { "Data": { "TeammateId": "500123", "UserId": 500123, "Name": "Example Name", "LastActivity": "2026-06-02T12:00:00Z", "AppId": "500123", "InvitationStatus": "Pending", "Email": "owner@example.com", "AppAccessLevel": "None", "HasAccessToAllStores": true, "StoreIds": [ 1 ], "PropertyIds": [ "string" ] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateTeammate400Example": { "summary": "Default UpdateTeammate 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateTeammate401Example": { "summary": "Default UpdateTeammate 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateTeammate403Example": { "summary": "Default UpdateTeammate 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": { "UpdateTeammate404Example": { "summary": "Default UpdateTeammate 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": { "UpdateTeammate500Example": { "summary": "Default UpdateTeammate 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 Teammate", "description": "Update Teammate via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/teammates/{id}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Teammates" ], "operationId": "DeleteTeammate", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteTeammate400Example": { "summary": "Default DeleteTeammate 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteTeammate401Example": { "summary": "Default DeleteTeammate 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteTeammate403Example": { "summary": "Default DeleteTeammate 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": { "DeleteTeammate404Example": { "summary": "Default DeleteTeammate 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": { "DeleteTeammate500Example": { "summary": "Default DeleteTeammate 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 Teammate", "description": "Delete Teammate via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/teammates/{id}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/teammates/pending-invitations": { "get": { "tags": [ "Teammates" ], "operationId": "Teammates_PendingInvitations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_PendingInvitation_" }, "examples": { "Teammates_PendingInvitations200Example": { "summary": "Default Teammates_PendingInvitations 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Teammates_PendingInvitations400Example": { "summary": "Default Teammates_PendingInvitations 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Teammates_PendingInvitations401Example": { "summary": "Default Teammates_PendingInvitations 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Teammates_PendingInvitations403Example": { "summary": "Default Teammates_PendingInvitations 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": { "Teammates_PendingInvitations500Example": { "summary": "Default Teammates_PendingInvitations 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 Teammates_Pending Invitations", "description": "Teammates_Pending Invitations via the Flipdish Open API v1.0 (GET /api/v1.0/teammates/pending-invitations).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/teammates/accept/{otc}": { "get": { "tags": [ "Teammates" ], "operationId": "Teammates_AcceptInvitation", "parameters": [ { "name": "otc", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The otc path parameter.", "example": "string" }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AcceptInvitationResult_" }, "examples": { "Teammates_AcceptInvitation200Example": { "summary": "Default Teammates_AcceptInvitation 200 response", "x-microcks-default": true, "value": { "Data": { "IsNewUser": true, "InvitedEmailAddress": "owner@example.com" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Teammates_AcceptInvitation400Example": { "summary": "Default Teammates_AcceptInvitation 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Teammates_AcceptInvitation401Example": { "summary": "Default Teammates_AcceptInvitation 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Teammates_AcceptInvitation403Example": { "summary": "Default Teammates_AcceptInvitation 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": { "Teammates_AcceptInvitation500Example": { "summary": "Default Teammates_AcceptInvitation 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 Teammates_Accept Invitation", "description": "Teammates_Accept Invitation via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/teammates/accept/{otc}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/teammates/redeem/{otc}": { "get": { "tags": [ "Teammates" ], "operationId": "RedeemInvitation", "parameters": [ { "name": "otc", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The otc path parameter.", "example": "string" }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_RedeemInvitationResult_" }, "examples": { "RedeemInvitation200Example": { "summary": "Default RedeemInvitation 200 response", "x-microcks-default": true, "value": { "Data": { "AppId": "500123", "InvitationStatus": "Pending" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RedeemInvitation400Example": { "summary": "Default RedeemInvitation 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RedeemInvitation401Example": { "summary": "Default RedeemInvitation 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RedeemInvitation403Example": { "summary": "Default RedeemInvitation 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": { "RedeemInvitation404Example": { "summary": "Default RedeemInvitation 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": { "RedeemInvitation500Example": { "summary": "Default RedeemInvitation 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 Redeem Invitation", "description": "Redeem Invitation via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/teammates/redeem/{otc}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/teammates/acceptInvitations": { "post": { "tags": [ "Teammates" ], "operationId": "Teammates_AcceptInvitations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_RedeemInvitationResult_" }, "examples": { "Teammates_AcceptInvitations200Example": { "summary": "Default Teammates_AcceptInvitations 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Teammates_AcceptInvitations400Example": { "summary": "Default Teammates_AcceptInvitations 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Teammates_AcceptInvitations401Example": { "summary": "Default Teammates_AcceptInvitations 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Teammates_AcceptInvitations403Example": { "summary": "Default Teammates_AcceptInvitations 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": { "Teammates_AcceptInvitations500Example": { "summary": "Default Teammates_AcceptInvitations 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 Teammates_Accept Invitations", "description": "Teammates_Accept Invitations via the Flipdish Open API v1.0 (POST /api/v1.0/teammates/acceptInvitations).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/teammates/grantaccess": { "post": { "tags": [ "Teammates" ], "operationId": "grantaccess", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "grantaccess200Example": { "summary": "Default grantaccess 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "grantaccess400Example": { "summary": "Default grantaccess 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "grantaccess401Example": { "summary": "Default grantaccess 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "grantaccess403Example": { "summary": "Default grantaccess 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "grantaccess409Example": { "summary": "Default grantaccess 409 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "grantaccess500Example": { "summary": "Default grantaccess 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 Grantaccess", "description": "Grantaccess via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/teammates/grantaccess).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/roles": { "get": { "tags": [ "Users" ], "operationId": "GetRoles", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringArrayResult" }, "examples": { "GetRoles200Example": { "summary": "Default GetRoles 200 response", "x-microcks-default": true, "value": { "Data": [ "string" ] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRoles400Example": { "summary": "Default GetRoles 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRoles401Example": { "summary": "Default GetRoles 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRoles403Example": { "summary": "Default GetRoles 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": { "GetRoles500Example": { "summary": "Default GetRoles 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 Roles", "description": "Get Roles via the Flipdish Open API v1.0 (GET /api/v1.0/users/roles).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}": { "get": { "tags": [ "Users" ], "operationId": "GetUserById", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_UserInfo_" }, "examples": { "GetUserById200Example": { "summary": "Default GetUserById 200 response", "x-microcks-default": true, "value": { "Data": { "PhoneNumber": "+353000000000", "Email": "owner@example.com", "EmailConfirmed": true, "PreventFromUsingCards": true, "IsUserPhoneNumberBlocked": true, "UserWhiteLabels": [], "UserId": 500123, "UserName": "Example Name", "CustomerName": "Example Name", "HasLoggedIn": true, "DisableAppRatingControl": true, "GloballyOptedOut": true, "CompletedOrderCount": 3, "CancelledOrderCount": 3, "OrderTotalValue": 12.5, "TsMostRecentOrder": "2026-06-02T12:00:00Z", "TsFirstOrder": "2026-06-02T12:00:00Z", "IsRestaurantUser": true, "Installs": [], "DeliveryLocations": [], "PaymentAccounts": [], "LanguageId": "500123", "CurrentLanguageName": "Example Name", "Languages": [], "SalesForceContactId": "500123", "StripeCustomerId": "500123", "UserMonthlyCommissions": [] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserById400Example": { "summary": "Default GetUserById 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserById401Example": { "summary": "Default GetUserById 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserById403Example": { "summary": "Default GetUserById 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": { "GetUserById500Example": { "summary": "Default GetUserById 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get User by Id", "description": "Get User by Id via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/roles": { "get": { "tags": [ "Users" ], "operationId": "GetRolesAndUnassignedRoles", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_UserRole_" }, "examples": { "GetRolesAndUnassignedRoles200Example": { "summary": "Default GetRolesAndUnassignedRoles 200 response", "x-microcks-default": true, "value": { "Data": { "RolesUserIn": [ "string" ], "RolesUserNotIn": [ "string" ] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRolesAndUnassignedRoles400Example": { "summary": "Default GetRolesAndUnassignedRoles 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRolesAndUnassignedRoles401Example": { "summary": "Default GetRolesAndUnassignedRoles 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRolesAndUnassignedRoles403Example": { "summary": "Default GetRolesAndUnassignedRoles 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": { "GetRolesAndUnassignedRoles500Example": { "summary": "Default GetRolesAndUnassignedRoles 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 Roles and Unassigned Roles", "description": "Get Roles and Unassigned Roles via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/roles).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/UserNotes": { "get": { "tags": [ "Users" ], "operationId": "GetUserNotes", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_UserNote_" }, "examples": { "GetUserNotes200Example": { "summary": "Default GetUserNotes 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserNotes400Example": { "summary": "Default GetUserNotes 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserNotes401Example": { "summary": "Default GetUserNotes 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserNotes403Example": { "summary": "Default GetUserNotes 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": { "GetUserNotes500Example": { "summary": "Default GetUserNotes 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get User Notes", "description": "Get User Notes via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/UserNotes).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/orders/{orderId}": { "get": { "tags": [ "Users" ], "operationId": "GetUserOrderByIdForAdmin", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The order id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Order_" }, "examples": { "GetUserOrderByIdForAdmin200Example": { "summary": "Default GetUserOrderByIdForAdmin 200 response", "x-microcks-default": true, "value": { "Data": { "Store": { "Id": 500123, "Name": "Example Name", "MenuId": 500123, "MenuPublishId": "00000000-0000-0000-0000-000000000000", "Metadata": {}, "Currency": "EUR", "Coordinates": {}, "StoreTimezone": "string", "StoreIanaTimezone": "string", "StoreGroupId": 500123, "TaxId": "500123", "PrettyAddress": "string", "CountryCode": "IE", "PropertyId": "500123" }, "Customer": { "Id": 500123, "Name": "Example Name", "EmailAddress": "owner@example.com", "PhoneNumberLocalFormat": "2026-06-02T12:00:00Z", "PhoneNumber": "+353000000000", "LanguagePreference": "string" }, "Voucher": { "VoucherId": 500123, "Name": "Example Name", "Description": "string", "Code": "string", "Amount": 12.5, "Type": "PercentageDiscount", "SubType": "None" }, "Fees": { "FeeAmount": 12.5, "PercentageRate": 1.0, "PerTransactionFee": 12.5 }, "OrderItems": [], "DeliveryLocation": { "Coordinates": {}, "Building": "string", "Street": "string", "Town": "string", "PostCode": "string", "DeliveryInstructions": "string", "PrettyAddressString": "string" }, "CustomerLocation": { "Latitude": 1.0, "Longitude": 1.0 }, "MaskedPhoneNumber": { "IsEnabled": true, "PhoneNumber": "+353000000000", "Code": "string" }, "DropOffLocationId": 500123, "DropOffLocation": "string", "AcceptedFor": "2026-06-02T12:00:00Z", "InFraudZone": true, "UnusualHighValueOrder": true, "RejectedByUserId": 500123, "ChannelOrderId": "500123", "ChannelOrderDisplayId": "500123", "Channel": { "ChannelId": 500123, "TranslationKey": "string", "Source": "Internal", "LogoUri": "https://api.flipdish.co/example", "Available": true, "MaintainedExternally": true }, "OrderDropOffLocation": { "OrderId": 500123, "LocationName": "Example Name", "LocationAreaName": "Example Name", "LocationId": 500123, "LocationAreaId": 500123, "ExternalLocationId": "500123" }, "FulfillmentStatus": { "StatusId": "500123", "StatusName": "Example Name", "Icon": "string" }, "OrderBatchInfo": { "Id": 500123, "DisplayCode": "string", "CreateTime": "2026-06-02T12:00:00Z", "IsPublished": true }, "TaxItems": [], "CreatedCampaignVoucherId": 500123, "OrderId": 500123, "LocalOrderId": "500123", "DeliveryType": "Delivery", "PickupLocationType": "TakeOut", "TableServiceCatagory": "Generic", "TipAmount": 12.5, "DeliveryAmount": 12.5, "OrderItemsAmount": 12.5, "ServiceChargeAmount": 12.5, "ServiceChargePercentage": 1.0, "Amount": 12.5, "ProcessingFee": 12.5, "PaymentAccountType": "Card", "PaymentAccountDescription": "string", "OrderState": "Created", "IsPreOrder": true, "PlacedTime": "2026-06-02T12:00:00Z", "RequestedForTime": "2026-06-02T12:00:00Z", "ChefNote": "string", "AppType": "Unknown", "UserRating": 1, "PaymentStatus": "Paid", "RejectionReason": "TooBusy", "RefundedAmount": 12.5, "DeliveryTrackingStatus": "Unassigned", "DriverId": 500123, "TotalTax": 12.5, "OrderTrackingCode": "string", "DeliveryFeeAreaId": 500123, "ReceiptCode": "string", "TotalDepositReturnFeeAmount": 12.5 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserOrderByIdForAdmin400Example": { "summary": "Default GetUserOrderByIdForAdmin 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": { "GetUserOrderByIdForAdmin401Example": { "summary": "Default GetUserOrderByIdForAdmin 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserOrderByIdForAdmin403Example": { "summary": "Default GetUserOrderByIdForAdmin 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": { "GetUserOrderByIdForAdmin404Example": { "summary": "Default GetUserOrderByIdForAdmin 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserOrderByIdForAdmin500Example": { "summary": "Default GetUserOrderByIdForAdmin 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get User Order by Id for Admin", "description": "Get User Order by Id for Admin via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/orders/{orderId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/RestaurantUserStores": { "get": { "tags": [ "Users" ], "operationId": "GetRestaurantUserStores", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_UserStoreInfo_" }, "examples": { "GetRestaurantUserStores200Example": { "summary": "Default GetRestaurantUserStores 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRestaurantUserStores400Example": { "summary": "Default GetRestaurantUserStores 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRestaurantUserStores401Example": { "summary": "Default GetRestaurantUserStores 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRestaurantUserStores403Example": { "summary": "Default GetRestaurantUserStores 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": { "GetRestaurantUserStores500Example": { "summary": "Default GetRestaurantUserStores 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 Restaurant User Stores", "description": "Get Restaurant User Stores via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/RestaurantUserStores).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/RestaurantUserAccounts": { "get": { "tags": [ "Users" ], "operationId": "GetRestaurantUserAccounts", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_UserFlipdishAccount_" }, "examples": { "GetRestaurantUserAccounts200Example": { "summary": "Default GetRestaurantUserAccounts 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRestaurantUserAccounts400Example": { "summary": "Default GetRestaurantUserAccounts 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRestaurantUserAccounts401Example": { "summary": "Default GetRestaurantUserAccounts 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetRestaurantUserAccounts403Example": { "summary": "Default GetRestaurantUserAccounts 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": { "GetRestaurantUserAccounts500Example": { "summary": "Default GetRestaurantUserAccounts 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 Restaurant User Accounts", "description": "Get Restaurant User Accounts via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/RestaurantUserAccounts).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/previousordercount/{storeId}": { "get": { "tags": [ "Users" ], "operationId": "GetPreviousOrderCountForStore", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user 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/RestApiStringResult" }, "examples": { "GetPreviousOrderCountForStore200Example": { "summary": "Default GetPreviousOrderCountForStore 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPreviousOrderCountForStore400Example": { "summary": "Default GetPreviousOrderCountForStore 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPreviousOrderCountForStore401Example": { "summary": "Default GetPreviousOrderCountForStore 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPreviousOrderCountForStore403Example": { "summary": "Default GetPreviousOrderCountForStore 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": { "GetPreviousOrderCountForStore500Example": { "summary": "Default GetPreviousOrderCountForStore 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 Previous Order Count for Store", "description": "Get Previous Order Count for Store via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/previousordercount/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/searchFlipdishAccounts": { "get": { "tags": [ "Users" ], "operationId": "SearchFlipdishAccounts", "parameters": [ { "name": "searchPattern", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The search pattern query parameter.", "example": "string" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_FlipdishAccountName_" }, "examples": { "SearchFlipdishAccounts200Example": { "summary": "Default SearchFlipdishAccounts 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SearchFlipdishAccounts400Example": { "summary": "Default SearchFlipdishAccounts 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SearchFlipdishAccounts401Example": { "summary": "Default SearchFlipdishAccounts 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SearchFlipdishAccounts403Example": { "summary": "Default SearchFlipdishAccounts 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": { "SearchFlipdishAccounts500Example": { "summary": "Default SearchFlipdishAccounts 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Search Flipdish Accounts", "description": "Search Flipdish Accounts via the Flipdish Open API v1.0 (GET /api/v1.0/users/searchFlipdishAccounts).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/deliveryLocations": { "get": { "tags": [ "Users" ], "operationId": "GetUserDeliveryLocationsForAdmin", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 }, { "name": "whiteLabelId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The white label id query parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_UserDeliveryLocationAdmin_" }, "examples": { "GetUserDeliveryLocationsForAdmin200Example": { "summary": "Default GetUserDeliveryLocationsForAdmin 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserDeliveryLocationsForAdmin400Example": { "summary": "Default GetUserDeliveryLocationsForAdmin 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": { "GetUserDeliveryLocationsForAdmin401Example": { "summary": "Default GetUserDeliveryLocationsForAdmin 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserDeliveryLocationsForAdmin403Example": { "summary": "Default GetUserDeliveryLocationsForAdmin 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": { "GetUserDeliveryLocationsForAdmin404Example": { "summary": "Default GetUserDeliveryLocationsForAdmin 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserDeliveryLocationsForAdmin500Example": { "summary": "Default GetUserDeliveryLocationsForAdmin 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get User Delivery Locations for Admin", "description": "Get User Delivery Locations for Admin via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/deliveryLocations).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Users" ], "operationId": "CreateUserDeliveryLocation", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserDeliveryLocationRequest" }, "examples": { "CreateUserDeliveryLocationRequestExample": { "summary": "Default CreateUserDeliveryLocation request", "x-microcks-default": true, "value": { "Building": "string", "Street": "string", "Town": "string", "PostCode": "string", "FullAddressJson": "string", "DeliveryInstructions": "string", "Coordinates": { "Latitude": 1.0, "Longitude": 1.0 }, "IsDisplayed": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "CreateUserDeliveryLocation200Example": { "summary": "Default CreateUserDeliveryLocation 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateUserDeliveryLocation400Example": { "summary": "Default CreateUserDeliveryLocation 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": { "CreateUserDeliveryLocation401Example": { "summary": "Default CreateUserDeliveryLocation 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateUserDeliveryLocation403Example": { "summary": "Default CreateUserDeliveryLocation 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": { "CreateUserDeliveryLocation404Example": { "summary": "Default CreateUserDeliveryLocation 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateUserDeliveryLocation500Example": { "summary": "Default CreateUserDeliveryLocation 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 User Delivery Location", "description": "Create User Delivery Location via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/deliveryLocations).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/orders": { "get": { "tags": [ "Users" ], "operationId": "GetUserOrdersForAdmin", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 }, { "name": "skip", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The skip query parameter.", "example": 1 }, { "name": "take", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The take query parameter.", "example": 1 }, { "name": "brandId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The brand id query parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_UserOrderSummary_" }, "examples": { "GetUserOrdersForAdmin200Example": { "summary": "Default GetUserOrdersForAdmin 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserOrdersForAdmin400Example": { "summary": "Default GetUserOrdersForAdmin 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": { "GetUserOrdersForAdmin401Example": { "summary": "Default GetUserOrdersForAdmin 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserOrdersForAdmin403Example": { "summary": "Default GetUserOrdersForAdmin 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": { "GetUserOrdersForAdmin404Example": { "summary": "Default GetUserOrdersForAdmin 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserOrdersForAdmin500Example": { "summary": "Default GetUserOrdersForAdmin 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get User Orders for Admin", "description": "Get User Orders for Admin via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/orders).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/smsConversationItems": { "get": { "tags": [ "Users" ], "operationId": "GetUserSmsConversationItems", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 }, { "name": "mostRecentCount", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The most recent count query parameter.", "example": 3 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_UserSmsChatItem_" }, "examples": { "GetUserSmsConversationItems200Example": { "summary": "Default GetUserSmsConversationItems 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserSmsConversationItems400Example": { "summary": "Default GetUserSmsConversationItems 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": { "GetUserSmsConversationItems401Example": { "summary": "Default GetUserSmsConversationItems 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserSmsConversationItems403Example": { "summary": "Default GetUserSmsConversationItems 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": { "GetUserSmsConversationItems404Example": { "summary": "Default GetUserSmsConversationItems 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetUserSmsConversationItems500Example": { "summary": "Default GetUserSmsConversationItems 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get User Sms Conversation Items", "description": "Get User Sms Conversation Items via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/smsConversationItems).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/search": { "get": { "tags": [ "Users" ], "operationId": "SearchUsers", "parameters": [ { "name": "searchQuery", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The search query query parameter.", "example": "string" }, { "name": "hasUserLoggedIn", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "The has user logged in query parameter.", "example": true }, { "name": "userDiscriminator", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "All", "ApplicationUsers", "RestaurantUsers", "HydraUsers" ] }, "description": "The user discriminator query parameter.", "example": "All" }, { "name": "searchIn", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Generic", "Id", "Email", "Phone", "CustomerName", "IdOrPhone", "IdOrCustomerName" ] }, "description": "The search in query parameter.", "example": "Generic" }, { "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 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult_UserSearch_" }, "examples": { "SearchUsers200Example": { "summary": "Default SearchUsers 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": { "SearchUsers400Example": { "summary": "Default SearchUsers 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SearchUsers401Example": { "summary": "Default SearchUsers 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SearchUsers403Example": { "summary": "Default SearchUsers 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": { "SearchUsers500Example": { "summary": "Default SearchUsers 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Search Users", "description": "Search Users via the Flipdish Open API v1.0 (GET /api/v1.0/users/search).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/sms": { "post": { "tags": [ "Users" ], "operationId": "SendUserSms", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendUserSmsRequest" }, "examples": { "SendUserSmsRequestExample": { "summary": "Default SendUserSms request", "x-microcks-default": true, "value": { "Message": "string", "WhiteLabelId": 500123, "FromNumber": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "SendUserSms200Example": { "summary": "Default SendUserSms 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SendUserSms400Example": { "summary": "Default SendUserSms 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": { "SendUserSms401Example": { "summary": "Default SendUserSms 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SendUserSms403Example": { "summary": "Default SendUserSms 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": { "SendUserSms404Example": { "summary": "Default SendUserSms 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SendUserSms500Example": { "summary": "Default SendUserSms 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 Send User Sms", "description": "Send User Sms via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/sms).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/ResetMfa": { "post": { "tags": [ "Users" ], "operationId": "ResetMfa", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "ResetMfa200Example": { "summary": "Default ResetMfa 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ResetMfa400Example": { "summary": "Default ResetMfa 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ResetMfa401Example": { "summary": "Default ResetMfa 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ResetMfa403Example": { "summary": "Default ResetMfa 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": { "ResetMfa500Example": { "summary": "Default ResetMfa 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 Reset Mfa", "description": "Reset Mfa via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/ResetMfa).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/AddUserNote": { "post": { "tags": [ "Users" ], "operationId": "AddUserNote", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "AddUserNote200Example": { "summary": "Default AddUserNote 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddUserNote400Example": { "summary": "Default AddUserNote 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddUserNote401Example": { "summary": "Default AddUserNote 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddUserNote403Example": { "summary": "Default AddUserNote 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": { "AddUserNote500Example": { "summary": "Default AddUserNote 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Add User Note", "description": "Add User Note via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/AddUserNote).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/AnonymizeUser": { "post": { "tags": [ "Users" ], "operationId": "AnonymizeUser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "AnonymizeUser200Example": { "summary": "Default AnonymizeUser 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AnonymizeUser400Example": { "summary": "Default AnonymizeUser 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AnonymizeUser401Example": { "summary": "Default AnonymizeUser 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AnonymizeUser403Example": { "summary": "Default AnonymizeUser 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": { "AnonymizeUser500Example": { "summary": "Default AnonymizeUser 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 Anonymize User", "description": "Anonymize User via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/AnonymizeUser).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/SetCustomerName": { "post": { "tags": [ "Users" ], "operationId": "SetCustomerName", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "SetCustomerName200Example": { "summary": "Default SetCustomerName 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetCustomerName400Example": { "summary": "Default SetCustomerName 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetCustomerName401Example": { "summary": "Default SetCustomerName 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetCustomerName403Example": { "summary": "Default SetCustomerName 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": { "SetCustomerName500Example": { "summary": "Default SetCustomerName 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Set Customer Name", "description": "Set Customer Name via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/SetCustomerName).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/pushNotifications": { "post": { "tags": [ "Users" ], "operationId": "SendUserPushNotification", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendUserPushNotificationRequest" }, "examples": { "SendUserPushNotificationRequestExample": { "summary": "Default SendUserPushNotification request", "x-microcks-default": true, "value": { "WhiteLabelId": 500123, "Message": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_UserPushNotificationSentResult_" }, "examples": { "SendUserPushNotification200Example": { "summary": "Default SendUserPushNotification 200 response", "x-microcks-default": true, "value": { "Data": { "TokenCount": 3 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SendUserPushNotification400Example": { "summary": "Default SendUserPushNotification 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": { "SendUserPushNotification401Example": { "summary": "Default SendUserPushNotification 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SendUserPushNotification403Example": { "summary": "Default SendUserPushNotification 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": { "SendUserPushNotification404Example": { "summary": "Default SendUserPushNotification 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SendUserPushNotification500Example": { "summary": "Default SendUserPushNotification 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 Send User Push Notification", "description": "Send User Push Notification via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/pushNotifications).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/BlockUserPhoneNumber": { "post": { "tags": [ "Users" ], "operationId": "BlockUserPhoneNumber", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "BlockUserPhoneNumber200Example": { "summary": "Default BlockUserPhoneNumber 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "BlockUserPhoneNumber400Example": { "summary": "Default BlockUserPhoneNumber 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "BlockUserPhoneNumber401Example": { "summary": "Default BlockUserPhoneNumber 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "BlockUserPhoneNumber403Example": { "summary": "Default BlockUserPhoneNumber 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": { "BlockUserPhoneNumber500Example": { "summary": "Default BlockUserPhoneNumber 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 Block User Phone Number", "description": "Block User Phone Number via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/BlockUserPhoneNumber).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/MarkUserAsFraudulent": { "post": { "tags": [ "Users" ], "operationId": "MarkUserAsFraudulent", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "MarkUserAsFraudulent200Example": { "summary": "Default MarkUserAsFraudulent 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "MarkUserAsFraudulent400Example": { "summary": "Default MarkUserAsFraudulent 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "MarkUserAsFraudulent401Example": { "summary": "Default MarkUserAsFraudulent 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "MarkUserAsFraudulent403Example": { "summary": "Default MarkUserAsFraudulent 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": { "MarkUserAsFraudulent500Example": { "summary": "Default MarkUserAsFraudulent 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 Mark User as Fraudulent", "description": "Mark User as Fraudulent via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/MarkUserAsFraudulent).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/MarkUserAsSuspicious": { "post": { "tags": [ "Users" ], "operationId": "MarkUserAsSuspicious", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "MarkUserAsSuspicious200Example": { "summary": "Default MarkUserAsSuspicious 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "MarkUserAsSuspicious400Example": { "summary": "Default MarkUserAsSuspicious 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "MarkUserAsSuspicious401Example": { "summary": "Default MarkUserAsSuspicious 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "MarkUserAsSuspicious403Example": { "summary": "Default MarkUserAsSuspicious 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": { "MarkUserAsSuspicious500Example": { "summary": "Default MarkUserAsSuspicious 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 Mark User as Suspicious", "description": "Mark User as Suspicious via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/MarkUserAsSuspicious).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/UnblockUserPhoneNumber": { "post": { "tags": [ "Users" ], "operationId": "UnblockUserPhoneNumber", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "UnblockUserPhoneNumber200Example": { "summary": "Default UnblockUserPhoneNumber 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UnblockUserPhoneNumber400Example": { "summary": "Default UnblockUserPhoneNumber 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UnblockUserPhoneNumber401Example": { "summary": "Default UnblockUserPhoneNumber 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UnblockUserPhoneNumber403Example": { "summary": "Default UnblockUserPhoneNumber 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": { "UnblockUserPhoneNumber500Example": { "summary": "Default UnblockUserPhoneNumber 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 Unblock User Phone Number", "description": "Unblock User Phone Number via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/UnblockUserPhoneNumber).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/AddUserToRole/{roleName}": { "post": { "tags": [ "Users" ], "operationId": "AddUserToRole", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 }, { "name": "roleName", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The role name path parameter.", "example": "Example Name" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_UserRole_" }, "examples": { "AddUserToRole200Example": { "summary": "Default AddUserToRole 200 response", "x-microcks-default": true, "value": { "Data": { "RolesUserIn": [ "string" ], "RolesUserNotIn": [ "string" ] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddUserToRole400Example": { "summary": "Default AddUserToRole 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddUserToRole401Example": { "summary": "Default AddUserToRole 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddUserToRole403Example": { "summary": "Default AddUserToRole 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": { "AddUserToRole500Example": { "summary": "Default AddUserToRole 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Add User to Role", "description": "Add User to Role via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/AddUserToRole/{roleName}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/SetLanguage/{languageId}": { "post": { "tags": [ "Users" ], "operationId": "SetUserLanguage", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 }, { "name": "languageId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The language id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "SetUserLanguage200Example": { "summary": "Default SetUserLanguage 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetUserLanguage400Example": { "summary": "Default SetUserLanguage 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetUserLanguage401Example": { "summary": "Default SetUserLanguage 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetUserLanguage403Example": { "summary": "Default SetUserLanguage 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": { "SetUserLanguage500Example": { "summary": "Default SetUserLanguage 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 User Language", "description": "Set User Language via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/SetLanguage/{languageId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/RemoveUserFromRole/{roleName}": { "post": { "tags": [ "Users" ], "operationId": "RemoveUserFromRole", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 }, { "name": "roleName", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The role name path parameter.", "example": "Example Name" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_UserRole_" }, "examples": { "RemoveUserFromRole200Example": { "summary": "Default RemoveUserFromRole 200 response", "x-microcks-default": true, "value": { "Data": { "RolesUserIn": [ "string" ], "RolesUserNotIn": [ "string" ] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RemoveUserFromRole400Example": { "summary": "Default RemoveUserFromRole 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RemoveUserFromRole401Example": { "summary": "Default RemoveUserFromRole 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RemoveUserFromRole403Example": { "summary": "Default RemoveUserFromRole 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": { "RemoveUserFromRole500Example": { "summary": "Default RemoveUserFromRole 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 User from Role", "description": "Remove User from Role via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/RemoveUserFromRole/{roleName}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/SetFlipdishAccountId/{accountId}": { "post": { "tags": [ "Users" ], "operationId": "SetFlipdishAccountIdForUser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The account id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "SetFlipdishAccountIdForUser200Example": { "summary": "Default SetFlipdishAccountIdForUser 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetFlipdishAccountIdForUser400Example": { "summary": "Default SetFlipdishAccountIdForUser 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetFlipdishAccountIdForUser401Example": { "summary": "Default SetFlipdishAccountIdForUser 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetFlipdishAccountIdForUser403Example": { "summary": "Default SetFlipdishAccountIdForUser 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": { "SetFlipdishAccountIdForUser500Example": { "summary": "Default SetFlipdishAccountIdForUser 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 Flipdish Account Id for User", "description": "Set Flipdish Account Id for User via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/SetFlipdishAccountId/{accountId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/RemoveFlipdishAccountId/{accountId}": { "post": { "tags": [ "Users" ], "operationId": "RemoveFlipdishAccountIdForUser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The account id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "RemoveFlipdishAccountIdForUser200Example": { "summary": "Default RemoveFlipdishAccountIdForUser 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RemoveFlipdishAccountIdForUser400Example": { "summary": "Default RemoveFlipdishAccountIdForUser 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RemoveFlipdishAccountIdForUser401Example": { "summary": "Default RemoveFlipdishAccountIdForUser 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "RemoveFlipdishAccountIdForUser403Example": { "summary": "Default RemoveFlipdishAccountIdForUser 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": { "RemoveFlipdishAccountIdForUser500Example": { "summary": "Default RemoveFlipdishAccountIdForUser 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 Flipdish Account Id for User", "description": "Remove Flipdish Account Id for User via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/RemoveFlipdishAccountId/{accountId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/hide": { "post": { "tags": [ "Users" ], "operationId": "HideUserDeliveryLocation", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 }, { "name": "deliveryLocationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The delivery location id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "HideUserDeliveryLocation200Example": { "summary": "Default HideUserDeliveryLocation 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "HideUserDeliveryLocation400Example": { "summary": "Default HideUserDeliveryLocation 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": { "HideUserDeliveryLocation401Example": { "summary": "Default HideUserDeliveryLocation 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "HideUserDeliveryLocation403Example": { "summary": "Default HideUserDeliveryLocation 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": { "HideUserDeliveryLocation404Example": { "summary": "Default HideUserDeliveryLocation 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "HideUserDeliveryLocation500Example": { "summary": "Default HideUserDeliveryLocation 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 Hide User Delivery Location", "description": "Hide User Delivery Location via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/hide).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/fields": { "post": { "tags": [ "Users" ], "operationId": "SetUserDeliveryLocationField", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 }, { "name": "deliveryLocationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The delivery location id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetUserDeliveryLocationFieldRequest" }, "examples": { "SetUserDeliveryLocationFieldRequestExample": { "summary": "Default SetUserDeliveryLocationField request", "x-microcks-default": true, "value": { "Field": "DeliveryInstructions", "Value": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "SetUserDeliveryLocationField200Example": { "summary": "Default SetUserDeliveryLocationField 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetUserDeliveryLocationField400Example": { "summary": "Default SetUserDeliveryLocationField 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": { "SetUserDeliveryLocationField401Example": { "summary": "Default SetUserDeliveryLocationField 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetUserDeliveryLocationField403Example": { "summary": "Default SetUserDeliveryLocationField 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": { "SetUserDeliveryLocationField404Example": { "summary": "Default SetUserDeliveryLocationField 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetUserDeliveryLocationField500Example": { "summary": "Default SetUserDeliveryLocationField 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 User Delivery Location Field", "description": "Set User Delivery Location Field via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/fields).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/coordinates": { "post": { "tags": [ "Users" ], "operationId": "SetUserDeliveryLocationCoordinates", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The user id path parameter.", "example": 500123 }, { "name": "deliveryLocationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The delivery location id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetUserDeliveryLocationCoordinatesRequest" }, "examples": { "SetUserDeliveryLocationCoordinatesRequestExample": { "summary": "Default SetUserDeliveryLocationCoordinates request", "x-microcks-default": true, "value": { "Latitude": 1.0, "Longitude": 1.0 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDefaultResponse" }, "examples": { "SetUserDeliveryLocationCoordinates200Example": { "summary": "Default SetUserDeliveryLocationCoordinates 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetUserDeliveryLocationCoordinates400Example": { "summary": "Default SetUserDeliveryLocationCoordinates 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": { "SetUserDeliveryLocationCoordinates401Example": { "summary": "Default SetUserDeliveryLocationCoordinates 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetUserDeliveryLocationCoordinates403Example": { "summary": "Default SetUserDeliveryLocationCoordinates 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": { "SetUserDeliveryLocationCoordinates404Example": { "summary": "Default SetUserDeliveryLocationCoordinates 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetUserDeliveryLocationCoordinates500Example": { "summary": "Default SetUserDeliveryLocationCoordinates 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 User Delivery Location Coordinates", "description": "Set User Delivery Location Coordinates via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/coordinates).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } } }, "components": { "schemas": { "AcceptInvitationResult": { "description": "", "type": "object", "properties": { "IsNewUser": { "description": "Bool indicating if the user accepting the invitation is a new user", "type": "boolean", "example": true }, "InvitedEmailAddress": { "description": "The email address that was invited.", "type": "string", "example": "owner@example.com" } } }, "AccountDetail": { "description": "Account details", "type": "object", "properties": { "Email": { "description": "Email", "type": "string", "example": "owner@example.com" }, "SignupSteps": { "description": "Signup steps", "type": "array", "items": { "$ref": "#/components/schemas/SignupStep" }, "example": [] }, "IsVerified": { "description": "Is account email verified", "type": "boolean", "example": true }, "IsSelfServeUser": { "description": "is the account a Self Server", "type": "boolean", "example": true }, "AccountId": { "format": "int32", "description": "Accounts Id", "type": "integer", "example": 500123 }, "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "Language": { "description": "Language Id", "type": "string", "example": "string" }, "TimeZoneInfoId": { "description": "Time Zone Info Id", "type": "string", "example": "500123" }, "DisplayTimesInUserLocalTimeZone": { "description": "Display the time in time zone local to the user", "type": "boolean", "example": true }, "ShowHiddenFeatures": { "description": "Show hidden features", "type": "boolean", "example": true }, "CreatedAt": { "format": "date-time", "description": "User created at", "type": "string", "example": "2026-06-02T12:00:00Z" } } }, "AccountDetailBase": { "description": "Account Details Base", "type": "object", "properties": { "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "Language": { "description": "Language Id", "type": "string", "example": "string" }, "TimeZoneInfoId": { "description": "Time Zone Info Id", "type": "string", "example": "500123" }, "DisplayTimesInUserLocalTimeZone": { "description": "Display the time in time zone local to the user", "type": "boolean", "example": true }, "ShowHiddenFeatures": { "description": "Show hidden features", "type": "boolean", "example": true }, "CreatedAt": { "format": "date-time", "description": "User created at", "type": "string", "example": "2026-06-02T12:00:00Z" } } }, "AppInstall": { "description": "App Install information", "type": "object", "properties": { "Name": { "description": "Name of the installed application.", "type": "string", "example": "Example Name" }, "FirstLogin": { "format": "date-time", "description": "Date and time of the user's first login to the app.", "type": "string", "example": "2026-06-02T12:00:00Z" }, "FirstLoginHuman": { "description": "Human-readable representation of the first login date.", "type": "string", "example": "string" }, "LastActivity": { "format": "date-time", "description": "Date and time of the user's last activity in the app.", "type": "string", "example": "2026-06-02T12:00:00Z" }, "LastActivityHuman": { "description": "Human-readable representation of the last activity date.", "type": "string", "example": "string" }, "GoogleTokens": { "format": "int32", "description": "Number of Google push notification tokens associated with the app install.", "type": "integer", "example": 1 }, "AppleTokens": { "format": "int32", "description": "Number of Apple push notification tokens associated with the app install.", "type": "integer", "example": 1 }, "OrderCount": { "format": "int32", "description": "Number of orders placed by the user through this app install.", "type": "integer", "example": 3 }, "UserAgentAtSignup": { "description": "User agent string at the time of signup.", "type": "string", "example": "string" }, "UserAgentMostRecent": { "description": "Most recent user agent string used by the user.", "type": "string", "example": "string" } } }, "ChangePasswordModel": { "description": "Change password model", "required": [ "OldPassword", "NewPassword" ], "type": "object", "properties": { "OldPassword": { "description": "Old password", "type": "string", "example": "string" }, "NewPassword": { "description": "New password", "type": "string", "example": "string" } } }, "Channel": { "description": "Channel.", "type": "object", "properties": { "ChannelId": { "format": "int32", "description": "Channel Id", "type": "integer", "example": 500123 }, "TranslationKey": { "description": "Channel TranslationKey", "type": "string", "example": "string" }, "Source": { "description": "Channel Source", "enum": [ "Internal", "External" ], "type": "string", "example": "Internal" }, "LogoUri": { "description": "Channel Logo URl", "type": "string", "example": "https://api.flipdish.co/example" }, "Available": { "description": "Channel is Available or not", "type": "boolean", "example": true }, "MaintainedExternally": { "description": "Channel is Maintained Externally or not", "type": "boolean", "example": true } } }, "Coordinates": { "description": "Coordinates", "type": "object", "properties": { "Latitude": { "format": "double", "description": "Latitude", "type": "number", "example": 1.0 }, "Longitude": { "format": "double", "description": "Longitude", "type": "number", "example": 1.0 } } }, "CreateAccountModel": { "description": "Create account model", "required": [ "Email", "StoreName" ], "type": "object", "properties": { "Email": { "description": "Email address", "type": "string", "example": "owner@example.com" }, "StoreName": { "description": "Store name", "type": "string", "example": "Example Name" }, "LanguageId": { "description": "LanguageId", "type": "string", "example": "500123" }, "Rid": { "format": "int32", "description": "Referral ID", "type": "integer", "nullable": true, "example": 500123 }, "Cid": { "description": "Campaign ID", "type": "string", "example": "500123" }, "RecaptchaToken": { "description": "Google Recaptcha Token", "type": "string", "example": "string" } } }, "CreateBasicAccountModel": { "description": "Basic attributes for creating an account", "required": [ "StoreName" ], "type": "object", "properties": { "StoreName": { "description": "Store name", "type": "string", "example": "Example Name" }, "LanguageId": { "description": "LanguageId", "type": "string", "example": "500123" } } }, "CreateUserDeliveryLocationRequest": { "description": "Create a delivery location for a user (admin).", "type": "object", "properties": { "Building": { "description": "Building.", "type": "string", "example": "string" }, "Street": { "description": "Street.", "type": "string", "example": "string" }, "Town": { "description": "Town.", "type": "string", "example": "string" }, "PostCode": { "description": "PostCode.", "type": "string", "example": "string" }, "FullAddressJson": { "description": "FullAddressJson.", "type": "string", "example": "string" }, "DeliveryInstructions": { "description": "DeliveryInstructions.", "type": "string", "example": "string" }, "Coordinates": { "$ref": "#/components/schemas/Coordinates" }, "IsDisplayed": { "description": "Passed through to the same parameter position as legacy admin MVC (maps to IsCustomAddress in map service).", "type": "boolean", "example": true } } }, "Customer": { "description": "Defines a customer", "type": "object", "properties": { "CustomerId": { "format": "int32", "description": "Id of the customer", "type": "integer", "example": 500123 }, "Name": { "description": "Customer name", "type": "string", "example": "Example Name" }, "RegistrationDate": { "format": "date-time", "description": "Customer registration date", "type": "string", "example": "2026-06-02T12:00:00Z" }, "PhoneNumber": { "description": "Phone Number in international format", "type": "string", "example": "+353000000000" }, "CashOrdersEnabled": { "description": "Customer can place cash orders", "type": "boolean", "example": true }, "CardOrdersEnabled": { "description": "Customer can place card orders", "type": "boolean", "example": true }, "MarketingEnabled": { "description": "Customer can receive marketing", "type": "boolean", "example": true } } }, "CustomerCreateModel": { "description": "Defines a customer create model", "type": "object", "properties": { "PhoneNumber": { "description": "Customer Phone Number", "type": "string", "example": "+353000000000" }, "AppType": { "description": "Customer AppType", "enum": [ "Unknown", "Ios", "Android", "Web", "Kiosk", "Pos", "TelephoneCall", "Sms", "PwaAndroid", "PwaIos", "Google" ], "type": "string", "example": "Unknown" }, "Name": { "description": "Customer Name", "type": "string", "example": "Example Name" } } }, "CustomerSummary": { "description": "Customer summary", "type": "object", "properties": { "Id": { "format": "int32", "description": "Customer identifier", "type": "integer", "example": 500123 }, "Name": { "description": "Customer name", "type": "string", "example": "Example Name" }, "EmailAddress": { "description": "Customer email address", "type": "string", "example": "owner@example.com" }, "PhoneNumberLocalFormat": { "description": "Customer local phone number", "type": "string", "example": "2026-06-02T12:00:00Z" }, "PhoneNumber": { "description": "Customer phone number", "type": "string", "example": "+353000000000" }, "LanguagePreference": { "description": "Preferred language of the consumer", "type": "string", "example": "string" } } }, "CustomerUpdateModel": { "description": "Defines a customer update model", "type": "object", "properties": { "CashOrdersEnabled": { "description": "Customer can place cash orders", "type": "boolean", "example": true }, "CardOrdersEnabled": { "description": "Customer can place card orders", "type": "boolean", "example": true }, "MarketingEnabled": { "description": "Customer can receive marketing", "type": "boolean", "example": true } } }, "Customers": { "description": "Defines a list of customers", "type": "object", "properties": { "Items": { "description": "List of customers", "type": "array", "items": { "$ref": "#/components/schemas/Customer" }, "example": [] } } }, "DeliveryLocation": { "description": "Delivery location", "type": "object", "properties": { "Coordinates": { "$ref": "#/components/schemas/Coordinates" }, "Building": { "description": "Building", "type": "string", "example": "string" }, "Street": { "description": "Street", "type": "string", "example": "string" }, "Town": { "description": "Town", "type": "string", "example": "string" }, "PostCode": { "description": "Post code", "type": "string", "example": "string" }, "DeliveryInstructions": { "description": "Delivery instructions", "type": "string", "example": "string" }, "PrettyAddressString": { "description": "Formatted, pretty address string", "type": "string", "example": "string" } } }, "DriverLoginModel": { "description": "Driver Login model", "required": [ "PhoneNumber", "Code" ], "type": "object", "properties": { "PhoneNumber": { "description": "Phone number", "type": "string", "example": "+353000000000" }, "Code": { "description": "Code", "type": "string", "example": "string" } } }, "DriverRequestLoginPinModel": { "description": "Driver Request Login Pin model", "required": [ "PhoneNumber" ], "type": "object", "properties": { "PhoneNumber": { "description": "Email address", "type": "string", "example": "+353000000000" } } }, "FeeSummary": { "description": "Fee Summary", "type": "object", "properties": { "FeeAmount": { "format": "double", "description": "Fee amount", "type": "number", "example": 12.5 }, "PercentageRate": { "format": "double", "description": "Percentage rate", "type": "number", "example": 1.0 }, "PerTransactionFee": { "format": "double", "description": "Per transaction fee", "type": "number", "example": 12.5 } } }, "FlipdishAccountName": { "description": "Flipdish Account Name", "type": "object", "properties": { "PayeeBankAccountDataId": { "format": "int32", "description": "Payee Bank Account Data Id", "type": "integer", "nullable": true, "example": 500123 }, "FlipdishAccountId": { "format": "int32", "description": "Flipdish Account Id", "type": "integer", "example": 500123 }, "Name": { "description": "Account Name", "type": "string", "example": "Example Name" } } }, "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'." } } } } }, "Language": { "description": "Sorted Language", "type": "object", "properties": { "LanguageId": { "description": "ISO 639-1 Language Code", "type": "string", "example": "500123" }, "DisplayOrder": { "format": "int32", "description": "Display Order", "type": "integer", "example": 1 }, "Name": { "description": "Language Name", "type": "string", "example": "Example Name" }, "Enabled": { "description": "Is the language enabled for use.", "type": "boolean", "example": true } } }, "LocalisedTimeZone": { "description": "Represents a localised time zone", "type": "object", "properties": { "TimeZoneId": { "description": "Microsoft Time Zone Id", "type": "string", "example": "500123" }, "IanaTimeZoneId": { "description": "Iana Time Zone Id", "type": "string", "example": "500123" }, "DisplayName": { "description": "Display name in users language", "type": "string", "example": "Example Name" } } }, "LoginModel": { "description": "Login model", "required": [ "Email", "Password" ], "type": "object", "properties": { "Email": { "description": "Email address", "type": "string", "example": "owner@example.com" }, "Password": { "description": "Password", "type": "string", "example": "string" } } }, "LoginWithPinModel": { "description": "Login with PIN model", "required": [ "Email", "Pin" ], "type": "object", "properties": { "Email": { "description": "Email addres", "type": "string", "example": "owner@example.com" }, "Pin": { "format": "int32", "description": "PIN code (received via email)", "type": "integer", "example": 1 } } }, "MaskedPhoneNumber": { "description": "Represents a masked phone number", "type": "object", "properties": { "IsEnabled": { "description": "Defines if the feature is enabled", "type": "boolean", "example": true }, "PhoneNumber": { "description": "Defines the phone number to call", "type": "string", "example": "+353000000000" }, "Code": { "description": "Defines the code to enter", "type": "string", "example": "string" } } }, "Order": { "description": "Order", "type": "object", "properties": { "Store": { "$ref": "#/components/schemas/StoreSummary" }, "Customer": { "$ref": "#/components/schemas/CustomerSummary" }, "Voucher": { "$ref": "#/components/schemas/OrderVoucherSummary" }, "Fees": { "$ref": "#/components/schemas/FeeSummary" }, "OrderItems": { "description": "Ordered items", "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" }, "example": [] }, "DeliveryLocation": { "$ref": "#/components/schemas/DeliveryLocation" }, "CustomerLocation": { "$ref": "#/components/schemas/Coordinates" }, "MaskedPhoneNumber": { "$ref": "#/components/schemas/MaskedPhoneNumber" }, "DropOffLocationId": { "format": "int32", "description": "Represents table service drop off location", "type": "integer", "nullable": true, "example": 500123 }, "DropOffLocation": { "description": "Represents table service drop off location", "type": "string", "example": "string" }, "AcceptedFor": { "format": "date-time", "description": "Time store has accepted the order for", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "InFraudZone": { "description": "Was order made within a fraud zone", "type": "boolean", "example": true }, "UnusualHighValueOrder": { "description": "Is order of unusually high value", "type": "boolean", "example": true }, "RejectedByUserId": { "format": "int32", "description": "Id of user who rejected order, if available", "type": "integer", "nullable": true, "example": 500123 }, "ChannelOrderId": { "description": "ChannelOrderId from external channel", "type": "string", "example": "500123" }, "ChannelOrderDisplayId": { "description": "ChannelOrderDisplayId from external channel", "type": "string", "example": "500123" }, "Channel": { "$ref": "#/components/schemas/Channel" }, "OrderDropOffLocation": { "$ref": "#/components/schemas/OrderDropOffLocation" }, "FulfillmentStatus": { "$ref": "#/components/schemas/OrderFulfillmentStatusBase" }, "OrderBatchInfo": { "$ref": "#/components/schemas/OrderBatchSummary" }, "TaxItems": { "description": "A collection of tax items on the order.", "type": "array", "items": { "$ref": "#/components/schemas/TaxItem" }, "example": [] }, "CreatedCampaignVoucherId": { "format": "int32", "description": "The id of the campaign voucher that was created from this order", "type": "integer", "nullable": true, "example": 500123 }, "OrderId": { "format": "int32", "description": "Order identifier", "type": "integer", "example": 500123 }, "LocalOrderId": { "description": "Local order Id. This is used for displaying a \"shorter\" order ID for customers (eg. Kiosk orders)", "type": "string", "example": "500123" }, "DeliveryType": { "description": "Delivery type", "enum": [ "Delivery", "Pickup" ], "type": "string", "example": "Delivery" }, "PickupLocationType": { "description": "Pickup location type", "enum": [ "TakeOut", "TableService", "DineIn" ], "type": "string", "example": "TakeOut" }, "TableServiceCatagory": { "description": "Pickup location type", "enum": [ "Generic", "Villa", "House", "Room", "Area", "Table", "ParkingBay", "Gate", "DriveThrough", "Team" ], "type": "string", "nullable": true, "example": "Generic" }, "TipAmount": { "format": "double", "description": "Tip amount", "type": "number", "example": 12.5 }, "DeliveryAmount": { "format": "double", "description": "Delivery amount", "type": "number", "example": 12.5 }, "OrderItemsAmount": { "format": "double", "description": "Ordered items amount", "type": "number", "example": 12.5 }, "ServiceChargeAmount": { "format": "double", "description": "Service Charge Amount", "type": "number", "example": 12.5 }, "ServiceChargePercentage": { "format": "double", "description": "Service Charge Percentage", "type": "number", "example": 1.0 }, "Amount": { "format": "double", "description": "This is the sum of the OrderItemsAmount, DeliveryAmount, TipAmount and Voucher.Amount (which is usually negative) and OnlineOrderingFee for cash orders.\r\nIt does not include the OnlineOrderingFee in the case of card orders as this fee is charged by Flipdish directly to the customer.", "type": "number", "example": 12.5 }, "ProcessingFee": { "format": "double", "description": "This contains the online ordering processing fee. For card payments this is charged directly to the customer and for cash orders it is paid by the customer to the store. It is tax inclusive.", "type": "number", "example": 12.5 }, "PaymentAccountType": { "description": "Payment account type", "enum": [ "Card", "Cash", "Ideal", "Bancontact", "Giropay", "Eps", "Emv", "PayPal", "PayGreen", "GoogleWalletToken" ], "type": "string", "example": "Card" }, "PaymentAccountDescription": { "description": "Payment account description (like Visa ****2371 or Apple Pay. or Cash)", "type": "string", "example": "string" }, "OrderState": { "description": "Order state", "enum": [ "Created", "PlacedCanBeCancelled", "ReadyToProcess", "AcceptedByRestaurant", "Dispatched", "Delivered", "Cancelled", "ManualReview", "RejectedByStore", "RejectedByFlipdish", "RejectedAutomatically", "RejectedAfterBeingAccepted", "AcceptedAndRefunded", "PendingPayment" ], "type": "string", "example": "Created" }, "IsPreOrder": { "description": "Is pre-order", "type": "boolean", "example": true }, "PlacedTime": { "format": "date-time", "description": "Order placed time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "RequestedForTime": { "format": "date-time", "description": "Order requested for", "type": "string", "example": "2026-06-02T12:00:00Z" }, "ChefNote": { "description": "Chef note", "type": "string", "example": "string" }, "AppType": { "description": "Used app type", "enum": [ "Unknown", "Ios", "Android", "Web", "Kiosk", "Pos", "TelephoneCall", "Sms", "PwaAndroid", "PwaIos", "Google" ], "type": "string", "example": "Unknown" }, "UserRating": { "format": "int32", "description": "User rating", "type": "integer", "nullable": true, "example": 1 }, "PaymentStatus": { "description": "Status of the payment", "enum": [ "Paid", "Unpaid", "Refunded", "PartiallyRefunded", "Disputed" ], "type": "string", "example": "Paid" }, "RejectionReason": { "description": "Rejection reason. Can have value if the order is rejected.", "enum": [ "TooBusy", "FoodUnavailable", "UnableToDeliver", "UnknownAddress", "UnknownReason", "TooSoon", "TimeUnavailable", "DontDeliverToArea", "StoreUncontactable" ], "type": "string", "nullable": true, "example": "TooBusy" }, "RefundedAmount": { "format": "double", "description": "Amount refunded to customer.", "type": "number", "nullable": true, "example": 12.5 }, "DeliveryTrackingStatus": { "description": "Delivery tracking status", "enum": [ "Unassigned", "Unaccepted", "Accepted", "Carrying", "OnTheWay", "ArrivedAtLocation", "Delivered", "CannotDeliver" ], "type": "string", "nullable": true, "example": "Unassigned" }, "DriverId": { "format": "int32", "description": "Assigned driver identifier", "type": "integer", "nullable": true, "example": 500123 }, "TotalTax": { "format": "double", "description": "Total tax applied to order", "type": "number", "example": 12.5 }, "OrderTrackingCode": { "description": "Unique, 6 character long alpha numeric code for tracking.", "type": "string", "example": "string" }, "DeliveryFeeAreaId": { "format": "int32", "description": "Delivery area identifier", "type": "integer", "nullable": true, "example": 500123 }, "ReceiptCode": { "description": "Code used to view the order's receipt", "type": "string", "example": "string" }, "TotalDepositReturnFeeAmount": { "format": "double", "description": "This contains the total deposit return fee amount for the order.", "type": "number", "example": 12.5 } } }, "OrderBatchSummary": { "description": "Order batch info", "type": "object", "properties": { "Id": { "format": "int32", "description": "Order batch id", "type": "integer", "example": 500123 }, "DisplayCode": { "description": "Order batch 6-sign human readable code", "type": "string", "example": "string" }, "CreateTime": { "format": "date-time", "description": "Batch creation date and time", "type": "string", "example": "2026-06-02T12:00:00Z" }, "IsPublished": { "description": "If the batch is already published", "type": "boolean", "example": true } } }, "OrderDropOffLocation": { "description": "OrderDropOffLocation.", "type": "object", "properties": { "OrderId": { "format": "int32", "description": "OrderId.", "type": "integer", "example": 500123 }, "LocationName": { "description": "LocationName.", "type": "string", "example": "Example Name" }, "LocationAreaName": { "description": "LocationAreaName.", "type": "string", "example": "Example Name" }, "LocationId": { "format": "int32", "description": "LocationId.", "type": "integer", "example": 500123 }, "LocationAreaId": { "format": "int32", "description": "LocationAreaId.", "type": "integer", "example": 500123 }, "ExternalLocationId": { "description": "ExternalLocationId.", "type": "string", "example": "500123" } } }, "OrderFulfillmentStatusBase": { "description": "Fulfillment Status Information", "type": "object", "properties": { "StatusId": { "description": "Fulfillment Status Id", "type": "string", "example": "500123" }, "StatusName": { "description": "Fulfillment Status Name", "type": "string", "example": "Example Name" }, "Icon": { "description": "Status Icon", "type": "string", "example": "string" } } }, "OrderItem": { "description": "Order item", "type": "object", "properties": { "OrderItemOptions": { "description": "Option list", "type": "array", "items": { "$ref": "#/components/schemas/OrderItemOption" }, "example": [] }, "Metadata": { "description": "Metadata", "type": "object", "additionalProperties": { "type": "string" } }, "MenuItemPublicId": { "format": "uuid", "description": "Public id of the Menu Item", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "MenuSectionName": { "description": "Menu section name", "type": "string", "example": "Example Name" }, "MenuSectionDisplayOrder": { "format": "int32", "description": "Menu section display order", "type": "integer", "example": 1 }, "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "Price": { "format": "double", "description": "Price", "type": "number", "example": 12.5 }, "TaxAmount": { "format": "double", "description": "Tax currency amount", "type": "number", "example": 12.5 }, "PriceIncludingOptionSetItems": { "format": "double", "description": "Price including option set items", "type": "number", "example": 12.5 }, "MenuItemId": { "format": "int32", "description": "Menu item identifier", "type": "integer", "example": 500123 }, "MenuItemDisplayOrder": { "format": "int32", "description": "Menu item display order", "type": "integer", "example": 1 }, "IsAvailable": { "description": "Is available", "type": "boolean", "example": true }, "DepositReturnFee": { "format": "double", "description": "Deposit return fee", "type": "number", "nullable": true, "example": 12.5 } } }, "OrderItemOption": { "description": "Order item option", "type": "object", "properties": { "Metadata": { "description": "Metadata", "type": "object", "additionalProperties": { "type": "string" } }, "MenuItemOptionPublicId": { "format": "uuid", "description": "Public id of the Menu Item Option", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "MenuItemOptionId": { "format": "int32", "description": "Menu item option identifier", "type": "integer", "example": 500123 }, "IsMasterOptionSetItem": { "description": "Is master option set item", "type": "boolean", "example": true }, "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "Price": { "format": "double", "description": "Price", "type": "number", "example": 12.5 }, "TaxAmount": { "format": "double", "description": "Tax currency amount", "type": "number", "example": 12.5 }, "MenuItemOptionDisplayOrder": { "format": "int32", "description": "Menu item option display order", "type": "integer", "example": 1 }, "MenuItemOptionSetDisplayOrder": { "format": "int32", "description": "Menu item option set display order", "type": "integer", "example": 1 }, "DepositReturnFee": { "format": "double", "description": "Deposit return fee", "type": "number", "nullable": true, "example": 12.5 } } }, "OrderVoucherSummary": { "description": "Voucher summary", "type": "object", "properties": { "VoucherId": { "format": "int32", "description": "Voucher ID", "type": "integer", "example": 500123 }, "Name": { "description": "Voucher name", "type": "string", "example": "Example Name" }, "Description": { "description": "Voucher description", "type": "string", "example": "string" }, "Code": { "description": "Voucher code", "type": "string", "example": "string" }, "Amount": { "format": "double", "description": "Voucher amount", "type": "number", "example": 12.5 }, "Type": { "description": "Voucher type", "enum": [ "PercentageDiscount", "LumpDiscount", "AddItem", "CreditNote", "FreeDelivery" ], "type": "string", "example": "PercentageDiscount" }, "SubType": { "description": "Voucher sub type", "enum": [ "None", "SignUp", "Loyalty", "Loyalty25", "Retention", "SecondaryRetention", "Custom" ], "type": "string", "example": "None" } } }, "PasswordResetModel": { "description": "Password reset model", "required": [ "Password", "PasswordConfirmation" ], "type": "object", "properties": { "TokenId": { "description": "Token Id", "type": "string", "example": "500123" }, "Email": { "description": "Email address", "type": "string", "example": "owner@example.com" }, "Password": { "description": "Password", "type": "string", "example": "string" }, "PasswordConfirmation": { "description": "Password confirmation", "type": "string", "example": "string" }, "Token": { "description": "Password reset token", "type": "string", "example": "string" } } }, "PaymentAccount": { "description": "Payment Account information", "type": "object", "properties": { "UserId": { "format": "int32", "description": "The user ID associated with the payment account.", "type": "integer", "example": 500123 }, "PaymentAccountId": { "format": "int32", "description": "Unique identifier for the payment account.", "type": "integer", "example": 500123 }, "CanRemoveFromCustomerView": { "description": "Indicates if the payment account can be removed from the customer view.", "type": "boolean", "example": true }, "Bin": { "description": "Bank Identification Number (BIN) of the payment method.", "type": "string", "example": "string" }, "IsDefaultPaymentMethod": { "description": "Indicates if this is the default payment method.", "type": "boolean", "example": true }, "IsVisibleToCustomer": { "description": "Indicates if the payment account is visible to the customer.", "type": "boolean", "example": true }, "PaymentAccountType": { "description": "The type of payment account (e.g., card, PayPal).", "type": "string", "example": "string" }, "Description": { "description": "Description of the payment account.", "type": "string", "example": "string" }, "CustomerId": { "description": "The customer ID associated with the payment account.", "type": "string", "example": "500123" } } }, "PendingInvitation": { "description": "An invitation to join a team at Flipdish.", "type": "object", "properties": { "AppName": { "description": "The name of the brand that you have been invited to join.", "type": "string", "example": "Example Name" }, "Email": { "description": "The email address that the invitation was sent to.", "type": "string", "example": "owner@example.com" }, "Otc": { "description": "The one-time code that can be used to accept the invitation.", "type": "string", "example": "string" }, "CreatedAt": { "format": "date-time", "description": "The time that the invitation was created.", "type": "string", "example": "2026-06-02T12:00:00Z" } } }, "PredefinedAnswer": { "description": "Predefined answer", "type": "object", "properties": { "Id": { "format": "int32", "description": "Identifier", "type": "integer", "example": 500123 }, "Text": { "description": "Text", "type": "string", "example": "string" } } }, "RedeemInvitationResult": { "description": "", "type": "object", "properties": { "AppId": { "description": "Access level is for this App", "type": "string", "example": "500123" }, "InvitationStatus": { "description": "Invitation status", "enum": [ "Pending", "Accepted", "Expired" ], "type": "string", "example": "Pending" } } }, "RequestLoginPinModel": { "description": "Request login PIN response", "required": [ "Email" ], "type": "object", "properties": { "Email": { "description": "Email address", "type": "string", "example": "owner@example.com" } } }, "RequestLoginPinResponse": { "description": "Request login PIN response", "type": "object", "properties": { "LoginPinSentViaEmail": { "description": "Login PIN sent via email to user", "type": "boolean", "example": true }, "ForceOktaLogin": { "description": "All flipdishers must login via Okta", "type": "boolean", "example": true } } }, "RequestPasswordResetPinResponse": { "description": "Request Password Reset PIN response", "type": "object", "properties": { "PasswordResetPinSentViaEmail": { "description": "Password Reset PIN sent via email to user", "type": "boolean", "example": true } } }, "RestApiArrayResult_FlipdishAccountName_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/FlipdishAccountName" }, "example": [] } } }, "RestApiArrayResult_LocalisedTimeZone_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/LocalisedTimeZone" }, "example": [] } } }, "RestApiArrayResult_PendingInvitation_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/PendingInvitation" }, "example": [] } } }, "RestApiArrayResult_RedeemInvitationResult_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/RedeemInvitationResult" }, "example": [] } } }, "RestApiArrayResult_Teammate_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/Teammate" }, "example": [] } } }, "RestApiArrayResult_UserDeliveryLocationAdmin_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/UserDeliveryLocationAdmin" }, "example": [] } } }, "RestApiArrayResult_UserFlipdishAccount_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/UserFlipdishAccount" }, "example": [] } } }, "RestApiArrayResult_UserNote_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/UserNote" }, "example": [] } } }, "RestApiArrayResult_UserOrderSummary_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/UserOrderSummary" }, "example": [] } } }, "RestApiArrayResult_UserSmsChatItem_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/UserSmsChatItem" }, "example": [] } } }, "RestApiArrayResult_UserStoreInfo_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/UserStoreInfo" }, "example": [] } } }, "RestApiDefaultResponse": { "description": "Rest api default response", "type": "object", "properties": { "Data": { "description": "Data string", "type": "string", "readOnly": true, "example": "string" } } }, "RestApiPaginationResult_UserSearch_": { "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/UserSearch" }, "example": [] } } }, "RestApiResult_AcceptInvitationResult_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AcceptInvitationResult" } } }, "RestApiResult_AccountDetail_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AccountDetail" } } }, "RestApiResult_Customer_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/Customer" } } }, "RestApiResult_Customers_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/Customers" } } }, "RestApiResult_Order_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/Order" } } }, "RestApiResult_RedeemInvitationResult_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/RedeemInvitationResult" } } }, "RestApiResult_Teammate_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/Teammate" } } }, "RestApiResult_UserInfo_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/UserInfo" } } }, "RestApiResult_UserPushNotificationSentResult_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/UserPushNotificationSentResult" } } }, "RestApiResult_UserRole_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/UserRole" } } }, "RestApiStringArrayResult": { "description": "Rest api string array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Data string array", "type": "array", "items": { "type": "string" }, "example": [ "string" ] } } }, "RestApiStringResult": { "description": "Rest api string result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Data string", "type": "string", "example": "string" } } }, "SendUserPushNotificationRequest": { "description": "Send a push notification to a user.", "type": "object", "properties": { "WhiteLabelId": { "format": "int32", "description": "WhiteLabelId.", "type": "integer", "example": 500123 }, "Message": { "description": "Message.", "type": "string", "example": "string" } } }, "SendUserSmsRequest": { "description": "Send an SMS to a user from admin.", "type": "object", "properties": { "Message": { "description": "Message.", "type": "string", "example": "string" }, "WhiteLabelId": { "format": "int32", "description": "WhiteLabelId.", "type": "integer", "example": 500123 }, "FromNumber": { "description": "FromNumber.", "type": "string", "example": "string" } } }, "SetPasswordWithPinModel": { "description": "Set password with PIN model", "required": [ "Pin", "NewPassword" ], "type": "object", "properties": { "Pin": { "format": "int32", "description": "PIN code (received via email)", "type": "integer", "example": 1 }, "NewPassword": { "description": "New Password", "type": "string", "example": "string" }, "RecaptchaToken": { "description": "Google Recaptcha Token", "type": "string", "example": "string" } } }, "SetUserDeliveryLocationCoordinatesRequest": { "description": "Set delivery location coordinates.", "type": "object", "properties": { "Latitude": { "format": "double", "description": "Latitude.", "type": "number", "example": 1.0 }, "Longitude": { "format": "double", "description": "Longitude.", "type": "number", "example": 1.0 } } }, "SetUserDeliveryLocationFieldRequest": { "description": "Update a single delivery location field (matches legacy SetDeliveryLocationInfo names).", "type": "object", "properties": { "Field": { "description": "Which field to update. Omit or set to null for a validation error.", "enum": [ "DeliveryInstructions", "IsDisplayed", "BuildingString", "StreetString", "TownString" ], "type": "string", "nullable": true, "example": "DeliveryInstructions" }, "Value": { "description": "Value.", "type": "string", "example": "string" } } }, "SignupStep": { "description": "", "type": "object", "properties": { "Action": { "description": "Action needs to take", "enum": [ "Question", "StoreLocation", "PaymentSubscription", "StoreName" ], "type": "string", "example": "Question" }, "Question": { "description": "Question in case Action == Question", "type": "string", "example": "string" }, "PredefinedAnswers": { "description": "Predefined answer in case Action == Question", "type": "array", "items": { "$ref": "#/components/schemas/PredefinedAnswer" }, "example": [] } } }, "StoreSummary": { "description": "Store summary", "type": "object", "properties": { "Id": { "format": "int32", "description": "Store identifier", "type": "integer", "example": 500123 }, "Name": { "description": "Store name", "type": "string", "example": "Example Name" }, "MenuId": { "format": "int32", "description": "Stores menu identifier", "type": "integer", "example": 500123 }, "MenuPublishId": { "format": "uuid", "description": "Stores menu publish GUID", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Metadata": { "description": "Store metadata", "type": "object", "additionalProperties": { "type": "string" } }, "Currency": { "description": "Currency which used by the Store", "enum": [ "EUR", "USD", "GBP", "CAD", "AUD", "DJF", "ZAR", "ETB", "AED", "BHD", "DZD", "EGP", "IQD", "JOD", "KWD", "LBP", "LYD", "MAD", "OMR", "QAR", "SAR", "SYP", "TND", "YER", "CLP", "INR", "AZN", "RUB", "BYN", "BGN", "NGN", "BDT", "CNY", "BAM", "CZK", "DKK", "CHF", "MVR", "BTN", "XCD", "BZD", "HKD", "IDR", "JMD", "MYR", "NZD", "PHP", "SGD", "TTD", "XDR", "ARS", "BOB", "COP", "CRC", "CUP", "DOP", "GTQ", "HNL", "MXN", "NIO", "PAB", "PEN", "PYG", "UYU", "VEF", "IRR", "XOF", "CDF", "XAF", "HTG", "ILS", "HRK", "HUF", "AMD", "ISK", "JPY", "GEL", "KZT", "KHR", "KRW", "KGS", "LAK", "MKD", "MNT", "BND", "MMK", "NOK", "NPR", "PKR", "PLN", "AFN", "BRL", "MDL", "RON", "RWF", "SEK", "LKR", "SOS", "ALL", "RSD", "KES", "TJS", "THB", "ERN", "TMT", "BWP", "TRY", "UAH", "UZS", "VND", "MOP", "TWD", "BMD" ], "type": "string", "example": "EUR" }, "Coordinates": { "$ref": "#/components/schemas/Coordinates" }, "StoreTimezone": { "description": "Timezone of store", "type": "string", "example": "string" }, "StoreIanaTimezone": { "description": "IANA Timezone of store", "type": "string", "example": "string" }, "StoreGroupId": { "format": "int32", "description": "Store group id of store", "type": "integer", "example": 500123 }, "TaxId": { "description": "VAT number or generic Tax ID of the store", "type": "string", "example": "500123" }, "PrettyAddress": { "description": "Address of the store", "type": "string", "example": "string" }, "CountryCode": { "description": "Country code of the store address (ISO 3166-1 alpha-2)", "type": "string", "example": "IE" }, "PropertyId": { "description": "Property identifier", "type": "string", "example": "500123" } } }, "TaxItem": { "description": "A collection of tax items on the order.", "type": "object", "properties": { "Name": { "description": "The name of the tax item.", "type": "string", "example": "Example Name" }, "Rate": { "format": "double", "description": "The tax rate applied to the item.", "type": "number", "example": 1.0 }, "Amount": { "format": "double", "description": "The amount of tax applied to the item.", "type": "number", "example": 12.5 } } }, "Teammate": { "description": "", "type": "object", "properties": { "TeammateId": { "description": "Unique indentifier", "type": "string", "example": "500123" }, "UserId": { "format": "int32", "description": "User ID of the teammate", "type": "integer", "nullable": true, "example": 500123 }, "Name": { "description": "Name", "type": "string", "example": "Example Name" }, "LastActivity": { "format": "date-time", "description": "Last activity", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "AppId": { "description": "Access level is for this App", "type": "string", "example": "500123" }, "InvitationStatus": { "description": "Invitation status", "enum": [ "Pending", "Accepted", "Expired" ], "type": "string", "example": "Pending" }, "Email": { "description": "Email address", "type": "string", "example": "owner@example.com" }, "AppAccessLevel": { "description": "App access level", "enum": [ "None", "Owner", "StoreOwner", "PropertyOwner", "ManagedOwner", "Integrator", "PropertyManager", "StoreManager", "StoreStaff", "StoreReadOnlyAccess", "FinanceManger", "Onboarding", "Support" ], "type": "string", "example": "None" }, "HasAccessToAllStores": { "description": "The user has access to all stores for the app (including new stores that added later)", "type": "boolean", "example": true }, "StoreIds": { "description": "Store IDs the user has access to (if HasAccessToAllStores is false)", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "PropertyIds": { "description": "Property Ids the user has access to (if HasAccessToAllStores is false)", "type": "array", "items": { "type": "string" }, "example": [ "string" ] } } }, "TeammateBase": { "description": "", "type": "object", "properties": { "AppAccessLevel": { "description": "App access level", "enum": [ "None", "Owner", "StoreOwner", "PropertyOwner", "ManagedOwner", "Integrator", "PropertyManager", "StoreManager", "StoreStaff", "StoreReadOnlyAccess", "FinanceManger", "Onboarding", "Support" ], "type": "string", "example": "None" }, "HasAccessToAllStores": { "description": "The user has access to all stores for the app (including new stores that added later)", "type": "boolean", "example": true }, "StoreIds": { "description": "Store IDs the user has access to (if HasAccessToAllStores is false)", "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "PropertyIds": { "description": "Property Ids the user has access to (if HasAccessToAllStores is false)", "type": "array", "items": { "type": "string" }, "example": [ "string" ] } } }, "UpdateDriverProfileModel": { "description": "Update Driver Profile", "type": "object", "properties": { "Name": { "description": "The new name of the Driver.", "type": "string", "example": "Example Name" } } }, "UserDeliveryLocationAdmin": { "description": "Delivery location with identifiers for admin user management.", "type": "object", "properties": { "DeliveryLocationId": { "format": "int32", "description": "DeliveryLocationId.", "type": "integer", "example": 500123 }, "Building": { "description": "Building.", "type": "string", "example": "string" }, "Street": { "description": "Street.", "type": "string", "example": "string" }, "Town": { "description": "Town.", "type": "string", "example": "string" }, "PostCode": { "description": "PostCode.", "type": "string", "example": "string" }, "DeliveryInstructions": { "description": "DeliveryInstructions.", "type": "string", "example": "string" }, "AutoSelectThisLocation": { "description": "AutoSelectThisLocation.", "type": "boolean", "example": true }, "IsDisplayed": { "description": "IsDisplayed.", "type": "boolean", "example": true }, "IsConfirmed": { "description": "IsConfirmed.", "type": "boolean", "nullable": true, "example": true }, "Coordinates": { "$ref": "#/components/schemas/Coordinates" } } }, "UserFlipdishAccount": { "description": "Flipdish account information associated with a user", "type": "object", "properties": { "PayeeBankAccountDataId": { "format": "int32", "description": "Payee Bank Account Data Id", "type": "integer", "nullable": true, "example": 500123 }, "FlipdishAccountId": { "format": "int32", "description": "Flipdish Account Id", "type": "integer", "example": 500123 }, "Name": { "description": "Flipdish Account Name", "type": "string", "example": "Example Name" } } }, "UserInfo": { "description": "User information", "type": "object", "properties": { "PhoneNumber": { "description": "The user's phone number.", "type": "string", "example": "+353000000000" }, "Email": { "description": "The user's email address.", "type": "string", "example": "owner@example.com" }, "EmailConfirmed": { "description": "Indicates if the user's email address has been confirmed.", "type": "boolean", "example": true }, "PreventFromUsingCards": { "description": "Indicates if the user is prevented from using cards.", "type": "boolean", "example": true }, "IsUserPhoneNumberBlocked": { "description": "Indicates if the user's phone number is blocked.", "type": "boolean", "example": true }, "UserWhiteLabels": { "description": "List of white label information associated with the user.", "type": "array", "items": { "$ref": "#/components/schemas/UserWhiteLabelInfo" }, "example": [] }, "UserId": { "format": "int32", "description": "The unique identifier for the user.", "type": "integer", "example": 500123 }, "UserName": { "description": "The user's username.", "type": "string", "example": "Example Name" }, "CustomerName": { "description": "The customer's name.", "type": "string", "example": "Example Name" }, "HasLoggedIn": { "description": "Indicates if the user has logged in.", "type": "boolean", "example": true }, "DisableAppRatingControl": { "description": "Indicates if the app rating control is disabled for the user.", "type": "boolean", "example": true }, "GloballyOptedOut": { "description": "Indicates if the user has globally opted out.", "type": "boolean", "example": true }, "CompletedOrderCount": { "format": "int32", "description": "The number of completed orders by the user.", "type": "integer", "example": 3 }, "CancelledOrderCount": { "format": "int32", "description": "The number of cancelled orders by the user.", "type": "integer", "example": 3 }, "OrderTotalValue": { "format": "double", "description": "The total value of orders placed by the user.", "type": "number", "example": 12.5 }, "TsMostRecentOrder": { "format": "date-time", "description": "The timestamp of the user's most recent order.", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "TsFirstOrder": { "format": "date-time", "description": "The timestamp of the user's first order.", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "IsRestaurantUser": { "description": "Indicates if the user is a restaurant user.", "type": "boolean", "example": true }, "Installs": { "description": "List of app installs associated with the user.", "type": "array", "items": { "$ref": "#/components/schemas/AppInstall" }, "example": [] }, "DeliveryLocations": { "description": "List of delivery locations associated with the user.", "type": "array", "items": { "$ref": "#/components/schemas/DeliveryLocation" }, "example": [] }, "PaymentAccounts": { "description": "List of payment accounts associated with the user.", "type": "array", "items": { "$ref": "#/components/schemas/PaymentAccount" }, "example": [] }, "LanguageId": { "description": "The language identifier for the user.", "type": "string", "example": "500123" }, "CurrentLanguageName": { "description": "Current language name for the user.", "type": "string", "example": "Example Name" }, "Languages": { "description": "Available languages that the user can choose from.", "type": "array", "items": { "$ref": "#/components/schemas/Language" }, "example": [] }, "SalesForceContactId": { "description": "The Salesforce contact ID for the user.", "type": "string", "example": "500123" }, "StripeCustomerId": { "description": "The Stripe customer ID for the user.", "type": "string", "example": "500123" }, "UserMonthlyCommissions": { "description": "User's monthly commissions.", "type": "array", "items": { "$ref": "#/components/schemas/UserMonthlyCommission" }, "example": [] } } }, "UserMonthlyCommission": { "description": "User Monthly Commission", "type": "object", "properties": { "UserId": { "format": "int32", "description": "The unique identifier of the user.", "type": "integer", "example": 500123 }, "MonthStart": { "format": "date-time", "description": "The start date of the month for which the commission is calculated.", "type": "string", "example": "2026-06-02T12:00:00Z" }, "CommissionAmount": { "format": "double", "description": "The total commission amount for the user in the specified month.", "type": "number", "example": 12.5 }, "Currency": { "description": "The currency in which the commission is paid.", "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" }, "IsoCurrency": { "description": "The ISO currency code for the commission currency.", "type": "string", "example": "EUR" } } }, "UserNote": { "description": "User Note", "type": "object", "properties": { "UserNoteId": { "format": "int32", "description": "Identifier for the user note.", "type": "integer", "example": 500123 }, "UserId": { "format": "int32", "description": "User identifier associated with the note.", "type": "integer", "example": 500123 }, "Note": { "description": "Note content.", "type": "string", "example": "string" }, "TsCreate": { "format": "date-time", "description": "Creation timestamp of the note.", "type": "string", "example": "2026-06-02T12:00:00Z" }, "CreatedByUserId": { "format": "int32", "description": "Identifier of the user who created the note.", "type": "integer", "example": 500123 }, "CreatedByUserName": { "description": "Name of the user who created the note.", "type": "string", "example": "Example Name" }, "CreatedByUserEmail": { "description": "Email of the user who created the note.", "type": "string", "example": "owner@example.com" } } }, "UserOrderSummary": { "description": "A previous order row for admin user management (structured; no HTML).", "type": "object", "properties": { "OrderId": { "format": "int32", "description": "OrderId.", "type": "integer", "example": 500123 }, "TsOrderPlacedUtc": { "format": "date-time", "description": "TsOrderPlacedUtc.", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "TsUpdateUtc": { "format": "date-time", "description": "TsUpdateUtc.", "type": "string", "example": "2026-06-02T12:00:00Z" }, "RestaurantName": { "description": "RestaurantName.", "type": "string", "example": "Example Name" }, "FoodAmount": { "format": "double", "description": "FoodAmount.", "type": "number", "example": 12.5 }, "TipAmount": { "format": "double", "description": "TipAmount.", "type": "number", "example": 12.5 }, "TotalRestaurantAmount": { "format": "double", "description": "TotalRestaurantAmount.", "type": "number", "example": 12.5 }, "IsoCurrency": { "description": "IsoCurrency.", "type": "string", "example": "EUR" }, "DeliveryType": { "description": "DeliveryType.", "type": "string", "example": "string" }, "OrderState": { "description": "OrderState.", "type": "string", "example": "string" }, "PaymentAccountDescription": { "description": "PaymentAccountDescription.", "type": "string", "example": "string" } } }, "UserPushNotificationSentResult": { "description": "Result of sending push notification.", "type": "object", "properties": { "TokenCount": { "format": "int32", "description": "TokenCount.", "type": "integer", "example": 3 } } }, "UserRole": { "description": "User Role", "type": "object", "properties": { "RolesUserIn": { "description": "Roles the user is in", "type": "array", "items": { "type": "string" }, "example": [ "string" ] }, "RolesUserNotIn": { "description": "Roles the user is not in", "type": "array", "items": { "type": "string" }, "example": [ "string" ] } } }, "UserSearch": { "description": "User Search Result", "type": "object", "properties": { "Id": { "format": "int32", "description": "User Id", "type": "integer", "example": 500123 }, "PhoneNumber": { "description": "Phone Number", "type": "string", "example": "+353000000000" }, "Email": { "description": "Email", "type": "string", "example": "owner@example.com" }, "CustomerName": { "description": "Customer Name", "type": "string", "example": "Example Name" }, "HasLoggedIn": { "description": "Has Logged In", "type": "boolean", "example": true }, "UserDiscriminator": { "description": "User Discriminator", "enum": [ "All", "ApplicationUsers", "RestaurantUsers", "HydraUsers" ], "type": "string", "example": "All" }, "TsCreate": { "format": "date-time", "description": "Timestamp Created", "type": "string", "example": "2026-06-02T12:00:00Z" }, "WhiteLabelConfigs": { "description": "WhiteLabel Configs", "type": "array", "items": { "$ref": "#/components/schemas/UserWhiteLabelConfig" }, "example": [] }, "UserType": { "description": "User Type", "type": "string", "readOnly": true, "example": "string" } } }, "UserSmsChatItem": { "description": "An SMS conversation item for admin user chat.", "type": "object", "properties": { "SmsConversationItemId": { "format": "int32", "description": "SmsConversationItemId.", "type": "integer", "example": 500123 }, "Direction": { "description": "Direction.", "type": "string", "example": "string" }, "From": { "description": "From.", "type": "string", "example": "string" }, "Text": { "description": "Text.", "type": "string", "example": "string" }, "TsSentReceivedUtc": { "format": "date-time", "description": "TsSentReceivedUtc.", "type": "string", "example": "2026-06-02T12:00:00Z" } } }, "UserStoreInfo": { "description": "Stores that the user is associated with", "type": "object", "properties": { "PropertyId": { "description": "Property Id", "type": "string", "example": "500123" }, "StoreId": { "format": "int32", "description": "Store Id", "type": "integer", "example": 500123 }, "StoreName": { "description": "Store Name", "type": "string", "example": "Example Name" } } }, "UserWhiteLabelConfig": { "description": "User WhiteLabelConfig", "type": "object", "properties": { "Id": { "format": "int32", "description": "Identifier", "type": "integer", "example": 500123 }, "ConfigId": { "format": "int32", "description": "WlConfigId", "type": "integer", "example": 500123 }, "AppId": { "description": "Brand Id", "type": "string", "example": "500123" }, "Name": { "description": "WhiteLabel Name", "type": "string", "example": "Example Name" }, "Level": { "description": "WhiteLabel Access Level", "enum": [ "None", "Owner", "StoreOwner", "PropertyOwner", "ManagedOwner", "Integrator", "PropertyManager", "StoreManager", "StoreStaff", "StoreReadOnlyAccess", "FinanceManager", "Support" ], "type": "string", "example": "None" } } }, "UserWhiteLabelInfo": { "description": "User WhiteLabel information", "type": "object", "properties": { "WlConfigId": { "format": "int32", "description": "WhiteLabelConfig Id", "type": "integer", "example": 500123 }, "AppId": { "description": "Brand Id (AppId)", "type": "string", "example": "500123" }, "WhiteLabelName": { "description": "WhiteLabel Name", "type": "string", "example": "Example Name" } } } }, "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" } } } } } } }