Technical Docs
  • Introduction
  • Guides
    • Getting Started
    • Attribution Guidelines
    • Core Concepts
      • Adherence Score
      • Programs, Diets, and Rulesets
      • User Profile
      • Datasets
    • Tutorials and Walkthroughs
      • Creating a Meal Plan
      • Food Log Guide
      • Pagination
      • Executing Multiple Mutations
  • Knowledge Base
    • How-to guides
      • How to add desserts to your meal plan
      • How to log your custom recipe
      • How to generate a Meal Plan based on a template
    • Common errors
      • Meal Plan generation
    • FAQs
      • Getting Started on Suggestic
      • API and Authentication
      • Device Compatibility
      • Meal Plan
      • Nutrition
      • Programs
      • Recipes
  • HELPFUL RESOURCES
    • Deprecated Features
    • Glossary
    • Integrations
      • Building a No-code Meal Planning Application
        • Step 1: Creating the Integromat Scenario and Google Forms Connection
        • Step 2: Creating a User, Generating a Meal Plan, and Retrieving It
        • Step 3: Crafting Our PDF and Connecting PDFMonkey
        • Step 4: Sending The Document to Our User
  • Packages and SDKs
    • Node Package (NPM)
  • GraphQL
    • GraphQL Overview
    • Authentication
    • Calling GraphQL
    • GraphQL Playground
  • Changelog
    • 2025
      • March
  • Suggestic API Reference
    • Search
      • Food Log
        • Branded Foods Search
        • Common Foods Search
        • My Branded Food Search
        • My Common Foods Search
        • Food Search
        • Legacy
          • Autocomplete
          • Barcode Search
      • Recipe Search
        • Recipe Search
        • Recipe Search by Name or Ingredients
        • Recipe Search by Ingredients
      • Meal Plan Template Search
      • Profile Search
      • Restaurant Search
        • Restaurant Search by Location
        • Restaurant Search
    • Queries
      • Appointments
        • Upcoming Appointments
        • Past Appointments
        • Appointments Types
      • Assessments
        • Assessment Answers
        • Display Assessments
        • Supplement Recommendations
        • User Assessments
      • Content
        • Content Library
        • Content Categories
        • Content Tags
        • Journey
      • Food Log
        • Frequently Logged
        • Food Log Entries
        • Macros Aggregation
        • Micronutrients Aggregation
        • Macro Goals
        • Recently Logged
        • User's Foods and Recipes
          • User's Recipes
        • Legacy
          • Food Log Entries (Legacy)
          • Own Food Items
          • Own Food Item
          • Own Food Item by Id
          • Own Items
          • Own Recipe
          • Own Recipes
      • Lab Tests
        • Biomarker Categories
        • Biomarker Units
        • Biomarker Catalog
        • Biomarkers
        • Biomarker Results
        • Historical Biomarker Results
        • Historical Results by Biomarker
        • Lab Test Reports
        • Recommended Supplements
        • Recommended Articles
      • Meal Plan
        • Meal Plan
        • Custom Meal Plan
        • Simplified Meal Tracking
          • Meal Tracker
        • Meal Plan Config
        • Meal Planner (deprecated)
      • Program
        • All Programs
        • Program Details
      • Recipes
        • Equivalent Recipes (Macros)
        • Equivalent Recipes (Calories)
        • Recipe by Id
        • Recipes By MealTime
        • Recipes By Tag
        • Recipe Swap Options
        • Popular Recipes
        • Favorite Recipes
        • Premium Program Recipes
      • Restaurants
        • Restaurant By Id
        • Menu Items
        • Menu Item By Id
        • Menu Item by Program
        • Recommend Menu Items
      • Restrictions
        • Restrictions
        • Restriction by ID
      • Shopping List
        • Shopping List by Aisle
        • Shopping List by Recipes
      • Subscriptions
        • Subscription List
      • Supplement Plans
        • Supplement plan list
        • Supplement list
      • Tracking
        • Activity and Exercise
        • Checklists
          • Intake Checklist
        • Daily Recap
          • Get Daily Recap
          • Get Daily Recaps
          • Get Daily Recap Questions
          • Get Daily Mood Summary
        • Inisghts
        • Wellness Score
        • Sleep
          • Sleep Time
          • Sleep Quality Score
        • Steps
        • Water and Hydration
        • Heart Rate
        • HRV
        • Weight Tracker
      • USDA Food
      • Users
        • Users
        • User Profile
      • WGPT
        • Assistants
        • Journey
        • Guardrails
    • Mutations
      • Appointments
        • Update Appointment Credits
      • Assessments
        • New User Assessments
        • Set User Answers
      • Content
        • Mark Content as Read
      • Feedback
      • Food Log
        • Log Entries
          • Food Log
            • Add a Food Log Entry
            • Delete a Food Log Entry
          • Meal Log (Legacy)
            • Create Log Entry
            • Update Log Entry
            • Remove Log Entry
        • User's Foods and Recipes
          • Create a User Recipe
          • Create my Branded Food
          • Create my Common Foods
          • Update a User Recipe
          • Delete a User Recipe
          • Legacy: "Own" Recipe
            • Create "Own" Recipe
            • Update "Own" Recipe
            • Remove "Own" Recipe
        • AI Food Log
          • Process Ai Food
        • Legacy (ownFoods and ownRecipes)
          • Create "own" Food Item
          • Update "own Food"
          • Remove "own" Food Item
      • Journey Status
        • Start Journeys
        • Journey Status
        • Toggle Task Completed
      • Lab Tests
        • Add Biomarker
        • Update Biomarker
        • Add Biomarker Result
        • Add Biomarker Category
        • Update Biomarker Category
        • Remove Biomarker Category
        • Add Lab Test Report
        • Delete Lab Test Report
        • Update Lab Test Report
        • Create Recommended Supplement
        • Update Recommended Supplement
        • Remove Recommended Supplement
        • Create Recommended Article
        • Update Recommended Article
        • Remove Recommended Supplement
      • Meal Plan
        • Create Meal Plan Template
          • Custom Options
          • From Days
          • From Scratch
        • Assign a Meal Plan Template to a User
        • Generate Simple Meal Plan
        • Generate Meal Plan
        • Start Over Meal Plan
        • Swap Meals
        • Simplified Meal Tracking
          • Create a Meal Tracker Entry
        • Remove Meal Plan
        • Remove Meal Plan Recipe
      • Recipes
        • Add new recipe
        • Add Favorite Recipe
      • Shopping List
        • Add Multiple Recipes to the Shopping List
        • Add a Recipe to the Shopping List
        • Bulk Check/Uncheck Items
        • Check/Uncheck an Item
        • Clear Checked Items
        • Clear Shopping List
        • Remove Recipe
        • Update Serving Number
      • Subscriptions
        • Update Subscription
      • Supplement Plans
        • Create supplement plan for user
        • Update user supplement plan
        • Add Supplement
        • Update Supplement
      • Tracking
        • Activity and Exercise
          • Add Exercise Entry
          • Delete Exercise Entry
        • Checklists
          • Create my Checklist Item
          • Delete my Checklist Item
        • Daily Recap
          • Create a daily recap question
          • Select Daily Recap Questions
          • Delete a Daily Recap Question
        • Sleep
          • Add Sleep Time
          • Add Sleep Quality Score
        • Steps
          • Add Steps Count
          • Delete Steps Count
        • Heart Rate
          • Add Heart Rate
          • Delete Heart Rate
        • HRV
          • Add HRV
          • Delete HRV
        • Water and Hydration
        • Weight
          • Add Weight Entry
          • Remove Weight Entry
        • User Tracker Goals
          • Create User Goal
          • Update User Goal
          • Remove User Goal
      • Users
        • Authenticate using a Magic Link
        • Create User
        • Custom Attributes
        • Delete a User Account
        • Login User
        • Merge User Accounts
        • Request Reset Password
        • Reset Password
        • Request Password Reset email
        • Sensitive Profile Attributes
        • Update Profile
        • Update User's Program
        • User's Restrictions
        • Update Meal Plan Settings
        • User's Goals
        • Legacy User Mutations
          • Legacy | User's Biomarkers
          • User's Meal Plan Settings (deprecated)
      • WGPT
        • Add user to journey
  • Objects
    • Appointments
      • Appointment
      • Appointment Type
      • Appointment Credit
      • Attendee
      • Coach
    • Common
      • User
      • Adherence
      • Aisle Name
      • CPC
      • CPCIngredientGroup
      • Meal Times
      • Menu Item
      • Own Serving
      • Own Nutrients
      • MacroNutrientsRangeInput
      • Range
      • Tracker
      • Restaurant
    • Food Logs
      • Food Filter
      • Ingredient Amount
      • Ingredients
      • Own Recipe Ingredient
      • Meal Type
      • Nutrients
        • Nutrient Enum
      • Portions
      • Servings
      • AI Food Log
        • Food Analysis
    • Meal Plan
      • Debug Meal Plan Conditions
      • Meal
      • Meal Plan Day
      • Maximum Time per Meal
      • Maximum Ingredient Count
      • Meal Plan Template
      • Simple Meal Plan Filters
    • Recipe
      • Recipe
        • Tags
        • Cuisines
      • Recipe Swap Options
      • Parsed Ingredient Lines
      • Nutritional Info
      • Nutrients Per Serving
      • Calories Per Serving
      • Relative Calories
      • Source
      • Ingredients
      • Units of Measurement
    • Lab Tests
      • Article
      • Biomarker
    • Supplement
    • Assessments
      • Question
      • Answer
    • Content
      • Content Library
      • Content Categories
      • Content Tag
    • WGPT
      • Journey
      • dayJourney
      • Interaction
  • Case Studies
    • Reverse Health Case Study
