392 lines
22 KiB
JSON
392 lines
22 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"$id": "schema:Offer",
|
|
"title": "Offer",
|
|
"description": "An offer to transfer some rights to an item or to provide a service — for example, an offer to sell tickets to an event, to rent the DVD of a movie, to stream a TV show over the internet, to repair a motorcycle, or to loan a book.\\n\\nNote: As the [[businessFunction]] property, which identifies the form of offer (e.g. sell, lease, repair, dispose), defaults to http://purl.org/goodrelations/v1#Sell; an Offer without a defined businessFunction value can be assumed to be an offer to sell.\\n\\nFor [GTIN](http://www.gs1.org/barcodes/technical/idkeys/gtin)-related fields, see [Check Digit calculator](http://www.gs1.org/barcodes/support/check_digit_calculator) and [validation guide](http://www.gs1us.org/resources/standards/gtin-validation-guide) from [GS1](http://www.gs1.org/).",
|
|
"type": "object",
|
|
"allOf": [
|
|
{
|
|
"description": "A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc.",
|
|
"$ref": "schema:Intangible"
|
|
}
|
|
],
|
|
"properties": {
|
|
"acceptedPaymentMethod": {
|
|
"description": "The payment method(s) that are accepted in general by an organization, or for some specific demand or offer.",
|
|
"anyOf": [
|
|
{ "type": "string" },
|
|
{ "$ref": "schema:LoanOrCredit" },
|
|
{ "$ref": "schema:PaymentMethod" }
|
|
]
|
|
},
|
|
"addOn": {
|
|
"description": "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).",
|
|
"oneOf": [
|
|
{ "$ref": "schema:Offer" },
|
|
{ "type": "array", "items": { "$ref": "schema:Offer" } }
|
|
]
|
|
},
|
|
"additionalProperty": {
|
|
"description": "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.\\n\\nNote: 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.\n",
|
|
"oneOf": [
|
|
{ "$ref": "schema:PropertyValue" },
|
|
{ "type": "array", "items": { "$ref": "schema:PropertyValue" } }
|
|
]
|
|
},
|
|
"advanceBookingRequirement": {
|
|
"description": "The amount of time that is required between accepting the offer and the actual usage of the resource or service.",
|
|
"$ref": "schema:QuantitativeValue"
|
|
},
|
|
"aggregateRating": {
|
|
"description": "The overall rating, based on a collection of reviews or ratings, of the item.",
|
|
"$ref": "schema:AggregateRating"
|
|
},
|
|
"areaServed": {
|
|
"description": "The geographic area where a service or offered item is provided.",
|
|
"anyOf": [
|
|
{ "type": "string" },
|
|
{ "$ref": "schema:AdministrativeArea" },
|
|
{ "$ref": "schema:GeoShape" },
|
|
{ "$ref": "schema:Place" }
|
|
]
|
|
},
|
|
"asin": {
|
|
"description": "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_Number)'s article).\n\nNote 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.\nASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.",
|
|
"oneOf": [
|
|
{
|
|
"anyOf": [{ "type": "string", "format": "uri" }, { "type": "string" }]
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{ "type": "string", "format": "uri" },
|
|
{ "type": "string" }
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"availability": {
|
|
"description": "The availability of this item—for example In stock, Out of stock, Pre-order, etc.",
|
|
"$ref": "schema:ItemAvailability"
|
|
},
|
|
"availabilityEnds": {
|
|
"description": "The end of the availability of the product or service included in the offer.",
|
|
"anyOf": [
|
|
{ "type": "string", "format": "date" },
|
|
{ "type": "string", "format": "date-time" },
|
|
{ "type": "string", "format": "time" }
|
|
]
|
|
},
|
|
"availabilityStarts": {
|
|
"description": "The beginning of the availability of the product or service included in the offer.",
|
|
"anyOf": [
|
|
{ "type": "string", "format": "date" },
|
|
{ "type": "string", "format": "date-time" },
|
|
{ "type": "string", "format": "time" }
|
|
]
|
|
},
|
|
"availableAtOrFrom": {
|
|
"description": "The place(s) from which the offer can be obtained (e.g. store locations).",
|
|
"$ref": "schema:Place"
|
|
},
|
|
"availableDeliveryMethod": {
|
|
"description": "The delivery method(s) available for this offer.",
|
|
"$ref": "schema:DeliveryMethod"
|
|
},
|
|
"businessFunction": {
|
|
"description": "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.",
|
|
"$ref": "schema:BusinessFunction"
|
|
},
|
|
"category": {
|
|
"description": "A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.",
|
|
"oneOf": [
|
|
{
|
|
"anyOf": [
|
|
{ "type": "string", "format": "uri" },
|
|
{ "type": "string" },
|
|
{ "$ref": "schema:CategoryCode" },
|
|
{ "$ref": "schema:PhysicalActivityCategory" },
|
|
{ "$ref": "schema:Thing" }
|
|
]
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{ "type": "string", "format": "uri" },
|
|
{ "type": "string" },
|
|
{ "$ref": "schema:CategoryCode" },
|
|
{ "$ref": "schema:PhysicalActivityCategory" },
|
|
{ "$ref": "schema:Thing" }
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"checkoutPageURLTemplate": {
|
|
"description": "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.",
|
|
"oneOf": [
|
|
{ "type": "string" },
|
|
{ "type": "array", "items": { "type": "string" } }
|
|
]
|
|
},
|
|
"deliveryLeadTime": {
|
|
"description": "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.",
|
|
"$ref": "schema:QuantitativeValue"
|
|
},
|
|
"eligibleCustomerType": {
|
|
"description": "The type(s) of customers for which the given offer is valid.",
|
|
"$ref": "schema:BusinessEntityType"
|
|
},
|
|
"eligibleDuration": {
|
|
"description": "The duration for which the given offer is valid.",
|
|
"$ref": "schema:QuantitativeValue"
|
|
},
|
|
"eligibleQuantity": {
|
|
"description": "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.",
|
|
"$ref": "schema:QuantitativeValue"
|
|
},
|
|
"eligibleRegion": {
|
|
"description": "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]].\n ",
|
|
"anyOf": [
|
|
{ "type": "string" },
|
|
{ "$ref": "schema:GeoShape" },
|
|
{ "$ref": "schema:Place" }
|
|
]
|
|
},
|
|
"eligibleTransactionVolume": {
|
|
"description": "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.",
|
|
"$ref": "schema:PriceSpecification"
|
|
},
|
|
"gtin": {
|
|
"description": "A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin)). GTINs identify trade items, including products and services, using numeric identification codes.\n\nA 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](https://www.gs1.org/services/check-digit-calculator) and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) 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.\n\nThe GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/) expresses GTINs as URLs (URIs, IRIs, etc.).\nDigital Links should be populated into the [[hasGS1DigitalLink]] attribute.\n\nNote 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.",
|
|
"oneOf": [
|
|
{
|
|
"anyOf": [{ "type": "string", "format": "uri" }, { "type": "string" }]
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{ "type": "string", "format": "uri" },
|
|
{ "type": "string" }
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"gtin12": {
|
|
"description": "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.",
|
|
"type": "string"
|
|
},
|
|
"gtin13": {
|
|
"description": "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.",
|
|
"type": "string"
|
|
},
|
|
"gtin14": {
|
|
"description": "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.",
|
|
"type": "string"
|
|
},
|
|
"gtin8": {
|
|
"description": "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.",
|
|
"type": "string"
|
|
},
|
|
"hasAdultConsideration": {
|
|
"description": "Used to tag an item to be intended or suitable for consumption or use by adults only.",
|
|
"oneOf": [
|
|
{ "$ref": "schema:AdultOrientedEnumeration" },
|
|
{
|
|
"type": "array",
|
|
"items": { "$ref": "schema:AdultOrientedEnumeration" }
|
|
}
|
|
]
|
|
},
|
|
"hasGS1DigitalLink": {
|
|
"description": "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.",
|
|
"type": "string",
|
|
"format": "uri"
|
|
},
|
|
"hasMeasurement": {
|
|
"description": "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.",
|
|
"oneOf": [
|
|
{ "$ref": "schema:QuantitativeValue" },
|
|
{ "type": "array", "items": { "$ref": "schema:QuantitativeValue" } }
|
|
]
|
|
},
|
|
"hasMerchantReturnPolicy": {
|
|
"description": "Specifies a MerchantReturnPolicy that may be applicable.",
|
|
"oneOf": [
|
|
{ "$ref": "schema:MerchantReturnPolicy" },
|
|
{ "type": "array", "items": { "$ref": "schema:MerchantReturnPolicy" } }
|
|
]
|
|
},
|
|
"includesObject": {
|
|
"description": "This links to a node or nodes indicating the exact quantity of the products included in an [[Offer]] or [[ProductCollection]].",
|
|
"oneOf": [
|
|
{ "$ref": "schema:TypeAndQuantityNode" },
|
|
{ "type": "array", "items": { "$ref": "schema:TypeAndQuantityNode" } }
|
|
]
|
|
},
|
|
"ineligibleRegion": {
|
|
"description": "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]].\n ",
|
|
"anyOf": [
|
|
{ "type": "string" },
|
|
{ "$ref": "schema:GeoShape" },
|
|
{ "$ref": "schema:Place" }
|
|
]
|
|
},
|
|
"inventoryLevel": {
|
|
"description": "The current approximate inventory level for the item or items.",
|
|
"$ref": "schema:QuantitativeValue"
|
|
},
|
|
"isFamilyFriendly": {
|
|
"description": "Indicates whether this content is family friendly.",
|
|
"type": "boolean"
|
|
},
|
|
"itemCondition": {
|
|
"description": "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.",
|
|
"oneOf": [
|
|
{ "$ref": "schema:OfferItemCondition" },
|
|
{ "type": "array", "items": { "$ref": "schema:OfferItemCondition" } }
|
|
]
|
|
},
|
|
"itemOffered": {
|
|
"description": "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.",
|
|
"anyOf": [
|
|
{ "$ref": "schema:AggregateOffer" },
|
|
{ "$ref": "schema:CreativeWork" },
|
|
{ "$ref": "schema:Event" },
|
|
{ "$ref": "schema:MenuItem" },
|
|
{ "$ref": "schema:Product" },
|
|
{ "$ref": "schema:Service" },
|
|
{ "$ref": "schema:Trip" }
|
|
]
|
|
},
|
|
"leaseLength": {
|
|
"description": "Length of the lease for some [[Accommodation]], either particular to some [[Offer]] or in some cases intrinsic to the property.",
|
|
"oneOf": [
|
|
{
|
|
"anyOf": [
|
|
{ "type": "string", "$comment": "https://schema.org/Duration" },
|
|
{ "$ref": "schema:QuantitativeValue" }
|
|
]
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{ "type": "string", "$comment": "https://schema.org/Duration" },
|
|
{ "$ref": "schema:QuantitativeValue" }
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"mobileUrl": {
|
|
"description": "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'.\n\nTo 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](https://en.wikipedia.org/wiki/Responsive_web_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.\n ",
|
|
"type": "string"
|
|
},
|
|
"mpn": {
|
|
"description": "The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.",
|
|
"type": "string"
|
|
},
|
|
"offeredBy": {
|
|
"description": "A pointer to the organization or person making the offer.",
|
|
"oneOf": [
|
|
{
|
|
"anyOf": [
|
|
{ "$ref": "schema:Organization" },
|
|
{ "$ref": "schema:Person" }
|
|
]
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{ "$ref": "schema:Organization" },
|
|
{ "$ref": "schema:Person" }
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"price": {
|
|
"description": "The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.\\n\\nUsage guidelines:\\n\\n* Use the [[priceCurrency]] property (with standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. \"USD\"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. \"BTC\"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. \"Ithaca HOUR\") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as '$' in the value.\\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.\\n* Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a \"content=\" attribute for publishing simple machine-readable values alongside more human-friendly formatting.\\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.\n ",
|
|
"anyOf": [{ "type": "number" }, { "type": "string" }]
|
|
},
|
|
"priceCurrency": {
|
|
"description": "The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.\\n\\nUse standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. \"USD\"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. \"BTC\"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. \"Ithaca HOUR\".",
|
|
"type": "string"
|
|
},
|
|
"priceSpecification": {
|
|
"description": "One or more detailed price specifications, indicating the unit price and delivery or payment charges.",
|
|
"oneOf": [
|
|
{ "$ref": "schema:PriceSpecification" },
|
|
{ "type": "array", "items": { "$ref": "schema:PriceSpecification" } }
|
|
]
|
|
},
|
|
"priceValidUntil": {
|
|
"description": "The date after which the price is no longer available.",
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"review": {
|
|
"description": "A review of the item.",
|
|
"oneOf": [
|
|
{ "$ref": "schema:Review" },
|
|
{ "type": "array", "items": { "$ref": "schema:Review" } }
|
|
]
|
|
},
|
|
"reviews": {
|
|
"description": "Review of the item.",
|
|
"oneOf": [
|
|
{ "$ref": "schema:Review" },
|
|
{ "type": "array", "items": { "$ref": "schema:Review" } }
|
|
]
|
|
},
|
|
"seller": {
|
|
"description": "An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider.",
|
|
"anyOf": [{ "$ref": "schema:Organization" }, { "$ref": "schema:Person" }]
|
|
},
|
|
"serialNumber": {
|
|
"description": "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.",
|
|
"type": "string"
|
|
},
|
|
"shippingDetails": {
|
|
"description": "Indicates information about the shipping policies and options associated with an [[Offer]].",
|
|
"oneOf": [
|
|
{ "$ref": "schema:OfferShippingDetails" },
|
|
{ "type": "array", "items": { "$ref": "schema:OfferShippingDetails" } }
|
|
]
|
|
},
|
|
"sku": {
|
|
"description": "The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.",
|
|
"type": "string"
|
|
},
|
|
"validForMemberTier": {
|
|
"description": "The membership program tier an Offer (or a PriceSpecification, OfferShippingDetails, or MerchantReturnPolicy under an Offer) is valid for.",
|
|
"$ref": "schema:MemberProgramTier"
|
|
},
|
|
"validFrom": {
|
|
"description": "The date when the item becomes valid.",
|
|
"anyOf": [
|
|
{ "type": "string", "format": "date" },
|
|
{ "type": "string", "format": "date-time" }
|
|
]
|
|
},
|
|
"validThrough": {
|
|
"description": "The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.",
|
|
"anyOf": [
|
|
{ "type": "string", "format": "date" },
|
|
{ "type": "string", "format": "date-time" }
|
|
]
|
|
},
|
|
"warranty": {
|
|
"description": "The warranty promise(s) included in the offer.",
|
|
"$ref": "schema:WarrantyPromise"
|
|
}
|
|
}
|
|
}
|