Developer Docs
  • Our Products
    • Channel Manager
      • Integration and Onboarding Flow
      • RG Bridge - Supply (Push)
        • Integration Overview
          • Vision of Integration
            • Commercial value and business case
          • Information Data flow
            • One way integration
            • Two Way integration – ARI Broadcast and Reservation fetch
            • Information delivery mechanism
          • Technical feasibility of integration
            • Test property setup
            • Sample reservation data
          • RG Bridge Setup
          • Contract
          • Project Plan
          • Certification
          • Monitoring and after sales support
          • Integration checklist
        • Interface Specifications – Availability and Rates Notification Service
          • RG Bridge Integration Process
          • Intended Audience
          • Typographical Conventions
          • Technical Overview
          • Operations
            • Availability Notification
              • OTA_HotelAvailNotifRQ
                • Change in Inventory count
                • Change in availability status and Restrictions
              • OTA_HotelAvailNotifRS
              • XML Usage Specification
            • Rate Change Notification
              • OTA_HotelRateAmountNotifRQ
              • XML Usage Description
              • OTA_HotelRateAmountNotifRS
              • XML Usage Specification
            • Points to remember
        • Interface Specifications – Reservation Notification Service
          • RG Bridge integration process
          • Intended audience
          • Typographical conventions
          • Technical overview
          • Operations
            • Reservation Notification
              • OTA_HotelResNotifRQ
              • XML Usage specification
              • Sample Reservation Messages
              • OTA_HotelResNotifRS
              • XML Usage specification
          • Points to remember
          • Code Lists
      • RG Bridge - Reservation Retrieval (Pull)
        • Technical overview
        • Operations
          • Reservation Retrieval
            • OTA_ReadRQ
            • XML Usage specification
            • OTA_ResRetrieveRS
            • XML Usage specification
          • Reservation Confirmation
            • OTA_NotifReportRQ
            • XML Usage specification
            • OTA_NotifReportRS
            • XML Usage specification
        • Code Lists
      • Direct Connect - Demand (Push)
        • Introduction
        • Interface Specifications – ARI Service
          • Technical Overview
          • Operation: Property List
            • HotelPropertyListGetRQ
            • HotelPropertyListGetRS
            • Test Use Cases
            • FAQ
          • Operation: Product List
            • HotelProductListGetRQ
            • HotelProductListGetRS
            • Test Use Cases
            • FAQ
          • Operation: ARI Get
            • HotelARIGetRQ
            • HotelARIGetRS
            • Test Use Cases
            • FAQ
          • Operation: ARI Update
            • HotelARIUpdateRQ
            • HotelARIUpdateRS
            • Test Use Cases
            • FAQ
          • Points to remember
          • Code Lists
        • Interface Specifications – Reservation Notification Service
          • Technical overview
            • Communication protocols
            • General design
            • Authentication
          • Operation: Reservation
            • OTA_HotelResNotifRQ
            • OTA_HotelResNotifRS
            • Test use cases
            • FAQ
    • Smart Distribution
      • Onboarding process
      • Certification - Demand
      • Authentication Method
      • Book and Cancel Reservation
        • Transaction Header Formats
        • Book API
          • Book Reservation
          • Cancel Reservation
          • Booking Reservation Request Message Format
          • Booking Reservation Response Message Format
          • Cancel Reservation Request Message Format
      • Multiavailability (Enhanced Shopping Transaction)
        • Transaction Header Formats
        • Enhanced Shopping (EST) – Detailed Rate Information
          • Requesting Specific Rates
          • UltraDirect Account Author Negotiated Rate Processing
          • Unavailable Properties
          • UltraDirect Cache Processing
          • Enhanced Shopping Transaction Request Header Format
          • Enhanced Shopping Transaction Response Message Format
      • Pre-Book
        • Transaction Header Formats
        • Pre Book API
          • Pre-Book Request message format
          • Pre-Book Response message format
      • Property list and Booking Summary
        • PropertyList API
        • Booking Summary API
  • Content
    • Integration Process
    • Certification - Demand
    • Content Retrieve
      • SOAP/HTTP
        • SOAP Envelop
        • SOAP Body
        • Date and Time
        • Specifications for Currency Amounts
      • Transaction Specifications
      • Content Retrieval Request
      • Content Retrieval Response
    • Content Update
      • Overview
      • Transaction List
      • Transaction Flow
      • Batch processing
        • File naming convention
      • Multi-lingual capabilities
      • Associating media to textual content
      • Managing images
      • GDS content updates
      • Office of Foreign Assets Control (OFAC)
      • Interface requirements
        • SOAP envelope
        • Standard element formats
      • Transaction specifications
        • Data mapping of elements
        • Area Information
        • Affiliation information
        • Media information
        • Contact information
        • TPA extensions
        • GDS information
        • Response message
      • Codes lists
        • Credit Card
        • Error and Warning codes
        • Spoken Language
        • State and Country
      • Supported language codes
      • Client application generation using WSDL tool
  • UltraDirect
    • Integration Process
    • Certification
    • Ultradirect transaction sets - XML
      • Transaction header formats
      • Booking transactions
        • Booking request message format..
        • Request message format - Cancel
        • Request message format - Commit/Rollback
        • Request message format - Modify
        • Response message format - Booking
      • Enhanced shopping (EST)
        • Requesting Specific Rates
        • Request message format
        • Response message format.
      • Rate and availability transactions
        • Standard multi-availability
          • Request & Response message format
      • Rate Rules
        • Request message format
        • Response message format
      • Reference data transactions
        • Request message format..
        • Response message format..
      • Single property availability
        • Request message format
        • Response message format
    • XML ultradirect specifications
      • Overview
        • Transaction list
      • Interface requirements
      • Transaction meta data
    • Error Codes..
    • UltraDirect Transaction Samples and Usage
      • Using UltraDirect (Seamless, a real-time transaction)
      • EST (Enhanced Shopping Transaction)
      • Rate Rules
      • Book Reservation
      • Cancellation
      • Book Reservation with session control
      • Modification
      • Booking Storage and Retrieval
      • List of Test Credit Cards
      • Test properties in UAT
      • Guarantee Type and Method Combinations
    • xml ultradirect codes
  • Get in Touch
    • Questions?
