Skip to main content

URL Parameter Reference

Using Parameters​

URL parameters are settings you can use to direct your guest to specific listings, subsets of vendors or products — or to apply settings such as viewing language or single-vendor mode on the booking engine.

info

The following example would load the Japanese language page (i18n=ja) for the specified vendor listing (listing/f808ad9639179863013932899b6a25d6) in single vendor mode (sv=1) , searching for 2 guests (g=2) checking in on Jan 31st (ci=20220131) for 1 night (n=1)

https://examplehotel.evoke.jp/search/listing/f808ad9639179863013932899b6a25d6?ci=20220131&n=1&g=2&sv=1&i18n=ja

Multi Vendor Search Parameters​

eg. https://examplehotel.evoke.jp/search?...

Parameters can be added to the above search query to yield specific search results for multiple vendors.

Single Vendor Search Parameters​

eg. https://examplehotel.evoke.jp/search/listing/f808ad9639179863013932899b6a25d6

Parameters can be added to the above search query to yield specific search results for a single vendor.

PMS URL Parameters​

Vendor ID​

Specifies the accommodation vendor listing. Vendor ID is only required when you want to link directly to a specific listing. The vendor ID is added directly after listing/ and is not denoted by a prefix.

Parameter: listing/
Options: Vendor ID (e.g "f808ad9639179863013932899b6a25d6")
Example:https://examplehotel.evoke.jp/search/listing/f808ad9639179863013932899b6a25d6

info

Vendor ID can be found in Product Setup → Product Details → Overview tab.

Single Vendor​

Specifies whether listing page should be loaded in single vendor mode or not. The single vendor parameter should only be used on single vendor search URL's.

Parameter: sv
Options: 1
Example:https://examplehotel.evoke.jp/search/listing/f808ad9639179863013932899b6a25d6?sv=1

Room Type​

Shows the selected room type at the top of the room list. The room type parameter should only be used on single vendor search URL's.

Parameter: rtid
Options: Room Type ID (e.g ff8081811c21f6e4011c2203591d0002)
Example:https://examplehotel.evoke.jp/search/listing/f808ad9639179863013932899b6a25d6?sv=1&rtid=ff8081811c21f6e4011c2203591d0002

info

Room Type ID can be found in Product Setup → Product Details → Room Types tab and then click Edit button.

Vendor Set​

When there are multiple facilities, it is possible to display only a specific set of vendors by restricting the map search page.

Parameter: vs
Options: Vendor set code (string)
Example: https://examplehotel.evoke.jp/search?i18n=ja&vs=sample

パラメータ：vs
オプション： Vendor set code (string)

例： https://examplehotel.evoke.jp/search?i18n=ja&vs=sample

Promotion Code​

Displays hidden pricing plans associated with the specified promotion code code. If one or more promotion codes are associated with a rate plan, it will not be displayed until one of the codes is applied.

Parameter: code
Options: Promotion code for this rate plan
Example: https://examplehotel.evoke.jp/search?i18n=ja&code=SUMMERSALE

Booking Segment ​

Booking Segment can be used to manage bookings made through specific channels, such as referrals or advertising campaigns.

Once a Booking Segment is created, any bookings made via a URL containing this parameter will be assigned to the specified Booking Segment. This information will be displayed on the reservation details page and can also be viewed in various reports and downloaded Excel files.

Parameter： segment
Options： Booking Segment code
Example：https://examplehotel.evoke.jp/search?i18n=ja&segment=MYCAMPAIGN

Location​

Specifies the search location for the map search screen. Location is compulsory on map search pages, but is not required in single vendor search. ie sv=1 mode.

Parameter: loc
Options:niseko niseko_hirafu niseko_annupuri niseko_higashiyama niseko_hanazono niseko_village nozawa nozawa_onsen furano hakuba bali and more.
Example:https://examplehotel.evoke.jp/search?loc=niseko

Check-in date​

Specifies the check-in date of the stay.

Parameter: ci
Options: Check-in date (YYYYMMDD)
Example:https://examplehotel.evoke.jp/search?ci=20220131

Nights​

Specifies the number of nights to search for.

Parameter: n
Options: Number of nights (number)
Example:https://examplehotel.evoke.jp/search?n=2

Guests​

Specifies the number of guests to search for.

Parameter: g
Options: Number of Guests (number)
Example:https://examplehotel.evoke.jp/search?g=2

Day Offset​

If the Check-in date parameter is not present, offset can be used to add a specified number of days to the default check-in date (today).

For example, if the current date is 2024/12/01 and offset is set to 7, the default check-in date upon navigating to the booking engine will be 2024/12/08.

Parameter: offset
Options: Day offset (number)
Example:https://examplehotel.evoke.jp/search/listing/f808ad9639179863013932899b6a25d6?n=5&offset=7



General URL Parameters​

There are more URL parameters available to use on the Accommodation booking engine, such as language, booking segments, vendor sets & more. A comprehensive list can be found in our general features documentation.