Cruise booking flow

Cruise bookings use Open API v2. The channel client handles itinerary and cabin selection and collects traveler details; the channel server signs requests and manages orders. All endpoints below use POST; the environment host and version prefix are omitted.

sequenceDiagram
    accTitle: Cruise booking flow
    accDescr: Search itineraries and fares, select and hold a cabin, obtain a quote for the travelers, and book using channel credit. Release the hold if the user abandons the selection.
    autonumber
    box rgb(235, 247, 243) Channel
        participant C as Channel client
        participant S as Channel server
    end
    box rgb(255, 246, 229) YSystem
        participant Y as YSystem server
    end

    C->>S: Search itineraries (dates, destination)
    S->>Y: /cruise/itinerary/search
    Y-->>S: Itineraries (itineraryId)
    S-->>C: Display itineraries
    C->>S: Select an itinerary and guest counts
    S->>Y: /cruise/fares
    Y-->>S: Cabin categories, fares and cancellation policies
    S-->>C: Display categories and fares
    C->>S: Select a category and fare
    S->>Y: /cruise/cabin/availability
    Y-->>S: Available cabins
    S-->>C: Display cabins
    C->>S: Select a cabin (cabinNo)
    S->>Y: /cruise/cabin/hold
    Y-->>S: holdId, expiresAt
    S-->>C: Show hold expiry and request traveler details
    C->>S: Submit traveler details
    S->>Y: /cruise/price
    Y-->>S: priceId, expiresAt, price breakdown
    S->>Y: /cruise/cabin/diningOptions
    Y-->>S: Dining options
    S-->>C: Display quote, terms and dining options
    alt User confirms the booking
        C->>S: Confirm price, travelers and dining
        S->>Y: /cruise/book (priceId, travelers, cabinNo)
        Y->>Y: Validate quote and travelers, create order and use channel credit
        Y-->>S: Order or business error
        S-->>C: Display order status or failure reason
        opt Order is awaiting confirmation
            S->>Y: /order/search
            Y-->>S: Latest order and booking result
            S-->>C: Update booking status
        end
    else User abandons or changes the cabin
        C->>S: Cancel current selection
        S->>Y: /cruise/cabin/release (holdId)
        Y-->>S: Release result
        S-->>C: Update cabin selection status
    end

Integration notes

Traveler fields

travelers in /cruise/price is an array. Provide each traveler's own details, and send the same traveler details when calling /cruise/book. The following shows one traveler; the full quote request also needs itineraryId, categoryCode, fareCode, and other parameters:

{
  "firstName": "三",
  "lastName": "张",
  "firstNameEn": "SAN",
  "lastNameEn": "ZHANG",
  "gender": "M",
  "birthday": "1989-01-01",
  "nationality": "CN",
  "telephoneCountryCode": "86",
  "telephone": "13800000000",
  "email": "traveler@example.com"
}

Try the Cruise API Demo to explore the flow. See the v2 cruise reference for full field definitions.