Webjet Msdp API

openapi: 3.2.0
info:
  version: 1.0.0
  title: Trip Ninja API Documentation Msdp API
  description: "<h2>Introduction</h2>\nTrip Ninja uses a REST API with requests and responses in JSON format. For development and testing, the pre-production servers\nare to be used. Once ready for live use, access to the production servers will be provided. All search endpoints have both production\nand pre-production endpoints - these correspond to the GDS’s production and pre-production services, and can be used as desired.<br  />\n<h2>Trip Ninja API URLs</h2>\n\nPre-Production: https://preprodapi.tripninja.io\n\nFor security, Trip Ninja’s servers are only accessible from whitelisted IPs. Please contact your account manager to whitelist IPs you\nwill be using.\n\nBefore you start ensure that:<br  />\n    - IP addresses have been provided to be whitelisted for our servers.<br  />\n    - PCC / OfficeID emulation via Trip Ninja’s PCC/OfficeID has been set up.<br  />\n    - API username and password have been provided by Trip Ninja.<br  />\n\n<h2>MSDP</h2>\nMulti Stop Dynamic Packaging (MSDP) provides an alternative to traditional, static packaging. \nIt allows users to build packages as they go. While users search for multi-destination flights, \nMSDP will find eligible hotels with which to bundle.\n\n<h2>Authentication</h2>\nTrip Ninja uses Basic Authentication standards. Simply encode your username and password string using base64 and pass it in the\nauthorization headers. See the python example below on how this is done. In the example, the payload and API endpoint url are not\nshown.\n\nPython Example:\n\n<pre>\nimport base64\nauth = base64.b64encode(\"USERNAME:PASSWORD\")\nheaders = {\n    'authorization': \"Basic \"+ auth,\n}\nresponse = requests.post(url, headers=headers, data=json.dumps(payload))\n</pre>\n"
  x-logo:
    url: https://s3.amazonaws.com/tn-api-docs/trip_ninja_logo.png
    altText: Trip Ninja logo
    href: https://www.tripninja.io/
servers:
- url: https://preprodapi.tripninja.io
  description: Pre-Production server
