Web API

Further documentation describing the Web API in more detail.

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

The geographic area where a service or offered item is provided.

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

A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).

An award won by or for this item.

The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.

An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.

Indicates an OfferCatalog listing for this Organization, Person, or Service.

The hours during which this service or contact is available.

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

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

An associated logo.

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.

The tangible thing generated by the service, e.g. a passport, permit, etc.

The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.

Indicates the mobility of a provided service (e.g. 'static', 'dynamic').

A review of the item.

The geographic area where the service is provided.

The audience eligible for this service.

The tangible thing generated by the service, e.g. a passport, permit, etc.

The type of service being offered, e.g. veterans' benefits, emergency relief, etc.

A slogan or motto associated with the item.

Human-readable terms of service documentation.

The types of sport, active recreation, and fitness associated with the entity.

The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.

The currency of the price.

This property is particularly useful for indicating time-sensitive pricing, such as limited-time discounts or promotional rates. After the priceValidUntil date, the price may change, or the offer may no longer be available at that price. It focuses specifically on the expiration of the stated price, which can differ from the overall validity period of the offer (defined by properties like validThrough)

The URL of the registration page for a listing.

Indicates the timezone for which the time(s) indicated in the Schedule are given. The value provided should be among those listed in the IANA Time Zone Database.

The type of schedule associated with the item or event. When left blank, a schedule is not applicable to the listing.

the date and time when the offer becomes active, meaning when you can start booking, purchasing, or accepting it. Example: For the boat lease, this might be when the offer is first posted (e.g., June 1, 2010).

This is the date and time after which the offer can no longer be accepted. It’s the deadline to book or buy. Example: For the boat lease, this is the last moment to reserve it (e.g., July 15, 2010, at 23:59).

.

The payment method(s) accepted by seller for this 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).

The amount of time that is required between accepting the offer and the actual usage of the resource or service.

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

The geographic area where a service or offered item is provided.

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.

The availability of this item—for example In stock, Out of stock, Pre-order, etc.

the date and time after which the product or service is no longer available. It marks the end of the period when you can use, receive, or pick up the item or service. Example: For the boat lease, this is when you must return it (e.g., August 31, 2010, at 23:59).

the date and time when the product or service becomes available to the customer. It’s when you can start using, receiving, or picking up what’s being offered. Example: If you’re leasing a boat, this is when you can begin using it (e.g., August 1, 2010, at 09:00).

The place(s) from which the offer can be obtained (e.g. store locations).

The delivery method(s) available for this offer.

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.

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.

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.

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.

The type(s) of customers for which the given offer is valid.

The duration for which the given offer is valid.

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.

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.\n\nSee also ineligibleRegion.

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.

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.

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.

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.

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

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.

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

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.

Specifies a MerchantReturnPolicy that may be applicable.

This links to a node or nodes indicating the exact quantity of the products included in an Offer or ProductCollection.

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.\n\nSee also eligibleRegion.

The current approximate inventory level for the item or items.

Indicates whether this content is family friendly.

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.

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.

Length of the lease for some Accommodation, either particular to some Offer or in some cases intrinsic to the property.

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.

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

A pointer to the organization or person making the offer.

The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.

The currency of the price.

One or more detailed price specifications, indicating the unit price and delivery or payment charges.

This property is particularly useful for indicating time-sensitive pricing, such as limited-time discounts or promotional rates. After the priceValidUntil date, the price may change, or the offer may no longer be available at that price. It focuses specifically on the expiration of the stated price, which can differ from the overall validity period of the offer (defined by properties like validThrough)

A review of the item.

Review of the item.

An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider.

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.

Indicates information about the shipping policies and options associated with an Offer.

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

the date and time when the offer becomes active, meaning when you can start booking, purchasing, or accepting it. Example: For the boat lease, this might be when the offer is first posted (e.g., June 1, 2010).

This is the date and time after which the offer can no longer be accepted. It’s the deadline to book or buy. Example: For the boat lease, this is the last moment to reserve it (e.g., July 15, 2010, at 23:59).

The warranty promise(s) included in the offer.

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. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

An alias for the item.

A description of the item.

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.

The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc.

An image of the item. This can be a URL or a fully described ImageObject.

Type to which this subject belongs. Use for membership in a value set (Enumeration), not inheritance. Example: K2 instanceOf mountain; volcano subClassOf mountain.

Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.

The name of the item.

Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

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.

A CreativeWork or Event about this Thing.

URL of the item.