Transfer parameters to the booking path, among other things (deep linking)
To influence the results within an integration, you can use parameters to restrict the results or define the entry point (e.g., in the posting range) yourself.
How can parameters be passed?
Depending on the intended use, there are two ways to transfer the parameters:
1. Passing parameters in the script call
If you want to pre-filter or pre-select specific integrations, you can customize the JavaScript snippet for your integration.
Example:
Standard-Snippet für Buchungsstrecke
<div id="vri-container-123"></div>
<script type="text/javascript" charset="UTF-8">
( function( v, i, o, m, a ){
if ( !( o in v ) ) {
v.vioma_vri=o;
v[o] || ( v[o] = function( ){ ( v[o].q = v[o].q || [] ).push( arguments ); } );
m = i.createElement( 'script' ), a = i.scripts[0];
m.src = 'https://cst-client-hotel-blaue-linde.viomassl.com/js/vri/vri.js';
a.parentNode.insertBefore( m, a );
}
} )( window, document, 'vcst' );
vcst( {load: 'init', url: 'https://cst-client-hotel-blaue-linde.viomassl.com/', set_language: 'de'} );
vcst( {'id': 123} );
</script>To pass parameters in the above example, you can extend the object after the ID (in line 13) and pass additional parameters. Please note that the individual parameters are separated by commas and the values are passed in the style name:value. Please also note whether the values must be passed as strings or integers. Arrays are passed as strings.
Zeile 13 JavaScript-Snippet
vcst( {'id': 123,'calendar_date_from':'2015-07-20','calendar_stays':14,'persons_adults':3,'package':12345} );Warnung
Please ensure that the syntax of your JavaScript snippet is correct, otherwise the snippet will generate a JavaScript error on your page and will not load. To ensure that your snippet does not contain any errors, have it checked by an online compiler, such as Google's Closure Compiler.
2. Pass parameters as GET parameters in the URL
When passing parameters in the URL, it also depends on which page you are calling up. Depending on the integration, these are the following pages:
Booking engine
vsc.php
Package list
package-list.php
Rooms
hotel-room-list.php
Programmliste
hotel-program-list.php
The parameters can then be passed in the familiar GET parameter style:
http://www.hotel_domain/hotel_seite.html#/vsc.php?calendar_date_from=2015-07-20&calendar_stays=14&persons_adults=3&package=12345
Hinweis
Please note the characters “#/” after the page you have called up. This causes the parameters to be looped through to the embedded booking section.
Wichtig
The URL parameters are only taken into account by the integration if the “Allow URL parameters” setting has been activated in the remote integration settings:
Section Setting up remote integration
This is important because it is possible that several remote integrations are integrated on one page. Otherwise, the parameters would be adopted by all integrations.
Global Parameters
For all integrations, you can specify the desired language.
Hinweis
Please note that your content must also be maintained in the desired language in order to appear in that language.
Parameter | Wert | Beispiel | Beschreibung |
|---|---|---|---|
String | 'de' | Possible languages:
|
Parameters for the booking engine
The following parameters exist for the booking engine, which you can transfer:
Calendar
Parameter | Example | Description |
|---|---|---|
2014-07-20 | Arrival date in ISO format (YYYY-MM-DD) | |
2014-07-20 | Departure date in ISO format (YYYY-MM-DD) | |
| Number of overnight stays (as an integer) | |
STAMMKUNDEN10 | Booking code for the closed rate |
It makes sense to use “calendar_dates_to” or “calendar_stays”. If both parameters are passed, the last parameter specified will be taken into account.
Persons
Parameter | Example | Description |
|---|---|---|
2 | Number of adults (as an integer) | |
2 | Number of children (as an integer) | |
3,7 | Age of children (as integer list) |
Rooms
Parameter | Example | Description |
|---|---|---|
| “hrt” (hotel room type) + room type ID (+ pension + adults + children's ages) The parameter “items[]” can occur multiple times. |
Additional services
Parameter | Example | Description |
|---|---|---|
| “hp” (hotel program) + program ID (+ number) The parameter “items[]” can occur multiple times. |
Packages
Parameter | Example | Description |
|---|---|---|
| The ID of each package (as an integer) | |
1234 | The ID of a package group (as an integer) |
Example 1
Deeplink from January 5, 2016, to January 7, 2016, 3 adults and 3 children aged 1, 4, and 7 with automatic room allocation:
Similarly, the snippet:
Snippet für Buchungsstrecke inkl. Parameter, Beispiel 1
<div id="vri-container-123"></div>
<script type="text/javascript" charset="UTF-8">
( function( v, i, o, m, a ){
if ( !( o in v ) ) {
v.vioma_vri=o;
v[o] || ( v[o] = function( ){ ( v[o].q = v[o].q || [] ).push( arguments ); } );
m = i.createElement( 'script' ), a = i.scripts[0];
m.src = 'https://cst-client-hotel-blaue-linde.viomassl.com/js/vri/vri.js';
a.parentNode.insertBefore ( m, a );
}
} )( window, document, 'vcst' );
vcst( {load: 'init', url: 'https://cst-client-hotel-blaue-linde.viomassl.com/', set_language: 'de'} );
vcst( {
'id':123,
'calendar_date_from':'2016-01-05',
'calendar_date_to':'2016-01-07',
'persons_adults':3,
'persons_children_ages':'1,4,7'
} );
</script>Example 2
Deeplink for arrival on January 5, 2016, with 2 nights, 1 room with 1 adult in a single room with ID 11111 and pension ID 2222, 1 room with 2 adults and 2 children aged 4 and 7, 3x the program with ID 12345:
Similarly, the snippet is as follows:
Snippet für Buchungsstrecke inkl. Parameter - Beispiel 2
<div id="vri-container-123"></div>
<script type="text/javascript" charset="UTF-8">
( function( v, i, o, m, a ){
if ( !( o in v ) ) {
v.vioma_vri=o;
v[o] || ( v[o] = function( ){ ( v[o].q = v[o].q || [] ).push( arguments ); } );
m = i.createElement( 'script' ), a = i.scripts[0];
m.src = 'https://cst-client-hotel-blaue-linde.viomassl.com/js/vri/vri.js';
a.parentNode.insertBefore ( m, a );
}
} )( window, document, 'vcst' );
vcst( {load: 'init', url: 'https://cst-client-hotel-blaue-linde.viomassl.com/', set_language: 'de'} );
vcst( {
'id': 123,
'calendar_date_from':'2016-01-05',
'calendar_stays':2,
'items[0]':'hrt:11111:2222:1',
'items[1]':'hrt:::2:4,7',
'items[2]':'hp:12345:3'
} );
</script>Parameters for the voucher sales system
Currently, there are no parameters that can be transferred to the voucher sales system.
Parameters for lists (room list, package list, etc.)
There are also parameters for integrations that contain lists. These are already stored in the settings:
Room list parameters
Parameter | Example | Description |
|---|---|---|
c[details_opened] | 1 | If the value is set to 1, the details are automatically expanded. |
hotel | 1234 | Hotel-ID Display of room types for a specific hotel (multi-property only) |
c[id_list_room_types] | 1234, | Room type ID Filter by specific room type(s) |
c[id_list_room_groups] | 1234, | Room group ID Filter by specific room type(s) (single room, double room, suite, etc.) |
c[id_list_roomtype_indicators] | 1234 | Indicator ID Filter by specific indicator(s) |
c[int_roomtype_catering] | 1234 | Catering ID Filter by a specific type of catering |
pension_id | 1234 | Rate ID Filter by a specific pension or rate |
Package list parameter
Parameter | Example | Description |
|---|---|---|
c[details_opened] | 1 | If the value is set to 1, the details are automatically expanded. |
type | 1 | Package type ID Filter by specific package type (e.g., last minute) |
hotel | 1234 | Hotel-ID Display of room types for a specific hotel (multi-property only) |
c[ids_hotels][] | c[ids_hotels][]=1234&c[ids_hotels][]=2345 | Hotel-IDs Filter by multiple hotels (multi-property only) |
c[id_list_hotels] | c[id_list_hotels]=3884,4259 | Hotel IDs - Alternatives Filter by multiple hotels (multi-property only) |
c[int_limit] | 5 | Number per item Maximum number of list items |
c[int_limit_per_hotel] | 5 | Number per item per hotel Maximum number of list items per hotel (multi-property only) |
c[int_list_stays] | 5 | Number of nights |
[ints_stays][] | 5 | Number of nights - alternative |
c[int_stays] | 5 | Number of nights - alternative |
c[ids_packages][] | c[ids_packages][]=1234&c[ids_packages][]=2345 | Package IDs List of special packages |
c[id_variant_group] | 1234 | Package options List of a package including all variants. The variant ID can be displayed as a column in the flat rate overview (hpa_variant_group). |
c[id_list_packages] | c[id_list_packages]=1234,2345 | Package IDs - Alternative List of special package deals |
c[id_package] | 1234 | Package ID A specific package |
c[ids_roomtypes][] | c[ids_roomtypes][]=1234&c[ids_roomtypes][]=2345 | Room type IDs List of special room types |
c[id_list_package_indicators] | 1234,2345 | Indicator IDs List of special indicators |
c[id_package_indicator_ne] | 1234 | Exclusive indicator ID Exclude specific indicator |
c[date_from] | 17.12.2015 | Arrival date |
c[date_to] | 17.12.2015 | Departure date |
c[date_to_latest] | 17.12.2015 | Date no later than |
c[id_pension] | 1234 | Rate ID Filter by a specific pension or rate |
c[id_pension_type] | 1234 | Pension type ID Filter by a specific type of pension |
c[bool_return_requestable] | 1 | On request Packages that are only available “on request” are also included with this parameter. |
Program list parameters
Parameter | Example | Description |
|---|---|---|
hotel | 1234 | Hotel-ID Display of room types for a specific hotel (multi-property only) |
c[id_list_programs] | 1234,2345,3456 | Program IDs Filters for specific programs |
c[id_list_program_indicators] | 1234,2345,3456 | Indicator IDs List of special indicators |
Parameters of the remaining space exchange
Parameter | Example | Description |
|---|---|---|
days | 31 | By default, the booking gaps for the next 14 days are displayed. You can change the number of days using the “days” parameter. |
limit_rooms | 2 | The variable “limit_rooms” limits the number of available periods per room. |
limit_stays | 2 | The variable “limit_stays” limits the maximum number of nights offered. For example, “limit_stays=2” only displays available periods with a maximum of 2 nights. |
Inhalt
- 1 How can parameters be passed?
- 1.1 1. Passing parameters in the script call
- 1.2 2. Pass parameters as GET parameters in the URL
- 1.2.1 Booking engine
- 1.2.2 Package list
- 1.2.3 Rooms
- 1.2.4 Programmliste
- 1.3 Global Parameters
- 1.4 Parameters for the booking engine
- 1.5 Parameters for the voucher sales system
- 1.6 Parameters for lists (room list, package list, etc.)
- 1.6.1 Room list parameters
- 1.6.2 Package list parameter
- 1.6.3 Program list parameters
- 1.7 Parameters of the remaining space exchange