All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.schema.Offer Maven / Gradle / Ivy

There is a newer version: 3.1.8
Show newest version
package org.schema;

/**
 * Schema.org/Offer
 * 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\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/).
 *
 * @author schema.org
 * @class Offer
 * @module org.schema
 * @extends Intangible
 */
public class Offer extends Intangible {
	/**
	 * Schema.org/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.
	 *
	 * @property sku
	 * @type Text
	 */
	public String sku;
	/**
	 * Schema.org/availabilityStarts
	 * The beginning of the availability of the product or service included in the offer.
	 *
	 * @property availabilityStarts
	 * @type DateTime
	 */
	public String availabilityStarts;
	/**
	 * Schema.org/availableDeliveryMethod
	 * The delivery method(s) available for this offer.
	 *
	 * @property availableDeliveryMethod
	 * @type DeliveryMethod
	 */
	public DeliveryMethod availableDeliveryMethod;
	/**
	 * Schema.org/mpn
	 * The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.
	 *
	 * @property mpn
	 * @type Text
	 */
	public String mpn;
	/**
	 * Schema.org/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.
	 *
	 * @property serialNumber
	 * @type Text
	 */
	public String serialNumber;
	/**
	 * Schema.org/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.\n\nSee also [[eligibleRegion]].
	 *
	 * @property ineligibleRegion
	 * @type GeoShape
	 */
	public GeoShape ineligibleRegion;
	/**
	 * Schema.org/gtin8
	 * The [GTIN-8](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) 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.
	 *
	 * @property gtin8
	 * @type Text
	 */
	public String gtin8;
	/**
	 * Schema.org/reviews
	 * Review of the item.
	 *
	 * @property reviews
	 * @type Review
	 */
	public Review reviews;
	/**
	 * Schema.org/availability
	 * The availability of this item—for example In stock, Out of stock, Pre-order, etc.
	 *
	 * @property availability
	 * @type ItemAvailability
	 */
	public ItemAvailability availability;
	/**
	 * Schema.org/priceSpecification
	 * One or more detailed price specifications, indicating the unit price and delivery or payment charges.
	 *
	 * @property priceSpecification
	 * @type PriceSpecification
	 */
	public PriceSpecification priceSpecification;
	/**
	 * Schema.org/inventoryLevel
	 * The current approximate inventory level for the item or items.
	 *
	 * @property inventoryLevel
	 * @type QuantitativeValue
	 */
	public QuantitativeValue inventoryLevel;
	/**
	 * Schema.org/aggregateRating
	 * The overall rating, based on a collection of reviews or ratings, of the item.
	 *
	 * @property aggregateRating
	 * @type AggregateRating
	 */
	public AggregateRating aggregateRating;
	/**
	 * 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.
	 *
	 * @property eligibleTransactionVolume
	 * @type PriceSpecification
	 */
	public PriceSpecification eligibleTransactionVolume;
	/**
	 * Schema.org/availableAtOrFrom
	 * The place(s) from which the offer can be obtained (e.g. store locations).
	 *
	 * @property availableAtOrFrom
	 * @type Place
	 */
	public Place availableAtOrFrom;
	/**
	 * 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.
	 *
	 * @property priceCurrency
	 * @type Text
	 */
	public String priceCurrency;
	/**
	 * Schema.org/category
	 * A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
	 *
	 * @property category
	 * @type Text
	 */
	public String category;
	/**
	 * Schema.org/priceValidUntil
	 * The date after which the price is no longer available.
	 *
	 * @property priceValidUntil
	 * @type Date
	 */
	public String priceValidUntil;
	/**
	 * Schema.org/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).
	 *
	 * @property addOn
	 * @type Offer
	 */
	public Offer addOn;
	/**
	 * Schema.org/warranty
	 * The warranty promise(s) included in the offer.
	 *
	 * @property warranty
	 * @type WarrantyPromise
	 */
	public WarrantyPromise warranty;
	/**
	 * Schema.org/includesObject
	 * This links to a node or nodes indicating the exact quantity of the products included in the offer.
	 *
	 * @property includesObject
	 * @type TypeAndQuantityNode
	 */
	public TypeAndQuantityNode includesObject;
	/**
	 * 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.
	 *
	 * @property eligibleQuantity
	 * @type QuantitativeValue
	 */
	public QuantitativeValue eligibleQuantity;
	/**
	 * Schema.org/validFrom
	 * The date when the item becomes valid.
	 *
	 * @property validFrom
	 * @type DateTime
	 */
	public String validFrom;
	/**
	 * 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.
	 *
	 * @property validThrough
	 * @type DateTime
	 */
	public String validThrough;
	/**
	 * 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](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) e.g. "USD") 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 similiar Unicode symbols.
	 *
	 * @property price
	 * @type Number
	 */
	public Double price;
	/**
	 * Schema.org/gtin14
	 * The [GTIN-14](http://apps.gs1.org/GDD/glossary/Pages/GTIN-14.aspx) 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.
	 *
	 * @property gtin14
	 * @type Text
	 */
	public String gtin14;
	/**
	 * Schema.org/gtin13
	 * The [GTIN-13](http://apps.gs1.org/GDD/glossary/Pages/GTIN-13.aspx) 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](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
	 *
	 * @property gtin13
	 * @type Text
	 */
	public String gtin13;
	/**
	 * Schema.org/gtin12
	 * The [GTIN-12](http://apps.gs1.org/GDD/glossary/Pages/GTIN-12.aspx) 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.
	 *
	 * @property gtin12
	 * @type Text
	 */
	public String gtin12;
	/**
	 * Schema.org/seller
	 * An entity which offers (sells / leases / lends / loans) the services / goods.  A seller may also be a provider.
	 *
	 * @property seller
	 * @type Person
	 */
	public Person seller;
	/**
	 * Schema.org/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.
	 *
	 * @property deliveryLeadTime
	 * @type QuantitativeValue
	 */
	public QuantitativeValue deliveryLeadTime;
	/**
	 * Schema.org/availabilityEnds
	 * The end of the availability of the product or service included in the offer.
	 *
	 * @property availabilityEnds
	 * @type DateTime
	 */
	public String availabilityEnds;
	/**
	 * Schema.org/review
	 * A review of the item.
	 *
	 * @property review
	 * @type Review
	 */
	public Review review;
	/**
	 * Schema.org/eligibleCustomerType
	 * The type(s) of customers for which the given offer is valid.
	 *
	 * @property eligibleCustomerType
	 * @type BusinessEntityType
	 */
	public BusinessEntityType eligibleCustomerType;
	/**
	 * Schema.org/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.
	 *
	 * @property itemCondition
	 * @type OfferItemCondition
	 */
	public OfferItemCondition itemCondition;
	/**
	 * Schema.org/itemOffered
	 * The item being offered.
	 *
	 * @property itemOffered
	 * @type Service
	 */
	public Service itemOffered;
	/**
	 * Schema.org/offeredBy
	 * A pointer to the organization or person making the offer.
	 *
	 * @property offeredBy
	 * @type Organization
	 */
	public Organization offeredBy;
	/**
	 * Schema.org/eligibleDuration
	 * The duration for which the given offer is valid.
	 *
	 * @property eligibleDuration
	 * @type QuantitativeValue
	 */
	public QuantitativeValue eligibleDuration;
	/**
	 * Schema.org/acceptedPaymentMethod
	 * The payment method(s) accepted by seller for this offer.
	 *
	 * @property acceptedPaymentMethod
	 * @type LoanOrCredit
	 */
	public LoanOrCredit acceptedPaymentMethod;
	/**
	 * Schema.org/areaServed
	 * The geographic area where a service or offered item is provided.
	 *
	 * @property areaServed
	 * @type Place
	 */
	public Place areaServed;
	/**
	 * Schema.org/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.
	 *
	 * @property businessFunction
	 * @type BusinessFunction
	 */
	public BusinessFunction businessFunction;
	/**
	 * Schema.org/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.\n\nSee also [[ineligibleRegion]].
	 *
	 * @property eligibleRegion
	 * @type Text
	 */
	public String eligibleRegion;
	/**
	 * Schema.org/advanceBookingRequirement
	 * The amount of time that is required between accepting the offer and the actual usage of the resource or service.
	 *
	 * @property advanceBookingRequirement
	 * @type QuantitativeValue
	 */
	public QuantitativeValue advanceBookingRequirement;

	/**
	 * Constructor, automatically sets @context and @type.
	 *
	 * @constructor
	 */
	public Offer() {
		context = "http://schema.org/";
		type = "Offer";
	}

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy