Looking for help!
NAME
SemanticWeb::Schema::Offer - An offer to transfer some rights to an item or to provide a service — for example
VERSION
version v23.0.0
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.
Note: 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.
For GTIN-related fields, see Check Digit calculator and validation guide from GS1.
ATTRIBUTES
accepted_payment_method
acceptedPaymentMethod
The payment method(s) accepted by seller for this offer.
A accepted_payment_method should be one of the following types:
_has_accepted_payment_method
A predicate for the "accepted_payment_method" attribute.
add_on
addOn
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).
A add_on should be one of the following types:
_has_add_on
A predicate for the "add_on" attribute.
advance_booking_requirement
advanceBookingRequirement
The amount of time that is required between accepting the offer and the actual usage of the resource or service.
A advance_booking_requirement should be one of the following types:
_has_advance_booking_requirement
A predicate for the "advance_booking_requirement" 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.
area_served
areaServed
The geographic area where a service or offered item is provided.
A area_served should be one of the following types:
InstanceOf['SemanticWeb::Schema::AdministrativeArea']InstanceOf['SemanticWeb::Schema::GeoShape']InstanceOf['SemanticWeb::Schema::Place']Str
_has_area_served
A predicate for the "area_served" 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.
availability
The availability of this item—for example In stock, Out of stock, Pre-order, etc.
A availability should be one of the following types:
_has_availability
A predicate for the "availability" attribute.
availability_ends
availabilityEnds
The end of the availability of the product or service included in the offer.
A availability_ends should be one of the following types:
Str
_has_availability_ends
A predicate for the "availability_ends" attribute.
availability_starts
availabilityStarts
The beginning of the availability of the product or service included in the offer.
A availability_starts should be one of the following types:
Str
_has_availability_starts
A predicate for the "availability_starts" attribute.
available_at_or_from
availableAtOrFrom
The place(s) from which the offer can be obtained (e.g. store locations).
A available_at_or_from should be one of the following types:
_has_available_at_or_from
A predicate for the "available_at_or_from" attribute.
available_delivery_method
availableDeliveryMethod
The delivery method(s) available for this offer.
A available_delivery_method should be one of the following types:
_has_available_delivery_method
A predicate for the "available_delivery_method" attribute.
business_function
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.
A business_function should be one of the following types:
_has_business_function
A predicate for the "business_function" 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.
checkout_page_url_template
checkoutPageURLTemplate
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.
A checkout_page_url_template should be one of the following types:
Str
_has_checkout_page_url_template
A predicate for the "checkout_page_url_template" attribute.
delivery_lead_time
deliveryLeadTime
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.
A delivery_lead_time should be one of the following types:
_has_delivery_lead_time
A predicate for the "delivery_lead_time" attribute.
eligible_customer_type
eligibleCustomerType
The type(s) of customers for which the given offer is valid.
A eligible_customer_type should be one of the following types:
_has_eligible_customer_type
A predicate for the "eligible_customer_type" attribute.
eligible_duration
eligibleDuration
The duration for which the given offer is valid.
A eligible_duration should be one of the following types:
_has_eligible_duration
A predicate for the "eligible_duration" attribute.
eligible_quantity
eligibleQuantity
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.
A eligible_quantity should be one of the following types:
_has_eligible_quantity
A predicate for the "eligible_quantity" attribute.
eligible_region
eligibleRegion
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]].
A eligible_region should be one of the following types:
_has_eligible_region
A predicate for the "eligible_region" attribute.
eligible_transaction_volume
eligibleTransactionVolume
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 eligible_transaction_volume should be one of the following types:
_has_eligible_transaction_volume
A predicate for the "eligible_transaction_volume" 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_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.
includes_object
includesObject
This links to a node or nodes indicating the exact quantity of the products included in an SemanticWeb::Schema::Offer or SemanticWeb::Schema::ProductCollection.
A includes_object should be one of the following types:
_has_includes_object
A predicate for the "includes_object" attribute.
ineligible_region
ineligibleRegion
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]].
A ineligible_region should be one of the following types:
_has_ineligible_region
A predicate for the "ineligible_region" attribute.
inventory_level
inventoryLevel
The current approximate inventory level for the item or items.
A inventory_level should be one of the following types:
_has_inventory_level
A predicate for the "inventory_level" 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.
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.
item_offered
itemOffered
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.
A item_offered should be one of the following types:
InstanceOf['SemanticWeb::Schema::AggregateOffer']InstanceOf['SemanticWeb::Schema::CreativeWork']InstanceOf['SemanticWeb::Schema::Event']InstanceOf['SemanticWeb::Schema::MenuItem']InstanceOf['SemanticWeb::Schema::Product']InstanceOf['SemanticWeb::Schema::Service']InstanceOf['SemanticWeb::Schema::Trip']
_has_item_offered
A predicate for the "item_offered" attribute.
lease_length
leaseLength
Length of the lease for some SemanticWeb::Schema::Accommodation, either particular to some SemanticWeb::Schema::Offer or in some cases intrinsic to the property.
A lease_length should be one of the following types:
_has_lease_length
A predicate for the "lease_length" 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.
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.
offered_by
offeredBy
A pointer to the organization or person making the offer.
A offered_by should be one of the following types:
_has_offered_by
A predicate for the "offered_by" attribute.
price
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.
A price should be one of the following types:
NumStr
_has_price
A predicate for the "price" attribute.
price_currency
priceCurrency
The currency of the price, or a price component when attached to SemanticWeb::Schema::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".
A price_currency should be one of the following types:
Str
_has_price_currency
A predicate for the "price_currency" attribute.
price_specification
priceSpecification
One or more detailed price specifications, indicating the unit price and delivery or payment charges.
A price_specification should be one of the following types:
_has_price_specification
A predicate for the "price_specification" attribute.
price_valid_until
priceValidUntil
The date after which the price is no longer available.
A price_valid_until should be one of the following types:
Str
_has_price_valid_until
A predicate for the "price_valid_until" 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.
seller
An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider.
A seller should be one of the following types:
_has_seller
A predicate for the "seller" attribute.
serial_number
serialNumber
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.
A serial_number should be one of the following types:
Str
_has_serial_number
A predicate for the "serial_number" attribute.
shipping_details
shippingDetails
Indicates information about the shipping policies and options associated with an SemanticWeb::Schema::Offer.
A shipping_details should be one of the following types:
_has_shipping_details
A predicate for the "shipping_details" 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.
valid_from
validFrom
The date when the item becomes valid.
A valid_from should be one of the following types:
Str
_has_valid_from
A predicate for the "valid_from" attribute.
valid_through
validThrough
The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.
A valid_through should be one of the following types:
Str
_has_valid_through
A predicate for the "valid_through" attribute.
warranty
The warranty promise(s) included in the offer.
A warranty should be one of the following types:
_has_warranty
A predicate for the "warranty" attribute.
SEE ALSO
SemanticWeb::Schema::Intangible
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)