Shopping List Mobile API Reference

List of normalised items to add.

List of raw items to add.

List of recipes to add.

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

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

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

Set default zip code. This will show stores available in this area. For de and us this should be 5 digits, e.g. 10001.

Identifies a specific product promotion or strategic campaign.

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

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

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

Identifies search terms.

Item name (e.g. potato)

Item quantity

Item unit (e.g. gram, ml)

Additional information (e.g. organic)

GraphId or URL of a Recipe

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