Offer
A proposal to sell a specific set of products or Services under specific conditions, for a certain price. Can be the response to a shopping request.
Properties
Name |
Description |
Type |
Required |
Generic |
Enum |
Ignore |
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 |
commission |
A remuneration either an amount of money, or a set percentage of the value involved, paid to an agent in relations to a commercial transaction. |
Commission |
false |
|
|
false |
disclosure |
A set of Information which should be made known. |
array |
false |
Disclosure |
--- |
false |
expirationTimeLimitDateTime |
The length of time an offer will persist in an airline's offer management system for use in subsequent transactions. Upon expiry, the expectation is that the offer is no longer retrievable and the shopping process must begin again. Note the presence of an Offer Time Limit does not indicate either a guarantee of price or inventory against a given Offer item within the Offer. Should the offer time limit expire, any other time limit also expires unless an Order has been created or changed. |
string |
false |
|
|
false |
inventoryGuarantee |
An Identification and time limit information for holding inventory in an Offer or Order. |
InventoryGuarantee |
false |
|
|
false |
marketingCarrier |
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 |
true |
|
|
false |
matchAppText |
Specifies which type of flight request the match information relate to (examples: Attribute, Affinity, Other). |
string |
false |
|
|
false |
matchPercent |
Offer match percentage to shopping criteria type. This information should be populated when there is a partial match of the initial shopping criteria. Example: 60 |
number |
false |
|
|
false |
matchTypeCode |
Offer match to shopping criteria type. Examples: Full, None, Partial, Other Note: An additional percentage qualifier, such as 50%, may be specified for a Partial match. |
MatchTypeCode |
false |
|
|
false |
offerIdentifier |
Carrier assigned ID which uniquely identifies a specific Offer across several messages. |
string |
false |
|
|
false |
offerItem |
A priced grouping of one or more services within an Offer. |
array |
true |
OfferItem |
--- |
false |
order |
A uniquely identified record of the agreement of one party with another to receive products and services under specified terms and conditions. Order supports the sale of a flexible range of airline products and services that are not necessarily Journey based (e.g. subscription services). |
Order |
true |
|
|
false |
ownerTypeCode |
Indicates whether or not the owner of this Order is the ORA or POA. |
OwnerTypeCode |
false |
|
|
false |
paymentTimeLimitDateTime |
A date/time by which payment commitment is required for a given Order Item. For example: PaymentTimeLimitDateTime: '2018-01-01T12:00:00Z' shows a static payment commitment date/time for a given Order Item. |
string |
false |
|
|
false |
penalty |
A fee or penalty for failure to meet agreed conditions. Information related to a punishment imposed for breaking a law, rule, or contract. |
array |
false |
Penalty |
--- |
false |
ptcOfferParameters |
A Passenger Type summary information for an offer. |
array |
false |
PtcOfferParameters |
--- |
false |
redemptionInd |
When TRUE, this Offer must be redeemed, e.g. it cannot be purchased. Note: Taxes may still apply. |
boolean |
false |
|
|
false |
requestedDateInd |
Indicator to specify if the offer relates to a requested date. For example in calendar search, this indicator will be set to 'true' if this airline offer is for a requested date and will not be present (or will be set to 'false' if airline offer is for another date than requested one. |
boolean |
false |
|
|
false |
totalPrice |
An amount of money expected, required, or given in payment for something. |
Price |
false |
|
|
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 |
webAddressUrlUri |
Deep linking into another site to complete the transaction. E.g. to bring the customer directly to a page to continue with a purchase of a specific offer. |
string |
false |
|
|
false |
{
"alacarteofferitem" : [ {
"cancelRestrictions" : [ { } ],
"changeRestrictions" : [ { } ],
"commission" : [ { } ],
"flightService" : { },
"offer" : { },
"offerItemIdentifier" : "string",
"orderItem" : { },
"pax" : [ { } ],
"paxJourney" : [ { } ],
"paxSegment" : [ { } ],
"paymentTimeLimit" : { },
"priceClass" : [ { } ],
"seatOnLeg" : { },
"unitPrice" : { }
} ],
"commission" : {
"alacarteofferitem" : { },
"amount" : { },
"code" : "string",
"commissionCode" : "string",
"interlineSettlementInfo" : { },
"offer" : { },
"offerItem" : { },
"order" : { },
"orderItem" : { },
"percentageAppliedToAmount" : { },
"percentagePercent" : "number",
"priceQuote" : { },
"remarkText" : "string",
"taxableInd" : "boolean",
"ticketDocInfo" : { }
},
"disclosure" : [ {
"baggageDisclosure" : { },
"disclosureIdentifier" : "string",
"offer" : { },
"orderItem" : { }
} ],
"expirationTimeLimitDateTime" : "string",
"inventoryGuarantee" : {
"inventoryGuaranteeIdentifier" : "string",
"noGuaranteeInd" : "boolean",
"offer" : { },
"order" : { },
"shoppingResponse" : { },
"timeLimitDateTime" : "string",
"waitListInd" : "boolean"
},
"marketingCarrier" : {
"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" : { }
},
"matchAppText" : "string",
"matchPercent" : "number",
"matchTypeCode" : {
"matchTypeCodeEnum" : { }
},
"offerIdentifier" : "string",
"offerItem" : [ {
"cancelRestrictions" : [ { } ],
"changeRestrictions" : [ { } ],
"commission" : [ { } ],
"mandatoryInd" : "boolean",
"modificationProhibitedInd" : "boolean",
"offer" : { },
"offerItemIdentifier" : "string",
"orderAmendment" : { },
"orderItem" : { },
"paymentTimeLimit" : { },
"price" : { },
"priceGuaranteeTimeLimitDateTime" : "string",
"relatedToExistingOrderItem" : [ { } ],
"service" : [ { } ],
"typeCode" : "string"
} ],
"order" : {
"bilateralTimeLimit" : [ { } ],
"bookingRef" : [ { } ],
"carrier" : { },
"commission" : [ { } ],
"creationDateTime" : "string",
"depositTimeLimitDateTime" : "string",
"existingOrderCriteria" : { },
"inventoryGuarantee" : { },
"lastModifiedDateTime" : "string",
"namingTimeLimitDateTime" : "string",
"offer" : [ { } ],
"order" : [ { } ],
"orderIdentifier" : "string",
"orderItem" : [ { } ],
"ownerTypeCode" : { },
"paxGroup" : { },
"paymentInfo" : [ { } ],
"paymentTimeLimitDateTime" : "string",
"statusCode" : { },
"ticketDocInfo" : { },
"totalPrice" : { },
"versionNumber" : "integer",
"webAddressUri" : "string"
},
"ownerTypeCode" : {
"ownerTypeCodeEnum" : { }
},
"paymentTimeLimitDateTime" : "string",
"penalty" : [ {
"amount" : { },
"appCode" : { },
"cancelFeeInd" : "boolean",
"changeFeeInd" : "boolean",
"descText" : "string",
"fareDetail" : [ { } ],
"fareRule" : { },
"netInd" : "boolean",
"offer" : { },
"orderItem" : { },
"penaltyIdentifier" : "string",
"percent" : "number",
"ticketDocInfo" : { },
"typeCode" : { },
"upgradeFeeInd" : "boolean"
} ],
"ptcOfferParameters" : [ {
"offer" : { },
"pricedPaxNumber" : "number",
"ptcPricedCode" : "string",
"ptcRequestedCode" : "string",
"requestedPaxNumber" : "number"
} ],
"redemptionInd" : "boolean",
"requestedDateInd" : "boolean",
"totalPrice" : {
"alacarteofferitem" : { },
"baseAmount" : { },
"baseAmountGuaranteeTimeLimitDateTime" : "string",
"curConversion" : [ { } ],
"discount" : { },
"equivAmount" : { },
"fareComponent" : { },
"fareDetail" : { },
"farePriceType" : { },
"fee" : [ { } ],
"loyaltyUnitAmount" : { },
"loyaltyUnitName" : "string",
"markup" : [ { } ],
"maskedInd" : "boolean",
"offer" : { },
"offerItem" : { },
"order" : { },
"orderItem" : { },
"service" : { },
"surcharge" : [ { } ],
"taxSummary" : [ { } ],
"totalAmount" : { }
},
"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" : { }
},
"webAddressUrlUri" : "string"
}