Offer

This page describes the Offer type.

This type is derived from https://schema.org/Offer, which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
Fields
Required fields
Property
Expected Type
Description
type
 Text​
 Must always be present and set to "type": "Offer"
price
 Float​
The offer price of the activity.
This price should be specified without currency symbols and as a floating point number with two decimal places.
The currency of the price should be expressed in the priceCurrency field.

Example
"price": 33
Recommended fields
Property
Expected Type
Description
id
 URL​
A unique url based identifier for the record

Example
"id": "https://example.com/offer/12345"
ageRange
 QuantitativeValue​
Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30

Example
"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
name
 Text​
A human readable name for the offer.

Example
"name": "Speedball winger position"
priceCurrency
 Text​
The currency (in 3-letter ISO 4217 format) of the price.
If an Offer has a zero price, then this property is not required. Otherwise the currency must be specified.

Example
"priceCurrency": "GBP"
url
 URL​
URL describing the offer

Example
"url": "http://www.rphs.org.uk/"
Optional fields
Property
Expected Type
Description
acceptedPaymentMethod
 Array of PaymentMethod​
Indicates the offline payment methods accepted by this provider.

Example
"acceptedPaymentMethod": [
  "http://purl.org/goodrelations/v1#Cash",
  "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
]
advanceBooking
 RequiredStatusType​
Indicates whether to accept this offer, a participant must book in advance, whether they must pay on attending, or have option to do either.

Example
"advanceBooking": "https://openactive.io/Required"
description
 Text​
A free text description of the Offer

Example
"description": "Concession requirements are available at https://www.fusion-lifestyle.com/. Proof of entitlement to concession membership must be provided when you visit the centre."
identifier
 Text
 - or -
PropertyValue
 - or -
Array of PropertyValue
 - or -
Integer​
A local non-URI identifier for the resource

Example
"identifier": "SB1234"
prepayment
 RequiredStatusType​
Indicates whether to accept this offer, a participant must pay in advance, pay when attending, or have the option to do either.

Example
"prepayment": "https://openactive.io/Required"
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution License (CC-BY V4.0), and code samples are licensed under the MIT License, for anyone to access, use and share; using attribution "OpenActive".

Lockers

OpeningHoursSpecification

Last updated Tue Jul 23 2019 09:43:58 GMT+0000 (UTC)

Property	Expected Type	Description
id	`URL`	A unique url based identifier for the record Example `"id": "https://example.com/offer/12345"`
ageRange	`QuantitativeValue`	Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30 Example `"ageRange": { "type": "QuantitativeValue", "minValue": 15, "maxValue": 60 }`
name	`Text`	A human readable name for the offer. Example `"name": "Speedball winger position"`
priceCurrency	`Text`	The currency (in 3-letter ISO 4217 format) of the price. If an Offer has a zero price, then this property is not required. Otherwise the currency must be specified. Example `"priceCurrency": "GBP"`
url	`URL`	URL describing the offer Example `"url": "http://www.rphs.org.uk/"`

Property	Expected Type	Description
acceptedPaymentMethod	Array of `PaymentMethod`	Indicates the offline payment methods accepted by this provider. Example `"acceptedPaymentMethod": [ "http://purl.org/goodrelations/v1#Cash", "http://purl.org/goodrelations/v1#PaymentMethodCreditCard" ]`
advanceBooking	`RequiredStatusType`	Indicates whether to accept this offer, a participant must book in advance, whether they must pay on attending, or have option to do either. Example `"advanceBooking": "https://openactive.io/Required"`
description	`Text`	A free text description of the Offer Example `"description": "Concession requirements are available at https://www.fusion-lifestyle.com/. Proof of entitlement to concession membership must be provided when you visit the centre."`
identifier	`Text` - or - `PropertyValue` - or - Array of `PropertyValue` - or - `Integer`	A local non-URI identifier for the resource Example `"identifier": "SB1234"`
prepayment	`RequiredStatusType`	Indicates whether to accept this offer, a participant must pay in advance, pay when attending, or have the option to do either. Example `"prepayment": "https://openactive.io/Required"`