Flipdish · Schema

Channel

Channel.

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
ChannelId integer Channel Id
TranslationKey string Channel TranslationKey
Source string Channel Source
LogoUri string Channel Logo URl
Available boolean Channel is Available or not
MaintainedExternally boolean Channel is Maintained Externally or not
View JSON Schema on GitHub

JSON Schema

orders-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/orders-channel-schema.json",
  "title": "Channel",
  "description": "Channel.",
  "type": "object",
  "properties": {
    "ChannelId": {
      "format": "int32",
      "description": "Channel Id",
      "type": "integer",
      "example": 500123
    },
    "TranslationKey": {
      "description": "Channel TranslationKey",
      "type": "string",
      "example": "string"
    },
    "Source": {
      "description": "Channel Source",
      "enum": [
        "Internal",
        "External"
      ],
      "type": "string",
      "example": "Internal"
    },
    "LogoUri": {
      "description": "Channel Logo URl",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "Available": {
      "description": "Channel is Available or not",
      "type": "boolean",
      "example": true
    },
    "MaintainedExternally": {
      "description": "Channel is Maintained Externally or not",
      "type": "boolean",
      "example": true
    }
  }
}