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
Returned Fields
MetadataConnection (OBJECT)
Metadata definition
Metadata definition
edges(MetadataEdge)
contains informations of each metadata requested contain information of each metadata requested code * (ID) Metadata supplier ID Metadata data supplierCode * (ID) Requested supplier code search * (MetadataSearch) Search metadata destinations * (MetadataSearchDestinations) Contains information regarding the destinations maxNumberHotels * (ReviewedInt) Maximum number of hotels that can be requested. reviewDate * (Date) Last reviewed date value * (Int) recommendedNumberHotels * (ReviewedInt) Recomended number of hotels. reviewDate * (Date) Last reviewed date value * (Int) maxNumberCities * (ReviewedInt) Maximum number of cities that can be requested. reviewDate * (Date) Last reviewed date value * (Int) recommendedNumberCities * (ReviewedInt) Recomended number of cities. reviewDate * (Date) Last reviewed date value * (Int) maxNumberZones * (ReviewedInt) Maximum number of zones that can be requested. reviewDate * (Date) Last reviewed date value * (Int) recommendedNumberZones * (ReviewedInt) Recomended number of zones. reviewDate * (Date) Last reviewed date value * (Int) hotelSameDestinationRestriction * (ReviewedBool) Required all hotels from same destination reviewDate * (Date) Last reviewed date value * (Boolean) allowsCurrency * (ReviewedBool) If true, it is possible to request the currency. reviewDate * (Date) Last reviewed date value * (Boolean) implementsCombination * (ReviewedBool) Informs whether the integration allows room combination or not. reviewDate * (Date) Last reviewed date value * (Boolean) Number of markets supported by the supplier in the same request. reviewDate * (Date) Last reviewed date value * (Int) release * (ReviewedInt) Minimum days required in between booking date and checking date ( days in advance ). If the value is zero then there is no limitation. reviewDate * (Date) Last reviewed date value * (Int) Maximum days required in between booking date and checking date ( days in advance ). reviewDate * (Date) Last reviewed date value * (Int) minimumStay * (ReviewedInt) Minimum number of days required for booking. If the value is zero then there is no limitation. reviewDate * (Date) Last reviewed date value * (Int) maxStay * (ReviewedInt) Maximum number of days allowed for booking. reviewDate * (Date) Last reviewed date value * (Int) roomCandidates * (MetadataRoomCandidates) Contains information about the restrictions of the rooms. maxNumberRoomCandidates * (ReviewedInt) Maximum number of room candidates that can be requested in the same search request. reviewDate * (Date) Last reviewed date value * (Int) Contains information about the age restrictions of the guests in a room. reviewDate * (Date) Last reviewed date candidates * (MetadataCandidate) Guest restrictions for each candidate type in a room. min * (Int) Minimum required number of guest of this type. max * (Int) Maximum number of guest of this type allowed. type * (HotelPaxType) Candidate classification type.(Adult, Child, Infant)
Possible values: maxPaxInRoomCandidates * (ReviewedInt) Maximum number paxs in same room that can be requested in the same search request. reviewDate * (Date) Last reviewed date value * (Int) maxPaxInAllRooms * (ReviewedInt) Total amount of paxs that can be requested in the same search request. reviewDate * (Date) Last reviewed date value * (Int) requiredRoomWithSamePaxConfiguration * (RequiredRoomWithSamePaxConfiguration) Indicates whether all of the distributions must have the same configuration. samePaxNumber * (ReviewedBool) Indicates whether it is necessary that the number of guests be the same in all of the configurations. reviewDate * (Date) Last reviewed date value * (Boolean) samePaxAge * (ReviewedBool) Indicates whether all of the guests in a particular distribution must be the same age. reviewDate * (Date) Last reviewed date value * (Boolean) rateRules * (ReviewedRateRule) List of rate rule types supported by the supplie reviewDate * (Date) Informs of the date when the field was last reviewed. value * (RateRulesType) beds * (MetadataBeds) Information about beds. informNumberOfUnits * (ReviewedBool) Indicates the number of units available per room. reviewDate * (Date) Last reviewed date value * (Boolean) informSharedBed * (ReviewedBool) Informs in Search response if beds in the room are shared. reviewDate * (Date) Last reviewed date value * (Boolean) informBedType * (ReviewedBool) Informs if the supplier returns the beds types. reviewDate * (Date) Last reviewed date value * (Boolean) informNumberOfBeds * (ReviewedBool) Informs if the supplier returns the number of beds for each room. reviewDate * (Date) Last reviewed date value * (Boolean) ageRange * (ReviewedAgeRanges) The age range used by the supplier. reviewDate * (Date) Last reviewed date ages * (AgeRange) list of type of passenger with the age range min * (Int) min age allowed max * (Int) max age allowed type * (HotelPaxType) PaxType
Possible values: informBindingPrice * (ReviewedBool) Supplier returns binding PVPs. reviewDate * (Date) Last reviewed date value * (Boolean) informCancelPolicies * (ReviewedBool) Returns cancellation policies at search step reviewDate * (Date) Last reviewed date value * (Boolean) informRoomCancelPolicies * (ReviewedBool) Returns cancellation policies at room level. reviewDate * (Date) Last reviewed date value * (Boolean) timeZone * (ReviewedTimeZone) Specifies the timezone in UTC in which the cancellation policies are located. reviewDate * (Date) Last reviewed date value * (TimeZoneType) informRemarks * (ReviewedBool) Space available for any remarks or comments aimed at the client. reviewDate * (Date) Last reviewed date value * (Boolean) paymentTypes * (ReviewedPaymentType) List of payment types accepted by the supplier with their reviewed date reviewDate * (Date) Last reviewed date value * (PaymentType) Indicates the types of payment suppoted
Possible values: languages * (ReviewedText) List of languages supported reviewDate * (Date) value * (String) informDailyPrice * (ReviewedBool) Informs if the supplier returns the daily price reviewDate * (Date) Last reviewed date value * (Boolean) informDailyRatePlan * (ReviewedBool) Informs if the supplier returns the daily rate. reviewDate * (Date) Last reviewed date value * (Boolean) informPromotions * (ReviewedBool) If true, the supplier returns the promotions(offers) applied. reviewDate * (Date) Last reviewed date value * (Boolean) informNRFRateByRoom * (ReviewedBool) The supplier can inform in Search if the room is non-refundable. reviewDate * (Date) Last reviewed date value * (Boolean) informSurcharges * (ReviewedBool) Informs if the supplier returns surcharges. reviewDate * (Date) Last reviewed date value * (Boolean) informRoomSurcharges * (ReviewedBool) Returns surcharges at room level. reviewDate * (Date) Last reviewed date value * (Boolean) informHotelName * (ReviewedBool) inform Hotel name at search step reviewDate * (Date) Last reviewed date value * (Boolean) Informs if the supplier requires nationality reviewDate * (Date) Last reviewed date value * (Boolean) quote * (MetadataQuote) Quote metadata informBindingPrice * (ReviewedBool) Informs if the price is binding in Quote response. reviewDate * (Date) Last reviewed date value * (Boolean) informNRFRate * (ReviewedBool) The supplier can inform in Quote if the rate is non-refundable. reviewDate * (Date) Last reviewed date value * (Boolean) informRemarks * (ReviewedBool) Returns remarks. reviewDate * (Date) Last reviewed date value * (Boolean) informCancelPolicies * (ReviewedBool) Informs cancellation policies. reviewDate * (Date) Last reviewed date value * (Boolean) informCancelPoliciesDescription * (ReviewedBool) Specifies if the supplier informs the cancel policies in free text. reviewDate * (Date) Last reviewed date value * (Boolean) timeZone * (ReviewedTimeZone) Specifies if the supplier inform the cancel policies in free text reviewDate * (Date) Last reviewed date value * (TimeZoneType) informSurcharges * (ReviewedBool) Informs if the supplier returns surcharges. reviewDate * (Date) Last reviewed date value * (Boolean) Informs if the supplier requires nationality reviewDate * (Date) Last reviewed date value * (Boolean) book * (MetadataBook) Book metadata allowsDeltaPrice * (ReviewedBool) Allows a margin stipulated by the client for booking with a higher price (delta). reviewDate * (Date) Last reviewed date value * (Boolean) requiredAllPassengers * (ReviewedBool) Required data for all passengers (names and surnames). reviewDate * (Date) Last reviewed date value * (Boolean) allowsRemarks * (ReviewedBool) Informs if the supplier allows send remarks. reviewDate * (Date) Last reviewed date value * (Boolean) informBillingSupplier * (ReviewedBool) Informs if the supplier billing code. reviewDate * (Date) Last reviewed date value * (Boolean) informHotelReference * (ReviewedBool) Informs if the supplier returns the hotel reference number. reviewDate * (Date) Last reviewed date value * (Boolean) informPrice * (ReviewedBool) The supplier informs the book price. reviewDate * (Date) Last reviewed date value * (Boolean) Informs if the supplier requires nationality reviewDate * (Date) Last reviewed date value * (Boolean) booking * (MetadataBooking) Booking metadata queryableBySupplierReference * (ReviewedBool) Specifies if booking can be performed using supplier reference. reviewDate * (Date) Last reviewed date value * (Boolean) queryableByClientReference * (ReviewedBool) Specifies if booking can be performed using client reference. reviewDate * (Date) Last reviewed date value * (Boolean) queryableByCreationDate * (ReviewedBool) Specifies if booking can be performed using creation dates. reviewDate * (Date) Last reviewed date value * (Boolean) queryableByCheckinDate * (ReviewedBool) Specifies if booking can be performed using check in dates. reviewDate * (Date) Last reviewed date value * (Boolean) Specifies if the supplier informs about Hotel Confirmation Number (HCN). reviewDate * (Date) Last reviewed date value * (Boolean) Specifies if the supplier informs about the cancellation policies. reviewDate * (Date) Last reviewed date value * (Boolean) Specifies if the supplier informs about the cancellation price. reviewDate * (Date) Last reviewed date value * (Boolean) requiresCheckInDateInReferences * (ReviewedBool) Specifies if the supplier requires check-in date in reference. reviewDate * (Date) Last reviewed date value * (Boolean) requiresCheckOutDateInReferences * (ReviewedBool) Specifies if the supplier requires check-out date in reference. reviewDate * (Date) Last reviewed date value * (Boolean) requiresReservationDateInReferences * (ReviewedBool) Specifies if the supplier requires the reservation date in reference. reviewDate * (Date) Last reviewed date value * (Boolean) timeZone * (ReviewedTimeZone) Specifies the timezone in UTC in which the cancellation policies are located. reviewDate * (Date) Last reviewed date value * (TimeZoneType) cancel * (MetadataCancel) Cancel metadata mutableBySupplierReference * (ReviewedBool) The supplier allows cancellation with supplier reference. reviewDate * (Date) Last reviewed date value * (Boolean) mutableByClientReference * (ReviewedBool) The supplier allows cancellation with client reference. reviewDate * (Date) Last reviewed date value * (Boolean) The supplier informs the cancellation price. reviewDate * (Date) Last reviewed date value * (Boolean) Amend Board metadata allowsAmendBoard * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) Amend Dates metadata allowsAmendCheckIn * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) allowsAmendCheckOut * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) Amend Paxes metadata allowsDeletePaxes * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) allowsAmendAge * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) allowsAddPaxes * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) allowsAmendPersonalTitle * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) allowsAmendName * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) allowsAmendSurname * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) Amend Remarks metadata allowsAmendRemarks * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) Amend Rooms metadata implementsAmendRoom * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) reviewDate * (Date) Last reviewed date value * (Boolean) reviewDate * (Date) Last reviewed date value * (Boolean) reviewDate * (Date) Last reviewed date value * (Boolean) reviewDate * (Date) Last reviewed date value * (Boolean) reviewDate * (Date) Last reviewed date value * (Boolean) 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 * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) languages * (ReviewedText) reviewDate * (Date) value * (String) Contains information regarding Destinations, Destinations returns the supplier s destination list.
Return null is not implemented implemented * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) languages * (ReviewedText) reviewDate * (Date) value * (String) Contains information regarding Rooms, RoomList aims to return a list of rooms, their codes as well as descriptions.
Return null is not implemented implemented * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) languages * (ReviewedText) reviewDate * (Date) value * (String) 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 implemented * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) languages * (ReviewedText) reviewDate * (Date) value * (String) Contains information regarding Categories, Categories returns a list of categories (codes and descriptions)
used in Hotels List. Return null is not implemented implemented * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) languages * (ReviewedText) reviewDate * (Date) value * (String) 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 implemented * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) languages * (ReviewedText) reviewDate * (Date) value * (String) Contains information regarding Currencies, Currencies returns a list of currencies the supplier in booking flow.
Return null is not implemented implemented * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) languages * (ReviewedText) reviewDate * (Date) value * (String) 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 implemented * (ReviewedBool) reviewDate * (Date) Last reviewed date value * (Boolean) languages * (ReviewedText) reviewDate * (Date) value * (String) 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: Specify the external message. 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) cursor to the next item, used for paginationnode(Metadata)
metadataData(MetadataData)
numMarketsAllowed(ReviewedInt)
maxRelease(ReviewedInt)
paxTypeRangeInRoomCandidates(ReviwedPaxTypeRangeInRoomCandidates)
ADULTCHILDINFANTNORMAL: NORMAL Used in the RateRulesFilterInput input for the search query to filter and retrieve only options without rate rules.PACKAGE: The product can't be sold separately from another product attached to it, such as a flight.OLDER55: OLDER55 can only be sold to people who are 55 and older.OLDER60: OLDER60 can only be sold to people who are 60 and older.OLDER65: OLDER65 can only be sold to people who are 65 and older.CANARY_RESIDENT: CANARY_RESIDENT is applicable to Canary Islands residents only.BALEARIC_RESIDENT: BALEARIC_RESIDENT is applicable to Balearic Islands residents only.LARGE_FAMILY: LARGE_FAMILY is applicable to large families and is determined by each supplier.HONEYMOON: HONEYMOON is applicable to those who just got married and is determined by each supplier.PUBLIC_SERVANT: PUBLIC_SERVANT is applicable to public servants only.UNEMPLOYED: UNEMPLOYED applies to individuals who are without work.NON_REFUNDABLE: NON_REFUNDABLE is applicable to non refundable options.MOBILE: MOBILE are special rates confirmed by mobile phone.WARRANTY: WARRANTY is applicable to options with cancellation warranty.ESSENTIAL_WORKER: ESSENTIAL_WORKER are special hotel rates for essential workers.NEGOTIATED: NEGOTIATED are special rates offered only to specific buyers.CUSTOM: CUSTOM defines other rates.ADULTCHILDINFANTUNKNOWNHOTEL_LOCAL_TIMEUTC_MINUS_12: UTC-12UTC_MINUS_11: UTC-11UTC_MINUS_10: UTC-10UTC_MINUS_9: UTC-9UTC_MINUS_8: UTC-8UTC_MINUS_7: UTC-7UTC_MINUS_6: UTC-6UTC_MINUS_5: UTC-5UTC_MINUS_4: UTC-4UTC_MINUS_3: UTC-3UTC_MINUS_2: UTC-2UTC_MINUS_1: UTC-1UTC_0: UTC+0UTC_1: UTC+1UTC_2: UTC+2UTC_3: UTC+3UTC_4: UTC+4UTC_5: UTC+5UTC_6: UTC+6UTC_7: UTC+7UTC_8: UTC+8UTC_9: UTC+9UTC_10: UTC+10UTC_11: UTC+11UTC_12: UTC+12UTC_13: UTC+13UTC_14: UTC+14MERCHANT: Payment is managed by the supplier.DIRECT: Payment is made directly to the actual payee (e.g., the hotel), without involving an intermediary or third party. The payment will be completed at check-in.CARD_BOOKING: Payment is managed by the supplier. The payment is effectuated at the time of booking.CARD_CHECK_IN: Payment is managed by the supplier and is made at the hotel during check-in.requiredNationality(ReviewedBool)
UNKNOWNHOTEL_LOCAL_TIMEUTC_MINUS_12: UTC-12UTC_MINUS_11: UTC-11UTC_MINUS_10: UTC-10UTC_MINUS_9: UTC-9UTC_MINUS_8: UTC-8UTC_MINUS_7: UTC-7UTC_MINUS_6: UTC-6UTC_MINUS_5: UTC-5UTC_MINUS_4: UTC-4UTC_MINUS_3: UTC-3UTC_MINUS_2: UTC-2UTC_MINUS_1: UTC-1UTC_0: UTC+0UTC_1: UTC+1UTC_2: UTC+2UTC_3: UTC+3UTC_4: UTC+4UTC_5: UTC+5UTC_6: UTC+6UTC_7: UTC+7UTC_8: UTC+8UTC_9: UTC+9UTC_10: UTC+10UTC_11: UTC+11UTC_12: UTC+12UTC_13: UTC+13UTC_14: UTC+14requiredNationality(ReviewedBool)
requiredNationality(ReviewedBool)
informHotelReference(ReviewedBool)
informCancelPolicies(ReviewedBool)
informPriceCancel(ReviewedBool)
UNKNOWNHOTEL_LOCAL_TIMEUTC_MINUS_12: UTC-12UTC_MINUS_11: UTC-11UTC_MINUS_10: UTC-10UTC_MINUS_9: UTC-9UTC_MINUS_8: UTC-8UTC_MINUS_7: UTC-7UTC_MINUS_6: UTC-6UTC_MINUS_5: UTC-5UTC_MINUS_4: UTC-4UTC_MINUS_3: UTC-3UTC_MINUS_2: UTC-2UTC_MINUS_1: UTC-1UTC_0: UTC+0UTC_1: UTC+1UTC_2: UTC+2UTC_3: UTC+3UTC_4: UTC+4UTC_5: UTC+5UTC_6: UTC+6UTC_7: UTC+7UTC_8: UTC+8UTC_9: UTC+9UTC_10: UTC+10UTC_11: UTC+11UTC_12: UTC+12UTC_13: UTC+13UTC_14: UTC+14informPriceCancel(ReviewedBool)
amendBoard(MetadataAmendBoard)
amendDates(MetadataAmendDates)
amendPaxes(MetadataAmendPaxes)
amendRemarks(MetadataAmendRemarks)
amendRooms(MetadataAmendRooms)
requireSameGuestsInAllOccupancies(ReviewedBool)
requireSameRooms(ReviewedBool)
allowsAddRooms(ReviewedBool)
allowsDeleteRooms(ReviewedBool)
allowsAmendSurname(ReviewedBool)
hotels(MetadataContent)
destinations(MetadataContent)
rooms(MetadataContent)
boards(MetadataContent)
categories(MetadataContent)
markets(MetadataContent)
currencies(MetadataContent)
amenities(MetadataContent)
adviseMessage(AdviseMessage)
WARN: Warning message.ERROR: Error message.INFO: Info message.external(ExternalMessage)
code(String)
adviseMessage(AdviseMessage)
List of messages, contain error message, such as invalid input, connection error 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: Specify the external message. External code. message * (String) External message. correlationID * (ID) Identifier to investigate the cause of the error.WARN: Warning message.ERROR: Error message.INFO: Info message.external(ExternalMessage)
code(String)