Flipdish · JSON Structure

Catalog Group Structure

CatalogGroup

Type: object Properties: 12 Required: 3

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Group is a JSON Structure definition published by Flipdish, describing 12 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

CatalogGroupId CatalogItemId IsArchived MinSelectCount MaxSelectCount Products Metafields GroupType Sku Name AutogenerateDisplayText ImageFileName

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-structure/catalog-group-structure.json",
  "name": "Group",
  "description": "CatalogGroup",
  "type": "object",
  "properties": {
    "CatalogGroupId": {
      "description": "Unique catalog group id",
      "maxLength": 30,
      "minLength": 0,
      "type": "string",
      "example": "500123"
    },
    "CatalogItemId": {
      "description": "Unique catalog item id",
      "maxLength": 30,
      "minLength": 0,
      "type": "string",
      "example": "500123"
    },
    "IsArchived": {
      "description": "Returns true if the group is archived",
      "type": "boolean",
      "example": true
    },
    "MinSelectCount": {
      "description": "Minimum number of items that the user has to select",
      "type": "int32",
      "example": 3
    },
    "MaxSelectCount": {
      "description": "Maximum number of items that the user has to select",
      "type": "int32",
      "nullable": true,
      "example": 3
    },
    "Products": {
      "description": "Collection of items associated with this product",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProductReference"
      },
      "example": []
    },
    "Metafields": {
      "description": "Collection of metafields",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Metafield"
      },
      "example": []
    },
    "GroupType": {
      "description": "Type of group (ModifierGroup, etc)",
      "enum": [
        "ModifierGroup"
      ],
      "type": "string",
      "example": "ModifierGroup"
    },
    "Sku": {
      "description": "Stock Keeping Unit (SKU)",
      "maxLength": 30,
      "minLength": 0,
      "type": "string",
      "example": "string"
    },
    "Name": {
      "description": "Group name",
      "maxLength": 300,
      "minLength": 0,
      "type": "string",
      "example": "Example Name"
    },
    "AutogenerateDisplayText": {
      "description": "Autogenerate display text in ordering applications",
      "type": "boolean",
      "example": true
    },
    "ImageFileName": {
      "description": "Image File Name",
      "maxLength": 512,
      "minLength": 0,
      "type": "string",
      "example": "Example Name"
    }
  },
  "required": [
    "GroupType",
    "Sku",
    "Name"
  ]
}