OfferItem
A priced grouping of one or more services within an Offer.
Properties
Name |
Description |
Type |
Required |
Generic |
Enum |
Ignore |
cancelRestrictions |
An offer item can have 0 to many Cancel Restrictions. |
array |
false |
CancelRestrictions |
--- |
false |
changeRestrictions |
An offer item can have 0 to many Change Restrictions. |
array |
false |
ChangeRestrictions |
--- |
false |
commission |
Offer items may have associated Commission |
array |
false |
Commission |
--- |
false |
mandatoryInd |
If set to 'true', indicates mandatory Offer Items which cannot be removed from the Offer. |
boolean |
false |
|
|
false |
modificationProhibitedInd |
POA to ORA only: to indicate that the offer is non-modifiable. This indicates to ORA that its offer is non-modifiable (e.g. Regulatory or brand protection reasons). If indicator is set to TRUE, modifications to the POA's offer ARE NOT allowed. |
boolean |
false |
|
|
false |
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. |
Offer |
true |
|
|
false |
offerItemIdentifier |
Carrier assigned ID which exists uniquely within an Offer. |
string |
false |
|
|
false |
orderAmendment |
An Order amendment information and action type. |
OrderAmendment |
true |
|
|
false |
orderItem |
An individually priced item within an Order, made up of one or more Services. May or may not be a selected Offer Item (e.g. non-chargeable Services available on request such as a wheelchair). |
OrderItem |
false |
|
|
false |
paymentTimeLimit |
A time limit used to indicate by when payment commitment must be received for confirmed Order Item in an Order. To indicate instant payment, the duration field should be populated with a value of 0. If no value is returned, then no advice has been given. |
PaymentTimeLimit |
false |
|
|
false |
price |
An amount of money expected, required, or given in payment for something. |
Price |
true |
|
|
false |
priceGuaranteeTimeLimitDateTime |
The length of time the price of an offer item is guaranteed. In the absence of the price guarantee time limit, the price is not guaranteed. Upon expiry, the price may no longer be guaranteed and either a new shopping process should begin, or the offer should be repriced resulting in a new Offer. Should the price guarantee time limit extend beyond Order creation (or change), the remaining length of time persists into the corresponding Order Item. At Order creation (or change) the airline can increase the remaining length of time beyond the original time limit should they wish to. Note: Where a price guarantee time limit is applied, there is no guarantee that related inventory is guaranteed by the airline. |
string |
false |
|
|
false |
relatedToExistingOrderItem |
An individually priced item within an Order, made up of one or more Services. May or may not be a selected Offer Item (e.g. non-chargeable Services available on request such as a wheelchair). |
array |
false |
OrderItem |
--- |
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 |
true |
Service |
--- |
false |
typeCode |
Specify the type of Offer Item being presented to the Customer. Using new PADIS codeset -initial content -RET - Retail -WHO - Wholesale -COR - Corporate |
string |
false |
|
|
false |
{
"cancelRestrictions" : [ {
"alacarteofferitem" : { },
"allowedModificationInd" : "boolean",
"descText" : "string",
"effectiveDateTime" : "string",
"expirationDateTime" : "string",
"fee" : { },
"journeyStageCode" : { },
"offerItem" : { },
"orderItem" : { },
"paxRefIdentifier" : "string",
"refund" : { }
} ],
"changeRestrictions" : [ {
"alacarteofferitem" : { },
"allowedModificationInd" : "boolean",
"changeTypeCode" : { },
"descText" : "string",
"effectiveDateTime" : "string",
"expirationDateTime" : "string",
"fee" : { },
"journeyStageCode" : { },
"offerItem" : { },
"orderItem" : { },
"paxRefIdentifier" : "string",
"refund" : { }
} ],
"commission" : [ {
"alacarteofferitem" : { },
"amount" : { },
"code" : "string",
"commissionCode" : "string",
"interlineSettlementInfo" : { },
"offer" : { },
"offerItem" : { },
"order" : { },
"orderItem" : { },
"percentageAppliedToAmount" : { },
"percentagePercent" : "number",
"priceQuote" : { },
"remarkText" : "string",
"taxableInd" : "boolean",
"ticketDocInfo" : { }
} ],
"mandatoryInd" : "boolean",
"modificationProhibitedInd" : "boolean",
"offer" : {
"alacarteofferitem" : [ { } ],
"commission" : { },
"disclosure" : [ { } ],
"expirationTimeLimitDateTime" : "string",
"inventoryGuarantee" : { },
"marketingCarrier" : { },
"matchAppText" : "string",
"matchPercent" : "number",
"matchTypeCode" : { },
"offerIdentifier" : "string",
"offerItem" : [ { } ],
"order" : { },
"ownerTypeCode" : { },
"paymentTimeLimitDateTime" : "string",
"penalty" : [ { } ],
"ptcOfferParameters" : [ { } ],
"redemptionInd" : "boolean",
"requestedDateInd" : "boolean",
"totalPrice" : { },
"validatingCarrier" : { },
"webAddressUrlUri" : "string"
},
"offerItemIdentifier" : "string",
"orderAmendment" : {
"actionTypeCode" : { },
"offerItem" : { },
"remark" : { },
"ticketDocInfo" : { }
},
"orderItem" : {
"alacarteofferitem" : { },
"bilateralTimeLimit" : [ { } ],
"cancelRestrictions" : [ { } ],
"changeGroupIdentifier" : "string",
"changeRestrictions" : [ { } ],
"changeTypeText" : "string",
"commission" : [ { } ],
"creationDateTime" : "string",
"depositTimeLimitDateTime" : "string",
"disclosure" : [ { } ],
"fareDetail" : [ { } ],
"grandTotalAmount" : { },
"inventoryGuaranteeIdentifier" : "string",
"inventoryGuaranteeTimeLimitDateTime" : "string",
"marketingCarrier" : { },
"namingTimeLimitDateTime" : "string",
"offerItem" : { },
"order" : { },
"orderItemIdentifier" : "string",
"ownerTypeCode" : { },
"paxGroup" : { },
"paymentInfo" : [ { } ],
"paymentTimeLimitDateTime" : "string",
"penalty" : [ { } ],
"price" : { },
"priceGuaranteeTimeLimitDateTime" : "string",
"reusableInd" : "boolean",
"service" : [ { } ],
"statusCode" : { },
"ticketingTimeLimitDateTime" : "string",
"typeCode" : "string",
"webAddressUri" : "string"
},
"paymentTimeLimit" : {
"alacarteofferitem" : { },
"duration" : "string",
"offerItem" : { }
},
"price" : {
"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" : { }
},
"priceGuaranteeTimeLimitDateTime" : "string",
"relatedToExistingOrderItem" : [ {
"alacarteofferitem" : { },
"bilateralTimeLimit" : [ { } ],
"cancelRestrictions" : [ { } ],
"changeGroupIdentifier" : "string",
"changeRestrictions" : [ { } ],
"changeTypeText" : "string",
"commission" : [ { } ],
"creationDateTime" : "string",
"depositTimeLimitDateTime" : "string",
"disclosure" : [ { } ],
"fareDetail" : [ { } ],
"grandTotalAmount" : { },
"inventoryGuaranteeIdentifier" : "string",
"inventoryGuaranteeTimeLimitDateTime" : "string",
"marketingCarrier" : { },
"namingTimeLimitDateTime" : "string",
"offerItem" : { },
"order" : { },
"orderItemIdentifier" : "string",
"ownerTypeCode" : { },
"paxGroup" : { },
"paymentInfo" : [ { } ],
"paymentTimeLimitDateTime" : "string",
"penalty" : [ { } ],
"price" : { },
"priceGuaranteeTimeLimitDateTime" : "string",
"reusableInd" : "boolean",
"service" : [ { } ],
"statusCode" : { },
"ticketingTimeLimitDateTime" : "string",
"typeCode" : "string",
"webAddressUri" : "string"
} ],
"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"
} ],
"typeCode" : "string"
}