Documentation

File specification

The contract information is informed in a plain text file. There are different structures informed with the { } character and all the fields of every structure separated by ":" character. Multiple records are allowed for one structure, the records are separated by a new line. 


Example

{STX1}
FIELD1:FIELD2:FIELD3
FIELD1:FIELD2:FIELD3
{/STX1}


There are two different groups of inventory information: the HotelBeds direct contract inventory and the supplier external inventory.

These are the different structures for each group. The name for the internal structures starts always with CN and the external with SI.



[CCON] Contract header

Field

Length

Type

Null

Description

Internal Name

 

 

 

E

I

 

 

External Inventory

1

Boolean

N

N

Y: HotelBeds external inventory information 
N: HotelBeds internal inventory contract information

 

Destination code

3

Text

N

N

Destination code. Used as a parameter at availability request on XML feed.

ides_cod_destino

Office code

8

Number

N

N

Incoming office code

grec_seq_rec

Contract number

8

Number

Y

N

Contract number and office code are unique identifier for a contract. Contract numbers can repeat for different office codes. 

seq_contr

Contract name

25

Text

N

N

Contract name is used in the XML ServiceAddRQ to valuate the booking

nom_contrato

Company code

3

Text

Y

Y

Should be noted the standing data for Meal Plans (board) and Room Type descriptions is dependent on the company code

semp_cod_emp

Type of service

1

Enumeration

N

N

Will be always 'H' [Hotel]. In the future it could specify different types of product: Transfers, Excursions, etc.

ind_tipo_servicio

Hotel code

8

Number

N

N

 

ghor_seq_hotel

GIATA Hotel code

15

Number

Y

Y

 

cod_hotel_giata

Initial date

8

Date

N

N

Travel start date

fec_desde

End date

8

Date

N

N

Travel end date

fec_hasta

No hotel

1

Boolean

N

N

Y: Roulette contract. There is no specific accommodation code defined. For example, "3 star hotels in London". 
N: The hotel code field will be always informed

ind_nohotel

Currency

3

Text

N

N

Currency code for prices in this contract.

sdiv_cod_divisa

Base board

2

Text

Y

N

Base board for the contract

greg_cod_reg

Classification

3

Enumeration

Y

Y

See Classification Table in the Conventions section.

cod_clasif

Payment model

1

Enumeration

Y

N

M: Merchant model. Net price will always appear and gross price will appear only when Recommended Retail Price (RRP) is required by Hotelier. 

ind_pvp

Daily price

1

Boolean

Y

N

Daily price is price for the first day of booking. 
Y: Daily price is based on the first night of stay i.e. taken from the first night and multiplied by the number of nights 
N: Daily price is based on a nightly basis (pro-rata) i.e. taken from each night of the stay

ind_primer_dia

Release days

1

Boolean

Y

N

N: Release days values are taken for release for first day of booking. Check release date only for the first night of the stay
Y: Check release date for each night of the stay

ind_release_estancia

Minimum child age

3

Number

Y

N

Minimum age a pax is considered child for price purposes.  Age below is considered an infant. For example, if the value is 2 a passenger with 1 age is an infant for price calculation

nro_edad_inicial

Maximum child age

3

Number

Y

N

Maximum child age when define the number of adults and children in a room for checking the occupancy restrictions.For example if 12 then a passenger above 13 and above is considered an adult

nro_edad_final

Opaque

1

Enumeration

Y

Y

This field indicates if rates are for packaging purposes or not: B: This contract can be sold as hotel only or packaged. P: This contract can be sold only when packaging. Package discount in the CNSU section appears, it needs to be applied when packaging

ind_opac

Fix rate

1

Boolean

Y

N

Rate type 
Y: Fix rate. Fix rates are included for compatibility purposes. At the moment of creation of this document, are not available. Will be released in future. 
N: Variable rate

ind_modotar

Contract type

1

Text

N

N

Always U

ind_tipocon

Maximum rooms

3

Number

Y

Y

Maximum number of rooms to be booked on a single reservation

max_habres

Hotel content

8

Number

Y

Y

For roulette contracts inform which hotel code to take the content description from

hot_ficha

Selling price

1

Boolean

N

N

Y: Price appearing at [CNCT.Price] is the mandatory final price for this product when sold to public 
N: Price appearing at [CNCT.Price] is not mandatory

re_t_co_interface.  ind_vinculante

Internal field

 

Boolean

Y

Y

 

 

Internal field data

 

Text

Y

Y

 

 

Internal classification