Powered by GitBook
On this page
  • Available Fields
  • Example
  • Get Shopping List Aggregate
  • Available Fields
  • Example

Was this helpful?

  1. Suggestic API Reference
  2. Queries
  3. Shopping List

Shopping List by Recipes

PreviousShopping List by AisleNextSubscriptions

Last updated 2 years ago

Was this helpful?

A shopping list in Suggestic is a collection of ingredients originating from recipes previously added to the list using the mutation.

Use the shoppingList query to obtain the list of recipes added to the shopping list.

Available Fields

Field

Type

Note

ingredient

String

Item in the shopping list

quantity

String

Quantity of the ingredient (item)

floatQuantity

Float

Item quantity as float

String

recipeName

String

Name of the recipe

isDone

Boolean

True if the item is checked

Example

GraphQL Example

{
  shoppingList {
    edges {
      node {
        ingredientLine
        quantity
        aisleName
        recipeName
        isDone
        unit
        databaseId
      }
    }
  }
}
{
  "data": {
    "shoppingList": {
      "edges": [
        {
          "node": {
            "ingredientLine": "16.4 grams non-diatatic malt powder (or barley malt syrup, or even brown sugar)",
            "quantity": "16.4",
            "aisleName": "Other",
            "recipeName": "Sourdough Bagels",
            "isDone": false,
            "unit": "grams",
            "databaseId": "05567b8f-ec1c-4f9d-8ed4-43ced7d36d26"
          }
        },
        {
          "node": {
            "ingredientLine": "1/2 cup pure cane syrup",
            "quantity": "1/2",
            "aisleName": "Other",
            "recipeName": "Glazed Turnips",
            "isDone": false,
            "unit": "cup",
            "databaseId": "57cd3daa-8499-47be-a126-be8eae7e1a4c"
          }
        },
        {
          "node": {
            "ingredientLine": "olive oil",
            "quantity": null,
            "aisleName": "Fats and Oils",
            "recipeName": "Glazed Turnips",
            "isDone": false,
            "unit": null,
            "databaseId": "195c0e2f-302f-4f65-8982-aa13fee2f8d5"
          }
        },
        {
          "node": {
            "ingredientLine": "1 tablespoon mccormick's montreal seasoning",
            "quantity": "1",
            "aisleName": "Other",
            "recipeName": "Glazed Turnips",
            "isDone": false,
            "unit": "tablespoon",
            "databaseId": "1440ca08-396a-4b58-a0b4-8ed9ed98c532"
          }
        }
      ]
    }
  }
}

