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
  • Guest Checkout Route - ScheduledSessions
  • Guest Checkout Route - Slots
  • Authenticated Checkout Route - ScheduledSessions
  • Authenticated Checkout Route - Slots
  1. incorporating book and pay
  2. imin Branded Checkout
  3. Firehose and Checkout [BETA]

Loading the Checkout via Firehose

PreviousFirehose and Checkout [BETA]Nextimin Booking Platform

Last updated 3 years ago

Looking to test the booking flow using Firehose and Checkout? Ask your account manager about imin's dummy dataset, which will give you everything you need to make test bookings.

Guest Checkout Route - ScheduledSessions

  1. First and foremost, please check that the following criteria (detailed more thoroughly ) are met:

    1. The ScheduledSession is bookable;

    2. The SessionSeries is bookable; and

    3. The startDate of the ScheduledSession is within the window specified by theSessionSeries.

  2. Once you are satisfied that the ScheduledSession is booklable, URI encode the data.identifer found in the scheduled-sessions feed and append it to https://{checkoutBaseUrl}/v1/scheduled-sessions/.

  3. This will load the Checkout with the details of the chosen ScheduledSession, in which the booker can enter their name, email address, and card details to complete the booking.

Guest Checkout Route - Slots

Booking via the Firehose is still in Beta and most of the work has focused on booking of ScheduledSessions rather than Slots. Please bear this in mind if you are focusing on the latter.

Authenticated Checkout Route - ScheduledSessions

  1. First and foremost, please check that the following criteria (detailed more thoroughly ) are met:

    1. The ScheduledSession is bookable;

    2. The SessionSeries is bookable; and

    3. The startDate of the ScheduledSession is within the window specified by theSessionSeries.

  2. POST to https://{checkoutBaseUrl}/api/checkout-sessions/ to make the Webhook Request, being sure to include all the relevant information detailed , including data.identifer from the ScheduledSession (NB this does not need to be URL encoded).

  3. Take the URL from potentialAction[].targetin the , which will load a Checkout page.

  4. The booker can then complete the booking without having to enter their name and email address (this is because this information was included in the Request Webhook). They only need to enter their card details where it is a paid-for (i.e. not free) session.

  5. On completion of the booking, imin will send a confirmation email and also fire off a , which will include relevant information for you to present to the booker in whatever way you see fit.

You must ensure you have registered your webhook with imin to use the Authenticated Checkout Route.

Authenticated Checkout Route - Slots

Booking via the Firehose is still in Beta and most of the work has focused on booking of ScheduledSessions rather than Slots. Please bear this in mind if you are focusing on the latter.

here
here
here
Response Webhook
Success Webhook