SwOTA API Development Guide
This development guide provides detailed information for integration partners building applications that connect to the SwOTA cruise booking API.
Overview
The SwOTA API allows you to search, book, and manage cruise reservations. The API is based on the OpenTravel Alliance (OTA) specifications with extended features, providing standardized XML messaging for cruise bookings.
As an integration partner, you'll use this API to:
- Search cruise availability (sailings, categories, cabins)
- Create and manage bookings
- Process payments
- Manage customer profiles
- Handle documentation
Guide Contents
Getting Started
- Seaware OTA Basics - General message format, data types, error handling
- Basic Seaware Concepts - Core concepts like sessions, bookings, packages, and inventory
- OTA Code Lists - Enumerated values and code mappings
- Seaware OTA API Protocols - SOAP, REST, and JMS protocols
- Plain OTA vs Versonix OTA - Differences between standard and extended API
API Messages
- SwOTA Point of Sale - Authentication and agency/agent/client identification
- SwOTA Shopping - General shopping flow and options
- Sailing Availability - Search for available cruises
- Fare Availability - Query available fare codes/promotions
- Category Availability - Get available cabin categories
- Cabin Availability - List available cabins
- Cabin Hold - Hold inventory temporarily
- Booking Pricing - Request detailed pricing
- Storing a Booking - Create or update reservations
- Retrieving Bookings - Query existing bookings and profiles
- Booking History - View booking change history
- Cancellation - Cancel bookings and query penalties
- Payments - Process payments and refunds
- Sending Documents - Email or print booking documents
- Profile Management - Create and update client profiles
Advanced Features
- Multi-Cabin Support - Book multiple cabins in one reservation
- Dining Support - Manage seating and premium dining
- Hotels Support - Add pre/post cruise hotels
- Tours Support - Book voyage and shorex tours
Session and State
- Session and State Support - Overview of sessionful and stateful modes
- Session Support - Working with user sessions
- Stateful Mode - Temporary storage and booking locks
Key Features
Stateless and Stateful Operations
SwOTA supports both:
- Stateless mode: Each request is independent (typical for GDS integrations)
- Stateful mode: Use temporary storage to hold inventory while building bookings
- Session mode: Maintain user context across multiple requests
API Variants
- Plain OTA: Strictly follows OpenTravel Alliance public specifications
- Versonix OTA: Includes additional features marked with "VXAddition"
The mode is configured per partner based on integration requirements.
Getting Help
For integration support, contact your integration support team with:
- Your partner/agency ID
- API endpoint you're using (production/test)
- Sample request/response messages
- Error messages or codes
- Timestamp of the issue
Related Documentation
- SwOTA API Integration Guide - Quick start guide for travel partners
- SOAP Testing Guide - How to test SOAP requests
- REST Testing Guide - How to test REST requests
- Sample Requests - Example API messages in both SOAP and REST formats