tags:
- name: Msdp
paths:
  /msdp/search/prod:
    post:
      summary: MSDP Search
      description: 'This endpoint initiates a msdp search for one or more flights and one or more hotels, and returns a list of available flights and hotels options. A separate endpoint needs to be called to obtain information about flight details, hotel room types, etc.

        '
      operationId: MSDPSearch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Requests/MSDPSearchRequest'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/Responses/ItineraryNoHotelResultsSearchResponse'
                - $ref: '#/components/schemas/Responses/ItineraryHotelResultsSearchResponse'
                - $ref: '#/components/schemas/Responses/SegmentNoHotelResultsSearchResponse'
                - $ref: '#/components/schemas/Responses/SegmentItineraryHotelResultsSearchResponse'
        400:
          description: Invalid Input
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/MSDPSearchErrorDetails/MISSING_MSDP_SEARCH_FIELD'
                - $ref: '#/components/schemas/MSDPSearchErrorDetails/INVALID_MSDP_SEARCH_REQUEST'
                - $ref: '#/components/schemas/MSDPSearchErrorDetails/INVALID_MSDP_ID'
                - $ref: '#/components/schemas/MSDPSearchErrorDetails/INVALID_MSDP_PACKAGE_DATES'
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Error code and 0 for success response
                    example: IE44
                  message:
                    type: string
                    description: Contains the error message
                    example: User is not authorized
        206:
          description: Partial Content (no Flight/Hotel found)
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Error code and 0 for success response
                    example: IE23
                  message:
                    type: string
                    description: Contains the error message
                    example: 'No availability found: Try changing dates'
        500:
          description: Server Error
      tags:
      - Msdp
  /msdp/results/flights/?trip_id={trip_id}:
    get:
      parameters:
      - in: path
        name: trip_id
        required: true
        schema:
          type: string
          example: 04187ebd88c965919a2b8d54ca98390a56cd48c5
        description: Parameter to retrieve the flight results
      summary: MSDP Get Flight Results
      description: 'This endpoint retrieves all the flight results from the prior msdp search

        '
      operationId: MSDPGetFlightResults
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/Responses/MSDPGetFlightResultsItineraryResponse'
                - $ref: '#/components/schemas/Responses/MSDPGetFlightResultsSegmentResponse'
        400:
          description: Invalid Input
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Error code and 0 for success response
                    example: IE38
                  message:
                    type: string
                    description: Contains the error message
                    example: Trip ID not found
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Error code and 0 for success response
                    example: IE44
                  message:
                    type: string
                    description: Contains the error message
                    example: User is not authorized
        500:
          description: Server Error
      tags:
      - Msdp
  /msdp/search/removehotel/:
    patch:
      summary: MSDP Remove Hotel Result
      description: This endpoint removes a specific hotel result from the prior msdp search. All msdp packages must have at least 1 hotel. An error will be thrown if you attempt to remove the final hotel from a package.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Requests/MSDPSearchRemoveHotelRequest'
      operationId: MSDPRemoveHotelResult
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/Responses/ItineraryNoHotelResultsSearchResponse'
                - $ref: '#/components/schemas/Responses/ItineraryHotelResultsSearchResponse'
                - $ref: '#/components/schemas/Responses/SegmentNoHotelResultsSearchResponse'
                - $ref: '#/components/schemas/Responses/SegmentItineraryHotelResultsSearchResponse'
        400:
          description: Invalid Input
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/MSDPRemoveHotelErrorDetails/INVALID_REQUEST'
                - $ref: '#/components/schemas/MSDPRemoveHotelErrorDetails/INVALID_NUM_OF_HOTELS'
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Error code and 0 for success response
                    example: IE44
                  message:
                    type: string
                    description: Contains the error message
                    example: User is not authorized
        500:
          description: Server Error
      tags:
      - Msdp
  /msdp/detail/hotel/prod:
    post:
      summary: MSDP Get Hotel Details
      description: 'This endpoint initiates a hotel search to get all the available rooms in a hotel, and returns a list of available hotel rooms options.

        '
      operationId: MSDPGetHotelDetails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Requests/MSDPGetHotelDetailsRequest'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Responses/MSDPGetHotelDetailsResponse'
        400:
          description: Invalid Input
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/MSDPHotelDetailErrorDetails/MISSING_FIELDS'
                - $ref: '#/components/schemas/MSDPHotelDetailErrorDetails/INVALID_IATA'
                - $ref: '#/components/schemas/MSDPHotelDetailErrorDetails/INVALID_FIELD_TYPE'
                - $ref: '#/components/schemas/MSDPHotelDetailErrorDetails/INVALID_FIELD_VALUE'
                - $ref: '#/components/schemas/MSDPHotelDetailErrorDetails/HOTEL_LOCATION_MISSING_TYPE_R'
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Error code and 0 for success response
                    example: IE44
                  message:
                    type: string
                    description: Contains the error message
                    example: User is not authorized
        500:
          description: Server Error
      tags:
      - Msdp
  /msdp/pre-booking/prod:
    post:
      summary: MSDP Price Confirmation Report
      description: When performing an availability or price confirmation request - when a user has selected their MSDP package or is arriving on the site from metasearch - please send a request to the following endpoint. This provides valuable data to our revenue management system in determining markups for trips.
      operationId: MSDPPriceConfirmationReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Requests/PriceConfirmationReportRequest'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Responses/MSDPPreBookingResponse'
        206:
          description: Partial Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MSDPOTAPreBookingErrorDetails/NO_ROOM_AVAILABLE'
        400:
          description: Invalid Input
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/MSDPOTAPreBookingErrorDetails/MISSING_DATASOURCE'
                - $ref: '#/components/schemas/GeneralErrorDetails/NOT_BOOKED'
                - $ref: '#/components/schemas/GeneralErrorDetails/INVALID_FIELD_TYPE'
                - $ref: '#/components/schemas/GeneralErrorDetails/MISSING_FIELDS'
        500:
          description: Server Error
      tags:
      - Msdp
  /msdp/booking/:
    post:
      summary: MSDP Booking Report
      description: When a booking is completed from a trip generated by Trip Ninja, report the booking to Trip Ninja via the booking endpoint.
      operationId: MSDPBookingReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Requests/BookingReportRequest'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
        400:
          description: Invalid Input
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/GeneralErrorDetails/NOT_BOOKED'
                - $ref: '#/components/schemas/GeneralErrorDetails/INVALID_FIELD_TYPE'
                - $ref: '#/components/schemas/GeneralErrorDetails/MISSING_FIELDS'
                - $ref: '#/components/schemas/GeneralErrorDetails/INVALID_TRIP_ID'
                - $ref: '#/components/schemas/MSDPOTABookingErrorDetails/UNABLE_TO_RETRIEVE_ITINERARY_PROFILE'
        500:
          description: Server Error
      tags:
      - Msdp
  /msdp/ticketing/:
    post:
      summary: MSDP Ticketing Report
      description: 'When tickets are issued for a trip, please hit the following endpoint

        '
      operationId: MSDPTicketingReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Requests/TicketingReportRequest'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
        400:
          description: Invalid Input
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/GeneralErrorDetails/NOT_BOOKED'
                - $ref: '#/components/schemas/GeneralErrorDetails/INVALID_FIELD_TYPE'
                - $ref: '#/components/schemas/GeneralErrorDetails/MISSING_FIELDS'
                - $ref: '#/components/schemas/GeneralErrorDetails/INVALID_TRIP_ID'
                - $ref: '#/components/schemas/MSDPOTATicketingCancelErrorDetails/INVALID_MSDP_PACKAGE_ID'
        500:
          description: Server Error
      tags:
      - Msdp
  /msdp/cancel/:
    post:
      summary: MSDP Cancel Booking Report
      description: 'To cancel a booking you have previously booked, report it to the Trip Ninja Service endpoint: “/msdp/cancel/”'
      operationId: MSDPCancelBookingReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Requests/CancelRequest'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: Trip has been cancelled.
        400:
          description: Invalid Input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MSDPOTATicketingCancelErrorDetails/INVALID_MSDP_PACKAGE_ID'
        500:
          description: Server Error
      tags:
      - Msdp
