Skip to main content

Hotel-X Settings

In all booking flow and booking management requests, you'll find certain fields that you need to fill in. These include the HotelSettingsInput and criteria inputs. These fields contain various elements, some of which are known as settings. These settings are the common configurations used to construct your requests to the supplier/s. They consist of fields that are frequently needed, like language, currency, and timeout.

You have the flexibility to fill in these settings with different values for each of your query and mutation requests. However, to make things easier, you can also choose not to fill them in every time, especially if you know the values will remain the same. In such cases, we have default settings. These default settings are the values we'll use in the background if you don't specify the fields that are part of these settings.

Remember!

When you begin using TravelgateX, these settings are automatically created, but it's essential to review and update them according to your preferences in our API Settings website section.

Settings fields​

We'll clarify which fields are categorized as settings and where you can locate them. We'll also specify whether it's mandatory to provide a value for each field or if you have the option to leave it empty, in which case the default settings will be applied:

FieldMandatory / OptionalWhere to Fill It
clientMandatoryQuery (Settings input)
contextMandatoryQuery (Settings input) or Default Settings will be used
timeoutMandatoryQuery (Settings input) or Default Settings will be used
businessRulesMandatoryQuery (Settings input) or Default Settings will be used
languageMandatoryQuery (Criteria input) or Default Settings will be used
currencyMandatoryQuery (Criteria input) or Default Settings will be used
nationalityMandatoryQuery (Criteria input) or Default Settings will be used
marketsMandatoryQuery (Criteria input) or Default Settings will be used
optionsQuotaOptionalQuery (Criteria input), default settings or 50 will be used as value. This sets the maximum number of options returned per board in a search. If not specified in the query, the system will use the value from your Hotel-X API default settings. If no value is set there, the system will default to 50 options.

Default settings levels​

Understanding the various levels at which default settings can be applied is crucial for tailoring your configurations precisely to your needs:

  1. Organization/Group Level: Settings at this level apply to the entire organization or Hotel-X group. You can adjust these organization or group settings at the API Settings section on our website.

Hotel-X groups refer to a group of clients to which you can apply different business rules. By default, as a Buyer, you only have one Hotel-X group. You don’t need to worry about having more than one unless you have very specific business needs. If you do, please contact our Customer Care team.

  1. Client Level: Settings at this level are specific to individual clients. This means that default settings set for a particular client will only affect that client. You can manage these settings within the "Clients Settings" section of the API Settings on our website.

  2. Supplier Level: These settings are tailored to specific suppliers. Default settings set for a particular supplier will impact all accesses associated with that supplier. If you want to configure default settings at this level, please reach out to our Customer Care team.

  3. Access Level: Settings set at this level apply to a specific access. This implies that they will only affect that access. These settings take precedence over settings at the organization/group, client, and supplier levels. If you want to configure default settings at this level, please reach out to our Customer Care team.

  4. Query/Mutation Level: These settings are those you, as a Buyer, specify in your query or mutation. Regardless of the default settings configured at other levels, these settings take precedence and will override them.