Embedded Files
The book request and response is the final stage of the booking journey and makes the reservation of the property with the supplier. The customer can optionally pay at this point of the booking and if so, must also send credit card details in the book request.
The book response will return a return status to indicate if the booking was successfully made, along with the booking reference, and details of any further payments due on the booking and the cost of cancelling the booking.
Request
Request
The structure of this XML will be the standard Basket Book Request call, which will include a Property Book Request.
The XML structure of the PropertyBookRequest is as follows:
Response
Response
The Basket Book Response returns a BookingReference, TotalPrice, TotalCommission and list of PaymentsDue, irrespective of which components have been booked. The BasketBookResponse also includes a list of BookResponses for each component that has been booked - in this case property bookings.Â
The structure of the Basket Book Response is available here .
The XML structure of the PropertyBookResponse is as follows.
Example XML
Example XML
Request
<BasketBookRequest>
<LoginDetails>
<Login>TestLogin</Login>
<Password>TestPassword</Password>
</LoginDetails>
<LeadCustomer>
<CustomerAddress2></CustomerAddress2>
<CustomerTownCity>Croydon</CustomerTownCity>
<CustomerCounty>Surrey</CustomerCounty>
<CustomerPostcode>CR0 6SY</CustomerPostcode>
<CustomerBookingCountryID>1</CustomerBookingCountryID>
<CustomerPhone>02086810000</CustomerPhone>
<CustomerFax />
<CustomerEmail>test@domain.co.uk</CustomerEmail>
<CustomerTitle>Ms</CustomerTitle>
<CustomerFirstName>Jane</CustomerFirstName>
<CustomerLastName>Smith</CustomerLastName>
<CustomerAddress1>10 Oak Drive</CustomerAddress1>
</LeadCustomer>
<GuestDetails>
<GuestDetail>
<GuestID>1</GuestID>
<Type>Adult</Type>
<Title>Ms</Title>
<FirstName>Jane</FirstName>
<LastName>Smith</LastName>
<Age>25</Age>
<DateOfBirth>1988-06-17</DateOfBirth>
</GuestDetail>
<GuestDetail>
<GuestID>2</GuestID>
<Type>Adult</Type>
<Title>Mr</Title>
<FirstName>John</FirstName>
<LastName>Doe</LastName>
<Age>25</Age>
<DateOfBirth>1988-02-22</DateOfBirth>
</GuestDetail>
</GuestDetails>
<Payment>
<CCIssueNumber>012</CCIssueNumber>
<Amount>280.00</Amount>
<TotalAmount>280.00</TotalAmount>
<PaymentType>CreditCard</PaymentType>
<CCCardHoldersName>MS J SMITH</CCCardHoldersName>
<CCCardTypeID>1</CCCardTypeID>
<CCCardNumber>4444444444444448</CCCardNumber>
<CCStartMonth>03</CCStartMonth>
<CCStartYear>2011</CCStartYear>
<CCExpireMonth>03</CCExpireMonth>
<CCExpireYear>2014</CCExpireYear>
<CCSecurityCode>0123</CCSecurityCode>
</Payment>
<PropertyBookings>
<PropertyBookRequest>
<BookingToken>77XHIv7Wgmh5VXW2Svh06/5h3n4BK3QdBdzUR9+gmJ0=</BookingToken
<ArrivalDate>2013-09-24</ArrivalDate>
<Duration>7</Duration>
<Request></Request>
<ExpectedTotal>280</ExpectedTotal>
<RoomBookings>
<RoomBooking>
<RoomBookingToken>...</RoomBookingToken>
<GuestIDs>
<GuestID>1</GuestID>
<GuestID>2</GuestID>
</GuestIDs>
</RoomBooking>
</RoomBookings>
</PropertyBookRequest>
</PropertyBookings>
</BasketBookRequest>
Response
<BasketBookResponse>
<ReturnStatus>
<Success>true</Success>
<Exceptions />
</ReturnStatus>
<BookingReference>1000384</BookingReference>
<TotalPrice>280.0</TotalPrice>
<TotalCommission>0.0</TotalCommission>
<VATOnCommission>0.0</VATOnCommission>
<PropertyBookings>
<PropertyBookResponse>
<ReturnStatus>
<Success>true</Success>
<Exceptions />
</ReturnStatus>
<BookingReference />
<TotalPrice>280.00</TotalPrice>
<TotalCommission>0.0</TotalCommission>
<VATOnCommission>0.0</VATOnCommission>
<PayLocalTotal>0</PayLocalTotal>
<PaymentsDue />
<Cancellations>
<Cancellation>
<StartDate>2013-08-06T00:00:00</StartDate>
<EndDate>2013-08-12T00:00:00</EndDate>
<Amount>55.35</Amount>
</Cancellation>
<Cancellation>
<StartDate>2013-08-13T00:00:00</StartDate>
<EndDate>2013-08-26T00:00:00</EndDate>
<Amount>129.15</Amount>
</Cancellation>
<Cancellation>
<StartDate>2013-08-27T00:00:00</StartDate>
<EndDate>2013-09-02T00:00:00</EndDate>
<Amount>147.60</Amount>
</Cancellation>
<Cancellation>
<StartDate>2013-09-03T00:00:00</StartDate>
<EndDate>2013-09-09T00:00:00</EndDate>
<Amount>184.50</Amount>
</Cancellation>
<Cancellation>
<StartDate>2013-09-10T00:00:00</StartDate>
<EndDate>2013-09-18T00:00:00</EndDate>
<Amount>280.00</Amount>
</Cancellation>
</Cancellations>
</PropertyBookResponse>
</PropertyBookings>
<FlightBookings />
<TransferBookings />
<ExtraBookings />
<PaymentsDue>
<PaymentDue>
<Amount>280.0</Amount>
<DateDue>2013-08-06T00:00:00</DateDue>
</PaymentDue>
</PaymentsDue>
<QuoteID>0</QuoteID>
</BasketBookResponse>
Page updated
Report abuse