Attention: Please check the Hotel Release Notes page for the latest updates and enhancements.

Create Reservation Reference Payload API Reference

POST	book/reservations/build Base path: Pre-production https://api.pp.travelport.com/11/hotel/ Production https://api.travelport.com/11/hotel/

Use the Create Reservation reference payload request to book a room using a cached offer ID from the Availability response. The reference payload sends an offer ID plus traveler, form of payment, and payment information. It does not send full offer details as in the full payload request.

Offers cached from the Availability response are stored for 15 minutes. If a reservation with the offer ID is not created within 15 minutes, you must send a new Availability request before a reference payload request.

Multi-room sell requests

Travelport will attempt to sell the number of rooms requested, but the supplier may not be able to accommodate the total number of rooms. Each room sold will create a unique hotel segment in the Travelport PNR.

A Traveler name will be associated with each room with these limitations:

If the number of rooms requested is equal to the number of Traveler names in the request, each room will be associated with a different Traveler name
If the number of rooms requested is not equal to the number of Traveler names in the request, each room will be associated to the first Traveler name.

Request

Also see Authorization and Common Hotel API Headers.

Query Parameters

Travelport has introduced an automatic check of the rate used in the reservation request. If the guarantee type or price has changed from what was received in the availability response, Travelport will return an error instructing the user to decide to accept this change. If the user wants to accept the change, the relevant query parameter indicator (one or both) listed should be added and the CREATE/ADD request sent a second time.

Parameter	Description	Required/Optional
acceptPriceChangeInd	Boolean: true indicates that the user accepts any difference in the total price received in availability versus what is the current price in the sell process; false denotes that the user does not accept a price difference and the sell process should not complete. Default is false.	Optional
acceptGuaranteeChangeInd	Boolean: true indicates that the user accepts any difference in the guarantee type (guarantee required, deposit required, prepay required) received in availability versus what is the current guarantee type in the sell process; false denotes that the user does not accept a guarantee type difference and the sell process should not complete. Default is false.	Optional

Request Body

Show Request Body Table

The tables in this section break down the Create Reservation request response into its top level objects to separate the information in each.

Object	Description	Required/Optional
ReservationQueryBuild	Top level object for the request. Includes the ReservationBuild object.	Required

Object

Description

Required/Optional

ReservationQueryBuild

Top level object for the request.

Includes the ReservationBuild object.

Required

Offer object

Object	Description	Required/Optional
ReservationBuild	Top level object for hotel sell request by offer ID. Includes the BuildFromCatalogOfferingHospitality, Traveler, FormOfPayment, Payment, ReservationComment, and TravelAgency objects.	Required
BuildFromCatalogOfferingHospitality	Object signifying hospitality request. Top level object for offer identifiers from the Availability response. Includes CatalogOfferingIdentifier object.	Required
numberOfRooms	Number. Supports values 1-9 inclusive. Number of rooms requested at a single property. If not present, defaults to one room.	Optional
CatalogOfferingIdentifier	Top level object for offer identifier.	Required
value	String. Send the offer identifier from the Availability response.	Required

Traveler object

Object	Description	Required/Optional
Traveler	Traveler details. Includes PersonName, Telephone, Email, and CustomerLoyalty objects.	Required
PersonName	Traveler details. Travelport+ limits the combination of Given and Surname to 22 characters. Given name must have at least one character. PersonName exceeding 22 characters is truncated in the response.	Required
Given	String. Traveler first name.	Required
Surname	String. Traveler last name.	Required
Prefix	String. Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)	Optional
Telephone	Traveler telephone details.	Required
countryAccessCode	String. Phone country code.	Optional
phoneNumber	String. Phone number.	Required
areaCityCode	String. Phone local area code.	Required
cityCode	String. Phone city code.	Optional
Email	Traveler email address. Booking.com and Expedia require a traveler email address in the Create Reservation and Add Reservation requests. Both systems send a confirmation email to the traveler moments after the booking completes.	Required for certain suppliers
value	String. Traveler email address.	Required
CustomerLoyalty	One frequent guest number and / or one frequent flyer number.	Optional
programId	String. Two character hotel or air supplier code or brand code of the loyalty program.	Required if object used.
value	String. Number on loyalty card.	Required if object used.
supplierType	String. “hotel” for designating frequent guest or “air” for designating frequent flyer.	Required if object used.

FormOfPayment object

