ItemList

Breadcrumb: Thing > Intangible > ItemList

A list of items of any sort—for example, Top 10 Movies About Weathermen, or Top 100 Party Songs. Not to be confused with HTML lists, which are often used only for formatting.

Parent types

Intangible

Properties

Properties for ItemList

Property	Expected type	Defined on	Description
aggregateElement	Thing	ItemList	Indicates a prototype of the elements in the list that is used to hold aggregate information (ratings, offers, etc.).
itemListElement	ListItem, Text, Thing	ItemList	For itemListElement values, you can use simple strings (e.g. "Peter", "Paul", "Mary"), existing entities, or use ListItem. Text values are best if the elements in the list are plain strings. Existing entities are best for a simple, unordered list of existing things in your data. ListItem is used with ordered lists when you want to provide additional context about the element in that list or when the same item might be in different places in different lists. Note: The order of elements in your mark-up is not sufficient for indicating the order or elements. Use ListItem with a 'position' property in such cases.
itemListOrder	ItemListOrderType, Text	ItemList	Type of ordering (e.g. Ascending, Descending, Unordered).
numberOfItems	Integer	ItemList	The number of items in an ItemList. Note that some descriptions might not fully describe all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems would be for the entire list.

Inherited properties

Property	Expected type	Inherited from	Description
additionalType	Text, URL	Thing	An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide.
alternateName	Text	Thing	An alias for the item.
description	Text, TextObject	Thing	A description of the item.
disambiguatingDescription	Text	Thing	A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier	PropertyValue, Text, URL	Thing	The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.
image	ImageObject, URL	Thing	An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage	CreativeWork, URL	Thing	Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
name	Text	Thing	The name of the item.
owner	Organization, Person	Thing	A person or organization who owns this Thing.
potentialAction	Action	Thing	Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs	URL	Thing	URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
subjectOf	CreativeWork, Event	Thing	A CreativeWork or Event about this Thing.
url	URL	Thing	URL of the item.

Sub-types

BreadcrumbList, HowToSection, HowToStep, OfferCatalog

Example

{
  "@context": "https://schema.org",
  "@type": "ItemList",
  "name": "Example Name",
  "description": "A short description.",
  "url": "/example",
  "aggregateElement": "Example value",
  "itemListElement": "Example value"
}