Whisk Docs
Whisk HomeHelp CenterDeveloper Tools
v2.0.0
v2.0.0
  • The Whisk Platform
  • Whisk API Overview
    • Introduction
    • Integration
    • Authentication
      • Server Token
      • User Access Token
        • Auth Flow Example
      • Client Token
      • Anonymous Access from Client Apps
    • Whisk Sandbox
    • Getting Started
  • Whisk API Reference 2.0
    • Provisioning
      • Get provisioning
    • Autocomplete
    • Community
      • Get your Communities
      • Get Communities from a Topic
      • Discover Recommended Communities
      • Search Communities
      • Get a Community
      • Get Recipes from a Community
      • Add Recipes to a Community
      • Remove a Recipe from a Community
      • Join a Community
      • Leave a Community
    • Posts and Reviews
      • Get reviews for a recipe
      • Create or edit review
      • Create a Post
      • Get Post by id
      • Delete a Post
      • Edit a Post
      • Report a Post
      • Create a Post Reply
      • Get Post Replies
      • Delete a Post reply
      • Report a Post reply
      • Like a Post or Reply
      • Users who liked a Post or Reply
    • Public profiles
      • Hide recipe in Public profile
      • Get Recipes for Public Profile
      • Get User's public profile by user_id
      • Get User's public profile by username
    • Custom Label
    • Feed
      • Obtain a Recipe Feed
    • Food DB
      • Autocomplete
      • Search
      • Get Food
    • Food List
    • Food Log
    • Foodpairing
    • Healthy meal recommendations
      • Healthy recipe only recommendations for DA
      • Recipe recommendations for SH
      • Tailored Plan API request for Samsung TV
    • Meal Plan
      • Generate a Meal Plan
      • Meal Object
        • Get Meals
        • Delete Meal
        • Add a Meal
      • Meal Plan Settings Object
        • Get Meal Plan Settings
        • Update Meal Plan Settings
      • Meal Plan Batch
    • Recipe
      • Get a Recipe
      • Search a Recipe
      • User Recipes & Collections
        • Add User Recipe
        • Create A Recipe
        • Update External Recipe
        • Get All User Recipes
        • Update User Recipe
        • Remove Recipe from Favorites
        • Create Collection
        • Get All User Collections
        • Get Collection
        • Get Recipes from a Collection
        • Remove Collection
        • Get Smart Collection
        • Get Recipes from a Smart Collection
    • Shopping List
      • Get your Shopping Lists
      • Get a Shopping List
      • Create a Shopping List
      • Delete a Shopping List
      • Update basic details of a Shopping List
      • Move Items between Shopping Lists
      • Add Items to a Shopping List
      • Delete an Item from a Shopping List
      • Update an Item in a Shopping List
      • Clear Items from a Shopping List
    • Media
    • Store Item
    • Unit Conversion
    • Users
      • Get a User
      • Update User Settings using Patch
      • Update User Settings using Post
    • Try it out!
  • Shopping List SDK
    • Overview
    • Examples
      • Shoppable Recipes
      • Shoppable Products
      • Shoppable Media
    • Basic Setup
      • Basic Setup
      • Methods
      • Event Listeners
      • Widget
      • Subscriptions
      • Global Configuration
      • UTM Parameters
      • Using With SPA
  • Shopping List Mobile API
    • Overview
    • Examples
    • Reference
  • API Resources
    • Authentication Scopes
    • Errors and Troubleshooting
    • Cursor Pagination
    • Limits
    • Nutrients
    • Recipe Labels
    • Filtering Recipes using Custom Labels
    • Health Score, Glycemic Index, Glycemic Load
    • Whisk User Data
    • Integrated Retailers
    • Optimizing Image Load
    • Meal Plan
Powered by GitBook
On this page
  • Parameters
  • ListsTransferItemPayload
  • ListsTransferRecipePayload

Was this helpful?

  1. Shopping List Mobile API

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]

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).

PreviousExamplesNextAuthentication Scopes

Last updated 4 years ago

Was this helpful?

List of available retailers in the shopping list app. If not set, all available retailers are shown. Each retailer should be prefixed with the country code to control which retailer will be available in which country. For example, GB:AmazonFresh, US:Walmart. To see the list of all retailers that we support, read .

Integrated Retailers