Sample Requests

Introduction

The SwOTA API supports both REST and SOAP protocols. REST is the recommended protocol for new integrations.

Protocol Comparison

Aspect	REST	SOAP
Endpoint	`https://bookings.sw.travelhx.com/ota/rest/<MessageName>`	`https://bookings.travelhx.com:8082/ota/ws`
Authentication	Auth0 Bearer Token	SSL Client Certificate
Request Format	Direct OTA message	Wrapped in SOAP Envelope

For detailed protocol documentation, see:

REST Testing Guide - REST setup and Auth0 authentication
SOAP Testing Guide - SOAP setup and SSL certificates
API Protocols - Technical protocol details

Sample Request Examples

Each example below shows both REST and SOAP versions of the same operation.

Ping

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_PingRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_PingRQ xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" TimeStamp="2025-01-01T12:00:00Z">
<EchoData>Test ping message</EchoData>
</OTA_PingRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_PingRQ xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" TimeStamp="2025-01-01T12:00:00Z">
<EchoData>Test ping message</EchoData>
</OTA_PingRQ>
</Body>
</Envelope>

Sailing Availability

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_CruiseSailAvailRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_CruiseSailAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<SailingDateRange Start="2025-01-01" End="2025-03-31" />
</OTA_CruiseSailAvailRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_CruiseSailAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<SailingDateRange Start="2025-01-01" End="2025-03-31" />
</OTA_CruiseSailAvailRQ>
</Body>
</Envelope>

Category Availability

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_CruiseCategoryAvailRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_CruiseCategoryAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<Guest/>
<Guest/>
<GuestCounts>
<GuestCount Code="10" Quantity="2"/>
</GuestCounts>
<SailingInfo>
<SelectedSailing VoyageID="TEST0123">
<CruiseLine/>
</SelectedSailing>
</SailingInfo>
<SelectedFare FareCode="BESTPRICE"/>
</OTA_CruiseCategoryAvailRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_CruiseCategoryAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<Guest/>
<Guest/>
<GuestCounts>
<GuestCount Code="10" Quantity="2"/>
</GuestCounts>
<SailingInfo>
<SelectedSailing VoyageID="TEST0123">
<CruiseLine/>
</SelectedSailing>
</SailingInfo>
<SelectedFare FareCode="BESTPRICE"/>
</OTA_CruiseCategoryAvailRQ>
</Body>
</Envelope>

Cabin Availability

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_CruiseCabinAvailRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_CruiseCabinAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID Type="5" ID_Context="SEAWARE" ID="12345" />
</Source>
</POS>
<GuestCounts>
<GuestCount Code="10" Quantity="2" />
</GuestCounts>
<SailingInfo>
<SelectedSailing VoyageID="TRIP0123">
<CruiseLine VendorCode="VEND" />
</SelectedSailing>
<SelectedCategory PricedCategoryCode="SS1" />
</SailingInfo>
<SelectedFare FareCode="F1"/>
</OTA_CruiseCabinAvailRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_CruiseCabinAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID Type="5" ID_Context="SEAWARE" ID="12345" />
</Source>
</POS>
<GuestCounts>
<GuestCount Code="10" Quantity="2" />
</GuestCounts>
<SailingInfo>
<SelectedSailing VoyageID="TRIP0123">
<CruiseLine VendorCode="VEND" />
</SelectedSailing>
<SelectedCategory PricedCategoryCode="SS1" />
</SailingInfo>
<SelectedFare FareCode="F1"/>
</OTA_CruiseCabinAvailRQ>
</Body>
</Envelope>

