Create A Shopping List
Creates a shopping list. Both Server Token and User Access Token are allowed to be used in this endpoint. In the case of Server Token, a list will not be linked to any user and it will be only possible to access it by id.
post​
enShoppingListRecipePayload recipes to add to a shopping listShoppingListItemPayload normalized items to add​
ATTRIBUTE | TYPE | DESCRIPTION |
id* | string | GraphId or URL of a Recipe |
scale | float | Multiplier for default amounts in recipe: 0.5, 2 ... |
ATTRIBUTE | TYPE | DESCRIPTION |
quantity | double | Item quantity |
unit | string | Item unit (e.g. gram, ml) |
name* | string | Item name (e.g. potato) |
comment | string | ​ |
ATTRIBUTE | TYPE | DESCRIPTION |
id* | string | ​ |
name* | string | ​ |
primary | boolean | ​ |
createdTime* | datetime | The time the Shopping List was created. |
updatedTime* | datetime | ​ |
items | array [ShoppingListItemElement] | ​ |
ATTRIBUTE | TYPE | DESCRIPTION |
quantity | double | Item quantity |
unit | string | Item unit (e.g. gram, ml) |
name* | string | Item name (e.g. potato) |
comment | string | ​ |
brand | string | ​ |
analysis | SLItemAnalysis | ​ |
recipe | string | ​ |
recipeOrdering | integer | ​ |
createdTime | datetime | ​ |
combined | array | ​ |
ATTRIBUTE | TYPE | DESCRIPTION |
canonicalName | string | Unique normalized product name |
category | ProductCategory | ​ |
ATTRIBUTE | ​ | TYPE | ​ | DESCRIPTION |
name* | ​ | string | ​ | ​ |
curl -X POST "https://graph.whisk.com/v1/lists" \-H "Accept: application/json" \-H "Content-Type: application/json" \-H "Authorization: Bearer <User-Access-Token>" \-d '{"name": "My Shopping List","rawItems": ["200g pack smoked salmon","2 slices sharp cheddar cheese","1 tbsp salt and olive oil to serve"]}'
curl -X POST "https://graph.whisk.com/v1/lists" \-H "Accept: application/json" \-H "Content-Type: application/json" \-H "Authorization: Bearer <User-Access-Token>" \-d '{"name": "My Shopping List","items": [{"quantity": 200,"unit": "g","name": "smoked salmon"},{"quantity": 2,"unit": "slices","name": "cheddar cheese","comment": "extra mature"}]}'
curl -X POST "https://graph.whisk.com/v1/lists" \-H "Accept: application/json" \-H "Content-Type: application/json" \-H "Authorization: Bearer <User-Access-Token>" \-d '{"name": "My Shopping List","recipes": [{"id": "https://www.bbcgoodfood.com/recipes/omelette-pancakes-tomato-pepper-sauce","scale": 0.5},{"id": "9773cb7eca5d11e7ae7e42010a9a0035"}]}'
