> For the complete documentation index, see [llms.txt](https://docs.guestway.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.guestway.io/guest-experience/upsells.md).

# Upsells

Upsells are extras that guests buy in the Guest Portal, such as early check-in, late check-out or a custom service.

{% hint style="info" %}
**Requirements**

* The *upsells read* permission to view upsells, and the *upsells edit* permission to change them. See [Users and roles](https://docs.guestway.io/account-and-administration/users-and-roles.md).
* A connected billing account to collect upsell payments. See [Billing](https://docs.guestway.io/account-and-administration/billing.md).
* A connected PMS to write upsells to the reservation and to the folio.
  {% endhint %}

## Overview

Upsells are in **Settings** → **Organization** → **Upsells**. Each upsell is one upsell definition. An upsell definition controls four things:

* **What is offered:** an early check-in, a late check-out or a custom upsell, with an internal name, a guest-facing name and images.
* **When and at what price:** time ranges with a price for early check-in and late check-out, or a pricing type and an amount for a custom upsell.
* **How it is confirmed:** instantly on payment, or after your team approves the request.
* **What guests tell you:** custom fields that guests fill in when they buy the upsell.

The overview has two tabs: **Upsells** and **Archived**. The **Archived** tab shows the archived upsells. See *Archived upsells*.

The overview shows one card for each upsell:

| Element                       | What it shows                                                                                                                                       |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Active** / **Paused** badge | If guests can buy the upsell. An archived upsell shows **Archived**.                                                                                |
| Type                          | **Early check-in**, **Late check-out**, or the category of a custom upsell. A custom upsell with the category **Other** shows **Service template**. |
| Image                         | The primary image of the upsell. Without images, the icon of the upsell type or of the category.                                                    |
| Visibility badges             | **Before stay**, **During stay** or **After stay**.                                                                                                 |
| **Needs approval** icon       | The upsell needs approval from your team.                                                                                                           |
| **Price timeline**            | The time ranges of an early check-in or late check-out upsell.                                                                                      |

Guests buy upsells in the **Guest Portal**: before check-in, and also during the stay when the purchase window of the upsell allows it. See *Purchase window*. Once purchased, the upsell appears on the reservation, in the inbox activity feed and on the Pre-check-in card.

## Upsells in the guest journey

You configure upsells once for the organization. The **Upsells** step in each [guest journey](https://docs.guestway.io/guest-experience/guest-journey.md) switches the step on, links back to this page, and lists the upsells that apply to the journey. There, you can block an upsell for the guests of that journey.

An upsell is offered in a journey only when the journey's **Guest facing currency** matches the currency of the upsell.

## Upsell types

Click **Add Upsell** to open **What would you like to add?**.

| Type               | What it does                                                                                                                                                     | Limits                                                                                                                            |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| **Early check-in** | Lets guests arrive before the standard check-in time.                                                                                                            | One upsell of this type for each property.                                                                                        |
| **Late check-out** | Lets guests stay past the standard check-out time.                                                                                                               | One upsell of this type for each property.                                                                                        |
| **Custom upsell**  | Offers your own service, for example breakfast or parking. It is backed by a [service template](https://docs.guestway.io/guest-experience/service-templates.md). | You can have more than one custom upsell. You cannot select properties: the service template decides where the upsell is offered. |

If a property is already linked to an early check-in or late check-out upsell, the error *Properties already linked* shows when you link it to a second upsell of the same type.

Early check-in and late check-out have no category. Each custom upsell has a category. See *Categories*.

## Upsell templates

Under **Or pick an existing template**, **What would you like to add?** has templates for common extras. A template starts a custom upsell with a suggested internal name, guest-facing name, description and price. **Needs approval** is on. You still select the service template.

| Template            | Category                 | Pricing                                                                         |
| ------------------- | ------------------------ | ------------------------------------------------------------------------------- |
| **Parking**         | **Parking**              | **Applies the whole stay**, **Per night**                                       |
| **Breakfast**       | **Breakfast**            | **Applies the whole stay**, **Per person per night**                            |
| **Welcome package** | **Celebrations & gifts** | **Applies the whole stay**, **Per stay**                                        |
| **Pet fee**         | **Pets**                 | **Applies the whole stay**, **Per night**, with **Guests choose a quantity** on |
| **Room upgrade**    | **Room upgrade**         | **Applies the whole stay**, **Per night**                                       |
| **Getting around**  | **Transfers & mobility** | **Applies a specific day**, **Fixed price**                                     |

While you create an upsell from a template, you cannot change its category.

## General fields

The left panel of the editor has these fields:

| Field                        | What it does                                                                                                                                                                                                                                                                      | Limits                                                                                                                                       |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| **Internal name**            | The name your team sees in Guestway.                                                                                                                                                                                                                                              | Required.                                                                                                                                    |
| **Guest-facing name**        | The name that guests see in the Guest Portal.                                                                                                                                                                                                                                     | Required.                                                                                                                                    |
| **Guest-facing description** | Text that guests see under the name.                                                                                                                                                                                                                                              | Optional.                                                                                                                                    |
| **Category**                 | What kind of extra the upsell sells. Without your own images, guests see a photo that fits the category.                                                                                                                                                                          | Custom upsells only. A new custom upsell starts with **Other**. Fixed while you create an upsell from a template.                            |
| **Guest portal images**      | The images that guests see in the Guest Portal for this upsell. Guests see the primary image first. **Set as primary** makes the selected image the primary image. Without your own images, guests see a default image for early check-in or late check-out, or for the category. | Optional. **Add images** adds one or more images. You can also drag images onto the card. Remove all images to go back to the default image. |
| **Guest facing currency**    | The currency that guests pay in.                                                                                                                                                                                                                                                  | Must match the guest journeys that offer this upsell.                                                                                        |
| Properties                   | The listings, multi-units or complexes where the upsell is offered.                                                                                                                                                                                                               | Early check-in and late check-out only. Select at least one.                                                                                 |

When you open the editor from the **Upsells** step of a guest journey (**Create a new upsell**), the currency and the linked properties come from that journey. The toast *Guest journey applied* shows.

The guest portal preview next to the cards shows what guests see, for each upsell type, with an example booking.

**Upsell visibility for this booking** shows only when the periods differ for some bookings: a period is off, the upsell is off, or a period has conditions or **Hours until check-in**. It shows for each period if the example booking gets the upsell:

| Status        | Meaning                                                       | Line under the period                                                                                                                                                                                                                                      |
| ------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Shown**     | The example booking gets the upsell in this period.           | Without conditions: *Until check-in*, *Every day of the stay* or, for a late check-out, *Until the end of the departure day*. With conditions: the number of conditions, for example *Depends on 2 conditions*, and the **Shown** tag has a warning color. |
| **Not shown** | The example booking does not match a condition of the period. | The first condition that does not match, for example *Doesn't match: Adult Count is 3*.                                                                                                                                                                    |
| **Not sold**  | The period or the upsell is off.                              | *Before check-in is off*, *During stay is off* or *The upsell is turned off*.                                                                                                                                                                              |

**Hours until check-in** counts as a condition, for example *Until 24 h before check-in*. Hover the line under a period with conditions to see them all under *Shown only when all conditions match*.

Click a period to preview it. When the period is **Not shown** or **Not sold**, the preview shows *Not buyable before check-in* or *Not buyable during the stay*.

The preview checks the conditions on the number of guests, the nights, the language and the stay dates against the example booking. Other conditions show under *Not checked in the preview*.

For an upsell that applies a specific day, you can pick more than one day in the preview, as guests can. The preview starts with the first day that guests can buy. **Select all days** picks every day, and **Deselect all days** picks none. The total is the price times the number of days that you pick, and the breakdown shows a **Days** line. An upsell with an arrival or departure template, or a stay with only one day to pick, keeps one day.

### Categories

The **Category** list has these categories: **Children**, **Breakfast**, **Pets**, **Parking**, **EV charging**, **Extra guests & beds**, **Beverages**, **Celebrations & gifts**, **Transfers & mobility**, **Room upgrade**, **Food**, **Luggage storage**, **Equipment & amenities**, **Experiences & activities**, **Meetings & workspace**, **Wellness & spa** and **Other**.

## Archived upsells

The left panel of an existing upsell has these actions:

| Action               | What it does                                                                                                                                                                | Limits                                                                                                                              |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| **Archive upsell**   | Archives the upsell after you confirm with **Archive**. Guests do not see the upsell anymore. It moves to the **Archived** tab. Guestway keeps the upsell and its requests. | Needs the *upsells edit* permission. An archived upsell is always off. You cannot turn on **Enabled** while the upsell is archived. |
| **Unarchive upsell** | Moves the upsell back to the **Upsells** tab.                                                                                                                               | The upsell stays **Paused** until you turn on **Enabled**.                                                                          |

## Purchase settings

| Field                                           | What it does                                                                                                                                                                                                                                                                                                                         | Limits                                                                                                                          |
| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
| **Enabled**                                     | When on, guests can purchase this upsell. When off, the upsell is saved but not offered, and its card shows **Paused**.                                                                                                                                                                                                              | None                                                                                                                            |
| **All channels**, **Include only**, **Exclude** | Which reservations see the upsell, by the channel of the reservation. **All channels**: every reservation. **Include only**: only reservations from the channels you select. **Exclude**: all reservations except the ones from the channels you select. Guests of the other reservations do not see the upsell in the Guest Portal. | Shows only when **Enabled** is on. With **Include only** or **Exclude**, select at least one channel in **Select channels...**. |
| **Needs approval**                              | When on, your team must approve the request before it is confirmed. The guest pays first, and the request shows as **Awaiting review**. When off, guests book instantly.                                                                                                                                                             | None                                                                                                                            |
| **Auto-refund on decline**                      | When on, the guest gets a refund automatically when you decline. When off, a declined request keeps the payment, and the status is **Declined (no refund)**.                                                                                                                                                                         | Shows only when **Needs approval** is on.                                                                                       |
| **Sync to PMS folio**                           | When on, Guestway writes the charge and the payment to the guest's bill in your PMS after payment.                                                                                                                                                                                                                                   | See *Folio sync*.                                                                                                               |
| **VAT percentage**                              | The tax rate on the synced charge.                                                                                                                                                                                                                                                                                                   | 0 to 100.                                                                                                                       |

## Purchase window

The **Purchase window** card sets when guests can buy the upsell, and which bookings get it. It has one row for each period:

| Period              | What it does                                                        | Limits                                                                                  |
| ------------------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| **Before check-in** | Guests can buy the upsell from booking confirmation until check-in. | Early check-in sells only before check-in, so this row is always on for early check-in. |
| **During stay**     | Guests can buy the upsell from check-in until check-out.            | Late check-out and custom upsells only.                                                 |

Each row has a toggle and a conditions button with the number of conditions. The line under the period says who can buy, for example *From booking confirmation until check-in.* or *Off. Guests can't buy during the stay.* You must turn on at least one period. If not, the message *Turn on at least one period, or guests can't buy this upsell.* shows, and you cannot save.

The conditions button opens the conditions of the period:

| Field                    | What it does                                                                                                                                                                                                    | Limits                                                                             |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| Conditions               | Only bookings that match all conditions of the period get the upsell in that period. **Add condition** adds a row. **Clear all** removes all rows. A summary under the rows says which bookings see the upsell. | Up to 25 conditions for each period. The fields include your active custom fields. |
| **Hours until check-in** | Stops the sales the number of hours before the check-in time of the listing on the arrival day, for example 24 hours.                                                                                           | **Before check-in** only. 1 to 720 hours.                                          |

When a condition or **Hours until check-in** limits the upsell, the card shows **When guests see the upsell**: a timeline from the booking to check-out, with the sales cutoff and the periods.

Guestway checks the purchase window and the conditions when the guest opens the Guest Portal, when the guest adds the upsell to the basket, and again at payment. If the window closes before the guest pays, Guestway removes the upsell from the basket and does not charge it.

## Folio sync

For early check-in and late check-out, you select how the charge goes to the folio:

| Option                       | What it does                                                                                                                                      |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Sync as bill line**        | Adds a bill line for the amount to the folio, then records the guest's payment.                                                                   |
| **Sync as service template** | Applies a [service template](https://docs.guestway.io/guest-experience/service-templates.md), which adds the folio line, and records the payment. |

A custom upsell has no option to select. A Guestway service template adds the charge and the payment to the folio. A PMS service template adds the payment, and also the charge if the booking of the service did not already add one.

## Time-based pricing

Early check-in and late check-out use **Pricing** → **Available times**: a timeline of time ranges, each with its own price. The guest picks a time and pays the price of that range.

| Rule                     | Detail                                                                                                                                                 |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Start                    | A new upsell starts with one range from **11:00** to **15:00** at price 0.                                                                             |
| Ranges must be connected | Adjacent ranges share an edge. If there is a gap, the message *Time ranges must be connected before you can save.* shows, and **Save** stays disabled. |
| Maximum five ranges      | At the limit, the message *Maximum of 5 time ranges. Remove one to add another.* shows.                                                                |
| Full day                 | The timeline covers 00:00 to 00:00. When there is no room left, the message *Timeline is full. Shrink a range to add another.* shows.                  |
| Steps                    | The **−** and **+** buttons move an edge in steps of 15 minutes.                                                                                       |

## Service template

A custom upsell has a **Service template** card:

| Field                         | What it does                                                                                                                                                                                                                                                                                                                  | Limits                                                                                                                                                                                                     |
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Default service template**  | The service template that Guestway books when no other template is set for the integration of the reservation. **Create new template** makes a new template. If a Guestway service template with the same name already exists, **Use existing** selects that template instead. **View template** opens the selected template. | Must be a Guestway service template for all listings. A PMS template cannot be the default.                                                                                                                |
| **Configure per integration** | Lets you select a different service template for each integration, for example one template in each PMS.                                                                                                                                                                                                                      | A PMS template can be used only for its own integration. If the template of an integration is archived or cannot be used, the upsell is not offered for that integration. The default is not used instead. |

All service templates of one upsell must have the same availability type. A reservation without an integration cannot get a custom upsell.

## Upsell pricing settings

A custom upsell has an **Upsell pricing settings** card. It shows after you select a service template.

| Field                        | What it does                                                                                                                                                                                                                                                                         | Limits                                                     |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
| **Applies the whole stay**   | The guest buys the service once for the booking. There is no service date.                                                                                                                                                                                                           | Not available for arrival and departure templates.         |
| **Applies a specific day**   | The guest picks the date of the service. To buy the service on more days, the guest picks more days.                                                                                                                                                                                 | Arrival and departure templates always use this option.    |
| **Pricing type**             | How the amount is multiplied: **Per stay** (**Fixed price** for a specific day), **Per night**, **Per person**, **Per person per night**, **Per adult**, **Per adult per night**, **Per child**, **Per child per night**, **Per infant**, **Per infant per night** or **No charge**. | The types per night are available only for the whole stay. |
| **Amount**                   | The price for one unit, for example **Amount per night**.                                                                                                                                                                                                                            | Not used for **No charge**.                                |
| **Guests choose a quantity** | When on, guests pick a quantity, and the calculated price is multiplied by it. When off, guests buy exactly one.                                                                                                                                                                     | Not available for **No charge**.                           |

## Same-day purchase limit

**Limit same-day purchase** is at the end of the **Upsell pricing settings** card of a custom upsell, and of the **Pricing** card of a late check-out. It sets if guests can still buy for the current day. For a late check-out, the current day is the departure day.

| Option                 | What it does                                                                                                                                                                    | Limits                                             |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| Off                    | Guests can always buy for the current day.                                                                                                                                      | None                                               |
| **Allow until a time** | Guests can buy for the current day until this time, for example 09:00. The tag shows *Purchase before 09:00*. Later days stay open.                                             | A time as HH:MM, in the time zone of the property. |
| **Don't allow**        | Guests cannot buy for the current day. The earliest day is tomorrow. For a late check-out, guests can buy until the day before departure. The tag shows *No purchase same day*. | None                                               |

The limit works only when **During stay** is on in the purchase window. When **During stay** is off, the card says *During stay is turned off in the purchase window, so this setting has no effect right now.*

For an upsell that applies a specific day, guests cannot pick the current day when the limit closes it. For an upsell that applies the whole stay, a guest who buys during the stay does not pay for the current day when the limit closes it. A simulator under the options shows when the current day closes.

## Custom fields on an upsell

The **Custom fields** card asks guests for extra information when they buy the upsell, for example special requests or a license plate. Early check-in and late check-out always show the card. A custom upsell shows it after you select a service template.

The **+** button (**Add custom field**) opens **What kind of field do you need?**:

| Kind               | What the guest gives                       |
| ------------------ | ------------------------------------------ |
| **Text**           | A short free-text answer.                  |
| **Number**         | A numeric value.                           |
| **Yes / No**       | A simple checkbox.                         |
| **Date**           | A calendar date.                           |
| **Time**           | A time of day.                             |
| **List**           | One or more options.                       |
| **License plates** | Vehicle plates. No custom field is needed. |

For each kind other than **License plates**, you pick a reservation [custom field](https://docs.guestway.io/properties/custom-fields.md) of that value type, or click **Create custom field**. The answer of the guest goes into that field.

Each row of the card has these fields:

| Field                | What it does                                                    | Limits                                                                                                                                          |
| -------------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| **Field**            | The reservation custom field that keeps the answer.             | Only active reservation fields that Guestway owns. Fields added by an integration are not in the list. Each field can be added once per upsell. |
| **Label guests see** | The question that guests see.                                   | Optional. Up to 255 characters. When empty, guests see the name of the custom field, or *License plates*.                                       |
| **Mandatory**        | When on, guests must answer before they can pay for the upsell. | None                                                                                                                                            |

Drag a row to change the order in which guests see the fields. **License plates** can be added once per upsell.

What happens to the answers:

* The answers show under the request in the **Upsells (n)** section of the reservation.
* Guestway writes the answers when the upsell is paid and approved. License plates go to the primary guest, up to 10 plates. Other answers go to the reservation custom field.
* If Guestway cannot write an answer, for example because the custom field was deleted, it skips that answer and shows a warning in the inbox. The upsell itself is still applied.
* You cannot delete a custom field while an upsell that is not archived uses it.

## Readiness check

The alert at the top of the editor checks the setup:

| Check                  | Requirement                                                                                                     | If it fails                                                                                               |
| ---------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| **Billing account**    | A connected billing account that can be used.                                                                   | **Fix** opens **Settings** → **Billing**.                                                                 |
| PMS folio capabilities | Your PMS must support the sync of payments and charges to the folio, and the changes to check-in and check-out. | The check shows each PMS. If the PMS does not support it, the upsell is sold, but not written to the PMS. |
| **Guest journeys**     | Lists the journeys whose **Guest facing currency** does not match the upsell.                                   | **View** opens the journey. These journeys do not offer the upsell.                                       |

**Re-check** runs the check again. The alert shows **Upsell setup ready** when all checks pass.

## Requests on the reservation

The requests are in the **Upsells (n)** section of the reservation, in the Inbox (**Reservation** tab) and in [Reservations](https://docs.guestway.io/reservations-and-operations/reservations.md). The requests of one upsell are in one group. A badge shows how many requests are **to review**. For example, breakfast on three days is one group with three requests.

| Status                                           | Meaning                                                           |
| ------------------------------------------------ | ----------------------------------------------------------------- |
| **In basket**                                    | The guest added the upsell, but did not pay yet.                  |
| **Awaiting payment**                             | The guest is at the payment step.                                 |
| **Awaiting review**                              | The guest paid. The request waits for **Approve** or **Decline**. |
| **Purchased**                                    | Paid and confirmed.                                               |
| **Declined (refund)** / **Declined (no refund)** | Your team declined the request, with or without a refund.         |
| **Cancelled by guest**                           | The guest withdrew the request.                                   |
| **Reverted**                                     | The purchase was undone.                                          |

Each resolved request shows who approved or declined it, and when.

The calendar icon on the reservation shows **Upsell availabilities**: how many early check-ins and late check-outs are already booked on the arrival day and the departure day.

Each change also appears in the conversation as an activity item. See [Unified AI inbox](https://docs.guestway.io/inbox-and-messaging/unified-ai-inbox.md#upsell-activity).

## Stock of custom upsells

Stock is counted for each day. Where the stock comes from depends on the service template of the upsell.

* **Guestway service template:** the stock is the **Daily Supply Limit** of the service template, for each day. If the field is empty, there is no limit. Each service of the template on that day uses stock: services that guests bought, and services that your team or a rule added. Requests that the guest checked out, but that are not booked yet, also use stock. A request uses its quantity, times the number of guests when the price is per person. A guest cannot add more than the stock that is left. At checkout, Guestway checks the stock again. If the stock is not enough, the upsell is removed from the basket. Your team can still add more services by hand.
* **PMS service template:** Guestway asks your PMS for the stock. In the Guest Portal, a day without stock is not available. At checkout, Guestway asks the PMS again. If the stock is not enough, the upsell is removed from the basket. If the PMS does not answer, Guestway uses the stock from the last answer of the PMS, when it is at most 5 minutes old. Without that answer, the checkout continues.

An upsell for the whole stay needs stock on each day that the service is delivered.

## Related

* [How to set up an upsell](https://docs.guestway.io/guest-experience/upsells/how-to-set-up-an-upsell.md)
* [How to review upsell requests](https://docs.guestway.io/guest-experience/upsells/how-to-review-upsell-requests.md)
* [Service templates](https://docs.guestway.io/guest-experience/service-templates.md)
* [Custom fields](https://docs.guestway.io/properties/custom-fields.md)
* [Guest journey](https://docs.guestway.io/guest-experience/guest-journey.md)
* [Guest portal](https://docs.guestway.io/guest-experience/guest-portal.md)
* [Billing](https://docs.guestway.io/account-and-administration/billing.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.guestway.io/guest-experience/upsells.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
