Module link parameters

Why	Save the guest some steps: a link from a newsletter, post, or landing page opens the module with dates, guests, room types, a promo code, or a language already set.
Who	Whoever runs the property’s website and campaigns: newsletters, posts, ads, landing pages. No developer needed — parameters are appended to the page address.
What you’ll get	Links to the booking module that open with arrival and departure dates, the party, room types, a promo code, and a language already in place.
Limitations	This article covers the main parameters and scenarios; the full list lives in the Link parameters reference in the PMS. There is no currency parameter in the link: guests pick the display currency themselves.

A link to the booking module is the address of the page where the module is embedded, plus parameters: short notes on what the module should already know before the guest’s first touch. The module opens right in the state you need: an apartment landing page opens on that apartment, a promo newsletter opens with dates and the code in place, a German-language email opens in German. Parameters combine: one link can carry dates, a promo code, and a language at once.

Arrival date

The most common parameter is dates: checkIn for the arrival date and checkOut for the departure date, written as YYYY-MM-DD, for example 2026-12-11. Instead of a date, checkIn accepts the words today or tomorrow — the module substitutes today’s or tomorrow’s date. The number of nights is set by the nights parameter.

Dates in a link bring the guest to a ready-made search. A post about Christmas stays, a weekend-offer newsletter — in these messages a dated link removes the guest’s first step: the calendar opens with the days already chosen.

Outcome: the module opens with the arrival and departure dates in place — the guest immediately sees what is available for their dates.

Party size

How many people are coming is part of the search too: adults for adults, children for children. For children, ages can be passed as a comma-separated list; the rooms parameter sets the number of rooms in the search.

A family link opens the module with the party already filled in: no counters to adjust — the search starts from rooms that fit the group.

The widget has its own defaults — the “Default adults” and “Default children” fields on the Widget page in the PMS; they apply when a guest opens the widget without parameters.

Outcome: the link brings the party size with it — the module opens with adults, children, and room count filled in.

Room types

The roomTypeIds parameter says which room types to show: the module opens with only the selected ones, and the rest stay out of the search. The parameter is repeatable — it is added once per room type, so a link can carry one room type or several.

The flagship scenario is an apartment landing page. In an aparthotel every apartment is its own room type; the apartment’s page on your site gets its own link that opens the module straight on that apartment. The same way you build “suites only” links for an ad campaign or “doubles” links for an anniversary newsletter.

Which room types are sold on the website at all is your call, made through rates; the parameter narrows the choice within what is already available. The full parameter list is in the Link parameters reference in the PMS.

Outcome: one link, one set of room types — from a whole apartment on its landing page to a curated pick for a specific campaign.

Promo code

The promoCode parameter brings the code into the module: the guest opens the link, and the code is already in the Promo code box in the cart — as if they had typed it themselves. From there everything is familiar: the Apply button, the answer appears right under the field, no page reload.

The Promo code box sits in the cart by default; the “Show promo code field” toggle on the Widget page controls it. How discounts are built, how code validity works, and what the statistics show — in the promo codes article.

Paired with dates, the parameter assembles a whole campaign: “dates plus code” in a single email — the guest opens the module with the campaign terms already set.

Outcome: the code from the link is already in the Promo code box — applying it takes the guest one click.

Language

The lang parameter sets the module’s language for this link: the module opens right in the chosen language. It matters where the language is known in advance: a German newsletter, a page for Italian guests, a post on a foreign social network.

You decide which of the module’s eight guest languages are available; the language switcher in the module header stays with the guest. Currencies are not among the link parameters: a link can carry a language, but the display currency is always the guest’s own choice.

Outcome: the link opens the module in the audience’s language — no “find your language” step.

Link recipes

The base of every link is the address of the page where the module is embedded. For the widget, this page is pinned down in the PMS: on the Widget page, in the Behavior block, there is a “Booking page URL” field — the page where the module is embedded, and the widget button leads exactly there. A link with parameters is that same address with parameters appended: the first one after the ”?”, the rest after &.

A few ready-made recipes:

• A promo newsletter — dates and a code in one message:

  https://hotel.example/booking?checkIn=2026-12-11&checkOut=2026-12-14&promoCode=WELCOME_10

• An apartment landing page — one room type; the parameter repeats once per room type:

  https://hotel.example/booking?roomTypeIds=IDENTIFIER

• A newsletter in the guest’s language — lang is added to any set of parameters: the German version of your email leads to a link with dates and the language, the Italian one to its own.

The embed code stays untouched: the snippet from the PMS loads the module from HotelsCalendar servers, so parameterized links live only where you hand them out — in emails, posts, and landing pages. There is nothing to edit on the website.

Outcome: take the booking page address, append the parameters — and the campaign link is ready.

See also

• Promo codes — create the code a link places into the cart: discounts, validity, limits, and statistics.
• Module languages and currencies — pick the module’s language set, and why currency is not a link parameter.
• The multi-property widget — several properties in one widget: who it suits and how to turn on the property selector.