Note: You are viewing the development version of Schema.org. See how we work for more details.

AggregateOffer

A Schema.org Type
When a single product is associated with multiple offers (for example, the same pair of shoes is offered by different merchants), then AggregateOffer can be used.

Note: AggregateOffers are normally expected to associate multiple offers that all share the same defined businessFunction value, or default to http://purl.org/goodrelations/v1#Sell if businessFunction is not explicitly defined.
PropertyExpected TypeDescription
Properties from AggregateOffer
highPrice Number  or
Text
The highest price of all offers available.

Usage guidelines:

  • Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
  • Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
lowPrice Number  or
Text
The lowest price of all offers available.

Usage guidelines:

  • Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
  • Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
offerCount Integer The number of offers for the product.
offers Demand  or
Offer
An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use businessFunction to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a Demand. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
Inverse property: itemOffered
Properties from Offer
acceptedPaymentMethod LoanOrCredit  or
PaymentMethod
The payment method(s) that are accepted in general by an organization, or for some specific demand or offer.
addOn Offer An additional offer that can only be obtained in combination with the first base offer (e.g. supplements and extensions that are available for a surcharge).
additionalProperty PropertyValue A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.

Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
advanceBookingRequirement QuantitativeValue The amount of time that is required between accepting the offer and the actual usage of the resource or service.
aggregateRating AggregateRating The overall rating, based on a collection of reviews or ratings, of the item.
areaServed AdministrativeArea  or
GeoShape  or
Place  or
Text
The geographic area where a service or offered item is provided. Supersedes serviceArea.
asin Text  or
URL
An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from Wikipedia's article).

Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details. ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.
availability ItemAvailability The availability of this item—for example In stock, Out of stock, Pre-order, etc.
availabilityEnds Date  or
DateTime  or
Time
The end of the availability of the product or service included in the offer.
availabilityStarts Date  or
DateTime  or
Time
The beginning of the availability of the product or service included in the offer.
availableAtOrFrom Place The place(s) from which the offer can be obtained (e.g. store locations).
availableDeliveryMethod DeliveryMethod The delivery method(s) available for this offer.
businessFunction BusinessFunction The business function (e.g. sell, lease, repair, dispose) of the offer or component of a bundle (TypeAndQuantityNode). The default is http://purl.org/goodrelations/v1#Sell.
category CategoryCode  or
PhysicalActivityCategory  or
Text  or
Thing  or
URL
A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
checkoutPageURLTemplate Text A URL template (RFC 6570) for a checkout page for an offer. This approach allows merchants to specify a URL for online checkout of the offered product, by interpolating parameters such as the logged in user ID, product ID, quantity, discount code etc. Parameter naming and standardization are not specified here.
deliveryLeadTime QuantitativeValue The typical delay between the receipt of the order and the goods either leaving the warehouse or being prepared for pickup, in case the delivery method is on site pickup.
eligibleCustomerType BusinessEntityType The type(s) of customers for which the given offer is valid.
eligibleDuration QuantitativeValue The duration for which the given offer is valid.
eligibleQuantity QuantitativeValue The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity.
eligibleRegion GeoShape  or
Place  or
Text
The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is valid.

See also ineligibleRegion.
eligibleTransactionVolume PriceSpecification The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount.
gtin Text  or
URL
A Global Trade Item Number (GTIN). GTINs identify trade items, including products and services, using numeric identification codes.

A correct gtin value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a valid GS1 check digit and meet the other rules for valid GTINs. See also GS1's GTIN Summary and Wikipedia for more details. Left-padding of the gtin values is not required or encouraged. The gtin property generalizes the earlier gtin8, gtin12, gtin13, and gtin14 properties.

The GS1 digital link specifications expresses GTINs as URLs (URIs, IRIs, etc.). Digital Links should be populated into the hasGS1DigitalLink attribute.

Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.
gtin12 Text The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See GS1 GTIN Summary for more details.
gtin13 Text The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See GS1 GTIN Summary for more details.
gtin14 Text The GTIN-14 code of the product, or the product to which the offer refers. See GS1 GTIN Summary for more details.
gtin8 Text The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See GS1 GTIN Summary for more details.
hasAdultConsideration AdultOrientedEnumeration Used to tag an item to be intended or suitable for consumption or use by adults only.
hasGS1DigitalLink URL The GS1 digital link associated with the object. This URL should conform to the particular requirements of digital links. The link should only contain the Application Identifiers (AIs) that are relevant for the entity being annotated, for instance a Product or an Organization, and for the correct granularity. In particular, for products:
  • A Digital Link that contains a serial number (AI 21) should only be present on instances of IndividualProduct
  • A Digital Link that contains a lot number (AI 10) should be annotated as SomeProduct if only products from that lot are sold, or IndividualProduct if there is only a specific product.
  • A Digital Link that contains a global model number (AI 8013) should be attached to a Product or a ProductModel.
