GET / POST Search Beef Cut

Calls to this endpoint will return a list of the beef cut summary objects.

This endpoint can be called via GET or POST. Calling the search via POST will check the body of the request for the search criteria:

GET /api/v2/beefcut/search
POST /api/v2/beefcut/search

Search Beef Cut Parameters

Try POST Endpoint Try GET Endpoint
Name Required Parameter Type Data Type
searchText (optional) path string
  The search will look for this text anywhere in the beef cut model.
beefCategories (optional) path string
  A list of beef categories that the beef cut may contain. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='beef-category'. Any values that are not an exact match to this field may return unexpected results.
collections (optional) path array
  A list of collections that the beef cut may be found in. Values in this array must be an exact match to the common/lookups collections. Any values that are not an exact match to this field may return unexpected results.
preferredCookingMethods (optional) path array
  A list of cooking methods that the beefcut may contain. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='preferred-cooking-method'. Any values that are not an exact match to this field may return unexpected results.
ingredientGroups (optional) path array
  A list of ingredient groups that the beef cut may belong to. Values in this array must be an exact match to the common/lookups IngredientGroups. Any values that are not an exact match to this field may return unexpected results.
parentIngredients (optional) path array
  A list of ingredientNameSlug values that a beef cut may be a descendent of. Values in this array must be an exact match an online beef cut. Any values that are not an exact match to this field may return unexpected results.
primals (optional) path array
  A list of ingredientNameSlug values that a beef cut may be a descendent of. Values in this array must be an exact match to the common/lookups ingredientPrimals. Any values that are not an exact match to this field may return unexpected results.
upcNumber (optional) path string
  Search criteria will search the database for a matching UPC number.
nampNumber (optional) path string
  Search criteria will search the database for a matching IMPS/NAMP number.
isLean (optional) path boolean
  Search criteria to look for lean or not lean beef cuts.
isMarinate (optional) path boolean
  Search criteria to look for marinate or not marinate beef cuts.
pageNumber (optional) path int
  Used in conjunction with the itemsPerPage parameter to manage paging in a search. This will default to page 1 if no value is provided.
itemsPerPage (optional) path int
  Used in conjunction with the pageNumber parameter to manage paging in a search. This will default to 10 if no value is provided. The maximum items per page is 50.
AuthorizationAppID (optional) query string
  This value must be present in either the http header or in the query string. If you supply an incorrect value or do not supply a value in the header or query string, then you will receive a http 401 error. (Please see Authentication section)
AuthorizationAppKey (optional) query string
  This value must be present in either the http header or in the query string. If you supply an incorrect value or do not supply a value in the header or query string, then you will receive a http 401 error. (Please see Authentication section)

What it Returns

Requests to the Search for a beef cut will return the following data:

