Book
The Book operation requests a booking confirmation for the specified optionId obtained from the Quote. It provides a concise summary of the option, along with the reservation status. Please note that the returned information may vary depending on the Seller. The returned fields include:
holderhotelpricecancelPolicybookingIDstatus(Make sure you add this field to your Query in order to receive the reservation status in the book response.)clientReference(The booking locator in your system - alphanumerical value.)supplierReference(Make sure you add this field to your Query in order to receive the provider locator in the book response.)
Mutation Overview
This mutation offers versatility in book options, with certain fields marked as mandatory (optionRefId, clientReference, holder etc.) and others as optional (language, deltaPrice, paymentCard etc.). This flexibility empowers you to create a personalized Book Multation, tailoring the requested fields to your specific needs.
When creating your book mutation, you have two different inputs to fill based on your specific needs:
- Input
- Settings
mutation {
hotelX {
book
input: {}
settings: {}
}
}
1. Input
To specify your book input you need to use the input HotelBookInput in your mutation variables:
{
"bookInput" : {
"optionRefId" : "11!11?1$241028?241029?1?1?0?ES?ES?es?EUR?0?2?1?1?1?0?15091142?BAR[%@BAR?146.0$0$false$EUR$$0$?1|30#30|1|2024-10-28|1|4132467|4132468|1|11|0?2269!2269?30$30??Double Standard?1??After$146.0!Before$146.0!ExpireDate$29/10/2024!mercado$ES!tgx_sess$f6152cba-f792-4e81-a2c1-e73ca63ecd02?OK?Sith?0?",
"clientReference" : "test_0123456789",
"deltaPrice" : {
"amount" : 10,
"percent" : 10,
"applyBoth" : true
},
"holder" : {
"name" : "Jane",
"surname" : "Doe"
},
"remarks" : "This is just a test booking! Feel free to include any extra information in the remarks section that you'd like the supplier to know.",
"rooms" : [
{
"occupancyRefId" : 1,
"paxes" : [
{
"name" : "Jane",
"surname" : "Doe",
"age" : 30
},
{
"name" : "John",
"surname" : "Smith",
"age" : 30
}
]
}
]
}
}
Mandatory input:
optionRefId(Identifier of the option used in Quote.)clientReference(Booking ID in client's system.)holderrooms
Optional input:
languagedeltaPrice(Indicates price variation permitted by the Buyer.)paymentCard(If the payment is done by credit card, it's mandatory to specify the payment type and the credit card information, unless you're using our VCC Plugin to generate virtual credit cards. Know more about VCC payments here.)remarks(Any customer comments for the supplier to consider.)
-
Customize the
timeoutaccording to your needs, taking into consideration the maximum values in Book is 180,000ms. -
Consider that the
deltaPricesets the price tolerance between Quote and Book. For instance, if the Quote stage displays a price of 100€ and thedeltaPriceis 5, a change up to 105€ will still secure a confirmed booking.
Payment Card
If the option or rate you want to book has a payment type such as DIRECT, CARD_BOOKING, or CARD_CHECK_IN, it is mandatory to provide payment card information when making the booking. This should be done using the PaymentCardInput in the book mutation.
Note that isVCC, virtualCreditCard and threeDomainSecurity, are all optionals.
{
"type": "VI",
"holder": {
"name": "test_name",
"surname": "test_surname"
},
"number": "4874495143042809",
"CVC": "330",
"expire": {
"month": 9,
"year": 2028
},
"isVCC": true,
"virtualCreditCard": {
"activationDate": "2020-10-02",
"deactivationDate": "2021-01-02",
"currentBalance": 50.58,
"currencyCode": "EUR"
},
"threeDomainSecurity": {
"version": "1.0.1",
"DSTransactionID": "transaction 1",
"XID": "id123456",
"ECI": "05",
"CAVV": "CAVV",
"payerResponse": "base64xml response",
"payerResponseStatus": "AUTHENTICATION_SUCCESS",
"cardEnrolledStatus": "CARD_ENROLLED",
"merchantName": "test_name",
"signatureStatus": "SIGNATURE_NOT_VALIDATED"
}
}
Possible values for the threeDomainSecurity fields
| ECI Value | Description |
|---|---|
| 05 | 3DS authentication was successful, transactions are secured by 3DS. |
| 06 | Authentication was attempted but was not or could not be completed; possible reasons being either the card or its Issuing Bank has yet to participate in 3DS. |
| 07 | 3DS authentication is either failed or could not be attempted; possible reasons being both card and Issuing Bank are not secured by 3DS, technical errors, or improper configuration. |
Mastercard
| ECI Value | Description |
|---|---|
| 00 | 3DS authentication is either failed or could not be attempted; possible reasons being both card and Issuing Bank are not secured by 3DS, technical errors, or improper configuration. |
| 01 | 3DS authentication was attempted but was not or could not be completed; possible reasons being either the card or its Issuing Bank has yet to participate in 3DS, or cardholder ran out of time to authorize. |
| 02 | 3DS authentication is successful. |
Payer response status
| Status Value | Description |
|---|---|
| AUTHENTICATION_SUCCESS | Successful Authentication. |
| AUTHENTICATION_FAILED | Failed Authentication. |
| AUTHENTICATION_INCOMPLETE | Unable to complete Authentication. |
| TRANSACTION_ATTEMPT_SUCCESS_A | Successful Attempts Transaction. |
| TRANSACTION_ATTEMPT_SUCCESS_B | You can proceed to authorisation using the information received. |
| AUTHENTICATION_REJECTED | Authentication Rejected. |
Card enrollment status
| Status Value | Description |
|---|---|
| CARD_ENROLLED | Cardholder is enrolled. Bank is participating in 3-D Secure protocol and will return the ACSUrl. |
| CARD_NOT_ENROLLED | Cardholder Not Participating – Cardholder is not enrolled. |
| CANT_AUTHENTICATE | Unavailable. The DS or ACS is not available for authentication at the time of the request. |
Signature verification status
| Status Value | Description |
|---|---|
| SIGNATURE_VALIDATED | Signature of the PARes has been validated successfully. |
| SIGNATURE_NOT_VALIDATED | PARes could not be validated. |
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 quote settings you need to use the HotelSettingsInput input in your query variables:
{
"settings": {
"client": "client_demo",
"context": "HOTELTEST",
"testMode": true,
"auditTransactions": false,
"timeout": 60000
}
}
Mandatory Settings:
clientcontext(You have the flexibility to choose between using the supplier's context or your own, depending on which codes you want to see in the response. If you prefer to receive responses with your custom codes, please ensure that your context code is linked to the mapping files that you've previously uploaded to your FTP account.)timeout(Timeout in milliseconds for the supplier connection. 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.)businessRules
-
Customize the
timeoutaccording to your needs, taking into consideration the maximum values in Book is 180,000ms. -
Set the
auditTransactionto "true" in Book when investigating errors.
For development and testing purposes, you are provided with the supplier test HOTELTEST (accessCode 2). We recommend using this during your development phase.
However, if you prefer testing with real suppliers, please note that any bookings made using test access but involving live suppliers are your responsibility, and must be cancelled in order to avoid any booking costs from Travelgate. This also means that the Buyer must handle any costs directly with the supplier if bookings are not canceled. Even if an access is labeled as "live" or "production" but uses test credentials internally, you're still responsible for any bookings made and not cancelled. Please keep this in mind when using our API services.
Response Considerations
Here are some key points to keep in mind about the response received:
Book Status
Once a Book (Reservation) method is run, our API response will provide its book status. This status represents the current status of the reservation and can be categorized into four possible values:
| Status | Description |
|---|---|
| OK | The reservation was successfully completed without any issues. |
| ON_REQUEST | Please note that a Book status may change over time: you may receive an ON_REQUEST status in Book response, and after running a Booking Query some seconds later the status may have already changed to OK. |
| UNKNOWN | During the reservation process, an issue led to an unknown reservation status. The Buyer is responsible for verifying with the Seller that the booking has been confirmed. |
| CANCELLED | The booking attempt was unsuccessful, and due to a supplier error or timeout, the system has automatically canceled the reservation to prevent further issues. |
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.
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_TYPEcurrency (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_WORKERNEGOTIATEDCUSTOMsettings (SettingsBaseInput)
You can configure an special settings for any access. This level overwrites the search and supplier settings levels.
You can configure an special settings for any access. This level overwrites the search and supplier settings levels.
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.
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_TYPEcurrency (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
plugins (PluginStepInput)
Array of plugins to execute.
Array of plugins to execute.
step (Enum of PluginStepType)
Indicates where the plugin will be executed. @deprecated(reason: "deprecated from 2025-08-25. This property is no longer recommended for use.")
Possible values:
REQUEST
REQUEST_ACCESS
RESPONSE_OPTION
RESPONSE_ACCESS
RESPONSE
Indicates where the plugin will be executed. @deprecated(reason: "deprecated from 2025-08-25. This property is no longer recommended for use.")
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. @deprecated(reason: "deprecated from 2025-08-25. This property is no longer recommended for use.")
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. @deprecated(reason: "deprecated from 2025-08-25. This property is no longer recommended for use.")
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
enable (Boolean)
Activates or deactivates the plugin behaviour
Activates or deactivates the plugin behaviour
parameters (ParameterInput)
Parameters of the plugin
Parameters of the plugin
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.
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. @deprecated(reason: "deprecated from 2025-08-25. This property is no longer recommended for use.")
Possible values:
REQUEST
REQUEST_ACCESS
RESPONSE_OPTION
RESPONSE_ACCESS
RESPONSE
The Step of the plugin to filter. @deprecated(reason: "deprecated from 2025-08-25. This property is no longer recommended for use.")
Possible values:
REQUESTREQUEST_ACCESSRESPONSE_OPTIONRESPONSE_ACCESSRESPONSEtype (String)
The Type of the plugin to filter. @deprecated(reason: "deprecated from 2025-08-25. This property is no longer recommended for use.")
The Type of the plugin to filter. @deprecated(reason: "deprecated from 2025-08-25. This property is no longer recommended for use.")
name * (String)
The Name of the plugin to filter
The Name of the plugin to filter
excludes (HotelXFilterPluginTypeInput)
Plugins to exclude
Plugins to exclude
step (Enum of PluginStepType)
The Step of the plugin to filter. @deprecated(reason: "deprecated from 2025-08-25. This property is no longer recommended for use.")
Possible values:
REQUEST
REQUEST_ACCESS
RESPONSE_OPTION
RESPONSE_ACCESS
RESPONSE
The Step of the plugin to filter. @deprecated(reason: "deprecated from 2025-08-25. This property is no longer recommended for use.")
Possible values:
REQUESTREQUEST_ACCESSRESPONSE_OPTIONRESPONSE_ACCESSRESPONSEtype (String)
The Type of the plugin to filter. @deprecated(reason: "deprecated from 2025-08-25. This property is no longer recommended for use.")
The Type of the plugin to filter. @deprecated(reason: "deprecated from 2025-08-25. This property is no longer recommended for use.")
name * (String)
The Name of the plugin to filter
The Name of the plugin to filter
HotelBookInput (INPUT_OBJECT)
Offers versatility in book options, with certain fields marked as mandatory (optionRefId, clientReference, holder etc.) and others as optional (language, delta price, payment card etc.). This flexibility empowers you to create a personalized Book Multation, tailoring the requested fields to your specific needs.
Offers versatility in book options, with certain fields marked as mandatory (optionRefId, clientReference, holder etc.) and others as optional (language, delta price, payment card etc.). This flexibility empowers you to create a personalized Book Multation, tailoring the requested fields to your specific needs.
optionRefId * (String)
OptionRefID is a unique identifier assigned to each option.
It is important to note that this identifier should not be modified or used externally, as it is an internal system identifier.
Additionally, it is crucial to understand that the OptionRefID value should not be interpreted in any other way beyond its use within the system.
OptionRefID is a unique identifier assigned to each option. It is important to note that this identifier should not be modified or used externally, as it is an internal system identifier. Additionally, it is crucial to understand that the OptionRefID value should not be interpreted in any other way beyond its use within the system.
language (Language)
Language to be used in the request.
Language to be used in the request.
clientReference * (String)
Booking ID in the client's system.
Booking ID in the client's system.
deltaPrice (DeltaPriceInput)
Input delta price, indicates price variation permitted by the client
An error will be returned if the new price does not abide to DeltaPrice. If DeltaPrice is not sent and the integration implements it, we assume that the price range is 0 and the process will continue
price is lower or equal to the price showed in valuation.
This field is implemented if its native to the supplier or if another availability/valuation request needs to be done in Reservation. In case the supplier blocks the option in valuation, reservation
Input delta price, indicates price variation permitted by the client An error will be returned if the new price does not abide to DeltaPrice. If DeltaPrice is not sent and the integration implements it, we assume that the price range is 0 and the process will continue price is lower or equal to the price showed in valuation. This field is implemented if its native to the supplier or if another availability/valuation request needs to be done in Reservation. In case the supplier blocks the option in valuation, reservation
amount (Float)
The amount that will be accepted by the client to be higher than the Quote price. It is returned in the currency of the option.
The amount that will be accepted by the client to be higher than the Quote price. It is returned in the currency of the option.
percent (Float)
The percentage accepted by the client to be higher than the Quote price.
The percentage accepted by the client to be higher than the Quote price.
applyBoth * (Boolean)
If applyBoth = false: Indicates that one of the conditions (amount or percentage) has to meet the criteria before reservation.
If applyBoth = true: Indicates that the new price cannot exceed the amount or percentage indicated by the client.
If applyBoth = false: Indicates that one of the conditions (amount or percentage) has to meet the criteria before reservation. If applyBoth = true: Indicates that the new price cannot exceed the amount or percentage indicated by the client.
paymentCard (PaymentCardInput)
If the payment is done by credit card, it's mandatory to specify the payment type and the credit card information.
If the payment is done by credit card, it's mandatory to specify the payment type and the credit card information.
type (Enum of PaymentCardType)
Indicates the supported card type, the supported card for this option is shown in Quote step.
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, the supported card for this option is shown in Quote step.
Possible values:
VIAXBCCACBCUDSDCTRNLEJCTOSECEUTPOPERXSOholder * (HolderInput)
Contains owner's name.
Contains owner's name.
name * (String)
The card holder's name.
The card holder's name.
surname * (String)
The card holder's surname.
The card holder's surname.
title (Enum of PersonalTitleType)
Holder’s title.
Possible values:
MR
MRS
MISS
MS
NOT_SPECIFIED
Holder’s title.
Possible values:
MRMRSMISSMSNOT_SPECIFIEDcontactInfo (ContactInfoInput)
Holder's contact info.
Holder's contact info.
email (Email)
Email contact
Email contact
phone (PhoneInput)
Phone contact
Phone contact
countryCode * (DialingCountryCode)
The combination of one, two or three digits identifying a specific country, countries in an integrated numbering plan, or a specific geographic area (1 to 3 digits)
The combination of one, two or three digits identifying a specific country, countries in an integrated numbering plan, or a specific geographic area (1 to 3 digits)
number * (PhoneSubscriberNumber)
Identifies a subscriber for a particular global service
Identifies a subscriber for a particular global service
number * (String)
Contains credit card number.
Contains credit card number.
CVC * (String)
Contains credit card CVC.
Contains credit card CVC.
expire * (ExpireDateInput)
Contains credit card expiration date.
Contains credit card expiration date.
month * (Int)
Month MM
Month MM
year * (Int)
Year yy
Year yy
isVCC (Boolean)
Indicates if it is a virtual card
Indicates if it is a virtual card
virtualCreditCard (VirtualCreditCardInput)
Virtual Credit Card data
Virtual Credit Card data
activationDate (Date)
The Date from when the card can be charged
The Date from when the card can be charged
deactivationDate (Date)
The date from when the card will no longer be chargeable.
The date from when the card will no longer be chargeable.
currentBalance (Float)
The amount which can be charged to the card.
The amount which can be charged to the card.
currencyCode (Currency)
The ISO currency code of the CurrentBalance.
The ISO currency code of the CurrentBalance.
threeDomainSecurity (ThreeDomainSecurityInput)
Three Domain Security data
Three Domain Security data
version (String)
Three Domain Security Version
Three Domain Security Version
DSTransactionID (String)
Universally unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.
Universally unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.
XID (String)
Transaction identifier resulting from authentication processing. Uniquely identifies a 3D Secure check request.
Transaction identifier resulting from authentication processing. Uniquely identifies a 3D Secure check request.
ECI (String)
Electronic Commerce Indicator
Electronic Commerce Indicator
CAVV (String)
Cardholder Authentication Verification Value
Cardholder Authentication Verification Value
payerResponse (String)
Payer Authentication Response. It is the response to the Payer Authentication Request. The Payer Authentication Response has an XML structure with the information from the response of the authentication, and it contains a digital certificate as a sign of authenticity.
Payer Authentication Response. It is the response to the Payer Authentication Request. The Payer Authentication Response has an XML structure with the information from the response of the authentication, and it contains a digital certificate as a sign of authenticity.
payerResponseStatus (Enum of PayerResponseStatusType)
Payer Authentication Response status
Possible values:
AUTHENTICATION_SUCCESS
AUTHENTICATION_FAILED
AUTHENTICATION_INCOMPLETE
TRANSACTION_ATTEMPT_SUCCESS_A
TRANSACTION_ATTEMPT_SUCCESS_B
AUTHENTICATION_REJECTED
Payer Authentication Response status
Possible values:
AUTHENTICATION_SUCCESSAUTHENTICATION_FAILEDAUTHENTICATION_INCOMPLETETRANSACTION_ATTEMPT_SUCCESS_ATRANSACTION_ATTEMPT_SUCCESS_BAUTHENTICATION_REJECTEDcardEnrolledStatus (Enum of ThreeDSCardEnrolledStatusType)
Result of enrollment status of the service request
Possible values:
CARD_ENROLLED
CARD_NOT_ENROLLED
CANT_AUTHENTICATE
Result of enrollment status of the service request
Possible values:
CARD_ENROLLEDCARD_NOT_ENROLLEDCANT_AUTHENTICATEmerchantName (String)
Merchant Name
Merchant Name
signatureStatus (Enum of ThreeDSSignatureStatusType)
Signature value
Possible values:
SIGNATURE_VALIDATED
SIGNATURE_NOT_VALIDATED
Signature value
Possible values:
SIGNATURE_VALIDATEDSIGNATURE_NOT_VALIDATEDremarks (String)
Any customer comments for the supplier to consider.
Any customer comments for the supplier to consider.
holder * (HolderInput)
Holder's basic information.
Holder's basic information.
name * (String)
The card holder's name.
The card holder's name.
surname * (String)
The card holder's surname.
The card holder's surname.
title (Enum of PersonalTitleType)
Holder’s title.
Possible values:
MR
MRS
MISS
MS
NOT_SPECIFIED
Holder’s title.
Possible values:
MRMRSMISSMSNOT_SPECIFIEDcontactInfo (ContactInfoInput)
Holder's contact info.
Holder's contact info.
email (Email)
Email contact
Email contact
phone (PhoneInput)
Phone contact
Phone contact
countryCode * (DialingCountryCode)
The combination of one, two or three digits identifying a specific country, countries in an integrated numbering plan, or a specific geographic area (1 to 3 digits)
The combination of one, two or three digits identifying a specific country, countries in an integrated numbering plan, or a specific geographic area (1 to 3 digits)
number * (PhoneSubscriberNumber)
Identifies a subscriber for a particular global service
Identifies a subscriber for a particular global service
rooms * (BookRoomInput)
Rooms within this option.
Rooms within this option.
occupancyRefId * (Int)
The room s reference in the booking
The room s reference in the booking
paxes * (BookPaxInput)
The list or lists of paxes of the room
The list or lists of paxes of the room
name * (String)
Passenger first name
Passenger first name
surname * (String)
Passenger last name
Passenger last name
age * (Int)
Passenger age on the day of the check-in
Passenger age on the day of the check-in
title (Enum of PersonalTitleType)
Passenger title.
Possible values:
MR
MRS
MISS
MS
NOT_SPECIFIED
Passenger title.
Possible values:
MRMRSMISSMSNOT_SPECIFIEDReturned Fields
HotelBookPayload (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 * (Stat)
Request validation time
Request validation 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
process * (Stat)
Process time. Contains communication time, parse time and plugin time.
Process time. Contains communication time, parse time and plugin 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
configuration * (Stat)
Build access time
Build access 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
request * (Stat)
Request time
Request 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
response * (Stat)
Response time
Response 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
requestPlugin (StatPlugin)
Plugin execution time
Plugin execution time
name * (String)
Plugin name
Plugin name
total * (Stat)
total plugin time
total plugin 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
responsePlugin (StatPlugin)
Plugin execution time
Plugin execution time
name * (String)
Plugin name
Plugin name
total * (Stat)
total plugin time
total plugin 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
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 * (Stat)
Total access time
Total access 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
staticConfiguration (Stat)
Static configuration time
Static configuration 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
hotels * (Int)
Number of hotels
Number of hotels
zones * (Int)
Number of zones
Number of zones
cities * (Int)
Number of cities
Number of cities
requestAccess (StatPlugin)
Access request time
Access request time
name * (String)
Plugin name
Plugin name
total * (Stat)
total plugin time
total plugin 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
responseAccess (StatPlugin)
Access response time
Access response time
name * (String)
Plugin name
Plugin name
total * (Stat)
total plugin time
total plugin 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
transactions * (StatTransaction)
Detail transaction time
Detail transaction time
reference * (String)
Extra information about transaction.
Extra information about transaction.
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
buildRequest * (Stat)
Build request time
Build request 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
workerCommunication * (Stat)
Worker connection time
Worker connection 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
parseResponse * (Stat)
Parse response time
Parse response 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
plugins (StatPlugin)
Plugin execution time
Plugin execution time
name * (String)
Plugin name
Plugin name
total * (Stat)
total plugin time
total plugin 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
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).
booking (HotelBookingDetail)
Information about booking
Information about booking
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 * (Reference)
Booking ID references codes.
Booking ID references codes.
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
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
phone (String)
Phone contact
Phone 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.
title (Enum of PersonalTitleType)
Specifies the pax title.
Possible values:
MR
MRS
MISS
MS
NOT_SPECIFIED
Specifies the pax title.
Possible values:
MRMRSMISSMSNOT_SPECIFIEDrooms (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
price (Price)
Total price for all days.
Total price for all days.
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 * (Exchange)
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.
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
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.
price (Price)
Indicates the current price (Gross and Net) of the booked option. In the 'book' mutation, it shows the reservation price. In the 'booking' query (booking read), it reflects the current price; for example, it could be 0 if the reservation is cancelled and fully refundable, or the cancellation fee if there is any cost. If the provider is unable to return the current price in the query, the price returned by the provider will be used.
Indicates the current price (Gross and Net) of the booked option. In the 'book' mutation, it shows the reservation price. In the 'booking' query (booking read), it reflects the current price; for example, it could be 0 if the reservation is cancelled and fully refundable, or the cancellation fee if there is any cost. If the provider is unable to return the current price in the query, the price returned by the provider will be used.
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 * (Exchange)
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.
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
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.
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 Travelgate (true)
Specifies if the deadline has been taken from the seller’s response (false) or has been calculated by Travelgate (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 * (Enum of BookStatusType)
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
Possible values:
OK
ON_REQUEST
CANCELLED
UNKNOWN
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
Possible values:
OKON_REQUESTCANCELLEDUNKNOWNbillingSupplierCode (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 details provided by the different layers involved in the transaction.
Additional details provided by the different layers involved in the transaction.
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 (AddOn)
Extra information from the Supplier layer.
Extra information from the Supplier 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.
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 * (Holder)
Contains owner's name.
Contains owner's name.
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
phone (String)
Phone contact
Phone contact
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
ORGANIZATION
API_KEY
ACCESSSUPPLIERCLIENTPROVIDERMEMBERORGANIZATIONAPI_KEYactionType * (Enum of ActionType)
Possible values:
UPDATE
DELETE
CREATE
ARCHIVE
UNARCHIVE
ACTIVATE
DEACTIVATE
GRANT_TO_GROUPS
REVOKE_FROM_FROUPS
APPEND_PARAMETERS
DELETE_PARAMETERS
SET_FIELD
REMOVE_FIELD
ACTIVATE_SPEED
DEACTIVATE_SPEED
SET_IS_PUBLIC
UPDATE_MEMBER_IN_ORGANIZATION
REMOVE_MEMBER_SERVICE_ROLE
UPDATE_MEMBER_SERVICE_ROLE
REFRESH_TOKEN
UPDATEDELETECREATEARCHIVEUNARCHIVEACTIVATEDEACTIVATEGRANT_TO_GROUPSREVOKE_FROM_FROUPSAPPEND_PARAMETERSDELETE_PARAMETERSSET_FIELDREMOVE_FIELDACTIVATE_SPEEDDEACTIVATE_SPEEDSET_IS_PUBLICUPDATE_MEMBER_IN_ORGANIZATIONREMOVE_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 (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.
totalCount * (Int)
connectionType * (Enum of ProviderConnectionType)
Indicates connection type of Supplier
Possible values:
PULL
PUSH
HYBRID
Indicates connection type of Supplier
Possible values:
PULLPUSHHYBRIDserviceApi * (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 (EntityOwnerData)
Organization that owns the Supplier
Organization that owns the Supplier
code * (ID)
Organization unique code
Organization unique code
label * (String)
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 (AdviseMessage)
List of advise messages.
List of advise 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)
Context creation date
Context creation date
updatedAt * (DateTime)
Context last update date
Context last update date
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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)
GroupContent creation date
GroupContent creation date
updatedAt * (DateTime)
GroupContent last update date
GroupContent last update date
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
sharedDefault (Access)
Indicates if this supplier normally have a shared default access, means that the content is managed in one only site and this is because improve de efficiency
Indicates if this supplier normally have a shared default access, means that the content is managed in one only site and this is because improve de efficiency
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
supplierData (SupplierData)
Extended Supplier information
Extended Supplier information
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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)
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.
shared (Access)
Parent Access if Shared Access
Parent Access if Shared Access
owner (EntityOwnerData)
Access owner
Access owner
code * (ID)
Organization unique code
Organization unique code
label * (String)
updateDescriptiveInfo * (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
master (Access)
Parent Master Access. null=>masterAccess, notNull=>slaveAccess
Parent Master Access. null=>masterAccess, notNull=>slaveAccess
groups (GroupConnection)
Groups where access belongs
Groups where access belongs
edges (GroupEdge)
node (Group)
code * (ID)
groupData (GroupData)
id * (ID)
code * (ID)
label (String)
folder (String)
type * (Enum of GroupType)
Possible values:
ROOT
ORG
GROUP
TEAM
FOLDER
PRODUCT
RESOURCE
SPECIFIC_RESOURCE
ROOTORGGROUPTEAMFOLDERPRODUCTRESOURCESPECIFIC_RESOURCEinfo (String)
isPublic * (Boolean)
parent (Group)
children (GroupConnection)
Only responses children.(non-hierarchically)
Only responses children.(non-hierarchically)
descendents (GroupConnection)
Response all descendents groups nodes in this group (nom-hierarchically)
Response all descendents groups nodes in this group (nom-hierarchically)
parents (GroupConnection)
Response all parents groups nodes for this group (nom-hierarchically)
Response all parents groups nodes for this group (nom-hierarchically)
owner (Member)
code * (ID)
memberData (MemberData)
adviseMessage (AdviseMessage)
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)
siblings (GroupConnection)
Sibilings of the group
Sibilings of the group
members (MemberConnection)
Only responses members in this group
Only responses members in this group
edges (MemberEdge)
pageInfo * (PageInfo)
adviseMessage (AdviseMessage)
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.
apis (APIConnection)
APIs assigned to this group. Products have APIs.
APIs assigned to this group. Products have APIs.
edges (APIEdge)
pageInfo * (PageInfo)
managedGroups (ManagedGroupConnection)
Responses all managed groups by this group.
Responses all managed groups by this group.
edges (ManagedGroupEdge)
pageInfo * (PageInfo)
allMembers (MemberConnection)
Response all members in this group s childrens (hierarchically),
Response all members in this group s childrens (hierarchically),
edges (MemberEdge)
pageInfo * (PageInfo)
adviseMessage (AdviseMessage)
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.
accesses (AccessConnection)
Access resources in a group
Access resources in a group
edges (AccessEdge)
pageInfo * (PageInfo)
adviseMessage (AdviseMessage)
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
pageInfo * (PageInfo)
Page info of the connection
Page info of the connection
adviseMessage (AdviseMessage)
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
pageInfo * (PageInfo)
Page info of the connection
Page info of the connection
adviseMessage (AdviseMessage)
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.
roles (RoleConnection)
You can grant roles to members, which define the roles catalog for a group.
You can grant roles to members, which define the roles catalog for a group.
edges (RoleEdge)
pageInfo * (PageInfo)
isBuyer * (Boolean)
isSeller * (Boolean)
deleted_at (DateTime)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise messages.
code * (ID)
AM code: The following codes can be returned:
AM code: The following codes can be returned:
description * (String)
Error description
Error description
level * (Enum of AdviseMessageLevel)
Indicates the level of importance of the message.
Possible values: ERROR, WARN, INFO.
Possible values:
WARN
ERROR
INFO
Indicates the level of importance of the message. Possible values: ERROR, WARN, INFO.
Possible values:
WARNERRORINFOexternal (ExternalMessage)
Specify the external message.
Specify the external message.
code (String)
External code.
External code.
message * (String)
External message.
External message.
correlationID * (ID)
Identifier to investigate the cause of the error.
Identifier to investigate the cause of the error.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
audits * (EntityAuditConnection)
Audits it shows the accesses change history
Audits it shows the accesses 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
ORGANIZATION
API_KEY
ACCESSSUPPLIERCLIENTPROVIDERMEMBERORGANIZATIONAPI_KEYactionType * (Enum of ActionType)
Possible values:
UPDATE
DELETE
CREATE
ARCHIVE
UNARCHIVE
ACTIVATE
DEACTIVATE
GRANT_TO_GROUPS
REVOKE_FROM_FROUPS
APPEND_PARAMETERS
DELETE_PARAMETERS
SET_FIELD
REMOVE_FIELD
ACTIVATE_SPEED
DEACTIVATE_SPEED
SET_IS_PUBLIC
UPDATE_MEMBER_IN_ORGANIZATION
REMOVE_MEMBER_SERVICE_ROLE
UPDATE_MEMBER_SERVICE_ROLE
REFRESH_TOKEN
UPDATEDELETECREATEARCHIVEUNARCHIVEACTIVATEDEACTIVATEGRANT_TO_GROUPSREVOKE_FROM_FROUPSAPPEND_PARAMETERSDELETE_PARAMETERSSET_FIELDREMOVE_FIELDACTIVATE_SPEEDDEACTIVATE_SPEEDSET_IS_PUBLICUPDATE_MEMBER_IN_ORGANIZATIONREMOVE_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 (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.
totalCount * (Int)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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
deletedAt (DateTime)
Access deleted date
Access deleted date
accesses (AccessConnection)
Accesses of this Supplier
Accesses of this Supplier
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
supplierData (SupplierData)
Extended Supplier information
Extended Supplier information
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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)
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.
shared (Access)
Parent Access if Shared Access
Parent Access if Shared Access
owner (EntityOwnerData)
Access owner
Access owner
code * (ID)
Organization unique code
Organization unique code
label * (String)
updateDescriptiveInfo * (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
master (Access)
Parent Master Access. null=>masterAccess, notNull=>slaveAccess
Parent Master Access. null=>masterAccess, notNull=>slaveAccess
groups (GroupConnection)
Groups where access belongs
Groups where access belongs
edges (GroupEdge)
node (Group)
code * (ID)
groupData (GroupData)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
audits * (EntityAuditConnection)
Audits it shows the accesses change history
Audits it shows the accesses change history
edges (EntityAuditEdge)
node (EntityAudit)
code * (ID)
entityAuditData (EntityAuditData)
adviseMessage (AdviseMessage)
createdAt * (Time)
updatedAt * (Time)
deletedAt (Time)
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (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.
totalCount * (Int)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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
deletedAt (DateTime)
Access deleted date
Access deleted date
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
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
group (Group)
Indicates the group where the System belongs
Indicates the group where the System belongs
code * (ID)
groupData (GroupData)
id * (ID)
code * (ID)
label (String)
folder (String)
type * (Enum of GroupType)
Possible values:
ROOT
ORG
GROUP
TEAM
FOLDER
PRODUCT
RESOURCE
SPECIFIC_RESOURCE
ROOTORGGROUPTEAMFOLDERPRODUCTRESOURCESPECIFIC_RESOURCEinfo (String)
isPublic * (Boolean)
parent (Group)
children (GroupConnection)
Only responses children.(non-hierarchically)
Only responses children.(non-hierarchically)
edges (GroupEdge)
node (Group)
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
descendents (GroupConnection)
Response all descendents groups nodes in this group (nom-hierarchically)
Response all descendents groups nodes in this group (nom-hierarchically)
edges (GroupEdge)
node (Group)
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
parents (GroupConnection)
Response all parents groups nodes for this group (nom-hierarchically)
Response all parents groups nodes for this group (nom-hierarchically)
edges (GroupEdge)
node (Group)
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
owner (Member)
code * (ID)
memberData (MemberData)
id * (ID)
code * (ID)
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)
groups (GroupConnection)
which groups the member is in?
which groups the member is in?
edges (GroupEdge)
pageInfo * (PageInfo)
adviseMessage (AdviseMessage)
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.
roles (RoleConnection)
which roles the member has in?
which roles the member has in?
edges (RoleEdge)
pageInfo * (PageInfo)
macroPermissions (MacroPermissionsConnection)
edges (MacroPermissionEdge)
pageInfo * (PageInfo)
organizationMemberRoles (OrganizationMemberRole)
organization * (Organization)
role * (Enum of RoleMemberType)
Possible values:
phone (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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
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)
siblings (GroupConnection)
Sibilings of the group
Sibilings of the group
edges (GroupEdge)
node (Group)
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
members (MemberConnection)
Only responses members in this group
Only responses members in this group
edges (MemberEdge)
node (Member)
code * (ID)
memberData (MemberData)
adviseMessage (AdviseMessage)
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.
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
apis (APIConnection)
APIs assigned to this group. Products have APIs.
APIs assigned to this group. Products have APIs.
edges (APIEdge)
node (API)
code * (ID)
adviseMessage (AdviseMessage)
apiData (APIData)
createdAt * (Time)
updatedAt * (Time)
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
managedGroups (ManagedGroupConnection)
Responses all managed groups by this group.
Responses all managed groups by this group.
edges (ManagedGroupEdge)
node (ManagedGroup)
code * (ID)
managedGroupData (ManagedGroupData)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
allMembers (MemberConnection)
Response all members in this group s childrens (hierarchically),
Response all members in this group s childrens (hierarchically),
edges (MemberEdge)
node (Member)
code * (ID)
memberData (MemberData)
adviseMessage (AdviseMessage)
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.
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
accesses (AccessConnection)
Access resources in a group
Access resources in a group
edges (AccessEdge)
node (Access)
code * (ID)
accessData (AccessData)
adviseMessage (AdviseMessage)
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 * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
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
node (Supplier)
Supplier item
Supplier item
code * (ID)
Supplier unique code
Supplier unique code
supplierData (SupplierData)
Extended Supplier information
Extended Supplier information
adviseMessage (AdviseMessage)
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
cursor * (String)
Cursor to the next item
Cursor to the next item
pageInfo * (PageInfo)
Page info of the connection
Page info of the connection
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
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
adviseMessage (AdviseMessage)
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 * (PageInfo)
Page info of the connection
Page info of the connection
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
roles (RoleConnection)
You can grant roles to members, which define the roles catalog for a group.
You can grant roles to members, which define the roles catalog for a group.
edges (RoleEdge)
node (Role)
code * (ID)
roleData (RoleData)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
isBuyer * (Boolean)
isSeller * (Boolean)
deleted_at (DateTime)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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
owner (Organization)
System owner
System owner
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)
partner (Organization)
isPublic (Boolean)
children (GroupConnection)
Only responses folders.(non-hierarchically)
Only responses folders.(non-hierarchically)
edges (GroupEdge)
node (Group)
code * (ID)
groupData (GroupData)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
descendents (GroupConnection)
Response all descendents groups nodes in this group (nom-hierarchically)
Response all descendents groups nodes in this group (nom-hierarchically)
edges (GroupEdge)
node (Group)
code * (ID)
groupData (GroupData)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
parents (GroupConnection)
Response all parents groups nodes for this group (nom-hierarchically)
Response all parents groups nodes for this group (nom-hierarchically)
edges (GroupEdge)
node (Group)
code * (ID)
groupData (GroupData)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
owner * (Member)
code * (ID)
memberData (MemberData)
id * (ID)
code * (ID)
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)
groups (GroupConnection)
which groups the member is in?
which groups the member is in?
edges (GroupEdge)
pageInfo * (PageInfo)
adviseMessage (AdviseMessage)
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.
roles (RoleConnection)
which roles the member has in?
which roles the member has in?
edges (RoleEdge)
pageInfo * (PageInfo)
macroPermissions (MacroPermissionsConnection)
edges (MacroPermissionEdge)
pageInfo * (PageInfo)
organizationMemberRoles (OrganizationMemberRole)
organization * (Organization)
role * (Enum of RoleMemberType)
Possible values:
phone (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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
deletedAt * (DateTime)
Date deleted. This value is used to include archived members.
Date deleted. This value is used to include archived members.
contacts (OrganizationContact)
Differents contacts in a organization.
Differents contacts in a organization.
type * (Enum of OrganizationContactType)
Possible values:
ADMIN
BILLING
SALES
TECHNICAL
OTHER
ADMINBILLINGSALESTECHNICALOTHERuser * (Member)
code * (ID)
memberData (MemberData)
id * (ID)
code * (ID)
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
groups (GroupConnection)
which groups the member is in?
which groups the member is in?
roles (RoleConnection)
which roles the member has in?
which roles the member has in?
macroPermissions (MacroPermissionsConnection)
organizationMemberRoles (OrganizationMemberRole)
phone (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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:
Indicates the level of importance of the message. Possible values: ERROR, WARN, INFO.
Possible values:
external (ExternalMessage)
Specify the external message.
Specify the 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
deletedAt * (DateTime)
Date deleted. This value is used to include archived members.
Date deleted. This value is used to include archived members.
isEditable * (Boolean)
members (MemberConnection)
edges (MemberEdge)
node (Member)
code * (ID)
memberData (MemberData)
adviseMessage (AdviseMessage)
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.
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
apis (APIConnection)
APIs assigned to this group. Products have APIs.
APIs assigned to this group. Products have APIs.
edges (APIEdge)
node (API)
code * (ID)
adviseMessage (AdviseMessage)
apiData (APIData)
createdAt * (Time)
updatedAt * (Time)
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
products (ProductConnection)
Products asign to a organization
Products asign to a organization
edges (ProductEdge)
node (Product)
code * (ID)
productData * (ProductData)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
allMembers (MemberConnection)
Response all members in this group s childrens (hierarchically)
Response all members in this group s childrens (hierarchically)
edges (MemberEdge)
node (Member)
code * (ID)
memberData (MemberData)
adviseMessage (AdviseMessage)
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.
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
accesses (AccessConnection)
Access resources in a group
Access resources in a group
edges (AccessEdge)
node (Access)
code * (ID)
accessData (AccessData)
adviseMessage (AdviseMessage)
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 * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
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
node (Supplier)
Supplier item
Supplier item
code * (ID)
Supplier unique code
Supplier unique code
supplierData (SupplierData)
Extended Supplier information
Extended Supplier information
adviseMessage (AdviseMessage)
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
cursor * (String)
Cursor to the next item
Cursor to the next item
pageInfo * (PageInfo)
Page info of the connection
Page info of the connection
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
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
adviseMessage (AdviseMessage)
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 * (PageInfo)
Page info of the connection
Page info of the connection
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
domains * (Domain)
code * (ID)
domainData (DomainData)
id * (ID)
name * (DomainName)
organization * (Organization)
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 * (DateTime)
updatedAt * (DateTime)
template (String)
allAccesses (AccessConnection)
Access resources in this organization
Access resources in this organization
edges (AccessEdge)
node (Access)
code * (ID)
accessData (AccessData)
adviseMessage (AdviseMessage)
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 * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
allSuppliers (SupplierConnection)
Supplier resources in this organization
Supplier resources in this organization
edges (SupplierEdge)
Supplier edges of Supplier connection
Supplier edges of Supplier connection
node (Supplier)
Supplier item
Supplier item
code * (ID)
Supplier unique code
Supplier unique code
supplierData (SupplierData)
Extended Supplier information
Extended Supplier information
adviseMessage (AdviseMessage)
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
cursor * (String)
Cursor to the next item
Cursor to the next item
pageInfo * (PageInfo)
Page info of the connection
Page info of the connection
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
allClients (ClientConnection)
Clients resources in this organization
Clients resources in this organization
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
adviseMessage (AdviseMessage)
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 * (PageInfo)
Page info of the connection
Page info of the connection
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
totalCount * (Int)
Identifies the total count of items in the connection.
Identifies the total count of items in the connection.
primaryPartner * (Partner)
code * (ID)
partnerData (PartnerData)
code * (ID)
cusXYZ..
cusXYZ..
name * (String)
isActive (Boolean)
friendlyName (String)
organizations (OrganizationConnection)
edges (OrganizationEdge)
pageInfo * (PageInfo)
adviseMessage (AdviseMessage)
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 Travelgate
Differents agents from Travelgate
type * (Enum of CustomerAgentType)
Possible values:
user * (Member)
user@travelgate.com
user@travelgate.com
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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
allPartners * (PartnerConnection)
edges (PartnerEdge)
node (Partner)
code * (ID)
partnerData (PartnerData)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise messages.
createdAt * (DateTime)
Date created
Date created
updatedAt * (DateTime)
Date updated
Date updated
cursor * (String)
pageInfo * (PageInfo)
hasNextPage * (Boolean)
hasPreviousPage * (Boolean)
startCursor (String)
endCursor (String)
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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.
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 (AdviseMessage)
List of advise messages.
List of advise 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
suppliers * (Supplier)
Obtain all suppliers for a filter.
Obtain all suppliers for a filter.
code * (ID)
Supplier unique code
Supplier unique code
supplierData (SupplierData)
Extended Supplier information
Extended Supplier information
adviseMessage (AdviseMessage)
List of advise messages.
List of advise 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)
Supplier creation date
Supplier creation date
updatedAt * (DateTime)
Supplier last update date
Supplier last update date
deletedAt (DateTime)
Supplier deleted date
Supplier deleted date
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 * (EntityAuditConnection)
Audits it shows the supplier's change history
Audits it shows the supplier'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
ORGANIZATION
API_KEY
ACCESSSUPPLIERCLIENTPROVIDERMEMBERORGANIZATIONAPI_KEYactionType * (Enum of ActionType)
Possible values:
UPDATE
DELETE
CREATE
ARCHIVE
UNARCHIVE
ACTIVATE
DEACTIVATE
GRANT_TO_GROUPS
REVOKE_FROM_FROUPS
APPEND_PARAMETERS
DELETE_PARAMETERS
SET_FIELD
REMOVE_FIELD
ACTIVATE_SPEED
DEACTIVATE_SPEED
SET_IS_PUBLIC
UPDATE_MEMBER_IN_ORGANIZATION
REMOVE_MEMBER_SERVICE_ROLE
UPDATE_MEMBER_SERVICE_ROLE
REFRESH_TOKEN
UPDATEDELETECREATEARCHIVEUNARCHIVEACTIVATEDEACTIVATEGRANT_TO_GROUPSREVOKE_FROM_FROUPSAPPEND_PARAMETERSDELETE_PARAMETERSSET_FIELDREMOVE_FIELDACTIVATE_SPEEDDEACTIVATE_SPEEDSET_IS_PUBLICUPDATE_MEMBER_IN_ORGANIZATIONREMOVE_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 (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.
totalCount * (Int)
serviceIntegrationData (ServiceIntegrationData)
Service Integration Data
Service Integration Data
type (Enum of ServiceIntegrationType)
Possible values:
SITH
WORKER
CONNECTORS
SITHWORKERCONNECTORSoptionsQuota (Int)
isPublic * (Boolean)
giata (GiataSupplierConfiguration)
giataType (String)
giataCode (String)
vccAccess * (String)
Indicates the vcc access code used to generate the payment card
Indicates the vcc access code used to generate the payment card
surcharges (Surcharge)
List of surcharges of the option returned.
List of surcharges of the option returned.
code (String)
Indicates the surcharge code
Indicates the surcharge code
chargeType * (Enum of ChargeType)
Indicates the charge type. We need to know whether the supplements have to be paid when the consumer gets to the hotel or beforehand.
Possible charge types: INCLUDE or EXCLUDE.
when INCLUDE : this surcharge is mandatory and included in the option s price
when EXCLUDE : this surcharge is not included in the option s price
Possible values:
INCLUDE
EXCLUDE
Indicates the charge type. We need to know whether the supplements have to be paid when the consumer gets to the hotel or beforehand. Possible charge types: INCLUDE or EXCLUDE. when INCLUDE : this surcharge is mandatory and included in the option s price when EXCLUDE : this surcharge is not included in the option s price
Possible values:
INCLUDEEXCLUDEmandatory * (Boolean)
Indicates if the surcharge is mandatory or not. If mandatory, this surcharge will be applied to this option.
If the chargeType is EXCLUDE the customer will have to pay it directly at the hotel.
Indicates if the surcharge is mandatory or not. If mandatory, this surcharge will be applied to this option. If the chargeType is EXCLUDE the customer will have to pay it directly at the hotel.
price * (Price)
Indicates the surcharge price.
Indicates the surcharge price.
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 * (Exchange)
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.
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
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.
description (String)
Specifies the surcharge description.
Specifies the surcharge description.
supplements (Supplement)
List of supplements of the option returned.
List of supplements of the option returned.
code * (String)
Specifies the supplement code.
Specifies the supplement code.
name (String)
Specifies the supplement name.
Specifies the supplement name.
description (String)
Specifies the supplement description.
Specifies the supplement description.
supplementType (Enum of SupplementType)
Indicates the supplement type. Possible types: Fee, Ski_pass, Lessons, Meals, Equipment, Ticket, Transfers, Gla, Activity or Other.
Possible values:
SKI_PASS
LESSONS
MEALS
EQUIPMENT
TICKET
TRANSFERS
GALA
ACTIVITY
OTHER
Indicates the supplement type. Possible types: Fee, Ski_pass, Lessons, Meals, Equipment, Ticket, Transfers, Gla, Activity or Other.
Possible values:
SKI_PASSLESSONSMEALSEQUIPMENTTICKETTRANSFERSGALAACTIVITYOTHERchargeType * (Enum of ChargeType)
Indicates the charge types. We need to know whether the supplements have to be paid when the consumer gets to the hotel or beforehand.
Possible charge types: INCLUDE or EXCLUDE.
when INCLUDE : this supplement is mandatory and included in the option s price
when EXCLUDE : this supplement is not included in the option s price
Possible values:
INCLUDE
EXCLUDE
Indicates the charge types. We need to know whether the supplements have to be paid when the consumer gets to the hotel or beforehand. Possible charge types: INCLUDE or EXCLUDE. when INCLUDE : this supplement is mandatory and included in the option s price when EXCLUDE : this supplement is not included in the option s price
Possible values:
INCLUDEEXCLUDEmandatory * (Boolean)
Indicates if the supplement is mandatory or not. If mandatory, this supplement will be applied to this option.
If the chargeType is EXCLUDE the customer will have to pay it directly at the hotel
Indicates if the supplement is mandatory or not. If mandatory, this supplement will be applied to this option. If the chargeType is EXCLUDE the customer will have to pay it directly at the hotel
durationType (Enum of DurationType)
Specifies the duration type. Possible duration types: Range (specified dates) or Open. This field is mandatory for PDI.
Possible values:
RANGE
OPEN
Specifies the duration type. Possible duration types: Range (specified dates) or Open. This field is mandatory for PDI.
Possible values:
RANGEOPENquantity (Int)
Indicates the quantity of field in the element "unit".
Indicates the quantity of field in the element "unit".
unit (Enum of UnitTimeType)
Indicates the unit type. Possible unit types: Day or Hour.
Possible values:
DAY
HOUR
Indicates the unit type. Possible unit types: Day or Hour.
Possible values:
DAYHOURstart (Date)
Indicates the effective date of the supplement.
Format: YYYY-MM-DD
Indicates the effective date of the supplement. Format: YYYY-MM-DD
end (Date)
Indicates the expire date of the supplement.
Format: YYYY-MM-DD
Indicates the expire date of the supplement. Format: YYYY-MM-DD
resort (Resort)
Contains information about the resort
Contains information about the resort
code * (String)
Specifies the resort code.
Specifies the resort code.
name (String)
Specifies the resort name.
Specifies the resort name.
description (String)
Specifies the resort description.
Specifies the resort description.
price (Price)
Indicates the supplement price.
Indicates the supplement price.
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 * (Exchange)
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.
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
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.
errors (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.
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
accessCode (String)
Access code related to the warning
Access code related to the warning
Examples
Frequently Asked Questions
What should I do if I receive both an OK status and an error in the same Book response?
What is the DeltaPrice? Why should I use it?
What does DeltaPrice "applyBoth" mean?
- If the value is 'false' it indicates that one of the conditions (amount or percentage) has to meet the DeltaPrice criteria before reservation.
- If the value is 'true' it indicates that the new price cannot exceed the amount and percentage indicated by the Buyer.
Why do I receive a status "ON_REQUEST" and a holder name "test" in my reservations the test environment?
Will the currency in Book be the same as the currency in Quote?
Do I have to provide real names and ages for all the passengers?
How do I define the total number of rooms in my Book request?
To define the number of rooms in your reservation, you need to utilize the occupancyRefId previously returned in Search response.For instance, for a room of two adults:
"rooms": [
{
"occupancyRefId": 1,
"paxes": [
{
"name": "TestName",
"surname": "Surname",
"age": 30
},
{
"name": "TestName",
"surname": "Surname",
"age": 30
}
]
}
]
What payment details should I add to my Book request?
Where can I get the Hotel Confirmation Number (HCN)?
Once a booking has been successfully confirmed in Travelgate you may retrieve 2 different locators from its logs:
- The Buyer's locator (client reference).
- The Seller's locator (provider reference).
The Seller may also provide a third type of locator, issued by the hotel when it confirms the booking. This is known as the Hotel Confirmation Number (HCN) or Hotel Reference Booking (HRB). Please note we are only able to provide this code if the Seller returns it in their response.