The imin Platform
2.0.0
2.0.0
  • Introduction to the imin Platform
  • Using the Platform
    • imin's Platform Products
    • Authentication
    • Our Platform Data
      • Understanding Responses
      • Namespaces and Extensions
      • Defensive Data Consumption
      • Mocking the Interface
  • platform products
    • Search
      • imin Events API
        • Events API Reference
        • Virtual & Physical Sessions
        • Concepts
          • EventSeries
          • ScheduledSessions and eventSchedules
          • Activities and Collections
            • Activities
            • Activity Concept Collections
          • Accessibility Support
          • Prices
        • Filters
          • Modes
          • Age Ranges
          • Dates and Times
          • Activities and Concept Collections
          • High Frequency Sessions
      • imin Facilities API
        • Query Parameter Search
          • Mandatory Query Parameters
            • mode=discovery-geo
            • mode=upcoming-slots
          • Optional Query Parameters
        • ByID Search
          • FacilityUse By-ID
          • Slot By-ID
        • FacilityUses and IndividualFacilityUses
        • Slots
        • Facilities Slot Booking
      • imin Places API [BETA]
        • Example Request & Response
    • Firehose
      • Introduction to the Firehose
      • Accessing the Firehose
      • Firehose Usage Policy & Restrictions
      • Firehose and Search
      • Bookable Firehose Feeds
      • Bookable Sellers Feed
      • Attribution Catalog Endpoint
    • Live Timetables
      • Pre-Requisites: Open Data Feeds
      • The Onboarding Process
        • 1. Ensuring your Data Offers the Best User Experience
        • 2. Setting up and Embedding your First Timetable
        • 3. Setting up the Rest of your Timetables
        • 4. Activating Booking via Guest Checkout
      • Features Available Upon Request
      • Styling the Live Timetables
      • FAQs
    • Data Dashboard
  • incorporating book and pay
    • imin Branded Checkout
      • Introduction
      • Setup
        • Information We Require From You
        • Actions You Need to Complete
      • Authenticated Checkout
        • Testing [BETA]
        • 👪Group Booking [BETA]
      • Standalone Checkout
      • Firehose and Checkout [BETA]
        • Loading the Checkout via Firehose
    • imin Booking Platform
      • Customer Account Management
        • Create Customer Account
        • Update Customer Account
        • Get Customer Account
        • Delete Customer Account
        • Example Scenario
        • Payment Card Management
        • Linked Accounts
        • Entitlement
          • Evidence Requests
          • Entitlement Pricing in Search
          • Entitlement Pricing in Checkout
        • Access Pass
        • Webhooks
      • Orders
        • Order History
        • Order (by ID)
        • Cancellations & Refunds
      • Upcoming OrderItems
      • Receipt (by ID)
  • imin and booking systems
    • Seller Onboarding
      • API
  • HINTS & TIPS
    • Get the Best Out of Search
      • Displaying Schedule Information
      • URLs and Offering a Call to Action
      • Searching by Activity
      • Your Search Results and HighFrequencySessions
      • Customer Specific Images
  • Info for Data Publishers
    • Your RPDE Feed & the imin Platform [BETA]
      • Providing Places Data [BETA]
      • Providing Schedule Information [BETA]
Powered by GitBook
On this page
  • Prices and imin:aggregateOffer
  • Example
  • Prices and subEvent[].offers
  • Example
  1. platform products
  2. Search
  3. imin Events API
  4. Concepts

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"
    }
],
PreviousAccessibility SupportNextFilters

Last updated 4 years ago