Looking for help!

The maintainer of this distribution is looking for people to help them improve this module! If you're interested then please contact them via email.

NAME

SemanticWeb::Schema::Offer - An offer to transfer some rights to an item or to provide a service â€” for example

VERSION

version v3.8.1

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.

For GTIN-related fields, see Check Digit calculator and valid ation 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:

InstanceOf['SemanticWeb::Schema::LoanOrCredit']
InstanceOf['SemanticWeb::Schema::PaymentMethod']

`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:

InstanceOf['SemanticWeb::Schema::Offer']

`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:

InstanceOf['SemanticWeb::Schema::QuantitativeValue']

`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:

InstanceOf['SemanticWeb::Schema::AggregateRating']

`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

`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:

InstanceOf['SemanticWeb::Schema::ItemAvailability']

`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

`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

`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:

InstanceOf['SemanticWeb::Schema::Place']

`available_delivery_method`

availableDeliveryMethod

The delivery method(s) available for this offer.

A available_delivery_method should be one of the following types:

InstanceOf['SemanticWeb::Schema::DeliveryMethod']

`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:

InstanceOf['SemanticWeb::Schema::BusinessFunction']

`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::PhysicalActivityCategory']
InstanceOf['SemanticWeb::Schema::Thing']
Str

`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:

InstanceOf['SemanticWeb::Schema::QuantitativeValue']

`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:

InstanceOf['SemanticWeb::Schema::BusinessEntityType']

`eligible_duration`

eligibleDuration

The duration for which the given offer is valid.

A eligible_duration should be one of the following types:

InstanceOf['SemanticWeb::Schema::QuantitativeValue']

`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:

InstanceOf['SemanticWeb::Schema::QuantitativeValue']

`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:

InstanceOf['SemanticWeb::Schema::GeoShape']
InstanceOf['SemanticWeb::Schema::Place']
Str

`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:

InstanceOf['SemanticWeb::Schema::PriceSpecification']

`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 for more details.

A gtin12 should be one of the following types:

Str

`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 preceeding zero. See GS1 GTIN Summary for more details.

A gtin13 should be one of the following types:

Str

`gtin14`

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

A gtin14 should be one of the following types:

Str

`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 for more details.

A gtin8 should be one of the following types:

Str

`includes_object`

includesObject

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

A includes_object should be one of the following types:

InstanceOf['SemanticWeb::Schema::TypeAndQuantityNode']

`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:

InstanceOf['SemanticWeb::Schema::GeoShape']
InstanceOf['SemanticWeb::Schema::Place']
Str

`inventory_level`

inventoryLevel

The current approximate inventory level for the item or items.

A inventory_level should be one of the following types:

InstanceOf['SemanticWeb::Schema::QuantitativeValue']

`item_condition`

itemCondition

A predefined value from OfferItemCondition or a textual description of the condition of the product or service, or the products or services included in the offer.

A item_condition should be one of the following types:

InstanceOf['SemanticWeb::Schema::OfferItemCondition']

`item_offered`

itemOffered

The item being offered.

A item_offered should be one of the following types:

InstanceOf['SemanticWeb::Schema::Product']
InstanceOf['SemanticWeb::Schema::Service']

`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

`offered_by`

offeredBy

A pointer to the organization or person making the offer.

A offered_by should be one of the following types:

InstanceOf['SemanticWeb::Schema::Organization']
InstanceOf['SemanticWeb::Schema::Person']

`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 Tradings 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 similiar Unicode symbols.

A price should be one of the following types:

Num
Str

`price_currency`

priceCurrency

The currency of the price, or a price component when attached to 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 Tradings Systems (LETS) and other currency types e.g. "Ithaca HOUR".

A price_currency should be one of the following types:

Str

`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:

InstanceOf['SemanticWeb::Schema::PriceSpecification']

`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

`review`

A review of the item.

A review should be one of the following types:

InstanceOf['SemanticWeb::Schema::Review']

`reviews`

Review of the item.

A reviews should be one of the following types:

InstanceOf['SemanticWeb::Schema::Review']

`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:

InstanceOf['SemanticWeb::Schema::Organization']
InstanceOf['SemanticWeb::Schema::Person']

`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

`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

`valid_from`

validFrom

The date when the item becomes valid.

A valid_from should be one of the following types:

Str

`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

`warranty`

The warranty promise(s) included in the offer.

A warranty should be one of the following types:

InstanceOf['SemanticWeb::Schema::WarrantyPromise']

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 is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)

To install SemanticWeb::Schema, copy and paste the appropriate command in to your terminal.

cpanm

cpanm SemanticWeb::Schema

CPAN shell

perl -MCPAN -e shell
install SemanticWeb::Schema

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

Looking for help!

NAME

VERSION

DESCRIPTION

ATTRIBUTES

accepted_payment_method

add_on

advance_booking_requirement

aggregate_rating

area_served

availability

availability_ends

availability_starts

available_at_or_from

available_delivery_method

business_function

category

delivery_lead_time

eligible_customer_type

eligible_duration

eligible_quantity

eligible_region

eligible_transaction_volume

gtin12

gtin13

gtin14

gtin8

includes_object

ineligible_region

inventory_level

item_condition

item_offered

mpn

offered_by

price

price_currency

price_specification

price_valid_until

review

reviews

seller

serial_number

sku

valid_from

valid_through

warranty

SEE ALSO