URL Parameters for Booking Widget

URL Parameters for Booking Widget

Info
Purpose:
This section is to explain how to create URL to launch various booking widget screens,
 by placing links with specific URL parameters on the property homepage. 
⏱ Estimated time: ~10 mins
Idea
"URL parameters" refer to variables (strings) appended to the end of a URL.
By placing links with specific URL parameters on a website, various booking widget screens can be launched.

When using a subdomain, all standard URL parameters are available 
For parameters applicable to subdomain usage, see here.

1. Specifying Number, String, and Dates

Numbers, strings, and dates used in parameters are shown in the table below.
Modify each value as needed before use.

Number#
Textxxx
Dateyyyy/mm/dd

2. Chat Bot

Purpose
Parameter
1. Launch / Open?triplabot_open=true
2. Launching the Auto Message?triplabot_open=true&auto_messages=####

3. Booking Widget

Purpose
Parameter
1. Launch / Open?tripla_booking_widget_open=search
2. Reservation Confirmation/Cancellation page?tripla_booking_widget_open=confirm

4. Room

Purpose
Parameter
1. Room Count
?tripla_booking_widget_open=search&room_count=#
2. Show search results including unavailable rooms?tripla_booking_widget_open=search&is_including_occupied=true
3. Show search results with available rooms only?tripla_booking_widget_open=search&is_including_occupied=false
4.Display Room type?tripla_booking_widget_open=search&type=rooms
5.Display Specify Room Type?tripla_booking_widget_open=search&room_type_code=xxx
6.Display multiple room type?tripla_booking_widget_open=search&room_type_codes= xxx,xxx
Info
*Enter the room code after "="
Warning
When multiple room type filters are specified, only the availability data for the first room type is reflected in the availability calendar.

4.1 Rooms and Guests

Purpose
Parameter
1. Adults and Number of Rooms (No Kid Categories / Bed-Sharing Only)?tripla_booking_widget_open=search&rooms=[{"adults":#},{"adults":#}]
2. Adults and Kids with Rooms (Kid Categories Enabled)?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=#
Warning
Warning:
  1. The parameters vary depending on the property’s kids settings.
  2. code.A to code.D represent the IDs for kids categories.
Warning
Warning:
&room_count represents the number of rooms to be reserved.

room_count parameter is supported when:
・Kids are allowed and
・“Users specify the number of kids by the following tiers” is selected and
・Kid tier are configured

■Use rooms parameter (room_count is not supported) when:
・ Kids are not allowed, or
・ Kids are allowed and “Users specify the number of kids (share bed with adult)” is selected during search

5. Plan

Purpose
Parameter
1. Display plan result?tripla_booking_widget_open=search&type=plan
2. Display specify plan
?tripla_booking_widget_open=search&hotel_plan_code=xxx
3. Display multiple plan
?tripla_booking_widget_open=search&hotel_plan_codes=xxx,xxx
4. Displaying secret-mode plans?tripla_booking_widget_open=search&hotel_plan_code=xxx&mode=secret
5. Display Day Use Plan?tripla_booking_widget_open=search&is_day_use=true
Idea
*Enter plan code after "="

6. Membership

Purpose
Parameter
1. Display Membership sign-up page?tripla_booking_widget_open=signUp
2. Display specific membership program
*Enter membership program ID after "=" sign
?tripla_booking_widget_open=signUp&program_id=xxx
3. Display Membership log in?tripla_booking_widget_open=signIn
4. Reset Password?tripla_booking_widget_open=passwordReset

7. Promotion

Purpose
Parameter
Display plans with a coupon code applied
*Enter the coupon code after the "=" sign
?tripla_booking_widget_open=search&coupon_code=xxx

8. When Brand Setting ON

8.1 Property List

PurposeParameter
View Property list?tripla_booking_widget_open=facilities
  1. The property list can be displayed only when Brand Settings are configured.
    1. Brand Settings: Admin Settings → tripla Setup → Brand Settings
  2. Properties to be shown on the property list page must be selected in advance:
    1. Setting page: Brand Management Screen
    2. Action: 'Setting' → 'Booking Engine' → 'Property Display Settings' → [Active] Suggestion for no stock → check the property, and save.

8.2 Area Setting

PurposeParameter
View Area List&area_id={area_id}
Idea
  1. The list is displayed only when an Area is configured in:
    1. Setting page: Brand Management
    2. Action: 'Setting' → 'Booking Engine' → 'Area Settings'

  1. The area_id can be obtained from the URL of the created area.
    ▼Example: https://cm.tripla.ai/brands/brand_id/settings/areas/area_id?locale=ja

9. Conditional Booking Widget Launch

9.1 Date

Purpose
Parameter
1. Specify check-in/out dates?tripla_booking_widget_open=search&checkin=yyyy/mm/dd&checkout=yyyy/mm/dd
2. Date not Specify
?tripla_booking_widget_open=search&search_type=undated

*For consecutive nights: add {&nights=〇}
▼Example: 2 nights
?tripla_booking_widget_open=search&search_type=undated&nights=2

9.2 Number of Guests

Purpose
Parameter
1. Adult Only
?tripla_booking_widget_open=search&adults=#
2. Adults + Kids
?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}]
3. Specify the number of bed-sharing kids

