The following is a list of optional field data for Hotel Sell, in the HT04 <HotelOptionalData> or the
IT04 <HtlSegOptFlds>.
Some optional fields are
contained in the fixed header part of this transaction, for example, crib.
They
will not be accepted for input in this section.
|
Code |
Description | Req | Res |
| AD |
Customer Address. There are two options to express the customer
address:
<Fld> |
x | x |
| AV |
Advance deposit.
<ID>AV </ID> |
x | |
| BA |
Billing Address. Contains the billing address that the credit
card company has on file for the credit card entered in the Form of
Guarantee.
The format is street address @ city @ state @ Z/postal code or ZIP Code @ country. Blanks are allowed for the address and city. Currently, the country code is not required, as Merchant Model inventory is only available in the US. <Fld> |
x | |
|
BS |
Booking Source. This eight-digit ARC/IATA number is assigned to the Pseudo City Code (PCC) that is making the request. | x | x |
| BT |
Bed Type Configuration. The bed type configuration for a room,
which includes the number of beds and bed size. For example: “A2K”, “*2Q”,
“B1D”, or “A2*”.
Note: The BT field is not used to request extra bedding. |
x | x |
| CA |
Child Ages. Child Ages are optional for the CRS and vendors. If
entered, there must be one age for each child listed in Number of Children
(CC). CC must precede CA. CA should be used with CC (number of children). The format is either one or two digits per age, separated by a space. For example, “12 4 3 2 1”. Up to five ages can be entered. This data is copied from previous <HotelCompleteAvailability_#> or <HotelAvailability_#> responses. |
x | x |
| CC |
Number of Children count. The number of children staying in one
room (1 - 5). This is used in a request.
Note: The number of Adults plus the number of Children must not exceed a total of nine. CC can be submitted without CA (Child Ages). CC must precede CA. Also see <HotelOptionalData> (HT04 KLR) for related optional child ages. Returned in previous <HotelCompleteAvailability_#> or <HotelAvailability_#> responses. |
x | x |
|
CD |
Corporate Discount/Negotiated Rate. These rates are negotiated between major corporations and hotel chains. The format is CorporateDiscountNumber@RateAccessCode. The Rate Access Code is six-digit code provided by the vendor. | x | x |
| CL |
Credentials ID. Flags a booking that requires credentials at
check-in. For example, if a booking has a military discount, the traveler
must show a military ID. Y = Requires credentials. |
x | |
| CM |
Commissionable Booking. Flags a booking that will include an
agency commission for the sale.
Y = Commissionable Note: Supplier can also return a 2-byte numeric percentage value with format – NN. |
x | |
|
CN |
Credit Card Name. The name that the credit card company has on file for the credit card entered in the Form of Guarantee. This name can be different for the name in the hotel booking and the name in the PNR/BF <Firstname Lastname>. | x | |
| CR | Crib. Requests an infant crib. A maximum of three cribs can be requested. | x | x |
| CS | Alternate Currency Crib. If a user requests a rate amount for a crib in a currency that is different from the currency rate stored in the vendor's database, this field will contain the crib charge in the requested currency. | x | |
| CT |
Rate Categories. The codes are based on OTA values (Table RPT),
but the following are Galileo codes. A09 -
Association |
x | |
| CV | Credit Card Verification Value (CVV ID). User provides this if applicable to the Credit Card. | x | |
| DB | A ‘Direct Bill’ parameter “/DBL” sent to Suppliers by agency users to identify an account code value that Suppliers bill directly. The maximum length of DBL is 50. It can be alphanumeric value. |
x | |
| DP |
Deposit. The deposit can also be a Payment Guarantee (GT). For
credit cards, the credit card code, number, and expiration date are included
as optional fields. Maximum of 25 characters.
Example: AX98765432123EXP1295. Other forms of deposit include: guaranteed by the agency (AGT), deposit has been taken (DPST), and deposit with free-form text. |
x | x |
| DR | Rate Description – This contains rate description text saved from HOC screen. This will be displayed only for PNR created from green screen. | x | |
| EC | Extra Child. Adds an additional Child traveler, in addition to any Children who where entered in the preceding Hotel Complete Availability or Hotel Rules request. | x | x |
| ED | Alternate currency extra child. If a user requests a rate amount for an extra child in a currency that is different from the currency rate stored in the vendor's database, this field will contain the extra child charge in the requested currency. | x | |
| EF |
Effective Date. The effective date is part of Rate change
information received in Type A sell and modify vendor’s response. Effective
Date is succeeded by Rate Change Amount (RN). EF and RN together specify the
rate change information. Hotel suppliers can return up to 30 rate changes. Example: EF29AUG, RN500USD The above example specifies that rate change is effective from Date 29AUG and Rate Change amount 500USD applies to that date. |
x | |
| EX | Extra Adult. Adds an additional Adult traveler, in addition to any Adults who where entered in the preceding Hotel Complete Availability or Hotel Rules request. | x | x |
| EY | Alternate currency extra adult. If a user requests a rate amount for an extra child in a currency that is different from the currency rate stored in the vendor's database, this field will contain the extra child charge in the requested currency. | x | |
| FG |
Frequent Guest Number. A number assigned by a chain for
frequent guests. Format: The two-character Chain or All Brands Code followed
by the Frequent Guest Number, which has a maximum of 35 characters.
For example: BW12345678987654321 for Best Western or EM112345678987654321 for Every Marriott. |
x | x |
| FT | Frequent Air Traveler Number. FT includes a carrier code as well as the number. | x | x |
| GA |
Absolute Hold Deadline. The date and time when a deadline for a
payment goes into effect.
The date and time are based the hotel property’s location. The time is in a 24-hour clock, where "T" is used as a delimiter between the date and the time: CCYYMMDDTHHMM. For example: 20050122T1800 and 20051101T0700. |
x | |
| GD | This will indicate how unit of time Off-set given in GO is applied to the above date.
BA = Before arrival indicator Indicates that the above date is the arrival date and the following unit of time Off-set is used to calculate the actual deadline for a payment in advance of the arrival. |
x | |
| GH | Guarantee Hold Time. The time until the room will be held, in a 24-hour clock. | x | |
| GI |
Guarantee Type Indicator. The Guarantee Type Indicator for Room
Rate values are: G - Guarantee |
x | |
| GM | Guarantee Amount | x | |
| GO |
Guarantee Deadline Offset Time. The optional units of time
off-set before or after the date/time that apply to the deadline. Used in
conjunction with Time Base - Before Arrival/After Booking (GD).
The format is YR-###, MO-###, DY-###, or HR-###, where ### is the number of units. If the above date (GA) is the arrival date, these units are used to calculate the actual deadline for a payment in advance of the arrival. For example, if the preceding date (GA) is the arrival date (BA), and this field contains DY-002, the actual deadline for a payment is two days before the arrival date. If the above date (GA) is the booking date, these units are used to calculate the actual deadline for a payment after the booking date. For example, if the preceding date (GA) is the booking date (AB), and this field contains MO-003, the actual deadline for a payment is three months after the booking date. |
x | |
| GT |
Payment Guarantee. Can also be a Deposit (DP).
For credit cards, the credit card code, number, and expiration date are included as optional fields. Maximum 25 characters. Example: AX98765432123EXP1295. Other forms of guarantee are: guarantee to agency with IATA number in AAA (AGT), guarantee to agency with the following IATA number, and guarantee free-form text. The "following IATA number" means that IATA number is not copied from AAA. The IATA number is provided in this optional field. |
x | x |
|
ID |
Customer Identification Number. A 19-character special code given by hotels for promotional bookings. | x | x |
|
LI |
Line number of property from previous availability. | x | |
| MC |
Meals Codes. Identifies a maximum of five of the following OTA meal codes that are associated to the Rate Plan (OTA Code: MPT). Formatted as a space-delimited list. For example: “12 10 3 8 11”, “9”, or “02 06 11”. 1 - All inclusive2 - American 3 - Bed & breakfast 4 - Buffet breakfast 5 - Caribbean breakfast 6 - Continental plan 7 - English breakfast 8 - European plan 9 - Family plan 10 - Full board 11 - Full breakfast 12 - Half board/modified American plan |
x | |
| MI |
Meals Included Indicator. Y/N list that represents Breakfast,
Lunch, and Dinner, respectively. Examples:
|
x | |
| MP | Meal Plan. You cannot include a meal plan in a sell, nor would it be returned in a sell response. With Complete Pricing, it is returned in the HOV (Rules) response and it would show what meals are included. Presently, the meal plan, or meals included with the rate are listed in the HOC description or in the HOV response. | x | |
| NC | Number of Children | x | |
| NF |
First Name. Optional. The first name of the primary traveler in
the booking. Minimum of one character.
Must be used with NL to create a full name. Overrides the First Name field in the PNR/BF. |
x | x |
| NL |
Last Name. The last name of the primary traveler in the
booking. Minimum of two characters.
Must be used with NF to create a full name. Overrides the Last Name field in the PNR/BF. |
x | x |
| NR | Non-refundable type for a Room Rate.
Y = Non-refundable |
x | x |
| OR |
On Request Flag. Indicates if the requested Room Type is
available on request status only.
Y = Room Type is available on request Returned in the Room on Request <RoomByReq> value in <HotelRate> (HTRT KLR) in the preceding Hotel Complete Availability response. |
x | |
| PA |
PA new ‘pay’ parameter sub-qualifier will be sent to Suppliers to flag that the booking is to be ‘Prepaid’ upon commit or check-in arrival with the cc number in /G- field which may or may not be a virtual credit card. |
x | |
| PT |
Pricing Type. Indicates that the rate in the Sell request is an approximate total. The values are: AP = Approximate Total Plus. The total includes all taxes, surcharges, and extra charges. AT = Approximate Total. The total includes all taxes and surcharges, but does not include any extra charges. |
x | x |
| RA | Rollaway bed for an adult. Maximum of three beds. | x | x |
| RB |
Alternate Currency rollaway bed for an adult.
If the user requests a rate amount for a rollaway bed in a currency that is different from the currency rate stored in the vendor's database, this field will contain the extra rollaway bed charge in the requested currency. |
x | |
| RC | Rollaway bed for a child. Maximum of three beds. RC should be used only in HT04 <HotelOptionalData>. | x | x |
| RD | Rollaway bed for a child. Maximum of three beds. RD should be used only in IT04 <HtlSegOptFlds>. | x | x |
| RE |
Alternate Currency rollaway bed for a child.
If a user requests a rate amount for a rollaway bed in the currency that is different from the currency rate stored in the vendor's database, this field will contain the extra rollaway bed charge in the requested currency. |
x | |
| RG | Guaranteed rate. | x | |
| RL |
Tour room location. From a business standpoint, this is the
room location,
e.g., MV – mountain view. |
x | x |
| RN |
Rate Change Amount. Rate change information received in a Type
A sell and modifies the vendor’s response. Rate Change Amount (RN) is
followed by Effective date (EF). EF and RN together specify the rate change information. Hotel suppliers can return up to 30 Rate changes. Example: EF29AUG, RN500USD The above example specifies that rate change is effective from Date 29AUG and Rate change amount 500USD applies to that date. |
x | |
| RO | Rate Override Rate | x | |
| RQ | Quoted Rate. | x | |
| RR | Room Rate (Rate Request). This rate is often a booking code (BIC). | x | x |
| RT | Nightly rate with currency code. | x | |
| RV |
Room View codes (OTA Code: RV). The OTA Room View codes are:
1 – Airport View |
x | |
| SC | Surcharge Fee Total. The surcharge amount charged for a room. The surcharge amount is common to the HT03 <HotelSell> currency code and decimals field. The currency code in the <HotelSell> applies to all amounts returned in a response. | x | |
| SI | Special Information. Information about guest requests, such as ground floor or a feather pillow. | x | x |
| SM | Smoking Room. Identifies when smoking is allowed in Room. 'Y' or 'N'. | x | |
| SU | Parameter that identifies the existing cc parameter /G- is a virtual or single use cc sent to hotel suppliers. This *SU can be only be given with G-CC, G-DPSTCC, G-PAYCC fields and cannot be given as a separate Qualifier. Example: /G-PAYAX370000000000028EXP1213*SU /G-AX370000000000028EXP1213*SU |
x | |
| TK | Token value from previous availability. | x | |
| TN | Tour Number. | x | x |
| TR | Total Rate Amount. The total amount, per room, including taxes and surcharges, for the stay. The format is a three-character currency code followed by a nine-digit rate amount. This rate also includes extra options, if the Pricing Type (PT) is "AP". Has common <HotelSell> currency code and decimals field. May contain currency code (mandatory when in request record, but optional when in response). | x | x |
| TT | Taxes Total. The total tax amount per room. This has the common HT03 <HotelSell> currency code and decimals field. | x | |
| XA |
Absolute
deadline for a cancellation fee. The last date and time the reservation can
be canceled without penalty
The date and time are based the hotel property’s location. The time is in a 24-hour clock, where "T" is used as a delimiter between the date and the time: CCYYMMDDTHHMM. For example: 20050122T1800 and 20051101T0700 |
x | |
| XB |
Basis Unit
for Charge. The unit of charge for the rate (first night, last night, etc.)
This value is used with Percent Cost of Cancel (XP).
This cost qualifier describes the percentage applied to calculate the cancellation penalty. The options are: FullStay, First, and Last. |
x | |
| XC | Cost Amount of Cancel. The cancellation penalty charge with a currency code. This value does not include a decimal point. The format for this "10000USD" | x | |
| XD |
Time Base -
Before Arrival/After Booking. Indicates how a unit of time off-set (XO) is
applied to a Cancellation Deadline (XA).
AB =
After booking indicator BA =
Before arrival indicator |
x | |
| XF | Fees Inclusive Cancel Amount. Displays if the penalty amount contains fees. | x | |
| XN | Number of Nights Cost for Cancel. The number of nights from the original booking that are charged if the booking is canceled. | x | |
| XO |
Deadline Offset Time for Cancel Fee. The optional units of time
off-set. This ID can be used only if the Cancel Date (XA) is the booking
date or the arrival date. May be used in conjunction with XA and XD.
If the cancel date is the arrival date, these units are used to calculate the actual cancellation date in advance of the arrival. For example, if the XO is DY-002, the actual cancellation date is two days before the arrival date. If the cancel date is the booking date, these units are used to calculate the actual cancellation date after the booking date. The format is YR-###, MO-###, DY-###, or HR-###, where ### is the number of units. For example, if the XO is MO-003, the actual cancellation date is three months after the booking date. |
x | |
| XP | Percent Cost of Cancel. The percentage of the booking rate that is charged if the booking is canceled. | x | |
| XT | Tax Inclusive Cancel Amount. The penalty amount for canceling the booking, including taxes. | x |