1

Enumeration

N

N

 

 

Is total price per stay

1

Boolean

N

Y

This field indicates if it is necessary to sum several price lines from [SIAP.Amount] in order to get the final price for reaching the length of stay desired or not. Example:  Y: Not possible to do the sum over other lines to get the final price with the length of stay required as it is returning the lengths of stay available for this room.  N: Possible to do the sum over other lines to get the final price with the length of stay required.

 

Internal field 1 1 Boolean Y Y    
Internal field 2
1 Boolean Y Y    
Release per hours 4 Number Y N

Time from destination until you can do the availability request in order to get proper availability. Example: Release 0 days until 13H means availability till the same day of entry till 13:00 (destination time)

Release 1 day until 10H means availability till the day before the entry till 10:00 (destination time)

 


NOTE: The Null column is divided in 2: I [internal] when [CCON.External inventory] value is false and E [external] when true.

NOTE 2: Internal field 1 and Internal field 2 might not appear depending on the version defined per client.

Example

{CCON}
N:PMI:1:56548:CG-TODOS:E10:H:4304::20110101:20111231:N:EUR:BB::M:N:N:0:12::N:U:5::N:N:zzzz:P:N:::
{/CCON}




[CNHA] Room Types

Specification

Field

Length

Type

Null

 


Description

Internal Name

 

 

 

I

E

 

 

Room type

3

Text

N

N

Room Type code. Depends on Company code at CCON 
Pair Room Type – Company code coincides with Room Type Code at Availability Response: 
<RoomType type="SIMPLE" code="DBT-E10"characteristic="ST">Double</RoomType>

cod_hab

Characteristic

15

Text

N

N

Characteristic code. Depends on company at CCON. 
The pair Room Type – Characteristic coincides with characteristic at Availability Response: 
<RoomType type="SIMPLE" code="DBT-E10"characteristic="ST">Double</RoomType>

cod_car

Standard capacity

3

Number

N

Y

Standard passengers capacity for the room

nro_paxest

Minimum pax

3

Number

N

Y

This will show the minimum number of persons that are required to book the room

nro_paxmin

Maximum pax

3

Number

N

Y

Maximum passengers capacity for the room

nro_paxmax

Maximum adult

3

Number

N

Y

The maximum number of adults who can stay in the room

nro_adumax

Maximum children

3

Number

N

Y

The maximum number of children that can stay in the room

nro_ninmax

Maximum infants

3

Number

Y

Y

It is the maximum number of babies that can stay in the room

nro_bbsmax

Minimum adults

3

Number

Y

Y

This new field will allow to define the minimum number of adults that must stay in the room to make a booking

nro_adumin

Minimum children

3

Number

Y

Y

The minimum number of children that can stay in the room

 


Example

{CNHA}
DBT:ST:2:2:2:2:0:::
DUS:ST:1:1:1:1:0:::
JSU:ST:2:2:3:3:1:::
SUI:LX-SU:2:2:5:5:2:::
SUI:ST:2:2:5:5:2:::
{/CNHA} 


NOTE: For external suppliers, this section only will appear if [SIAP.Occupancy] is Y, when [SIAP.Occupancy] is N, it is necessary to check the occupancy in SIAP section and do the calculations based on SIAP occupancy.

NOTE: The Null column is divided in 2: I [internal] when [CCON.External inventory] value is false and E [external] when true.



[CNNH] No hotel contracts

Specification

Field

Length

Type

Null

Description

Internal Name

Language

3

Text

N

Language code. Refer to language code list.

cod_idioma

Hotel Description

50

Text

N

Hotel description

des_corta

Example

{CNNH}
ENG:OFFER NO NAME 4 STARS HOTEL SALOU
{/CNNH} 




[CNPR] Promotions

Specification

Field

Length

Type

Null

Description

Internal Name

Code

8

Text

N

Promotion code

cod_promo

Description

 

Text

N

Promotion description

nom_promo

Initial date

8

Date

N

Travel start date

fec_inires

Final date

8

Date

N

Travel end date

fec_finres

Application initial date

8

Date

N

Earliest booking creation date

fec_inicre

Application final date

8

Date

N

Last booking creation date

fec_fincre

Is included

1

Boolean

N

Restriction type 
Y: The travel start date must be between initial and final date 
N: The travel start date can be out of initial and final date. If any day of the stay coincides with some date in the promotion range, it will be applied 

fec_entrada


Example

{CNPR}
2003:Package Hotel + Excursion:20110401:20111031:20110320:20111031:Y
{/CNPR} 