Price a Booking

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_CruisePriceBookingRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_CruisePriceBookingRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<GuestCounts>
<GuestCount Code="10" Quantity="1"/>
</GuestCounts>
<SailingInfo>
<SelectedSailing VoyageID="VOYAGE0123">
<CruiseLine/>
</SelectedSailing>
<SelectedCategory PricedCategoryCode="SS1">
<SelectedCabin CabinNumber="10218" Status="36"/>
</SelectedCategory>
</SailingInfo>
<ReservationInfo>
<GuestDetails>
<GuestDetail>
<ContactInfo>
<PersonName>
<GivenName>John</GivenName>
<Surname>Doe</Surname>
</PersonName>
</ContactInfo>
</GuestDetail>
</GuestDetails>
</ReservationInfo>
</OTA_CruisePriceBookingRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_CruisePriceBookingRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<GuestCounts>
<GuestCount Code="10" Quantity="1"/>
</GuestCounts>
<SailingInfo>
<SelectedSailing VoyageID="VOYAGE0123">
<CruiseLine/>
</SelectedSailing>
<SelectedCategory PricedCategoryCode="SS1">
<SelectedCabin CabinNumber="10218" Status="36"/>
</SelectedCategory>
</SailingInfo>
<ReservationInfo>
<GuestDetails>
<GuestDetail>
<ContactInfo>
<PersonName>
<GivenName>John</GivenName>
<Surname>Doe</Surname>
</PersonName>
</ContactInfo>
</GuestDetail>
</GuestDetails>
</ReservationInfo>
</OTA_CruisePriceBookingRQ>
</Body>
</Envelope>

Hold a Cabin

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_CruiseCabinHoldRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_CruiseCabinHoldRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<GuestCounts>
<GuestCount Code="10" Quantity="3"/>
</GuestCounts>
<SelectedSailing VoyageID="VOYAGE0123">
<SelectedCategory PricedCategoryCode="SS1">
<SelectedCabin CabinNumber="10218" />
<SelectedCabin CabinNumber="10220" />
</SelectedCategory>
<SelectedCategory PricedCategoryCode="SS2">
<SelectedCabin CabinNumber="10003" />
</SelectedCategory>
</SelectedSailing>
</OTA_CruiseCabinHoldRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_CruiseCabinHoldRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<GuestCounts>
<GuestCount Code="10" Quantity="3"/>
</GuestCounts>
<SelectedSailing VoyageID="VOYAGE0123">
<SelectedCategory PricedCategoryCode="SS1">
<SelectedCabin CabinNumber="10218" />
<SelectedCabin CabinNumber="10220" />
</SelectedCategory>
<SelectedCategory PricedCategoryCode="SS2">
<SelectedCabin CabinNumber="10003" />
</SelectedCategory>
</SelectedSailing>
</OTA_CruiseCabinHoldRQ>
</Body>
</Envelope>

