Flipdish · Schema

UpdateGroup

Update Catalog Group

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name	Type	Description
Sku	string	Stock Keeping Unit (SKU)
Name	string	Group name
AutogenerateDisplayText	boolean	Autogenerate display text in ordering applications
ImageFileName	string	Image File Name
MinSelectCount	integer	Minimum number of items that the user has to select
MaxSelectCount	integer	Maximum number of items that the user has to select
Products	array	Collection of items associated with this group
Metafields	array	Collection of metafields

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/catalog-update-group-schema.json",
  "title": "UpdateGroup",
  "description": "Update Catalog Group",
  "type": "object",
  "properties": {
    "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",
      "nullable": true,
      "example": true
    },
    "ImageFileName": {
      "description": "Image File Name",
      "maxLength": 512,
      "minLength": 0,
      "type": "string",
      "example": "Example Name"
    },
    "MinSelectCount": {
      "format": "int32",
      "description": "Minimum number of items that the user has to select",
      "type": "integer",
      "nullable": true,
      "example": 3
    },
    "MaxSelectCount": {
      "format": "int32",
      "description": "Maximum number of items that the user has to select",
      "type": "integer",
      "nullable": true,
      "example": 3
    },
    "Products": {
      "description": "Collection of items associated with this group",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UpdateProductReference"
      },
      "example": []
    },
    "Metafields": {
      "description": "Collection of metafields",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Metafield"
      },
      "example": []
    }
  }
}