the template contains the fields detailed in the following tables.
| field name | required | Maps to JE | Maps to TA | Maps to Skip | What it does | Validation Rules |
|---|---|---|---|---|---|---|
| category | Mandatory | Yes | Yes | Yes | The name of the category in which the item belongs. | String - Platform validation rules apply |
| name | Mandatory | Yes | Yes | Yes | The name of the item. | String - Platform validation rules apply |
| PLU | Mandatory | Yes | Yes | Yes | The plu identifier of the item which will be received in ordering payloads. | String - Platform validation rules apply |
| reference | Optional | Yes | a unique reference for the menu item, used when multiple menu items under the use the same menu use the same plu | |||
| price | Mandatory | Yes | Yes | Yes | The price of the item in minor denomination ie. cents, pennies, pence. | Must be a positive integer. |
| 3 EUR is 300 | ||||||
| 2.75 GBP is 275 | ||||||
| 75 cents is 75 | ||||||
| Description | Optional | Yes | Yes | Yes | The description of the product. | String - Platform validation rules apply |
| swap | Optional | No | No | Yes | selection presented to the customer that replaces the item in the https://connect-api.flyt.io/docs/orders#post-receive-order body. Used where there are multiple variations of an item with the same modifier groups. | |
| taxCategory | Optional | No | No | Yes | field used only by SkipTheDishes. | - |
| taxPercentage | Optional | No | Yes | Yes | The amount of tax in the price of the item. | Can contain a decimal point |
| unit_count | Optional | No | No | Yes | Denotes the number of individual units of the current item. For instance, for a box of donuts, this field should be 6 | Integer value |
| a_la_carte_price | Optional | Yes | Yes | Yes | Shows the stand-alone taxable price of the item, on which the tax should be calculated. | integer value, |
| isAlcoholic | Optional | No | No | Yes | Determines if the item is alcoholic or not. | Should be TRUE or FALSE |
| modifierIDs | Optional | Yes | Yes | Yes | Adds modifier groups to a product | String. |
| all modifier ids should be defined in the Modifier Register tab. | ||||||
| gallery | Optional | Yes | Yes | Yes | URL linking to an image of the item. | Should be a valid URL of the image. |
| Live | Mandatory | - | - | Determines whether this item should be included in the menu or not. | Should be TRUE or FALSE | |
| depositType | Optional | No | Yes | Yes | The type of deposit for the item | Should be NOT_SPECIFIED, SINGLE_USE or MULTIPLE_USE. |
For Deposits on Skip, please refer to our https://flytplatform.notion.site/07b9bed5f1234500b6a7d3c9a11243ee | | menuID | Mandatory | Yes | Yes | Yes | Slash (/) separated list of IDs that determine which menu these items will belong to, as defined in the 'Menu Availabilities" tab. | All menuIDs used in this field should also be defined in the Menu Availabilities tab. Any menuIDs defined in the Menu Availabilities tab and not used in the Item Registry tab would cause the menu to fail to be synced. Please remove any unused menuIDs from Menu Availabilities. | | depositAmount | Optional | No | Yes | Yes | Deposit amount in minor denomination (similar to price). | Must be a positive integer. 3 EUR is 300 2.75 GBP is 275 75 cents is 75
For Deposits on Skip, please refer to our https://flytplatform.notion.site/07b9bed5f1234500b6a7d3c9a11243ee | | kj | Optional | Yes | No | No | The kilocalories of the item. | Must be an integer, or a hyphen separated integer range e.g. 10-12 | | kcal | Optional | Yes | No | No | The kilojoules of the item. | Must be an integer, or a hyphen separated integer range e.g. 10-12 | | allergens | Optional | No | Yes | No | Item allergens. | Slash (/) separated to define a list | | additives | Optional | No | Yes | No | Item additives. | Slash (/) separated to define a list | | alcoholPercentage | Optional | No | Yes | No | The amount of alcohol percentage the item contains. | Can contain a decimal point | | caffeineMg | Optional | No | Yes | No | The amount of caffeine in milligrams the item contains. | Can contain a decimal point | | volumeUnitName | Optional | No | Yes | No | The unit name for volume | Should be VOL_MILLILITERS or VOL_LITERS | | volumeGrossValue | Optional | No | Yes | No | Value for gross volume of the item | Can contain a decimal point. Must be used with volumeUnitName. | | volumeNetValue | Optional | No | No | No | Value for net volume of item | Can contain a decimal point | | weightUnitName | Optional | No | Yes | No | The unit name for weight | Should be WEIGHT_GRAMS or WEIGHT_KILOGRAMS | | weightGrossValue | Optional | No | Yes | No | Value for gross weight of the item | Can contain a decimal point. Must be used with weightUnitName. | | weightNetValue | Optional | No | No | No | Value for net weight of item | Can contain a decimal point | | manufacturerName | Optional | No | Yes | No | The name of the manufacturer for the item. | String - Platform validation rules apply | | depositIncludedInTotalPrice | Optional | No | No | No | Determines if the deposit is included in the total price or not. | Should be TRUE or FALSE | | manufacturerBrand | Optional | No | No | No | The name of the brand for the item. | String - Platform validation rules apply | | manufacturerCountryOfOrigin | Optional | No | No | No | The name of the Country of Origin for the item. | String - Platform validation rules apply | | manufacturerAdditionalDetails | Optional | No | No | No | Free text section as a catch all for any missing manufacturer information. | String - Platform validation rules apply | | storageType | Optional | No | No | No | Defines the type of storage needed for the item | Should be FROZEN or COOL_DRY | | storageAdditionalDetails | Optional | No | Yes | No | Free text section as a catch all for any missing storage information. | String - Platform validation rules apply | | gtin | Optional | No | Yes | No | the GTIN of the item | String - Platform validation rules apply | | protein | Optional | Yes | No | No | The amount of protein in the item. | May contain decimal | | carbohydrates | Optional | Yes | No | No | The amount of carbohydrates in the item. | May contain decimal | | sugar | Optional | Yes | No | No | The amount of sugar in the item. | May contain decimal | | fat | Optional | Yes | No | No | The amount of fat in the item. | May contain decimal | | saturatedFat | Optional | Yes | No | No | The amount of saturated fat in the item. | May contain decimal | | salt | Optional | Yes | No | No | The amount of salt in the item. | May contain decimal | | nutritionalInfoAdditionalDetails | Optional | No | Yes | No | Free text section as a catch all for any missing nutritional information. | String - Platform validation rules apply |