Reservation XML structure

Please note that for pushed reservations, the credit card details are not included by default. If the partner is PCI/DSS compliant and can provide a valid AOC, and if there are more than 25 properties connected, the secure transfer of credit card details can be activated.

ResStatus

Yes

Possible values are:

• Book

• Modify

• Cancel

OriginalDeliveryMethodCode

No

The default value is "11"

.

RoomStayReservation

No

WalkInIndicator

No

The value will be returned in the OTA_HotelResNotifRS response

CreateDateTime

Yes

The format respects the ISO 8601 format 2015-11-16T22:23:48+00:00

LastModifyDateTime

Yes

The format respects the ISO 8601 format 2015-11-16T22:23:48+00:00

ID

Yes

Unique identifier of the source channel. You can retrieve the full list automatically, see Specific call : retrieve channels list

Type

Yes

Default value is "22"

Yes

Name of the source channel. You can retrieve the full list automatically, see Specific call : retrieve channels list

IndexNumber

Yes

Unique identifier of this specific room stay.

RoomStayStatus

Yes

Possible values are:

• Book 

• Cancel

RoomID

Yes

The ID of the room

IsRoom

No

The default value is "1"

Name

Yes

The name of the room

MealPlanIndicator

Yes

Indicate if there is a mealplan included or not with this rateplan

MealPlanCodes

No

List of MealPlan codes included separated by spaces.

Example : "4.MPT 3.MPT"

List

EffectiveDate

Yes

The day on which this rate plan was applied for a reservation. The format respects the ISO 8601 2015-11-16

ExpireDate

Yes

The day on which this rate plan was applied for a reservation. The format respects the ISO 8601 2015-11-16

ExpireDateExclusiveInd

No

In the case of a date span, should the ExpireDate be included (ExpireDateExclusiveInd="0") or excluded (ExpireDateExclusiveInd="1")

RatePlanID

Yes

The ID of the rate plan

In order to avoid any confusion about the exact day rate and for which days they have been applied, the Hotel-Spider can work with the following three scenarios:

• The values of the EffectiveDate and the ExpireDate attributes are equal. The day rate will apply only to the date specified

• The values of the EffectiveDate and the ExpireDate attributes are different and the ExpireDateExclusiveInd attribute is not set. The day rate will apply to all the days covered from the EffectiveDate until and including the ExpireDate.

• The values of the EffectiveDate and the ExpireDate attributes are different and the ExpireDateExclusiveInd attribute is set. The day rate will apply to all the days covered from the EffectiveDate until the day before the ExpireDate. Thus the ExpireDate is excluded from the day rates.

EffectiveDate

Yes

The day on which this rate was applied for a reservation. The format respects the ISO 8601 2015-11-16

ExpireDate

Yes

The day on which this rate was applied for a reservation. The format respects the ISO 8601 2015-11-16

In order to prevent any interpretation issue, exactly one Rate element is present for each night of the stay while RoomRate elements are used to differentiate rate plans.

In the example message above, both room stays are for 4 nights but

• the first one has a different rate plan for the third night, resulting in the presence of 3 different RoomRate elements

• the second one is made with the same rate plan for all nights, thus only one RoomRate element is needed

CurrencyCode

Yes

The day on which this rate plan was applied for a reservation. The format respects the ISO 8601 2015-11-16

AmountBeforeTax / AmountAfterTax

Yes

The day rate for this specific product (room type + rate plan) without any additional services

CurrencyCode

Yes

The day on which this rate plan was applied for a reservation. The format respects the ISO 8601 2015-11-16

AmountBeforeTax / AmountAfterTax

Yes

The day rate for this specific product (room type + rate plan) with additional services

RPH

Yes

Provides a unique reference to the service.

AgeQualifyingCode

No

Possible values are:

• 7 (Infant) 

• 8 (Child)

• 9 (Teenager)

• 10 (Adult) 

• 11 (Senior)
  
  

Count

Yes

The number of guests for this specific room stay within a specific age category.

The guest count applies per Room Stay

Start

Yes

The arrival day for this room stay. The format respects the ISO 8601 2015-11-16

End

Yes

The departure day for this room stay. The format respects the ISO 8601 2015-11-16

Duration

No

The number of nights for this room stay. The format respectss the ISO 8601 format PnYnMnDTnHnMnS

AmountAfterTax

Yes

The discount total amount including all associated taxes

AmountBeforeTax

No

The discount total amount not including any associated tax

CurrencyCode

Yes

An ISO 4217 (3) alpha character code that specifies a monetary unit.

DiscountCode

No

Specifies the type of discount (max 16 chars)

Name

No

Can be used to transfer a promotion code (max 64 chars)

CurrencyCode

Yes

The currency in which the price is transmitted. The format will be provided in ISO 4214

AmountBeforeTax

No

The price for this particular room stay without any taxes

AmountAfterTax

No

The price for this particular room stay with taxes

HotelCode

Yes

The ID of the hotel as defined on the online booking system

HotelName

Yes

The name of the hotel as defined on the online booking system

CurrencyCode

No

The currency code that has been configured for the hotel on the online booking system.

