Menu Import API

API-ReferenzMenu Import API

API-REFERENZ

Menu Import API

Speisepläne, Artikel und Menüdaten für die digitale Auslobung importieren.

Referenz5 Endpunkte

Blueprint

Blueprint-Backup. Produktiver Versionsstatus noch zu bestätigen.

BASE URLhttps://menufactory-live-eu.qnips.com

Menu import

GETGET: Brands/dbapi/menuimport/brandsGETGET: BrandInfo/dbapi/menuimport/brandinfo{?id}POSTPOST: MenuCards/dbapi/menuimport/menucards{?brandId,sortId,cardId}POSTPOST: Week/api/v1/partners/{partnerId}/menucards/{cardId}/weeks/{mondayDate}{?sortId}

Item import | Coming soon

PATCHPATCH: Items/dbapi/SortimentImport/SortimentItems{?brandId,sortId}

Grundlagen & vollständige Einführung

This document describes the menio MenuImport API and essential resources provided by qnips. The API provides programmatic access to read and write all necessary menio menu card data. The API allows you to automize the process of creating and/or updating the menio menu card week objects and all other relavant data.

Glossary

A brief list of terms used in the menio MenuImport API context.

• API: An http Application Programming Interface.

• JSON: JavaScript Object Notation is a data format commonly used for API requests in parameters and response bodies.

• XML: Extensible Markup Language.

Menu Import

About

menio Menu Import allows you to automize the process of creating and/or updating the menio menu card week objects and all other relavant data. Only a few steps are required to successfully sync your menu data with the menio menu data.

This can be achieved by sending certain API requests to the menio MenuImport API.

Summarized

What happens when I start a menu import?

• menio will try to create or update week objects of an existing menio menu card.

• menio will try to create or update menu categories of an existing menio menu card.

• menio will try to create or update sortiment items of an existing menio sortiment.

• menio will try to create or update price tags of an existing menio brand.

• menio will try to create or update additives of an existing menio brand.

• menio will try to create or update custom tags of an existing menio brand.

Terms like "catgories", "price tags" and "custom tags" will be explained later on in this document.

Import Process

Step 1. Retrieving brands

Brand: A company or organisation registered with qnips.

Preconditions:

• You need valid login credentials of a menio Dashboard user. From now on, this user will be referred as menio user.

menio user: A registered menio Dashboard user. The user's menio Dashboard login credentials will be used for authentication of the API requests.

All registered menio users are authorized to retrieve their related brands. A menio user can be related to 0, 1 or multiple brands. This depends on the access rights settings in the menio Dashboard.

A list of Brands can be retrieved by the menio MenuImport API. This list contains 0, 1 or multiple brand objects. A brand object contains the following properties:

Name	Type	Description
Id	Long	Reference Id of the brand, defined by menio
Name	String	The name of the brand

Step 2. Retrieving more detailed information of a specific brand

After retrieving a list of brand objects in Step 1, you can use one of the brand Ids to retrieve more detailed information about a specific brand. This information is essential in order to start the actual menu import.

Preconditions:

1. You need valid login credentials as a menio user.

2. The brand Id should be valid and available in the response of Step 1.

3. The menio user in question needs access rights to the brand with the specified Id.

The BrandInfo response object contains the following properties:

Name	Type	Description
MenuCards	Array	Array of MenuCard objects (metadata)
Sortiments	Array	Array of Sortiment objects (metadata)

MenuCard (object)

Name	Type	Description
Id	Long	Reference Id of the menu card, defined by menio
Name	String	The Name of the menu card

Sortiment (object)

Name	Type	Description
Id	Long	Reference Id of the sortiment, defined by menio
Name	String	The Name of the sortiment
StoreThirdPartyId	String, optional	Unique identifier specified in the menio Dashboard by the external party.
ThirdPartyId	String, optional	Unique identifier specified in the menio Dashboard by the external party.

Step 3. Sync your Menu Data with menio

The third and last step will be the actual menu import. This menu import will sync your menu data with the menu data of qnips.

Preconditions:

1. You need valid login credentials of a menio User.

2. The menio User in question needs access rights to the brand with the specified Id.

