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
  • Accessing the Bookable Sellers feed
  • Using the Bookable Sellers feed with Bookable Firehose
  • Testing with Bookable Sellers feed
  1. platform products
  2. Firehose

Bookable Sellers Feed

PreviousBookable Firehose FeedsNextAttribution Catalog Endpoint

Last updated 2 years ago

The Bookable Sellers feed is an whose items are Sellers that are bookable by the accessing Broker.

Accessing the Bookable Sellers feed

The Bookable Sellers feed is broker specific and can be accessed at the following endpoint:

https://firehose.imin.co/firehose/bookable-sellers/:broker

where :broker is your broker name.

As with other feeds, you must provide a valid API key as the X-API-KEY request header.

Using the Bookable Sellers feed with Bookable Firehose

The data object in an item in the Bookable Sellers feed will look like the following:

"data": {
  "@context": "https://openactive.io/",
  "@type": "Organization",
  "@id": "https://firehose.imin.co/sellers/premiertennis/https%3A%2F%2Fapi.premiertennis.co.uk%2Fopenactive%2Fidentifiers%2Fsellers%2F1",
},

The value of the data["@id"] property represents a Bookable Seller for you, the broker. The SessionSeries and FacilityUse feeds can be filtered using this value to leave only opportunities that are bookable for you.

For SessionSeries the corresponding Seller ID can be found at data.superEvent.organizer["@id"]

For FacilityUse the corresponding Seller ID can be found at data.provider["@id"]

Testing with Bookable Sellers feed

A test Bookable Sellers feed can be found by appending -test to your Broker name. For example if your broker name was acme , your test Bookable Sellers feed can be found at

https://firehose.imin.co/firehose/bookable-sellers/acme-test

As with other feeds, you must provide a valid API key as the X-API-KEY request header.

Use this in conjunction with the in order to perform end-to-end testing against non-live data.

RPDE feed
test Bookable Firehose feeds