index
API OVERVIEW
AUTHENTICATION
API PROTOCOL
API DATA
- Recipes
- Recipe Reviews
- Recipe Images
- Recipe Search Results
- Food Glossary
- Favorites
- Try Soons
- Grocery List
- User Profile
DATA MANAGEMENT
BRANDING, LEGAL & FINANCIAL
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 |
Creating a Grocery List (HTTP POST)
Add a new grocery list item for the authenticated user.
POST http://api.bigoven.com/grocerylist
| Parameter | Description | Required? |
| quantity | Quantity of grocery list item | Yes |
| name | Name of shopping list item | Yes |
| notes | Additional notes for item | No |
| department | Department in which item is found | No |
Reading a Grocery List (HTTP GET)
Read all grocery list items for the authenticated user.
GET http://api.bigoven.com/grocerylist
| Parameter | Description | Required? |
| N/A | N/A | N/A |
Updating a Grocery List (HTTP PUT)
Updating a grocery list item for the authenticated user.
POST http://api.bigoven.com/grocerylist/{id}
| Parameter | Description | Required? |
| id | Grocery list item primary key (ID) | Yes |
| quantity | Quantity of grocery list item | Yes |
| name | Name of shopping list item | Yes |
| 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{id}
| Parameter | Description | Required? |
| id | Grocery list item primary key (ID) | Yes |