Other item types should be adapted similarly.
hasMeasurement QuantitativeValue A measurement of an item, For example, the inseam of pants, the wheel size of a bicycle, the gauge of a screw, or the carbon footprint measured for certification by an authority. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.
hasMerchantReturnPolicy MerchantReturnPolicy Specifies a MerchantReturnPolicy that may be applicable. Supersedes hasProductReturnPolicy.
includesObject TypeAndQuantityNode This links to a node or nodes indicating the exact quantity of the products included in an Offer or ProductCollection.
ineligibleRegion GeoShape  or
Place  or
Text
The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.

See also eligibleRegion.
inventoryLevel QuantitativeValue The current approximate inventory level for the item or items.
isFamilyFriendly Boolean Indicates whether this content is family friendly.
itemCondition OfferItemCondition A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns.
itemOffered AggregateOffer  or
CreativeWork  or
Event  or
MenuItem  or
Product  or
Service  or
Trip
An item being offered (or demanded). The transactional nature of the offer or demand is documented using businessFunction, e.g. sell, lease etc. While several common expected types are listed explicitly in this definition, others can be used. Using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
Inverse property: offers
leaseLength Duration  or
QuantitativeValue
Length of the lease for some Accommodation, either particular to some Offer or in some cases intrinsic to the property.
mobileUrl Text The mobileUrl property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.

To discourage over-use, and reflecting intial usecases, the property is expected only on Product and Offer, rather than Thing. The general trend in web technology is towards responsive design in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established url property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all url markup to use mobileUrl for more mobile-oriented pages. The property is intended for the case when items (primarily Product and Offer) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style.
mpn Text The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.
offeredBy Organization  or
Person
A pointer to the organization or person making the offer.
Inverse property: makesOffer
price Number  or
Text
The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.

Usage guidelines:

  • Use the priceCurrency property (with standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR") instead of including ambiguous symbols such as '$' in the value.
  • Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
  • Note that both RDFa and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.
  • Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
priceCurrency Text The currency of the price, or a price component when attached to PriceSpecification and its subtypes.

Use standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR".
priceSpecification PriceSpecification One or more detailed price specifications, indicating the unit price and delivery or payment charges.
priceValidUntil Date The date after which the price is no longer available.
review Review A review of the item. Supersedes reviews.
seller Organization  or
Person
An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider. Supersedes merchant, vendor.
serialNumber Text The serial number or any alphanumeric identifier of a particular product. When attached to an offer, it is a shortcut for the serial number of the product included in the offer.
shippingDetails OfferShippingDetails Indicates information about the shipping policies and options associated with an Offer.
sku Text The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.
validFrom Date  or
DateTime
The date when the item becomes valid.
validThrough Date  or
DateTime
The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.
warranty WarrantyPromise The warranty promise(s) included in the offer. Supersedes warrantyPromise.
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 AggregateOffer may appear as a value for the following properties
PropertyOn TypesDescription
itemOffered Demand  or
Offer
An item being offered (or demanded). The transactional nature of the offer or demand is documented using businessFunction, e.g. sell, lease etc. While several common expected types are listed explicitly in this definition, others can be used. Using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.

Examples

Example 1
Copied
Example notes or example HTML without markup.
<img src="dell-30in-lcd.jpg" alt="A Dell UltraSharp monitor" />
Dell UltraSharp 30" LCD Monitor

87 out of 100 based on 24 user ratings

$1250 to $1495 from 8 sellers

Sellers:
<a href="save-a-lot-monitors.com/dell-30.html">
  Save A Lot Monitors - $1250</a>
<a href="jondoe-gadgets.com/dell-30.html">
  Jon Doe's Gadgets - $1350</a>
...
Example encoded as Microdata embedded in HTML.
<div itemscope itemtype="https://schema.org/Product">
  <img itemprop="image" src="dell-30in-lcd.jpg" alt="A Dell UltraSharp monitor"/>
  <span itemprop="name">Dell UltraSharp 30" LCD Monitor</span>

  <div itemprop="aggregateRating"
    itemscope itemtype="https://schema.org/AggregateRating">
    <span itemprop="ratingValue">87</span>
    out of <span itemprop="bestRating">100</span>
    based on <span itemprop="ratingCount">24</span> user ratings
  </div>

  <div itemprop="offers" itemscope itemtype="https://schema.org/AggregateOffer">
    <meta itemprop="priceCurrency" content="USD" />
    <span itemprop="lowPrice" content="1250">$1250</span>
    to <span itemprop="highPrice" content="1495">$1495</span>
    from <span itemprop="offerCount">8</span> sellers

    Sellers:
    <div itemprop="offers" itemscope itemtype="https://schema.org/Offer">
        <a itemprop="url" href="save-a-lot-monitors.com/dell-30.html">
        Save A Lot Monitors - $1250</a>
    </div>
    <div itemprop="offers" itemscope itemtype="https://schema.org/Offer">
        <a itemprop="url" href="jondoe-gadgets.com/dell-30.html">
        Jon Doe's Gadgets - $1350</a>
    </div>
  </div>
  ...
</div>
Example encoded as RDFa embedded in HTML.
<div vocab="https://schema.org/" typeof="Product">
    <img property="image" src="dell-30in-lcd.jpg" alt="A Dell UltraSharp monitor"> <span property="name">Dell UltraSharp 30" LCD Monitor</span>
    <div property="aggregateRating" typeof="AggregateRating">
        <span property="ratingValue">87</span> out of
        <span property="bestRating">100</span> based on
        <span property="ratingCount">24</span> user ratings
    </div>
    <div property="offers" typeof="AggregateOffer">
        <meta property="priceCurrency" content="USD" />
        <span property="lowPrice" content="1250">$1250</span> to
        <span property="highPrice" content="1495">$1495</span> from
        <span property="offerCount">8</span> sellers Sellers:
        <div property="offers" typeof="Offer">
            <a property="url" href="save-a-lot-monitors.com/dell-30.html">Save A Lot Monitors - $1250</a>
        </div>
        <div property="offers" typeof="Offer">
            <a property="url" href="jondoe-gadgets.com/dell-30.html">Jon Doe's Gadgets - $1350</a>
        </div>
        ...
    </div>
</div>
Example encoded as JSON-LD in a HTML script tag.
<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "Product",
  "aggregateRating": {
    "@type": "AggregateRating",
    "bestRating": "100",
    "ratingCount": "24",
    "ratingValue": "87"
  },
  "image": "dell-30in-lcd.jpg",
  "name": "Dell UltraSharp 30\" LCD Monitor",
  "offers": {
    "@type": "AggregateOffer",
    "priceCurrency": "USD",
    "highPrice": "1495",
    "lowPrice": "1250",
    "offerCount": "8",
    "offers": [
      {
        "@type": "Offer",
        "url": "save-a-lot-monitors.com/dell-30.html"
      },
      {
        "@type": "Offer",
        "url": "jondoe-gadgets.com/dell-30.html"
      }
    ]
  }
}
</script>
Structured representation of the JSON-LD example.
Example 2
Copied
Example notes or example HTML without markup.
<a href="nba-miami-philidelphia-game3.html">
NBA Eastern Conference First Round Playoff Tickets:
 Miami Heat at Philadelphia 76ers - Game 3 (Home Game 1)
