Looking for help!
NAME
SemanticWeb::Schema::Product - Any offered product or service
VERSION
version v23.0.0
DESCRIPTION
Any offered product or service. For example: a pair of shoes; a concert ticket; the rental of a car; a haircut; or an episode of a TV show streamed online.
ATTRIBUTES
additional_property
additionalProperty
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. http://schema.org/width, http://schema.org/color, http://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
A additional_property should be one of the following types:
_has_additional_property
A predicate for the "additional_property" attribute.
aggregate_rating
aggregateRating
The overall rating, based on a collection of reviews or ratings, of the item.
A aggregate_rating should be one of the following types:
_has_aggregate_rating
A predicate for the "aggregate_rating" attribute.
asin
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](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Nu mber)'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.
A asin should be one of the following types:
Str
_has_asin
A predicate for the "asin" attribute.
audience
An intended audience, i.e. a group for whom something was created.
A audience should be one of the following types:
_has_audience
A predicate for the "audience" attribute.
award
An award won by or for this item.
A award should be one of the following types:
Str
_has_award
A predicate for the "award" attribute.
awards
Awards won by or for this item.
A awards should be one of the following types:
Str
_has_awards
A predicate for the "awards" attribute.
brand
The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
A brand should be one of the following types:
_has_brand
A predicate for the "brand" attribute.
category
A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
A category should be one of the following types:
InstanceOf['SemanticWeb::Schema::CategoryCode']InstanceOf['SemanticWeb::Schema::PhysicalActivityCategory']InstanceOf['SemanticWeb::Schema::Thing']Str
_has_category
A predicate for the "category" attribute.
color
The color of the product.
A color should be one of the following types:
Str
_has_color
A predicate for the "color" attribute.
country_of_assembly
countryOfAssembly
The place where the product was assembled.
A country_of_assembly should be one of the following types:
Str
_has_country_of_assembly
A predicate for the "country_of_assembly" attribute.
country_of_last_processing
countryOfLastProcessing
The place where the item (typically SemanticWeb::Schema::Product) was last processed and tested before importation.
A country_of_last_processing should be one of the following types:
Str
_has_country_of_last_processing
A predicate for the "country_of_last_processing" attribute.
country_of_origin
countryOfOrigin
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 SemanticWeb::Schema::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. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
A country_of_origin should be one of the following types:
_has_country_of_origin
A predicate for the "country_of_origin" attribute.
depth
The depth of the item.
A depth should be one of the following types:
_has_depth
A predicate for the "depth" attribute.
funding
A SemanticWeb::Schema::Grant that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
A funding should be one of the following types:
_has_funding
A predicate for the "funding" attribute.
gtin
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.
A gtin should be one of the following types:
Str
_has_gtin
A predicate for the "gtin" attribute.
gtin12
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](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
A gtin12 should be one of the following types:
Str
_has_gtin12
A predicate for the "gtin12" attribute.
gtin13
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](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
A gtin13 should be one of the following types:
Str
_has_gtin13
A predicate for the "gtin13" attribute.
gtin14
The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
A gtin14 should be one of the following types:
Str
_has_gtin14
A predicate for the "gtin14" attribute.
gtin8
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](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
A gtin8 should be one of the following types:
Str
_has_gtin8
A predicate for the "gtin8" attribute.
has_adult_consideration
hasAdultConsideration
Used to tag an item to be intended or suitable for consumption or use by adults only.
A has_adult_consideration should be one of the following types:
_has_has_adult_consideration
A predicate for the "has_adult_consideration" attribute.
has_energy_consumption_details
hasEnergyConsumptionDetails
Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard.
A has_energy_consumption_details should be one of the following types:
_has_has_energy_consumption_details
A predicate for the "has_energy_consumption_details" attribute.
has_measurement
hasMeasurement
A product measurement, for example the inseam of pants, the wheel size of a bicycle, or the gauge of a screw. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.
A has_measurement should be one of the following types:
_has_has_measurement
A predicate for the "has_measurement" attribute.
has_merchant_return_policy
hasMerchantReturnPolicy
Specifies a MerchantReturnPolicy that may be applicable.
A has_merchant_return_policy should be one of the following types:
_has_has_merchant_return_policy
A predicate for the "has_merchant_return_policy" attribute.
has_product_return_policy
hasProductReturnPolicy
Indicates a ProductReturnPolicy that may be applicable.
A has_product_return_policy should be one of the following types:
_has_has_product_return_policy
A predicate for the "has_product_return_policy" attribute.
height
The height of the item.
A height should be one of the following types:
_has_height
A predicate for the "height" attribute.
in_product_group_with_id
inProductGroupWithID
Indicates the [[productGroupID]] for a SemanticWeb::Schema::ProductGroup that this product [[isVariantOf]].
A in_product_group_with_id should be one of the following types:
Str
_has_in_product_group_with_id
A predicate for the "in_product_group_with_id" attribute.
is_accessory_or_spare_part_for
isAccessoryOrSparePartFor
A pointer to another product (or multiple products) for which this product is an accessory or spare part.
A is_accessory_or_spare_part_for should be one of the following types:
_has_is_accessory_or_spare_part_for
A predicate for the "is_accessory_or_spare_part_for" attribute.
is_consumable_for
isConsumableFor
A pointer to another product (or multiple products) for which this product is a consumable.
A is_consumable_for should be one of the following types:
_has_is_consumable_for
A predicate for the "is_consumable_for" attribute.
is_family_friendly
isFamilyFriendly
Indicates whether this content is family friendly.
A is_family_friendly should be one of the following types:
Bool
_has_is_family_friendly
A predicate for the "is_family_friendly" attribute.
is_related_to
isRelatedTo
A pointer to another, somehow related product (or multiple products).
A is_related_to should be one of the following types:
_has_is_related_to
A predicate for the "is_related_to" attribute.
is_similar_to
isSimilarTo
A pointer to another, functionally similar product (or multiple products).
A is_similar_to should be one of the following types:
_has_is_similar_to
A predicate for the "is_similar_to" attribute.
is_variant_of
isVariantOf
Indicates the kind of product that this is a variant of. In the case of SemanticWeb::Schema::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 SemanticWeb::Schema::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 SemanticWeb::Schema::ProductGroup, this property can apply to any SemanticWeb::Schema::Product included in the group.
A is_variant_of should be one of the following types:
_has_is_variant_of
A predicate for the "is_variant_of" attribute.
item_condition
itemCondition
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.
A item_condition should be one of the following types:
_has_item_condition
A predicate for the "item_condition" attribute.
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.
A keywords should be one of the following types:
_has_keywords
A predicate for the "keywords" attribute.
logo
An associated logo.
A logo should be one of the following types:
_has_logo
A predicate for the "logo" attribute.
manufacturer
The manufacturer of the product.
A manufacturer should be one of the following types:
_has_manufacturer
A predicate for the "manufacturer" attribute.
material
A material that something is made from, e.g. leather, wool, cotton, paper.
A material should be one of the following types:
_has_material
A predicate for the "material" attribute.
mobile_url
mobileUrl
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 SemanticWeb::Schema::Product and SemanticWeb::Schema::Offer, rather than SemanticWeb::Schema::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 SemanticWeb::Schema::Product and SemanticWeb::Schema::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.
A mobile_url should be one of the following types:
Str
_has_mobile_url
A predicate for the "mobile_url" attribute.
model
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.
A model should be one of the following types:
_has_model
A predicate for the "model" attribute.
mpn
The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.
A mpn should be one of the following types:
Str
_has_mpn
A predicate for the "mpn" attribute.
negative_notes
negativeNotes
Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside [[positiveNotes]]). For symmetry
In the case of a SemanticWeb::Schema::Review, the property describes the [[itemReviewed]] from the perspective of the review; in the case of a SemanticWeb::Schema::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 SemanticWeb::Schema::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).
A negative_notes should be one of the following types:
InstanceOf['SemanticWeb::Schema::ItemList']InstanceOf['SemanticWeb::Schema::ListItem']InstanceOf['SemanticWeb::Schema::WebContent']Str
_has_negative_notes
A predicate for the "negative_notes" attribute.
nsn
Indicates the NATO stock number (nsn) of a SemanticWeb::Schema::Product.
A nsn should be one of the following types:
Str
_has_nsn
A predicate for the "nsn" attribute.
offers
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 SemanticWeb::Schema::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.
A offers should be one of the following types:
_has_offers
A predicate for the "offers" attribute.
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.
A pattern should be one of the following types:
_has_pattern
A predicate for the "pattern" attribute.
positive_notes
positiveNotes
Provides positive considerations regarding something, for example product highlights or (alongside [[negativeNotes]]) pro/con lists for reviews.
In the case of a SemanticWeb::Schema::Review, the property describes the [[itemReviewed]] from the perspective of the review; in the case of a SemanticWeb::Schema::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).
A positive_notes should be one of the following types:
InstanceOf['SemanticWeb::Schema::ItemList']InstanceOf['SemanticWeb::Schema::ListItem']InstanceOf['SemanticWeb::Schema::WebContent']Str
_has_positive_notes
A predicate for the "positive_notes" attribute.
product_id
productID
The product identifier, such as ISBN. For example: ``` meta itemprop="productID" content="isbn:123-456-789" ```.
A product_id should be one of the following types:
Str
_has_product_id
A predicate for the "product_id" attribute.
production_date
productionDate
The date of production of the item, e.g. vehicle.
A production_date should be one of the following types:
Str
_has_production_date
A predicate for the "production_date" attribute.
purchase_date
purchaseDate
The date the item, e.g. vehicle, was purchased by the current owner.
A purchase_date should be one of the following types:
Str
_has_purchase_date
A predicate for the "purchase_date" attribute.
release_date
releaseDate
The release date of a product or product model. This can be used to distinguish the exact variant of a product.
A release_date should be one of the following types:
Str
_has_release_date
A predicate for the "release_date" attribute.
review
A review of the item.
A review should be one of the following types:
_has_review
A predicate for the "review" attribute.
reviews
Review of the item.
A reviews should be one of the following types:
_has_reviews
A predicate for the "reviews" attribute.
size
A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured SemanticWeb::Schema::SizeSpecification; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
A size should be one of the following types:
InstanceOf['SemanticWeb::Schema::DefinedTerm']InstanceOf['SemanticWeb::Schema::QuantitativeValue']InstanceOf['SemanticWeb::Schema::SizeSpecification']Str
_has_size
A predicate for the "size" attribute.
sku
The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.
A sku should be one of the following types:
Str
_has_sku
A predicate for the "sku" attribute.
slogan
A slogan or motto associated with the item.
A slogan should be one of the following types:
Str
_has_slogan
A predicate for the "slogan" attribute.
weight
The weight of the product or person.
A weight should be one of the following types:
_has_weight
A predicate for the "weight" attribute.
width
The width of the item.
A width should be one of the following types:
_has_width
A predicate for the "width" attribute.
SEE ALSO
SOURCE
The development version is on github at https://github.com/robrwo/SemanticWeb-Schema and may be cloned from git://github.com/robrwo/SemanticWeb-Schema.git
BUGS
Please report any bugs or feature requests on the bugtracker website https://github.com/robrwo/SemanticWeb-Schema/issues
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
AUTHOR
Robert Rothenberg <rrwo@cpan.org>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2018-2023 by Robert Rothenberg.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)