Guides

Nutritional & Supplemental Info

There is an extensive amount of additional info which can be associated with a product to enhance the details shown online or comply with legislation

Suggest Edits

Introduction

Local legislation may require that you pass nutritional information, additives, ingredients and other supplemental information as part of the product data.

🚧

Prepackaged only

Legislation may state that sending nutritional information is only required when items are prepackaged. Channels may not display this info when "prepackaged" is not true.

Product Model

Below is a snippet of a single product with all additional info which can be set, including nutritional information and other supplemental info. For a reference to the full product model, see the link below;

▶ See Product Model

Example

{
    "productType": 1,
    "plu": "ff***-****-****-**0f5",
    "posProductId": "",
    "posCategoryIds": [
        "BRGR"
    ],
    "imageUrl": "",
    "price": 100,
    "name": "Product",
    "description": "",
    "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,
    "subProducts": [],
    "deliveryTax": 0,
    "takeawayTax": 0,
    "productTags": [],
    "isVariant": false
}

Updated 5 months ago