Make A Booking

Request

Parameters

Name Type Description
LoginDetails object Required. See the Login section for details.
BookDetails object  
   ArrivalDate date string Required. Date must be on or after today.
   Duration integer Required. Stay length in days. Must be between 1 and 88.
   LeadGuest object Required.
      FirstName string Required. Max 30 characters.
      LastName string Required. Max 30 characters.
      Title string

Required. Max 10 characters.
      Address1 string

Max 30 characters.
      Address2 string

Max 30 characters.
      TownCity string

Max 30 characters.
      County string

Max 30 characters.
      Postcode string

Max 15 characters.
      Phone string

Max 20 characters.
      Email string

Max 50 characters.
   Request string

Any comments / requests for the booking.
   TradeReference string

Required. Max 50 characters.

Any reference you have that can be attached to this booking to help retrieval later – usually the booking reference in your system.
      TotalPrice decimal

Sometimes required.

Total price given in the original search result this booking is being made in accordance with. When provided, compared with current pricing to ensure no discrepancy. Any mismatch will give an error.
   RoomBookings object

Required.
      RoomBooking object

Required. At least 1 RoomBooking must be provided.
         RoomID integer

Required.
         MealBasisID integer

Required.
         Adults integer

Required.
         Children integer

Required. Ages 0 - 17.
         Infants integer

Deprecated. Please use children. 
         Guests object

Sometimes Required. See below for details.
            Guest object

For the first room requested, you must provide a Guest tag for each adult and child (not including the Lead Guest).

Example: A single room booking with two adults and one child will need the lead guest information, as well as two Guest tags. One for the other adult, and one for the child.

If you request more than one room, subsequent rooms must have one Guest tag for each guest in that room.
               Type string enum

Required.

  • Adult
  • Child
               FirstName string

Required. When unknown, use "TBA".

Max 30 Characters.
               LastName string

Required. When unknown use "TBA".

Max 30 Characters.
               Title string

Required. Max 10 characters.
               Age integer Required when Type = "Child"
               Nationality string  

 

<?xml version="1.0" encoding="UTF-8"?>
<BookRequest>
  <LoginDetails>
    <Login>xmltest</Login>
    <Password>xmltest</Password>
    <Version>6.0</Version>
  </LoginDetails>
  <BookDetails>
    <ArrivalDate>2020-08-01</ArrivalDate>
    <Duration>5</Duration>
    <LeadGuest>
      <FirstName>Jim</FirstName>
      <LastName>Watsworth</LastName>
      <Title>Mr</Title>
    </LeadGuest>
    <RoomBookings>
      <RoomBooking>
        <RoomID>14384</RoomID>
        <MealBasisID>1</MealBasisID>
        <Adults>2</Adults>
        <Children>1</Children>
        <Infants>0</Infants>
        <Guests>
          <Guest>
            <Type>Adult</Type>
            <FirstName>Sally</FirstName>
            <LastName>Smith</LastName>
            <Title>Mrs</Title>
            <Nationality>French</Nationality>
          </Guest>
          <Guest>
            <Type>Child</Type>
            <FirstName>Jimmy</FirstName>
            <LastName>Smith</LastName>
            <Age>5</Age>
            <Nationality>French</Nationality>
          </Guest>
        </Guests>
      </RoomBooking>
      <RoomBooking>
        <RoomID>14384</RoomID>
        <MealBasisID>1</MealBasisID>
        <Adults>1</Adults>
        <Children>0</Children>
        <Infants>0</Infants>
        <Guests>
          <Guest>
            <Type>Adult</Type>
            <FirstName>Joe</FirstName>
            <LastName>Smith</LastName>
            <Title>Mr</Title>
            <Nationality>British</Nationality>
          </Guest>
        </Guests>
      </RoomBooking>
    </RoomBookings>
  </BookDetails>
</BookRequest>

Response

Parameters

Name Type Description
RequestInfo RequestInfo See above.
ReturnStatus ReturnStats See the Response Status section.
BookingDetails object  
   BookingReference string Our Reference

   SupplierReference

 string

Reference from the Supplier.

Sometimes not returned.

   PropertyReference

 string

Reference from the Property/Hotel.

Sometimes not returned.
   Status string  
   ArrivalDate date string  
   Duration integer Stay length in days.
   LeadGuest object  
      FirstName string  
      LastName string  
      Title string  
      Address1 string Sometimes not returned.
      Address2 string Sometimes not returned.
      TownCity string Sometimes not returned.
      County string Sometimes not returned.
      Postcode string Sometimes not returned.
      Phone string Sometimes not returned.
      Email string Sometimes not returned.
   Request string

Sometimes not returned. Any comments or requests for this booking.
   TradeReference string

Sometimes not returned.
   TotalPrice decimal  
   Currency string Three letter ISO 4217 currency code.
   DueDate date string Date the TotalPrice is due. Depreciated and may not be returned.
   RoomBookings object  
      RoomBooking object  
         RoomID integer  
         Name string Name of the room.
         View string

Sometimes not returned. View of the room.
         MealBasisID integer  
         Adults integer  
         Children integer  
         Infants integer  
         Guests object Self-closing tag if no further guest details are available.
            Guest object  
               Type string enum
  • Adult
  • Child
               FirstName string  
               LastName string  
               Title string Sometimes not returned.
               Age string Always returned when Type = "Child"
               Nationality string  
         Supplements object Sometimes not returned. Same format as in the SearchRequest.
         SpecialOffers object Sometimes not returned. Same format as in the SearchRequest.
         Taxes object Sometimes not returned. Same format as in the SearchRequest.
         CancellationPolicies object Sometimes not returned. Same format as in the SearchRequest.
         RoomPrice decimal

Note that due to currency conversions the total of all rooms may not exactly match the TotalPrice
   Property object  
      PropertyID string  
      ProperyName string  
      Supplier    
         SupplierID integer  
         SupplierName string Informational only. Please rely on SupplierID.
      Rating decimal Star-rating, with half stars represented as .5
      Errata object Sometimes not returned.
         Erratum object  
            StartDate date  
            EndDate date  
            Desctription string  
      GeographyLevel1ID integer  
      GeographyLevel2ID integer  
      GeographyLevel3ID integer  
      Country string  
      Area string  
      Region string  
      Strapline string May be empty.
      Description string  
      CMSBaseURL string Used to get the images below.
         MainImage string Filename.
         MainImageThumbnail string Filename.
         Images object If no additional images are found, returns selfclosing tag: <Images/>
            Image object  
               FullSize string Filename.
               Thumbnail string Filename.