title
layout
Direct Connect - Hotel Service v4 - Schemas
reference
Direct Connect - Hotel Service v4 - Schemas
Search by either location or exact property reference, if available.
Name
Type
Format
Description
requestorInfo
RequestorInfo
-
Required Information about Point of Sale (POS), traveler, and user associated with this request.
numGuests
integer
int32
Number of guests for accommodation as entered by traveler.
guestCountryCode
string
ISO ALPHA-2
Two-character ISO code for country.
locationSearch
LocationSearch
-
Reference to location details for search.
hotelPropertyRefs
HotelPropertyRef
-
Reference IDs to hotel properties, if available. When provided, locationSearch
will not be used and may not be set.
checkin
string
date
Required Check in date as entered by traveler.
checkout
string
date
Required Check out date as entered by traveler.
customFields
CustomField
-
Custom fields that are supported by vendor. Example: CostCenter
includeDepositRequired
boolean
true
\ false
Required If true
, properties where deposits are required are displayed.
rateCategories
RateCategory
-
Special rate categories requested, if applicable.
maxSearchResults
integer
-
Maximum number of properties allowed to be included in search results.
Reference to location details for search.
Name
Type
Format
Description
location
Location
-
Required Defines geographic location for search.
radius
Radius
-
Required Radius to restrict the search for hotels.
maxRadius
Radius
-
Required Allows extended search radius for preferred hotel properties and can be more than radius defined by traveler.
Name
Type
Format
Description
requestorInfo
RequestorInfo
-
Required Information about POS (Point Of Sale), traveler, and user associated with this request.
hotelPropertyRefs
HotelPropertyRef
-
Required Reference IDs for hotel properties where the rate is requested.
checkin
string
date
Required Check in date as entered by traveler.
checkout
string
date
Required Check out date as entered by traveler.
rateCategories
RateCategory
-
Special rate categories requested, if applicable.
numGuests
integer
int32
Number of guests for accommodation.
guestCountryCode
string
ISO ALPHA-2
Two-character ISO code for country.
searchSessionToken
SearchSessionToken
-
Session token to be generated and provided by server on initial search call that can be referenced back for future calls on the same session.
Name
Type
Format
Description
requestorInfo
RequestorInfo
-
Required Information about POS (Point Of Sale), traveler, and user associated with this request.
hotelPropertyRefs
HotelPropertyRef
-
Required Reference IDs for hotel properties where the rate is requested.
ratePlanIds
string
-
Required Rate product IDs for which detail rates are requested.
checkin
string
date
Required Check in date as entered by traveler.
checkout
string
date
Required Check out date as entered by traveler.
rateCategories
RateCategory
-
Special rate categories requested, if applicable
numGuests
integer
int32
Number of guests for accommodation.
guestCountryCode
string
ISO ALPHA-2
Two-character ISO code for country.
searchSessionToken
SearchSessionToken
-
Session token to be generated and provided by server on initial search call that can be referenced back for future calls on the same session.
Name
Type
Format
Description
requestorInfo
RequestorInfo
-
Required Information about POS (Point Of Sale), traveler, and user associated with this request.
hotelCodes
HotelPropertyRef
-
Required Reference IDs for hotel properties where the rate is requested.
searchSessionToken
SearchSessionToken
-
Session token to be generated and provided by server on initial search call that can be referenced back for future calls on the same session.
Vendor supported custom field.
Name
Type
Format
Description
name
string
-
Required Name of the custom field.
value
string
-
Required Value of the custom field.
Reference to hotel property using provider specific property code.
Name
Type
Format
Description
chainCode
string
-
Chain code associated with hotel, if available.
propertyCode
string
-
Required Provider's property code as given in search response.
Hotel property object returned by hotel search.
Name
Type
Format
Description
propertyCode
PropertyCode
-
Required
altPropertyCode
object
-
Alternate property code.
» catalogCode
PropertyCode
-
Required Catalog code of property.
» catalogName
CatalogName
-
Required NORTHSTAR
, GIATA
, and GDS
(SABRE
, AMADEUS
, GALILEO
) are preferred. Supported values: NORTHSTAR
, GIATA
, LEONARDO
, AMADEUS
, SABRE
, GALILEO
, CWT
, EXPEDIA
, HRS
, BOOKING.COM
, OMNIBEES
chainCode
string
-
Chain code associated with hotel, if available.
superChainCode
string
-
Super chain code for property.
hotelName
string
-
Required Name of hotel.
contactInfo
ContactInfo
-
Required Contact information for property.
position
Geolocation
-
Geolocation of property.
address
Address
-
Required Address of property.
leadRate
LeadRate
-
Required The lowest nightly rate averaged over the stay. Not required if availabilityStatus
is CLOSED_OUT
or UNKNOWN
.
onRequest
boolean
true
/ false
Indicates that the hotel can only be confirmed on request.
availabilityStatus
AvailabilityStatus
-
Required Supported values: AVAILABLE_FOR_SALE
, CLOSED_OUT
, UNKNOWN
preferenceRank
PreferenceRank
-
Supported values: PREFERRED
, MORE_PREFERRED
, MOST_PREFERRED
. This value will override any preferences set by company admins.
preferenceLevel
preferenceLevel
-
Supported values: CHAIN
, PROPERTY
. Note that value can be set to CHAIN
for hotels preferred at both chain or superchain level and this is what is displayed to user as UI as Preferred Chain
.
amenities
HotelAmenity
-
Required Hotel amenity containing code as described in OTA code list Hotel Amenity Code (HAC).
leadImageURI
string
URI
Required Contains an HTTPS URL pointing to a .png or .jpg hotel image file. The image will be used as a thumbnail and should be limited to 70x70 pixels to prevent image artifacts by scaling.
rating
HotelRating
-
Hotel rating details along with source.
sustainabilityAwards
SustainabilityAward
-
Award/Certification related to sustainability awarded to the hotel.
emissionInfo
EmissionInfo
-
Hotel Sustainability Index information.
Hotel rating details along with source. If source is not one of the supported values, it is possible to use OTHER
as source
and provide it's name in additional name
attribute.
Name
Type
Format
Description
value
integer
-
Required Hotel rating value should be an integer number from 1
to 5
, representing the star rating.
source
string
-
Required Source of rating. Supported values: NORTHSTAR
, AAA_DIAMONDS
, HOTELSTAR
, STAR_RATING_AUSTRALIA
,HRS_STAR_RATING
,OTHER
name
string
-
Name of the rating provider in case when above source
is set as OTHER
.
Name
Type
Format
Description
propertyCode
PropertyCode
-
Required
chainCode
string
-
Chain code associated with hotel, if available.
hotelName
string
-
Required Name of hotel.
contactInfo
ContactInfo
-
Required Contact information for property.
position
Geolocation
-
Geolocation property.
address
Address
-
Address of property.
cityCode
string
IATA 3-character city code
Required for adding passing segments City code for the property.
Name
Type
Format
Description
url
string
uri
Required URL of hotel property.
category
integer
int32
OTA code describing the image as defined in OTA Picture Category Code (PIC) list.
description
string
-
Description of the hotel media.
type
MediaType
-
Required Type of media. Supported values: IMAGE
Defines geolocation for search.
Name
Type
Format
Description
geoLocation
Geolocation
-
Required Geolocation of property.
locationType
LocationType
-
Required Type of location associated with this search. Supported values: COMPANY_LOCATION
, HOTEL
, ADDRESS
, PLACE
, AIRPORT
name
string
-
Required
address
Address
-
iataCode
string
-
IATA code of airport, if location type searched is AIRPORT
.
Name
Type
Format
Description
latitude
number
-
Required
longitude
number
-
Required
Name
Type
Format
Description
addressLines
string
-
Required Address of the property.
city
string
-
Required City name.
state
string
-
Deprecated - Use stateName
instead 2-character state code - will continue to be supported when state code is available.
stateName
string
-
Name or code of the state, province or administrative region.
countryCode
string
ISO ALPHA-2
Required ISO code for country.
postalCode
string
-
Postal or zip code of the property.
Name
Type
Format
Description
propertyCode
PropertyCode
-
Required Property code of the hotel.
rates
HotelRate
-
Required Applicable rates for the property.
Name
Type
Format
Description
bedding
Bedding
-
Details about bedding associated with the room.
mealsIncluded
integer
-
Code based on OTA Meal Plan Type (MPT) .
roomDescription
string
-
Room description information.
roomAmenities
RoomAmenity
-
Room amenity containing code as described in OTA code list Room Amenity Type (RMA).
roomType
integer
int32
OTA code of GRI (Guest Room Info) type providing guest room type details.
roomRate
RoomRate
-
Required
source
object
-
Details about the source attributed to this rate. NOTE: name
must also be provided along with logo
. logo
- if provided is displayed as source while name is used as title/label. Nothing is displayed as source
if suppress
is true
.
» name
string
-
Name of the supplier for the source that can be shown in user interface.
» logo
string
uri
URI to logo image of the supplier for the source that can be shown in user interface. Size should be at-least 84x16.
» suppress
boolean
true
/ false
If true
, all source attributions for this rate will be suppressed.
Name
Type
Format
Description
otaCode
integer
int32
Required Code based on OTA Rate Plan Type (RPT) .
value
string
-
The given rate plan type code.
Details about the total pricing associated with stay.
Name
Type
Format
Description
totalBeforeTax
number
-
Required Total price before tax.
taxes
number
-
Additional taxes to be added to rate.
taxesBreakdown
FeeTaxType
-
Tax breakdown by FTT Code associated with rate. Can be either included or excluded from total rate as marked with inclusive
field.
fees
number
-
Additional fees to be added to rate.
feesBreakdown
FeeTaxType
-
Fee breakdown by FTT Code associated with rate. Can be either included or excluded from total rate as marked with inclusive
field.
totalAfterTax
number
-
Total price after tax is included.
currencyCode
CurrencyCode
ISO 4217
Required Currency code.
isTotalBeforeTaxDisplayEligible
boolean
true
/ false
Controls what value is shown on property details page for rates. Displays totalBeforeTax
if set to true otherwise display totalAftertax
. Note that totalAfterTax
will be required if this is set false.
Name
Type
Format
Description
amount
number
-
Required
currencyCode
CurrencyCode
ISO 4217
Required Currency code.
Name
Type
Format
Description
rateDescription
string
-
Description of the rate.
rateCategory
RateCategory
-
rateCustomText
string
-
Informational text for rate.
rateChangesOverStay
boolean
true
/ false
Required
loyaltyMembershipRequired
boolean
true
/ false
Indicates if a loyalty card/program is required to book this rate.
roomId
string
-
ratePlanId
string
-
Required
guarantee
object
-
Required to be part of rate
call for applying travel policies.
» guaranteeType
GuaranteeType
-
Required Supported values: DEPOSIT_REQUIRED
, GUARANTEE_REQUIRED
, NONE
» acceptedPayments
AcceptedPayments
-
Supported values: AMERICAN_AIRLINES
, ALASKA_BARTER
, AMEX
, AWARD_CREDIT
, CANADIAN
, CARTE_BLANCHE
, CHINA_UNION_PAY
, CONFERMA
, DELTA
, DINERS_CLUB
, DISCOVER
, ENROUTE
, EURO_CARD
, JCB
, MC
, NORTHWEST
, TWA
, UATP
, UNITED_TRAVEL
, UNITED_CREDIT
, VENDOR_PROVIDED
,VISA
» cvvRequired
boolean
true
/ false
» amountPercent
AmountPercent
-
prepayRequired
boolean
true
/ false
If true
, prepayment is required for booking this rate.
refundable
boolean
true
/ false
If true
, this rate is refundable (based on all cancel penalties).
totalPrice
TotalPrice
-
Required Details about total pricing associated with the stay.
nightlyPrices
NightlyPrice
-
Details about nightly price for a given date range.
cancelPenalties
CancelPenalties
-
Information about cancellation penalties.
rateDetailsCallRequired
boolean
true
/ false
If true
, this rate requires a call to RateDetails
before being booked. Default: false
Name
Type
Format
Description
rateDescription
string
-
Description of the rate.
rateCategory
RateCategory
-
rateChangesOverStay
boolean
true
/ false
Required
roomId
string
-
ratePlanId
string
-
Required
guarantee
object
-
Required
» guaranteeType
GuaranteeType
-
Required Supported values: DEPOSIT_REQUIRED
, GUARANTEE_REQUIRED
, NONE
» acceptedPayments
AcceptedPayments
-
Supported values: AMERICAN_AIRLINES
, ALASKA_BARTER
, AMEX
, AWARD_CREDIT
, CANADIAN
, CARTE_BLANCHE
, CHINA_UNION_PAY
, CONFERMA
, DELTA
, DINERS_CLUB
, DISCOVER
, ENROUTE
, EURO_CARD
, JCB
, MC
, NORTHWEST
, TWA
, UATP
, UNITED_TRAVEL
, UNITED_CREDIT
, VENDOR_PROVIDED
, VISA
» cvvRequired
boolean
true
/ false
» amountPercent
AmountPercent
-
prepayRequired
boolean
true
/ false
If true
, prepayment is required for booking this rate.
refundable
boolean
true
/ false
If true
, this rate is refundable (based on all cancel penalties).
totalPrice
TotalPrice
-
Required Details about total pricing associated with the stay.
nightlyPrices
NightlyPrice
-
Details about nightly price for a given date range.
cancelPenalties
CancelPenalties
-
Required Information about cancellation penalties.
Name
Type
Format
Description
description
string
-
Common description applicable to all the penalties.
penalties
CancelPenalty
-
Required Cancellation penalties associated with rate. Should be empty array for non-refundable rate.
Details about nightly price for a given date range.
Name
Type
Format
Description
basePrice
number
-
Required
taxes
Taxes
-
Representation of nightly tax amount associated with a rate along with optional breakdown.
fees
Fees
-
Representation of nightly fees associated with a rate for given dates along with optional breakdown.
totalPrice
number
-
Total price including taxes and fees per night.
startDate
string
date
Required
endDate
string
date
Required
currencyCode
CurrencyCode
ISO 4217
Required Currency code.
Name
Type
Format
Description
cancelDeadline
string
YYYY-MM-DDThh:mm:ssZhh:mm
or YYYY-MM-DDThh:mm:ss
or YYYY-MM-DD hh:mm:ss
Date string in date-time notation as defined by RFC 3339 with time representing local time at property and corresponding timezone. Timezone can be skipped if not available and just provide date-time in local time.
description
string
-
-
refundableStatus
RefundableStatus
-
Required Supported values: FULLY_REFUNDABLE
, PARTIALLY_REFUNDABLE
, NON_REFUNDABLE
(previously NON-REFUNDABLE
- which will be supported as well)
amountPercent
AmountPercent
-
Name
Type
Format
Description
taxInclusive
boolean
true
/ false
If true
, all taxes are included in the returned rate.
feesInclusive
boolean
true
/ false
If true
, all fees are included in the returned rate.
numberOfNights
integer
-
The number of nights that are to be spent on the property.
basisType
AmountPercentBasisType
-
Supported values: FULL_STAY
, NIGHTS
, FIRST_LAST
applyAs
AmountPercentApplyAs
-
Supported values: FIRST_NIGHT_DEPOSIT
, LAST_NIGHT_DEPOSIT
, FIRST_AND_LAST_NIGHT_DEPOSIT
percent
number
-
The percentage used to calculate the amount of the cancellation fee.
amount
Price
-
Information about Point of Sale (POS), traveler, and user associated with the request.
Name
Type
Format
Description
posRequestorId
string
-
Required The identifier of the entity making the request (e.g. ATA/IATA/ID number).
travelerUuid
string
-
Required UUID that identifies the traveler within SAP Concur systems.
loginId
string
-
Login ID of traveler within SAP Concur systems, if available.
bookingForSelf
boolean
true
/ false
If true
, the person logged in is making a booking for themselves.
Name
Type
Format
Description
value
integer
int32
Required
unit
DistanceUnit
-
Required Unit of distance. Supported values: MILE
, KM
Name
Type
Format
Description
propertyRef
HotelPropertyRef
-
Required Reference to hotel property using provider specific property code.
hotelDescriptiveInfo
object
-
» propertyDescription
string
-
Required
» descriptiveInfos
HotelDescriptiveInfo
-
Required
mediaItems
HotelMedia
-
Required Hotel media items.
checkInTime
string
HH:MM
Check-in time in HH:MM 24 hour format eg. 11:00.
checkOutTime
string
HH:MM
Check-out time in HH:MM 24 hour format eg. 16:00.
Name
Type
Format
Description
otaCode
integer
int32
Required Code based on OTA Additional Detail Type (ADT) .
contents
string
-
Required
startDate
string
date
Start date for descriptive info, if applicable. Only for specific dates (e.g. for alerts or special events).
endDate
string
date
End date for descriptive info, if applicable. Only for specific dates (e.g. for alerts or special events).
Name
Type
Format
Description
bookingUuid
string
-
Required UUID that identifies the booking within the SAP Concur system.
hotelPropertyRef
HotelPropertyRef
-
Required Reference to hotel property using provider specific property code.
requestorInfo
RequestorInfo
-
Required Information about POS, traveler, and user associated with this request.
ratePlanId
string
-
Required
guests
Guest
-
Required Number of guests the reservation is for.
paymentModeIndicator
PaymentModeIndicator
-
Supported values: PERSONAL_CARD
, CORPORATE_CARD
, CONCUR_VIRTUAL_CARD
, VENDOR_VIRTUAL_CARD
guarantee
object
-
» cardType
PaymentCardType
-
Required Supported values: AMERICAN_AIRLINES
, ALASKA_BARTER
, AMEX
, AWARD_CREDIT
, CANADIAN
, CARTE_BLANCHE
, CHINA_UNION_PAY
, CONFERMA
, DELTA
, DINERS_CLUB
, DISCOVER
, ENROUTE
, EURO_CARD
, JCB
, MC
, NORTHWEST
, TWA
, UATP
, UNITED_TRAVEL
, UNITED_CREDIT
, VISA
» cardNumber
string
-
Required
» cardExpiryMonth
integer
-
Expiration month for payment card.
» cardExpiryYear
integer
-
4 digit expiration year for payment card.
» cvv
string
-
Card verification value. The three or four-digit number on the credit card for security.
» cardHolderName
string
-
Name of the payment card holder.
» cardHolderAddress
Address
-
Address of the payment card holder.
» virtualCardDeploymentId
string
-
ID for virtual card deployment
loyalty
object
-
» programCode
string
-
Required Loyalty program code.
» accountId
string
-
Required Loyalty program ID.
checkin
string
date
Required Check in date as entered by traveler.
checkout
string
date
Required Check out date as entered by traveler.
comments
string
-
Comments for special requests.
customFields
CustomField
-
Required Vendor specific fields, if set up for vendor integration.
searchSessionToken
SearchSessionToken
-
Session token to be generated and provided by server on initial search call. Can be referenced back for future calls in the same session.
legalEntity
LegalEntity
-
Provides details about the legal entity associated with this booking, if available.
threeDSecure
ThreeDSecure
-
3D Secure Strong Customer Authentication payment verification parameters.
tripUuid
string
-
Required UUID that identifies the trip within the SAP Concur system.
Name
Type
Format
Description
confirmationCodes
ConfirmationCode
-
Required
status
ReservationStatus
-
Required Supported values: RESERVED
, CANCELLED
,PENDING_CONFIRMATION
basicHotelProperty
BasicHotelProperty
-
Required
roomRate
RoomRateDetails
-
Required
checkin
string
date
Required Check in date as entered by traveler.
checkout
string
date
Required Check out date as entered by traveler.
guests
Guest
-
Required
roomDescription
string
-
Room description information.
comments
string
-
Comments about special requests for the booking.
isModifiable
boolean
true
/ false
Whether or not this reservation can be modified.
Name
Type
Format
Description
codeType
ConfirmationCodeType
-
Required Confirmation code type that maps to OTA codes for unique ID types. Supported values: RESERVATION
, SUPPLIER_CONFIRMATION
, CANCELLATION
, HOTEL_CONFIRMATION
, CONCUR_GDS_REFERENCE
, PASSIVE_CONFIRMATION
, PIN
code
string
-
Required
For details on usage of confirmation codes, please refer to Confirmation Codes section of the documentation.
Name
Type
Format
Description
firstname
string
-
Required
lastname
string
-
Required
address
Address
-
-
companyName
string
-
contactInfo
ContactInfo
-
birthdate
string
date
Name
Type
Format
Description
requestorInfo
RequestorInfo
-
Required Information about POS, traveler, and user associated with this request.
confirmationCodes
ConfirmationCode
-
Required
Name
Type
Format
Description
requestorInfo
RequestorInfo
-
Required Information about POS, traveler, and user associated with this request.
confirmationCodes
ConfirmationCode
-
Required
Name
Type
Format
Description
confirmationCodes
ConfirmationCode
-
Required
cancellationRemarks
string
-
Name
Type
Format
Description
phoneNumbers
string
-
Required
faxNumber
string
-
emails
string
-
Required
The lowest nightly rate averaged over the stay.
Name
Type
Format
Description
avgNightlyRate
Price
-
Required
isTaxAndFeesInclusive
boolean
true
/ false
Whether or not tax and fees are included.
Hotel amenity containing code as described in OTA code list Hotel Amenity Code .
Name
Type
Format
Description
amenityCode
integer
int32
Required
cost
Price
-
Cost associated with the amenity.
Room amenity containing code as described in OTA code list Room Amenity Type .
Name
Type
Format
Description
amenityCode
integer
int32
Required
cost
Price
-
Cost associated with the amenity.
Error with OTA code and description.
Name
Type
Format
Description
otaCode
integer
int32
Code based on OTA Error Codes list .
message
string
-
Required
Name
Type
Format
Description
hotelProperties
HotelProperty
-
Required Hotel property object returned by hotel search.
searchSessionToken
SearchSessionToken
-
Session token to be generated and provided by server on initial search call that can be referenced back for future calls on the same session.
Name
Type
Format
Description
checkin
string
date
Required Check in date as entered by traveler.
checkout
string
date
Required Check out date as entered by traveler.
hotelRates
HotelRates
date
Required
Name
Type
Format
Description
checkin
string
date
Required Check in date as entered by traveler.
checkout
string
date
Required Check out date as entered by traveler.
roomRates
RoomRateDetails
-
Required
Name
Type
Format
Description
hotelDetailsList
HotelDetails
-
Required
Details about bedding associated with the room.
Name
Type
Format
Description
quantity
integer
-
Required Number of beds.
bedTypeCode
integer
int32
Code based on OTA Bed Type (BED) list .
Representation of nightly tax amount associated with a rate along with optional breakdown.
Name
Type
Format
Description
amount
number
-
Required Amount of the taxes.
taxBreakdown
FeeTaxType
-
Fee or tax associated with rate. Can be either included or excluded from total rate as marked with inclusive
field.
Representation of nightly fees associated with a rate for given dates along with optional breakdown.
Name
Type
Format
Description
amount
number
-
Required Amount of the fees.
taxBreakdown
FeeTaxType
-
Fee or tax associated with rate. Can be either included or excluded from total rate as marked with inclusive
field.
Name
Type
Format
Description
amount
number
-
Required
fttCode
integer
int32
Required Code based on OTA's Fee Tax Type (FTT) list .
inclusive
boolean
true
/ false
Required If true
, this tax/fee is included in totalAmountAfterTax
amount.
Award or certification related to sustainability awarded to the hotel. If certification name is not known, it is possible to use OTHER
as label
and provide additional name
attribute.
Name
Type
Format
Description
label
SustainabilityProvider
-
Required Name or label of the award/certification. Supported values: GSTC
,EARTH_CHECK
,GREEN_GLOBE
,GREEN_KEY
,TRAVELIFE
,GREEN_LEAF
,LEED
,GREEN_GROWTH_2050
,GREEN_SEAL
,HILTON_LIGHTSTAY
,IHG_GREEN_ENGAGE
,NORDIC_SWAN
,ACTIVITY_GREEN
,ADVENTURE_GREEN_ALASKA
,ECO_CERTIFICATION_MALTA
,GLOBAL_ECOSPHERE_RETREATS
,GREAT_GREEN_DEAL
,SEYCHELLES_SUSTAINABLE_TOURISM
,GREEN_STAY
,OTHER
level
string
-
Optional level of certification.
name
string
-
Name of certification in case when not possible to map to currently supported labels (OTHER
is used).
The EmissionInfo provides a way to compare the environmental impact of different hotels. It can be used by travelers to make informed decisions about their hotel stays.
Name
Type
Format
Description
emissions
number
-
Represents the total value of emissions produced by the hotel.
sustainabilityScore
integer
-
Rates the hotel's overall sustainability efforts. It's on a scale of 0-100.
measure
Measure
-
Specifies the type of emissions that are measured. Supported values: CO2E
, CO2
unitOfMeasure
UnitOfMeasure
-
Specifies the units in which the emissions are measured. Supported values: TONNES
, KILOGRAMS
Provides details about the legal entity associated with this booking, if available.
Name
Type
Format
Description
name
string
-
Required Name of the legal entity.
taxId
string
-
Required Tax identity of the legal entity.
address
Address
-
Address of legal entity.
3D Secure strong customer authentication payment verification parameters.
Name
Type
Format
Description
avv
string
-
Required For 3DS1, this is the CAVV
. For 3DS2, this is the AVV
.
cavvAlgorithm
string
-
Identifies the algorithm used to generate the CAVV for 3DS1.
messageVersion
string
-
Required 3D Secure version.
transactionId
string
-
Unique transaction identifier assigned by the 3DS Server to identify a single transaction.
threeDSServerTransactionId
string
-
For 3DS1, this identifies the XID
. For 3DS2, this identifies the dsTransactionId
.
eci
string
-
Required Electronic Commerce Indicator.
exemptionCode
string
-
Identifies SCA exemption type.
HotelChangeNotificationRQ
Name
Type
Format
Description
changeTypeCode
HotelChangeTypeCode
-
Required
changeId
string
-
Required Uniquely identifies this change.
changeTimestamp
string
-
Required
changeSource
HotelChangeSource
-
changeDescription
string
-
Brief description associated with the change.
changeReasonCode
HotelChangeReasonCode
-
oldBooking
HotelBooking
-
Previous state of the booking that is modified (before modification).
updatedBookings
array
of HotelBooking
-
New state of the bookings that are modified or added (after modification).
HotelChangeNotificationRS
Name
Type
Format
Description
correlationId
string
-
Unique SAP Concur system correlation ID for tracing purposes.
impactedBookings
array
of HotelBookingRef
-
List of booking references that are impacted by this change (old and new). Note that this will allow suppliers to get SAP Concur system booking ids of any newly added booking and match to their confirmation number.
Name
Type
Format
Description
HotelChangeTypeCode
string
-
Code describing type of change. Supported values:UPDATE``ADD
, UPDATE
, CANCEL
, REPLACE
Name
Type
Format
Description
HotelChangeSource
string
-
Original source of this change. Supported values: TMC
, CHSSupplier
, GDS
, HOTEL
Name
Type
Format
Description
HotelChangeReasonCode
string
-
Code specifying reason for the change. Supported values:AGENT_UPDATED
,USER_REQUESTED
, AGENT_UPDATED
, HOTEL_UPDATED
, SUPPLIER_UPDATED
Name
Type
Format
Description
bookingId
string
-
SAP Concur system id of existing booking that needs to be updated (Required for oldBookings
)
confirmationCodes
array
of ConfirmationCode
-
Required
status
ReservationStatus
-
Required
basicHotelProperty
BasicHotelProperty
-
roomRate
RoomRateDetails
-
checkin
string
-
checkout
string
-
guests
array
of Guest
-
roomDescription
array
of string
-
comments
array
of string
-
Comments about special requests for this booking.
isModifiable
boolean
true
/ false
Required Whether or not this reservation can be modified.
Name
Type
Format
Description
bookingId
string
-
Required SAP Concur system id of booking that is impacted with this change (existing or new).
confirmationCodes
array
of ConfirmationCode
-
Required
Name
Type
Format
Description
propertyCode
PropertyCode
-
Required
chainCode
string
-
Example:HH
hotelName
string
-
Example: JW Marriott Parq
contactInfo
ContactInfo
-
Required
position
Geolocation
-
address
Address
-
cityCode
string
-
Required IATA 3 char city code for this property (required for adding passive segments).
Name
Type
Format
Description
latitude
number
-
Required
longitude
number
-
Required
Name
Type
Format
Description
addressLines
array
-
Required
city
string
-
Required City name.
state
string
-
Two-character state code.
stateName
string
-
Name or code of the State/Province/Administrative region.
countryCode
string
-
Required Two-character ISO code (ISO ALPHA-2) for country.
postalCode
string
-
Name
Type
Format
Description
isTotalBeforeTaxDisplayEligible
boolean
true
/ false
Controls what value is shown on property details page for rates. Displays totalBeforeTax
if set to true otherwise display totalAftertax
.
totalBeforeTax
number
-
Required
taxes
number
-
fees
number
-
totalAfterTax
number
-
Required
currencyCode
CurrencyCode
ISO 4217
Required
Name
Type
Format
Description
amount
number
-
Required
currencyCode
CurrencyCode
ISO 4217
Required Currency code.
Name
Type
Format
Description
penaltyDescription
string
-
Penalty information applicable to all the penalties.
penalties
array
-
Required Cancel penalties associated with the rate.
Name
Type
Format
Description
rateDescription
array
-
rateCategory
RateCategory
-
rateDetailsCallRequired
boolean
true
/ false
If true
, this rate requires a call to RateDetails before being booked.
rateChangesOverStay
boolean
true
/ false
roomId
string
-
ratePlanId
string
-
guarantee
Guarantee
-
Required
prepayRequired
boolean
true
/ false
Whether or not prepayment is required for booking this rate.
refundable
boolean
true
/ false
Is this rate refundable or not (based on all cancel penalties).
totalPrice
TotalPrice
-
Required
nightlyPrices
array
-
Required
cancelPenalties
CancelPenalties
-
Name
Type
Format
Description
basePrice
number
-
Required
taxes
Taxes
-
fees
Fees
-
totalPrice
number
-
Required
startDate
string
date
endDate
string
date
currencyCode
CurrencyCode
ISO 4217
Required
Name
Type
Format
Description
string
-
ISO 4217 currency code.
Name
Type
Format
Description
cancelDeadline
string
-
Required Date string in the date-time notation as defined by RFC 3339 with or without timezone, section 5.6. If there is no timezone it is assumed to be local timezone of the hotel.
description
string
-
refundableStatus
RefundableStatus
-
Required
amountPercent
AmountPercent
-
Name
Type
Format
Description
RefundableStatus
string
-
Supported values: FULLY_REFUNDABLE
, PARTIALLY_REFUNDABLE
, NON_REFUNDABLE
Name
Type
Format
Description
taxInclusive
boolean
true
/ false
If true
, all taxes are included in the returned rate.
feesInclusive
boolean
true
/ false
If true
, all fees are included in the returned rate.
numberOfNights
integer
-
The number of nights that are to be spent in the property.
basisType
AmountPercentBasisType
-
applyAs
AmountPercentApplyAs
-
percent
number
-
The percentage used to calculate the amount of the cancel fee.
amount
Price
-
Name
Type
Format
Description
AmountPercentBasisType
string
-
Supported values: FULL_STAY
, NIGHTS
, FIRST_LAST
Name
Type
Format
Description
AmountPercentApplyAs
string
-
Supported values: FIRST_NIGHT_DEPOSIT
, LAST_NIGHT_DEPOSIT
, FIRST_AND_LAST_NIGHT_DEPOSIT
, FIRST_NIGHT_PAYMENT
, LAST_NIGHT_PAYMENT
, FIRST_AND_LAST_NIGHT_PAYMENT
Name
Type
Format
Description
RateCategory
string
-
Supported values: AAA
, CONCIERGE
, CONVENTION
, CORPORATE_DISCOUNT
, GOVERNMENT
, MILITARY
, SENIOR
, TRAVEL_INDUSTRY
, NEGOTIATED
, PROMOTIONAL
, CONSORTIA
, CONTRACT
, FEDROOM
Name
Type
Format
Description
GuaranteeType
string
-
Supported values: DEPOSIT_REQUIRED
, GUARANTEE_REQUIRED
, NONE
Name
Type
Format
Description
PaymentCardType
string
-
Supported values: AMERICAN_AIRLINES
, ALASKA_BARTER
, AMEX
, AWARD_CREDIT
, CANADIAN
, CARTE_BLANCHE
, CHINA_UNION_PAY
, CONFERMA
, DELTA
, DINERS_CLUB
, DISCOVER
, ENROUTE
, EURO_CARD
, JCB
, MC
, NORTHWEST
, TWA
, UATP
, UNITED_TRAVEL
, UNITED_CREDIT
, VENDOR_PROVIDED
, VISA
Name
Type
Format
Description
PropertyCode
string
-
Example: 'HH498949'
Name
Type
Format
Description
ReservationStatus
string
-
Supported values" RESERVED
, CANCELLED
, PENDING_CONFIRMATION
Name
Type
Format
Description
ConfirmationCodeType
string
-
Confirmation Code Types that maps to OTA codes for Unique Id Types list RESERVATION(Record Locator)=14, SUPPLIER_CONFIRMATION=40, CANCELLATION=50, HOTEL_CONFIRMATION(Property Confirmation No.)=10, CONCUR_GDS_REFERENCE -> Concur Booking Record Locator for Passives. Supported values: RESERVATION
, SUPPLIER_CONFIRMATION
, CANCELLATION
, HOTEL_CONFIRMATION
, CONCUR_GDS_REFERENCE
, PASSIVE_CONFIRMATION