components:
  schemas:
    GeneralErrorDetails:
      NOT_BOOKED:
        type: object
        title: Failed to book
        properties:
          status:
            type: string
            description: States whether request to book was successful.
            example: Not booked
      INVALID_FIELD_TYPE:
        type: object
        title: Invalid field type
        properties:
          field:
            type: string
            description: Contains the error message
            example: A valid integer is required
      MISSING_FIELDS:
        type: object
        title: Missing field
        properties:
          field:
            type: string
            description: Contains the error message
            example: This field is required.
      INVALID_TRIP_ID:
        type: object
        title: Invalid trip_id
        properties:
          status:
            type: string
            description: Error code and 0 for success response
            example: '400'
          message:
            type: string
            description: Contains the error message
            example: 'Failed to save booked flight: Trip ID not found'
    MSDPHotelDetailErrorDetails:
      MISSING_FIELDS:
        type: object
        title: Missing Fields
        properties:
          status:
            type: string
            description: Error code and 0 for success response
            example: '400'
          message:
            type: string
            description: Contains the error message
            example: Value missing for field traveller_total
      INVALID_IATA:
        type: object
        title: Invalid IATA Code
        properties:
          status:
            type: string
            description: Error code and 0 for success response
            example: '400'
          message:
            type: string
            description: Contains the error message
            example: IATA code must be 3 letters you passed TEST
      INVALID_FIELD_TYPE:
        type: object
        title: Invalid field type
        properties:
          status:
            type: string
            description: Error code and 0 for success response
            example: '400'
          message:
            type: string
            description: Contains the error message
            example: Type wrong for field traveller_total, expected int but was passed str
      INVALID_FIELD_VALUE:
        type: object
        title: Invalid field value
        properties:
          status:
            type: string
            description: Error code and 0 for success response
            example: '400'
          message:
            type: string
            description: Contains the error message
            example: Bad traveller_total value of 25. 1 <= traveller_total <= 20
      HOTEL_LOCATION_MISSING_TYPE_R:
        type: object
        title: Hotel location name missing with hotel_location_type='R'
        properties:
          status:
            type: string
            description: Error code and 0 for success response
            example: '400'
          message:
            type: string
            description: Contains the error message
            example: if hotel location type is R then the hotel location name must be passed
    SearchComponents:
      Hotel:
        ShouldIncludeHotelResultsResponse:
          description: Consists of all the hotel results
          type: array
          items:
            type: object
            properties:
              id:
                description: An identifier to refer to the flight index
                type: int
                example: 1
              hotel_trace_id:
                description: An identifier to refer to the hotel for searching room availability
                type: string
                example: 4f499298b303c55a1ee522118afce28abe2f68e4
              hotels:
                description: A list of hotels available based on the search request details.
                type: array
                items:
                  type: object
                  properties:
                    location_iata:
                      description: The location of the hotel.
                      type: string
                      example: LON
                    location_full:
                      description: The full location name as provided by the GDS.
                      type: string
                      example: London, England
                    rating:
                      description: The rating of the hotel.
                      type: object
                      properties:
                        rating:
                          description: The hotel rating
                          type: int
                          example: 4
                        rating_provider:
                          description: The provider of the rating.
                          type: string
                          example: Giata
                        rating_maximum:
                          description: The best possible rating.
                          type: int
                          example: 10
                        rating_minimum:
                          description: The worst possible rating.
                          type: int
                          example: 0
                    hotel_chain:
                      description: The refence for the hotel chain.
                      type: string
                      example: GI
                    hotel_code:
                      description: The reference for the hotel code
                      type: string
                      example: '35573'
                    hotel_name:
                      description: The name of the hotel
                      type: string
                      example: Cambridge Suites Hotel Halifax
                    minimum_charge:
                      description: The minimun total for the requested search available (in the currency provided in the search request)
                      type: float
                      example: 400.32
                    maximum_charge:
                      description: The maximum total priced room option available (in the currency provided in the search request)
                      type: float
                      example: 780.65
                    address:
                      type: object
                      description: Contains hotel address details
                      properties:
                        street_address:
                          description: The street address of the hotel.
                          type: string
                          example: 1583 Brunswick St, Halifax, NS B3J 3P5
                        longitude:
                          description: The longitude of the hotel.
                          type: float
                          example: 44.64511447836071
                        lattitude:
                          description: The lattitude of the hotel.
                          type: float
                          example: -63.575245615440565
                        distance_from_reference_point_km:
                          description: The distance that the hotel is from the reference submitted in the search.
                          type: float
                          example: 7.5
                        phone_number:
                          type: str
                          description: The contact phone number for the hotel.
                          example: +1 902-420-0555
                    ammenities:
                      type: array
                      description: A list of the amenities provided at this hotel.
                      items:
                        type: object
                        properties:
                          amenity_type:
                            type: string
                            description: The amenity type, can be either HA (Hotel Amenity) or RA (Room amenity)
                            example: HA
                          amenity_title:
                            type: string
                            description: A title or descriptor of the amenity provided.
                            example: High speed internet connection
                    credential_info:
                      $ref: '#/components/schemas/SearchComponents/Credentials'
                    conversion_rate:
                      description: The conversion rate to get the price in the currency requested.
                      type: float
                      example: 0.45
                    neighbourhood:
                      description: The neighbourhood or locality of the hotel.
                      type: string
                      example: Saint Boniface
              hotel_itinerary_reference:
                $ref: '#/components/schemas/SearchComponents/Hotel/HotelItineraryReference'
              next_result_reference:
                $ref: '#/components/schemas/SearchComponents/Hotel/HotelNextResultReference'
              hotels_media:
                description: A list of media items for all the hotels returned in the search.
                type: array
                items:
                  type: object
                  properties:
                    hotel_chain:
                      description: The refence for the hotel chain.
                      type: string
                      example: GI
                    hotel_code:
                      description: The reference for the hotel code
                      type: string
                      example: '35573'
                    hotel_media_items:
                      description: A selection of media items for the above referenced hotel.
                      type: array
                      items:
                        type: object
                        properties:
                          title:
                            description: The title / descriptor of the photos contained in this media item.
                            type: string
                            example: Front desk.
                          large:
                            description: The url for the image of the above titled part of the hotel of size large.
                            type: string
                            example: https://media-cdn.tripadvisor.com/media/photo-m/1280/1b/45/0b/f8/lobby.jpg
                          thumbnail:
                            description: The url for the image of the above titled part of the hotel of size thumbnail.
                            type: string
                            example: https://media-cdn.tripadvisor.com/media/photo-m/1280/1b/45/0b/f8/lobby.jpg
              hotel_neighbourhoods:
                description: The top 5 most common neighbourhoods found in the hotel search location, ordered from most common to least common.
                type: array of strings
                example:
                - St. Vital Center
                - Downtown
                - River Heights
                - Saint Boniface
                - Fort Garry
        NotShouldIncludeHotelResultsResponse:
          description: Consists of all the hotel results. If should_include_hotel_results is false, only the hotel_trace_id will be returned.
          type: array
          items:
            type: object
            properties:
              id:
                description: An identifier to refer to the flight index
                type: int
                example: 1
              hotel_trace_id:
                description: An identifier to refer to the hotel for searching room availability
                type: string
                example: 4f499298b303c55a1ee522118afce28abe2f68e4
        HotelLocation:
          description: location (city, airport, or reference point) to search for hotels in.
          type: object
          required:
          - type
          - IATA
          properties:
            city_name:
              description: The city name for the reference point.
              type: string
              example: Ottawa
            country:
              description: The 2-letter country code for the reference point. Required for reference point.
              type: string
              example: FR
            country_name:
              description: The full country name for the reference point.
              type: string
              example: France
            IATA:
              description: The IATA code for the city/airport, or nearest IATA for the reference point
              type: string
              example: PAR
            name:
              description: The IATA code for the city/airport, or nearest IATA for the reference point. Required for reference point.
              type: string
              example: Eiffel Tower
            region:
              description: The state/province for the reference point. Only required for reference point if there are multiple reference points with same name in the same country.
              type: string
              example: NS
            type:
              type: string
              description: Defines whether it's a city ('C'), airport ('A'), or reference point ('R')
              example: R
        HotelRooms:
          description: List of guest info for 1 room required to make hotel search requests.
          type: array
          items:
            type: object
            required:
            - num_adults
            - num_children
            - nationality
            - country_of_residence
            properties:
              num_adults:
                description: Number of adults staying in the room.
                type: int
                example: 2
              num_children:
                description: Number of children staying in the room, if none use 0.
                type: int
                example: 3
              children_age_list:
                description: List of ages for children staying in room. Optional if num_children = 0, Required if num_children > 0.
                type: array of ints
                example:
                - 5
                - 7
                - 11
              nationality:
                description: 2 letter country code of nationality of primary guest. e.g. CA for Canada, GB for United Kingdom, CO for Colombia.
                type: string
                example: CA
              country_of_residence:
                description: 2 letter country code of country of residence of primary guest. e.g. CA for Canada, GB for United Kingdom, CO for Colombia.
                type: string
                example: CA
        HotelNextResultReference:
          description: The reference object with the reference and the provider map.
          type: array
          items:
            type: object
            properties:
              reference:
                description: The reference for the GDS to make the next search.
                example: GvCe60ac0/ca8J7rRpzT99+A990Uzoz9uPnDvrR9vlPYyiAdwA/4TedEKvTDZyf87Yyw51a62Z0vr9lr1UD15D2BfyUpgIOXDnCDubYq+Qg9pzbZYLqUbA==
                type: string
              provider:
                description: Fare provider to use.<br  />“1V” - Apollo, “1G” - Galileo, “1P” - Worldspan, “1A” - Amadeus, “webbeds” - Webbeds
                type: string
                example: 1V
        HotelItineraryReference:
          description: A reference that indicates the itineraries position in the flow of itineraries in the super_trip with the index starting at 0.
          type: string
          example: '1'
      Flight:
        ItineraryFareStructure:
          type: object
          description: Contains the JSON object of the response.
          properties:
            currency:
              type: string
              description: Currency
              example: CAD
            markup:
              type: float
              description: Markup specified by the Trip Ninja Net Fare to be applied at the itinerary level.
              example: 25.0
            path_sequence:
              type: array
              description: An array of IATA codes representing the chronological order of your trip.
              example:
              - LON-CDG
              - CDG-YUL
              - YUL-LON
            trip_id:
              type: string
              description: A unique key used for identification and when booking a trip.
              example: 04187ebd88c965919a2b8d54ca98390a56cd48c5
            itineraries:
              $ref: '#/components/schemas/SearchComponents/Flight/FareStructureSearchItineraries'
        SegmentFareStructure:
          type: object
          description: Contains the JSON object of the response.
          properties:
            currency:
              type: string
              description: Currency
              example: CAD
            markup:
  

# --- truncated at 32 KB (114 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webjet/refs/heads/main/openapi/webjet-msdp-api-openapi.yml