The ResGuestRPHs element contains a comma separated string of integers that each link uniquely to a guest profile as described in the ResGuest elements.

IsPerRoom

No

The default value is "1"

RPH

Yes

An integer that will uniquely link a service described in the Service element to a RoomStay

ResGuestRPH

Yes

An integer that will uniquely link the current guest profile to a RoomStay

ProfileType

Yes

Possible values are:

• 1 (Customer) 

• 3 (Company)

• 4 (Travel Agency)

Salutation of honorific. Example: Mr, Mrs, Ms, Miss, Dr

Degree or honors. Example: Ph. D., M.D.

Given name, first name or names. Example: John, James, Martin

The middle name of the person name. Example: Johny, James, Martin

The surname prefix. Example: "van der", "von", "de"

Family name, last name. Even though this is not recommended, it may also be used for full name if the online booking system does have the ability to separate a full name into its parts.

Can contain various name suffixes and letters. Example: "Jr.", "Sr.", "III"

PhoneTechType

Yes

Possible values are:

• 1 (Voice) 

• 3 (Fax)

• 5 (Mobile)

PhoneNumber

Yes

The numerical string representing the telephone number

FormattedInd

no

Is the telephone number provided formatted or unformatted

CountryAccessCode

no

Code assigned by telecommunications authorities for international country access identifier

AreaCityCode

no

Code assigned for telephones in a specific region, city or area

When the FormattedInd attribute is set, the CountryAccessCode, the AreaCityCode and the PhoneNumber attributes should contain the appropriate information.

When the telephone is transmitted formatted, the PhoneNumber attribute should not contain the CountryAccessCode nor the AreaCityCode values.

FormattedInd

No

When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted, street number and street name are sent independently: the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.

Contains the street number.

When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name are sent independently: the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.

Postal Office Code number

City, town or postal station (i.e., a postal service territory, often used in a military address)

County or Region Name

State or Province name

Code

Yes

ISO 3166 alpha 2 code for a county

The CountryName can also be transmitted for readability.

Description of the ProfileType="3" and ProfileType="4"

PhoneTechType

Yes

Possible values are:

• 1 (Voice) 

• 3 (Fax)

• 5 (Mobile)

PhoneNumber

Yes

The numerical string representing the telephone number

FormattedInd

no

Is the telephone number provided formatted or unformatted

CountryAccessCode

no

Code assigned by telecommunications authorities for international country access identifier

AreaCityCode

no

Code assigned for telephones in a specific region, city or area

When the FormattedInd attribute is set, the CountryAccessCode, the AreaCityCode and the PhoneNumber attributes should contain the appropriate information.

When the telephone is transmitted formatted, the PhoneNumber attribute should not contain the CountryAccessCode nor the AreaCityCode values.

FormattedInd

No

When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted the street number and street name are sent independently: the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.

Contains the street number.

When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted the street number and street name are sent independently: the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.

Postal Office Code number

City, town or postal station (i.e., a postal service territory, often used in a military address)

County or Region Name

State or Province name

Code

Yes

ISO 3166 alpha 2 code for a county

The CountryName can also be transmitted for readability.

AgeQualifyingCode

No

Possible values are:

• 7 (Infant) 

• 8 (Child)

• 9 (Teenager)

• 10 (Adult) 

• 11 (Senior)
  
  

Count

Yes

The total number of guests for this specific reservation within a specific age category.

Start

Yes

The arrival day for this reservation. The format respects the ISO 8601 2015-11-16

End

Yes

The departure day for this reservation. The format respects the ISO 8601 2015-11-16

Duration

No

The number of nights for this reservation. The format respects the ISO 8601 format PnYnMnDTnHnMnS

GuaranteeType

Yes

Possible values are:

• CC/DC/Voucher
  
  

• Deposit

• Profile

CardCode

Yes

Possible values are:

• AX (American Express)

• BC (Bank Card)

• BL (Carte Bleu)

• CB (Carte Blance)

• DN (Diners Club)

• DS (Discover Card)

• EC (Eurocard)

• JC (Japanese Credit Bureau Credit Card)

• MA (Maestro / Switch)

• MC (Mastercard)

• TP (Universal Air Travel Card)

• VI (Visa)

ExpireDate

Yes

The expire date of the payment card. The format is mmYY

Mask

No

The masked version of the credit card number. Only the last 4 digits will be displayed.

GuaranteeType

No

An enumerated type defining the guarantee to be applied to this reservation.

Possible values are:

• CC/DC/Voucher
  
  

• Deposit

• Profile

• GuaranteeRequired

• PrePay

• None

Type

No

Used to specify the type of information being sent (i.e., RequiredPayment, GuaranteePolicy, AcceptedPaymentForms)

CurrencyCode

Yes

The currency in which the price is transmitted. The format will be provided in ISO 4214

AmountBeforeTax

No

The price for this particular day without any taxes

AmountAfterTax

No

The price for this particular day with taxes

ResID_Type

Yes

Possible values are:

• 14 (Reservation)

• 15 (Cancellation)
  
  

ResID_Value

Yes

The reservation number as provided by the online booking system to the end customer/guest

