Booking Widget URL Parameters
A URL parameter refers to a variable (string) added to the end of a URL.
By placing links with specific URL parameters on your website, you can launch various views of the booking widget.
All standard URL parameters can be used even when using a subdomain.
For subdomain-specific parameters, please refer to [this guide].
Language will automatically be selected based on the browser settings, so there is no need to set the language via a parameter.
Format for Numbers, Strings, and Dates
When using parameters that require numbers, text, or dates, use the following formats:
| Number | # |
| Text | xxx |
| Date | yyyy/mm/dd |
Item | Usage | Parameter |
Chatbot | Open | ?triplabot_open=true |
| Launch auto message | ?triplabot_open=true&auto_messages=#### | |
Booking Widget | Open | ?tripla_booking_widget_open=search |
| View/Cancel reservation | ?tripla_booking_widget_open=confirm | |
| Include unavailable rooms in results | ?tripla_booking_widget_open=search&is_including_occupied=true | |
| Show available rooms only | ?tripla_booking_widget_open=search&is_including_occupied=false | |
| Dates | Specify check-in/out dates | ?tripla_booking_widget_open=search&checkin=yyyy/mm/dd&checkout=yyyy/mm/dd |
Undated search (when using TL-Lincoln and not using Kids tier) | ?tripla_booking_widget_open=search&search_type=undated ＊連泊の場合：&nights=〇を追加 2連泊：?tripla_booking_widget_open=search&search_type=undated&nights=2 | |
| Guests | Adults only | ?tripla_booking_widget_open=search&adults=# |
Adults + Children (with child categories) | ?tripla_booking_widget_open=search&adults=2&kids_tiers=[{"code":"A","children":1},{"code":"B","children":1},{"code":"B2","children":1},{"code":"C","children":1},{"code":"D","children":1}] | |
| Room Count | Specify number of rooms ※ &room_count refers to the number of rooms being reserved. ※ The room_count parameter is only valid when Kids tiers are configured in the Reservation Engine’s child stay settings. If children are not allowed or the setting is for bed-sharing only, please use the rooms parameter instead. When children are allowed and “Specify number of children by category” is selected with Kids tiers configured → room_count parameter is valid When children are not allowed, or children are allowed but set as “Specify number of bed-sharing children” for vacancy search → room_count is invalid, use the rooms parameter instead. Only available when using Kids tiers (not for “children not allowed” or “bed-sharing only” cases) | ?tripla_booking_widget_open=search&room_count=# |
| Adults per Room | Without Kids tiers | ?tripla_booking_widget_open=search&rooms=[{"adults":#},{"adults":#}] |
With Kids tiers ※ The parameters vary depending on the property’s child stay settings. code.A~D represent the IDs of the Kids tiers. ※ &room_count indicates the number of rooms being reserved. (As of April 9, 2021, multiple room selection is not supported on Neppan.) ※ The room_count parameter is only valid when Kids tiers are configured in the child stay settings under the Reservation Engine. If children are not allowed or the setting is for bed-sharing, please use the rooms parameter instead. When children are allowed and “Specify number of children by category” is selected with Kids tiers configured → room_count parameter is valid When children are not allowed, or children are allowed but set to “Specify number of bed-sharing children” for vacancy search → room_count is invalid, use the rooms parameter instead. | ?tripla_booking_widget_open=search&adults=2&kids_tiers=[{"code":"A","children":1},{"code":"B","children":1},{"code":"B2","children":1},{"code":"C","children":1},{"code":"D","children":1}]&room_count=# | |
With bed-sharing children only | ?tripla_booking_widget_open=search&rooms=[{“adults”:#, “children”: #},{“adults”:#, “children”: #}] | |
| Room type | Show room types | ?tripla_booking_widget_open=search&type=rooms |
Specify single room type (use room code) | ?tripla_booking_widget_open=search&room_type_code=xxx | |
Specify multiple room types Note: When multiple room filters are used, the availability calendar shows data for the first room only. | ?tripla_booking_widget_open=search&room_type_codes= xxx,xxx | |
| Filter | Multiple filters | ?tripla_booking_widget_open=search&filter=xxx,xxx |
| Plan | Show plan search results Plan search must be enabled in Settings → Widget Settings → Booking Widget | ?tripla_booking_widget_open=search&type=plan |
Specify single plan (use plan code) | ?tripla_booking_widget_open=search&hotel_plan_code= xxx | |
Specify multiple plans | ?tripla_booking_widget_open=search&hotel_plan_codes= xxx,xxx | |
| Secret Mode Plan | ?tripla_booking_widget_open=search&hotel_plan_code=xxx&mode=secret | |
| Dynamic Package | Show dynamic package-compatible plans | ?tripla_booking_widget_open=search&dynamic_package=wbf |
| Day Use | Day-use (non-overnight) plans Not supported by Neppan and Rakutsuu | ?tripla_booking_widget_open=search&is_day_use=true |
Membership | Membership sign-up | ?tripla_booking_widget_open=signUp |
Specify membership program (use program ID) | ?tripla_booking_widget_open=signUp&program_id=xxx | |
| Membership login | ?tripla_booking_widget_open=signIn | |
| Password reset | ?tripla_booking_widget_open=passwordReset | |
| API login via one-time access token | Launch with member logged in ※ Specify `one_time_access_token`, which is the one-time access token returned by the API. (The one-time access token becomes invalid after a single use or after 5 minutes.) | ?tripla_booking_widget_open=search&one_time_access_token=xxx |
| Promotion | Show plan with coupon code | ?tripla_booking_widget_open=search&coupon_code=xxx |
| Voucher | Voucher | ?tripla_booking_widget_open=search&mode=voucher |
| Facility List View | Show list of properties Only works if “Brand Property Settings” are enabled in widget settings. Note: Facilities must be marked as “displayed” from Brand Management → Reservation Engine Settings → Display Settings → Display Target Properties If brand settings are not configured, the list may still show but is not guaranteed to work properly. | ?tripla_booking_widget_open=facilities |
| Area Filter | Filter by area (requires area settings in Brand Management) | &area_id={area_id} |
| Language | Set display language | ?tripla_booking_widget_open=search&locale=ja en: English ja: Japanese ko: Korean zh_Hans: Simplified Chinese zh_Hant: Traditional Chinese |
Corporate Login URL Parameter
To get the login URL for organizations, go to:
Property Management Screen → Settings → Widget Settings → Login Widget,
then scroll to the bottom to find the “Organization login Widget URL.”
Related Articles
Booking Widget URL Parameters When Using a Subdomain
URL parameters refer to variables (strings) added to the end of a URL. By placing links with specific URL parameters on your website, you can launch various views of the reservation widget. If you're using a custom subdomain for your reservation ...Call the booking widget from an existing search panel
This setting should be configured by the website administrator. If you are not using tripla's default search panel and have your own custom design or an existing search panel, you can launch the booking widget using a JavaScript function. ...Corporate Membership Program
By using the corporate (organization) membership program, companies with corporate contracts can make reservations on a dedicated page. See here for how to add corporate (organization). ⏱ Estimated time: about 30 minutes. Difference from Individual ...Search Bar and Availability Search Screen Settings
※This setting is intended for your website administrator. This section is for installing the accommodation plan search screen (Booking Widget) and search bar on your website. In addition to the search bar provided by tripla, it is also possible to ...GA4 Setup Guide
Required Pre-Setup Items tripla Book settings must be completed. Subdomain settings must be configured. A Google Analytics 4 (GA4) account must be created. A Google Tag Manager (GTM) account and container must be created. GA4 measurement settings ...