3. The menio User in question needs edit rights ("Speiseplan bearbeiten") for the menu in the menio Dashboard.

4. The brand Id should be valid and available in the response of Step 1.

5. The sortiment Id should be valid and available in the response of Step 2.

6. The menu card Id should be valid and available in the response of Step 2.

Note: Sortiments, menu cards and menio users are managed in the menio Dashboard.

You have the option to sync your menu data with menio by either sending your data in a JSON or XML format to the menio MenuImport API. The structure of the JSON or XML data is predefined by qnips. This structure might change in the future. We will do our best to not affect the existing data structure when changes are made.

Note:

• Data needs to be UTF-8 encoded.
• Property names are case-sensitive.
• All properties are required, unless stated otherwise.
• The dashboard settings determine which data is to be overwritten .

Menu import data structure

Name	Type	Description
MenuImportData	Object	The root element.

MenuImportData (object)

Name	Type	Description
SortimentGroups	Array	Array of SortimentGroup objects
PriceTags	Array, optional	Array of PriceTag objects
Additives	Array, optional	Array of Additive objects
CustomTags	Array, optional	Array of CustomTag objects
Vats	Array, optional	Array of Vat objects
RevenueAccounts	Array, optional	Array of RevenueAccount objects
LabelGroups	Array, optional	Array of LabelGroup objects
Labels	Array, optional	Array of Label objects
RatingLabels	Array, optional	Array of RatingLabel objects
ComponentGroups	Array, optional	Array of ComponentGroup objects
Items	Array, optional	Array of Item objects
Weeks	Array	Array of Week objects. One or more weeks can be imported at the same time for the same menu card

SortimentGroup (object)

Name	Type	Description
PLU	String, max length 50	Unique identifier of the sortiment group specified by external party. An Item will use this PLU as its SortimentGroupPLU property
Name	String	Name of the sortiment group
RevenueAccountId	String, optional	Unique identifier of the RevenueAccount. You have to make sure that a RevenueAccount with the Id exists in the RevenueAccounts array
VatIds	Array, optional	Array of Strings with unique identifiers of the Vat. You have to make sure that a Vat with the Id exists in the Vats array In the XML format this array contains Id-child-elements.

PriceTag (object)

Name	Type	Description
Id	String	Unique identifier specified by the external party. menio will use this Id to map price tags with Item.Prices.PriceTagId. This Id will also be used for future updates of an existing price tag
CurrencyIso	String	e.g. "EUR" for Euro, "USD" for United States dollar or "GBP" for Pound sterling
InternalName	String	The name of the item in the main language. This name is not visible to the outside world
PublicName	Array	Array of Translatable objects. The name of the price tag that will be displayed in menu cards. This name can be created in multiple languages
PublicLabel	Array, optional	Array of Translatable objects. This name can be created in multiple languages. If a PublicLabel is specified, this price tag label will be displayed in the menu card instead of the PublicName

Additive (object)

Name	Type	Description
Id	String	Unique identifier specified by the external party. menio will use this Id to map additives with Item AdditiveIds. This Id will also be used for future updates of an existing additive
PublicName	Array	Array of Translatable objects. The name of the additive that will be displayed in the menu card. This name can be created in multiple languages
PublicLabel	Array, optional	Array of Translatable objects. This name can be created in multiple languages. If a PublicLabel is specified, this additive label will be displayed in the menu card instead of the PublicName
IconUrl	String, optional	URL of an image (online only). Local paths are not supported. An empty string ("") will be ignored and not update previous value.

CustomTag (object)

Name	Type	Description
Id	String	Unique identifier specified by the external party. menio will use this Id to map custom tags with Item CustomTagIds. This Id will also be used for future updates of an existing custom tag
PublicName	Array	Array of Translatable objects. The name of the custom tag that will be displayed in the menu card. This name can be created in multiple languages
PublicLabel	Array, optional	Array of Translatable objects. This name can be created in multiple languages. If a PublicLabel is specified, this custom tag label will be displayed in the menu card instead of the PublicName
IconUrl	String, optional	URL of an image (online only). Local paths are not supported. An empty string ("") will be ignored and not update previous value.

RevenueAccount (object)

