Shopping List Mobile API Reference

Parameters

ATTRIBUTETYPEDESCRIPTION
itemsarray [ListsTransferItemPayload]

List of normalised items to add.

rawItemsarray [string]

List of raw items to add.

recipesarray [ListsTransferRecipePayload]

List of recipes to add.

allowedRetailersarray [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' ]

languagestring

This affects interface language and analysis on item text.
Possible values: en, de, fr.

countrystring

Set default country. This will affect which stores are available. If not set, the country will be automatically detected.

zipcodestring

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_campaignstring

Identifies a specific product promotion or strategic campaign.

utm_sourcestring

Identifies which site sent the traffic, and is a required parameter.

utm_mediumstring

Identifies what type of link was used, such as cost per click or email.

utm_contentstring

Identifies what specifically was clicked to bring the user to the site, such as a banner ad or a text link.

utm_termstring

Identifies search terms.

ListsTransferItemPayload

ATTRIBUTETYPEDESCRIPTION
name*string

Item name (e.g. potato)

quantitydouble

Item quantity

unitstring

Item unit (e.g. gram, ml)

commentstring

Additional information (e.g. organic)

ListsTransferRecipePayload

ATTRIBUTETYPEDESCRIPTION
id*string

GraphId or URL of a Recipe

scalenumber

Multiply the quantities of all ingredients within recipe. Accepts integers (e.g. 2) or decimals (e.g. 0.5).