Skip to main content

Categories

The Categories Query returns a comprehensive hotel categories list from a supplier's access that may include translations to other languages, granting you access to all the categories configured by the Seller for a given set of credentials. The returned fields include:

  • categoryCode
  • text
  • language

Query Overview​

When creating your categories query, you have 1 input to fill based on your specific needs:

  1. Criteria

1. Criteria​

This query offers versatility, with certain fields marked as mandatory (access) and others as optional (categoryCodes and group). This flexibility empowers you to create a personalized Categories 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

  • categoryCodes (Search by category type)
  • group

Response Considerations​

note

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

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

Query Inputs​

HotelXCategoryQueryInput (INPUT_OBJECT)

categoryCodes(String)

Indicates the category codes that you want filter.

access(ID)

Indicates the access that you want use.

group(ID)

Indicates the group that you want to search categories.

Returned Fields​

CategoryConnection (OBJECT)
CategoryList definition

edges(CategoryEdge)
node(Category)

code  *  (ID)

Category ID

categoryData(CategoryData)

Category data

code  *  (ID)

Internal code for checking availability

categoryCode  *  (String)

Code of the hotel based on the Supplier selected

texts(Text)

Label

text  *  (String)

language  *  (Language)

adviseMessage(AdviseMessage)

List of messages

code  *  (ID)

AM code: The following codes can be returned:

description  *  (String)

Error description

level  *  (AdviseMessageLevel)

Indicates the level of importance of the message. Possible values: ERROR, WARN, INFO. Possible values:

  • WARN: Warning message.
  • ERROR: Error message.
  • INFO: Info message.
external(ExternalMessage)

Specify the external message.

code(String)

External code.

message  *  (String)

External message.

correlationID  *  (ID)

Identifier to investigate the cause of the error.

createdAt  *  (DateTime)

Date created

updatedAt  *  (DateTime)

Date updated

cursor  *  (String)

Examples​

Search for the complete categories list from a supplier​

Search for a specific category code from a supplier​

When utilizing the Categories List Query, for more personalized results, filter specific categories based on your interests. For example, to focus solely on the 4* (four stars) inventory of a Seller, add the categoryCodes field with "4" and "5" (these are the codes that this Seller has assigned for the 4* categories) in your criteria. This will provider you with highly targeted and relevant information.