ProductGroup Object

A ProductGroup represents a group of Products that vary only in certain well-described ways, such as by size, color, material etc.

Modeled based on https://schema.org/ProductGroup We welcome your feedback. Please use the Improvement Requests form.

Attributes

Name
Type
Description

id

String

The Object ID

at_context

String

Stand-In for JSON-LD @context - your UI is expected to change it to valid JSON-LD @context filed name. Value is set to "https://schema.org"

at_type

String

Stand-In for JSON-LD @type - your UI is expected to change it to valid JSON-LD @type filed name. Value is set to "ProductGroup"

identifier

String

The identifier property represents any kind of identifier for any kind of Product

image

String

An image of the item. This can be a URL

name

Object name

description

Object description

url

String

URL of the Product

hasVariant

Array of String

Indicates a Product that is a member of this ProductGroup. Inverse property: isVariantOf

productGroupID

String

Indicates a textual identifier for a ProductGroup.

variesBy

Array of String

Indicates the property or properties by which the variants in a ProductGroup vary, e.g. their size, color etc. Schema.org properties can be referenced by their short name e.g. "color"; terms defined elsewhere can be referenced with their URIs.

aggregateRating

The overall rating, based on a collection of reviews or ratings, of the item.

asin

String

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).

audience

Audience Object

An intended audience, i.e. a group for whom something was created. Supersedes serviceAudience.

award

String

An award won by or for this item.

brand

String

The brand associated with a product or service, or the brand maintained by an organization or business person. URL to the Brand or Brand name

category

Array of String

A list of categories for the Product.

color

String

The color of the product

colorSwatch

String

A color swatch image, visualizing the color of a Product. Should match the textual description specified in the color property. This can be a URL or a fully described ImageObject.

countryOfAssembly

String

The place where the product was assembled. ISO 3166

countryOfLastProcessing

String

The place where the item (typically Product) was last processed and tested before importation. ISO 3155

countryOfOrigin

Object

The country of origin of something, including products as well as creative works such as movie and TV content.

In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of CreativeWork it is difficult to provide fully general guidance, and properties such as contentLocation and locationCreated may be more applicable.

In the case of products, the country of origin of the product. ISO 3166

depth

The depth of the item.

funding

String

A Grant that directly or indirectly provide funding or sponsorship for this item. See also ownershipFundingInfo.

gtin

String

A Global Trade Item Number (GTIN). GTINs identify trade items, including products and services, using numeric identification codes.

The GS1 digital link specifications express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also schema.org tracking issue for schema.org-specific discussion. 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.

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

String

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

String

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

String

The GTIN-14 code of the product, or the product to which the offer refers. See GS1 GTIN Summary for more details.

gtin8

String

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

Array of String

Used to tag an item to be intended or suitable for consumption or use by adults only. Use AdultOrientedEnumeration

hasCertification

Array of String

Certification information about a product, organization, service, place, or person.

hasEnergyConsumptionDetails

Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard.

hasGS1DigitalLink

String

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 Product.

hasMeasurement

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. QuantitativeValue

hasMerchantReturnPolicy

Specifies a MerchantReturnPolicy that may be applicable. Supersedes hasProductReturnPolicy.

height

The height of the item.

inProductGroupWithID

String

Indicates the productGroupID for a ProductGroup that this product isVariantOf.

isAccessoryOrSparePartFor

Array of String

A pointer to another product (or multiple products) for which this product is an accessory or spare part. Product

isConsumableFor

Array of String

A pointer to another product (or multiple products) for which this product is a consumable. Product

isFamilyFriendly

Boolean

Indicates whether this content is family friendly.

isRelatedTo

Array of String

A pointer to another, somehow related product (or multiple products). Product or Service

isSimilarTo

Array of String

A pointer to another, functionally similar product (or multiple products). Product or Service

isVariantOf

String

Indicates the kind of product that this is a variant of. In the case of ProductModel, this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a ProductGroup, the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with ProductGroup, this property can apply to any Product included in the group. Inverse property: hasVariant. ProductGroup or ProductModel

itemCondition

String

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. Use OfferItemCondition

keywords

Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.

logo

String

An associated logo.

manufacturer

String

The manufacturer of the product.

material

Array of String

The material(s) that something is made from, e.g. leather, wool, cotton, paper.

mobileUrl

String

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.

model

String

The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.

mpn

String

The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.

negativeNotes

Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside positiveNotes). For symmetry

In the case of a Review, the property describes the itemReviewed from the perspective of the review; in the case of a Product, the product itself is being described. Since product descriptions tend to emphasise positive claims, it may be relatively unusual to find negativeNotes used in this way. Nevertheless for the sake of symmetry, negativeNotes can be used on Product.

The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most negative is at the beginning of the list).

nsn

String

Indicates the NATO stock number (nsn) of a Product.

offers

Array of String

The URL(s) to offers to provide this product—for example, an offer to sell a product.

pattern

A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.

positiveNotes

Provides positive considerations regarding something, for example product highlights or (alongside negativeNotes) pro/con lists for reviews.

In the case of a Review, the property describes the itemReviewed from the perspective of the review; in the case of a Product, the product itself is being described.

The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most positive is at the beginning of the list).

productID

String

The product identifier, such as ISBN. For example: meta itemprop="productID" content="isbn:123-456-789".

productionDate

DateTime

The date of production of the item, e.g. vehicle. Date ISO 8601

purchaseDate

DateTime

The date the item, e.g. vehicle, was purchased by the current owner. ISO 8601

releaseDate

DateTime

The release date of a product or product model. This can be used to distinguish the exact variant of a product. ISO 8601

review

Array of String

URLs to reviews of the product.

size

A standardized size of a product

sku

String

The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.

slogan

A slogan or motto associated with the item.

weight

The weight of the product or person. QuantitativeValue

width

The width of the item. Distance or QuantitativeValue

tags

Array of Tag

Array of Tag

meta

Object Meta

Meta object

Last updated

Was this helpful?