Powered by GitBook
On this page
  1. Our Products
  2. Smart Distribution
  3. Book and Cancel Reservation
  4. Book API

Book Reservation

The BookReservation transaction is used to create a new booking. The minimum required information typically includes:

Property, room type and rate plan codes

Arrival and departure dates

Number of guests and rooms

Guarantee method (this normally means sending the credit card details)

Primary guest’s name and contact details

Special requests or comments (optional)

Request Message

The following is an example booking request without session control (Passive participation):

<HotelML xmlns="http://www.xpegs.com/v2001Q3/HotelML">
<Head>
<Process DataPath="/HotelML/Form/BookReservation" Function="TI_BookReservationV1_1" Token="1307101856910"/>
<Route Destination="00" Source="01"/>
</Head>
<Form>
<BookReservation CurrencyCode="EUR" GuaranteeMethod="CreditCard" GuaranteeType="Guarantee" InDate="2011-07-01" OutDate="2011-07-04" PropertyCode="GT;042934" RatePlanCode="RAC" RoomRate="134.00" RoomTypeCode="A06">
<CreditCard ExpirationDate="2012-05" IssuedName="John Doe" Number="4321432143214327" TypeIdentifier="VI"/>
<Guest FirstName="John" LastName="Doe" NumberOfAdults="2" NumberOfRooms="1" Primary="true" Remarks="VIP
guest" ServiceRequest="Quiet room on high floor please">
<Email Address="john.doe@pegs.com"/>
<Phone Number="0123456789"/>
<PostalAddress City="Brentford" CountryCode="GB" Line1="2 Kew Bridge Road" PostalCode="TW8 0JF" />
</Guest>
</BookReservation>
</Form>
</HotelML>

Response Message

The response then includes the confirmation number:

<HotelML xmlns="http://www.xpegs.com/v2001Q3/HotelML">
<Head>
<Route Destination="01" Source="00">
<Operation Action="Create" App="TIDispatcher" AppVer="1.12.40.2.8.1" DataPath="/HotelML" StartTime="2011-06-
03T12:01:24.015+00:00" Success="true" TotalProcessTime="497"/>
</Route>
</Head>
<Reservation BookedRate="134.00" ConfirmationNumber="312919307911" CurrencyCode="EUR" HotelComments="VIP GUEST" HotelRoomType="A06RAC" InDate="2011-07-01" NumberOfPersons="2" OutDate="2011-07-04" PropertyCode="GT;042934"
RateGuaranteed="true" RatePlanCode="RAC" RoomTypeCode="A06" Token="1307101856910">
<CancelPolicy Description="CANCEL BY 1400 20110630 LOCAL PROPERTY TIME"/>
<GuaranteePolicy Description="CREDIT CARD GTD"/>
<Guest FirstName="John" LastName="Doe" NumberOfAdults="2" NumberOfRooms="1" Primary="true" Remarks="VIP guest" ServiceRequest="Quiet room on hig floor please">
<Email Address="john.doe@pegs.com"/>
<Phone Number="0123456789"/>
<PostalAddress City="Brentford" CountryCode="GB" Line1="2 Kew Bridge Road" PostalCode="TW8 0JF" StateCode="-
Select-"/>
</Guest>
</Reservation>
</HotelML>

Last updated 4 months ago