Skip to main content

URL Parameters

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.

Multiple Parameters​

Multiple parameters can be added to a URL to give the desired results, however for 2+ parameters, please note they must be separated by an ampersand &.

Example: https://book.examplecompany.com/public/booking/order02.jsf?uid=12345&mv=1&code=sample&i18=en

Available Parameters​

Company ID​

Specifies a company as the booking source

Parameter: uid

Options: Company ID

Example: https://book.examplecompany.com/public/booking/order02.jsf?uid=8028808c11f7ee4d0111f7ee55980071&mv=1&i18=en

Vendor ID​

Multi Vendor​

Specifies that the booking widget should be displayed with all available Vendors

Parameter: mv

Options: 1

Example: https://book.examplecompany.com/public/booking/order02.jsf?uid=8028808c11f7ee4d0111f7ee55980071&mv=1&i18=en

info

Category Groups (ECS, SSMS) are displayed only on the Multi-Vendor Mode booking engine when the mv=1 parameter is included. Example: https://OOOO.bookfast.jp/public/booking/order02.jsf?mv=1

Single Vendor​

Limits the booking engine to display only a single, specified vendor to be viewable by the guest

Parameter: vid

Options: Vendor ID

Example: https://book.examplecompany.com/public/booking/order02.jsf?uid=8028808c11f7ee4d0111f7ee55980071&vid=c879d5991c4f5dc2011c501d389201d5&i18=en

Selected Vendor / Category / Product​

Allows the booking engine to open with a specific vendor, category, or product preselected.

Parameters:

  • slvid = Selected Vendor ID
  • slcid = Selected Category ID
  • slpid = Selected Product ID

Example:
https://book.examplecompany.com/public/booking/order02.jsf?mv=1&slvid=c879d5991c4f5dc2011c501d389201d5&i18=en

info

Note that the slpid parameter does not automatically open the product selection dialog or add the product to the cart.
The slpid parameter preloads the page in the context (vendor → category → type) of the specified product ID.

Vendor Set​

Limits the booking engine to display a specified set of vendors. Vendor Sets can be created in: Navigate → Account → Vendor Set

Note: vs must be used in conjunction with the multi-vendor parameter mv as in the example below

Parameter: vs

Options: Vendor Set Name

Example: https://book.examplecompany.com/public/booking/order02.jsf?uid=8028808c11f7ee4d0111f7ee55980071&mv=1&vs=examplevendorset&i18=en

Language​

Specifies the language the link opens. Defaults to the browser language if it is supported. Defaults to EN if not specified.

Parameter: i18n

Options: Supported languages en ja zh-hans zh-hant

Example: https://book.examplecompany.com/public/booking/order02.jsf?uid=12345&vid=12345&i18n=ja

Promotional Code​

Displays hidden rate plans associated to the specified Promotional Code.
If a rate plan has a one or more promotional codes associated to it, it will not be visible until one of the codes has been applied.

Parameter: code

Options: Rate plan promotional code (string)

Example: https://book.examplecompany.com/public/booking/order02.jsf?uid=12345&vid=12345&code=SUMMERSALE

Vendor Category​

It is also possible to limit the services displayed on the Order02 booking widget using the vendor categories as a parameter

Parameter: vendorCategory

Options:

activities - Display Activities vendors only
lift_tickets - Display Lift Tickets vendors only
restaurant – Display Dining vendors only
ski_rentals – Display Rentals vendors only
ski_school – Display Ski Schools and Guiding vendors only
transportation – Display Transportation and Tours vendors only
no_category – Display Other vendors only

Example: https://book.examplecompany.com/public/booking/order02.jsf?mv=1&vendorCategory=activities

Booking ID​

Booking IDs can also be passes as URL parameters.

Please see our more detailed documentation here.

Booking Segment​

Booking Segments can also be passes as URL parameters.

Please see our more detailed documentation here.

PMS URL Parameters​

There are also some PMS specific URL parameters that are only applicable to the Accommodation booking widget.

Please see our PMS URL Parameter documentation for more details.