Prices

Prices in the API are included in two different ways:

1. Within the imin:aggregateOffer object (included in the search results and By-ID results); and

2. Within subEvent[].offers array (only included in the By-ID results).

Prices and imin:aggregateOffer

The imin:aggregateOffer object, which is included in both the search results and By-ID results, includes the two most popular price types (where they are included in the open data): adult and junior.

The API search results will not include an offers array. This can only be found in subEvent[].offers in the By-ID search results.

Example

"imin:aggregateOffer": {
    "type": "imin:AggregateOffer",
    "publicAdult": {
        "type": "AggregateOffer",
        "price": 4.3,
        "priceCurrency": "GBP",
        "imin:membershipRequired": false
    },
    "publicJunior": {
        "type": "AggregateOffer",
        "price": 3.3,
        "priceCurrency": "GBP",
        "imin:membershipRequired": false
    }
},

We recommend using the imin:aggregateOffer object within the search results when you want to show the most common prices to your end user after an initial frontend search. If a person wants to know more about a particular session and any associated concessionary prices, then you can use the By-ID search to present the prices included within subEvent[].offers (see below).

Prices and subEvent[].offers

The subEvent[].offers array, which is only included in the By-ID results, includes all the price types available within a provider's open data feed, including concessionary prices.

Some objects will include an offers[].ageRange object, which will provide age restrictions against a particular concessionary price, for example, a price for seniors might have an ageRange with a minValue of 50.

Example

"offers": [
    {
        "name": "Adult",
        "type": "Offer",
        "price": 4.3,
        "identifier": "EX-AD",
        "description": "Public Swim",
        "priceCurrency": "GBP"
    },
    {
        "name": "Junior",
        "type": "Offer",
        "price": 3.3,
        "ageRange": {
            "type": "QuantitativeValue",
            "maxValue": 13
        },
        "identifier": "EX-JNR",
        "description": "Public Swim",
        "priceCurrency": "GBP"
    },
    {
        "name": "Young Adult",
        "type": "Offer",
        "price": 3.3,
        "ageRange": {
            "type": "QuantitativeValue",
            "maxValue": 15,
            "minValue": 14
        },
        "identifier": "EX-JNR2",
        "description": "Public Swim",
        "priceCurrency": "GBP"
    },
    {
        "name": "Senior",
        "type": "Offer",
        "price": 3.3,
        "ageRange": {
            "type": "QuantitativeValue",
            "minValue": 50
        },
        "identifier": "EX-SNR",
        "description": "Public Swim",
        "priceCurrency": "GBP"
    }
],