500,000+ Recipe and Grocery List API (v2)
  1. Schemas
500,000+ Recipe and Grocery List API (v2)
  • Article
    • Get a food article
  • Collection
    • Gets a recipe collection. A recipe collection is a curated set of recipes.
    • Gets a recipe collection metadata. A recipe collection is a curated set of recipes.
    • Get the list of current, seasonal recipe collections. From here, you can use the /collection/{id} endpoint to retrieve the recipes in those collections.
  • GroceryList
    • Delete all the items on a grocery list; faster operation than a sync with deleted items.
    • Get the user's grocery list. User is determined by Basic Authentication.
    • Clears the checked lines.
    • Departmentalize a list of strings -- used for ad-hoc grocery list item addition
    • Add a single line item to the grocery list
    • /grocerylist/item/{guid} DELETE will delete this item assuming you own it.
    • Update a grocery item by GUID
    • Add a single line item to the grocery list
    • Add a Recipe to the grocery list. In the request data, pass in recipeId, scale (scale=1.0 says to keep the recipe the same size as originally posted), markAsPending (true/false) to indicate that the lines in the recipe should be marked in a
    • Synchronize the grocery list. Call this with a POST to /grocerylist/sync
  • Images
    • POST: /image/avatar Testing with Postman (validated 11/20/2015): 1) Remove the Content-Type header; add authentication information 2) On the request, click Body and choose "form-data", then add a line
    • Gets the pending by user.
    • POST: /recipe/{recipeId}/image?lat=42&lng=21&caption=this%20is%20my%20caption Note that caption, lng and lat are all optional, but must go on the request URI as params because this endpoint needs a multip
    • Get all the images for a recipe. DEPRECATED. Please use /recipe/{recipeId}/photos.
    • Get all the photos for a recipe
    • Gets a list of RecipeScan images for the recipe. There will be at most 3 per recipe.
  • Me
    • Indexes this instance.
    • Puts me.
    • Puts me personal.
    • Puts me preferences.
    • Gets the options.
    • Puts me.
    • Skinnies this instance.
  • Recipe
    • Add a new recipe
    • Update a recipe
    • Given a query, return recipe titles starting with query. Query must be at least 3 chars in length.
    • Automatics the complete all recipes.
    • Automatics the complete my recipes.
    • Get a list of recipe categories (the ID field can be used for include_cat in search parameters)
    • Returns last active recipe for the user
    • Gets recipe single step as text
    • Returns stored step number and number of steps in recipe
    • Stores recipe step number and returns saved step data
    • POST an image as a new RecipeScan request 1) Fetch the filename -- DONE 2) Copy it to the pics/scan folder - ENSURE NO NAMING COLLISIONS -- DONE 3) Create 120 thumbnail size in pics/scan/120 -- DONE
    • Return full Recipe detail with steps. Returns 403 if the recipe is owned by someone else.
    • Delete a Recipe (you must be authenticated as an owner of the recipe)
    • Return full Recipe detail. Returns 403 if the recipe is owned by someone else.
    • Zaps the recipe.
    • Feedback on a Recipe -- for internal BigOven editors
    • Get recipes related to the given recipeId
    • Search for recipes. There are many parameters that you can apply. Starting with the most common, use title_kw to search within a title. Use any_kw to search across the entire recipe. If you'd like to limit by course, set the para
    • Get a random, home-page-quality Recipe.
    • Get the recipe/comment tuples for those recipes with 4 or 5 star ratings
    • Get a list of recipes that the authenticated user has most recently viewed
    • Search for recipes. There are many parameters that you can apply. Starting with the most common, use title_kw to search within a title. Use any_kw to search across the entire recipe. If you'd like to limit by course, set the para
    • Same as GET recipe but also includes the recipe videos (if any)
  • Review
    • DELETE a reply to a given review. Authenticated user must be the one who originally posted the reply.
    • Update (PUT) a reply to a given review. Authenticated user must be the original one that posted the reply.
    • Get a given review by string-style ID. This will return a payload with FeaturedReply, ReplyCount. Recommended display is to list top-level reviews with one featured reply underneath. Currently, the FeaturedReply is the most rece
    • Update a given top-level review.
    • Get a paged list of replies for a given review.
    • POST a reply to a given review. The date will be set by server. Note that replies no longer have star ratings, only top-level reviews do.
    • Get *my* review for the recipe {recipeId}, where "me" is determined by standard authentication headers
    • Add a new review. Only one review can be provided per {userId, recipeId} pair. Otherwise your review will be updated.
    • DEPRECATED! - Deletes a review by recipeId and reviewId. Please use recipe/review/{reviewId} instead.
    • Get a given review - DEPRECATED. See recipe/review/{reviewId} for the current usage. Beginning in January 2017, BigOven moded from an integer-based ID system to a GUID-style string-based ID system for reviews and replies. We are
    • HTTP PUT (update) a recipe review. DEPRECATED. Please see recipe/review/{reviewId} PUT for the new endpoint. We are moving to a string-based primary key system, no longer integers, for reviews and replies.
    • Get paged list of reviews for a recipe. Each review will have at most one FeaturedReply, as well as a ReplyCount.
  • Note
    • HTTP POST a new note into the system.
    • Delete a review do a DELETE Http request of /note/{ID}
    • Get a given note. Make sure you're passing authentication information in the header for the user who owns the note.
    • HTTP PUT (update) a Recipe note (RecipeNote).
    • recipe/100/notes
  • Schemas
    • Schemas
      • API2.Controllers.WebAPI.GroceryListController.DepartmentModel
      • API2.Controllers.WebAPI.GroceryListController.PostGroceryListAddLineRequest
      • API2.Controllers.WebAPI.GroceryListController.PostGroceryListRecipeRequest
      • API2.Controllers.WebAPI.GroceryListController.PostGroceryListSyncRequest
      • API2.Controllers.WebAPI.GroceryListController.PostToGroceryListRecipeRequest
      • API2.Controllers.WebAPI.GroceryListController.UpdateItemByGuidRequest
      • API2.Controllers.WebAPI.ImagesController.RecipePhotosResponse
      • API2.Controllers.WebAPI.MeController.EatingStyle
      • API2.Controllers.WebAPI.MeController.Option
      • API2.Controllers.WebAPI.MeController.PreferenceOptions
      • API2.Controllers.WebAPI.NoteController.NoteRequest
      • API2.Controllers.WebAPI.ReviewController.PostReplyReq
      • API2.Controllers.WebAPI.ReviewController.ReviewRequest
      • API2.Controllers.WebAPI.ReviewController.ReviewRequestLegacy
      • API2.GroceryListDepartmentResult
      • API2.Models.Accounting
      • API2.Models.BigOvenUser
      • API2.Models.Counts
      • API2.Models.Location
      • API2.Models.Personal
      • API2.Models.Preference
      • API2.Models.Profile
      • API2.Models.Recipes.FeedbackDTO
      • API2.Models.Recipes.RecipeResponse
      • API2.Models.Recipes.RecipeVideoResponse
      • API2.Result
      • BigOven.Model.API.Grocery.GroceryList
      • BigOven.Model.API.Grocery.Item
      • BigOven.Model.API.Image
      • BigOven.Model.API.Ingredient
      • BigOven.Model.API.IngredientInfo
      • BigOven.Model.API.NutritionInfo
      • BigOven.Model.API.Recipe
      • BigOven.Model.API.RecipeInfo
      • BigOven.Model.API.RecipeNote
      • BigOven.Model.API.RecipeNoteList
      • BigOven.Model.API.Reply
      • BigOven.Model.API.Review
      • BigOven.Model.API.UserInfo
      • BigOven.Model.API.UserInfoTiny
      • BigOven.Model.API2.CollectionInfo
      • BigOven.Model.API2.GroceryList
      • BigOven.Model.API2.Photo
      • BigOven.Model.API2.Recipe
      • BigOven.Model.API2.RecipeInfox
      • BigOven.Model.API2.RecipeNote
      • BigOven.Model.API2.RecipeSearchResult
      • BigOven.Model.API2.UserInfoTinyx
      • BigOven.Model.InstructionStep
      • BigOven.Model.RecipeCategory
      • BigOven.Model.RecipeInfoDateTuple2
      • BigOven.Model.RecipeInfoReviewTuple2
      • BigOven.Model.RecipeInfoTiny
      • BigOven.Model.ShoppingListLine
      • BigOven.Result
      • System.Object
  1. Schemas

