Boards
The Boards Query returns a comprehensive boards list from a supplier's access that may include translations to other languages, granting you access to all the boards configured by the Seller for a given set of credentials. The returned fields include:
boardCodetextlanguage
Query Overview
When creating your boards query, you have 1 input to fill based on your specific needs:
- Criteria
1. Criteria
This query offers versatility, with certain fields marked as mandatory (access) and others as optional (boardCodes and group). This flexibility empowers you to create a personalized Boards 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.
Mandatory criteria
access
Optional criteria
boardCodes(Search by board type)group
Response Considerations
The amount of information and content returned might vary between Sellers.
Hotel-X supports all languages, but receiving board descriptions in one or another depends entirely on the languages supported by the Seller.
Mapping
When utilizing the Boards List Query, you will receive the Seller's native boards codes. Connecting with a new Seller doesn't always mean that you are interested in the whole board's portfolio, maybe you are just interested in some specific boards. Since mapping depends entirely on your side, you can map only those boards you are interested in.
Additionally, you can upload your own mapping files to our FTP (credentials should be provided by our Customer Care team), and we will use your own boards codes in the booking flow.
You can find all the necessary information in the mapping section.
Query Inputs
HotelXBoardQueryInput (INPUT_OBJECT)
boardCodes * (String)
Indicates the board codes that you want filter.
Indicates the board codes that you want filter.
access * (ID)
Indicates the access that you want use.
Indicates the access that you want use.
Returned Fields
BoardConnection (OBJECT)
BoardList definition
BoardList definition
edges (BoardEdge)
node (Board)
code * (ID)
Board ID
Board ID
boardData (BoardData)
Board data
Board data
code * (ID)
Internal code for checking availability
Internal code for checking availability
boardCode * (String)
Code of the hotel in the Supplier selected
Code of the hotel in the Supplier selected
texts * (Text)
Label
Label
text * (String)
language * (Language)
adviseMessage * (AdviseMessage)
List of messages
List of messages
code * (ID)
AM code: The following codes can be returned:
AM code: The following codes can be returned:
description * (String)
Error description
Error description
level * (Enum of AdviseMessageLevel)
Indicates the level of importance of the message.
Possible values: ERROR, WARN, INFO.
Possible values:
WARN
ERROR
INFO
Indicates the level of importance of the message. Possible values: ERROR, WARN, INFO.
Possible values:
WARNERRORINFOexternal (ExternalMessage)
Specify the external message.
Specify the external message.
code (String)
External code.
External code.
message * (String)
External message.
External message.
correlationID * (ID)
Identifier to investigate the cause of the error.
Identifier to investigate the cause of the error.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (PageInfo)
Indicates info about page
Indicates info about page
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
Examples
Search for the complete board list from a supplier
Search for a specific board list from a supplier
When utilizing the Boards List Query, for more personalized results, filter specific boards based on your interests. For example, to focus solely on the half board inventory of a Seller, add the boardCodes field with "2" and "256" (these are the codes this Seller has assigned for the half board from their side) in your criteria. This can provide you with highly targeted and relevant information.