Name & Description Type
  • IngredientSearchResultModel object
    A container that holds the search result information.
    • searchResults array
      A list of beef cut summary objects.
      • ingredientID int
        Unique identifier of the beef cut
      • ingredientName string
        Name of the beef cut
      • ingredientNameSlug string
        URL-friendly slugged name of the beef cut
      • isOnline boolean
        Marker to denote if this beef cut is available on the Beef API
      • ingredientText string
        General description of the beef cut
      • ingredientMeta string
        Short, concise meta description of the beef cut
      • isBeefIngredient boolean
        True if this is a beef ingredient
      • isBeefPrimal boolean
        True if this is a primal beef cut
      • isBeefSubprimal boolean
        True if this is a subprimal beef cut
      • isBeefSubsection boolean
        True if this is a subsection beef cut
      • isBeefFabricatedCut boolean
        True if this is a fabricated beef cut
      • isLean boolean
        True if this is a lean beef cut
      • isMarinate boolean
        True if this beef cut is suggested to marinate
      • isRecipeIngredient boolean
        True if this beef cut is used in recipes
      • grocerySection array
        The grocery section this beef cut can be found in. Object values found in this array will be an exact match to what can be found in the master list of grocerySections in the common endpoint (/api/v2/common/lookups).
        • grocerySectionName string
          Name of the grocery section
        • grocerySectionNameSlug string
          URL-friendly slugged name of the grocery section
      • ingredientType object
        The type of ingredient. Object values found in this array will be an exact match to what can be found in the master list of ingredientTypes in the common endpoint (/api/v2/common/lookups).
        • ingredientTypeName string
          Name of the ingredient type
        • ingredientTypeNameSlug string
          URL-friendly slugged name of the ingredient type
      • showcaseNutrients array
        A list of nutrients from this beef cuts primary nutritional that we suggest to highlight
        • nutritionalType string
          The type of nutritional. This will be "raw" or "cooked"
        • usdaNutrient object
          The USDA nutrient object for the given nutrient. Object values found in this array will be an exact match to what can be found in the master list of usdaNutrients in the common endpoint (/api/v2/common/lookups)
          • usdaNutrientGroup string
            The food group of the nutrient
          • nutrientDisplayName string
            The display name of the nutrient
          • nutrientDisplayNameSlug string
            URL-friendly slugged name of the nutrient
        • unitOfMeasureValue decimal
          The calculated unit of measure for the given nutrient
        • unitOfMeasure string
          The unit of measure for the given nutrient
        • dailyValueCalculation decimal
          The calculated daily value for this nutrient
        • sortOrder int
          The preferred sort order for display of this nutrient
        • isGoodSource boolean
          If the unitOfMeasureValue meets that USDA requirements for a "good" source of the given nutrient, this field will be true, else it will be false
        • isExcellentSource boolean
          If the unitOfMeasureValue meets that USDA requirements for an "excellent" source of the given nutrient, this field will be true, else it will be false
      • attributes array
        A list of attributes by type that pertain to this beef cut. Object values found in this array will be an exact match to what can be found in the master list of attributesByTypes in the common endpoint (/api/v2/common/lookups).
        • attributeTypeName string
          Name of the attribute type
        • attributeTypeNameSlug string
          URL-friendly name of the attribute type
        • objectType array
          The type object this attribute type pertains to. Object values found in this array will be an exact match to what can be found in the master list of object type in the common endpoint (/api/v2/common/lookups)
          • objectTypeName string
            The name of the object type this attribute type pertains to
          • objectTypeNameSlug string
            URL-friendly slugged name of the type of object this attribute type pertains to
        • attributes array
          A list of attributes that pertain to this beef cut attribute type
          • attributeName string
            Name of the attribute
          • attributeNameSlug string
            URL-friendly name of the attribute
      • media array
        A list of media objects containing information about media assigned to this beef cut.
        • widenURL string
          This is the base part of the URL that is needed to build the embed link
        • widenUID string
          This is the customer userid part of the URL that is needed to build the embed link
        • externalID string
          This is the unique identifier of the media item
        • filename string
          This is the filename of the media item
        • title string
          This is the title of the media item
        • caption string
          This is the caption used for the media item
        • mediaGroup array
          Media will always be returned grouped and sorted. Use this grouping to help manage any groupings that may be suggested from the BeefAPI. Object values found in this array will be an exact match to what can be found in the master list of mediaGroups in the common endpoint (/api/v2/common/lookups)
          • mediaGroupName string
            Name of the media group
          • mediaGroupNameSlug string
            URL-friendly slugged name of the media group
          • objectType array
            The type object this media group pertains to. Object values found in this array will be an exact match to what can be found in the master list of objectTypes in the common endpoint (/api/v2/common/lookups)
            • objectTypeName string
              The name of the object type
            • objectTypeNameSlug string
              URL-friendly name of the object type
          • mediaType string
            The type of media returned
          • sortOrder int
            The suggested sort order to be used for this media item
          • links array
            A list HATEOAS for this media item that is a link to view the media in its original size.
            • rel string
              The rel attribute specifies the relationship between the current document and the linked document.
            • href string
              URI of the beefapi call to get more information for this links' context.
            • title string
              Title of the link.
      • links array
        A list of HATEOAS in relation to this beef cut. Typically if this beef cut is online, you will be provided with a link to the endpoint to get the full beef cut details. You will also be provided a link to get all the recipes that use this beef cut.
        • rel string
          The rel attribute specifies the relationship between the current document and the linked document
        • href string
          URI of the beefapi call to get more information for this links' context
        • title string
          Title of the link
    • searchCriteria object
      An object representing the search parameters that were passed into the search beef cuts API call.
      • searchText string
        The search will look for this text anywhere in the beef cut model.
      • beefCategories array
        A list of beef categories that the beef cut may contain. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='beef-category'. Any values that are not an exact match to this field may return unexpected results.
      • collections array
        A list of collections that the beef cut may be found in. Values in this array must be an exact match to the common/lookups collections. Any values that are not an exact match to this field may return unexpected results.
      • preferredCookingMethods array
        A list of cooking methods that the beef cut may contain. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='preferred-cooking-method'. Any values that are not an exact match to this field may return unexpected results.
      • ingredientGroups array
        A list of ingredient groups that the beef cut may belong to. Values in this array must be an exact match to the common/lookups IngredientGroups. Any values that are not an exact match to this field may return unexpected results.
      • parentIngredients array
        A list of ingredientNameSlug values that a beef cut may be a descendent of. Values in this array must be an exact match an online beef cut. Any values that are not an exact match to this field may return unexpected results.
      • primals array
        A list of ingredientNameSlug values that a beef cut may be a descendent of. Values in this array must be an exact match to the common/lookups ingredientPrimals. Any values that are not an exact match to this field may return unexpected results.
      • upcNumber string
        Search criteria will search the database for a matching Universal Product Code(UPC) number.
      • nampNumber string
        Search criteria will search the database for a matching IMPS/NAMP number.
      • isLean boolean
        Search criteria to look for lean or not lean beef cuts.
      • isMarinate boolean
        Search criteria to look for marinate or not marinate beef cuts.
      • pageNumber int
        Used in conjunction with the itemsPerPage parameter to manage paging in a search. This will default to page 1 if no value is provided.
      • itemsPerPage int
        Used in conjunction with the pageNumber parameter to manage paging in a search. This will default to 10 if no value is provided. The maximum items per page is 50.
    • totalCount int
      Estimated total count of items that match the search criteria
    • curPage int
      The current page of the search results
    • itemsPerPage object
      The current items per page used in returning the search results
    • links array
      A list of HATEOAS in relation to this search call.
      • rel string
        The rel attribute specifies the relationship between the current document and the linked document
      • href string
        URI of the beefapi call to get more information for this links' context
      • title string
        Title of the link