cURL Example

curl -XPOST 'https://production.suggestic.com/graphql' \
  -H 'Authorization: Bearer <User-JWT>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"query":"{  shoppingList { edges {node {ingredientLine quantity aisleName recipeName isDone unit  databaseId  errors   }  }  }}"}'

UI/UX example

In the same way, we have code examples, this is an implementation example in which see results of the API execution in the Suggestic App.

Get Shopping List Aggregate

Use shoppingListAggregate to obtain the ingredients for the recipe added to the shopping list. If more than one recipe is added to the shopping list, this will show the cumulative ingredients.

Available Fields

Field

Type

Note

ingredient

String

Item in the shopping list

quantity

String

Item (ingredient) quantity

aisleName

String

Name of the aisle in which the ingredient (item) can be found

unit

String

Unit of measurement. Possible Values: cup, spoon, ounces, teaspoon, tablespoon.

grams

Float

Recipe measurement. Use this value as a reference only.

isDone

Bool

True if the item is checked

Example

GraphQL Example

query {
  shoppingListAggregate {
    edges {
      node {
        databaseId
        ingredient
        aisleName
        quantity
        unit
        grams
        isDone
      }
    }
  }
}
{
  "data": {
    "shoppingList": {
      "edges": [
        {
          "node": {
            "databaseId": "856f3e88-ebde-4dc8-a38b-af3dd4c8a291",
            "ingredient": "olive oil",
            "aisleName": "Pantry",
            "quantity": "1/2",
            "grams": 2.25,
            "isDone": false
          }
        },
        {
          "node": {
            "databaseId": "9bfdfe98-6cb2-4293-9146-c8298c06a243",
            "ingredient": "avocado",
            "asileName": "Pantry",
            "quantity": "1",
            "grams": 201,
            "isDone": false
          }
        }
      ]
    },
    "shoppingListAggregate": {
      "edges": [
        {
          "node": {
            "databaseId": "23cb01bf-50be-40cb-871d-954baa15fa79",
            "ingredient": "salt",
            "aisleName": "Pantry",
            "quantity": 6,
            "unit": "dash",
            "grams": 2.25,
            "isDone": false
          }
        },
        {
          "node": {
            "databaseId": "dcbd2ca8-d455-4944-895f-784825cc18ed",
            "ingredient": "avocado",
            "aisleName": "Pantry",
            "quantity": 2,
            "unit": "cup, pureed",
            "grams": 402,
            "isDone": false
          }
        }
      ]
    }
  }
}

cURL Example

curl -XPOST 'https://production.suggestic.com/graphql' \
  -H 'Authorization: Bearer <User-JWT>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"query":"{  shoppingListAggregate  { edges {node {databaseId ingredient aisleName quantity unit grams  isDone   }  }  }}"}'

UI/UX example

In the same way, we have code examples, this is an implementation example in which see results of the API execution in the Suggestic App.

Name of the aisle in which the ingredient (item) can be found. See options .

Login to the App, tap on the Meal Plan option, and tap on the icon to access the Shopping List, Tap on By Recipe tab and see the list of recipes added.

Login to the App, tap on the Meal Plan option, and tap on the icon to access the Shopping List, Tap on By Aisle tab and see the list of ingredients per each recipe:

addToShoppingList
aisleName
here