Hotel API · Booking flow
HotelBookingCreation()
This function is dedicated to creating the booking.
Request
<HotelBookingCreationREQ>
<Credential>
<Login>?</Login>
<Password>?</Password>
</Credential>
<User>?</User>
<Language>?</Language>
<FromDate>?</FromDate>
<ToDate>?</ToDate>
<HotelID>?</HotelID>
<HotelTitle>?</HotelTitle>
<QuoteId>?</QuoteId>
<IdToken>?</IdToken>
<Nationality>XX</Nationality>
<SourceMarket>?</SourceMarket>
<Source>?</Source>
<Recommandation>?</Recommandation>
<CodePromo>?</CodePromo>
<expectedprice tolerance="’?’">?</expectedprice>
<onlyavailable>?</onlyavailable>
<Timeout>?</Timeout>
<HotelCollect>?</HotelCollect>
<SelectedRooms>
<SelectedRoom id="’1’" title="?" >
<Adult>2</Adult>
<Child>0</Child>
<Infant>0</Infant>
<OfferId>?</OfferId>
<Boarding id="’?’" title="?"/>
<Customers>
<Customer holder=”true”>
<Civility>?</Civility>
<FirstName>?</FirstName>
<LastName>?</LastName>
<Age></Age>
</Customer>
<Customer>
<Civility>?</Civility>
<FirstName>?</FirstName>
<LastName>?</LastName>
<Age></Age>
</Customer>
</Customers>
<Recommandation>?</Recommandation>
</SelectedRoom>
<SelectedRoom id="’2’">
<Adult>1</Adult>
<Child>0</Child>
<Infant>0</Infant>
<OfferId>?</OfferId>
<Boarding id="’?’" />
<Customers>
<Customer>
<Civility>?</Civility>
<FirstName>?</FirstName>
<LastName>?</LastName>
<Age></Age>
</Customer>
</Customers>
<Recommandation>?</Recommandation>
</SelectedRoom>
<SelectedRoom id="’3’">
<Adult>1</Adult>
<Child>2</Child>
<Infant>0</Infant>
<Boarding id="’?’" />
<OfferId>?</OfferId>
<Customers>
<Customer>
<Civility>?</Civility>
<FirstName>?</FirstName>
<LastName>?</LastName>
<Age></Age>
</Customer>
<Customer>
<Civility>?</Civility>
<FirstName>?</FirstName>
<LastName>?</LastName>
<Age>3</Age>
</Customer>
<Customer>
<Civility>?</Civility>
<FirstName>?</FirstName>
<LastName>?</LastName>
<Age>6</Age>
</Customer>
</Customers>
<Recommandation>?</Recommandation>
</SelectedRoom>
<SelectedRoom id="’4’">
<Adult>2</Adult>
<Child>2</Child>
<Infant>0</Infant>
<OfferId>?</OfferId>
<Boarding id="’?’" />
<Customers>
<Customer>
<Civility>?</Civility>
<FirstName>?</FirstName>
<LastName>?</LastName>
<Age></Age>
</Customer>
<Customer>
<Civility>?</Civility>
<FirstName>?</FirstName>
<LastName>?</LastName>
<Age></Age>
</Customer>
<Customer>
<Civility>?</Civility>
<FirstName>?</FirstName>
<LastName>?</LastName>
<Age>4</Age>
</Customer>
<Customer>
<Civility>?</Civility>
<FirstName>?</FirstName>
<LastName>?</LastName>
<Age>7</Age>
</Customer>
</Customers>
<Recommandation>?</Recommandation>
</SelectedRoom>
…
</SelectedRooms>
<IdAssignedUserPayment></IdAssignedUserPayment>
<PaymentMode>
<Id>?</Id>
<TotalRate>?</TotalRate>
</PaymentMode>
<Kit>
<PaymentGateway>?</PaymentGateway>
<SecurityCode>?</SecurityCode>
<IdAutorisation>?</IdAutorisation>
<CardType>?</CardType>
<CardBank>?</CardBank>
<BankCountry>?</BankCountry>
<CardNumber>?</CardNumber>
<ClientLastName>?</ClientLastName>
<ClientFirstName>?</ClientFirstName>
<ClientEmail>?</ClientEmail>
</Kit>
<PaymentDetails>
<Name>?</Name>
<CardNumber>?</CardNumber>
<CVC>?</CVC>
<ExpiryDate>?</ExpiryDate>
</PaymentDetails>
<Customer>
<Id>?</Id>
<Email>?</Email>
</Customer>
</HotelBookingCreationREQ>| Root | Sub Root | Description | Valeurs & Format | Tag |
|---|---|---|---|---|
| Credential | Mandatory | |||
| Login | Login | Text | ||
| Password | Password | Text | ||
| User | Current user ID | Numeric | Mandatory | |
| Language | Cyberesa language code | Numeric 1: French 2: English | Mandatory | |
| HotelID | The selected hotel | Text | Mandatory | |
| HotelTitle | the Hotel title | Text | Mandatory If B2C with <source> | |
| QuoteId | booking operation code | Numeric | Mandatory | |
| IdToken | A unique Token id, you can pass in request in order to send the reservation id of the buyer to the seller and in case of time-out, to verify later if the booking goes through or not via calling the BookingList API | Text | Optional | |
| Nationality | Nationality of the client, if available | 2 letters in uppercase iso-code : FR GB DE IT RO | Optional | |
| SourceMarket | Source market of the reservation, if available | 2 letters in uppercase iso-code : FR GB DE IT RO | Optional | |
| Source | ID Source of the 3rd party supplier | Numeric | Mandatory if reservation is through a 3rd party supplier | |
| CodePromo | Code promo to be used when calculating final price | Text | Optional | |
| expectedprice | Expected price of the booking. If not respected than booking creation will fail | Numeric | Mandatory | |
| expectedprice : @tolerance | How much %pc is tolerated if expectedprice is different from real price | Numeric | Optional "0" or "1" or … | |
| onlyavailable | Booking creation will fail if onlyAvailable is True and booking is not available | Boolean (True/False) | Optional | |
| Recommandation | Client recommandations for the booking | Text | Optional. Use with precaution to not include recommandation that may impact total price of the booking | |
| Timeout | maximum accepted response time in milliseconds, if it takes beyond that limit then cancel the booking | Numeric | Optional | |
| FromDate | Search start date | dd/mm/yyyy | Mandatory | |
| ToDate | Search end date | dd/mm/yyyy | Mandatory | |
| HotelCollect | Indicates whether the client will pay directly at the hotel (hotel-collect) or to the vendor (vendor-collect) | Boolean (True/False) | Optional | |
| SelectedRooms | SelectedRooms:SelectedRoom:@id | Id of the selected room | Numeric | Mandatory |
| SelectedRooms:SelectedRoom: | Offer Identifier for the selected room. | Text | Mandatory for international api bookings | |
| SelectedRooms:SelectedRoom:Title | the room title | Text | Mandatory If B2C with <source> | |
| SelectedRooms:SelectedRoom:Adult | Adult count for the current room configuration | Numeric | Mandatory | |
| SelectedRooms:SelectedRoom:Child | Child count for the current room configuration | Numeric | Mandatory | |
| SelectedRooms:SelectedRoom:Infant | Infant count for the current room configuration | Numeric | Optional | |
| SelectedRooms:SelectedRoom:OfferId | OfferId (offer identifier) | Text | Mandatory if returned in HotelQuoteRES. Use same value in HotelQuoteRES | |
| SelectedRooms:SelectedRoom:Recommandation | recommandations for this room | Text | Optional. Use with precaution to not include recommandation that may impact total price of the booking | |
| SelectedRooms:SelectedRoom: Boarding:@id | Id of the selected boarding | Numeric | Mandatory | |
| SelectedRooms:SelectedRoom: Boarding:Title | the boarding title | Text | Mandatory If B2C with <source> | |
| SelectedRooms:SelectedRoom:Customers | Details of room’s passengers | Text | Mandatory | |
| SelectedRooms: SelectedRoom:Passengers: Customer:Civility | Current passenger civility Possible values : Mr or Mrs or Ms | Text | Mandatory | |
| SelectedRooms: SelectedRoom:Passengers: Customer:FirstName | Current passenger first name | Text | Mandatory | |
| SelectedRooms: SelectedRoom:Passengers: Customer:LastName | Current passenger last name | Text | Mandatory | |
| SelectedRooms: SelectedRoom:Passengers: Age | Child age (only for children, DO NOT PASS for adults !!!) | Numeric | Mandatory for children DO NOT PASS for adults !!! | |
| IdAssignedUserPayment | Current agent: Available only for B2C | Numeric | only for B2C API | |
| PaymentMode | PaymentMode : Id | Selected payment mode 1: OnlineDownPayment 2: OnlineFullPayment 3: POSFullPayment 4: POSDownPayment 5: HotelCollect | Numeric | only for B2C API |
| PaymentMode : TotalRate | The total amount paid | Numeric | only for B2C API | |
| Kit | Optional | |||
| Kit: PaymentGateway | Payment mode : Available only for B2C | Numeric | 4 : offline 6 : sps 8 : mtc Note : booking status will be reserved when you send 4 other case will be confirmed | |
| Kit:SecurityCode | 3DS | Boolean | 1 0 | |
| Kit:IdAutorisation | Id of autorisation | Text | ||
| Kit:CardType | Type of card | Text | ||
| Kit:CardBank | Bank of card | Text | ||
| Kit:BankCountry | Country of bank | Text | ||
| Kit:CardNumber | Number of card | Text | ||
| Kit:ClientLastName | Last name of client | Text | ||
| Kit:ClientFirstName | First name of client | Text | ||
| Kit:ClientEmail | Email of client | Text | ||
| PaymentDetails | ||||
| PaymentDetails: Name | Name of payment card owner | Text | Mandatory if PaymentDetails node exist | |
| PaymentDetails: CardNumber | Card Number of the bank card | Text | Mandatory if PaymentDetails node exist | |
| PaymentDetails: CVC | CVC code | Text | Optional if PaymentDetails node exist | |
| PaymentDetails: ExpirationDate | Card expiration date in AAAAMM format. | Text: AAAAMM Example: 202012 | Mandatory if PaymentDetails node exist | |
| Customer | Available only in B2C | only for B2C API | ||
| Customer:Id | Id of customer | Numeric | ||
| Customer:Email | Email of customer | Text |
Response
<HotelBookingCreationRES>
<ErrorResult id="?">
<Message>?</Message>
</ErrorResult>
<User>?</User>
<FromDate>?</FromDate>
<ToDate>?</ToDate>
<Language>?</Language>
<Currency>?</Currency>
<City id="’?’">?</City>
<Destination id="’?’">?</Destination>
<HotelID>?</HotelID>
<HotelTitle>?</HotelTitle>
<Category>?</Category>
<OrderDetails id="’?’" idtoken="’?’" password="’?’" OfferId=”?”>
<CancellationPolicies>
<CancellationPolicy>
<FromDate>?</FromDate>
<Fees>?</Fees>
</CancellationPolicy>
</CancellationPolicies>
<NoShowPolicy>
<Fee>?</Fee>
</NoShowPolicy>
<Rooms>
<Room id="’?’">
<Adult>?</Adult>
<Child>?</Child>
<Infant>?</Infant>
<Title>?</Title>
<Boarding id="?">
<Rate>?</Rate>
<Title>?</Title>
<TariffNotes>?</TariffNotes>
</Boarding>
<Passengers>
<Passenger>
<Civility>?</Civility>
<FirstName>?</FirstName>
<LastName>?</LastName>
<Age>?</Age>
<Reduction id="’?’">?</Reduction>
</Passenger>
</Passengers>
<Supplements>
<Supplement>
<Title>?</Title>
<Rate currency=””>?</Rate>
</Supplement>
</Supplements>
</Room>
</Rooms>
<State id="’?’">?</State>
<TotalNetRate>?</TotalNetRate>
<TotalRate>?</TotalRate>
<GlobalSupplement>?</GlobalSupplement>
</OrderDetails>
<HotelCheckinUrl>https://www.website.com/checkin/0000-0000</HotelCheckinUrl>
<HotelCheckinStartingDate>01/01/2021</HotelCheckinStartingDate>
<PaymentDetails>
<TransactionId>?</TransactionId>
<AuthorizationId>?</AuthorizationId>
</PaymentDetails>
<PaymentMode>
<Id>?</Id>
<TotalRate>?</TotalRate>
</PaymentMode>
</HotelBookingCreationRES>| Racine | Sous racine | Description | Valeurs & Format | Tag |
|---|---|---|---|---|
| ErrorResult | Operation State | |||
| ErrorResult:@id | Id of current error | Numeric | ||
| Message | Appropriate message | Text | ||
| User | Current user ID | Numeric | ||
| FromDate | Search start date | dd/mm/yyyy | ||
| ToDate | Search end date | dd/mm/yyyy | ||
| Language | Language code | Text | ||
| Currency | Currency code | Numeric | ||
| City | City Name | Text | ||
| City :@Id | City Id | Numeric | ||
| Destination | Destination Name | Text | ||
| Destination :@Id | Destination ID | Numeric | ||
| HotelID :@Id | Id of the selected Hotel | Text | ||
| HotelTitle | Hotel Name | Text | ||
| Category | Hotel Category | Numeric | ||
| OderDetails :@id | Id of the order | |||
| OderDetails :@idToken | Id Token of the order | Numeric | ||
| OderDetails :@password | Order password | |||
| OderDetails :@OfferId | the offer identifier for some 3rd party suppliers | Text | ||
| CancellationPolicies | CancellationPolicies | |||
| CancellationPolicies :CancellationPolicy :FromDate | CancellationPolicy start date | dd/mm/yyyy | ||
| CancellationPolicies :CancellationPolicy :Fees | Cancellation Policy fee rate | Decimal | ||
| NoShowPolicy | NoShow Policy | |||
| NoShowPolicy :Fee | NoShow policy fee rate | Decimal | ||
| Rooms :Room :@id | Id of the current selected room | Numeric | ||
| Rooms :Room :Adult | Adult’s count of the current selected room | Numeric | ||
| Rooms :Room :Child | Children count of the current selected room | Numeric | ||
| Rooms :Room :Infant | Infants count of the current selected room | Numeric | ||
| Rooms :Room :Title | Selected Room Title | Text | ||
| Rooms:Room:Supplement | Supplement of the room | Text | ||
| Rooms :Room :Boarding :@id | Id of the selected boarding | Numeric | ||
| Rooms :Room :Boarding :Rate | Rate of the current selected boarding | Numeric | ||
| Rooms :Room :Boarding :TariffNotes | Display any comment about the related rate like "You will pay upon arrival a tax charge of XXX for the YY night(s)" or if NRF: "This booking is non-refundable"..etc. | Text | ||
| Rooms :Room :Boarding :Title | Selected Boarding Title | Text | ||
| Rooms :Room :Passengers :Passenger | One Passenger details for the current selected room | |||
| Rooms :Room :Passengers :Passenger :Civility | Civility of the current passenger | Text | ||
| Rooms :Room :Passengers :Passenger :FirstName | FirstName of the current passenger | Text | ||
| Rooms :Room :Passengers :Passenger :LastName | LastName of the current passenger | Text | ||
| Rooms :Room :Passengers :Passenger :Age | Age of child passenger | Number | Optional | |
| Rooms :Room :Passengers :Passenger : Reduction:@id | Id of reduction | Numeric | Optional | |
| Rooms :Room :Passengers :Passenger : Reduction | Title of reduction | Text | Optional | |
| Rooms :Room :Supplements:Supplement | Supplements details for the current room | Text | Optionnel | |
| Rooms :Room :Supplements:Supplement:Title | Supplement Title | Text | ||
| Rooms :Room :Supplements:Supplement:Rate | Rate of the supplement | Text | ||
| Rooms :Room :Supplements:Supplement:Rate:@currency | Currency code of the rate | Numeric | ||
| TotalRate | Total order rate | Numeric | ||
| TotalNetRate | Total order net rate (cost) | Numeric | Optional (B2C distribution) | |
| State | Order state | Text | ||
| State:@id | Id state | Numeric | 4 : The hotel is available and your booking is confirmed, a voucher is issued 1 : The hotel is available and your booking is confirmed as reserved, no voucher is issued 0 : the hotel is not available is your booking is saved as onrequest | |
| HotelCheckinUrl | URL of hotel online express check-in page for this booking. | Text | If returned, this link must be displayed on the reservation voucher. Customers are supposed to check-in online before arrival to the hotel. | |
| HotelCheckinStartingDate | The starting date when the hotel online express check-in is open. | dd/mm/yyyy | Starting from this date online check-in is open. This information should be shown to the customer. | |
| PaymentDetails | ||||
| PaymentDetails: TransactionId | Payment Transaction Id number | Numeric | Payment Transaction number (if paid by bank card) | |
| PaymentDetails:AuthorizationId | Payment Authorization code | Numeric | Payment Authorization code (if paid by bank card) | |
| GlobalSupplement | Global Supplement | Numeric | ||
| HotelArrivalHour | CheckIn Hour | Text | Optional | |
| HotelDepartureHour | CheckOut Hour | Text | Optional | |
| PaymentMode | PaymentMode:Id | Selected payment mode 1: OnlineDownPayment 2: OnlineFullPayment 3: POSFullPayment 4: POSDownPayment 5: HotelCollect | Numeric | only for B2C API |
| PaymentMode: TotalRate | the total amount paid | Numeric | only for B2C API |