Skip to main content

Cancel

The Cancel operation allows you to cancel a booking made via TravelgateX. The returned fields include: ProviderLocator, CancelId, TransactionStatus, Price etc.

Cancel Request

<soapenv:Envelope xmlns:soapenv = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns = "http://schemas.xmltravelgate.com/hub/2012/06" xmlns:wsse = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<soapenv:Header>
<wsse:Security>
<wsse:UsernameToken>
<wsse:Username>username</wsse:Username>
<wsse:Password>password</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<ns:Cancel>
<ns:cancelRQ>
<ns:timeoutMilliseconds>20000</ns:timeoutMilliseconds>
<ns:version>1</ns:version>
<ns:providerRQ>
<ns:code>suppliercode</ns:code>
<ns:id>1</ns:id>
<ns:rqXML>
<CancelRQ xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd = "http://www.w3.org/2001/XMLSchema" hotelCode = "">
<timeoutMilliseconds>19700</timeoutMilliseconds>
<source>
<languageCode>en</languageCode>
</source>
<filterAuditData>
<registerTransactions>true</registerTransactions>
</filterAuditData>
<Configuration>
<User>user</User>
<Password>password</Password>
<UrlAvail>www.supplier.com/avail</UrlAvail>
<UrlReservation>www.supplier.com/reservation</UrlReservation>
<UrlValuation>www.supplier.com/valuation</UrlValuation>
<UrlGeneric>www.supplier.com/generic</UrlGeneric>
<Parameters>
<Parameter key = "UrlListHotels" value = "http://www.supplier.com/ListHotels"></Parameter>
<Parameter key = "Access" value = "22334"></Parameter>
</Parameters>
</Configuration>
<Locators>
<Client>XXXXXXX</Client>
<Provider>XXXXXXX</Provider>
<Property>XXXXXXX</Property>
</Locators>
<StartDate>28/11/2014</StartDate>
<EndDate>28/11/2014</EndDate>
<Holder title = "Miss" name = "Test11" surname = "TestAp11"/>
</CancelRQ>
</ns:rqXML>
</ns:providerRQ>
</ns:cancelRQ>
</ns:Cancel>
</soapenv:Body>
</soapenv:Envelope>

Request Data Breakdown

ElementNumberTypeDescription
CancelRQ1Root node.
@hotelCode1StringHotel code.
CancelRQ/Locators1Locator Information (it's mandatory to indicate either the client or supplier's).
Locators/Client0..1StringClient locator.
Locators/Provider0..1StringSupplier locator.
Locators/Property0..1StringProperty locator (see MetaData method in order to verify if the supplier implements it).
CancelRQ/StartDate1StringStart date of booking.
CancelRQ/EndDate1StringEnd date of booking.
CancelRQ/Holder0..1Holder of the booking.
@title1StringHolder’s title. Possible values: Mr, Mrs, Miss, Ms
@name1StringHolder's name.
@surname1StringHolder's surname.

Cancel Response

After each request, you will process the data and provide a response. Upon receiving a Cancel request, you will need to send a corresponding Cancel response.

The response options include either success or an error. In the event of success, you will send the transaction status.

Success

<CancelRS>
<ProviderLocator>YYYYYYYY</ProviderLocator>
<CancelId>0000000</CancelId>
<TransactionStatus>
<ComunicationStatus>OK</ComunicationStatus>
<RSStatus>EXISTE</RSStatus>
<ResStatus>CN</ResStatus>
</TransactionStatus>
<Price currency="EUR" amount="120.5" binding="false" commission="-1" minimumSellingPrice="-1"/>
</CancelRS>

Success Response Data Breakdown

ElementRelTypeDescription
CancelRS1Root node.
CancelRS/ProviderLocator1StringSupplier locator.
CancelRS/CancelId0..1StringCancellation id.
CancelRS/TransactionStatus1Transaction Status.
TransactionStatus/ComunicationStatus1StringStatus communication (OFFLINE, OK and KO).
TransactionStatus/RSStatus1String
Response Status
Status Description
DESCONOCIDO Unknown
EXISTE Exists
EXISTECANCELADA exists but it's cancelled
NO_EXISTE Does not exist
TransactionStatus/ResStatus1String
Reservation Status
Status Code Description
OK The reservation was completed with no problems.
RQ The reservation was completed but the product is still not available, so the reservation goes into a waiting list (Request).
CN The reservation was completed but due to a supplier error or a timeout the system will immediately cancel the reservation to prevent further possible errors.
UN The reservation was completed but due to a supplier error or a timeout, the reservation status is unknown. It is the client’s responsibility to check if the booking is OK.
CancelRS/Price0..1DecimalFee for the cancellation. (see MetaData in order to verify if supplier informs of it).
@currency1StringCurrency code (Our system uses a standard ISO - 3 for all suppliers).
@amount1DecimalAmount.
@binding1BooleanIf binding is set as true, then the client can’t sell the product for a lower price that the one set by the supplier. If it set as as false, the client can sell the product for a lower price.
@commission1Decimal
Commission Scenarios
Commission Description
0 The price returned is net.
-1 The supplier has not supplied the sale price nor the commission. This information is in the commercial contract with the supplier.
Greater than 0 X = % of the commission applied to the amount.
@minimumSellingPrice1DecimalIndicates the minimum selling price it can be sold (determined by the Seller). If is specified (different than "-1"), that field takes preference to amount.
Minimum Selling Price Scenarios
Minimum Selling Price Description
0 No minimum selling price is provided.
-1 We have no information about MSP from the Seller.
Greater than 0 The lowest possible amount that can be sold commercially.

Error

<CancelRS>
<operationImplemented>true</operationImplemented>
<applicationError>
<code/>
<type>105</type>
<description>Communication Error.</description>
<httpStatusCode>0</httpStatusCode>
</applicationError>
</CancelRS>
Error codes that you will need to include in the response in the event of an error
Error CodeError Description
101System Exception (Exception not controlled or not classified as general exception).
102Supplier Error.
103Too many requests to the supplier.
104Timeout (Timeout during the execution of an operation (look in the common attribute timeout )).
105Communication Error.
204Supplier returns 0 results in availability.
205The Supplier doesn’t accept the distribution RQ.
206The Supplier doesn’t accept the dates RQ.
207The Supplier doesn’t accept the request RQ.
301Option not found in policies.
302Hotel Not Found in DescriptiveInfo.
303Booking not confirmed in the supplier’s system.