Flipdish · JSON Structure

Catalog Catalog Item Structure

CatalogItem

Type: object Properties: 11 Required: 4

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

CatalogItemId IsArchived Groups Metafields ItemType Sku Name Description Price ImageFileName Alcohol

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-catalog-item-structure.json",
  "name": "CatalogItem",
  "description": "CatalogItem",
  "type": "object",
  "properties": {
    "CatalogItemId": {
      "description": "Unique catalog Item id",
      "maxLength": 30,
      "minLength": 0,
      "type": "string",
      "example": "500123"
    },
    "IsArchived": {
      "description": "Returns true if the item is archived",
      "type": "boolean",
      "example": true
    },
    "Groups": {
      "description": "Collection of groups associated with this item",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CatalogGroupReference"
      },
      "example": []
    },
    "Metafields": {
      "description": "Collection of metafields",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Metafield"
      },
      "example": []
    },
    "ItemType": {
      "description": "Type of item (Product, Modifier, etc)",
      "enum": [
        "Product",
        "Modifier"
      ],
      "type": "string",
      "example": "Product"
    },
    "Sku": {
      "description": "Stock Keeping Unit (SKU)",
      "maxLength": 30,
      "minLength": 0,
      "type": "string",
      "example": "string"
    },
    "Name": {
      "description": "Item name",
      "maxLength": 300,
      "minLength": 0,
      "type": "string",
      "example": "Example Name"
    },
    "Description": {
      "description": "Item description",
      "maxLength": 3000,
      "minLength": 0,
      "type": "string",
      "example": "string"
    },
    "Price": {
      "description": "Item price",
      "minimum": 0,
      "type": "double",
      "example": 12.5
    },
    "ImageFileName": {
      "description": "Image File Name",
      "maxLength": 512,
      "minLength": 0,
      "type": "string",
      "example": "Example Name"
    },
    "Alcohol": {
      "description": "item contains alcohol",
      "type": "boolean",
      "example": true
    }
  },
  "required": [
    "ItemType",
    "Sku",
    "Name",
    "Price"
  ]
}