*Only the number of bed-sharing kids is supported.
This option is not available when kid categories (e.g., Under 12 years old or 6 years old) are used.
?tripla_booking_widget_open=search&rooms=[{“adults”:#, “children”: #},{“adults”:#, “children”: #}]

9.3 Filter 

Purpose
Parameter
Display multiple filter?tripla_booking_widget_open=search&filter=xxx,xxx
Idea
  1. Enter the filter ID after the "="
  2. Filter IDs can be found under: Brand Management Screen
    1. Action: 'Settings' → 'Booking Engine' → 'Search Filters'

10. Language

Purpose
Parameter
Display language
?tripla_booking_widget_open=search&locale=ja

en: English
ja: Japanese
ko: Korean
zh_Hans: Simplified Chinese
zh_Hant: Traditional Chinese
id: Indonesian
th: Thai
ar: Arabic
Warning
The language is automatically set based on the browser language, so no parameter configuration is required.

11. Parameter for organization login

To get the login URL for organizations, 
  1. Setting Page: Property Management Screen
  2. Action: 'Settings' → 'Widget Settings' → 'Login Widget'
  3. Scroll down to the bottom of screen and find "Organization login Widget URL"

    • Related Articles

    • URL Parameters for Booking Widget (Subdomain)

      Purpose: This section explains how to create a booking widget URL with parameters for properties using a subdomain. ⏱ Estimated time: ~10 mins "URL parameters" refer to variables (strings) appended to the end of a URL. By placing links with specific ...
    • Subdomain Setup for Booking Widget(BW)

      Purpose: This section is to explain basic information and key considerations regarding the use of subdomains for the booking widget. 1. What is Subdomain? A subdomain is used to divide a single domain into multiple parts for different purposes. ...
    • Widget Settings (Search Bar)

      Purpose: This section explains how to install the booking widget and search bar on the website. ⏱ Estimated time: ~10mins In addition to the search bar provided by tripla, the booking widget can also be launched from a custom-designed search bar or ...
    • Guest Booking Flow

      Purpose: This section explains the booking and reservation flow on the customer screen. ⏱ Estimated time: ~10mins 1. Reservation Flow Step 1 ・On the search bar, enter the check-in & check-out date, number of guests and number of rooms. ・If the Kids ...
    • Recommender Widget

      Purpose: This section explains how to configure the recommender widget, which uses AI recommendations to display the most suitable room type for each user by plan. ⏱ Estimated time: ~10mins Plans are displayed at the lowest price within the past ...