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
  • Configuration options

Was this helpful?

  1. Shopping List SDK

Overview

PreviousAutocompleteNextExamples

Last updated 5 years ago

Was this helpful?

The Whisk Shopping List SDK provides a rich set of client-side functionality that allows you to make your content shoppable.

Whether it’s a single product, a recipe, or even a meal planner, you can integrate the SDK in a few different ways and with many configuration options to suit your specific needs.

These docs provide all the details about setting up and using the Whisk Shopping List SDK.

Here are some things you can do:

Note: By using the Shopping List SDK you agree to our . If you are not using our Pro (paid) version you are required to add a link below or next to the button.

Getting started

The Whisk SDK enables you to make your content shoppable in minutes. Copy a few pieces of code to your site, add the parameters you want to customize your experience. See the page to get instructions about how to build with the SDK, or visit the page for all the details.

Here are a few basic concepts and terminology:

  • Widgets – premade shopping buttons that you can quickly drop onto your page.

  • Methods – actions you can take, for example adding a recipe to a list.

  • Event Listeners – how you initiate the actions, for example with a click.

  • Parameters – options that control specific behavior of a widget or event listener.

Configuration options

and try it out yourself!

The shopping list SDK can be used in a number of ways, easily customized to personalize for your needs. View the to see a full list of parameters.

Go to widget builder
reference pages
Add recipe to a shopping list
Add recipe to a basket
Add individual items to a shopping list
Terms
Powered by Whisk.com
Examples
Reference
Add individual items to a basket