openapi: 3.2.0 info: title: NewSkies-Digital-Api Booking API version: 4.8.6.23 description: Navitaire Digital Api servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground security: - JWT: [] tags: - name: booking paths: /api/nsk/v1/booking: get: tags: - booking summary: Get the current booking in state. description: 'Note: To add a booking comment please use api/nsk/v3/booking. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: booking' operationId: nsk_v1_booking_get 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:12.9400815Z' createdDate: '2026-07-09T05:55:12.9400817Z' expirationDate: '2026-07-12T05:55:12.940082Z' modifiedDate: '2026-07-09T05:58:12.9400846Z' 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:12.9401375Z' 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:12.9402234Z' 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:12.9402276Z' 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:12.9402642+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:12.9402306Z' number: P31322423218 issuedDate: '2025-07-09T05:55:12.940236Z' gender: 1 dateOfBirth: '2025-07-09T05:55:12.9402364Z' 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:12.9404736Z' 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:12.9402665Z' number: P31322423218 issuedDate: '2016-07-09T05:55:12.9402666Z' gender: 1 dateOfBirth: '2002-07-09T05:55:12.9402667Z' 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:12.9403844Z' 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:12.9407477Z' departure: '2026-07-09T05:55:12.9407478Z' 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:12.9407477Z' departure: '2026-07-09T05:55:12.9407478Z' 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:12.9404781Z' 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:12.9404793Z' boardingSequence: '0' createdDate: '2026-07-09T05:55:12.9404795Z' liftStatus: 0 modifiedDate: '2026-07-09T06:05:12.9404798Z' overBookIndicator: 0 priorityDate: '2026-07-09T05:55:12.94048Z' 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:12.9405003Z' 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:12.9407349Z' international: false flightReference: 20250131 NV5670 SLCBOS legs: - legKey: NjM4NzM5NDE0MDAwMDAwMDAwIU5WITU2NzAhICFTTEMhQk9TITI0MDYxMDQ- operationsInfo: arrivalGate: estimatedGate: First Gate actualGate: Second Gate estimatedArrivalTime: '2026-07-09T08:55:12.9407372Z' departureGate: estimatedGate: First Gate actualGate: Second Gate actualOffBlockTime: '2026-07-10T05:55:12.9407413Z' actualOnBlockTime: '2026-07-10T05:55:12.940742Z' actualTouchDownTime: '2026-07-11T05:55:12.9407422Z' airborneTime: '2026-07-10T08:55:12.9407424Z' arrivalNote: Arrival Note arrivalStatus: 0 baggageClaim: Baggage Claim departureNote: Departure Note departureStatus: 0 departureTimes: scheduled: '2026-07-09T05:55:12.940743Z' estimated: '2026-07-09T05:45:12.9407431Z' standardArrivalTime: '2026-07-10T05:55:12.9407433Z' tailNumber: 9V-SKA designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:12.9407477Z' departure: '2026-07-09T05:55:12.9407478Z' legInfo: departureTimeUtc: '2026-07-09T12:55:12Z' arrivalTimeUtc: '2026-07-10T10:55:12Z' 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:12.9407451Z' departureTime: '2026-07-09T05:55:12.9407451Z' 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:12.9407505Z' 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:12.9408301Z' payments: - paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx code: VI approvalDate: '2026-07-09T05:55:12.9408487Z' details: accountNumberId: 0 parentPaymentId: 0 accountName: John Doe accountNumber: '5110920006810092' expirationDate: '2030-07-09T05:55:12.94085Z' 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:12.9408528Z' transactionCode: TRANSACTION dcc: rateId: 4c59d768-b5e7-4217-822d-92bbdf7aa78c 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:12.9409321Z' modifiedDate: '2026-07-09T06:00:12.9409323Z' 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:12.9413975Z' beginLocation: SLC endDate: '2026-07-16T05:55:12.9414171Z' endLocation: BOS externalReference: HONDA-123 description: Car Rental externalConfirmationNumber: HDA365 reference: Component Reference created: agentReference: MTIxNTg- agentCode: Agent date: '2026-07-09T05:55:12.941594Z' 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:12.9416424Z' 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:12.9421047Z' 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:12.9423547Z' 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:12.9424383Z' 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:12.9425326Z' 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:12.9437007Z' modified: '2026-07-09T06:25:12.9437187Z' 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: 2a727ff3-4f5a-4d07-a83d-6e617e656d29 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: No booking in state: description: There is no booking to retrieve in the session state. value: errors: - id: null code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. 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' /api/nsk/v3/booking: post: tags: - booking summary: Commits stateful changes made and processes the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` This endpoint can be configured to allow for the newly created record locator to be returned in the response. This is an API value that needs to be set in configuration, NskSystemOptions.ReturnPnrOnv3BookingPost = true. Default behavior is to not return the new record locator. This will require a SNOW ticket to change. GraphQL endpoint: bookingCommitv3' operationId: nsk_v3_booking_post requestBody: x-name: request description: Commit request. content: application/json: schema: $ref: '#/components/schemas/CommitRequestv2' required: true x-position: 1 responses: '201': description: Committed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCommitBookingResponse' '403': description: Role permissions are not met. 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' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Duplicate passenger names: description: Example error with 2 passengers with identical names. value: errors: - id: null code: nsk-server:DuplicatePassengerName message: 'Booking is not allowed to have two passengers with the same name: Derek Holmes' type: Error details: null 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 Modified Booking: description: Booking was modified since last viewed, please reload. value: errors: - id: null code: nsk-server:BookingWasModified message: Booking ZZZ123 has been modified by another user. type: Error details: null 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 Class Not Available: description: The class of service has sold out since the shopping request was made. value: errors: - id: null code: nsk-server:ClassNotAvailable message: The requested class of service is sold out. type: Error details: null 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 SSR Not Available: description: The SSR has sold out since the ssr availability request was made. value: errors: - id: null code: nsk-server:SSRNotAvailable message: SSR PS is not available on flight FR1123 SLC-DEN for passenger John Smith. type: Error details: null 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 Hold Not Allowed Error: description: Example error when Committing Booking while Hold Date Override is disabled. value: errors: - id: null code: nsk:Booking:HoldNotAllowed message: A booking hold is not allowed for this booking. Verify that the booking has journeys, balance due, or override is configured. type: Error details: null 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 Hold Greater Than Allowed: description: Example error when Committing Booking with Hold Date Greater Than allowed. value: errors: - id: null code: nsk-server:HoldBookingNotAllowed message: The selected hold date is not allowed. The value, 11/14/2023 00:00:00, and is greater than the allowed hold date of 11/10/2023 01:01:00. type: Error details: null 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 First passenger is not allowed to be TBA and is set as TBA: description: Example error when first passenger is not allowed to be TBA and its first or last name is set to "TBA". Please see GET /settings/booking/passenger for the configuration. value: errors: - id: null code: nsk:GroupBooking:GroupNameUpdateNotAllowed message: The first Pax is not allowed to be listed as TBA. type: Validation details: null rawMessage: The first Pax is not allowed to be listed as TBA. 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 Passengers are not allowed to be TBA and at least one passenger is set to TBA: description: Example error when passengers are not allowed to be TBA and at least one passenger's first or last name is set to "TBA". Please see GET /settings/booking/passenger for the configuration. value: errors: - id: null code: nsk:GroupBooking:GroupNameUpdateNotAllowed message: No passengers are allowed to be listed as TBA. type: Validation details: null rawMessage: No passengers are allowed to be listed as TBA. 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 put: tags: - booking summary: Commits stateful changes made and processes the booking. description: 'Only archived bookings can use the `Archive` comment type. If the booking in state is archived, only the comments will be acknowledged by New Skies. All other filled in fields in the request will be ignored. If AllowConcurrentChanges is set to true, a merge between concurrent changes between multiple sessions will be performed before committing the booking. New Skies refers to this as MergeAndCommit2. We recommend only setting this flag to true for cases where concurrent booking changes are highly possible (e.g. multiple sessions making changes to the same booking right before checking-in). IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingCommitv3' operationId: nsk_v3_booking_put parameters: - name: allowConcurrentChanges in: query description: Flag to allow concurrent booking changes between multiple sessions. schema: type: boolean x-position: 2 requestBody: x-name: request description: Commit request. content: application/json: schema: $ref: '#/components/schemas/CommitRequestv2' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Hold Date Changed: description: Example response when hold date is changed. value: messages: - rawValue: The hold date has changed from 10/10/2023 08:50 to 10/25/2023 00:00. code: '' 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: HoldDateChanged value: null status: 0 details: null 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: Duplicate passenger names: description: Example error with 2 passengers with identical names. value: errors: - id: null code: nsk-server:DuplicatePassengerName message: 'Booking is not allowed to have two passengers with the same name: Derek Holmes' type: Error details: null 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 Modified Booking: description: Booking was modified since last viewed, please reload. value: errors: - id: null code: nsk-server:BookingWasModified message: Booking ZZZ123 has been modified by another user. type: Error details: null 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 Class Not Available: description: The class of service has sold out since the shopping request was made. value: errors: - id: null code: nsk-server:ClassNotAvailable message: The requested class of service is sold out. type: Error details: null 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 SSR Not Available: description: The SSR has sold out since the ssr availability request was made. value: errors: - id: null code: nsk-server:SSRNotAvailable message: SSR PS is not available on flight FR1123 SLC-DEN for passenger John Smith. type: Error details: null 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 Hold Not Allowed Error: description: Example error when Committing Booking while Hold Date Override is disabled. value: errors: - id: null code: nsk:Booking:HoldNotAllowed message: A booking hold is not allowed for this booking. Verify that the booking has journeys, balance due, or override is configured. type: Error details: null 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 Hold Greater Than Allowed: description: Example error when Committing Booking with Hold Date Greater Than allowed. value: errors: - id: null code: nsk-server:HoldBookingNotAllowed message: The selected hold date is not allowed. The value, 11/14/2023 00:00:00, and is greater than the allowed hold date of 11/10/2023 01:01:00. type: Error details: null 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 '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' /api/nsk/v1/booking/baggageAllowances: get: tags: - booking summary: 'Gets the baggage allowances for the current booking in state. Baggage usage details will only be returned if includeUsageDetails is flagged true AND the allowance behavior is NOT Default.' description: 'GraphQL endpoint: baggageAllowances' operationId: nsk_v1_booking_baggageAllowances_get parameters: - name: includeUsageDetails in: query description: "If true, the baggage allowance usage details will be populated in the response.\nIncluding these details adds processing overhead, so set this only when absolutely necessary.\nDefaults to `false`, not include usage details.\n " schema: type: - boolean - 'null' x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIListOfBaggageAllowance' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/baggageAllowances/external: post: tags: - booking summary: Gets the third-party baggage allowance calculations for the current booking in state. description: 'Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues. GraphQL endpoint: baggageAllowancesExternal' operationId: nsk_v1_booking_baggageAllowances_external_post requestBody: x-name: request description: "External baggage allowance request.\n " content: application/json: schema: $ref: '#/components/schemas/ExternalBaggageAllowanceRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfExternalBaggageAllowanceResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/bundle/availability: post: tags: - booking summary: Retrieves the bundle and ssr availability for the booking in-state. description: 'Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues. GraphQL endpoint: bookingBundleAvailability' operationId: nsk_v1_booking_bundle_availability_post requestBody: x-name: request description: The bundle availability request. content: application/json: schema: $ref: '#/components/schemas/BundleAvailabilityRequest' required: true 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/IJsonResponseOfIListOfBundleAvailability' /api/nsk/v1/booking/comments: get: tags: - booking summary: Gets the list of comments on the in-state booking. description: Gets the list of comments on the in-state booking. operationId: nsk_v1_booking_comments_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingComment' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/comments/{commentKey}: delete: tags: - booking summary: Deletes a comment from the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingCommentsDeletev2' operationId: nsk_v2_booking_comments_commentKey_delete parameters: - name: commentKey in: path required: true description: The booking comment key. schema: type: string x-position: 1 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' /api/nsk/v2/booking/divide: post: tags: - booking summary: Divides the current booking. description: 'A valid user must be logged in to divide a booking. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingDividev2' operationId: nsk_v2_booking_divide_post requestBody: x-name: request description: Contains the divide request information. content: application/json: schema: $ref: '#/components/schemas/DivideRequestv2' required: true x-position: 1 responses: '201': description: Successfully divided. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' '200': description: Successfully divided and canceled. 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' '403': description: Role permissions are not met. 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' /api/nsk/v2/booking/equipment/legs/{legKey}: get: tags: - booking summary: Retrieves equipment information for a specified leg. description: 'GraphQL endpoint: legEquipmentv2' operationId: nsk_v2_booking_equipment_legs_legKey_get parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfEquipmentBasev2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/equipment/legs/{legKey}/properties: get: tags: - booking summary: Retrieves equipment, supported seat property and seat-dependent SSR information for a specified leg. description: 'GraphQL endpoint: legEquipmentPropertiesv2' operationId: nsk_v2_booking_equipment_legs_legKey_properties_get parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfEquipmentv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/equipment/segments/{segmentKey}: get: tags: - booking summary: Retrieves equipment information for all legs on a specified segment. description: 'GraphQL endpoint: segmentEquipmentv2' operationId: nsk_v2_booking_equipment_segments_segmentKey_get parameters: - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEquipmentBasev2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/equipment/segments/{segmentKey}/properties: get: tags: - booking summary: 'Retrieves equipment, supported seat property and seat-dependent SSR information for all legs on a specified segment.' description: 'GraphQL endpoint: segmentEquipmentPropertiesv2' operationId: nsk_v2_booking_equipment_segments_segmentKey_properties_get parameters: - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEquipmentv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/eTickets: post: tags: - booking summary: BETA - Issues new e-tickets and re-issues existing e-tickets for segments with voluntary changes. description: 'The endpoint performs validation and determines internally if the booking is for issuance of new e-tickets or re-issuance of existing e-tickets. For some cases that the re-issuance is not allowed by the ticketing service, a `502 BadGateway` will be returned and new e-tickets can be issued using the POST `api/nsk/v1/booking/eTickets/forceIssue` endpoint. GraphQL endpoint: eTicketAddv2' operationId: nsk_v2_booking_eTickets_post responses: '201': description: Successfully issued or re-issued e-tickets. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIssueETicketResponse' examples: Successfully issue or reissue new e-tickets: description: Example response when issuance or re-issuance of e-tickets is successful. value: ticketNumbers: - 0286010103190 - 0286010103191 '502': description: Bad gateway. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Failure to re-issue and needs new e-tickets: description: Example error when the attempt to re-issue was not allowed by the ticketing service and issuance of new e-tickets is needed instead. value: errors: - id: null code: nsk:ETickets:IssuanceOfNewETicketsRequired message: nsk:ETickets:IssuanceOfNewETicketsRequired type: Error details: null rawMessage: The ticketing service did not allow the re-issuance of e-tickets and new e-tickets are required to be issued instead. Please call the POST `api/nsk/v1/booking/eTickets/forceIssue` endpoint to force issuance of new e-tickets. 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 put: tags: - booking summary: BETA - Re-issues existing e-tickets for segments with involuntary changes such as schedule change and IROP. description: 'For some cases that the re-issuance is not allowed by the ticketing service, a `502 BadGateway` will be returned and new e-tickets can be issued using the POST `api/nsk/v1/booking/eTickets/forceIssue` endpoint. GraphQL endpoint: eTicketSetv2' operationId: nsk_v2_booking_eTickets_put responses: '200': description: Successfully re-issued e-tickets. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIssueETicketResponse' examples: Successfully issue or reissue new e-tickets: description: Example response when issuance or re-issuance of e-tickets is successful. value: ticketNumbers: - 0286010103190 - 0286010103191 '502': description: Bad gateway. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Failure to re-issue and needs new e-tickets: description: Example error when the attempt to re-issue was not allowed by the ticketing service and issuance of new e-tickets is needed instead. value: errors: - id: null code: nsk:ETickets:IssuanceOfNewETicketsRequired message: nsk:ETickets:IssuanceOfNewETicketsRequired type: Error details: null rawMessage: The ticketing service did not allow the re-issuance of e-tickets and new e-tickets are required to be issued instead. Please call the POST `api/nsk/v1/booking/eTickets/forceIssue` endpoint to force issuance of new e-tickets. 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 /api/nsk/v1/booking/eTickets: post: tags: - booking summary: Issues new e-tickets and re-issues existing e-tickets for segments with voluntary changes. description: 'The endpoint performs validation and determines internally if the booking is for issuance of new e-tickets or re-issuance of existing e-tickets. For some cases that the re-issuance is not allowed by the ticketing service, new e-tickets are issued instead. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: eTicketAdd' operationId: nsk_v1_booking_eTickets_post responses: '201': description: Successfully issued or re-issued e-tickets. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIssueETicketResponse' examples: Successfully issue or reissue new e-tickets: description: Example response when issuance or re-issuance of e-tickets is successful. value: ticketNumbers: - 0286010103190 - 0286010103191 '502': description: Bad gateway. 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' put: tags: - booking summary: Re-issues existing e-tickets for segments with involuntary changes such as schedule change and IROP. description: 'For some cases that the re-issuance is not allowed by the ticketing service, new e-tickets are issued instead. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: eTicketSet' operationId: nsk_v1_booking_eTickets_put responses: '200': description: Successfully re-issued e-tickets. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIssueETicketResponse' examples: Successfully issue or reissue new e-tickets: description: Example response when issuance or re-issuance of e-tickets is successful. value: ticketNumbers: - 0286010103190 - 0286010103191 '502': description: Bad gateway. 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' /api/nsk/v1/booking/eTickets/forceIssue: post: tags: - booking summary: BETA - Forces issuance of new e-tickets when re-issuance is not allowed by the ticketing service. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is intended to be used only if the POST or PUT e-tickets endpoints return an error with code `nsk:ETickets:IssuanceOfNewETicketsRequired`. Tickets are accountable documents and need to be available for check-in, refund or exchange. Using this endpoint other than the said use case would potentially cause negative impact during settlement and would require carriers to manually identify and close out e-tickets that were left open. GraphQL endpoint: eTicketForceAdd' operationId: nsk_v1_booking_eTickets_forceIssue_post responses: '201': description: Successfully issued or re-issued e-tickets. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIssueETicketResponse' examples: Successfully issue or reissue new e-tickets: description: Example response when issuance or re-issuance of e-tickets is successful. value: ticketNumbers: - 0286010103190 - 0286010103191 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: E-Ticket Required for Force Issuance: description: Example response when an existing e-ticket is required for force issuance. value: errors: - id: null code: nsk:ETickets:ETicketRequiredForForceIssuance message: nsk:ETickets:ETicketRequiredForForceIssuance type: Error details: null rawMessage: An existing e-ticket is required for force issuance of new e-tickets 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 '502': description: Bad gateway. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/eTickets/validation: get: tags: - booking summary: Checks if the booking in state is valid for e-ticketing operations. description: 'GraphQL endpoint: eTicketBookingValidation' operationId: nsk_v1_booking_eTickets_validation_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfETicketBookingValidationResponse' /api/nsk/v1/booking/fareOverride/journey/{journeyKey}: post: tags: - booking 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: fareOverrideAdd' operationId: nsk_v1_booking_fareOverride_journey_journeyKey_post parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 requestBody: x-name: request description: The fare override request. content: application/json: schema: $ref: '#/components/schemas/FareOverrideRequest' 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' '403': description: Role permissions are not met. 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' /api/nsk/v2/booking/fareRules: get: tags: - booking summary: Retrieves the collection of all fare rules from the current booking in state. description: 'Note that this defaults to returning the fare rules in html format. The html format may not be entirely culture sensitive, so setting the convertToHtml flag to false will allow users some flexibility when converting the content and the fare rules will be returned as an rtf string. GraphQL endpoint: fareRulesv3' operationId: nsk_v2_booking_fareRules_get parameters: - name: convertToHtml in: query description: Whether to convert to html. Defaults to true. schema: type: - boolean - 'null' x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFareRule' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/fareRules/category50/journeys/{journeyKey}/segments/{segmentKey}: post: tags: - booking summary: Get the category 50 fare rule information for a specific segment on a booking. description: 'This is functionally a GET but POST is used to reduce URL length overhead. GraphQL endpoint: bookingCategory50FareRuleInfov3' operationId: nsk_v2_booking_fareRules_category50_journeys_journeyKey_segments_segmentKey_post parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 2 - name: cultureCode in: query description: the culture code. schema: type: - string - 'null' x-position: 3 - name: convertToHtml in: query description: If true, converts the response's Text value from RTF to HTML. Defaults to true. schema: type: - boolean - 'null' x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCategory50Responsev2' examples: Retrieve Category 50 Fare Rule Information: description: Example response for successfully retrieving the category 50 fare rule information. value: data: title: Category 50 Fare Rule text: 'Fare Rules and Conditions: Tickets are available for purchase by all individuals aged 18 and above.' dataType: 0 cultureCode: en-US '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 Journey Key: description: The journey key is not valid nor does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'journeyKey' with value 'MTW' is invalid. type: Validation details: journeyKey: MTW rawMessage: The identifier 'journeyKey' with value 'MTW' 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 Segment Key: description: The segment key is not valid nor does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'segmentKey' with value 'MTW' is invalid. type: Validation details: segmentKey: MTW rawMessage: The identifier 'segmentKey' with value 'MTW' 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. '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Null Fare Rule Information: description: Example response when there is no fare rule information returned. value: data: null /api/nsk/v1/booking/fareRules/fare/{fareKey}: get: tags: - booking summary: 'Retrieves a fare rule from the current booking in state based on the specific fare key.' description: 'Note that this defaults to returning the fare rules in html format. The html format may not be entirely culture sensitive, so setting the convertToHtml flag to false will allow users some flexibility when converting the content and the fare rules will be returned as an rtf string. GraphQL endpoint: fareRulesByKeyv2' operationId: nsk_v1_booking_fareRules_fare_fareKey_get parameters: - name: fareKey in: path required: true description: The unique fare key. schema: type: string x-position: 1 - name: convertToHtml in: query description: Whether to convert to html. Defaults to true. schema: type: - boolean - 'null' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFareRule' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/fareRules/journey/{journeyKey}: get: tags: - booking summary: 'Retrieves the collection of all fare rules from the current booking in state for the specific journey key.' description: 'Note that this defaults to returning the fare rules in html format. The html format may not be entirely culture sensitive, so setting the convertToHtml flag to false will allow users some flexibility when converting the content and the fare rules will be returned as an rtf string. GraphQL endpoint: fareRulesByJourneyv3' operationId: nsk_v2_booking_fareRules_journey_journeyKey_get parameters: - name: journeyKey in: path required: true description: The unique journey key. schema: type: string x-position: 1 - name: convertToHtml in: query description: Whether to convert to html. Defaults to true. schema: type: - boolean - 'null' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFareRule' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/fareRules/segment/{segmentKey}: get: tags: - booking summary: Retrieves the collection of all fare rules from the current booking in state for the specific segment key. description: 'Note that this defaults to returning the fare rules in html format. The html format may not be entirely culture sensitive, so setting the convertToHtml flag to false will allow users some flexibility when converting the content and the fare rules will be returned as an rtf string. GraphQL endpoint: fareRulesBySegmentv3' operationId: nsk_v2_booking_fareRules_segment_segmentKey_get parameters: - name: segmentKey in: path required: true description: The unique segment key. schema: type: string x-position: 1 - name: convertToHtml in: query description: Whether to convert to html. Defaults to true. schema: type: - boolean - 'null' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFareRule' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/fee: get: tags: - booking summary: Gets the fee price. description: 'Only service and penalty fee types support a price that is configured by the booking in state. Depending on the configuration, the passenger key will be needed. For other fee types the price amount is manually provided. GraphQL endpoint: fee' operationId: nsk_v1_booking_fee_get parameters: - name: PassengerKey in: query description: "The passenger key.\n " schema: type: - string - 'null' x-position: 1 - name: Origin in: query description: "The origin station code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 2 - name: CollectedCurrencyCode in: query description: "The collected currency code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 1 x-position: 3 - name: FeeCode in: query description: "The fee code.\n " schema: type: - string - 'null' maxLength: 6 minLength: 0 x-position: 4 - name: FeePricingMode in: query description: "Determines if fees are to be paid in points or with currency.\n \nEnumeration values: 0 = MonetaryOnly, 1 = PointsOnly" schema: $ref: '#/components/schemas/FeePricingMode' x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfServiceCharge' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking summary: Manually adds a new fee. description: 'Penalty fees, spoilage fees, and service fees can be created manually. Other types are automatically created by the system. Depending on the configuration, the passenger key will be needed. If a passenger key was added to the request, the API will attempt to provide a location header url to point to the newly created fee using the passenger key and the passenger fee key from the new fee. However, depending on the fee type, this url may not always be valid. Spoilage fees for example are applied to the primary passenger, so if a non-primary passenger key was added on the request, the resulting url constructed by the API may result in a 404 - Not Found response. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: feeAdd' operationId: nsk_v1_booking_fee_post requestBody: x-name: request description: The fee request. content: application/json: schema: $ref: '#/components/schemas/CommitPassengerFeeRequest' required: true x-position: 1 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' /api/nsk/v1/booking/fee/{feeKey}: put: tags: - booking summary: Overrides a fee amount. description: 'When the fee override amount is zero, New Skies keeps or removes passenger fees with respect to the Store Confirming Waived Fees system setting. This endpoint returns a HTTP 200 on either case. Please retrieve the state booking afterwards to verify the absence or presence of the overridden fee. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: feeSet' operationId: nsk_v1_booking_fee_feeKey_put parameters: - name: feeKey in: path required: true description: The fee key. schema: type: string x-position: 1 requestBody: x-name: request description: The fee request. content: application/json: schema: $ref: '#/components/schemas/FeeRequestBase' required: true x-position: 2 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' delete: tags: - booking summary: Deletes a fee. description: 'If a fee is deleted during the same commit in which it was added, then the fee will not be present on the booking -- It is truly deleted If a fee is waived after it has been committed to a booking, then the fee will still be present, along with a "FEE OR" fee indicating the override is 0. This behavior can be changed by checking the "Store Confirming Waived Fees" box in the Booking Settings dialog in utilities (SYS Users Only). If this box is checked, then all fees will behave in the second manner shown above -- meaning that an uncommitted fee that is overriden to 0 will not be removed from the booking. Additionally, if the fee was added pre-commit and the SkySpeed setting ''Allow Fees to be Deleted'' is enabled for that user, then they will be able to delete the fee without needing waive fee permissions. Post-commit we still require waive fee permissions to override a fee. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: feeDelete' operationId: nsk_v1_booking_fee_feeKey_delete parameters: - name: feeKey in: path required: true description: The fee key request. schema: type: string x-position: 1 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' /api/nsk/v1/booking/fees: put: tags: - booking summary: Overrides multiple fee amounts. description: 'When the fee override amount is zero, New Skies keeps or removes passenger fees with respect to the Store Confirming Waived Fees system setting. This endpoint returns a HTTP 200 on either case. Please retrieve the state booking afterwards to verify the absence or presence of the overridden fees. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: feeSetMultiple' operationId: nsk_v1_booking_fees_put requestBody: x-name: request description: The multiple fee override request. content: application/json: schema: $ref: '#/components/schemas/MultipleFeeOverrideRequest' required: true x-position: 1 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' /api/nsk/v1/booking/fees/{feeKey}/quote: get: tags: - booking summary: Gets the override fee quote of an existing fee. description: 'GraphQL endpoint: overrideExistingFeeQuote' operationId: nsk_v1_booking_fees_feeKey_quote_get parameters: - name: feeKey in: path required: true description: The fee key of an existing fee. schema: type: string x-position: 1 - name: Amount in: query description: "The override amount.\n " schema: type: - number - 'null' format: decimal x-position: 2 - name: CollectedCurrencyCode in: query description: "The collected currency code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfGetOverrideFeeQuoteResponse' examples: Retrieve Override Fee Quote Response: description: Example response for successfully retrieving the override fee quote response. value: data: feeOverrideCharges: - amount: 100.0 code: NFSF detail: Non Flight type: 6 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 100.0 ticketCode: NSF '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 No Booking in State: description: Example Error if there is no booking in state. value: errors: - id: 505b55d3-cac8-93a9-4d25-131256cdd551 code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. 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 With Invalid Passenger Key: description: Example Error if passenger key is invalid. value: errors: - id: 2987bed7-5690-5050-55e9-819b8551b344 code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'PassengerKey' with value 'MCFBASDFRFQ-' 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 With Invalid Currency Code: description: Example Error if the currency code is invalid. value: errors: - id: 10daf3f4-82c2-cf99-21ba-169fadae0b10 code: nsk:Validation:UnknownSellCurrencyCode message: nsk:Validation:UnknownSellCurrencyCode type: Validation details: currencyCode: SDK rawMessage: The currency code SDK 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 With Invalid Fee Key: description: Example Error if fee key is invalid. value: errors: - id: ea9e908c-8979-85d8-c9ed-886014d6fc46 code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'FeeKey' with value 'MT21XF' 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 With Invalid Fee Code: description: Example Error if the fee code is not allowed to be quoted. value: errors: - id: bf7c1a48-a4bf-ddf7-2413-93959ba6a3b3 code: nsk-server:FeeCalculation message: nsk-server:FeeCalculation type: Validation details: null rawMessage: Cannot quote overrides of type NameChangeFee for new fees. 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 With Null Fee Code: description: Example Error if the fee code is null value: errors: - id: 6b34775e-d264-f3a6-4034-62daf6699617 code: GetNewOverrideFeeQuoteRequestBase.FeeCode:RequiredAttribute message: The GetNewOverrideFeeQuoteRequestBase field is required. type: Validation details: validation: RequiredAttribute model: GetNewOverrideFeeQuoteRequestBase member: FeeCode rawMessage: The GetNewOverrideFeeQuoteRequestBase 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 With Null Fee Amount: description: Example Error if the fee amount is null value: errors: - id: 6b34775e-d264-f3a6-4034-62daf6699617 code: GetNewOverrideFeeQuoteRequestBase.FeeCode:RequiredAttribute message: The GetNewOverrideFeeQuoteRequestBase field is required. type: Validation details: validation: RequiredAttribute model: GetNewOverrideFeeQuoteRequestBase member: Amount rawMessage: The GetNewOverrideFeeQuoteRequestBase 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 With Allow Negative Fees Role Setting Off: description: Example Error if the fee amount is negative or the fee type is not allowed to override, and the role setting is turned off. value: errors: - id: a49a0074-9b6d-9e30-83c3-1c21a56d748c code: nsk:Validation:RoleSettingsProhibit message: nsk:Validation:RoleSettingsProhibit type: Validation details: null rawMessage: Role settings prohibit a negative fee. 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 With Inactive Fees: description: Example Error if the agent attempted to sell inactive fees. value: errors: - id: bee189bc-edfc-263b-edc1-33cbf8b709cf code: nsk:Fee:NotFound message: nsk:Fee:NotFound type: Validation details: null rawMessage: The fee was not found. 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 With Unauthorized Overriding of Service Fees: description: Example Error if the agent is not authorized to override a service fee. value: errors: - id: 7911302f-46af-3dc8-5714-b2823fec853d code: nsk-server:AuthorizationSSRNotAllowed message: Agent is not authorized to override fees. type: Validation details: message: Agent is not authorized to override fees. rawMessage: Agent is not authorized to override fees. 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 With Unauthorized Selling of Service Fees: description: Example Error if the agent is not authorized to sell a service fee. value: errors: - id: cfdacd38-5e2c-ab09-9fce-86722e945f0b code: nsk-server:AuthorizationServiceFeeNotAllowed message: Agent is not authorized to sell service fee FLO. type: Validation details: message: Agent is not authorized to sell service fee FLO. rawMessage: Agent is not authorized to sell service fee FLO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/fees/penalty: delete: tags: - booking summary: Waives the penalty fee of all journeys in the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingPenaltyFeeDelete' operationId: nsk_v1_booking_fees_penalty_delete 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' /api/nsk/v1/booking/fees/spoilage: delete: tags: - booking summary: Waives the spoilage fee of all journeys in the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingSpoilageFeeDelete' operationId: nsk_v1_booking_fees_spoilage_delete 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' /api/nsk/v1/booking/groupName: put: tags: - booking summary: Changes the group name of the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: groupNameSet' operationId: nsk_v1_booking_groupName_put parameters: - name: groupName in: query description: The booking group name. schema: type: - string - 'null' x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '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 delete: tags: - booking summary: Deletes the group name of the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: groupNameDelete' operationId: nsk_v1_booking_groupName_delete 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' /api/nsk/v2/booking/groupName: put: tags: - booking summary: Changes the group name of the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: groupNameSetv2' operationId: nsk_v2_booking_groupName_put requestBody: x-name: request description: The booking group name request. content: application/json: schema: $ref: '#/components/schemas/BookingGroupNameRequest' required: true x-position: 1 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' /api/nsk/v2/booking/hold/available: get: tags: - booking summary: Retrieves the recommended hold date if hold is available. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingHoldv2' operationId: nsk_v2_booking_hold_available_get responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfNullableDateTime' '404': description: 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' /api/nsk/v1/booking/indiaGstRegistrationRequirement: get: tags: - booking summary: Returns true if it is expected to prompt the user for India GST registration details. description: 'GraphQL endpoint: indiaGstRegistrationRequirement' operationId: nsk_v1_booking_indiaGstRegistrationRequirement_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBoolean' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/info: get: tags: - booking summary: Gets the details of the current booking in state. description: 'This endpoint returns the same booking information in the GET /api/nsk/v1/booking endpoint, but with the addition of the eligibility of the booking for external baggage display. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingInfo' operationId: nsk_v1_booking_info_get responses: '200': description: OK. The request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBookingInfov2' examples: Retrieve booking information: description: Successful retrieval of the booking information value: data: isBookingEligibleForExternalBaggageDisplay: true status: 2 paidStatus: 1 priceStatus: 2 profileStatus: 1 bookingType: L channelType: 1 bookedDate: '2026-07-09T05:55:13.0532675Z' createdDate: '2026-07-09T05:55:13.0532678Z' expirationDate: '2026-07-12T05:55:13.053268Z' modifiedDate: '2026-07-09T05:58:13.0532694Z' modifiedAgentId: 1 createdAgentId: 1 owningCarrierCode: NV changeAllowed: true createdUserKey: MQ-- modifiedUserKey: MQ-- '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: No booking in state: description: There is no booking to retrieve in the session state. value: errors: - id: null code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. 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' /api/nsk/v1/booking/itinerary/print: post: tags: - booking summary: 'Sends the booking itinerary notification to the specified printer. Automatically commits uncommitted changes to the state booking before queuing the booking to a print notification queue.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingItineraryPrint' operationId: nsk_v1_booking_itinerary_print_post requestBody: x-name: request description: The print itinerary request. content: application/json: schema: $ref: '#/components/schemas/PrintItineraryRequest' required: true x-position: 1 responses: '202': description: The request was accepted 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' /api/nsk/v1/booking/penalties: get: tags: - booking summary: Gets the booking penalty from the booking in state. description: 'GraphQL endpoint: bookingPenalties' operationId: nsk_v1_booking_penalties_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBookingPenalty' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/penalties/{cancelledJourneyKey}: delete: tags: - booking summary: Waives the penalty fees of the specified cancelled journey. description: 'If the journey key specified is for a non-cancelled journey, i.e. the journey exists in the booking in state, an exception will be thrown. To waive the penalty fee of a journey in the booking in state, please use /api/nsk/v1/booking/journeys/{journeyKey}/fees/penalty instead. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingPenaltiesDeleteByKey' operationId: nsk_v1_booking_penalties_cancelledJourneyKey_delete parameters: - name: cancelledJourneyKey in: path required: true description: The journey key of the cancelled journey. schema: type: string x-position: 1 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' /api/nsk/v1/booking/pointOfSale: put: tags: - booking summary: Updates the booking point of sale. description: 'The ISO country code cannot be updated for a committed booking. This value can only be updated on an uncommitted booking. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingPointOfSaleSet' operationId: nsk_v1_booking_pointOfSale_put requestBody: x-name: request description: Details to update the point of sale. content: application/json: schema: $ref: '#/components/schemas/BookingPointOfSaleEditRequest' required: true x-position: 1 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' patch: tags: - booking summary: Updates the booking point of sale. description: 'The ISO country code cannot be updated for a committed booking. This value can only be updated on an uncommitted booking. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingPointOfSaleModify' operationId: nsk_v1_booking_pointOfSale_patch requestBody: x-name: request description: Details to update the point of sale. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfBookingPointOfSaleEditRequest' required: true x-position: 1 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' /api/nsk/v1/booking/prepaidExternal: post: tags: - booking summary: Creates a new prepaid external payment on the booking in state. description: 'This endpoint requires agent permissions. The payment fields are dynamic to the criteria of your payment provider. Here is an example request for a credit card payment that does not require address, zip, etc. { "amount": 10, "currencyCode": "USD", "paymentFields": {"ACCTNO":"411111111111", "EXPDATE":"10/8/2017", "CC::AccountHolderName":"Bob Smith", "CC::VerificationCode":"111"}} `IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: paymentPrepaidExternal' operationId: nsk_v1_booking_prepaidExternal_post parameters: - name: prepaidApprovalCode in: query description: "The prepaid approval code. This maps to a payment field with PrepaidApprovalCode as the system field type\n(configured in Utilities - Payment Types).\n " schema: type: - string - 'null' x-position: 2 requestBody: x-name: request description: The payment request. content: application/json: schema: $ref: '#/components/schemas/PaymentMethodRequest' required: true x-position: 1 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' /api/nsk/v1/booking/price: put: tags: - booking summary: Applies fares, discounts and taxes to the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: priceSet' operationId: nsk_v1_booking_price_put requestBody: x-name: priceRequest description: The price request. content: application/json: schema: $ref: '#/components/schemas/PriceRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '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' /api/nsk/v1/booking/price/validation: get: tags: - booking summary: Validates the fare prices on the booking in state. description: 'This endpoint is only recommended to be used with Fare Manager Plus and CAT1 validation is not fully supported in this endpoint outside of 4.5.2. GraphQL endpoint: priceValidate' operationId: nsk_v1_booking_price_validation_get 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: Failed Fare Restrictions: description: Example response when booking has failed fare restrictions value: errors: - id: 26b205f5-6db8-4b6f-ab9b-5697d5f9e3f7 code: nsk:Booking:FailedFareRestriction message: nsk:Booking:FailedFareRestriction type: Error details: failedFareRestrictions: 'Failed passenger eligibility restrictions Carrier: XY Rule Number: DA0X Fare Basis: HBUDDY New Skies Default Tariff Market: DTW-EWR' rawMessage: 'Failed passenger eligibility restrictions Carrier: XY Rule Number: DA0X Fare Basis: HBUDDY New Skies Default Tariff Market: DTW-EWR' 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 /api/nsk/v1/booking/promotion: post: tags: - booking summary: Sets a promotion code to a booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingPromotionCodeSet' operationId: nsk_v1_booking_promotion_post requestBody: x-name: request description: Promotion request. content: application/json: schema: $ref: '#/components/schemas/PromotionRequest' examples: Promotion request: description: Example request for adding a promotion code value: promotionCode: PROMO1 organizationCode: null Promotion request with organization code: description: Example request for adding a promotion code value: promotionCode: PROMO1 organizationCode: Organization ABC required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Promotion Already On Booking Error: description: Example error when attempting to add a promotion to a booking that already has a promotion applied. value: errors: - id: null code: nsk:Validation:ObjectAlreadyExists message: nsk:Validation:ObjectAlreadyExists type: Validation details: null rawMessage: Object already exists. 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 Requested Promotion Code Too Long: description: Example error when attempting to add a promotion code with more than 8 characters. value: errors: - id: null code: PromotionRequest.PromotionCode:StringLengthAttribute message: The field PromotionRequest must be a string with a maximum length of 8. type: Validation details: null rawMessage: The field PromotionRequest must be a string with a maximum length of 8. 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 Promotion Code: description: Example error when attempting to use a promotion code that does not exist. value: errors: - id: null code: nsk-server:PromotionNotFound message: nsk-server:PromotionNotFound type: Information details: null rawMessage: 'Specified promotion does not exist: PROMO22' 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' put: tags: - booking summary: Updates a promotion code to a booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingPromotionCodeSet' operationId: nsk_v1_booking_promotion_put requestBody: x-name: request description: Promotion request. content: application/json: schema: $ref: '#/components/schemas/PromotionRequest' examples: Promotion request: description: Example request for adding a promotion code value: promotionCode: PROMO1 organizationCode: null Promotion request with organization code: description: Example request for adding a promotion code value: promotionCode: PROMO1 organizationCode: Organization ABC required: true x-position: 1 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Promotion Updated: description: Example when the promotion has been successfully updated value: data: null Expired Promotion: description: Example warning when attempting to add an expired promotion value: messages: - rawValue: 'Promotion AUTPCAA is not valid for organization: ORG1.' code: PromotionNotApplied 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: Information value: PromotionNotApplied status: 0 details: null data: null '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Same Promotion Already On Booking Error: description: Example error when attempting to update the promotion on the booking to the same promotion that is already on the booking. value: errors: - id: null code: nsk:Booking:NotModified message: nsk:Booking:NotModified type: Validation details: null rawMessage: Booking was not modified. 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 Requested Promotion Code Too Long: description: Example error when attempting to add a a promotion code with more than 8 characters. value: errors: - id: null code: PromotionRequest.PromotionCode:StringLengthAttribute message: The field PromotionRequest must be a string with a maximum length of 8. type: Validation details: null rawMessage: The field PromotionRequest must be a string with a maximum length of 8. 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 Promotion Code: description: Example error when attempting to use a promotion code that does not exist. value: errors: - id: null code: nsk-server:PromotionNotFound message: nsk-server:PromotionNotFound type: Information details: null rawMessage: 'Specified promotion does not exist: PROMO22' 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 No Promotion Code On Booking: description: Example error when attempting to update a promotion code when none is on the booking. value: errors: - id: null code: nsk:Validation:ObjectNotFound message: nsk:Validation:ObjectNotFound type: Validation details: null rawMessage: The object is not found. 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' delete: tags: - booking summary: Deletes the promotion code on the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingPromotionCodeDelete' operationId: nsk_v1_booking_promotion_delete responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: No Promotion Code On Booking: description: Example error when attempting to delete a promotion code when none is on the booking. value: errors: - id: null code: nsk:Validation:ObjectNotFound message: nsk:Validation:ObjectNotFound type: Validation details: null rawMessage: The object is not found. 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' /api/nsk/v3/booking/queue: post: tags: - booking summary: Adds the booking from state to a booking queue. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingEnqueuev3' operationId: nsk_v3_booking_queue_post requestBody: x-name: request description: The booking request. content: application/json: schema: $ref: '#/components/schemas/BookingQueueRequestv2' required: true x-position: 1 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: 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 /api/nsk/v2/booking/queue: post: tags: - booking summary: Adds the booking from state to a booking queue. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingEnqueuev2' operationId: nsk_v2_booking_queue_post requestBody: x-name: request description: The booking request. content: application/json: schema: $ref: '#/components/schemas/BookingQueueRequestv2' required: true x-position: 1 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 delete: tags: - booking summary: Removes the booking in state from a booking queue. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingDequeuev2' operationId: nsk_v2_booking_queue_delete requestBody: x-name: request description: The booking request. content: application/json: schema: $ref: '#/components/schemas/BookingQueueDeleteRequest' required: true x-position: 1 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' /api/nsk/v1/booking/queues/{bookingQueueKey}: delete: tags: - booking summary: Removes the booking in state from the specified booking queue item. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingDequeueByKey' operationId: nsk_v1_booking_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' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/recordLocators: get: tags: - booking summary: Gets all of the record locators on the in-state booking. description: 'GraphQL endpoint: recordLocators' operationId: nsk_v1_booking_recordLocators_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfRecordLocator' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking summary: Adds a third party record locator to the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: recordLocatorsAdd' operationId: nsk_v1_booking_recordLocators_post requestBody: x-name: request description: The record locator request. content: application/json: schema: $ref: '#/components/schemas/RecordLocatorCreateRequest' required: true x-position: 1 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' delete: tags: - booking summary: Deletes all record locators from the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: recordLocatorsDelete' operationId: nsk_v1_booking_recordLocators_delete 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' /api/nsk/v1/booking/recordLocators/{recordLocatorKey}: get: tags: - booking summary: 'Gets the record locator associated with the record locator key for the in-state booking.' description: 'GraphQL endpoint: recordLocator' operationId: nsk_v1_booking_recordLocators_recordLocatorKey_get parameters: - name: recordLocatorKey in: path required: true description: The record locator key to retrieve. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfRecordLocator' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking summary: Replaces the data of a third party record locator on the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: recordLocatorsSet' operationId: nsk_v1_booking_recordLocators_recordLocatorKey_put parameters: - name: recordLocatorKey in: path required: true description: The record locator key to update. schema: type: string x-position: 1 requestBody: x-name: request description: The record locator update request. content: application/json: schema: $ref: '#/components/schemas/RecordLocatorEditRequest' 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' patch: tags: - booking summary: Patches the data of a third party record locator on the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: recordLocatorsModify' operationId: nsk_v1_booking_recordLocators_recordLocatorKey_patch parameters: - name: recordLocatorKey in: path required: true description: The record locator key to update. schema: type: string x-position: 1 requestBody: x-name: request description: The record locator update request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfRecordLocatorEditRequest' 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' delete: tags: - booking summary: Deletes a record locator from the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: recordLocatorDelete' operationId: nsk_v1_booking_recordLocators_recordLocatorKey_delete parameters: - name: recordLocatorKey in: path required: true description: The record locator key. schema: type: string x-position: 1 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' /api/nsk/v1/booking/reinstate: put: tags: - booking summary: Reinstates a booking with a status of hold canceled. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingReinstate' operationId: nsk_v1_booking_reinstate_put responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Reinstate Successful: description: Example when booking is Reinstated Successfully value: data: null Failed To Assign All Seats Message: description: Example OSI Message when reinstating a booking with no available seats value: messages: - rawValue: 'Failed to assign seat(s) for passenger Aurelio David on the flight NV5682 SLCBOS Detail: Seats cannot be assigned on flight segment NV5682 SLC-BOS for 12/01/2023 due to either one of the following: anchor unit Y/3E was not selected, insufficient number of available seats for 1 passenger (2 total). ' code: FailedToAssignAllSeats 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: FailedToAssignAllSeats value: null status: 0 details: reinstateGeneralMessage: 'Failed to assign seat(s) for passenger Aurelio David on the flight NV5682 SLCBOS Detail: Seats cannot be assigned on flight segment NV5682 SLC-BOS for 12/01/2023 due to either one of the following: anchor unit Y/3E was not selected, insufficient number of available seats for 1 passenger (2 total). ' data: null SSR Is Unavailable Message: description: Example OSI Message when reinstating a booking with no available SSRs value: messages: - rawValue: 'A SSR could not be sold for the following SSR, passenger and flight: LEGX|MCFBRFQ-|NV5683 |DEN|SLC|2023-11-17T00:00:00.0000000' code: SSRIsUnavailable 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: SSRIsUnavailable value: null status: 0 details: ssrCode: LEGX passengerKey: MCFBRFQ- carrierCode: NV flightNumber: '5683' opSuffix: null origin: DEN destination: SLC departureDate: '2023-11-17T00:00:00' data: null Failed To Reinstate Journey Message: description: Example OSI Message when reinstating a multi journey booking where there is at least one journey with no available AUs and at least one journey that succeeded to reinstate. value: messages: - rawValue: 'Failed to reinstate journey: 20231101 NV 5682 SLCBOS. Reason: The requested class of service is sold out.' code: FailedToReinstateJourney 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: FailedToReinstateJourney value: null status: 1 details: reinstateWarningMessage: 'Failed to reinstate journey: 20231101 NV 5682 SLCBOS. Reason: The requested class of service is sold out.' 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: Reinstate Restricted On Non HoldCanceled Error: description: Example error when Reinstating a booking that is not Hold Canceled. value: errors: - id: null code: nsk:Booking:ReinstateRestrictedOnNonHoldCanceled message: nsk:Booking:ReinstateRestrictedOnNonHoldCanceled type: Validation details: null rawMessage: Unable to reinstate a booking that is not hold canceled. 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 No Booking In State Error: description: Example error when Reinstating without a booking in state. value: errors: - id: null code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. 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 Failed To Reinstate Journey Error: description: Example error when all journeys failed to reinstate. value: errors: - id: null code: FailedToReinstateJourney message: FailedToReinstateJourney type: Error details: reinstateErrorMessage: 'Failed to reinstate journey: 20231101 NV 5682 SLCBOS. Reason: The requested class of service is not offered on this flight.' rawMessage: 'Failed to reinstate journey: 20231101 NV 5682 SLCBOS. Reason: The requested class of service is not offered on this flight.' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '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' /api/nsk/v1/booking/reset: delete: tags: - booking summary: Clears the current booking state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingReset' operationId: nsk_v1_booking_reset_delete 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' /api/nsk/v1/booking/salesChannel: put: tags: - booking summary: Overrides the effective sales channel for the booking in state. description: 'For the overriden channel to be implemented, the booking in state must be committed after calling this endpoint. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: salesChannelSet' operationId: nsk_v1_booking_salesChannel_put parameters: - name: channelType in: query description: "The sales channel type to override to. \nEnumeration values: 0 = Direct, 1 = Web, 2 = Api, 3 = DigitalApi, 4 = DigitalWeb, 5 = Ndc" schema: $ref: '#/components/schemas/OverrideChannelType' x-position: 1 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' /api/nsk/v2/booking/status: get: tags: - booking summary: Gets the status of the booking commit and returns the booking. description: 'There are certain booking data that are not saved to state, such as payment attachments. This endpoint will return the booking data so that non persisted information is returned when and only when the status code is 200. This is the only time the data will be available. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingCommitStatusv2' operationId: nsk_v2_booking_status_get responses: '200': description: Ok, booking has processed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' '202': description: Accepted, booking is still processing. 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' /api/nsk/v1/booking/systemCode: put: tags: - booking summary: Updates the system code of the state booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingSystemCodeSet' operationId: nsk_v1_booking_systemCode_put requestBody: x-name: systemCode description: The updated system code. content: application/json: schema: type: string required: true x-position: 1 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' delete: tags: - booking summary: Removes the system code of the state booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingSystemCodeDelete' operationId: nsk_v1_booking_systemCode_delete 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' /api/nsk/v1/booking/validation: get: tags: - booking summary: Evaluates the booking in state prior to commit or payment processing. description: 'The response indicates the forecasted status that will be applied to the booking during commit and if a held seat warning should be issued. GraphQL endpoint: bookingValidation' operationId: nsk_v1_booking_validation_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBookingValidationResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/verifiedTravelDocuments/segments/{segmentKey}/passengers/{passengerKey}: post: tags: - booking summary: Adds a new verified travel document to a passenger or the associated infant. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` The following items are required to use this endpoint. Agent permissions. Government Security Drivers need to be enabled under government security configurations. Government Security Drivers need to be configured to approve the given document type. The given document must be a document type approved by customs. The target passenger must be either CheckedIn or Boarded on the target segment. Due to the nature of this endpoint there is no data returned. To confirm successful update you can find an entry in the booking using GET `api/nsk/v1/booking` or view passenger segment information by pulling the booking using GET `/api/nsk/v1/bookings/{recordLocator}` GraphQL endpoint: bookingVerifiedTravelDocumentsAdd' operationId: nsk_v1_booking_verifiedTravelDocuments_segments_segmentKey_passengers_passengerKey_post parameters: - name: segmentKey in: path required: true description: The target segment key. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The target passenger key. schema: type: string x-position: 2 requestBody: x-name: request description: The request for updating verified travel documents on a bookings. content: application/json: schema: $ref: '#/components/schemas/BookingVerifiedTravelDocument' examples: Example verified travel document: description: An example of a basic verified travel document. value: documentTypeCode: P issuedByCode: US isInfant: false 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' examples: Invalid Record Locator Error: description: Example error when record locator is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: recordLocator: 9SkFNRegdQRYuQ3YfA2g9 rawMessage: The identifier 'RecordLocator' with value '9SkFNRegdQRYuQ3YfA2g9' 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 Invalid Passenger Key Error: description: Example error when passenger key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: passengerKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'PassengerKey' with value 'JoKwkYODu4gNYRwNQo' 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 Invalid Segment Key Error: description: Example error when segment key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: segmentKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'SegmentKey' with value 'JoKwkYODu4gNYRwNQo' 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 Invalid Lift Status Error: description: Example error when lift status is invalid. value: errors: - id: null code: nsk:VerifiedTravelDocuments:InvalidLiftStatus message: Updating verified travel documents requires the passenger to have a lift status of checked in or boarded. Lift status for passenger JoKwkYODu4gNYRwNQo is currently Default. type: Validation details: null 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 Invalid Document Type Error: description: Example error when document type is invalid. value: errors: - id: null code: nsk:VerifiedTravelDocuments:InvalidDocumentType message: The document type code 'INVALID' is invalid or inactive. type: Validation details: null 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 Invalid Issued by Code Error: description: Example error when document issued by code is invalid. value: errors: - id: null code: nsk:VerifiedTravelDocuments:InvalidIssuedByCode message: The issued by code 'INVALID' is invalid or inactive. type: Validation details: null 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 components: schemas: 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 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 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 PenaltyType: type: integer description: "Enumeration representing all the different penalty types.\n \n\n0 = None\n1 = WithFee\n2 = NonRefundable" x-enumNames: - None - WithFee - NonRefundable enum: - 0 - 1 - 2 PrintItineraryRequest: type: object description: "Defines the print itinerary request model.\n " additionalProperties: false required: - printerCode properties: printerCode: type: string description: "The printer code.\n " minLength: 1 numberOfCopies: type: - integer - 'null' description: "The number of copies.\nDefaults to 1 if not specified.\n " format: int32 maximum: 2147483647.0 minimum: 1.0 EquipmentBasev2: type: object description: "Represents the basic equipment information response model.\n " additionalProperties: false properties: marketInformation: description: "The market information.\n " $ref: '#/components/schemas/MarketInformation' name: type: - string - 'null' description: "The name of the equipment.\n " marketingCode: type: - string - 'null' description: "The market code.\n " equipmentCategory: description: "The equipment category.\n " $ref: '#/components/schemas/EquipmentCategory' availableUnits: type: integer description: "The available units.\n " format: int32 equipmentType: type: - string - 'null' description: "The type of equipment for the journey.\n " maxLength: 3 minLength: 0 equipmentTypeSuffix: type: - string - 'null' description: "The suffix associated with the equipment type.\n " maxLength: 3 minLength: 0 BookingPenalty: type: object description: "Defines booking penalty.\n " additionalProperties: false properties: journeyPenalties: type: - array - 'null' description: "The journey penalties.\n " items: $ref: '#/components/schemas/JourneyPenalty' GetOverrideFeeQuoteResponse: type: object description: "Defines the get override fee quote response.\n " additionalProperties: false properties: feeOverrideCharges: type: - array - 'null' description: "The list of service charges that contain the fee override amounts.\n " items: $ref: '#/components/schemas/ServiceCharge' 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 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' 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 IJsonResponseOfIListOfFareRule: 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/FareRule' 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' 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' 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 Equipmentv2: type: object description: "Represents the equipment information response model.\n " additionalProperties: false properties: marketInformation: description: "The market information.\n " $ref: '#/components/schemas/MarketInformation' name: type: - string - 'null' description: "The name of the equipment.\n " marketingCode: type: - string - 'null' description: "The market code.\n " equipmentCategory: description: "The equipment category.\n " $ref: '#/components/schemas/EquipmentCategory' availableUnits: type: integer description: "The available units.\n " format: int32 equipmentType: type: - string - 'null' description: "The type of equipment for the journey.\n " maxLength: 3 minLength: 0 equipmentTypeSuffix: type: - string - 'null' description: "The suffix associated with the equipment type.\n " maxLength: 3 minLength: 0 properties: type: - array - 'null' description: "Indicates the supported seat properties in effect on this equipment.\n " items: $ref: '#/components/schemas/SeatMapProperty' ssrs: type: - array - 'null' description: "Indicates the supported seat-dependent SSRs in effect on this equipment.\n " items: type: string ExternalBaggageAllowanceCarryOnDetail: type: object description: "External baggage allowance information details for carry-on baggage.\n " additionalProperties: false properties: mostSignificantCarrier: type: - string - 'null' description: "The carrier whose baggage allowance rules were used for assessment.\n " usDotDisclosure: type: - string - 'null' description: "U.S. DOT disclosure text.\n " freeAllowance: type: - string - 'null' description: "Short-hand description for free baggage that is allowed.\n " passengerReference: type: - string - 'null' description: "Passenger being referred for this baggage allowance detail.\nSets to \"EACH\" if this baggage allowance information matches all passengers\nfor the specified origin and destination.\n " passengerKey: type: - string - 'null' description: "The key of the passenger referred in the current state booking.\n " bagTravel: type: - string - 'null' description: "The origin and destination traveled by checked or carry-on baggage.\n " charges: type: - array - 'null' description: "Baggage charge details listed for each carry-on bag.\n " items: $ref: '#/components/schemas/ExternalBaggageAllowanceCarryOnCharge' IJsonResponseOfCommitBookingResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/CommitBookingResponse' 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' BundleJourneySsr: type: object description: "Model information for a bundle sell service request (SSR) tied to a specific journey.\n " additionalProperties: false properties: ssrCode: type: - string - 'null' description: "The unique code for the SSR.\n " passengersAvailability: type: - object - 'null' description: "The passengers to which this SSR is available.\n " additionalProperties: $ref: '#/components/schemas/PassengerSsrAvailability' ssrType: description: "Indicates the type of SSR.\n " $ref: '#/components/schemas/SsrType' name: type: - string - 'null' description: "Short description or name of the SSR.\n " limitPerPassenger: type: integer description: "Indicates how many SSRs is allowed per passenger.\n " format: int32 available: type: - integer - 'null' description: "The number of SSRs available.\n " format: int32 inventoryControlled: type: boolean description: "Indicates if the SSR is inventory controlled.\n " seatDependent: type: boolean description: "Indicates if the SSR is seat-dependent.\n " feeCode: type: - string - 'null' description: "The fee code associated with the SSR.\n " nest: type: - string - 'null' description: "The SSR nest.\n " seatRestriction: description: "Indicates the seat restriction for the SSR.\n " $ref: '#/components/schemas/SeatRestriction' journeyKey: type: - string - 'null' description: "The unique identifier for the journey.\n " journeyDetails: description: "The journey's market information.\n " $ref: '#/components/schemas/MarketInformation' 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 ExternalBaggageAllowanceCarryOnCharge: type: object description: "Charge details under each external baggage allowance information item for carry-on baggage.\n " additionalProperties: false properties: chargeDetail: type: - string - 'null' description: "Baggage allowance charge details.\n " DeltaMapperOfRecordLocatorEditRequest: type: object description: "Map delta changes of a specific type T to another object.\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 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 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 " PaymentMethodRequest: type: object description: "Defines a request to apply payment to the booking in state.\n " additionalProperties: false required: - amount - paymentMethodCode properties: amount: type: number description: "The amount to apply.\n " format: decimal maximum: 2147483647.0 minimum: 0.0 paymentFields: type: - object - 'null' description: "Dynamic field information used for validation related to the specific payment type.\nSee the PaymentMethodsAvailable view model / PaymentMethodFieldList\n " additionalProperties: type: string currencyCode: type: - string - 'null' description: "The currency code. This will default to the bookings currency code.\n " maxLength: 3 minLength: 0 installments: type: - integer - 'null' description: "The requested number of installments. Defaults to 1.\n " maximum: 32767.0 minimum: 1.0 paymentMethodCode: type: string description: "Payment method code.\n " maxLength: 2 minLength: 1 deposit: type: - boolean - 'null' description: "Whether to add the payment as a deposit.\n " waiveFees: type: - boolean - 'null' description: "Determines if the system calculated payment fee should be waived when adding this payment. This flag is for agents\nonly.\n " IJsonResponseOfBoolean: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: boolean description: "The payload data.\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' 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 " 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 " 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' 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 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 FeeRequest: type: object description: "Defines the request to retrieve a service fee.\n " additionalProperties: false required: - amount - feeKey properties: amount: type: number description: "The override amount.\n " format: decimal collectedCurrencyCode: type: - string - 'null' description: "The collected currency code.\n " maxLength: 3 minLength: 1 feeKey: type: string description: "The passenger fee key.\n " minLength: 1 BaggageAllowance: type: object description: "Defines a baggage allowance.\n " additionalProperties: false properties: baggageAllowanceKey: type: - string - 'null' description: "The unique identifier for the baggage allowance.\n " journeyKey: type: - string - 'null' description: "The journey key.\n " segmentKeys: type: - array - 'null' description: "The list of flight segment keys.\n " items: type: string passengerKey: type: - string - 'null' description: "The passenger key.\n " behavior: description: "The allowance behavior.\n " $ref: '#/components/schemas/BaggageAllowanceBehavior' typeCodes: type: - array - 'null' description: "The list of baggage type codes.\n " items: type: string maximumPieces: type: - integer - 'null' description: "The maximum number of pieces.\n " maximumWeightPerPiece: type: - number - 'null' description: "The maximum weight allowed per piece.\n " format: decimal totalWeight: type: - number - 'null' description: "The total weight for all pieces.\n " format: decimal weightType: description: "The weight type for MaximumWeightPerPiece and TotalWeight.\n " $ref: '#/components/schemas/WeightType' baggageUsage: description: "The associated baggage usage details.\n " $ref: '#/components/schemas/BaggageUsageDetails' 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 " IJsonResponseOfIssueETicketResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/IssueETicketResponse' 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' 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 FareRule: type: object description: "Defines a fare rule and its data.\n " additionalProperties: false properties: fareSellKey: type: - string - 'null' description: "The fare sell key that is in reference to the fare rule.\n " content: type: - string - 'null' description: "The fare rule content.\n " 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 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 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 " 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 " 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 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 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 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' SsrType: type: integer description: "SsrType enumeration.\n \n\n0 = Standard\n1 = Infant\n2 = Meal\n3 = BaggageAllowance\n4 = TravelLineMeal" x-enumNames: - Standard - Infant - Meal - BaggageAllowance - TravelLineMeal enum: - 0 - 1 - 2 - 3 - 4 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' 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 FeeApplication: type: integer description: "Enumeration representing how and where fees are to be applied.\n \n\n0 = Pnr\n1 = TravelComponent\n2 = EachPassenger\n3 = EachPassengerTravelComponent\n4 = SpecifyPassenger\n5 = AllPaxCheckingBagsTogether\n6 = PerBookingNoLimit" x-enumNames: - Pnr - TravelComponent - EachPassenger - EachPassengerTravelComponent - SpecifyPassenger - AllPaxCheckingBagsTogether - PerBookingNoLimit enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 IJsonResponseOfIListOfEquipmentv2: 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/Equipmentv2' 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' 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 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 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 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 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 BaggageAllowanceBehavior: type: integer description: "Baggage allowance behavior enumeration.\n \n\n0 = Default\n1 = WeightSharing\n2 = PerPiece\n3 = PerPieceWithWeightSharing\n4 = NotAvailable" x-enumNames: - Default - WeightSharing - PerPiece - PerPieceWithWeightSharing - NotAvailable enum: - 0 - 1 - 2 - 3 - 4 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' IJsonResponseOfEquipmentv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Equipmentv2' 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' ServiceBundleType: type: integer description: "Defines the types for bundles.\n \n\n0 = Included\n1 = AddOn" x-enumNames: - Included - AddOn enum: - 0 - 1 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 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 BaggageUsageDetails: type: object description: "Defines baggage usage details.\n " additionalProperties: false properties: baggageAllowanceKey: type: - string - 'null' description: "The baggage allowance key.\n " remainingPieces: type: - integer - 'null' description: "The remaining pieces.\n " remainingWeight: type: - number - 'null' description: "The remaining total weight.\n " format: decimal weightType: description: "The weight type for RemainingTotalWeight.\n " $ref: '#/components/schemas/WeightType' 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 BookingPaymentTransfer: type: object description: "Defines a booking payment transfer transaction\n " additionalProperties: false properties: bookingPaymentId: type: integer description: "The booking payment id to transfer.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 transferAmount: type: number description: "The amount to include in the transfer\n " format: decimal 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 " 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 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 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 " 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 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 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' 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 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 BundlePriceAvailability: type: object description: "The bundle price availability model.\n " additionalProperties: false properties: totalPrice: type: number description: "The total price for the service bundle, minus taxes.\nIncludes any fees associated with the bundle.\n " format: decimal taxTotal: type: number description: "The total sales taxes that are applicable to the\nservice bundle.\n " format: decimal feePrice: type: number description: "The fee price associated with the bundle if there is any.\n " format: decimal passengerType: type: - string - 'null' description: "The passenger type that is applicable to the service\nbundle.\n " maxLength: 4 minLength: 0 program: description: "The program details that are applicable to the service\nbundle.\n " $ref: '#/components/schemas/BundleProgramDetails' inclusiveTaxTotal: type: number description: "The total sales inclusive taxes that are applicable to the service bundle.\n " format: decimal includedSsrs: type: - array - 'null' description: "The included ssr availability.\n " items: $ref: '#/components/schemas/IncludedSsrAvailability' upgradableSsrs: type: - array - 'null' description: "The upgradable bundle ssr availability.\n " items: $ref: '#/components/schemas/UpgradableSsrAvailability' additionalSsrs: type: - array - 'null' description: "The additional bundle ssr availability.\n " items: $ref: '#/components/schemas/AdditionalSsrAvailability' inBundleSeat: description: "The in-bundle seat information.\n " $ref: '#/components/schemas/InBundleSeatAvailability' SeatMapProperty: type: object description: "Defines a property of a equipment unit.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The dynamic equipment property code.\n " value: type: - string - 'null' description: "The dynamic equipment property value.\n " RecordLocatorEditRequest: type: object description: "The record locator edit request model.\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 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' IJsonResponseOfExternalBaggageAllowanceResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ExternalBaggageAllowanceResponse' 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' 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 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 PromotionRequest: type: object description: "Defines the simple request to apply a promotion code.\n " additionalProperties: false required: - promotionCode properties: promotionCode: type: string description: "The promotion code to be applied.\n " maxLength: 8 minLength: 0 organizationCode: type: - string - 'null' description: "The point of sale organization code.\n " maxLength: 10 minLength: 0 BundlePricesByJourney: type: object description: "The bundle prices by journey model.\n " additionalProperties: false properties: journeyKey: type: - string - 'null' description: "The journey key associated with the bundle prices.\n " prices: type: - array - 'null' description: "The bundle price availabilities.\n " items: $ref: '#/components/schemas/BundlePriceAvailability' SeatRestriction: type: integer description: "The seat restriction enumeration.\n \n\n0 = Undefined\n1 = AlwaysAllowed\n2 = DefaultAllowed\n3 = DefaultRestricted" x-enumNames: - Undefined - AlwaysAllowed - DefaultAllowed - DefaultRestricted enum: - 0 - 1 - 2 - 3 BundleProgramDetails: type: object description: "Represents the bundle program details model.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The program code.\n " maxLength: 3 minLength: 0 level: type: - string - 'null' description: "The program level.\n " maxLength: 3 minLength: 0 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 UpgradableSsrAvailability: type: object description: "The upgradable bundle ssr availability model.\n " additionalProperties: false properties: upgradeFromSsrCode: type: - string - 'null' description: "The ssr code that was upgraded.\n " maxLength: 4 minLength: 0 ssrCode: type: - string - 'null' description: "The ssr code.\n " maxLength: 4 minLength: 0 currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 0 discountPercent: type: number description: "The discount percent.\n " format: decimal maximum: 1.0 minimum: 0.0 ssrNumber: type: integer description: "The SSR number.\n " isFeeWaived: type: boolean description: "Indicates if the service fee is waived.\n " amounts: type: - array - 'null' description: "The service bundle SSR discount amounts.\n " items: $ref: '#/components/schemas/BundleDiscountAmount' legSsrs: type: - array - 'null' description: "The available bundle leg ssrs.\n " items: $ref: '#/components/schemas/BundleLegSsr' segmentSsrs: type: - array - 'null' description: "The available bundle segment ssrs.\n " items: $ref: '#/components/schemas/BundleSegmentSsr' journeySsr: description: "The available bundle journey ssr.\n " $ref: '#/components/schemas/BundleJourneySsr' 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' IJsonResponseOfIListOfServiceCharge: 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/ServiceCharge' 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' IJsonResponseOfBookingInfov2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/BookingInfov2' 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' PenaltyFeeTypeInfo: type: object description: "Defines penalty fee type info.\n " additionalProperties: false properties: feeApplication: description: "The cancel fee application.\n " $ref: '#/components/schemas/FeeApplication' passengerFees: type: - array - 'null' description: "The cancel fees.\n " items: $ref: '#/components/schemas/PassengerFee' penaltyType: description: "The cancel penalty type.\n " $ref: '#/components/schemas/PenaltyType' 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 " 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 IJsonResponseOfNullableDateTime: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - string - 'null' description: "The payload data.\n " format: date-time 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' IssueETicketResponse: type: object description: "The response from issuing an e-ticket.\n " additionalProperties: false properties: ticketNumbers: type: - array - 'null' description: "The collection of issued or re-issued e-tickets.\n " items: type: string 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 " IJsonResponseOfIListOfRecordLocator: 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/RecordLocator' 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' 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 IJsonResponseOfBookingValidationResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/BookingValidationResponse' 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 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 PenaltyFeeType: type: integer description: "Enumeration representing all the different penalty fee types.\n \n\n0 = None\n1 = Change\n2 = Cancel\n3 = Move" x-enumNames: - None - Change - Cancel - Move enum: - 0 - 1 - 2 - 3 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 " 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 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 IncludedSsrAvailability: type: object description: "The included ssr availability model.\n " additionalProperties: false properties: bundleSsrPrice: type: number description: "The total price of the applied fee.\n " format: decimal taxTotal: type: number description: "The applied sales tax.\n " format: decimal inclusiveTaxTotal: type: number description: "The total sales inclusive taxes that are applicable to the service bundle ssr.\n " format: decimal ssrCode: type: - string - 'null' description: "The ssr code for the in-bundle ssr availability.\n " legSsrs: type: - array - 'null' description: "The available bundle leg ssrs.\n " items: $ref: '#/components/schemas/BundleLegSsr' segmentSsrs: type: - array - 'null' description: "The available bundle segment ssrs.\n " items: $ref: '#/components/schemas/BundleSegmentSsr' journeySsr: description: "The available bundle journey ssr.\n " $ref: '#/components/schemas/BundleJourneySsr' segmentKey: type: - string - 'null' description: "The segment key where the SSR availability pricing applies.\n " BundleLegSsr: type: object description: "Model information for a bundle sell service request (SSR) tied to a specific leg.\n " additionalProperties: false properties: ssrCode: type: - string - 'null' description: "The unique code for the SSR.\n " passengersAvailability: type: - object - 'null' description: "The passengers to which this SSR is available.\n " additionalProperties: $ref: '#/components/schemas/PassengerSsrAvailability' ssrType: description: "Indicates the type of SSR.\n " $ref: '#/components/schemas/SsrType' name: type: - string - 'null' description: "Short description or name of the SSR.\n " limitPerPassenger: type: integer description: "Indicates how many SSRs is allowed per passenger.\n " format: int32 available: type: - integer - 'null' description: "The number of SSRs available.\n " format: int32 inventoryControlled: type: boolean description: "Indicates if the SSR is inventory controlled.\n " seatDependent: type: boolean description: "Indicates if the SSR is seat-dependent.\n " feeCode: type: - string - 'null' description: "The fee code associated with the SSR.\n " nest: type: - string - 'null' description: "The SSR nest.\n " seatRestriction: description: "Indicates the seat restriction for the SSR.\n " $ref: '#/components/schemas/SeatRestriction' legKey: type: - string - 'null' description: "The unique identifier for the leg.\n " legDetails: description: "The leg's market information.\n " $ref: '#/components/schemas/MarketInformation' 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 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' 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 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' 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 " 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 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 " 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 PriceRequest: type: object description: "Defines price request.\n " additionalProperties: false properties: forceRefareItinerary: type: boolean description: "Set to true to force the system to select new fares for all journeys -- including those for which a fare has\nalready been applied.\n " buildConnections: type: boolean description: "When set to true, unpriced journeys will be combined with other journeys in the PNR, given that the connection\nexists in schedule and is priceable.\n " sourceBookingPointOfSale: description: "The source booking point of sale to use. If set, the booking's source point of sale will be updated to the\nspecified value, and will be used for evaluation of fare sales restrictions, tax rules that require the\norganization, etc. Note that updating the source point of sale will force RefareItinerary to true.\n " $ref: '#/components/schemas/BookingPointOfSale' typeOFSale: description: "Additional details that can drive the pricing results. Only ResidentCountry and PromotionCode will be used for\npricing decisions.\n " $ref: '#/components/schemas/TypeOfSale' 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 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 " 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 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 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' CommitBookingResponse: type: object description: "The response of committing a booking, providing the record locator.\n " additionalProperties: false properties: recordLocator: type: - string - 'null' description: "The record locator of the booking.\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 " 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' BundleDiscountAmount: type: object description: "The discount amount details for an SSR bundle.\n " additionalProperties: false properties: currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 0 amount: type: number description: "The discount amount.\n " format: decimal ssrNumber: type: integer description: "The SSR number.\n " InBundleSeatAvailability: type: object description: "In-bundle seat availability model.\n " additionalProperties: false properties: seatGroup: type: - string - 'null' description: "The applicable seat group.\n " bundleSsrPrice: type: number description: "The total price of the applied fee.\n " format: decimal taxTotal: type: number description: "The applied sales tax.\n " format: decimal inclusiveTaxTotal: type: number description: "The total sales inclusive taxes that are applicable to the service bundle ssr.\n " format: decimal ETicketQueueStatus: type: integer description: "Defines the queueing status of e-tickets in the booking.\n \n\n0 = None\n1 = NewIssue\n2 = Reissue\n3 = Revalidate" x-enumNames: - None - NewIssue - Reissue - Revalidate enum: - 0 - 1 - 2 - 3 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 Category50Responsev2: type: object description: "Represents a cat 50 response.\n " additionalProperties: false properties: title: type: - string - 'null' description: "The title of the category 50 fare rule information.\n " text: type: - string - 'null' description: "The formatted text for the category 50 fare rule information..\n " dataType: description: "The content data type of the text.\n " $ref: '#/components/schemas/ContentDataType' cultureCode: type: - string - 'null' description: "The culture code.\n " maxLength: 17 minLength: 0 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 " 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 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 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 ExternalBaggageAllowanceInfo: type: object description: "Information item used in a external baggage allowance information response.\n " additionalProperties: false properties: checkedBaggageAllowances: type: - array - 'null' description: "Allowances for checked baggage.\n " items: $ref: '#/components/schemas/ExternalBaggageAllowanceCheckedDetail' carryOnBaggageAllowances: type: - array - 'null' description: "Allowances for carry-on baggage.\n " items: $ref: '#/components/schemas/ExternalBaggageAllowanceCarryOnDetail' 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 " 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 " IJsonResponseOfEquipmentBasev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/EquipmentBasev2' 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' 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' 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 JourneyPenalty: type: object description: "Defines journey penalty.\n " additionalProperties: false properties: appliedFeeType: description: "The applied fee type.\n " $ref: '#/components/schemas/PenaltyFeeType' cancelPenaltyFeeInfo: description: "The cancel penalty fee info.\n " $ref: '#/components/schemas/PenaltyFeeTypeInfo' changePenaltyFeeInfo: description: "The change penalty fee info.\n " $ref: '#/components/schemas/PenaltyFeeTypeInfo' movePenaltyFeeInfo: description: "The move penalty fee info.\n " $ref: '#/components/schemas/PenaltyFeeTypeInfo' changeAllowed: type: boolean description: "The change allowed.\n " collectedCurrencyCode: type: - string - 'null' description: "The collected currency code.\n " feeWaived: type: boolean description: "The flag indicating whether fee is waived.\n " infantCancelFees: type: - array - 'null' description: "The infant cancel fees.\n " items: $ref: '#/components/schemas/PassengerFee' infantChangeFees: type: - array - 'null' description: "The infant change fees.\n " items: $ref: '#/components/schemas/PassengerFee' infantMoveFees: type: - array - 'null' description: "The infant move fees.\n " items: $ref: '#/components/schemas/PassengerFee' journeyKey: type: - string - 'null' description: "The journey key.\n " minimumPassengers: type: integer description: "The minimum passengers.\n " spoilageWaived: type: boolean description: "The spoilage waived flag.\n " 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 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 " 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' IJsonResponseOfGetOverrideFeeQuoteResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/GetOverrideFeeQuoteResponse' 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' ExternalBaggageAllowanceRequest: type: object description: "External baggage allowance information request.\n " additionalProperties: false required: - baggageWeights properties: baggageWeights: type: array description: "The list of weight items that represent baggage that will be used for baggage allowance evaluation.\n " items: $ref: '#/components/schemas/ExternalBaggageAllowanceWeight' 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 " IJsonResponseOfIListOfBookingComment: 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/BookingComment' 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' 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 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' 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 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 " 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 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 " 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 " IJsonResponseOfCategory50Responsev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Category50Responsev2' 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' 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 BookingVerifiedTravelDocument: type: object description: "The model for a dotRez stateful booking verified travel document.\n " additionalProperties: false required: - documentTypeCode - issuedByCode properties: documentTypeCode: type: string description: "The unique travel document type code.\n " maxLength: 4 minLength: 0 issuedByCode: type: string description: "The issuer code for the travel document (country code).\n " maxLength: 3 minLength: 0 isInfant: type: boolean description: "Flag for if this verified travel document is for an infant or not.\n " OverrideChannelType: type: integer description: "Defines the available channel types to override to.\n \n\n0 = Direct\n1 = Web\n2 = Api\n3 = DigitalApi\n4 = DigitalWeb\n5 = Ndc" x-enumNames: - Direct - Web - Api - DigitalApi - DigitalWeb - Ndc enum: - 0 - 1 - 2 - 3 - 4 - 5 PassengerSsrAvailability: type: object description: "Model containing the details about the availability and price of the Ssr for a specific passenger.\n " additionalProperties: false properties: ssrKey: type: - string - 'null' description: "The Ssr key that identifies the ssr, passenger and trip information.\nNote this key does not equal the SSR key on the booking. The availability key contains the ssr number that is\nhelpful in some creation requests as well as a less accurate departure date.\n " passengerKey: type: - string - 'null' description: "The passenger key.\n " price: type: number description: "Gets the SSR price.\n " format: decimal IJsonResponseOfBookingPenalty: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/BookingPenalty' 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' 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 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 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' 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 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 " 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 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 CommitPassengerFeeRequest: type: object description: "Defines the request to retrieve a service fee.\n " additionalProperties: false required: - feeCode properties: note: type: - string - 'null' description: "The note.\n " maxLength: 128 minLength: 0 origin: type: - string - 'null' description: "The origin station code.\n " maxLength: 3 minLength: 3 collectedCurrencyCode: type: - string - 'null' description: "The collected currency code.\n " maxLength: 3 minLength: 1 feeCode: type: string description: "The fee code.\n " maxLength: 6 minLength: 0 feePricingMode: description: "Determines if fees are to be paid in points or with currency.\n " $ref: '#/components/schemas/FeePricingMode' passengerKey: type: - string - 'null' description: "The passenger key.\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 " 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 IJsonResponseOfRecordLocator: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/RecordLocator' 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' 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 " 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 " 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 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' BookingCommentRequest: 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 sendToBookingSource: type: - boolean - 'null' description: "The flag for triggering an outbound sync message that will be generated to\nthe booking source as an SSR OTHS element.\n " 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 ExternalBaggageAllowanceCheckedCharge: type: object description: "Charge details under each external baggage allowance information item.\n " additionalProperties: false properties: chargeDetail: type: - string - 'null' description: "Baggage allowance charge details.\n " baggageWeight: description: "Baggage weight referred to by this charge detail in the request.\n " $ref: '#/components/schemas/ExternalBaggageAllowanceWeight' SsrDurationType: type: integer description: "Ssr duration type.\n \n\n0 = Segment\n1 = Journey\n2 = Leg" x-enumNames: - Segment - Journey - Leg enum: - 0 - 1 - 2 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 " 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 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 DeltaMapperOfBookingPointOfSaleEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: agentCode: type: string description: "The point of sale agent code.\n " maxLength: 64 minLength: 0 domainCode: type: - string - 'null' description: "The point of sale domain code.\n " maxLength: 5 minLength: 0 locationCode: type: - string - 'null' description: "The point of sale location code.\n " maxLength: 5 minLength: 0 organizationCode: type: string description: "The point of sale organization code.\n " maxLength: 10 minLength: 0 isoCountryCode: type: - string - 'null' description: "Two character country code, optionally supplied in GDS message\n " maxLength: 2 minLength: 0 sourceSystemCode: type: - string - 'null' description: "Two character system code, optionally supplied in GDS message\n " maxLength: 3 minLength: 0 ETicketBookingValidationResponse: type: object description: "The response for e-ticket booking validation.\n " additionalProperties: false properties: eTicketQueueStatus: description: "The e-ticket queue status.\n " $ref: '#/components/schemas/ETicketQueueStatus' AdditionalSsrAvailability: type: object description: "The additional ssr availability model.\n " additionalProperties: false properties: ssrCode: type: - string - 'null' description: "The ssr code.\n " maxLength: 4 minLength: 0 currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 0 discountPercent: type: number description: "The discount percent.\n " format: decimal maximum: 1.0 minimum: 0.0 ssrNumber: type: integer description: "The SSR number.\n " isFeeWaived: type: boolean description: "Indicates if the service fee is waived.\n " amounts: type: - array - 'null' description: "The service bundle SSR discount amounts.\n " items: $ref: '#/components/schemas/BundleDiscountAmount' legSsrs: type: - array - 'null' description: "The available bundle leg ssrs.\n " items: $ref: '#/components/schemas/BundleLegSsr' segmentSsrs: type: - array - 'null' description: "The available bundle segment ssrs.\n " items: $ref: '#/components/schemas/BundleSegmentSsr' journeySsr: description: "The available bundle journey ssr.\n " $ref: '#/components/schemas/BundleJourneySsr' RecordLocatorCreateRequest: type: object description: "The record locator create request model.\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 recordCode: type: - string - 'null' description: "The system domain code.\n " maxLength: 12 minLength: 0 owningSystemCode: type: - string - 'null' description: "The owning system code for the booking.\n " maxLength: 3 minLength: 0 EquipmentCategory: type: integer description: "Represents the category of the equipment used for reservation operations.\n \n\n0 = None\n1 = JetAircraft\n2 = PistonAircraft\n3 = TurbopropAircraft\n4 = Helicopter\n5 = Surface\n6 = Train\n7 = Bus\n8 = AllCategories" x-enumNames: - None - JetAircraft - PistonAircraft - TurbopropAircraft - Helicopter - Surface - Train - Bus - AllCategories enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 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 IJsonResponseOfIListOfEquipmentBasev2: 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/EquipmentBasev2' 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' IJsonResponseOfIDictionaryOfStringAndIListOfBaggageAllowance: 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/BaggageAllowance' 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' 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 IJsonResponseOfFareRule: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/FareRule' 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' 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 " ContentDataType: type: integer description: "Defines the content data type enumeration.\n \n\n0 = Default\n1 = Text\n2 = RichTextFormat\n3 = ImageJpg\n4 = ImageGif\n5 = ImageBmp\n6 = ImagePng\n7 = WordDoc\n8 = Html\n9 = Pdf\n10 = Uri\n11 = WordDocx\n-1 = Unmapped" x-enumNames: - Default - Text - RichTextFormat - ImageJpg - ImageGif - ImageBmp - ImagePng - WordDoc - Html - Pdf - Uri - WordDocx - Unmapped enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - -1 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 " 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 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 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 " 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 BookingPointOfSaleEditRequest: type: object description: "Model related to the booking point of sale edit request. This is to be used for update operations only.\n " additionalProperties: false required: - agentCode - organizationCode properties: agentCode: type: string description: "The point of sale agent code.\n " maxLength: 64 minLength: 0 domainCode: type: - string - 'null' description: "The point of sale domain code.\n " maxLength: 5 minLength: 0 locationCode: type: - string - 'null' description: "The point of sale location code.\n " maxLength: 5 minLength: 0 organizationCode: type: string description: "The point of sale organization code.\n " maxLength: 10 minLength: 0 isoCountryCode: type: - string - 'null' description: "Two character country code, optionally supplied in GDS message\n " maxLength: 2 minLength: 0 sourceSystemCode: type: - string - 'null' description: "Two character system code, optionally supplied in GDS message\n " maxLength: 3 minLength: 0 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 IJsonResponseOfIListOfBundleAvailability: 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/BundleAvailability' 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' 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 MultipleFeeOverrideRequest: type: object description: "Defines the multiple fee override request.\n " additionalProperties: false properties: feeRequests: type: - array - 'null' description: "The list of fee requests.\n " items: $ref: '#/components/schemas/FeeRequest' 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 " BookingValidationResponse: type: object description: "Represents the booking validation response model.\n " additionalProperties: false properties: issueHeldSeatWarning: type: boolean description: "Indicates that if a booking is committed, the seats might be lost based on the NewSkies configuration.\n " bookingStatus: description: "The forecasted status that will be applied if the booking is committed.\nThis will be reflected in the info.status node during a get booking call.\n " $ref: '#/components/schemas/BookingStatus' 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 FeeRequestBase: type: object description: "Defines the request to retrieve a service fee.\n " additionalProperties: false required: - amount properties: amount: type: number description: "The override amount.\n " format: decimal collectedCurrencyCode: type: - string - 'null' description: "The collected currency code.\n " maxLength: 3 minLength: 1 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 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 BundleAvailability: type: object description: "Model containing the bundle ssr availability information.\n " additionalProperties: false properties: bundleCode: type: - string - 'null' description: "The bundle code.\n " maxLength: 4 minLength: 0 serviceBundleType: description: "The type of the bundle\n " $ref: '#/components/schemas/ServiceBundleType' hasPrice: type: boolean description: "Indicates if the bundle has a cost associated with it.\n " pricesByJourney: type: - object - 'null' description: "The available in-state booking bundle prices per journey.\n " additionalProperties: $ref: '#/components/schemas/BundlePricesByJourney' 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 " 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 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 " FeePricingMode: type: integer description: "The fee pricing mode enumeration.\n \n\n0 = MonetaryOnly\n1 = PointsOnly" x-enumNames: - MonetaryOnly - PointsOnly enum: - 0 - 1 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 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 BookingGroupNameRequest: type: object description: "The booking group name request model.\n " additionalProperties: false properties: bookingGroupName: type: - string - 'null' description: "The booking group name.\n " 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 " ExternalBaggageAllowanceResponse: type: object description: "External baggage allowance information response.\n " additionalProperties: false properties: baggageAllowanceInformation: type: - object - 'null' description: "External baggage allowance information items.\n " additionalProperties: $ref: '#/components/schemas/ExternalBaggageAllowanceInfo' disclaimer: type: - string - 'null' description: "Disclaimer text.\n " DivideRequestv2: type: object description: "Defines the booking divide request.\n " additionalProperties: false properties: crsRecordLocators: type: - array - 'null' description: "The CRS record locators.\nIf a record locator and/or owning system code is provided they will be used instead of the record locator key\nvalues.\n " items: $ref: '#/components/schemas/RecordLocator' passengerKeys: type: - array - 'null' description: "The passengers to include specified by their respective keys.\n " items: type: string autoDividePayments: type: boolean description: "Allow the divide to automatically divide payments between bookings.\n " bookingPaymentTransfers: type: - array - 'null' description: "Specific amounts to split between the bookings. This is applied if auto divide payments is set to false.\n " items: $ref: '#/components/schemas/BookingPaymentTransfer' receivedBy: type: - string - 'null' description: "Specify the user requesting the booking divide.\n " maxLength: 64 minLength: 0 overrideRestrictions: type: boolean description: "Override any restrictions that may prevent divide.\n " parentEmail: type: - string - 'null' description: "The email address for updating the parent booking.\n " childEmail: type: - string - 'null' description: "The email address for the child booking.\n " cancelSourceBooking: type: boolean description: "Cancel the created booking after divide. If this is set to true the cancelled booking\nis not returned and its PNR is not easily available.\n " BookingInfov2: 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 " isBookingEligibleForExternalBaggageDisplay: type: boolean description: "Determines if the booking is eligible for external baggage display.\n " IJsonResponseOfETicketBookingValidationResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ETicketBookingValidationResponse' 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' 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 CommitRequestv2: type: object description: "Represents version two of the booking commit request.\n " additionalProperties: false properties: receivedBy: type: - string - 'null' description: "The received by name.\n " maxLength: 64 minLength: 0 restrictionOverride: type: boolean description: "If set to true, booking will be committed even if Price is not valid, granted that agent's role\nhas permission to override.\n " hold: description: "The booking hold date.\n " $ref: '#/components/schemas/BookingHold' notifyContacts: type: boolean description: "The notify contacts flag.\n " comments: type: - array - 'null' description: "The optional comments to add.\n " items: $ref: '#/components/schemas/BookingCommentRequest' contactTypesToNotify: type: - array - 'null' description: "List of contact type codes for notification.\nPlease note that this is a list of chars not a list of strings.\nFor example, there is usually a primary contact represented with 'P'.\nThese are configurable so valid types will depend on your environment.\n " items: type: string maxLength: 1 receivedReference: type: - string - 'null' description: "The received by reference.\n " maxLength: 20 minLength: 0 BundleAvailabilityRequest: type: object description: "Represents a bundle availability request.\n " additionalProperties: false properties: bundleCode: type: - string - 'null' description: "The optional bundle code to look for.\n " maxLength: 4 minLength: 0 currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 0 journeyKey: type: - string - 'null' description: "The optional journey key to get bundle availability for.\n " residentCountry: type: - string - 'null' description: "The country of residence for the passengers.\n " maxLength: 2 minLength: 0 sourceOrganization: type: - string - 'null' description: "The organization to use when evaluating availability of private fares (ATPCO faring\ncategory 15).\n " maxLength: 10 minLength: 0 passengerKeys: type: - array - 'null' description: "The passenger keys for the bundle availability requests.\n " items: type: string filterBundles: type: boolean description: "A flag to indicate if the results should be filtered such that only\nbundles with ssr availability will be returned.\n " ExternalBaggageAllowanceWeight: type: object description: "Weight item for requesting external baggage allowance information.\n " additionalProperties: false properties: weight: type: integer description: "Weight value.\n " format: int32 type: description: "Weight type.\n " $ref: '#/components/schemas/WeightType' 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 BundleSegmentSsr: type: object description: "Model information for a bundle sell service request (SSR) tied to a specific segment.\n " additionalProperties: false properties: ssrCode: type: - string - 'null' description: "The unique code for the SSR.\n " passengersAvailability: type: - object - 'null' description: "The passengers to which this SSR is available.\n " additionalProperties: $ref: '#/components/schemas/PassengerSsrAvailability' ssrType: description: "Indicates the type of SSR.\n " $ref: '#/components/schemas/SsrType' name: type: - string - 'null' description: "Short description or name of the SSR.\n " limitPerPassenger: type: integer description: "Indicates how many SSRs is allowed per passenger.\n " format: int32 available: type: - integer - 'null' description: "The number of SSRs available.\n " format: int32 inventoryControlled: type: boolean description: "Indicates if the SSR is inventory controlled.\n " seatDependent: type: boolean description: "Indicates if the SSR is seat-dependent.\n " feeCode: type: - string - 'null' description: "The fee code associated with the SSR.\n " nest: type: - string - 'null' description: "The SSR nest.\n " seatRestriction: description: "Indicates the seat restriction for the SSR.\n " $ref: '#/components/schemas/SeatRestriction' segmentKey: type: - string - 'null' description: "The unique identifier for the segment.\n " segmentDetails: description: "The segment market information.\n " $ref: '#/components/schemas/MarketInformation' ExternalBaggageAllowanceCheckedDetail: type: object description: "External baggage allowance information details for checked baggage.\n " additionalProperties: false properties: mostSignificantCarrier: type: - string - 'null' description: "The carrier whose baggage allowance rules were used for assessment.\n " usDotDisclosure: type: - string - 'null' description: "U.S. DOT disclosure text.\n " freeAllowance: type: - string - 'null' description: "Short-hand description for free baggage that is allowed.\n " passengerReference: type: - string - 'null' description: "Passenger being referred for this baggage allowance detail.\nSets to \"EACH\" if this baggage allowance information matches all passengers\nfor the specified origin and destination.\n " passengerKey: type: - string - 'null' description: "The key of the passenger referred in the current state booking.\n " bagTravel: type: - string - 'null' description: "The origin and destination traveled by checked or carry-on baggage.\n " charges: type: - array - 'null' description: "Baggage charge details listed for each checked bag.\n " items: $ref: '#/components/schemas/ExternalBaggageAllowanceCheckedCharge' BookingOrderStatus: type: integer description: "Booking Order Status Enumeration\n \n\n0 = None\n1 = FinalizedProcess" x-enumNames: - None - FinalizedProcess enum: - 0 - 1 securitySchemes: JWT: type: http description: Paste your JWT token from the token endpoint. scheme: bearer bearerFormat: jwt x-generator: NSwag v14.6.3.0 (NJsonSchema v11.5.2.0 (Newtonsoft.Json v13.0.0.0))