</a>

Thu, 04/21/16
8:00 p.m.

<a href="wells-fargo-center.html">
Wells Fargo Center
</a>
Philadelphia, PA

Priced from: $35
1938 tickets left
Example encoded as Microdata embedded in HTML.
<div itemscope itemtype="https://schema.org/Event">
  <a itemprop="url" href="nba-miami-philidelphia-game3.html">
  NBA Eastern Conference First Round Playoff Tickets:
  <span itemprop="name"> Miami Heat at Philadelphia 76ers - Game 3 (Home Game 1) </span>
  </a>

  <meta itemprop="startDate" content="2016-04-21T20:00">
    Thu, 04/21/16
    8:00 p.m.

  <div itemprop="location" itemscope itemtype="https://schema.org/Place">
    <a itemprop="url" href="wells-fargo-center.html">
    Wells Fargo Center
    </a>
    <div itemprop="address" itemscope itemtype="https://schema.org/PostalAddress">
      <span itemprop="addressLocality">Philadelphia</span>,
      <span itemprop="addressRegion">PA</span>
    </div>
  </div>

  <div itemprop="offers" itemscope itemtype="https://schema.org/AggregateOffer">
  <meta itemprop="priceCurrency" content="USD" />
    Priced from: <span itemprop="lowPrice" content="35">$35</span>
    <span itemprop="offerCount">1938</span> tickets left
  </div>
</div>
Example encoded as RDFa embedded in HTML.
<div vocab="https://schema.org/" typeof="Event">
  <a property="url" href="nba-miami-philidelphia-game3.html">
  NBA Eastern Conference First Round Playoff Tickets:
  <span property="name"> Miami Heat at Philadelphia 76ers - Game 3 (Home Game 1) </span>
  </a>

  <meta property="startDate" content="2016-04-21T20:00">
    Thu, 04/21/16
    8:00 p.m.

  <div property="location" typeof="Place">
    <a property="url" href="wells-fargo-center.html">
    Wells Fargo Center
    </a>
    <div property="address" typeof="PostalAddress">
      <span property="addressLocality">Philadelphia</span>,
      <span property="addressRegion">PA</span>
    </div>
  </div>

  <div property="offers" typeof="AggregateOffer">
    <meta property="priceCurrency" content="USD" />
    Priced from: <span property="lowPrice" content="35">$35</span>
    <span property="offerCount">1938</span> tickets left
  </div>
</div>
Example encoded as JSON-LD in a HTML script tag.
<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "Event",
  "name": "Miami Heat at Philadelphia 76ers - Game 3 (Home Game 1)",
  "location": {
    "@type": "Place",
    "address": {
      "@type": "PostalAddress",
      "addressLocality": "Philadelphia",
      "addressRegion": "PA"
    },
    "url": "wells-fargo-center.html"
  },
  "offers": {
    "@type": "AggregateOffer",
    "priceCurrency": "USD",
    "lowPrice": "35",
    "offerCount": "1938"
  },
  "startDate": "2016-04-21T20:00",
  "url": "nba-miami-philidelphia-game3.html"
}
</script>
Structured representation of the JSON-LD example.