XML Search and Booking

This guide is designed to give a quick start to your integration with the TRAVELfusion API. In the XML examples below, various XML elements and attributes have been omitted for simplicity. There are also many more details, features and functions available that you can read about in our Detailed Specification. The detailed specification also sets out specific guidelines concerning how the API should be used and gives various other information that should be read before your integration is completed and released to end users.

Step 4: Selecting a flight for booking

Once the end user has decided which flight they would like to book, a ProcessDetails XML request should be made to begin the booking process. In the example, notice the HandoffParametersOnly element must be set to 'false' and note that the OutwardId corresponds ot the id of the first British Airways outward result in the example CheckRouting response in step 3. In the case of a return journey, a ReturnId must also be submitted after the OutwardId which will identify the chosen return flight (which must be in the same Group as the outward selection).

ProcessDetails request XML example:

The ProcessDetails response can normally be ignored. However it may contain a Router element which will contain any new data related to the flight/ price. This is used to handle special cases where the supplier only supplies certain information after a flight has been submitted. For example, some suppliers may not supply the flight number until a specific flight has been chosen.

ProcessDetails response XML example:

Step 5: Submitting the booking details

The ProcessTerms XML request is used to submit the travellers' details and credit card details. See the ProcessTerms request specification in the Detailed Specification for more details of the booking profile.

ProcessTerms request XML example:

<CommandList>
  <ProcessTerms>
    <XmlLoginId>****</XmlLoginId>
    <LoginId>****</LoginId>
    <RoutingId>Z1LXGWR0QX1XKAN3</RoutingId>
    <OutwardId>N9IPVX2WCO9RV419</OutwardId>
    <BookingProfile>
      <TravellerList>
        <Traveller>
          <Age>30</Age>
          <Name>
            <Title>Mr</Title>
            <NamePartList>
              <NamePart>Andy</NamePart>
              <NamePart>S</NamePart>
              <NamePart>Peterson</NamePart>
            </NamePartList>
          </Name>
          <CustomSupplierParameterList>
            <CustomSupplierParameter>
              <Name>DateOfBirth</Name>
              <Value>16/04/1974</Value>
            </CustomSupplierParameter>
          </CustomSupplierParameterList>
        </Traveller>
      </TravellerList>
       <ContactDetails>
         <Name>
          <Title>Mr</Title>
          <NamePartList>
            <NamePart>Andy</NamePart>
            <NamePart>S</NamePart>
            <NamePart>Peterson</NamePart>
          </NamePartList>
         </Name>
         <Address>
           <Company></Company>
           <Flat>22A</Flat>
           <BuildingName>Dean's Court</BuildingName>
           <BuildingNumber>3</BuildingNumber>
           <Street>St. George Street</Street>
           <Locality>Redland</Locality>
           <City>Bristol</City>
           <Province>Avon</Province>
           <Postcode>BS8 6GC</Postcode>
           <CountryCode>GB</CountryCode>
         </Address>
         <HomePhone>
           <InternationalCode>0044</InternationalCode>
           <AreaCode>12332</AreaCode>
           <Number>232223</Number>
           <Extension>3322</Extension>
         </HomePhone>
         <Email>andy@hotmail.com</Email>
      </ContactDetails>
      <BillingDetails>
        <Name>
          <Title>Mr</Title>
          <NamePartList>
            <NamePart>Andy</NamePart>
            <NamePart>S</NamePart>
            <NamePart>Peterson</NamePart>
          </NamePartList>
        </Name>
        <Address>
           <Company></Company>
           <Flat>22A</Flat>
           <BuildingName>Dean's Court</BuildingName>
           <BuildingNumber>3</BuildingNumber>
           <Street>St. George Street</Street>
           <Locality>Redland</Locality>
           <City>Bristol</City>
           <Province>Avon</Province>
           <Postcode>BS8 6GC</Postcode>
           <CountryCode>GB</CountryCode>
        </Address>
        <CreditCard>
           <Company></Company>
           <NameOnCard>
            <NamePartList>
              <NamePart>Mr Andy S Peterson</NamePart>
            </NamePartList>
           </NameOnCard>
           <Number>5411666677775555</Number>
           <SecurityCode>887</SecurityCode>
           <ExpiryDate>01/07</ExpiryDate>
           <StartDate>01/03</StartDate>
           <CardType>MasterCard</CardType>
           <IssueNumber>0</IssueNumber>
        </CreditCard>
      </BillingDetails>
    </BookingProfile>
  </ProcessTerms>
</CommandList>

The response will contain a TFBookingReference element. This is the TRAVELfusion booking reference for this booking (note that the booking is not actually executed until the StartBooking request is submitted). A Router is also returned which will contain any new data related to the flight/ price. For example in the XML below, a 'Credit card surcharge' is returned which was not known until this stage since it depends upon the card type. Note that the XML below is for an easyjet flight and is not related to the previous examples. See the Detailed XML Specification for more details of the terms request/ response and the handling of bookings in general.

