Flipdish · Schema

SupportedCountry

Describes a supported country

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name	Type	Description
CountryCode	string	Country code
Name	string	Nice display name for a country
PhoneCode	integer	Country internatinoal phone code prefix
LanguageCode	string	Language code
LanguageName	string	Language name
OtpNumber	string	The phone number provided to Store staff which, in conjunction with a one-time-code, will connect them to the customer.
SupportNumber	string	The store's support phone number, displayed to customers.
AddressLayout	string	Address layout format. This changes the layout of address entry forms on the web app, iOS and Android app and should be set based on local custom.
PostCodeType	string	Post code type
SupportRegion	string	Supported region. This is not used.

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-supported-country-schema.json",
  "title": "SupportedCountry",
  "description": "Describes a supported country",
  "type": "object",
  "properties": {
    "CountryCode": {
      "description": "Country code",
      "type": "string",
      "example": "IE"
    },
    "Name": {
      "description": "Nice display name for a country",
      "type": "string",
      "example": "Example Name"
    },
    "PhoneCode": {
      "format": "int32",
      "description": "Country internatinoal phone code prefix",
      "type": "integer",
      "example": 1
    },
    "LanguageCode": {
      "description": "Language code",
      "type": "string",
      "example": "string"
    },
    "LanguageName": {
      "description": "Language name",
      "type": "string",
      "example": "Example Name"
    },
    "OtpNumber": {
      "description": "The phone number provided to Store staff which, in conjunction with a one-time-code, will connect them to the customer.",
      "type": "string",
      "example": "string"
    },
    "SupportNumber": {
      "description": "The store's support phone number, displayed to customers.",
      "type": "string",
      "example": "string"
    },
    "AddressLayout": {
      "description": "Address layout format. This changes the layout of address entry forms on the web app, iOS and Android app and should be set based on local custom.",
      "enum": [
        "BuildingFirst",
        "AddressFirst",
        "FullStreetAddressFirst"
      ],
      "type": "string",
      "example": "BuildingFirst"
    },
    "PostCodeType": {
      "description": "Post code type",
      "enum": [
        "None",
        "PostCode",
        "Zip"
      ],
      "type": "string",
      "example": "None"
    },
    "SupportRegion": {
      "description": "Supported region. This is not used.",
      "enum": [
        "Default",
        "Spain",
        "Benelux"
      ],
      "type": "string",
      "example": "Default"
    }
  }
}