Flipdish · JSON Structure

Catalog Product Reference Structure

Catalog Item associated

Type: object Properties: 5 Required: 2
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

Item Product CatalogItemId ProductType PreselectedQuantity

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-product-reference-structure.json",
  "name": "ProductReference",
  "description": "Catalog Item associated",
  "type": "object",
  "properties": {
    "Item": {
      "$ref": "#/components/schemas/Product"
    },
    "Product": {
      "$ref": "#/components/schemas/Product"
    },
    "CatalogItemId": {
      "description": "Identifier of the CatalogItemId to use as SubProduct",
      "maxLength": 30,
      "minLength": 0,
      "type": "string",
      "example": "500123"
    },
    "ProductType": {
      "description": "Type of the SupProduct",
      "enum": [
        "Product",
        "Modifier"
      ],
      "type": "string",
      "example": "Product"
    },
    "PreselectedQuantity": {
      "description": "Quantity of the modifier that will be set when the parent product is placed in the basket",
      "type": "int32",
      "example": 3
    }
  },
  "required": [
    "CatalogItemId",
    "ProductType"
  ]
}