Flipdish · Schema

AppConfigSalesChannel

App Config Sales Channel

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
EmailRequestMode string Display a popup to users requesting their email address
WebToAppRedirect string Sends users to their native apps or request them to install the pwa
AddressEntryType string Address entry type - TextEntryManualDisallowed is the only supported configuration
DisplayDeliveryRestaurantListScreen boolean Display Pickup Restaurant List Screen
View JSON Schema on GitHub

JSON Schema

apps-app-config-sales-channel-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-sales-channel-schema.json",
  "title": "AppConfigSalesChannel",
  "description": "App Config Sales Channel",
  "type": "object",
  "properties": {
    "EmailRequestMode": {
      "description": "Display a popup to users requesting their email address",
      "enum": [
        "DoNotRequest",
        "Request",
        "Require"
      ],
      "type": "string",
      "example": "DoNotRequest"
    },
    "WebToAppRedirect": {
      "description": "Sends users to their native apps or request them to install the pwa",
      "enum": [
        "NoRedirect",
        "RedirectOnce",
        "RedirectAlways",
        "SuggestPwa",
        "ForcePwa"
      ],
      "type": "string",
      "example": "NoRedirect"
    },
    "AddressEntryType": {
      "description": "Address entry type - TextEntryManualDisallowed is the only supported configuration",
      "enum": [
        "MapFirst",
        "TextEntryManualAllowed",
        "TextEntryManualDisallowed"
      ],
      "type": "string",
      "example": "MapFirst"
    },
    "DisplayDeliveryRestaurantListScreen": {
      "description": "Display Pickup Restaurant List Screen",
      "type": "boolean",
      "example": true
    }
  }
}