Object	Description	Required/Optional
FormOfPayment	Top level object for form of payment details. Includes PaymentCard.	Required
PaymentCard	Form of payment details. Includes CardNumber, SeriesCode, Telephone, and Address objects.	Required
expireDate	String. Credit card expiration date in MMYY format.	Required
CardType	String. Type of card including Credit, Debit, and Gift.	Required
CardCode	String. Code for credit card type.	Required
CardHolderName	String. Name on credit card.	Required
CardNumber	Card number details.	Required
PlainText	String. Credit card number.	Required
SeriesCode	Security code of card.
PlainText	String. The credit card three- or four-digit CVV code. Booking.com and Expedia require the CVV code.	Required for certain suppliers.
Telephone	Telephone information associated with card.
countryAccessCode	String. Phone country code.	Optional
phoneNumber	String. Phone number.	Optional
areaCityCode	String. Phone local area code.	Optional
cityCode	String. Agency city code.	Optional
Address	Billing address details. Includes Number, Street, AddressLine, City, StateProv, Country, and PostalCode objects.	Optional
Number	Top level object for street number of billing address.	Optional
value	String. Street number value.	Optional
Street	String. See name value.	Optional
AddressLine	String. Address number and street name.	Optional
City	String. The city of the billing address.	Optional
County	String. The county of the billing address.	Optional
StateProv	Top level state or province object.	Optional
value	String. State or province of billing address.	Optional
name	String. Full state or province name.	Optional
Country	Country of billing address.	Optional
Value	String. Standard two-letter coded value for country.	Optional
Id	String. Custom user-assigned identifier for the country	Optional
Name	String. Full country name.	Optional
codeContext	String. Organization that provided the Id number.	Optional
PostalCode	String. Postal code of billing address.	Optional
Email	Billing email address.	Optional
value	String. Billing email address.	Optional

Optional objects - Payment, TravelAgency

Object	Description	Required/Optional
Payment	Top level object for payment details. The payment object is used to explicitly denote the amount expected to be charged for the hotel reservation in this style: For Prepay Required rates, the full total amount is used. This amount will be charged to the credit card on this transaction. Indicators should be set as: depositInd = true; guaranteeInd = false. For Deposit Required rates, the deposit amount is used. This amount will be charged to the credit card on this transaction. Indicators should be set as: depositInd = true; guaranteeInd = false. For Guarantee Required rates, the full total amount is used. This amount is expected to be charged to the credit card at check in. Indicators should be set as: depositInd = false; guaranteeInd = true. Includes Amount object.	Required
id	String. Customer-assigned identifier for the payment.	Optional
PaymentRef	String. Customer-assigned name for the payment.	Optional
depositInd	Boolean (true/false). If set to true, user expects credit card to be charged to support deposit or prepay rate.	Required
guaranteeInd	Boolean (true/false). If set to true, user expects payment due at check in at the hotel.	Required
Amount	Amount of payment.	Required
code	String. Currency code.	Required
value	String. Amount to pay.	Required
TravelAgency	Optional top level object for travel agency information. Includes AgencyPCC and Telephone objects.	Optional
AgencyPCC	Top level object.	Optional
agencyCode	String. Agency PCC code.	Optional
Telephone	Top level object for agency telephone information.	Optional
phoneNumber	String. Agency telephone number.	Optional
areaCityCode	String. Agency phone local area code.	Optional
phoneUseType	String. OTA code for how phone is used. (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening)	Optional
cityCode	String. Agency city code.	Optional

Optional objects - Comment

Object

Description

Required/Optional

ReservationComment

Optional top level object used for notepad, unassociated, and special instruction remarks.

Includes Comment object.

Optional

commentSource

Originator of comment. Accepted value: Agency.

Required

shareWith

Designates visibility of remark.

Notepad remarks: Agency

Unassociated remarks: Traveler

Special instructions: Supplier

Required

Comment

Array of name/value pairs.

Required

name

Type of remark.

Notepad remarks: 2 character code. Use asterisk for any placeholder. (HS, CR, R*, **)

Unassociated remarks: ITIN COMMENTS

Special instruction remarks: SI

Required

value

String. Remark text. Limits:

Notepad remarks: 87 characters

Unassociated remarks: 70 characters

Special instruction remarks: 50 characters

Required

Accounting

Optional top level object used for all DOCI remarks.

Includes NameValuePair object.

Optional

dataType

Accounting remark designator. Accepted value: DOCI.

Required

NameValuePair

Array of name/value pairs.

Required

name

Type of remark. Accepted values:

DYO	Design Your Own Itinerary
FS	Fare Saver
CR	Canned Remarks
TK	Ticket Number Details
AC	Agent, Account, or Branch Details
AR	Replace Sign On Code
X*	Back Office Accounting Details
FT	Free Text

Required

value

String. Text to pair with name values above. Text limitations for each name value are listed below.

DYO	2 digit, numeric
FS	9 characters total limit in format 1 (all numeric) or format 2 (numeric “–“ two alpha)
CR	42 characters total limit in format (two numeric “.” two numeric “.” etc)
TK	8 to 12 characters in format 1 (all numeric) or format 2 (numeric “-“ three numeric)
AC	42 characters, alphanumeric and some special characters
AR	10 characters, alphanumeric
X*	84 characters, alphanumeric and some special characters
FT	84 characters, alphanumeric and some special characters

Required

Response

Show Response Body Table

The tables in this section break down the Create Reservation response into its top level objects to separate the information in each.

Top level objects