Create a Booking

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_CruiseBookRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_CruiseBookRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<SailingInfo>
<SelectedSailing VoyageID="VOYAGE0123">
<CruiseLine/>
</SelectedSailing>
<SelectedCategory PricedCategoryCode="SS1">
<SelectedCabin CabinNumber="10218" GuestRefNumbers="1 2" Status="36"/>
<SelectedCabin CabinNumber="10220" GuestRefNumbers="3" Status="36"/>
</SelectedCategory>
<SelectedCategory PricedCategoryCode="SS2">
<SelectedCabin CabinNumber="10003" GuestRefNumbers="4 5" Status="36"/>
</SelectedCategory>
</SailingInfo>
<ReservationInfo>
<GuestDetails>
<!-- Guest 1 -->
<GuestDetail>
<ContactInfo>
<PersonName>
<GivenName>Alice</GivenName>
<Surname>Williams</Surname>
</PersonName>
</ContactInfo>
</GuestDetail>
<!-- Guest 2 -->
<GuestDetail>
<ContactInfo>
<PersonName>
<GivenName>Bob</GivenName>
<Surname>Jones</Surname>
</PersonName>
</ContactInfo>
</GuestDetail>
<!-- Guest 3 -->
<GuestDetail>
<ContactInfo>
<PersonName>
<GivenName>Charlie</GivenName>
<Surname>Brown</Surname>
</PersonName>
</ContactInfo>
</GuestDetail>
<!-- Guest 4 -->
<GuestDetail>
<ContactInfo>
<PersonName>
<GivenName>Diana</GivenName>
<Surname>Miller</Surname>
</PersonName>
</ContactInfo>
</GuestDetail>
<!-- Guest 5 -->
<GuestDetail>
<ContactInfo>
<PersonName>
<GivenName>Eve</GivenName>
<Surname>Davis</Surname>
</PersonName>
</ContactInfo>
</GuestDetail>
</GuestDetails>
</ReservationInfo>
</OTA_CruiseBookRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_CruiseBookRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<SailingInfo>
<SelectedSailing VoyageID="VOYAGE0123">
<CruiseLine/>
</SelectedSailing>
<SelectedCategory PricedCategoryCode="SS1">
<SelectedCabin CabinNumber="10218" GuestRefNumbers="1 2" Status="36"/>
<SelectedCabin CabinNumber="10220" GuestRefNumbers="3" Status="36"/>
</SelectedCategory>
<SelectedCategory PricedCategoryCode="SS2">
<SelectedCabin CabinNumber="10003" GuestRefNumbers="4 5" Status="36"/>
</SelectedCategory>
</SailingInfo>
<ReservationInfo>
<GuestDetails>
<!-- Guest 1 -->
<GuestDetail>
<ContactInfo>
<PersonName>
<GivenName>Alice</GivenName>
<Surname>Williams</Surname>
</PersonName>
</ContactInfo>
</GuestDetail>
<!-- Guest 2 -->
<GuestDetail>
<ContactInfo>
<PersonName>
<GivenName>Bob</GivenName>
<Surname>Jones</Surname>
</PersonName>
</ContactInfo>
</GuestDetail>
<!-- Guest 3 -->
<GuestDetail>
<ContactInfo>
<PersonName>
<GivenName>Charlie</GivenName>
<Surname>Brown</Surname>
</PersonName>
</ContactInfo>
</GuestDetail>
<!-- Guest 4 -->
<GuestDetail>
<ContactInfo>
<PersonName>
<GivenName>Diana</GivenName>
<Surname>Miller</Surname>
</PersonName>
</ContactInfo>
</GuestDetail>
<!-- Guest 5 -->
<GuestDetail>
<ContactInfo>
<PersonName>
<GivenName>Eve</GivenName>
<Surname>Davis</Surname>
</PersonName>
</ContactInfo>
</GuestDetail>
</GuestDetails>
</ReservationInfo>
</OTA_CruiseBookRQ>
</Body>
</Envelope>

Retrieve a Booking

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_ReadRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_ReadRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<UniqueID Type="14" ID="12345" ID_Context="SEAWARE"/> <!-- 14 = Booking Reference -->
</OTA_ReadRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_ReadRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<UniqueID Type="14" ID="12345" ID_Context="SEAWARE"/> <!-- 14 = Booking Reference -->
</OTA_ReadRQ>
</Body>
</Envelope>

Cancel a Booking

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_CancelRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_CancelRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0" CancelType="Cancel">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<UniqueID Type="14" ID="12345" ID_Context="SEAWARE"/> <!-- 14 = Booking Reference -->
<Verification/>
</OTA_CancelRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_CancelRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0" CancelType="Cancel">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<UniqueID Type="14" ID="12345" ID_Context="SEAWARE"/> <!-- 14 = Booking Reference -->
<Verification/>
</OTA_CancelRQ>
</Body>
</Envelope>

Unhold a Cabin

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_CruiseCabinUnholdRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_CruiseCabinUnholdRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<SelectedSailing VoyageID="RAINBOWLAND0123">
<SelectedCabin CabinNumber="10218"/>
</SelectedSailing>
</OTA_CruiseCabinUnholdRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_CruiseCabinUnholdRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<SelectedSailing VoyageID="RAINBOWLAND0123">
<SelectedCabin CabinNumber="10218"/>
</SelectedSailing>
</OTA_CruiseCabinUnholdRQ>
</Body>
</Envelope>

Dining Availability

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_CruiseDiningAvailRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_CruiseDiningAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<GuestCounts>
<GuestCount Code="10" Quantity="2"/>
</GuestCounts>
<SailingInfo>
<SelectedSailing VoyageID="VOYAGE0123">
<CruiseLine/>
</SelectedSailing>
</SailingInfo>
<SelectedFare FareCode="BESTPRICE"/>
</OTA_CruiseDiningAvailRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_CruiseDiningAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<GuestCounts>
<GuestCount Code="10" Quantity="2"/>
</GuestCounts>
<SailingInfo>
<SelectedSailing VoyageID="VOYAGE0123">
<CruiseLine/>
</SelectedSailing>
</SailingInfo>
<SelectedFare FareCode="BESTPRICE"/>
</OTA_CruiseDiningAvailRQ>
</Body>
</Envelope>