Name	Type	Description
Id	String	Unique identifier specified by the external party. menio will use this Id to map a revenue account with Item.RevenueAccountId. This Id will also be used for future updates of an existing revenue account
PublicName	Array	Array of Translatable objects. The name of the revenue account that will be displayed in a report. This name can be created in multiple languages

Vat (object)

Vat is an object for specifying an applicable VAT-Rate to a product. Each product can reference multiple such Vats as they might apply in different contexts, i.e. In-House Meal, Take-Away-Order or even some proprietary VAT Application like for Students

Name	Type	Description
Id	String	Unique identifier specified by the external party. menio will use this Id to map vats with Item.VatIds. This Id will also be used for future updates of an existing vats
PublicName	Array	Array of Translatable objects. The name of the vat that will be displayed in a report. This name can be created in multiple languages
Rate	Decimal	Rate of current vat in percents as decimal value
VatType	Enum	Enum value of VatType

VatType (Enum)

Id	Name	Description
0	EatIn	-
1	TakeAway	-
2	Custom	Generic type for e.g. Student, Senior, etc.

LabelGroup (object)

Name	Type	Description
Id	String	Unique identifier specified by the external party. menio will use this Id to map label groups with Item.LabelGroups. This Id will also be used for future updates of an existing label group
InternalName	String	The name of the label group in the main language. This name is not visible to the outside world
PublicName	Array	Array of Translatable objects. The text of the label group that will be displayed on the product. This name can be created in multiple languages

Label (object)

Name	Type	Description
Id	String	Unique identifier specified by the external party. menio will use this Id to map labels with LabelGroups.LabelIds. This Id will also be used for future updates of an existing label
InternalName	String	The name of the label in the main language. This name is not visible to the outside world
PublicName	Array	Array of Translatable objects. The text of the label that will be displayed on the product. This text can be created in multiple languages

RatingLabel (object)

Name	Type	Description
Id	String	Unique identifier specified by the external party. menio will use this Id to map ratingLabels with Ratings.RatingLabelId. This Id will also be used for future updates of an existing label
InternalName	String	The name of the ratingLabel in the main language. This name is not visible to the outside world
PublicName	Array	Array of Translatable objects. The text of the ratingLabel that will be displayed on the product. This text can be created in multiple languages
Description	Array	Array of Translatable objects. The description of the ratingLabel that can be displayed in the frontends. This description can be created in multiple languages
Type	Enum	Enum value of RatingLabelType
IconUrl	String, optional	URL of an image (online only). Local paths are not supported. An empty string ("") will be ignored and not update previous value.

RatingLabelType (Enum)

Id	Name	Description
0	Nutrition	Used for nutrition labeling (Nutri-Score)
1	CO2	Used for carbon emission labeling
2	WaterFootprint	Used for water foootprint labeling
3	HealthScore	Used for health score labeling
4	AnimalTreatment	Used for animal welfare labeling
5	Rainforest	Used for rain forest labeling

ComponentGroup (object)

Name	Type	Description
Id	String	Unique identifier specified by the external party. menio will use this Id to map component group with Item.ComponentGroups. This Id will also be used for future updates of an existing component group
InternalName	String	The name of the component group in the main language. This name is not visible to the outside world
PublicName	Array	Array of Translatable objects. The name of the ComponentGroup that will be displayed in our apps. This name can be created in multiple languages
HasFixedComponents	Boolean	Determines whether this group has always the same Component(s) across all products
IsOptional	Boolean	Determines whether this group is mandatory in a preorder Component(s)
IsHidden	Boolean	Determines whether this group is visible in the apps
MinGroupQuantity	Integer	The minimum quantity of Component(s) that have to be ordered in this group. Used in preorder and only if IsOptional is true
MaxGroupQuantity	Integer	The maximum quantity of Component(s) that have to be ordered in this group. Used in preorder and only if IsOptional is true
MaxComponentQuantity	Integer	The maximum quantity of the same Component that can be ordered in this group. Used in preorder and only if IsOptional is true

Week (object)