Object	Description
ReservationResponse	Top level object for the response.
Reservation	Top level object. Key value pair: id: Internal identifier for the response. Includes Offer, Traveler, TravelerProduct, and Receipt objects. May include ReservationComment.
Offer	Top level object for offer details. Key value pair: id: System-generated offer identifier value sent in the reference payload request to book that offer. Note that id is not returned in the response to a full payload request. This is the only difference in the two responses. Includes Identifier object and, detailed in tables below, Product, Price, and TermsAndConditionsFull objects. May include DepositPolicy object.
Identifier	Defines which supplier system returned that specific room rate (offer). Key value pair: authority: Indicates which supplier returned the lowest available rate for that property. Acceptable values are: TVPT: Travelport EXPE: Expedia BKNG: Booking.com value: Reference offer ID value.
Traveler	Traveler details. See table below. Includes PersonName object.
TravelerProduct	Reference numbers to link travelers to a specific offer. See table below.
Receipt	Top level object for confirmation details. See table below.
ReservationComment	Top level for Comment objects if any comments were sent in the request.
Comment	Any comments about the reservation sent in the request. Key value pairs: value: Text string of the comment sent. name: Text string with description of the value.
AppliesTo	Top level object to designate which offer this comment applies to. Includes OfferRef object.
OfferRef	Reference number of specific offer. Always the letter "O" followed by a number.

Offer/Product object

Object	Description
Product	Array. One instance for each product, type ProductHospitality. Product is a common object in the model. Not all objects in this table may be returned in this specific API. Key value pairs: bookingCode: Booking code retrieved from the Availability response. adaCompliant: Yes, No, or Unknown indicator for ADA compliance. propertyName: Name of property offering this product. guests: Number of guests. Quantity: Number of rooms currently available matching this rate. Quantity is only returned with Booking.com or Expedia content, as they have limited real-time access to the total number of sold rooms at the property. Includes PropertyKey, PropertyAddress, RoomType, and DateRange objects.
PropertyKey	When ReferenceList is returned, PropertyKey includes the key value pairs: chainCode: Chain code for the property propertyCode: Property code for the property.
PropertyAddress	Top level property address object.
Address	Property address. Key value pairs: City: Property city. PostalCode: Property postal code. Includes AddressLine, StateProv, and Country objects.
AddressLine	Text string for property street address.
StateProv	Property state or province. Key value pair: value: The state of providence code of the property address.
Country	Property country. Key value pairs: name: Country name. value: Property country code.
RoomType	Room type detail. Includes RoomCharacteristics, Description, and RoomAmenity objects.
RoomCharacteristics	Room details. Key value pairs: category: Category of the room. typeCode: OTA room type code. smokingAllowed: Yes or No indicator for smoking. wifiIncluded: Yes or No indicator for wifi. viewCode: Free text describing the view. shortRoomDescription: Normalized text for grouping rates against similar room types. accessibleRoom: Yes or No indicator for room with accessible features. Includes BedConfiguration object.
BedConfiguration	Configuration of bed(s) in room. Key value pairs: quantity: Number of beds in the room. bedType: Bed type values as follows: King Bed(s) Queen Bed(s) Twin Bed(s) Sofa Bed(s) OTHER Bed(s) size: Size of bed(s) in the room. Approximate measurement of the bed(s).
Description	A room description text string. Key value pairs: languages: The language code of the description text. value: Room description text (e.g. Save 15 Pct Off Studio King Suite Full Breakfast:Free WiFi:32in TV).
RoomAmenity	Room amenity name and description. Key value pairs: description: Description of amenity received from supplier. code: OTA code associated to amenity includedIndicator: Amenity included with rate.
RoomOccupancy	Room occupancy value. Key value pair: maxOccupancy: The maximum number of room occupants.
DateRange	Check-in and -out dates. Key value pairs: start: Check-in date in YYYY-MM-DD format. end: Check-out date in YYYY-MM-DD format.

Offer/Price object

