Materials are a shared entity. This page describes what Food & Beverage adds to them: three classifications for allergens, storage, and origin.
Classifications
| Classification | Code in classifications
|
Excel column | Example values |
|---|---|---|---|
| Allergen | allergen |
Allergen | milk, nuts, gluten |
| Storage | storage |
Storage | chilled, frozen, ambient |
| Origin | origin |
Origin | country of origin |
Each classification is optional. A material can have one value per classification.
Register the values first
Each value must be registered as a Type that applies to materials before a material uses it. For example:
{
"type": "Storage",
"appliesTo": ["material"],
"code": "CHILLED",
"name": "Chilled (0–4 °C)"
}
A value that is not registered is refused.
Classify a material
Send the values in the material's classifications object, keyed by the classification code:
{
"code": "MILK-RAW",
"name": "Raw milk",
"unit": "kg",
"group": "MG-DAIRY",
"lotTracked": true,
"classifications": {
"allergen": "MILK",
"storage": "CHILLED",
"origin": "AT"
}
}
In the Excel template, enter the value codes in the Allergen, Storage, and Origin columns of the Materials sheet.
Utilities
Water, electricity, steam, and other utilities are registered as materials with lotTracked set to false. Their use is recorded in consumption and planned use under the water and energy categories.
Pack format
Pack format is a classification of products, not of materials. It is set with the product's packFormat field.