BigOven.Model.API.Grocery.GroceryList

{
    "Items": [
        {
            "BigOvenObject": "string",
            "CreationDate": "2019-08-24T14:15:22.123Z",
            "Department": "string",
            "DisplayQuantity": "string",
            "GUID": "string",
            "IsChecked": true,
            "ItemID": 0,
            "LastModified": "2019-08-24T14:15:22.123Z",
            "LocalStatus": "string",
            "Name": "string",
            "Notes": "string",
            "RecipeID": 0,
            "ThirdPartyURL": "string"
        }
    ],
    "LastModified": "2019-08-24T14:15:22.123Z",
    "Recipes": [
        {
            "BookmarkURL": "string",
            "Category": "string",
            "CreationDate": "2019-08-24T14:15:22.123Z",
            "Cuisine": "string",
            "HasVideos": true,
            "HeroPhotoUrl": "string",
            "HideFromPublicSearch": true,
            "ImageURL": "string",
            "ImageURL120": "string",
            "IsBookmark": true,
            "IsPrivate": true,
            "MaxImageSquare": 0,
            "Microcategory": "string",
            "Poster": {
                "FirstName": "string",
                "ImageUrl48": "string",
                "IsKitchenHelper": true,
                "IsPremium": true,
                "IsUsingRecurly": true,
                "LastName": "string",
                "MemberSince": "2019-08-24T14:15:22.123Z",
                "PhotoUrl": "string",
                "PhotoUrl48": "string",
                "PremiumExpiryDate": "2019-08-24T14:15:22.123Z",
                "UserID": 0,
                "UserName": "string",
                "WebUrl": "string"
            },
            "QualityScore": 0,
            "RecipeID": 0,
            "ReviewCount": 0,
            "StarRating": 0,
            "StarRatingIMG": "string",
            "Subcategory": "string",
            "Title": "string",
            "TotalTries": 0,
            "WebURL": "string",
            "YieldNumber": 0
        }
    ],
    "VersionGuid": "string"
}
Built with