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).
Properties
Name |
Description |
Type |
Required |
Generic |
Enum |
Ignore |
bilateralTimeLimit |
A bilaterally agreed limitation or restriction of time. |
array |
false |
BilateralTimeLimit |
--- |
false |
bookingRef |
A location in a database where to find a booking. |
array |
false |
BookingRef |
--- |
false |
carrier |
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 |
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. |
array |
false |
Commission |
--- |
false |
creationDateTime |
The date time by which the order is created. Examples: 2018-09-05T15:52:01Z |
string |
false |
|
|
false |
depositTimeLimitDateTime |
The date by which a deposit must be paid for an order Examples: 2015-01-13T13:59:38Z |
string |
false |
|
|
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 |
inventoryGuarantee |
An Identification and time limit information for holding inventory in an Offer or Order. |
InventoryGuarantee |
false |
|
|
false |
lastModifiedDateTime |
The date time by which the order is modified. Examples: 2018-09-05T15:52:01Z |
string |
false |
|
|
false |
namingTimeLimitDateTime |
The time by which an Order must be completed with individual passenger names. Examples: 2015-01-13T13:59:38Z |
string |
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. |
array |
true |
Offer |
--- |
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). |
array |
false |
Order |
--- |
false |
orderIdentifier |
Carrier assigned ID which uniquely identifies a specific Order across several messages. |
string |
false |
|
|
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). |
array |
true |
OrderItem |
--- |
false |
ownerTypeCode |
Indicates whether 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 date by which a payment must be made for the confirmed items in the order. Examples: 2015-01-13T13:59:38Z |
string |
false |
|
|
false |
statusCode |
Indicates the current status of an Order E.g. OK (Confirmed) |
OrderStatusCode |
false |
|
|
false |
ticketDocInfo |
An Information corresponding to a group of 1 to 4 Tickets for a single Origin Destination and a single Passenger. |
TicketDocInfo |
true |
|
|
false |
totalPrice |
An amount of money expected, required, or given in payment for something. |
Price |
false |
|
|
false |
versionNumber |
Version of the Order used to track the evolution of an Order and the changes made to it. |
integer |
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 |
{
"bilateralTimeLimit" : [ {
"descText" : "string",
"name" : "string",
"order" : { },
"orderItem" : { },
"serviceDefinition" : { },
"timeLimitDateTime" : "string"
} ],
"bookingRef" : [ {
"bookingCreationDateTime" : "string",
"bookingEntity" : { },
"bookingIdentifier" : "string",
"order" : { },
"org" : { },
"paxGroup" : { },
"service" : { },
"ticketDocInfo" : { },
"typeCode" : "string"
} ],
"carrier" : {
"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" : { }
},
"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",
"existingOrderCriteria" : {
"order" : { },
"pax" : [ { } ],
"shoppingCriteria" : { }
},
"inventoryGuarantee" : {
"inventoryGuaranteeIdentifier" : "string",
"noGuaranteeInd" : "boolean",
"offer" : { },
"order" : { },
"shoppingResponse" : { },
"timeLimitDateTime" : "string",
"waitListInd" : "boolean"
},
"lastModifiedDateTime" : "string",
"namingTimeLimitDateTime" : "string",
"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"
} ],
"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"
} ],
"orderIdentifier" : "string",
"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"
} ],
"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",
"statusCode" : {
"orderStatusCodeEnum" : { }
},
"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" : [ { } ]
},
"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" : { }
},
"versionNumber" : "integer",
"webAddressUri" : "string"
}