Source: https://guides.developer.iata.org/docs/download-the-latest-standards

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).

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. ALaCarteOfferItem false false
bilateralTimeLimit A bilaterally agreed limitation or restriction of time. array false BilateralTimeLimit --- false
cancelRestrictions An order item can have 0 to many Cancel Restrictions. array false CancelRestrictions --- false
changeGroupIdentifier Reference to one Order Item that are going to be replaced, unique within Order string false false
changeRestrictions An order item can have 0 to many Change Restrictions. array false ChangeRestrictions --- false
changeTypeText indicates whether the Order Item is the old or the new Order Item string false false
commission An Order item may have Commission. array false Commission --- false
creationDateTime Order Item creation Timestamp. string false false
depositTimeLimitDateTime The date by which a deposit must be paid for an order item. Examples: 2015-01-13T13:59:38Z string false false
disclosure A set of Information which should be made known. array false Disclosure --- false
fareDetail An amount charged by the carrier for the carriage of a passenger and his allowable free baggage. array false FareDetail --- false
grandTotalAmount Reflects the Differential Total Amount and the Penalty Total Amount, if netted. Amount false false
inventoryGuaranteeIdentifier Unique Inventory Guarantee ID. Examples: INVREF123456, 68E0-675C Note: This is a unique identifier issued by an Airline to reference that inventory for a specified offer will be guaranteed as available for a period. string false false
inventoryGuaranteeTimeLimitDateTime The length of time inventory against a given Service is guaranteed. If inventory is not guaranteed, the Order creation (or change) may fail. In the absence of a time limit, no inventory is guaranteed. Notes: The presence of an inventory guarantee does not assume a guarantee of price. For the price to be guaranteed against a given Offer Item, the Price Guarantee Time Limit must also be present. The assumption is that inventory is held when an Order is created (or changed), so this time limit only applies in the context of an Offer. string 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 false false
namingTimeLimitDateTime The time by which an Order Item must be completed with individual passenger names. Examples: 2015-01-13T13:59:38Z string false false
offerItem A priced grouping of one or more services within an Offer. OfferItem true 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
orderItemIdentifier Carrier assigned ID which exists uniquely within an Order. string false false
ownerTypeCode Indicates whether or not the owner is the ORA or POA. OwnerTypeCode false 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
paymentInfo An information related to the settlement of a transaction through monetary or other compensations. For example, a payment may be applied to an entire Order or individual Order Items. array false PaymentInfo --- false
paymentTimeLimitDateTime The time limit by which a commitment to pay must be made for the given Order Item. Upon expiry it is expected that the Order item is removed from the Order. If no value is returned, then no advice has been given. For example: PaymentTimeLimitDateTime: 2015-01-01T12:53:12Z - indicates the date time by which payment commitment is required. 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
price An amount of money expected, required, or given in payment for something. Price false false
priceGuaranteeTimeLimitDateTime The length of time the price of an Order 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 the Order should be repriced, which may result in a new RepricedOffer, or a new shopping process may begin. string false false
reusableInd If Reusable = true, indicates that part of the value of the OrderItem may be reused for reshopping or refund. Exact reusable amount is unknown until Seller requests to reshop or to process a refund for this OrderItem. boolean 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 true Service --- false
statusCode Indicates the current status of an Order Item. OrderItemStatusCode false false
ticketingTimeLimitDateTime The time by which passengers must secure tickets (or other accountable documents) for confirmed reservation as agreed with the airline. Examples: 2015-01-13T13:59:38Z string false false
typeCode Specify the type of Order Item being presented to the Customer. Using new PADIS codeset -initial content -RET - Retail -WHO - Wholesale -COR - Corporate string false false
webAddressUri 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

Referenced By