Shore Excursion Availability

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_CruiseShorexAvailRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_CruiseShorexAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<GuestCounts>
<GuestCount Code="10" Quantity="2"/>
</GuestCounts>
<SailingInfo>
<SelectedSailing VoyageID="VOYAGE0123">
<CruiseLine/>
</SelectedSailing>
</SailingInfo>
<ShorexOption PackageTypeCode="1"/>
</OTA_CruiseShorexAvailRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_CruiseShorexAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<GuestCounts>
<GuestCount Code="10" Quantity="2"/>
</GuestCounts>
<SailingInfo>
<SelectedSailing VoyageID="VOYAGE0123">
<CruiseLine/>
</SelectedSailing>
</SailingInfo>
<ShorexOption PackageTypeCode="1"/>
</OTA_CruiseShorexAvailRQ>
</Body>
</Envelope>

Cancellation Pricing

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_CruiseCancellationPricingRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_CruiseCancellationPricingRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<ReservationID Type="14" ID="12345" ID_Context="SEAWARE"/>
</OTA_CruiseCancellationPricingRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_CruiseCancellationPricingRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<ReservationID Type="14" ID="12345" ID_Context="SEAWARE"/>
</OTA_CruiseCancellationPricingRQ>
</Body>
</Envelope>

Booking History

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_ReadRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_ReadRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<ReadRequests>
<ReadRequest HistoryRequestedInd="true">
<UniqueID ID="12345" Type="14" ID_Context="SEAWARE"/>
</ReadRequest>
</ReadRequests>
</OTA_ReadRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_ReadRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<ReadRequests>
<ReadRequest HistoryRequestedInd="true">
<UniqueID ID="12345" Type="14" ID_Context="SEAWARE"/>
</ReadRequest>
</ReadRequests>
</OTA_ReadRQ>
</Body>
</Envelope>

Create a Guest Profile

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_ProfileCreateRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_ProfileCreateRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<UniqueID ID="999" Type="1" ID_Context="SEAWARE"/>
<Profile>
<Customer>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Smith</Surname>
</PersonName>
<Telephone PhoneTechType="1" PhoneNumber="555-555-5555" />
<Email>jane.smith@example.com&lt;/Email&gt;
</Customer>
</Profile>
</OTA_ProfileCreateRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_ProfileCreateRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<UniqueID ID="999" Type="1" ID_Context="SEAWARE"/>
<Profile>
<Customer>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Smith</Surname>
</PersonName>
<Telephone PhoneTechType="1" PhoneNumber="555-555-5555" />
<Email>jane.smith@example.com&lt;/Email&gt;
</Customer>
</Profile>
</OTA_ProfileCreateRQ>
</Body>
</Envelope>

Read a Guest Profile

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_ReadRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_ReadRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<ReadRequests>
<ProfileReadRequest>
<UniqueID ID="PROFILE123" Type="1" ID_Context="SEAWARE"/>
</ProfileReadRequest>
</ReadRequests>
</OTA_ReadRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_ReadRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<ReadRequests>
<ProfileReadRequest>
<UniqueID ID="PROFILE123" Type="1" ID_Context="SEAWARE"/>
</ProfileReadRequest>
</ReadRequests>
</OTA_ReadRQ>
</Body>
</Envelope>

Modify a Guest Profile

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_ProfileModifyRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_ProfileModifyRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<UniqueID ID="PROFILE123" Type="1" ID_Context="SEAWARE"/>
<ProfileModify>
<Customer>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Smith-Jones</Surname>
</PersonName>
</Customer>
</ProfileModify>
</OTA_ProfileModifyRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_ProfileModifyRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<UniqueID ID="PROFILE123" Type="1" ID_Context="SEAWARE"/>
<ProfileModify>
<Customer>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Smith-Jones</Surname>
</PersonName>
</Customer>
</ProfileModify>
</OTA_ProfileModifyRQ>
</Body>
</Envelope>

