Flipdish · Schema

AppGeneralConfigModel

App general configuration model

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name	Type	Description
WhiteLabelId	integer	White label ID
DeepLinkUrlScheme	string	Deep link URL scheme
SmsRestaurantName	string	SMS restaurant name
NexmoSupportSmsNumber	string	Nexmo support SMS number
TwilioSupportSmsNumber	string	Twilio support SMS number
FallbackPhoneNumberPrefix	string	Fallback phone number prefix
AutocompletePhoneNumberLength	integer	Autocomplete phone number length
ContactFormType	string	Contact form type None = 0, Email = 1, Intercom = 2, WebView = 3, FlipdishMessages = 4
PrivateSupportEmailAddress	string	Private support email address
ContactPhoneNumber	string	Contact phone number
DeliveryEnabled	boolean	Delivery enabled
PickupEnabled	boolean	Pickup enabled
DineInEnabled	boolean	Dine in enabled
DisplayDeliveryRestaurantListScreen	boolean	Display delivery restaurant list screen
DisplayPickupRestaurantListScreen	boolean	Display pickup restaurant list screen

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/apps-app-general-config-model-schema.json",
  "title": "AppGeneralConfigModel",
  "description": "App general configuration model",
  "type": "object",
  "properties": {
    "WhiteLabelId": {
      "format": "int32",
      "description": "White label ID",
      "type": "integer",
      "example": 500123
    },
    "DeepLinkUrlScheme": {
      "description": "Deep link URL scheme",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "SmsRestaurantName": {
      "description": "SMS restaurant 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"
    },
    "FallbackPhoneNumberPrefix": {
      "description": "Fallback phone number prefix",
      "type": "string",
      "example": "+353000000000"
    },
    "AutocompletePhoneNumberLength": {
      "format": "int32",
      "description": "Autocomplete phone number length",
      "type": "integer",
      "example": 3
    },
    "ContactFormType": {
      "description": "Contact form type\r\nNone = 0,\r\nEmail = 1,\r\nIntercom = 2,\r\nWebView = 3,\r\nFlipdishMessages = 4",
      "type": "string",
      "example": "string"
    },
    "PrivateSupportEmailAddress": {
      "description": "Private support email address",
      "type": "string",
      "example": "[email protected]"
    },
    "ContactPhoneNumber": {
      "description": "Contact phone number",
      "type": "string",
      "example": "+353000000000"
    },
    "DeliveryEnabled": {
      "description": "Delivery enabled",
      "type": "boolean",
      "example": true
    },
    "PickupEnabled": {
      "description": "Pickup enabled",
      "type": "boolean",
      "example": true
    },
    "DineInEnabled": {
      "description": "Dine in enabled",
      "type": "boolean",
      "example": true
    },
    "DisplayDeliveryRestaurantListScreen": {
      "description": "Display delivery restaurant list screen",
      "type": "boolean",
      "example": true
    },
    "DisplayPickupRestaurantListScreen": {
      "description": "Display pickup restaurant list screen",
      "type": "boolean",
      "example": true
    }
  }
}