Metadata
The Metadata Query returns a clear and summarized view of the Seller's main characteristics, as well as the methods implemented through their integration and the limitations and restrictions associated with their connection. The returned fields include:
maxNumberHotels(Maximum number of hotels that can be requested)recommendedNumberHotels(Recommended number of hotels that can be requested)allowsCurrencyrelease(Minimum days required in between booking date and checking date, if the value is zero then there is no limitation)maxRelease(Maximum days required in between booking date and checking date)minimumStay(Minimum number of days required for booking, if the value is zero then there is no limitation)maxStay(Maximum number of days allowed for booking)maxNumberRoomCandidates(Maximum number of room candidates that can be requested in the same search request)paxTypeRangeInRoomCandidates(Contains information about the age restrictions of the guests in a room)maxPaxInRoomCandidates(Maximum number paxs in same room that can be requested in the same search request)maxPaxInAllRooms(Maximum number of sum of paxs that can be requested in the same search request)requiredRoomWithSamePaxConfiguration(Indicates whether all room must have the same configuration, same ages or same number of paxs)rateRulesageRange(The age range used by the supplier)languages
Travelgate API specifications will always prevail over the Seller's specifications. For instance, nationality should always be sent in SearchRQ even though it may be optional for some Sellers.
Since Metadata information may not be updated by our Sellers frequently (they update it whenever there is a major update on their APIs), we suggest you confirm directly with them whether the information is up to date.
Query Overview
When creating your metadata query, you have 1 input to fill based on your specific needs:
- Criteria
1. Criteria
This query has a single criteria, which is marked as mandatory (supplierCodes).
Mandatory criteria
supplierCodes
Query Inputs
HotelXMetadataQueryInput (INPUT_OBJECT)
supplierCodes (ID)
Indicates the supplier code
Indicates the supplier code
Returned Fields
MetadataConnection (OBJECT)
Metadata definition
Metadata definition
edges (MetadataEdge)
contains informations of each metadata requested
contains informations of each metadata requested
node (Metadata)
contain information of each metadata requested
contain information of each metadata requested
code * (ID)
Metadata supplier ID
Metadata supplier ID
metadataData (MetadataData)
Metadata data
Metadata data
supplierCode * (ID)
Requested supplier code
Requested supplier code
search * (MetadataSearch)
Search metadata
Search metadata
destinations * (MetadataSearchDestinations)
Contains information regarding the destinations
Contains information regarding the destinations
maxNumberHotels * (ReviewedInt)
Maximum number of hotels that can be requested.
Maximum number of hotels that can be requested.
reviewDate * (Date)
Last reviewed date
Last reviewed date
value * (Int)
recommendedNumberHotels * (undefined)
Recomended number of hotels.
Recomended number of hotels.
maxNumberCities * (undefined)
Maximum number of cities that can be requested.
Maximum number of cities that can be requested.
recommendedNumberCities * (undefined)
Recomended number of cities.
Recomended number of cities.
maxNumberZones * (undefined)
Maximum number of zones that can be requested.
Maximum number of zones that can be requested.
recommendedNumberZones * (undefined)
Recomended number of zones.
Recomended number of zones.
hotelSameDestinationRestriction * (ReviewedBool)
Required all hotels from same destination
Required all hotels from same destination
reviewDate * (Date)
Last reviewed date
Last reviewed date
value * (Boolean)
allowsCurrency * (undefined)
If true, it is possible to request the currency.
If true, it is possible to request the currency.
implementsCombination * (undefined)
Informs whether the integration allows room combination or not.
Informs whether the integration allows room combination or not.
numMarketsAllowed (undefined)
Number of markets supported by the supplier in the same request.
Number of markets supported by the supplier in the same request.
release * (undefined)
Minimum days required in between booking date and checking date ( days in advance ). If the value is zero then there is no limitation.
Minimum days required in between booking date and checking date ( days in advance ). If the value is zero then there is no limitation.
maxRelease (undefined)
Maximum days required in between booking date and checking date ( days in advance ).
Maximum days required in between booking date and checking date ( days in advance ).
minimumStay * (undefined)
Minimum number of days required for booking. If the value is zero then there is no limitation.
Minimum number of days required for booking. If the value is zero then there is no limitation.
maxStay * (undefined)
Maximum number of days allowed for booking.
Maximum number of days allowed for booking.
roomCandidates * (MetadataRoomCandidates)
Contains information about the restrictions of the rooms.
Contains information about the restrictions of the rooms.
maxNumberRoomCandidates * (undefined)
Maximum number of room candidates that can be requested in the same search request.
Maximum number of room candidates that can be requested in the same search request.
paxTypeRangeInRoomCandidates (ReviwedPaxTypeRangeInRoomCandidates)
Contains information about the age restrictions of the guests in a room.
Contains information about the age restrictions of the guests in a room.
reviewDate * (Date)
Last reviewed date
Last reviewed date
candidates * (MetadataCandidate)
Guest restrictions for each candidate type in a room.
Guest restrictions for each candidate type in a room.
min * (Int)
Minimum required number of guest of this type.
Minimum required number of guest of this type.
max * (Int)
Maximum number of guest of this type allowed.
Maximum number of guest of this type allowed.
type * (Enum of HotelPaxType)
Candidate classification type.(Adult, Child, Infant)
Possible values:
ADULT
CHILD
INFANT
Candidate classification type.(Adult, Child, Infant)
Possible values:
ADULTCHILDINFANTmaxPaxInRoomCandidates * (undefined)
Maximum number paxs in same room that can be requested in the same search request.
Maximum number paxs in same room that can be requested in the same search request.
maxPaxInAllRooms * (undefined)
Total amount of paxs that can be requested in the same search request.
Total amount of paxs that can be requested in the same search request.
requiredRoomWithSamePaxConfiguration * (RequiredRoomWithSamePaxConfiguration)
Indicates whether all of the distributions must have the same configuration.
Indicates whether all of the distributions must have the same configuration.
samePaxNumber * (undefined)
Indicates whether it is necessary that the number of guests be the same in all of the configurations.
Indicates whether it is necessary that the number of guests be the same in all of the configurations.
samePaxAge * (undefined)
Indicates whether all of the guests in a particular distribution must be the same age.
Indicates whether all of the guests in a particular distribution must be the same age.
rateRules * (ReviewedRateRule)
List of rate rule types supported by the supplie
List of rate rule types supported by the supplie
reviewDate * (Date)
Informs of the date when the field was last reviewed.
Informs of the date when the field was last reviewed.
value * (Enum of RateRulesType)
Possible values:
NORMAL
PACKAGE
OLDER55
OLDER60
OLDER65
CANARY_RESIDENT
BALEARIC_RESIDENT
LARGE_FAMILY
HONEYMOON
PUBLIC_SERVANT
UNEMPLOYED
NON_REFUNDABLE
MOBILE
WARRANTY
ESSENTIAL_WORKER
NEGOTIATED
CUSTOM
NORMALPACKAGEOLDER55OLDER60OLDER65CANARY_RESIDENTBALEARIC_RESIDENTLARGE_FAMILYHONEYMOONPUBLIC_SERVANTUNEMPLOYEDNON_REFUNDABLEMOBILEWARRANTYESSENTIAL_WORKERNEGOTIATEDCUSTOMbeds * (MetadataBeds)
Information about beds.
Information about beds.
informNumberOfUnits * (undefined)
Indicates the number of units available per room.
Indicates the number of units available per room.
informSharedBed * (undefined)
Informs in Search response if beds in the room are shared.
Informs in Search response if beds in the room are shared.
informBedType * (undefined)
Informs if the supplier returns the beds types.
Informs if the supplier returns the beds types.
informNumberOfBeds * (undefined)
Informs if the supplier returns the number of beds for each room.
Informs if the supplier returns the number of beds for each room.
ageRange * (ReviewedAgeRanges)
The age range used by the supplier.
The age range used by the supplier.
reviewDate * (Date)
Last reviewed date
Last reviewed date
ages * (AgeRange)
list of type of passenger with the age range
list of type of passenger with the age range
min * (Int)
min age allowed
min age allowed
max * (Int)
max age allowed
max age allowed
type * (undefined)
PaxType
PaxType
informBindingPrice * (undefined)
Supplier returns binding PVPs.
Supplier returns binding PVPs.
informCancelPolicies * (undefined)
Returns cancellation policies at search step
Returns cancellation policies at search step
informRoomCancelPolicies * (undefined)
Returns cancellation policies at room level.
Returns cancellation policies at room level.
timeZone * (ReviewedTimeZone)
Specifies the timezone in UTC in which the cancellation policies are located.
Specifies the timezone in UTC in which the cancellation policies are located.
reviewDate * (Date)
Last reviewed date
Last reviewed date
value * (Enum of TimeZoneType)
Possible values:
UNKNOWN
HOTEL_LOCAL_TIME
UTC_MINUS_12
UTC_MINUS_11
UTC_MINUS_10
UTC_MINUS_9
UTC_MINUS_8
UTC_MINUS_7
UTC_MINUS_6
UTC_MINUS_5
UTC_MINUS_4
UTC_MINUS_3
UTC_MINUS_2
UTC_MINUS_1
UTC_0
UTC_1
UTC_2
UTC_3
UTC_4
UTC_5
UTC_6
UTC_7
UTC_8
UTC_9
UTC_10
UTC_11
UTC_12
UTC_13
UTC_14
UNKNOWNHOTEL_LOCAL_TIMEUTC_MINUS_12UTC_MINUS_11UTC_MINUS_10UTC_MINUS_9UTC_MINUS_8UTC_MINUS_7UTC_MINUS_6UTC_MINUS_5UTC_MINUS_4UTC_MINUS_3UTC_MINUS_2UTC_MINUS_1UTC_0UTC_1UTC_2UTC_3UTC_4UTC_5UTC_6UTC_7UTC_8UTC_9UTC_10UTC_11UTC_12UTC_13UTC_14informRemarks * (undefined)
Space available for any remarks or comments aimed at the client.
Space available for any remarks or comments aimed at the client.
paymentTypes * (ReviewedPaymentType)
List of payment types accepted by the supplier with their reviewed date
List of payment types accepted by the supplier with their reviewed date
reviewDate * (Date)
Last reviewed date
Last reviewed date
value * (Enum of PaymentType)
Indicates the types of payment suppoted
Possible values:
MERCHANT
DIRECT
CARD_BOOKING
CARD_CHECK_IN
Indicates the types of payment suppoted
Possible values:
MERCHANTDIRECTCARD_BOOKINGCARD_CHECK_INlanguages * (ReviewedText)
List of languages supported
List of languages supported
reviewDate * (Date)
value * (String)
informDailyPrice * (undefined)
Informs if the supplier returns the daily price
Informs if the supplier returns the daily price
informDailyRatePlan * (undefined)
Informs if the supplier returns the daily rate.
Informs if the supplier returns the daily rate.
informPromotions * (undefined)
If true, the supplier returns the promotions(offers) applied.
If true, the supplier returns the promotions(offers) applied.
informNRFRateByRoom * (undefined)
The supplier can inform in Search if the room is non-refundable.
The supplier can inform in Search if the room is non-refundable.
informSurcharges * (undefined)
Informs if the supplier returns surcharges.
Informs if the supplier returns surcharges.
informRoomSurcharges * (undefined)
Returns surcharges at room level.
Returns surcharges at room level.
informHotelName * (undefined)
inform Hotel name at search step
inform Hotel name at search step
requiredNationality (undefined)
Informs if the supplier requires nationality
Informs if the supplier requires nationality
quote * (MetadataQuote)
Quote metadata
Quote metadata
informBindingPrice * (undefined)
Informs if the price is binding in Quote response.
Informs if the price is binding in Quote response.
informNRFRate * (undefined)
The supplier can inform in Quote if the rate is non-refundable.
The supplier can inform in Quote if the rate is non-refundable.
informRemarks * (undefined)
Returns remarks.
Returns remarks.
informCancelPolicies * (undefined)
Informs cancellation policies.
Informs cancellation policies.
informCancelPoliciesDescription * (undefined)
Specifies if the supplier informs the cancel policies in free text.
Specifies if the supplier informs the cancel policies in free text.
timeZone * (undefined)
Specifies if the supplier inform the cancel policies in free text
Specifies if the supplier inform the cancel policies in free text
informSurcharges * (undefined)
Informs if the supplier returns surcharges.
Informs if the supplier returns surcharges.
requiredNationality (undefined)
Informs if the supplier requires nationality
Informs if the supplier requires nationality
book * (MetadataBook)
Book metadata
Book metadata
allowsDeltaPrice * (undefined)
Allows a margin stipulated by the client for booking with a higher price (delta).
Allows a margin stipulated by the client for booking with a higher price (delta).
requiredAllPassengers * (undefined)
Required data for all passengers (names and surnames).
Required data for all passengers (names and surnames).
allowsRemarks * (undefined)
Informs if the supplier allows send remarks.
Informs if the supplier allows send remarks.
informBillingSupplier * (undefined)
Informs if the supplier billing code.
Informs if the supplier billing code.
informHotelReference * (undefined)
Informs if the supplier returns the hotel reference number.
Informs if the supplier returns the hotel reference number.
informPrice * (undefined)
The supplier informs the book price.
The supplier informs the book price.
requiredNationality (undefined)
Informs if the supplier requires nationality
Informs if the supplier requires nationality
booking * (MetadataBooking)
Booking metadata
Booking metadata
queryableBySupplierReference * (undefined)
Specifies if booking can be performed using supplier reference.
Specifies if booking can be performed using supplier reference.
queryableByClientReference * (undefined)
Specifies if booking can be performed using client reference.
Specifies if booking can be performed using client reference.
queryableByCreationDate * (undefined)
Specifies if booking can be performed using creation dates.
Specifies if booking can be performed using creation dates.
queryableByCheckinDate * (undefined)
Specifies if booking can be performed using check in dates.
Specifies if booking can be performed using check in dates.
informHotelReference (undefined)
Specifies if the supplier informs about Hotel Confirmation Number (HCN).
Specifies if the supplier informs about Hotel Confirmation Number (HCN).
informCancelPolicies (undefined)
Specifies if the supplier informs about the cancellation policies.
Specifies if the supplier informs about the cancellation policies.
informPriceCancel (undefined)
Specifies if the supplier informs about the cancellation price.
Specifies if the supplier informs about the cancellation price.
requiresCheckInDateInReferences * (undefined)
Specifies if the supplier requires check-in date in reference.
Specifies if the supplier requires check-in date in reference.
requiresCheckOutDateInReferences * (undefined)
Specifies if the supplier requires check-out date in reference.
Specifies if the supplier requires check-out date in reference.
requiresReservationDateInReferences * (undefined)
Specifies if the supplier requires the reservation date in reference.
Specifies if the supplier requires the reservation date in reference.
timeZone * (undefined)
Specifies the timezone in UTC in which the cancellation policies are located.
Specifies the timezone in UTC in which the cancellation policies are located.
cancel * (MetadataCancel)
Cancel metadata
Cancel metadata
mutableBySupplierReference * (undefined)
The supplier allows cancellation with supplier reference.
The supplier allows cancellation with supplier reference.
mutableByClientReference * (undefined)
The supplier allows cancellation with client reference.
The supplier allows cancellation with client reference.
informPriceCancel (undefined)
The supplier informs the cancellation price.
The supplier informs the cancellation price.
amendBoard (MetadataAmendBoard)
Amend Board metadata
Amend Board metadata
allowsAmendBoard * (undefined)
amendDates (MetadataAmendDates)
Amend Dates metadata
Amend Dates metadata
allowsAmendCheckIn * (undefined)
allowsAmendCheckOut * (undefined)
amendPaxes (MetadataAmendPaxes)
Amend Paxes metadata
Amend Paxes metadata
allowsDeletePaxes * (undefined)
allowsAmendAge * (undefined)
allowsAddPaxes * (undefined)
allowsAmendPersonalTitle * (undefined)
allowsAmendName * (undefined)
allowsAmendSurname * (undefined)
amendRemarks (MetadataAmendRemarks)
Amend Remarks metadata
Amend Remarks metadata
allowsAmendRemarks * (undefined)
amendRooms (MetadataAmendRooms)
Amend Rooms metadata
Amend Rooms metadata
implementsAmendRoom * (undefined)
requireSameGuestsInAllOccupancies (undefined)
requireSameRooms (undefined)
allowsAddRooms (undefined)
allowsDeleteRooms (undefined)
allowsAmendSurname (undefined)
hotels (MetadataContent)
Contains information regarding Hotels, Hotels returns a list of hotels all information available (code, name,
address, phone, etc.) for each hotel. Return null is not implemented
Contains information regarding Hotels, Hotels returns a list of hotels all information available (code, name, address, phone, etc.) for each hotel. Return null is not implemented
implemented * (undefined)
languages * (undefined)
destinations (undefined)
Contains information regarding Destinations, Destinations returns the supplier s destination list.
Return null is not implemented
Contains information regarding Destinations, Destinations returns the supplier s destination list. Return null is not implemented
rooms (undefined)
Contains information regarding Rooms, RoomList aims to return a list of rooms, their codes as well as descriptions.
Return null is not implemented
Contains information regarding Rooms, RoomList aims to return a list of rooms, their codes as well as descriptions. Return null is not implemented
boards (undefined)
Contains information regarding Boards, Boards aims to return a list of the search boards,
which will be used in the Search response. Return null is not implemented
Contains information regarding Boards, Boards aims to return a list of the search boards, which will be used in the Search response. Return null is not implemented
categories (undefined)
Contains information regarding Categories, Categories returns a list of categories (codes and descriptions)
used in Hotels List. Return null is not implemented
Contains information regarding Categories, Categories returns a list of categories (codes and descriptions) used in Hotels List. Return null is not implemented
markets (undefined)
Contains information regarding Markets, Markets return a list of the available Markets, which will be
used in the Search request. Return null is not implemented
Contains information regarding Markets, Markets return a list of the available Markets, which will be used in the Search request. Return null is not implemented
currencies (undefined)
Contains information regarding Currencies, Currencies returns a list of currencies the supplier in booking flow.
Return null is not implemented
Contains information regarding Currencies, Currencies returns a list of currencies the supplier in booking flow. Return null is not implemented
amenities (undefined)
Contains information regarding Amenities, Amenities is defined as something intended to make life more
pleasant or comfortable for people, Examples include: swimming pools, shopping centers, etc.
Return null is not implemented
Contains information regarding Amenities, Amenities is defined as something intended to make life more pleasant or comfortable for people, Examples include: swimming pools, shopping centers, etc. Return null is not implemented
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)
cursor to the next item, used for pagination
cursor to the next item, used for pagination
adviseMessage (undefined)
List of messages, contain error message, such as invalid input, connection error
List of messages, contain error message, such as invalid input, connection error