Coupon
A portion of the Passenger Ticket and Baggage Check or Excess Baggage Ticket that indicates particular places between which the coupon is good for carriage.
Properties
Name |
Description |
Type |
Required |
Generic |
Enum |
Ignore |
baggageAllowance |
An amount of checked or carry-on luggage the airline will allow per passenger. |
array |
false |
BaggageAllowance |
--- |
false |
connectedCouponNumber |
The coupon number to which this document is connected. |
number |
false |
|
|
false |
consumedAtIssuanceInd |
When TRUE, the coupon is consumed at issuance. |
boolean |
false |
|
|
false |
couponNumber |
Number assigned to the issued coupon. |
number |
false |
|
|
false |
couponValidityPeriod |
A date range a coupon is valid for with an optional time component. |
CouponValidityPeriod |
false |
|
|
false |
excessBaggage |
An Excess baggage information displayed on a coupon. |
ExcessBaggage |
false |
|
|
false |
fareBasisCode |
Fare basis code as ticketed. Example: Y26 |
string |
false |
|
|
false |
filedFee |
A Filed fee information relating to a coupon, including the Bankers Seller Rate used to convert the filed amount into the currency of payment. |
FiledFee |
false |
|
|
false |
involIndCode |
Involuntary charge transaction code. Example: I (Involuntary - no reason given). |
string |
false |
|
|
false |
mediaTypeCode |
Type of media used to issue the coupon (e.g. Electronic, Paper, Other). |
string |
false |
|
|
false |
nonCommissionableInd |
When TRUE, the document is non-commissionable. |
boolean |
false |
|
|
false |
nonInterlineableInd |
When TRUE, the document is non-interlineable. |
boolean |
false |
|
|
false |
nonRefundableInd |
When TRUE, the fare is non refundable. |
boolean |
false |
|
|
false |
nonReissuableNonExchInd |
When TRUE, the document is non-reissuable and/or exchangeable. |
boolean |
false |
|
|
false |
productCharacteristic |
A contextual information to further describe something using a key-value pair. |
KeyValueProperty |
false |
|
|
false |
promotion |
An Information item related to publicizing a product, organization, or venture so as to increase sales or public awareness. |
Promotion |
false |
|
|
false |
refNumber |
The sequential number (segment identifier) of an individual flight segment. |
number |
false |
|
|
false |
remarkText |
Free text to provide further information related to the document and/or coupon. |
string |
false |
|
|
false |
resChangeInfo |
A reservation change information which describes new flight information as it relates to a changed reservation. |
ResChangeInfo |
false |
|
|
false |
rficCode |
Reason For Issuance Code Examples: A (Air Transportation) C (Baggage) E (Airport Services) F (Merchandise) G (In-flight Services) |
ReasonForIssuanceCode |
false |
|
|
false |
rfiscCode |
Reason For Issuance Sub Code. Examples: 0CC (First Checked Bag) 0B1 (In-flight Entertainment) 0BX (Lounge) |
ReasonForIssuanceSubCode |
false |
|
|
false |
rfiscDescText |
Corresponding description for the Reason for Issuance subcode. |
string |
false |
|
|
false |
seqNumber |
The number representing the order in which this coupon was used or is to be used. |
number |
false |
|
|
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 |
serviceDeliveryDate |
The date that the associated service to this Coupon should be delivered. |
string |
false |
|
|
false |
serviceDeliveryProviderLocationCode |
The name of the service provider who will perform the service as described on an EMD coupon. |
IataLocationCode |
false |
|
|
false |
serviceDeliveryProviderName |
The location of service provider. Example: ATL |
string |
false |
|
|
false |
serviceQty |
Number of services of the same type that are included in an EMD coupon. |
number |
false |
|
|
false |
settlementAuthorizationIdentifier |
A reference ID generated by the validating carrier authorizing settlement of a coupon. Example: AUTH123 |
string |
false |
|
|
false |
soldAirlineInfo |
A transportation of a passenger on a Dated Operating Segment. |
PaxSegment |
false |
|
|
false |
statusCode |
Current status of the flight/ value coupon. Example: E (Exchanged/Reissued) |
string |
false |
|
|
false |
taxSummary |
A tax summary information. |
array |
false |
TaxSummary |
--- |
false |
ticket |
An accountable document issued by or on behalf of a carrier which includes notices and the flight and passenger coupons. |
Ticket |
true |
|
|
false |
validatingCarrier |
An organization which carries the passenger, baggage, or goods, and/or commits to delivering the carriage as well as any related services such as issuance of ticket, creation of Order, etc. |
Carrier |
false |
|
|
false |
valueAmount |
The value associated to a single coupon of a miscellaneous document (e.g. 100 USD). |
Amount |
false |
|
|
false |
{
"baggageAllowance" : [ {
"applicableBagText" : "string",
"applicablePartyText" : "string",
"baggageAllowanceIdentifier" : "string",
"bdc" : { },
"coupon" : { },
"descText" : "string",
"dimensionAllowance" : [ { } ],
"paxJourney" : { },
"pieceAllowance" : [ { } ],
"reasonForIssuanceSubCode" : { },
"serviceDefinition" : { },
"ticket" : { },
"typeCode" : { },
"weightAllowance" : [ { } ]
} ],
"connectedCouponNumber" : "number",
"consumedAtIssuanceInd" : "boolean",
"couponNumber" : "number",
"couponValidityPeriod" : {
"coupon" : { },
"duration" : "string",
"effectiveDate" : "string",
"expirationDate" : "string"
},
"excessBaggage" : {
"amount" : { },
"coupon" : { },
"measure" : { }
},
"fareBasisCode" : "string",
"filedFee" : {
"bankersSellerRate" : { },
"coupon" : { },
"feeAmount" : { }
},
"involIndCode" : "string",
"mediaTypeCode" : "string",
"nonCommissionableInd" : "boolean",
"nonInterlineableInd" : "boolean",
"nonRefundableInd" : "boolean",
"nonReissuableNonExchInd" : "boolean",
"productCharacteristic" : {
"affinityShoppingCriteria" : { },
"coupon" : { },
"discount" : { },
"keyText" : "string",
"prefLevel" : { },
"seatProfile" : { },
"valueText" : "string"
},
"promotion" : {
"coupon" : { },
"ownerName" : "string",
"pax" : [ { } ],
"paymentInfo" : { },
"promotionIdentifier" : "string",
"promotionIssuer" : { },
"remark" : [ { } ],
"shoppingCriteria" : { },
"urlUri" : "string"
},
"refNumber" : "number",
"remarkText" : "string",
"resChangeInfo" : {
"coupon" : { },
"paxSegment" : { },
"resStatusCode" : "string"
},
"rficCode" : {
"reasonForIssuanceCodeEnum" : { }
},
"rfiscCode" : {
"reasonForIssuanceSubCodeEnum" : { }
},
"rfiscDescText" : "string",
"seqNumber" : "number",
"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"
} ],
"serviceDeliveryDate" : "string",
"serviceDeliveryProviderLocationCode" : {
"iataLocationCodeEnum" : { }
},
"serviceDeliveryProviderName" : "string",
"serviceQty" : "number",
"settlementAuthorizationIdentifier" : "string",
"soldAirlineInfo" : {
"alacarteofferitem" : [ { } ],
"arnkInd" : "boolean",
"cabinType" : { },
"coupon" : { },
"datedMarketingSegment" : { },
"fareComponent" : { },
"flightService" : [ { } ],
"marketingCarrierRbd" : { },
"nonFlightService" : [ { } ],
"operatingCarrierRbd" : { },
"pax" : { },
"paxJourney" : { },
"paxLeg" : [ { } ],
"paxSegmentIdentifier" : "string",
"resChangeInfo" : { }
},
"statusCode" : "string",
"taxSummary" : [ {
"allRefundableInd" : "boolean",
"approximateInd" : "boolean",
"carrierFee" : { },
"collectionInd" : "boolean",
"coupon" : { },
"guaranteeTimeLimitDateTime" : "string",
"price" : { },
"pricingParameter" : { },
"tax" : [ { } ],
"totalTaxAmount" : { }
} ],
"ticket" : {
"baggageAllowance" : [ { } ],
"connectedDocNumber" : "number",
"coupon" : [ { } ],
"docTypeCode" : "string",
"exchReissueInd" : "boolean",
"feeOwnerCode" : { },
"presentCreditCardInd" : "boolean",
"primaryDocInd" : "boolean",
"remarkText" : "string",
"reportingTypeCode" : { },
"routingCode" : "string",
"taxOnEmdInd" : "boolean",
"ticketDocInfo" : { },
"ticketIssuanceInfo" : { },
"ticketNumber" : "number"
},
"validatingCarrier" : {
"aircraftGroup" : [ { } ],
"airlineAccountingCode" : "string",
"airlineCabinType" : [ { } ],
"airlineCriteria" : [ { } ],
"airlineDesigCode" : { },
"airlineLoadInfo" : [ { } ],
"airlineProfile" : { },
"alliance" : [ { } ],
"baggageAllowance" : { },
"baggageDisclosure" : { },
"baggageStandardWeights" : [ { } ],
"bagTag" : { },
"bookingEntity" : { },
"carrierAgent" : [ { } ],
"carrierAircraftType" : [ { } ],
"carrierFee" : { },
"clearance" : { },
"clearanceParty" : { },
"contactInfo" : [ { } ],
"contentOwner" : { },
"coupon" : { },
"crewBaggageStandardWeights" : [ { } ],
"crewStandardWeights" : [ { } ],
"datedMarketingSegment" : [ { } ],
"datedOperatingFlight" : [ { } ],
"datedOperatingSegment" : [ { } ],
"duplicateDesigInd" : "boolean",
"iataAircraftType" : [ { } ],
"iataNumber" : "number",
"loyaltyProgram" : { },
"loyaltyProgramAccount" : { },
"marketedOffer" : [ { } ],
"merchantAccount" : { },
"name" : "string",
"order" : [ { } ],
"orderItem" : [ { } ],
"paxStandardWeights" : [ { } ],
"programCriteria" : { },
"promotionIssuer" : { },
"service" : { },
"serviceDefinition" : [ { } ],
"shoppingResponse" : { },
"ticketIssuanceInfo" : { },
"uldType" : [ { } ],
"validatedOffer" : [ { } ],
"volumeUnitCode" : { },
"weightUnitCode" : { }
},
"valueAmount" : {
"curCode" : "string",
"value" : "number"
}
}