ActiveInventoryII-FilesService-v0.7
description
Transcript of ActiveInventoryII-FilesService-v0.7
-
ActiveInventory II
Files Service Description
DRAFT VERSION
________________________________________________________
Version 0.7
July, 2012
Hotelbeds Accommodation & Destination Services
Cam de Son Fangs, 100 - Torre A, 5 Planta
07007 Palma de Mallorca - Spain
Spain
Copyright 2011 HotelBeds Accommodation & Destination Services
This document contains information that is protected by copyright. All Rights Reserved. No part of this
work may be reproduced or used in any form or by any means graphic, electronic, or mechanical,
including photocopying, recording, taping or information storage and retrieval systems without the
without the prior agreement and written permission of HotelBeds Accommodation & Destination Services.
All copies of this document must include this copyright information
-
2
TABLE OF CONTENTS
1 DOCUMENT CONTROL ................................................................... 5
2 SERVICE OVERVIEW ..................................................................... 7
3 OPERATIONS ................................................................................ 8
3.1 FULL ................................................................................................................. 8
3.2 UPDATE ............................................................................................................. 9
3.3 VERSION CONFIRM .............................................................................................. 10
3.4 ACCESSIBLE ENVIRONMENTS ................................................................................... 11
3.5 HTTP RESPONSE CODES ....................................................................................... 12
3.6 CONNECTION EXAMPLE .......................................................................................... 13
4 WORKFLOWS .............................................................................. 14
4.1 RETRIEVE ALL THE FILES ........................................................................................ 15
4.2 MANAGING ONLY UPDATES ..................................................................................... 16
4.3 ADD OR REMOVE DESTINATIONS ............................................................................... 17
5 FILE SPECIFICATION .................................................................. 18
5.1 [CCON] CONTRACT HEADER .................................................................................. 19
5.2 [CNHA] ROOM TYPES .......................................................................................... 21
5.3 [CNIN] INVENTORY............................................................................................. 22
5.4 [CNCT] PRICES ................................................................................................. 23
5.5 [CNSR] BOARD SUPPLEMENTS AND DISCOUNTS ............................................................ 25
5.6 [CNSU] SUPPLEMENTS AND DISCOUNTS..................................................................... 26
5.7 [CNPV] STOP SALES ........................................................................................... 28
5.8 [CNGR] FREES .................................................................................................. 29
5.9 [CNOE] COMBINABLE OFFERS ................................................................................ 31
5.10 [CNEM] MINIMUM AND MAXIMUM STAY ...................................................................... 32
5.11 [CNTA] RATE CODES ........................................................................................... 33
5.12 [CNES] CHECK IN AND CHECK OUT .......................................................................... 34
5.13 [CNNH] NO HOTEL CONTRACTS .............................................................................. 35
5.14 [CNCF] CANCELLATION FEES.................................................................................. 36
5.15 [CNPR] PROMOTIONS .......................................................................................... 37
5.16 [CNHF] HANDLING FEES ....................................................................................... 38
5.17 [SIAP] SUPPLIERS INTEGRATION AVAILABILITY AND PRICES .............................................. 39
5.18 [SICF] SUPPLIERS INTEGRATION CANCELLATION FEES ..................................................... 40
6 INTERNAL INVENTORY PROCESS ................................................ 41
-
3
6.1 AVAILABILITY APPLICATION RULES ............................................................................ 42
6.2 VALUATION RULES AND PROCESS .............................................................................. 46
6.3 ADDITIONAL INFORMATION ..................................................................................... 75
7 EXTERNAL INVENTORY PROCESS ............................................... 76
8 BEST PRACTICES ........................................................................ 77
8.1 DEVELOPING ..................................................................................................... 77
8.2 CONFIRM THE PROCESS ......................................................................................... 77
8.3 IMPLEMENTING ENUMERATED TYPES ........................................................................... 77
9 FAQ ............................................................................................ 78
9.1 WHAT INFORMATION I GET IN THE FULL REQUEST OPERATION? ........................................... 78
9.2 WHAT INFORMATION I GET IN THE UPDATE REQUEST OPERATION? ....................................... 78
9.3 IF I DID NOT CONFIRM THE VERSION NUMBER, WHAT WILL I GET WITH NEW UPDATE REQUEST? ..... 78
9.4 WHY DO I HAVE TO CONFIRM THE VERSION? ................................................................. 78
9.5 I HAVE REQUESTED AN UPDATE BUT I GOT THE HTTP 204 CODE ......................................... 78
9.6 I HAVE DETECTED A PRICE DIFFERENCE. WHAT IS WRONG? ............................................... 78
9.7 HOW DO I KNOW WHEN THE CONTRACT IS NO LONGER AVAILABLE? ...................................... 79
9.8 I SENT A REQUEST WITH THE X-USERNAME AND X-PASSWORD BUT I GOT 451. WHATS WRONG? . 79
10 CODE LIST AND CONVENTIONS .................................................. 80
10.1 FOLDER STRUCTURE ............................................................................................. 80
10.2 DATE FORMAT .................................................................................................... 80
10.3 AMOUNT FORMAT ................................................................................................ 80
10.4 EXTERNAL SUPPLIERS CODE LIST .............................................................................. 81
10.5 CURRENCY CODE LIST ........................................................................................... 81
10.6 CONTRACT CLASSIFICATION CODE LIST ....................................................................... 81
-
4
FIGURES AND TABLES
FIGURE 1: SERVICE OVERVIEW .............................................................................................. 7
FIGURE 2: CLIENT SOURCE CODE SNIPPET ............................................................................... 13
FIGURE 3: FULL OPERATION WORKFLOW ................................................................................. 15
FIGURE 4: UPDATE OPERATION WORKFLOW .............................................................................. 16
FIGURE 5: NEW FIELD IMPLEMENTATION BEST PRACTICE ............................................................... 77
FIGURE 6: NEW STRUCTURE IMPLEMENTATION BEST PRACTICE ........................................................ 77
TABLE 1: FULL OPERATION PARAMETERS ................................................................................... 8
TABLE 2: UPDATE OPERATION PARAMETERS................................................................................ 9
TABLE 3: CONFIRM OPERATION PARAMETERS ............................................................................ 10
TABLE 4: TEST ENVIRONMENT URLS .................................................................................... 11
TABLE 5: LIVE ENVIRONMENT URLS .................................................................................... 11
TABLE 6: INTERNAL INVENTORY STRUCTURES SUMMARY ............................................................... 41
TABLE 7: BASE PRICE CALCULATION EXAMPLE ........................................................................... 47
TABLE 8: BOARD SUPPLEMENT/DISCOUNT PER AMOUNT ................................................................ 49
TABLE 9: BOARD SUPPLEMENT/DISCOUNT PER PERCENTAGE ........................................................... 49
TABLE 10: CHILD SUPPLEMENT/DISCOUNT VALUATION EXAMPLE ...................................................... 52
TABLE 11: CHILD SUPPLEMENT/DISCOUNT VALUATION EXAMPLE ...................................................... 53
TABLE 12: CHILD SUPPLEMENT/DISCOUNT VALUATION EXAMPLE ...................................................... 54
TABLE 13: ADDITIONAL BED SUPPLEMENT/DISCOUNT VALUATION EXAMPLE ......................................... 57
TABLE 14: ADDITIONAL BED SUPPLEMENT/DISCOUNT VALUATION EXAMPLE ......................................... 58
TABLE 15: OCCUPANCY SUPPLEMENT/DISCOUNT APPLICATION TYPES ................................................ 59
TABLE 16: SUPPLEMENT/DISCOUNT VALUATION EXAMPLE ............................................................. 60
TABLE 17: GENERAL SUPPLEMENT/DISCOUNT TYPES ................................................................... 61
TABLE 18: EARLY BOOKING SUPPLEMENT/DISCOUNT SUMMARY ....................................................... 62
TABLE 19: TURBO EARLY BOOKING SUPPLEMENT/DISCOUNT SUMMARY .............................................. 62
TABLE 20: LAST MINUTE SUPPLEMENT/DISCOUNT SUMMARY .......................................................... 63
TABLE 21: LONG STAY SUPPLEMENT/DISCOUNT SUMMARY ............................................................. 63
TABLE 22: MINIMUM STAY SUPPLEMENT/DISCOUNT SUMMARY ........................................................ 64
TABLE 23: OPERATION DATES SUPPLEMENT/DISCOUNT SUMMARY .................................................... 64
TABLE 24: FIXED STAY SUMMARY ......................................................................................... 64
TABLE 25: ARRIVAL DAY SUPPLEMENT/DISCOUNT SUMMARY .......................................................... 65
TABLE 26: GENERAL SUPPLEMENT/DISCOUNT SUMMARY ............................................................... 65
TABLE 27: GENERAL SUPPLEMENT/DISCOUNT VALUATION EXAMPLE .................................................. 68
TABLE 28: GENERAL SUPPLEMENT/DISCOUNT VALUATION EXAMPLE .................................................. 69
TABLE 29: GENERAL SUPPLEMENT/DISCOUNT VALUATION EXAMPLE .................................................. 69
TABLE 30: GENERAL SUPPLEMENT/DISCOUNT VALUATION EXAMPLE .................................................. 69
TABLE 31: FREES APPLICATION TYPES .................................................................................... 70
TABLE 32: FREES APPLICATION BOARD EXAMPLE ........................................................................ 71
TABLE 33: FREES VALUATION NUMBER OF FREES EXAMPLE ............................................................ 72
TABLE 34: FREES VALUATION DISCOUNT EXAMPLE ...................................................................... 72
TABLE 35: FREES VALUATION DISCOUNT TYPE EXAMPLE ............................................................... 72
TABLE 36: FREES VALUATION BASE TYPE EXAMPLE ...................................................................... 73
TABLE 37: FREE VALUATION BOARD TYPE EXAMPLE ..................................................................... 73
TABLE 38: FREE VALUATION EXAMPLE .................................................................................... 73
TABLE 39: EXTERNAL SUPPLIERS CODE LIST ............................................................................. 81
TABLE 40: CURRENCY CODE LIST ......................................................................................... 81
-
5
1 DOCUMENT CONTROL
Version Release Description
0.1 25/05/2011 First DRAFT documentation
0.2 22/06/2011
Added minimum adults and maximum infants at CNHA
Deleted minimum age in CCON
Deleted [CNOE.Is for a free] column
Deleted [CNHF.Is per service] column
0.3 29/06/2011
Added list of figures and tables
Deleted SHA1 in the response parameters
Added mandatory fields for external and internal inventory at CCON
structure
New FAQ question for the no longer available contracts
New FAQ question for the file name when different formats are
possible in the update workflow
0.4 17/11/2011
Changed the URL for the operations
Added example for the CNEM availability check
Added [CNHF.Is per service] column
Changed description for [CCCON.Selling Price]
Changed description for [CNCT.Price] and [CNCT.Net Price]
Added Promotion Description [CNPR.Description]
Removed [SITA] structure
Added new supplement/discount type F: infant informed at [CNSU]
Added [SIAP.Adults], [SIAP.Children], [SIAP.Number of rooms] fields
to inform the number of adults, children and number of rooms
included in the price.
Added cancellation fee application end date [CNCF.Application end
date]
Added cancellation fee type per stay, and attribute [CNCF.Type]
Added Week Day validation type in Free offers [CNGR.Week day
validation type]
0.5 22/11/2011 Switched the fields order [CNSU.Number of days] and [CNSU.Length
of stay]
0.6 16/12/2011 Changed the values of the [CCON.Packaging] field.
0.7 05/07/2012
Changed the description of the fields Limit date and Days of advance
for supplements: Early Booking, Turbo Early Booking and Last minute
Added new internal field.
-
6
-
7
2 SERVICE OVERVIEW The purpose of Active Inventory II Files Service is to provide access to HotelBeds information
of product, prices and inventory.
The system allows you to get the HotelBeds Databank information and you are able to:
Look up all our updated prices and inventory information at any time
Create dynamic packaging content
Create accurate offerings
Show an instant pre-calculated availability in your website
Supply your inventory cache
Figure 1: Service overview
The Active Inventory II Files Service exports all the information in a single comma separated
files, with the structure defined in at File Specification chapter.
You can access to this .zip file with HTTP GET requests to a defined REST resources. This way
you are able to request whenever you want.
The Active Inventory II Files service is updated hourly, generating the new files or updating
the files according to Hotelbeds data bank updates.
Users can send HTTP Get requests at any time; however, new files will be delivered once
generated by the system.
Configuration parameters:
Credentials and valid IP
External chains Available
Destination List
Hotels Included and Excluded
Classification Codes
-
8
3 OPERATIONS The client uses HTTP GET requests in order to get the archived files.
When calling the service, in order to be able to download the files, the client must supply the
username and password in the request header.
3.1 Full This resource allows you to get a .zip file with all the information from our Databank.
You must send the user credentials as parameters inside the HTTP request headers.
http://aif2.interface-xml.com/aif2-pub-ws/files/full
The response message will contain:
HTTP Status Code
.zip file with information
unique version number of the files provided informed as VERSION parameter in the HTTP response header
HTTP Headers
Operation Parameter Type Description
HTTP Request X-Username Mandatory User credential X-Password Mandatory Password credential
HTTP Response X-Version Mandatory Unique version number of the files Table 1: Full operation parameters
It is the clients responsibility to select the location of the download.
-
9
3.2 Update This resource allows you to get a .zip file with all the information from our Databank.
You must send the user credentials as parameters inside the HTTP request headers.
http://aif2.interface-xml.com/aif2-pub-ws/files/update
The response message will contain:
HTTP Status Code
.zip file with updated information since the last version you have confirmed if exists
unique version number of the files provided informed as VERSION parameter in the HTTP response header
HTTP Headers
Operation Parameter Type Description
HTTP Request X-Username Mandatory User credential X-Password Mandatory Password credential
HTTP Response X-Version Mandatory Unique version number of the files Table 2: Update operation parameters
It is the clients responsibility to select the location of the download.
If there are no changes in our Databank since your last access, then the HTTP Status Code 204
No Content will be returned without .zip file.
-
10
3.3 Version confirm This resource allows you to confirm the unique version number of the files which has been
successfully processed by your system.
You must send the user credentials as parameters inside the HTTP request headers.
http://aif2.interface-xml.com/aif2-pub-ws/files/confirm
HTTP Headers
Operation Parameter Type Description
HTTP Request
X-Username Mandatory User credential X-Password Mandatory Password credential X-Version Mandatory Unique version number to confirm success process
Table 3: Confirm operation parameters
It is the clients responsibility to confirm the successfully processed version.
-
11
3.4 Accessible environments
The Active Inventory II Files Service can be used with two different environments: TEST and
LIVE.
The TEST environment is connected to the same TEST environment used in the XML Interface
Specification. This way you will be able to test both systems with the same data base source.
On the other hand, with the LIVE environment you will get all the real information from
HotelBeds Databank.
Due to IP restriction control, please provide your XML Support Agent the IP/IPs from which
you are planning to run the Files Service. HotelBeds will grant you the access to our systems.
The user and password HTTP request parameters must be settled with the values provided by
your XML Support Agent.
Here you have summary tables with the resources corresponding to available operations and
environment:
Operation TEST environment
Full http://testaif2.interface-xml.com/aif2-pub-ws/files/full
Update http://testaif2.interface-xml.com/aif2-pub-ws/files/upate
Confirm version http://testaif2.interface-xml.com/aif2-pub-ws/files/confirm
Table 4: TEST environment URLs
Operation LIVE environment
Full http://aif2.interface-xml.com/aif2-pub-ws/files/full
Update http://aif2.interface-xml.com/aif2-pub-ws/files/update
Confirm version http://aif2.interface-xml.com/aif2-pub-ws/files/confirm
Table 5: LIVE environment URLs
-
12
3.5 HTTP Response codes The service will return the error codes returned by the HTTP GET and some additional codes.
The status codes returned by the service are presented below:
3.5.1 2XX Success
200 Ok A 200 error code means that the request was successful. The response will contain an entity
corresponding to the requested resource.
204 No content A 204 error code means that the update request was successful but there is no updated
information in our data base since your last access. The process is correct and you can send
again the same request.
3.5.2 4XX Client Error
The request contains bad syntax or cannot be fulfilled. An error message will be transmitted to
the client to explain to him the error situation.
400 Bad Request The request contains bad syntax or request parameters are not informed.
404 Not Found The requested resource can not be found but Subsequent requests by the client are
permissible.
408 Request Timeout The server timed out waiting for the request.
450 Authentication needed You need to introduce username and password as HTTP request headers.
451 Not authorized Your credentials (username and password) do not authorize you to use the service.
3.5.3 5XX Server Error
500 Internal server error A generic error message, given when no more specific message is suitable
-
13
3.6 Connection example Here you have a Java source code snippet example showing how to access the service for the
3 operations.
// EXAMPLE 1. Access to FULL resource HttpClient client = new HttpClient(); GetMethod method = new GetMethod("http://aif2.interface-xml.com/aif2-pub-ws/files/full"); method.addRequestHeader("X-Username","myUserCredential"); method.addRequestHeader("X-Password","myPassCredential");
// Execute the HTTP GET request int status = client.executeMethod(method);
if (status == 200){ // Get the file as InputStream
InputStream in = method.getResponseBodyAsStream(); // Your process...
}
-----------------------------------------------------------------------------------
// EXAMPLE 2. Access to CONFIRM resource HttpClient client = new HttpClient(); GetMethod method = new GetMethod("http://aif2.interface-xml.com/aif2-pub-ws/files/confirm"); method.addRequestHeader("X-Username","myUserCredential"); method.addRequestHeader("X-Password","myPassCredential"); method.addRequestHeader("X-Version","versionToConfirm");
// Execute the HTTP GET request int status = client.executeMethod(method);
if (status == 200){ // Get the file as InputStream
InputStream in = method.getResponseBodyAsStream(); // Your process...
}
-----------------------------------------------------------------------------------
// EXAMPLE 3. Access to UPDATE resource HttpClient client = new HttpClient(); GetMethod method = new GetMethod("http://aif2.interface-xml.com/aif2-pub-ws/files/update"); method.addRequestHeader("X-Username","myUserCredential"); method.addRequestHeader("X-Password","myPassCredential");
// Execute the HTTP GET request int status = client.executeMethod(method);
if (status == 200){ // Get the file as InputStream
InputStream in = method.getResponseBodyAsStream(); // Your process...
} Figure 2: Client source code snippet
-
14
4 WORKFLOWS The Active Inventory II Files Service has two different possibilities to get all the information
and manage the updates.
The first one consists in always retrieving all the files HotelBeds has for you. In this scenario,
the update process is quite simple, remove all your data and overwrite with the newly
generated files.
Advantages:
Simply update workflow
Only one operation implementation
Easy to restore the data after error in process
Disadvantages:
Higher size for the downloads
Process of all the files, even if there is no changes
On the other hand, you can retrieve all the files the first time you use the service and after
that, manage only the updated information with update requests.
Advantages:
Only process the changed files
Lower size for the downloads
Disadvantages:
More complex workflow
Three operations implementation
-
15
4.1 Retrieve all the files
Figure 3: Full operation workflow
This workflow process starts with the FULL request operation from your system to the web
service. The credentials are sent inside the HTTP headers.
The HTTP response contains a .zip file with all the files we have generated according to your
product set up.
After that you have to unzip the .zip file and process all the single files corresponding to our
contract information.
In order to get the updated information, then you have to start again the process, but
overwriting the data you have processed with the newly files.
At this point you can implement a compare process to detect the changes or simply remove
and create again the data into your system.
-
16
4.2 Managing only updates
Figure 4: Update operation workflow
-
17
This workflow process starts with the FULL request operation from your system to the web
service. The credentials are sent inside the HTTP headers.
The HTTP response contains a .zip file with all the files we have generated according to your
product set up and the unique version number of the files.
After that you have to unzip the .zip file and process all the single files corresponding to our
contract information.
Once you have processed the information, you have to confirm to our service the current
version of the files you have successfully managed, and provided in our response. This can be
done with the Confirm Version operation, just by sending an HTTP request to that REST
resource.
With this confirmation, our system fixes the current version successfully managed by your
system.
Whenever you want updated information, you only have to send the HTTP request for the
Update REST resource. Our system will provide you a .zip file with the information which has
been modified since the last version you have confirmed in the previous step. Each new
version will be composed of set of files, a unique file per contract. At update requests, each
update will produce a unique set of files.
After the process of the updated files, remember to start again the confirmation version
process.
4.3 Add or remove destinations In order to add or remove destinations, please contact your XML Support Agent.
-
18
5 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 new line.
Example: Here you can see the structure STX1 with 2 records and 3 fields per record.
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:
General information
o [CCON] CONTRACT HEADER
HotelBeds internal
o [CNHA] ROOM TYPES
o [CNIN] INVENTORY
o [CNCT] PRICES
o [CNSR] BOARD SUPPLEMENTS AND DISCOUNTS
o [CNSU] SUPPLEMENTS AND DISCOUNTS
o [CNPV] STOP SALES
o [CNGR] FREES
o [CNOE] COMBINABLE OFFERS
o [CNEM] MINIMUM AND MAXIMUM STAY
o [CNTA] RATE CODES
o [CNES] CHECK IN AND CHECK OUT
o [CNNH] NO HOTEL CONTRACTS
o [CNCF] CANCELLATION FEES
o [CNPR] PROMOTIONS
o [CNHF] HANDLING FEES
Suppliers Inventory
o [SIAP] SUPPLIERS INTEGRATION AVAILABILITY AND PRICES
o [SICF] SUPPLIERS INTEGRATION CANCELLATION FEES
{STX1} FIELD1:FIELD2:FIELD3 FIELD1:FIELD2:FIELD3 {/STX1}
-
Active Inventory II Files Service Description
19
5.1 [CCON] Contract header
5.1.1 Specification
Field Length Type Null
Order 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. Null when External Inventory is set to true
seq_contr
Contract name 15 Text N N Contract name is used in the XML ServiceAddRQ to valuate the booking nom_contrato
Company code 3 Text N N 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 Y ghor_seq_hotel GIATA Hotel code 15 Number N 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 Y 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. P: Direct Payment model. Gross price. In the sales process the end client pays the amount at Hotel.
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 Release days values are taken for release for first day of booking. Y: Check release date only for the first night of the stay N: Check release date for each night of the stay
ind_release_estancia
-
Active Inventory II Files Service Description
20
Field Length Type Null
Order Description Internal Name E I
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. H: This contract can be sold only as hotel 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 N 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 1 Boolean N N Y: Internal data N: Internal data
NOTE: The Null column is divided in 2: I [internal] when [CNCT.External inventory] value is false and E [external] when true.
5.1.2 Example
{CCON} N:PMI:1:56548:CG-TODOS:E10:H:4304::20110101:20111231:N:EUR:::M:N:N:0:12::N:U:5::N:N {/CCON}
-
Active Inventory II Files Service Description
21
5.2 [CNHA] Room Types
5.2.1 Specification
Field Length Type Null Order Description Internal Name
Room type 3 Text N
Room Type code. Depends on Company code at CCON Pair Room Type Company code coincides with Room Type Code at Availability Response: Double
cod_hab
Characteristic 15 Text N
Characteristic code. Depends on company at CCON. The pair Room Type Characteristic coincides with characteristic at Availability Response: Double
cod_car
Standard capacity 3 Number N Standard passengers capacity for the room nro_paxest
Minimum pax 3 Number N This will show the minimum number of persons that are required to book the room
nro_paxmin
Maximum pax 3 Number N Maximum passengers capacity for the room nro_paxmax Maximum adult 3 Number N The maximum number of adults who can stay in the room nro_adumax
Maximum child 3 Number N The maximum number of children that can stay in the room nro_ninmax Maximum infants 3 Number Y It is the maximum number of babies that can stay in the room nro_bbsmax
Minimum adults 3 Number 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
5.2.2 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}
-
Active Inventory II Files Service Description
22
5.3 [CNIN] Inventory
5.3.1 Specification
Field Length Type Null Order Description Internal Name
Initial date 8 Date N Travel start date fec_desde Final date 8 Date N Travel end date fec_hasta
Room type 3 Text N
The combination of the Room Type, Room Characteristic is the room code in the XML. However certain offers and supplement can be applied to specific Room Type and/or Room Characteristic. File will contain multiple room types. No limit on the number of room types
cod_hab
Characteristic 15 Text N cod_car Rate 8 Number Y Rate code Release 4 Number N Release days. 0 is day of departure (i.e. no release date) nro_release
Allotment 2 Number N Remaining allotment from 0 to 10. 10 will indicate the number of rooms available is equal or greater than 10
nro_disponible
5.3.2 Example
A contract with CCON.Fix rate value true. The Rate field is always informed and shows the specific release/allotment per day from 20110501 to
20110508.
More than one record is possible for every combination of room type and characteristic. One record per rate.
A contract with CCON.Fix rate value false. The Rate field is always null and you can see the release/allotment for DBT-ST and DBT-HD rooms
per day from 20110501 to 20110508.
Only one record is possible for every combination of room type and characteristic.
{CNIN} 20110501:20110508:DBT:ST:1:(0,8)(0,10)(0,10)(0,10)(0,10)(0,10)(0,9)(0,10) 20110501:20110508:DBT:ST:2:(0,6)(0,10)(0,10)(0,10)(0,10)(0,10)(0,10)(0,9) {/CNIN}
{CNIN} 20110501:20110508:DBT:ST::(0,10)(0,8)(0,10)(0,10)(0,10)(0,10)(0,10)(0,10) 20110501:20110508:DBT:HD::(0,10)(0,10)(0,10)(0,8)(0,10)(0,10)(0,10)(0,10) {/CNIN}
-
Active Inventory II Files Service Description
23
5.4 [CNCT] Prices
5.4.1 Specification
Field Length Type Null Order Description Internal Name
Initial date 8 Date N Travel start date fec_desde Final date 8 Date N Travel end date fec_hasta
Room type 3 Text N
The combination of the Room Type, Room Characteristic is the room code in the XML. However certain prices filters can be applied by Room Type and or Room Characteristic. File will contain multiple room types. No limit on the number of room types
cod_hab
Characteristic 15 Text N cod_car Generic Rate 8 Number Y Rate code
Is price per pax 1 Boolean N Applies per pax or per service: Y: Price per passenger N: Price per room
ind_paxser
Net price Number Y Contains net sale amount for the product
Price ? Number Y Contains the final price for this product when sold to public When [CCON.Selling price] value is true indicates this price is mandatory
Specific Rate 8 Number Y Rate code Base board 2 Text Y Default base board code
-
Active Inventory II Files Service Description
24
5.4.2 Example
A contract with CCON.Fix rate value true. The generic rate field is always informed and shows the price information per day from 20110501 to
20110508. Note that the specific rate is null.
More than one record is possible for every combination of room type and characteristic. One record per rate.
A contract with CCON.Fix rate value false. The generic rate field is always null and you can see the price information for DBT-ST per day from
20110501 to 20110508. Note that the rate information is informed in the specific rate field in each day.
Only one record is possible for every combination of room type and characteristic.
{CNCT} 20110501:20110508:DBT:ST:1:(,,50,,RO)(,,45,,RO)(,,50,,RO)(,,75,,RO)(,,75,,RO)(,,150,,RO)(,,50,,RO)(,,50,,RO) 20110501:20110508:DBT:ST:2:(,,50,,RO)(,,45,,RO)(,,50,,RO)(,,75,,RO)(,,75,,RO)(,,150,,RO)(,,50,,RO)(,,50,,RO) {/CNCT}
{CNCT} 20110501:20110508:DBT:ST::(,,50,1,RO)(,,45,2,RO)(,,50,1,RO)(,,75,1,RO)(,,75,2,RO)(,,150,2,RO)(,,50,1,RO)(,,50,1,RO) {/CNCT}
-
Active Inventory II Files Service Description
25
5.5 [CNSR] Board supplements and discounts
5.5.1 Specification
Field Length Type Null Order Description Internal Name
Initial date 8 Date N Travel start date fec_desde Final date 8 Date N Travel end date fec_hasta Board code 2 Text N Board code cod_regimen
Is per pax 1 Boolean N Applies per pax or per service: Y: Per person N: Per room
ind_paxser
Amount Number Y Amount. It could be positive (supplement) and negative (discount) imp_suplem
Percentage Number Y Percentage. It could be positive (supplement) and negative (discount)
pct_suplem
Rate 8 Number Y 1 cod_tarifa Room type 3 Text Y 2 cod_hab Characteristic 15 Text Y 3 cod_car Minimum age 2 Number Y Minimum age that limits the rule nro_edaini Maximum age 2 Number Y Maximum age that limits the rule nro_edafin
On Monday 1 Boolean N True if supplement on Monday. False if not. ind_lun On Tuesday 1 Boolean N True if supplement on Tuesday. False if not. ind_mar On Wednesday 1 Boolean N True if supplement on Wednesday. False if not. ind_mie On Thursday 1 Boolean N True if supplement on Thursday. False if not. ind_jue On Friday 1 Boolean N True if supplement on Friday. False if not. ind_vie
On Saturday 1 Boolean N True if supplement on Saturday. False if not. ind_sab On Sunday 1 Boolean N True if supplement on Sunday. False if not. ind_dom Board supplement price application percentage
Number N Refer to Board supplements and discounts valuation process pct_coste
5.5.2 Example
{CNSR} 20110101:20111231:BB:Y:24.5:::::::Y:Y:Y:Y:Y:Y:Y:0 {/CNSR}
-
Active Inventory II Files Service Description
26
5.6 [CNSU] Supplements and discounts
5.6.1 Specification
Field Length Type Null Order Description Internal Name
Initial date 8 Date N fec_desde Final date 8 Date N fec_hasta
Application initial date 8 Date N Earliest booking creation date fec_aplini Application final date 8 Date Y Last booking creation date fec_aplfin Supplement or discount code 3 Text N Supplement or discount code cod_suplem
Type 1 Enumeration N
N: Child discount F: Infant C: Additional/Extra Bed I: Double for individual use L: Long stay B: Early booking E: Fixed stay M: Minimum stay O: Operation days G: General K: Turbo early booking V: Apply supplement based on arrival date times number of nights if arrival date is in the Travel Start / End date period U: Last minute
tipo_suplemento
Is per pax 1 Boolean N Applies per pax or per service: Y: Per person N: Per room
ind_paxser
Opaque 1 Boolean N If true, only applies for packaging ind_opaque
Order 8 Number Y Order in which supplements must be applied. From lowest to highest.
orden
Application type 1 Enumeration N
B: On base board R: On board supplement N: Per night, base board plus supplement A: Absolute amount T: Only once. Check in date must be within the travel start and end date. Apply once to check in date. U: Only once type if any date of the booking overlaps with the period. The day to apply the offer is the first one that overlaps.
ind_tipapl
Amount Number Y Amount. It could be positive (supplement) and negative (discount) imp_suplem
Percentage Number Y Percentage. It could be positive (supplement) and negative (discount)
pct_suplem
Is cumulative 1 Boolean N True if cumulative and applies to rest of supplements applied before ind_acumula
-
Active Inventory II Files Service Description
27
Field Length Type Null Order Description Internal Name
Rate 8 Number Y 1 cod_tarifa Room type 3 Text Y 2 cod_hab Characteristic 15 Text Y 3 cod_car Board 3 Text Y 4 cod_regim Adults 3 Number Y Minimum adults to apply the rule nro_adultos
Pax order 3 Number Y Indicates adult to which the rule applies N and C
nro_orden
Minimum age 2 Number Y Minimum age that limits the rule nro_edaini Maximum age 2 Number Y Maximum age that limits the rule nro_edafin Number of days 3 Number Y Refer to valuation process nro_dias Length of stay 3 Number Y Number of days for the stay nro_dias_estancia
Limit date 8 Date Y Refer to valuation process fec_limite On Monday 1 Boolean N True if supplement on Monday. False if not. ind_lun On Tuesday 1 Boolean N True if supplement on Tuesday. False if not. ind_mar On Wednesday 1 Boolean N True if supplement on Wednesday. False if not. ind_mie On Thursday 1 Boolean N True if supplement on Thursday. False if not. ind_jue On Friday 1 Boolean N True if supplement on Friday. False if not. ind_vie
On Saturday 1 Boolean N True if supplement on Saturday. False if not. ind_sab On Sunday 1 Boolean N True if supplement on Sunday. False if not. ind_dom
5.6.2 Example
{CNSU} 20110101:20111231:20100915::DN:N:Y:N:-30:N::-100:N::JSU:ST::2:1:0:12::::Y:Y:Y:Y:Y:Y:Y 20110101:20111231:20100915::DN:N:Y:N:-30:N::-100:N::SUI:ST::2:1:0:12::::Y:Y:Y:Y:Y:Y:Y 20110101:20111231:20100915::DN:N:Y:N:-30:N::-100:N::SUI:LX-SU::2:1:0:12::::Y:Y:Y:Y:Y:Y:Y 20110101:20111231:20100915::DN:N:Y:N:-30:N::-100:N::SUI:ST::2:2:0:12::::Y:Y:Y:Y:Y:Y:Y 20110101:20111231:20100915::DN:N:Y:N:-30:N::-100:N::SUI:LX-SU::2:2:0:12::::Y:Y:Y:Y:Y:Y:Y 20110101:20111231:20100915::CA:C:Y:N:-20:A:134.5:N:::::BB::3:13:99::::Y:Y:Y:Y:Y:Y:Y 20110101:20111231:20100915::CA:C:Y:N:-20:A:110::N::::RO::3:13:99::::Y:Y:Y:Y:Y:Y:Y 20110101:20111231:20100915::CA:C:Y:N:-20:A:110::N::::RO::4:13:99::::Y:Y:Y:Y:Y:Y:Y 20110101:20111231:20100915::CA:C:Y:N:-20:A:134.5::N::::BB::4:13:99::::Y:Y:Y:Y:Y:Y:Y 20110101:20111231:20100915::CA:C:Y:N:-20:A:110::N::::RO::5:13:99::::Y:Y:Y:Y:Y:Y:Y 20110101:20111231:20100915::CA:C:Y:N:-20:A:134.5::N::::BB::5:13:99::::Y:Y:Y:Y:Y:Y:Y 20110101:20111231:20100915::EB:B:S:N:0:N::-10:N:::::::::30:::Y:Y:Y:Y:Y:Y:Y {/CNSU}
-
Active Inventory II Files Service Description
28
5.7 [CNPV] Stop sales
5.7.1 Specification
Field Length Type Null Order Description Internal Name
Initial date 8 Date N Initial date for the stop sales fec_desde Final date 8 Date N End date for the stop sales fec_hasta
Rate 8 Number Y 1 cod_tarifa Room type 3 Text Y 2 cod_hab Characteristic 15 Text Y 3 cod_car Board 3 Text Y 4 cod_regim
5.7.2 Example
A stop of sales from 05th May to 07th May for the DBT-ST room.
A stop of sales from 01st June to 15th June for all the bookings with rate code 1
{CNPV} 20110505:20110507::DBT:ST: 20110601:20110615:1::: {/CNPV}
-
Active Inventory II Files Service Description
29
5.8 [CNGR] Frees
5.8.1 Specification
Field Length Type Null Order Description Internal Name
Initial date 8 Date N fec_desde Final date 8 Date N fec_hasta
Application initial date 8 Date N Earliest booking creation date fec_aplini Application final date 8 Date Y Last booking creation date fec_aplfin Minimum days 1 Number N Minimum days for the booking nro_ini Maximum days 1 Number N Maximum days for the booking nro_fin Rate 8 Number Y cod_tarifa
Room type 3 Text Y cod_hab Characteristic 15 Text Y cod_car Board 3 Text Y cod_regim Frees 3 Number Y Number of free nights nro_gratis Free code 3 Text Y Free code. It is used in conjunction with the data held in the CNOE cod_grat
Discount 8 Number Y Percentage amount of discount pct_descuento
Application base type 1 Enumeration N
B: Applies to the base price [without supplement and discounts CNSU] D: Applies to the base price with base supplements and discounts [CNSU.Type = N, C or I] T: Applies to the total price
ind_base
Application board type 1 Enumeration N B: Applies to the base price [without board supplements and discounts CNSR] R: Applies to the price with board supplements and discounts
ind_regimen
Application discount type 1 Enumeration N
Which night the free offer applies B: Cheapest night C: Most expensive night M: Average night P: First night U: Last night
ind_tipapl
Application stay type 1 Enumeration N
E: Check in date must be in travel date period S: Check in date and check out date minus 1 must be in the travel date period P: Only applies if no E or S has been applied. The check in and check out (minus 1) dates must overlap with the travel date period. The number of nights stay is taken from the overlap period and validated against the min/max duration. Multiple P offers can be applied. However max of 1 offer for each night P only applies if no E or S offers have been applied
ind_entest
-
Active Inventory II Files Service Description
30
Field Length Type Null Order Description Internal Name
On Monday 1 Boolean N True if applies on Monday. False if not. ind_lun On Tuesday 1 Boolean N True if applies on Tuesday. False if not. ind_mar On Wednesday 1 Boolean N True if applies on Wednesday. False if not. ind_mie On Thursday 1 Boolean N True if applies on Thursday. False if not. ind_jue On Friday 1 Boolean N True if applies on Friday. False if not. ind_vie
On Saturday 1 Boolean N True if applies on Saturday. False if not. ind_sab On Sunday 1 Boolean N True if applies on Sunday. False if not. ind_dom
Week Day validation type 1 Enumeration N E: Check in date must be valid for the week day S: The travel stay overlaps with at least one valid week day
ind_DiasemEntest
5.8.2 Example
{CNGR} 20110101:20111231:::5:999:::::1:::D:R:B:S:N:N:N:N:N:N:N:E {/CNGR}
-
Active Inventory II Files Service Description
31
5.9 [CNOE] Combinable offers
5.9.1 Specification
Field Length Type Null Order Description Internal Name
Code1 3 Text N Free or supplement/discount code cod_splgra Code2 3 Text N Free or supplement/discount code cod_splgra_ex
Is excluded 1 Boolean N Y: If Code1 applies then Code2 is excluded N: If Code1 applies then Code2 is also mandatory required
ind_excluido
5.9.2 Example
The EB supplement/discount is excluded when the ARD free applies.
{CNOE} ARD:EB:Y {/CNOE}
-
Active Inventory II Files Service Description
32
5.10 [CNEM] Minimum and maximum stay
5.10.1 Specification
Field Length Type Null Order Description Internal Name
Application date 8 Date Y Earliest booking creation date where the minimum stay applies. If null the rule always applies.
fec_aplicacion
Initial date 8 Date N Travel starts date fec_desde
Final date 8 Date N Travel end date fec_hasta
Type 1 Enumeration N
Rule types: T: Check in date if between the travels date period. Check min/max stay on check in date E: Check in and check out dates minus 1 is between the travels date period. Check min/max stay on check in date
ind_tipo
Rate 8 Number Y 1 cod_tarifa Room type 3 Text Y 2 cod_hab Characteristic 15 Text Y 3 cod_car
Board 3 Text Y 4 Minimum days 3 Number N Minimum days for the stay duration nro_dias_min Maximum days 3 Number N Maximum days for the stay duration nro_dias_max On Monday 1 Boolean N True if check in required on Monday. False if not. ind_lun On Tuesday 1 Boolean N True if check in required on Tuesday. False if not. ind_mar
On Wednesday 1 Boolean N True if check in required on Wednesday. False if not. ind_mie On Thursday 1 Boolean N True if check in required on Thursday. False if not. ind_jue On Friday 1 Boolean N True if check in required on Friday. False if not. ind_vie On Saturday 1 Boolean N True if check in required on Saturday. False if not. ind_sab On Sunday 1 Boolean N True if check in required on Sunday. False if not. ind_dom
5.10.2 Example
From 1st July to 30th September minimum of 7 length of stay days required. 3 days the rest of the periods.
{CNEM} :20110425:20110630:T:::::3:999:Y:Y:Y:Y:Y:Y:Y :20110701:20110930:T:::::7:999:Y:Y:Y:Y:Y:Y:Y :20111001:20111031:T:::::3:999:Y:Y:Y:Y:Y:Y:Y {/CNEM}
-
Active Inventory II Files Service Description
33
5.11 [CNTA] Rate codes
5.11.1 Specification
Field Length Type Null Order Description Internal Name
Rate 8 Number N Rate code cod_tarifa Description 5 Text N Rate name cor_tarifa
Order 3 Number N Rate order for cancellation policy nro_orden
5.11.2 Example
Different rate codes and descriptions.
{CNTA} 3:FIT: 0:NRATE: {/CNTA}
-
Active Inventory II Files Service Description
34
5.12 [CNES] Check in and check out
5.12.1 Specification
Field Length Type Null Order Description Internal Name
Application date 8 Date Y Application start date fec_aplicacion Initial date 8 Date N Travel starts date fec_desde
Final date 8 Date N Travel end date fec_hasta
Type 1 Enumeration N Restriction type I: Check in O: Check out
ind_tipo
Room type 3 Text Y cod_hab Characteristic 15 Text Y cod_car Rate 8 Number Y Rate code cod_tarifa
On Monday 1 Boolean N True if the rule applies. False if not ind_lun On Tuesday 1 Boolean N True if the rule applies. False if not ind_mar On Wednesday 1 Boolean N True if the rule applies. False if not ind_mie On Thursday 1 Boolean N True if the rule applies. False if not ind_jue On Friday 1 Boolean N True if the rule applies. False if not ind_vie
On Saturday 1 Boolean N True if the rule applies. False if not ind_sab On Sunday 1 Boolean N True if the rule applies. False if not ind_dom
5.12.2 Example
From 1st July to 30th September only Saturday and Sunday check in allowed.
{CNES} :20110425:20110630:I::::Y:Y:Y:Y:Y:Y:Y :20110701:20110930:I::::N:N:N:N:N:Y:Y :20111001:20111031:I::::Y:Y:Y:Y:Y:Y:Y {/CNES}
-
Active Inventory II Files Service Description
35
5.13 [CNNH] No hotel contracts
5.13.1 Specification
Field Length Type Null Order 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
5.13.2 Example
{CNNH} ENG:OFFER NO NAME 4 STARS HOTEL SALOU {/CNNH}
-
Active Inventory II Files Service Description
36
5.14 [CNCF] Cancellation fees
5.14.1 Specification
Field Length Type Null Order Description Internal Name
Application date 8 Date Y Cancellation fee application date fec_aplicacion Initial date 8 Date N Travel starts date fec_desde
Final date 8 Date N Travel end date fec_hasta Rate 8 Number Y Rate code cod_tarifa
Days Number Y Days before the booking client check in where the cancellation fee applies
nro_dias
Hours Number Y Hours before the client check in where the cancellation fee applies. Hour is considered local time at hotel.
nro_hora
Amount first night Number N Total amount of the cancellation fee for the first night imp_gasto_1
Percentage first night Number N Percentage of the cancellation fee for the first night pct_gasto_1 Amount per night Number N Total amount of the cancellation fee per night of the stay imp_gasto_noc Percentage per night Number N Percentage of the cancellation fee per night of the stay pct_gasto_noc Application end date 8 Date Y Cancellation fee application end date
Type Enumeration N Cancellation type: EN: Per check in ES: Per stay
ind_tipgas
5.14.2 Example
A 100% of first night cancellation fees from 1st May to 05th May, 5 days before travel start.
{CNCF} :20111110:20111231::3:0:0.0:0.0:0.0:100.0:EN {/CNCF}
-
Active Inventory II Files Service Description
37
5.15 [CNPR] Promotions
5.15.1 Specification
Field Length Type Null Order 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 must be out of initial and final date
fec_entrada
5.15.2 Example
{CNPR} 2003:Package Hotel + Excursion:20110401:20111031:20110320:20111031:Y {/CNPR}
-
Active Inventory II Files Service Description
38
5.16 [CNHF] Handling fees
5.16.1 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
5.16.2 Example
{CNHF} 20110101:20110131:HF::R:100.0:::::::N {/CNHF}
-
Active Inventory II Files Service Description
39
5.17 [SIAP] Suppliers integration availability and prices
5.17.1 Specification
Field Length Type Null Order Description
Initial date 8 Date N Travel start date End date 8 Date N Travel end date
Room type 3 Text N Characteristic 15 Text N Board type 2 Text N Length of stay (LOS) Number N Adults 2 Number N Number of adults
Children 2 Number N Number of children Number of rooms 2 Number N Number of rooms included in the price. NOT related to free allotment Net price Number Y Price Number Y
5.17.2 Example
This examples informs about the availability and prices for DBL-ST room with RO board for 1 room of 2 adults:
Price from 1st June to 2nd June, from 2nd to 3rd, from 3rd to 4th and from 4th to 5th.
Price from 1st June to 3rd, from 2nd to 4th and from 3rd to 5th of June.
Price from 1st June to 5th.
{SIAP} 20110601:20110605:DBL:ST:RO:1:2:0:1:(100.0,100.0)(100.0,100.0)(100.0,100.0)(100.0,100.0) 20110601:20110605:DBL:ST:RO:2:2:0:1:(100.0,100.0)(100.0,100.0)(100.0,100.0) 20110601:20110605:DBL:ST:RO:5:2:0:1:(100.0,100.0) {/SIAP}
-
Active Inventory II Files Service Description
40
5.18 [SICF] Suppliers integration cancellation fees
5.18.1 Specification
Field Length Type Null Order Description
Initial date 8 Date N Application start date End date 8 Date N Application end date Days Number Y Days before the client check in where the cancellation fee applies
Hours Number Y Hours before the client check in where the cancellation fee applies. Local hotel time is considered here.
Charge type 1 Enumeration N 1: First night E: Stay
Amount Number Y Percentage Number Y
5.18.2 Example
{SICF} 20110601:20110605:1::E::100 {/SICF}
-
Active Inventory II Files Service Description
41
6 INTERNAL INVENTORY PROCESS The structures previously defined can be grouped into three different types according to their
usefulness:
Availability These structures provide information to evaluate if the booking is bookable in the requested
dates. The main information in this group is inventory, stop of sales, minimum and maximum
stay restrictions, etc
Valuation These structures provide rules to determine the final price of the service to be booked. Prices,
supplements, discounts, frees, etc
Additional information These structures provide additional information needed to complete the booking process or
show relevant information to the final customer. For example, promotions, cancellation fees,
etc
The main process is divided in three steps:
1. Check the contracts at CCON
a. List the available rooms at CNHA
b. List the available boards at CNSR
2. Check the availability of the contracts
3. Valuate and obtain the price
4. Complete the information
Structure Availability Valuation Additional
Info
[CCON] CONTRACT HEADER
[CNHA] ROOM TYPES
[CNIN] INVENTORY
[CNCT] PRICES
[CNSR] BOARD SUPPLEMENTS AND DISCOUNTS
[CNPV] STOP SALES
[CNSU] SUPPLEMENTS AND DISCOUNTS
[CNGR] FREES
[CNOE] COMBINABLE OFFERS
[CNEM] MINIMUM AND MAXIMUM STAY
[CNTA] RATE CODES
[CNES] CHECK IN AND CHECK OUT
[CNNH] NO HOTEL CONTRACTS
[CNCF] CANCELLATION FEES
[CNPR] PROMOTIONS
[CNHF] HANDLING FEES
Table 6: Internal inventory structures summary
-
Active Inventory II Files Service Description
42
6.1 Availability application rules These rules determine the available product of the contract. The availability requires a travel
start and travel end dates.
6.1.1 [CNHA] Rooms
The structure CNHA inform about the available rooms. A single room is defined by code
[CNHA.Room type] and characteristic [CNHA.Characteristic]. Every room has a number of
passenger restrictions. The minimum and maximum paxes [CNHA.Minimum pax] and
[CNHA.Maximum pax], the maximum adults [CNHA.Maximum adults] and children
[CNHA.Maximum child].
The number of adults needs to be greater or equal than [CNHA.Minimum adults] and the
number of infants lower or equal than [CNHA.Maximum infants].
The standard capacity [CNHA.Standard capacity] is needed in the valuation process.
6.1.2 [CNIN] Inventory
The inventory inform about the available dates, allotment free and release days.
The header of the structure informs two dates, the start and end date where the inventory is
informed [CNIN.Initial date] and [CNIN.Final date].
For every room defined in the contract you will see the inventory information in a different
section.
6.1.3 [CNSR] Board
In addition of the base board informed at [CCON.Base board] more boards can be supported
by the contract. This information corresponds to the board supplements and discounts
structure [CNSR].
6.1.4 [CNPV] Stop sales
The structure CNPV informs about the stop of sales in the contract. The criterion for the valid
records is:
The initial and end date overlaps one day of the booking
The rate is the same or the value is null
The room type is the same or the value is null
The room characteristic is the same or the value is null
The board is the same or the value is null
If one of the records is valid then the booking is not possible due to stop of sales contract
restriction.
-
Active Inventory II Files Service Description
43
6.1.5 [CNEM] Minimum and maximum stay
The structure CNEM informs about the minimum and maximum days required for the service
stay.
We can distinguish 2 different types:
1. Per stay: when [CNEM.Type] value is T
2. Per dates: when [CNEM.Type] value is E
All these items are common to both types of minimum stay (T and E) the difference is the
number of days that are valid restriction of stay:
Minimum stay per stay (T), the booking check in date overlaps with the period indicated by [CNEM.Initial Date] and [CNEM.Final Date]. The total length of the stay is compared
against the minimum and maximum days of stay.
Minimum stay per dates (E), any day of the booking overlaps with the period indicated by [CNEM.Initial Date] and [CNEM.Final Date]. The number of days we use to compare
with the defined minimum and maximum is the number of days of stay requested that
overlap with those defined in the record.
Example: CNEM record with minimum days 5 and type T from 1st July to 31st July Availability from 29th July to 05th August is available. The travel stay is greater than 5 days.
Example: CNEM record with minimum days 5 and type E from 1st July to 31st July Availability from 29th July to 05th August is not available. The travel stay is only 3 days during
CNEM record applicability.
The checking algorithm must be considering both types [E and T]. And for each type the
process is the same:
The applicability of the record depends on:
The requested stay overlaps
Matches the requested room type or is generic [null]
Matches requested room characteristic or is generic [null]
The application date is valid for the booking creation day
Matches the board requested or is generic [null]
Matches the rate requested or is generic [null]
The minimum stay rule includes days of operation. The record is applicable only if the
days of operation are valid [the value is true] for the days of stay requested
First we will review those records that are minimum stay completely generic, with the Rate,
Characteristic, Room and Board fields empty. Day by day, we select the less restrictive one.
Every day affected by one or more minimum stay rules must comply at least one of them, or
what is the same, we select the less restrictive one.
-
Active Inventory II Files Service Description
44
Later we will review the records of specific minimum stay (rate, characteristic, room or board
informed). In that case, every day affected by one or more minimum stay rules must comply
with ALL of them, or what is the same, we select the most restrictive minimum stay. The
following priority must be considered in the restriction:
1. Rate
2. Characteristic
3. Room
4. Board
Once we have the result of both minimum stay, the overall result will be the most restrictive.
So, all the selected rules must apply in order to have the service available.
Example: Two records at CNEM
Minimum stay restriction of 2 days. Operation days: Mon, Tue, Wed, Thu, Fri and Sun
Minimum stay restriction of 3 days. Operation days: Sat
Availability from Saturday to Sunday will not be available. The most restrictive record does not
apply [the second one].
-
Active Inventory II Files Service Description
45
6.1.6 [CNES] Check in and check out days
This information is informet at CNES structure.
The [CNES.type] indicator informs about the application: if it is a restriction to check in or
check out date.
In both cases seek applicable records, they shall fulfil the following conditions:
The date of check in/out is included
Matches the requested room or is generic
Matches requested characteristic or is generic
The application date is valid for the booking creation day
After that, we will validate the days when the contract requires checking in or checking out.
Every record informs about the day of the week. This value must be true.
In the case of more than one applicable record, when you have just one of them to allow
checking in or checking out then it will be valid for booking.
In the absence of any record, then booking is allowed.
-
Active Inventory II Files Service Description
46
6.2 Valuation rules and process Once we have checked the availability of the service for the requested dates, then you can
calculate the price.
The service and all the information you need in order to get the price are:
Travel start date
Travel end date
Room type
Room characteristic
Board or meal plan
Occupancy information
Rate [if the contract has fixed rate [CCON.Fix rate] is true]
The valuation process is composed by:
1. Calculate the base price
2. Calculate the board supplement and discount
3. Calculate the occupancy supplements and discounts
o Child
o Additional bed
o Individual use
4. Calculate the general supplements and discounts
5. Calculate the frees
6. Check the combinable supplements and discounts
7. Calculate the handling fees
-
Active Inventory II Files Service Description
47
6.2.1 Calculate the base price
The first step consists in calculate the base price for every day. This price is informed in the
CNCT structure. The currency of the prices is informed in the contract header at CCON.
The CNCT contains, for every room type and characteristic, records with the price information.
You have to check the corresponding record to your travel dates and get the base prices.
Example: In a service from 10th to 13th the records you have to process are the corresponding to day
10th, day 11th and day 12th.
6.2.1.1 Base board For each day, the price retrieved corresponds to the board informed. In case you are valuating
a service with a different meal plan, you have to go to board supplements and discounts at
CNSR to determine the base price. More detailed rules in order to apply the supplements and
discounts are explained later.
6.2.1.2 Price type The [CNCT.Is price per pax] can be:
Y: Price per passenger
N: Price per room
Example: Booking for 3 days and one room for 2 adults:
Dates Case 1 Case 2
Record Daily price Record Daily price
Day 10 (Y,10,10,0,R0) 10+10 (N,10,10,0,R0) 10
Day 11 (Y,10,10,0,R0) 10+10 (N,10,10,0,R0) 10
Day 12 (Y,10,10,0,R0) 10+10 (N,10,10,0,R0) 10
TOTAL 60 30
Table 7: Base price calculation example
6.2.1.3 Rate The rate information [CNCT.Rate] is necessary to take in consideration for the following
valuation steps, so you have to keep track of the value in the record which is being processed.
-
Active Inventory II Files Service Description
48
6.2.2 Calculate the board supplements and discounts
At this point we have the base price of the service for the base board of the contract. Now we
have to process the board supplements and discounts informed at CNSR structure.
For every day of stay you have to process only the valid records, checking by:
Board requested
Dates
Operation day
Rate
Room type and characteristic
One single day can only have one supplement or discount to apply. If there is more than one
valid record the restriction criteria selection is:
1. Rate codes if informed
2. Room type
3. Room characteristic
If the board requested it is different than the base board of the contract and does not have a
valid record for one day of the booking stay, then the entire valuation and booking is discarded
and the service is not available.
The application process is:
Is per pax: if the value is true then the record applies for each passenger of the service. If not, then only once per service.
Percentage: when the supplement or discount is informed with a percentage you have to calculate the amount on which apply it. When the [CNCT.Is per pax] and [CNSR.Is
per pax] have the same value, then the amount is the informed in base price CNCT.
Otherwise, it is necessary to get the standard capacity of the room [CNHA.Standard
capacity] to calculate the amount. When the [CNCT.Is per pax] is false and [CNSR.Is
per pax] value is true, the percentage applies to [CNCT.Price] divided by
[CNHA.Standard capacity]. When the [CNCT.Is per pax] is true and [CNSR.Is per pax]
value is false then the percentage applies to [CNCT.Price] multiplied by
[CNHA.Standard capacity].
If exists a board supplement or discount for the base board, these kind of record applies only
to the passengers that exceeds the standard capacity of the room.
The next examples will show the application process for the board supplements and discounts.
-
Active Inventory II Files Service Description
49
Example: Board supplement per amount
Base price [CNCT] CNHA Standard capacity
Board supplement and discount [CNSR]
Board supplement price
Amount Is per pax
Amount Is per pax 1 pax 3 pax
100 N Irrelevant 10 N 10 10
100 N Irrelevant 10 Y 10 10+10+10
100 Y Irrelevant 10 N 10 10
100 Y Irrelevant 10 Y 10 10+10+10
Table 8: Board supplement/discount per amount
Example: Board supplement per percentage
Base price [CNCT] CNHA Standard capacity
Board supplement and discount [CNSR]
Board supplement price
Amount Is per pax
Percent. Is per pax 1 pax 3 pax
80 N 2 20 N 20%80 20%80
80 N 2 20 Y 20%(80/2) 20%(80/2)+ 20%(80/2)+ 20%(80/2)
80 Y 2 20 N 20%(80*2) 20%(80*2)
80 Y 2 20 Y 20%80 20%80+ 20%80+ 20%80
Table 9: Board supplement/discount per percentage
-
Active Inventory II Files Service Description
50
6.2.3 Calculate the occupancy supplements and discounts
Once we have the base price and the board supplement or discount applied, then we have to
process the occupancy supplements and discounts informed at CNSU structure.
There are three different types:
1. Child supplement or discount
Determine the final type of pax for the service
2. Additional bed
Applied only for the passenger exceeding the standard capacity
3. Room for single use
Applied only for passengers not exceeding the standard capacity
General restrictions:
The [CNSU.Is per pax] value is always true
One passenger can only have one record to apply
The [CNSU.Order] is not relevant due to are the first in the application order
The [CNSU.Is cumulative] is not relevant, will be always false
The price calculated after this process will be the base price on which apply the rest of the
supplements and discounts.
-
Active Inventory II Files Service Description
51
6.2.3.1 Child supplement or discount A child supplement or discount is defined when the [CNSU.Type] value is N.
At this stage we will obtain the passenger type: adult, child or infant, depending on the
contract information.
A passenger is considered an infant when his age is younger than [CCON.Minimum child age].
Also when you can not apply a child supplement or discount but only because of the age rules
does not applies due to the passenger age is younger than the minimum age in the child
supplement or discount record and there is no more record for this passenger age.
An infant will not be considered in the valuation process and the price is 0.
A passenger is considered a child pax when a child supplement or discount applies. It is very
common child discounts of 100% from 0 to 2 years old. Then, a 1 years old pax will be
considered a child pax with price 0, but not an infant.
A passenger is considered an adult pax when is not an infant or child.
You have to process record by record and check if it applies for all the days and passenger. As
the child supplement or discount is the first you have to apply the order is not relevant.
The validation record check is:
Dates
Rate
Room type
Room characteristic
Board
Passengers age
Operation days
If more than one record is valid, then the filtering order is:
1. Rate
2. Room type
3. Room characteristic
4. Board
The child supplement and discount has two more fields that we have to validate:
Order [CNSU.Pax order]: The child order. It could appear different supplements or discounts for the first child and the second one in the same booking.
Adults [CNSU.Adults]: The minimum adults that may have in the booking in order to apply the record.
-
Active Inventory II Files Service Description
52
Example: Child supplements and discount records for a contract where:
[CCON.Minimum child age] value is 0
# Pax order
Adults Minimum-maximum age Percentage
A 1 2 0-2 100%
B 1 2 3-12 100%
C 2 2 0-2 100%
D 2 2 3-12 50%
Availability Pax Age Supplement or Discount
Order Description
2 AD AD 30 -
There is no pax with child supplement/discount AD 30 -
1AD + 1CH AD 30 - There is not enough adults to apply the child
supplement/discount CH 2 -
2AD + 1CH
AD 30 -
The A child supplement/discount applies AD 30 -
CH 2 A 1
2AD + 1CH
AD 30 -
The B child supplement/discount applies AD 30 -
CH 8 B 1
1AD + 2CH
AD 30 - The A child supplement/discount applies. There is enough adults because one requested child is considered adult
CH 2 A 1
AD 8 -
2AD + 2CH
AD 30 - The A child supplement/discount applies for the first child. The D child supplement/discount applies for the second child
AD 30 -
CH 2 A 1
CH 8 D 2
1AD + 3CH
AD 30 - The B child supplement/discount applies for the first child. The C child supplement/discount applies for the second child. There is enough adults because one requested child is considered adult
CH 8 B 1
CH 8 C 2
AD 8 -
2AD + 3CH
AD 30 - The B child supplement/discount applies for the first child. The D child supplement/discount applies for the second child. No more child supplement/discount applies because there is no more Pax Order informed.
AD 30 -
CH 8 B 1
CH 8 D 2
AD 8 -
Table 10: Child supplement/discount valuation example
-
Active Inventory II Files Service Description
53
Example: Child supplements and discount records for a contract where:
[CCON.Minimum child age] value is 3
# Pax order
Adults Minimum-maximum age Percentage
A 1 2 3-12 100%
B 2 2 3-12 50%
Availability Pax Age Supplement or Discount
Order Description
2 AD AD 30 -
There is no pax with child supplement/discount AD 30 -
1AD + 1CH AD 30 - There are not enough adults to apply the child
supplement/discount. The child is considered infant because is younger than 3 INF 2 -
2AD + 1CH
AD 30 - There is no pax with child supplement/discount. The child is considered infant because is younger than 3
AD 30 -
INF 2 -
2AD + 1CH
AD 30 -
The A child supplement/discount applies AD 30 -
CH 8 A 1
1AD + 2CH
AD 30 - There are not enough adults to apply the child supplement/discount. The child is considered infant because is younger than 3
INF 2 -
AD 8 -
2AD + 2CH
AD 30 -
The A child supplement/discount applies for the second child. The first child is considered infant because is younger than 3
AD 30 -
INF 2 -
CH 8 A 1
1AD + 3CH
AD 30 - The A child supplement/discount applies for the first child. The B child supplement/discount applies for the second child. There are enough adults due to the third child is considered adult.
CH 8 A 1
CH 8 B 2
AD 8 -
2AD + 3CH
AD 30 - The A child supplement/discount applies for the first child. The B child supplement/discount applies for the second child. No more child supplement/discount applies because there is no more Pax Order informed.
AD 30 -
CH 8 A 1
CH 8 B 2
AD 8 -
Table 11: Child supplement/discount valuation example
-
Active Inventory II Files Service Description
54
Example: Child supplements and discount records for a contract where:
[CCON.Minimum child age] value is 0
# Pax order
Adults Minimum-maximum age Percentage
A 1 2 3-12 100%
B 2 2 3-12 50%
Availability Pax Age Supplement or Discount
Order Description
2 AD AD 30 -
There is no pax with child supplement/discount AD 30 -
1AD + 1CH AD 30 - There are not enough adults to apply the child
supplement/discount. The child is considered infant because there is no record to apply AD 2 -
2AD + 1CH
AD 30 - The child is considered as price 0 because there are child supplement/discount which not applies due to the passenger ages is younger
AD 30 -
CH 2 - 1
2AD + 1CH
AD 30 -
The A child supplement/discount applies AD 30 -
CH 8 A 1
1AD + 2CH
AD 30 - The child is considered as price 0 because there are child supplement/discount which not applies due to the passenger ages is younger
CH 2 - 1
AD 8 -
2AD + 2CH
AD 30 - The child is considered as price 0 because there are child supplement/discount which not applies due to the passenger ages is younger. The B child supplement/discount applies for the second pax with order 2
AD 30 -
CH 2 - 1
CH 8 B 2
1AD + 3CH
AD 30 - The A child supplement/discount applies for the first pax. The B child supplement/discount applies for the second pax
CH 8 A 1
CH 8 B 2
AD 8 -
2AD + 3CH
AD 30 - The A child supplement/discount applies for the first pax. The B child supplement/discount applies for the second pax. No more child supplement/discount applies because there is no more Pax Order informed.
AD 30 -
CH 8 A 1
CH 8 B 2
AD 8 -
Table 12: Child supplement/discount valuation example
Once you have the record to apply, the price calculation is detailed in the next section.
-
Active Inventory II Files Service Description
55
6.2.3.2 Infant supplement or discount An infant supplement or discount is defined when the [CNSU.Type] value is F.
Remember that a passenger is considered an infant when his age is younger than
[CCON.Minimum child age].
All the infant supplements or discounts will have the [CNSU.Minimum age] and
[CNSU.Maximum age] informed. Furthermore, the [CNSU.Maximum age] will be equal or lower
than [CCON.Minimum child age]
The validation record check is:
Dates
Rate
Room type
Room characteristic
Board
Passengers age
Operation days
If more than one record is valid, then the filtering order is:
5. Rate
6. Room type
7. Room characteristic
8. Board
The infant supplement and discount has two more fields that we have to validate:
Order [CNSU.Pax order]: The infant order. It could appear different supplements or discounts for the first child and the second one in the same booking.
Adults [CNSU.Adults]: The minimum adults that may have in the booking in order to apply the record.
-
Active Inventory II Files Service Description
56
6.2.3.3 Additional bed An additional bed supplement or discount is defined when the [CNSU.Type] value is C.
These records must be processed just afterwards the child supplement and discounts.
The additional bed only applies for the adult passengers which exceed the standard capacity of
the room. And also you have to check:
Dates
Rate
Room type
Room characteristic
Board
Passengers age
Operation days
If more than one record is valid, then the filtering order is:
1. Rate
2. Room type
3. Room characteristic
4. Board
You have to consider the order [CNSU.Pax order]. It could appear different supplements or
discounts for the first adult and the second one in the same booking
-
Active Inventory II Files Service Description
57
Example: Additional bed supplements and discount records for a contract where:
Standard capacity value is 2
# Order Percentage
A 3 -50%
B 4 -30%
Availability Pax Age Supplement or Discount
Order Description
1AD AD 30 - - Not enough passengers to apply
2AD
AD 30 - -
Not enough passengers to apply
AD 30 - -
3AD
AD 30 - -
The A supplement/discount to the third passenger. AD 30 - -
AD 30 A 3
4AD
AD 30 - -
The A supplement/discount to the third passenger. The B supplement/discount to the fourth passenger
AD 30 - -
AD 30 A 3
AD 30 B 4
2AD+ 1CH
AD 30 - -
The third passenger has the child supplement/discount applied so the additional bed
supplement/discount does not apply
AD 30 - -
CH 8 - -
2AD+ 1CH
AD 30 - -
The A supplement/discount applies to third adult. The child is considered adult because no child supplement or discount applied
AD 30 - -
AD 8 A 3
Table 13: Additional bed supplement/discount valuation example
Once you have the record to apply, the price calculation is detailed in the next section.
-
Active Inventory II Files Service Description
58
6.2.3.4 Room for single use A room for single use supplement or discount is defined when the [CNSU.Type] value is I.
The application order is just after the additional bed. Note that the additional bed and single
use supplement and discount can only apply one of them to the same passenger. The reason is
because the room for a single use applies only to adults not covering the standard capacity.
And also you have to check:
Dates
Rate
Room type
Room characteristic
Board
Passengers age
Operation days
If more than one record is valid, then the filtering order is:
1. Rate
2. Room type
3. Room characteristic
4. Board
The [CNSU.Pax order] restriction is mandatory. It could appear different supplements or
discounts for the first adult and the second one in the same booking.
Example: Additional bed supplements and discount records for a contract where:
Standard capacity value is 2
# Order Percentage
A 1 -50%
Availability Pax Age Supplement or Discount
Order Description
1AD AD 30 A 1 The A supplement/discount applies to the first passenger.
2AD
AD 30 - - Too much passengers to apply the single use supplement/discount
AD 30 - -
Table 14: Additional bed supplement/discount valuation example
Once you have the record to apply, the price calculation is detailed in the next section.
-
Active Inventory II Files Service Description
59
Occupancy supplements and discounts price calculation
Different rules for the application type [CNSU.Application type]:
Application type Rule description
B Applies to the base price
R Applies to the board supplement and discount calculated price
N Applies to the price per night
A Overwrite the base price
U Applies to the first night price
T Applies to the first night price. The application dates must be between the travel start date
Table 15: Occupancy supplement/discount application types
The next table have all the different scenarios and the calculated price.
-
Active Inventory II Files Service Description
60
Example: Supplements and discounts price calculation
Standard capacity for the room is 2
Base price [CNCT] Board supplement
and discount [CNSR] Supplement and discount [CNSU]
Price Is per pax
Price Is per pax Application
type Amount Price per pax
100 Y 20
N B -10
(100-10)+20=110
Y (100-10)+20=110
N R -10
100+(20-10)=110
Y 100+(20-10)=110
N N -10
(100-10)+20=110
Y (100-10)+20=110
N A 10
10
Y 10
100 N 20
N B -10
(100/2)-10+(20/2)=50
Y (100/2)-10+20=60
N R -10
(100/2)+((20/2)-10)=50
Y (100/2)+(20-10))=60
N N -10
(100/2)-10+(20/2)=50
Y (100/2)-10+20=60
N A 10
10
Y 10
100 Y 20
N B -30%
(100-30%100)+(20/2)=80
Y (100-30%100)+20=90
N R -30%
100+((20/2)-30%20/2))=107
Y 100+(20-30%20)=114
N N -30%
(100-30%100)+(20/2-30%20/2)=77
Y (100-30%100)+(20-30%20)=84
N A 30%
30%(100+(20/2))=33
Y 30%(100+20)=36
100 N 20
N B -30%
(100/2