Skip to content
imin imin Developer Docs

Bookable Firehose Feeds

The Bookable Firehose feeds are a set of Firehose feeds containing only those Booking Systems that are bookable by imin.

Not all of the opportunities in the feeds may be bookable by you, the broker. To determine which Booking Systems are bookable by you, you must also consume the Bookable Sellers feed that is specific to you.

Accessing the Feeds

These feeds can be accessed at the following endpoints:

FeedEndpoint
SessionSerieshttps://firehose.imin.co/firehose/bookable/v2/session-series
ScheduledSessionhttps://firehose.imin.co/firehose/bookable/v2/scheduled-sessions
FacilityUsehttps://firehose.imin.co/firehose/bookable/v2/facility-uses
Slothttps://firehose.imin.co/firehose/bookable/v2/slots

These feeds are followed in the same way as the other Firehose feeds. See Firehose Authentication and CDN Endpoints.

Bookability Fields

Every item in these feeds carries imin:isPotentiallyBookable flags that tell you whether it can be booked through imin. Which Booking Systems are bookable by you still comes from your Bookable Sellers feed.

  • ScheduledSession.imin:isPotentiallyBookable and Slot.imin:isPotentiallyBookable: the occurrence has spaces left and no additionalAdmissionRestriction.
  • SessionSeries.imin:isPotentiallyBookable and FacilityUse.imin:isPotentiallyBookable: the organiser/provider takes online bookings.
  • SessionSeries.superEvent.imin:aggregateOffer.publicAdult.imin:isPotentiallyBookable, FacilityUse.imin:aggregateOffer.publicAdult.imin:isPotentiallyBookable and Slot.imin:aggregateOffer.publicAdult.imin:isPotentiallyBookable: the public adult offer can be booked. imin:aggregateOffer sits on whichever item the Booking System publishes its offers on: the SessionSeries (under superEvent) for sessions, and the FacilityUse for some Booking Systems or each Slot for others, so for facilities check both.

A ScheduledSession or Slot is bookable when its own flag, its parent’s top-level flag and an aggregate-offer flag on either of them are all true, and the booking window is open. The full rules, including the booking window, are in Firehose and Booking.

Testing With Bookable Firehose

In order to help with integration and testing, a set of test bookable Firehose feeds can be found at the following endpoints:

FeedEndpoint
SessionSerieshttps://firehose.imin.co/firehose/bookable-test/v2/session-series
ScheduledSessionhttps://firehose.imin.co/firehose/bookable-test/v2/scheduled-sessions
FacilityUsehttps://firehose.imin.co/firehose/bookable-test/v2/facility-uses
Slothttps://firehose.imin.co/firehose/bookable-test/v2/slots

As with the other Firehose feeds you must provide a valid API key as the X-API-KEY request header. For test feeds you can use the following API key:

7rqDX97CwJrbi0kRFzWkjUcAiWttpZAq