RoomBoss Documentation
English
  • Home
  • General Feature
  • PMS
  • SSMS
  • ECS
  • Travel Agent
English
  • Property Management System (PMS)
  • Rates & Inventory Setup
    • Accommodation Setup
      • Different Room Configuration
    • Managing Rate Plans
    • Setting Rates & Restrictions
      • Managing Rates & Restrictions At The Day Level
      • Managing Rates & Restrictions with Calendars and Periods
    • Managing Invoicing & Cancellation Strategies
    • Managing OTA Rates & Restrictions
    • Automated Gap Management
    • Using Allotments
    • User Roles
  • Channel Managers
    • RoomBoss Channel Manager
      • Prior to Integration
      • Starting the Integration Process
      • Once Activated
      • Managing Rates and Restrictions
      • Managing Room Stock Available To Channel Managers
      • RoomBoss Channel Manager Dashboard
      • Other Notes
      • FAQ
    • Neppan
      • Activating the Integration
      • Once Activated
      • FAQ
  • Website Booking Engine
    • Accommodation Booking Engine
    • Website Integration
    • URL Parameter Reference
    • Conversions & Analytics
    • Web Components
    • Sync Airbnb Calendar
  • Front Desk, Reservation & Housekeeping Operation
    • Front Desk
      • Check In
      • Check Out
      • Non-Accommodation Bookings
      • Daily Procedures
        • Start of Day Procedures
        • End of Day Procedures
      • General Recommendations
    • Reservations
      • Daily Procedures
      • New Booking Requests
        • Direct Booking Requests
        • Agent Booking Requests
      • New Booking Reservations
        • Direct Booking Reservations
        • Agent Booking Reservations
        • Channel Manager Booking Reservations
      • Allocating Bookings To Rooms
      • Modified Bookings
        • Modify a Direct Booking
        • Modify an Agent Booking
        • Modified Channel Manager Booking
      • Cancel Bookings
        • Cancelling a Direct Booking
        • Cancelling an Agent Booking
        • Cancelled Channel Manager Booking
      • Packages And Non-Accommodation Bookings
        • Non-Accommodation Notification Email Received
      • Record Adults, Children, and Infants on Bookings
    • Housekeeping
      • Overview
      • Setup
      • Managing Cleaning Tasks
      • Room Status
      • Custom Housekeeping
      • Daily Procedures
      • Suggested Workflow
    • Online Self Check-in System
      • Setup
      • Check-in Processes
        • Auto Email Self Check-in URL
        • Convey Check-in ID to Guest
        • Unpopulated Check-in Forms
      • Check-in Form Search
      • Front Desk HQ Integration
      • Online Self Check-in Form URL
      • Features Coming Soon
      • FAQ
    • Guest ID Capture With AdriaScan
    • General Room Status
  • Financial & Reporting Tools
    • User Management
    • Activity Tracking
      • Bookings
      • Invoices and Payments
      • Sales Desk
    • Data Locking
      • Financial Transaction Locking
      • Reservation Locking
      • Calendar Month Locking
      • Recommended Permissions for Data Locking
    • Reports
      • Rate Audit Report
      • In House
      • Manager Report
      • Operations Report
      • Kutchan Tax Report
  • Trust Accounting
    • The Basics
    • Journal Entry Upload
    • Allow Bookings Via Trust Owner Statements
    • Managing Post-Checkout Payments and Accounts Receivable
    • Property Ownership Changes
    • Clearing Accounts
  • USER GUIDES
    • General Features Across All Systems
    • Snow School Management System (SSMS)
    • E-Commerce System (ECS)
    • RoomBoss For Agent
  • LINKS
    • RoomBoss Login
    • RoomBoss Website
    • Contact Us
    • Privacy
Powered by GitBook
On this page
  • Using Parameters
  • Multi Vendor Search Parameters
  • Single Vendor Search Parameters
  • PMS URL Parameters
  • Vendor ID
  • Single Vendor
  • Room Type
  • Location
  • Check-in date
  • Nights
  • Guests
  • Day Offset
  • General URL Parameters

Was this helpful?

  1. Website Booking Engine

URL Parameter Reference

A list of available URL parameters and options available on the new accommodation booking engine.

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.

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

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

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

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

PreviousWebsite IntegrationNextConversions & Analytics

Last updated 2 months ago

Was this helpful?

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

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

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

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 .

Product Details
general features documentation
Check-in date parameter
Product Details