TUI Group Cruise Alternate Cabin and Board Search API

openapi: 3.2.0
info:
  title: TUI Cruise Price and Availability. Cruise Alternate Cabin and Board Search API
  description: These APIs returns price and availability for given search criteria
  version: '1.0'
  contact:
    email: cruise-api-support@TUIGroup.onmicrosoft.com
    name: Cruise API Support
  x-header: 'This APIs returns cruises prices and availability for given search criteria.

    '
  x-summary: 'This API returns range of availability and pricing information that is specific to the search criteria.

    This API returns offer details and pricing information for a specific itinerary, date range, and duration.

    This API returns availability and pricing information for alternate cabins and boards.

    This API returns availability and pricing information of alternative flights for a specific cruise package.

    This API returns availability and pricing information of alternative stay variants for a specific cruise package.

    '
servers:
- url: https://prod.api.tui/cruisepriceresults
tags:
- name: Cruise Alternate Cabin and Board Search
paths:
  /v1/cruises/cabin-board-variants:
    post:
      tags:
      - Cruise Alternate Cabin and Board Search
      summary: API to get the alternate cabin and boards
      description: 'This API is designed to retrieve the availability and pricing information for alternate cabins based on the itinerary, date range, and duration provided.  It''s important to note that the API is unable to handle more than one cabin at a time. Therefore, if you want to request alternate cabins for multiple cabins,  you must make separate requests for each cabin allocation. For instance, if you select two cabins, you need to make two separate requests, one for each cabin.

        '
      operationId: getAlternateCabinAndBoards
      parameters:
      - name: x-Trace-Id
        in: header
        required: true
        description: End to end tracing ID, can be any string
        schema:
          type: string
          pattern: ^[A-Za-z0-9]{10,15}$
          example: OQ9Eu77laT
      - name: env
        in: header
        required: false
        description: A unique environment identifier for request to retrieve from correct ngs instance
        schema:
          type: string
          example: dev,test
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CruiseUniqueRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CruiseAlternateCabinAndBoardOffers'
        '400':
          description: Invalid input parameters
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ValidationProblem'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '502':
          description: Bad Gateway
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '504':
          description: Gateway Timed Out
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        default:
          description: Unexpected error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
