Flipdish · Schema

AppConfigUpdateModel

Application configuration

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
Name string App name. This is used in various places on the Apple App Store, Google Play Store, mobile apps and websites.
HostName string HostName on which the web-ordering system is allowed to be hosted or that a Flipdish website is hosted on.
MainColor string Main color of the web / Android / iOS applications
KioskPrimaryColour string Primary colour used on the Kiosk
ApplicationCategory string Application Category
IsPanaceaEnabled boolean Panacea is the term used for websites that are hosted on the my.flipdish.com domain. This value is true when the App's website is hosted on this domain. The alternative to using Panacea websites is to
PanaceaVanityUrl string In case of IsPanaceaEnabled is true, the app can be accessed via https://my.flipdish.com/{PanaceaVanityUrl}
CookieConsentPromptEnabled boolean Cookie Consent Prompt Enabled
LogoImageUrl string Logo image URL
CountryId string Country identifier in ISO 3166-1 alpha-2 format. This code is set automatically based on the locations of the Stores in the App. The App Country is used - to determine how to parse mobile phone number
View JSON Schema on GitHub

JSON Schema

apps-app-config-update-model-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/apps-app-config-update-model-schema.json",
  "title": "AppConfigUpdateModel",
  "description": "Application configuration",
  "type": "object",
  "properties": {
    "Name": {
      "description": "App name. \r\nThis is used in various places on the Apple App Store, Google Play Store, mobile apps and websites.",
      "type": "string",
      "example": "Example Name"
    },
    "HostName": {
      "description": "HostName on which the web-ordering system is allowed to be hosted or that a Flipdish website is hosted on.",
      "type": "string",
      "example": "Example Name"
    },
    "MainColor": {
      "description": "Main color of the web / Android / iOS applications",
      "type": "string",
      "example": "string"
    },
    "KioskPrimaryColour": {
      "description": "Primary colour used on the Kiosk",
      "type": "string",
      "example": "string"
    },
    "ApplicationCategory": {
      "description": "Application Category",
      "enum": [
        "Restaurant",
        "Cafe",
        "Convenience"
      ],
      "type": "string",
      "example": "Restaurant"
    },
    "IsPanaceaEnabled": {
      "description": "Panacea is the term used for websites that are hosted on the my.flipdish.com domain. This value is true when the App's website is hosted on this domain.\r\nThe alternative to using Panacea websites is to use a custom domain.",
      "type": "boolean",
      "example": true
    },
    "PanaceaVanityUrl": {
      "description": "In case of IsPanaceaEnabled is true, the app can be accessed via https://my.flipdish.com/{PanaceaVanityUrl}",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "CookieConsentPromptEnabled": {
      "description": "Cookie Consent Prompt Enabled",
      "type": "boolean",
      "example": true
    },
    "LogoImageUrl": {
      "description": "Logo image URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "CountryId": {
      "description": "Country identifier in ISO 3166-1 alpha-2 format. \r\nThis code is set automatically based on the locations of the Stores in the App. \r\n\r\nThe App Country is used \r\n - to determine how to parse mobile phone numbers that are entered in their local numbering format\r\n - to determine if country specific payment methods should be offered\r\n - in various fraud checks",
      "maxLength": 2,
      "minLength": 0,
      "type": "string",
      "example": "500123"
    }
  }
}