Free Trial Signup

Articles in this section

Extending the Hosted Customer Booking Page using supported arguments

Learn how to use URL arguments to change how the Hosted Booking Page displays.

Are you new to the Hosted Booking Page? Please read the first article in this series for an introduction to our Hosted Booking Page integration. 

 

Which plans include this feature?

Legacy:  Soho, Pro, Plus, Enterprise, Flex
New:  Starter, Growth (Subscription), Growth (Per Booking), Managed
→ Learn more about our new plans or how to change your plan.


Where can I find this feature using the top menu?

  • Configure: Manage > Integrations or Manage > Layout > Booking Page
  • Access: Via URL or Staff-side from Customers > Customer Booking Page


What more do I need to use this feature?

  • Available by default on your account! Admin permissions are needed to access Integration and Layout settings.

Which Checkfront version supports this feature - classic, new or both?

  • This feature is available in both our classic version using items (Inventory > Items) and our newest version using products (Inventory > Products).  → Learn more about products

 

Supported Arguments

Back to top

You can pass further information (arguments) via the URL of your booking page that alters the layout or items/products shown. For example, to preselect a Category, you can use:

  • https://example.checkfront.com/reserve/?category_id=

Arguments must be passed in a standard name-value pair syntax, separated by an ampersand and URL encoded, for example:

  • https://example.checkfront.com/reserve/?date=2020-12-24&tid=promo1 

 

Note

If using multiple options= arguments at once, connect them with a comma and not an ampersand. For example:

  • https://example.checkfront.com/reserve/?options=hidedates,hidesearch

 

attentive

Expert Tips from Checkfront Support: 

"You can include these links in your email, text messages, or web pages to help direct Customers to specific offerings and customize their experience."

- Andry, Technical Support Specialist

 

Using 'category_id'

Back to top

Numeric category ID (Inventory > Categories or Inventory > Products) e.g.: category_id=3

  • https://example.checkfront.com/reserve/?category_id=3

 

Category Items

In this example using items, choosing to display category_id=22 shows only the Customer items from the Events category.

 

Category ID

In this example using products, choosing to display category_id=6 shows only the Customer products from the Activities category.

Multiple categories should be comma-separated. For example, category_id=2,6 displays both the Tours and Activities categories for items.

  • https://example.checkfront.com/reserve/?category_id=2,6

 

Using 'item_id'

Back to top

Numeric item or product ID (Inventory > Items or Inventory > Products) e.g.: item_id=1

  • https://example.checkfront.com/reserve/?item_id=1

 

Category Item ID

In this example using items, choosing to display item ID 132 shows the Customer the Tournament item only.

 

Product ID

In this example using products, choosing to display item ID 117 shows the Customer the Kayak Rentals product only.

 

Using 'popup'

Back to top

To enable the ability to directly book an item or product and go straight to the popup booking window, add this argument to the hosted booking page URL along with the item ID, e.g., item_id=1&popup=1

  • https://example.checkfront.com/reserve/?item_id=1&popup=1

 

Category Popup

 

Suggestion Just to change the subject for a second, you can, similarly, direct your Customers right to the Customer account login modal. To do this, use the URL: https://example.checkfront.com/reserve/?login=1. Just make sure you replace the demo account pre-fix with your account!

 

Using 'date'

Back to top

Fast forward to a specific date. ISO 8601 format (e.g. date=12-24-2020) or a date string (date=Friday, date=Next%20Friday, date=First%20Monday%20of%20next%20month).

  • https://example.checkfront.com/reserve/?date=2020-12-24
  • https://example.checkfront.com/reserve/?date=Next%20Friday
  • https://example.checkfront.com/reserve/?date=First%20Monday%20of%20next%20month

 

Using 'start_date & end_date'

Back to top

Display a specific date range. ISO 8601 format (e.g., start_date=2022-07-01&end_date=2022-07-14).

  • https://example.checkfront.com/reserve/?start_date=2022-07-01&end_date=2022-07-14

 

Hosted Date Range

 

Using 'tid'

Back to top

 

Create a tracking id to be displayed on the invoice (e.g. tid=winter-email) 

  • https://example.checkfront.com/reserve/?tid=winter-email 

 

Using 'discount'

Back to top

Automatically apply a discount code (Inventory > Discounts) to the booking.

  • https://example.checkfront.com/reserve/?discount=december

Apply a discount code to a specific item (e.g. item_id=3&discount=december)

  • https://example.checkfront.com/reserve/?item_id=3&discount=december

 

Using 'language'

Back to top

Display the booking page in a specific system language using abbreviations (e.g. lang_id=fr).

  • https://example.checkfront.com/reserve/?lang_id=fr

Make sure the language (Manage > Languages) you are specifying is enabled for your account!

 

Using 'options=tabs'

Back to top

Display categories as tabs (options=tabs) rather than a dropdown menu.

  • https://example.checkfront.com/reserve/?options=tabs

Booking Page Tabs

 

 

Using 'options=hidedates'

Back to top

Hide the date fields on the booking page.

  • https://example.checkfront.com/reserve/?options=hidedates

 

Using 'options=%2Chidesearch'

Back to top

Hide the search field on the booking page.

  • https://example.checkfront.com/reserve/?options=%2Chidesearch

 

If you want more customization options, including changing the look and feel of the booking page, please look at our website plugins.

 

 

< Configuring the Book Now button for the Hosted Booking Page

 

 

Related articles