components:
  schemas:
    Accommodation:
      title: Accommodation
      required:
      - code
      - duration
      - room
      type: object
      properties:
        id:
          type: string
          example: 1309874606/3
          description: Atcom Id
        promotionCode:
          type: string
          example: CGCR
          description: Atcom Promo Code
        sourceCode:
          type: string
          example: XXXX0029/011
          description: Atcom accommodation code
        code:
          type: string
          example: A0421241
        name:
          type: string
          example: Avani Bentota Resort
        duration:
          allOf:
          - $ref: '#/components/schemas/Duration'
          - example:
            - checkInDate: 2023-06-07
              checkInTime: 0.0
              checkOutDate: 2023-06-14
              checkOutTime: 0.0
              numberOfNights: 7
        roomBoardRate:
          type: array
          items:
            $ref: '#/components/schemas/RoomBoardRate'
          description: ''
          example:
          - roomType: DDBT
            boardType: HB
            termsConditions: CNX7D
            occupancy:
              adult: 1
              child: 1
            travellers:
            - id: 1
              type: ADULT
            - id: 3
              type: CHILD
            prices:
            - breakdowns:
              - fare:
                - level: ROOM_AND_BOARD
                  type: PER_PAX
                  category: NET
                  value: 99.4
                  travellers:
                  - id: '1'
                  - id: '2'
                discount:
                - level: ROOM_AND_BOARD
                  type: PER_PAX
                  category: DISCOUNT
                  value: 0.27
                  travellers:
                  - id: '1'
                  - id: '2'
                total:
                - level: ROOM_AND_BOARD
                  type: PER_PAX
                  category: GROSS
                  value: 109.99
                  travellers:
                  - id: '1'
                  - id: '2'
              total:
              - level: ROOM_AND_BOARD
                type: PER_BOOKING
                category: GROSS
                value: 99.4
                travellers:
                - id: '1'
                - id: '2'
        room:
          type: array
          items:
            $ref: '#/components/schemas/Room'
          description: ''
          example:
          - code: DDBT
            name: Deluxe Double Room with Balcony or Terrace
            minPax: 1
            maxPax: 2
            default: true
            freeKids: false
            prices:
            - breakdowns:
              - fare:
                - level: ROOM
                  type: PER_PAX
                  category: NET
                  value: 99.4
                  travellers:
                  - id: '1'
                  - id: '2'
                discount:
                - level: ROOM
                  type: PER_PAX
                  category: DISCOUNT
                  value: 0.27
                  travellers:
                  - id: '1'
                  - id: '2'
                total:
                - level: ROOM
                  type: PER_PAX
                  category: GROSS
                  value: 109.99
                  travellers:
                  - id: '1'
                  - id: '2'
              total:
              - level: ROOM
                category: GROSS
                value: 99.4
                travellers:
                - id: '1'
                - id: '2'
        board:
          type: array
          items:
            $ref: '#/components/schemas/Board'
          description: ''
          example:
          - id: string
            code: HB
            name: Half board
            prices:
            - breakdowns:
              - fare:
                - level: BOARD
                  type: PER_PAX
                  category: NET
                  value: 99.4
                  travellers:
                  - id: '1'
                  - id: '2'
                discount:
                - level: BOARD
                  type: PER_PAX
                  category: DISCOUNT
                  value: 0.27
                  travellers:
                  - id: '1'
                  - id: '2'
                total:
                - level: BOARD
                  type: PER_PAX
                  category: GROSS
                  value: 109.99
                  travellers:
                  - id: '1'
                  - id: '2'
              total:
              - level: BOARD
                type: PER_PAX
                category: GROSS
                value: 109.99
                travellers:
                - id: '1'
                - id: '2'
        sourceInformation:
          allOf:
          - $ref: '#/components/schemas/SourceInformation'
          - example:
            - category: CONTRACTED
              system: TUIAccommodationSourcing
    SeenPrice:
      type: object
      properties:
        currency:
          type: string
          example: GBP
        value:
          type: string
          example: '199.99'
      required:
      - value
    CruiseV2:
      type: object
      description: Cruise details
      properties:
        id:
          type: string
          example: '101088'
        sailings:
          type: array
          items:
            $ref: '#/components/schemas/SailingV2'
        cabinBoardVariants:
          type: array
          items:
            type: object
            properties:
              cabin:
                type: string
                example: ZI01
              availability:
                type: integer
                example: 5
              cabinBoardRate:
                type: array
                items:
                  $ref: '#/components/schemas/CabinBoardRate'
                example:
                - cabinType: ZI01
                  boardType: AI
                  termsConditions: CNX7D
                  occupancy:
                    adult: 1
                    child: 1
                  travellers:
                  - id: 1
                    type: ADULT
                  - id: 2
                    type: CHILD
                  prices:
                  - breakdowns:
                    - fare:
                      - level: HOLIDAY
                        type: PER_PAX
                        category: NET
                        value: 99.4
                        travellers:
                        - id: '1'
                        - id: '2'
                      - level: HOLIDAY
                        type: PER_BOOKING
                        category: NET
                        value: 299.4
                        travellers:
                        - id: '1'
                        - id: '2'
                      discount:
                      - level: HOLIDAY
                        type: PER_PAX
                        category: DISCOUNT
                        value: 99.27
                        travellers:
                        - id: '1'
                        - id: '2'
                        - id: '3'
                        - id: '4'
                      - level: HOLIDAY
                        type: PER_BOOKING
                        category: DISCOUNT
                        value: 199.27
                        travellers:
                        - id: '1'
                        - id: '2'
                        - id: '3'
                        - id: '4'
                      deposit:
                      - level: HOLIDAY
                        type: PER_PAX
                        category: LOW_DEPOSIT
                        value: 99.27
                        travellers:
                        - id: '1'
                        - id: '2'
                        - id: '3'
                        - id: '4'
                      - level: HOLIDAY
                        type: PER_BOOKING
                        category: LOW_DEPOSIT
                        value: 199.27
                        travellers:
                        - id: '1'
                        - id: '2'
                        - id: '3'
                        - id: '4'
                      total:
                      - level: HOLIDAY
                        type: PER_PAX
                        category: NET
                        value: 1984.969
                        travellers:
                        - id: '1'
                        - id: '2'
                      - level: HOLIDAY
                        type: PER_BOOKING
                        category: NET
                        value: 1984.96
                        travellers:
                        - id: '1'
                        - id: '2'
                    total:
                    - level: HOLIDAY
                      type: PER_BOOKING
                      category: NET
                      value: 5954.89
                      travellers:
                      - id: '1'
                      - id: '2'
                - cabinType: ZI01
                  boardType: PI
                  termsConditions: CNX7D
                  occupancy:
                    adult: 1
                    child: 1
                  travellers:
                  - id: 1
                    type: ADULT
                  - id: 3
                    type: CHILD
                  prices:
                  - breakdowns:
                    - fare:
                      - level: HOLIDAY
                        type: PER_PAX
                        category: NET
                        value: 99.4
                        travellers:
                        - id: '1'
                        - id: '2'
                      - level: HOLIDAY
                        type: PER_BOOKING
                        category: NET
                        value: 299.4
                        travellers:
                        - id: '1'
                        - id: '2'
                      discount:
                      - level: HOLIDAY
                        type: PER_PAX
                        category: DISCOUNT
                        value: 99.27
                        travellers:
                        - id: '1'
                        - id: '2'
                        - id: '3'
                        - id: '4'
                      - level: HOLIDAY
                        type: PER_BOOKING
                        category: DISCOUNT
                        value: 199.27
                        travellers:
                        - id: '1'
                        - id: '2'
                        - id: '3'
                        - id: '4'
                      deposit:
                      - level: HOLIDAY
                        type: PER_PAX
                        category: LOW_DEPOSIT
                        value: 99.27
                        travellers:
                        - id: '1'
                        - id: '2'
                        - id: '3'
                        - id: '4'
                      - level: HOLIDAY
                        type: PER_BOOKING
                        category: LOW_DEPOSIT
                        value: 199.27
                        travellers:
                        - id: '1'
                        - id: '2'
                        - id: '3'
                        - id: '4'
                      total:
                      - level: HOLIDAY
                        type: PER_PAX
                        category: NET
                        value: 1984.969
                        travellers:
                        - id: '1'
                        - id: '2'
                      - level: HOLIDAY
                        type: PER_BOOKING
                        category: NET
                        value: 1984.96
                        travellers:
                        - id: '1'
                        - id: '2'
                    total:
                    - level: HOLIDAY
                      type: PER_BOOKING
                      category: NET
                      value: 5954.89
                      travellers:
                      - id: '1'
                      - id: '2'
    PointType:
      type: string
      example: PORT
      enum:
      - HOTEL
      - AIRPORT
      - PORT
      - POI
      - RESORT
      - CITY
      - DESTINATION
      - REGION
      - COUNTRY
      - CONTINENT
    Ship:
      type: object
      properties:
        code:
          type: string
          example: '150016'
        name:
          type: string
          example: MARELLA VOYAGER
        cruiseLine:
          $ref: '#/components/schemas/CruiseLine'
    MetaInformation:
      title: MetaInformation
      description: Details of requester who wants to use this API
      required:
      - locale
      - market
      - brand
      - channel
      - medium
      - currency
      type: object
      properties:
        locale:
          type: string
          example: en_GB
        market:
          type: string
          example: GB
        brand:
          type: string
          example: MARELLA_UK
        channel:
          type: string
          example: B2B
        medium:
          type: string
          example: WEB
        agent:
          type: string
          example: T|MARCR
          description: 'Agent identifier in format T|XXXX where XXXX is the agent code. Examples include: T|MARCR, T|J0332, T|RIVER'
        currency:
          type: string
          example: GBP
      additionalProperties: false
    PriceDetail:
      title: PriceDetail
      required:
      - total
      type: object
      properties:
        breakdowns:
          type: array
          items:
            $ref: '#/components/schemas/PriceBreakdown'
          description: ''
          example:
          - fare:
            - level: DIRECTION
              type: PER_PAX
              category: NET
              value: 99.4
              travellers:
              - id: '1'
              - id: '2'
            tax:
            - level: DIRECTION
              type: PER_PAX
              category: AIRPORT_TAX
              code: BE2
              value: 0.27
              travellers:
              - id: '1'
            total:
            - level: DIRECTION
              type: PER_PAX
              category: GROSS
              value: 109.99
              travellers:
              - id: '1'
              - id: '2'
        bookingFee:
          type: array
          default: []
          items:
            $ref: '#/components/schemas/BookingFee'
        total:
          type: array
          items:
            $ref: '#/components/schemas/Price'
          description: ''
          example:
          - level: DIRECTION
            category: GROSS
            value: 99.4
            travellers:
            - id: '1'
            - id: '2'
    StayDuration:
      title: Stay Duration
      type: object
      required:
      - numberOfNights
      - stayOrder
      properties:
        numberOfNights:
          title: Number of nights
          type: integer
          format: int32
          example: 5
          description: Number of nights stay in before or after cruise
        stayOrder:
          title: Stay order
          type: string
          enum:
          - STAYAFTERCRUISE
          - STAYBEFORECRUISE
          description: The stay order before or after cruise
      additionalProperties: false
      description: Stay is available only for the 7 days cruise sailing duration
    RoomBoardRate:
      title: RoomBoardRate
      required:
      - roomType
      - boardType
      - travellers
      - prices
      type: object
      properties:
        roomType:
          type: string
          example: DDBT
        boardType:
          type: string
          example: HB
        termsConditions:
          type: string
          example: CNX7D
        occupancy:
          allOf:
          - $ref: '#/components/schemas/Occupancy'
          - example:
            - adult: 1
              child: 1
        travellers:
          type: array
          items:
            $ref: '#/components/schemas/Traveller'
          description: ''
          example:
          - id: 1
            type: ADULT
          - id: 3
            type: CHILD
        prices:
          type: array
          items:
            $ref: '#/components/schemas/PriceDetail'
          description: ''
          example:
          - breakdowns:
            - fare:
              - level: ROOM_AND_BOARD
                type: PER_PAX
                category: NET
                value: 99.4
                travellers:
                - id: '1'
                - id: '2'
              discount:
              - level: ROOM_AND_BOARD
                type: PER_PAX
                category: DISCOUNT
                value: 0.27
                travellers:
                - id: '1'
                - id: '2'
                - id: '3'
                - id: '4'
              total:
              - level: ROOM_AND_BOARD
                type: PER_PAX
                category: GROSS
                value: 109.99
                travellers:
                - id: '1'
                - id: '2'
            total:
            - level: ROOM_AND_BOARD
              category: GROSS
              value: 99.4
              travellers:
              - id: '1'
              - id: '2'
    PriceLevel:
      type: string
      example: SAILING
      enum:
      - DIRECTION
      - FLIGHT
      - HOLIDAY
      - ROOM
      - BOARD
      - ROOM_AND_BOARD
      - CABIN
      - CABIN_AND_BOARD
      - SAILING
      - OFFER_GROUP
    Point:
      type: object
      properties:
        code:
          type: string
        name:
          type: string
        type:
          $ref: '#/components/schemas/PointType'
    CruiseType:
      title: Cruise Type
      type: string
      enum:
      - FLY_CRUISE
      - FLY_CRUISEANDSTAY
      - FLY_STAYANDCRUISE
      - FLY_BACKTOBACK_CRUISE
      - CRUISE_ONLY
    Direction:
      title: Direction
      required:
      - id
      - type
      - segments
      type: object
      properties:
        id:
          type: string
          example: string
        type:
          $ref: '#/components/schemas/DirectionType'
          example:
          - OUTBOUND
        supplier:
          allOf:
          - $ref: '#/components/schemas/Supplier'
          - example:
            - code: string
        segments:
          type: array
          items:
            $ref: '#/components/schemas/Segment'
          description: ''
          example:
          - id: string
            departurePoint:
              code: PMI
              type: AIRPORT
            arrivalPoint:
              code: A123S
              countryCode: string
              type: RESORT
            departureDate: 2023-06-07
            departureTime: 09:45:00
            arrivalDate: 2023-06-07
            arrivalTime: 38700
        sourceInformation:
          allOf:
          - $ref: '#/components/schemas/SourceInformation'
          - example:
            - category: CONTRACTED
              system: ASTERIX
        prices:
          type: array
          items:
            $ref: '#/components/schemas/PriceDetail'
          description: ''
          example:
          - breakdowns:
            - fare:
              - level: DIRECTION
                type: PER_PAX
                category: NET
                value: 99.4
                travellers:
                - id: '1'
                - id: '2'
              fee:
              - level: DIRECTION
                type: PER_PAX
                category: AIRPORT_TAX
                code: BE2
                value: 0.27
                travellers:
                - id: '1'
                - id: '2'
              total:
              - level: DIRECTION
                type: PER_PAX
                category: GROSS
                value: 109.99
                travellers:
                - id: '1'
                - id: '2'
            - fare:
              - level: DIRECTION
                type: PER_CHILD
                category: NET
                value: 99.4
                travellers:
                - id: '3'
                - id: '4'
              fee:
              - level: DIRECTION
                type: PER_CHILD
                category: NET
                code: BE2
                value: 0.27
                travellers:
                - id: '3'
                - id: '4'
              total:
              - level: DIRECTION
                type: PER_CHILD
                category: GROSS
                value: 109.99
                travellers:
                - id: '3'
                - id: '4'
            total:
            - level: DIRECTION
              category: GROSS
              value: 99.4
              travellers:
              - id: '1'
              - id: '2'
    FlightResponse:
      title: Flight
      required:
      - id
      - directions
      - travellers
      type: object
      properties:
        id:
          type: string
          example: 1317590995/4653275
        routeCode:
          type: string
          example: TFSLTN5ALTNTFS
        directions:
          type: array
          items:
            $ref: '#/components/schemas/Direction'
          description: ''
        travellers:
          type: array
          items:
            $ref: '#/components/schemas/Traveller'
          description: ''
        totalPrice:
          allOf:
          - $ref: '#/components/schemas/SeenPrice'
      example:
        id: '1'
        routeCode: TFSLTN5ALTNTFS
        directions:
        - id: '1'
          type: OUTBOUND
          segments:
          - id: '1'
            operatingCarrier: TB
            marketingCarrier: TB
            flightNo: '1114'
            departurePoint:
              code: LGW
            arrivalPoint:
              code: PMI
            departureDate: 2023-10-11
            departureTime: 09:45:00
            arrivalDate: 2023-10-11
            arrivalTime: 45300
            sectors:
            - departureAirport:
                code: LGW
              departureDate: 2023-10-11
              departureTime: 09:45:00
              arrivalAirport:
                code: PMI
              arrivalDate: 2023-10-11
              arrivalTime: 45300
          sourceInformation:
            category: CONTRACTED
            system: NewSkies
            journeyKey: string
        travellers:
        - id: 1
          type: ADULT
        - id: 2
          type: ADULT
        - id: 3
          type: CHILD
        - id: 4
          type: CHILD
    Supplier:
      title: Supplier
      required:
      - code
      type: object
      properties:
        code:
          type: string
          example: string
    Extras:
      type: object
      required:
      - code
      properties:
        code:
          type: string
          example: WCF1/A
          description: Extras item code
        name:
          type: string
          example: Tui Care foundation
          description: Extras item name
        prices:
          type: array
          items:
            $ref: '#/components/schemas/PriceDetail'
          minItems: 1
        travellers:
          type: array
          items:
            $ref: '#/components/schemas/Traveller'
          description: ''
      example:
        code: WCF1/A
        name: TUI Care Foundation
        prices:
        - total:
          - type: PER_BOOKING
            value: 109.99
            travellers:
            - id: '1'
            - id: '2'
    Currency:
      title: Currency
      required:
      - code
      type: object
      properties:
        code:
          type: string
          example: EUR
    CabinBoardRate:
      title: CabinBoardRate
      required:
      - cabinType
      - boardType
      - travellers
      - prices
      type: object
      properties:
        cabinType:
          type: string
          example: ZI01
        boardType:
          type: string
          example: AI
        termsConditions:
          type: string
          example: CNX7D
        occupancy:
          allOf:
          - $ref: '#/components/schemas/Occupancy'
          - example:
              adult: 1
              child: 1
        travellers:
          type: array
          items:
            $ref: '#/components/schemas/Traveller'
          description: ''
          example:
          - id: 1
            type: ADULT
          - id: 3
            type: CHILD
        prices:
          type: array
          items:
            $ref: '#/components/schemas/PriceDetail'
          description: ''
          example:
          - breakdowns:
            - fare:
              - level: HOLIDAY
                type: PER_PAX
                category: NET
                value: 99.4
                travellers:
                - id: '1'
                - id: '2'
              - level: HOLIDAY
                type: PER_BOOKING
                category: NET
                value: 299.4
                travellers:
                - id: '1'
                - id: '2'
              discount:
              - level: HOLIDAY
                type: PER_PAX
                category: DISCOUNT
                value: 99.27
                travellers:
                - id: '1'
                - id: '2'
                - id: '3'
                - id: '4'
              - level: HOLIDAY
                type: PER_BOOKING
                category: DISCOUNT
                value: 199.27
                travellers:
                - id: '1'
                - id: '2'
                - id: '3'
                - id: '4'
              deposit:
              - level: HOLIDAY
                type: PER_PAX
                category: LOW_DEPOSIT
                value: 99.27
                travellers:
                - id: '1'
                - id: '2'
                - id: '3'
                - id: '4'
              - level: HOLIDAY
                type: PER_BOOKING
                category: LOW_DEPOSIT
                value: 199.27
                travellers:
                - id: '1'
                - id: '2'
                - id: '3'
                - id: '4'
              total:
              - level: HOLIDAY
                type: PER_PAX
                category: NET
                value: 1984.969
                travellers:
                - id: '1'
                - id: '2'
              - level: HOLIDAY
                type: PER_BOOKING
                category: NET
                value: 1984.96
                travellers:
                - id: '1'
                - id: '2'
            total:
            - level: HOLIDAY
              type: PER_BOOKING
              category: NET
              value: 5954.89
              travellers:
              - id: '1'
              - id: '2'
    Segment:
      title: Segment
      required:
      - id
      - departurePoint
      - arrivalPoint
      - departureDate
      - departureTime
      - arrivalDate
      - arrivalTime
      type: object
      properties:
        id:
          type: string
          example: '1'
        operatingCarrier:
          type: string
          example: TB
        marketingCarrier:
          type: string
          example: TB
        flightNo:
          type: string
          example: '1114'
        departurePoint:
          allOf:
          - $ref: '#/components/schemas/Point'
          - example:
            - code: LGW
        arrivalPoint:
          allOf:
          - $ref: '#/components/schemas/Point'
          - example:
            - code: PMI
        departureDate:
          type: string
          example: '2023-10-11'
        departureTime:
          type: string
          format: time
          example: 09:45:00
        arrivalDate:
          type: string
          example: '2023-10-11'
        arrivalTime:
          type: string
          format: time
          example: '12:35:00'
        sectors:
          type: array
          items:
            $ref: '#/components/schemas/Sector'
          description: ''
          example:
          - departureAirport:
              code: code
            departureDate: '2023-10-11'
            departureTime: 09:45:00
            arrivalAirport:
              code: PMI
            arrivalDate: '2023-10-11'
            arrivalTime: '12:35:00'
    Money:
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/Currency'
        value:
          default: 0.0
          type: number
          example: 100.0
      required:
      - value
    Board:
      title: Board
      required:
      - code
      type: object
      properties:
        id:
          type: string
          exam

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tui-group/refs/heads/main/openapi/tui-group-cruise-alternate-cabin-and-board-search-api-openapi.yml