Object	Description
Price	Price details for this offer or rate. Price is a common object in the model. Not all objects in this table may be returned in this specific API. Key value pairs: Base: Base price before taxes and fees. Not returned by all suppliers. TotalTaxes: Total taxes applied to the base price. Not returned by all suppliers. TotalPrice: The amount of the offer. Includes CurrencyCode and PriceBreakdown objects.
CurrencyCode	The currency code the amount is provided in. Key value pairs: decimalPlace: Decimal place number. value: Three-character currency code.
PriceBreakdown	The information returned in PriceBreakdown can vary by provider and location. Key value pairs: roomPricingType: A string provided by the hotel to describe the rate, such as per night or per stay. priceChangesDuringStayInd: When set as true, expect multiple occurrences of roomPricingType (per night). If roomPricingType = Per night, May include NightlyRate, AverageNightlyRate, and AmenitySurcharges objects. If roomPricingType = Per stay, Description: A rate description text string, e.g., Advance Purchase-Ro-Free WiFi. May include Amount and Commission objects.
NightlyRate	Rate per night. Key value pairs: startDate: Start date for the nightly rate in YYYY-MM-DD format. nights: Number of nights the nightly rate is valid. Includes Amount object. If the nightly rate changes during the stay, multiple NightlyRate objects are returned.
Amount	The rate amount. Key value pairs: Base: Base amount of the rate not including taxes or fees. Total: Total for this group of nights. Includes CurrencyCode (see above), Taxes, and Fees objects.
Taxes	Tax details. TotalTaxes: Total of all taxes included in this rate. Includes Tax and TaxPercent objects.
Tax	Breakdown of the tax. Key value pairs: currencyCode: (see above) description: OTA description of tax. purpose: Supplier returned description of tax. includedInBase: Indicates whether tax is included in Amount/Base value. Possible values are Yes, No, Unknown. taxCode: OTA code for the tax. value: The amount of the tax
TaxPercent	Returned when the tax is expressed as a percentage of the amount. Key value pairs: taxCode: Any code for the tax. includedInBase: Indicates whether tax is included in the base amount. Possible values are Yes, No, or Unknown. value: The tax percentage amount.
Fees	Parent object which can include Fee by rate or by property. Travelport defines fees as any extra payment due at the property. Key value pair: TotalFees: Total of all fees included in this rate, due separately. Includes Fee object.
Fee	Fee details. Key value pairs: description: Hotel provider's text explanation of the fee, e.g. Resort Fee. feeCode: Hotel provider's explanation of the fee; can be returned either as a code or as text. feeApplication: When the fee is applied. Possible values are: PERPERSON PERROOM PERACCOMMODATION PERHOUSE PERAPARTMENT PERADULT feeFrequency: The frequency of the fee. Possible values are: PERNIGHT PERDAY PERSTAY PERWEEK ROUNDTRIP ONEWAY Includes FeeAmountOrPercent object.
FeeAmountOrPercent	Object defining the amount or percent charged as a fee. Key value pairs: Amount: Amount object for a specific fee amount. code: Three-character currency code. value: Exact amount of fee. Percent: Percentage of base amount charged as a fee.
Commission	Commission details. Key value pairs: When returned with type: CommissionPercent: application: A value of Commissionable indicates the rate pays commission. Non-paying indicates no commission. Percent: Provides the commission percentage. When returned with type: CommissionAmount application: Same as above. Amount: Exact amount of commission paid for this booking. code: Three-character currency code. value: Numeric amount of commission.
AverageNightlyRate	The average nightly rate of the request. Key value pairs: code: Three-character currency code of amount. approximateInd: true indicates this is a calculated value; false indicates this is the value returned by the property. value: Numeric amount of average nightly rate.
AmenitySurcharges	Amenity surcharges detail. Includes Surcharge object.
Surcharge	Additional charges related to requested amenities. Key value pairs: currencyCode: Three-character currency code. description: Description of charge (e.g., Roll away Surcharge) value: Surcharge amount.

Offer/TermsAndConditionsFull object

