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
  • Sending items to basket
  • Sending recipes to basket
  • Setting additional parameters

Was this helpful?

  1. Shopping List Mobile API

Examples

This functionality allows you to send items and recipes to a basket, below are some common use cases.

Sending items to basket

You can send one or more items using rawItemsor items.

curl "https://graph.whisk.com/v1/lists/transfers" \
  -H "Authorization: Token <Access-Token>" \
  -H "Content-Type: application/json" \
  -d '{
  "language": "en",
  "rawItems": [
    "250ml milk",
    "50g dark chocolate ",
    "10 marshmallows"
  ],
  "items": [
    {
      "name": "milk",
      "quantity": 250,
      "unit": "ml"
    },
    {
      "name": "dark chocolate",
      "quantity": 50,
      "unit": "g"
    },
    {
      "name": "marshmallows",
      "quantity": 10
    }
  ]
}'

Sending recipes to basket

You can send one or more recipes to the basket.

You can use a scale to adjust quantities of all ingredients within a recipe. For example, if a recipe is for 4 servings by default, you can use scale:2 to set quantities to 8 servings or use scale:0.5 for 2 servings.

curl "https://graph.whisk.com/v1/lists/transfers" \
  -H "Authorization: Token <Access-Token>" \
  -H "Content-Type: application/json" \
  -d '{
  "recipes": [
    {
      "id": "https://whisk.com/demo/calzone-roasted-peppers",
      "scale": 1
    },
    {
      "id": "https://whisk.com/demo/sponsored-ingredient",
      "scale": 2
    }
  ]
}'

Setting additional parameters

If you don’t submit additional parameters Whisk will attempt to detect language and location automatically.

curl "https://graph.whisk.com/v1/lists/transfers" \
  -H "Authorization: Token <Access-Token>" \
  -H "Content-Type: application/json" \
  -d '{
    "language": "de",
    "country": "DE",
    "zipcode": "80333",
    "items": [
      
        "name": "Äpfel",
        "quantity": 5
      },
      {
        "name": "Bananen",
        "quantity": 5
      },
      {
        "name": "Orangen",
        "quantity": 5
      }
    ]
  }'

Note: Although Whisk performs automatic language detection we recommended you submit language explicitly so that Whisk can apply the correct NLP (to analyze your content and match it to store items).

PreviousOverviewNextReference

Last updated 4 years ago

Was this helpful?

Note: To make your recipes shoppable they must be understood by Whisk, to check how we’ve parsed your recipe go to the .

You can customize the experience using additional parameters when sending items. For example, you can set the country and zip code to show stores relevant to the user’s region. See the page for the full list.

recipe validator
Reference