Name	Type	Description
Name	String, optional	Name of the week. When no name is specified, menio will create a default name with the following structure: "KW {CalenderWeek} ( {MondayDate})". Example: "KW 1 (01.01.2020)"
MondayDate	String	Unique monday date of the week. DateTime object formatted in "yyyy-MM-dd"
HeaderHtml	String, optional	HTML to be displayed above the week in menu card templates
FooterHtml	String, optional	HTML to be displayed below the week in menu card templates
ActiveDays	Array, optional	Array of Integers. In the XML format this array contains DayNumber-child-elements. The definition of the Integer values can be found below
Categories	Array	Array of Category objects

ActiveDays / DayNumbers

Id	Day of Week
0	Monday
1	Tuesday
2	Wednesday
3	Thursday
4	Friday
5	Saturday
6	Sunday

Category (object)

Name	Type	Description
InternalName	String	Name of the menu category in the main language. When a PublicName and AppName are defined, this name will not be visible to the outside world. The menu importer identifies existing categories by this name
PublicName	Array, optional	Array of Translatable objects. The name of the menu category that will be displayed in the menu card. This name can be created in multiple languages. When no PublicName is specified, the InternalName will be used instead
AppName	Array, optional	Array of Translatable objects. The name of the menu category that will be displayed in the mobile menio app menu cards. This name can be created in multiple languages. When no AppName is specified, the InternalName will be used instead
VisibleInApp	Boolean, optional	Default value is true. If false, the menu category will not be delivered to any menio app
PictureUrl	String, optional	URL of an image (online only). Local paths are not supported
OrderIndex	Integer, optional	OrderIndex of the category
Days	Array	Array of Day objects
ThirdPartyId	String	Unique identifier specified by the external party

Translatable (object)

Name	Type	Description
lang	String	Language Culture Name, e.g. "de-DE", "en-US", "nl-NL" etc
val	String	Text of the object in the specified language. Newlines are not allowed

Day (object)

Name	Type	Description
Date	String	DateTime object formatted in "yyyy-MM-dd"
Items	Array	Array of Item objects

Item (object)