[CNHF] Handling fees

Specification

Field

Length

Type

Null

Order

Description

Internal Name

Initial date

8

Date

N

 

 

fec_desde

Final date

8

Date

N

 

 

fec_hasta

Code

2

Text

N

 

Handling fee code

rgre_cod_recup

Rate

8

Number

Y

1

 

cod_tarifa

Type

1

Enumeration

N

 

G: Percentage of the service R: Amount of the service 
P: Once per pax 
D: Per pax and day

ind_tipo_rec

Amount

 

Number

Y

 

 

imp_reserva

Percentage

 

Number

Y

 

 

pct_reserva

Adult amount

 

Number

Y

 

 

imp_adulto

Child amount

 

Number

Y

 

 

imp_nino

Minimum age

2

Number

Y

 

Minimum age that limits the rule

nro_edad_inicial

Maximum age

2

Number

Y

 

Maximum age that limits the rule

nro_edad_final

Age Amount

 

Number

Y

 

Amount. It could be positive (supplement) and negative (discount)

imp_edad

Is per service

1

Boolean

N

 

Y: Per service 
N: Per booking

ind_tipo_servicio


Example

{CNHF}
20110101:20110131:HF::R:100.0:::::::N
{/CNHF} 




[ATAX] Tax breakdown

Specification

Field

Length

Type

Null

Description

Internal Name

Initial date

8

Date

Y

Travel start date

fec_desde

Final date

8

Date

Y

Travel end date

fec_hasta

Room code

3

Text

Y

 

cod_hab

Board code

2

Text

Y

Board code

cod_regimen

Tax code

8

Text

N

Tax code (See possible types below)

 

Included in price

1

Boolean

N

Y: Included in price 
N: Not included in price

 

Maximum number of nights

 

Number

Y

Contains maximum number of nights to apply this tax

 

Minimum age

 

Number

Y

Contains minimum age to apply this tax

 

Maximum age Number Y Contains maximum age to apply this tax

Is per night

1

Boolean

N

Indicates if the tax is applied per night or per stay:  Y: Applies per night  N: Applies per whole stay

 

Is per pax

1

Boolean

N

Indicates if the tax is applied per pax or per service:  Y: Applies per pax  N: Applies per service

 

Amount

 

Number

Y

Contains the amount of the product

 

Percentage

 

Number

Y

Contains the percentage of the product

 

Currency

3

Text

Y

Currency code for this tax.

sdiv_cod_divisa

Apply over 1 Text Y

Indicates if the tax is applied over net price (when it appears net price, amount and Price) or over amount (only applicable/available when tax is a percentage):

N: Applies over net price

A: Applies over amount
Market code 2 Text Y Origin market (only available for clients that works on several countries). If you only work with one country, you will receive this field empty
Legal Description 10
Text Y Legal Description for Canadian Taxes (only available for Canadian Taxes)

Tax code

Description

T-10-CT

City taxes

F-0-FF

Fees

F-1-RF

Resort Fee

F-10-RF

Convenience Fee

F-20-RF

Amenity Fee

F-30-RF

Boutique Fee

F-40-RF

Connection Fee

F-50-RF

Facilty Fee

F-55-RF

Activity Fee

F-60-RF

Service Charge

F-65-RF

Hospitality Fee

F-70-RF

Energy surcharge

F-75-RF

Cleaning Fee

F-80-RF

Transportation Fee

F-85-RF

Ecologic Fee

F-90-RF

Tips

F-95-RF

Mountain rescue Fee

T-10-ST

State Tax

T-20-ST

Country Tax 1

T-21-ST

Country Tax 2

T-30-ST

City Tax 1

T-31-ST

City Tax 2

T-32-ST

City Tax 3

T-50-ST

Taxes

T-90-ST

Service Fee

T-999-ST

Service Fee I

T-0-TT

Taxes

Example

{ATAX}

20140101:20151231:DUS:BB:T-10-CT:N::::Y:Y:4.5::EUR:N::

{/ATAX}




[CNCL] Valid Markets

Specification

Field

Length

Type

Null

Description

Country code

2

Text

N

Country code valid for this contract

Valid for a country

1

Boolean

N

Indicates if the contract is valid for this country. Y: The market is activated for the client and Cache files are calculated for this market.

N: The market is NOT activated for the client therefore, Cache files have not been calculated for this market but the market is valid for this contract.


Example

{CNCL}
DE:Y
AT:N
CH:N
{/CNCL}