Reference

Parameters

ATTRIBUTE	TYPE	DESCRIPTION
items	array [ListsTransferItemPayload]	List of normalized items to add.
rawItems	array [string]	List of raw items to add.
recipes	array [ListsTransferRecipePayload]	List of recipes to add.
allowedRetailers	array [string]	List of available retailers in the shopping list app. If not set, all available retailers will be shown. Should be prefixed with the country code, so you can control which retailer will be available in every country: For example: [ 'GB:AmazonFresh', 'US:Walmart' ]
language	string	This affects interface language and analysis on item text. Possible values: en, de, fr.
country	string	Set default country. This will affect which stores are available. If not set, the country will be automatically detected.
zipcode	string	Set default zip code. This will show stores available in this area. For de and us this should be 5 digits, e.g. 10001.
utm_campaign	string	Identifies a specific product promotion or strategic campaign.
utm_source	string	Identifies which site sent the traffic, and is a required parameter.
utm_medium	string	Identifies what type of link was used, such as cost per click or email.
utm_content	string	Identifies what specifically was clicked to bring the user to the site, such as a banner ad or a text link.
utm_term	string	Identifies search terms.

ListsTransferItemPayload

ATTRIBUTE	TYPE	DESCRIPTION
name*	string	Item name (e.g. potato)
quantity	double	Item quantity
unit	string	Item unit (e.g. gram, ml)
comment	string	Additional information (e.g. organic)

ListsTransferRecipePayload

ATTRIBUTE	TYPE	DESCRIPTION
id*	string	GraphId or URL of a Recipe
scale	number	Multiply the quantities of all ingredients within recipe. Accepts integers (e.g. 2) or decimals (e.g. 0.5).