Flipdish · Schema

CreateAppStoreApp

CreateAppStoreApp schema from Flipdish API - Apps.

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
Details string
ConfigurationType string
StoreSelectorType string
FieldGroups array
SetupInstructions string
ExternalSetupLink string
TeammateAppAccessLevel string
PermissionsType string
Support object
ExternalFunctionActionUrl string
ExternalFunctionSignatureKey string
IsPaid boolean
Name string
Description string
IsEnabled boolean
Categories array
Countries array
DeveloperName string
View JSON Schema on GitHub

JSON Schema

apps-create-app-store-app-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-create-app-store-app-schema.json",
  "title": "CreateAppStoreApp",
  "description": "CreateAppStoreApp schema from Flipdish API - Apps.",
  "type": "object",
  "properties": {
    "Details": {
      "type": "string",
      "example": "string"
    },
    "ConfigurationType": {
      "enum": [
        "ExternalLink",
        "FlipdishHosted"
      ],
      "type": "string",
      "example": "ExternalLink"
    },
    "StoreSelectorType": {
      "enum": [
        "None",
        "Single",
        "Multiple"
      ],
      "type": "string",
      "example": "None"
    },
    "FieldGroups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FieldGroup"
      },
      "example": []
    },
    "SetupInstructions": {
      "type": "string",
      "example": "string"
    },
    "ExternalSetupLink": {
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "TeammateAppAccessLevel": {
      "enum": [
        "Owner",
        "StoreOwner",
        "PropertyOwner",
        "ManagedOwner",
        "Integrator",
        "PropertyManager",
        "StoreManager",
        "StoreStaff",
        "StoreReadOnlyAccess",
        "FinanceManger"
      ],
      "type": "string",
      "example": "Owner"
    },
    "PermissionsType": {
      "enum": [
        "Teammate"
      ],
      "type": "string",
      "example": "Teammate"
    },
    "Support": {
      "$ref": "#/components/schemas/AppStoreAppSupportInfo"
    },
    "ExternalFunctionActionUrl": {
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "ExternalFunctionSignatureKey": {
      "type": "string",
      "example": "string"
    },
    "IsPaid": {
      "type": "boolean",
      "example": true
    },
    "Name": {
      "type": "string",
      "example": "Example Name"
    },
    "Description": {
      "type": "string",
      "example": "string"
    },
    "IsEnabled": {
      "type": "boolean",
      "example": true
    },
    "Categories": {
      "type": "array",
      "items": {
        "enum": [
          "PointOfSale",
          "DeliveryAndLogistics",
          "CRM",
          "GiftCard",
          "Accounting",
          "LoyaltyAndMarketing",
          "Other"
        ],
        "type": "string"
      },
      "example": [
        "PointOfSale"
      ]
    },
    "Countries": {
      "type": "array",
      "items": {
        "enum": [
          "GB",
          "IE",
          "FR",
          "ES",
          "PT",
          "IT",
          "DE",
          "PL",
          "BE",
          "LU",
          "NL",
          "US",
          "CA",
          "BG",
          "MX",
          "AU",
          "NZ"
        ],
        "type": "string"
      },
      "example": [
        "GB"
      ]
    },
    "DeveloperName": {
      "type": "string",
      "example": "Example Name"
    }
  },
  "required": [
    "Details",
    "ConfigurationType",
    "StoreSelectorType",
    "PermissionsType",
    "Name",
    "Description",
    "Categories",
    "Countries"
  ]
}