Flipdish · Schema

CatalogGroupReference

Reference to an existing {Flipdish.Menus.PublicModels.V1.Catalog.Groups.Group}

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
Group object
CatalogGroupId string Identifier of the ProductId to use as SubProduct
CatalogItemId string Identifier of the ProductId to use as SubProduct
GroupType string Type of the SupProduct
View JSON Schema on GitHub

JSON Schema

catalog-catalog-group-reference-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/catalog-catalog-group-reference-schema.json",
  "title": "CatalogGroupReference",
  "description": "Reference to an existing {Flipdish.Menus.PublicModels.V1.Catalog.Groups.Group}",
  "type": "object",
  "properties": {
    "Group": {
      "$ref": "#/components/schemas/Group"
    },
    "CatalogGroupId": {
      "description": "Identifier of the ProductId to use as SubProduct",
      "maxLength": 30,
      "minLength": 0,
      "type": "string",
      "example": "500123"
    },
    "CatalogItemId": {
      "description": "Identifier of the ProductId to use as SubProduct",
      "maxLength": 30,
      "minLength": 0,
      "type": "string",
      "example": "500123"
    },
    "GroupType": {
      "description": "Type of the SupProduct",
      "enum": [
        "ModifierGroup"
      ],
      "type": "string",
      "example": "ModifierGroup"
    }
  },
  "required": [
    "CatalogGroupId",
    "GroupType"
  ]
}