Cancel
The cancel operation allows you to cancel a booking made via Travelgate. The returned fields include:
statusreferencepriceholderhotelroomsrates
Mutation Overview
When creating your cancel query, you have two different inputs to fill based on your specific needs:
- Criteria
- Settings
mutation {
hotelX {
cancel
criteria: {}
settings: {}
}
}
1. Input
This mutation offers versatility in cancellation, with all fields marked as optional (accessCode, language, hotelCode etc.). You can decide between the two options for cancellation, either by reference or by bookingID, empowering you with the choice that suits you best.
To specify your cancel input you need to use the input HotelCancelInput in your mutation variables.
If you decide to cancel using only the bookingID from the booking response, here's how you should structure your input:
{
"input" : {
"bookingID" : "1@1[241028[241029[230918[1[es[EUR[2[test_0123456789[2596391"
}
}
On the other hand, if you prefer to cancel using the accessCode, hotelCode, and reference from the booking response, here's the format you should follow:
{
"input" : {
"accessCode" : "2",
"hotelCode" : "1",
"reference" : {
"supplier" : "2596391"
}
}
}
Optional criteria
referencebookingIDaccessCodelanguagehotelCode
While not all criteria are required, you'll need to do one of two things to cancel a reservation: either use the bookingID from the booking response, or provide all the other criteria, including accessCode, hotel, and reference. This ensures a successful cancellation of the reservation.
2. Settings
Settings are the common configurations used to construct requests to the supplier/s. By default, we apply the same configuration to all Hotel-X clients.
To specify your cancel settings you need to use the HotelSettingsInput input in your mutation variables:
{
"settings": {
"client": "client_demo",
"context": "HOTELTEST",
"testMode": true,
"auditTransactions": false,
"timeout": 60000
}
}
Mandatory Settings:
clientcontexttimeout(Timeout in milliseconds for all supplier connections. Won't close client connection if exceeded.)
Optional Settings:
groupauditTransactionssuppliers(Each one contains its own code, settings and accesses)pluginstestMode(This flag allows only the accesses checked as test)clientTokens(Used to identify the origin of the request, this is only used in plugins)commitRequired(Indicates if the book will be confirmed in 1 or 2 steps. It only should be used in Book)businessRules
Keep in mind that if you leave some of the fields in the settings inputs unspecified, we will use the values from your default settings. You can review and control your default API settings by visiting the API Settings section on our website.
Response Considerations
Keep in mind that the content of the Cancel response can differ depending on the Sellers. For instance, some Sellers might provide details about the hotel, while others may only offer information about the status and locators/references.
Next, we'll provide important information about some of the returned fields.
Cancel Status
Once a Cancel method is run, our API response will provide its cancel status. This status represents the current status of the cancellation and can be categorized into four possible values:
| Status | Description |
|---|---|
CANCELLED | The reservation is cancelled. |
OK | The reservation status is OK, is not cancelled. |
ON_REQUEST | The reservation was completed but the product is still not available by the Seller, so the reservation goes into a waiting list. It is the Buyer’s responsibility to check if the booking is OK. |
UNKNOWN | During the cancelation process, an issue led to an unknown reservation status. The Buyer is responsible for confirming with the Seller that the booking has been canceled. |
If you receive any of the "common errors" or a status other than "CANCELLED", it will be your responsibility as a Buyer to check the final status of the cancellation in the Seller's system.
Cancel Penalty
Cancellation always takes into account the day and time of the destination in order to calculate what cancellation policy should be applied. UTC time.
Query Inputs
HotelSettingsInput (INPUT_OBJECT)
Settings are the common configurations used to construct requests to the supplier/s. By default,
we apply the same configuration to all Hotel-X clients in our back system.
Settings are the common configurations used to construct requests to the supplier/s. By default, we apply the same configuration to all Hotel-X clients in our back system.
context (String)
Indicates the context of the I/O codes (hotel, board, room and rates)
Indicates the context of the I/O codes (hotel, board, room and rates)
client (ID)
Client name set in TGX, present only if the authorization header is of the JWT type. It is used to modify the user initially set in the preload.
Client name set in TGX, present only if the authorization header is of the JWT type. It is used to modify the user initially set in the preload.
timeout (Int)
Specifies the time limit, in milliseconds, for connecting with suppliers. If multiple suppliers are involved, this timeout applies to all of them. If a supplier exceeds this time limit, the connection to that supplier will be cut. However, Travelgate will keep the connection with the client even if this timeout is exceeded.
If not set, the value saved in your Hotel-X API default settings will be used.
Specifies the time limit, in milliseconds, for connecting with suppliers. If multiple suppliers are involved, this timeout applies to all of them. If a supplier exceeds this time limit, the connection to that supplier will be cut. However, Travelgate will keep the connection with the client even if this timeout is exceeded. If not set, the value saved in your Hotel-X API default settings will be used.
operationTimeout (Int)
Defines the maximum time, in milliseconds, before an operation is cancelled by our system. Once this time is reached, the operation will be aborted and an error will be returned. This timeout is for the Hotel-X layer and should be set to a higher value than the timeout for suppliers. For example, you could specify timeout as 20000ms and operationTimeout as 22000ms. This means that we will send a timeout of 20000ms to the suppliers and will close the connection at 22000ms if the operationTimeout is exceeded. Optional.
@deprecated(reason: "deprecated from 2024-11-11.")
Defines the maximum time, in milliseconds, before an operation is cancelled by our system. Once this time is reached, the operation will be aborted and an error will be returned. This timeout is for the Hotel-X layer and should be set to a higher value than the timeout for suppliers. For example, you could specify timeout as 20000ms and operationTimeout as 22000ms. This means that we will send a timeout of 20000ms to the suppliers and will close the connection at 22000ms if the operationTimeout is exceeded. Optional. @deprecated(reason: "deprecated from 2024-11-11.")
auditTransactions (Boolean)
Returns all the transactions exchanged with the supplier.
Returns all the transactions exchanged with the supplier.
businessRules (BusinessRulesInput)
Business rules
Business rules
optionsQuota (Int)
The maximum number of options returned per board in the search query. If not set, the value saved in your Hotel-X API default settings will be used.
The maximum number of options returned per board in the search query. If not set, the value saved in your Hotel-X API default settings will be used.
businessRulesType (Enum of BusinessRulesType)
Different business rules to filter the returned options.
Possible values:
CHEAPER_AMOUNT
ROOM_TYPE
Different business rules to filter the returned options.
Possible values:
CHEAPER_AMOUNTROOM_TYPEsuppliers * (HotelXSupplierInput)
Array of suppliers. Each one contains its own code, settings and accesses.
Array of suppliers. Each one contains its own code, settings and accesses.
settings (SettingsBaseInput)
You can configure an special settings for any supplier. This level overwrites the avail settings level but not the
access settings level.
You can configure an special settings for any supplier. This level overwrites the avail settings level but not the access settings level.
timeout (Int)
Milliseconds before the connection is closed.
Milliseconds before the connection is closed.
auditTransactions (Boolean)
Specifies if the exachanged transactions with the supplier have to be logged or not.
Specifies if the exachanged transactions with the supplier have to be logged or not.
currency (Currency)
Currency in ISO 4217 standard
Currency in ISO 4217 standard
commitRequired (Boolean)
Indicates if the book will be confirmed in 1 or 2 steps
Indicates if the book will be confirmed in 1 or 2 steps
code * (String)
Code that represents a supplier in our system.
This information is mandatory.
Code that represents a supplier in our system. This information is mandatory.
accesses * (HotelXAccessInput)
Array of accesses that can overwrite an existing access information or include a new access for this avail.
Array of accesses that can overwrite an existing access information or include a new access for this avail.
accessId * (ID)
The accessID used to identify the existing access in our Back Office in order to
overwrite it. Acts as an identifier in this search. It can either exist or not.
The accessID used to identify the existing access in our Back Office in order to overwrite it. Acts as an identifier in this search. It can either exist or not.
configuration (ConfigurationInput)
Information required to access the supplier s system.
Information required to access the supplier s system.
username (String)
User name for the connection.
User name for the connection.
password (String)
Password for the connection
Password for the connection
urls * (UrlsInput)
URL or endpoint for the connection.
URL or endpoint for the connection.
search (URI)
Specific URL for Availability method.
Specific URL for Availability method.
quote (URI)
Specific URL for Reservation method.
Specific URL for Reservation method.
book (URI)
Specific URL for Valuation method.
Specific URL for Valuation method.
generic (URI)
Supplier URL used for multiple methods.
Supplier URL used for multiple methods.
parameters * (ParameterInput)
List of parameters with additional required information.
List of parameters with additional required information.
key * (String)
Contains the keyword/Id to identify a parameter.
This information is mandatory.
Contains the keyword/Id to identify a parameter. This information is mandatory.
value * (String)
Contains the parameter values.
This information is mandatory.
Contains the parameter values. This information is mandatory.
markets * (String)
Source Markets allowed for the Access (use ISO3166_1_alfa_2).
Source Markets allowed for the Access (use ISO3166_1_alfa_2).
rateRules * (Enum of RateRulesType)
RateRules allowed for the access.
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
RateRules allowed for the access.
Possible values:
NORMALPACKAGEOLDER55OLDER60OLDER65CANARY_RESIDENTBALEARIC_RESIDENTLARGE_FAMILYHONEYMOONPUBLIC_SERVANTUNEMPLOYEDNON_REFUNDABLEMOBILEWARRANTYESSENTIAL_WORKERNEGOTIATEDCUSTOMplugins * (PluginStepInput)
Array of plugins to execute.
Array of plugins to execute.
step * (Enum of PluginStepType)
Indicates where the plugin will be executed.
Possible values:
REQUEST
REQUEST_ACCESS
RESPONSE_OPTION
RESPONSE_ACCESS
RESPONSE
Indicates where the plugin will be executed.
Possible values:
REQUESTREQUEST_ACCESSRESPONSE_OPTIONRESPONSE_ACCESSRESPONSEpluginsType * (PluginsInput)
Indicates the plugin that will be executed.
Indicates the plugin that will be executed.
type * (Enum of PluginType)
Type of the plugin to execute
Possible values:
PRE_STEP
HOTEL_MAP
BOARD_MAP
ROOM_MAP
CURRENCY_CONVERSION
MARKUP
AGGREGATION
POST_STEP
COMMISSION
MARKETS_GROUP
AMENITY_MAP
PROMOTION_MAP
Type of the plugin to execute
Possible values:
PRE_STEPHOTEL_MAPBOARD_MAPROOM_MAPCURRENCY_CONVERSIONMARKUPAGGREGATIONPOST_STEPCOMMISSIONMARKETS_GROUPAMENITY_MAPPROMOTION_MAPname * (String)
Name of the plugin to execute
Name of the plugin to execute
parameters * (undefined)
Parameters of the plugin
Parameters of the plugin
testMode (Boolean)
This flag is only allowed to be used for the access checked as 'TEST.' By default, it is set to 'LIVE.'
This flag is only allowed to be used for the access checked as 'TEST.' By default, it is set to 'LIVE.'
clientTokens * (String)
Used to identify the origin of the request. This is solely used in plugins.
Used to identify the origin of the request. This is solely used in plugins.
commitRequired (Boolean)
Indicates if the book will be confirmed in 1 or 2 steps. It only should be used in Book.
Indicates if the book will be confirmed in 1 or 2 steps. It only should be used in Book.
HotelXFilterInput (INPUT_OBJECT)
plugin (HotelXPluginFilterInput)
Only is possible to specify one of this filters, it allows to filter which plugins have to be executed or excluded
Only is possible to specify one of this filters, it allows to filter which plugins have to be executed or excluded
includes * (HotelXFilterPluginTypeInput)
Plugins to be only executed
Plugins to be only executed
step * (Enum of PluginStepType)
The Step of the plugin to filter
Possible values:
REQUEST
REQUEST_ACCESS
RESPONSE_OPTION
RESPONSE_ACCESS
RESPONSE
The Step of the plugin to filter
Possible values:
REQUESTREQUEST_ACCESSRESPONSE_OPTIONRESPONSE_ACCESSRESPONSEtype * (String)
The Type of the plugin to filter
The Type of the plugin to filter
name * (String)
The Name of the plugin to filter
The Name of the plugin to filter
excludes * (undefined)
Plugins to exclude
Plugins to exclude
HotelCancelInput (INPUT_OBJECT)
Cancel criteria.
Cancel criteria.
accessCode (String)
The name of the access to use in the request.
The name of the access to use in the request.
language (Language)
The language code.
The language code.
hotelCode (String)
The hotel code, which is only used if you try to cancel with reference.
The hotel code, which is only used if you try to cancel with reference.
reference (BookReferenceInput)
It contains reservation references. When using the reference object to cancel, hotelCode has to be send as well.
It contains reservation references. When using the reference object to cancel, hotelCode has to be send as well.
client (String)
The client's booking reference
The client's booking reference
supplier (String)
The supplier's booking reference
The supplier's booking reference
hotel (String)
The hotel's reference
The hotel's reference
dates (BookReferenceDatesInput)
Used to receive a list of all the reservations made in a specific type frame. However, even if you are looking for a specific booking using references,
this field may be mandatory for some suppliers.
Used to receive a list of all the reservations made in a specific type frame. However, even if you are looking for a specific booking using references, this field may be mandatory for some suppliers.
start (Date)
Start or check-in booking date
Format: YYYY-MM-DD
Start or check-in booking date Format: YYYY-MM-DD
end (Date)
End or check-out booking date
Format: YYYY-MM-DD
End or check-out booking date Format: YYYY-MM-DD
creation (Date)
Booking creation date
Format: YYYY-MM-DD
Booking creation date Format: YYYY-MM-DD
bookingID (String)
HotelX's booking reference. If you cancel with bookingID nor hotelCode norany other reference needs to be send.
HotelX's booking reference. If you cancel with bookingID nor hotelCode norany other reference needs to be send.
Returned Fields
HotelCancelPayload (OBJECT)
stats (StatsRequest)
Application stats in string format
Application stats in string format
total * (Stat)
Total transaction time
Total transaction time
start * (DateTime)
Start UTC
Start UTC
end * (DateTime)
End UTC
End UTC
duration (Float)
Difference between start and end in miliseconds
Difference between start and end in miliseconds
validation * (undefined)
Request validation time
Request validation time
process * (undefined)
Process time. Contains communication time, parse time and plugin time.
Process time. Contains communication time, parse time and plugin time.
configuration * (undefined)
Build access time
Build access time
request * (undefined)
Request time
Request time
response * (undefined)
Response time
Response time
requestPlugin (StatPlugin)
Plugin execution time
Plugin execution time
name * (String)
Plugin name
Plugin name
total * (undefined)
total plugin time
total plugin time
hotels * (Int)
Number of hotels
Number of hotels
zones * (Int)
Number of zones
Number of zones
cities * (Int)
Number of cities
Number of cities
dockerID * (String)
Docker Id
Docker Id
Accesses * (StatAccess)
Detail access time
Detail access time
name * (String)
Access name
Access name
total * (undefined)
Total access time
Total access time
hotels * (Int)
Number of hotels
Number of hotels
zones * (Int)
Number of zones
Number of zones
cities * (Int)
Number of cities
Number of cities
transactions * (StatTransaction)
Detail transaction time
Detail transaction time
reference * (String)
Extra information about transaction.
Extra information about transaction.
total * (undefined)
Total transaction time
Total transaction time
buildRequest * (undefined)
Build request time
Build request time
workerCommunication * (undefined)
Worker connection time
Worker connection time
parseResponse * (undefined)
Parse response time
Parse response time
plugins * (undefined)
Plugin execution time
Plugin execution time
auditData (AuditData)
Data sent and received in the supplier's native format.
Data sent and received in the supplier's native format.
transactions * (Transactions)
List of the transactions data.
List of the transactions data.
request * (String)
Transaction Request.
Transaction Request.
response * (String)
Transaction Response.
Transaction Response.
timeStamp * (DateTime)
Time when the request has been processed.
Time when the request has been processed.
timeStamp * (DateTime)
Timestamp.
Timestamp.
processTime * (Float)
Process time of the transaction data in milliseconds (ms).
Process time of the transaction data in milliseconds (ms).
cancellation (HotelCancelDetail)
Information about cancel
Information about cancel
reference (Reference)
Contains all the references obtained along the flow (client's, supplier's, hotel's...).
Contains all the references obtained along the flow (client's, supplier's, hotel's...).
client (String)
Client reference booking.
Client reference booking.
supplier (String)
Supplier reference booking.
Supplier reference booking.
hotel (String)
Hotel reference booking
Hotel reference booking
hotelConfirmationNumberStatus (String)
Process Status in order to obtain the hotel confirmation number. If this field is null or empty that means that the status is UNKNOWN. Possible values:
"P" => (pending): The booking hasn't been assinged to any operator yet, or it has but the operator did not make the call yet.
"R" => (retrying): The operator tried to call the hotel but, for some reason, the call couldn't be completed because of external factors. This means the operator will try to call again later.
"NA" => (no answer): The operator tried to call the hotel several times but the hotel did not answer.
"C" => (cancelled): The operator has been informed by the hotel that the reservation has been cancelled.
"DNE" => (does not exist): The operator has been informed by the hotel that the reservation does not exist.
"F" => (fetched): The operator called the hotel and they got the hotel confirmation number (a truly succesful call)
"I" => (issued): The operator called the hotel but there were issues. Maybe the hotel is closed, maybe natural disaster situations are alerted for the check-in date, etc.
Process Status in order to obtain the hotel confirmation number. If this field is null or empty that means that the status is UNKNOWN. Possible values: "P" => (pending): The booking hasn't been assinged to any operator yet, or it has but the operator did not make the call yet. "R" => (retrying): The operator tried to call the hotel but, for some reason, the call couldn't be completed because of external factors. This means the operator will try to call again later. "NA" => (no answer): The operator tried to call the hotel several times but the hotel did not answer. "C" => (cancelled): The operator has been informed by the hotel that the reservation has been cancelled. "DNE" => (does not exist): The operator has been informed by the hotel that the reservation does not exist. "F" => (fetched): The operator called the hotel and they got the hotel confirmation number (a truly succesful call) "I" => (issued): The operator called the hotel but there were issues. Maybe the hotel is closed, maybe natural disaster situations are alerted for the check-in date, etc.
bookingID (String)
HotelX's booking reference. The BookingID is a unique identifier for each reservation that can be used to perform Booking queries and Cancel mutations in the system.
It is not recommended to modify or use this value externally, although it may be useful for identifying and managing reservations within the system.
It is important to note that the BookingID value should not be interpreted in any other way beyond its use within the system.
HotelX's booking reference. The BookingID is a unique identifier for each reservation that can be used to perform Booking queries and Cancel mutations in the system. It is not recommended to modify or use this value externally, although it may be useful for identifying and managing reservations within the system. It is important to note that the BookingID value should not be interpreted in any other way beyond its use within the system.
amendmentID (String)
HotelX's amend booking reference
HotelX's amend booking reference
cancelReference (String)
Cancellation ID in the supplier's system, if supported.
Cancellation ID in the supplier's system, if supported.
status (Enum of BookStatusType)
Booking Status.
Possible values:
OK
ON_REQUEST
CANCELLED
UNKNOWN
Booking Status.
Possible values:
OKON_REQUESTCANCELLEDUNKNOWNprice (Price)
Specifies the prices (Gross and Net) of the cancellation.
Specifies the prices (Gross and Net) of the cancellation.
currency * (Currency)
Currency code indicating which currency should be paid.
Currency code indicating which currency should be paid.
binding * (Boolean)
It indicates whether the gross price must be honored, meaning the customer cannot sell the room/option at a price lower than the supplier's established rate.
It indicates whether the gross price must be honored, meaning the customer cannot sell the room/option at a price lower than the supplier's established rate.
net * (Float)
It indicates the net price that the customer must pay to the supplier.
The net price is calculated by substrating the included surcharges from the gross price. (For calculation purposes only)
It indicates the net price that the customer must pay to the supplier. The net price is calculated by substrating the included surcharges from the gross price. (For calculation purposes only)
gross * (Float)
Indicates the retail price that the supplier sells to the customer.
Indicates the retail price that the supplier sells to the customer.
exchange * (Exchange)
Provides currency information and the applicable rate for the results returned by the Supplier
Provides currency information and the applicable rate for the results returned by the Supplier
currency * (Currency)
Provide information about the currency of origin
Provide information about the currency of origin
rate * (Float)
Provides information about the rate applied over results
Provides information about the rate applied over results
markups * (Markup)
Informs markup applied over supplier price.
Informs markup applied over supplier price.
channel (String)
channel of markup application.
channel of markup application.
currency * (Currency)
Currency code indicating which currency should be paid.
This information is mandatory.
Currency code indicating which currency should be paid. This information is mandatory.
binding * (Boolean)
It indicates if the price indicated in the gross must be respected. In case minimumSellingPrice is not empty, the binding indicates instead that the minimumSellingPrice must be respected.
That is, the customer can not sell the room / option at a price lower than that established by the supplier.
This information is mandatory.
It indicates if the price indicated in the gross must be respected. In case minimumSellingPrice is not empty, the binding indicates instead that the minimumSellingPrice must be respected. That is, the customer can not sell the room / option at a price lower than that established by the supplier. This information is mandatory.
net * (Float)
Indicates the net price that the customer must pay to the supplier plus the markup.
This information is mandatory.
Indicates the net price that the customer must pay to the supplier plus the markup. This information is mandatory.
gross (Float)
Indicates the retail price that the supplier sells to the customer plus the markup.
Indicates the retail price that the supplier sells to the customer plus the markup.
exchange * (undefined)
Informs about the currency of origin, and the rate applied over result.
This information is mandatory.
Informs about the currency of origin, and the rate applied over result. This information is mandatory.
rules * (Rule)
Breakdown of the applied rules for a markup
Breakdown of the applied rules for a markup
id * (String)
rule identifier
rule identifier
name (String)
rule name
rule name
type * (Enum of MarkupRuleType)
type of the value
Possible values:
PERCENT
IMPORT
type of the value
Possible values:
PERCENTIMPORTvalue * (Float)
value applied by this rule
value applied by this rule
minimumSellingPrice (Float)
Indicates the minimum selling price it can be sold (determined by the Seller). Is is specified (not null), that field takes preference to Gross and Binding.
Indicates the minimum selling price it can be sold (determined by the Seller). Is is specified (not null), that field takes preference to Gross and Binding.
booking (HotelBookingDetail)
Information about the reservation.
Information about the reservation.
supplierCode (String)
Supplier code of the booking
Supplier code of the booking
accessCode (String)
Access code of the booking
Access code of the booking
reference * (undefined)
Booking ID references codes.
Booking ID references codes.
holder (Holder)
Holder's name and surname
Holder's name and surname
name * (String)
Holder's name.
Holder's name.
surname * (String)
Holder's surname.
Holder's surname.
title (Enum of PersonalTitleType)
Holder's title, if return.
Possible values:
MR
MRS
MISS
MS
NOT_SPECIFIED
Holder's title, if return.
Possible values:
MRMRSMISSMSNOT_SPECIFIEDcontactInfo (ContactInfo)
Holder's contact information.
Holder's contact information.
email (String)
Email contact
Email contact
hotel (BookingHotel)
Information about the hotel.
Information about the hotel.
bookingDate (Date)
Creation date of the booking.
Format: YYYY-MM-DD
Creation date of the booking. Format: YYYY-MM-DD
start (Date)
Check-in date for booking
Format: YYYY-MM-DD
Check-in date for booking Format: YYYY-MM-DD
end (Date)
Check-out date for the booking.
Format: YYYY-MM-DD
Check-out date for the booking. Format: YYYY-MM-DD
hotelCode (String)
Code of the hotel in the context selected.
Code of the hotel in the context selected.
hotelName (String)
Name of the hotel.
Name of the hotel.
boardCode (String)
Code of the board in the context selected.
Code of the board in the context selected.
occupancies * (Occupancy)
List of occupancies for the request
List of occupancies for the request
id * (Int)
Unique ID room in this option.
Unique ID room in this option.
paxes * (Pax)
List of pax of this occupancy.
List of pax of this occupancy.
age * (Int)
Passenger age on the day of check-in, which can vary for adults, infants, or babies depending on each supplier's particular age range.
Passenger age on the day of check-in, which can vary for adults, infants, or babies depending on each supplier's particular age range.
name (String)
Specifies the pax name.
Specifies the pax name.
surname (String)
Specifies the pax surname.
Specifies the pax surname.
rooms * (BookingRoom)
List of rooms.
List of rooms.
occupancyRefId (Int)
ID reference to the occupancy
ID reference to the occupancy
code (String)
Indicates the room code
Indicates the room code
description (String)
Description about the room
Description about the room
quotePrice (PriceChange)
Specifies the price of the previous OptionQuote, returned only if it differs from the price shown at the Quote Option. If the price remains unchanged, this field will be returned as Null.
Specifies the price of the previous OptionQuote, returned only if it differs from the price shown at the Quote Option. If the price remains unchanged, this field will be returned as Null.
currency * (String)
The currency of previous option.
The currency of previous option.
net * (Float)
The net value of previous option.
The net value of previous option.
gross * (Float)
The gross value of previous option.
The gross value of previous option.
binding * (Boolean)
Indicates if previous option price was binding or not
Indicates if previous option price was binding or not
cancelPolicy (CancelPolicy)
Specifies cancel policies of the returned option .
Specifies cancel policies of the returned option .
refundable * (Boolean)
Indicates if the option is refundable or non-refundable
Indicates if the option is refundable or non-refundable
cancelPenalties * (CancelPenalty)
List of cancellation penalties
List of cancellation penalties
deadline (DateTime)
Cancellation fees will be applicable between this date and check-in date
Cancellation fees will be applicable between this date and check-in date
isCalculatedDeadline * (Boolean)
Specifies if the deadline has been taken from the seller’s response (false) or has been calculated by TravelgateX (true)
Specifies if the deadline has been taken from the seller’s response (false) or has been calculated by TravelgateX (true)
penaltyType * (Enum of CancelPenaltyType)
Type of penalty; this can be Nights, Percent or Import
Possible values:
NIGHTS
PERCENT
IMPORT
Type of penalty; this can be Nights, Percent or Import
Possible values:
NIGHTSPERCENTIMPORTcurrency * (Currency)
Currency used in the cancellation policy
Currency used in the cancellation policy
value * (Float)
Value of the cancellation policy
Value of the cancellation policy
description (String)
Extra details and information about supplier's cancel policies to give a further insight. This information is not supported for all the suppliers.
Extra details and information about supplier's cancel policies to give a further insight. This information is not supported for all the suppliers.
remarks (String)
Additional information about the book.
Additional information about the book.
status * (undefined)
Booking Status.
The possible values for this field are specified in our documentation.
Possible values for book mutation and booking query: https://docs.travelgate.com/docs/apis/for-buyers/hotel-x-pull-buyers-api/booking-flow/book#book-status
Possible values for cancel mutation: https://docs.travelgate.com/docs/apis/for-buyers/hotel-x-pull-buyers-api/booking-management/cancel#cancel-status
Booking Status. The possible values for this field are specified in our documentation. Possible values for book mutation and booking query: https://docs.travelgate.com/docs/apis/for-buyers/hotel-x-pull-buyers-api/booking-flow/book#book-status Possible values for cancel mutation: https://docs.travelgate.com/docs/apis/for-buyers/hotel-x-pull-buyers-api/booking-management/cancel#cancel-status
billingSupplierCode (String)
Supplier’s billing code. It will be returned if the supplier has different billing accounts and this is informed in the reservation.
Supplier’s billing code. It will be returned if the supplier has different billing accounts and this is informed in the reservation.
payable (String)
Payable.
Payable.
addOns (AddOns)
Additional information about the option.
Additional information about the option.
distribution * (AddOn)
Extra information from the Distribution layer.
Extra information from the Distribution layer.
key * (String)
Contains keyword/ID to identify the AddOn.
Contains keyword/ID to identify the AddOn.
value * (JSON)
Contains AddOn values.
Contains AddOn values.
supplier * (undefined)
Extra information from the Supplier layer.
Extra information from the Supplier layer.
paymentInfo (GeneratedPaymentInfo)
Specifies the information about the payment generated at Book step.
Specifies the information about the payment generated at Book step.
generatedCard (PaymentCardData)
Specifies the information of the payment card, and the source of it, that has been generated at Book step
Specifies the information of the payment card, and the source of it, that has been generated at Book step
active * (Date)
Contains the Payment Card activation date.
Contains the Payment Card activation date.
CVC * (CVC)
Contains Payment Card security code (CVC).
Contains Payment Card security code (CVC).
expire * (Date)
Contains the Payment Card expiration date.
Contains the Payment Card expiration date.
holder * (undefined)
Contains owner's name.
Contains owner's name.
id * (ID)
Contains the generated card ID. It is provided by a third party supplier.
Contains the generated card ID. It is provided by a third party supplier.
number * (CardNumber)
Contains credit card number.
Contains credit card number.
type * (Enum of PaymentCardType)
Indicates the supported card type.
Possible values:
VI
AX
BC
CA
CB
CU
DS
DC
T
R
N
L
E
JC
TO
S
EC
EU
TP
OP
ER
XS
O
Indicates the supported card type.
Possible values:
VIAXBCCACBCUDSDCTRNLEJCTOSECEUTPOPERXSOstatus (Enum of PaymentCardStatus)
Indicates the credit card status.
Possible values:
CREATED
CANCELED
EXPIRED
ACTIVE
UNKNOWN
Indicates the credit card status.
Possible values:
CREATEDCANCELEDEXPIREDACTIVEUNKNOWNid * (String)
Payment identification generated by the payment supplier. This field is only returned in Book step, when the card is generated.
Payment identification generated by the payment supplier. This field is only returned in Book step, when the card is generated.
method (Enum of GeneratedPaymentMethodType)
Indicates the payment method used, which depends on the configured payment supplier.
Possible values:
VIRTUAL_CARD
Indicates the payment method used, which depends on the configured payment supplier.
Possible values:
VIRTUAL_CARDsupplier * (SupplierData)
Indicates the supplier information responsible of the payment card's creation
Indicates the supplier information responsible of the payment card's creation
id * (ID)
Supplier unique ID. Format: integer.
Supplier unique ID. Format: integer.
code * (ID)
Supplier unique code
Supplier unique code
name * (String)
Supplier name
Supplier name
isActive * (Boolean)
Indicates whether a Supplier is active.
This is a calculated field, a specific supplier can be activated or deactivated,
but if its provider is deactivated, the value will be = false
Indicates whether a Supplier is active. This is a calculated field, a specific supplier can be activated or deactivated, but if its provider is deactivated, the value will be = false
provider * (ProviderData)
Instance to which this supllier is connected
Instance to which this supllier is connected
id * (ID)
Provider unique ID. Format: integer.
Provider unique ID. Format: integer.
code * (ID)
Provider unique code
Provider unique code
name * (String)
Provider name
Provider name
isActive * (Boolean)
Indicates whether a Provider is active.
If the Provider is deactivated, all its Suppliers will be deactivated
Indicates whether a Provider is active. If the Provider is deactivated, all its Suppliers will be deactivated
audits * (EntityAuditConnection)
Audits it shows the provider's change history
Audits it shows the provider's change history
edges (EntityAuditEdge)
node (EntityAudit)
code * (ID)
entityAuditData (EntityAuditData)
id * (ID)
code * (ID)
entityType * (Enum of EntityType)
Possible values:
ACCESS
SUPPLIER
CLIENT
PROVIDER
MEMBER
API_KEY
ACCESSSUPPLIERCLIENTPROVIDERMEMBERAPI_KEYactionType * (Enum of ActionType)
Possible values:
UPDATE
DELETE
CREATE
ARCHIVE
UNARCHIVE
ACTIVATE
DEACTIVATE
GRANT_TO_GROUPS
REVOKE_FROM_FROUPS
APPEND_PARAMETERS
DELETE_PARAMETERS
APPEND_MARKETS
DELETE_MARKETS
APPEND_RATERULES
DELETE_RATERULES
SET_FIELD
REMOVE_FIELD
ACTIVATE_SPEED
DEACTIVATE_SPEED
SET_IS_PUBLIC
REMOVE_MEMBER_SERVICE_ROLE
UPDATE_MEMBER_SERVICE_ROLE
REFRESH_TOKEN
UPDATEDELETECREATEARCHIVEUNARCHIVEACTIVATEDEACTIVATEGRANT_TO_GROUPSREVOKE_FROM_FROUPSAPPEND_PARAMETERSDELETE_PARAMETERSAPPEND_MARKETSDELETE_MARKETSAPPEND_RATERULESDELETE_RATERULESSET_FIELDREMOVE_FIELDACTIVATE_SPEEDDEACTIVATE_SPEEDSET_IS_PUBLICREMOVE_MEMBER_SERVICE_ROLEUPDATE_MEMBER_SERVICE_ROLEREFRESH_TOKENauditDetails (AuditDetails)
field * (String)
current * (String)
previous * (String)
modifiedBy * (String)
correlationID (String)
adviseMessage * (AdviseMessage)
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 * (Time)
updatedAt * (Time)
deletedAt (Time)
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage * (undefined)
totalCount * (Int)
connectionType * (Enum of ProviderConnectionType)
Indicates connection type of Supplier
Possible values:
PULL
PUSH
Indicates connection type of Supplier
Possible values:
PULLPUSHserviceApi * (Int)
ServiceAPI indicates the type of the connection
- hotel
- transportation
- car
- transfers
- activities
- virtualaccount
- payment
- package
ServiceAPI indicates the type of the connection
api * (Enum of APIName)
API name for service API
Possible values:
HOTEL
TRANSPORTATION
CAR
TRANSFERS
ACTIVITIES
VIRTUALACCOUNT
PAYMENT
PACKAGE
API name for service API
Possible values:
HOTELTRANSPORTATIONCARTRANSFERSACTIVITIESVIRTUALACCOUNTPAYMENTPACKAGEowner (Organization)
Organization that owns the Supplier
Organization that owns the Supplier
code * (ID)
organizationData (OrganizationData)
id * (ID)
code * (ID)
label (String)
type * (Enum of GroupType)
Possible values:
ROOT
ORG
GROUP
TEAM
FOLDER
PRODUCT
RESOURCE
SPECIFIC_RESOURCE
ROOTORGGROUPTEAMFOLDERPRODUCTRESOURCESPECIFIC_RESOURCEinfo (String)
crmID (String)
crmData (CompanyCrmData)
crmID * (String)
connectionType * (Enum of ConnectionType)
Possible values:
HOTEL_X_BUYER_ONLY
HOTEL_LEGACY_BUYER_ONLY
CHANNEL_X_BUYER_ONLY
HOTEL_PULL_LEGACY_SELLER_ONLY
HOTEL_PULL_SELLER_GENERIC
HOTEL_PUSH_LEGACY_SELLER_ONLY
HOTEL_PUSH_SELLER_GENERIC
DMC_X
FLIGHTS_LEGACY_SELLER_ONLY
PAYMENT_LEGACY_SELLER_ONLY
B2B_VIRTUAL_AGENCY_TOOL_BUYER_ONLY
TRANSPORTATION_FLIGHT_LEGACY_BUYER_ONLY
FLIGHT_X_BUYER_ONLY
DIRECT_X
DISTRIBUTE
INVENTORY
ACTIVITIES_LEGACY
CARS_LEGACY
TRANSFERS_LEGACY
VIRTUAL_ACCOUNT_LEGACY
HOTEL_X_BUYER_ONLYHOTEL_LEGACY_BUYER_ONLYCHANNEL_X_BUYER_ONLYHOTEL_PULL_LEGACY_SELLER_ONLYHOTEL_PULL_SELLER_GENERICHOTEL_PUSH_LEGACY_SELLER_ONLYHOTEL_PUSH_SELLER_GENERICDMC_XFLIGHTS_LEGACY_SELLER_ONLYPAYMENT_LEGACY_SELLER_ONLYB2B_VIRTUAL_AGENCY_TOOL_BUYER_ONLYTRANSPORTATION_FLIGHT_LEGACY_BUYER_ONLYFLIGHT_X_BUYER_ONLYDIRECT_XDISTRIBUTEINVENTORYACTIVITIES_LEGACYCARS_LEGACYTRANSFERS_LEGACYVIRTUAL_ACCOUNT_LEGACYcontract * (Enum of Contract)
Possible values:
CONTRACT_TCP
CONTRACT_AFFILIATE
CONTRACT_RESELLER
ANNEX_POWER_BUYER
ANNEX_PREMIUM_SELLER
ANNEX_SELECTIVE_PREMIUM_SELLER
ANNEX_STANDARD_SELLER
ANNEX_STANDARD_BUYER
ANNEX_PREFERRED_SELLER
CONTRACT_TCPCONTRACT_AFFILIATECONTRACT_RESELLERANNEX_POWER_BUYERANNEX_PREMIUM_SELLERANNEX_SELECTIVE_PREMIUM_SELLERANNEX_STANDARD_SELLERANNEX_STANDARD_BUYERANNEX_PREFERRED_SELLERtechPlatformName (String)
isPublic (Boolean)
children (GroupConnection)
Only responses folders.(non-hierarchically)
Only responses folders.(non-hierarchically)
edges (GroupEdge)
node (Group)
code * (ID)
groupData (GroupData)
id * (ID)
code * (ID)
label (String)
folder (String)
type * (undefined)
info (String)
isPublic * (Boolean)
owner (Member)
code * (ID)
memberData (MemberData)
id * (ID)
code * (ID)
label (String)
isActive * (Boolean)
Can members does queries in the platform?
Can members does queries in the platform?
firstName (String)
lastName (String)
crmData (CrmData)
CRM specific data
CRM specific data
crmID (String)
contactImportance (String)
companyRole (String)
roles (RoleConnection)
which roles the member has in?
which roles the member has in?
edges (RoleEdge)
node (Role)
code * (ID)
roleData (RoleData)
id * (ID)
code * (ID)
type * (Enum of RoleType)
Possible values:
VIEWER
EDITOR
ADMIN
EXECUTOR
SPECIFIC
VIEWEREDITORADMINEXECUTORSPECIFICisEditable * (Boolean)
label (String)
isCreate * (Boolean)
Has resource Create permission?
Has resource Create permission?
isRead * (Boolean)
Has resource Create permission?
Has resource Create permission?
isUpdate * (Boolean)
Has resource Update permission?
Has resource Update permission?
isDelete * (Boolean)
Has resource Delete permission?
Has resource Delete permission?
isEnable * (Boolean)
Is role enabled or not?
Is role enabled or not?
isExecutable * (Boolean)
Has resource Executable permission?
Has resource Executable permission?
isSpecial * (Boolean)
Has any other non-basic permission/s?
Has any other non-basic permission/s?
special (String)
Special permission
Special permission
resources (ResourceConnection)
Resources used
Resources used
edges (ResourceEdge)
node (Resource)
code * (ID)
resourceData (ResourceData)
id * (ID)
code * (ID)
isEditable * (Boolean)
label (String)
apis (APIConnection)
which API have asigned this resource?
which API have asigned this resource?
edges (APIEdge)
node (API)
code * (ID)
adviseMessage * (undefined)
apiData (APIData)
id * (ID)
code * (ID)
label (String)
errorCatalog * (ErrorCatalog)
code * (ID)
description * (String)
type * (String)
level * (String)
operations (OperationConnection)
edges (OperationEdge)
node (Operation)
code * (ID)
adviseMessage * (undefined)
operationData (OperationData)
id * (ID)
code * (ID)
label (String)
types * (Enum of OperationType)
Possible values:
SEARCH
QUOTE
BOOKING
CANCEL
SCHEDULER
CREATE
READ
UPDATE
DELETE
EXECUTE
OTHER
SEARCHQUOTEBOOKINGCANCELSCHEDULERCREATEREADUPDATEDELETEEXECUTEOTHERcreatedAt * (Time)
updatedAt * (Time)
cursor * (String)
pageInfo * (undefined)
adviseMessage * (undefined)
totalCount * (Int)
createdAt * (Time)
updatedAt * (Time)
cursor * (String)
pageInfo * (undefined)
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (undefined)
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (undefined)
macroPermissions (MacroPermissionsConnection)
edges (MacroPermissionEdge)
node (MacroPermission)
code * (ID)
macroPermissionData (MacroPermissionData)
id * (ID)
code * (ID)
productID * (ID)
group * (ID)
label (String)
permissions (Permission)
role * (undefined)
resource * (undefined)
api * (undefined)
adviseMessage * (undefined)
createdAt * (DateTime)
updatedAt * (DateTime)
cursor * (String)
pageInfo * (undefined)
organizationMemberRoles * (OrganizationMemberRole)
organization * (undefined)
role * (Enum of RoleMemberType)
Possible values:
ADMIN
GUEST
EDITOR
VIEWER
ADMINGUESTEDITORVIEWERphone (String)
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
deletedAt * (DateTime)
Date deleted. This value is used to include archived members.
Date deleted. This value is used to include archived members.
isEditable * (Boolean)
productId (Int)
resourceId (Int)
members (MemberConnection)
Only responses members in this group
Only responses members in this group
edges (MemberEdge)
cursor * (String)
pageInfo * (undefined)
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
managedGroups (ManagedGroupConnection)
Responses all managed groups by this group.
Responses all managed groups by this group.
edges (ManagedGroupEdge)
node (ManagedGroup)
code * (ID)
managedGroupData (ManagedGroupData)
code * (ID)
group * (undefined)
api * (undefined)
resource * (undefined)
role * (undefined)
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (undefined)
accesses (AccessConnection)
Access resources in a group
Access resources in a group
edges (AccessEdge)
node (Access)
code * (ID)
accessData (AccessData)
id * (ID)
Unique ID identifier
Unique ID identifier
code * (ID)
Unique AccessConfiguration identifier
Unique AccessConfiguration identifier
name * (String)
Access descriptive name
Access descriptive name
isActive * (Boolean)
Indicates if Access is active
Indicates if Access is active
isTest * (Boolean)
Indicates if Access can be used for testing or not
Indicates if Access can be used for testing or not
isShared * (Boolean)
Indicates if Access is Shared
Indicates if Access is Shared
isOpenAccess * (Boolean)
Indicates if Access is open to all partners.
Indicates if Access is open to all partners.
supplier * (Supplier)
Supplier for this Access
Supplier for this Access
code * (ID)
Supplier unique code
Supplier unique code
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Supplier creation date
Supplier creation date
updatedAt * (DateTime)
Supplier last update date
Supplier last update date
deletedAt (DateTime)
Supplier deleted date
Supplier deleted date
user (String)
User code to connect to supplier
User code to connect to supplier
password (String)
Password for this Access. To retrieve this field, ADMIN permissions are required.
Otherwise, the value will be null.
Password for this Access. To retrieve this field, ADMIN permissions are required. Otherwise, the value will be null.
urls (Urls)
Specific URLs
Specific URLs
search (URI)
Specific URL for Availability method.
Specific URL for Availability method.
quote (URI)
Specific URL for Quote method.
Specific URL for Quote method.
book (URI)
Specific URL for Book method.
Specific URL for Book method.
generic (URI)
Supplier URL used for multiple methods.
Supplier URL used for multiple methods.
parameters (Parameter)
List of parameters for additional information
List of parameters for additional information
key * (ID)
Contains the keyword/Id to identify a parameter.
This information is mandatory.
Contains the keyword/Id to identify a parameter. This information is mandatory.
value * (String)
Contains the parameter values.
This information is mandatory.
Contains the parameter values. This information is mandatory.
markets * (String)
Markets allowed for the Access
Markets allowed for the Access
rateRules * (Enum of RateRulesType)
Business rule types for the Access
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
Business rule types for the Access
Possible values:
NORMALPACKAGEOLDER55OLDER60OLDER65CANARY_RESIDENTBALEARIC_RESIDENTLARGE_FAMILYHONEYMOONPUBLIC_SERVANTUNEMPLOYEDNON_REFUNDABLEMOBILEWARRANTYESSENTIAL_WORKERNEGOTIATEDCUSTOMupdateDescriptiveInfo * (Int)
Refresh time to update Despriptive Info
Refresh time to update Despriptive Info
descriptiveInfoLimit * (Int)
Limit on DescriptiveInfo; 0 denotates no limit
Limit on DescriptiveInfo; 0 denotates no limit
isSchedulerActive (Boolean)
True if scheduler is active
True if scheduler is active
updateList * (Int)
Refresh time to update other batch lists
Refresh time to update other batch lists
updateDateRange * (String)
Range on update date
Range on update date
audits * (undefined)
Audits it shows the accesses change history
Audits it shows the accesses change history
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
deletedAt (DateTime)
Access deleted date
Access deleted date
cursor * (String)
pageInfo * (undefined)
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
suppliers (SupplierConnection)
Supplier resources in a group
Supplier resources in a group
edges (SupplierEdge)
Supplier edges of Supplier connection
Supplier edges of Supplier connection
cursor * (String)
Cursor to the next item
Cursor to the next item
pageInfo * (undefined)
Page info of the connection
Page info of the connection
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
clients (ClientConnection)
Clients resources in a group
Clients resources in a group
edges (ClientEdge)
Client edges of client connection
Client edges of client connection
node (Client)
Client item
Client item
code * (ID)
Client unique code, format: "cli000"
Client unique code, format: "cli000"
clientData (ClientData)
Extended Client information
Extended Client information
id * (ID)
ID unique identifier of a Client. Format: integer.
ID unique identifier of a Client. Format: integer.
code * (ID)
Client unique code. Format: "cliX" where X = ID
Client unique code. Format: "cliX" where X = ID
name * (ID)
Client unique name
Client unique name
password (String)
Client's passowrd
Client's passowrd
legacyPassword (String)
isActive * (Boolean)
Indicates whether a Client is active or inactive
Indicates whether a Client is active or inactive
audits * (undefined)
Audits it shows the client's change history
Audits it shows the client's change history
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Client creation date
Client creation date
updatedAt * (DateTime)
Client last update date
Client last update date
deletedAt (DateTime)
Client deleted date
Client deleted date
cursor * (String)
Cursor to the next item
Cursor to the next item
pageInfo * (undefined)
Page info of the connection
Page info of the connection
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
isBuyer * (Boolean)
isSeller * (Boolean)
deleted_at (DateTime)
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (undefined)
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
owner * (undefined)
contacts * (OrganizationContact)
Differents contacts in a organization.
Differents contacts in a organization.
type * (Enum of OrganizationContactType)
Possible values:
ADMIN
BILLING
SALES
TECHNICAL
OTHER
ADMINBILLINGSALESTECHNICALOTHERuser * (undefined)
isEditable * (Boolean)
products (ProductConnection)
Products asign to a organization
Products asign to a organization
edges (ProductEdge)
node (Product)
code * (ID)
productData * (ProductData)
id * (ID)
code * (ID)
label (String)
adviseMessageCatalog * (undefined)
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (undefined)
domains * (Domain)
code * (ID)
domainData (DomainData)
id * (ID)
name * (DomainName)
organization * (undefined)
adviseMessage * (undefined)
createdAt * (DateTime)
updatedAt * (DateTime)
template (String)
primaryPartner * (Partner)
code * (ID)
partnerData (PartnerData)
code * (ID)
cusXYZ..
cusXYZ..
name * (String)
isActive (Boolean)
friendlyName (String)
organizations (OrganizationConnection)
edges (OrganizationEdge)
cursor * (String)
pageInfo * (undefined)
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
agents * (CustomerAgent)
Differents agents from TravelgateX
Differents agents from TravelgateX
type * (Enum of CustomerAgentType)
Possible values:
KAM
TECH_KAM
CUSTOMER_CARE
OTHER
KAMTECH_KAMCUSTOMER_CAREOTHERuser * (undefined)
user@xmltravelgate.com o user@travelgatex.com
user@xmltravelgate.com o user@travelgatex.com
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
allPartners * (PartnerConnection)
edges (PartnerEdge)
cursor * (String)
pageInfo * (undefined)
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
isBuyer * (Boolean)
isSeller * (Boolean)
deleted_at (DateTime)
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
groupContent (GroupContent)
Grouping of static content related to this Supplier.
Grouping of static content related to this Supplier.
code * (ID)
GroupContent unique code
GroupContent unique code
groupContentData (GroupContentData)
Extended GroupContent information
Extended GroupContent information
id * (ID)
GroupContent unique ID. Format: integer.
GroupContent unique ID. Format: integer.
code * (ID)
GroupContent unique code
GroupContent unique code
context * (Context)
GroupContent related Context
GroupContent related Context
code * (ID)
Context unique code
Context unique code
contextData (ContextData)
Extended Context information
Extended Context information
id * (ID)
Context unique ID. Format: integer.
Context unique ID. Format: integer.
code * (ID)
Context unique code
Context unique code
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Context creation date
Context creation date
updatedAt * (DateTime)
Context last update date
Context last update date
adviseMessage * (undefined)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
GroupContent creation date
GroupContent creation date
updatedAt * (DateTime)
GroupContent last update date
GroupContent last update date
supplierGroup (ID)
This is a calculated field that responds to groupContent > code
This is a calculated field that responds to groupContent > code
context (String)
This is a calculated field that responds to groupContent > groupContentData > context > code
This is a calculated field that responds to groupContent > groupContentData > context > code
system * (System)
code * (ID)
systemData (SystemData)
code * (ID)
ID identifier of a System
ID identifier of a System
name * (ID)
System complete name
System complete name
isActive * (Boolean)
Indicates whether a System is active or inactive
Indicates whether a System is active or inactive
suppliers * (undefined)
Obtain all suppliers for a filter.
Obtain all suppliers for a filter.
error * (Error)
Errors that abort services
Errors that abort services
code * (String)
Error code.
Error code.
type * (String)
Error type.
Error type.
description * (String)
Error description.
Error description.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
audits * (undefined)
Audits it shows the supplier's change history
Audits it shows the supplier's change history
serviceIntegrationData (ServiceIntegrationData)
Service Integration Data
Service Integration Data
type (Enum of ServiceIntegrationType)
Possible values:
SITH
WORKER
CONNECTORS
SITHWORKERCONNECTORSgroup (String)
isPublic * (Boolean)
giata (GiataSupplierConfiguration)
giataType (String)
giataCode (String)
errors * (undefined)
Errors that abort services
Errors that abort services
warnings * (Warning)
Potentially harmful situations or errors that won't force the service to abort.
To identify if it is blocked one, you can check our documentation regards this matter.
Potentially harmful situations or errors that won't force the service to abort. To identify if it is blocked one, you can check our documentation regards this matter.
code * (String)
Warning code
Warning code
type * (String)
Warning type
Warning type
description * (String)
Warning description
Warning description
Examples
Cancel with the bookingID from the book response
Cancel using the accessCode, hotelCode and reference from the book response
Frequently Asked Questions
How are cancellation costs calculated and displayed?
Depending on the specifications provided by a Seller, cancellation costs can be calculated using three different penalty types. It is important to keep in mind that a booking may have more than one penalty type associated with it.
- NIGHTS: It indicates the number of nights to be penalized.
- PERCENT: It indicates the percentage to pay based on the option price (possible values between 0 and 100).
- IMPORT: It Indicates the exact amount payable.