HX Partner API Documentation

Welcome to the HX Partner API documentation. This site provides comprehensive information on how to integrate with HX's services, including both expedition and Norwegian coastal voyages.

Which integration should I use?

The choice comes down to one question: are you reading product data, or transacting live?

  • Reading — browsing, searching, displaying, or caching the catalogue → Flat files
  • Transacting — real-time availability, up-to-the-moment pricing, holds, bookings → Seaware API (SwOTA)
flowchart TD
    START(["Starting an integration<br/>with HX"]) --> Q1{"What is this part of<br/>your application doing?"}

    Q1 -->|"<b>Reading</b> product data<br/>browse · search · display · cache"| FF(["Flat files"])
    Q1 -->|"<b>Transacting</b> live"| API

    FF --> Q2{"Have you integrated<br/>with HX before?"}

    Q2 -->|"<b>No</b><br/>first integration"| V3["<b>Flat files V3</b><br/>current generation<br/>/voyages · /ships · /locations"]
    Q2 -->|"<b>Yes</b><br/>already live on V1"| V1["<b>Flat files V1</b><br/>fully supported<br/>stay where you are"]

    V3 --> SNAP["Daily snapshot — prices and cabin<br/>counts move during the day"]
    V1 --> SNAP
    SNAP -->|"re-quote before<br/>booking"| API

    API["<b>Seaware API (SwOTA)</b><br/>real-time availability<br/>up-to-the-moment pricing<br/>cabin holds &amp; bookings<br/>amendments · cancellations"]

    style START fill:#ede7f6,stroke:#673AB7,stroke-width:2px,color:#000
    style Q1 fill:#f5f0fa,stroke:#9C27B0,stroke-width:2px,color:#000
    style Q2 fill:#f5f0fa,stroke:#9C27B0,stroke-width:2px,color:#000
    style FF fill:#e8f4f8,stroke:#2196F3,stroke-width:2px,color:#000
    style V3 fill:#e8f5e9,stroke:#4CAF50,stroke-width:2px,color:#000
    style V1 fill:#fff3e0,stroke:#FF9800,stroke-width:2px,color:#000
    style API fill:#fce4ec,stroke:#E91E63,stroke-width:2px,color:#000
    style SNAP fill:#fffde7,stroke:#FBC02D,stroke-width:1px,color:#000

The rules in one table

If you need to… Use Why
List or search voyages, ships, ports; keep a local catalogue in sync Flat files V3 Current generation. All new integrations start here.
Do the same, but you are an existing partner already live on V1 Flat files V1 Fully supported — no need to migrate. V1 is for existing integrations only.
Check real-time availability Seaware API Flat files are a daily snapshot; cabin counts move during the day.
Get the final, up-to-the-moment price Seaware API Fares change between snapshots. Never charge a customer a flat-file price.
Hold a cabin, create or amend a booking Seaware API Flat files are read-only — they cannot transact.
Important

Flat files and the Seaware API are complements, not alternatives. A typical partner uses flat files to power browse and search, then switches to the Seaware API the moment the customer picks a sailing — to confirm live availability and price, hold the cabin, and book.

API

Flat files

Bulk product data delivered as files for keeping a local copy of inventory in sync. New integrations should start with V3 — see the Flat files overview to choose.

  • V3 — Voyages, ships, and ports served as plain JSON over simple GET endpoints
  • V1 — Bulk download of inventory data (sailings, ships, cabins, excursions, pricing) as a ZIP archive of JSON files
  • API SDK — JS/.NET client library that loads flat files into a navigable object graph, so you don't parse and cross-reference the JSON yourself

Getting Started

To start using the HX APIs, follow these steps:

  1. Contact us for credentials: Reach out to our support team via the support portal to get your API credentials.
  2. Authenticate with Auth0: Use your credentials to obtain a bearer token from Auth0.
  3. Make API Requests: Use the bearer token to authenticate your requests to the HX APIs.
Note

Agencies integrating through a tech partner should contact their tech partner to initiate the signup process on their behalf.

Authentication

Authentication may work differently depending on which API you're using. Please refer to the Getting Started page for each specific API for detailed instructions on how to authenticate.

All API requests require authentication via a bearer token from Auth0.

Note

API credentials are specific to either the HRN or HX APIs. Separate credentials are required to access each API.

FAQ

Common questions on credentials, authentication, and booking — see the FAQ.

Support

If you have any questions or need assistance, please contact our support team via the support portal.