ProcessTerms response XML example:

<CommandList>
  <ProcessTerms>
    <RoutingId>B1MGUR1D506SYHWL</RoutingId>
    <TFBookingReference>B1KL3B76P</TFBookingReference>
    <Router>
      <Supplier>easyjet</Supplier>
      <Complete>true</Complete>
      <RequestedLocations>
        <Origin>
          <Type>airport</Type>
          <Code>LGW</Code>
        </Origin>
        <Destination>
          <Type>airport</Type>
          <Code>MAD</Code>
        </Destination>
      </RequestedLocations>
      <GroupList>
        <Group>
          <Id>3NCVJ6W86SOMWXRK</Id>
          <OutwardList>
            <Outward>
              <Id>AGG6M1JGCAZEXY0F</Id>
              <CacheInfo>
                <CacheDataAgeSeconds>0</CacheDataAgeSeconds>
              </CacheInfo>
              <Duration>155</Duration>
              <SegmentList>
                <Segment>
                  <Origin>
                    <Type>airport</Type>
                    <Code>LGW</Code>
                  </Origin>
                  <Destination>
                    <Type>airport</Type>
                    <Code>MAD</Code>
                  </Destination>
                  <DepartDate>26/06/2006-07:40</DepartDate>
                  <ArriveDate>26/06/2006-11:15</ArriveDate>
                  <Duration>155</Duration>
                  <Operator>
                    <Name>easyjet</Name>
                    <Code>U2</Code>
                  </Operator>
                  <VendingOperator>
                    <Name>easyjet</Name>
                    <Code>U2</Code>
                  </VendingOperator>
                  <FlightId>
                    <Code>5475</Code>
                    <Number>5475</Number>
                  </FlightId>
                  <TravelClass>
                    <TfClass>Economy With Restrictions</TfClass>
                    <SupplierClass>Economy With Restrictions</SupplierClass>
                  </TravelClass>
                  <SegmentMayEndWithAStop>false</SegmentMayEndWithAStop>
                </Segment>
              </SegmentList>
              <Vendor>
                <Name>EasyJet</Name>
                <Url>http://www.easyjet.com/</Url>
              </Vendor>
            </Outward>
          </OutwardList>
          <Price>
            <Amount>61.44</Amount>
            <Currency>GBP</Currency>
            <PriceIncludesTax>true</PriceIncludesTax>
            <TaxIsEstimated>false</TaxIsEstimated>
            <TaxItemList>
              <TaxItem>
                <Name>Credit card surcharge</Name>
                <Amount>4.95</Amount>
                <Currency>GBP</Currency>
              </TaxItem>
            </TaxItemList>
          </Price>
        </Group>
      </GroupList>
      <SupplierInfoList>
        <SupplierInfo>
          <DisplayName>Terms and Conditions</DisplayName>
          <InfoType>url</InfoType>
          <Info>http://www.easyjet.com/en/book/conditions.php</Info>
        </SupplierInfo>
      </SupplierInfoList>
    </Router>
  </ProcessTerms>
</CommandList>

Step 6: Starting the booking

The StartBooking XML request is used to execute the booking. The TFBookingReference should have the value returned in the previous ProcessTerms response. The FakeBooking element is used for development purposes to request a simulated booking. If the FakeBooking element is omitted, a real booking will be made. See the Detailed Specification for more details of fake bookings and booking handling in general.

StartBooking request XML example:

The StartBooking request is asynchronous, so a response will be returned immediately (whilst the booking is still in progress in the 'background'). The response will contain no useful information. The CheckBooking request, described below in step 7, is used to retrieve the final status of the booking.

StartBooking response XML example:

Step 7: Retrieving the booking status

The CheckBooking XML request is used to get the latest status of the booking. The TFBookingReference should have the value returned in the previous ProcessTerms response.

CheckBooking request XML example:

The CheckBooking response returns the latest status of the booking. While TRAVELfusion is waiting for a response from the supplier, the status will be 'BookingInProgress'. In this case the CheckBooking request should be resubmitted after a few seconds delay.

CheckBooking response XML example while booking is still in progress:

In some cases, the supplier may require special verification of the credit card. This involves forwarding the customer to a URL operated by the card issuer (visa/ mastercard etc). The user then enters a password on the card issuer's website and is returned to a specified URL. The mechanics of this process are explained in detail in the Card Verification Handling Guide.

Once the booking has been completed, the CheckBooking response will contain a different status. For a successful booking the status will be 'Succeeded' and the supplier's booking reference will be returned. A failed booking will have status 'Failed'. There are also situations where the booking has completed but the status is uncertain. For more details of how to handle these cases and bookings in general, please see the Detailed Specification, with particular reference to the Booking handling guide.

CheckBooking response XML example once booking is complete:

About TRAVELfusion | Contact Our API Support Team | Latest API Change - 2nd January