Fare Availability

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_CruiseFareAvailRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_CruiseFareAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<GuestCounts>
<GuestCount Code="10" Quantity="2"/>
</GuestCounts>
<SailingInfo>
<SelectedSailing VoyageID="VOYAGE0123">
<CruiseLine/>
</SelectedSailing>
</SailingInfo>
</OTA_CruiseFareAvailRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_CruiseFareAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<GuestCounts>
<GuestCount Code="10" Quantity="2"/>
</GuestCounts>
<SailingInfo>
<SelectedSailing VoyageID="VOYAGE0123">
<CruiseLine/>
</SelectedSailing>
</SailingInfo>
</OTA_CruiseFareAvailRQ>
</Body>
</Envelope>

Make a Payment (Tokenize Card Information in Production)

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_CruisePaymentRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_CruisePaymentRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<ReservationPayment>
<ReservationID Type="14" ID="12345" ID_Context="SEAWARE"/>
<PaymentDetail PaymentType="5">
<PaymentCard ExpireDate="1225">
<CardType Code="1">VISA</CardType>
<CardHolderName>John Smith</CardHolderName>
<CardNumber>
<PlainText>4111111111111111</PlainText>
</CardNumber>
</PaymentCard>
<PaymentAmount Amount="500.00" CurrencyCode="USD"/>
</PaymentDetail>
</ReservationPayment>
</OTA_CruisePaymentRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_CruisePaymentRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<ReservationPayment>
<ReservationID Type="14" ID="12345" ID_Context="SEAWARE"/>
<PaymentDetail PaymentType="5">
<PaymentCard ExpireDate="1225">
<CardType Code="1">VISA</CardType>
<CardHolderName>John Smith</CardHolderName>
<CardNumber>
<PlainText>4111111111111111</PlainText>
</CardNumber>
</PaymentCard>
<PaymentAmount Amount="500.00" CurrencyCode="USD"/>
</PaymentDetail>
</ReservationPayment>
</OTA_CruisePaymentRQ>
</Body>
</Envelope>

Send Booking Documents

REST Version

POST https://bookings.sw.travelhx.com/ota/rest/OTA_CruiseBookingDocumentRQ
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/xml
<OTA_CruiseBookingDocumentRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<ReservationID Type="14" ID="12345" ID_Context="SEAWARE"/>
<CruiseDocument DefaultIndicator="true" DeliveryMethodCode="2" DocumentDestination="CLIENT" DocumentLanguage="ENG"/>
</OTA_CruiseBookingDocumentRQ>

SOAP Version

POST https://bookings.travelhx.com:8082/ota/ws
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header/>
<Body>
<OTA_CruiseBookingDocumentRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-01-01T12:00:00Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="12345" Type="5" ID_Context="SEAWARE" />
</Source>
</POS>
<ReservationID Type="14" ID="12345" ID_Context="SEAWARE"/>
<CruiseDocument DefaultIndicator="true" DeliveryMethodCode="2" DocumentDestination="CLIENT" DocumentLanguage="ENG"/>
</OTA_CruiseBookingDocumentRQ>
</Body>
</Envelope>

Table of Contents

Sample Requests

Introduction

Protocol Comparison

Sample Request Examples

Ping

REST Version

SOAP Version

Sailing Availability

REST Version

SOAP Version

Category Availability

REST Version

SOAP Version

Cabin Availability

REST Version

SOAP Version

Price a Booking

REST Version

SOAP Version

Hold a Cabin

REST Version

SOAP Version

Create a Booking

REST Version

SOAP Version

Retrieve a Booking

REST Version

SOAP Version

Cancel a Booking

REST Version

SOAP Version

Unhold a Cabin

REST Version

SOAP Version

Dining Availability

REST Version

SOAP Version

Shore Excursion Availability

REST Version

SOAP Version

Cancellation Pricing

REST Version

SOAP Version

Booking History

REST Version

SOAP Version

Create a Guest Profile

REST Version

SOAP Version

Read a Guest Profile

REST Version

SOAP Version

Modify a Guest Profile

REST Version

SOAP Version

Fare Availability

REST Version

SOAP Version

Make a Payment (Tokenize Card Information in Production)

REST Version

SOAP Version

Send Booking Documents

REST Version

SOAP Version