GET Beef Cut Collections By List

Calls to this endpoint will return a summary list of the beef cut collections based on a given list of collection IDs.

The base URI for Get beef cut collections by list is:

GET /api/v2/beefcut/collection/list

Get Beef Cut Collections By List Parameters

Try This Endpoint on Swagger
Name Required Parameter Type Data Type
collectionIDList path array
  An array or comma delimited list of collection ID's. These values must be integers.
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 Get beef cut collections by list will return the following data:

Name & Description Type
  • BeefAPICollectionSummaryListing object
    A container that holds the list of collections.
    • collectionListing array
      A list of beef cut collections summary objects
      • collectionID int
        Unique identifier of the collection.
      • collectionName string
        Name of the collection.
      • collectionNameSlug string
        URL-friendly slugged name of the collection.
      • collectionGroup object
        Contains information about the group to which the collection belongs. Object values found in this array will be an exact match to what can be found in the master list of collection groups in the common endpoint (/api/v2/common/lookups).
        • collectionGroupName string
          Name of the collection group.
        • collectionGroupNameSlug string
          URL-friendly name of the collection group.
        • objectType object
          The type object this collection 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 this collection group pertains to.
          • objectTypeNameSlug string
            URL-friendly slugged name of the object type this collection group pertains to.
      • objectType object
        The type object this collection 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 this collection group pertains to.
        • objectTypeNameSlug string
          URL-friendly slugged name of the object type this collection group pertains to.
      • tagline string
        Short, concise description of the collection.
      • description string
        Text used to describes the contents and use of the collection.
      • estimatedItemCount int
        An estimated count of beef cuts that are included in this collection.
      • media array
        A list of media objects containing information about media assigned to this collection.
        • 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 object
          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 object
            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 collection. Typically if this collection is online, you will be provided with a link to the endpoint to get the full collection details.
        • 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.