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"

id

URL

A unique url based identifier for the record

Example

"id": "https://example.com/offer/12345"

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.

Includes or excludes tax depending on the taxMode of the seller.

Example

"price": 33

Property

Expected Type

Description

ageRange

QuantitativeValue

Indicates that an Offer is applicable to a specific age range. Specified as a QuantitativeValue with minValue and maxValue properties.

Example

"ageRange": { "@type": "QuantitativeValue", "minValue": 15, "maxValue": 60 }

name

Text

The name of the Offer suitable for communication to participants.

Example

"name": "Speedball winger position"

priceCurrency

Text

The currency of the price. Specified as a 3-letter ISO 4217 value. If an Offer has a zero price, then this property is not required. Otherwise the priceCurrency 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. Values must be one of https://openactive.io/Required, https://openactive.io/Optional or https://openactive.io/Unavailable.

Example

"advanceBooking": "https://openactive.io/Required"

availableChannel

Array of AvailableChannelType

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"

latestCancellationBeforeStartDate

Duration

The duration before the startDate during which this Offer may not be cancelled, given in ISO 8601 format.

openBookingFlowRequirement

Array of OpenBookingFlowRequirement

Can include https://openactive.io/OpenBookingIntakeForm, https://openactive.io/OpenBookingAttendeeDetails, https://openactive.io/OpenBookingApproval, https://openactive.io/OpenBookingNegotiation, https://openactive.io/OpenBookingMessageExchange

prepayment

RequiredStatusType

Indicates whether to accept this offer, a participant must pay in advance, pay when attending, or have the option to do either. Values must be one of https://openactive.io/Required, https://openactive.io/Optional or https://openactive.io/Unavailable.

Example

"prepayment": "https://openactive.io/Required"

validFromBeforeStartDate

Duration

The duration before the startDate for which this Offer is valid, given in ISO 8601 format. This is a relatively-defined equivalent of schema:validFrom, to allow for Offer inheritance.

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".