Object	Description
TermsAndConditionsFull	Top level object for terms and conditions, instances of TermsAndConditionsFullHospitality. RatePaymentInfo: Postpay or Prepay designation. As returned from supplier, may include TextBlock, Guarantee, CancelPenalty, DepositPolicy, AcceptedCreditCard, Description, MealsIncluded, ProductRateCodeInfo, and CheckInOutPolicy objects. TermsAndConditionsFull is a common object in the model. Not all objects in this table may be returned in this specific API.
TextBlock	Array. Each instance is one rule or set of information. Key value pair: title: The title of the rule or information. Can include any of the following Rule Types. Not every property returns all of these types. Some properties do not return any title. Note that currently only English is supported for these values Promotional Data Rate Description Room Rate Data Rate Text Guarantee Cancellation Deposit Check in/out Room detail Extra charges Packages Property Location Miscellaneous Rate Amount Alternate Rate Amount Rate Comment FAX Phone Special Information Information Room Hold Expiration Time Includes the TextFormatted object providing the rule or information itself.
TextFormatted	The rule or information itself. Key value pairs: language: The language the rule is provided in. value: The actual text of the hotel rule or information.
Guarantee	Array. Indicates if the room rate requires a guarantee to be booked. Key value pair: GuaranteeType: The type of guarantee. The following are Guarantee types that may be returned: PrepayRequired DepositRequired GuaranteesNotRequired Profile DepositNotRequired NoGuaranteesAccepted GuaranteeRequired CC/DC/Voucher PrepayNotRequired GuaranteesAccepted NoDepositsAccepted
CancelPenalty	Array. CancelPenalty breaks down any cancellation penalties for the rate. Key value pair: Refundable: Yes or No values. Includes the Deadline and HotelPenalty objects.
Deadline	Cancellation penalty deadline details. Key value pair: Time: The deadline time in 24-hour HH:MM:SS format. Includes SpecificDate object.
SpecificDate	Details on cancellation penalty. Key value pairs: specific: Specific cancellation date in YYYY-MM-DD format. start: Date in YYYY-MM-DD format. Used with end to designate a range of dates. end: Date in YYYY-MM-DD format.
HotelPenalty	Cancellation penalty amount. Attributes include: When returned with type: HotelPenaltyNights subjectToTax: Yes, No, or Unknown indicating if additional taxes may be applied to penalty amount. Nights: The number of nights charged at the nightly rate if provider charges a cancellation fee. When returned with type: HotelPenaltyPercent Percent: Percentage of total amount to be charged as penalty. appliesTo: Value of “Amount” will be returned. When returned with type: HotelPenaltyAmount Amount: Exact penalty amount. code: Three-character currency code. value: Penalty amount.
DepositPolicy	Deposit details related to this booking. Includes Deposit object.
Deposit	Deposit total in relation to TotalPrice. Key value pairs: CurrencyAmount: Three-character currency code. value: Deposit amount. remainderInd:true or false indicating if a deposit was part of the total price. Date: Date deposit must be received.
AcceptedCreditCard	An array of accepted credit cards. Key value pair: value: Two-character credit card code.
Description	Free-form text for a room and rate description. This duplicates the room description in RoomType and the rate description in Price and will be removed in a future release.
MealsIncluded	The following meal attributes are returned and set to true if applicable: breakfastInd lunchInd dinnerInd
ProductRateCodeInfo	Top level object for rate code details. Includes RateCodeInfo.
CheckInOutPolicy	checkInTime: Local property check in time in 24 hour clock format. checkOutTime: Local property check out time in 24 hour clock format.
RateCodeInfo	Rate code information. Key value pairs: rateName: Name of the rate plan. rateID: ID of the rate plan associated with the negotiated rate plan code. value: The negotiated rate plan code. rateCategory: OTA rate category code. Values may be: Military Convention Credential Weekly Association All FamilyPlan Club Monthly RackGeneral FullInclusive Promotional Government Industry/TravelAgentRate PrePaid Weekend Corporate Mutli-DayPackage Tour Employee MultLevel/Negotiated/Secure Package Other Leisure VIP SeniorCitizen

Traveler object

Object	Description
Traveler	Traveler details. Key value pair: id: Travelport generated traveler identification number. Always the letter "T" followed by a unique number. Includes PersonName, Telephone, and Email.
PersonName	Key value pairs: Given: Traveler first name. Surname: Traveler last name. Prefix: Honorific title. The combination of Given and Surname is limited to 22 characters. Given name must have at least one character. Any additional characters beyond the 22 limit are truncated.
Telephone	Traveler telephone details. Key value pairs: phoneNumber: Phone number. areaCityCode: Phone local area code. countryAccessCode: Phone country code. cityCode: Traveler city code.
Email	Traveler email address. Key value pair: value: Traveler email address.
CustomerLoyalty	One frequent guest number and / or one frequent flyer number. Key value pairs: programID: Two character hotel or air supplier code. value: Number on loyalty card. supplierType: “hotel” for Frequent Guest / “air” for Frequent Flyer

TravelerProduct object

Object	Description
TravelerProduct	Top level object array that links a particular traveler to a particular hotel segment (offer). Each offer has a linked traveler. Key value pairs: TravelerRef: Traveler reference number allowing a linkage to an offer. OfferRef: Offer reference number allowing a linkage to a traveler.

Object

Description

TravelerProduct

Top level object array that links a particular traveler to a particular hotel segment (offer). Each offer has a linked traveler.

Key value pairs:

TravelerRef: Traveler reference number allowing a linkage to an offer.

OfferRef: Offer reference number allowing a linkage to a traveler.

Receipt object

Object	Description
Receipt	Top level object. Includes OfferRef and Confirmation objects.
OfferRef	Reference number to link this set of receipt information to a specific offer. Always the letter “O” followed by a number.
Confirmation	Confirmation details. Includes Locator and OfferStatus objects.
Locator	Locator information for the reservation. Key value pairs: source: Content source. Two character Supplier code. If source matches chain code, the offer is directly with the supplier. If source is XZ, the offer is with Expedia. If source is BO, the offer is with Booking.com. sourceContext: Either Travelport, Agency, or Supplier. locatorType: Description of what value represents. Travelport: Confirmation number; PNR locator Agency: IATA Number Booking.com: Confirmation number; PIN number Expedia: Itinerary ID (true confirmation number); affiliate_reference_id; Confirmation number value: Reference number for locatorType. creationDate: Date created in Travelport / Supplier system in YYYY-MM-DD format. Booking.com returns a PIN number along with the confirmation number for each sold hotel segment. If the agent/traveler needs to reconcile the booking with Booking.com, both the PIN number and confirmation number are needed for Booking.com to locate the segment in their system.
OfferStatus	Status of offer. Key value pair: Status: Status associated to the sold hotel segment. Possible values include: Cancelled Confirmed Pending Rejected

CurrencyRateConversion object

