Skip to main content

Rooms

The Rooms Query returns a comprehensive room list from a supplier's access, which may include translations to other languages. This call is primarily intended for Suppliers with a fixed room list. Keep in mind that many Suppliers work with dynamic rooms, where room details are generated on the fly during the search.

Thanks to FastX codes, every search response also includes the standardized FastX room code and description, ensuring a consistent experience across the Marketplace.

The returned fields of the rooms query include:

  • roomCode
  • source
  • occupancies
  • amenities
  • medias
  • views
  • beds

Query Overview​

When creating your rooms query, you have two different inputs to fill based on your specific needs:

  1. Criteria
  2. Token

1. Criteria​

This query offers versatility, with certain fields marked as mandatory (access) and others as optional (roomCodes). This flexibility empowers you to create a personalized Rooms Query, tailoring the requested fields to your specific needs. Consequently, the response will only include information that is highly relevant to you, streamlining the retrieval process and ensuring the data you receive meets your exact requirements.

{
	"criteria": {
		"access": "2",
		"maxSize": 5,
		"roomCodes": [
			"2269"
		]
	},
	"token": ""
}

Mandatory criteria

  • access

Optional criteria

  • roomCodes (Search by room type)
  • maxSize (Paginate response)

2. Token​

The Hotel-X API provides paginated responses to handle cases where the number of rooms from the selected provider exceeds 10000. The default response page contains a maximum of 500 rooms, but you can specify the number of objects returned per page using the maxSize field in the query criteria to retrieve between 1 and 10000 rooms.

To include the token in your request, all you need to do is:

  1. Add the token object to the fields and arguments. Moreover, you have the flexibility to specify the number of objects returned per page by utilizing the maxSize tag in your arguments.

  2. After receiving a response, you will only receive a portion of the full list. To access the next page, simply copy the token tag from the response and include it in your next request. This will allow you to obtain a new set of objects in the following response.

  3. Repeat these steps until the token is no longer included in the response, the query will return “Rooms not found”.

Query variables

First, in your rooms query you won't indicate any tokeninput:

{
    "criteria" : {
        "access" : "2",
        "maxSize" : 5
    },
    "token" : ""
}

You will obtain a response with 5 rooms per page:

Response

{
	"data": {
		"hotelX": {
			"rooms": {
				"token": "FGluY2x1ZGVfY29udGV4dF91dWlkDnF1ZXJ5FGhlbkZldGNoAhZMN2w2SlZYaVNaaXhYeXHwdm1GWjlBAAAAAATLRLQWeXZ3cU12MkpSbTY3WkF6QzJraWJWZxZFX3NZYkQ1UFN6fWFaQjlXMXBSbmhBAAAAABCavEoWWFltUDMwVXRUT0ctUWY5Y3FDX39vQQ=="
				"edges": [

This token should be used as input in your next rooms query, inside the token input:

{
    "criteria" : {
        "access" : "2",
        "maxSize" : 5
    },
    "token" : "FGluY2x1ZGVfY29udGV4dF91dWlkDnF1ZXJ5FGhlbkZldGNoAhZMN2w2SlZYaVNaaXhYeXHwdm1GWjlBAAAAAATLRLQWeXZ3cU12MkpSbTY3WkF6QzJraWJWZxZFX3NZYkQ1UFN6fWFaQjlXMXBSbmhBAAAAABCavEoWWFltUDMwVXRUT0ctUWY5Y3FDX39vQQ=="
}

Response Considerations​

note

The amount of information and content returned might vary between Sellers.

Hotel-X supports all languages, but receiving room descriptions in one or another depends entirely on the languages supported by the Seller.

Query Inputs​

HotelXRoomQueryInput (INPUT_OBJECT)

access  *  (ID)

Indicates the access that you want use.

roomCodes(String)

Indicates the room codes that you want filter.

maxSize(Int)

Maxium number of items per page

token (String)
A unique authentication token required for API requests.

Examples​

Search for the complete rooms list from a supplier​

Search for a specific room list from a supplier​

When utilizing the Rooms List Query, for more personalized results, filter specific rooms based on your interests. For example, to focus solely on the twin room inventory of a Seller, add the roomCodes field with "2269" (this is the code that this Seller has assigned for the "Double Standard" room) in your criteria. This will provide you with highly targeted and relevant information.