OfferCatalog
A Schema.org Type
- Canonical URL: https://schema.org/OfferCatalog
- Check for open issues.
An OfferCatalog is an ItemList that contains related Offers and/or further OfferCatalogs that are offeredBy the same provider.
Property | Expected Type | Description |
---|---|---|
Properties from ItemList | ||
itemListElement |
ListItem or Text or Thing |
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 or Text |
Type of ordering (e.g. Ascending, Descending, Unordered). |
numberOfItems |
Integer | 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. |
Properties from Thing | ||
additionalType |
Text or URL |
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 | An alias for the item. |
description |
Text or TextObject |
A description of the item. |
disambiguatingDescription |
Text | 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 or Text or URL |
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 or URL |
An image of the item. This can be a URL or a fully described ImageObject. |
mainEntityOfPage |
CreativeWork or URL |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
Inverse property: mainEntity |
name |
Text | The name of the item. |
potentialAction |
Action | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
sameAs |
URL | 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 or Event |
A CreativeWork or Event about this Thing.
Inverse property: about |
url |
URL | URL of the item. |
Instances of
OfferCatalog may appear as a value for the following properties
Property | On Types | Description |
---|---|---|
hasOfferCatalog |
Organization or Person or Service |
Indicates an OfferCatalog listing for this Organization, Person, or Service. |
Examples
Example 1
Copied
Example notes or example HTML without markup.
ACME Home Cleaning offers a variety of services in Massachusetts, including: <ul> <li>House cleaning</li> <ul> <li>Apartment light cleaning</li> <li>House light cleaning up to 2 bedrooms</li> <li>House light cleaning 3+ bedrooms</li> </ul> <li>One-time services</li> <ul> <li>Window washing</li> <li>Carpet deep cleaning</li> <li>Move in/out cleaning</li> </ul> </ul>
Example encoded as Microdata embedded in HTML.
<div itemscope itemtype="https://schema.org/Service"> <meta itemprop="serviceType" content="Home cleaning" /> <span itemprop="provider" itemscope itemtype="https://schema.org/LocalBusiness"> <span itemprop="name">ACME Home Cleaning</span> </span> offers a variety of services in <span itemprop="areaServed" itemscope itemtype="https://schema.org/State"> <span itemprop="name">Massachusetts</span>, including </span> <ul itemprop="hasOfferCatalog" itemscope itemtype="https://schema.org/OfferCatalog"> <li itemprop="itemListElement" itemscope itemtype="https://schema.org/OfferCatalog"> <span itemprop="name">House cleaning</span> <ul itemprop="itemListElement" itemscope itemtype="https://schema.org/OfferCatalog"> <li itemprop="itemListElement" itemscope itemtype="https://schema.org/Offer"> <div itemprop="itemOffered" itemscope itemtype="https://schema.org/Service"> <span itemprop="name">Apartment light cleaning</span> </div> </li> <li itemprop="itemListElement" itemscope itemtype="https://schema.org/Offer"> <div itemprop="itemOffered" itemscope itemtype="https://schema.org/Service"> <span itemprop="name">House light cleaning up to 2 bedrooms</span> </div> </li> <li itemprop="itemListElement" itemscope itemtype="https://schema.org/Offer"> <div itemprop="itemOffered" itemscope itemtype="https://schema.org/Service"> <span itemprop="name">House light cleaning 3+ bedrooms</span> </div> </li> </ul> <li itemprop="itemListElement" itemscope itemtype="https://schema.org/OfferCatalog"> <span itemprop="name">One-time services</span> <ul itemprop="itemListElement" itemscope itemtype="https://schema.org/OfferCatalog"> <li itemprop="itemListElement" itemscope itemtype="https://schema.org/Offer"> <div itemprop="itemOffered" itemscope itemtype="https://schema.org/Service"> <span itemprop="name">Window washing</span> </div> </li> <li itemprop="itemListElement" itemscope itemtype="https://schema.org/Offer"> <div itemprop="itemOffered" itemscope itemtype="https://schema.org/Service"> <span itemprop="name">Carpet deep cleaning</span> </div> </li> <li itemprop="itemListElement" itemscope itemtype="https://schema.org/Offer"> <div itemprop="itemOffered" itemscope itemtype="https://schema.org/Service"> <span itemprop="name">Move in/out cleaning</span> </div> </li> </ul> </li> </ul> </div>
Example encoded as RDFa embedded in HTML.
<div vocab="https://schema.org/" typeof="Service"> <meta property="serviceType" content="Home cleaning" /> <span property="provider" typeof="LocalBusiness"> <span property="name">ACME Home Cleaning</span> </span> offers a variety of services in <span property="areaServed" typeof="State"> <span property="name">Massachusetts</span>, including </span> <ul property="hasOfferCatalog" typeof="OfferCatalog"> <li property="itemListElement" typeof="OfferCatalog"> <span property="name">House cleaning</span> <ul property="itemListElement" typeof="OfferCatalog"> <li property="itemListElement" typeof="Offer"> <div property="itemOffered" typeof="Service"> <span property="name">Apartment light cleaning</span> </div> </li> <li property="itemListElement" typeof="Offer"> <div property="itemOffered" typeof="Service"> <span property="name">House light cleaning up to 2 bedrooms</span> </div> </li> <li property="itemListElement" typeof="Offer"> <div property="itemOffered" typeof="Service"> <span property="name">House light cleaning 3+ bedrooms</span> </div> </li> </ul> <li property="itemListElement" typeof="OfferCatalog"> <span property="name">One-time services</span> <ul property="itemListElement" typeof="OfferCatalog"> <li property="itemListElement" typeof="Offer"> <div property="itemOffered" typeof="Service"> <span property="name">Window washing</span> </div> </li> <li property="itemListElement" typeof="Offer"> <div property="itemOffered" typeof="Service"> <span property="name">Carpet deep cleaning</span> </div> </li> <li property="itemListElement" typeof="Offer"> <div property="itemOffered" typeof="Service"> <span property="name">Move in/out cleaning</span> </div> </li> </ul> </li> </ul> </div>
Example encoded as JSON-LD in a HTML script tag.
<script type="application/ld+json"> { "@context": "https://schema.org/", "@type": "Service", "serviceType": "Weekly home cleaning", "provider": { "@type": "LocalBusiness", "name": "ACME Home Cleaning" }, "areaServed": { "@type": "State", "name": "Massachusetts" }, "hasOfferCatalog": { "@type": "OfferCatalog", "name": "Cleaning services", "itemListElement": [ { "@type": "OfferCatalog", "name": "House Cleaning", "itemListElement": [ { "@type": "Offer", "itemOffered": { "@type": "Service", "name": "Apartment light cleaning" } }, { "@type": "Offer", "itemOffered": { "@type": "Service", "name": "House light cleaning up to 2 bedrooms" } }, { "@type": "Offer", "itemOffered": { "@type": "Service", "name": "House light cleaning 3+ bedrooms" } } ] }, { "@type": "OfferCatalog", "name": "One-time services", "itemListElement": [ { "@type": "Offer", "itemOffered": { "@type": "Service", "name": "Window washing" } }, { "@type": "Offer", "itemOffered": { "@type": "Service", "name": "Carpet cleaning" } }, { "@type": "Offer", "itemOffered": { "@type": "Service", "name": "Move in/out cleaning" } } ] } ] } } </script>
Structured representation of the JSON-LD example.