Whisk Docs
Whisk HomeHelp CenterDeveloper Tools
v1.0.0
v1.0.0
  • Overview
  • Guides
    • Creating An Account
    • Getting Started
    • Whisk Sandbox
  • API
    • Authentication
      • Server Token
      • Client Token
      • User Access Token
      • Anonymous Access
    • Recipes
      • Get Recipe
      • Get Recipe Categories
      • Recipe Objects
    • Recipe Discovery
      • Recipe Feed
      • Recipe Search
      • Get Similar Recipes
    • Shopping Lists
      • Get Shopping Lists
      • Create A Shopping List
      • Add Items To A Shopping List
      • List Analysis
    • Meal Plans
      • Meal Plan Management
      • Delete Meals
      • Auto-Generator
      • Error Handling
    • Retailers
      • Get Available Stores
      • Retailers Checkout Flow
      • Retailer Aliases
      • OAuth Retailer Flow
      • Retailer User Info
      • Search Store Items
    • Carts
      • Create a Cart
      • Update Cart Item
      • Splitting Combined Items
      • Add Items To Cart
      • Add Recipes To Cart
      • Get Cart Item Options
      • Swap Cart Item Product
      • Delete A Cart Or A Cart Item
      • Checkout
    • Users
      • Get A User
      • Update A User
    • 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
    • Tools
      • Autocomplete
  • 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
  • Tips and Tricks
    • Object IDs
    • URL Lookup
    • Searching
    • Multiple IDs request
  • Resources
    • Nutrients
    • Recipe Labels
    • Health Score, Glycemic Index, Glycemic Load
    • Whisk User Data
    • Supported Retailers
    • Optimizing Image Load
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