TUI Group Manifest API

openapi: 3.2.0
info:
  title: NewSkies-Digital-Api Manifest API
  version: 4.8.6.23
  description: Navitaire Digital Api
servers:
- url: https://prod.api.tui/flight/newskies/rest
  description: TUI Prod
- url: https://playground.api.tui/flight/newskies/rest
  description: TUI Playground
security:
- JWT: []
tags:
- name: manifest
paths:
  /api/nsk/v2/manifest:
    get:
      tags:
      - manifest
      summary: 'Gets the manifest trip information response list for the specified

        manifest trip information search request.'
      description: 'GraphQL endpoint: manifestSearchv2'
      operationId: nsk_v2_manifest_get
      parameters:
      - name: Origin
        in: query
        description: "The departure station.\n            "
        schema:
          type:
          - string
          - 'null'
          maxLength: 3
          minLength: 0
        x-position: 1
      - name: Destination
        in: query
        description: "The arrival station.\n            "
        schema:
          type:
          - string
          - 'null'
          maxLength: 3
          minLength: 0
        x-position: 2
      - name: CarrierCode
        in: query
        description: "The carrier code.\n            "
        schema:
          type:
          - string
          - 'null'
          maxLength: 3
          minLength: 2
        x-position: 3
      - name: BeginDate
        in: query
        description: "The starting date of the trip information search.\n            "
        schema:
          type:
          - string
          - 'null'
          format: date-time
        x-position: 4
      - name: Identifier
        in: query
        description: "The transportation identifier, such as a flight number.\n            "
        schema:
          type:
          - string
          - 'null'
          maxLength: 4
          minLength: 0
        x-position: 5
      - name: FlightType
        in: query
        description: "The flight type.\n             \nEnumeration values: 0 = All, 1 = NonStop, 2 = Through, 3 = Direct, 4 = Connect"
        schema:
          $ref: '#/components/schemas/OperationsFlightType'
        x-position: 6
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfTripInformationResponsev2'
  /api/nsk/v1/manifest/{legKey}:
    get:
      tags:
      - manifest
      summary: Gets the manifest for the specified leg.
      description: 'GraphQL endpoint: manifestv3'
      operationId: nsk_v1_manifest_legKey_get
      parameters:
      - name: legKey
        in: path
        required: true
        description: The manifest leg key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfManifestLight'
              examples:
                Manifest Light Response:
                  description: Example response for retrieving the manifest.
                  value:
                    data:
                      passengers:
                      - balanceDue: true
                        userKey: Nzk3MTZ-
                        personKey: MA--
                        passengerAlternateKey: NML4Tgw
                        passengerKey: MCFBRFQ-
                        checkInType: 0
                        customerNumber: '888888888'
                        discountCode: null
                        infant: null
                        name:
                          first: First
                          middle: Middle
                          last: Last
                          title: MR
                          suffix: null
                        paidStatus: 0
                        profileStatus: 0
                        program: null
                        recordLocator: R35N2F
                        sourcePointOfSale:
                          agentCode: agent
                          domainCode: EXT
                          locationCode: WWW
                          organizationCode: '88887777'
                        bookingStatus: 0
                        passengerInformation:
                          nationality: US
                          residentCountry: US
                          gender: 1
                          dateOfBirth: '0001-01-01T00:00:00'
                          familyNumber: null
                          declaredGender: null
                        type: ADT
                        bookingDate: '2026-07-09T05:55:14.8216718+00:00'
                        soldDate: '2026-07-09T05:55:14.8216724+00:00'
                        journey:
                          customerRecognition:
                            code: null
                            points: 0
                          segmentCount: 1
                          segment:
                            bookingStatus: HK
                            changeReason: 0
                            classOfService: N
                            fareBasisCode: NNNN
                            leg:
                              boardingSequence: 0
                              boardingZone: 3
                              compartmentDesignator: E
                              legNumber: 1
                              liftStatus: 0
                              priorityCode: null
                              priorityDate: '2026-07-09T05:55:14.8216741+00:00'
                              unitAssignmentWeight: 0
                              unitDesignator: 1D
                              manifestLegKey: NjM4ODIzNDU2MDAwMDAwMDAwIU5WITU2MjUhICFERU4hU0xD
                            productClassCode: EC
                            seatProperties: []
                            soldDate: '2026-07-09T05:55:14.821675+00:00'
                            ticketIndicator: null
                            ticketNumber: null
                            upgradeIndicator: false
                            externalIdentifier: null
                            legCount: 1
                            segmentType: 0
                            manifestSegmentKey: NjM4ODIzNDU2MDAwMDAwMDAwIU5WITU2MjUhICFERU4hU0xD
                            ticketFareBasis: null
                          changeReason: 0
                      cabinPassengerCounts:
                      - classRank: 0
                        checkedIn: 0
                        cabinOfService: F
                        clearedStandBy: 0
                        clearedThruStandby: 0
                        manifested: 0
                        noShow: 0
                        standBy: 0
                        thruCheckedIn: 0
                        thruManifested: 0
                        thruNoShow: 0
                        thruStandBy: 0
                        totalCheckedIn: 0
                        totalOnBoard: 0
                      inventoryLegCrossReferences:
                      - legKey: NjM4NjQ4NLQ1NSMxNCBlNSNwIUpCITExMTEhICFTTEMhQk9TITMwMTM3NTM-
                        number: 1
                        marketInformation:
                          identifier:
                            identifier: '5600'
                            carrierCode: NV
                            opSuffix: null
                          destination: BOS
                          origin: SLC
                          departureDate: '2026-07-09T05:55:14.8217633+00:00'
                      passengerCounts:
                        checkedIn: 0
                        clearedStandBy: 0
                        clearedThruStandby: 0
                        manifested: 1
                        noShow: 1
                        standBy: 0
                        thruCheckedIn: 0
                        thruManifested: 0
                        thruNoShow: 0
                        thruStandBy: 0
                        totalCheckedIn: 0
                        totalOnBoard: 0
                      checkInLid: 810
                      codeShareIndicator: null
                      operatedByText: null
                      operatingIdentifier: null
                      legStatus: 0
  /api/nsk/v1/manifest/{legKey}/bags:
    get:
      tags:
      - manifest
      summary: 'Gets the manifest Passenger Bags for the specified leg. Sorted by recordLocator and then by Passenger.

        weightType 0 = Default, 1 = Pounds, 2 = Kilograms, (2 is current default for backwards compatibility)'
      description: 'GraphQL endpoint: manifestBags'
      operationId: nsk_v1_manifest_legKey_bags_get
      parameters:
      - name: legKey
        in: path
        required: true
        description: The manifest leg key.
        schema:
          type: string
        x-position: 1
      - name: weightType
        in: query
        description: "Weight type. 0 = Default, 1 = Pounds, 2 = Kilograms. \nEnumeration values: 0 = Default, 1 = Pounds, 2 = Kilograms"
        schema:
          $ref: '#/components/schemas/WeightType2'
        x-position: 2
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIDictionaryOfStringAndIListOfOperationBag'
              examples:
                Manifest Bag Valid Response:
                  description: This is a valid Manifest Bag Expected Response.
                  value:
                    xxxxxx - recordLocator:
                      passenger1AlternateKey:
                      - operationBagKey: BagKey
                        identifier: NV1111
                        baggageStatus: 1
                        nonStandard: true
                        checkInDate: '2026-07-09T00:00:00+00:00'
                        osTag: bagOsTag
                        compartment: 1
                        taggedToStation: SLC
                        taggedToStationCity: SLC
                        weight: 10
                        baggageTypeCode: null
                        weightType: 0
                      - operationBagKey: BagKey2
                        identifier: NV1111
                        baggageStatus: 3
                        nonStandard: true
                        checkInDate: '2026-07-09T00:00:00+00:00'
                        osTag: bagOsTag2
                        compartment: 1
                        taggedToStation: SLC
                        taggedToStationCity: SLC
                        weight: 10
                        baggageTypeCode: null
                        weightType: 1
                      passenger2AlternateKey:
                      - operationBagKey: BagKey3
                        identifier: NV1111
                        baggageStatus: 1
                        nonStandard: true
                        checkInDate: '2026-07-09T00:00:00+00:00'
                        osTag: bagOsTag3
                        compartment: 1
                        taggedToStation: SLC
                        taggedToStationCity: SLC
                        weight: 10
                        baggageTypeCode: null
                        weightType: 0
                    xxxxX2 - recordLocator 2:
                      passenger3AlternateKey:
                      - operationBagKey: BagKey4
                        identifier: NV1111
                        baggageStatus: 1
                        nonStandard: true
                        checkInDate: '2026-07-09T00:00:00+00:00'
                        osTag: bagOsTag4
                        compartment: 1
                        taggedToStation: SLC
                        taggedToStationCity: SLC
                        weight: 10
                        baggageTypeCode: null
                        weightType: 0
                      passenger4AlternateKey:
                      - operationBagKey: BagKey5
                        identifier: NV1111
                        baggageStatus: 1
                        nonStandard: true
                        checkInDate: '2026-07-09T00:00:00+00:00'
                        osTag: bagOsTag5
                        compartment: 1
                        taggedToStation: SLC
                        taggedToStationCity: SLC
                        weight: 10
                        baggageTypeCode: null
                        weightType: 0
                      - operationBagKey: BagKey6
                        identifier: NV1111
                        baggageStatus: 3
                        nonStandard: true
                        checkInDate: '2026-07-09T00:00:00+00:00'
                        osTag: bagOsTag6
                        compartment: 1
                        taggedToStation: SLC
                        taggedToStationCity: SLC
                        weight: 10
                        baggageTypeCode: null
                        weightType: 1
  /api/nsk/v1/manifest/{legKey}/bookings:
    get:
      tags:
      - manifest
      summary: Gets the manifest bookings data for the specified leg.
      description: 'GraphQL endpoint: manifestBookings'
      operationId: nsk_v1_manifest_legKey_bookings_get
      parameters:
      - name: legKey
        in: path
        required: true
        description: The manifest leg key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndManifestBookings'
  /api/nsk/v1/manifest/{legKey}/governmentSecurityInfo:
    get:
      tags:
      - manifest
      summary: Gets the manifest Passenger Government Security Information for the specified leg.
      description: 'GraphQL endpoint: manifestGovernmentSecurityInformation'
      operationId: nsk_v1_manifest_legKey_governmentSecurityInfo_get
      parameters:
      - name: legKey
        in: path
        required: true
        description: The manifest leg key.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndListOfManifestLightPassengerGovernmentSecurityInfo'
              examples:
                Manifest Government Security Information Response:
                  description: Example response for retrieving the manifest government security information.
                  value:
                    data:
                      zzzzzz - recordLocator:
                      - userKey: userKey
                        personKey: PersonKey
                        passengerAlternateKey: PassAltKey
                        passengerKey: PassKey
                        checkInType: 0
                        infant:
                          nationality: US
                          dateOfBirth: '2026-07-09T05:55:14.8702293+00:00'
                          residentCountry: US
                          gender: 2
                          name:
                            first: infFirst
                            middle: infMiddle
                            last: infLast
                            title: ''
                            suffix: ''
                          declaredGender: null
                        name:
                          first: first
                          middle: Middle
                          last: Last
                          title: ''
                          suffix: ''
                        recordLocator: ZZZZZZ - RecordLocator
                        bookingStatus: 2
                        passengerInformation:
                          nationality: US
                          residentCountry: US
                          gender: 2
                          dateOfBirth: '2026-07-09T05:55:14.8704381+00:00'
                          familyNumber: 1
                          declaredGender: null
                        type: ADT
                        bookingDate: '2026-07-09T05:55:14.8701628+00:00'
                        isMissingVerifiedDocAdult: true
                        isMissingVerifiedDocInfant: true
                        passengerAddresses:
                        - passengerAlternateKey: PassAltKey
                          countryName: US
                          lineOne: Address
                          companyName: ''
                          lineTwo: ''
                          phone: '8885551234'
                          lineThree: ''
                          stationCode: SLC
                          countryCode: US
                          emailAddress: Yes@Yes.com
                          provinceState: UT
                          status: 1
                          city: SLC
                          passengerAddressKey: PassKey
                          postalCode: '88888'
                        passengerTravelDocuments:
                        - passengerTravelDocumentKey: PassTravDocKey
                          documentTypeCode: P
                          birthCountry: US
                          issuedByCode: US
                          name:
                            first: First
                            middle: Middle
                            last: Last
                            title: ''
                            suffix: ''
                          nationality: US
                          expirationDate: '2026-07-10T05:55:14.8704662+00:00'
                          number: '123456789'
                          issuedDate: '2026-07-09T05:55:14.8704677+00:00'
                          gender: 2
                          dateOfBirth: '2026-07-09T05:55:14.8704657+00:00'
                          declaredGender: Female
                          placeOfBirth: US
                          placeOfIssue: US
                        - passengerTravelDocumentKey: InfPassTravDocKey
                          documentTypeCode: P
                          birthCountry: US
                          issuedByCode: US
                          name:
                            first: infFirst
                            middle: infMiddle
                            last: infLast
                            title: ''
                            suffix: ''
                          nationality: US
                          expirationDate: '2026-07-10T05:55:14.8704692+00:00'
                          number: 123456789I
                          issuedDate: '2026-07-09T05:55:14.8704694+00:00'
                          gender: 2
                          dateOfBirth: '2026-07-09T05:55:14.8704691+00:00'
                          declaredGender: Female
                          placeOfBirth: US
                          placeOfIssue: US
                        passengerAddressRequirement: true
                        profileStatus: 0
                        authorizationList: null
      deprecated: true
  /api/nsk/v2/manifest/{legKey}/governmentSecurityInfo:
    get:
      tags:
      - manifest
      summary: 'Retrieves the government security requirements for all passengers on the specified leg by calling the New Skies

        Government Security Service (GSS).'
      description: 'This endpoint is slower than other manifest endpoints because it requires synchronous communication with backend

        systems such as the Government Security Service (GSS) and the underlying New Skies remoting layer that brokers

        GSS calls.


        The `data.internationalFlight` property is only populated if there are passengers on the flight.


        The following response properties are only populated if the flight is international and already has passengers:

        - `data.arrivalCountry`

        - `data.departureCountry`


        This endpoint requires a session token and is agent-only.


        GraphQL endpoint: manifestGovernmentSecurityInformationv2'
      operationId: nsk_v2_manifest_legKey_governmentSecurityInfo_get
      parameters:
      - name: legKey
        in: path
        required: true
        description: The leg key.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfManifestLightGovernmentSecurityInfoResponse'
              examples:
                Manifest government security information response:
                  description: Example response for retrieving the manifest government security information. This is only a sample response for NRT-SYD and values may differ depending on the GSS configuration.
                  value:
                    data:
                      passengers:
                      - userKey: userKey
                        personKey: PersonKey
                        passengerAlternateKey: PassAltKey
                        passengerKey: PassKey
                        checkInType: 0
                        infant:
                          nationality: US
                          dateOfBirth: '2026-07-09T05:55:14.8830757+00:00'
                          residentCountry: US
                          gender: 2
                          name:
                            first: infFirst
                            middle: infMiddle
                            last: infLast
                            title: ''
                            suffix: ''
                          declaredGender: null
                        name:
                          first: first
                          middle: Middle
                          last: Last
                          title: ''
                          suffix: ''
                        recordLocator: ZZZZZZ - RecordLocator
                        bookingStatus: 2
                        passengerInformation:
                          nationality: US
                          residentCountry: US
                          gender: 2
                          dateOfBirth: '2026-07-09T05:55:14.8830797+00:00'
                          familyNumber: 1
                          declaredGender: null
                        type: ADT
                        bookingDate: '2026-07-09T05:55:14.8830746+00:00'
                        isMissingVerifiedDocAdult: true
                        isMissingVerifiedDocInfant: true
                        passengerAddresses:
                        - passengerAlternateKey: PassAltKey
                          countryName: US
                          lineOne: Address
                          companyName: ''
                          lineTwo: ''
                          phone: '8885551234'
                          lineThree: ''
                          stationCode: SLC
                          countryCode: US
                          emailAddress: Yes@Yes.com
                          provinceState: UT
                          status: 1
                          city: SLC
                          passengerAddressKey: PassKey
                          postalCode: '88888'
                        passengerTravelDocuments:
                        - passengerTravelDocumentKey: PassTravDocKey
                          documentTypeCode: P
                          birthCountry: US
                          issuedByCode: US
                          name:
                            first: First
                            middle: Middle
                            last: Last
                            title: ''
                            suffix: ''
                          nationality: US
                          expirationDate: '2026-07-10T05:55:14.883082+00:00'
                          number: '123456789'
                          issuedDate: '2026-07-09T05:55:14.8830833+00:00'
                          gender: 2
                          dateOfBirth: '2026-07-09T05:55:14.8830817+00:00'
                          declaredGender: Female
                          placeOfBirth: US
                          placeOfIssue: US
                        - passengerTravelDocumentKey: InfPassTravDocKey
                          documentTypeCode: P
                          birthCountry: US
                          issuedByCode: US
                          name:
                            first: infFirst
                            middle: infMiddle
                            last: infLast
                            title: ''
                            suffix: ''
                          nationality: US
                          expirationDate: '2026-07-10T05:55:14.8830839+00:00'
                          number: 123456789I
                          issuedDate: '2026-07-09T05:55:14.883084+00:00'
                          gender: 2
                          dateOfBirth: '2026-07-09T05:55:14.8830838+00:00'
                          declaredGender: Female
                          placeOfBirth: US
                          placeOfIssue: US
                        passengerAddressRequirement: true
                        profileStatus: 0
                        authorizationList: null
                      arrivalCountry:
                        apisCheckDocuments: false
                        apisRequiredInbound: false
                        apisRequiredOutbound: false
                        appsRequiredInbound: true
                        appsRequiredOutbound: true
                        countryCode: AU
                        countryCode3C: AUS
                      departureCountry:
                        apisCheckDocuments: true
                        apisRequiredInbound: true
                        apisRequiredOutbound: true
                        appsRequiredInbound: false
                        appsRequiredOutbound: false
                        countryCode: JP
                        countryCode3C: JPN
                      internationalFlight: true
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                Invalid leg key:
                  description: The provided leg key is invalid and cannot be decoded correctly.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:InvalidKey
                      message: The identifier 'legKey' with value 'MjM4Nzc5NjQ0MDAwMDAwMDAwIU5WITU2MDAhICFTTEMhQk9TITQ2ODAbc4+-' is invalid.
                      type: Validation
                      details: null
                      rawMessage: The identifier 'legKey' with value 'MjM4Nzc5NjQ0MDAwMDAwMDAwIU5WITU2MDAhICFTTEMhQk9TITQ2ODAbc4+-' is invalid.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Leg key is null:
                  description: The provided leg key is null. It can be set to null by setting it to a URL encoded space value `%20`.
                  value:
                    errors:
                    - id: null
                      code: core:Validation:RequiredArgument
                      message: The request is missing a required argument expected in the request.
                      type: Validation
                      details:
                        argument: legKey
                      rawMessage: The request is missing a required argument expected in the request.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                No manifest government security information:
                  description: No manifest government security information to be retrieved. This happens when there are no bookings with passengers for the specified leg.
                  value:
                    data: null
        '401':
          description: Authorization not allowed. Endpoint requires agent permissions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                Authentication token is missing or invalid:
                  description: Example when the authentication token is missing or invalid. A token from a non-agent user is not valid.
                  value: null
  /api/nsk/v2/manifest/{legKey}/passengerDetails:
    get:
      tags:
      - manifest
      summary: Gets the passenger details for the specified leg.
      description: 'GraphQL endpoint: manifestPassengerDetailsv2'
      operationId: nsk_v2_manifest_legKey_passengerDetails_get
      parameters:
      - name: legKey
        in: path
        required: true
        description: The leg key.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPassengerDetailsv2'
              examples:
                Manifest with Passenger Details:
                  description: Successful retrieval of manifest with passenger details.
                  value:
                    data:
                      passengers:
                      - passengerAlternateKey: MjY0OTQ3
                        status: 2
                        recordLocator: ASDFGH
                        createdDate: '2026-07-09T05:55:14.8957318Z'
                        name:
                          first: Justine
                          middle: null
                          last: Doe
                          title: null
                          suffix: null
                        profileStatus: 0
                        infantTicketNumber: null
                        weightCategory: 1
                        ticketNumber: null
                        origin: SLC
                        ticketIndicator: null
                        destination: BOS
                        ssrCodes: null
                        tripType: 1
                        segmentBookingStatus: HK
                        connectingFlight: null
                        connectingStation: null
                        finalDestination: BOS
                        paymentMethods:
                        - CA
                        comments: null
                        infant:
                          nationality: null
                          dateOfBirth: '2026-06-09T00:00:00+00:00'
                          residentCountry: null
                          gender: 1
                          name:
                            first: Ba

# --- truncated at 32 KB (155 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tui-group/refs/heads/main/openapi/tui-group-manifest-api-openapi.yml