Flipdish · Schema

CreateProductReference

Information to create a reference to a {Flipdish.Menus.PublicModels.V1.Catalog.Product}

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name	Type	Description
CatalogItemId	string	Identifier of the CatalogItemId to use as SubProduct
ProductType	string	Type of the SupProduct
PreselectedQuantity	integer	Quantity of the modifier that will be set when the parent product is placed in the basket

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-create-product-reference-schema.json",
  "title": "CreateProductReference",
  "description": "Information to create a reference to a {Flipdish.Menus.PublicModels.V1.Catalog.Product}",
  "type": "object",
  "properties": {
    "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": {
      "format": "int32",
      "description": "Quantity of the modifier that will be set when the parent product is placed in the basket",
      "type": "integer",
      "example": 3
    }
  },
  "required": [
    "CatalogItemId",
    "ProductType"
  ]
}