Technical Architecture
Redeam's Operator API enables communication between Redeam-connected resellers and operators by establishing a two-way interface between Redeam and operators. The first half of this interface, the Operator Booking System, provides Redeam access to fetch information and create bookings against the operator.
Operator Booking System Schema
The OBS schema works off of six objects:
- The Supplier object represents a provider or operator of a tour or attraction. This could be a discrete business (e.g. 'Widget Tours') or a satellite location (e.g. 'Widget Tours Orlando').
- The Product object sits underneath a supplier (one supplier has one or many products), and represents a general tour or attraction offering (e.g. 'History of Widgets Exhibit').
- The Option object sits underneath a product (one product has one or many options), and represents a variation of a product (e.g. 'Guided Tour').
- Each option contains an array of one or more Unit objects, which describes a discrete, bookable type of an option (e.g. 'Adult', 'Child').
- Availabilities are associated with all options (including options which require no reservation, aka Freesale), and reflect the dates & times at which the option may be booked.
- A Booking references one of all the above objects (possibly multiple units) and represents a held or confirmed reservation of a particular option at a specific time for a number of guests.
Booking Flow
The booking object has five status states, which are enumerated below:
- HOLD
- PENDING*
- CONFIRMED
- EXPIRED
- REJECTED
The PENDING status represents a booking with a confirmation request that is waiting on action from the operator _(where instantConfirmation is set to false on the product) _before transitioning into CONFIRMED or REJECTED. At this time, this state is not supported by Redeam, but may be supported in future versions.
More information on each state can be found in the API reference. Below is a diagram depicting the transition between booking states: