Pax
A person except members of the crew carried or to be carried with the consent of the carrier, on board of any transport vehicle such as aircraft, train, bus, ship. Holds the attributes specific to a one booking, from shopping to fulfillment.
Properties
Name |
Description |
Type |
Required |
Generic |
Enum |
Ignore |
ageMeasure |
The Age of the Passenger. To be used in NDC Anonymous Shopping requests or when the birthdate (in Individual) is not known. |
Measure |
false |
|
|
false |
ageOrdinal |
The Age of the Passenger. |
integer |
false |
|
|
false |
aLaCarteOfferItem |
A Container of one Service (excluding flights) or Service Bundle which is priced per unit. A La Carte Offer Items are optional, and the quantities of these can be selected for any of the eligible passengers and segments. |
array |
false |
ALaCarteOfferItem |
--- |
false |
bag |
A piece of luggage associated with a passenger, packed for traveling, and necessary or appropriate in connection with a journey. |
array |
false |
Bag |
--- |
false |
birthdate |
The Date of Birth of the Passenger. Intended to be used in NDC Anonymous Shopping requests. Example: 2017-01-13 |
string |
false |
|
|
false |
booking |
A booking or reservation. |
Booking |
false |
|
|
false |
contactInfo |
An electronic or geographic address which a party has provided as the contact channel. For example, contact email, contact postal address, contact phone number. |
array |
false |
ContactInfo |
--- |
false |
countryOfCitizenship |
A nation with its own government, occupying a particular territory. |
Country |
false |
|
|
false |
countryOfResidence |
A nation with its own government, occupying a particular territory. |
Country |
false |
|
|
false |
customerValueNumber |
A numeric value assigned to a customer by an airline to be used at the discretion of the airline. |
number |
true |
|
|
false |
existingOrderCriteria |
A References to Orders that were created from Offers that have already been purchased, booked and/or are being held for a Passenger. |
ExistingOrderCriteria |
true |
|
|
false |
fareDetail |
An amount charged by the carrier for the carriage of a passenger and his allowable free baggage. |
FareDetail |
true |
|
|
false |
foid |
A Form of identification. Typically used to identify that the passenger is who he says he is. This is the type of FOID as defined in AIRIMP (FF Number, Credit Card Number, etc.). |
Foid |
false |
|
|
false |
identityDoc |
A document which may be used to identify a person or verify aspects of a person's personal identity. If issued in a small, standard credit card size form, it is usually called an identity card. Some countries issue formal identity documents, while others may require identity verification using informal documents. When the identity document incorporates a person's photograph, it may be called photo ID. In the absence of a formal identity document, a driver's license may be accepted in many countries for identity verification. Most countries accept passports as a form of identification. |
array |
false |
IdentityDoc |
--- |
false |
individual |
A single human being as distinct from a group, class, or family. |
Individual |
true |
|
|
false |
infant |
Reference to Passenger instance within the context of one message, associating an infant on lap to the adult passenger. |
Pax |
false |
|
|
false |
langUsage |
A Language Code representation. |
array |
false |
LangUsage |
--- |
false |
loyaltyProgramAccount |
An account set up for a customer within a rewards program which holds funds on behalf of that customer. |
array |
false |
LoyaltyProgramAccount |
--- |
false |
offeredService |
An instance of a specific flight or Service Definition as it has been offered (and eventually ordered and consumed) in the context of a specific Offer and/or Order. |
array |
false |
Service |
--- |
false |
org |
An organized structure set up for a particular purpose, such as a business, government body, department, charity, or financial institution. |
Org |
false |
|
|
false |
pax |
Reference to Passenger instance within the context of one message, associating an infant on lap to the adult passenger. |
Pax |
true |
|
|
false |
paxGroup |
A number of individual passengers traveling under one commercial name that associates them. E.g. a Tour group or a group for sales allotment from airline to agency. |
PaxGroup |
false |
|
|
false |
paxIdentifier |
Uniquely identifies a Passenger within the context of one message. |
string |
false |
|
|
false |
paxSegment |
A transportation of a passenger on a Dated Operating Segment. |
array |
false |
PaxSegment |
--- |
false |
profileConsentInd |
When TRUE, passenger authorizes the airline to share his/her profile information or send promotional emails. |
boolean |
false |
|
|
false |
profileIdentifierText |
Passenger Profile ID |
string |
false |
|
|
false |
promotion |
An Information item related to publicizing a product, organization, or venture so as to increase sales or public awareness. |
Promotion |
true |
|
|
false |
ptcCode |
Type code applying to the Passenger which typically drives pricing (e.g. ADT, CHD, etc). |
string |
false |
|
|
false |
redressCase |
A person's case of being registered with a country's redress program, which can eliminate watch list misidentification and assist in identity verification. |
array |
false |
RedressCase |
--- |
false |
remark |
An additional, supplementary information about the document or service. |
array |
false |
Remark |
--- |
false |
service |
An instance of a specific flight or Service Definition as it has been offered (and eventually ordered and consumed) in the context of a specific Offer and/or Order. |
array |
false |
Service |
--- |
false |
ticketDocInfo |
An Information corresponding to a group of 1 to 4 Tickets for a single Origin Destination and a single Passenger. |
TicketDocInfo |
false |
|
|
false |
{
"ageMeasure" : {
"unitCode" : "string",
"value" : "number"
},
"ageOrdinal" : "integer",
"alacarteofferitem" : [ {
"cancelRestrictions" : [ { } ],
"changeRestrictions" : [ { } ],
"commission" : [ { } ],
"flightService" : { },
"offer" : { },
"offerItemIdentifier" : "string",
"orderItem" : { },
"pax" : [ { } ],
"paxJourney" : [ { } ],
"paxSegment" : [ { } ],
"paymentTimeLimit" : { },
"priceClass" : [ { } ],
"seatOnLeg" : { },
"unitPrice" : { }
} ],
"bag" : [ {
"bagDimension" : { },
"bagException" : [ { } ],
"bagLocationCity" : { },
"bagLocationCountry" : { },
"bagLocationRegion" : { },
"bagPhysicalProperty" : { },
"bagPosition" : { },
"bagSegment" : [ { } ],
"bagTag" : { },
"crewMember" : { },
"pax" : { },
"service" : { }
} ],
"birthdate" : "string",
"booking" : {
"bookingIdentifier" : "string",
"pax" : { },
"refCompanyCode" : "string",
"refTypeCode" : "string"
},
"contactInfo" : [ {
"aggregator" : { },
"airline" : { },
"carrier" : { },
"contactInfoIdentifier" : "string",
"contactPurposeText" : "string",
"contactRefusedInd" : "boolean",
"contactTypeText" : "string",
"corporation" : { },
"directBill" : { },
"emailAddress" : [ { } ],
"enabledSystem" : { },
"individual" : { },
"individualRefIdentifier" : "string",
"org" : { },
"otherAddress" : [ { } ],
"pax" : { },
"paxGroup" : { },
"paymentCard" : { },
"paymentInfo" : { },
"phone" : [ { } ],
"postalAddress" : [ { } ],
"relationshipToPaxText" : "string",
"retailPartner" : { },
"travelAgency" : { }
} ],
"countryOfCitizenship" : {
"affinityArrivalRequest" : [ { } ],
"affinityDepRequest" : [ { } ],
"bag" : { },
"carrierAgent" : [ { } ],
"citizenshipCountry" : [ { } ],
"citizenshipIdentifyingDoc" : [ { } ],
"countryCode" : { },
"countryName" : "string",
"countrySubDivision" : [ { } ],
"issuedIdentifyingDoc" : [ { } ],
"merchantAccount" : { },
"natlIdentifyingDoc" : [ { } ],
"pos" : [ { } ],
"redressCase" : [ { } ],
"residenceIdentifyingDoc" : [ { } ],
"residentialCountry" : [ { } ],
"salesTaxRegistration" : { },
"tax" : [ { } ],
"travelAgent" : [ { } ],
"visa" : [ { } ]
},
"countryOfResidence" : {
"affinityArrivalRequest" : [ { } ],
"affinityDepRequest" : [ { } ],
"bag" : { },
"carrierAgent" : [ { } ],
"citizenshipCountry" : [ { } ],
"citizenshipIdentifyingDoc" : [ { } ],
"countryCode" : { },
"countryName" : "string",
"countrySubDivision" : [ { } ],
"issuedIdentifyingDoc" : [ { } ],
"merchantAccount" : { },
"natlIdentifyingDoc" : [ { } ],
"pos" : [ { } ],
"redressCase" : [ { } ],
"residenceIdentifyingDoc" : [ { } ],
"residentialCountry" : [ { } ],
"salesTaxRegistration" : { },
"tax" : [ { } ],
"travelAgent" : [ { } ],
"visa" : [ { } ]
},
"customerValueNumber" : "number",
"existingOrderCriteria" : {
"order" : { },
"pax" : [ { } ],
"shoppingCriteria" : { }
},
"fareDetail" : {
"accountCode" : "string",
"fareCalculationInfo" : { },
"fareComponent" : [ { } ],
"fareIndCode" : "string",
"farePriceType" : [ { } ],
"fareRefText" : "string",
"fareWaiver" : [ { } ],
"filedFareInd" : "boolean",
"interlineSettlementInfo" : { },
"netReportingCodeText" : "string",
"orderItem" : { },
"pax" : [ { } ],
"penalty" : { },
"price" : { },
"pricingSystemCodeText" : "string",
"statisticalCodeText" : "string",
"ticketDocInfo" : { },
"tourCode" : "string"
},
"foid" : {
"creditCardIssuerCode" : { },
"foidIdentifier" : "string",
"pax" : { },
"typeText" : "string"
},
"identityDoc" : [ {
"birthdate" : "string",
"birthplaceText" : "string",
"countryOfCitizenship" : { },
"countryOfNatl" : { },
"countryOfResidence" : { },
"expiryDate" : "string",
"genderCode" : { },
"givenName" : "string",
"identityDocIdentifier" : "string",
"individual" : [ { } ],
"issueDate" : "string",
"issuerCountry" : { },
"middleName" : "string",
"pax" : { },
"suffixName" : "string",
"surname" : "string",
"titleName" : "string",
"typeCode" : { },
"visa" : [ { } ]
} ],
"individual" : {
"addlName" : [ { } ],
"agent" : [ { } ],
"birthdate" : "string",
"birthplaceSimpleText" : "string",
"birthplaceText" : "string",
"contactInfo" : [ { } ],
"crewMember" : [ { } ],
"employee" : [ { } ],
"genderCode" : { },
"givenName" : "string",
"handlingAgency" : [ { } ],
"identityDoc" : [ { } ],
"individualIdentifier" : "string",
"middleName" : "string",
"nameTypeCode" : { },
"pax" : [ { } ],
"payer" : { },
"suffixName" : "string",
"surname" : "string",
"titleName" : "string"
},
"infant" : {
"ageMeasure" : { },
"ageOrdinal" : "integer",
"alacarteofferitem" : [ { } ],
"bag" : [ { } ],
"birthdate" : "string",
"booking" : { },
"contactInfo" : [ { } ],
"countryOfCitizenship" : { },
"countryOfResidence" : { },
"customerValueNumber" : "number",
"existingOrderCriteria" : { },
"fareDetail" : { },
"foid" : { },
"identityDoc" : [ { } ],
"individual" : { },
"infant" : { },
"langUsage" : [ { } ],
"loyaltyProgramAccount" : [ { } ],
"offeredService" : [ { } ],
"org" : { },
"pax" : { },
"paxGroup" : { },
"paxIdentifier" : "string",
"paxSegment" : [ { } ],
"profileConsentInd" : "boolean",
"profileIdentifierText" : "string",
"promotion" : { },
"ptcCode" : "string",
"redressCase" : [ { } ],
"remark" : [ { } ],
"service" : [ { } ],
"ticketDocInfo" : { }
},
"langUsage" : [ {
"codesetMetadata" : { },
"langCode" : { },
"pax" : { },
"responseParameters" : { },
"text" : "string"
} ],
"loyaltyProgramAccount" : [ {
"accountNumberCode" : "string",
"alliance" : { },
"bagSegment" : [ { } ],
"carrier" : { },
"loyaltyProgram" : { },
"loyaltyProgramAccountIdentifier" : "string",
"loyaltyRedemption" : [ { } ],
"pax" : [ { } ],
"priorityCode" : "string",
"signInIdentifier" : "string",
"tierCode" : "string",
"tierLevelCode" : "string",
"tierName" : "string",
"tierPriorityText" : "string",
"typeCode" : "string"
} ],
"offeredService" : [ {
"accountingCode" : "string",
"accountingSubCode" : "string",
"actionCode" : { },
"alacarteofferitem" : { },
"bag" : [ { } ],
"bookingRef" : [ { } ],
"bookingStatusCode" : { },
"componentService" : [ { } ],
"compoundService" : { },
"coupon" : { },
"deliveryCode" : "string",
"deliveryMilestoneCode" : "string",
"deliveryProvider" : { },
"deliveryStatusCode" : { },
"deliveryStatusDescText" : "string",
"dependeeService" : { },
"dependentService" : [ { } ],
"descText" : "string",
"expirationDateTime" : "string",
"interlineSettlementInfo" : { },
"internalValue" : { },
"milestoneCode" : "string",
"offeredPax" : [ { } ],
"offerItem" : { },
"orderItem" : { },
"pax" : { },
"paxJourney" : { },
"paxSegment" : { },
"responsibleAirline" : { },
"selectedSeat" : { },
"serviceAssociations" : { },
"serviceDefinition" : { },
"serviceIdentifier" : "string",
"statusChangeReasonText" : "string",
"statusCode" : { },
"statusDescText" : "string",
"typeText" : "string",
"unchangedInd" : "boolean"
} ],
"org" : {
"bookingEntity" : { },
"bookingRef" : [ { } ],
"clearance" : { },
"clearanceParty" : { },
"contactInfo" : [ { } ],
"contentOwner" : { },
"name" : "string",
"orgIdentifier" : "string",
"pax" : { },
"programCriteria" : { },
"promotionIssuer" : { },
"salesTaxRegistration" : [ { } ],
"taxDeductedAtSourceCapabilityInd" : "boolean"
},
"pax" : {
"ageMeasure" : { },
"ageOrdinal" : "integer",
"alacarteofferitem" : [ { } ],
"bag" : [ { } ],
"birthdate" : "string",
"booking" : { },
"contactInfo" : [ { } ],
"countryOfCitizenship" : { },
"countryOfResidence" : { },
"customerValueNumber" : "number",
"existingOrderCriteria" : { },
"fareDetail" : { },
"foid" : { },
"identityDoc" : [ { } ],
"individual" : { },
"infant" : { },
"langUsage" : [ { } ],
"loyaltyProgramAccount" : [ { } ],
"offeredService" : [ { } ],
"org" : { },
"pax" : { },
"paxGroup" : { },
"paxIdentifier" : "string",
"paxSegment" : [ { } ],
"profileConsentInd" : "boolean",
"profileIdentifierText" : "string",
"promotion" : { },
"ptcCode" : "string",
"redressCase" : [ { } ],
"remark" : [ { } ],
"service" : [ { } ],
"ticketDocInfo" : { }
},
"paxGroup" : {
"bookingRef" : [ { } ],
"contactInfo" : [ { } ],
"intendedPaxQty" : "number",
"order" : { },
"orderItem" : { },
"pax" : [ { } ],
"paxGroupIdentifier" : "string",
"paxGroupName" : "string",
"responseParameters" : { }
},
"paxIdentifier" : "string",
"paxSegment" : [ {
"alacarteofferitem" : [ { } ],
"arnkInd" : "boolean",
"cabinType" : { },
"coupon" : { },
"datedMarketingSegment" : { },
"fareComponent" : { },
"flightService" : [ { } ],
"marketingCarrierRbd" : { },
"nonFlightService" : [ { } ],
"operatingCarrierRbd" : { },
"pax" : { },
"paxJourney" : { },
"paxLeg" : [ { } ],
"paxSegmentIdentifier" : "string",
"resChangeInfo" : { }
} ],
"profileConsentInd" : "boolean",
"profileIdentifierText" : "string",
"promotion" : {
"coupon" : { },
"ownerName" : "string",
"pax" : [ { } ],
"paymentInfo" : { },
"promotionIdentifier" : "string",
"promotionIssuer" : { },
"remark" : [ { } ],
"shoppingCriteria" : { },
"urlUri" : "string"
},
"ptcCode" : "string",
"redressCase" : [ {
"country" : { },
"pax" : { },
"programName" : "string",
"redressCaseIdentifier" : "string"
} ],
"remark" : [ {
"aircraft" : { },
"aircraftGroup" : { },
"asymmetricalLoadLimitationTable" : { },
"baggageStandardWeights" : { },
"balanceOutputRequirement" : { },
"cargoHeatingDevice" : { },
"cargoVentilationDevice" : { },
"centerOfGravityLimitTable" : { },
"combinedLoadLimitation" : { },
"combinedLoadLimitationTable" : { },
"creationDateTime" : "string",
"crewBaggageStandardWeights" : { },
"crewDistribution" : { },
"crewStandardWeights" : { },
"cumulativeLoadLimitationTable" : { },
"curtailmentTable" : { },
"datedOperatingFlight" : { },
"deck" : { },
"displayInd" : "boolean",
"dowConfiguration" : { },
"dowItem" : { },
"dryOperatingAircraft" : { },
"fareRule" : { },
"floorLoadLimitationTable" : { },
"fuelDistribution" : { },
"fuelingProcedure" : { },
"idealTrimLineTable" : { },
"lateralImbalanceLimitTable" : { },
"maximumWeights" : { },
"maximumWeightsTable" : { },
"minimumWeights" : { },
"minimumWeightsTable" : { },
"missingRestraintRule" : { },
"orderAmendment" : { },
"otherPaymentMethod" : { },
"pantryDistribution" : { },
"pax" : { },
"paxStandardWeights" : { },
"paxTrimOutputRequirement" : { },
"potableWaterDistribution" : { },
"priceVarianceRule" : { },
"promotion" : { },
"responseParameters" : { },
"runningLoadLimitationTable" : { },
"specialLoadLimitation" : { },
"stabTable" : { },
"supplementaryInfoRequirement" : { },
"swa" : { },
"text" : "string",
"tippingLimitTable" : { },
"uldCompatibility" : { },
"uldType" : { }
} ],
"service" : [ {
"accountingCode" : "string",
"accountingSubCode" : "string",
"actionCode" : { },
"alacarteofferitem" : { },
"bag" : [ { } ],
"bookingRef" : [ { } ],
"bookingStatusCode" : { },
"componentService" : [ { } ],
"compoundService" : { },
"coupon" : { },
"deliveryCode" : "string",
"deliveryMilestoneCode" : "string",
"deliveryProvider" : { },
"deliveryStatusCode" : { },
"deliveryStatusDescText" : "string",
"dependeeService" : { },
"dependentService" : [ { } ],
"descText" : "string",
"expirationDateTime" : "string",
"interlineSettlementInfo" : { },
"internalValue" : { },
"milestoneCode" : "string",
"offeredPax" : [ { } ],
"offerItem" : { },
"orderItem" : { },
"pax" : { },
"paxJourney" : { },
"paxSegment" : { },
"responsibleAirline" : { },
"selectedSeat" : { },
"serviceAssociations" : { },
"serviceDefinition" : { },
"serviceIdentifier" : "string",
"statusChangeReasonText" : "string",
"statusCode" : { },
"statusDescText" : "string",
"typeText" : "string",
"unchangedInd" : "boolean"
} ],
"ticketDocInfo" : {
"bookingAgency" : { },
"bookingRef" : [ { } ],
"bookletQty" : "number",
"carrierFee" : { },
"commission" : { },
"endorsementText" : "string",
"fareDetail" : { },
"orderAmendment" : { },
"originalIssueInfo" : { },
"originDest" : { },
"pax" : { },
"paymentInfo" : [ { } ],
"penalty" : [ { } ],
"pricingCountryCode" : { },
"pricingDate" : "string",
"pricingLocationCode" : { },
"pricingTime" : "string",
"referencedOrder" : { },
"servicingAgency" : { },
"ticket" : [ { } ],
"ticketRefIdentification" : [ { } ]
}
}