NAME

SemanticWeb::Schema::PriceSpecification - A structured value representing a price or price range

VERSION

version v5.0.0

DESCRIPTION

A structured value representing a price or price range. Typically, only the subclasses of this type are used for markup. It is recommended to use MonetaryAmount to describe independent amounts of money such as a salary, credit card limits, etc.

ATTRIBUTES

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_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']

max_price

maxPrice

The highest price if the price is a range.

A max_price should be one of the following types:

Num

min_price

minPrice

The lowest price if the price is a range.

A min_price should be one of the following types:

Num

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

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

value_added_tax_included

valueAddedTaxIncluded

Specifies whether the applicable value-added tax (VAT) is included in the price specification or not.

A value_added_tax_included should be one of the following types:

Bool

SEE ALSO

SemanticWeb::Schema::StructuredValue

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-2019 by Robert Rothenberg.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)