Flipdish · JSON Structure

Apps App General Config Model Structure

App general configuration model

Type: object Properties: 15

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

WhiteLabelId DeepLinkUrlScheme SmsRestaurantName NexmoSupportSmsNumber TwilioSupportSmsNumber FallbackPhoneNumberPrefix AutocompletePhoneNumberLength ContactFormType PrivateSupportEmailAddress ContactPhoneNumber DeliveryEnabled PickupEnabled DineInEnabled DisplayDeliveryRestaurantListScreen DisplayPickupRestaurantListScreen

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-structure/apps-app-general-config-model-structure.json",
  "name": "AppGeneralConfigModel",
  "description": "App general configuration model",
  "type": "object",
  "properties": {
    "WhiteLabelId": {
      "description": "White label ID",
      "type": "int32",
      "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": {
      "description": "Autocomplete phone number length",
      "type": "int32",
      "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": "owner@example.com"
    },
    "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
    }
  }
}