Object	Description
CurrencyRateConversion	CurrencyRateConversion is returned only if requestedCurrency was sent in the request. By default the Hotel APIs return all rates in the currency of the hotel's location. If requestedCurrency was sent in the request, the response returns currency conversion information per below. Includes SourceCurrency, TargetCurrency, and ConversionRate objects.
SourceCurrency	The currency code based on the location of the hotel and used for all rates in the response. Key value pairs: decimalPlace: Number of decimal places for the currency value. value: Currency code.
TargetCurrency	Currency code sent in the request in requestedCurrency. Key value pairs: decimalPlace: Number of decimal places value: Currency code.
ConversionRate	Current conversion rate of the user-specified currency (the TargetCurrency value). Key value pair: value: Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response.

Example Request

The example below shows the reference payload to create a reservation using an offer ID from Hotel Availability.

Show Example Request

{
  "ReservationQueryBuild": {
    "ReservationBuildFromCatalogOffering": {
      "BuildFromCatalogOfferingHospitality": {
        "numberOfRooms": "1",
        "CatalogOfferingIdentifier": {
          "@type": "CatalogOfferingIdentifier",
          "Identifier": {
            "value": "033e3299-c33d-4d64-bc87-a9c74fce81a2:37dbfb1b-151a-4ba8-a770-bc6de90b4bbd"
          }
        }
      },
      "Traveler": [
        {
          "@type": "Traveler",
          "PersonName": {
            "Given": "Bear",
            "Surname": "Das",
            "Title": "Mr"
          },
          "Telephone": [
            {
              "@type": "TelephoneDetail",
              "countryAccessCode": "91",
              "areaCityCode": "011",
              "phoneNumber": "9891766469",
              "cityCode": "DL"
            }
          ],
          "Email": [
            {
              "value": "matt.singh@galileo.co.in"
            }
          ]
        }
      ],
      "ReservationComment": [
        {
          "@type": "ReservationComment",
          "Comment": [
            {
              "value": "Please dont charge CC"
            }
          ]
        }
      ],
      "FormOfPayment": [
        {
          "@type": "FormOfPaymentPaymentCard",
          "PaymentCard": {
            "@type": "PaymentCardDetail",
            "expireDate": "0825",
            "CardType": "Credit",
            "CardCode": "VI",
            "CardHolderName": "Frank Sinatra",
            "CardNumber": {
              "@type": "CardNumber",
              "PlainText": "4444333322221111"
            },
            "SeriesCode": {
              "@type": "SeriesCode",
              "PlainText": "343"
            },
            "PersonName": {
              "@type": "PersonNameDetail",
              "Given": "Bill",
              "Middle": "Example String Value",
              "Surname": "Thisguy"
            },
            "Address": {
              "@type": "AddressDetail",
              "Number": {
                "value": "125"
              },
              "Street": "Billing Address Street",
              "AddressLine": [
                "125 Billing Address Street"
              ],
              "City": "Claremont",
              "County": "Los Angeles",
              "StateProv": {
                "value": "CA",
                "name": "Texas"
              },
              "Country": {
                "value": "US",
                "id": "country_4",
                "name": "United States",
                "codeContext": "Example String Value"
              },
              "PostalCode": "91711-3323"
            },
            "Telephone": [
              {
                "@type": "TelephoneDetail",
                "countryAccessCode": "1",
                "areaCityCode": "909",
                "phoneNumber": "1231234",
                "cityCode": "DEN"
              }
            ],
            "Email": [
              {
                "value": "smith@example.com"
              }
            ]
          }
        }
      ],
      "Payment": [
        {
          "@type": "Payment",
          "Amount": {
            "code": "USD",
            "value": 68.44
          }
        }
      ]
    }
  }
}

Example Response

The request above returns the example response below. The Offer in the reservation response is populated with the cached offer from Hotel Availability. All responses are subject to what is received from the supplier.

Show Example Response

