openapi: 3.2.0 info: title: Tui Group Bookings API x-refined-note: - x-header differs across the merged source definitions and was not carried - x-summary differs across the merged source definitions and was not carried version: '1.0' description: 'Operations tagged Bookings across 3 of this provider''s published API definitions: tui-group-tui-cruise-booking-apis-openapi.yml, tui-group-tui-newskies-digital-api-openapi.yml, tui-group-tui-newskies-gonow-api-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://prod.api.tui/cruise-ota-book description: Production server - url: https://pre-prod.api.tui/cruise-ota-book description: Non-production server - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground - url: https://prod.api.tui/flight/newskies/gonow description: TUI Prod - url: https://playground.api.tui/flight/newskies/gonow description: TUI Playground tags: - name: Bookings paths: /validate-holiday: parameters: - name: x-business-relationship in: header required: false schema: type: string example: InfoBooking_v3_Action description: Validate holiday for cruises post: summary: Validate holiday for cruises description: Validates the booking details in the system with customer and travel details operationId: validateHoliday tags: - Bookings requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ValidateHolidayRequest' responses: '200': description: Booking validated successfully content: application/json: schema: $ref: '#/components/schemas/ValidateHolidayResponse' '400': description: Bad request - invalid input data content: application/json: schema: $ref: '#/components/schemas/Problem' '401': description: Unauthorized - authentication required content: application/json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://prod.api.tui/cruise-ota-book description: Production server - url: https://pre-prod.api.tui/cruise-ota-book description: Non-production server /confirm-holiday: parameters: - name: x-business-relationship in: header required: false schema: type: string example: CreateBooking_v3_Action description: Confirm to book holiday for cruises post: summary: Confirm to book holiday for cruises description: Creates a new booking in the system with customer and travel details operationId: confirmHoliday tags: - Bookings requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConfirmHolidayRequest' responses: '200': description: Booking created successfully content: application/json: schema: $ref: '#/components/schemas/ConfirmHolidayResponse' '400': description: Bad request - invalid input data content: application/json: schema: $ref: '#/components/schemas/Problem' '401': description: Unauthorized - authentication required content: application/json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://prod.api.tui/cruise-ota-book description: Production server - url: https://pre-prod.api.tui/cruise-ota-book description: Non-production server /api/nsk/v2/bookings: get: tags: - Bookings summary: 'Retrieves the booking from the New Skies server based on the retrieve booking request parameters and any configured booking retrieve strategies. If the booking exists and the search criteria is allowed by one of the configured booking retrieve strategies, the booking will be returned, but not loaded into the web session.' description: 'This endpoint will perform validation using a pre-configured booking retrieve strategy. Custom strategies can be configured in Utilities, and are configurable based on application name. To set up a custom strategy, go to Utilities -> Resource Management. From the "Resource Management" screen, go to Root -> Web -> dotREZ folder. Right-click on the dotREZ folder and select "Add Content". On the "Add Resource" screen, set the "Content Name" to "BookingStrategyManagementConfig". Choose "XML" as the "Type". The "Content Data" will be in JSON, and should look like this: { "strategies" : [{ "applicationName" : "dotREZApi", "allowedStrategies" : [ "firstAndLastName", "email" ] }, { "applicationName" : "Web", "allowedStrategies" : [ "email" ] }, { "applicationName" : "", "allowedStrategies" : [ "lastName" ] }] } The application name can be set when creating a new token. If no application name is given for a token create request, the API will use whatever value is defined in the "dotrez-nsk-common.json" configuration file under the "systemOptions" -> "fallbackApplicationName". If no strategies are configured and no "fallbackApplicationName" is configured, the default strategy will be a booking retrieve based on PNR, first name, and last name. If the same strategy should be used for multiple applications, the last entry in the example above can be set by setting an empty string as the application name, and then listing the allowed strategies to be used. Application specific strategies can still be defined, but if no application specific strategy is found, a list of strategies associated with the blank application name will be used (if one exists in the configuration file). The list of strategies currently includes the following options: firstAndLastName email originAndDepartureDate lastName customerNumber More strategies may be added in the future. GraphQL endpoint: bookingsv2' operationId: nsk_v2_bookings_get parameters: - name: RecordLocator in: query description: "Record locator being requested.\n " schema: type: - string - 'null' maxLength: 12 minLength: 0 x-position: 1 - name: EmailAddress in: query description: "The email address of a contact.\n " schema: type: - string - 'null' maxLength: 266 minLength: 0 x-position: 2 - name: Origin in: query description: "The origin station code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 3 - name: FirstName in: query description: "The first name of a passenger or contact.\n " schema: type: - string - 'null' maxLength: 32 minLength: 0 x-position: 4 - name: LastName in: query description: "The last name of a passenger or contact.\n " schema: type: - string - 'null' maxLength: 32 minLength: 0 x-position: 5 - name: CustomerNumber in: query description: "One of the passengers customer numbers applied.\n " schema: type: - string - 'null' maxLength: 20 minLength: 0 x-position: 6 - name: DepartureDate in: query description: "The first journeys departure date.\n " schema: type: - string - 'null' format: date-time x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Retrieve booking: description: Successful retrieval of a booking value: data: selfServiceMoveAvailable: false bookingKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- recordLocator: PC6Z4H currencyCode: USD systemCode: SYS groupName: GRP locators: numericRecordLocator: '310530162615' parentRecordLocator: PB5L2S parentId: 0 recordLocators: - recordLocatorKey: NjA4NjQyMjchTlY- recordCode: '60864227' systemDomainCode: MVS owningSystemCode: NV bookingSystemCode: NV interactionPurpose: ML hostedCarrierCode: MK info: status: 2 paidStatus: 1 priceStatus: 2 profileStatus: 1 bookingType: Default channelType: 1 bookedDate: '2026-07-09T05:55:14.160618Z' createdDate: '2026-07-09T05:55:14.1606181Z' expirationDate: '2026-07-12T05:55:14.1606182Z' modifiedDate: '2026-07-09T05:58:14.1606195Z' modifiedAgentId: 1 createdAgentId: 1 owningCarrierCode: NV changeAllowed: true createdUserKey: MQ-- modifiedUserKey: MQ-- sales: created: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW source: isoCountryCode: LA sourceSystemCode: LA agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW modified: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW typeOfSale: residentCountry: US promotionCode: PROMO fareTypes: - FareType hold: expiration: '2026-07-12T05:55:14.1606231Z' breakdown: balanceDue: 0.0 pointsBalanceDue: 0.0 authorizedBalanceDue: 0.0 totalAmount: 66.44 totalPoints: 0.0 totalToCollect: 66.44 totalPointsToCollect: 0.0 totalCharged: 66.44 passengerTotals: services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF totalCost: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 0.3 code: INFT detail: Infant Fee type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 0.3 ticketCode: INF totalCost: null journeyTotals: totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 journeys: tlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 addOnTotals: car: 1.0 hotel: 0.0 activities: 0.0 receivedBy: receivedBy: Doe, John latestReceivedBy: Doe, John receivedReference: DOE latestReceivedReference: DOE referralCode: REFERRAL contacts: p: contactTypeCode: P phoneNumbers: - type: 1 number: '98123124123' cultureCode: USD address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com customerNumber: '2050001326' sourceOrganization: WWW distributionOption: 0 notificationPreference: 0 companyName: Company Name name: first: John middle: Cee last: Doe title: MR suffix: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: MTk2MjE1 customerNumber: '2050001326' fees: - type: 9 ssrCode: SSR ssrNumber: 365 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: JSF detail: Fee Details passengerFeeKey: MCEwITk- override: false flightReference: 20250131 NV5670 SLCBOS note: Fee Notes createdDate: '2026-07-09T05:55:14.1606482Z' isProtected: false serviceCharges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF name: first: John middle: Cee last: Doe title: MR suffix: null passengerTypeCode: ADT discountCode: ADT bags: - identifier: '5670' baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- nonStandard: false type: Backpack osTag: NV3665 osTagDate: '2026-07-09T05:55:14.1606508Z' taggedToStation: BOS stationCode: SLC weight: 5 taggedToCarrierCode: JanSport Backpack weightType: 2 program: code: ADT levelCode: LVL number: '365' infant: fees: [] nationality: US dateOfBirth: '2025-07-09T05:55:14.160655+00:00' travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: JR nationality: US expirationDate: '2036-07-09T05:55:14.1606533Z' number: P31322423218 issuedDate: '2025-07-09T05:55:14.1606538Z' gender: 1 dateOfBirth: '2025-07-09T05:55:14.1606541Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City residentCountry: US gender: 1 name: first: John middle: Cee last: Doe title: MR suffix: JR type: INFT declaredGender: null info: nationality: US residentCountry: US gender: 1 dateOfBirth: '2002-07-09T05:55:14.1606609Z' familyNumber: 1 declaredGender: null travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: null nationality: US expirationDate: '2036-07-09T05:55:14.1606564Z' number: P31322423218 issuedDate: '2016-07-09T05:55:14.1606565Z' gender: 1 dateOfBirth: '2002-07-09T05:55:14.1606566Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City addresses: - status: 0 companyName: Company Name lineOne: Line One passengerAddressKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- phone: 801-555-1212 lineTwo: Line Two stationCode: SLC lineThree: Line Three emailAddress: johndoe@gmail.com countryCode: US cultureCode: US provinceState: UT refusedContact: false city: Salt Lake City postalCode: '84101' weightCategory: 1 emdCoupons: - status: 0 passengerEmdCouponKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- emdTypeCode: 0 emdNumber: '1234567890123' couponNumber: 1 optionalServiceInformation: carrierCode: NV reasonForIssuanceSubCode: RFISC salesDate: '2026-07-09T05:55:14.1606583Z' flightReference: 20250131 NV5670 SLCBOS receivedFromSystemCode: GDS numberOfServices: 1 feeType: 9 feeKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- ssrCode: SSR ssrNumber: 365 journeys: - flightType: 1 stops: 0 designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:14.1606841Z' departure: '2026-07-09T05:55:14.1606842Z' move: maxMoveBackDays: 365 maxMoveOutDays: 365 segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:14.1606841Z' departure: '2026-07-09T05:55:14.1606842Z' isSeatmapViewable: true fares: - isGoverning: true carrierCode: NV fareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjB_flg- classOfService: E classType: Class Type fareApplicationType: 0 fareClassOfService: E fareBasisCode: ERPTSFRE fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: E ruleNumber: RPTS productClass: C2 ruleTariff: RPTS travelClassCode: C pricingDate: '2026-07-09T05:55:14.1606638Z' crossReferenceClassOfService: E fareDesignator: fareTypeCodes: - A - AP - B - C passengerFares: - serviceCharges: - amount: 2.44 code: USTAX detail: SLC-BOS type: 5 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 2.44 ticketCode: US discountCode: ADT fareDiscountCode: 20DDISC ticketFareBasis: null passengerType: ADT fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '5670' carrierCode: NV opSuffix: N passengerSegment: mcfbrfQ-: seats: - compartmentDesignator: C penalty: 0 unitDesignator: 7G seatInformation: deck: 1 seatSet: 1 propertyList: aisle: 'TRUE' bulkhead: 'TRUE' tcc: C arrivalStation: BOS departureStation: SLC passengerKey: MCFBRFQ- unitKey: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9TITdHIUM- crossReferenceSeatingPreference: A isPending: false seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T passengerKey: MCFBRFQ- activityDate: '2026-07-09T05:55:14.1606648Z' boardingSequence: '0' createdDate: '2026-07-09T05:55:14.160665Z' liftStatus: 0 modifiedDate: '2026-07-09T06:05:14.1606651Z' overBookIndicator: 0 priorityDate: '2026-07-09T05:55:14.1606654Z' timeChanged: false verifiedTravelDocs: null sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW ssrs: - isConfirmed: false isConfirmingUnheld: false note: Note ssrDuration: 2 ssrKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- count: 1 ssrCode: SSR feeCode: JSF inBundle: true passengerKey: MCFBRFQ- ssrDetail: Detail ssrNumber: 365 market: identifier: identifier: '5670' carrierCode: NV opSuffix: N destination: BOS origin: SLC departureDate: '2026-07-09T05:55:14.1606702Z' tickets: - ticketNumber: '1234567890123' infantTicketNumber: '1234567890124' ticketIndicator: 1 ticketStatus: 1 passengerKey: MCFBRFQ- bags: - baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- passengerKey: MCFBRFQ- arrivalStation: BOS status: 0 departureStation: SLC osTag: NV3665 scores: - guestValueCode: GVC score: 100 passengerKey: MCFBRFQ- boardingPassDetail: gateInformation: Gate Information priorityInformation: Priority Information cabinClass: Cabin Class compartmentLevel: Compartment level boardingZone: Boarding Zone seatAssignment: Seat Assignment sequenceNumber: Sequence Number hasInfant: true seatPreferences: seat: 2 travelClass: 2 advancedPreferences: - seatMapCode: AISLE value: 'TRUE' status: 1 bundleCode: CC02 verifiedTravelDocuments: - MTU4NjExIVBDNlo0SCFmYWxzZQ-- referenceNumber: 35642 baggageGroupNumber: 2 baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 1 cabinOfService: C externalIdentifier: identifier: '5660' carrierCode: MK opSuffix: M priorityCode: R changeReasonCode: 0 segmentType: 0 salesDate: '2026-07-09T05:55:14.160675Z' international: false flightReference: 20250131 NV5670 SLCBOS legs: - legKey: NjM4NzM5NDE0MDAwMDAwMDAwIU5WITU2NzAhICFTTEMhQk9TITI0MDYxMDQ- operationsInfo: arrivalGate: estimatedGate: First Gate actualGate: Second Gate estimatedArrivalTime: '2026-07-09T08:55:14.1606765Z' departureGate: estimatedGate: First Gate actualGate: Second Gate actualOffBlockTime: '2026-07-10T05:55:14.1606776Z' actualOnBlockTime: '2026-07-10T05:55:14.1606777Z' actualTouchDownTime: '2026-07-11T05:55:14.1606779Z' airborneTime: '2026-07-10T08:55:14.160678Z' arrivalNote: Arrival Note arrivalStatus: 0 baggageClaim: Baggage Claim departureNote: Departure Note departureStatus: 0 departureTimes: scheduled: '2026-07-09T05:55:14.1606786Z' estimated: '2026-07-09T05:45:14.1606787Z' standardArrivalTime: '2026-07-10T05:55:14.1606789Z' tailNumber: 9V-SKA designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:14.1606841Z' departure: '2026-07-09T05:55:14.1606842Z' legInfo: departureTimeUtc: '2026-07-09T12:55:14Z' arrivalTimeUtc: '2026-07-10T10:55:14Z' adjustedCapacity: 168 arrivalTerminal: Concourse A arrivalTimeVariant: -300 backMoveDays: 365 capacity: 171 changeOfDirection: false codeShareIndicator: 0 departureTerminal: Concourse B departureTimeVariant: -420 equipmentType: '767' equipmentTypeSuffix: '200' eTicket: false irop: false lid: 168 marketingCode: DJM_3R marketingOverride: false operatedByText: Operated By NV operatingCarrier: NV operatingFlightNumber: '5670' operatingOpSuffix: N outMoveDays: 365 arrivalTime: '2026-07-10T05:55:14.1606805Z' departureTime: '2026-07-09T05:55:14.1606806Z' prbcCode: B767EMDJ scheduleServiceType: S sold: 6 status: 0 subjectToGovtApproval: false nests: - adjustedCapacity: 168 classNest: 8 lid: 168 travelClassCode: C nestType: 0 legClasses: - classNest: 8 classAllotted: 0 classType: C classAuthorizedUnits: 0 classOfService: C classRank: 0 classSold: 0 cnxSold: 0 latestAdvancedReservation: 0 status: 0 thruSold: 0 ssrs: - available: 88 ssrNestCode: 1BAG lid: 168 sold: 100 unitSold: 80 seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T flightReference: 20250131 NV5670 SLCBOS status: 6 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: - type: 0 text: Comment createdDate: '2026-07-09T05:55:14.1606859Z' pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW commentKey: MASDFASDXCFQ- queues: - code: AQCD subCode: AQBD name: Automation Queue Smoke queueId: 121940 passengerId: 196215 watchListId: 23 note: Booking with balance due of 67.44 type: 15 action: 0 mode: 0 flightReference: 20250131 NV5670 SLCBOS bookingQueueKey: MTIxOTQwIUFRQ0Qh passengerAlternateKey: MTk2MjE1 watchListKey: MjM- history: - historyCategory: 31 details: Assigned Seat event: 4 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW receivedBy: Doe, John receivedByReference: '315231' createdDate: '2026-07-09T05:55:14.1606882Z' payments: - paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx code: VI approvalDate: '2026-07-09T05:55:14.1606892Z' details: accountNumberId: 0 parentPaymentId: 0 accountName: John Doe accountNumber: '5110920006810092' expirationDate: '2030-07-09T05:55:14.1606901Z' text: Payment installments: 0 binRange: 511092 fields: payment Field: Payment Field Value amounts: amount: 67.44 currencyCode: USD collected: 67.44 collectedCurrencyCode: USD quoted: 67.44 quotedCurrencyCode: USD authorizationCode: AUTH authorizationStatus: 4 fundedDate: '2026-07-09T05:55:14.1606917Z' transactionCode: TRANSACTION dcc: rateId: 758db33b-103a-4a34-93b1-90414c788963 currencyCode: USD rateValue: 1.0 amount: 67.44 putInState: STATE status: 2 applicable: true threeDSecure: browserUserAgent: TAW3 browserAccept: SYS remoteIpAddress: 192.168.1.1 termUrl: www.bank.com paReq: Payload acsUrl: www.bank.com paRes: Response authResult: Approved cavv: UmFuZG9tIENBVlY= cavvAlgorithm: Encryption eci: '05' xid: SDF235 applicable: true successful: true threeDSecureSessionId: VGhpcyBpcyBhIHJhbmRvbSB0aHJlZSBEIHNlY3VyZSBzZXNzaW9uIElELg== challengePreference: 0 challengeWindowSize: 0 transactionIdThreeDSecure: 6f068cbd-40cc-97d2-e8bc-139591794461 threeDSecureVersion: 1.0.2 merchantData: MerchantData redirectJwt: VGhpcyBpcyBhIHJhbmRvbSByZWRpcmVjdCBKV1QgdG9rZW4gc3RyaW5nLg== redirectJwtUrl: www.bank.com dsTransactionId: SDF235 authenticationStatus: 1 attachments: - id: 365291 paymentId: 3652391231 attachment: AQIDBAU= createdDate: '2026-07-09T05:55:14.1607027Z' modifiedDate: '2026-07-09T06:00:14.1607029Z' type: 0 status: 3 transferred: false channelType: 1 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW deposit: false accountId: 0 voucher: id: 0 transactionId: 0 overrideRestrictions: false overrideAmount: false recordLocator: PC6Z4H addedToState: true createdAgentId: 1 modifiedAgentId: 1 reference: 150509 passengerVoucher: passengerVoucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx passengerKey: MCFBRFQ- voucherConfigurationCode: HNDACAR voucherUses: - 13 customerPrograms: - programCode: HNDA programNumber: '3215135' customerNumber: '2050001326' addOns: honda Civic: paymentRequired: false status: 0 addOnKey: null type: 4 summary: total: 100.0 held: 0.0 charged: 100.0 supplierCode: HONDA beginDate: '2026-07-09T05:55:14.1607073Z' beginLocation: SLC endDate: '2026-07-16T05:55:14.1607074Z' endLocation: BOS externalReference: HONDA-123 description: Car Rental externalConfirmationNumber: HDA365 reference: Component Reference created: agentReference: MTIxNTg- agentCode: Agent date: '2026-07-09T05:55:14.1607091Z' organizationCode: WWW domainCode: TAW3 locationCode: TAW3 source: agentCode: Agent organizationCode: WWW domainCode: TAW3 locationCode: TAW3 declinedText: Declined Component Text cultureCode: US modifiedDate: '2026-07-09T06:55:14.1607094Z' modifiedAgentReference: Agent Reference order: address: coordinates: latitude: '40.7608' longitude: ' -111.951814' lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' orderKey: HNDA365 phoneNumbers: - type: 1 number: '98123124123' active: false locations: - description: Salt Lake City Location code: SLC utcOffset: 365.0 usageDate: '0001-01-01T00:00:00' criteria: catalogCode: A countryCode: US supplierCode: JPN departmentCode: CARS vendorCode: HNDA companyCode: HNDA ratingCode: '10' discountCode: CVCDSC promotionCode: HNDASALE currencyCode: USD categoryCode: CAR customer: customerKey: MCFBRFQ- name: first: John middle: Cee last: Doe title: MR suffix: null customerNumber: '2050001326' address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' dateOfBirth: '2002-07-09T05:55:14.1607145Z' emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 thumbnailFileName: File Name participants: john Doe: participantKey: MCFBRFQ- description: New Participant name: first: John middle: Cee last: Doe title: MR suffix: null participantTypeCode: ADT address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' isPrimary: true dateOfBirth: '2002-07-09T05:55:14.1607166Z' document: number: '1' issuedByCode: PRTICPANT documentTypeCode: CHECK emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 quantity: 10 history: - code: Y previousCode: N note: Note created: '2026-07-09T05:55:14.1607175Z' hasError: false usageDate: '0001-01-01T00:00:00' payment: paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx type: VI currencyCode: USD name: first: John middle: Cee last: Doe title: MR suffix: null number: '5110920006810092' expiration: '2030-07-09T05:55:14.1607186Z' cvv: '365' amount: 100.0 description: Payment Description issueNumber: '3656912' address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com phoneNumbers: - type: 1 number: '98123124123' externalLocator: JPN parameters: - value: '10' code: HNDA description: Parameter Description description: Order Description descriptionFormatType: Description Format Type productDescription: Product Description productVariationDescription: Product Variation Description paymentAction: 1 amounts: display: value: 25.0 total: 50.0 initial: value: 25.0 total: 50.0 markup: value: 25.0 total: 50.0 listed: value: 25.0 total: 50.0 listedDiscount: value: 25.0 total: 50.0 discount: value: 25.0 total: 50.0 handling: value: 25.0 total: 50.0 handlingDiscount: value: 25.0 total: 50.0 dueNow: preTax: 25.0 tax: 10.0 total: 35.0 dueLater: preTax: 25.0 tax: 10.0 total: 35.0 personalizations: 10.0 taxable: 35.0 services: 50.0 fees: 100.0 total: 115.0 taxRate: 2 taxExempt: true taxAtUnitPrice: true terms: - code: APPROVED description: Description terms: Terms cancellationTerms: - code: CANCELLED description: Description terms: Terms details: - code: HNDA styleCode: H description: Description fees: - code: HND feeCategoryCode: VI description: Fee Description amount: value: 25.0 total: 50.0 foreignAmount: value: 25.0 total: 50.0 type: 0 isWaiveable: false foreignCurrencyCode: USD currencyCode: USD isChargeable: false notes: - text: Order Text description: Order Description created: '2026-07-09T05:55:14.1607242Z' modified: '2026-07-09T06:25:14.1607243Z' productVariationKey: HNDA365 productOrderKey: HNDA365 isHistorical: false charges: - type: 6 code: SRVC ticketCode: JSF collection: 0 currencyCode: USD amount: 64.0 details: Charge Details orders: - bookingOrderKey: HNDA365 orderId: 46477700-2ba8-48f1-b157-102d3b54871f collect: 100.0 thirdPartyCharge: 0.0 thirdPartyHold: 0.0 total: 100.0 status: 1 '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 search criteria: description: The search parameters used did not meet the configured strategy in the Management Console. For more information about setting up the strategies, please refer to the Navitaire Developer Portal. value: errors: - id: null code: nsk:Booking:GeneralRestriction message: nsk:Booking:GeneralRestriction type: Validation details: null rawMessage: Invalid search criteria 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 Validation failed: description: The booking associated with the record locator is not found or the provided search parameters didn't match with the booking. The value for the `rawMessage` might differ depending on the strategy used. Aside from the first and last name, it could be email, customer number, last name or origin and departure date. value: errors: - id: null code: nsk:Booking:GeneralRestriction message: nsk:Booking:GeneralRestriction type: Validation details: null rawMessage: First and last name validation failed 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 security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{bookingKey}/history: get: tags: - Bookings summary: Gets an itinerary history stateless. description: 'GraphQL endpoint: bookingsHistory' operationId: nsk_v1_bookings_bookingKey_history_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 - name: Event in: query description: "The event that triggered the history entry.\n \nEnumeration values: 0 = Unknown, 1 = ConvertedHistory, 2 = FlightTimeChange, 3 = FlightDesignatorChange, 4 = AssignedSeat, 5 = RemoveSeat, 6 = AddedFlight, 7 = DeletedFlight, 8 = DeletedPassenger, 9 = NameChange, 10 = GroupNameChange, 11 = CancelledTicketing, 12 = ScheduleChange, 13 = AddedPayment, 14 = ServiceFee, 15 = QueuedPnr, 16 = UnqueuedPnr, 17 = DeletedComment, 18 = Divided, 19 = CheckedIn, 20 = CheckedOut, 21 = FareOverride, 22 = AddedBaggage, 23 = ChangedBaggageWeight, 24 = CheckedBaggage, 25 = RemovedBaggage, 26 = BoardedPassenger, 27 = UnboardedPassenger, 28 = ManualAuthorization, 29 = ManualDecline, 30 = UndoCancel, 31 = ItinerarySent, 32 = ContactChange, 33 = SsrAdded, 34 = FlightMoved, 35 = VerifiedDocument, 36 = RemovedVerifiedDocument, 37 = Promotion, 38 = BookingComment, 39 = CancelledSchedule, 40 = CancelServiceFee, 41 = OverrideServiceFee, 42 = AddedRecordLocator, 43 = DeletedRecordLocator, 44 = UpgradeClassOfService, 45 = DowngradeClassOfService, 46 = StandbyPriorityChange, 47 = AssignedTicketNumber, 48 = DeletedTicketNumber, 49 = ConfirmSegmentStatusCodeChange, 50 = CodeshareFlightChanged, 51 = PdsCancel, 52 = PdsPending, 53 = PdsConfirm, 54 = PdsFinalized, 55 = PdsDeclined, 56 = PdsException, 57 = PdsCancelRefused, 58 = PdsCancelUnsuccessful, 59 = Apps, 60 = InhibitedOverride, 61 = PrintedBagTag, 62 = SelfPrintedBagTag, 63 = PrintedBoardingPass, 64 = AddCustomerId, 65 = DeleteCustomerId, 66 = HoldCreated, 67 = HoldRemoved, 68 = HoldChanged, 69 = OverrideCoupon, 70 = PdsSynchronized, 71 = PdsItemremoved, 72 = Reprice, 73 = ChannelOverride, 74 = EmdCreated, 75 = EmdRemoved, 76 = EmdChanged, 77 = ServiceBundle, 78 = PublishedFareOverride, 79 = FareClassRealignment, 80 = AddedDocument, 81 = ChangedDocument, 82 = DeletedPaymentProperties" schema: $ref: '#/components/schemas/BookingHistoryEvent' x-position: 2 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n " schema: type: - string - 'null' x-position: 3 - name: PageSize in: query description: "The page size for the response.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 4 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfHistoryResponse' examples: Retrieve Booking History Stateless Response: description: Example response for successfully retrieving the booking history. value: data: histories: - historyCategory: 30 details: AD P 1234 event: 2 pointOfSale: isoCountryCode: null sourceSystemCode: null agentCode: CCAuserM domainCode: DEF locationCode: HDQ organizationCode: SYSTEM sourcePointOfSale: isoCountryCode: null sourceSystemCode: null agentCode: CCAuserM domainCode: DEF locationCode: HDQ organizationCode: SYSTEM receivedBy: Dailey, Paltry receivedByReference: 801-555-9965 createdDate: '2026-07-09T05:55:13.9045187+00:00' pageKey: null '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 passenger key error: description: Example error when passenger key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'bookingKey' with value 'ABCDE' is invalid. type: Validation details: bookingKey: ABCDE rawMessage: null 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: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{bookingKey}/history/bagTagPrint: get: tags: - Bookings summary: Gets the current bag tag print history for a booking, stateless. description: 'GraphQL endpoint: bookingsBagTagPrintv2' operationId: nsk_v1_bookings_bookingKey_history_bagTagPrint_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 - name: isBagTagSelfPrinted in: query description: Whether the bag tag is self printed. schema: type: - boolean - 'null' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBagTagPrintHistory' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] post: tags: - Bookings summary: Creates a bag tag print history for a booking, stateless. description: 'Also updates bag''s status from Added to AddedPrinted if Self-Tagging Baggage is enabled. In order to see the status of a bag, check bags on a passenger segment. The `Enable Baggage Self-Tagging` in Premium Services and `Write to booking history for bag tag printing` in Departure Control Settings must be enabled in Management Console for self bag-tag printing. GraphQL endpoints: bookingsBagTagPrintHistoryAdd, bookingsBagTagPrintHistoryAddBatch' operationId: nsk_v1_bookings_bookingKey_history_bagTagPrint_post parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 requestBody: x-name: request description: The bag tag print history request. content: application/json: schema: $ref: '#/components/schemas/BagTagPrintHistoryRequest' examples: Bag Tag Print History Request: description: Example request for creating a bag tag print history. value: legKey: NjM4NzkzNDMyMDAwMDAwMDAwIU5WITU2MjYhICFTTEMhREVOITMxNDQ0ODk- receivedBy: John Doe passengerName: first: John middle: Cee last: Doe title: MR suffix: null isBagTagSelfPrinted: true bagTagInformation: - osTag: 0888045757 taggedToStation: DEN weight: 15 weightType: 2 originStation: SLC required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Null Leg Key: description: The provided leg key is null. value: errors: - id: 09ef838d-5e7c-a7fa-fcbf-4b3429d4cfe6 code: BagTagPrintHistoryRequest.LegKey:RequiredAttribute message: BagTagPrintHistoryRequest.LegKey:RequiredAttribute type: Validation details: validation: RequiredAttribute model: BagTagPrintHistoryRequest member: LegKey rawMessage: The BagTagPrintHistoryRequest field is required. 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. Invalid Leg Key: description: The provided leg key is invalid and cannot be decoded correctly. value: errors: - id: cfffb48e-507e-6874-5cbd-a397225ffc9e code: nsk:Booking:InvalidLegKey message: nsk:Booking:InvalidLegKey type: Validation details: null rawMessage: The leg key NjM4NzkzNDMyMDAwMDAwMDAwIU5WITU2MjYhICFTTEMhREVOITMxsNDQ0ODk- is not valid. 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. Invalid Booking Key: description: The provided booking key is invalid and cannot be decoded correctly. value: errors: - id: 90465c09-d169-3619-ac68-ed84ca71392e code: nsk:Exceptions:InvalidKey message: The identifier 'bookingKey' with value 'NDAyMjY2sIVFEUVlGRSFmYWxzZQ--' is invalid. type: Validation details: bookingKey: NDAyMjY2sIVFEUVlGRSFmYWxzZQ-- rawMessage: The identifier 'bookingKey' with value 'NDAyMjY2sIVFEUVlGRSFmYWxzZQ--' 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. Invalid Baggage Weight: description: The baggage weight is invalid or out of range. value: errors: - id: add3f8a9-237d-040c-3a45-e2708bf44a69 code: BagTagInformation.Weight:RangeAttribute message: BagTagInformation.Weight:RangeAttribute type: Validation details: validation: RangeAttribute model: BagTagInformation member: Weight rawMessage: The field BagTagInformation must be between 0 and 32767. 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. Invalid Baggage Weight Type: description: The baggage weight type is invalid or out of range. value: errors: - id: ffedb436-96be-b87c-f338-f68ff1335fcd code: core:Validation:EnumOutOfRange message: The enum 'WeightType' contains an invalid value of '3'. type: Validation details: value: '3' name: WeightType rawMessage: The enum 'WeightType' contains an invalid value of '3'. 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. Invalid Origin Station Length: description: The origin station is exceeded the maximum character length. value: errors: - id: e255e91c-96f7-472f-5662-700ea3f1436d code: BagTagInformation.OriginStation:StringLengthAttribute message: The field BagTagInformation must be a string with a minimum length of 3 and a maximum length of 3. type: Validation details: validation: StringLengthAttribute model: BagTagInformation member: OriginStation rawMessage: The field BagTagInformation must be a string with a minimum length of 3 and a maximum length of 3. 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. Invalid Tagged To Station Length: description: The tagged to station exceeded the maximum character length. value: errors: - id: 6aaa4d83-e780-eb34-028f-b6fbc272d0f9 code: BagTagInformation.TaggedToStation:StringLengthAttribute message: The field BagTagInformation must be a string with a minimum length of 3 and a maximum length of 3. type: Validation details: validation: StringLengthAttribute model: BagTagInformation member: TaggedToStation rawMessage: The field BagTagInformation must be a string with a minimum length of 3 and a maximum length of 3. 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. security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{bookingKey}/history/flightMove: get: tags: - Bookings summary: Gets a flight move history stateless. description: 'GraphQL endpoint: bookingsFlightMoveHistory' operationId: nsk_v1_bookings_bookingKey_history_flightMove_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n " schema: type: - string - 'null' x-position: 2 - name: PageSize in: query description: "The page size for the response.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 3 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFlightMoveHistoryResponse' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{bookingKey}/history/holdDateChange: get: tags: - Bookings summary: Gets the hold date change history records for a booking. description: 'GraphQL endpoint: bookingsHoldDateChangeHistory' operationId: nsk_v1_bookings_bookingKey_history_holdDateChange_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 - name: Event in: query description: "The event that triggered the hold date change history entry.\n \nEnumeration values: 66 = Created, 67 = Removed, 68 = Changed" schema: $ref: '#/components/schemas/HoldDateChangeEvent' x-position: 2 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n " schema: type: - string - 'null' x-position: 3 - name: PageSize in: query description: "The page size for the response.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 4 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfHoldDateChangeHistoryResponse' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{bookingKey}/history/itinerarySent: get: tags: - Bookings summary: Gets the itinerary sent history records for a booking. description: 'GraphQL endpoint: bookingsItinerarySentHistory' operationId: nsk_v1_bookings_bookingKey_history_itinerarySent_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n " schema: type: - string - 'null' x-position: 2 - name: PageSize in: query description: "The page size for the response.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 3 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfItinerarySentHistoryResponse' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{bookingKey}/history/message: get: tags: - Bookings summary: Gets a booking's message history, stateless. description: 'GraphQL endpoint: bookingsMessageHistory' operationId: nsk_v1_bookings_bookingKey_history_message_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingMessageHistory' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{bookingKey}/history/notification: get: tags: - Bookings summary: Gets the booking notification history, stateless. description: 'GraphQL endpoint: bookingsNotificationHistory' operationId: nsk_v1_bookings_bookingKey_history_notification_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingNotificationHistory' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{bookingKey}/history/seatAssignment: get: tags: - Bookings summary: Gets a seat assignment history stateless. description: 'GraphQL endpoint: bookingsSeatAssignmentHistory' operationId: nsk_v1_bookings_bookingKey_history_seatAssignment_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 - name: Event in: query description: "The event that triggered the seat assignment history entry.\n \nEnumeration values: 4 = AssignedSeat, 5 = RemoveSeat" schema: $ref: '#/components/schemas/SeatAssignmentEvent' x-position: 2 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n " schema: type: - string - 'null' x-position: 3 - name: PageSize in: query description: "The page size for the response.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 4 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSeatAssignmentHistoryResponse' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{bookingKey}/history/segmentChange: get: tags: - Bookings summary: Gets a segment change history stateless. description: 'GraphQL endpoint: bookingsSegmentChangeHistory' operationId: nsk_v1_bookings_bookingKey_history_segmentChange_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 - name: Event in: query description: "The event that triggered the seat assignment history entry.\n \nEnumeration values: 6 = AddedFlight, 7 = DeletedFlight" schema: $ref: '#/components/schemas/SegmentChangeEvent' x-position: 2 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n " schema: type: - string - 'null' x-position: 3 - name: PageSize in: query description: "The page size for the response.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 4 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSegmentChangeHistoryResponse' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v3/bookings/{bookingKey}/queue: post: tags: - Bookings summary: Adds a booking to a booking queue. description: 'GraphQL endpoint: bookingsEnqueuev3' operationId: nsk_v3_bookings_bookingKey_queue_post parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 requestBody: x-name: request description: The booking queue request v2. content: application/json: schema: $ref: '#/components/schemas/BookingQueueRequestv2' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Enqueue Booking, Queue Code Does Not Exist: description: Example error when trying to add a booking to a queue, and the requested queue code does not exist. value: errors: - id: null code: nsk-server:BookingQueueDoesNotExist message: nsk-server:BookingQueueDoesNotExist type: Information details: null rawMessage: Booking Queue 'ZZZZZ' does not exist in the DB.. 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 Manual Queueing for Queue Code Not Allowed: description: Example error when trying to add a booking to a queue, and manual queueing from that queue is not allowed. value: errors: - id: null code: nsk-server:InvalidSelfServiceRebookingQueuing message: nsk-server:InvalidSelfServiceRebookingQueuing type: Information details: null rawMessage: Manual queuing from a Self-Service Rebooking Booking Queue is not allowed. 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 Booking already in queue: description: Example error when trying to add a booking to a queue, and the booking is already in the target queue. value: errors: - id: null code: nsk-server:BookingAlreadyInQueue message: nsk-server:BookingAlreadyInQueue type: Information details: null rawMessage: 'Booking is already on queue: ''DAPI'', BookingID = 127160, BookingQueueItemID = 0, SegmentKey = ''''.' 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 security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/{bookingKey}/queue: post: tags: - Bookings summary: Adds a booking to a booking queue. description: 'GraphQL endpoint: bookingsEnqueuev2' operationId: nsk_v2_bookings_bookingKey_queue_post parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 requestBody: x-name: request description: The booking queue request v2. content: application/json: schema: $ref: '#/components/schemas/BookingQueueRequestv2' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true security: - JWT: [] delete: tags: - Bookings summary: Removes a booking from a booking queue. description: 'GraphQL endpoint: bookingsDequeuev2' operationId: nsk_v2_bookings_bookingKey_queue_delete parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 requestBody: x-name: request description: The booking queue delete request. content: application/json: schema: $ref: '#/components/schemas/BookingQueueDeleteRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{bookingKey}/queue/history: post: tags: - Bookings summary: Gets the booking queue history for a specific booking. description: 'GraphQL endpoint: bookingQueueHistory' operationId: nsk_v1_bookings_bookingKey_queue_history_post parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 requestBody: x-name: request description: The booking queue history request. content: application/json: schema: $ref: '#/components/schemas/BookingQueueHistoryRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingQueueHistory' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{recordLocator}: get: tags: - Bookings summary: Retrieves a booking itinerary stateless. description: 'This endpoint requires a session token and is agent-only. This is a stateless booking endpoint and `LegInfo` is not returned. This is intentional as New Skies does not query schedule data for this call. If this data is needed, please use the stateful booking retrieval endpoint/graph route to get this information. You can also use GET `/api/nsk/v2/trip/info/legs/simple` to get this information. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. If no booking associated with the record locator is found, an HTTP 404 `NotFound` will be returned. GraphQL endpoint: bookingsByRecordLocator' operationId: nsk_v1_bookings_recordLocator_get parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 responses: '200': description: OK. The request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Retrieve booking: description: Successful retrieval of a booking value: data: selfServiceMoveAvailable: false bookingKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- recordLocator: PC6Z4H currencyCode: USD systemCode: SYS groupName: GRP locators: numericRecordLocator: '310530162615' parentRecordLocator: PB5L2S parentId: 0 recordLocators: - recordLocatorKey: NjA4NjQyMjchTlY- recordCode: '60864227' systemDomainCode: MVS owningSystemCode: NV bookingSystemCode: NV interactionPurpose: ML hostedCarrierCode: MK info: status: 2 paidStatus: 1 priceStatus: 2 profileStatus: 1 bookingType: Default channelType: 1 bookedDate: '2026-07-09T05:55:13.1329999Z' createdDate: '2026-07-09T05:55:13.1330001Z' expirationDate: '2026-07-12T05:55:13.1330001Z' modifiedDate: '2026-07-09T05:58:13.133001Z' modifiedAgentId: 1 createdAgentId: 1 owningCarrierCode: NV changeAllowed: true createdUserKey: MQ-- modifiedUserKey: MQ-- sales: created: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW source: isoCountryCode: LA sourceSystemCode: LA agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW modified: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW typeOfSale: residentCountry: US promotionCode: PROMO fareTypes: - FareType hold: expiration: '2026-07-12T05:55:13.1330036Z' breakdown: balanceDue: 0.0 pointsBalanceDue: 0.0 authorizedBalanceDue: 0.0 totalAmount: 66.44 totalPoints: 0.0 totalToCollect: 66.44 totalPointsToCollect: 0.0 totalCharged: 66.44 passengerTotals: services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF totalCost: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 0.3 code: INFT detail: Infant Fee type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 0.3 ticketCode: INF totalCost: null journeyTotals: totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 journeys: tlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 addOnTotals: car: 1.0 hotel: 0.0 activities: 0.0 receivedBy: receivedBy: Doe, John latestReceivedBy: Doe, John receivedReference: DOE latestReceivedReference: DOE referralCode: REFERRAL contacts: p: contactTypeCode: P phoneNumbers: - type: 1 number: '98123124123' cultureCode: USD address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com customerNumber: '2050001326' sourceOrganization: WWW distributionOption: 0 notificationPreference: 0 companyName: Company Name name: first: John middle: Cee last: Doe title: MR suffix: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: MTk2MjE1 customerNumber: '2050001326' fees: - type: 9 ssrCode: SSR ssrNumber: 365 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: JSF detail: Fee Details passengerFeeKey: MCEwITk- override: false flightReference: 20250131 NV5670 SLCBOS note: Fee Notes createdDate: '2026-07-09T05:55:13.1330257Z' isProtected: false serviceCharges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF name: first: John middle: Cee last: Doe title: MR suffix: null passengerTypeCode: ADT discountCode: ADT bags: - identifier: '5670' baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- nonStandard: false type: Backpack osTag: NV3665 osTagDate: '2026-07-09T05:55:13.1330272Z' taggedToStation: BOS stationCode: SLC weight: 5 taggedToCarrierCode: JanSport Backpack weightType: 2 program: code: ADT levelCode: LVL number: '365' infant: fees: [] nationality: US dateOfBirth: '2025-07-09T05:55:13.1330305+00:00' travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: JR nationality: US expirationDate: '2036-07-09T05:55:13.1330288Z' number: P31322423218 issuedDate: '2025-07-09T05:55:13.1330295Z' gender: 1 dateOfBirth: '2025-07-09T05:55:13.1330297Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City residentCountry: US gender: 1 name: first: John middle: Cee last: Doe title: MR suffix: JR type: INFT declaredGender: null info: nationality: US residentCountry: US gender: 1 dateOfBirth: '2002-07-09T05:55:13.1330357Z' familyNumber: 1 declaredGender: null travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: null nationality: US expirationDate: '2036-07-09T05:55:13.1330323Z' number: P31322423218 issuedDate: '2016-07-09T05:55:13.1330324Z' gender: 1 dateOfBirth: '2002-07-09T05:55:13.1330325Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City addresses: - status: 0 companyName: Company Name lineOne: Line One passengerAddressKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- phone: 801-555-1212 lineTwo: Line Two stationCode: SLC lineThree: Line Three emailAddress: johndoe@gmail.com countryCode: US cultureCode: US provinceState: UT refusedContact: false city: Salt Lake City postalCode: '84101' weightCategory: 1 emdCoupons: - status: 0 passengerEmdCouponKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- emdTypeCode: 0 emdNumber: '1234567890123' couponNumber: 1 optionalServiceInformation: carrierCode: NV reasonForIssuanceSubCode: RFISC salesDate: '2026-07-09T05:55:13.1330338Z' flightReference: 20250131 NV5670 SLCBOS receivedFromSystemCode: GDS numberOfServices: 1 feeType: 9 feeKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- ssrCode: SSR ssrNumber: 365 journeys: - flightType: 1 stops: 0 designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.1330539Z' departure: '2026-07-09T05:55:13.133054Z' move: maxMoveBackDays: 365 maxMoveOutDays: 365 segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.1330539Z' departure: '2026-07-09T05:55:13.133054Z' isSeatmapViewable: true fares: - isGoverning: true carrierCode: NV fareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjB_flg- classOfService: E classType: Class Type fareApplicationType: 0 fareClassOfService: E fareBasisCode: ERPTSFRE fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: E ruleNumber: RPTS productClass: C2 ruleTariff: RPTS travelClassCode: C pricingDate: '2026-07-09T05:55:13.1330392Z' crossReferenceClassOfService: E fareDesignator: fareTypeCodes: - A - AP - B - C passengerFares: - serviceCharges: - amount: 2.44 code: USTAX detail: SLC-BOS type: 5 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 2.44 ticketCode: US discountCode: ADT fareDiscountCode: 20DDISC ticketFareBasis: null passengerType: ADT fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '5670' carrierCode: NV opSuffix: N passengerSegment: mcfbrfQ-: seats: - compartmentDesignator: C penalty: 0 unitDesignator: 7G seatInformation: deck: 1 seatSet: 1 propertyList: aisle: 'TRUE' bulkhead: 'TRUE' tcc: C arrivalStation: BOS departureStation: SLC passengerKey: MCFBRFQ- unitKey: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9TITdHIUM- crossReferenceSeatingPreference: A isPending: false seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T passengerKey: MCFBRFQ- activityDate: '2026-07-09T05:55:13.13304Z' boardingSequence: '0' createdDate: '2026-07-09T05:55:13.1330401Z' liftStatus: 0 modifiedDate: '2026-07-09T06:05:13.1330404Z' overBookIndicator: 0 priorityDate: '2026-07-09T05:55:13.1330406Z' timeChanged: false verifiedTravelDocs: null sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW ssrs: - isConfirmed: false isConfirmingUnheld: false note: Note ssrDuration: 2 ssrKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- count: 1 ssrCode: SSR feeCode: JSF inBundle: true passengerKey: MCFBRFQ- ssrDetail: Detail ssrNumber: 365 market: identifier: identifier: '5670' carrierCode: NV opSuffix: N destination: BOS origin: SLC departureDate: '2026-07-09T05:55:13.1330438Z' tickets: - ticketNumber: '1234567890123' infantTicketNumber: '1234567890124' ticketIndicator: 1 ticketStatus: 1 passengerKey: MCFBRFQ- bags: - baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- passengerKey: MCFBRFQ- arrivalStation: BOS status: 0 departureStation: SLC osTag: NV3665 scores: - guestValueCode: GVC score: 100 passengerKey: MCFBRFQ- boardingPassDetail: gateInformation: Gate Information priorityInformation: Priority Information cabinClass: Cabin Class compartmentLevel: Compartment level boardingZone: Boarding Zone seatAssignment: Seat Assignment sequenceNumber: Sequence Number hasInfant: true seatPreferences: seat: 2 travelClass: 2 advancedPreferences: - seatMapCode: AISLE value: 'TRUE' status: 1 bundleCode: CC02 verifiedTravelDocuments: - MTU4NjExIVBDNlo0SCFmYWxzZQ-- referenceNumber: 35642 baggageGroupNumber: 2 baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 1 cabinOfService: C externalIdentifier: identifier: '5660' carrierCode: MK opSuffix: M priorityCode: R changeReasonCode: 0 segmentType: 0 salesDate: '2026-07-09T05:55:13.1330478Z' international: false flightReference: 20250131 NV5670 SLCBOS legs: - legKey: NjM4NzM5NDE0MDAwMDAwMDAwIU5WITU2NzAhICFTTEMhQk9TITI0MDYxMDQ- operationsInfo: arrivalGate: estimatedGate: First Gate actualGate: Second Gate estimatedArrivalTime: '2026-07-09T08:55:13.133049Z' departureGate: estimatedGate: First Gate actualGate: Second Gate actualOffBlockTime: '2026-07-10T05:55:13.13305Z' actualOnBlockTime: '2026-07-10T05:55:13.1330501Z' actualTouchDownTime: '2026-07-11T05:55:13.1330502Z' airborneTime: '2026-07-10T08:55:13.1330503Z' arrivalNote: Arrival Note arrivalStatus: 0 baggageClaim: Baggage Claim departureNote: Departure Note departureStatus: 0 departureTimes: scheduled: '2026-07-09T05:55:13.1330507Z' estimated: '2026-07-09T05:45:13.1330508Z' standardArrivalTime: '2026-07-10T05:55:13.133051Z' tailNumber: 9V-SKA designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.1330539Z' departure: '2026-07-09T05:55:13.133054Z' legInfo: departureTimeUtc: '2026-07-09T12:55:13Z' arrivalTimeUtc: '2026-07-10T10:55:13Z' adjustedCapacity: 168 arrivalTerminal: Concourse A arrivalTimeVariant: -300 backMoveDays: 365 capacity: 171 changeOfDirection: false codeShareIndicator: 0 departureTerminal: Concourse B departureTimeVariant: -420 equipmentType: '767' equipmentTypeSuffix: '200' eTicket: false irop: false lid: 168 marketingCode: DJM_3R marketingOverride: false operatedByText: Operated By NV operatingCarrier: NV operatingFlightNumber: '5670' operatingOpSuffix: N outMoveDays: 365 arrivalTime: '2026-07-10T05:55:13.1330521Z' departureTime: '2026-07-09T05:55:13.1330521Z' prbcCode: B767EMDJ scheduleServiceType: S sold: 6 status: 0 subjectToGovtApproval: false nests: - adjustedCapacity: 168 classNest: 8 lid: 168 travelClassCode: C nestType: 0 legClasses: - classNest: 8 classAllotted: 0 classType: C classAuthorizedUnits: 0 classOfService: C classRank: 0 classSold: 0 cnxSold: 0 latestAdvancedReservation: 0 status: 0 thruSold: 0 ssrs: - available: 88 ssrNestCode: 1BAG lid: 168 sold: 100 unitSold: 80 seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T flightReference: 20250131 NV5670 SLCBOS status: 6 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: - type: 0 text: Comment createdDate: '2026-07-09T05:55:13.1330552Z' pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW commentKey: MASDFASDXCFQ- queues: - code: AQCD subCode: AQBD name: Automation Queue Smoke queueId: 121940 passengerId: 196215 watchListId: 23 note: Booking with balance due of 67.44 type: 15 action: 0 mode: 0 flightReference: 20250131 NV5670 SLCBOS bookingQueueKey: MTIxOTQwIUFRQ0Qh passengerAlternateKey: MTk2MjE1 watchListKey: MjM- history: - historyCategory: 31 details: Assigned Seat event: 4 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW receivedBy: Doe, John receivedByReference: '315231' createdDate: '2026-07-09T05:55:13.1330572Z' payments: - paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx code: VI approvalDate: '2026-07-09T05:55:13.1330578Z' details: accountNumberId: 0 parentPaymentId: 0 accountName: John Doe accountNumber: '5110920006810092' expirationDate: '2030-07-09T05:55:13.1330583Z' text: Payment installments: 0 binRange: 511092 fields: payment Field: Payment Field Value amounts: amount: 67.44 currencyCode: USD collected: 67.44 collectedCurrencyCode: USD quoted: 67.44 quotedCurrencyCode: USD authorizationCode: AUTH authorizationStatus: 4 fundedDate: '2026-07-09T05:55:13.1330593Z' transactionCode: TRANSACTION dcc: rateId: bec19ef4-a914-4a86-93ed-c75209849fca currencyCode: USD rateValue: 1.0 amount: 67.44 putInState: STATE status: 2 applicable: true threeDSecure: browserUserAgent: TAW3 browserAccept: SYS remoteIpAddress: 192.168.1.1 termUrl: www.bank.com paReq: Payload acsUrl: www.bank.com paRes: Response authResult: Approved cavv: UmFuZG9tIENBVlY= cavvAlgorithm: Encryption eci: '05' xid: SDF235 applicable: true successful: true threeDSecureSessionId: VGhpcyBpcyBhIHJhbmRvbSB0aHJlZSBEIHNlY3VyZSBzZXNzaW9uIElELg== challengePreference: 0 challengeWindowSize: 0 transactionIdThreeDSecure: 6f068cbd-40cc-97d2-e8bc-139591794461 threeDSecureVersion: 1.0.2 merchantData: MerchantData redirectJwt: VGhpcyBpcyBhIHJhbmRvbSByZWRpcmVjdCBKV1QgdG9rZW4gc3RyaW5nLg== redirectJwtUrl: www.bank.com dsTransactionId: SDF235 authenticationStatus: 1 attachments: - id: 365291 paymentId: 3652391231 attachment: AQIDBAU= createdDate: '2026-07-09T05:55:13.1330687Z' modifiedDate: '2026-07-09T06:00:13.1330688Z' type: 0 status: 3 transferred: false channelType: 1 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW deposit: false accountId: 0 voucher: id: 0 transactionId: 0 overrideRestrictions: false overrideAmount: false recordLocator: PC6Z4H addedToState: true createdAgentId: 1 modifiedAgentId: 1 reference: 150509 passengerVoucher: passengerVoucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx passengerKey: MCFBRFQ- voucherConfigurationCode: HNDACAR voucherUses: - 13 customerPrograms: - programCode: HNDA programNumber: '3215135' customerNumber: '2050001326' addOns: honda Civic: paymentRequired: false status: 0 addOnKey: null type: 4 summary: total: 100.0 held: 0.0 charged: 100.0 supplierCode: HONDA beginDate: '2026-07-09T05:55:13.1330734Z' beginLocation: SLC endDate: '2026-07-16T05:55:13.1330735Z' endLocation: BOS externalReference: HONDA-123 description: Car Rental externalConfirmationNumber: HDA365 reference: Component Reference created: agentReference: MTIxNTg- agentCode: Agent date: '2026-07-09T05:55:13.1330746Z' organizationCode: WWW domainCode: TAW3 locationCode: TAW3 source: agentCode: Agent organizationCode: WWW domainCode: TAW3 locationCode: TAW3 declinedText: Declined Component Text cultureCode: US modifiedDate: '2026-07-09T06:55:13.133075Z' modifiedAgentReference: Agent Reference order: address: coordinates: latitude: '40.7608' longitude: ' -111.951814' lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' orderKey: HNDA365 phoneNumbers: - type: 1 number: '98123124123' active: false locations: - description: Salt Lake City Location code: SLC utcOffset: 365.0 usageDate: '0001-01-01T00:00:00' criteria: catalogCode: A countryCode: US supplierCode: JPN departmentCode: CARS vendorCode: HNDA companyCode: HNDA ratingCode: '10' discountCode: CVCDSC promotionCode: HNDASALE currencyCode: USD categoryCode: CAR customer: customerKey: MCFBRFQ- name: first: John middle: Cee last: Doe title: MR suffix: null customerNumber: '2050001326' address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' dateOfBirth: '2002-07-09T05:55:13.1330794Z' emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 thumbnailFileName: File Name participants: john Doe: participantKey: MCFBRFQ- description: New Participant name: first: John middle: Cee last: Doe title: MR suffix: null participantTypeCode: ADT address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' isPrimary: true dateOfBirth: '2002-07-09T05:55:13.1330817Z' document: number: '1' issuedByCode: PRTICPANT documentTypeCode: CHECK emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 quantity: 10 history: - code: Y previousCode: N note: Note created: '2026-07-09T05:55:13.1330822Z' hasError: false usageDate: '0001-01-01T00:00:00' payment: paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx type: VI currencyCode: USD name: first: John middle: Cee last: Doe title: MR suffix: null number: '5110920006810092' expiration: '2030-07-09T05:55:13.1330829Z' cvv: '365' amount: 100.0 description: Payment Description issueNumber: '3656912' address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com phoneNumbers: - type: 1 number: '98123124123' externalLocator: JPN parameters: - value: '10' code: HNDA description: Parameter Description description: Order Description descriptionFormatType: Description Format Type productDescription: Product Description productVariationDescription: Product Variation Description paymentAction: 1 amounts: display: value: 25.0 total: 50.0 initial: value: 25.0 total: 50.0 markup: value: 25.0 total: 50.0 listed: value: 25.0 total: 50.0 listedDiscount: value: 25.0 total: 50.0 discount: value: 25.0 total: 50.0 handling: value: 25.0 total: 50.0 handlingDiscount: value: 25.0 total: 50.0 dueNow: preTax: 25.0 tax: 10.0 total: 35.0 dueLater: preTax: 25.0 tax: 10.0 total: 35.0 personalizations: 10.0 taxable: 35.0 services: 50.0 fees: 100.0 total: 115.0 taxRate: 2 taxExempt: true taxAtUnitPrice: true terms: - code: APPROVED description: Description terms: Terms cancellationTerms: - code: CANCELLED description: Description terms: Terms details: - code: HNDA styleCode: H description: Description fees: - code: HND feeCategoryCode: VI description: Fee Description amount: value: 25.0 total: 50.0 foreignAmount: value: 25.0 total: 50.0 type: 0 isWaiveable: false foreignCurrencyCode: USD currencyCode: USD isChargeable: false notes: - text: Order Text description: Order Description created: '2026-07-09T05:55:13.1330876Z' modified: '2026-07-09T06:25:13.1330877Z' productVariationKey: HNDA365 productOrderKey: HNDA365 isHistorical: false charges: - type: 6 code: SRVC ticketCode: JSF collection: 0 currencyCode: USD amount: 64.0 details: Charge Details orders: - bookingOrderKey: HNDA365 orderId: 142aa3c7-dac9-4a86-9fb4-c7b05987aac4 collect: 100.0 thirdPartyCharge: 0.0 thirdPartyHold: 0.0 total: 100.0 status: 1 '404': description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{recordLocator}/account: get: tags: - Bookings summary: Retrieves the booking account and collections based on the record locator. description: 'This endpoint allows agents to see all of the different payment account transactions for the booking. See related endpoint for non agents: /booking/payments/bookingCredit IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingsAccount' operationId: nsk_v1_bookings_recordLocator_account_get parameters: - name: recordLocator in: path required: true description: The record locator. 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/IJsonResponseOfAccount' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] post: tags: - Bookings summary: 'Creates the booking account based on the record locator and data in the request.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsAccountAdd' operationId: nsk_v1_bookings_recordLocator_account_post parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 requestBody: x-name: request description: The create account request. content: application/json: schema: $ref: '#/components/schemas/CreateAccountRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{recordLocator}/account/collection: post: tags: - Bookings summary: 'Creates a booking account collection and transaction based on the record locator and data in the request.' description: 'This endpoint will create a new account collection and a transaction if no collection exists or no matching collection is found. An account collection is unique based on the transaction code and the expiration date. If a matching collection is found, a transaction for that collection is generated and the account collection will be updated. See /api/nsk/v1/resources/accountTransactionCodes for a list of available account transaction codes. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingsAccountCollectionsAdd' operationId: nsk_v1_bookings_recordLocator_account_collection_post parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 requestBody: x-name: request description: The create account collection request. content: application/json: schema: $ref: '#/components/schemas/AccountCollectionRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{recordLocator}/account/collection/{accountCollectionKey}/transactions: get: tags: - Bookings summary: 'Retrieves the booking account collection transactions based on the record locator, the account collection key, and the request data.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsAccountTransactions' operationId: nsk_v1_bookings_recordLocator_account_collection_accountCollectionKey_transactions_get parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: accountCollectionKey in: path required: true description: The account collection key. schema: type: string x-position: 2 - name: StartTime in: query description: "The starting date and time of the date range to search in.\n " schema: type: - string - 'null' format: date-time x-position: 3 - name: EndTime in: query description: "The end date and time of the date range to search in.\n " schema: type: - string - 'null' format: date-time x-position: 4 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 5 - name: PageSize in: query description: "Used to specify the number of records to return.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 6 - name: PageIndex in: query description: "Represents the index of the requested paged item.\n " schema: type: - integer - 'null' format: int64 x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTransaction' examples: Retrieve Transactions Response: description: Example response for retrieving transactions. value: data: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3431398Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. 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 End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. 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 '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true security: - JWT: [] post: tags: - Bookings summary: 'Creates a booking account collection transaction based on the record locator, the account collection key, and data in the request.' description: 'This endpoint will add a transaction to an existing account collection. If there are no account collections, or the account collection key does not match an existing collection, the request will fail. To add a new credit, see /api/nsk/v1/bookings/{recordLocator}/account/collection. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingsAccountTransactionsAdd' operationId: nsk_v1_bookings_recordLocator_account_collection_accountCollectionKey_transactions_post parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: accountCollectionKey in: path required: true description: The account collection key. schema: type: string x-position: 2 requestBody: x-name: request description: The create transaction requests. content: application/json: schema: $ref: '#/components/schemas/TransactionRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/{recordLocator}/account/collection/{accountCollectionKey}/transactions: get: tags: - Bookings summary: Retrieves the booking account collection transactions based on the record locator, the account collection key, and the request data. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsAccountTransactionsv2' operationId: nsk_v2_bookings_recordLocator_account_collection_accountCollectionKey_transactions_get parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: accountCollectionKey in: path required: true description: The account collection key. schema: type: string x-position: 2 - name: StartDate in: query description: "The starting date and time of the date range to search in.\n " schema: type: - string - 'null' format: date-time x-position: 3 - name: EndDate in: query description: "The end date and time of the date range to search in.\n " schema: type: - string - 'null' format: date-time x-position: 4 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 5 - name: PageSize in: query description: "Used to specify the number of records to return.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 6 - name: LastPageKey in: query description: "The last page key where to start paged query.\n " schema: type: - string - 'null' x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedTransactionResponse' examples: Retrieve Transactions Successful: description: Example response for a successful retrieval of transactions. value: data: totalCount: 11085 lastPageKey: MTAw transactions: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3842132Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. 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 End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. 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 security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{recordLocator}/account/status: put: tags: - Bookings summary: Updates the booking account status. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsAccountStatusSet' operationId: nsk_v1_bookings_recordLocator_account_status_put parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: status in: query description: "The allowed account status. \nEnumeration values: 0 = Open, 1 = Closed, 2 = AgencyInactive, 3 = Unknown" schema: $ref: '#/components/schemas/AccountStatus' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{recordLocator}/account/transactions: get: tags: - Bookings summary: Retrieves all of the transactions for all of the collections for the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsAccountAllTransactions' operationId: nsk_v1_bookings_recordLocator_account_transactions_get parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: StartTime in: query description: "The starting date and time of the date range to search in.\n " schema: type: - string - 'null' format: date-time x-position: 2 - name: EndTime in: query description: "The end date and time of the date range to search in.\n " schema: type: - string - 'null' format: date-time x-position: 3 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 4 - name: PageSize in: query description: "Used to specify the number of records to return.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 5 - name: PageIndex in: query description: "Represents the index of the requested paged item.\n " schema: type: - integer - 'null' format: int64 x-position: 6 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTransaction' examples: Retrieve Transactions Response: description: Example response for retrieving transactions. value: data: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3463866Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. 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 End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. 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 '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/{recordLocator}/account/transactions: get: tags: - Bookings summary: Retrieves all of the transactions for the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsAccountAllTransactionsv2' operationId: nsk_v2_bookings_recordLocator_account_transactions_get parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: StartDate in: query description: "The starting date and time of the date range to search in.\n " schema: type: - string - 'null' format: date-time x-position: 2 - name: EndDate in: query description: "The end date and time of the date range to search in.\n " schema: type: - string - 'null' format: date-time x-position: 3 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 4 - name: PageSize in: query description: "Used to specify the number of records to return.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 5 - name: LastPageKey in: query description: "The last page key where to start paged query.\n " schema: type: - string - 'null' x-position: 6 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedTransactionResponse' examples: Retrieve Transactions Successful: description: Example response for a successful retrieval of transactions. value: data: totalCount: 11085 lastPageKey: MTAw transactions: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3828848Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. 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 End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. 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 security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{recordLocator}/children: get: tags: - Bookings summary: Gets children record locators of a booking not in state. description: 'A booking gets children bookings as a result of a booking divide operation. This endpoint returns a list of children booking record locators. GraphQL endpoint: childrenRecordLocators' operationId: nsk_v1_bookings_recordLocator_children_get parameters: - name: recordLocator in: path required: true description: The record locator to find children bookings for. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfString' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v3/bookings/{recordLocator}/comments: post: tags: - Bookings summary: Adds a comment to a booking not in state. description: 'Requires agent permissions. Note: To add comments and log added comments to GDS history please use POST or PUT /api/nsk/v3/booking and set SendToBookingSource to true GDS comments cannot be logged statelessly. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingsCommentsAddv3' operationId: nsk_v3_bookings_recordLocator_comments_post parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 requestBody: x-name: comments description: The comments to add. content: application/json: schema: type: array items: $ref: '#/components/schemas/BookingsCommentRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{recordLocator}/email: post: tags: - Bookings summary: Sends itinerary notification via email. description: 'This method will always send itinerary notifications via email, regardless of the chosen distributionOption on the contact. GraphQL endpoint: bookingsAddEmailNotification' operationId: nsk_v1_bookings_recordLocator_email_post parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{recordLocator}/fareOverride/journey/{journeyKey}: post: tags: - Bookings summary: Replaces an existing fare price with an amount specified. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsFareOverrideAdd' operationId: nsk_v1_bookings_recordLocator_fareOverride_journey_journeyKey_post parameters: - name: recordLocator in: path required: true description: The booking key. schema: type: string x-position: 1 - name: journeyKey in: path required: true description: The journeyKey. schema: type: string x-position: 2 requestBody: x-name: request description: The fare override request. content: application/json: schema: $ref: '#/components/schemas/FareOverrideRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{recordLocator}/fees/{passengerFeeKey}/confirm: put: tags: - Bookings summary: Confirms the passenger fee for a given booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: confirmPassengerFee' operationId: nsk_v1_bookings_recordLocator_fees_passengerFeeKey_confirm_put parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: passengerFeeKey in: path required: true description: The passenger fee key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{recordLocator}/journey: put: tags: - Bookings summary: Moves a journey on a stateless booking to a different journey. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsMoveJourney' operationId: nsk_v1_bookings_recordLocator_journey_put parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 requestBody: x-name: moveJourneyRequest description: The move journey request. content: application/json: schema: $ref: '#/components/schemas/MoveJourneyRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/{recordLocator}/journey: put: tags: - Bookings summary: Moves a journey on a stateless booking to a different journey. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsMoveJourneyv2' operationId: nsk_v2_bookings_recordLocator_journey_put parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 requestBody: x-name: moveJourneyRequest description: The move journey request. content: application/json: schema: $ref: '#/components/schemas/MoveJourneyRequestv2' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Move request missing journey keys: description: Example error for when the ToJourneyKeys list is null or empty. value: errors: - id: null code: MoveJourneyRequestv2.ToJourneyKeys:RequiredAttribute message: MoveJourneyRequestv2.ToJourneyKeys:RequiredAttribute type: Validation details: validation: RequiredAttribute model: MoveJourneyRequestv2 member: ToJourneyKeys rawMessage: The ToJourneyKeys field is required. It is empty or only contains null values. 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 Invalid record locator.: description: Example error for when the record locator is not valid. value: errors: - id: null code: nsk:Booking:InvalidRecordLocator message: nsk:Booking:InvalidRecordLocator type: Validation details: null rawMessage: The record locator RCELjpDeUF is not valid. 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 Invalid from journey key.: description: Example error for when the FromJourneyKey is not found on the booking. value: errors: - id: null code: nsk:MoveJourney:InvalidFromJourneyKey message: nsk:MoveJourney:InvalidFromJourneyKey type: Validation details: null rawMessage: The 'FromJourneyKey' 'S5FeljIfcR' was not found on the booking with record locator 'DD5DNE'. Move request cannot be processed. 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 Invalid to journey key.: description: Example error for when one of the ToJourneyKey values is not a valid journey key. value: errors: - id: null code: nsk:MoveJourney:InvalidToJourneyKey message: nsk:MoveJourney:InvalidToJourneyKey type: Validation details: null rawMessage: The 'ToJourneyKey' '8cuBtL9aZa' does not appear to be a valid journey key. Move request cannot be processed. 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 Move Journey Failed.: description: Example error for when the move request failed for unspecified reasons. Please consult the developer portal for potential reasons for this failure. value: errors: - id: null code: nsk:MoveJourney:MoveJourneyFailed message: Failed to move journey due to the NewSkies move status 'UC'. Please check that request information is correct, and consult documentation for possible error states. type: Validation details: null rawMessage: Failed to move journey due to the NewSkies move status 'UC'. Please check that request information is correct, and consult documentation for possible error states. 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 '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{recordLocator}/journey/adHocMove: put: tags: - Bookings summary: 'Combines a collection of journeys represented by the "ToJourneyKeys" into one journey and attempts to create an ad hoc connection between the journeys, and then move to the new journey.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` This endpoint does not validate that the submitted journeys are valid for ad hoc connections. It is the responsibility of the end user to ensure that the ad hoc connection is valid. Submit the journey keys in order in the "ToJourneyKeys" list, with the origin journey appearing first, and the final destination journey appearing last in the list. The segments from each valid journey will be combined in order to create the new journey. GraphQL endpoint: bookingsAdHocMoveJourney' operationId: nsk_v1_bookings_recordLocator_journey_adHocMove_put parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 requestBody: x-name: request description: The ad hoc move journey request. content: application/json: schema: $ref: '#/components/schemas/AdHocMoveJourneyRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Ad hoc move missing journey keys: description: Example error for when the ToJourneyKeys list is null or empty. value: errors: - id: null code: AdHocMoveJourneyRequest.ToJourneyKeys:RequiredAttribute message: AdHocMoveJourneyRequest.ToJourneyKeys:RequiredAttribute type: Validation details: validation: RequiredAttribute model: AdHocMoveJourneyRequest member: ToJourneyKeys rawMessage: The ToJourneyKeys field is required. It is empty or only contains null values. 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 Invalid record locator.: description: Example error for when the record locator is not valid. value: errors: - id: null code: nsk:Booking:InvalidRecordLocator message: nsk:Booking:InvalidRecordLocator type: Validation details: null rawMessage: The record locator RCELjpDeUF is not valid. 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 Invalid from journey key.: description: Example error for when the FromJourneyKey is not found on the booking. value: errors: - id: null code: nsk:MoveJourney:InvalidFromJourneyKey message: nsk:MoveJourney:InvalidFromJourneyKey type: Validation details: null rawMessage: The 'FromJourneyKey' 'S5FeljIfcR' was not found on the booking with record locator 'DD5DNE'. Move request cannot be processed. 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 Invalid to journey key.: description: Example error for when one of the ToJourneyKey values is not a valid journey key. value: errors: - id: null code: nsk:MoveJourney:InvalidToJourneyKey message: nsk:MoveJourney:InvalidToJourneyKey type: Validation details: null rawMessage: The 'ToJourneyKey' '8cuBtL9aZa' does not appear to be a valid journey key. Move request cannot be processed. 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 Move Journey Failed.: description: Example error for when the move request failed for unspecified reasons. Please consult the developer portal for potential reasons for this failure. value: errors: - id: null code: nsk:MoveJourney:MoveJourneyFailed message: Failed to move journey due to the NewSkies move status 'UC'. Please check that request information is correct, and consult documentation for possible error states. type: Validation details: null rawMessage: Failed to move journey due to the NewSkies move status 'UC'. Please check that request information is correct, and consult documentation for possible error states. 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 '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/{recordLocator}/notification: post: tags: - Bookings summary: Sends itinerary notification. description: 'Itinerary will be sent using the method set on the contact''s distributionOption field. GraphQL endpoint: bookingsAddNotificationv2' operationId: nsk_v2_bookings_recordLocator_notification_post parameters: - name: recordLocator in: path required: true description: The record locator of the booking. schema: type: string x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/dcs/v1/bookings/{recordLocator}/passengers/{passengerKey}/documents/check: get: tags: - Bookings summary: Gets the document check status for a specific passenger if there are any on a specific booking. description: 'Requires a committed booking in state. Requires document check to be enabled in government security configuration. Performs document check and returns the results as documentCheckStatus. More detailed information is intentionally not provided for security reasons. The designers of the client application will need to determine what to do with the different responses, in most cases the passenger will need to be assisted by an airport agent. For more specific requirements check the following endpoint GET/api/nsk/v1/booking/checkin/journey/{journeyKey}/requirements. For configuration options please contact your CSDM. For full documentation see https://developer.navitaire.com/documentation/dotrez-api/how-to/adc. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: documentCheck' operationId: dcs_v1_bookings_recordLocator_passengers_passengerKey_documents_check_get parameters: - name: recordLocator in: path required: true description: The record locator of the associated booking. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerDocumentCheckResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/dcs/v1/bookings/{recordLocator}/passengers/{passengerKey}/infant/documents/check: get: tags: - Bookings summary: Gets the document check status for a specific passenger's infant if there are any on a specific booking. description: 'Requires a committed booking in state. Requires document check to be enabled in government security configuration. Performs document check and returns the results as documentCheckStatus. More detailed information is intentionally not provided for security reasons. The designers of the client application will need to determine what to do with the different responses, in most cases the passenger will need to be assisted by an airport agent. For more specific requirements check the following endpoint GET/api/nsk/v1/booking/checkin/journey/{journeyKey}/requirements. For configuration options please contact your CSDM. For full documentation see https://developer.navitaire.com/documentation/dotrez-api/how-to/adc. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: infantDocumentCheck' operationId: dcs_v1_bookings_recordLocator_passengers_passengerKey_infant_documents_check_get parameters: - name: recordLocator in: path required: true description: The record locator of the associated booking. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerDocumentCheckResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{recordLocator}/passengers/{passengerKey}/seats/{unitKey}: post: tags: - Bookings summary: 'Agent only. Adds a seat assignment to a specific passenger on a booking.' description: 'Agent only. This endpoint actively checks whether the passenger has a seat. If the passenger does have a seat, it will delete the current seat the passenger occupies and add the requested one. This may result in slightly slower response times. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoints: bookingsSeatAdd, bookingsSeatsAdd' operationId: nsk_v1_bookings_recordLocator_passengers_passengerKey_seats_unitKey_post parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 - name: unitKey in: path required: true description: The unit key. schema: type: string x-position: 3 requestBody: x-name: request description: The add seat request. content: application/json: schema: $ref: '#/components/schemas/AddUnitStatelessConfig' required: true x-position: 4 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] delete: tags: - Bookings summary: 'Agent only. Deletes a seat assignment from a specific passenger on a booking.' description: 'Agent only. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoints: bookingsSeatDelete, bookingsSeatsDelete' operationId: nsk_v1_bookings_recordLocator_passengers_passengerKey_seats_unitKey_delete parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 - name: unitKey in: path required: true description: The unique unit key. schema: type: string x-position: 3 requestBody: x-name: request description: The delete seat request. content: application/json: schema: $ref: '#/components/schemas/DeleteUnitStatelessConfig' required: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/{recordLocator}/queues/{queueCode}: post: tags: - Bookings summary: Retrieves the details for the booking queues of a specific booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsQueues' operationId: nsk_v1_bookings_recordLocator_queues_queueCode_post parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: queueCode in: path required: true description: The queue code. schema: type: string x-position: 2 requestBody: x-name: request description: The booking queue request. content: application/json: schema: $ref: '#/components/schemas/BookingQueuesRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingQueue' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/byBookingId/{bookingId}: get: tags: - Bookings summary: Retrieves a booking itinerary stateless. description: 'This endpoint requires a session token and is agent-only. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. If no booking associated with the record locator is found, an HTTP 404 `NotFound` will be returned. GraphQL endpoint: bookingsByBookingId' operationId: nsk_v1_bookings_byBookingId_bookingId_get parameters: - name: bookingId in: path required: true description: The New Skies Booking ID. schema: type: integer format: int64 x-position: 1 responses: '200': description: OK. The request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Retrieve booking: description: Successful retrieval of a booking value: data: selfServiceMoveAvailable: false bookingKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- recordLocator: PC6Z4H currencyCode: USD systemCode: SYS groupName: GRP locators: numericRecordLocator: '310530162615' parentRecordLocator: PB5L2S parentId: 0 recordLocators: - recordLocatorKey: NjA4NjQyMjchTlY- recordCode: '60864227' systemDomainCode: MVS owningSystemCode: NV bookingSystemCode: NV interactionPurpose: ML hostedCarrierCode: MK info: status: 2 paidStatus: 1 priceStatus: 2 profileStatus: 1 bookingType: Default channelType: 1 bookedDate: '2026-07-09T05:55:13.1355693Z' createdDate: '2026-07-09T05:55:13.1355695Z' expirationDate: '2026-07-12T05:55:13.1355696Z' modifiedDate: '2026-07-09T05:58:13.1355703Z' modifiedAgentId: 1 createdAgentId: 1 owningCarrierCode: NV changeAllowed: true createdUserKey: MQ-- modifiedUserKey: MQ-- sales: created: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW source: isoCountryCode: LA sourceSystemCode: LA agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW modified: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW typeOfSale: residentCountry: US promotionCode: PROMO fareTypes: - FareType hold: expiration: '2026-07-12T05:55:13.1355724Z' breakdown: balanceDue: 0.0 pointsBalanceDue: 0.0 authorizedBalanceDue: 0.0 totalAmount: 66.44 totalPoints: 0.0 totalToCollect: 66.44 totalPointsToCollect: 0.0 totalCharged: 66.44 passengerTotals: services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF totalCost: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 0.3 code: INFT detail: Infant Fee type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 0.3 ticketCode: INF totalCost: null journeyTotals: totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 journeys: tlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 addOnTotals: car: 1.0 hotel: 0.0 activities: 0.0 receivedBy: receivedBy: Doe, John latestReceivedBy: Doe, John receivedReference: DOE latestReceivedReference: DOE referralCode: REFERRAL contacts: p: contactTypeCode: P phoneNumbers: - type: 1 number: '98123124123' cultureCode: USD address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com customerNumber: '2050001326' sourceOrganization: WWW distributionOption: 0 notificationPreference: 0 companyName: Company Name name: first: John middle: Cee last: Doe title: MR suffix: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: MTk2MjE1 customerNumber: '2050001326' fees: - type: 9 ssrCode: SSR ssrNumber: 365 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: JSF detail: Fee Details passengerFeeKey: MCEwITk- override: false flightReference: 20250131 NV5670 SLCBOS note: Fee Notes createdDate: '2026-07-09T05:55:13.1355898Z' isProtected: false serviceCharges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF name: first: John middle: Cee last: Doe title: MR suffix: null passengerTypeCode: ADT discountCode: ADT bags: - identifier: '5670' baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- nonStandard: false type: Backpack osTag: NV3665 osTagDate: '2026-07-09T05:55:13.1355912Z' taggedToStation: BOS stationCode: SLC weight: 5 taggedToCarrierCode: JanSport Backpack weightType: 2 program: code: ADT levelCode: LVL number: '365' infant: fees: [] nationality: US dateOfBirth: '2025-07-09T05:55:13.1355937+00:00' travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: JR nationality: US expirationDate: '2036-07-09T05:55:13.1355925Z' number: P31322423218 issuedDate: '2025-07-09T05:55:13.135593Z' gender: 1 dateOfBirth: '2025-07-09T05:55:13.1355932Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City residentCountry: US gender: 1 name: first: John middle: Cee last: Doe title: MR suffix: JR type: INFT declaredGender: null info: nationality: US residentCountry: US gender: 1 dateOfBirth: '2002-07-09T05:55:13.1355977Z' familyNumber: 1 declaredGender: null travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: null nationality: US expirationDate: '2036-07-09T05:55:13.1355947Z' number: P31322423218 issuedDate: '2016-07-09T05:55:13.1355948Z' gender: 1 dateOfBirth: '2002-07-09T05:55:13.1355949Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City addresses: - status: 0 companyName: Company Name lineOne: Line One passengerAddressKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- phone: 801-555-1212 lineTwo: Line Two stationCode: SLC lineThree: Line Three emailAddress: johndoe@gmail.com countryCode: US cultureCode: US provinceState: UT refusedContact: false city: Salt Lake City postalCode: '84101' weightCategory: 1 emdCoupons: - status: 0 passengerEmdCouponKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- emdTypeCode: 0 emdNumber: '1234567890123' couponNumber: 1 optionalServiceInformation: carrierCode: NV reasonForIssuanceSubCode: RFISC salesDate: '2026-07-09T05:55:13.135596Z' flightReference: 20250131 NV5670 SLCBOS receivedFromSystemCode: GDS numberOfServices: 1 feeType: 9 feeKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- ssrCode: SSR ssrNumber: 365 journeys: - flightType: 1 stops: 0 designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.1356122Z' departure: '2026-07-09T05:55:13.1356122Z' move: maxMoveBackDays: 365 maxMoveOutDays: 365 segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.1356122Z' departure: '2026-07-09T05:55:13.1356122Z' isSeatmapViewable: true fares: - isGoverning: true carrierCode: NV fareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjB_flg- classOfService: E classType: Class Type fareApplicationType: 0 fareClassOfService: E fareBasisCode: ERPTSFRE fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: E ruleNumber: RPTS productClass: C2 ruleTariff: RPTS travelClassCode: C pricingDate: '2026-07-09T05:55:13.1355997Z' crossReferenceClassOfService: E fareDesignator: fareTypeCodes: - A - AP - B - C passengerFares: - serviceCharges: - amount: 2.44 code: USTAX detail: SLC-BOS type: 5 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 2.44 ticketCode: US discountCode: ADT fareDiscountCode: 20DDISC ticketFareBasis: null passengerType: ADT fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '5670' carrierCode: NV opSuffix: N passengerSegment: mcfbrfQ-: seats: - compartmentDesignator: C penalty: 0 unitDesignator: 7G seatInformation: deck: 1 seatSet: 1 propertyList: aisle: 'TRUE' bulkhead: 'TRUE' tcc: C arrivalStation: BOS departureStation: SLC passengerKey: MCFBRFQ- unitKey: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9TITdHIUM- crossReferenceSeatingPreference: A isPending: false seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T passengerKey: MCFBRFQ- activityDate: '2026-07-09T05:55:13.1356005Z' boardingSequence: '0' createdDate: '2026-07-09T05:55:13.1356006Z' liftStatus: 0 modifiedDate: '2026-07-09T06:05:13.1356007Z' overBookIndicator: 0 priorityDate: '2026-07-09T05:55:13.1356009Z' timeChanged: false verifiedTravelDocs: null sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW ssrs: - isConfirmed: false isConfirmingUnheld: false note: Note ssrDuration: 2 ssrKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- count: 1 ssrCode: SSR feeCode: JSF inBundle: true passengerKey: MCFBRFQ- ssrDetail: Detail ssrNumber: 365 market: identifier: identifier: '5670' carrierCode: NV opSuffix: N destination: BOS origin: SLC departureDate: '2026-07-09T05:55:13.1356038Z' tickets: - ticketNumber: '1234567890123' infantTicketNumber: '1234567890124' ticketIndicator: 1 ticketStatus: 1 passengerKey: MCFBRFQ- bags: - baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- passengerKey: MCFBRFQ- arrivalStation: BOS status: 0 departureStation: SLC osTag: NV3665 scores: - guestValueCode: GVC score: 100 passengerKey: MCFBRFQ- boardingPassDetail: gateInformation: Gate Information priorityInformation: Priority Information cabinClass: Cabin Class compartmentLevel: Compartment level boardingZone: Boarding Zone seatAssignment: Seat Assignment sequenceNumber: Sequence Number hasInfant: true seatPreferences: seat: 2 travelClass: 2 advancedPreferences: - seatMapCode: AISLE value: 'TRUE' status: 1 bundleCode: CC02 verifiedTravelDocuments: - MTU4NjExIVBDNlo0SCFmYWxzZQ-- referenceNumber: 35642 baggageGroupNumber: 2 baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 1 cabinOfService: C externalIdentifier: identifier: '5660' carrierCode: MK opSuffix: M priorityCode: R changeReasonCode: 0 segmentType: 0 salesDate: '2026-07-09T05:55:13.1356068Z' international: false flightReference: 20250131 NV5670 SLCBOS legs: - legKey: NjM4NzM5NDE0MDAwMDAwMDAwIU5WITU2NzAhICFTTEMhQk9TITI0MDYxMDQ- operationsInfo: arrivalGate: estimatedGate: First Gate actualGate: Second Gate estimatedArrivalTime: '2026-07-09T08:55:13.1356079Z' departureGate: estimatedGate: First Gate actualGate: Second Gate actualOffBlockTime: '2026-07-10T05:55:13.1356087Z' actualOnBlockTime: '2026-07-10T05:55:13.1356088Z' actualTouchDownTime: '2026-07-11T05:55:13.135609Z' airborneTime: '2026-07-10T08:55:13.1356091Z' arrivalNote: Arrival Note arrivalStatus: 0 baggageClaim: Baggage Claim departureNote: Departure Note departureStatus: 0 departureTimes: scheduled: '2026-07-09T05:55:13.1356095Z' estimated: '2026-07-09T05:45:13.1356096Z' standardArrivalTime: '2026-07-10T05:55:13.1356098Z' tailNumber: 9V-SKA designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.1356122Z' departure: '2026-07-09T05:55:13.1356122Z' legInfo: departureTimeUtc: '2026-07-09T12:55:13Z' arrivalTimeUtc: '2026-07-10T10:55:13Z' adjustedCapacity: 168 arrivalTerminal: Concourse A arrivalTimeVariant: -300 backMoveDays: 365 capacity: 171 changeOfDirection: false codeShareIndicator: 0 departureTerminal: Concourse B departureTimeVariant: -420 equipmentType: '767' equipmentTypeSuffix: '200' eTicket: false irop: false lid: 168 marketingCode: DJM_3R marketingOverride: false operatedByText: Operated By NV operatingCarrier: NV operatingFlightNumber: '5670' operatingOpSuffix: N outMoveDays: 365 arrivalTime: '2026-07-10T05:55:13.1356108Z' departureTime: '2026-07-09T05:55:13.1356109Z' prbcCode: B767EMDJ scheduleServiceType: S sold: 6 status: 0 subjectToGovtApproval: false nests: - adjustedCapacity: 168 classNest: 8 lid: 168 travelClassCode: C nestType: 0 legClasses: - classNest: 8 classAllotted: 0 classType: C classAuthorizedUnits: 0 classOfService: C classRank: 0 classSold: 0 cnxSold: 0 latestAdvancedReservation: 0 status: 0 thruSold: 0 ssrs: - available: 88 ssrNestCode: 1BAG lid: 168 sold: 100 unitSold: 80 seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T flightReference: 20250131 NV5670 SLCBOS status: 6 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: - type: 0 text: Comment createdDate: '2026-07-09T05:55:13.1356135Z' pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW commentKey: MASDFASDXCFQ- queues: - code: AQCD subCode: AQBD name: Automation Queue Smoke queueId: 121940 passengerId: 196215 watchListId: 23 note: Booking with balance due of 67.44 type: 15 action: 0 mode: 0 flightReference: 20250131 NV5670 SLCBOS bookingQueueKey: MTIxOTQwIUFRQ0Qh passengerAlternateKey: MTk2MjE1 watchListKey: MjM- history: - historyCategory: 31 details: Assigned Seat event: 4 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW receivedBy: Doe, John receivedByReference: '315231' createdDate: '2026-07-09T05:55:13.1356162Z' payments: - paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx code: VI approvalDate: '2026-07-09T05:55:13.1356168Z' details: accountNumberId: 0 parentPaymentId: 0 accountName: John Doe accountNumber: '5110920006810092' expirationDate: '2030-07-09T05:55:13.1356173Z' text: Payment installments: 0 binRange: 511092 fields: payment Field: Payment Field Value amounts: amount: 67.44 currencyCode: USD collected: 67.44 collectedCurrencyCode: USD quoted: 67.44 quotedCurrencyCode: USD authorizationCode: AUTH authorizationStatus: 4 fundedDate: '2026-07-09T05:55:13.1356183Z' transactionCode: TRANSACTION dcc: rateId: 7cec6a8c-2579-4029-ae4d-b8115ebb856b currencyCode: USD rateValue: 1.0 amount: 67.44 putInState: STATE status: 2 applicable: true threeDSecure: browserUserAgent: TAW3 browserAccept: SYS remoteIpAddress: 192.168.1.1 termUrl: www.bank.com paReq: Payload acsUrl: www.bank.com paRes: Response authResult: Approved cavv: UmFuZG9tIENBVlY= cavvAlgorithm: Encryption eci: '05' xid: SDF235 applicable: true successful: true threeDSecureSessionId: VGhpcyBpcyBhIHJhbmRvbSB0aHJlZSBEIHNlY3VyZSBzZXNzaW9uIElELg== challengePreference: 0 challengeWindowSize: 0 transactionIdThreeDSecure: 6f068cbd-40cc-97d2-e8bc-139591794461 threeDSecureVersion: 1.0.2 merchantData: MerchantData redirectJwt: VGhpcyBpcyBhIHJhbmRvbSByZWRpcmVjdCBKV1QgdG9rZW4gc3RyaW5nLg== redirectJwtUrl: www.bank.com dsTransactionId: SDF235 authenticationStatus: 1 attachments: - id: 365291 paymentId: 3652391231 attachment: AQIDBAU= createdDate: '2026-07-09T05:55:13.135627Z' modifiedDate: '2026-07-09T06:00:13.1356271Z' type: 0 status: 3 transferred: false channelType: 1 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW deposit: false accountId: 0 voucher: id: 0 transactionId: 0 overrideRestrictions: false overrideAmount: false recordLocator: PC6Z4H addedToState: true createdAgentId: 1 modifiedAgentId: 1 reference: 150509 passengerVoucher: passengerVoucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx passengerKey: MCFBRFQ- voucherConfigurationCode: HNDACAR voucherUses: - 13 customerPrograms: - programCode: HNDA programNumber: '3215135' customerNumber: '2050001326' addOns: honda Civic: paymentRequired: false status: 0 addOnKey: null type: 4 summary: total: 100.0 held: 0.0 charged: 100.0 supplierCode: HONDA beginDate: '2026-07-09T05:55:13.1356305Z' beginLocation: SLC endDate: '2026-07-16T05:55:13.1356306Z' endLocation: BOS externalReference: HONDA-123 description: Car Rental externalConfirmationNumber: HDA365 reference: Component Reference created: agentReference: MTIxNTg- agentCode: Agent date: '2026-07-09T05:55:13.1356314Z' organizationCode: WWW domainCode: TAW3 locationCode: TAW3 source: agentCode: Agent organizationCode: WWW domainCode: TAW3 locationCode: TAW3 declinedText: Declined Component Text cultureCode: US modifiedDate: '2026-07-09T06:55:13.1356318Z' modifiedAgentReference: Agent Reference order: address: coordinates: latitude: '40.7608' longitude: ' -111.951814' lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' orderKey: HNDA365 phoneNumbers: - type: 1 number: '98123124123' active: false locations: - description: Salt Lake City Location code: SLC utcOffset: 365.0 usageDate: '0001-01-01T00:00:00' criteria: catalogCode: A countryCode: US supplierCode: JPN departmentCode: CARS vendorCode: HNDA companyCode: HNDA ratingCode: '10' discountCode: CVCDSC promotionCode: HNDASALE currencyCode: USD categoryCode: CAR customer: customerKey: MCFBRFQ- name: first: John middle: Cee last: Doe title: MR suffix: null customerNumber: '2050001326' address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' dateOfBirth: '2002-07-09T05:55:13.1356352Z' emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 thumbnailFileName: File Name participants: john Doe: participantKey: MCFBRFQ- description: New Participant name: first: John middle: Cee last: Doe title: MR suffix: null participantTypeCode: ADT address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' isPrimary: true dateOfBirth: '2002-07-09T05:55:13.1356364Z' document: number: '1' issuedByCode: PRTICPANT documentTypeCode: CHECK emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 quantity: 10 history: - code: Y previousCode: N note: Note created: '2026-07-09T05:55:13.1356368Z' hasError: false usageDate: '0001-01-01T00:00:00' payment: paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx type: VI currencyCode: USD name: first: John middle: Cee last: Doe title: MR suffix: null number: '5110920006810092' expiration: '2030-07-09T05:55:13.1356373Z' cvv: '365' amount: 100.0 description: Payment Description issueNumber: '3656912' address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com phoneNumbers: - type: 1 number: '98123124123' externalLocator: JPN parameters: - value: '10' code: HNDA description: Parameter Description description: Order Description descriptionFormatType: Description Format Type productDescription: Product Description productVariationDescription: Product Variation Description paymentAction: 1 amounts: display: value: 25.0 total: 50.0 initial: value: 25.0 total: 50.0 markup: value: 25.0 total: 50.0 listed: value: 25.0 total: 50.0 listedDiscount: value: 25.0 total: 50.0 discount: value: 25.0 total: 50.0 handling: value: 25.0 total: 50.0 handlingDiscount: value: 25.0 total: 50.0 dueNow: preTax: 25.0 tax: 10.0 total: 35.0 dueLater: preTax: 25.0 tax: 10.0 total: 35.0 personalizations: 10.0 taxable: 35.0 services: 50.0 fees: 100.0 total: 115.0 taxRate: 2 taxExempt: true taxAtUnitPrice: true terms: - code: APPROVED description: Description terms: Terms cancellationTerms: - code: CANCELLED description: Description terms: Terms details: - code: HNDA styleCode: H description: Description fees: - code: HND feeCategoryCode: VI description: Fee Description amount: value: 25.0 total: 50.0 foreignAmount: value: 25.0 total: 50.0 type: 0 isWaiveable: false foreignCurrencyCode: USD currencyCode: USD isChargeable: false notes: - text: Order Text description: Order Description created: '2026-07-09T05:55:13.1356413Z' modified: '2026-07-09T06:25:13.1356414Z' productVariationKey: HNDA365 productOrderKey: HNDA365 isHistorical: false charges: - type: 6 code: SRVC ticketCode: JSF collection: 0 currencyCode: USD amount: 64.0 details: Charge Details orders: - bookingOrderKey: HNDA365 orderId: ea6529e5-96b9-4b70-b1eb-05cf1955b640 collect: 100.0 thirdPartyCharge: 0.0 thirdPartyHold: 0.0 total: 100.0 status: 1 '404': description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/checkin/{recordLocator}/journey/{journeyKey}: delete: tags: - Bookings summary: Removes the checkin status of passengers for a specific journey stateless. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInByJourneyDelete' operationId: nsk_v1_bookings_checkin_recordLocator_journey_journeyKey_delete parameters: - name: recordLocator in: path required: true description: The booking record locator to look up the journey. schema: type: string x-position: 1 - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 2 requestBody: x-name: request description: The checkin passengers request. content: application/json: schema: $ref: '#/components/schemas/CheckinPassengersRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v3/bookings/checkin/{recordLocator}/journey/{journeyKey}: post: tags: - Bookings summary: Checks in a collection of passengers to a specific journey stateless. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` - When debug mode is disabled, warning and error messages will be masked if the `SystemOptions.HideErrorMessages` is set to true. - When debug mode is disabled, warning and error messages will be returned to agents only if the `SystemOptions.HideErrorMessages` is set to false. GraphQL endpoint: checkInByJourneyv3' operationId: nsk_v3_bookings_checkin_recordLocator_journey_journeyKey_post parameters: - name: recordLocator in: path required: true description: The booking record locator to look up the journey. schema: type: string x-position: 1 - name: journeyKey in: path required: true description: The journey key of the journey to check into. schema: type: string x-position: 2 requestBody: x-name: request description: The checkin passengers request. content: application/json: schema: $ref: '#/components/schemas/CheckinPassengersRequestv3' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Check-in Successful: description: Example when check-in is successful. value: data: null Checkin Valid with displaying warning message to agents.: description: Example message when check in requirements are met, but there are still travel documents required. This requires Digital API configuration to be set such that warning messages can be returned to agents only when debug is turned off. value: messages: - code: CheckinPassengerWarning type: Warning value: 'AUT TEST Authorization Response Free Text 8501:AU:OK TO BOARD Documents are required for this flight.' status: 0 details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_ data: null Checkin Valid with a masked warning message.: description: Example message when check in requirements are met, but there are still travel documents required. This is what non-agents will see regardless of Digital API configuration for displaying warning messages when debug is off.This is also what an agent would see if the corresponding API configuration is not set to allow warning messages to be shown. value: messages: - code: CheckinPassengerWarning type: Warning value: CheckinPassengerWarning status: 0 details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_ data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Checkin Invalid: description: Example error when check in requirements are not met. The /requirements endpoint should be called before attempting a checkin. value: errors: - id: null code: nsk:Checkin:Invalid message: nsk:Checkin:Invalid type: Validation details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: Checkin request is invalid. Please refer to checkin requirements for more details. 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 Seat Missing: description: In this example the optional request parameter `seatsRequired` was set to true. One passenger had a seat assigned and one did not. value: errors: - id: null code: nsk:Checkin:TypeID:1223 message: nsk:Checkin:TypeID:1223 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: Baggins/Bilbo missing seat assignments on flight number 2452. 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 Inhibited: description: In this example the passenger meets all the requirements but is inhibited due to government security. value: errors: - id: null code: nsk:Checkin:TypeID:3096 message: nsk:Checkin:TypeID:3096 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n' 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. - id: null code: nsk:Checkin:TypeID:3088 message: nsk:Checkin:TypeID:3088 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n' 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 Missing verified document with agent visible error message: description: This example shows both the expected response when a passenger is missing verified documents, as well as what a logged-in agent would see if the API configuration is set correctly. This is an example response when debug mode is turned off. value: errors: - id: null code: nsk:Checkin:TypeID:1236 message: Baggins/Bilbo missing verified documents. type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: null 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 '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/checkin/{recordLocator}/journey/{journeyKey}/requirements: get: tags: - Bookings summary: Gets the checkin pre-validation requirements for a specific journey. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInRequirementsByJourney' operationId: nsk_v1_bookings_checkin_recordLocator_journey_journeyKey_requirements_get parameters: - name: recordLocator in: path required: true description: The record locator of the booking. schema: type: string x-position: 1 - name: journeyKey in: path required: true description: The journey key to be pre validate checkin with. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinRequirements' examples: Not Paid In Full: description: Example partial response showing that the payment is due before check in value: data: isValid: false passengers: null governmentProgramRequirements: null restrictions: - 4 Closed: description: Example partial response showing that the check in is closed which is common if its outside of the configured check in window. value: data: isValid: false passengers: null governmentProgramRequirements: null restrictions: - 0 '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/checkin/{recordLocator}/journey/{journeyKey}/requirements: get: tags: - Bookings summary: Gets the checkin pre-validation requirements for a specific journey version 2. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInRequirementsByJourneyv2' operationId: nsk_v2_bookings_checkin_recordLocator_journey_journeyKey_requirements_get parameters: - name: recordLocator in: path required: true description: The record locator of the booking. schema: type: string x-position: 1 - name: journeyKey in: path required: true description: The journey key to be pre validate checkin with. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinRequirementsv2' examples: Valid Response No Restrictions: description: Example Response value: data: passengers: passengerKey: passengerKey: PassengerKey documentRequirements: documentsOnFile: - P - V governmentDocumentInstances: - governmentInstance: USDHS numberOfMissingDocuments: 0 eligibleDocuments: - group: 18 documentTypeCode: I - group: 5 documentTypeCode: M verifiableDocuments: - group: 6 documentTypeCode: P - group: 9 documentTypeCode: V documentVerificationRequired: true - governmentInstance: CBSA numberOfMissingDocuments: 0 eligibleDocuments: - group: 18 documentTypeCode: I verifiableDocuments: - group: 6 documentTypeCode: P - group: 9 documentTypeCode: V documentVerificationRequired: true isValid: true addressRequirements: isValid: false addressesOnFile: - Address1 unhandledAddresses: - Address2 invalidSsrs: null requiredSsrs: null restrictions: null isValid: true governmentProgramRequirements: usdhs: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: USDHS messageType: null minVerifiedDocumentCount: 1 cbsa: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: CBSA messageType: null minVerifiedDocumentCount: 1 restrictions: null isValid: true Response with Restrictions: description: Example Response value: data: passengers: passengerKey: passengerKey: PassengerKey documentRequirements: null addressRequirements: null invalidSsrs: null requiredSsrs: null restrictions: - restriction: 12 description: Missing Documents - restriction: 1 description: Missing Destination Address isValid: false governmentProgramRequirements: usdhs: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: USDHS messageType: null minVerifiedDocumentCount: 1 restrictions: - 4 isValid: false '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/checkin/{recordLocator}/journey/{journeyKey}/status: get: tags: - Bookings summary: Gets the passengers lift status stateless for a specific journey based on the record locator. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInStatusByJourney' operationId: nsk_v1_bookings_checkin_recordLocator_journey_journeyKey_status_get parameters: - name: recordLocator in: path required: true description: The record locator in reference to the journey. schema: type: string x-position: 1 - name: journeyKey in: path required: true description: The journey key in reference. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIListOfCheckinPassengerLiftStatus' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/checkin/{recordLocator}/segment/{segmentKey}: delete: tags: - Bookings summary: Removes the checkin status of passengers for a specific journey's segment stateless. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInBySegmentDelete' operationId: nsk_v1_bookings_checkin_recordLocator_segment_segmentKey_delete parameters: - name: recordLocator in: path required: true description: The booking record locator to look up the journeys segment. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 2 requestBody: x-name: request description: The checkin passengers request. content: application/json: schema: $ref: '#/components/schemas/CheckinPassengersRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v3/bookings/checkin/{recordLocator}/segment/{segmentKey}: post: tags: - Bookings summary: Checks in a collection of passengers to a specific journeys segment stateless. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` - When debug mode is disabled, warning and error messages will be masked if the `SystemOptions.HideErrorMessages` is set to true. - When debug mode is disabled, warning and error messages will be returned to agents only if the `SystemOptions.HideErrorMessages` is set to false. GraphQL endpoint: checkInBySegmentv3' operationId: nsk_v3_bookings_checkin_recordLocator_segment_segmentKey_post parameters: - name: recordLocator in: path required: true description: The booking record locator to look up the journeys segment. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment key of the segment to check into. schema: type: string x-position: 2 requestBody: x-name: request description: The checkin passengers request. content: application/json: schema: $ref: '#/components/schemas/CheckinPassengersRequestv3' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Check-in Successful: description: Example when check-in is successful. value: data: null Checkin Valid with displaying warning message to agents.: description: Example message when check in requirements are met, but there are still travel documents required. This requires Digital API configuration to be set such that warning messages can be returned to agents only when debug is turned off. value: messages: - code: CheckinPassengerWarning type: Warning value: 'AUT TEST Authorization Response Free Text 8501:AU:OK TO BOARD Documents are required for this flight.' status: 0 details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_ data: null Checkin Valid with a masked warning message.: description: Example message when check in requirements are met, but there are still travel documents required. This is what non-agents will see regardless of Digital API configuration for displaying warning messages when debug is off.This is also what an agent would see if the corresponding API configuration is not set to allow warning messages to be shown. value: messages: - code: CheckinPassengerWarning type: Warning value: CheckinPassengerWarning status: 0 details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_ data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Checkin Invalid: description: Example error when check in requirements are not met. The /requirements endpoint should be called before attempting a checkin. value: errors: - id: null code: nsk:Checkin:Invalid message: nsk:Checkin:Invalid type: Validation details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: Checkin request is invalid. Please refer to checkin requirements for more details. 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 Seat Missing: description: In this example the optional request parameter `seatsRequired` was set to true. One passenger had a seat assigned and one did not. value: errors: - id: null code: nsk:Checkin:TypeID:1223 message: nsk:Checkin:TypeID:1223 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: Baggins/Bilbo missing seat assignments on flight number 2452. 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 Inhibited: description: In this example the passenger meets all the requirements but is inhibited due to government security. value: errors: - id: null code: nsk:Checkin:TypeID:3096 message: nsk:Checkin:TypeID:3096 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n' 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. - id: null code: nsk:Checkin:TypeID:3088 message: nsk:Checkin:TypeID:3088 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n' 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 Missing verified document with agent visible error message: description: This example shows both the expected response when a passenger is missing verified documents, as well as what a logged-in agent would see if the API configuration is set correctly. This is an example response when debug mode is turned off. value: errors: - id: null code: nsk:Checkin:TypeID:1236 message: Baggins/Bilbo missing verified documents. type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: null 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 '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/checkin/{recordLocator}/segment/{segmentKey}/requirements: get: tags: - Bookings summary: Gets the checkin pre-validation requirements for a specific bookings journeys segment. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInRequirementsBySegment' operationId: nsk_v1_bookings_checkin_recordLocator_segment_segmentKey_requirements_get parameters: - name: recordLocator in: path required: true description: The record locator of the booking. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment key to pre validate checkin with. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinRequirements' examples: Not Paid In Full: description: Example partial response showing that the payment is due before check in value: data: isValid: false passengers: null governmentProgramRequirements: null restrictions: - 4 Closed: description: Example partial response showing that the check in is closed which is common if its outside of the configured check in window. value: data: isValid: false passengers: null governmentProgramRequirements: null restrictions: - 0 '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/checkin/{recordLocator}/segment/{segmentKey}/requirements: get: tags: - Bookings summary: Gets the checkin pre-validation requirements for a specific bookings journeys segment version 2. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInRequirementsBySegmentv2' operationId: nsk_v2_bookings_checkin_recordLocator_segment_segmentKey_requirements_get parameters: - name: recordLocator in: path required: true description: The record locator of the booking. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment key to pre validate checkin with. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinRequirementsv2' examples: Valid Response No Restrictions: description: Example Response value: data: passengers: passengerKey: passengerKey: PassengerKey documentRequirements: documentsOnFile: - P - V governmentDocumentInstances: - governmentInstance: USDHS numberOfMissingDocuments: 0 eligibleDocuments: - group: 18 documentTypeCode: I - group: 5 documentTypeCode: M verifiableDocuments: - group: 6 documentTypeCode: P - group: 9 documentTypeCode: V documentVerificationRequired: true - governmentInstance: CBSA numberOfMissingDocuments: 0 eligibleDocuments: - group: 18 documentTypeCode: I verifiableDocuments: - group: 6 documentTypeCode: P - group: 9 documentTypeCode: V documentVerificationRequired: true isValid: true addressRequirements: isValid: false addressesOnFile: - Address1 unhandledAddresses: - Address2 invalidSsrs: null requiredSsrs: null restrictions: null isValid: true governmentProgramRequirements: usdhs: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: USDHS messageType: null minVerifiedDocumentCount: 1 cbsa: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: CBSA messageType: null minVerifiedDocumentCount: 1 restrictions: null isValid: true Response with Restrictions: description: Example Response value: data: passengers: passengerKey: passengerKey: PassengerKey documentRequirements: null addressRequirements: null invalidSsrs: null requiredSsrs: null restrictions: - restriction: 12 description: Missing Documents - restriction: 1 description: Missing Destination Address isValid: false governmentProgramRequirements: usdhs: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: USDHS messageType: null minVerifiedDocumentCount: 1 restrictions: - 4 isValid: false '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/checkin/{recordLocator}/segment/{segmentKey}/status: get: tags: - Bookings summary: Gets the passengers lift status stateless for a specific segment based on the record locator. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInStatusBySegment' operationId: nsk_v1_bookings_checkin_recordLocator_segment_segmentKey_status_get parameters: - name: recordLocator in: path required: true description: The record locator in reference to the journey. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment key in reference. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIListOfCheckinPassengerLiftStatus' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/queues: post: tags: - Bookings summary: Queues the bookings by inventory leg. description: 'GraphQL endpoint: bookingQueuesByInventoryLeg' operationId: nsk_v1_bookings_queues_post requestBody: x-name: request description: The queue booking by inventory leg request content: application/json: schema: $ref: '#/components/schemas/QueueBookingByInventoryLegRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Queued bookings successfully: description: Example when all the bookings are queued successfully. value: data: null Queued with skipped bookings: description: Example when there are bookings skipped during inventory queueing due to unhandled exceptions. value: messages: - code: nsk:BookingQueues:BookingsNotQueued type: Warning value: There are bookings that were not queued. status: 1 details: skippedBookings: ZB3LMA,Y141SB,O232XL data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Leg Key is null or empty: description: Example when the Leg Key is null or empty. value: errors: - id: bef37773-8bc1-0d5e-b407-287277dfee16 code: QueueBookingByInventoryLegRequest.LegKey:RequiredAttribute message: QueueBookingByInventoryLegRequest.LegKey:RequiredAttribute type: Validation details: validation: RequiredAttribute model: QueueBookingByInventoryLegRequest member: LegKey rawMessage: The QueueBookingByInventoryLegRequest field is required. 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 Booking Queue Codes is null or empty: description: Example when the Booking Queue Codes is null or empty. value: errors: - id: b5b77041-86b5-d75b-5685-03d7d09c7591 code: QueueBookingByInventoryLegRequest.BookingQueueCodes:RequiredAttribute message: QueueBookingByInventoryLegRequest.BookingQueueCodes:RequiredAttribute type: Validation details: validation: RequiredAttribute model: QueueBookingByInventoryLegRequest member: BookingQueueCodes rawMessage: The BookingQueueCodes field is required. It is empty or only contains null values. 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 At least 1 null or empty booking queue code: description: Example if at least one of the Booking Queue Codes is null or empty. value: errors: - id: ff8a93b6-79d0-051e-67eb-1e69fbde1aa9 code: nsk:BookingQueues:BookingQueueCodesNullOrEmpty message: nsk:BookingQueues:BookingQueueCodesNullOrEmpty type: Validation details: null rawMessage: Booking queue codes cannot be null or empty. 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 Invalid Leg Key: description: Example if the Leg Key is not valid. value: errors: - id: 399ce6c5-16f7-9a6a-c234-49bb51e0070c code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: legKey: abc rawMessage: The identifier 'legKey' with value 'abc' 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 Comments is null or empty: description: Example when the comments is null or empty. value: errors: - id: 0a4856dc-2a3b-b176-b276-5d89b2dbc1da code: QueueBookingByInventoryLegRequest.Comments:RequiredAttribute message: QueueBookingByInventoryLegRequest.Comments:RequiredAttribute type: Validation details: validation: RequiredAttribute model: QueueBookingByInventoryLegRequest member: Comments rawMessage: The QueueBookingByInventoryLegRequest field is required. 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 Inventory Queuing is not allowed: description: Example if queuing bookings on the specified leg is not allowed. value: errors: - id: 35c280c4-26e4-3357-e9f3-c05fd9c3d412 code: nsk:BookingQueues:QueueBookingsOnSpecifiedLegNotAllowed message: nsk:BookingQueues:QueueBookingsOnSpecifiedLegNotAllowed type: Error details: null rawMessage: Queuing bookings on the specified leg is not allowed. 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 Flight is before the allowed time: description: Example if the flight is before the allowed time to process. value: errors: - id: a01958be-bd6c-bdad-ec31-af616b1a0c8b code: nsk-server:InventoryQueuingNotAllowed message: nsk-server:InventoryQueuingNotAllowed type: Error details: message: Selected flight is no longer valid for flight queuing. rawMessage: Selected flight is no longer valid for flight queuing. 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 Flight is after the allowed time: description: Example if the flight is after the allowed time to process. value: errors: - id: a01958be-bd6c-bdad-ec31-af616b1a0c8b code: nsk-server:InventoryQueuingNotAllowed message: nsk-server:InventoryQueuingNotAllowed type: Error details: message: Selected flight is not yet valid for flight queuing. rawMessage: Selected flight is not yet valid for flight queuing. 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 Flight does not contain any bookings: description: Example if the flight does not contain any bookings value: errors: - id: 741c2461-9eaa-31f8-2868-d43a3aee913e code: nsk-server:InventoryQueuingNotAllowed message: nsk-server:InventoryQueuingNotAllowed type: Error details: message: Selected flight does not contain any bookings. rawMessage: Selected flight does not contain any bookings. 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 Booking queue code does not exist: description: Example if a booking queue code in the list does not exist. value: errors: - id: 8b150b05-cbbb-2623-c612-31d6b4650e3f code: nsk-server:InventoryQueuingNotAllowed message: nsk-server:InventoryQueuingNotAllowed type: Error details: message: Selected booking queue DAPi is not allowed for flight queuing. rawMessage: Selected booking queue DAPi is not allowed for flight queuing. 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 Booking queue code is not of Inventory Queuing Event Type: description: Example if a booking queue code in the list is not of Inventory Queuing Event Type. value: errors: - id: 9e497521-d2e2-1f2d-3bb8-caa77787db1a code: nsk-server:InventoryQueuingNotAllowed message: nsk-server:InventoryQueuingNotAllowed type: Error details: message: Selected booking queue AQCD is not allowed for flight queuing. rawMessage: Selected booking queue AQCD is not allowed for flight queuing. 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 Flight does not exist: description: Example if the provided Leg Key has an inexistent flight. value: errors: - id: cef3c8a5-a9d5-21b1-493e-e3fedd7cc18f code: nsk-server:InventoryQueuingNotAllowed message: nsk-server:InventoryQueuingNotAllowed type: Error details: message: Flight does not exist. rawMessage: Flight does not exist. 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 security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/queues/{bookingQueueKey}: delete: tags: - Bookings summary: Removes a booking from the specified booking queue item. description: 'GraphQL endpoint: bookingsDequeueByKey' operationId: nsk_v1_bookings_queues_bookingQueueKey_delete parameters: - name: bookingQueueKey in: path required: true description: The unique key of the booking queue to dequeue from. schema: type: string x-position: 1 requestBody: x-name: request description: The request for the dequeue operation. content: application/json: schema: $ref: '#/components/schemas/BookingQueueDeleteByKeyRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/queues/{queueCode}/items: get: tags: - Bookings summary: Retrieves the booking queue items associated with the queue code. description: 'GraphQL endpoint: bookingQueueItemsv2' operationId: nsk_v2_bookings_queues_queueCode_items_get parameters: - name: queueCode in: path required: true description: The queue code. schema: type: string x-position: 1 - name: SubQueueCode in: query description: "The sub queue code.\n " schema: type: - string - 'null' x-position: 2 - name: StartDate in: query description: "The start date.\n " schema: type: string format: date-time x-position: 3 - name: EndDate in: query description: "The end date.\n " schema: type: string format: date-time x-position: 4 - name: QueueEventType in: query description: "The queue event type.\n \nEnumeration values: 0 = Default, 1 = BookingBalanceDue, 2 = BookingNegativeBalance, 3 = BookingCustomerComment, 4 = DeclinedPaymentInitial, 5 = DeclinedPaymentChange, 6 = FareOverride, 7 = ScheduleTimeChange, 8 = ScheduleTimeChangeMisconnect, 9 = ScheduleCancellation, 10 = FlightDesignatorChange, 11 = ReaccommodationMove, 12 = GdsCancelWithPendingPayment, 13 = InvalidPriceStatusOverride, 14 = FareRestrictionOverride, 15 = HeldBookings, 16 = InvalidPriceStatus, 17 = Watchlist, 18 = NonFlightServiceFee, 19 = NotAllTicketNumbersReceived, 20 = BookingSegmentOversold, 21 = ReaccommodationCancel, 22 = ExternalSsrAutoConfirmed, 23 = OpCarrierSegUpdate, 24 = OpCarrierSsrUpdate, 25 = OpCarrierOtherUpdate, 26 = NameChangeNotAllowed, 27 = InboundAscNotProcessed, 28 = OpCarrierInformationChange, 29 = BookingComponentUpdate, 30 = GroupBookings, 31 = BankDirectPnrOutOfBalance, 32 = NoSeatAssigned, 33 = SeatNumberChange, 34 = SsrNotSupportedOnNewSeat, 35 = FewerSeatPreferencesMetOnNewSeat, 36 = AosUnableToConfirmCancel, 37 = ETicketIssue, 38 = ETicketFollowup, 39 = InvoluntaryFlyAhead, 40 = ManualClearanceOnOutage, 41 = UnbalancedPoints, 42 = OpCarrierTimeChange, 43 = OaCarrierTimeChange, 44 = VoluntaryFlightChange, 45 = InvoluntaryFlightChange, 46 = HoldCancellationFailed, 47 = ScheduleTimeChangeWithDynamicQueueCode, 48 = ReaccommodationMoveWithDynamicQueueCode, 49 = ItineraryIntegrity, 50 = ReducePartyNotProcessed, 51 = CheckedPassengerUpdate, 52 = MustBeSeatGroupViolation, 57 = NameChangeWithinRule, 58 = IncompletePassengerEMDCoupon, 59 = ASVCUpdateFailed, 60 = FailedFareClassRealignment, 61 = ScheduleTimeChangeMisconnectBelowMinimum, 62 = ScheduleTimeChangeMisconnectAboveMaximum, 63 = OpCarrierMisconnect, 64 = InventoryQueuing, 65 = SelfServiceAsm, 66 = SelfServiceDelay, 67 = SelfServiceFlightCancellation, 68 = SelfServiceIrop, 69 = SelfServiceScheduleChange, 70 = SelfServiceTimeChange, 71 = AosAddOrCancelNotSuccessful, 72 = MissingGdsFareFamily, 73 = ChangeCabinQueue, 74 = PendingPaymentQueue, 75 = TicketDisplayToDetermineIncludedServiceBundleFailed, 76 = DuplicateTicketsInBooking, 77 = TicketCouponUpdateQueue, 78 = ETicketRefund, 79 = ExternalEticketVoidCheck, 80 = ExternalEticketVoidCheckFollowUp, 81 = NoAssignedSeatOnNewFlightFromEquipmentChange" schema: $ref: '#/components/schemas/QueueEventType' x-position: 5 - name: PageSize in: query description: "The number of records to be retrieved per page.\nTo retrieve the next set of records, use the endpoint again with the lastIndex set.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 x-position: 6 - name: LastIndex in: query description: "The last row retrieved. This is used for paging.\n " schema: type: integer format: int64 x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfRetrieveBookingQueueResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/quote: post: tags: - Bookings summary: Retrieves an itinerary quote based on the request. description: 'Although this endpoint behaves like a GET, POST is used to reduce the limitations resulting from URL length issues. Itinerary is a stateless booking and not tied to the logged-in user. The `IncludeServiceBundle` parameter defaults to `false` if not supplied. GraphQL endpoint: bookingsQuotev2' operationId: nsk_v2_bookings_quote_post requestBody: x-name: request description: The itinerary quote request. content: application/json: schema: $ref: '#/components/schemas/ItineraryQuoteRequest' examples: Basic itinerary quote request: description: Example request for quoting an itinerary with a round-trip flight and a single passenger. value: ssrs: null serviceBundleCodes: null includeServiceBundle: null keys: - journeyKey: TlZ_NTYyMn4gfn5TTEN_MDcvMjkvMjAyNSAwNjowMH5CT1N_MDcvMjkvMjAyNSAxNDowMH5ERU5_ fareAvailabilityKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flghMA-- standbyPriorityCode: null inventoryControl: null - journeyKey: TlZ_NTYxM34gfn5CT1N_MDgvMDEvMjAyNSAwNzowMH5TTEN_MDgvMDEvMjAyNSAxMDowMH5_ fareAvailabilityKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flghMA-- standbyPriorityCode: null inventoryControl: null passengers: types: - type: ADT discountCode: null count: 1 residentCountry: null currencyCode: USD infantCount: null promotionCode: null sourceOrganization: null Itinerary quote with infant: description: Example request for quoting an itinerary with a one-way flight and a passenger with infant. value: ssrs: null serviceBundleCodes: null includeServiceBundle: null keys: - journeyKey: TlZ_NTYyMn4gfn5TTEN_MDcvMjkvMjAyNSAwNjowMH5CT1N_MDcvMjkvMjAyNSAxNDowMH5ERU5_ fareAvailabilityKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flghMA-- standbyPriorityCode: null inventoryControl: null passengers: types: - type: ADT discountCode: null count: 1 residentCountry: null currencyCode: USD infantCount: 1 promotionCode: null sourceOrganization: null Itinerary quote with SSRs: description: Example request for quoting an itinerary with a one-way flight with multiple passengers and SSR. value: ssrs: - market: identifier: identifier: '5622' carrierCode: NV opSuffix: null destination: BOS origin: SLC departureDate: '2025-07-29T06:00:00' items: - passengerType: ADT ssrs: - ssrCode: BA10 count: 1 designator: null serviceBundleCodes: null includeServiceBundle: null keys: - journeyKey: TlZ_NTYyMn4gfn5TTEN_MDcvMjkvMjAyNSAwNjowMH5CT1N_MDcvMjkvMjAyNSAxNDowMH5ERU5_ fareAvailabilityKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flghMA-- standbyPriorityCode: null inventoryControl: null passengers: types: - type: ADT discountCode: null count: 1 - type: CHD discountCode: null count: 1 residentCountry: null currencyCode: USD infantCount: null promotionCode: null sourceOrganization: null Itinerary quote with included bundle: description: Example request for quoting an itinerary with a one-way flight and a passenger with included bundle. For included bundles, if the `includeServiceBundle` is set to `true`, the bundle will be applied regardless if the bundle code is specified in the request or not. value: ssrs: null serviceBundleCodes: null includeServiceBundle: true keys: - journeyKey: TlZ_NTYyMn4gfn5TTEN_MDcvMjkvMjAyNSAwNjowMH5CT1N_MDcvMjkvMjAyNSAxNDowMH5ERU5_ fareAvailabilityKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flghMA-- standbyPriorityCode: null inventoryControl: null passengers: types: - type: ADT discountCode: null count: 1 residentCountry: null currencyCode: USD infantCount: null promotionCode: null sourceOrganization: null Itinerary quote with add-on bundles: description: Example request for quoting an itinerary with a round-trip flight and a passenger with add-on bundle for both journeys. value: ssrs: null serviceBundleCodes: - DA01 - DA02 includeServiceBundle: true keys: - journeyKey: TlZ_NTYyMn4gfn5TTEN_MDcvMjkvMjAyNSAwNjowMH5CT1N_MDcvMjkvMjAyNSAxNDowMH5ERU5_ fareAvailabilityKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flghMA-- standbyPriorityCode: null inventoryControl: null - journeyKey: TlZ_NTYxM34gfn5CT1N_MDgvMDEvMjAyNSAwNzowMH5TTEN_MDgvMDEvMjAyNSAxMDowMH5_ fareAvailabilityKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flghMA-- standbyPriorityCode: null inventoryControl: null passengers: types: - type: ADT discountCode: null count: 1 residentCountry: null currencyCode: USD infantCount: null promotionCode: null sourceOrganization: null required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfItineraryQuote' examples: Booking quote successful: description: Example response when the booking quote is successful. value: data: passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: null customerNumber: null fees: null name: null passengerTypeCode: ADT discountCode: null bags: null program: null infant: null info: null travelDocuments: null addresses: - status: 0 companyName: null lineOne: 123 First Street passengerAddressKey: null phone: 555-555-1234 lineTwo: null stationCode: SLC lineThree: null emailAddress: null countryCode: US cultureCode: null provinceState: UT refusedContact: null city: SLC postalCode: '84108' weightCategory: null emdCoupons: null journeys: - flightType: 1 stops: 0 designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' move: null segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' isSeatmapViewable: true fares: - isGoverning: true carrierCode: null fareKey: MH5Cfn5OVn5CRU1EfkVTQ1J_fjB_MH5_WA-- classOfService: null classType: null fareApplicationType: 0 fareClassOfService: null fareBasisCode: null fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: null ruleNumber: null productClass: null ruleTariff: null travelClassCode: null pricingDate: '0001-01-01T00:00:00' crossReferenceClassOfService: null fareDesignator: null passengerFares: null fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '1234' carrierCode: NV opSuffix: null passengerSegment: mcfbrfQ-: seats: null passengerKey: null activityDate: null boardingSequence: null createdDate: null liftStatus: 2 modifiedDate: null overBookIndicator: 0 priorityDate: null timeChanged: false verifiedTravelDocs: null sourcePointOfSale: null pointOfSale: null ssrs: - isConfirmed: false isConfirmingUnheld: false note: null ssrDuration: 0 ssrKey: null count: 0 ssrCode: WCHR feeCode: null inBundle: false passengerKey: null ssrDetail: null ssrNumber: null market: null tickets: null bags: null scores: null boardingPassDetail: null hasInfant: false seatPreferences: null bundleCode: null verifiedTravelDocuments: null referenceNumber: 0 baggageGroupNumber: null baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 0 cabinOfService: null externalIdentifier: null priorityCode: null changeReasonCode: 0 segmentType: 0 salesDate: null international: false flightReference: null legs: - legKey: null operationsInfo: null designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' legInfo: null nests: null ssrs: null seatmapReference: null flightReference: null status: 0 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false breakdown: null One or more of the SSRs in the bundle is restricted to the role: description: Example response when one or more of the SSRs in the bundle is restricted to the role. value: messages: - rawValue: Failed to sell SSR HMC in service bundle DA03 on SLC-DEN for passenger 0 code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: CannotSellBundleSSR value: null status: 0 details: null data: passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: null customerNumber: null fees: null name: null passengerTypeCode: ADT discountCode: null bags: null program: null infant: null info: null travelDocuments: null addresses: - status: 0 companyName: null lineOne: 123 First Street passengerAddressKey: null phone: 555-555-1234 lineTwo: null stationCode: SLC lineThree: null emailAddress: null countryCode: US cultureCode: null provinceState: UT refusedContact: null city: SLC postalCode: '84108' weightCategory: null emdCoupons: null journeys: - flightType: 1 stops: 0 designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' move: null segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' isSeatmapViewable: true fares: - isGoverning: true carrierCode: null fareKey: MH5Cfn5OVn5CRU1EfkVTQ1J_fjB_MH5_WA-- classOfService: null classType: null fareApplicationType: 0 fareClassOfService: null fareBasisCode: null fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: null ruleNumber: null productClass: null ruleTariff: null travelClassCode: null pricingDate: '0001-01-01T00:00:00' crossReferenceClassOfService: null fareDesignator: null passengerFares: null fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '1234' carrierCode: NV opSuffix: null passengerSegment: mcfbrfQ-: seats: null passengerKey: null activityDate: null boardingSequence: null createdDate: null liftStatus: 2 modifiedDate: null overBookIndicator: 0 priorityDate: null timeChanged: false verifiedTravelDocs: null sourcePointOfSale: null pointOfSale: null ssrs: - isConfirmed: false isConfirmingUnheld: false note: null ssrDuration: 0 ssrKey: null count: 0 ssrCode: WCHR feeCode: null inBundle: false passengerKey: null ssrDetail: null ssrNumber: null market: null tickets: null bags: null scores: null boardingPassDetail: null hasInfant: false seatPreferences: null bundleCode: null verifiedTravelDocuments: null referenceNumber: 0 baggageGroupNumber: null baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 0 cabinOfService: null externalIdentifier: null priorityCode: null changeReasonCode: 0 segmentType: 0 salesDate: null international: false flightReference: null legs: - legKey: null operationsInfo: null designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' legInfo: null nests: null ssrs: null seatmapReference: null flightReference: null status: 0 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false breakdown: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Non-existent currency code: description: The specified currency code is not configured in the system. value: errors: - id: null code: nsk:Validation:UnknownSellCurrencyCode message: nsk:Validation:UnknownSellCurrencyCode type: Validation details: currencyCode: ABC rawMessage: The currency code ABC does not exist or is not active. 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 Number of passenger exceeds limit: description: The number of passengers specified in the request exceeds what is configured in the Management Console. value: errors: - id: null code: nsk:Availability:MaxBookingPassengers message: nsk:Availability:MaxBookingPassengers type: Validation details: null rawMessage: The requested 101 passengers exceeds the configured system limit of 100. 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 Number of infants is more than the passenger count: description: The number of infants is greater than the number of passengers allowed to have infants on lap. value: errors: - id: null code: nsk:Availability:MaxInfantCountToPassengerCount message: nsk:Availability:MaxInfantCountToPassengerCount type: Error details: null rawMessage: The number of infants 2 requested exceeds the number of allowed passenger types of 1. 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 Non-existent passenger type in the SSRs: description: The passenger type under `ssrs.items` is invalid or not configured in the system. value: errors: - id: null code: nsk:Passenger:InvalidPassengerType message: nsk:Passenger:InvalidPassengerType type: Validation details: null rawMessage: The passenger type XYZ is not valid. 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 Mismatching passenger types in the request: description: The passenger type under `ssrs.items` is not found under `passengers`. value: errors: - id: null code: nsk:Passenger:TypeNotFound message: nsk:Passenger:TypeNotFound type: Error details: null rawMessage: Passenger type SNR is not found in this 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 Number of SSRs exceeds limit: description: The SSR count exceeds the allowed number per passenger and leg. value: errors: - id: null code: code=nsk-server:CannotSellSSR message: code=nsk-server:CannotSellSSR type: Validation details: null rawMessage: SSR (BA10) is restricted to 1 occurence(s) per passenger and leg. 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 Bundle is not applicable to the journey or passenger: description: The specified bundle is invalid or ineligible for the journey or passenger. value: errors: - id: null code: nsk-server:ErrorProcessingServiceBundles message: nsk-server:ErrorProcessingServiceBundles type: Information details: null rawMessage: Passenger {name not specified} does not qualify for bundle DAI1 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 Logged-in agent is not authorized to sell the bundle: description: The logged in agent has no permissions to sell the bundle. value: errors: - id: null code: nsk-server:ErrorProcessingServiceBundles message: nsk-server:ErrorProcessingServiceBundles type: Information details: null rawMessage: Current agent is not authorized to sell bundle DA03 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 '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/searchByAgency: get: tags: - Bookings summary: Find booking by agency. description: 'GraphQL endpoint: searchByAgencyv2' operationId: nsk_v2_bookings_searchByAgency_get parameters: - name: OrganizationCode in: query description: "OrganizationCode represents the organization associated with the agent who created\nthe booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 1 - name: FirstName in: query description: "The first name of a passenger.\n " schema: type: - string - 'null' maxLength: 32 minLength: 0 x-position: 2 - name: LastName in: query description: "The last name of a passenger.\n " schema: type: - string - 'null' maxLength: 32 minLength: 0 x-position: 3 - name: PhoneticSearch in: query description: "Whether or not to do a phonetic search of the last name.\n " schema: type: - boolean - 'null' x-position: 4 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 5 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 6 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: - string - 'null' x-position: 7 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: - string - 'null' format: date-time x-position: 8 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 9 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 10 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 11 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 12 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: - boolean - 'null' x-position: 13 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/searchByAgent: get: tags: - Bookings summary: Find booking by agent. description: 'GraphQL endpoint: searchByAgentv2' operationId: nsk_v2_bookings_searchByAgent_get parameters: - name: AgentId in: query description: "The agent identifier.\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 1 - name: FirstName in: query description: "The first name of a passenger.\n " schema: type: - string - 'null' maxLength: 32 minLength: 0 x-position: 2 - name: LastName in: query description: "The last name of a passenger.\n " schema: type: - string - 'null' maxLength: 32 minLength: 0 x-position: 3 - name: PhoneticSearch in: query description: "Whether or not to do a phonetic search.\n " schema: type: - boolean - 'null' x-position: 4 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 5 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 6 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: - string - 'null' x-position: 7 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: - string - 'null' format: date-time x-position: 8 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 9 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 10 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 11 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 12 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: - boolean - 'null' x-position: 13 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/searchByAgentCode: get: tags: - Bookings summary: Find booking by the agent code. description: 'GraphQL endpoint: searchByAgentCodev2' operationId: nsk_v2_bookings_searchByAgentCode_get parameters: - name: AgentCode in: query description: "The agent code (name) that created the booking.\n " schema: type: - string - 'null' maxLength: 64 minLength: 0 x-position: 1 - name: DomainCode in: query description: "The domain code to find.\n " schema: type: - string - 'null' maxLength: 5 minLength: 0 x-position: 2 - name: FirstName in: query description: "The first name of a passenger.\n " schema: type: - string - 'null' maxLength: 32 minLength: 0 x-position: 3 - name: LastName in: query description: "The last name of a passenger.\n " schema: type: - string - 'null' maxLength: 32 minLength: 0 x-position: 4 - name: PhoneticSearch in: query description: "Whether or not to do a phonetic search.\n " schema: type: - boolean - 'null' x-position: 5 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 6 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 7 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: - string - 'null' x-position: 8 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: - string - 'null' format: date-time x-position: 9 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 10 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 11 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 12 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 13 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: - boolean - 'null' x-position: 14 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v3/bookings/searchByBagTag: get: tags: - Bookings summary: 'Find booking by a bag tag. The StartUtc needs to be within 7 days before the created date of the booking. If the StartUtc is set to DateTime.MinValue (1/1/0001) or not set at all, the value will be set to the current date, UTC.' description: 'GraphQL endpoint: searchByBagTagv3' operationId: nsk_v3_bookings_searchByBagTag_get parameters: - name: BagTag in: query description: "One of the OS tag number.\n " schema: type: - string - 'null' maxLength: 32 minLength: 0 x-position: 1 - name: StartUtc in: query description: "The OS tag start date. If not set or set to DateTime.MinValue (1/1/0001), will default to current date, UTC.\nThis date needs to be within 7 days before the created date of the booking.\n " schema: type: - string - 'null' format: date-time x-position: 2 - name: PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 3 - name: LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 4 - name: SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: - boolean - 'null' x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/searchByContact: get: tags: - Bookings summary: Find booking by contact. description: 'GraphQL endpoint: searchByContactv2' operationId: nsk_v2_bookings_searchByContact_get parameters: - name: FirstName in: query description: "The first name of a passenger or contact.\n " schema: type: - string - 'null' maxLength: 32 minLength: 0 x-position: 1 - name: LastName in: query description: "The last name of a passenger or contact.\n " schema: type: - string - 'null' maxLength: 32 minLength: 0 x-position: 2 - name: RecordLocator in: query description: "Record locator being requested.\n " schema: type: - string - 'null' maxLength: 12 minLength: 0 x-position: 3 - name: PhoneNumber in: query description: "One of the applied phone numbers to a passenger or contact.\n " schema: type: - string - 'null' maxLength: 20 minLength: 0 x-position: 4 - name: EmailAddress in: query description: "The email address of a contact.\n " schema: type: - string - 'null' maxLength: 266 minLength: 0 x-position: 5 - name: SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 6 - name: OrganizationCode in: query description: "OrganizationCode represents the organization associated with the agent who created\nthe booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 7 - name: OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 8 - name: SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: - boolean - 'null' x-position: 9 - name: PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 10 - name: LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 11 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/searchByContactCustomerNumber: get: tags: - Bookings summary: Find booking by contact customer number. description: 'GraphQL endpoint: searchByContactCustomerNumberv2' operationId: nsk_v2_bookings_searchByContactCustomerNumber_get parameters: - name: ContactCustomerNumber in: query description: "One of the contacts customer number applied.\n " schema: type: - string - 'null' maxLength: 20 minLength: 1 x-position: 1 - name: AgentId in: query description: "The agent identifier.\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 2 - name: OrganizationCode in: query description: "OrganizationCode represents the organization associated with the agent who created\nthe booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 3 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 4 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 5 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: - string - 'null' x-position: 6 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: - string - 'null' format: date-time x-position: 7 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 8 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 9 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 10 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 11 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: - boolean - 'null' x-position: 12 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/searchByCreditCard: post: tags: - Bookings summary: Find booking by credit card number. description: 'This endpoint behaves like a GET but is masked as a POST. GraphQL endpoint: searchByCreditCardv2' operationId: nsk_v1_bookings_searchByCreditCard_post requestBody: x-name: request description: Search bookings by credit card request. content: application/json: schema: $ref: '#/components/schemas/SearchBookingsByCreditCard' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/searchByCustomerNumber: get: tags: - Bookings summary: Find booking by customer number. description: 'GraphQL endpoint: searchByCustomerNumberv2' operationId: nsk_v2_bookings_searchByCustomerNumber_get parameters: - name: CustomerNumber in: query description: "One of the contacts customer number applied.\n " schema: type: - string - 'null' maxLength: 20 minLength: 1 x-position: 1 - name: AgentId in: query description: "The agent identifier.\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 2 - name: OrganizationCode in: query description: "OrganizationCode represents the organization associated with the agent who created\nthe booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 3 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 4 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 5 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: - string - 'null' x-position: 6 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: - string - 'null' format: date-time x-position: 7 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 8 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 9 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 10 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 11 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: - boolean - 'null' x-position: 12 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/searchByDate: get: tags: - Bookings summary: Find booking by date. description: 'GraphQL endpoint: searchByDatev2' operationId: nsk_v2_bookings_searchByDate_get parameters: - name: StartDateUtc in: query description: "The booking date start search.\n " schema: type: - string - 'null' format: date-time x-position: 1 - name: EndDateUtc in: query description: "The booking date end search.\n " schema: type: - string - 'null' format: date-time x-position: 2 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 3 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 4 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: - string - 'null' x-position: 5 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: - string - 'null' format: date-time x-position: 6 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 7 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 8 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 9 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 10 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: - boolean - 'null' x-position: 11 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/searchByDocument: get: tags: - Bookings summary: Find booking by document. description: 'GraphQL endpoint: searchByDocumentv2' operationId: nsk_v2_bookings_searchByDocument_get parameters: - name: Document.DocumentNumber in: query description: "One of the passengers applied travel document number.\n " schema: type: - string - 'null' maxLength: 35 minLength: 0 x-position: 1 - name: Document.DocumentTypeCode in: query description: "One of the passengers applied travel document type code.\n " schema: type: - string - 'null' maxLength: 4 minLength: 0 x-position: 2 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 3 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 4 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: - string - 'null' x-position: 5 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: - string - 'null' format: date-time x-position: 6 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 7 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 8 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 9 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 10 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: - boolean - 'null' x-position: 11 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/searchByEmail: get: tags: - Bookings summary: Find booking by email. description: 'GraphQL endpoint: searchByEmailv2' operationId: nsk_v2_bookings_searchByEmail_get parameters: - name: EmailAddress in: query description: "The email address of a contact.\n " schema: type: - string - 'null' format: email x-position: 1 - name: AgentId in: query description: "The agent identifier.\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 2 - name: PhoneticSearch in: query description: "Whether or not to do a phonetic search.\n " schema: type: - boolean - 'null' x-position: 3 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 4 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 5 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: - string - 'null' x-position: 6 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: - string - 'null' format: date-time x-position: 7 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 8 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 9 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 10 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 11 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: - boolean - 'null' x-position: 12 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/searchByExternalPayment: get: tags: - Bookings summary: 'Used to search the list of bookings that have used the account from the payment. Only External Payments should be used for searching.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: searchByExternalPayment' operationId: nsk_v1_bookings_searchByExternalPayment_get parameters: - name: RecordLocator in: query description: "The record locator of a booking.\n " schema: type: - string - 'null' x-position: 1 - name: PaymentKey in: query description: "The payment key of a specific payment under a booking.\n " schema: type: - string - 'null' x-position: 2 - name: PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 3 - name: LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 4 - name: FlightNumber in: query description: "Filter by the flight number.\n " schema: type: - string - 'null' x-position: 5 - name: DepartureDate in: query description: "The first journeys departure date.\n " schema: type: - string - 'null' format: date-time x-position: 6 - name: Destination in: query description: "Filter by the destination code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 7 - name: Origin in: query description: "Filter by the departure code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 8 - name: SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 9 - name: OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 10 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/searchByLastName: get: tags: - Bookings summary: Find booking by last name. description: 'GraphQL endpoint: searchByLastNamev2' operationId: nsk_v2_bookings_searchByLastName_get parameters: - name: LastName in: query description: "The last name of a passenger or contact.\n " schema: type: - string - 'null' maxLength: 32 minLength: 0 x-position: 1 - name: FirstName in: query description: "The first name of a passenger or contact.\n " schema: type: - string - 'null' maxLength: 32 minLength: 0 x-position: 2 - name: PhoneticSearch in: query description: "Whether or not to do a phonetic search.\n " schema: type: - boolean - 'null' x-position: 3 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 4 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 5 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: - string - 'null' x-position: 6 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: - string - 'null' format: date-time x-position: 7 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 8 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 9 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 10 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 11 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: - boolean - 'null' x-position: 12 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/searchByPerson: get: tags: - Bookings summary: Retrieves the bookings of the specified person based on the date range. description: 'Adds the ability to search by a date range. To get more information about each booking, a subsequent call to GET /api/nsk/v1/bookings/{recordLocator} can be used. Please use this call and not any stateful calls for performance reasons. GraphQL endpoint: searchByPerson' operationId: nsk_v1_bookings_searchByPerson_get parameters: - name: PersonKey in: query description: "The unique person key. This can be found by using GET /api/nsk/v2/persons endpoint.\n " schema: type: - string - 'null' maxLength: 100 x-position: 1 - name: StartDate in: query description: "The booking date start search. If not set manually the start date will be set to the current day.\n " schema: type: - string - 'null' format: date-time x-position: 2 - name: EndDate in: query description: "The booking date end search. If not set manually the end date will be 24 hours after the start date.\n " schema: type: - string - 'null' format: date-time x-position: 3 - name: PageSize in: query description: "Used to specify the maximum results to return.\nDefaults to 1000 if not specified. Minimum is 10 and maximum is 5000.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 4 - name: LastPageKey in: query description: "The last page key of the last paged item. This can be found on the\nresponse from the previous set of paged results.\n " schema: type: - string - 'null' maxLength: 100 x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedBookingSearchByPersonResult' examples: With matching bookings: description: Successful retrieval of bookings that match the search criteria. value: data: bookings: - bookingDate: '2026-07-09T05:55:16.0450106Z' departureDate: '2026-07-12T05:55:16.0450407+00:00' arrivalStation: YTZ departureStation: LAX recordLocator: Z378SY bookingKey: MzY3MTc0IVozNzhTWSE- lastPageKey: MA-- With no matching bookings: description: No bookings match the search criteria. value: data: bookings: [] lastPageKey: MA-- '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'asdf' 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. With Invalid Customer Number: description: The customer number does not exist. value: errors: - id: 88ab2c3c-bbb4-6788-8gb5-3cg50c2d98c0 code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'asdf' 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. With Invalid Page Size: description: The page size value is not between the range of 10 and 5000. value: errors: - id: 41fa77a0-f351-5152-305f-f92cf1daf8c1 code: SearchBookingsByPerson.PageSize:RangeAttribute message: The field PersonBookingSearchRequest must be between 10 and 5000. type: Validation details: null rawMessage: The field SearchBookingsByPerson must be between 10 and 5000. 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. With Invalid Date Range: description: The date range exceeded the configured maxmimum number of days. value: errors: - id: cc25dafa-5637-2fff-e402-3250131e12ab code: nsk:Booking:MaxBookingSearchDateRange message: nsk:Booking:MaxBookingSearchDateRange type: Validation details: null rawMessage: The requested date range of 764 days exceeds the system limit of 731. 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. With End Date Before Start Date: description: The end date exceeded the start date value: errors: - id: bc4eeb6c-ed73-6a63-f34f-e66bd9c461cb code: FindCustomerBookingRequest.EndDate:MinMaxDateTimeAttribute message: End date may not be before Start date. type: Validation details: null rawMessage: End date may not be before Start date. 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. security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/searchByPhone: get: tags: - Bookings summary: Find booking by phone. description: 'GraphQL endpoint: searchByPhonev2' operationId: nsk_v2_bookings_searchByPhone_get parameters: - name: PhoneNumber in: query description: "One of the applied phone numbers to a passenger or contact.\n " schema: type: - string - 'null' maxLength: 20 minLength: 0 x-position: 1 - name: AgentId in: query description: "The agent identifier.\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 2 - name: OrganizationCode in: query description: "OrganizationCode represents the organization associated with the agent who created\nthe booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 3 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 4 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 5 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: - string - 'null' x-position: 6 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: - string - 'null' format: date-time x-position: 7 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 8 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 9 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 10 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 11 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: - boolean - 'null' x-position: 12 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/searchByRecordLocator: get: tags: - Bookings summary: Find booking by record locator. description: 'GraphQL endpoint: searchByRecordLocatorv2' operationId: nsk_v2_bookings_searchByRecordLocator_get parameters: - name: RecordLocator in: query description: "Record locator being requested.\n " schema: type: - string - 'null' maxLength: 12 minLength: 0 x-position: 1 - name: PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 2 - name: LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 3 - name: SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 4 - name: OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 5 - name: SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: - boolean - 'null' x-position: 6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/bookings/searchByReferenceNumber: get: tags: - Bookings summary: 'Find booking by reference number. The reference number is used as identifier by New Skies Rail customers for purposes of ticketing and check in.' description: 'GraphQL endpoint: searchByReferenceNumberv2' operationId: nsk_v2_bookings_searchByReferenceNumber_get parameters: - name: ReferenceNumber in: query description: "The reference number, used as an identifier by New Skies Rail customers for purposes\nof ticketing and check in.\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 1 - name: AgentId in: query description: "The agent identifier.\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 2 - name: OrganizationCode in: query description: "The organization code associated with the agent who created the booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 3 - name: PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 4 - name: LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 5 - name: SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 6 - name: OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 7 - name: SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: - boolean - 'null' x-position: 8 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v3/bookings/searchByThirdPartyRecordLocator: get: tags: - Bookings summary: Find booking by a third party record locator. description: 'GraphQL endpoint: searchByThirdPartyRecordLocatorv3' operationId: nsk_v3_bookings_searchByThirdPartyRecordLocator_get parameters: - name: SystemCode in: query description: "The system code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 1 - name: AgentId in: query description: "The agent identifier.\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 2 - name: OrganizationCode in: query description: "OrganizationCode represents the organization associated with the agent who created\nthe booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 3 - name: RecordLocator in: query description: "Record locator being requested.\n " schema: type: - string - 'null' maxLength: 12 minLength: 0 x-position: 4 - name: PageSize in: query description: "The number of items to return for the request.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 5 - name: LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 6 - name: SourceOrganization in: query description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 7 - name: OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 8 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/bookings/watchList/{bookingKey}: get: tags: - Bookings summary: Retrieves the watch list for a specific booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsWatchList' operationId: nsk_v1_bookings_watchList_bookingKey_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfWatchListResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/dcs/v2/bookings/searchByScan: post: tags: - Bookings summary: Parses scanner output and performs a booking search based on the type of scan. description: 'GraphQL endpoint: dcsSearchByScan' operationId: dcs_v2_bookings_searchByScan_post requestBody: x-name: request description: Scan data with optional origin and departureDate. content: application/json: schema: $ref: '#/components/schemas/SearchByScanRequestV2' required: true x-position: 1 responses: '200': description: A list of booking search results. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfBookingSummary' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse_2' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse_2' security: - JWT: [] servers: - url: https://prod.api.tui/flight/newskies/gonow description: TUI Prod - url: https://playground.api.tui/flight/newskies/gonow description: TUI Playground components: schemas: ValidateHolidayRequest: type: object required: - InfoBookingRequest properties: InfoBookingRequest: $ref: '#/components/schemas/InfoBookingRequest' ValHolidayResponseHotelProduct: type: object required: - Name - Acc_Cd properties: HtlPrd: type: object properties: Name: type: string example: Highlights of the Mediterranean (Discovery 2) description: Product name Prom: type: object properties: Code: type: string example: CGCR description: Promotion code Issue: type: integer example: 1 description: Issue number Name: type: string example: Marella Cruises description: Promotion name Brand: type: string example: 'NULL' description: Brand information TEXT: type: string example: 'NULL' description: Additional text information Acc_Cd: type: object properties: Accom_Id: type: string example: 1174396007/3 description: Accommodation ID TEXT: type: string example: XXXX0013/025 description: Accommodation code text Acc_InvState: type: string example: INTERNAL description: Accommodation inventory state Hotel: type: object properties: Add: type: object properties: Name: type: string example: Highlights of the Mediterranean (Discovery 2) description: Hotel name City: type: string example: Palma Port description: City name Region: type: string example: Majorca description: Region name CountryISOCode: type: string example: ES description: Country ISO code Comm: type: object properties: CommType: type: string example: TYPE_PHONE description: Communication type Sphere: type: string example: SPHERE_BUSINESS description: Communication sphere AreaCode: type: string example: 'NULL' description: Area code Num: type: string example: 01234567890 description: Phone number Loc: type: object properties: Loc_Cd: type: string example: ESMJPB description: Location code Loc_Tp: type: string example: CITY description: Location type Loc_Name: type: string example: Palma Port description: Location name Cat_Page: type: object properties: Catalog: type: object properties: Code: type: string example: GCR description: Catalog code Name: type: string example: Marella Cruises UK NEW description: Catalog name TEXT: type: string example: 'NULL' description: Additional text information Cat_Page_No: type: integer example: 0 description: Catalog page number Prc_Cat_Page_No: type: integer example: 0 description: Price catalog page number Ship_Cd: type: string example: XXXX0013 description: Ship code Ship_Name: type: string example: Marella Discovery 2 description: Ship name Corporate_Cd: type: integer example: 101752 description: Corporate code Sub_Corporate_Cd: type: string example: 'NULL' description: Sub-corporate code ValHolidayRequestSec: type: object required: - Dep_Air_Cd - Arr_Air_Cd - Flt_Dt_Tm - Car_Cd properties: Dep_Air_Cd: type: string description: Departure airport code (IATA code) example: LGW Arr_Air_Cd: type: string description: Arrival airport code (IATA code) example: PMI Flt_Dt_Tm: type: array description: Flight date and time information items: $ref: '#/components/schemas/ValHolidayRequestFlight_DateTime' Car_Cd: type: string description: Carrier code example: TOM Flt_No: type: string description: Flight number example: '4230' ValHolidayResponseRoute_List: type: object required: - Routing properties: Routing: $ref: '#/components/schemas/ValHolidayResponseRouting' SubServicePassengers: type: object properties: SubServPax: type: array description: List of passengers for this service items: $ref: '#/components/schemas/SubServicePassenger' ValHolidayRequestSource: type: object required: - '#attrs' properties: '#attrs': type: object required: - Cd properties: Cd: type: string description: Source code example: AGEN Person: type: object required: - FirstName - LastName - Title - Sex - PersonType properties: FirstName: type: string description: First name of the passenger example: TEST LastName: type: string description: Last name of the passenger example: PASSENGER Title: type: string description: Title of the passenger example: Mr Sex: type: string description: Gender of the passenger enum: - SEX_MALE - SEX_FEMALE example: SEX_MALE PersonType: type: string description: Type of person enum: - TYPE_NATURAL example: TYPE_NATURAL Item: type: array description: List of additional items in the booking items: $ref: '#/components/schemas/Item_Element' Summary_Prices: type: object properties: Summary_Price: type: array items: type: object properties: Prc_Tp_Cd: type: string example: ACRMAD description: Price type code Prc_Tp_Name: type: string example: Adult Package Price description: Price type name Qty: type: integer example: 2 description: Quantity Prc: type: number format: float example: 2075.0 description: Price amount ValHolidayRequestSub_Source: type: object required: - '#attrs' properties: '#attrs': type: object required: - Cd properties: Cd: type: string description: Sub-source code example: ZWEB ValHolidayResponseRouting: type: object required: - Routing_Id - Route properties: Routing_Id: type: string description: Routing identifier example: '2' Route: type: array description: List of routes items: $ref: '#/components/schemas/ValHolidayResponseRoute' ValHolidayRequestAdm: type: object properties: ReqId: type: string description: Request identifier example: node1-6eaY7EbD ValHolidayRequestMultiCentre: type: object required: - id - stDt - endDt - mcPrd - rmCd properties: Id: type: string description: Multi-center identifier example: '1' St_Dt: type: string format: date description: Start date example: '2026-08-04' End_Dt: type: string format: date description: End date example: '2026-08-18' MC_Prd: $ref: '#/components/schemas/ValHolidayRequestMultiCentreProduct' Rm_Cd: $ref: '#/components/schemas/RoomCode' Offer_Choice: type: array description: List of accommodation offers items: $ref: '#/components/schemas/ValHolidayRequestOfferChoice' '#attrs': type: object properties: Is_Adhoc: type: string description: Multi-center identifier example: 'false' Prices: type: object properties: Price: type: array items: type: object properties: Prc_Cd: type: string example: AA description: Price code Prc_Cd_Name: type: string example: Adult Package Price description: Price code name Prc_Cd_Tp: type: string example: ACRMAD description: Price code type Qty: type: integer example: 2 description: Quantity Prc: type: object properties: CurISO: type: string example: GBP description: Currency ISO code TEXT: type: number format: float example: 525.0 description: Price amount Prc_Dt: type: string format: date-time example: '2025-05-01T14:02:02+01:00' description: Price date PricePaxs: type: object properties: Pax_Id: type: array items: type: integer example: - 1 - 2 description: Passenger IDs Visible: type: boolean example: true description: Visibility flag Prc_Sts: type: string example: STK description: Price status ValHolidayRequestAccommodation: type: object required: - Id - stDt - endDt - htlPrd - rmCd properties: Id: type: string description: Accommodation identifier example: '2' St_Dt: type: string format: date description: Start date example: '2026-08-04' End_Dt: type: string format: date description: End date example: '2026-08-11' HtlPrd: $ref: '#/components/schemas/ValHolidayRequestHotelProduct' Rm_Cd: $ref: '#/components/schemas/RoomCode' InfoBookingRequest: type: object required: - DiscardSession - Adm - BkgSts - BkgEnt - Pax - Source - SubSource properties: DiscardSession: type: string description: Flag to indicate if the session should be discarded example: 'true' Adm: $ref: '#/components/schemas/ValHolidayRequestAdm' BkgSts: type: string description: Status of the booking example: BOOKING Bkg_Ent: $ref: '#/components/schemas/ValHolidayRequestBkg_Ent' Pax: type: array description: List of passengers in the booking items: $ref: '#/components/schemas/Pax' Source: $ref: '#/components/schemas/ValHolidayRequestSource' Sub_Source: $ref: '#/components/schemas/ValHolidayRequestSub_Source' ValHolidayResponseSource: type: object properties: Cd: type: string example: AGEN description: Source code Name: type: string example: Shop Booking description: Source name TEXT: type: string example: 'NULL' description: Additional text information ValHolidayResponseSec: type: object required: - Dep_Air_Cd - Arr_Air_Cd - Flt_Dt_Tm - Car_Cd properties: Id: type: integer example: 4 description: Primary identifier SecId: type: integer example: 1 description: Section identifier Dep_Air_Cd: type: string description: Departure airport code (IATA code) example: LGW Arr_Air_Cd: type: string description: Arrival airport code (IATA code) example: PMI Flt_Dt_Tm: type: array description: Flight date and time information items: $ref: '#/components/schemas/ValHolidayResponseFlight_DateTime' JnyDur: type: string example: 02:15 description: Journey duration in hours:minutes format Car_Cd: type: string description: Carrier code example: TOM Flt_No: type: string description: Flight number example: '4230' Bkg_Cls: type: object properties: Code: type: string example: Y description: Booking class code TEXT: type: string example: 'NULL' description: Additional text information Cab_Cls: type: object properties: Code: type: string example: Y description: Cabin class code Name: type: string example: 'Economy ' description: Cabin class name TEXT: type: string example: 'NULL' description: Additional text information Eqmt: type: string example: B787-300 description: Equipment code EqmtDescription: type: string example: Boeing 787-300 description: Equipment description Seat_Res_Possible: type: string example: 'NO' description: Seat reservation possibility enum: - 'YES' - 'NO' PayData: type: object properties: Dpt: type: array items: type: object properties: Type: type: string example: LOW CurISO: type: string example: GBP Amt: type: number format: float example: 250.0 Dep_Dt: type: string example: '2025-05-01' Bkg_Prc_Ex: type: object properties: CurISO: type: string example: GBP Amt: type: number format: float example: 3970.0 Bkg_Prc_Inc: type: object properties: CurISO: type: string example: GBP Amt: type: number format: float example: 3970.0 Bal_Due_Amt: type: number format: float example: 3970.0 Bal_Due_Dt: type: string example: '2026-05-12' Tot_Amt: type: number format: float example: 3970.0 Agt_Com: type: number format: float example: 0.0 Comm_Inc_VAT: type: number format: float example: 0.0 VAT: type: number format: float example: 0.0 Payment_Received: type: number format: float example: 0.0 Tot_Refund_Amt: type: number format: float example: 0.0 Tot_Dpt: type: number format: float example: 600.0 Pax_Element: type: object required: - '#attrs' - Person properties: '#attrs': type: object required: - Age - Index properties: Age: type: string description: Passenger age example: '30' Index: type: string description: Passenger index example: '1' Person: $ref: '#/components/schemas/Person' Lead_Pax: type: string description: Indicates if this is the lead passenger example: 'false' Transfer_Info: type: array description: Transfer information items: type: object properties: Dir: type: string description: Transfer direction (inbound/outbound) enum: - inbound - outbound example: inbound Transfer_Code: type: string description: Transfer code example: TFR Desc: type: string description: Transfer description example: Coach Transfer Included ValHolidayResponseItem_Element: type: object required: - St_Dt - Set_Type - Item_Type - Bkg_Qty - Ser_Sts properties: Is_Adhoc: type: boolean example: false description: Indicates if this is an ad-hoc item Code: type: string example: S263025/3529 description: Cabin code Name: type: string example: Deck 2/3 Inside 2 berth 3529 description: Cabin name Is_Default: type: boolean example: false description: Indicates if this is the default option Auto_Inc: type: boolean example: false description: Indicates if auto-increment is enabled Short_Name: type: integer example: 3529 description: Cabin number Error: type: boolean example: false description: Indicates if there is an error with this item Id: type: integer example: 7 description: Cabin identifier St_Dt: type: string format: date description: Start date example: '2026-08-04' End_Dt: type: string format: date description: Start date example: '2026-08-04' Set_Type: type: string description: Set type example: EXTRA Item_Type: type: object properties: Code: type: string example: PC description: Item type code Item_Type_Desc: type: object properties: Locale: type: string example: EN_EN description: Locale code Desc: type: string example: Pre Booked Cabin description: Item type description Prom: $ref: '#/components/schemas/ValHolidayResponseProm' Bkg_Qty: type: string description: Booking quantity example: '1' Ser_Sts: type: array description: Available service statuses items: type: string enum: - FIX - OPTION - QUOTE example: - FIX - OPTION - QUOTE MinPrice: type: - string - 'null' example: 'NULL' description: Minimum price MaxPrice: type: - string - 'null' example: 'NULL' description: Maximum price Price: type: - string - 'null' example: 'NULL' description: Current price SubServPaxs: type: object properties: SubServPax: oneOf: - type: array items: $ref: '#/components/schemas/SubServPax' - $ref: '#/components/schemas/SubServPax' Prices: $ref: '#/components/schemas/Prices' Ref_Prd_Id: type: string example: '2' description: Ref Prod Id Rate_Rule: type: string example: JOURNEY description: Rate rule type Item_Method: type: string example: PI description: Item method Atol_Mth: type: string example: APP description: ATOL method ValHolidayResponseProm: type: object description: Promotion information properties: Code: type: string description: Promotion code example: BGCR Issue: type: integer description: Issue number example: 1 Name: type: string description: Promotion name example: Marella Cruises Brand: type: string description: Brand code example: S TEXT: type: string description: Additional text information example: 'NULL' InfoBookingResponse: type: object required: - Adm - BkgSts - Bkg_Ent - Pax properties: Adm: $ref: '#/components/schemas/ValHolidayResponseAdm' CltInfo: $ref: '#/components/schemas/ValHolidayResponseCltInfo' BkgSts: type: string description: Status of the booking example: BOOKING ResSts: type: string description: Reservation status example: CONFIRMED Super_Ref2: type: string description: Super reference 2 example: 'NULL' HasAgt_Notice: type: boolean description: Has agent notice flag example: false StsExpDateMax: type: string format: date-time description: Status expiration date maximum example: '2026-08-04T00:00:00+01:00' His: type: object properties: Bkg_Dt_Tm: type: string format: date-time description: Booking date and time example: '2025-05-01T14:02:01+01:00' Bkg_Ent: $ref: '#/components/schemas/ValHolidayResponseBkg_Ent' Agt_No: type: string description: Agent number example: MARCR PayData: $ref: '#/components/schemas/PayData' Pax: type: array items: $ref: '#/components/schemas/Pax' DD_Marketing_Sts: type: string description: Direct debit marketing status example: V0 DD_Mandate: type: object properties: Apply_Sts: type: string description: Apply status example: DISA TEXT: type: string description: Additional text example: 'NULL' Prom: $ref: '#/components/schemas/ValHolidayResponseProm' Source: $ref: '#/components/schemas/ValHolidayResponseSource' Sub_Source: $ref: '#/components/schemas/ValHolidayResponseSub_Source' Incident_Sts: type: string example: NA description: Incident status Insurance_Method: type: string example: EXT description: Insurance method Retail_Bkg_Id: type: integer example: -1 description: Retail booking ID Bkg_Type_Mth: type: string example: RET description: Booking type method Market: type: object properties: Code: type: string example: BCTH description: Market code TEXT: type: string example: B2C TUI UK (£) description: Market description Agent_Group: type: object properties: Code: type: string example: MARELLA description: Agent group code Name: type: string example: Marella Websites description: Agent group name TEXT: type: string example: 'NULL' description: Additional text information ValHolidayResponseOfferChoice: type: object required: - accom properties: selectedOffer: type: integer example: 1 description: Selected offer ID isSelectionMandatory: type: boolean example: true description: Indicates if selection is mandatory Accom: $ref: '#/components/schemas/ValHolidayResponseAccommodation' '#attrs': type: object properties: selectedOffer: type: string description: Flag indicating if this offer is selected example: '1' TUITILResponse: type: object required: - Result properties: Result: type: object required: - ResponseCode - Description - CorrelationID properties: ResponseCode: type: string description: Response code indicating the status of the request example: '0000' Description: type: string description: Description of the response status example: SUCCESS CorrelationID: type: string description: Unique identifier for correlating the request and response example: fdd8c683-cf4e-4256-8cf6-f5b134145167 Service_version: type: string description: Version of the service example: v3 Xsd_version: type: string description: Version of the XSD schema example: T3.22.19.1 ValHolidayRequestPackage: type: object properties: Accom: $ref: '#/components/schemas/ValHolidayRequestAccommodation' MultiCentre: $ref: '#/components/schemas/ValHolidayRequestMultiCentre' Route_List: $ref: '#/components/schemas/ValHolidayRequestRoute_List' ValHolidayResponseRoomCode: type: object required: - Rm_No - Code - BB_Cd properties: Is_Adhoc: type: boolean example: false description: Indicates if this is an ad-hoc room Rm_No: type: integer example: 1 description: Room number Code: type: string example: ZI01 description: Room code Desc: type: string example: Decks 2/3 Inside Cabin description: Room description Fac_List: type: string example: Decks 2/3, Air-conditioning, Shower, WC description: Facility list as text Facility_List: type: object properties: Facility: type: array items: type: object properties: Code: type: string example: DK12 description: Facility code Name: type: string example: Decks 2/3 description: Facility name TEXT: type: string example: 'NULL' description: Additional text information StopSaleOverridden: type: boolean example: false description: Indicates if stop sale has been overridden Inf_Inc_Occ: type: boolean example: true description: Indicates if infants are included in occupancy Min_Pax: type: integer example: 1 description: Minimum number of passengers Max_Pax: type: integer example: 2 description: Maximum number of passengers Max_Adu: type: integer example: 2 description: Maximum number of adults Max_Chd: type: integer example: 2 description: Maximum number of children Max_Inf: type: integer example: 1 description: Maximum number of infants BB_Cd: type: string example: AI description: Board basis code BB_Name: type: string example: All Inclusive description: Board basis name Alt_BB_Cd: type: string example: PI description: Alternative board basis code Ser_Sts: type: array description: Available service statuses items: type: string enum: - FIX - OPTION - QUOTE example: - FIX - OPTION - QUOTE SubServPaxs: $ref: '#/components/schemas/SubServicePassengers' Prices: $ref: '#/components/schemas/Prices' No_Free_Chd: type: integer example: 0 description: Number of free children ValHolidayResponseRoute: type: object required: - RouteCd - Dep_Air_Cd - Arr_Air_Cd - Flt_Dt_Tm properties: Rt_Dir: type: string example: outbound description: Route direction enum: - outbound - inbound Is_Adhoc: type: boolean example: false description: Indicates if this is an ad-hoc route Error: type: boolean example: false description: Indicates if there is an error with this route RouteId: type: string description: Route Id example: '4' RouteCd: type: string description: Route code example: PMILGW2ALGWPMI Flt_Inv_Id: type: object properties: Box_Id: type: integer example: 6724334 description: Box identifier TEXT: type: integer example: 6194153804 description: Flight inventory identifier Rt_InvState: type: string example: INTERNAL description: Route inventory state Dep_Air_Cd: type: string description: Departure airport code (IATA code) example: LGW Arr_Air_Cd: type: string description: Arrival airport code (IATA code) example: PMI Flt_Dt_Tm: type: array description: Flight date and time information items: $ref: '#/components/schemas/ValHolidayResponseFlight_DateTime' Duration: type: integer example: 14 description: Duration in days Cycle_Dt: type: string format: date example: '2026-08-04' description: Cycle date JnyDur: type: string example: 02:15 description: Journey duration in hours:minutes format Prom: $ref: '#/components/schemas/ValHolidayResponseProm' Car_Cd: type: string description: Carrier code example: TOM Flt_No: type: integer example: 4230 description: Flight number Bkg_Cls: type: object properties: Code: type: string example: Y description: Booking class code TEXT: type: string example: 'NULL' description: Additional text information Cab_Cls: type: object properties: Code": type: string example: Y description: Cabin class code Name: type: string example: 'Economy ' description: Cabin class name TEXT: type: string example: 'NULL' description: Additional text information Flt_Seq_Cd: type: string description: Flight sequence code example: A Sec: $ref: '#/components/schemas/ValHolidayResponseSec' Ser_Sts: type: string description: Service status example: FIX SubServPaxs: $ref: '#/components/schemas/SubServPaxs' Memo: $ref: '#/components/schemas/Memo' Seat_Res_Possible: type: string example: 'NO' description: Seat reservation possibility enum: - 'YES' - 'NO' Check_In: type: object properties: Dir: type: string example: DEPARTURE description: Check-in direction enum: - DEPARTURE - ARRIVAL TEXT: type: string example: North Terminal description: Terminal information Atol_Mth: type: string example: APP description: ATOL method SSR_Possible: type: boolean example: false description: Special service request possibility Online_Chk_In_Mth: type: string example: DIS description: Online check-in method enum: - DIS - ENA Prom: type: object description: Promotion object with attributes properties: '#attrs': type: object description: Container for attribute-style properties properties: Code: type: string description: Promotion code identifier example: BGMC Issue: type: string description: Promotion code issue example: '1' required: - Code required: - '#attrs' TILInfoBookingResponse: type: object required: - TUITILResponse - InfoBookingResponse properties: TUITILResponse: $ref: '#/components/schemas/TUITILResponse' InfoBookingResponse: $ref: '#/components/schemas/InfoBookingResponse' SubServPaxs: type: object properties: SubServPax: type: array description: List of passengers for this service items: $ref: '#/components/schemas/SubServPax' ValHolidayRequestOfferChoice: type: object required: - accom properties: Accom: $ref: '#/components/schemas/ValHolidayRequestAccommodation' '#attrs': type: object properties: selectedOffer: type: string description: Flag indicating if this offer is selected example: '1' Flt_Extra_Cat_List: type: array items: type: object properties: Flt_Inv_Id: type: integer example: 6194153804 Flt_Extra_Cat: type: object properties: Code: type: string example: BAG Name: type: string example: Baggage Method: type: string example: BAG Flt_Extra: type: object properties: Code: type: string example: BAG Name: type: string example: Baggage Allowance Error: type: boolean example: false AllowComment: type: boolean example: false Class: type: string example: Y Baggage: type: object properties: Weight: type: object properties: Cd: type: integer example: 20 Piece: type: object properties: Cd: type: integer example: 1 TEXT: type: integer example: 0 SubServPaxs: type: object properties: SubServPax: oneOf: - type: array items: $ref: '#/components/schemas/SubServPax' - $ref: '#/components/schemas/SubServPax' Atol_Mth: type: string example: NONE Corporate_Cd: type: string example: L31422 ValHolidayRequestBkg_Ent: type: object properties: Accom: $ref: '#/components/schemas/ValHolidayRequestAccommodation' Package: $ref: '#/components/schemas/ValHolidayRequestPackage' Item: type: array description: List of additional items in the booking items: $ref: '#/components/schemas/Item' ValHolidayResponsePackage: type: object properties: Accom: $ref: '#/components/schemas/ValHolidayResponseAccommodation' MultiCentre: $ref: '#/components/schemas/ValHolidayResponseMultiCentre' Route_List: $ref: '#/components/schemas/ValHolidayResponseRoute_List' Item_Element: type: object required: - St_Dt - Set_Type - Item_Type - Bkg_Qty - Ser_Sts properties: St_Dt: type: string format: date description: Start date example: '2026-08-04' End_Dt: type: string format: date description: End date example: '2026-08-10' Set_Type: type: string description: Set type example: EXTRA Item_Type: type: object properties: '#attrs': type: object properties: Code: type: string description: Item type code example: WC Prom: type: object properties: '#attrs': type: object properties: Code: type: string description: Promotion code example: AUCI Bkg_Qty: type: string description: Booking quantity example: '2' Ser_Sts: type: string description: Service status example: FIX SubServPaxs: type: object properties: SubServPax: oneOf: - type: array items: $ref: '#/components/schemas/SubServPax' - $ref: '#/components/schemas/SubServPax' Ref_Prd_Id: type: string description: Reference product ID example: '1' Item_Method: type: string description: Item method example: PP '#attrs': type: object properties: Code: type: string description: Item code example: WCF1/A Name: type: string description: Item name example: Worldcare Fund Problem: type: object description: General error response object based on RFC 7807 properties: type: type: string example: validation title: type: string example: There was a problem validating the request required: - type - title SubServPax: type: object required: - Pax_Id properties: Pax_Id: type: string description: Passenger identifier example: '1' ValHolidayRequestRouting: type: object required: - Routing_Id - Route properties: Routing_Id: type: string description: Routing identifier example: '2' Route: type: array description: List of routes items: $ref: '#/components/schemas/ValHolidayRequestRoute' '#attrs': type: object properties: Routing_Type: type: string description: Type of routing example: OWR ValHolidayResponseSub_Source: type: object properties: Cd: type: string example: ZWEB description: Sub-source code Name: type: string example: Web Booking description: Sub-source name TEXT: type: string example: 'NULL' description: Additional text information ValHolidayResponseCltInfo: type: object properties: Locale: type: string example: en_EN CltSysContext: type: integer example: 3 Agt_No: type: string example: MARCR TermCode: type: string example: VTX User_Name: type: string example: MCUSER Chan: type: integer example: 1100 Channel_Type: type: string example: VRP User_Role: type: string example: INTERNAL Payment_VTID: type: integer example: 99000140 Bkg_Owner_Tp_Mth: type: string example: TO Payment_OrgID: type: string example: ba96ae31Ace67A4004Aa78aAdae2eec844a2 ValHolidayRequestRoute: type: object required: - RouteCd - Dep_Air_Cd - Arr_Air_Cd - Flt_Dt_Tm properties: RouteCd: type: string description: Route code example: PMILGW2ALGWPMI Flt_Inv_Id: type: string description: Flight inventory identifier example: '6194153804' Dep_Air_Cd: type: string description: Departure airport code (IATA code) example: LGW Arr_Air_Cd: type: string description: Arrival airport code (IATA code) example: PMI Flt_Dt_Tm: type: array description: Flight date and time information items: $ref: '#/components/schemas/ValHolidayRequestFlight_DateTime' Prom: $ref: '#/components/schemas/Prom' Car_Cd: type: string description: Carrier code example: TOM Bkg_Cls: type: string description: Booking class example: '' Flt_Seq_Cd: type: string description: Flight sequence code example: A Sec: $ref: '#/components/schemas/ValHolidayRequestSec' Ser_Sts: type: string description: Service status example: FIX SubServPaxs: $ref: '#/components/schemas/SubServPaxs' '#attrs': type: object properties: Rt_Dir: type: string description: Route direction enum: - outbound - inbound example: outbound ValHolidayResponseAccommodation: type: object required: - Id - stDt - endDt - htlPrd - rmCd properties: Is_Adhoc: type: boolean example: false description: Indicates if this is an ad-hoc item Error: type: boolean example: false description: Indicates if there is an error with this item Id: type: string description: Accommodation identifier example: '2' St_Dt: type: string format: date description: Start date example: '2026-08-04' End_Dt: type: string format: date description: End date example: '2026-08-11' HtlPrd: $ref: '#/components/schemas/ValHolidayResponseHotelProduct' Rm_Cd: $ref: '#/components/schemas/ValHolidayResponseRoomCode' Memo: $ref: '#/components/schemas/Memo' Ref_Prd_Id: type: integer example: 1 description: Reference product ID Free_Car_Rental_Poss: type: boolean example: false description: Free car rental possibility Child_Price_Reduction: type: object properties: Cd: type: string example: ALOW description: Child price reduction code TEXT: type: string example: 'NULL' description: Additional text information Atol_Mth: type: string example: APP description: ATOL method ValHolidayResponseBkg_Ent: type: object properties: Amend_Mth: type: string description: Amendment method example: ALL Accom: $ref: '#/components/schemas/ValHolidayResponseAccommodation' Package: $ref: '#/components/schemas/ValHolidayResponsePackage' Item: type: array items: $ref: '#/components/schemas/ValHolidayResponseItem_Element' Flt_Extra_Cat_List: $ref: '#/components/schemas/Flt_Extra_Cat_List' CurISO: type: string description: Currency ISO code example: GBP Fast_Seller: type: string description: Fast seller indicator example: S Acc_Prc_Zero_Fg: type: boolean description: Accommodation price zero flag example: false Acc_Cost_Zero_Fg: type: boolean description: Accommodation cost zero flag example: false Atol_Prot_Tp: type: string description: ATOL protection type example: PKG Atol_Prot_By: type: string description: ATOL protection by example: TO Atol_Prot_Issuer: type: string description: ATOL protection issuer example: TO Summary_Prices: $ref: '#/components/schemas/Summary_Prices' ValHolidayResponseAdm: type: object properties: Debug: type: boolean example: false IncludeDetailedPerfStats: type: boolean example: false Xsd_Ver: type: string example: T3.22.20.1 ReqId: type: string example: node1-6eaY7EbD Tm: type: string format: date-time example: '2025-05-01T14:02:04.070882+01:00' Trk: type: object properties: From: type: string example: atcomres To: type: string example: phoenix TEXT: type: string example: 'NULL' Pax: type: array description: List of passengers in the booking items: $ref: '#/components/schemas/Pax_Element' Memo: type: array description: Memo information items: type: object properties: Memo_Dt: type: string format: date-time description: Memo date and time example: '2025-04-29T10:45:21+01:00' Memo_Cd: type: string description: Memo code example: ERR Memo_Name: type: string description: Memo name example: Geography Errata Memo_Des: type: string description: Memo description (may contain HTML) example:

For access to up-to-date travel advice, see Travel Aware – Staying Safe and Healthy Abroad.
Memo_User_Name: type: string description: Username of memo creator example: MCUSER Memo_Key: type: integer description: Memo key/ID example: 1 Memo_Rights: type: string description: Memo access rights example: READ SubServicePassenger: type: object required: - Pax_Id properties: Pax_Id: type: string description: Passenger identifier example: '1' ValHolidayRequestFlight_DateTime: type: object required: - Local properties: '#attrs': type: object properties: DirType: type: string description: Direction type enum: - DEPARTURE - ARRIVAL example: DEPARTURE Local: type: string format: date-time description: Local date and time example: '2026-08-04T06:15:00.000+01:00' ValHolidayResponseFlight_DateTime: type: object required: - Local properties: DirType: type: string description: Direction type enum: - DEPARTURE - ARRIVAL example: DEPARTURE Local: type: string format: date-time description: Local date and time example: '2026-08-04T06:15:00.000+01:00' ConfirmHolidayResponse: type: object properties: TILCreateBookingResponse: type: object properties: TUITILResponse: type: object properties: Result: type: object properties: ResponseCode: type: string example: '0000' Description: type: string example: SUCCESS CorrelationID: type: string example: 03e47977-eb73-41e9-97eb-7be3d13eee4a Service_version: type: string example: v3 Xsd_version: type: string example: T3.22.19.1 CreateBookingResponse: type: object properties: Adm: type: object properties: Debug: type: boolean description: Debug flag example: false IncludeDetailedPerfStats: type: boolean description: Flag to include detailed performance statistics example: false Xsd_Ver: type: string description: XSD version example: T3.22.20.1 ReqId: type: string description: Request identifier example: node1-db9HGCGi Tm: type: string format: date-time description: Timestamp example: '2025-04-29T10:45:40.362918+01:00' Trk: type: object properties: From: type: string description: Source system example: atcomres To: type: string description: Target system example: phoenix TEXT: type: string description: Additional text information example: 'NULL' CltInfo: type: object properties: Locale: type: string description: Client locale example: en_EN CltSysContext: type: integer description: Client system context example: 3 Agt_No: type: string description: Agent number example: MARCR TermCode: type: string description: Terminal code example: VTX User_Name: type: string description: Username example: MCUSER Chan: type: integer description: Channel number example: 1100 Channel_Type: type: string description: Channel type example: VRP User_Role: type: string description: User role example: INTERNAL Payment_VTID: type: integer description: Payment VTID example: 99000140 Bkg_Owner_Tp_Mth: type: string description: Booking owner type method example: TO Payment_OrgID: type: string description: Payment organization ID example: ba96ae31Ace67A4004Aa78aAdae2eec844a2 BkgNum: type: object properties: BkgId: type: integer example: 43005201 CurrentVersion: type: integer example: 1 AtcomresBkgVersion: type: integer example: 557769208 DH_Queue_Sts: type: string example: WAIT BkgSts: type: string example: BOOKING ResSts: type: string example: CONFIRMED HasAgt_Notice: type: boolean description: Flag indicating if there are agent notices example: false His: type: object description: Booking history information properties: Bkg_Dt_Tm: type: string format: date-time description: Booking date and time example: '2025-04-29T10:45:20+01:00' Bkg_User: type: string description: User who created the booking example: MCUSER Bkg_Term_Code: type: string description: Terminal code used for booking example: VTX Bkg_Chan: type: integer description: Booking channel example: 1100 Bkg_Ent: type: object properties: Amend_Mth: type: string description: Amendment method example: ALL Package: type: object properties: Accom: type: object properties: Is_Adhoc: type: boolean description: Flag indicating if accommodation is ad-hoc example: false Error: type: boolean description: Error flag example: false Id: type: integer description: Accommodation ID example: 1 St_Dt: type: string format: date description: Start date example: '2026-08-01' End_Dt: type: string format: date HtlPrd: type: object description: Hotel product information properties: Name: type: string description: Hotel product name example: Mediterranean Medley (Explorer) Prom: type: object description: Promotion information properties: Code: type: string description: Promotion code example: BGCR Issue: type: integer description: Issue number example: 1 Name: type: string description: Promotion name example: Marella Cruises Brand: type: string description: Brand code example: S TEXT: type: string description: Additional text information example: 'NULL' Acc_Cd: type: object description: Accommodation code properties: Accom_Id: type: string description: Accommodation ID example: 6311920741/3 TEXT: type: string description: Accommodation code text example: XXXX0028/078 Acc_InvState: type: string description: Accommodation inventory state example: INTERNAL Hotel: type: object description: Hotel information properties: Add: type: object description: Hotel address properties: Name: type: string description: Hotel name example: Mediterranean Medley (Explorer) City: type: string description: City example: Palma Port Region: type: string description: Region example: Majorca CountryISOCode: type: string description: ISO country code example: ES Comm: type: object description: Communication information properties: CommType: type: string description: Communication type example: TYPE_PHONE Sphere: type: string description: Communication sphere example: SPHERE_BUSINESS AreaCode: type: string description: Area code example: 'NULL' Num: type: string description: Phone number example: 01234567890 Loc: type: object description: Location information properties: Loc_Cd: type: string description: Location code example: ESMJPB Loc_Tp: type: string description: Location type example: CITY Loc_Name: type: string description: Location name example: Palma Port Cat_Page: type: object description: Catalog page information properties: Catalog: type: object description: Catalog information properties: Code: type: string description: Catalog code example: GCR Name: type: string description: Catalog name example: Marella Cruises UK NEW TEXT: type: string description: Additional text information example: 'NULL' Cat_Page_No: type: integer description: Catalog page number example: 0 Prc_Cat_Page_No: type: integer description: Price catalog page number example: 0 Ship_Cd: type: string description: Ship code example: XXXX0028 Ship_Name: type: string description: Ship name example: Marella Explorer Corporate_Cd: type: integer description: Corporate code example: 101762 Rm_Cd: type: object description: Room code information properties: Is_Adhoc: type: boolean description: Flag indicating if room is ad-hoc example: false Rm_No: type: integer description: Room number example: 1 Code: type: string description: Room code example: ZI01 Desc: type: string description: Room description example: Decks 4/5 Inside Cabin Fac_List: type: string description: Facility list text example: Decks 4/5, Shower, WC Facility_List: type: object description: Detailed facility list properties: Facility: type: array description: List of facilities items: type: object properties: Code: type: string description: Facility code example: DK5 Name: type: string description: Facility name example: Decks 4/5 TEXT: type: string description: Additional text information example: 'NULL' StopSaleOverridden: type: boolean description: Flag indicating if stop sale is overridden example: false Inf_Inc_Occ: type: boolean description: Flag indicating if infants are included in occupancy example: true Min_Pax: type: integer description: Minimum number of passengers example: 1 Max_Pax: type: integer description: Maximum number of passengers example: 2 Max_Adu: type: integer description: Maximum number of adults example: 2 Max_Chd: type: integer description: Maximum number of children example: 2 Max_Inf: type: integer description: Maximum number of infants example: 1 BB_Cd: type: string description: Board basis code example: AI BB_Name: type: string description: Board basis name example: All Inclusive Alt_BB_Cd: type: string description: Alternative board basis code example: PI Ser_Sts: type: string description: Service status example: FIX SubServPaxs: type: object description: Sub-service passengers information properties: SubServPax: type: array description: List of sub-service passengers items: type: object properties: Pax_Id: type: integer description: Passenger ID example: 1 Pax_Tp: type: string description: Passenger type example: ADULT Pax_Srv_Prc_Ex: type: object description: Passenger service price excluding taxes properties: CurISO: type: string description: Currency ISO code example: GBP TEXT: type: number format: float description: Price amount example: 1724.16 Prices: type: object description: Price information properties: Price: type: array description: List of prices items: type: object properties: Prc_Cd: type: string description: Price code example: AA Prc_Cd_Name: type: string description: Price code name example: Adult Package Price Prc_Cd_Tp: type: string description: Price code type example: ACRMAD Qty: type: integer description: Quantity example: 2 Prc: type: object description: Price information properties: CurISO: type: string description: Currency ISO code example: GBP TEXT: type: number format: float description: Price amount example: 1796.0 Prc_Dt: type: string format: date-time description: Price date example: '2025-04-29T10:45:20+01:00' PricePaxs: type: object description: Price passengers information properties: Pax_Id: type: array description: List of passenger IDs items: type: integer example: 1 Visible: type: boolean description: Visibility flag example: true Prc_Sts: type: string description: Price status example: STK No_Free_Chd: type: integer description: Number of free children example: 0 Memo: type: array description: Memo information items: type: object properties: Memo_Dt: type: string format: date-time description: Memo date and time example: '2025-04-29T10:45:21+01:00' Memo_Cd: type: string description: Memo code example: ERR Memo_Name: type: string description: Memo name example: Geography Errata Memo_Des: type: string description: Memo description (may contain HTML) example:

For access to up-to-date travel advice, see Travel Aware – Staying Safe and Healthy Abroad.
Memo_User_Name: type: string description: Username of memo creator example: MCUSER Memo_Key: type: integer description: Memo key/ID example: 1 Memo_Rights: type: string description: Memo access rights example: READ Transfer_Info: type: array description: Transfer information items: type: object properties: Dir: type: string description: Transfer direction (inbound/outbound) enum: - inbound - outbound example: inbound Transfer_Code: type: string description: Transfer code example: TFR Desc: type: string description: Transfer description example: Coach Transfer Included Ref_Prd_Id: type: integer description: Reference product ID example: 2 Free_Car_Rental_Poss: type: boolean description: Flag indicating if free car rental is possible example: false Child_Price_Reduction: type: object description: Child price reduction information properties: Cd: type: string description: Child price reduction code example: ALOW TEXT: type: string description: Additional text information example: 'NULL' Atol_Mth: type: string description: ATOL (Air Travel Organiser's Licence) method example: APP Route_List: type: object description: Route list information properties: Routing: type: object description: Routing information properties: Routing_Type: type: string description: Routing type example: OW Routing_Id: type: integer description: Routing ID example: 2 Route: type: array description: List of routes items: type: object properties: Rt_Dir: type: string description: Route direction enum: - outbound - inbound example: outbound Is_Adhoc: type: boolean description: Flag indicating if route is ad-hoc example: false Error: type: boolean description: Error flag example: false Route_Id: type: integer description: Route ID example: 2 RouteCd: type: string description: Route code example: PMILGW6CLGWPMI Flt_Inv_Id: type: object description: Flight inventory ID properties: Box_Id: type: integer description: Box ID example: 6726296 TEXT: type: integer description: Flight inventory ID text example: 6194160332 Rt_InvState: type: string description: Route inventory state example: INTERNAL Dep_Air_Cd: type: string description: Departure airport code example: LGW Arr_Air_Cd: type: string description: Arrival airport code example: PMI Flt_Dt_Tm: type: array description: Flight date and time information items: type: object properties: DirType: type: string description: Direction type enum: - DEPARTURE - ARRIVAL example: DEPARTURE Local: type: string format: date-time description: Local date and time example: '2026-08-01T06:00:00+01:00' Duration: type: integer description: Duration in days example: 7 Cycle_Dt: type: string format: date description: Cycle date example: '2026-08-01' JnyDur: type: string description: Journey duration (HH:MM) example: 02:15 Prom: type: object description: Promotion information properties: Code: type: string description: Promotion code example: ACPK Issue: type: integer description: Issue number example: 1 Name: type: string description: Promotion name example: Cruise UK Package TEXT: type: string description: Additional text information example: 'NULL' Car_Cd: type: string description: Carrier code example: TOM Flt_No: type: integer description: Flight number example: 4618 Bkg_Cls: type: object description: Booking class properties: Code: type: string description: Booking class code example: Y TEXT: type: string description: Additional text information example: 'NULL' Cab_Cls: type: object description: Cabin class properties: Code: type: string description: Cabin class code example: Y Name: type: string description: Cabin class name example: 'Economy ' TEXT: type: string description: Additional text information example: 'NULL' Flt_Seq_Cd: type: string description: Flight sequence code example: C Sec: type: object description: Sector information properties: Id: type: integer description: Sector ID example: 2 SecId: type: integer description: Sector sequence ID example: 1 Dep_Air_Cd: type: string description: Departure airport code example: LGW Arr_Air_Cd: type: string description: Arrival airport code example: PMI Flt_Dt_Tm: type: array description: Flight date and time information items: type: object properties: DirType: type: string description: Direction type enum: - DEPARTURE - ARRIVAL example: DEPARTURE Local: type: string format: date-time description: Local date and time example: '2026-08-01T06:00:00+01:00' JnyDur: type: string description: Journey duration (HH:MM) example: 02:15 Car_Cd: type: string description: Carrier code example: TOM Flt_No: type: integer description: Flight number example: 4618 Bkg_Cls: type: object description: Booking class properties: Code: type: string description: Booking class code example: Y TEXT: type: string description: Additional text information example: 'NULL' Cab_Cls: type: object description: Cabin class properties: Code: type: string description: Cabin class code example: Y Name: type: string description: Cabin class name example: 'Economy ' TEXT: type: string description: Additional text information example: 'NULL' Eqmt: type: string description: Equipment example: B738-189 EqmtDescription: type: string description: Equipment description example: Boeing 738-189 Seat_Res_Possible: type: string description: Seat reservation possibility enum: - 'YES' - 'NO' example: 'NO' Ser_Sts: type: string description: Service status example: FIX SubServPaxs: type: object description: Sub-service passengers information properties: SubServPax: type: array description: List of sub-service passengers items: type: object properties: Pax_Id: type: integer description: Passenger ID example: 1 Pax_Tp: type: string description: Passenger type example: ADULT Pax_Srv_Prc_Ex: type: object description: Passenger service price excluding taxes properties: CurISO: type: string description: Currency ISO code example: GBP TEXT: type: number Seat_Res_Possible: type: string description: Seat reservation possibility enum: - 'YES' - 'NO' example: 'NO' Check_In: type: object description: Check-in information properties: Dir: type: string description: Check-in direction example: DEPARTURE TEXT: type: string description: Check-in location/terminal example: Main Terminal Atol_Mth: type: string description: ATOL (Air Travel Organiser's Licence) method example: APP SSR_Possible: type: boolean description: Flag indicating if special service requests are possible example: false Online_Chk_In_Mth: type: string description: Online check-in method example: DIS Item: type: object description: Item information properties: Is_Adhoc: type: boolean description: Flag indicating if item is ad-hoc example: false Code: type: string description: Item code example: WCF1/A Name: type: string description: Item name example: TUI Care Foundation Is_Default: type: boolean description: Flag indicating if item is default example: false Auto_Inc: type: boolean description: Flag indicating if item is auto-included example: true Short_Name: type: string description: Item short name example: TUI Care Foundation Error: type: boolean description: Error flag example: false Id: type: integer description: Item ID example: 4 St_Dt: type: string format: date description: Start date example: '2026-08-01' Set_Type: type: string description: Set type example: EXTRA Item_Type: type: object description: Item type information properties: Code: type: string description: Item type code example: WC Item_Type_Desc: type: object description: Item type description properties: Locale: type: string description: Locale example: EN_EN Desc: type: string description: Description example: TUI Care Foundation Prom: type: object description: Promotion information properties: Code: type: string description: Promotion code example: AUCI Issue: type: integer description: Issue number example: 1 Name: type: string description: Promotion name example: TUI UK Common Items Brand: type: string description: Brand code example: 'NULL' TEXT: type: string description: Additional text information example: 'NULL' Bkg_Qty: type: integer description: Booking quantity example: 2 Ser_Sts: type: string description: Service status example: FIX MinPrice: type: string description: Minimum price example: 'NULL' MaxPrice: type: string description: Maximum price example: 'NULL' Price: type: string description: Price example: 'NULL' SubServPaxs: type: object description: Sub-service passengers information properties: SubServPax: type: array description: List of sub-service passengers items: type: object properties: Pax_Id: type: integer description: Passenger ID example: 1 Pax_Tp: type: string description: Passenger type example: ADULT Pax_Srv_Prc_Ex: type: object description: Passenger service price excluding taxes properties: CurISO: type: string description: Currency ISO code example: GBP TEXT: type: number format: float description: Price amount example: 1.0 Prices: type: object description: Price information properties: Price: type: object description: Price details properties: Prc_Cd: type: string description: Price code example: EWC Prc_Cd_Name: type: string description: Price code name example: TUI Care Foundation Prc_Cd_Tp: type: string description: Price code type example: WCFND Qty: type: integer description: Quantity example: 2 Prc: type: object description: Price information properties: CurISO: type: string description: Currency ISO code example: GBP TEXT: type: number format: float description: Price amount example: 1.0 Prc_Dt: type: string format: date-time description: Price date example: '2025-04-29T10:45:20+01:00' PricePaxs: type: object description: Price passengers information properties: Pax_Id: type: array description: List of passenger IDs items: type: integer example: 1 Visible: type: boolean description: Visibility flag example: true Prc_Sts: type: string description: Price status example: STK Ref_Prd_Id: type: integer description: Reference product ID example: 1 Rate_Rule: type: string description: Rate rule example: DAY Item_Method: type: string description: Item method example: PP Atol_Mth: type: string description: ATOL method example: APP Corporate_Cd: type: string description: Corporate code example: L33008 Flt_Extra_Cat_List: type: array description: Flight extra category list items: type: object properties: Flt_Inv_Id: type: integer description: Flight inventory ID example: 6194160332 Flt_Extra_Cat: type: object description: Flight extra category information properties: Code: type: string description: Category code example: BAG Name: type: string description: Category name example: Baggage Method: type: string description: Category method example: BAG Flt_Extra: type: object description: Flight extra information properties: Code: type: string description: Extra code example: BAG Name: type: string description: Extra name example: Baggage Allowance Error: type: boolean description: Error flag example: false AllowComment: type: boolean description: Flag indicating if comments are allowed example: false Class: type: string description: Class example: Y Baggage: type: object description: Baggage information properties: Weight: type: object description: Weight information properties: Cd: type: integer description: Weight code/value in kg example: 20 Piece: type: object description: Piece information properties: Cd: type: integer description: Piece code/count example: 1 TEXT: type: integer description: Additional piece information example: 0 SubServPaxs: type: object description: Sub-service passengers information properties: SubServPax: type: array description: List of sub-service passengers items: type: object properties: Pax_Id: type: integer description: Passenger ID example: 1 Pax_Tp: type: string description: Passenger type example: ADULT Pax_Srv_Prc_Ex: type: object description: Passenger service price excluding taxes properties: CurISO: type: string description: Currency ISO code example: GBP TEXT: type: number format: float description: Price amount example: 0.0 Atol_Mth: type: string description: ATOL method example: NONE Corporate_Cd: type: string description: Corporate code example: L31422 CurISO: type: string description: Currency ISO code example: GBP Fast_Seller: type: string description: Fast seller indicator example: S Acc_Prc_Zero_Fg: type: boolean description: Flag indicating if accommodation price is zero example: false Acc_Cost_Zero_Fg: type: boolean description: Flag indicating if accommodation cost is zero example: false Atol_Prot_Tp: type: string description: ATOL protection type example: PKG Atol_Prot_By: type: string description: ATOL protection provider example: TO Atol_Prot_Issuer: type: string description: ATOL protection issuer example: TO Summary_Prices: type: object description: Summary of prices properties: Summary_Price: type: array description: List of summary prices items: type: object properties: Prc_Tp_Cd: type: string description: Price type code example: ACRMAD Prc_Tp_Name: type: string description: Price type name example: Adult Package Price Qty: type: integer description: Quantity example: 2 Prc: type: number format: float description: Price amount example: 1796.0 Agt_No: type: string description: Agent number example: MARCR CusDet: type: object description: Customer details information properties: New_Cus: type: boolean description: Flag indicating if this is a new customer example: false Person: type: object description: Person information properties: Add: type: object description: Address information properties: Name: type: string description: Name or company name example: T U I Wigmore House, Street: type: string description: Street address example: Wigmore Lane ZipCode: type: string description: Postal/ZIP code example: LU2 9TN City: type: string description: City name example: LUTON CountryISOCode: type: string description: ISO country code example: GB Comm: type: object description: Communication information properties: CommType: type: string description: Communication type example: TYPE_MOBILE Sphere: type: string description: Communication sphere (private/business) example: SPHERE_PRIVATE AreaCode: type: string description: Area code example: 'NULL' Num: type: string description: Phone number example: 07555889000 Email: type: object description: Email information properties: Address: type: string format: email description: Email address example: sudharshan.mb@tui.co.uk Sphere: type: string description: Email sphere (private/business) example: SPHERE_PRIVATE Marketing: type: object description: Marketing preferences properties: Mailshot: type: boolean description: Consent for mail marketing example: true Tel: type: boolean description: Consent for telephone marketing example: true By_Email: type: boolean description: Consent for email marketing example: true By_SMS: type: boolean description: Consent for SMS marketing example: true TrvDox: type: object description: Travel documents information properties: DocumentReceiver: type: string description: Entity that receives the documents (e.g., PAYER, AGENCY) example: PAYER DoxLang: type: string description: Document language example: en_EN Next_Travel_Dox_Prt_Dt: type: string format: date-time description: Next travel document print date example: '2026-07-04T23:59:59+01:00' ConfPrt: type: boolean description: Confirmation printed flag example: false Travel_Dox_Stop: type: boolean description: Flag to stop travel document generation example: false Conf_Stop: type: boolean description: Flag to stop confirmation generation example: false Travel_Dox_No_Price: type: boolean description: Flag to exclude prices from travel documents example: false Travel_Dox_Per_Person: type: boolean description: Flag to generate per-person travel documents example: false Print_Voucher_Immed: type: boolean description: Flag to print vouchers immediately example: false PayData: type: object description: Payment data information properties: Dpt: type: array description: Deposit information items: type: object properties: Type: type: string description: Deposit type (LOW/HIGH) example: LOW CurISO: type: string description: Currency ISO code example: GBP Amt: type: number format: float description: Deposit amount example: 250.0 Dep_Dt: type: string format: date description: Deposit date example: '2025-04-29' Bkg_Prc_Ex: type: object description: Booking price excluding taxes/fees properties: CurISO: type: string description: Currency ISO code example: GBP Amt: type: number format: float description: Amount example: 3450.32 Bkg_Prc_Inc: type: object description: Booking price including taxes/fees properties: CurISO: type: string description: Currency ISO code example: GBP Amt: type: number format: float description: Total amount example: 3450.32 Bal_Due_Amt: type: number format: float description: Balance due amount example: 3450.32 Bal_Due_Dt: type: string format: date description: Balance due date example: '2026-05-09' Tot_Amt: type: number format: float description: Total amount example: 3450.32 Agt_Com: type: number format: float description: Agent commission example: 0.0 Comm_Inc_VAT: type: number format: float description: Commission including VAT example: 0.0 VAT: type: number format: float description: VAT amount example: 0.0 Payment_Received: type: number format: float description: Payment received amount example: 0.0 Tot_Refund_Amt: type: number format: float description: Total refund amount example: 0.0 Tot_Dpt: type: number format: float description: Total deposit amount example: 600.0 Pax: type: array description: Passenger information items: type: object properties: Age: type: integer description: Passenger age example: 30 Index: type: integer description: Passenger index/position example: 1 Person: type: object description: Person details properties: FirstName: type: string description: First name example: TEST LastName: type: string description: Last name example: PASSENGER Title: type: string description: Title (Mr, Mrs, Ms, etc.) example: Mr Sex: type: string description: Gender enum: - SEX_MALE - SEX_FEMALE example: SEX_MALE PersonType: type: string description: Person type enum: - TYPE_NATURAL - TYPE_LEGAL example: TYPE_NATURAL Pax_Tp: type: string description: Passenger type enum: - ADULT - CHILD - INFANT example: ADULT Lead_Pax: type: boolean description: Flag indicating if this is the lead passenger example: true DD_Marketing_Sts: type: string description: Direct debit marketing status example: V0 Prom: type: object description: Promotion information properties: Code: type: string description: Promotion code example: BGCR Issue: type: integer description: Issue number example: 1 Name: type: string description: Promotion name example: Marella Cruises Prom_Group_Code: type: string description: Promotion group code example: CRMP Brand: type: string description: Brand code example: S TEXT: type: string description: Additional text information example: 'NULL' Source: type: object description: Booking source information properties: Cd: type: string description: Source code example: AGEN Name: type: string description: Source name example: Shop Booking TEXT: type: string description: Additional text information example: 'NULL' Sub_Source: type: object description: Booking sub-source information properties: Cd: type: string description: Sub-source code example: ZWEB Name: type: string description: Sub-source name example: Web Booking TEXT: type: string description: Additional text information example: 'NULL' Incident_Sts: type: string description: Incident status example: NA Insurance_Method: type: string description: Insurance method example: EXT Retail_Bkg_Id: type: integer description: Retail booking ID example: -1 Ext_Pay_Ref: type: string description: External payment reference example: 430 05201 Bkg_Type_Mth: type: string description: Booking type method example: RET Credited_User: type: object description: Credited user information properties: Code: type: string description: User code example: MCUSER Name: type: string description: User name example: Marella Cruises (Sys Default) TEXT: type: string description: Additional text information example: 'NULL' Market: type: object description: Market information properties: Code: type: string description: Market code example: BCTH TEXT: type: string description: Market description example: B2C TUI UK (£) Agent_Group: type: object description: Agent group information properties: Code: type: string description: Agent group code example: MARELLA Name: type: string description: Agent group name example: Marella Websites TEXT: type: string description: Additional text information example: 'NULL' ValHolidayRequestHotelProduct: type: object required: - Name - Acc_Cd properties: Name: type: string description: Name of the accommodation example: Ship Prom: $ref: '#/components/schemas/Prom' Acc_Cd: type: string description: Accommodation code example: XXXX0013/025 RoomCode: type: object required: - Rm_No - Code - BB_Cd properties: Rm_No: type: string description: Room number example: '1' Code: type: string description: Room code example: MC BB_Cd: type: string description: Board basis code example: AB SubServPaxs: $ref: '#/components/schemas/SubServicePassengers' ValidateHolidayResponse: type: object required: - TILInfoBookingResponse properties: TILInfoBookingResponse: $ref: '#/components/schemas/TILInfoBookingResponse' ValHolidayRequestRoute_List: type: object required: - Routing properties: Routing: $ref: '#/components/schemas/ValHolidayRequestRouting' ConfirmHolidayRequest: type: object properties: CreateBookingRequest: type: object required: - Adm - CusDet properties: Adm: type: object required: - SessId - ReqId properties: SessId: type: string description: Session identifier example: 497dcaf8-e113-454b-902c-5dc924c51b1f@0 ReqId: type: string description: Request identifier example: node1-db9HGCGi CusDet: type: object required: - Person - TrvDox properties: Person: type: object properties: Add: type: object properties: Name: type: string example: T U I Wigmore House, Street: type: string example: Wigmore Lane ZipCode: type: string example: LU2 9TN City: type: string example: LUTON CountryISOCode: type: string example: GB Comm: type: object properties: CommType: type: string example: TYPE_MOBILE Sphere: type: string example: SPHERE_PRIVATE AreaCode: type: string example: '' Num: type: string example: 07555889000 Email: type: object properties: Address: type: string format: email example: sudharshan.mb@tui.co.uk Sphere: type: string example: SPHERE_PRIVATE Marketing: type: object properties: Mailshot: type: string example: 'true' Tel: type: string example: 'true' By_Email: type: string example: 'true' By_SMS: type: string example: 'true' TrvDox: type: object properties: DocumentReceiver: type: string example: AGENCY DoxLang: type: string example: en_EN ValHolidayRequestMultiCentreProduct: type: object required: - mcCode properties: MC_Code: type: string description: Multi-center product code example: ESMJ0466 Prom: $ref: '#/components/schemas/Prom' Itin_Cd: type: string description: Itinerary code example: '6339173891' ValHolidayResponseMultiCentreProduct: type: object required: - mcCode properties: MC_Code: type: string description: Multi-center product code example: ESMJ0466 Prom: $ref: '#/components/schemas/ValHolidayResponseProm' Itin_Cd: type: string description: Itinerary code example: '6339173891' Itin_Name: type: string example: Marella Discovery 2 Cruise & Stay PMI 14 description: Itinerary name Corporate_Cd: type: integer example: 101752 description: Corporate code ValHolidayResponseMultiCentre: type: object required: - id - stDt - endDt - mcPrd - rmCd properties: Is_Adhoc: type: boolean example: false description: Indicates if this is an ad-hoc item Error: type: boolean example: false description: Indicates if there is an error with this item Id: type: string description: Multi-center identifier example: '1' St_Dt: type: string format: date description: Start date example: '2026-08-04' End_Dt: type: string format: date description: End date example: '2026-08-18' Memo: $ref: '#/components/schemas/Memo' Transfer_Info: $ref: '#/components/schemas/Transfer_Info' MC_Prd: $ref: '#/components/schemas/ValHolidayResponseMultiCentreProduct' Rm_Cd: $ref: '#/components/schemas/ValHolidayResponseRoomCode' Offer_Choice: type: array description: List of accommodation offers items: $ref: '#/components/schemas/ValHolidayResponseOfferChoice' EmdTypeCode: type: integer description: "Represents the EMD type code options.\n \n\n0 = None\n1 = Associated\n2 = StandAlone" x-enumNames: - None - Associated - StandAlone enum: - 0 - 1 - 2 CheckinDocumentRequirements: type: object description: "Defines a passenger checkin document requirements.\n " deprecated: true x-deprecatedMessage: Obsolete as of 4.4.4, please use the v2. additionalProperties: false properties: isValid: type: boolean description: "Flag indicating if the checkin document requirements are all meet and ready/valid for checkin.\n " documentsOnFile: type: - array - 'null' description: "The collection of document type codes that already exist on the passenger.\n " items: type: string unhandledDocuments: type: - array - 'null' description: "The collection of unhandled documents at each acting government entity.\n " items: $ref: '#/components/schemas/GovernmentPassengerDocumentRequirement' documentVerificationRequired: type: boolean description: "Boolean to confirm documents need to be verified.\n***Note***\nIf it is TRUE, document verification is required.\nIf it is FALSE, it could be\n1) No document verification is required, or\n2) The given Travel Documents Type and Count matches the government program driver requirements, BUT this\ndoes not ensure that all government security document requirements have been met.\n " QueueMode: type: integer description: "Determines where a queue request is coming from.\n \n\n0 = EnQueued\n1 = DeQueued" x-enumNames: - EnQueued - DeQueued enum: - 0 - 1 AccountCollectionRequest: type: object description: "The account collection request model.\n " additionalProperties: false required: - amount - currencyCode properties: amount: type: number description: "The credit account transaction amount.\n " format: decimal currencyCode: type: string description: "The credit account transaction currency code.\n " maxLength: 3 minLength: 0 note: type: - string - 'null' description: "The credit account transaction note.\n " maxLength: 128 minLength: 0 transactionCode: type: - string - 'null' description: "The transaction code.\n " maxLength: 6 minLength: 0 expiration: type: - string - 'null' description: "The account collection expiration.\n " format: date-time PaymentAttachment: type: object description: "Defines a payment attachment.\n " additionalProperties: false properties: id: type: integer description: "The attachment ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 paymentId: type: integer description: "The payment ID attached to.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 attachment: type: - string - 'null' description: "The attachment data.\n " format: byte PagedTransactionResponse: type: object description: "The paged transaction response.\n " additionalProperties: false properties: totalCount: type: integer description: "The total count of transactions.\n " format: int32 lastPageKey: type: - string - 'null' description: "The last page key.\n " transactions: type: - array - 'null' description: "The collection of transactions.\n " items: $ref: '#/components/schemas/Transaction' GovernmentDocumentRequirement: type: object description: "Defines a certain document requirement regarding a specific government instance.\n " additionalProperties: false properties: group: description: "The document group.\n " $ref: '#/components/schemas/DocumentGroup' documentTypeCode: type: - string - 'null' description: "The documents type code.\n " PassengerProgram: type: object description: "Model representing a passenger program.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The program code.\n " maxLength: 3 minLength: 0 pattern: ^[^|]*$ levelCode: type: - string - 'null' description: "The program level code.\n " maxLength: 3 minLength: 0 pattern: ^[^|]*$ number: type: - string - 'null' description: "The program number.\n " maxLength: 32 minLength: 0 Passenger: type: object description: "Model information representing a passenger on a journey.\n " additionalProperties: false required: - passengerTypeCode properties: customerNumber: type: - string - 'null' description: "The passenger customer number.\n " maxLength: 20 minLength: 0 name: description: "The passenger's name.\n " $ref: '#/components/schemas/Name' discountCode: type: - string - 'null' description: "The discount code associated with the passenger type.\n " maxLength: 8 minLength: 0 program: description: "The passenger programs.\n " $ref: '#/components/schemas/PassengerProgram' info: description: "Additional passenger information.\n " $ref: '#/components/schemas/PassengerInformation' passengerKey: type: - string - 'null' description: "The unique passenger identifier key.\n " passengerAlternateKey: type: - string - 'null' description: "The passenger alternate key is used to identify a passenger post commit of the booking.\n " fees: type: - array - 'null' description: "Fees.\n " items: $ref: '#/components/schemas/PassengerFee' passengerTypeCode: type: string description: "The passenger type code.\n " minLength: 1 bags: type: - array - 'null' description: "Passenger bags.\n " items: $ref: '#/components/schemas/PassengerBag' infant: description: "The optional infant associated with this passenger.\n " $ref: '#/components/schemas/PassengerInfant' travelDocuments: type: - array - 'null' description: "The collection of passenger travel Documents.\n " items: $ref: '#/components/schemas/PassengerTravelDocument' addresses: type: - array - 'null' description: "The collection of passenger addresses.\n " items: $ref: '#/components/schemas/PassengerAddress' weightCategory: description: "The weight category assigned to this passenger.\n " $ref: '#/components/schemas/WeightCategory' emdCoupons: type: - array - 'null' description: "The passenger EMD coupons.\n " items: $ref: '#/components/schemas/PassengerEmdCoupon' AuthenticationStatus: type: integer description: "Defines the different possible payment authentication statuses for 3DS.\n \n\n0 = Unknown\n1 = AuthenticationSuccessful\n2 = AuthenticationFailed\n3 = AuthenticationCouldNotBePerformed\n4 = AuthenticationAttemptProcessing\n5 = AuthenticationRejected" x-enumNames: - Unknown - AuthenticationSuccessful - AuthenticationFailed - AuthenticationCouldNotBePerformed - AuthenticationAttemptProcessing - AuthenticationRejected enum: - 0 - 1 - 2 - 3 - 4 - 5 BookingOrder: type: object description: "Represents a booking order.\n " additionalProperties: false properties: bookingOrderKey: type: - string - 'null' description: "The unique identifier.\n " orderId: type: string description: "The unique identifier related to a travel commerce order.\nFor use with TC API.\n " format: guid collect: type: number description: "Total amount of the order that is to be collected directly by NewSkies.\n " format: decimal thirdPartyCharge: type: number description: "Total amount of the order that will be charged immediately by a third party.\nFor example, the amount that is charged when an add-on is booked.\n " format: decimal thirdPartyHold: type: number description: "Total amount of the order that will be charged at the time of the service by a third party.\nFor example, the amount that is charged when a car is picked up.\n " format: decimal total: type: number description: "Total face value of the order, including non-chargeable amounts.\n " format: decimal status: description: "The overall status of the order from a NewSkies perspective, indicating\ninformation such as if the order has been finalized in Travel Commerce.\n " $ref: '#/components/schemas/BookingOrderStatus' DocumentCheckStatus: type: integer description: "Represents the status of a document after performing a third party document check.\nMore detailed information is intentionally not provided for security reasons.\n \n\n0 = None\n1 = Ok\n2 = Conditional\n3 = NotOk" x-enumNames: - None - Ok - Conditional - NotOk enum: - 0 - 1 - 2 - 3 StatelessChangeReasonCodes: type: integer description: "Specifies the change reason code for a stateless booking.\n \n\n0 = Irop\n1 = ScheduleChange\n2 = Move\n3 = VoluntaryFlyAhead\n4 = InvoluntaryFlyAhead" x-enumNames: - Irop - ScheduleChange - Move - VoluntaryFlyAhead - InvoluntaryFlyAhead enum: - 0 - 1 - 2 - 3 - 4 OrderFeeType: type: integer description: "Defines the travel commerce fee types.\n \n\n0 = Default\n1 = Tax\n2 = Markup\n3 = Discount" x-enumNames: - Default - Tax - Markup - Discount enum: - 0 - 1 - 2 - 3 CheckinRequirementsv2: type: object description: "Defines the pre checkin requirements.\n " additionalProperties: false properties: passengers: type: - object - 'null' description: "The collection of passengers and there requirements to checkin.\nKey is the PassengerKey.\n " additionalProperties: $ref: '#/components/schemas/CheckinPassengerRequirementsv2' governmentProgramRequirements: type: - object - 'null' description: "The collection of government programs requirements.\nKey is the Government Driver Instance Name, e.g. 'USDHS', 'CBSA', 'KRKIS', 'APPS', etc.\n " additionalProperties: $ref: '#/components/schemas/GovernmentProgramRequirements' restrictions: type: - array - 'null' description: "The list of any non passenger related checkin restrictions that will restrict the desired segments to be checked\nin.\nThe checkin restriction type = ('Closed', 'NotOpened', 'PnrLocked', 'MarketingCodeShareNotAllowed',\n'NotPaidInFull', 'PaymentsPending',\n'PaymentsPendingCustomerAction', 'RestrictedOnAnotherSystem', 'NotAllowed', 'ApisNotAllowed', 'AppsNotAllowed',\n'SegmentNotFound', 'InvalidPrice').\n " items: $ref: '#/components/schemas/CheckinRestrictionType' isValid: type: boolean description: "Flag indicating if the ability to checkin is valid.\n " GssStayType: type: integer description: "The type of stay type.\n \n\n0 = None\n1 = Vacation\n2 = Business\n3 = Duty" x-enumNames: - None - Vacation - Business - Duty enum: - 0 - 1 - 2 - 3 AmountDue: type: object description: "Defines the amounts due for an order.\n " additionalProperties: false properties: preTax: type: - number - 'null' description: "The pre tax total.\n " format: decimal tax: type: - number - 'null' description: "The tax total.\n " format: decimal total: type: - number - 'null' description: "The total.\n " format: decimal SsrsStatelessRequest: type: object description: "Ssrs by type model allows multiple Ssr requests for a specific type.\n " additionalProperties: false required: - market properties: market: description: "Market for the segment.\n " $ref: '#/components/schemas/MarketInformation' items: type: - array - 'null' description: "SSR request items.\n " items: $ref: '#/components/schemas/SsrRequestByPassengerType' AddOnOrderSummary: type: object description: "Defines the details about an order if the order is not available.\n " additionalProperties: false properties: total: type: number description: "The total price of the order.\n " format: decimal held: type: number description: "The total held amount of the order.\n " format: decimal charged: type: number description: "The total charged amount of the order.\n " format: decimal supplierCode: type: - string - 'null' description: "The order's supplier code.\n " beginDate: type: string description: "The order's begin date.\n " format: date-time beginLocation: type: - string - 'null' description: "The order's begin location code.\n " endDate: type: string description: "The order's end date.\n " format: date-time endLocation: type: - string - 'null' description: "The order's end location code.\n " externalReference: type: - string - 'null' description: "The order's supplier external reference (record locator).\n " description: type: - string - 'null' description: "The order's description.\n " externalConfirmationNumber: type: - string - 'null' description: "The order's supplier external confirmation number.\n " PassengerPriceBreakdown: type: object description: "Defines the individual passenger-level pricing breakdown.\n " additionalProperties: false properties: services: description: "The charge breakdown of the service fees.\n " $ref: '#/components/schemas/ChargeBreakdown' specialServices: description: "The charge breakdown of the special service requests.\n " $ref: '#/components/schemas/ChargeBreakdown' seats: description: "The charge breakdown of seat fees.\n " $ref: '#/components/schemas/ChargeBreakdown' upgrades: description: "The charge breakdown of upgrade fees.\n " $ref: '#/components/schemas/ChargeBreakdown' spoilage: description: "The charge breakdown of spoilage fees.\n " $ref: '#/components/schemas/ChargeBreakdown' nameChanges: description: "The charge breakdown of name change fees.\n " $ref: '#/components/schemas/ChargeBreakdown' convenience: description: "The charge breakdown of convenience fees.\n " $ref: '#/components/schemas/ChargeBreakdown' infant: description: "The charge breakdown of infant fees.\n " $ref: '#/components/schemas/ChargeBreakdown' totalCost: type: - number - 'null' description: "The total cost for the passenger.\nThese values are only populated by NewSkies after a booking commit\n " format: decimal passengerKey: type: - string - 'null' description: "The unique passenger number.\n " Fare: type: object description: "Model describing a fare.\n " additionalProperties: false properties: carrierCode: type: - string - 'null' description: "The fares carrier code.\n " maxLength: 3 minLength: 2 classOfService: type: - string - 'null' description: "The class of service.\n " maxLength: 8 minLength: 0 fareApplicationType: description: "The type of the fare application.\n " $ref: '#/components/schemas/FareApplicationType' fareBasisCode: type: - string - 'null' description: "The fare basis code.\n " maxLength: 8 minLength: 0 inboundOutBound: description: "The inbound and outbound.\n " $ref: '#/components/schemas/InboundOutbound' isAllotmentMarketFare: type: boolean description: "Gets or sets a value indicating whether this fare is an allotment marker.\n " ruleNumber: type: - string - 'null' description: "The rule number.\n " maxLength: 4 minLength: 0 ruleTariff: type: - string - 'null' description: "The rule tariff.\n " maxLength: 4 minLength: 0 pricingDate: type: string description: "The pricing date.\n " format: date-time fareDesignator: description: "The fare designator.\n " $ref: '#/components/schemas/FareDesignator' isGoverning: type: boolean description: "Flag that indicates if the fare is the governing fare.\n " fareKey: type: - string - 'null' description: "Unique key for this type of fare.\n " classType: type: - string - 'null' description: "The fares type of the class.\n " fareClassOfService: type: - string - 'null' description: "The fare class of service.\n " maxLength: 8 minLength: 0 fareSequence: type: integer description: "The fare sequence.\n " maximum: 32767.0 minimum: 0.0 fareStatus: description: "The fare status.\n " $ref: '#/components/schemas/FareStatus' originalClassOfService: type: - string - 'null' description: "The original class of service.\n " maxLength: 8 minLength: 0 productClass: type: - string - 'null' description: "The product class.\n " maxLength: 2 minLength: 0 travelClassCode: type: - string - 'null' description: "The travel class code.\nPlease note that this should be a char and not a string.\n " maxLength: 1 crossReferenceClassOfService: type: - string - 'null' description: "The cross reference class of service.\n " maxLength: 8 minLength: 0 passengerFares: type: - array - 'null' description: "The collection of passenger fares.\n " items: $ref: '#/components/schemas/PassengerFare' fareLink: type: integer description: "The fare link.\n " maximum: 32767.0 minimum: 0.0 SegmentChangeHistoryResponse: type: object description: "Defines a segment change history response.\n " additionalProperties: false properties: pageKey: type: - string - 'null' description: "The key of the last item in the history list.\n " histories: type: - array - 'null' description: "The segment change history list.\n " items: $ref: '#/components/schemas/SegmentChangeHistory' SeatPreference: type: object description: "Represents a single seat preference.\n " additionalProperties: false required: - seatMapCode - value properties: seatMapCode: type: string description: "The seat map code (ex. 'SMOKING').\n " maxLength: 8 minLength: 0 value: type: string description: "The seat map value (ex. 'TRUE').\n " maxLength: 8 minLength: 0 status: description: "Defines if the seat preference is met, not met or unknown.\n " $ref: '#/components/schemas/SeatPreferenceStatus' InputedParameter: type: object description: "Defines a parameter with data input.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The unique code for a supplier parameter.\n " description: type: - string - 'null' description: "The description.\n " value: type: - string - 'null' description: "The parameters value.\n " HistoryCategory: type: integer description: "Represents the various history report types.\n \n\n0 = Unknown\n1 = Baggage\n2 = BagTagPrint\n3 = BoardingPassPrint\n4 = CheckIn\n5 = ClassOfServiceChange\n6 = Comment\n7 = ConfirmedSegment\n8 = ContactChange\n9 = Converted\n10 = CouponOverride\n11 = DividePnr\n12 = FareOverride\n13 = Fee\n14 = FlightMove\n15 = GroupNameChange\n16 = Hold\n17 = ItinerarySent\n18 = ManualPayment\n19 = MoveBackPnr\n20 = NameChange\n21 = NameRemove\n22 = Payment\n23 = Pds\n24 = Promotion\n25 = QueuePlaceRemove\n26 = RecordLocator\n27 = ScheduleCancelllation\n28 = ScheduleCodeShareChange\n29 = ScheduleFlightDesignatorChange\n30 = ScheduleTimeChange\n31 = SeatAssignment\n32 = SegmentChange\n33 = Reprice\n34 = SsrChange\n35 = StandByChange\n36 = TicketNumber\n37 = VerifiedTravelDocument\n38 = Apps\n39 = InhibitedOverride\n40 = CustomIdChange\n41 = HoldDateChange\n42 = AddedTravelDocument\n43 = ChangedTravelDocument\n44 = ChangedPayment" x-enumNames: - Unknown - Baggage - BagTagPrint - BoardingPassPrint - CheckIn - ClassOfServiceChange - Comment - ConfirmedSegment - ContactChange - Converted - CouponOverride - DividePnr - FareOverride - Fee - FlightMove - GroupNameChange - Hold - ItinerarySent - ManualPayment - MoveBackPnr - NameChange - NameRemove - Payment - Pds - Promotion - QueuePlaceRemove - RecordLocator - ScheduleCancelllation - ScheduleCodeShareChange - ScheduleFlightDesignatorChange - ScheduleTimeChange - SeatAssignment - SegmentChange - Reprice - SsrChange - StandByChange - TicketNumber - VerifiedTravelDocument - Apps - InhibitedOverride - CustomIdChange - HoldDateChange - AddedTravelDocument - ChangedTravelDocument - ChangedPayment enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 SegmentChangeEvent: type: integer description: "Represents the different events that trigger an entry into the segment change history.\n \n\n6 = AddedFlight\n7 = DeletedFlight" x-enumNames: - AddedFlight - DeletedFlight enum: - 6 - 7 DeleteUnitStatelessConfig: type: object description: "Unit delete config defines the different configurations when removing stateless units.\n " additionalProperties: false properties: ignoreSeatSsrs: type: - boolean - 'null' description: "Flag indicating whether to ignore seat SSR's.\n " SsrDesignatorRequest: type: object description: "SSR request for a Ssr designator request.\n " additionalProperties: false required: - ssrCode properties: ssrCode: type: string description: "The Ssr code.\n " minLength: 1 count: type: - integer - 'null' description: "The number of items to include. Defaults to 1.\n " maximum: 32767.0 minimum: 1.0 designator: description: "The designator if different than the segment. This will only be passed to select a unique leg on flights with\nmultiple legs.\n " $ref: '#/components/schemas/MarketDesignator' BookingMessageHistory: type: object description: "Defines a booking message history log entry.\n " additionalProperties: false properties: type: description: "The message history type.\n " $ref: '#/components/schemas/BookingMessageHistoryType' message: type: - string - 'null' description: "The message.\n " createdDate: type: string description: "The created date.\n " format: date-time PassengerVoucherCustomerProgram: type: object description: "Defines the passenger voucher customer program.\n " additionalProperties: false properties: programCode: type: - string - 'null' description: "The program code.\n " programNumber: type: - string - 'null' description: "The program number.\n " NestType: type: integer description: "Nest type enumeration.\n \n\n0 = Default\n1 = Net\n2 = Serial\n3 = OneBooking" x-enumNames: - Default - Net - Serial - OneBooking enum: - 0 - 1 - 2 - 3 GovernmentPassengerDocumentRequirementv2: type: object description: "Defines a specific government document requirements for a specific passenger. Version 2\n " additionalProperties: false properties: governmentInstance: type: - string - 'null' description: "Identifies which instance of government security is associated with these specific requirements.\n " numberOfMissingDocuments: type: integer description: "The number of documents still missing.\n " eligibleDocuments: type: - array - 'null' description: "The collection of eligible documents that have not already been added by the passenger.\n " items: $ref: '#/components/schemas/GovernmentDocumentRequirement' verifiableDocuments: type: - array - 'null' description: "The collection of verifiable documents at each acting government entity.\n " items: $ref: '#/components/schemas/GovernmentDocumentRequirement' documentVerificationRequired: type: boolean description: "Boolean to confirm documents need to be verified.\n***Note***\nIf it is TRUE, document verification is required.\nIf it is FALSE, it could be\n1) No document verification is required, or\n2) The given Travel Documents Type and Count matches the government program driver requirements, BUT this\ndoes not ensure that all government security document requirements have been met.\n " Account: type: object description: "The account model.\n " additionalProperties: false properties: accountKey: type: - string - 'null' description: "The account key.\n " totalAvailable: type: number description: "The summed total of all currently available credit amounts for the account.\n " format: decimal owner: description: "The account owner type.\n " $ref: '#/components/schemas/AccountOwnerType' type: description: "The account type.\n " $ref: '#/components/schemas/AccountType' status: description: "The account status.\n " $ref: '#/components/schemas/AccountStatus' totalAmount: type: number description: "The total amount.\n " format: decimal foreignAvailable: type: number description: "The foreign currency available.\n " format: decimal foreignCurrencyCode: type: - string - 'null' description: "The foreign currency code.\n " accountNumber: type: - string - 'null' description: "The account number associated to the customer or organization.\n " expiredCreditAmount: type: number description: "The amount of credit that was unused and already expired.\n " format: decimal expiredCreditCurrencyCode: type: - string - 'null' description: "The currency code of the expired credit amount.\n " currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 0 collections: type: - array - 'null' description: "The list of account collections.\n " items: $ref: '#/components/schemas/AccountCollection' accountName: type: - string - 'null' description: "The account name associated to the customer.\n " HoldDateChangeHistory: type: object description: "Defines a hold date change history log entry.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " $ref: '#/components/schemas/PointOfSale' receivedBy: type: - string - 'null' description: "The received by name.\n " maxLength: 64 minLength: 0 receivedByReference: type: - string - 'null' description: "The received by reference number.\n " maxLength: 20 minLength: 0 createdDate: type: - string - 'null' description: "The the history entry was created.\n " format: date-time previousHoldTime: type: - string - 'null' description: "The previous hold time for the booking.\n " format: date-time holdTime: type: - string - 'null' description: "The current hold time for the booking.\n " format: date-time PassengerEmdCoupon: type: object description: "Model information for the passenger EMD coupon.\n " additionalProperties: false properties: status: description: "The EMD coupon status.\n " $ref: '#/components/schemas/EmdCouponStatus' emdTypeCode: description: "The EMD type code.\n " $ref: '#/components/schemas/EmdTypeCode' passengerEmdCouponKey: type: - string - 'null' description: "The unique identifier for a passenger EMD coupon.\n " emdNumber: type: - string - 'null' description: "The 13 digit passenger EMD number, assigned after the EMD has been issued.\n " maxLength: 13 minLength: 0 couponNumber: type: integer description: "The EMD coupon number, assigned after the EMD has been issued.\nTODO: In SkySpeed this is 0-4 only\n " maximum: 32767.0 minimum: 0.0 optionalServiceInformation: description: "The optional service information.\n " $ref: '#/components/schemas/OptionalServiceInformation' salesDate: type: - string - 'null' description: "The sale date.\n " format: date-time flightReference: type: - string - 'null' description: "The EMD flight reference.\n " maxLength: 22 minLength: 0 receivedFromSystemCode: type: - string - 'null' description: "The received from system code.\n " maxLength: 3 minLength: 0 numberOfServices: type: integer description: "The number of services.\n " maximum: 32767.0 minimum: 1.0 feeType: description: "The EMD related fee type.\n " $ref: '#/components/schemas/FeeType' feeKey: type: - string - 'null' description: "The EMD related fee key.\n " ssrCode: type: - string - 'null' description: "The EMD related SSR code.\n " maxLength: 4 minLength: 0 ssrNumber: type: - integer - 'null' description: "The EMD related SSR code.\n " ReceivedByInfo: type: object description: "Defines the received by information.\n " additionalProperties: false properties: receivedBy: type: - string - 'null' description: "The received by name.\n " maxLength: 64 minLength: 0 latestReceivedBy: type: - string - 'null' description: "The latest received by name.\n " maxLength: 64 minLength: 0 receivedReference: type: - string - 'null' description: "The received by reference.\n " maxLength: 20 minLength: 0 latestReceivedReference: type: - string - 'null' description: "The latest received by reference.\n " maxLength: 20 minLength: 0 referralCode: type: - string - 'null' description: "The referral code.\n " maxLength: 12 minLength: 0 PassengerFare: type: object description: "Model that represents the passenger fare details.\n " additionalProperties: false required: - passengerType properties: fareDiscountCode: type: - string - 'null' description: "The fare discount code.\n " maxLength: 8 minLength: 0 passengerType: type: string description: "The type of the passenger.\n " maxLength: 4 minLength: 0 serviceCharges: type: - array - 'null' description: "The service charges.\n " items: $ref: '#/components/schemas/ServiceCharge' discountCode: type: - string - 'null' description: "The passenger discount code.\n " maxLength: 4 minLength: 0 ticketFareBasis: type: - string - 'null' description: "A fare basis alias which is a more descriptive and custom value than the fare basis itself. \nThis value is created in FareManager Plus based on specific fare rule categories and ATPCO documentation.\n " CollectType: type: integer description: "Used to identify the collect type of a service charge.\n \n\n0 = SellerChargeable\n1 = ExternalChargeable\n2 = SellerNonChargeable\n3 = ExternalNonChargeable\n4 = ExternalChargeableImmediate" x-enumNames: - SellerChargeable - ExternalChargeable - SellerNonChargeable - ExternalNonChargeable - ExternalChargeableImmediate enum: - 0 - 1 - 2 - 3 - 4 OperationsInformation: type: object description: "Model describing the operations information.\n " additionalProperties: false properties: arrivalGate: description: "The arrival gate information.\n " $ref: '#/components/schemas/GateInformation' departureGate: description: "The departure gate information.\n " $ref: '#/components/schemas/GateInformation' actualOffBlockTime: type: - string - 'null' description: "The actual off block time.\n " format: date-time actualOnBlockTime: type: - string - 'null' description: "The actual on block time.\n " format: date-time actualTouchDownTime: type: - string - 'null' description: "The actual touch down time.\n " format: date-time airborneTime: type: - string - 'null' description: "The airborne time.\n " format: date-time arrivalNote: type: - string - 'null' description: "The arrival note.\n " maxLength: 128 minLength: 0 arrivalStatus: description: "The arrival status.\n " $ref: '#/components/schemas/ArrivalStatus' baggageClaim: type: - string - 'null' description: "The baggage claim.\n " maxLength: 10 minLength: 0 departureNote: type: - string - 'null' description: "The departure note.\n " maxLength: 128 minLength: 0 departureStatus: description: "The departure status.\n " $ref: '#/components/schemas/DepartureStatus' departureTimes: description: "The departure time information.\n " $ref: '#/components/schemas/DepartureEvent' standardArrivalTime: type: - string - 'null' description: "The standard time of arrival (STA).\n " format: date-time tailNumber: type: - string - 'null' description: "The tail number.\n " maxLength: 10 minLength: 0 estimatedArrivalTime: type: - string - 'null' description: "The estimated time of arrival (ETA).\n " format: date-time OrderFee: type: object description: "Defines a order fee.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The fee code.\n " feeCategoryCode: type: - string - 'null' description: "The charge type code.\n " description: type: - string - 'null' description: "The fee description.\n " amount: description: "The fees amounts.\n " $ref: '#/components/schemas/Amount' foreignAmount: description: "The fees foreign amounts.\n " $ref: '#/components/schemas/Amount' type: description: "The type of fee applied.\n " $ref: '#/components/schemas/OrderFeeType' isWaiveable: type: boolean description: "Flag indicating if they specific fee is waiveable.\n " foreignCurrencyCode: type: - string - 'null' description: "The foreign currency code.\n " currencyCode: type: - string - 'null' description: "The currency code.\n " isChargeable: type: boolean description: "The currency code.\n " PaymentAmounts: type: object description: "Defines the different applied payment amounts for a single payment.\n " additionalProperties: false properties: amount: type: number description: "The amount in the booking currency (based off the origin).\n " format: decimal currencyCode: type: - string - 'null' description: "The payment amount currency code.\n " maxLength: 3 minLength: 0 collected: type: number description: "The collected amount post DCC or MCC.\n " format: decimal collectedCurrencyCode: type: - string - 'null' description: "The collected amounts currency code.\n " maxLength: 3 minLength: 0 quoted: type: number description: "The pre DCC or MCC amount (maybe different than the booking).\n " format: decimal quotedCurrencyCode: type: - string - 'null' description: "The quoted currency code.\n " maxLength: 3 minLength: 0 BookingProfileStatus: type: integer description: "Defines the profiling status of the booking.\n \n\n0 = Default\n1 = KnownIndividual\n2 = ResolutionGroup\n3 = SelecteeGroup\n4 = NotUsed\n5 = FailureGroup\n6 = RandomSelectee\n7 = Exempt" x-enumNames: - Default - KnownIndividual - ResolutionGroup - SelecteeGroup - NotUsed - FailureGroup - RandomSelectee - Exempt enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 QueueAction: type: integer description: "Specifies the basics by which a queue filter was created.\n \n\n0 = Default\n1 = Warning\n2 = Lock\n3 = DefaultAndNotify\n4 = WarningAndNotify\n5 = LockAndNotify" x-enumNames: - Default - Warning - Lock - DefaultAndNotify - WarningAndNotify - LockAndNotify enum: - 0 - 1 - 2 - 3 - 4 - 5 Order: type: object description: "Defines a order.\n " additionalProperties: false properties: orderKey: type: - string - 'null' description: "The unique order key.\n " active: type: boolean description: "Flag indicating if the order is active.\n " criteria: description: "The specific order criteria.\n " $ref: '#/components/schemas/OrderCriteria' thumbnailFileName: type: - string - 'null' description: "The thumbnail file name.\n " quantity: type: integer description: "The quantity.\n " format: int32 usageDate: type: string description: "The usage date for this order.\n " format: date-time externalLocator: type: - string - 'null' description: "The third party external locator.\n " description: type: - string - 'null' description: "The orders description.\n " descriptionFormatType: type: - string - 'null' description: "The order descriptions format type.\n " productDescription: type: - string - 'null' description: "The products description.\n " productVariationDescription: type: - string - 'null' description: "The products variations description.\n " paymentAction: description: "The payment action.\n " $ref: '#/components/schemas/PaymentAction' amounts: description: "The pricing breakdown.\n " $ref: '#/components/schemas/OrderPriceBreakdown' terms: type: - array - 'null' description: "The collection of terms and conditions.\n " items: $ref: '#/components/schemas/Term' cancellationTerms: type: - array - 'null' description: "The collection of cancellation terms and conditions.\n " items: $ref: '#/components/schemas/Term' details: type: - array - 'null' description: "The collection of product variation details.\n " items: $ref: '#/components/schemas/ProductVariationDetail' fees: type: - array - 'null' description: "The collection of applied fees.\n " items: $ref: '#/components/schemas/OrderFee' notes: type: - array - 'null' description: "The collection of notes about the order.\n " items: $ref: '#/components/schemas/OrderNote' productVariationKey: type: - string - 'null' description: "The unique product variation key.\n " productOrderKey: type: - string - 'null' description: "The unique product order key.\n " address: description: "The orders address.\n " $ref: '#/components/schemas/OrderAddress' phoneNumbers: type: - array - 'null' description: "The collection of available phone numbers.\n " items: $ref: '#/components/schemas/PhoneNumber' locations: type: - array - 'null' description: "The collection of order locations.\n " items: $ref: '#/components/schemas/OrderLocation' customer: description: "The oder customer.\n " $ref: '#/components/schemas/OrderCustomer' participants: type: - object - 'null' description: "The collection of order participants.\n " additionalProperties: $ref: '#/components/schemas/OrderParticipant' history: type: - array - 'null' description: "The collection of order history entry history.\n " items: $ref: '#/components/schemas/OrderHistory' payment: description: "The applied payment.\n " $ref: '#/components/schemas/OrderPayment' parameters: type: - array - 'null' description: "The collection of dynamic order input parameters.\n " items: $ref: '#/components/schemas/InputedParameter' RetrieveBookingQueueResponseItem: type: object description: "The booking queue response items for retrieving booking queue items.\n " additionalProperties: false properties: recordLocator: type: - string - 'null' description: "The record locator.\n " bookingQueueRestriction: description: "The queue restriction.\n " $ref: '#/components/schemas/BookingQueueRestriction' queueCode: type: - string - 'null' description: "The queue code.\n " notes: type: - string - 'null' description: "The notes.\n " inProgress: type: boolean description: "The call status.\n " priorityDate: type: string description: "The priority date.\n " format: date-time domainCode: type: - string - 'null' description: "The domain code.\n " queueEventType: description: "The queue event type.\n " $ref: '#/components/schemas/QueueEventType' CheckinPassengerRestriction: type: object description: "Defines a passengers restriction for the current segment trying to be checked into.\n " additionalProperties: false properties: restriction: description: "The passenger restriction type.\n " $ref: '#/components/schemas/CheckinPassengerRestrictionType' description: type: - string - 'null' description: "The description of the restriction.\n " PassengerSegment: type: object description: "Model data for the passenger on the booking for the specific segment.\n " additionalProperties: false properties: seats: type: - array - 'null' description: "The seat details.\n " items: $ref: '#/components/schemas/PassengerSeat' passengerKey: type: - string - 'null' description: "The unique key of the passenger on the segment\n " activityDate: type: - string - 'null' description: "The activity date.\n " format: date-time boardingSequence: type: - string - 'null' description: "The passenger segment boarding sequence.\n " createdDate: type: - string - 'null' description: "The created date.\n " format: date-time liftStatus: description: "The lift status.\n " $ref: '#/components/schemas/LiftStatus' modifiedDate: type: - string - 'null' description: "The modified date.\n " format: date-time overBookIndicator: description: "The over book indicator.\n " $ref: '#/components/schemas/OverbookIndicatorTypes' priorityDate: type: - string - 'null' description: "The priority date.\n " format: date-time timeChanged: type: boolean description: "Gets or sets a value indicating whether the passenger segment time has changed.\n " verifiedTravelDocs: type: - string - 'null' description: "The verified travel docs. Please use VerifiedTravelDocuments instead.\n " maxLength: 44 minLength: 0 sourcePointOfSale: description: "The source point of sale.\n " $ref: '#/components/schemas/PointOfSale' pointOfSale: description: "The point of sale.\n " $ref: '#/components/schemas/PointOfSale' ssrs: type: - array - 'null' description: "The Ssr information for both the leg and segment.\n " items: $ref: '#/components/schemas/PassengerSsr' tickets: type: - array - 'null' description: "The ticket information.\n " items: $ref: '#/components/schemas/Ticket' bags: type: - array - 'null' description: "The baggage information.\n " items: $ref: '#/components/schemas/PassengerSegmentBag' scores: type: - array - 'null' description: "The collection of passenger scores.\n " items: $ref: '#/components/schemas/PassengerScore' boardingPassDetail: description: "The passengers boarding pass details.\n " $ref: '#/components/schemas/PassengerBoardingPassDetail' hasInfant: type: boolean description: "Flag indicating if the passenger has an infant for the specific segment.\n " seatPreferences: description: "The passenger seat preferences.\n " $ref: '#/components/schemas/SeatPreferences' bundleCode: type: - string - 'null' description: "The bundle code associated with the passenger segment.\n " verifiedTravelDocuments: type: - array - 'null' description: "The travel document keys that have been verified at checkin.\n " items: type: string referenceNumber: type: integer description: "The reference number, used as an identifier by New Skies Rail customers for purposes\nof ticketing and check in.\n " format: int64 baggageGroupNumber: type: - integer - 'null' description: "The passenger's baggage group number.\n " baggageAllowanceUsed: type: boolean description: "Indicates whether the passenger segment baggage allowance is used.\n " baggageAllowanceWeight: type: integer description: "The passenger segment baggage allowance weight.\n " maximum: 32767.0 minimum: 0.0 baggageAllowanceWeightType: description: "The type of passenger segment baggage allowance weight.\n " $ref: '#/components/schemas/WeightType' stayType: description: "The stay type.\n " $ref: '#/components/schemas/GssStayType' infantStayType: description: "The stay type for an infant.\n " $ref: '#/components/schemas/GssStayType' MoveJourneyRequestv2: type: object description: "Defines the move journey request, version two.\n " additionalProperties: false required: - fromJourneyKey - toJourneyKeys - fareKey properties: fromJourneyKey: type: string description: "The key of the journey that is being moved from.\n " minLength: 1 toJourneyKeys: type: array description: "The list of keys of the journeys that are potentially being moved to.\n " items: type: string fareKey: type: string description: "The fare key to move to.\n " minLength: 1 standbyPriorityCode: type: - string - 'null' description: "Standby priority code.\n " inventoryControlType: description: "Inventory control.\n " $ref: '#/components/schemas/InventoryControlType' changeReasonCode: description: "Change reason code.\n " $ref: '#/components/schemas/StatelessChangeReasonCodes' bookingComment: type: - string - 'null' description: "A comment to be added to the effected booking.\n " PaymentMethodType: type: integer description: "Defines the payment method types.\n \n\n0 = ExternalAccount\n1 = PrePaid\n2 = AgencyAccount\n3 = CustomerAccount\n4 = Voucher\n5 = Loyalty" x-enumNames: - ExternalAccount - PrePaid - AgencyAccount - CustomerAccount - Voucher - Loyalty enum: - 0 - 1 - 2 - 3 - 4 - 5 GovernmentDocumentFieldType: type: integer description: "Defines all the different travel document fields that a government program can require to be prompted/required.\n \n\n0 = FirstName\n1 = MiddleName\n2 = LastName\n3 = Title\n4 = Suffix\n5 = DateOfBirth\n6 = BirthCountry\n7 = Gender\n8 = Nationality\n9 = Number\n10 = IssuingCountry\n11 = ExpirationDate\n12 = IssuedDate\n13 = Verified" x-enumNames: - FirstName - MiddleName - LastName - Title - Suffix - DateOfBirth - BirthCountry - Gender - Nationality - Number - IssuingCountry - ExpirationDate - IssuedDate - Verified enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 AccountCollection: type: object description: "The account collection model.\n " additionalProperties: false properties: accountCollectionKey: type: - string - 'null' description: "The unique account collection key.\n " available: type: number description: "The available amount.\n " format: decimal amount: type: number description: "The total amount.\n " format: decimal createdDate: type: - string - 'null' description: "The creation date.\n " format: date-time transactionCode: type: - string - 'null' description: "The transaction code.\n " expiration: type: - string - 'null' description: "The expiration date.\n " format: date-time spoiledAmount: type: number description: "The spoiled amount.\n " format: decimal CheckinRequirements: type: object description: "Defines the pre checkin requirements.\n " deprecated: true x-deprecatedMessage: Obsolete as of 4.4.4, please use the v2. additionalProperties: false properties: isValid: type: boolean description: "Flag indicating if the ability to checkin is valid.\n " passengers: type: - object - 'null' description: "The collection of passengers and there requirements to checkin.\n " additionalProperties: $ref: '#/components/schemas/CheckinPassengerRequirements' governmentProgramRequirements: type: - object - 'null' description: "The collection of government programs requirements.\n " additionalProperties: $ref: '#/components/schemas/GovernmentProgramRequirements' restrictions: type: - array - 'null' description: "The list of any non passenger related checkin restrictions that will restrict the desired segments to be checked\nin.\nThe checkin restriction type = ('Closed', 'NotOpened', 'PnrLocked', 'MarketingCodeShareNotAllowed',\n'NotPaidInFull', 'PaymentsPending',\n'PaymentsPendingCustomerAction', 'RestrictedOnAnotherSystem', 'NotAllowed', 'ApisNotAllowed', 'AppsNotAllowed',\n'SegmentNotFound', 'InvalidPrice').\n " items: $ref: '#/components/schemas/CheckinRestrictionType' BookingHold: type: object description: "Defines the booking hold expiration.\n " additionalProperties: false properties: expiration: type: - string - 'null' description: "Defines the hold date and time expiration.\n " format: date-time IJsonResponseOfIListOfBookingQueue: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/BookingQueue' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' ProductTypeCode: type: integer description: "Defines the different travel commerce types.\n \n\n0 = Default\n1 = Insurance\n2 = Activity\n3 = Hotel\n4 = Car" x-enumNames: - Default - Insurance - Activity - Hotel - Car enum: - 0 - 1 - 2 - 3 - 4 PassengerPriceBreakdownBase: type: object description: "Defines the combined booking passengers pricing breakdown.\n " additionalProperties: false properties: services: description: "The charge breakdown of the service fees.\n " $ref: '#/components/schemas/ChargeBreakdown' specialServices: description: "The charge breakdown of the special service requests.\n " $ref: '#/components/schemas/ChargeBreakdown' seats: description: "The charge breakdown of seat fees.\n " $ref: '#/components/schemas/ChargeBreakdown' upgrades: description: "The charge breakdown of upgrade fees.\n " $ref: '#/components/schemas/ChargeBreakdown' spoilage: description: "The charge breakdown of spoilage fees.\n " $ref: '#/components/schemas/ChargeBreakdown' nameChanges: description: "The charge breakdown of name change fees.\n " $ref: '#/components/schemas/ChargeBreakdown' convenience: description: "The charge breakdown of convenience fees.\n " $ref: '#/components/schemas/ChargeBreakdown' infant: description: "The charge breakdown of infant fees.\n " $ref: '#/components/schemas/ChargeBreakdown' totalCost: type: - number - 'null' description: "The total cost for the passenger.\nThese values are only populated by NewSkies after a booking commit\n " format: decimal CreatedAddOnDetails: type: object description: "Defines a component details.\n " additionalProperties: false properties: agentCode: type: - string - 'null' description: "The created agent code.\n " organizationCode: type: - string - 'null' description: "The created organization code.\n " domainCode: type: - string - 'null' description: "The created domain code.\n " locationCode: type: - string - 'null' description: "The created location code.\n " agentReference: type: - string - 'null' description: "The agent key.\n " date: type: string description: "The date created.\n " format: date-time ChargeType: type: integer description: "The type of a service charge.\n \n\n0 = FarePrice\n1 = Discount\n2 = IncludedTravelFee\n3 = IncludedTax\n4 = TravelFee\n5 = Tax\n6 = ServiceCharge\n7 = PromotionDiscount\n8 = ConnectionAdjustmentAmount\n9 = AddOnsPrice\n10 = FarePoints\n11 = DiscountPoints\n16 = IncludedAddOnsFee\n17 = AddOnsFee\n18 = AddOnsMarkup\n19 = FareSurcharge\n21 = AddOnsCancelFee\n22 = Calculated\n23 = Note\n24 = Points\n25 = DynamicFareAdjustment" x-enumNames: - FarePrice - Discount - IncludedTravelFee - IncludedTax - TravelFee - Tax - ServiceCharge - PromotionDiscount - ConnectionAdjustmentAmount - AddOnsPrice - FarePoints - DiscountPoints - IncludedAddOnsFee - AddOnsFee - AddOnsMarkup - FareSurcharge - AddOnsCancelFee - Calculated - Note - Points - DynamicFareAdjustment enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 16 - 17 - 18 - 19 - 21 - 22 - 23 - 24 - 25 BookingFilters: type: object description: "Model representing the booking filters available when searching.\n " additionalProperties: false properties: pageSize: type: - integer - 'null' description: "The number of items to return for the request.\n " maximum: 5000.0 minimum: 10.0 lastIndex: type: - integer - 'null' description: "The last booking index (used for paging).\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 flightNumber: type: - string - 'null' description: "Filter by the flight number.\n " departureDate: type: - string - 'null' description: "The first journeys departure date.\n " format: date-time destination: type: - string - 'null' description: "Filter by the destination code.\n " maxLength: 3 minLength: 3 origin: type: - string - 'null' description: "Filter by the departure code.\n " maxLength: 3 minLength: 3 sourceOrganization: type: - string - 'null' description: "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " maxLength: 10 minLength: 0 organizationGroupCode: type: - string - 'null' description: "Filter by the organization group code to find.\n " maxLength: 3 minLength: 0 searchArchive: type: - boolean - 'null' description: "Whether or not to search the booking archive.\n " BookingQueuesRequest: type: object description: "The booking request base model for retrieving booking queues.\n " additionalProperties: false properties: password: type: - string - 'null' description: "The Password needed to access the queue. Required if queue\nis set to password-protected in Sky Manager.\n " passengerKey: type: - string - 'null' description: "The unique passenger identifier key.\n " segmentKey: type: - string - 'null' description: "The unique segment key.\n " BookingHistory: type: object description: "Defines a booking history log entry.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " $ref: '#/components/schemas/PointOfSale' receivedBy: type: - string - 'null' description: "The received by name.\n " maxLength: 64 minLength: 0 receivedByReference: type: - string - 'null' description: "The received by reference number.\n " maxLength: 20 minLength: 0 createdDate: type: - string - 'null' description: "The the history entry was created.\n " format: date-time historyCategory: description: "The booking history report category.\n " $ref: '#/components/schemas/HistoryCategory' details: type: - string - 'null' description: "The the history report data.\n " event: description: "The specific history code.\n " $ref: '#/components/schemas/BookingHistoryEvent' Booking: type: object description: "Represents a full booking object.\n " additionalProperties: false properties: selfServiceMoveAvailable: type: boolean description: "The flag indicating whether self-service move is allowed.\n " bookingKey: type: - string - 'null' description: "The unique identifier.\n " recordLocator: type: - string - 'null' description: "The alphanumeric identifier assigned to a reservation when the record is created (created means when the booking\nwas submitted to the database).\n " maxLength: 12 minLength: 0 currencyCode: type: - string - 'null' description: "The currency in which the booking is created and priced.\n " maxLength: 3 minLength: 0 systemCode: type: - string - 'null' description: "The GDS/CRS code that requested the booking.\n " maxLength: 3 minLength: 0 groupName: type: - string - 'null' description: "The group name of the booking.\n " locators: description: "Booking locators used to define a booking.\n " $ref: '#/components/schemas/BookingRecordLocators' info: description: "Informational about the booking.\n " $ref: '#/components/schemas/BookingInfo' sales: description: "Details about the point of sale.\n " $ref: '#/components/schemas/BookingSales' typeOfSale: description: "Information about the type of sale the booking was.\n " $ref: '#/components/schemas/TypeOfSale' hold: description: "Defines the hold expiration.\n " $ref: '#/components/schemas/BookingHold' breakdown: description: "The booking pricing breakdown.\n " $ref: '#/components/schemas/BookingPriceBreakdown' receivedBy: description: "Details about what received the booking commit.\n " $ref: '#/components/schemas/ReceivedByInfo' contacts: type: - object - 'null' description: "The contacts on the booking by unique the contact type code.\nPlease note that this should be a dictionary of char keys and not a dictionary of string keys.\n " additionalProperties: $ref: '#/components/schemas/Contact' passengers: type: - object - 'null' description: "The list of passengers and information.\n " additionalProperties: $ref: '#/components/schemas/Passenger' journeys: type: - array - 'null' description: "The list of journeys and information.\n " items: $ref: '#/components/schemas/Journey' comments: type: - array - 'null' description: "The list of associated comments.\n " items: $ref: '#/components/schemas/BookingComment' queues: type: - array - 'null' description: "The list of information indicating which queue the booking is present in.\n " items: $ref: '#/components/schemas/BookingQueueInfo' history: type: - array - 'null' description: "The history of the booking since it was loaded into state.\n " items: $ref: '#/components/schemas/BookingHistory' payments: type: - array - 'null' description: "The list of applied payments.\n " items: $ref: '#/components/schemas/Payment' addOns: type: - object - 'null' description: "The list of components.\n " additionalProperties: $ref: '#/components/schemas/AddOn' orders: type: - array - 'null' description: "The list of booking orders.\n " items: $ref: '#/components/schemas/BookingOrder' QueueEventType: type: integer description: "Describes the different queue event types.\n \n\n0 = Default\n1 = BookingBalanceDue\n2 = BookingNegativeBalance\n3 = BookingCustomerComment\n4 = DeclinedPaymentInitial\n5 = DeclinedPaymentChange\n6 = FareOverride\n7 = ScheduleTimeChange\n8 = ScheduleTimeChangeMisconnect\n9 = ScheduleCancellation\n10 = FlightDesignatorChange\n11 = ReaccommodationMove\n12 = GdsCancelWithPendingPayment\n13 = InvalidPriceStatusOverride\n14 = FareRestrictionOverride\n15 = HeldBookings\n16 = InvalidPriceStatus\n17 = Watchlist\n18 = NonFlightServiceFee\n19 = NotAllTicketNumbersReceived\n20 = BookingSegmentOversold\n21 = ReaccommodationCancel\n22 = ExternalSsrAutoConfirmed\n23 = OpCarrierSegUpdate\n24 = OpCarrierSsrUpdate\n25 = OpCarrierOtherUpdate\n26 = NameChangeNotAllowed\n27 = InboundAscNotProcessed\n28 = OpCarrierInformationChange\n29 = BookingComponentUpdate\n30 = GroupBookings\n31 = BankDirectPnrOutOfBalance\n32 = NoSeatAssigned\n33 = SeatNumberChange\n34 = SsrNotSupportedOnNewSeat\n35 = FewerSeatPreferencesMetOnNewSeat\n36 = AosUnableToConfirmCancel\n37 = ETicketIssue\n38 = ETicketFollowup\n39 = InvoluntaryFlyAhead\n40 = ManualClearanceOnOutage\n41 = UnbalancedPoints\n42 = OpCarrierTimeChange\n43 = OaCarrierTimeChange\n44 = VoluntaryFlightChange\n45 = InvoluntaryFlightChange\n46 = HoldCancellationFailed\n47 = ScheduleTimeChangeWithDynamicQueueCode\n48 = ReaccommodationMoveWithDynamicQueueCode\n49 = ItineraryIntegrity\n50 = ReducePartyNotProcessed\n51 = CheckedPassengerUpdate\n52 = MustBeSeatGroupViolation\n57 = NameChangeWithinRule\n58 = IncompletePassengerEMDCoupon\n59 = ASVCUpdateFailed\n60 = FailedFareClassRealignment\n61 = ScheduleTimeChangeMisconnectBelowMinimum\n62 = ScheduleTimeChangeMisconnectAboveMaximum\n63 = OpCarrierMisconnect\n64 = InventoryQueuing\n65 = SelfServiceAsm\n66 = SelfServiceDelay\n67 = SelfServiceFlightCancellation\n68 = SelfServiceIrop\n69 = SelfServiceScheduleChange\n70 = SelfServiceTimeChange\n71 = AosAddOrCancelNotSuccessful\n72 = MissingGdsFareFamily\n73 = ChangeCabinQueue\n74 = PendingPaymentQueue\n75 = TicketDisplayToDetermineIncludedServiceBundleFailed\n76 = DuplicateTicketsInBooking\n77 = TicketCouponUpdateQueue\n78 = ETicketRefund\n79 = ExternalEticketVoidCheck\n80 = ExternalEticketVoidCheckFollowUp\n81 = NoAssignedSeatOnNewFlightFromEquipmentChange" x-enumNames: - Default - BookingBalanceDue - BookingNegativeBalance - BookingCustomerComment - DeclinedPaymentInitial - DeclinedPaymentChange - FareOverride - ScheduleTimeChange - ScheduleTimeChangeMisconnect - ScheduleCancellation - FlightDesignatorChange - ReaccommodationMove - GdsCancelWithPendingPayment - InvalidPriceStatusOverride - FareRestrictionOverride - HeldBookings - InvalidPriceStatus - Watchlist - NonFlightServiceFee - NotAllTicketNumbersReceived - BookingSegmentOversold - ReaccommodationCancel - ExternalSsrAutoConfirmed - OpCarrierSegUpdate - OpCarrierSsrUpdate - OpCarrierOtherUpdate - NameChangeNotAllowed - InboundAscNotProcessed - OpCarrierInformationChange - BookingComponentUpdate - GroupBookings - BankDirectPnrOutOfBalance - NoSeatAssigned - SeatNumberChange - SsrNotSupportedOnNewSeat - FewerSeatPreferencesMetOnNewSeat - AosUnableToConfirmCancel - ETicketIssue - ETicketFollowup - InvoluntaryFlyAhead - ManualClearanceOnOutage - UnbalancedPoints - OpCarrierTimeChange - OaCarrierTimeChange - VoluntaryFlightChange - InvoluntaryFlightChange - HoldCancellationFailed - ScheduleTimeChangeWithDynamicQueueCode - ReaccommodationMoveWithDynamicQueueCode - ItineraryIntegrity - ReducePartyNotProcessed - CheckedPassengerUpdate - MustBeSeatGroupViolation - NameChangeWithinRule - IncompletePassengerEMDCoupon - ASVCUpdateFailed - FailedFareClassRealignment - ScheduleTimeChangeMisconnectBelowMinimum - ScheduleTimeChangeMisconnectAboveMaximum - OpCarrierMisconnect - InventoryQueuing - SelfServiceAsm - SelfServiceDelay - SelfServiceFlightCancellation - SelfServiceIrop - SelfServiceScheduleChange - SelfServiceTimeChange - AosAddOrCancelNotSuccessful - MissingGdsFareFamily - ChangeCabinQueue - PendingPaymentQueue - TicketDisplayToDetermineIncludedServiceBundleFailed - DuplicateTicketsInBooking - TicketCouponUpdateQueue - ETicketRefund - ExternalEticketVoidCheck - ExternalEticketVoidCheckFollowUp - NoAssignedSeatOnNewFlightFromEquipmentChange enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 - 52 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 DayOfWeek: type: integer description: "Defines the day of the week with none as an option.\n \n\n0 = None\n1 = Monday\n2 = Tuesday\n3 = Wednesday\n4 = Thursday\n5 = Friday\n6 = Saturday\n7 = Sunday" x-enumNames: - None - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 ChangeReasonCodes: type: integer description: "Specifies the reason code on why the change on the journey or segment is performed.\n \n\n0 = NoChange\n1 = Irop\n2 = ScheduleChange\n3 = Move\n4 = VoluntaryFlyAhead\n5 = InvoluntaryFlyAhead\n6 = SelfServiceRebooking" x-enumNames: - NoChange - Irop - ScheduleChange - Move - VoluntaryFlyAhead - InvoluntaryFlyAhead - SelfServiceRebooking enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 AuthorizationStatus: type: integer description: "Defines the different possible payment authorization states.\n \n\n0 = Unknown\n1 = Acknowledged\n2 = Pending\n3 = InProcess\n4 = Approved\n5 = Declined\n6 = Referral\n7 = PickUpCard\n8 = HotCard\n9 = Voided\n10 = Retrieval\n11 = ChargedBack\n12 = Error\n13 = ValidationFailed\n14 = Address\n15 = VerificationCode\n16 = FraudPrevention\n17 = ForcedApproval\n18 = ForcedDecline\n19 = NoResponse\n20 = BadResponse" x-enumNames: - Unknown - Acknowledged - Pending - InProcess - Approved - Declined - Referral - PickUpCard - HotCard - Voided - Retrieval - ChargedBack - Error - ValidationFailed - Address - VerificationCode - FraudPrevention - ForcedApproval - ForcedDecline - NoResponse - BadResponse enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 PaidStatus: type: integer description: "Paid status enumeration.\n \n\n0 = UnderPaid\n1 = PaidInFull\n2 = OverPaid" x-enumNames: - UnderPaid - PaidInFull - OverPaid enum: - 0 - 1 - 2 TransportationIdentifier: type: object description: "Represents the transportation identifier model data.\n " additionalProperties: false required: - identifier - carrierCode properties: identifier: type: string description: "The unique transportation identifier.\n " maxLength: 4 minLength: 0 carrierCode: type: string description: "The carrier code.\n " maxLength: 3 minLength: 2 opSuffix: type: - string - 'null' description: "The op suffix.\nPlease note that this should be a char and not a string.\n " maxLength: 1 CheckinPassengerRequest: type: object description: "Defines the individual passenger checkin request.\n " additionalProperties: false required: - passengerKey properties: passengerKey: type: string description: "The unique passenger key being checked in.\n " minLength: 1 transitType: description: "The passengers transit type.\n " $ref: '#/components/schemas/TransitType' processApps: type: - boolean - 'null' description: "Flag indicating to process APPS.\n " verifiedReference: type: - string - 'null' description: "The value specifying the verified travel document(s) associated with this checkin.\n " InventoryControlType: type: integer description: "Defines the different ways inventory is held at the time of sell.\n \n\n0 = HoldSpace\n1 = SoftHoldSpace\n2 = ClaimSpace\n3 = OversellSpace\n4 = StandBy" x-enumNames: - HoldSpace - SoftHoldSpace - ClaimSpace - OversellSpace - StandBy enum: - 0 - 1 - 2 - 3 - 4 ParticipantDocument: type: object description: "Defines a consumer document.\n " additionalProperties: false properties: number: type: - string - 'null' description: "The documents number.\n " issuedByCode: type: - string - 'null' description: "The documents issued by code.\n " documentTypeCode: type: - string - 'null' description: "The documents type code.\n " IJsonResponseOfIListOfBookingQueueHistory: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/BookingQueueHistory' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' BookingQueue: type: object description: "The booking queue model.\n " additionalProperties: false properties: bookingQueueKey: type: - string - 'null' description: "The booking queue key.\n " notes: type: - string - 'null' description: "A summary on why the booking was placed in the queue.\n " maxLength: 128 minLength: 0 type: description: "The type of event that triggered placement of the booking in the queue.\n " $ref: '#/components/schemas/QueueEventType' watchListKey: type: - string - 'null' description: "The watch list key.\n " details: type: - array - 'null' description: "The list of booking queue details.\n " items: $ref: '#/components/schemas/BookingQueueDetail' TicketStatusCode: type: integer description: "This enumeration defines the ticket availability status.\n \n\n0 = Unknown\n1 = TicketAvailableForUse\n2 = TicketUnavailableForUse\n3 = TicketReissueRequiredForPassenger\n4 = TicketReissueRequiredForInfant\n5 = TicketReissueRequiredForBoth\n6 = TicketReValidationRequired" x-enumNames: - Unknown - TicketAvailableForUse - TicketUnavailableForUse - TicketReissueRequiredForPassenger - TicketReissueRequiredForInfant - TicketReissueRequiredForBoth - TicketReValidationRequired enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 CheckinDocumentRequirementsv2: type: object description: "Defines passenger checkin document requirements version 2.\n " additionalProperties: false properties: documentsOnFile: type: - array - 'null' description: "The collection of document type codes that already exist on the passenger.\n " items: type: string governmentDocumentInstances: type: - array - 'null' description: "The collection of unhandled documents at each acting government entity.\n " items: $ref: '#/components/schemas/GovernmentPassengerDocumentRequirementv2' isValid: type: boolean description: "Flag indicating if the checkin document requirements are all met and ready/valid for checkin.\n " OrderParticipant: type: object description: "Defines a orders participant.\n " additionalProperties: false properties: description: type: - string - 'null' description: "The participant description.\n " participantTypeCode: type: - string - 'null' description: "The participant type code.\n " isPrimary: type: boolean description: "Flag indicating if the participant is the primary.\n " document: description: "The participant document.\n " $ref: '#/components/schemas/ParticipantDocument' name: description: "The name of the consumer.\n " $ref: '#/components/schemas/Name' address: description: "The address of the consumer.\n " $ref: '#/components/schemas/ConsumerAddress' dateOfBirth: type: - string - 'null' description: "The date of birth of the consumer.\n " format: date-time emailAddress: type: - string - 'null' description: "The email address of the consumer.\n " companyName: type: - string - 'null' description: "The company name of the consumer.\n " type: type: - string - 'null' description: "The type of consumer (business or residential).\n " homePhone: type: - string - 'null' description: "The home phone number.\n " maxLength: 20 minLength: 0 workPhone: type: - string - 'null' description: "The work phone number.\n " maxLength: 20 minLength: 0 fax: type: - string - 'null' description: "The fax phone number.\n " maxLength: 20 minLength: 0 participantKey: type: - string - 'null' description: "The unique participant key.\n " AdHocMoveJourneyRequest: type: object description: "Defines the ad hoc move journey request.\n " additionalProperties: false required: - fromJourneyKey - toJourneyKeys properties: fromJourneyKey: type: string description: "The key of the journey that is being moved from.\n " minLength: 1 toJourneyKeys: type: array description: "The list of ad hoc keys of the journeys that are potentially being moved to. The API will combine the segments\nfrom these journeys into one journey and pass that to NewSkies, but will do no other validation to ensure the ad\nhoc connection will work. The end user is responsible for ensuring the ad hoc connection is valid.\n " items: type: string fareKey: type: - string - 'null' description: "The optional fare key to move to.\n " standbyPriorityCode: type: - string - 'null' description: "Standby priority code.\n " inventoryControlType: description: "Inventory control.\n " $ref: '#/components/schemas/InventoryControlType' changeReasonCode: description: "Change reason code.\n " $ref: '#/components/schemas/StatelessChangeReasonCodes' bookingComment: type: - string - 'null' description: "A comment to be added to the effected booking.\n " adHocIsForGeneralUse: type: boolean description: "Flag that sets the \"For General Use\" setting when creating an ad hoc connection.\n " TravelClassSeatPreference: type: integer description: "Represents a travel class seating preference.\n \n\n0 = None\n1 = Business\n2 = Economy\n3 = FirstClass" x-enumNames: - None - Business - Economy - FirstClass enum: - 0 - 1 - 2 - 3 PassengerSeat: type: object description: "Model for a passenger seat for a segment.\n " additionalProperties: false properties: compartmentDesignator: type: - string - 'null' description: "The passenger seat compartment designator.\n " maxLength: 2 minLength: 0 penalty: type: integer description: "The passenger seat penalty.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 unitDesignator: type: - string - 'null' description: "The passenger seat unit designator.\n " seatInformation: description: "The passenger seat seat information.\n " $ref: '#/components/schemas/SeatInfo' arrivalStation: type: - string - 'null' description: "The leg arrival station.\n " maxLength: 3 minLength: 3 departureStation: type: - string - 'null' description: "The leg departure station.\n " maxLength: 3 minLength: 3 passengerKey: type: - string - 'null' description: "The passenger key associated with the seat.\n " unitKey: type: - string - 'null' description: "The seat's unique unit key.\n " crossReferenceSeatingPreference: type: - string - 'null' description: "The seating preference for non-hosted flight seating assignments.\nCould be either one of the following values:\nnull = seating preference is not applicable (usual value for hosted flights)\nN = no requested seating preference\nA = aisle\nW = window\nF = front seating location\nR = rear seating location\nAF = front seating location, on aisle\nAR = rear seating location, on aisle\nWF = front seating location, on window\nWR = rear seating location, on window\n " isPending: type: boolean description: "Determines whether or not the seat is pending request.\n " seatmapReference: type: - string - 'null' description: "The reference identifying what seat map the passenger seat is associated to.\n " BookingPaymentStatus: type: integer description: "Determines if the booking has been paid for or not.\n \n\n0 = New\n1 = Received\n2 = Pending\n3 = Approved\n4 = Declined\n5 = Unknown\n6 = PendingCustomerAction" x-enumNames: - New - Received - Pending - Approved - Declined - Unknown - PendingCustomerAction enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 AddOn: type: object description: "Defines a booking add on service details.\n " additionalProperties: false properties: paymentRequired: type: boolean description: "Returns true if the component requires a separate\npayment from the rest of the booking.\n " status: description: "The status of the add on.\n " $ref: '#/components/schemas/AddOnStatus' addOnKey: type: - string - 'null' description: "The unique add on key.\n " type: description: "The type of add on.\n " $ref: '#/components/schemas/ProductTypeCode' summary: description: "The components order summary when the order is not available.\n " $ref: '#/components/schemas/AddOnOrderSummary' reference: type: - string - 'null' description: "The component reference.\n " created: description: "The created by details.\n " $ref: '#/components/schemas/CreatedAddOnDetails' source: description: "The responsible source details.\n " $ref: '#/components/schemas/AddOnDetails' declinedText: type: - string - 'null' description: "The declined component text.\n " cultureCode: type: - string - 'null' description: "The culture code.\n " modifiedDate: type: string description: "The date the component was last modified.\n " format: date-time modifiedAgentReference: type: - string - 'null' description: "The agent reference that modified the component.\n " order: description: "The component order details.\n " $ref: '#/components/schemas/Order' isHistorical: type: boolean description: "Flag indicating if the component is historical.\n " charges: type: - array - 'null' description: "The collection of booking component charges.\n " items: $ref: '#/components/schemas/AddOnCharge' UnitInventoryControlType: type: integer description: "Enum indicates the type of hold placed on the seat.\n \n\n0 = Session\n1 = None" x-enumNames: - Session - None enum: - 0 - 1 SegmentStatus: type: integer description: "The segment status.\n \n\n0 = UnknownStatus\n1 = UnableToConfirmSegment\n2 = UnableToSellSegment\n3 = HeldPending\n4 = WaitListConfirmed\n5 = HeldUnconfirmed\n6 = HeldConfirmed\n7 = HeldCancelled\n8 = Confirming\n9 = ConfirmingWaitList\n10 = ConfirmedTimeChange" x-enumNames: - UnknownStatus - UnableToConfirmSegment - UnableToSellSegment - HeldPending - WaitListConfirmed - HeldUnconfirmed - HeldConfirmed - HeldCancelled - Confirming - ConfirmingWaitList - ConfirmedTimeChange enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 JourneyPriceBreakdownBase: type: object description: "Defines the journey price breakdown base.\n " additionalProperties: false properties: totalAmount: type: number description: "The journey price total.\n " format: decimal totalPoints: type: number description: "The journey points total.\n " format: decimal totalTax: type: number description: "The journey taxes total.\n " format: decimal totalDiscount: type: number description: "The journey discount total.\n " format: decimal BookingQueueDetail: type: object description: "The detail in a booking queue model.\n " additionalProperties: false properties: bookingQueueDetailKey: type: - string - 'null' description: "The booking queue detail key.\n " detail: type: - string - 'null' description: "The booking queue detail.\n " passengerAlternateKey: type: - string - 'null' description: "The detail passenger alternate key.\n " passengerTicketInfo: description: "The passenger ticket info detail.\n " $ref: '#/components/schemas/PassengerTicketInfo' PassengerSsr: type: object description: "The model for a passengers Ssr details.\n " additionalProperties: false properties: note: type: - string - 'null' description: "The passenger SSR note.\n " maxLength: 128 minLength: 0 count: type: integer description: "The passenger SSR unit value.\n " maximum: 32767.0 minimum: 1.0 inBundle: type: boolean description: "Indicates if the SSR is part of a bundle.\n " ssrDuration: description: "The length of the Ssr duration.\n " $ref: '#/components/schemas/SsrDurationType' ssrCode: type: - string - 'null' description: "The passenger SSR code.\n " maxLength: 4 minLength: 0 passengerKey: type: - string - 'null' description: "The unique passenger key.\n " ssrNumber: type: - integer - 'null' description: "The passenger SSR number.\n " maximum: 32767.0 minimum: 0.0 market: description: "The market for either the leg or segment depending on the Ssr type.\n " $ref: '#/components/schemas/MarketInformation' isConfirmed: type: boolean description: "A status flag to indicate if the ssr has been confirmed or not.\n " isConfirmingUnheld: type: boolean description: "A status flag to indicate if the ssr is in a confirming unheld state.\n " ssrKey: type: - string - 'null' description: "The key that uniquely identifies the Ssr, passenger, and leg or segment.\n " feeCode: type: - string - 'null' description: "The SSR fee code.\n " maxLength: 6 minLength: 0 ssrDetail: type: - string - 'null' description: "The passenger SSR detail.\n " maxLength: 20 minLength: 0 TypeOfSale: type: object description: "Defines the type of sale values.\n " additionalProperties: false properties: residentCountry: type: - string - 'null' description: "The resident country.\n " maxLength: 2 minLength: 0 promotionCode: type: - string - 'null' description: "The promo code that was applied.\n " maxLength: 8 minLength: 0 fareTypes: type: - array - 'null' description: "The collection of fare types applied.\n " items: type: string MoveJourneyRequest: type: object description: "Defines the move journey request.\n " deprecated: true x-deprecatedMessage: 4.5.3 - Please use MoveJourneyRequestv2 instead. additionalProperties: false required: - fromJourneyKey - toJourneyKey - fareKey properties: fromJourneyKey: type: string description: "The key of the journey that is being moved from.\n " minLength: 1 toJourneyKey: type: string description: "The key of the journey that is being moved to.\n " minLength: 1 fareKey: type: string description: "The fare key to move to.\n " minLength: 1 standbyPriorityCode: type: - string - 'null' description: "Standby priority code.\n " inventoryControlType: description: "Inventory control.\n " $ref: '#/components/schemas/InventoryControlType' changeReasonCode: description: "Change reason code.\n " $ref: '#/components/schemas/StatelessChangeReasonCodes' bookingComment: type: - string - 'null' description: "A comment to be added to the effected booking.\n " adHocConnection: type: boolean description: "Flag representing if an ad hoc connection is needed.\n " adHocIsForGeneralUse: type: boolean description: "Flag that sets the \"For General Use\" setting when creating an ad hoc connection.\n " CheckinPassengersRequest: type: object description: "Defines the checkin passengers request.\n " additionalProperties: false required: - passengers properties: seatsRequired: type: - boolean - 'null' description: "The flag indicating whether a seat is required for checkin.\n " skipSecurityChecks: type: - boolean - 'null' description: "The flag indicating whether checkin requirement validation will be skipped.\n " isStandby: type: - boolean - 'null' description: "The flag indicating whether the collection of passengers are for standby checkin.\n " passengers: type: array description: "The collection of passengers to checkin.\n " items: $ref: '#/components/schemas/CheckinPassengerRequest' ChargeBreakdown: type: object description: "Defines a charge breakdown.\n " additionalProperties: false properties: total: type: - number - 'null' description: "The total amount.\n " format: decimal taxes: type: - number - 'null' description: "The total fee taxes amount.\n " format: decimal adjustments: type: - number - 'null' description: "The total adjusted amount.\n " format: decimal charges: type: - array - 'null' description: "The collection of charges within the calculation.\n " items: $ref: '#/components/schemas/ServiceCharge' FlightMoveHistory: type: object description: "Defines a flight move history log entry.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " $ref: '#/components/schemas/PointOfSale' receivedBy: type: - string - 'null' description: "The received by name.\n " maxLength: 64 minLength: 0 receivedByReference: type: - string - 'null' description: "The received by reference number.\n " maxLength: 20 minLength: 0 createdDate: type: - string - 'null' description: "The the history entry was created.\n " format: date-time previousMarket: description: "The previous market designator for the journey the passenger\nwas moved from.\n " $ref: '#/components/schemas/MarketDesignator' newMarket: description: "The new market designator for the journey the passenger\nwas moved to.\n " $ref: '#/components/schemas/MarketDesignator' previousIdentifier: type: - string - 'null' description: "The previous transportation identifier for the journey the passenger\nwas moved from.\n " newIdentifier: type: - string - 'null' description: "The new transportation identifier for the journey the passenger\nwas moved to.\n " changeReason: description: "The reason for the move operation.\n " $ref: '#/components/schemas/ChangeReasonCodes' SeatAssignmentHistory: type: object description: "Defines a seat assignment history log entry.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " $ref: '#/components/schemas/PointOfSale' receivedBy: type: - string - 'null' description: "The received by name.\n " maxLength: 64 minLength: 0 receivedByReference: type: - string - 'null' description: "The received by reference number.\n " maxLength: 20 minLength: 0 createdDate: type: - string - 'null' description: "The the history entry was created.\n " format: date-time designator: description: "The market designator.\n " $ref: '#/components/schemas/MarketDesignator' identifier: type: - string - 'null' description: "The unique transportation identifier.\n " seatAssignment: type: - string - 'null' description: "The seat assignment.\n " compartment: type: - string - 'null' description: "The compartment containing the seat.\n " name: description: "The passenger name.\n " $ref: '#/components/schemas/Name' OrderLocation: type: object description: "Defines a location.\n " additionalProperties: false required: - code - usageDate properties: code: type: string description: "The unique location code.\n " minLength: 1 usageDate: type: string description: "The usage date at this location.\n " format: date-time minLength: 1 description: type: - string - 'null' description: "The location description.\n " utcOffset: type: number description: "The UTC offset.\n " format: float AccountType: type: integer description: "The account type enumeration.\n \n\n0 = Credit\n1 = Prepaid\n2 = Supplementary\n3 = Dependent\n4 = Unknown" x-enumNames: - Credit - Prepaid - Supplementary - Dependent - Unknown enum: - 0 - 1 - 2 - 3 - 4 Gender: type: integer description: "Defines the different binary gender types.\n \n\n0 = XX\n1 = Male\n2 = Female" x-enumNames: - XX - Male - Female enum: - 0 - 1 - 2 BookingsCommentRequest: type: object description: "Defines a booking comment.\n " additionalProperties: false properties: type: description: "Indicates where the comment will be seen.\n " $ref: '#/components/schemas/CommentType' text: type: - string - 'null' description: "The text of the comment.\n " maxLength: 1024 minLength: 0 createdDate: type: - string - 'null' description: "The created date of the comment.\n " format: date-time FareStatus: type: integer description: "This enumeration defines the fare status of a passenger fare.\n \n\n0 = Default\n1 = SameDayStandBy\n2 = FareOverrideConfirming\n3 = FareOverrideConfirmed\n4 = PublishedFareOverrideConfirming\n5 = PublishedFareOverrideConfirmed" x-enumNames: - Default - SameDayStandBy - FareOverrideConfirming - FareOverrideConfirmed - PublishedFareOverrideConfirming - PublishedFareOverrideConfirmed enum: - 0 - 1 - 2 - 3 - 4 - 5 BookingSearchByPersonResult: type: object description: "Defines the search booking by person result.\n " additionalProperties: false properties: bookingDate: type: - string - 'null' description: "Returns the latest date that the booking was created.\n " format: date-time departureDate: type: - string - 'null' description: "The departure date is associated with the returned leg of the booking.\n " format: date-time arrivalStation: type: - string - 'null' description: "The arrival station code. For all configured stations see GET /api/nsk/v1/resources/Stations\n " maxLength: 3 minLength: 3 departureStation: type: - string - 'null' description: "The departure station code. For all configured stations see GET /api/nsk/v1/resources/Stations\n " maxLength: 3 minLength: 3 recordLocator: type: - string - 'null' description: "The record locator which uniquely identifies the booking.\n " bookingKey: type: - string - 'null' description: "The booking key is another unique identifier similar to the record locator. Due to technical reasons some endpoints will require it vs the record locator.\n " FeeType: type: integer description: "Enumeration representing all the different fee types.\n \n\n0 = All\n1 = Tax\n2 = TravelFee\n3 = ServiceFee\n4 = PaymentFee\n5 = PenaltyFee\n6 = SsrFee\n7 = NonFlightServiceFee\n8 = UpgradeFee\n9 = SeatFee\n10 = BaseFare\n11 = SpoilageFee\n12 = NameChangeFee\n13 = ConvenienceFee\n14 = BaggageFee\n15 = FareSurcharge\n16 = PromotionDiscount\n17 = ServiceBundle\n18 = ExtraBagFee\n19 = ATPCOBagFee" x-enumNames: - All - Tax - TravelFee - ServiceFee - PaymentFee - PenaltyFee - SsrFee - NonFlightServiceFee - UpgradeFee - SeatFee - BaseFare - SpoilageFee - NameChangeFee - ConvenienceFee - BaggageFee - FareSurcharge - PromotionDiscount - ServiceBundle - ExtraBagFee - ATPCOBagFee enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 IJsonResponseOfBooking: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Booking' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PaymentVoucherDetails: type: object description: "Payment voucher details. This describes a voucher applied to a payment.\n " additionalProperties: false properties: id: type: integer description: "The voucher ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 transactionId: type: integer description: "The vouchers transactions ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 overrideRestrictions: type: boolean description: "Flag indicating if the voucher restrictions were overridden.\n " overrideAmount: type: boolean description: "The amount applied of the voucher.\n " recordLocator: type: - string - 'null' description: "The record locator attached to the voucher.\n " maxLength: 12 minLength: 0 IJsonResponseOfIListOfWatchListResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/WatchListResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' LegNest: type: object description: "A model representing a leg nest.\n " additionalProperties: false properties: adjustedCapacity: type: integer description: "Gets or sets the adjusted capacity of the nest.\n " classNest: type: integer description: "Gets or sets the nest class nest.\n " lid: type: integer description: "Gets or sets the nest lid.\n " travelClassCode: type: - string - 'null' description: "Gets or sets the nest travel class code.\nPlease note that this should be a char and not a string.\n " maxLength: 1 nestType: description: "Gets or sets the type of the nest.\n " $ref: '#/components/schemas/NestType' legClasses: type: - array - 'null' description: "Gets or sets the nest leg classes.\n " items: $ref: '#/components/schemas/LegClass' BookingQueueRequestv2: type: object description: "The booking queue request v2 model.\n " additionalProperties: false required: - queueCode properties: queueCode: type: string description: "The code for the booking queue.\n " maxLength: 6 minLength: 0 notes: type: - string - 'null' description: "The notes for the booking request.\n " password: type: - string - 'null' description: "The Password needed to access the queue. Required if queue\nis set to password-protected in Sky Manager.\n " BookingMessageHistoryType: type: integer description: "Represents the booking message history types.\n \n\n0 = TeletypeMessage\n1 = ETicket\n2 = GovernmentSecurity\n3 = PnrGovernment\n4 = BaggageMessage\n5 = Iatci\n6 = EMD" x-enumNames: - TeletypeMessage - ETicket - GovernmentSecurity - PnrGovernment - BaggageMessage - Iatci - EMD enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 LegClass: type: object description: "The leg class model information.\n " additionalProperties: false required: - classOfService properties: classAllotted: type: integer description: "The leg class allotted.\n " classAuthorizedUnits: type: integer description: "The leg class Authorized Units (AUs).\n " classOfService: type: string description: "The leg class, class of service.\n " maxLength: 8 minLength: 0 classRank: type: integer description: "The leg class rank.\n " classSold: type: integer description: "The class sold.\n " cnxSold: type: integer description: "The CNX sold.\n " latestAdvancedReservation: type: integer description: "The latest advanced reservation.\n " status: description: "The status.\n " $ref: '#/components/schemas/ClassStatus' thruSold: type: integer description: "The thru sold.\n " classNest: type: integer description: "The leg class nest.\n " classType: type: - string - 'null' description: "The type of class.\n " DirectCurrencyConversion: type: object description: "Defines a direct currency conversion.\n " additionalProperties: false properties: rateId: type: string description: "The rate ID.\n " format: guid currencyCode: type: - string - 'null' description: "The currency code converted to.\n " maxLength: 3 minLength: 0 rateValue: type: number description: "The conversion rate value.\n " format: decimal amount: type: number description: "The conversion rate amount.\n " format: decimal putInState: type: - string - 'null' description: "The put in state value.\n " status: description: "The conversion status.\n " $ref: '#/components/schemas/DirectCurrencyConversionStatus' applicable: type: boolean description: "Flag indicating if DCC is applicable.\n " IJsonResponseOfPagedTransactionResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PagedTransactionResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' FareDesignator: type: object description: "Model describing the fare designator information.\n " additionalProperties: false properties: fareTypeCodes: type: - array - 'null' description: "The fares carrier code.\n " items: type: string LegStatus: type: integer description: "Leg status enumeration.\n \n\n0 = Normal\n1 = Closed\n2 = Canceled\n3 = Suspended\n5 = ClosedPending\n6 = BlockAllActivities\n7 = Mishap" x-enumNames: - Normal - Closed - Canceled - Suspended - ClosedPending - BlockAllActivities - Mishap enum: - 0 - 1 - 2 - 3 - 5 - 6 - 7 ItinerarySentHistory: type: object description: "Defines an itinerary sent history log entry.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " $ref: '#/components/schemas/PointOfSale' receivedBy: type: - string - 'null' description: "The received by name.\n " maxLength: 64 minLength: 0 receivedByReference: type: - string - 'null' description: "The received by reference number.\n " maxLength: 20 minLength: 0 createdDate: type: - string - 'null' description: "The the history entry was created.\n " format: date-time contact: type: - string - 'null' description: "The booking contact triggering the sending of the itinerary.\n " distributionOption: description: "The distribution method in sending the itinerary.\n " $ref: '#/components/schemas/DistributionOption' sent: type: string description: "The timestamp on when the itinerary was sent.\n " format: date-time SubscriptionEventType: type: integer description: "Represents the different subscription events.\n \n\n0 = Unknown\n1 = Departure\n2 = DepartureDelay\n3 = Arrival\n4 = ArrivalDelay\n5 = ScheduleChange\n6 = CheckIn\n7 = Gate\n8 = IropMove\n9 = InventoryCancel" x-enumNames: - Unknown - Departure - DepartureDelay - Arrival - ArrivalDelay - ScheduleChange - CheckIn - Gate - IropMove - InventoryCancel enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 IJsonResponseOfAccount: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Account' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' SeatPreferences: type: object description: "Represents the seating preferences base model.\n " additionalProperties: false properties: seat: description: "The simple seating preference.\n " $ref: '#/components/schemas/SimpleSeatPreference' travelClass: description: "The preferred travel class of service.\n " $ref: '#/components/schemas/TravelClassSeatPreference' advancedPreferences: type: - array - 'null' description: "The advanced seating preferences.\n " items: $ref: '#/components/schemas/SeatPreference' AddOnPriceBreakdown: type: object description: "Defines the addOn price breakdown.\n " additionalProperties: false properties: car: type: - number - 'null' description: "The car price total.\n " format: decimal hotel: type: - number - 'null' description: "The hotel price total.\n " format: decimal activities: type: - number - 'null' description: "The activities price total.\n " format: decimal PhoneNumberType: type: integer description: "Defines the types of phone numbers. Note: New Skies does not support Mobile for booking contacts.\n \n\n0 = Other\n1 = Home\n2 = Work\n3 = Mobile\n4 = Fax" x-enumNames: - Other - Home - Work - Mobile - Fax enum: - 0 - 1 - 2 - 3 - 4 Contact: type: object description: "Contact model describing a person contact information.\n " additionalProperties: false required: - contactTypeCode properties: phoneNumbers: type: - array - 'null' description: "The collection of phone numbers.\nSupported types: Home, Work, Fax, Other.\nThis collections can only contain one number for each supported type.\n " items: $ref: '#/components/schemas/PhoneNumber' cultureCode: type: - string - 'null' description: "The culture code.\n " maxLength: 17 minLength: 0 address: description: "The contact address.\n " $ref: '#/components/schemas/Address' emailAddress: type: - string - 'null' description: "The email address of the contact.\n " customerNumber: type: - string - 'null' description: "The customer number.\n " maxLength: 20 minLength: 0 sourceOrganization: type: - string - 'null' description: "Source organization.\n " maxLength: 10 minLength: 0 distributionOption: description: "The contact distribution option.\n " $ref: '#/components/schemas/DistributionOption' notificationPreference: description: "The notification preference of the contact.\n " $ref: '#/components/schemas/NotificationPreference' companyName: type: - string - 'null' description: "The company name.\n " maxLength: 64 minLength: 0 name: description: "The contact's name.\n " $ref: '#/components/schemas/Name' contactTypeCode: type: string description: "The contact type code. There can only be one contact of a specific type on the booking.\nTypically only one contact is used. Null values will be replaced by the primary contact type code.\nPlease note that this should be a char and not a string.\n " maxLength: 1 minLength: 1 PriceStatus: type: integer description: "Describes the fare pricing status\n \n\n0 = Invalid\n1 = Override\n2 = Valid" x-enumNames: - Invalid - Override - Valid enum: - 0 - 1 - 2 BookingPointOfSale: type: object description: "Model related to the point of sale.\n " additionalProperties: false properties: agentCode: type: - string - 'null' description: "The point of sale agent code.\n " domainCode: type: - string - 'null' description: "The point of sale domain code.\n " locationCode: type: - string - 'null' description: "The point of sale location code.\n " organizationCode: type: - string - 'null' description: "The point of sale organization code.\n " isoCountryCode: type: - string - 'null' description: "Two character country code, optionally supplied in GDS message\n " sourceSystemCode: type: - string - 'null' description: "Two character system code, optionally supplied in GDS message\n " IJsonResponseOfSegmentChangeHistoryResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/SegmentChangeHistoryResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' Message: type: object description: "Defines a unique informational message.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The unique message code.\n " type: type: - string - 'null' description: "The message type.\n " value: type: - string - 'null' description: "The message's value.\n " status: description: "The message's status.\n " $ref: '#/components/schemas/MessageStatus' details: type: - object - 'null' description: "Dynamic detailed information about the message.\n " additionalProperties: type: string IJsonResponseOfIListOfBookingSearchResult: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/BookingSearchResult' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' SegmentTypes: type: integer description: "Indicates the type of a segment.\n \n\n0 = Normal\n1 = CodeShareOperating\n2 = CodeShareMarketing\n3 = InterlineOutbound\n4 = InterlineInbound\n5 = Passive" x-enumNames: - Normal - CodeShareOperating - CodeShareMarketing - InterlineOutbound - InterlineInbound - Passive enum: - 0 - 1 - 2 - 3 - 4 - 5 Payment: type: object description: "Defines an applied payment on the booking.\n " additionalProperties: false properties: paymentKey: type: - string - 'null' description: "The payment key that uniquely identifies the payment.\n " code: type: - string - 'null' description: "The payment method code.\n " maxLength: 2 minLength: 0 approvalDate: type: - string - 'null' description: "Date when the card/payment is approved in the database.\n " format: date-time details: description: "The payment detail information.\n " $ref: '#/components/schemas/PaymentDetails' amounts: description: "The payment amounts and currency codes.\n " $ref: '#/components/schemas/PaymentAmounts' authorizationCode: type: - string - 'null' description: "The banks auth code when funds are released.\n " maxLength: 10 minLength: 0 authorizationStatus: description: "The real payment status that should never be exposed to the end user unless a agent.\n " $ref: '#/components/schemas/AuthorizationStatus' fundedDate: type: - string - 'null' description: "The date restriction for a payment (when funds will be there).\n " format: date-time transactionCode: type: - string - 'null' description: "Used for credit shell payments and how to compute the expiration of the credit.\n " dcc: description: "DCC payment details.\n " $ref: '#/components/schemas/DirectCurrencyConversion' threeDSecure: description: "3DS payment details.\n " $ref: '#/components/schemas/ThreeDSecure' attachments: type: - array - 'null' description: "The list of payment attachments.\n " items: $ref: '#/components/schemas/PaymentAttachment' createdDate: type: - string - 'null' description: "The date the payment was created on.\n " format: date-time modifiedDate: type: - string - 'null' description: "The date the payment was modified.\n " format: date-time type: description: "The payment method type.\n " $ref: '#/components/schemas/PaymentMethodType' status: description: "The status of the booking (this is the safe status).\n " $ref: '#/components/schemas/BookingPaymentStatus' transferred: type: boolean description: "Flag that indicates if the payment is a result of a divide.\n " channelType: description: "The channel type that the payment was made through.\n " $ref: '#/components/schemas/ChannelType' pointOfSale: description: "The payments point of sale information.\n " $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The payments source point of sale information.\n " $ref: '#/components/schemas/PointOfSale' deposit: type: boolean description: "Flag indicating if the payment is a deposit.\n " accountId: type: integer description: "Used to identify a credit shell, credit file and agency payments.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 voucher: description: "The applied voucher details.\n " $ref: '#/components/schemas/PaymentVoucherDetails' addedToState: type: boolean description: "Flag indicating if the payment has been added to state or not.\n " createdAgentId: type: integer description: "The created agents ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 modifiedAgentId: type: integer description: "The modified agents ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 reference: type: integer description: "The reference to the payment.\n " format: int64 passengerVoucher: description: "The passenger voucher.\n " $ref: '#/components/schemas/PassengerVoucher' AddOnDetails: type: object description: "Defines a booking add on base details.\n " additionalProperties: false properties: agentCode: type: - string - 'null' description: "The created agent code.\n " organizationCode: type: - string - 'null' description: "The created organization code.\n " domainCode: type: - string - 'null' description: "The created domain code.\n " locationCode: type: - string - 'null' description: "The created location code.\n " MarketInformation: type: object description: "Model information about the market arrival and destination details.\n " additionalProperties: false required: - destination - origin - departureDate - identifier properties: destination: type: string description: "Gets or sets the leg arrival station.\n " maxLength: 3 minLength: 0 origin: type: string description: "Gets or sets the leg departure station.\n " maxLength: 3 minLength: 0 departureDate: type: string description: "The departure date.\n " format: date-time minLength: 1 identifier: description: "Gets or sets the leg arrival station.\n " $ref: '#/components/schemas/TransportationIdentifier' IJsonResponseOfPassengerDocumentCheckResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerDocumentCheckResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' SegmentChangeHistory: type: object description: "Defines a segment change history log entry.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " $ref: '#/components/schemas/PointOfSale' receivedBy: type: - string - 'null' description: "The received by name.\n " maxLength: 64 minLength: 0 receivedByReference: type: - string - 'null' description: "The received by reference number.\n " maxLength: 20 minLength: 0 createdDate: type: - string - 'null' description: "The the history entry was created.\n " format: date-time daysOfWeek: type: - array - 'null' description: "The days of the week of the operation.\n " items: $ref: '#/components/schemas/DayOfWeek' segmentNumber: type: - integer - 'null' description: "The segment number.\n " classOfService: type: - string - 'null' description: "The class of service.\n " market: description: "The market information.\n " $ref: '#/components/schemas/MarketInformation' stopCount: type: integer description: "The number of stops in the reservation.\n " connectionIndicator: type: - string - 'null' description: "The connection indicator.\nPlease note that this should be a char and not a string.\n " maxLength: 1 passengerCount: type: integer description: "The number of passengers on the booking.\n " scheduledArrivalTime: type: - string - 'null' description: "The scheduled time of arrival local to the arrival station.\n " format: date-time scheduledDepartureTime: type: - string - 'null' description: "The scheduled time of departure local to the arrival station.\n " format: date-time fareBasis: type: - string - 'null' description: "An alphanumeric identifier assigned to a fare.\n " fareAmount: type: - number - 'null' description: "The cash value of the fare.\n " format: decimal Transaction: type: object description: "The transaction model.\n " additionalProperties: false required: - amount - currencyCode properties: amount: type: number description: "The credit account transaction amount.\n " format: decimal currencyCode: type: string description: "The credit account transaction currency code.\n " maxLength: 3 minLength: 0 note: type: - string - 'null' description: "The credit account transaction note.\n " maxLength: 128 minLength: 0 accountTransactionCode: type: - string - 'null' description: "The system-generated code for the transaction.\n " recordLocator: type: - string - 'null' description: "The record locator from the refunded booking payment. This property is redundant and the same information can be\nfound on the AccountReference property.\n " deprecated: true x-deprecatedMessage: 4.4.4 - Please use Account Reference instead. accountReference: type: - string - 'null' description: "The account reference. This property may contain a record locator, account number, string value, or may be null\ndepending on the transaction type.\n " transactionKey: type: - string - 'null' description: "The unique transaction key.\n " createdDate: type: - string - 'null' description: "The created date associated with the transaction.\n " format: date-time foreignAmount: type: number description: "The transaction foreign amount.\n " format: decimal foreignCurrencyCode: type: - string - 'null' description: "The transaction foreign currency code.\n " maxLength: 3 minLength: 0 type: description: "The transaction type.\n " $ref: '#/components/schemas/TransactionType' paymentId: type: integer description: "The payment ID of the transaction. This will only be non zero on refunded booking payments. A zero signifies that\nno payment ID is found.\n " format: int64 accountCollectionKey: type: - string - 'null' description: "The account collection key associated with the transaction.\n " ArrivalStatus: type: integer description: "Arrival status.\n \n\n0 = Default\n1 = Cancelled\n2 = Arrived\n3 = SeeAgent\n4 = Delayed" x-enumNames: - Default - Cancelled - Arrived - SeeAgent - Delayed enum: - 0 - 1 - 2 - 3 - 4 BookingQueueHistoryRequest: type: object description: "The booking queue history request model.\n " additionalProperties: false properties: password: type: - string - 'null' description: "The password needed to access the queue. Required if queue\nis set to password-protected in Sky Manager.\n " lastPageIndex: type: - integer - 'null' description: "Indicates the last item number in the history list that was returned.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 1.0 pageSize: type: - integer - 'null' description: "Used to specify the number of records to return when paging is supported.\nThis is optional.\n " maximum: 5000.0 minimum: 10.0 fromArchive: type: boolean description: "Gets or sets the from archive flag needed to access the queue.\n " ChannelType: type: integer description: "Defines the available channel types doing invoking the communication with the server.\n \n\n0 = Default\n1 = Direct\n2 = Web\n3 = Gds\n4 = Api\n5 = DigitalApi\n6 = DigitalWeb\n7 = Ndc" x-enumNames: - Default - Direct - Web - Gds - Api - DigitalApi - DigitalWeb - Ndc enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 PassengerTypeCriteria: type: object description: "Defines the availability criteria passenger types.\n " additionalProperties: false required: - types properties: types: type: array description: "The list of passenger types and counts.\n " items: $ref: '#/components/schemas/PassengerSearchCriteria' residentCountry: type: - string - 'null' description: "The passenger resident country.\n " maxLength: 2 minLength: 0 OrderCriteria: type: object description: "Defines a products order criteria.\n " additionalProperties: false properties: countryCode: type: - string - 'null' description: "The country code (source or market of the customer).\n " departmentCode: type: - string - 'null' description: "The department code.\n " companyCode: type: - string - 'null' description: "The company code.\n " ratingCode: type: - string - 'null' description: "The rating code.\n " discountCode: type: - string - 'null' description: "The discount code.\n " promotionCode: type: - string - 'null' description: "The promotion code.\n " currencyCode: type: - string - 'null' description: "The currency code.\n " categoryCode: type: - string - 'null' description: "The category code to search with.\n " catalogCode: type: - string - 'null' description: "The catalog code.\n " supplierCode: type: - string - 'null' description: "The suppliers code.\n " vendorCode: type: - string - 'null' description: "The orders vendor.\n " IJsonResponseOfIDictionaryOfStringAndIListOfCheckinPassengerLiftStatus: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - object - 'null' description: "The payload data.\n " additionalProperties: type: array items: $ref: '#/components/schemas/CheckinPassengerLiftStatus' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' BookingHistoryEvent: type: integer description: "Represents the different events that trigger an\nentry into the schedule history.\n \n\n0 = Unknown\n1 = ConvertedHistory\n2 = FlightTimeChange\n3 = FlightDesignatorChange\n4 = AssignedSeat\n5 = RemoveSeat\n6 = AddedFlight\n7 = DeletedFlight\n8 = DeletedPassenger\n9 = NameChange\n10 = GroupNameChange\n11 = CancelledTicketing\n12 = ScheduleChange\n13 = AddedPayment\n14 = ServiceFee\n15 = QueuedPnr\n16 = UnqueuedPnr\n17 = DeletedComment\n18 = Divided\n19 = CheckedIn\n20 = CheckedOut\n21 = FareOverride\n22 = AddedBaggage\n23 = ChangedBaggageWeight\n24 = CheckedBaggage\n25 = RemovedBaggage\n26 = BoardedPassenger\n27 = UnboardedPassenger\n28 = ManualAuthorization\n29 = ManualDecline\n30 = UndoCancel\n31 = ItinerarySent\n32 = ContactChange\n33 = SsrAdded\n34 = FlightMoved\n35 = VerifiedDocument\n36 = RemovedVerifiedDocument\n37 = Promotion\n38 = BookingComment\n39 = CancelledSchedule\n40 = CancelServiceFee\n41 = OverrideServiceFee\n42 = AddedRecordLocator\n43 = DeletedRecordLocator\n44 = UpgradeClassOfService\n45 = DowngradeClassOfService\n46 = StandbyPriorityChange\n47 = AssignedTicketNumber\n48 = DeletedTicketNumber\n49 = ConfirmSegmentStatusCodeChange\n50 = CodeshareFlightChanged\n51 = PdsCancel\n52 = PdsPending\n53 = PdsConfirm\n54 = PdsFinalized\n55 = PdsDeclined\n56 = PdsException\n57 = PdsCancelRefused\n58 = PdsCancelUnsuccessful\n59 = Apps\n60 = InhibitedOverride\n61 = PrintedBagTag\n62 = SelfPrintedBagTag\n63 = PrintedBoardingPass\n64 = AddCustomerId\n65 = DeleteCustomerId\n66 = HoldCreated\n67 = HoldRemoved\n68 = HoldChanged\n69 = OverrideCoupon\n70 = PdsSynchronized\n71 = PdsItemremoved\n72 = Reprice\n73 = ChannelOverride\n74 = EmdCreated\n75 = EmdRemoved\n76 = EmdChanged\n77 = ServiceBundle\n78 = PublishedFareOverride\n79 = FareClassRealignment\n80 = AddedDocument\n81 = ChangedDocument\n82 = DeletedPaymentProperties" x-enumNames: - Unknown - ConvertedHistory - FlightTimeChange - FlightDesignatorChange - AssignedSeat - RemoveSeat - AddedFlight - DeletedFlight - DeletedPassenger - NameChange - GroupNameChange - CancelledTicketing - ScheduleChange - AddedPayment - ServiceFee - QueuedPnr - UnqueuedPnr - DeletedComment - Divided - CheckedIn - CheckedOut - FareOverride - AddedBaggage - ChangedBaggageWeight - CheckedBaggage - RemovedBaggage - BoardedPassenger - UnboardedPassenger - ManualAuthorization - ManualDecline - UndoCancel - ItinerarySent - ContactChange - SsrAdded - FlightMoved - VerifiedDocument - RemovedVerifiedDocument - Promotion - BookingComment - CancelledSchedule - CancelServiceFee - OverrideServiceFee - AddedRecordLocator - DeletedRecordLocator - UpgradeClassOfService - DowngradeClassOfService - StandbyPriorityChange - AssignedTicketNumber - DeletedTicketNumber - ConfirmSegmentStatusCodeChange - CodeshareFlightChanged - PdsCancel - PdsPending - PdsConfirm - PdsFinalized - PdsDeclined - PdsException - PdsCancelRefused - PdsCancelUnsuccessful - Apps - InhibitedOverride - PrintedBagTag - SelfPrintedBagTag - PrintedBoardingPass - AddCustomerId - DeleteCustomerId - HoldCreated - HoldRemoved - HoldChanged - OverrideCoupon - PdsSynchronized - PdsItemremoved - Reprice - ChannelOverride - EmdCreated - EmdRemoved - EmdChanged - ServiceBundle - PublishedFareOverride - FareClassRealignment - AddedDocument - ChangedDocument - DeletedPaymentProperties enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 - 52 - 53 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 - 82 PassengerVoucherUsageType: type: integer description: "Passenger voucher usage type specifies what parts of a booking this voucher can pay for.\n \n\n0 = None\n1 = Fares\n2 = Taxes\n3 = TravelFees\n4 = ServiceFees\n5 = PenaltyFees\n6 = SsrFees\n7 = NonFlightServiceFees\n8 = UpgradeFees\n9 = SeatFees\n10 = SpoilageFees\n11 = NameChangeFees\n12 = ConvenienceFees\n13 = Car\n14 = Hotel\n15 = Insurance\n16 = Activities\n17 = BaseFeeOnly" x-enumNames: - None - Fares - Taxes - TravelFees - ServiceFees - PenaltyFees - SsrFees - NonFlightServiceFees - UpgradeFees - SeatFees - SpoilageFees - NameChangeFees - ConvenienceFees - Car - Hotel - Insurance - Activities - BaseFeeOnly enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 CheckinPassengerRestrictionType: type: integer description: "Defines the checkin passenger restriction types.\n \n\n0 = NotFound\n1 = MissingDestinationAddress\n2 = MissingCountryOrResidence\n3 = OnLockQueue\n4 = MissingRequiredSsrs\n5 = ContainsRestrictedSsrs\n6 = IsSelectee\n7 = MissingSeat\n8 = NotConfirmed\n9 = NotStandby\n10 = ContainsUnknownSsr\n11 = MissingApisRequirement\n12 = MissingDocuments\n13 = MissingName\n14 = MissingInfantName\n15 = MissingDateOfBirth\n16 = MissingInfantDateOfBirth\n17 = RestrictedInfantInLap" x-enumNames: - NotFound - MissingDestinationAddress - MissingCountryOrResidence - OnLockQueue - MissingRequiredSsrs - ContainsRestrictedSsrs - IsSelectee - MissingSeat - NotConfirmed - NotStandby - ContainsUnknownSsr - MissingApisRequirement - MissingDocuments - MissingName - MissingInfantName - MissingDateOfBirth - MissingInfantDateOfBirth - RestrictedInfantInLap enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 IJsonResponseOfIListOfBookingNotificationHistory: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/BookingNotificationHistory' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' DistributionOption: type: integer description: "This enumeration specifies the distribution methods for sending notifications.\n \n\n0 = None\n1 = Mail\n2 = Email\n3 = Fax\n4 = MailFax\n5 = Airport\n6 = Hold\n7 = Print" x-enumNames: - None - Mail - Email - Fax - MailFax - Airport - Hold - Print enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 IJsonResponse: type: object description: "Defines the JSON response contract for a not content type response.\n " additionalProperties: false properties: data: description: "The payload data, this will always be null for errors responses and no content responses.\n " errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfItinerarySentHistoryResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ItinerarySentHistoryResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' AddOnCharge: type: object description: "Defines a booking add ons charge.\n " additionalProperties: false properties: type: description: "The charge type.\n " $ref: '#/components/schemas/ChargeType' code: type: - string - 'null' description: "The charge code.\n " ticketCode: type: - string - 'null' description: "The charge ticket code.\n " collection: description: "The charge collection type.\n " $ref: '#/components/schemas/CollectType' currencyCode: type: - string - 'null' description: "The currency code.\n " amount: type: number description: "The charged amount.\n " format: decimal details: type: - string - 'null' description: "The charge details.\n " OrderHistory: type: object description: "Defines a order history transaction.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The status code.\n " previousCode: type: - string - 'null' description: "The previous status code.\n " note: type: - string - 'null' description: "The history note.\n " created: type: string description: "The history entry created date.\n " format: date-time hasError: type: boolean description: "Flag indicating if has an error.\n " PassengerFee: type: object description: "Model representing passenger fee information.\n " additionalProperties: false required: - code properties: isConfirmed: type: boolean description: "A status flag to indicate if the fee has been confirmed or not.\n " isConfirming: type: boolean description: "A status flag to indicate if the fee is confirming or not.\n " isConfirmingExternal: type: boolean description: "A status flag to indicate if the fee is confirming external or not.\n " code: type: string description: "The fee code.\n " maxLength: 6 minLength: 0 detail: type: - string - 'null' description: "The fee detail.\n " maxLength: 32 minLength: 0 passengerFeeKey: type: - string - 'null' description: "The passenger fee key.\n " override: type: boolean description: "The fee override.\n " flightReference: type: - string - 'null' description: "The flight reference which signifies a link to a segment and or leg.\n " maxLength: 22 minLength: 0 note: type: - string - 'null' description: "The fee notes.\n " maxLength: 128 minLength: 0 createdDate: type: - string - 'null' description: "The created date for the fee.\n " format: date-time isProtected: type: boolean description: "Indicates if the fee is protected.\n " serviceCharges: type: - array - 'null' description: "The list of service charges for the fee.\n " items: $ref: '#/components/schemas/ServiceCharge' type: description: "The fee type.\n " $ref: '#/components/schemas/FeeType' ssrCode: type: - string - 'null' description: "The SSR code.\n " ssrNumber: type: integer description: "The fee SSR number.\n " paymentNumber: type: integer description: "The fee payment number.\n " IJsonResponseOfIListOfBookingMessageHistory: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/BookingMessageHistory' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' OverbookIndicatorTypes: type: integer description: "Specifies the type of code share agreement.\n \n\n0 = NormalSell\n1 = Oversold\n2 = ClassOrCabinOversold" x-enumNames: - NormalSell - Oversold - ClassOrCabinOversold enum: - 0 - 1 - 2 ThreeDSecure: type: object description: "Defines three D secure.\n " additionalProperties: false properties: browserUserAgent: type: - string - 'null' description: "The browser agent being used.\n " browserAccept: type: - string - 'null' description: "The browser agent accept.\n " remoteIpAddress: type: - string - 'null' description: "The remote IP address.\n " termUrl: type: - string - 'null' description: "The return URL from the bank.\n " paReq: type: - string - 'null' description: "The payload that will be sent to the bank site.\n " acsUrl: type: - string - 'null' description: "The URL to redirect to for TDS (aka the bank).\n " paRes: type: - string - 'null' description: "The response that comes back from the bank.\n " authResult: type: - string - 'null' description: "The result of 3DS.\n " cavv: type: - string - 'null' description: "The encrypted string of prof that 3DS was processed.\n " cavvAlgorithm: type: - string - 'null' description: "The algorithm that created the Cavv.\n " eci: type: - string - 'null' description: "The electronic commerce indicator (the level of 3DS).\n " xid: type: - string - 'null' description: "The transaction ID specific to the 3DS 3rd party processing.\n " applicable: type: boolean description: "Flag that indicates if more validation is needed.\n " successful: type: boolean description: "Flag indicating if 3DS was successful.\n " threeDSecureSessionId: type: - string - 'null' description: "The three d secure session id. This is returned by device data collection.\nThis ties the device data collection to the 3DSecure Lookup.\n " challengePreference: description: "The requested challenge preference.\nIndicates whether the merchant would like to force the issuer to present a 3DSecure challenge.\n " $ref: '#/components/schemas/ChallengePreference' challengeWindowSize: description: "The requested challenge window size.\nIndicates the preferred size of the 3DSecure challenge window.\n " $ref: '#/components/schemas/ChallengePreferenceWindowSize' transactionIdThreeDSecure: type: - string - 'null' description: "The transaction id three d secure. Used after completing 3DS Native challenge.\nThis is the equivalent of the 3DSecure Redirect PaRes value. For 3DSecure Native authentications,\nthe transaction ID should be populated in lieu of the PaRes.\n " threeDSecureVersion: type: - string - 'null' description: "The three d secure version. Indicates the version of 3DS that was applied during the authentication.\n " merchantData: type: - string - 'null' description: "Merchant data.\n " redirectJwt: type: - string - 'null' description: "The Jwt object created by SkyPay to use when redirecting a customer.\n " redirectJwtUrl: type: - string - 'null' description: "Secondary url that may be included in lieu or in addition to the Redirect Url.\n " dsTransactionId: type: - string - 'null' description: "The D S transaction id.\n " authenticationStatus: description: "The authentication status.\n " $ref: '#/components/schemas/AuthenticationStatus' CheckinAddressRequirements: type: object description: "Defines a passenger checkin address requirements.\n " additionalProperties: false properties: isValid: type: boolean description: "Flag indicating if the checkin address requirements are meet and ready/valid for checkin.\n " addressesOnFile: type: - array - 'null' description: "The collection of addresses that are tagged to a station code that already exist on the passenger.\n " items: type: string unhandledAddresses: type: - array - 'null' description: "The collection of unhandled tagged to station addresses required.\n " items: type: string GovernmentPassengerDocumentRequirement: type: object description: "Defines a specific government document requirements for a specific passenger.\n " deprecated: true x-deprecatedMessage: Obsolete as of 4.4.4, please use the v2. additionalProperties: false properties: governmentInstance: type: - string - 'null' description: "Identifies which instance of government security is associated with these specific requirements.\n " numberOfMissingDocuments: type: integer description: "The number of documents still missing.\n " eligibleDocuments: type: - array - 'null' description: "The collection of eligible documents that have not already been added by the passenger.\n " items: $ref: '#/components/schemas/GovernmentDocumentRequirement' Coordinate: type: object description: "The defined coordinates of a location.\n " additionalProperties: false properties: latitude: type: - string - 'null' description: "The locations latitude.\n " longitude: type: - string - 'null' description: "The locations longitude.\n " LiftStatus: type: integer description: "Lift status enumeration.\n \n\n0 = Default\n1 = CheckedIn\n2 = Boarded\n3 = NoShow" x-enumNames: - Default - CheckedIn - Boarded - NoShow enum: - 0 - 1 - 2 - 3 BaggageStatus: type: integer description: "Baggage Status enumeration.\n \n\n0 = Default\n1 = Checked\n2 = Removed\n3 = Added\n4 = AddedPrinted" x-enumNames: - Default - Checked - Removed - Added - AddedPrinted enum: - 0 - 1 - 2 - 3 - 4 OrderCustomer: type: object description: "Defines an order customer contact details.\n " additionalProperties: false properties: name: description: "The name of the consumer.\n " $ref: '#/components/schemas/Name' address: description: "The address of the consumer.\n " $ref: '#/components/schemas/ConsumerAddress' dateOfBirth: type: - string - 'null' description: "The date of birth of the consumer.\n " format: date-time emailAddress: type: - string - 'null' description: "The email address of the consumer.\n " companyName: type: - string - 'null' description: "The company name of the consumer.\n " type: type: - string - 'null' description: "The type of consumer (business or residential).\n " homePhone: type: - string - 'null' description: "The home phone number.\n " maxLength: 20 minLength: 0 workPhone: type: - string - 'null' description: "The work phone number.\n " maxLength: 20 minLength: 0 fax: type: - string - 'null' description: "The fax phone number.\n " maxLength: 20 minLength: 0 customerKey: type: - string - 'null' description: "The unique customer key.\n " customerNumber: type: - string - 'null' description: "The customer number.\n " TransportationDesignator: type: object description: "Model information about the traveling arrival and destination details.\n " additionalProperties: false properties: destination: type: - string - 'null' description: "Gets or sets the leg arrival station.\n " maxLength: 3 minLength: 0 origin: type: - string - 'null' description: "Gets or sets the leg departure station.\n " maxLength: 3 minLength: 0 arrival: type: string description: "The arrival date and time local to the arrival station.\n " format: date-time departure: type: string description: "The departure date and time local to the departure station.\n " format: date-time SeatAssignmentEvent: type: integer description: "Represents the different events that trigger an\nentry into the seat assignment history.\n \n\n4 = AssignedSeat\n5 = RemoveSeat" x-enumNames: - AssignedSeat - RemoveSeat enum: - 4 - 5 TransitType: type: integer description: "Defines the different type of transit states.\n \n\n0 = Default\n1 = Origin\n2 = Destination\n3 = Both" x-enumNames: - Default - Origin - Destination - Both enum: - 0 - 1 - 2 - 3 DepartureStatus: type: integer description: "Departure status.\n \n\n0 = Default\n1 = Cancelled\n2 = Boarding\n3 = SeeAgent\n4 = Delayed\n5 = Departed" x-enumNames: - Default - Cancelled - Boarding - SeeAgent - Delayed - Departed enum: - 0 - 1 - 2 - 3 - 4 - 5 CheckinPassengerRequestv2: type: object description: "Defines the individual passenger checkin request.\n " additionalProperties: false required: - passengerKey properties: passengerKey: type: string description: "The unique passenger key being checked in.\n " minLength: 1 transitType: description: "The passengers transit type.\n " $ref: '#/components/schemas/TransitType' processApps: type: - boolean - 'null' description: "Flag indicating to process APPS.\n " verifiedTravelDocumentKeys: type: - array - 'null' description: "The value specifying the verified travel document(s) associated with this checkin.\n " items: type: string Exception: type: object additionalProperties: false properties: Message: type: string InnerException: $ref: '#/components/schemas/Exception' Source: type: - string - 'null' StackTrace: type: - string - 'null' BookingStatus: type: integer description: "Booking Status Enumeration\n \n\n0 = Default\n1 = Hold\n2 = Confirmed\n3 = Closed\n4 = HoldCanceled\n5 = PendingArchive\n6 = Archived\n7 = ArchivedPrivate\n777 = ProcessedForArchive" x-enumNames: - Default - Hold - Confirmed - Closed - HoldCanceled - PendingArchive - Archived - ArchivedPrivate - ProcessedForArchive enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 777 JourneyPriceBreakdown: type: object description: "Defines a specifics journey pricing breakdown.\n " additionalProperties: false properties: totalAmount: type: number description: "The journey price total.\n " format: decimal totalPoints: type: number description: "The journey points total.\n " format: decimal totalTax: type: number description: "The journey taxes total.\n " format: decimal totalDiscount: type: number description: "The journey discount total.\n " format: decimal journeyKey: type: - string - 'null' description: "The unique journey key.\n " GovernmentAdditionalDataType: type: integer description: "Defines the additional data that is required for a government program but are not collected with documents.\n \n\n0 = CountryOfResidence\n1 = InTransitOrigin\n2 = InTransitDestination\n3 = DateOfBirth\n4 = Gender\n5 = FirstName\n6 = LastName" x-enumNames: - CountryOfResidence - InTransitOrigin - InTransitDestination - DateOfBirth - Gender - FirstName - LastName enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 PassengerInformation: type: object description: "Represents additional passenger information.\n " additionalProperties: false properties: nationality: type: - string - 'null' description: "The passenger's nationality.\n " maxLength: 2 minLength: 0 residentCountry: type: - string - 'null' description: "The resident country.\n " maxLength: 2 minLength: 2 gender: description: "The passenger's binary gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The passenger's date of birth.\n " format: date-time familyNumber: type: - integer - 'null' description: "The unique identifier of a family registered in the system.\n " declaredGender: type: - string - 'null' description: "The passenger's declared gender. A value of \"F\" is mapped to a female binary gender. All other values will be\nmapped to a male binary gender.\n " maxLength: 2 minLength: 0 LegSsr: type: object description: "A model representing a leg ssr summary.\n " additionalProperties: false properties: available: type: integer description: "The number of Ssrs available.\n " ssrNestCode: type: - string - 'null' description: "The SSR nest code.\n " maxLength: 4 minLength: 0 lid: type: integer description: "The maximum number of SSRs authorized to be sold on a nest.\n " sold: type: integer description: "The number of SSRs sold in the SSR nest.\n " unitSold: type: integer description: "The units of space sold for the SSR.\n " ProductVariationDetail: type: object description: "Defines a products variation detail.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The product variation detail code.\n " styleCode: type: - string - 'null' description: "The style code.\n " description: type: - string - 'null' description: "The product variation detail description.\n " PassengerVoucher: type: object description: "Defines a passenger voucher.\n " additionalProperties: false properties: passengerVoucherKey: type: - string - 'null' description: "The passenger voucher key.\n " passengerKey: type: - string - 'null' description: "The passenger key.\nWill be null if the voucher does not apply to a specific passenger.\n " voucherConfigurationCode: type: - string - 'null' description: "The voucher configuration code.\n " voucherUses: type: - array - 'null' description: "The list of voucher uses.\n " items: $ref: '#/components/schemas/PassengerVoucherUsageType' customerPrograms: type: - array - 'null' description: "The list of customer programs.\n " items: $ref: '#/components/schemas/PassengerVoucherCustomerProgram' customerNumber: type: - string - 'null' description: "The customer number of the customer record to which the voucher has been issued.\n " BagTagPrintHistoryRequest: type: object description: "Contains information needed to add bag tag print history for a specific passenger.\n " additionalProperties: false required: - legKey - bagTagInformation properties: legKey: type: string description: "Leg key where the bag is checked in.\n " minLength: 1 receivedBy: type: - string - 'null' description: "Received by.\n " passengerName: description: "The name of the passenger.\n " $ref: '#/components/schemas/Name' isBagTagSelfPrinted: type: - boolean - 'null' description: "Whether to make the bag tag status self printed.\n " bagTagInformation: type: array description: "List of bags to add to bag tag print history.\n " items: $ref: '#/components/schemas/BagTagInformation' IJsonResponseOfHistoryResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/HistoryResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' Leg: type: object description: "Model data describing the leg which is a single travel leg from point a to b.\n " additionalProperties: false properties: legKey: type: - string - 'null' description: "The unique identifier for this leg sell information.\n " designator: description: "Transportation information.\n " $ref: '#/components/schemas/TransportationDesignator' operationsInfo: description: "The operations information.\n " $ref: '#/components/schemas/OperationsInformation' legInfo: description: "The leg information.\n " $ref: '#/components/schemas/LegInformation' nests: type: - array - 'null' description: "The collection of leg nests.\n " items: $ref: '#/components/schemas/LegNest' ssrs: type: - array - 'null' description: "The Ssrs summary information.\n " items: $ref: '#/components/schemas/LegSsr' seatmapReference: type: - string - 'null' description: "The reference identifying what seatmap the leg is in associated to.\n " flightReference: type: - string - 'null' description: "The flight reference which signifies a link to a segment and or leg.\n " maxLength: 22 minLength: 0 PassengerTravelDocument: type: object description: "Model representing a passenger travel document.\n " additionalProperties: false required: - documentTypeCode properties: documentTypeCode: type: string description: "The unique travel document type code.\n " maxLength: 4 minLength: 0 issuedByCode: type: - string - 'null' description: "The issuer code for the travel document (country code).\n " maxLength: 3 minLength: 0 birthCountry: type: - string - 'null' description: "The BirthCountry property.\n " name: description: "The Name property.\n " $ref: '#/components/schemas/Name' nationality: type: - string - 'null' description: "The Nationality property.\n " maxLength: 2 minLength: 0 expirationDate: type: - string - 'null' description: "The date when this travel document expires.\n " format: date-time number: type: - string - 'null' description: "The travel document number.\n " maxLength: 35 minLength: 0 issuedDate: type: - string - 'null' description: "The date this travel document was issued.\n " format: date-time gender: description: "The travel document holder's gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The person's date of birth.\n " format: date-time declaredGender: type: - string - 'null' description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n " maxLength: 2 minLength: 0 placeOfBirth: type: - string - 'null' description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, numbers, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ placeOfIssue: type: - string - 'null' description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ passengerTravelDocumentKey: type: - string - 'null' description: "A key that uniquely identifies a travel document in the context of a specific passenger.\n " PhoneNumber: type: object description: "Defines a common phone number.\n " additionalProperties: false required: - number - type properties: number: type: string description: "The phone number without any formatting characters.\n " maxLength: 20 minLength: 0 type: description: "The phone number type.\n " $ref: '#/components/schemas/PhoneNumberType' SeatInfo: type: object description: "The model for the seat information such as deck, seat properties, etc.\n " additionalProperties: false properties: deck: type: integer description: "Gets or sets the deck.\n " seatSet: type: integer description: "Gets or sets the seat set.\n " propertyList: type: - object - 'null' description: "The property list by type code and value.\n " additionalProperties: type: string WeightCategory: type: integer description: "Defines the categories of adults by gender or specifies the passenger as a child. This is used for balance\ndeterminations.\n \n\n0 = Undefined\n1 = Male\n2 = Female\n3 = Child" x-enumNames: - Undefined - Male - Female - Child enum: - 0 - 1 - 2 - 3 IJsonResponseOfFlightMoveHistoryResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/FlightMoveHistoryResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' Segment: type: object description: "Segment model for an already booked flight.\n " additionalProperties: false properties: isStandby: type: boolean description: "Represents the stand by status of the segment.\n " isConfirming: type: boolean description: "Represents the confirming status of the segment.\n " isConfirmingExternal: type: boolean description: "Represents the pending external confirming status of the segment.\n " channelType: description: "The type of the channel from the user that added the segment.\n " $ref: '#/components/schemas/ChannelType' priorityCode: type: - string - 'null' description: "The priority code.\n " maxLength: 2 minLength: 0 salesDate: type: - string - 'null' description: "The segment sales date.\n " format: date-time flightReference: type: - string - 'null' description: "The flight reference which signifies a link to a segment and or leg.\n " maxLength: 22 minLength: 0 status: description: "Represents the segment status.\n " $ref: '#/components/schemas/SegmentStatus' isBlocked: type: boolean description: "Represents the blocked status of the segment.\n " isHosted: type: boolean description: "Represents the hosted status of the segment.\n " isChangeOfGauge: type: boolean description: "Represents the change of gauge status of the segment.\n " designator: description: "This is a summary of all the legs on the segment. It will contain the details\nof the transportation from the first and last leg.\n " $ref: '#/components/schemas/TransportationDesignator' segmentKey: type: - string - 'null' description: "The unique identifier for this segment sell information.\n " cabinOfService: type: - string - 'null' description: "The cabin of service.\nPlease note that this should be a char and not a string.\n " maxLength: 1 changeReasonCode: description: "The change reason code.\n " $ref: '#/components/schemas/ChangeReasonCodes' international: type: boolean description: "The value indicating if this segment is international.\n " legs: type: - array - 'null' description: "The legs.\n " items: $ref: '#/components/schemas/Leg' isSeatmapViewable: type: boolean description: "Indicates if the seatmaps associated with the segment are retrievable.\nSets to `false` for passive segments, and `true` for non-passive segments.\n " identifier: description: "The transportation identifier.\n " $ref: '#/components/schemas/TransportationIdentifier' externalIdentifier: description: "The external transportation identifier.\n " $ref: '#/components/schemas/TransportationIdentifier' segmentType: description: "The type of the segment.\n " $ref: '#/components/schemas/SegmentTypes' fares: type: - array - 'null' description: "The fares.\n " items: $ref: '#/components/schemas/Fare' passengerSegment: type: - object - 'null' description: "Passengers on this segment by passenger key.\n " additionalProperties: $ref: '#/components/schemas/PassengerSegment' DirectCurrencyConversionStatus: type: integer description: "Enumeration that determines the status of a DCC authorization.\n \n\n0 = DccNotOffered\n1 = DccOfferRejected\n2 = DccOfferAccepted\n3 = DccInitialValue\n4 = MccInUse" x-enumNames: - DccNotOffered - DccOfferRejected - DccOfferAccepted - DccInitialValue - MccInUse enum: - 0 - 1 - 2 - 3 - 4 OrderPayment: type: object description: "Defines a payment on an order.\n " additionalProperties: false required: - type properties: type: type: string description: "The payment type.\n " minLength: 1 name: description: "The name on the payment.\n " $ref: '#/components/schemas/Name' number: type: - string - 'null' description: "The number on the payment.\n " expiration: type: - string - 'null' description: "The expiration date.\n " format: date-time cvv: type: - string - 'null' description: "The CVV on the payment.\n " amount: type: number description: "The applied payment amount.\n " format: decimal description: type: - string - 'null' description: "The payment description.\n " issueNumber: type: - string - 'null' description: "The payment issue number.\n " address: description: "The payments address.\n " $ref: '#/components/schemas/Address' emailAddress: type: - string - 'null' description: "The provided email address.\n " format: email phoneNumbers: type: - array - 'null' description: "The collection of phone numbers.\n " items: $ref: '#/components/schemas/PhoneNumber' paymentKey: type: - string - 'null' description: "The unique order payment key.\n " currencyCode: type: - string - 'null' description: "The currency code the payment is in (will always be set to the bookings currency code).\n " Name: type: object description: "Defines a common name.\n " additionalProperties: false properties: first: type: - string - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 IJsonResponseOfItineraryQuote: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ItineraryQuote' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' ApisAddressStatus: type: integer description: "Defines what type of APIS requirement is the address.\n \n\n0 = Residence\n1 = InCountry\n2 = Emergency\n3 = Contact" x-enumNames: - Residence - InCountry - Emergency - Contact enum: - 0 - 1 - 2 - 3 SsrRequestByPassengerType: type: object description: "SSR request for a single passenger type.\n " additionalProperties: false required: - passengerType properties: passengerType: type: string description: "The passenger type.\n " maxLength: 4 minLength: 0 ssrs: type: - array - 'null' description: "The Ssr code.\n " items: $ref: '#/components/schemas/SsrDesignatorRequest' PassengerBag: type: object description: "Model information about the passenger's baggage.\n " additionalProperties: false properties: identifier: type: - string - 'null' description: "The unique transportation identifier.\n " maxLength: 4 minLength: 1 nonStandard: type: boolean description: "Flag for marking a bag as a non-standard piece of luggage.\n " osTag: type: - string - 'null' description: "The OSTag in Bag object.\n " maxLength: 32 minLength: 0 taggedToStation: type: - string - 'null' description: "The tagged to station in the bag object. This is the last station where\nthe bag is going to. For example, on a trip from SLC to JFK, JFK would\nbe the tagged to station value.\n " maxLength: 3 minLength: 3 weight: type: integer description: "The Weight in Bag object.\n " maximum: 32767.0 minimum: 0.0 weightType: description: "The WeightType in Bag object.\n " $ref: '#/components/schemas/WeightType' baggageKey: type: - string - 'null' description: "Unique key for the baggage.\n " type: type: - string - 'null' description: "The type of baggage.\n " maxLength: 6 minLength: 0 osTagDate: type: - string - 'null' description: "The bag OS tag date.\n " format: date-time stationCode: type: - string - 'null' description: "The bag station code.\n " maxLength: 3 minLength: 3 taggedToCarrierCode: type: - string - 'null' description: "The bag tagged to carrier code.\n " maxLength: 3 minLength: 2 HoldDateChangeHistoryResponse: type: object description: "Defines a hold date change history response.\n " additionalProperties: false properties: pageKey: type: - string - 'null' description: "The key of the last item in the history list.\n " histories: type: - array - 'null' description: "The hold date change history list.\n " items: $ref: '#/components/schemas/HoldDateChangeHistory' PassengerScore: type: object description: "Defines a passenger score.\n " additionalProperties: false required: - guestValueCode properties: guestValueCode: type: string description: "The guest value code.\n " maxLength: 8 minLength: 1 score: type: integer description: "The score.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 passengerKey: type: - string - 'null' description: "The passenger key associated with the score.\n " PointOfSale: type: object description: "Model related to the point of sale. This is for read-only operations.\n " additionalProperties: false properties: agentCode: type: - string - 'null' description: "The point of sale agent code.\n " domainCode: type: - string - 'null' description: "The point of sale domain code.\n " locationCode: type: - string - 'null' description: "The point of sale location code.\n " organizationCode: type: - string - 'null' description: "The point of sale organization code.\n " SeatAssignmentHistoryResponse: type: object description: "Defines a seat assignment history response.\n " additionalProperties: false properties: pageKey: type: - string - 'null' description: "The key of the last item in the history list.\n " histories: type: - array - 'null' description: "The seat assignment history list.\n " items: $ref: '#/components/schemas/SeatAssignmentHistory' OrderAddress: type: object description: "Defines an address with GPS coordinates.\n " additionalProperties: false properties: lineOne: type: - string - 'null' description: "The address line one.\n " lineTwo: type: - string - 'null' description: "The address line two.\n " lineThree: type: - string - 'null' description: "The address line 3.\n " countryCode: type: - string - 'null' description: "The country code.\n " provinceState: type: - string - 'null' description: "The province state.\n " city: type: - string - 'null' description: "The city.\n " postalCode: type: - string - 'null' description: "The postal code.\n " coordinates: description: "The GPS coordinates associated with this item address.\n " $ref: '#/components/schemas/Coordinate' Address: type: object description: "Defines a common address.\n " additionalProperties: false properties: lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 BookingComment: type: object description: "Defines a booking comment.\n " additionalProperties: false properties: type: description: "Indicates where the comment will be seen.\n " $ref: '#/components/schemas/CommentType' text: type: - string - 'null' description: "The text of the comment.\n " createdDate: type: - string - 'null' description: "The created date of the comment.\n " format: date-time pointOfSale: description: "The point of sale for the comment.\n " $ref: '#/components/schemas/PointOfSale' commentKey: type: - string - 'null' description: "The comment key.\n " PagedBookingSearchByPersonResult: type: object description: "Defines a paged booking search by person result.\n " additionalProperties: false properties: bookings: type: - array - 'null' description: "The booking search results.\n " items: $ref: '#/components/schemas/BookingSearchByPersonResult' lastPageKey: type: - string - 'null' description: "The last page key of the last paged item.\nThis value can be used in another request to page the data correctly and identifies the last result in this request.\n " IJsonResponseOfCheckinRequirements: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/CheckinRequirements' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' BookingQueueHistory: type: object description: "Represents a booking queue history item.\n " additionalProperties: false properties: alternatePassengerKey: type: - string - 'null' description: "The alternate passenger key.\n " historyId: type: integer description: "The booking queue history ID.\n " format: int64 historyEvent: description: "The booking queue history event type.\n " $ref: '#/components/schemas/BookingQueueHistoryEvent' queueCode: type: - string - 'null' description: "The booking queue code.\n " note: type: - string - 'null' description: "The booking queue note.\n " dequeueNote: type: - string - 'null' description: "The note associated with a dequeue action.\n " authorizedBy: type: - string - 'null' description: "The booking queue authorized by field.\n " priorityDate: type: - string - 'null' description: "The booking queue priority date.\n " format: date-time queueAction: description: "The booking queue action.\n " $ref: '#/components/schemas/QueueAction' domainCode: type: - string - 'null' description: "The booking queue domain code.\n " createdByUserKey: type: - string - 'null' description: "The key of the user that created the booking queue event.\n " createdDate: type: - string - 'null' description: "The booking queue item created date.\n " format: date-time queueType: description: "The booking queue item event type.\n " $ref: '#/components/schemas/QueueEventType' pointOfSale: description: "The booking queue item point of sale.\n " $ref: '#/components/schemas/PointOfSale' segmentKey: type: - string - 'null' description: "The booking queue item segment key.\n " watchListId: type: - integer - 'null' description: "The watch list ID of the booking queue entry.\n " format: int64 MatchType: type: integer description: "Match list enumeration.\n \n\n0 = Default\n1 = PaymentAccountNumber\n2 = ContactEmailAddress\n3 = ContactPhone\n4 = ContactFullName\n5 = ContactLastNameFirstInitial\n6 = ContactFullAddress\n7 = ContactAddress\n8 = PassengerDOB\n9 = PassengerFullName\n10 = PassengerLastName\n11 = TravelDocNumber\n12 = TravelDocFullName\n13 = TravelDocLastName" x-enumNames: - Default - PaymentAccountNumber - ContactEmailAddress - ContactPhone - ContactFullName - ContactLastNameFirstInitial - ContactFullAddress - ContactAddress - PassengerDOB - PassengerFullName - PassengerLastName - TravelDocNumber - TravelDocFullName - TravelDocLastName enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 AccountStatus: type: integer description: "The account status enumeration.\n \n\n0 = Open\n1 = Closed\n2 = AgencyInactive\n3 = Unknown" x-enumNames: - Open - Closed - AgencyInactive - Unknown enum: - 0 - 1 - 2 - 3 TicketIndicatorCode: type: integer description: "This enumeration defines the ticket requirements\n \n\n0 = Unknown\n1 = TicketRequired\n2 = AutomatedTicketLiftRequired\n3 = ManualTicketLiftRequired\n4 = AutomatedTicketNoLiftRequired\n5 = ManualTicketNoLiftRequired\n6 = HostETicketNoLiftRequired\n7 = ElectronicTicketNoLiftRequired" x-enumNames: - Unknown - TicketRequired - AutomatedTicketLiftRequired - ManualTicketLiftRequired - AutomatedTicketNoLiftRequired - ManualTicketNoLiftRequired - HostETicketNoLiftRequired - ElectronicTicketNoLiftRequired enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 BookingPriceBreakdown: type: object description: "Defines the booking top level pricing breakdown.\n " additionalProperties: false properties: balanceDue: type: number description: "The booking balance due.\n " format: decimal pointsBalanceDue: type: number description: "The booking points balance due.\n " format: decimal authorizedBalanceDue: type: number description: "The bookings authorized balance due.\n " format: decimal totalAmount: type: number description: "The booking total amount.\n " format: decimal totalPoints: type: number description: "The booking total points.\n " format: decimal totalToCollect: type: number description: "The booking total to collect.\n " format: decimal totalPointsToCollect: type: number description: "The booking total points to collect.\n " format: decimal totalCharged: type: number description: "The total amount charged.\n " format: decimal passengerTotals: description: "The calculated price breakdown for all passengers.\n " $ref: '#/components/schemas/PassengerPriceBreakdownBase' passengers: type: - object - 'null' description: "The individual collection of passenger price breakdowns.\n " additionalProperties: $ref: '#/components/schemas/PassengerPriceBreakdown' journeyTotals: description: "The calculated price breakdown for all journeys.\n " $ref: '#/components/schemas/JourneyPriceBreakdownBase' journeys: type: - object - 'null' description: "The individual collection of journey price breakdown.\n " additionalProperties: $ref: '#/components/schemas/JourneyPriceBreakdown' addOnTotals: description: "The total amounts charged for each type of AddOn.\n " $ref: '#/components/schemas/AddOnPriceBreakdown' PaymentAction: type: integer description: "Defines payment action that should be taken by selling system for this service.\n \n\n1 = SellingSystemCollects\n2 = PassThroughHold\n3 = NoPaymentRequired\n4 = ReferToSupplierMessage\n5 = PassThroughCharge" x-enumNames: - SellingSystemCollects - PassThroughHold - NoPaymentRequired - ReferToSupplierMessage - PassThroughCharge enum: - 1 - 2 - 3 - 4 - 5 CheckinRestrictionType: type: integer description: "Defines the checkin level restriction types.\n \n\n0 = Closed\n1 = NotOpened\n2 = PnrLocked\n3 = MarketingCodeShareNotAllowed\n4 = NotPaidInFull\n5 = PaymentsPending\n6 = PaymentsPendingCustomerAction\n7 = RestrictedOnAnotherSystem\n8 = NotAllowed\n9 = ApisNotAllowed\n10 = AppsNotAllowed\n11 = SegmentNotFound\n12 = InvalidPrice\n13 = MissingEMDCoupon" x-enumNames: - Closed - NotOpened - PnrLocked - MarketingCodeShareNotAllowed - NotPaidInFull - PaymentsPending - PaymentsPendingCustomerAction - RestrictedOnAnotherSystem - NotAllowed - ApisNotAllowed - AppsNotAllowed - SegmentNotFound - InvalidPrice - MissingEMDCoupon enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 Term: type: object description: "Defines the terms and conditions of an order.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The terms and conditions code.\n " description: type: - string - 'null' description: "The description.\n " terms: type: - string - 'null' description: "The terms.\n " AddUnitStatelessConfig: type: object description: "Unit sell config defines the different configurations when selling stateless units.\n " additionalProperties: false properties: ignoreSeatSsrs: type: - boolean - 'null' description: "Flag indicating whether to ignore seat SSR's.\n " collectedCurrencyCode: type: - string - 'null' description: "Optional Currency code if different than booking currency code.\n " maxLength: 3 minLength: 0 inventoryControl: description: "Indicates the type of hold placed on a unit.\n " $ref: '#/components/schemas/UnitInventoryControlType' GateInformation: type: object description: "Represents the gate information for the trip status model. Consists\nof actual gate information and estimated/scheduled gate information.\n " additionalProperties: false properties: estimatedGate: type: - string - 'null' description: "Represents the estimated or scheduled gate of the trip mode.\n " maxLength: 4 minLength: 0 actualGate: type: - string - 'null' description: "Represents the actual gate of the trip mode.\n " maxLength: 4 minLength: 0 NotificationPreference: type: integer description: "Describes types of notifications the user would prefer.\n \n\n0 = None\n1 = Promotional" x-enumNames: - None - Promotional enum: - 0 - 1 CheckinPassengersRequestv3: type: object description: "Defines the checkin passengers request v3 model.\n " additionalProperties: false required: - passengers properties: passengers: type: array description: "The collection of passengers to checkin.\n " items: $ref: '#/components/schemas/CheckinPassengerRequestv2' seatsRequired: type: - boolean - 'null' description: "The flag indicating whether a seat is required for checkin.\n " skipSecurityChecks: type: - boolean - 'null' description: "The flag indicating whether checkin requirement validation will be skipped.\n " PassengerAddress: type: object description: "Passenger address information. This contains more data then the base address class.\n " additionalProperties: false properties: status: description: "The addresses APIS status.\n " $ref: '#/components/schemas/ApisAddressStatus' companyName: type: - string - 'null' description: "Company name associated with this address.\n " maxLength: 64 minLength: 0 phone: type: - string - 'null' description: "Phone number associated with this address.\n " maxLength: 20 minLength: 0 stationCode: type: - string - 'null' description: "Station code associated with this address.\n " maxLength: 3 minLength: 3 emailAddress: type: - string - 'null' description: "The email address associated with the address.\n " cultureCode: type: - string - 'null' description: "The culture code for the passenger address.\n " maxLength: 17 minLength: 0 refusedContact: type: - boolean - 'null' description: "Indicates if the passenger refused to enter a contact.\n " lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 passengerAddressKey: type: - string - 'null' description: "The unique address identifier.\n " PassengerSearchCriteria: type: object description: "Model representing an passenger group type for availability search.\n " additionalProperties: false required: - type - count properties: type: type: string description: "The passenger type code.\n " maxLength: 4 minLength: 0 discountCode: type: - string - 'null' description: "The discount code to be applied.\n " maxLength: 4 minLength: 0 count: type: integer description: "The number of passenger for the type.\n " format: int32 maximum: 2147483647.0 minimum: 1.0 IJsonResponseOfHoldDateChangeHistoryResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/HoldDateChangeHistoryResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' CommentType: type: integer description: "Comment Types Enumerations\n \n\n0 = Default\n1 = Itinerary\n2 = Manifest\n3 = Alert\n4 = Archive\n5 = Voucher" x-enumNames: - Default - Itinerary - Manifest - Alert - Archive - Voucher enum: - 0 - 1 - 2 - 3 - 4 - 5 BookingSearchResult: type: object description: "Booking model data.\n " additionalProperties: false properties: bookingKey: type: - string - 'null' description: "The booking key.\n " allowedToModifyGdsBooking: type: boolean description: "Indicates whether it is allowed to modify GDS booking.\n " bookingStatus: description: "The booking status.\n " $ref: '#/components/schemas/BookingStatus' channelType: description: "The type of the channel.\n " $ref: '#/components/schemas/ChannelType' editable: type: boolean description: "Indicates whether this is editable.\n " expiredDate: type: - string - 'null' description: "The expired date.\n " format: date-time flightDate: type: - string - 'null' description: "Flight date.\n " format: date-time flightNumber: type: - string - 'null' description: "The flight number.\n " origin: type: - string - 'null' description: "Origin.\n " passengerId: type: - integer - 'null' description: "The passenger id.\n " format: int64 recordLocator: type: - string - 'null' description: "The record locator.\n " sourceAgentCode: type: - string - 'null' description: "The source agent code.\n " sourceDomainCode: type: - string - 'null' description: "The source domain code.\n " sourceOrganizationCode: type: - string - 'null' description: "The source organization code.\n " systemCode: type: - string - 'null' description: "The system code.\n " destination: type: - string - 'null' description: "Destination.\n " name: description: "The name on the booking.\n " $ref: '#/components/schemas/Name' IJsonResponseOfIListOfString: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: type: string errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' InboundOutbound: type: integer description: "This enumeration specifies direction of flight application.\n \n\n0 = None\n1 = Inbound\n2 = Outbound\n3 = Both\n4 = RoundFrom\n5 = RoundTo" x-enumNames: - None - Inbound - Outbound - Both - RoundFrom - RoundTo enum: - 0 - 1 - 2 - 3 - 4 - 5 RetrieveBookingQueueResponse: type: object description: "The booking queue response for retrieving booking queue items.\n " additionalProperties: false properties: lastIndex: type: integer description: "The last row id retrieved.\n " format: int64 retrieveBookingQueueResponseItems: type: - array - 'null' description: "The list of booking queue response items.\n " items: $ref: '#/components/schemas/RetrieveBookingQueueResponseItem' CheckinPassengerRequirements: type: object description: "Defines an individual passengers checkin requirements.\n " deprecated: true x-deprecatedMessage: Obsolete as of 4.4.4, please use the v2. additionalProperties: false properties: isValid: type: boolean description: "Flag indicating if the specific passenger checkin is valid.\n " passengerKey: type: - string - 'null' description: "The associated passenger key.\n " documentRequirements: description: "The passengers document requirements.\n " $ref: '#/components/schemas/CheckinDocumentRequirements' addressRequirements: description: "The passengers address requirements.\n " $ref: '#/components/schemas/CheckinAddressRequirements' invalidSsrs: type: - array - 'null' description: "The collection of checkin restricted/invalid SSR's the passenger contains.\n " items: type: string requiredSsrs: type: - array - 'null' description: "The collection of checkin required SSR's the passenger is missing for each segment.\n " items: $ref: '#/components/schemas/CheckinMissingSegmentRequiredSsr' restrictions: type: - array - 'null' description: "The list of passengers restrictions that will restrict passenger from checkin.\n " items: $ref: '#/components/schemas/CheckinPassengerRestriction' BookingSales: type: object description: "Defines the different point of sale information.\n " additionalProperties: false properties: created: description: "Contains the details about the agent and organization information that created this booking.\n " $ref: '#/components/schemas/PointOfSale' source: description: "Contains the details about the agent and organization information that referred the created booking.\n " $ref: '#/components/schemas/BookingPointOfSale' modified: description: "Contains the details about the agent and organization information that made the last set of changes.\n " $ref: '#/components/schemas/PointOfSale' BookingQueueDeleteByKeyRequest: type: object description: "The booking queue delete by queue key request.\n " additionalProperties: false required: - authorizedBy - notes properties: authorizedBy: type: string description: "The authorizing agent.\n " minLength: 1 notes: type: string description: "The notes for the booking request.\n " minLength: 1 password: type: - string - 'null' description: "The password needed to access the queue.\nRequired if queue is set to password-protected in Sky Manager.\n " HoldDateChangeEvent: type: integer description: "Represents the different events that trigger an\nentry into the hold date change history.\n \n\n66 = Created\n67 = Removed\n68 = Changed" x-enumNames: - Created - Removed - Changed enum: - 66 - 67 - 68 BagTagPrintHistory: type: object description: "Defines bag tag print history.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " $ref: '#/components/schemas/PointOfSale' receivedBy: type: - string - 'null' description: "The received by name.\n " maxLength: 64 minLength: 0 createdDate: type: - string - 'null' description: "The created date.\n " format: date-time departureDate: type: string description: "The departure date.\n " format: date-time identifier: description: "The unique transportation identifier.\n " $ref: '#/components/schemas/TransportationIdentifier' passengerName: description: "The passenger name.\n " $ref: '#/components/schemas/Name' osTag: type: - string - 'null' description: "The os tag.\n " maxLength: 32 minLength: 0 taggedToStation: type: - string - 'null' description: "The tagged to station on the baggage object.\n " maxLength: 3 minLength: 3 weight: type: integer description: "The baggage weight.\n " maximum: 32767.0 minimum: 0.0 weightType: description: "The baggage weight type.\n " $ref: '#/components/schemas/WeightType' isBagTagSelfPrinted: type: - boolean - 'null' description: "Whether the bag tag is self printed.\n " BookingInfo: type: object description: "Describes general booking details.\n " additionalProperties: false properties: status: description: "The status of the entire booking.\n " $ref: '#/components/schemas/BookingStatus' paidStatus: description: "The status of the applied payments.\n " $ref: '#/components/schemas/PaidStatus' priceStatus: description: "The pricing status of the booking.\n " $ref: '#/components/schemas/PriceStatus' profileStatus: description: "The booking profiling status.\n " $ref: '#/components/schemas/BookingProfileStatus' bookingType: type: - string - 'null' description: "Identifies the type (Default, GDS, CodeShare, ect) of the booking set during the commit process.\n " channelType: description: "The channel that is responsible for created the booking.\n " $ref: '#/components/schemas/ChannelType' bookedDate: type: - string - 'null' description: "The UTC date and time the booking was originally created.\n " format: date-time createdDate: type: - string - 'null' description: "The UTC date and time of when the booking was created.\n " format: date-time expirationDate: type: - string - 'null' description: "The UTC date and time indicating when the booking will not be returned when retrieved by a GDS/GRS.\n " format: date-time modifiedDate: type: - string - 'null' description: "The UTC date and time when the booking was last updated on the server.\n " format: date-time modifiedAgentId: type: integer description: "The last agent ID who modified the booking.\n " format: int64 createdAgentId: type: integer description: "The agent ID that created the booking.\n " format: int64 owningCarrierCode: type: - string - 'null' description: "Identifies which carrier is financially responsible for the booking and payment.\n " maxLength: 3 minLength: 2 changeAllowed: type: boolean description: "The flag indicating whether the booking can be changed.\n " createdUserKey: type: - string - 'null' description: "The user key of the agent ID who created the booking, which can be used anywhere the userKey is accepted.\n " modifiedUserKey: type: - string - 'null' description: "The modified user key of the agent ID who modified the booking last, which can be used anywhere the userKey is\naccepted.\n " IJsonResponseOfPagedBookingSearchByPersonResult: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PagedBookingSearchByPersonResult' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' AddOnStatus: type: integer description: "An enumeration to indicate the add on's current status.\n \n\n0 = Unknown\n1 = Active\n2 = Pending\n3 = Confirming\n4 = CancelPending\n5 = Cancelled" x-enumNames: - Unknown - Active - Pending - Confirming - CancelPending - Cancelled enum: - 0 - 1 - 2 - 3 - 4 - 5 PassengerTicketInfo: type: object description: "Represents detailed information for an e-ticket assigned to a passenger.\n " additionalProperties: false properties: status: description: "Ticket status.\n " $ref: '#/components/schemas/TicketStatusCode' ticketIndicator: type: - string - 'null' description: "Ticket indicator.\n " passengerCouponCount: type: integer description: "Number of passenger coupons affected.\n " format: int32 infantPassengerCouponCount: type: integer description: "Number of infant passenger coupons affected.\n " format: int32 TransactionType: type: integer description: "The dotREZ specific transaction types. This includes some system specific values that\nare not allowed during a transaction creation.\n \n\n0 = Default\n1 = Payment\n2 = Adjustment\n3 = Supplementary\n4 = Transfer\n5 = Spoilage\n6 = StatementDateAndBalance\n7 = PayableCommission\n8 = Commission\n9 = ChildCommissionTransfer\n10 = ParentCommissionTransfer" x-enumNames: - Default - Payment - Adjustment - Supplementary - Transfer - Spoilage - StatementDateAndBalance - PayableCommission - Commission - ChildCommissionTransfer - ParentCommissionTransfer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 InfantFee: type: object description: "Defines the infant fee information.\n " additionalProperties: false required: - code properties: isConfirmed: type: boolean description: "A status flag to indicate if the fee has been confirmed or not.\n " isConfirming: type: boolean description: "A status flag to indicate if the fee is confirming or not.\n " isConfirmingExternal: type: boolean description: "A status flag to indicate if the fee is confirming external or not.\n " code: type: string description: "The fee code.\n " maxLength: 6 minLength: 0 detail: type: - string - 'null' description: "The fee detail.\n " maxLength: 32 minLength: 0 passengerFeeKey: type: - string - 'null' description: "The passenger fee key.\n " override: type: boolean description: "The fee override.\n " flightReference: type: - string - 'null' description: "The flight reference which signifies a link to a segment and or leg.\n " maxLength: 22 minLength: 0 note: type: - string - 'null' description: "The fee notes.\n " maxLength: 128 minLength: 0 createdDate: type: - string - 'null' description: "The created date for the fee.\n " format: date-time isProtected: type: boolean description: "Indicates if the fee is protected.\n " serviceCharges: type: - array - 'null' description: "The list of service charges for the fee.\n " items: $ref: '#/components/schemas/ServiceCharge' HistoryResponse: type: object description: "Defines a booking history response.\n " additionalProperties: false properties: pageKey: type: - string - 'null' description: "The key of the last item in the history list.\n " histories: type: - array - 'null' description: "The booking history list.\n " items: $ref: '#/components/schemas/BookingHistory' BookingQueueDeleteRequest: type: object description: "The booking queue delete request.\n " additionalProperties: false required: - queueCode - authorizedBy properties: queueCode: type: string description: "The code for the booking queue.\n " maxLength: 6 minLength: 0 notes: type: - string - 'null' description: "The notes for the booking request.\n " password: type: - string - 'null' description: "The Password needed to access the queue. Required if queue\nis set to password-protected in Sky Manager.\n " authorizedBy: type: string description: "The authorizing agent.\n " minLength: 1 ChallengePreference: type: integer description: "Defines the challenge preference.\n \n\n0 = NoPreference\n1 = NoChallengeRequested\n2 = ChallengeRequested\n3 = ChallengeMandated" x-enumNames: - NoPreference - NoChallengeRequested - ChallengeRequested - ChallengeMandated enum: - 0 - 1 - 2 - 3 WeightType: type: integer description: "Weight Type enumeration.\n \n\n0 = Default\n1 = Pounds\n2 = Kilograms" x-enumNames: - Default - Pounds - Kilograms enum: - 0 - 1 - 2 BookingNotificationHistory: type: object description: "Defines a booking notification history.\n " additionalProperties: false properties: bookingNotificationHistoryKey: type: - string - 'null' description: "The booking notification history key.\n " createdDate: type: string description: "Date and time the history was logged.\n " format: date-time eventTypeCode: description: "Event type code of the notification.\n " $ref: '#/components/schemas/SubscriptionEventType' deliveryMethodCode: type: - string - 'null' description: "Delivery method code of the notification.\n " destination: type: - string - 'null' description: "Destination address of the notification.\n " cultureCode: type: - string - 'null' description: "Culture code of the notification.\n " detail: type: - string - 'null' description: "Details of the booking notification history.\n " minutesToEvent: type: integer description: "Reminder time for the notification.\n " format: int32 AccountOwnerType: type: integer description: "The account owner type enumeration.\n \n\n0 = Organization\n1 = Personnal\n2 = Booking\n3 = Unknown" x-enumNames: - Organization - Personnal - Booking - Unknown enum: - 0 - 1 - 2 - 3 BookingQueueHistoryEvent: type: integer description: "The booking queue history code values represent the different events that trigger\nan entry into the booking queue history.\n \n\n0 = Unknown\n1 = Add\n2 = Remove\n3 = Update" x-enumNames: - Unknown - Add - Remove - Update enum: - 0 - 1 - 2 - 3 SsrDurationType: type: integer description: "Ssr duration type.\n \n\n0 = Segment\n1 = Journey\n2 = Leg" x-enumNames: - Segment - Journey - Leg enum: - 0 - 1 - 2 ItinerarySentHistoryResponse: type: object description: "Defines an itinerary sent history response.\n " additionalProperties: false properties: pageKey: type: - string - 'null' description: "The key of the last item in the history list.\n " histories: type: - array - 'null' description: "The itinerary sent history list.\n " items: $ref: '#/components/schemas/ItinerarySentHistory' BookingQueueInfo: type: object description: "Describes the booking queue info.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The identifier for the queue where the booking is placed.\n " maxLength: 6 minLength: 0 subCode: type: - string - 'null' description: "The identifier for the sub queue where the booking is placed.\n " maxLength: 6 minLength: 0 name: type: - string - 'null' description: "The name for the queue where the booking is placed.\n " maxLength: 64 minLength: 0 queueId: type: integer description: "The unique ID of the booking queue entry.\n " format: int64 passengerId: type: integer description: "The unique identifier of a passenger on the booking.\n " format: int64 watchListId: type: integer description: "Unique identifier of the watchlist where a match was found for the booking or passenger.\n " format: int64 note: type: - string - 'null' description: "A summary on why the booking was placed in the queue.\n " maxLength: 128 minLength: 0 type: description: "The type of event that triggered placement of the booking in the queue.\n " $ref: '#/components/schemas/QueueEventType' action: description: "The action that will be taken as a result of the placement in the queue.\n " $ref: '#/components/schemas/QueueAction' mode: description: "The indicator if this entry was added or removed from the queue.\n " $ref: '#/components/schemas/QueueMode' flightReference: type: - string - 'null' description: "The flight reference.\n " bookingQueueKey: type: - string - 'null' description: "The key of the booking queue entry.\n " passengerAlternateKey: type: - string - 'null' description: "The unique identifier of a passenger on the booking.\n " watchListKey: type: - string - 'null' description: "Unique identifier of the watchlist where a match was found for the booking or passenger.\n " PaymentDetails: type: object description: "Defines the payment details.\n " additionalProperties: false properties: accountNumberId: type: integer description: "The reference of an encrypted account number.\n " format: int64 parentPaymentId: type: - integer - 'null' description: "ID of the parent of refunds or divide. Null if none exists.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 accountName: type: - string - 'null' description: "The account holder name.\n " maxLength: 64 minLength: 0 accountNumber: type: - string - 'null' description: "The account number.\n " maxLength: 34 minLength: 0 expirationDate: type: - string - 'null' description: "The expiration date.\n " format: date-time text: type: - string - 'null' description: "The payment added text.\n " maxLength: 64 minLength: 0 installments: type: integer description: "The number of installments to be applied.\n " maximum: 999.0 minimum: 0.0 binRange: type: integer description: "The first 6 digits of the credit card number.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 fields: type: - object - 'null' description: "The collection of payment fields.\n " additionalProperties: type: string RecordLocator: type: object description: "Defines a unique locator for reference.\n " additionalProperties: false properties: systemDomainCode: type: - string - 'null' description: "The system domain code.\n " maxLength: 3 minLength: 0 bookingSystemCode: type: - string - 'null' description: "The system code of where the booking was created.\n " maxLength: 3 minLength: 0 hostedCarrierCode: type: - string - 'null' description: "The hosted carrier's code.\n " maxLength: 3 minLength: 0 recordLocatorKey: type: - string - 'null' description: "The unique record locator key.\n " recordCode: type: - string - 'null' description: "The record code.\n " maxLength: 12 minLength: 0 owningSystemCode: type: - string - 'null' description: "The owning system code for the booking.\n " maxLength: 3 minLength: 0 interactionPurpose: type: - string - 'null' description: "The interaction purpose.\n " maxLength: 2 minLength: 0 IJsonResponseOfRetrieveBookingQueueResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/RetrieveBookingQueueResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' SellKey: type: object description: "Sell key represents the journey and the fare sell keys to combine to what journey and fare will be sold.\n " additionalProperties: false required: - journeyKey - fareAvailabilityKey properties: journeyKey: type: string description: "The journey sell key.\n " minLength: 1 fareAvailabilityKey: type: string description: "The fare sell key.\n " minLength: 1 standbyPriorityCode: type: - string - 'null' description: "The stand by priority code.\n " inventoryControl: description: "The reserving inventory action of the journey once sold by the system.\n " $ref: '#/components/schemas/InventoryControlType' DepartureEvent: type: object description: "Represents the flight operation times for the departure event, which\nincludes an estimated and scheduled time event.\n " additionalProperties: false properties: scheduled: type: - string - 'null' description: "Represents the scheduled departure time.\n " format: date-time estimated: type: - string - 'null' description: "Represents the estimated departure time.\n " format: date-time SearchBookingsByCreditCard: type: object description: "Search for a booking by credit card.\n " additionalProperties: false required: - creditCardNumber properties: creditCardNumber: type: string description: "The digits of one of the credit card number applied.\n " maxLength: 34 minLength: 0 agentId: type: - integer - 'null' description: "The agent identifier.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 organizationCode: type: - string - 'null' description: "OrganizationCode represents the organization associated with the agent who created\nthe booking.\n " maxLength: 10 minLength: 0 filters: description: "Common search filters.\n " $ref: '#/components/schemas/BookingFilters' Ticket: type: object description: "Model for a ticket applied to a passenger.\n " additionalProperties: false properties: ticketNumber: type: - string - 'null' description: "The ticket number.\n " maxLength: 14 minLength: 0 infantTicketNumber: type: - string - 'null' description: "The infant ticket number.\n " maxLength: 14 minLength: 0 ticketIndicator: description: "The ticket indicator.\n " $ref: '#/components/schemas/TicketIndicatorCode' ticketStatus: description: "The ticket status.\n " $ref: '#/components/schemas/TicketStatusCode' passengerKey: type: - string - 'null' description: "The passenger key the ticket is associated with.\n " FlightType: type: integer description: "Flight types enumeration.\n \n\n0 = None\n1 = NonStop\n2 = Through\n3 = Direct\n4 = Connect\n5 = All" x-enumNames: - None - NonStop - Through - Direct - Connect - All enum: - 0 - 1 - 2 - 3 - 4 - 5 ConsumerAddress: type: object description: "Defines a consumer address.\n " additionalProperties: false properties: lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 county: type: - string - 'null' description: "The address country.\n " CheckinMissingSegmentRequiredSsr: type: object description: "Defines the a segments collection of missing SSR's.\n " additionalProperties: false properties: codes: type: - array - 'null' description: "The collection of SSR's missing.\n " items: type: string designator: description: "The transportation designator that the SSR codes are missing from.\n " $ref: '#/components/schemas/TransportationDesignator' PassengerSegmentBag: type: object description: "Model information about the baggage a passenger has on a segment.\n " additionalProperties: false required: - passengerKey - arrivalStation - departureStation properties: baggageKey: type: - string - 'null' description: "Unique key for the baggage.\n " passengerKey: type: string description: "The passenger key associated to this bag.\n " minLength: 1 arrivalStation: type: string description: "The bag segment arrival station.\n " maxLength: 3 minLength: 3 status: description: "The bag status.\n " $ref: '#/components/schemas/BaggageStatus' departureStation: type: string description: "The bag segment departure station.\n " maxLength: 3 minLength: 3 osTag: type: - string - 'null' description: "The bag OS tag.\n " maxLength: 32 minLength: 0 GovernmentProgramRequirements: type: object description: "Defines a government programs document requirements.\n " additionalProperties: false properties: governmentInstance: type: - string - 'null' description: "Identifies which instance of government security is associated with these specific requirements.\n " requiredDocumentFields: type: - array - 'null' description: "The collection of required document fields to be collected.\n " items: $ref: '#/components/schemas/GovernmentDocumentFieldType' additionalDataRequired: type: - array - 'null' description: "The collection of additional data that is required that are not related to documents.\n " items: $ref: '#/components/schemas/GovernmentAdditionalDataType' programDescription: type: - string - 'null' description: "User-friendly label or description that should be used for all prompts and error messages\nto the user.\n " messageType: type: - string - 'null' description: "Message type associated with these requirements.\n " minVerifiedDocumentCount: type: integer description: "The minimum number of verified documents required.\n " format: int32 ClassStatus: type: integer description: "Indicates whether a leg class may be used or not.\n \n\n1 = Active\n2 = InActive\n3 = AvsOpen\n4 = AvsOnRequest\n5 = AvsClosed" x-enumNames: - Active - InActive - AvsOpen - AvsOnRequest - AvsClosed enum: - 1 - 2 - 3 - 4 - 5 PassengerInfant: type: object description: "Model representing an infant with a passenger.\n " additionalProperties: false properties: nationality: type: - string - 'null' description: "The nationality of the passenger.\n " maxLength: 2 minLength: 0 residentCountry: type: - string - 'null' description: "The residentCountry of the passenger.\n " maxLength: 2 minLength: 0 dateOfBirth: type: - string - 'null' description: "The date of birth of the infant.\n " format: date-time gender: description: "The gender of the passenger.\n " $ref: '#/components/schemas/Gender' name: description: "The name of the passenger.\n " $ref: '#/components/schemas/Name' declaredGender: type: - string - 'null' description: "The infant's declared gender. A value of \"F\" is mapped to a female binary gender. All other values will be\nmapped to a male binary gender.\n " maxLength: 2 minLength: 0 fees: type: - array - 'null' description: "The collection of infant fees.\n " items: $ref: '#/components/schemas/InfantFee' travelDocuments: type: - array - 'null' description: "Travel Documents.\n " items: $ref: '#/components/schemas/PassengerTravelDocument' type: type: - string - 'null' description: "The infant passenger type.\n " OrderPriceBreakdown: type: object description: "Defines all the different order price breakdown.\n " additionalProperties: false properties: display: description: "The display prices.\n " $ref: '#/components/schemas/Amount' initial: description: "The initial base prices.\n " $ref: '#/components/schemas/Amount' markup: description: "The markup prices.\n " $ref: '#/components/schemas/Amount' listed: description: "The list prices.\n " $ref: '#/components/schemas/Amount' listedDiscount: description: "The list discount prices.\n " $ref: '#/components/schemas/Amount' discount: description: "The discount prices.\n " $ref: '#/components/schemas/Amount' handling: description: "The handling charge prices.\n " $ref: '#/components/schemas/Amount' handlingDiscount: description: "The handling charge discount prices.\n " $ref: '#/components/schemas/Amount' dueNow: description: "The amounts due now at payment.\n " $ref: '#/components/schemas/AmountDue' dueLater: description: "The amounts due later at pickup.\n " $ref: '#/components/schemas/AmountDue' personalizations: type: - number - 'null' description: "The personalized total.\n " format: decimal taxable: type: - number - 'null' description: "The taxable total.\n " format: decimal services: type: - number - 'null' description: "The services total.\n " format: decimal fees: type: - number - 'null' description: "The fees total.\n " format: decimal total: type: - number - 'null' description: "The overall cost.\n " format: decimal taxRate: type: integer description: "The applied tax rate.\n " format: int32 taxExempt: type: boolean description: "Flag indicating if taxes are exempt.\n " taxAtUnitPrice: type: boolean description: "Flag indicating if taxed at the unit price.\n " SimpleSeatPreference: type: integer description: "Represents a simple seating preference.\n \n\n0 = None\n1 = Window\n2 = Aisle\n3 = Other" x-enumNames: - None - Window - Aisle - Other enum: - 0 - 1 - 2 - 3 BookingRecordLocators: type: object description: "Defines the booking's unique identifiers.\n " additionalProperties: false properties: numericRecordLocator: type: - string - 'null' description: "The alphanumeric identifier generated when the booking is retrieved from the alphanumeric record locator value that\nwas assigned.\n " maxLength: 12 minLength: 0 parentRecordLocator: type: - string - 'null' description: "The record locator of the booking where the current booking resulted from.\n " maxLength: 12 minLength: 0 parentId: type: integer description: "The unique identifier of the booking where the current booking resulted from.\n " format: int64 recordLocators: type: - array - 'null' description: "The list of other reservations that can be used as cross reference for the booking.\n " items: $ref: '#/components/schemas/RecordLocator' OptionalServiceInformation: type: object description: "Represents the optional service information model.\n " additionalProperties: false properties: carrierCode: type: - string - 'null' description: "The optional service carrier code.\n " maxLength: 3 minLength: 0 reasonForIssuanceSubCode: type: - string - 'null' description: "The optional service reason for issuance sub-code (RFISC).\n " maxLength: 3 minLength: 0 MessageStatus: type: integer description: "Defines the message status.\n \n\n0 = General\n1 = Warning\n2 = Critical" x-enumNames: - General - Warning - Critical enum: - 0 - 1 - 2 MarketDesignator: type: object description: "Model information about the date market which identifies a market and the departure date.\n " additionalProperties: false required: - destination - origin - departureDate properties: destination: type: string description: "Gets or sets the leg arrival station.\n " maxLength: 3 minLength: 0 origin: type: string description: "Gets or sets the leg departure station.\n " maxLength: 3 minLength: 0 departureDate: type: string description: "The departure date.\n " format: date-time minLength: 1 IJsonResponseOfIListOfTransaction: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/Transaction' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' EmdCouponStatus: type: integer description: "Represents the EMD coupon status options.\n \n\n0 = Unknown\n1 = HeldConfirmed\n2 = HoldingNeed\n3 = HoldingConfirmedEmdRequired\n4 = HoldingConfirmedEmdIssued" x-enumNames: - Unknown - HeldConfirmed - HoldingNeed - HoldingConfirmedEmdRequired - HoldingConfirmedEmdIssued enum: - 0 - 1 - 2 - 3 - 4 PassengerBoardingPassDetail: type: object description: "Defines information used to populate the printed boarding pass and 2D bar codes.\n " additionalProperties: false properties: gateInformation: type: - string - 'null' description: "The gate information from the boarding pass.\n " priorityInformation: type: - string - 'null' description: "The priority information from the boarding pass.\n " cabinClass: type: - string - 'null' description: "The cabin class as seen from the boarding pass.\n " compartmentLevel: type: - string - 'null' description: "The compartment level as seen from the boarding pass.\n " boardingZone: type: - string - 'null' description: "The assigned boarding zone from the boarding pass.\n " seatAssignment: type: - string - 'null' description: "The seat assignment as seen from the boarding pass.\n " sequenceNumber: type: - string - 'null' description: "The boarding sequence number as seen from the boarding pass.\n " Amount: type: object description: "Defines an amount base price and total price.\n " additionalProperties: false properties: value: type: - number - 'null' description: "The base amount value.\n " format: decimal total: type: - number - 'null' description: "The total amount.\n " format: decimal ItineraryQuoteRequest: type: object description: "Defines the itinerary booking quote request.\n " additionalProperties: false required: - passengers - currencyCode properties: keys: type: - array - 'null' description: "The list of selected sell keys to be added to the booking.\n " items: $ref: '#/components/schemas/SellKey' passengers: description: "The list of passengers.\n " $ref: '#/components/schemas/PassengerTypeCriteria' currencyCode: type: string description: "The desired currency code.\n " maxLength: 3 minLength: 1 infantCount: type: - integer - 'null' description: "The number of infants to be added.\n " format: int32 promotionCode: type: - string - 'null' description: "The promo code to apply.\n " maxLength: 8 minLength: 0 sourceOrganization: type: - string - 'null' description: "The acting source organization code.\n " maxLength: 10 minLength: 0 ssrs: type: - array - 'null' description: "Sell service requests to quote.\n " items: $ref: '#/components/schemas/SsrsStatelessRequest' serviceBundleCodes: type: - array - 'null' description: "Optional list of bundle codes from a specific fare of a flight to be included in the booking quote if\n`IncludeServiceBundle` is set to `Yes`.\n " items: type: string includeServiceBundle: type: - boolean - 'null' description: "Determines whether to include bundles in the booking quote.\n " CodeShareIndicator: type: integer description: "Specifies the type of code share agreement.\n \n\n0 = NonCodeShare\n1 = CodeShareCommercialDuplicate\n2 = SharedDesignatorOrWetLease\n3 = CodeShareHostOperatingCarrier\n4 = CodeShareCommercialDuplicateWithOverrideText\n5 = SharedDesignatorOrWetLeaseWithOverrideText" x-enumNames: - NonCodeShare - CodeShareCommercialDuplicate - SharedDesignatorOrWetLease - CodeShareHostOperatingCarrier - CodeShareCommercialDuplicateWithOverrideText - SharedDesignatorOrWetLeaseWithOverrideText enum: - 0 - 1 - 2 - 3 - 4 - 5 OrderNote: type: object description: "Defines a order note.\n " additionalProperties: false properties: text: type: - string - 'null' description: "The notes text.\n " description: type: - string - 'null' description: "The notes description (used to identity the note).\n " created: type: string description: "The created date.\n " format: date-time modified: type: string description: "The modified date.\n " format: date-time DocumentGroup: type: integer description: "The document grouping enumeration.\n \n\n0 = Unknown\n1 = AlienRegistrationCard\n2 = PermanentResidentCard\n3 = FacilitationDocument\n4 = InsPass\n5 = MilitaryId\n6 = Passport\n7 = ReEntryPermit\n8 = CreditCard\n9 = TravelVisa\n10 = OaFrequentFlyer\n11 = ParoleLetter\n12 = NoticeOfAction\n13 = TransportationLetter\n14 = BorderCrossingCard\n15 = PilotLicense\n16 = UsNaturalizationCertificate\n17 = RefugeeTravelDocument\n18 = GovernmentId\n19 = DriversLicense\n20 = RedressNumber\n21 = KnownTravelerId\n22 = FormOfId\n23 = Nexus\n24 = SecondaryExempt" x-enumNames: - Unknown - AlienRegistrationCard - PermanentResidentCard - FacilitationDocument - InsPass - MilitaryId - Passport - ReEntryPermit - CreditCard - TravelVisa - OaFrequentFlyer - ParoleLetter - NoticeOfAction - TransportationLetter - BorderCrossingCard - PilotLicense - UsNaturalizationCertificate - RefugeeTravelDocument - GovernmentId - DriversLicense - RedressNumber - KnownTravelerId - FormOfId - Nexus - SecondaryExempt enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 TransactionRequest: type: object description: "The create transaction request.\n " additionalProperties: false required: - amount - currencyCode properties: amount: type: number description: "The credit account transaction amount.\n " format: decimal currencyCode: type: string description: "The credit account transaction currency code.\n " maxLength: 3 minLength: 0 note: type: - string - 'null' description: "The credit account transaction note.\n " maxLength: 128 minLength: 0 CheckinPassengerLiftStatus: type: object description: "Defines a single passengers checkin status for a specific segment.\n " additionalProperties: false properties: status: description: "The lift status of the passenger for a specific segment.\n " $ref: '#/components/schemas/LiftStatus' identifier: description: "The transportation identifier.\n " $ref: '#/components/schemas/TransportationIdentifier' ItineraryQuote: type: object description: "Defines the itinerary quote model.\n " additionalProperties: false properties: passengers: type: - object - 'null' description: "The dictionary of passengers.\n " additionalProperties: $ref: '#/components/schemas/Passenger' journeys: type: - array - 'null' description: "The list of journeys.\n " items: $ref: '#/components/schemas/Journey' breakdown: description: "The itinerary pricing breakdown.\n " $ref: '#/components/schemas/BookingPriceBreakdown' LegInformation: type: object description: "Model describing the detailed leg information.\n " additionalProperties: false properties: departureTimeUtc: type: - string - 'null' description: "The departure time using the time variant in universal time.\n " format: date-time arrivalTimeUtc: type: - string - 'null' description: "The arrival time using the time variant in universal time.\n " format: date-time adjustedCapacity: type: integer description: "The leg adjusted capacity.\n " arrivalTerminal: type: - string - 'null' description: "The leg arrival terminal.\n " maxLength: 2 minLength: 0 arrivalTimeVariant: type: integer description: "The leg arrival Local Time Variant (LTV).\n " backMoveDays: type: integer description: "The legs back move days.\n " capacity: type: integer description: "The leg capacity.\n " changeOfDirection: type: boolean description: "A value indicating whether the leg has a change of direction.\n " codeShareIndicator: description: "The leg code share indicator.\n " $ref: '#/components/schemas/CodeShareIndicator' departureTerminal: type: - string - 'null' description: "The leg departure terminal.\n " maxLength: 2 minLength: 0 departureTimeVariant: type: integer description: "The leg departure Local Time Variant (LTV).\n " equipmentType: type: - string - 'null' description: "The leg type of the equipment.\n " maxLength: 3 minLength: 0 equipmentTypeSuffix: type: - string - 'null' description: "The leg equipment type suffix.\n " maxLength: 3 minLength: 0 eTicket: type: boolean description: "A value indicating whether this leg is an e-ticketed leg.\n " irop: type: boolean description: "Gets or sets a value indicating whether this leg is an IROP.\n " lid: type: integer description: "The legs lid.\n " marketingCode: type: - string - 'null' description: "The leg marketing code.\n " marketingOverride: type: boolean description: "A value indicating whether the leg has a marketing override.\n " operatedByText: type: - string - 'null' description: "The leg \"operated by\" text.\n " operatingCarrier: type: - string - 'null' description: "The leg operating carrier.\n " operatingFlightNumber: type: - string - 'null' description: "The leg operating flight number.\n " operatingOpSuffix: type: - string - 'null' description: "The leg operating operating suffix.\nPlease note that this should be a char and not a string.\n " maxLength: 1 outMoveDays: type: integer description: "The leg move out days.\n " arrivalTime: type: - string - 'null' description: "The leg passenger standard time of arrival (STA).\n " format: date-time departureTime: type: - string - 'null' description: "The leg passenger standard time of departure (STD).\n " format: date-time prbcCode: type: - string - 'null' description: "The leg PRBC code.\n " maxLength: 8 minLength: 0 scheduleServiceType: type: - string - 'null' description: "The type of the schedule service.\nPlease note that this should be a char and not a string.\n " maxLength: 1 sold: type: integer description: "The sold.\n " status: description: "The legs status.\n " $ref: '#/components/schemas/LegStatus' subjectToGovtApproval: type: boolean description: "A value indicating whether the leg is subject to government approval.\n " BookingQueueRestriction: type: integer description: "Defines the restrictions associated with a BookingQueue\n \n\n0 = Restricted\n1 = AddAllowedOnly\n2 = Allowed" x-enumNames: - Restricted - AddAllowedOnly - Allowed enum: - 0 - 1 - 2 MatchKeyType: type: integer description: "The match key type enumeration.\n \n\n0 = Default\n1 = PassengerAlternateKey\n2 = ContactTypeCode\n3 = PaymentKey" x-enumNames: - Default - PassengerAlternateKey - ContactTypeCode - PaymentKey enum: - 0 - 1 - 2 - 3 FlightMoveHistoryResponse: type: object description: "Defines a flight move history response.\n " additionalProperties: false properties: pageKey: type: - string - 'null' description: "The key of the last item in the history list.\n " histories: type: - array - 'null' description: "The flight move history list.\n " items: $ref: '#/components/schemas/FlightMoveHistory' ServiceCharge: type: object description: "Model that represents the fare service charge information.\n " additionalProperties: false properties: amount: type: number description: "The service charge amount.\n " format: decimal code: type: - string - 'null' description: "The service charge code.\n " detail: type: - string - 'null' description: "The service charge detail.\n " maxLength: 10 minLength: 0 type: description: "The service charge type.\n " $ref: '#/components/schemas/ChargeType' collectType: description: "The service charge collect type.\n " $ref: '#/components/schemas/CollectType' currencyCode: type: - string - 'null' description: "The service charge currency code.\n " maxLength: 3 minLength: 0 foreignCurrencyCode: type: - string - 'null' description: "The service charge foreign currency code.\n " maxLength: 3 minLength: 0 foreignAmount: type: number description: "The service charge foreign amount.\n " format: decimal ticketCode: type: - string - 'null' description: "The service charge ticket code.\n " maxLength: 3 minLength: 0 BagTagInformation: type: object description: "Defines bag tag information.\n " additionalProperties: false properties: osTag: type: - string - 'null' description: "The os tag.\n " maxLength: 32 minLength: 0 taggedToStation: type: - string - 'null' description: "The tagged to station on the baggage object.\n " maxLength: 3 minLength: 3 weight: type: integer description: "The weight of the baggage.\n " maximum: 32767.0 minimum: 0.0 weightType: description: "The weight type of the baggage.\n " $ref: '#/components/schemas/WeightType' originStation: type: - string - 'null' description: "The origin station of the baggage.\n " maxLength: 3 minLength: 3 IJsonResponseOfIListOfBagTagPrintHistory: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/BagTagPrintHistory' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' Journey: type: object description: "Data about the journey which represents the collection of segments and their legs on the journey.\n " additionalProperties: false properties: journeyKey: type: - string - 'null' description: "The unique identifier for this journey sell information.\n " notForGeneralUser: type: boolean description: "A value indicating whether the journey is for a general user.\n " flightType: description: "Returns a flight type enumeration. (NonStop, Thru, etc.)\n " $ref: '#/components/schemas/FlightType' stops: type: integer description: "The total number of stops this flight takes.\n " format: int32 designator: description: "This is a summary of all the segments. It will contain the details\nof the transportation from the first and last segment.\n " $ref: '#/components/schemas/TransportationDesignator' move: description: "The information regarding the journey move restrictions.\n " $ref: '#/components/schemas/JourneyMove' segments: type: - array - 'null' description: "The collection of segments.\n " items: $ref: '#/components/schemas/Segment' ErrorResponse: type: object description: "Defines a unique error response.\n " additionalProperties: false properties: exception: description: "The original exception that was thrown and all the exception details.\n " $ref: '#/components/schemas/Exception' rawMessage: type: - string - 'null' description: "The original raw message set (non-localized).\n " code: type: - string - 'null' description: "The unique error code. The primary value used to match against a unique message localized for the end user in the\nchosen language.\n " message: type: - string - 'null' description: "The error message. Deprecated: Please use the Code instead.\n " type: type: - string - 'null' description: "The error type showing severity. Values: Critical, Error, Validation, Information.\n " number: type: - integer - 'null' description: "A unique identifier in numeric form. This is required for Splunk logging. If none is provided a number will be\ngenerated based on code and type.\n " format: int32 maximum: 99999.0 minimum: 0.0 details: type: - object - 'null' description: "Dynamic detailed information about the error.\n " additionalProperties: type: string ActivityId: type: - string - 'null' description: "The activity ID unique to the request. Useful for debugging purposes to uniquely look up what happened for this\nspecific request.\n " QueueBookingByInventoryLegRequest: type: object description: "The queue booking by inventory leg request model\n " additionalProperties: false required: - legKey - bookingQueueCodes - comments properties: legKey: type: string description: "The leg key of the inventory which the bookings to be queued belongs to.\n " minLength: 1 bookingQueueCodes: type: array description: "The collection of booking queue codes to enqueue the bookings to.\n " items: type: string comments: type: string description: "Additional information for the queue operation.\n " minLength: 1 IJsonResponseOfCheckinRequirementsv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/CheckinRequirementsv2' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfSeatAssignmentHistoryResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/SeatAssignmentHistoryResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' FareApplicationType: type: integer description: "This enumeration defines the fare application type of a fare.\n \n\n0 = Route\n1 = Sector\n2 = Governing" x-enumNames: - Route - Sector - Governing enum: - 0 - 1 - 2 WatchListResponse: type: object description: "The watch list response.\n " additionalProperties: false properties: referenceNumber: type: - string - 'null' description: "The watch list match criteria reference number.\n " watchListKey: type: - string - 'null' description: "The watch list key.\n " watchListPersonKey: type: - string - 'null' description: "The watch list person key.\n " matchKey: type: - string - 'null' description: "A key matching an API key depending on the MatchKeyType.\n " matchKeyType: description: "An enum indicating which API key MatchKey matches.\n " $ref: '#/components/schemas/MatchKeyType' matchDetail: type: - string - 'null' description: "The details of the person matched.\n " matchType: description: "What the person was matched by.\n " $ref: '#/components/schemas/MatchType' matchCode: type: - string - 'null' description: "The match code.\n " JourneyMove: type: object description: "Summarized move data at the journey level.\n " additionalProperties: false properties: maxMoveBackDays: type: integer description: "The maximum number of days this flight can be moved backwards.\n " format: int32 maxMoveOutDays: type: integer description: "The maximum number of days this flight can be moved forward.\n " format: int32 PassengerDocumentCheckResponse: type: object description: "Model for passenger document check response.\n " additionalProperties: false properties: passengerAlternateKey: type: - string - 'null' description: "The passenger alternative key.\n " name: description: "The passenger name.\n " $ref: '#/components/schemas/Name' documentCheckStatus: description: "The document check status of the passenger.\n " $ref: '#/components/schemas/DocumentCheckStatus' FareOverrideRequest: type: object description: "Defines a fare override.\n " additionalProperties: false required: - amount properties: amount: type: number description: "The new fare amount.\n " format: decimal overridePublishedPrice: type: - boolean - 'null' description: "Whether the price being overridden is a published price or a discounted price\n " CheckinPassengerRequirementsv2: type: object description: "Defines an individual passengers checkin requirements.\n " additionalProperties: false properties: passengerKey: type: - string - 'null' description: "The associated passenger key.\n " documentRequirements: description: "The passengers document requirements.\n " $ref: '#/components/schemas/CheckinDocumentRequirementsv2' addressRequirements: description: "The passengers address requirements.\n " $ref: '#/components/schemas/CheckinAddressRequirements' invalidSsrs: type: - array - 'null' description: "The collection of checkin restricted/invalid SSR's the passenger contains.\n " items: type: string requiredSsrs: type: - array - 'null' description: "The collection of checkin required SSR's the passenger is missing for each segment.\n " items: $ref: '#/components/schemas/CheckinMissingSegmentRequiredSsr' restrictions: type: - array - 'null' description: "The list of passengers restrictions that will restrict passenger from checkin.\n " items: $ref: '#/components/schemas/CheckinPassengerRestriction' isValid: type: boolean description: "Flag indicating if the specific passenger checkin is valid.\n " SeatPreferenceStatus: type: integer description: "Defines the seat preference status.\n \n\n0 = Unknown\n1 = Met\n2 = NotMet" x-enumNames: - Unknown - Met - NotMet enum: - 0 - 1 - 2 CreateAccountRequest: type: object description: "The create account request model.\n " additionalProperties: false properties: currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 0 ChallengePreferenceWindowSize: type: integer description: "Defines the challenge preference window size.\n \n\n0 = SizeFullPage\n1 = Size250X400\n2 = Size390X400\n3 = Size500X600\n4 = Size600X400" x-enumNames: - SizeFullPage - Size250X400 - Size390X400 - Size500X600 - Size600X400 enum: - 0 - 1 - 2 - 3 - 4 BookingOrderStatus: type: integer description: "Booking Order Status Enumeration\n \n\n0 = None\n1 = FinalizedProcess" x-enumNames: - None - FinalizedProcess enum: - 0 - 1 BookingSummary: type: object additionalProperties: false properties: bookingKey: type: - string - 'null' allowedToModifyGdsBooking: type: boolean bookingStatus: $ref: '#/components/schemas/BookingStatus_2' channelType: $ref: '#/components/schemas/ChannelType_2' editable: type: boolean expiredDate: type: - string - 'null' format: date-time flightDate: type: - string - 'null' format: date-time flightNumber: type: - string - 'null' origin: type: - string - 'null' passengerId: type: integer format: int64 recordLocator: type: - string - 'null' sourceAgentCode: type: - string - 'null' sourceDomainCode: type: - string - 'null' sourceOrganizationCode: type: - string - 'null' systemCode: type: - string - 'null' destination: type: - string - 'null' name: $ref: '#/components/schemas/Name_2' BookingStatus_2: type: integer description: '0 = Default 1 = Hold 2 = Confirmed 3 = Closed 4 = HoldCanceled 5 = PendingArchive 6 = Archived 7 = ArchivedPrivate 777 = ProcessedForArchive' x-enumNames: - Default - Hold - Confirmed - Closed - HoldCanceled - PendingArchive - Archived - ArchivedPrivate - ProcessedForArchive enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 777 SearchByScanRequestV2: type: object additionalProperties: false required: - scan properties: scan: $ref: '#/components/schemas/ParseScanRequestV2' origin: type: - string - 'null' maxLength: 3 minLength: 3 departureDate: type: - string - 'null' format: date-time IJsonResponseOfListOfBookingSummary: type: object additionalProperties: false properties: data: type: - array - 'null' items: $ref: '#/components/schemas/BookingSummary' errors: type: - array - 'null' items: $ref: '#/components/schemas/ErrorResponse_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/Message_2' ChannelType_2: type: integer description: 'Defines the available channel types invoking communication with the server. 0 = Default 1 = Direct 2 = Web 3 = Gds 4 = Api 5 = DigitalApi 6 = DigitalWeb 7 = Ndc' x-enumNames: - Default - Direct - Web - Gds - Api - DigitalApi - DigitalWeb - Ndc enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 MessageStatus_2: type: integer description: '0 = General 1 = Warning 2 = Critical' x-enumNames: - General - Warning - Critical enum: - 0 - 1 - 2 ParseScanRequestV2: type: object additionalProperties: false properties: track1: type: - string - 'null' track2: type: - string - 'null' track3: type: - string - 'null' locationCode: type: - string - 'null' description: 'The location code specifying which parsing rules will be used. If not specified, the default location code from the JWT will be used.' documentTypeCode: type: - string - 'null' description: "This is only used when the scanned data is from a travel documment. If left blank\nwhen parsing a travel document's scanned data, the MRZ parser will try to guess \nwhich document type code to use." IJsonResponse_2: type: object additionalProperties: false properties: data: {} errors: type: - array - 'null' items: $ref: '#/components/schemas/ErrorResponse_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/Message_2' ErrorResponse_2: type: object additionalProperties: false properties: exception: $ref: '#/components/schemas/Exception' rawMessage: type: - string - 'null' code: type: - string - 'null' message: type: - string - 'null' type: type: - string - 'null' number: type: - integer - 'null' format: int32 maximum: 99999.0 minimum: 0.0 details: type: - object - 'null' additionalProperties: type: string ActivityId: type: - string - 'null' Message_2: type: object additionalProperties: false properties: code: type: - string - 'null' type: type: - string - 'null' value: type: - string - 'null' status: $ref: '#/components/schemas/MessageStatus_2' details: type: - object - 'null' additionalProperties: type: string Name_2: type: object additionalProperties: false properties: first: type: - string - 'null' middle: type: - string - 'null' last: type: - string - 'null' title: type: - string - 'null' suffix: type: - string - 'null' securitySchemes: JWT: type: http description: Paste your JWT token from the token endpoint. scheme: bearer bearerFormat: jwt x-refined-from: - tui-group-tui-cruise-booking-apis-openapi.yml - tui-group-tui-newskies-digital-api-openapi.yml - tui-group-tui-newskies-gonow-api-openapi.yml x-header: 'This API returns the price and availability for TUI''s packages specifically for OTA''s according to the G7 standard. ' x-summary: "This API returns the price and availability for TUI's packages specifically for OTA's according to the G7 standard.\nThe Travelmessage API returns information on all the available tui.nl packages, along with other relevant details such as price, extras, etc. for this specified package. \nThis API also allows to start a bookingdialogue for these packages.\n"