Name	Type	Description
PLU	String, max length 50	Unique identifier specified by external party. The item will not be imported if the PLU is empty or missing. This Id will also be used for future updates of an existing item
SortimentGroupPLU	String	Unique identifier of the sortiment group the item belongs to. The item will not be imported if the SortimentGroupPLU is empty or missing. You have to make sure that a SortimentGroup with SortimentGroupPLU exists in the SortimentGroups array
InternalName	String	The name of the item in the main language. This name is not visible to the outside world
PublicName	Array	Array of Translatable objects. The name of the item that will be displayed in the menu card. This name can be created in multiple languages
AppName	Array, optional	Array of Translatable objects. The name of the item that will be displayed in menio apps. This name can be created in multiple languages
Teaser	Array, optional	Array of Translatable objects. The teaser of the item that will be displayed in the menu card. This teaser can be created in multiple languages
Description	Array, optional	Array of Translatable objects. The description of the item that will be displayed in the menu card. This description can be created in multiple languages
PictureUrl	String, optional	URL of an image (online only). Local paths are not supported
CoverUrls	Array, optional	Array of strings, indicating the URL of an image (online only). Local paths are not supported. In the XML format this array contains Url-child-elements for each URL.
AllergenIds	Array, optional	Array of Integers, indicating which allergens the item contains. In the XML format this array contains Id-child-elements for each Integer. The definition of the Integer values can be found here
AllergenTracesIds	Array, optional	Array of Integers, indicating which traces of allergens the item contains. When the Id is already listed in AllergenIds, the AllergenTracesId will be ignored. In the XML format this array contains Id-child-elements for each Integer. The definition of the Integer values can be found here
AdditiveIds	Array, optional	Array of Strings, indicating which additives the item contains. In the XML format this array contains Id-child-elements for each String. The definition of the String values can be found here. You have to make sure that an Additive with the Id exists in the Additives array
CustomTagIds	Array, optional	Array of Strings, indicating which custom tags the item contains. In the XML format this array contains Id-child-elements for each String. The definition of the String values can be found here. You have to make sure that a CustomTag with the Id exists in the CustomTags array
NutritionFacts	Object, optional	Nutritional information of the item. See: NutritionFacts
ServingSize	Integer, optional	The serving/portion size of the item in grams or milliliter. Without decimals
ServingSizeUnit	String, optional	The unit of the ServingSize. Use "g" for grams or "ml" for milliliter
Prices	Array, optional	Array of Price objects. The prices can (but don't have to) be displayed in the menu card
RevenueAccountId	String, optional	Unique identifier of the RevenueAccount. You have to make sure that a RevenueAccount with the Id exists in the RevenueAccounts array
VatIds	Array, optional	Array of Strings with unique identifier of the Vat. You have to make sure that a Vat with the Id exists in the Vats array
ProductInfoUrl	String, optional	URL providing more info about the item (online only). Local paths are not supported
Ingredients	Array, optional	Array of Translatable objects. The ingredients that will be displayed in the menu card. The ingredients are comma separated inside the Translatable.val. These ingredients can be created in multiple languages
Infos	Array, optional	Array of Info objects
IsSoldOut	Boolean, optional	Indicates whether this item is sold out and unavailable for preorder
LabelGroups	Array, optional	Array of LabelGroup(Item) objects
Ratings	Array, optional	Array of Rating objects
ComponentGroups	Array, optional	Array of ComponentGroup(Item) objects
GTIN	String, max length 14	Unique GTIN (Global Trade Item Number) of the item
CostOfGoodsSold	Object, optional	Direct production costs of the item. See: Money

Component (object)

Component inherits all properties of Item and adds a few extra properties.

Name	Type	Description
IsOptional	Boolean	Indicates if this is a main or side component
Quantity	Integer	Quantity of the component inside the ComponentGroup. If not specified defaults to 1. Used in IsOptional=true ComponentGroup
Price	Decimal, optional	Price of the component inside the ComponentGroup. Used in IsOptional=true ComponentGroup
Unit	Integer, opional	Unit of the component. The definition of the Integer values can be found below
UnitValue	Decimal, optional	Value of the unit

Unit

Id	Unit
0	Gramm
1	Kilogram
2	Milliliter
3	Liter
4	Piece

Allergen Ids

Id	Allergen (English)	Allergen (Deutsch)
1	Cereals containing gluten	Glutenhaltiges Getreide
1001	Wheat	Weizen
1002	Rye	Roggen
1003	Barley	Gerste
1004	Oats	Hafer
2	Crustaceans	Krebstiere
3	Eggs	Eier
4	Fish	Fische
5	Soybeans	Sojabohnen
6	Milk	Milch
7	Peanut	Erdnuss
8	Nuts	Schalenfrüchte
8001	Almonds	Mandeln
8002	Hazelnuts	Haselnüsse
8003	Walnuts	Walnüsse
8004	Cashews	Kaschunüsse
8005	Pecan nuts	Pecannüsse
8006	Brazil nuts	Paranüsse
8007	Pistachio nuts	Pistazien
8008	Macadamia or Queensland nuts	Macadamia- oder Queenslandnüsse
9	Celery	Sellerie
10	Mustard	Senf
11	Sesame seeds	Sesamsamen
12	Sulphur dioxide and sulphites	Schwefeldioxid und Sulphite
13	Molluscs	Weichtiere
14	Lupin	Lupinen

NutritionFacts (object)

For Decimal two decimals are allowed, use a decimal point (".") as separator

Name	Deutsch	Type	Description
CarbsPerServing	Kohlenhydrate	Decimal, optional	Amount of carbs in grams per serving/portion of the item.
SugarPerServing	Zucker	Decimal, optional	Amount of sugar in grams per serving/portion of the item.
PolyolsPerServing	Mehrwertige Alkohole	Decimal, optional	Amount of polyols in grams per serving/portion of the item.
StarchPerServing	Stärke	Decimal, optional	Amount of starch in grams per serving/portion of the item.
FatsPerServing	Fett	Decimal, optional	Amount of fats in grams per serving/portion of the item.
SaturatedFatsPerServing	Gesättigte Fettsäuren	Decimal, optional	Amount of saturated fats in grams per serving/portion of the item.
MonounsaturatedFatsPerServing	Einfach ungesättigte Fettsäuren	Decimal, optional	Amount of monounsaturated fats in grams per serving/portion of the item.
PolyunsaturatedFatsPerServing	Mehrfach ungesättigte Fettsäuren	Decimal, optional	Amount of polunsaturated fats in grams per serving/portion of the item.
KCalPerServing	KCal	Integer, optional	Amount of kilocalories per serving/portion of the item
KJoulePerServing	KJoule	Integer, optional	Amount of kilojoules (Energy) per serving/portion of the item
ProteinsPerServing	Eiweiß	Decimal, optional	Amount of proteins in grams per serving/portion of the item.
FibrePerServing	Ballaststoffe	Decimal, optional	Amount of fibre in grams per serving/portion of the item.
SaltPerServing	Salz	Decimal, optional	Amount of salt in grams per serving/portion of the item.
CarbsPer100	Kohlenhydrate	Decimal, optional	Amount of carbs in grams per 100g of the item
SugarPer100	Zucker	Decimal, optional	Amount of sugar in grams per 100g of the item.
PolyolsPer100	Mehrwertige Alkohole	Decimal, optional	Amount of polyols in grams per 100g of the item.
StarchPer100	Stärke	Decimal, optional	Amount of starch in grams per 100g of the item.
FatsPer100	Fett	Decimal, optional	Amount of fats in grams per 100g of the item.
SaturatedFatsPer100	Gesättigte Fettsäuren	Decimal, optional	Amount of saturated fats in grams per 100g of the item.
MonounsaturatedFatsPer100	Einfach ungesättigte Fettsäuren	Decimal, optional	Amount of monounsaturated fats in grams per 100g of the item.
PolyunsaturatedFatsPer100	Mehrfach ungesättigte Fettsäuren	Decimal, optional	Amount of polyunsaturated fats in grams per 100g of the item.
KCalPer100	KCal	Integer, optional	Amount of kilocalories per 100g of the item.
KJoulePer100	KJoule	Integer, optional	Amount of kilojoules (Energy) per 100g of the item
ProteinsPer100	Eiweiß	Decimal, optional	Amount of proteins in grams per 100g of the item.
FibrePer100	Ballaststoffe	Decimal, optional	Amount of fibre in grams per 100g of the item.
SaltPer100	Salz	Decimal, optional	Amount of salt in grams per 100g of the item.
CholesterolPer100	Cholesterin	Decimal, optional	Amount of cholesterol in milligrams per 100g of the item.
WaterPer100	Wasser	Decimal, optional	Amount of water in grams per 100g of the item.
VitamineA1Per100	Vitamin A1	Decimal, optional	Amount of vitamin A1 in micrograms per 100g of the item.
VitamineB1Per100	Vitamin B1	Decimal, optional	Amount of vitamin B1 in micrograms per 100g of the item.
VitamineB2Per100	Vitamin B2	Decimal, optional	Amount of vitamin B2 in micrograms per 100g of the item.
VitamineB6Per100	Vitamin B6	Decimal, optional	Amount of vitamin B6 in micrograms per 100g of the item.
VitamineB12Per100	Vitamin B12	Decimal, optional	Amount of vitamin B12 in micrograms per 100g of the item.
VitamineCPer100	Vitamin C	Decimal, optional	Amount of vitamin C in milligrams per 100g of the item.
VitamineDPer100	Vitamin D	Decimal, optional	Amount of vitamin D in micrograms per 100g of the item.
VitamineEPer100	Vitamin E	Decimal, optional	Amount of vitamin E in micrograms per 100g of the item.
VitamineHPer100	Vitamin H	Decimal, optional	Amount of vitamin H in micrograms per 100g of the item.
VitamineKPer100	Vitamin K	Decimal, optional	Amount of vitamin K in micrograms per 100g of the item.
BetaCarotenePer100	Beta-Carotin	Decimal, optional	Amount of beta carotene in milligrams per 100g of the item.
NiacinPer100	Niacin	Decimal, optional	Amount of niacin acid (vitamin B3 equivalent) in milligrams per 100g of the item.
PantohenPer100	Pantothen-säure	Decimal, optional	Amount of pantothenic acid (vitamin B5 equivalent) in milligrams per 100g of the item.
FolicAcidPer100	Folsäure	Decimal, optional	Amount of folic acid in micrograms per 100g of the item.
SodiumPer100	Natrium	Decimal, optional	Amount of sodium in milligrams per 100g of the item.
PotassiumPer100	Kalium	Decimal, optional	Amount of potassium in milligrams per 100g of the item.
ChlorinePer100	Chlor	Decimal, optional	Amount of chlorine in milligrams per 100g of the item.
CalciumPer100	Calcium	Decimal, optional	Amount of calcium in milligrams per 100g of the item.
MagnesiumPer100	Magnesium	Decimal, optional	Amount of magnesium in milligrams per 100g of the item.
PhosphorusPer100	Phosphor	Decimal, optional	Amount of phosphorus in milligrams per 100g of the item.
IronPer100	Eisen	Decimal, optional	Amount of iron in milligrams per 100g of the item.
ZincPer100	Zink	Decimal, optional	Amount of zinc in micrograms per 100g of the item.
CopperPer100	Kupfer	Decimal, optional	Amount of copper in micrograms per 100g of the item.
ManganesePer100	Mangan	Decimal, optional	Amount of manganese in micrograms per 100g of the item.
FlouridePer100	Fluoride	Decimal, optional	Amount of flouride in micrograms per 100g of the item.
IodinePer100	Jod	Decimal, optional	Amount of iodine in micrograms per 100g of the item.
PurinePer100	Purine	Decimal, optional	Amount of purine in milligrams per 100g of the item.
UricAcidPer100	Harnsäure	Decimal, optional	Amount of uric acid in milligrams per 100g of the item.
AlcoholPercentPer100	Alkoholgehalt	Decimal, optional	Amount of alcohol in volume percent per 100g of the item.

Price (object)

Name	Type	Description
PriceTagId	String	Id of a PriceTag object
Value	Decimal	Price of the item. Two decimals are allowed, use a decimal point (".") as separator

Money (object)

Name	Type	Description
Value	Decimal	Money amount. Two decimals are allowed, use a decimal point (".") as separator.
CurrencyIso	String, optional	Currency code of the money. Default is EUR.

Info (object)

Name	Type	Description
Title	Array, optional	Array of Translatable objects. The title of the Info that will be displayed in our backoffice system. This name can be created in multiple languages
Message	Array, optional	Array of Translatable objects. The message of the Info that will be displayed in our backoffice system. This name can be created in multiple languages
PictureUrl	String, optional	URL of an image (online only). Local paths are not supported
OrderIndex	Integer, opional	OrderIndex of the Info

ComponentGroup(Item) (object)

Name	Type	Description
Id	String	Unique identifier of the ComponentGroup. You have to make sure that a ComponentGroup with the Id exists in the ComponentGroups array
Components	Array, optional	Array of Component objects
ComponentMetas	Array, optional	Array of ComponentMeta objects

ComponentMeta(object)

Name	Type	Description
PLU	String, max length 50	Unique identifier specified by external party. The item will not be imported if the PLU is empty or missing. This Id will also be used for future updates of an existing item. You have to make sure that a Item with PLU exists in the Items array
IsOptional	Boolean	Indicates if this is a main or side component
Quantity	Integer	Quantity of the component inside the ComponentGroup. Used in IsOptional=true ComponentGroup
Price	Decimal, optional	Price of the component inside the ComponentGroup. Used in IsOptional=true ComponentGroup
Unit	Integer, opional	Unit of the component. The definition of the Integer values can be found above
UnitValue	Decimal, optional	Value of the unit

LabelGroup(Item) (object)

Name	Type	Description
Id	String	Unique identifier of the LabelGroup. You have to make sure that a LabelGroup with the Id exists in the LabelGroups array
LabelIds	Array	Array of Label.Id. You have to make sure that a Label with the Id exists in the Label array

Rating (object)

Name	Type	Description
RatingLabelId	String	Unique identifier of the RatingLabel. You have to make sure that a RatingLabel with the Id exists in the RatingLabels array
Value	Decimal, optional	The value (if available/appropriate) of the respektive label

API Blueprint herunterladenStand der Dokumentation