{
  "ReservationResponse": {
    "Reservation": {
      "@type": "ReservationDetail",
      "id": "f1ecd79d-198c-4fe3-ae91-a9ca9cd10637",
      "Offer": [
        {
          "@type": "Offer",
          "Identifier": {
            "authority": "TVPT"
          },
          "Product": [
            {
              "@type": "ProductHospitality",
              "Quantity": 1,
              "bookingCode": "A00BQ6",
              "guests": 1,
              "PropertyKey": {
                "chainCode": "CN",
                "propertyCode": "B6381"
              },
              "RoomType": {
                "@type": "RoomTypeDetail",
                "RoomCharacteristics": {
                  "GuaranteeTypeCode": "A00",
                  "smokingAllowed": "No",
                  "BedConfiguration": [
                    {
                      "quantity": 1,
                      "bedType": "king"
                    }
                  ]
                },
                "Description": {
                  "value": "King Deluxe Room 42 Square Metre/WiFi/Minibar/Desk/Soaktub Separate Rain Shower/42 Inch HDTV/Media Hub"
                },
                "RoomAmenity": [
                  {
                    "description": "king",
                    "quantity": 1
                  }
                ]
              },
              "DateRange": {
                "start": "2022-02-22",
                "end": "2022-02-25"
              }
            }
          ],
          "Price": {
            "@type": "PriceDetail",
            "CurrencyCode": {
              "value": "USD",
              "decimalPlace": 2
            },
            "TotalPrice": 150,
            "TotalTaxes": 50,
            "TotalFees": 30,
            "Base": 100,
            "PriceBreakdown": [
              {
                "@type": "PriceBreakdownHospitality",
                "roomPricingType": "Per night",
                "NightlyRate": [
                  {
                    "startDate": "2022-02-22",
                    "nights": 1,
                    "Amount": {
                      "CurrencyCode": {
                        "value": "USD"
                      },
                      "Base": 40,
                      "Total": 60,
                      "Taxes": {
                        "@type": "TaxesDetail",
                        "TotalTaxes": 20,
                        "Tax": [
                          {
                            "currencyCode": "USD",
                            "taxCode": "CITYTAX",
                            "Description": "Tax and Service fee",
                            "includedInBase": "No",
                            "value": 16
                          },
                          {
                            "currencyCode": "USD",
                            "taxCode": "VAT",
                            "Description": "VAT",
                            "includedInBase": "No",
                            "value": 4
                          }
                        ]
                      }
                    }
                  },
                  {
                    "startDate": "2022-02-23",
                    "nights": 3,
                    "Amount": {
                      "CurrencyCode": {
                        "value": "USD"
                      },
                      "Base": 60,
                      "Total": 90,
                      "Taxes": {
                        "@type": "TaxesDetail",
                        "TotalTaxes": 30,
                        "Tax": [
                          {
                            "currencyCode": "USD",
                            "taxCode": "CITYTAX",
                            "Description": "Tax and Service fee",
                            "includedInBase": "No",
                            "value": 24
                          },
                          {
                            "currencyCode": "USD",
                            "taxCode": "VAT",
                            "Description": "VAT",
                            "includedInBase": "No",
                            "value": 6
                          }
                        ]
                      }
                    }
                  },
                  {
                    "startDate": "2022-02-26",
                    "nights": 1,
                    "Amount": {
                      "CurrencyCode": {
                        "value": "USD"
                      },
                      "Base": 60,
                      "Total": 90,
                      "Taxes": {
                        "@type": "TaxesDetail",
                        "TotalTaxes": 30,
                        "Tax": [
                          {
                            "currencyCode": "USD",
                            "taxCode": "CITYTAX",
                            "Description": "Tax and Service fee",
                            "includedInBase": "No",
                            "value": 24
                          },
                          {
                            "currencyCode": "USD",
                            "taxCode": "VAT",
                            "Description": "VAT",
                            "includedInBase": "No",
                            "value": 6
                          }
                        ]
                      }
                    }
                  }
                ],
                "AverageNightlyRate": [
                  {
                    "code": "USD",
                    "value": 50,
                    "approximateInd": true
                  }
                ],
                "AmenitySurcharges": {
                  "@type": "AmenitySurchargesDetail",
                  "Surcharge": [
                    {
                      "currencyCode": "USD",
                      "description": "Crib Surcharge",
                      "value": 0
                    },
                    {
                      "currencyCode": "USD",
                      "description": "Rollaway Surcharge",
                      "value": 25
                    }
                  ]
                }
              },
              {
                "@type": "PriceBreakdownHospitality",
                "roomPricingType": "Per stay",
                "Amount": {
                  "CurrencyCode": {
                    "value": "USD"
                  },
                  "Base": 100,
                  "Total": 150,
                  "Taxes": {
                    "@type": "TaxesDetail",
                    "TotalTaxes": 50,
                    "Tax": [
                      {
                        "currencyCode": "USD",
                        "taxCode": "CITYTAX",
                        "Description": "Tax and Service fee",
                        "includedInBase": "No",
                        "value": 40
                      },
                      {
                        "currencyCode": "USD",
                        "taxCode": "VAT",
                        "Description": "VAT",
                        "includedInBase": "No",
                        "value": 10
                      }
                    ]
                  },
                  "Fees": {
                    "@type": "FeesDetail",
                    "TotalFees": 30,
                    "Fee": [
                      {
                        "feeCode": "RESORT",
                        "feeApplication": "PerAccommodation",
                        "feeFrequency": "PerStay",
                        "FeeAmountOrPercent": {
                          "Amount": {
                            "code": "USD",
                            "value": 15
                          }
                        }
                      }
                    ]
                  },
                  "Commission": {
                    "@type": "CommissionAmount ",
                    "application": "Non-paying "
                  },
                  "Description": "Standard Double or Twin Room - Free cancellation - Free WiFi"
                }
              }
            ]
          },
          "TermsAndConditionsFull": [
            {
              "@type": "TermsAndConditionsFullHospitality",
              "Guarantee": [
                {
                  "GuaranteeType": "DepositRequired",
                  "code": "CCD"
                }
              ],
              "CancelPenalty": [
                {
                  "Deadline": {
                    "SpecificDate": {
                      "specific": "2022-02-19"
                    }
                  },
                  "Refundable": "Yes"
                }
              ],
              "Description": [
                "Honors Prepay And Save",
                "First Night Deposit Required. Free Changes/",
                "Cancellations Up To 72 Hours Before Arrival.",
                "King Deluxe Room",
                "42 Square Metre/WiFi/Minibar/Desk/Soaktub",
                "Separate Rain Shower/42 Inch HDTV/Media Hub"
              ],
              "ProductRateCodeInfo": [
                {
                  "RateCodeInfo": {
                    "value": "BQ6"
                  }
                }
              ],
              "DepositPolicy": {
                "Deposit": [
                  {
                    "@type": "Deposit",
                    "remainderInd": false
                  }
                ]
              }
            }
          ]
        }
      ],
      "Traveler": [
        {
          "@type": "Traveler",
          "id": "T1",
          "PersonName": {
            "@type": "PersonName",
            "Given": "John",
            "Surname": "Smith"
          },
          "Telephone": [
            {
              "countryAccessCode": "1",
              "areaCityCode": "909",
              "phoneNumber": "1231234",
              "cityCode": "DEN"
            }
          ],
          "Email": [
            {
              "value": "smith@example.com"
            }
          ]
        }
      ],
      "TravelerProduct": [
        {
          "@type": "TravelerProduct",
          "TravelerRef": "T1",
          "OfferRef": "O1"
        }
      ],
      "Receipt": [
        {
          "@type": "ReceiptConfirmation",
          "Confirmation": {
            "@type": "ConfirmationHold",
            "confirmationStatus": {
              "@type": "OfferStatusHospitality",
              "Status": "Confirmed"
            },
            "Locator": {
              "value": "0GQ9J0",
              "locatorType": "PNR Locator",
              "sourceContext": "Travelport"
            },
            "OfferStatus": {
              "@type": "OfferStatusHospitality",
              "Status": "Confirmed"
            }
          }
        },
        {
          "@type": "ReceiptConfirmation",
          "OfferRef": [
            "O1"
          ],
          "Confirmation": {
            "@type": "ConfirmationHold",
            "confirmationStatus": {
              "@type": "OfferStatusHospitality",
              "Status": "Confirmed"
            },
            "Locator": {
              "value": "3186166041",
              "locatorType": "Confirmation Number",
              "source": "CN",
              "sourceContext": "Supplier"
            },
            "OfferStatus": {
              "@type": "OfferStatusHospitality",
              "Status": "Confirmed"
            }
          }
        }
      ]
    }
  }
}

