API Docs for: 1.3.12
Show:

UnitPriceSpecification Class

Schema.org/UnitPriceSpecification The price asked for a given offer by the respective organization or person.

Methods

getDescription

() String

Returns the description of the thing

Returns:

String:

description of Thing

getName

() String

Returns the name of the thing

Returns:

String:

name of Thing

setDescription

(
  • description
)

Method to set Thing description

Parameters:

  • description String

    Description to set for its Thing

setName

(
  • name
)

Method to set Thing name

Parameters:

  • name String

    Name to set for this Thing

Properties

additionalType

URL

Schema.org/additionalType 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.

alternateName

Text

Schema.org/alternateName An alias for the item.

billingIncrement

Number

Schema.org/billingIncrement This property specifies the minimal quantity and rounding increment that will be the basis for the billing. The unit of measurement is specified by the unitCode property.

description

Text

Schema.org/description A description of the item.

disambiguatingDescription

Text

Schema.org/disambiguatingDescription 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.

eligibleQuantity

QuantitativeValue

Schema.org/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.

eligibleTransactionVolume

PriceSpecification

Schema.org/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.

identifier

Schema, URL | schema,Text | schema,PropertyValue

Schema.org/identifier The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.

image

Schema, URL | schema,ImageObject

Schema.org/image An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

mainEntityOfPage

Schema, URL | schema,CreativeWork

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

maxPrice

Number

Schema.org/maxPrice The highest price if the price is a range.

minPrice

Number

Schema.org/minPrice The lowest price if the price is a range.

name

Text

Schema.org/name The name of the item.

potentialAction

Action

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

price

Number

Schema.org/price 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 ISO 4217 codes e.g. "USD") instead of including ambiguous symbols 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 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 similiar Unicode symbols.

priceCurrency

Text

Schema.org/priceCurrency The currency (in 3-letter ISO 4217 format) of the price or a price component, when attached to [[PriceSpecification]] and its subtypes.

priceType

Text

Schema.org/priceType A short text or acronym indicating multiple price specifications for the same offer, e.g. SRP for the suggested retail price or INVOICE for the invoice price, mostly used in the car industry.

referenceQuantity

QuantitativeValue

Schema.org/referenceQuantity The reference quantity for which a certain price applies, e.g. 1 EUR per 4 kWh of electricity. This property is a replacement for unitOfMeasurement for the advanced cases where the price does not relate to a standard unit.

sameAs

URL

Schema.org/sameAs 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.

unitCode

Text

Schema.org/unitCode The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL. Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon.

unitText

Text

Schema.org/unitText A string or text indicating the unit of measurement. Useful if you cannot provide a standard unit code for unitCode.

url

URL

Schema.org/url URL of the item.

validFrom

DateTime

Schema.org/validFrom The date when the item becomes valid.

validThrough

DateTime

Schema.org/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.

valueAddedTaxIncluded

Boolean

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