Flipdish · JSON Structure

Apps White Label Config Model Structure

WhiteLabelConfig model

Type: object Properties: 108
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

WhiteLabelConfigModel is a JSON Structure definition published by Flipdish, describing 108 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

WhiteLabelLanguages WhiteLabelAssets ColorScheme WhiteLabelConfigId WhiteLabelId WhiteLabelName AppNameId OrgId SmsRestaurantName DeepLinkUrlScheme HostName NexmoSupportSmsNumber TwilioSupportSmsNumber MixpanelToken IntercomAppId ShareMessageEmailSubject ShareMessageEmailMessage ShareMessageSmsMessage ShareMessageWhatsAppMessage ShareMessageFacebookMessage ShareMessageTwitterMessage ShareMessageGenericMessage DisplayDeliveryRestaurantListScreen ContactFormType ContactPhoneNumber DisplayBumpSideMenuItem DisplayFreeCokeSideMenuItem AppStoreUrl DeliveryEnabled PickupEnabled DisplayPickupRestaurantListScreen DisplayCuisineTypeListAndRestaurantSearchBar DisplayUserRestaurantRatings ReadyToPublishWeb ReadyToPublishIos ReadyToPublishAndroid DisplayFooterLinksToOtherSites DisplayOnlineOrderingMenu HideAppConfigFromAdminList ComplianceType IsMenuMigratedToRms MapBoundryMaxLongitude MapBoundryMinLongitude MapBoundryMaxLatitude MapBoundryMinLatitude AppStoreAppleId AppStoreToken WebsiteDisplayStaticMenuPage IsEmbed DisplayTipOptionToUsersByDefault

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-structure/apps-white-label-config-model-structure.json",
  "name": "WhiteLabelConfigModel",
  "description": "WhiteLabelConfig model",
  "type": "object",
  "properties": {
    "WhiteLabelLanguages": {
      "description": "White label languages",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WhiteLabelLanguageModel"
      },
      "example": []
    },
    "WhiteLabelAssets": {
      "description": "White label assets",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WhiteLabelAssetModel"
      },
      "example": []
    },
    "ColorScheme": {
      "$ref": "#/components/schemas/WhiteLabelColorSchemeModel"
    },
    "WhiteLabelConfigId": {
      "description": "White label configuration ID",
      "type": "int32",
      "example": 500123
    },
    "WhiteLabelId": {
      "description": "White label ID",
      "type": "int32",
      "example": 500123
    },
    "WhiteLabelName": {
      "description": "White label name",
      "type": "string",
      "example": "Example Name"
    },
    "AppNameId": {
      "description": "App name ID (Bundle ID Suffix)",
      "type": "string",
      "example": "500123"
    },
    "OrgId": {
      "description": "Organization ID",
      "type": "string",
      "example": "500123"
    },
    "SmsRestaurantName": {
      "description": "SMS restaurant name",
      "type": "string",
      "example": "Example Name"
    },
    "DeepLinkUrlScheme": {
      "description": "Deep link URL scheme",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "HostName": {
      "description": "Host name",
      "type": "string",
      "example": "Example Name"
    },
    "NexmoSupportSmsNumber": {
      "description": "Nexmo support SMS number",
      "type": "string",
      "example": "string"
    },
    "TwilioSupportSmsNumber": {
      "description": "Twilio support SMS number",
      "type": "string",
      "example": "string"
    },
    "MixpanelToken": {
      "description": "Mixpanel token",
      "type": "string",
      "example": "string"
    },
    "IntercomAppId": {
      "description": "Intercom app ID",
      "type": "string",
      "example": "500123"
    },
    "ShareMessageEmailSubject": {
      "description": "Share message email subject",
      "type": "string",
      "example": "owner@example.com"
    },
    "ShareMessageEmailMessage": {
      "description": "Share message email message",
      "type": "string",
      "example": "owner@example.com"
    },
    "ShareMessageSmsMessage": {
      "description": "Share message SMS message",
      "type": "string",
      "example": "string"
    },
    "ShareMessageWhatsAppMessage": {
      "description": "Share message WhatsApp message",
      "type": "string",
      "example": "string"
    },
    "ShareMessageFacebookMessage": {
      "description": "Share message Facebook message",
      "type": "string",
      "example": "string"
    },
    "ShareMessageTwitterMessage": {
      "description": "Share message Twitter message",
      "type": "string",
      "example": "string"
    },
    "ShareMessageGenericMessage": {
      "description": "Share message generic message",
      "type": "string",
      "example": "string"
    },
    "DisplayDeliveryRestaurantListScreen": {
      "description": "Display delivery restaurant list screen",
      "type": "boolean",
      "example": true
    },
    "ContactFormType": {
      "description": "Contact form type",
      "type": "int32",
      "example": 1
    },
    "ContactPhoneNumber": {
      "description": "Contact phone number",
      "type": "string",
      "example": "+353000000000"
    },
    "DisplayBumpSideMenuItem": {
      "description": "Display bump side menu item",
      "type": "boolean",
      "example": true
    },
    "DisplayFreeCokeSideMenuItem": {
      "description": "Display free coke side menu item",
      "type": "boolean",
      "example": true
    },
    "AppStoreUrl": {
      "description": "App store URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "DeliveryEnabled": {
      "description": "Delivery enabled",
      "type": "boolean",
      "example": true
    },
    "PickupEnabled": {
      "description": "Pickup enabled",
      "type": "boolean",
      "example": true
    },
    "DisplayPickupRestaurantListScreen": {
      "description": "Display pickup restaurant list screen",
      "type": "boolean",
      "example": true
    },
    "DisplayCuisineTypeListAndRestaurantSearchBar": {
      "description": "Display cuisine type list and restaurant search bar",
      "type": "boolean",
      "example": true
    },
    "DisplayUserRestaurantRatings": {
      "description": "Display user restaurant ratings",
      "type": "boolean",
      "example": true
    },
    "ReadyToPublishWeb": {
      "description": "Ready to publish web",
      "type": "boolean",
      "example": true
    },
    "ReadyToPublishIos": {
      "description": "Ready to publish iOS",
      "type": "boolean",
      "example": true
    },
    "ReadyToPublishAndroid": {
      "description": "Ready to publish Android",
      "type": "boolean",
      "example": true
    },
    "DisplayFooterLinksToOtherSites": {
      "description": "Display footer links to other sites",
      "type": "boolean",
      "example": true
    },
    "DisplayOnlineOrderingMenu": {
      "description": "Display online ordering menu",
      "type": "boolean",
      "example": true
    },
    "HideAppConfigFromAdminList": {
      "description": "Hide app config from admin list",
      "type": "boolean",
      "example": true
    },
    "ComplianceType": {
      "description": "Compliance type",
      "enum": [
        "Default",
        "GdprCompliance"
      ],
      "type": "string",
      "example": "Default"
    },
    "IsMenuMigratedToRms": {
      "description": "Is menu migrated to RMS",
      "type": "boolean",
      "example": true
    },
    "MapBoundryMaxLongitude": {
      "description": "Map boundary max longitude",
      "type": "double",
      "nullable": true,
      "example": 1.0
    },
    "MapBoundryMinLongitude": {
      "description": "Map boundary min longitude",
      "type": "double",
      "nullable": true,
      "example": 1.0
    },
    "MapBoundryMaxLatitude": {
      "description": "Map boundary max latitude",
      "type": "double",
      "nullable": true,
      "example": 1.0
    },
    "MapBoundryMinLatitude": {
      "description": "Map boundary min latitude",
      "type": "double",
      "nullable": true,
      "example": 1.0
    },
    "AppStoreAppleId": {
      "description": "App store Apple ID",
      "type": "string",
      "example": "500123"
    },
    "AppStoreToken": {
      "description": "App store token",
      "type": "string",
      "example": "string"
    },
    "WebsiteDisplayStaticMenuPage": {
      "description": "Website display static menu page",
      "type": "boolean",
      "example": true
    },
    "IsEmbed": {
      "description": "Is embed",
      "type": "boolean",
      "nullable": true,
      "example": true
    },
    "DisplayTipOptionToUsersByDefault": {
      "description": "Display tip option to users by default",
      "type": "boolean",
      "example": true
    },
    "EmailRequestMode": {
      "description": "Email request mode",
      "type": "int32",
      "example": 1
    },
    "AddressEntryType": {
      "description": "Address entry type",
      "type": "int32",
      "example": 1
    },
    "AddressLayout": {
      "description": "Address layout",
      "type": "int32",
      "example": 1
    },
    "Category": {
      "description": "Category",
      "type": "int32",
      "example": 1
    },
    "MapCenterLatitude": {
      "description": "Map center latitude",
      "type": "double",
      "example": 1.0
    },
    "MapCenterLongitude": {
      "description": "Map center longitude",
      "type": "double",
      "example": 1.0
    },
    "IntercomTokenIos": {
      "description": "Intercom token iOS",
      "type": "string",
      "example": "string"
    },
    "IntercomTokenAndroid": {
      "description": "Intercom token Android",
      "type": "string",
      "example": "500123"
    },
    "GoogleAnalyticsTokensCsv": {
      "description": "Google Analytics tokens CSV",
      "type": "string",
      "example": "string"
    },
    "FacebookTokensCsv": {
      "description": "Facebook tokens CSV",
      "type": "string",
      "example": "string"
    },
    "ShareMessageGenericUrl": {
      "description": "Share message generic URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "PrivateSupportEmailAddress": {
      "description": "Private support email address",
      "type": "string",
      "example": "owner@example.com"
    },
    "AppStoreId": {
      "description": "App store ID",
      "type": "string",
      "example": "500123"
    },
    "PlayConsoleAccount": {
      "description": "Play console account",
      "type": "int32",
      "example": 3
    },
    "ApnCertificateValidAfter": {
      "description": "APN certificate valid after",
      "type": "datetime",
      "nullable": true,
      "example": "2026-06-02T12:00:00Z"
    },
    "ApnCertificateValidBefore": {
      "description": "APN certificate valid before",
      "type": "datetime",
      "nullable": true,
      "example": "2026-06-02T12:00:00Z"
    },
    "DineInEnabled": {
      "description": "Dine in enabled",
      "type": "boolean",
      "example": true
    },
    "AppFont": {
      "description": "App font",
      "type": "string",
      "example": "string"
    },
    "WhiteLabelColorSchemeId": {
      "description": "White label color scheme ID",
      "type": "int32",
      "example": 500123
    },
    "WhiteLabelImagesId": {
      "description": "White label images ID",
      "type": "int32",
      "example": 500123
    },
    "AppStoreCopyright": {
      "description": "App store copyright",
      "type": "string",
      "example": "string"
    },
    "AppStoreDescription": {
      "description": "App store description",
      "type": "string",
      "example": "string"
    },
    "AppStoreShortDescription": {
      "description": "App store short description",
      "type": "string",
      "example": "string"
    },
    "AppStoreKeywords": {
      "description": "App store keywords",
      "type": "string",
      "example": "string"
    },
    "AppStoreMarketingUrl": {
      "description": "App store marketing URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "AppStoreName": {
      "description": "App store name",
      "type": "string",
      "example": "Example Name"
    },
    "AppStorePrivacyUrl": {
      "description": "App store privacy URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "AppStoreSupportUrl": {
      "description": "App store support URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "AppStoreReleaseNotes": {
      "description": "App store release notes",
      "type": "string",
      "example": "string"
    },
    "AppStoreIconUrl": {
      "description": "App store icon URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "AppStoreIconThumbnail100Url": {
      "description": "App store icon thumbnail 100 URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "TransparentLogoUrl": {
      "description": "Transparent logo URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "LogoImageName": {
      "description": "Logo image name",
      "type": "string",
      "example": "Example Name"
    },
    "KioskNameScreenImage": {
      "description": "Kiosk name screen image",
      "type": "string",
      "example": "Example Name"
    },
    "WebToAppRedirect": {
      "description": "Web to app redirect",
      "type": "int32",
      "example": 1
    },
    "FeaturesCsv": {
      "description": "Features CSV",
      "type": "string",
      "example": "string"
    },
    "AppStorePassword": {
      "description": "App store password",
      "type": "string",
      "example": "string"
    },
    "AppStoreTeamId": {
      "description": "App store team ID",
      "type": "string",
      "example": "500123"
    },
    "AppStoreAppGroup": {
      "description": "App store app group",
      "type": "string",
      "example": "string"
    },
    "AppStoreSigningIdentity": {
      "description": "App store signing identity",
      "type": "string",
      "example": "string"
    },
    "AppStoreItcTeamId": {
      "description": "App store ITC team ID",
      "type": "string",
      "example": "500123"
    },
    "HeadHtml": {
      "description": "Head HTML",
      "type": "string",
      "example": "string"
    },
    "SocialTwitterUrl": {
      "description": "Social Twitter URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "SocialFacebookUrl": {
      "description": "Social Facebook URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "SocialInstagramUrl": {
      "description": "Social Instagram URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "SocialPintrestUrl": {
      "description": "Social Pinterest URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "SocialTripAdvisorUrl": {
      "description": "Social TripAdvisor URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "SocialGooglePlusUrl": {
      "description": "Social Google Plus URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "SocialFourSquareUrl": {
      "description": "Social FourSquare URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "SocialYelpUrl": {
      "description": "Social Yelp URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "WebsiteType": {
      "description": "Website type",
      "type": "int32",
      "example": 1
    },
    "ExternalOrderingPageUrl": {
      "description": "External ordering page URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "PanaceaEnabled": {
      "description": "Panacea enabled",
      "type": "boolean",
      "example": true
    },
    "CookieConsentPromptEnabled": {
      "description": "Cookie consent prompt enabled",
      "type": "boolean",
      "example": true
    },
    "PanaceaVanityUrl": {
      "description": "Panacea vanity URL",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "CountryId": {
      "description": "Country ID",
      "type": "string",
      "example": "500123"
    },
    "ReferralUserId": {
      "description": "Referral user ID",
      "type": "int32",
      "nullable": true,
      "example": 500123
    },
    "ReferralCampaignId": {
      "description": "Referral campaign ID",
      "type": "string",
      "example": "500123"
    }
  }
}