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
  • Analyze List
  • Sample Request
  • Sample Response

Was this helpful?

  1. API
  2. Shopping Lists

List Analysis

This endpoint allows you to perform analysis on Shopping List or any generic set of items

Analyze List

POST https://graph.whisk.com/v1/lists/analyze

Request Body

Name
Type
Description

items

array

Text of items to analyze. Example: ["1 tbsp olive oil", "2 large tomatoes"]

{
  "analyzedItems": [
    {
      "sourceText": "200g pack smoked salmon",
      "normalized": "200 g smoked salmon",
      "analysis": {
        "product": "smoked salmon",
        "quantity": 200,
        "unit": "g",
        "category": "MEATS AND SEAFOOD"
      }
    },
    ...
    {
      "sourceText": "1 tbsp salt and olive oil to serve",
      "normalized": "olive oil",
      "analysis": {
        "product": "olive oil",
        "category": "CONDIMENTS"
      }
    }
  ]
}

This endpoint allows you to perform analysis on Shopping List or any generic set of items

Sample Request

curl -X POST "https://graph.whisk.com/v1/lists/analyze" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Token <Access-Token>" \
  -d '{
    "items": [
      "200g pack smoked salmon",
      "2 slices sharp cheddar cheese",
      "1 tbsp salt and olive oil to serve"
    ]
  }'

Sample Response

{
  "analyzedItems": [
    {
      "sourceText": "200g pack smoked salmon",
      "normalized": "200 g smoked salmon",
      "analysis": {
        "product": "smoked salmon",
        "quantity": 200,
        "unit": "g",
        "category": "MEATS AND SEAFOOD"
      }
    },
    ...
    {
      "sourceText": "1 tbsp salt and olive oil to serve",
      "normalized": "olive oil",
      "analysis": {
        "product": "olive oil",
        "category": "CONDIMENTS"
      }
    }
  ]
}
PreviousAdd Items To A Shopping ListNextMeal Plans

Last updated 5 years ago

Was this helpful?