Booking Engine - Create a pre-filled link for a specific stay

Created by Alex Savchuk, Modified on Tue, May 20 at 11:56 AM by Alex Savchuk

The innRoad Booking Engine allows guests to book available rooms at your property at their own pace. You can also create a custom link to pre-define search criteria for the guest, and give them an option to book a specific stay date quickly.


You can see your Booking Engine URL in Setup > Booking Engines.


The Booking Engine search parameters are a JSON string. To make sure the link is usable on all browsers, we recommend using URL encoding tools that encode special characters for you.

For example, use https://codebeautify.org/json-url-encode with this JSON string:

{"propertyId":1234,"checkIn":"2019-04-01","checkOut":"2019-04-02","promoCode":"MyPromo","guests":[{"adults":2,"children":0}],"multi":false,"step":0}

Replace the parameters in the text with the actual parameters of the link you want to create. 


You can find a list of all the parameters that you can sue here:


Parameters

Description

Required?

Type

Format

propertyId 

innRoad property ID.


You can find it in Setup > Properties.

No 

integer 

Number 

checkIn  

Check-in Date

Yes 

date  

yyyy-mm-dd 

checkOut 

Check-out Date

Yes 

date  

yyyy-mm-dd 

promoCode 

A promo code that has been setup in innCenter previously in Inventory > Rates Grid > Rate Plan. 

No 

String

a-z, 0-9 

guests 

This is where you define the number of adults and children for this reservation.

Yes 

JSON node

JSON code  

adults 

Number of adults  

Yes 

integer 

0-100

children 

Number of children 

Yes 

integer  

0-100

multi 

Define if this is a multi-room reservation or a single room reservation.

Yes 

Boolean 

True or false  

step 

Reservation Step 

Yes 

integer  

Always 0 ( zero) 

  room
  innRoad Room Class ID (when sharing a link to book a specific room)  No  integer  Number

 

Multi Property Note: 
If you want to search for available rooms in all properties connected to a single Booking Engine, you can exclude the Property ID parameter. 


Encoded Examples:

  1. Single room from August 11 to August 12, 2025, for 2 adults without a promo-code:
    URL:  https://myhotel.client.innroad.com/#search={%22propertyId%22:1234,%22checkIn%22:%222025-08-11%22,%22checkOut%22:%222025-08-12%22,%22guests%22:[{%22adults%22:2,%22children%22:0}],%22multi%22:false,%22step%22:0} 
     
  2. Single room for 2 adults and 0 children from August 11, 2025 to August 12, 2025 with promo code = “MyPromo 
     
    URL:  https://myhotel.client.innroad.com/#search={%22propertyId%22:1234,%22checkIn%22:%222025-08-11%22,%22checkOut%22:%222025-08-12%22,%22guests%22:[{%22adults%22:2,%22children%22:0}], %22promocode%22:%22MyPromo%22,%22multi%22:false,%22step%22:0} 
     
  3. Multi-room reservation: 2 rooms, where each room has 2 adults, from August 11, 2025 to August 12, 2025 without a promo code. 
     
    URL: https://myhotel.client.innroad.com/#search={%22propertyId%22:1234,%22checkIn%22:%222025-08-11%22,%22 checkOut%22:%222025-08-12%22,%22guests%22:[{%22adults%22:2,%22children%22:0},{%22adults%22:2,%22children%22:0}],%22multi%22:true,%22step%22:0} 

    Notice there are 2 blocks of guests:
    "guests:[{"adults":2,"children":0},{"adults":2,"children":0}]
     


Direct room link:
If you would like to show guests availability of a specific room class, you can append “/room/{room.id}” to the URL as seen here in bold: 

URL:  https://myhotel.client.innroad.com/room/3879#search={%22propertyId%22:1234,%22checkIn%22:%222019-03-11%22,%22checkOut%22:%222019-03-12%22,%22guests%22:[{%22adults%22:2,%22children%22:0}], %22promocode%22:%22MyPromo%22,%22multi%22:false,%22step%22:0} 



  1.  

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article