Flipdish · Schema

StoreGroupExtended

Store Group Extended

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name	Type	Description
TotalStores	integer	Total Amount of Stores
GroupedCoordinates	array	Grouped store coordinates
StoreHeaders	array	Store Headers associated with Store Group
StoreGroupId	integer	Unique Store Group Identifier
GeneralRating	number	Store Group rating
GeneralRatingCount	integer	Store Group rating count
DeliveryMenuMessage	string	Delivery menu message
PickupMenuMessage	string	Pickup menu message
BrandIds	array	List of brand ids (AppIds) that are associated with this store group
Name	string	Store Group Name
Currency	string	Currency used by the stores in this group

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/stores-store-group-extended-schema.json",
  "title": "StoreGroupExtended",
  "description": "Store Group Extended",
  "type": "object",
  "properties": {
    "TotalStores": {
      "format": "int32",
      "description": "Total Amount of Stores",
      "type": "integer",
      "example": 12.5
    },
    "GroupedCoordinates": {
      "description": "Grouped store coordinates",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GroupedCoordinates"
      },
      "example": []
    },
    "StoreHeaders": {
      "description": "Store Headers associated with Store Group",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StoreHeader"
      },
      "example": []
    },
    "StoreGroupId": {
      "format": "int32",
      "description": "Unique Store Group Identifier",
      "type": "integer",
      "example": 500123
    },
    "GeneralRating": {
      "format": "double",
      "description": "Store Group rating",
      "type": "number",
      "nullable": true,
      "example": 1.0
    },
    "GeneralRatingCount": {
      "format": "int32",
      "description": "Store Group rating count",
      "type": "integer",
      "example": 3
    },
    "DeliveryMenuMessage": {
      "description": "Delivery menu message",
      "type": "string",
      "example": "string"
    },
    "PickupMenuMessage": {
      "description": "Pickup menu message",
      "type": "string",
      "example": "string"
    },
    "BrandIds": {
      "description": "List of brand ids (AppIds) that are associated with this store group",
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "string"
      ]
    },
    "Name": {
      "description": "Store Group Name",
      "type": "string",
      "example": "Example Name"
    },
    "Currency": {
      "description": "Currency used by the stores in this group",
      "enum": [
        "EUR",
        "USD",
        "GBP",
        "CAD",
        "AUD",
        "DJF",
        "ZAR",
        "ETB",
        "AED",
        "BHD",
        "DZD",
        "EGP",
        "IQD",
        "JOD",
        "KWD",
        "LBP",
        "LYD",
        "MAD",
        "OMR",
        "QAR",
        "SAR",
        "SYP",
        "TND",
        "YER",
        "CLP",
        "INR",
        "AZN",
        "RUB",
        "BYN",
        "BGN",
        "NGN",
        "BDT",
        "CNY",
        "BAM",
        "CZK",
        "DKK",
        "CHF",
        "MVR",
        "BTN",
        "XCD",
        "BZD",
        "HKD",
        "IDR",
        "JMD",
        "MYR",
        "NZD",
        "PHP",
        "SGD",
        "TTD",
        "XDR",
        "ARS",
        "BOB",
        "COP",
        "CRC",
        "CUP",
        "DOP",
        "GTQ",
        "HNL",
        "MXN",
        "NIO",
        "PAB",
        "PEN",
        "PYG",
        "UYU",
        "VEF",
        "IRR",
        "XOF",
        "CDF",
        "XAF",
        "HTG",
        "ILS",
        "HRK",
        "HUF",
        "AMD",
        "ISK",
        "JPY",
        "GEL",
        "KZT",
        "KHR",
        "KRW",
        "KGS",
        "LAK",
        "MKD",
        "MNT",
        "BND",
        "MMK",
        "NOK",
        "NPR",
        "PKR",
        "PLN",
        "AFN",
        "BRL",
        "MDL",
        "RON",
        "RWF",
        "SEK",
        "LKR",
        "SOS",
        "ALL",
        "RSD",
        "KES",
        "TJS",
        "THB",
        "ERN",
        "TMT",
        "BWP",
        "TRY",
        "UAH",
        "UZS",
        "VND",
        "MOP",
        "TWD",
        "BMD"
      ],
      "type": "string",
      "example": "EUR"
    }
  }
}