Order
PaymentInfo
PaxGroup
BilateralTimeLimit
Commission
Service
Disclosure
ALaCarteOfferItem
Penalty
CancelRestrictions
FareDetail
ChangeRestrictions
Price
Carrier
OfferItem
{
  "alacarteofferitem" : {
    "cancelRestrictions" : [ { } ],
    "changeRestrictions" : [ { } ],
    "commission" : [ { } ],
    "flightService" : { },
    "offer" : { },
    "offerItemIdentifier" : "string",
    "orderItem" : { },
    "pax" : [ { } ],
    "paxJourney" : [ { } ],
    "paxSegment" : [ { } ],
    "paymentTimeLimit" : { },
    "priceClass" : [ { } ],
    "seatOnLeg" : { },
    "unitPrice" : { }
  },
  "bilateralTimeLimit" : [ {
    "descText" : "string",
    "name" : "string",
    "order" : { },
    "orderItem" : { },
    "serviceDefinition" : { },
    "timeLimitDateTime" : "string"
  } ],
  "cancelRestrictions" : [ {
    "alacarteofferitem" : { },
    "allowedModificationInd" : "boolean",
    "descText" : "string",
    "effectiveDateTime" : "string",
    "expirationDateTime" : "string",
    "fee" : { },
    "journeyStageCode" : { },
    "offerItem" : { },
    "orderItem" : { },
    "paxRefIdentifier" : "string",
    "refund" : { }
  } ],
  "changeGroupIdentifier" : "string",
  "changeRestrictions" : [ {
    "alacarteofferitem" : { },
    "allowedModificationInd" : "boolean",
    "changeTypeCode" : { },
    "descText" : "string",
    "effectiveDateTime" : "string",
    "expirationDateTime" : "string",
    "fee" : { },
    "journeyStageCode" : { },
    "offerItem" : { },
    "orderItem" : { },
    "paxRefIdentifier" : "string",
    "refund" : { }
  } ],
  "changeTypeText" : "string",
  "commission" : [ {
    "alacarteofferitem" : { },
    "amount" : { },
    "code" : "string",
    "commissionCode" : "string",
    "interlineSettlementInfo" : { },
    "offer" : { },
    "offerItem" : { },
    "order" : { },
    "orderItem" : { },
    "percentageAppliedToAmount" : { },
    "percentagePercent" : "number",
    "priceQuote" : { },
    "remarkText" : "string",
    "taxableInd" : "boolean",
    "ticketDocInfo" : { }
  } ],
  "creationDateTime" : "string",
  "depositTimeLimitDateTime" : "string",
  "disclosure" : [ {
    "baggageDisclosure" : { },
    "disclosureIdentifier" : "string",
    "offer" : { },
    "orderItem" : { }
  } ],
  "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"
  } ],
  "grandTotalAmount" : {
    "curCode" : "string",
    "value" : "number"
  },
  "inventoryGuaranteeIdentifier" : "string",
  "inventoryGuaranteeTimeLimitDateTime" : "string",
  "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" : { }
  },
  "namingTimeLimitDateTime" : "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"
  },
  "orderItemIdentifier" : "string",
  "ownerTypeCode" : {
    "ownerTypeCodeEnum" : { }
  },
  "paxGroup" : {
    "bookingRef" : [ { } ],
    "contactInfo" : [ { } ],
    "intendedPaxQty" : "number",
    "order" : { },
    "orderItem" : { },
    "pax" : [ { } ],
    "paxGroupIdentifier" : "string",
    "paxGroupName" : "string",
    "responseParameters" : { }
  },
  "paymentInfo" : [ {
    "amount" : { },
    "merchantAccount" : { },
    "order" : { },
    "orderItem" : { },
    "payer" : { },
    "payerContact" : { },
    "paymentInfoIdentifier" : "string",
    "paymentMethod" : { },
    "paymentRefIdentifier" : "string",
    "paymentStatusCode" : { },
    "paymentTrx" : { },
    "priceVarianceAmount" : { },
    "priceVarianceRule" : { },
    "promotion" : [ { } ],
    "surchargeAmount" : { },
    "ticketDocInfo" : { },
    "typeCode" : { },
    "verificationInd" : "boolean"
  } ],
  "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"
  } ],
  "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",
  "reusableInd" : "boolean",
  "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"
  } ],
  "statusCode" : {
    "orderItemStatusCodeEnum" : { }
  },
  "ticketingTimeLimitDateTime" : "string",
  "typeCode" : "string",
  "webAddressUri" : "string"
}