Grocery List

The Grocery List object refers to the collection of grocery list items for a BigOven user. The following methods are supported for the Grocery List object.

CREATE READ UPDATE DELETE
Grocery List Yes Yes Yes Yes

Adding to Grocery List

Add a new item to the grocery list for the authenticated user.

POST http://api.bigoven.com/grocerylist/item
Parameter Description Required?
quantity Quantity of grocery list item (e.g., 1.5 or "1 1/2" url-encoded) No
unit Unit grocery list item (e.g., lbs) No
name Name of shopping list item (e.g., blueberries) Yes
notes Additional notes for item No
department Department in which item is found No. If not provided, BigOven will try to auto-match

Reading a Grocery List (HTTP GET)

Read all grocery list items for the authenticated user.

GET http://api.bigoven.com/grocerylist
SAMPLE RESPONSE (JSON)
{
  "Items": [
    {
      "ItemID": 13809644,
      "GUID": "6B8CC6F5-3F47-47B1-BC16-E8589259D96B",
      "RecipeID": null,
      "Name": "chicken",
      "Notes": "",
      "DisplayQuantity": "1 lb",
      "Department": "Poultry",
      "CreationDate": "\\/Date(1436410705347)\\/",
      "IsChecked": null,
      "LocalStatus": "UNMODIFIED",
      "LastModified": "\\/Date(1436410705363)\\/",
      "BigOvenObject": null,
      "ThirdPartyURL": null
    },
    {
      "ItemID": 13809645,
      "GUID": "9636EFE8-3770-47D1-B641-EAF9FB78FAEF",
      "RecipeID": null,
      "Name": "blueberries",
      "Notes": "",
      "DisplayQuantity": "2 pints",
      "Department": "Produce",
      "CreationDate": "\\/Date(1436410712353)\\/",
      "IsChecked": null,
      "LocalStatus": "UNMODIFIED",
      "LastModified": "\\/Date(1436410712353)\\/",
      "BigOvenObject": null,
      "ThirdPartyURL": null
    }
  ],
  "Recipes": [],
  "LastModified": "\\/Date(1436410712353)\\/",
  "VersionGuid": "abd2888b-6dc1-4625-a3fa-6fb6f2643610"
}

Updating a Grocery List Item (HTTP PUT)

Updates a item for the authenticated user.

PUT http://api.bigoven.com/grocerylist/item/{guid}
Parameter Description Required?
guid Grocery list item id (GUID) Yes
quantity Quantity of grocery list item No
unit unit, e.g., lbs No
name Name of shopping list item No
notes Additional notes for item No
department Department in which item is found No

Deleting a Grocery List item (HTTP DELETE)

Delete a grocery list item for the authenticated user.

DELETE http://api.bigoven.com/grocerylist/item/{guid}
Parameter Description Required?
guid Grocery list item guid Yes

Clearing a Grocery List (HTTP DELETE)

Delete an entire grocery list for the authenticated user.

DELETE http://api.bigoven.com/grocerylist