Flipdish · JSON Structure

Catalog Update Group Structure

Update Catalog Group

Type: object Properties: 8
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

UpdateGroup is a JSON Structure definition published by Flipdish, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Sku Name AutogenerateDisplayText ImageFileName MinSelectCount MaxSelectCount Products Metafields

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-structure/catalog-update-group-structure.json",
  "name": "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": {
      "description": "Minimum number of items that the user has to select",
      "type": "int32",
      "nullable": true,
      "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 group",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UpdateProductReference"
      },
      "example": []
    },
    "Metafields": {
      "description": "Collection of metafields",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Metafield"
      },
      "example": []
    }
  }
}