ResID_SourceContext

No

The name of the online booking system

ResID_Source

Yes

The ID of the online booking system as defined on the Hotel-Spider system.

ResID_Date

No

The date and time of generation of the given ID

When ResID_Source="14" the ResIDSourceContext will contain the name of the channel from which the reservation originated. The ResID_Value will contain the reservation number that was assigned to this specific reservation by the channel through which it was originally made.

When ResID_Source="15" the ResID_SourceContext will contain the name of the channel from which the cancellation originated. The ResID_Value will contain the reservation number that was assigned to this specific reservation by the channel through which it was originally made.

When ResID_Source="34", the ResID_SourceContext will contain "Hotel-Spider" or the name of any of its white label partners. The ResID_Value will contain the internal reservation number that was assigned by the Hotel-Spider system to this specific reservation. This value must be re-used when the third party software provider confirms the proper processing of any reservations/modifications/cancellations.

When ResID_Source="40", the ResID_SourceContext will contain "Hotel-Spider" or the name of any of its white label partners. The ResID_Value will contain the internal reservation number that was assigned by the third party software client to this specific reservation. This value will only be provided if the reservation has previously already been confirmed by the third party software client.

ProfileType

Yes

Possible values are:

• 1 (Customer) 

• 4 (Company)

• 5 (Travel Agency)

Salutation of honorific. Example: Mr, Mrs, Ms, Miss, Dr

Degree or honors. Example: Ph. D., M.D.

Given name, first name or names. Example: John, James, Martin

The middle name of the person name. Example: Johny, James, Martin

The surname prefix. Example: "van der", "von", "de"

Family name, last name. Even though this is not recommended, it may also be used for full name if the online booking system does have the ability to separate a full name into its parts.

Can contain various name suffixes and letters. Example: "Jr.", "Sr.", "III"

PhoneTechType

Yes

Possible values are:

• 1 (Voice) 

• 3 (Fax)

• 5 (Mobile)

PhoneNumber

Yes

The numerical string representing the telephone number

FormattedInd

no

Is the telephone number provided formatted or unformatted

CountryAccessCode

no

Code assigned by telecommunications authorities for international country access identifier

AreaCityCode

no

Code assigned for telephones in a specific region, city or area

When the FormattedInd attribute is set, the CountryAccessCode, the AreaCityCode and the PhoneNumber attributes contains the appropriate information.

When the telephone is transmitted formatted, the PhoneNumber attribute does not contain the CountryAccessCode nor the AreaCityCode values.

FormattedInd

No

When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted the street number and street name are sent independently: the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.

Contains the street number.

When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted the street number and street name are sent independently: the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.

Postal Office Code number

City, town or postal station (i.e., a postal service territory, often used in a military address)

County or Region Name

State or Province name

Code

Yes

ISO 3166 alpha 2 code for a county

The CountryName can also be transmitted for readability.

Description of the ProfileType="3" and ProfileType="4"

PhoneTechType

Yes

Possible values are:

• 1 (Voice) 

• 3 (Fax)

• 5 (Mobile)

PhoneNumber

Yes

The numerical string representing the telephone number

FormattedInd

no

Is the telephone number provided formatted or unformatted

CountryAccessCode

no

Code assigned by telecommunications authorities for international country access identifier

AreaCityCode

no

Code assigned for telephones in a specific region, city or area

When the FormattedInd attribute is set, the CountryAccessCode, the AreaCityCode and the PhoneNumber attributes contains the appropriate information.

When the telephone is transmitted formatted, the PhoneNumber attribute does not contain the CountryAccessCode nor the AreaCityCode values.

FormattedInd

No

When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted the street number and street name are sent independently: the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.

Contains the street number.

When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted the street number and street name are sent independently: the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.

Postal Office Code number

City, town or postal station (i.e., a postal service territory, often used in a military address)

County or Region Name

State or Province name

Code

Yes

ISO 3166 alpha 2 code for a county

The CountryName can also be transmitted for readability.

HotelCode

Yes

The ID of the hotel as defined on the online booking system

HotelName

Yes

The name of the hotel as defined on the online booking system

CurrencyCode

No

The currency code that has been configured for the hotel on the online booking system.

Inclusive

Yes

Whether the price for this service is included in the room rate. Values: False (or No), and True (or Yes).

ServicePricingType

No

An enumerated type that defines how a service is priced. Refer to Service pricing type (ServicePricingType)

ServiceRPH

Yes

A unique ID for a service that may be referenced elsewhere in the schema.

Type

No

A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).

NumberOfUnits

Yes

Number of units reserved

EffectiveDate

Yes

Indicates the starting date.

AmountAfterTax

Yes

The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).

CurrencyCode

Yes

An ISO 4217 (3) alpha character code that specifies a monetary unit.

AmountAfterTax

Yes

The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).

CurrencyCode

Yes

An ISO 4217 (3) alpha character code that specifies a monetary unit.

Name

No

Contains Name/Code value for Special Request

Start

Yes

Start date of the TimeSpan

End

Yes

End date of the TimeSpan

Name

Yes

Contains value for name of service