Error Messages

Error messages for Hotel Create Reservation API.

Show Error Messages for Create Reservation Reference Payload

SourceCode	StatusCode (HTTP code)	Message
	405	Cannot find hotel offer with ID: xxx. Offer ID may be incorrect or offer has expired. Try performing availability again.

Show Error Messages for both Create Reservation Full and Reference Payload

SourceCode	StatusCode (HTTP code)	Message
	400	Traveler Information cannot be empty.
	400	PersonName Cannot be Empty.
	400	First Name Cannot be Empty.
	400	Last Name Cannot be Empty.
	400	Traveler phone cannot be empty.
	400	Country Access Code must contain only numbers, spaces, dashes, or dots.
	400	Phone country code is invalid.
	400	Phone Number must contain only alpha chars , spaces, dashes, or dots
	400	Phone is invalid.
	400	Traveler email cannot be empty.
	400	Traveler email is invalid.
	400	Form of payment cannot be empty.
	400	UNSUCCESSFUL LINK SELL- MSG FROM LINK VENDOR INVALID FORM OF GUARANTEE *
	400	Card Expiration date cannot be empty.
	400	INVALID - CREDIT CARD
	400	Expiration month value must be less than 13.
	400	String index out of range: 4
	400	Card Type cannot be empty.
	400	Card Code cannot be empty.
	400	Card Code cannot be greater than 2.
	400	UNSUCCESSFUL LINK SELL- MSG FROM LINK VENDOR INVALID FORM OF GUARANTEE *
	400	Card detail card holder name cannot be empty.
	400	Card Number cannot be empty.
	400	Card detail card series code cannot be empty.
	400	Card detail address cannot be empty.
	400	Card detail address line cannot be empty.
	400	Card detail city cannot be empty.
	400	State / province code is required.
	400	Card detail country cannot be empty.
	400	Address country code must be 2 characters.
	400	Address country code is invalid.
	400	Card detail postal code line cannot be empty.
	400	Form of payment phone cannot be empty.
	400	Country Access Code must contain only numbers, spaces, dashes, or dots
	400	Phone Number must contain only alpha chars , spaces, dashes, or dots
	400	Phone number must contain only digits.