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
  • Getting started
  • Response

Was this helpful?

  1. Shopping List Mobile API

Overview

PreviousUsing With SPANextExamples

Last updated 4 years ago

Was this helpful?

This functionality provides a simple way to integrate Whisk’s add-to-basket functionality into your mobile application, allowing you to send items and recipes to an online grocery basket.

Using this API you can generate URLs (we call these "transfer URLs") which pass your content to the Whisk basket experience. In your application, you add a button, such as "Order ingredients", which opens this URL in a web browser. This allows the user to choose a retailer, select store products, and send everything to their online basket.

Note: To use this service you will need access to the Whisk Graph API. This requires registering an application on the Whisk Platform, which you can do by .

Getting started

There are three ways to add items with transfer URLs:

  • rawItems - a full string containing quantity, unit, and product. "E.g. 250g cheddar cheese"

  • items - structured item data with separate fields for quantity, unit, product.

  • recipes - recipes are identified by URL or unique Whisk ID.

The endpoint is:

POST

https://graph.whisk.com/v1/lists/transfers

When you send items Whisk automatically matches them to appropriate store items at all available retailers. Whisk’s matching algorithm uses various factors including available store items, quantity, brand, attributes, and price.

Here is a basic example sending items and recipes:

curl "https://graph.whisk.com/v1/lists/transfers" \
  -H "Authorization: Token <Access-Token>" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "name": "skimmed milk",
        "quantity": 2,
        "unit": "l"
      },
      {
        "name": "coffee"
      },
      {
        "name": "sugar",
        "quantity": "5",
        "unit": "tbsp"
      }
    ],
    "rawItems": [
      "2l skimmed milk",
      "coffee",
      "5 tbsp sugar"
    ],
    "recipes": [
      {
        "id": "https://whisk.com/demo/calzone-roasted-peppers",
        "scale": 1
      }
    ]
  }'

Response

The response will contain a URL which should be opened in the user’s mobile web browser - not inside WebViews. This opens the Whisk basket experience and allows users to select their store, choose store items, and send items to their basket.

{
    "landingUrl": "https://graph.whisk.com/v1/lists/transfers/9e107d15377f484eb7c343f93028b936/landing"
}

Note: Generated URLs are valid for 14 days and are then expired.

See Graph API documentation about for more information.

Take a look at the or view the page for all available parameters.

authentication
Examples
Reference
contacting us
image alt text