How to configure product metadata

Introduction

A product can be set with additional metadata including; allergens/tags, calories, nutritional and supplemental information. This can be for general customer reference, but certain regional legislation may require this information to be included as part of the product data displayed on digital ordering platforms.

Product tags

A product can have one or more product tags, these cover allergens but also consumable types and other product labels. These are are contained inside a productTags array.

In below example snippet, 104 and 109 are values representing 'eggs' and 'peanuts'

{
  "productType": 1,
  "plu": "P-SATE",
  "price": 450,
  "name": "Chicken Sate",
...
  "productTags": [
    104,
    110
  ]
},

See link below for a complete list of tags available;

▶ Product Tags

Calories

Each item can be set with calories and optionally a caloriesRangeHigh to indicate a range;

Parameter	Meaning
`calories`	This is the base calorie amount, where `caloriesRangeHigh` is set, this should be interpreted as the minimum calorie amount
`caloriesRangeHigh`	The maximum calorie amount of an item

"products": [
  {
    "productType": 1,
    "plu": "PR03",
    "price": 900,
    "name": "Cheese Lovers Pizza",
    "calories": 500,
    "caloriesRangeHigh": 750
  }
]
},

Nutritional Information and Supplemental Info

The full range of product attributes and their meaning can be found in the full product model, see the link below;

▶ Product Model

Example

Below is a snippet of a single product with all additional info, which can be set, including tags, calories, nutritional and and other supplemental information

{
  "productType": 1,
  "plu": "ff***-****-****-**0f5",
  "price": 100,
  "name": "Product Example",
  "description": "Item with various additional attributes",
  "productTags": [
    104,
    110
  ],
  "packaging": {
    "count": 1,
    "reusable": true,
    "storageInstructions": ""
  },
  "supplementalInfo": {
    "prepackaged": true,
    "additives": [
      "COLORANT_UNSPECIFIED",
      "COLORANT_ADVERSE_EFFECT",
      "UNSPECIFIED",
      "PRESERVATIVES_UNSPECIFIED",
      "PRESERVATIVES_NITRITE_CURING_SALT",
      "PRESERVATIVES_NITRATE",
      "PRESERVATIVES_NITRATE_CURING_SALT_AND_NITRATE",
      "ANTIOXIDANT",
      "FLAVOURE_ENHANCER",
      "SULFITES",
      "BLACKENED",
      "WAXED",
      "PHOSPHATE",
      "SWEETENER_UNSPECIFIED",
      "SWEETENER_PHENYLALANINE",
      "SWEETENER_LAXATIVE",
      "CAFFEINE_UNSPECIFIED",
      "CAFFEINE_HIGH_CAFFEINE",
      "CAFFEINE_CAFFEINE",
      "QUININE",
      "GENETICALLY_MODIFIED",
      "ACIDIFIERS",
      "STABILISERS",
      "PROTEIN_UNSPECIFIED",
      "PROTEIN_MILK_PROTEIN",
      "PROTEIN_STARCH",
      "PROTEIN_EGG_WHITE"
    ],
    "deposit": 1,
    "ingredients": [
      "Water",
      "Sugar"
    ],
    "instructionsForUse": "",
    "legalName": "",
    "fbo": {
      "name": "",
      "address": "",
      "brand": "",
      "countryOfOrigin": ""
    }
  },
  "nutritionalInfo": {
    "netQuantity": {
      "amount": 2,
      "countUnitDescription": "gram",
      "unitType": 1
    },
    "servingSize": {
      "amount": 2,
      "countUnitDescription": "gram",
      "unitType": 1
    },
    "fat": 4,
    "saturatedFat": 1,
    "monoUnsaturatedFat": 1,
    "polyUnsaturatedFat": 1,
    "transFat": 1,
    "carbohydrates": 1,
    "sugar": 1,
    "addedSugar": 1,
    "fiber": 1,
    "starch": 1,
    "polyols": 1,
    "protein": 1,
    "cholesterol": 1,
    "sodium": 1,
    "salt": 1,
    "calcium": 1,
    "chloride": 1,
    "fluoride": 1,
    "magnesium": 1,
    "potassium": 1,
    "vitaminC": 1
  },
  "beverageInfo": {
    "caffeine": 1,
    "alcohol": 1
  },
  "calories": 200,
  "caloriesRangeHigh": 300
}