Start new booking

PHP examples use the PHP Client Library with SimpleXML

Description

object start_new_booking ( SimpleXmlElement $booking_data, int $channel )

Parameters

$booking_data

SimpleXmlElement containing the booking data

$channel

ID number for the channel the booking is being made with

Example

// Set the channel this booking will be made with
$channel = 3930;

// Start building the booking XML
$booking = new SimpleXMLElement('<booking />');

// Append the total customers, we'll add their details on below
$booking->addChild('total_customers', '1');

// If we're calling the API as a Tour Operator we need to add a Booking Key
// otherwise skip this
// See "Getting a new booking key" for info
$booking->addChild('booking_key', 'BOOKING_KEY_HERE');

// Append a container for the components to be booked
$components = $booking->addChild('components');

// Add a component node for each item to add to the booking
$component = $components->addChild('component');

// "Component key" obtained via call to "Check availability"
$component->addChild('component_key', 'COMPONENT_KEY_HERE');

// Append a container for the customer recrds
$customers = $booking->addChild('customers');

// Optionally append the customer details
// Either add their details (as here)
// OR an existing customer_id
// OR leave blank and TourCMS will create a blank customer
$customer = $customers->addChild('customer');
$customer->addChild('title', 'Mr');
$customer->addChild('firstname', 'Joe');
$customer->addChild('surname', 'Bloggs');
$customer->addChild('email', 'Email');

// Query the TourCMS API, creating the booking
$result = $tourcms->start_new_booking($booking, $channel);

$bkg = $result->booking;

// Display the temporary booking ID
print "Temporary booking ID: " . $bkg->booking_id . "<br />";

// Check whether any components were unavailable
// Non-zero would indicate some items sold out since "Check availability"
print $bkg->unavailable_component_count . " unavailable components";

Temporary booking ID: 123456
0 unavailable components

C# examples use the .Net Client Library

Overload list

XmlDocument StartNewBooking (XmlDocument bookingData, int channelId)

Parameters

bookingData

XmlDocument containing the booking data

channelId

The channel we are booking with

VB examples use the .Net Client Library

Overload list

XmlDocument StartNewBooking (XmlDocument bookingData, Integer channelId)

Parameters

bookingData

XmlDocument containing the booking data

channelId

The channel we are booking with

NodeJS examples use the NodeJS Wrapper

Example

TourCMS.startNewBooking({
  channelId: 3930,
  booking: {
    booking_key: "BOOKING_KEY_HERE",
    total_customers: 1,
    components: {
      component: [
        {
          component_key: "COMPONENT_KEY_HERE",
        }
      ]
    }
  },
  callback: function(response) {
    console.log(response.booking.booking_id);
  }
});

12345

Looking for sample code in a different language? TourCMS and community provided API libraries