OrderCreate Request Field Descriptions
/PayloadAttributes/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <VersionNumber> | The version of the protocol being used. This should be 21.3. | Decimal | Required |
/DistributionChain/DistributionChainLink/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <Ordinal> | The number defining the position of the distribution chain link in the distribution chain indicating the order in which the organization participated. | Integer | Required |
| <OrgRole> | The distribution chain role performed by the participating organization. That is, the Seller (end buyer facing), the Distributor (an intermediary), or the Carrier (the Responsible Supplier). For clarity this is different to the business model used by the participating organization, and the Nature of Business typically registered during incorporation as one of the organization's business activities. |
Enumeration:
Aggregator B2C:
OTA Direct Connect:
|
Required |
/DistributionChain/DistributionChainLink/ParticipatingOrg/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <Name> | Name of the organization. | Token | Required |
| <OrgID> | Organization code of identifier. | Token: IATA number | Required |
/Request/PaymentFunctions/PaymentProcessingDetails/PaymentMethod/PaymentCard/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <CardNumber> | The card number indicated on the payment card. | String | Required |
| <CardHolderName> | Name of credit card holder. Example: John Smith. | Token | Required |
| <ExpirationDate> | The Last month of validity. | String | Required |
| <CardSecurityCode> | 3-digit number printed on the signature panel on the back of the card and following the last four digits of the Primary Account Number (PAN). For American Express, 4 digits located on the front of the card, above the card number on the right hand side. Visa - CVV2, MasterCard - CVC2, American Express - CID, Discover - CMID, Union Pay - CVN2, JCB - CAV2. | Token | Required. If VCC, optional, but highly recommended |
/Request/PaymentFunctions/PaymentProcessingDetails/PaymentMethod/PaymentCard/CardHolderAddress/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <StreetText> | Street name and number. Examples: Main street. | String. The maximum character is 100 | Required |
| <CityName> | The name, expressed as text, of the city, town or village. | String. The maximum character is 50, but it will be trimmed to the first 10 characters | Required |
| <CountrySubDivisionName> | The name, expressed as text, of the sub-division of a country. | String. The maximum character is 50, but it will be trimmed to the first 13 characters | Required |
| <PostalCode> | Postal code examples: 11001. For an international address, if the address has a postal code, please use the related postal code. If no postal code, please enter 11111 | String. The maximum character is 12, but it will be trimmed to the first 10 characters | Required |
| <CountryCode> | ISO Country Code (can be extended by bilateral agreement in case of exceptions). | String. The maximum character is 60, but it will be trimmed to the first 10 characters | Required |
| <BuildingRoomText> | Additional address information including building name, room, apartment, or suite number. | Token | Optional |
/Request/PaymentFunctions/PaymentProcessingDetails/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <PaymentRefID> | If creating the order after payment authorization it is a way of linking an order to an existing payment reference. not triggering the whole process again. | Token | Optional |
| <Amount> | The amount applied to the associated payment method. Example: 300 USD. | Decimal | Required |
/Request/PaymentFunctions/PaymentProcessingDetails/Payer/PayerName/IndividualName/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <GivenName> | A personal name given to the individual at birth and used before a family name. Also called first name. E.g. JOHN. | Token. The maximum character limitation is 30 | Required |
| <Surname> | Individual's hereditary name(s) common to all members of a family. Also known as family name or last name. E.g. SMITH. Excludes any potential suffix. | Token. The maximum character limitation is 30 | Required |
/Request/PaymentFunctions/PaymentProcessingDetails/Payer/PayerPhoneNumber/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <CountryDialingCode> | Numeric telephone dialng prefixes for the member of the international telecommunication Union. | String. Maximum length is 4 characters, but it will be trimmed to the first 1 to 3 digits after removing spaces and special characters | Required |
| <AreaCodeNumber> | Phone number area code Example: 813. | String. Maximum length is 5 characters, but it will be trimmed to the first 3 digits after removing spaces and special characters | Required |
| <PhoneNumber> | Phone Number text. | String. Maximum length is 10 characters, but it will be trimmed to the first 7 digits after removing spaces and special characters | Required |
| <ExtensionNumber> | Phone extension number. | String | Optional (leave null in the value) |
| <ContactTypeText> | PADIS code list: Contact Type (to identify the technical contact type information). | String | Optional (leave null in the value) |
/Request/DataList/PaxList/Pax/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <PaxID> | Uniquely identifies a Passenger within the context of one message. | String | Required |
| <PassengerTypeCode(PTC)> | Type code applying to the Passenger which typically drives pricing (e.g. ADT, CHD, etc). | String | Required |
/Request/DataLists/PaxList/Pax/LoyaltyProgramAccount/LoyaltyProgram/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <AccountNumber> | Loyalty Program account number. Example: ABC123456. | Token. AS NDC validates loyalty number in both QA and PROD environment by matching passenger’s name. |
Optional |
/Request/DataLists/PaxList/Pax/LoyaltyProgramAccount/LoyaltyProgram/Carrier/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <AirlineDesigCode> | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. | Token | Optional |
/Request/DataLists/PaxList/Pax/IdentityDoc/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <IdentityDocID> | Uniquely identifies the document from all other identity documents issued by the state or organization. e.g. passport number, driver’s license number, known traveler number. | Token | Optional |
| <IdentityDocTypeCode> | The type of passenger document. Examples: PT = Passport, CR = KTN. | Token | Optional |
| <Surname> | An individual’s hereditary name common to all members of a family. Also known as family name or last name. | Token. The maximum character limitation is 30 | Optional |
/Request/DataLists/PaxList/Pax/RedressCase/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <RedressCaseID> | A unique government-issued identifier assigned to a redress case. | Token | Optional |
| <IdentityDocTypeCode> | The type of passenger document. Examples: PT = Passport, CR = KTN. | Token | Optional |
| <Surname> | An individual’s hereditary name common to all members of a family. Also known as family name or last name. | Token. Maximum character limitation is 29. Total maximum character limitation of Given Name + Last Name + Middle Name is 61 characters | Optional |
/Request/DataList/PaxList/Pax/Individual/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <Birthdate> | The date on which an individual was born. | Date | Required |
| <GenderCode> | Gender of the individual. “M, F, U and X” currently supported. | Token | Required |
| <GivenName> | A personal name given to the individual at birth and used before a family name. Enter the first name as it appears on legal identification. It must consist of a minimum of one alphabetic character. Hyphens, spaces, and apostrophes are allowed between letters. Periods are not allowed. | Token. The maximum character limitation is 30 | Required |
| <MiddleName> | Individuals middle name or initial. Enter middle name or initial as it appears on legal documents and identification. A minimum of one alphabetic character is required for this field. Hyphens, spaces, and apostrophes are allowed between letters. Periods are not allowed. | Token. The maximum character limitation is 30 | Optional (Leave null in the value) |
| <SuffixName> | Individual’s name suffixes and letters. | Token | Optional |
| <Surname> | Individuals hereditary name(s) common to all members of a family. Also known as family name or last name. Enter the last name as it appears on legal identification. It must consist of a minimum of one alphabetic character. (please note: our system cannot accept the letter "B" or "C" as single characters). Hyphens, spaces, and apostrophes are allowed between letters. Periods are not allowed. | Token. The maximum character limitation is 30 | Required |
| <TitleName> | A word such as Mr., Mrs., Miss or Dr that is used before an individuals name to indicate the gender, profession or marital status. | Token | Optional |
/Request/DataList/ContactInfoList/ContactInfo/
NOTE: It is an agent’s obligation to meet relevant IATA resolution. If agents provide the customer’s email/phone number, customer will receive the same communications with direct booking from Alaska Airlines. If agency's contact information is provided, agency will be responsible to notify/service passenger.
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <ContactPurposeText> | To identify the contact purpose. | String | Required |
| <ContactInfoID> | Uniquely Identifies a set of Contact Information, within the context of one message. | Token | Required |
/Request/DataList/ContactInfoList/ContactInfo/EmailAddress/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <ContactTypeText> | PADIS code list: Contact type. | String | Required |
| <EmailAddressText> | The email address which should be used for contact purposes. | String. The maximum character limitation is 50, and the minimum is 7 | Required |
/Request/DataList/ContactInfoList/ContactInfo/Individual/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <GivenName> | A personal name given to the individual at birth and used before a family name. Also called first name. E.g. JOHN. | Token. The maximum character limitation is 30 | Required |
| <Surname> | Individual's hereditary name(s) common to all members of a family. Also known as family name or last name. E.g. SMITH. Excludes any potential suffix. | Token. The maximum character limitation is 30 | Required |
/Request/DataList/ContactInfoList/ContactInfo/Phone/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <AreaCodeNumber> | Phone number area code. | String. Maximum length is 5 characters, but it will be trimmed to the first 3 digits after removing spaces and special characters | Required |
| <ContactTypeText> | PADIS code list: Contact type. | String | Optional (leave null in the value) |
| <CountryDialingCode> | Numeric telephone dialing prefixes for the member countries of the International Telecommunication Union. | String. Maximum length is 4 characters, but it will be trimmed to the first 1 to 3 digits after removing spaces and special characters | Required |
| <ExtensionNumber> | Phone Extension Number. | String | Optional (leave null in the value) |
| <PhoneNumber> | Phone number text. Examples: +1 999-999-9999 ext 1234, 617-9976 Note: This may be a simple, un-structured phone number, such as +01 999-999-9999 ext 1234 or combined with additional attributes country dialing code, area code and extension to create a structured phone number. | String. Maximum length is 10 characters, but it will be trimmed to the first 7 digits after removing spaces and special characters | Required |
/Request/CreateOrder/AcceptanceSelectedQuotedOfferList/SelectedPricedOffer/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <OfferRefID> | Reference to the OfferID of the selected Offer (either a standard Offer or an a-la-carte Offer) returned in a previous shopping response | Token | Optional (leave null in the value) |
| <OwnerCode> | Designator of Airline that owns/ assigned these IDs. Examples: AS | Token | Optional (leave null in the value) |
/Request/CreateOrder/AcceptanceSelectedQuotedOfferList/SelectedPricedOffer/SelectedOfferItem/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <OfferItemRefID> | Reference to the OfferItemID of the selected OfferItem (contained in either a standard Offer or an a-la-carte Offer) returned in a previous shopping response. Use the OfferItemID from: /IATA_OfferPriceRS/Response/PricedOffer/OfferItem/OfferItemID/ | Token | Required |
| <PaxRefID> | Reference to passenger(s) for which this OfferItem and selected Services (in case of Service Bundles) applies. | Token | Required |
/Request/CreateOrder/AcceptSelectedQuotedOfferList/SelectedPricedOffer/SelectedOfferItem/SelectedSeat/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <ColumnID> | Seat column to identify a particular seat position on an aircraft. | Token | Required |
| <SeatRowNumber> | Seat Row number. Example: 2. | Decimal | Required |
| <Qty> | Quantity to allow the ordering of more than one instances of the related a la carte OfferItem. | Decimal | Required. Keep as 0 for now |
| <PaxSegmentRefID> | Reference to a PaxSegmentID. Use the paxSegmentRefID from OfferPriceRS, not SeatAvailabilityRS. | Token | Required |
OrderView Response Field Descriptions
/Response/DataLists/BaggageAllowanceList/BaggageAllowance/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <BaggageAllowanceID> | Unique identifier of this baggage allowance. | Token | Required |
| <DescText> | Baggage allowance description and additional information. | String | Optional |
| <TypeCode> | Type of baggage allowance e.g. Checked or CarryOn. | Token | Required |
/Response/DataLists/ContactInfoList/ContactInfo/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <ContactInfoID> | Uniquely identifies a set of contact information, within the context of one message. | Token | Required |
| <EmailAddressText> | The email address which should be used for contact purposes. | String | Required |
| <GivenName> | A personal name given to the individual at birth and used before a family name. | Token | Optional |
| <IndividualID> | Uniquely Identifies an individual within the context of one message. | Token | Optional |
| <Surname> | Individual’s hereditary name common to all members of a family. Also known as family name or last name. | Token | Required |
| <CountryDialingCode> | Numeric telephone dialing prefixes for the member countries of the international telecommunication union. | Token | Optional |
| <ExtensionNumber> | Phone extension number. | String | Optional |
| <PhoneNumber> | Phone number text. | String | Optional |
/Response/DataLists/DatedMarketingSegmentList/DatedMarketingSegment/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <DatedMarketingSegmentId> | Unique identifier of a dated marketing segment used in a message. | Token | Required |
| <MarketingCarrierFlightNumberText> | The numerical designation of a flightas it is marked by a carrier. | String | Required |
| <DatedOperatingSegmentRefId> | Reference to a unique identifier of a dated operating segment used in a message. | Token | Required |
| <CarrierDesigCode> | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. | Token | Required |
| <AircraftScheduledDateTime> | The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport. | DateTime | Required |
| <IATA_LocationCode> | IATA 3-letter code defining the city or airport code. | Token | Required |
/Response/DataLists/DatedOperatingLegList/DatedOperatingLeg/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <DatedOperatingLegID> | Uniquely identifies a leg within the context of one message. | Token | Required |
| <IATA_LocationCode> | IATA 3-letter code defining the city or airport code. | Token | Required |
| <AircraftScheduledDateTime> | The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport. | DateTime | Required |
/Response/DataLists/DatedOperatingLegList/DatedOperatingLeg/CarrierAircraftType/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <CarrierAircraftTypeCode> | Internal code used by a carrier to identify the type of aircraft. | Token | Required |
| <CarrierAircraftTypeName> | Internal name given by the carrier to this aircraft type. | String | Required |
/Response/DataLists/DatedOperatingLegList/DatedOperatingLeg/AirlineTaxonomy/TaxonomyFeature/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <CodesetNameCode> | Defines the codeset that is being used in each entry to define the codeset code and the associated value text. | Token | Optional |
| <ValueText> | The textural description associated to the codeset code for a given defined codeset. | String | Optional |
/Response/DataLists/DatedOperatingSegmentList/DatedOperatingSegment/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <DatedOperatingSegmentId> | Unique identifier of a dated operating segment used in a message. | Token | Required |
| <DatedOperatingLegRefID> | Identifies one or more flight legs within this segment. | Token | Required |
| <Duration> | Total segment time including the combined air time and connection times of any legs. | Duration | Required |
| <OperatingCarrierFlightNumberText> | The numerical designation of a flight as it is operated by a carrier. | String | Required |
| <CarrierDesigCode> | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. | Token | Required |
| <DisclosureRefID> | Uniquely identifies a disclosure within the context of one message. | Token | Optional |
/Response/DataLists/DisclosureList/Disclosure/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <DescText> | Description text value. | String | Required |
| <DiscosureID> | Uniquely Identifies a disclosure within the context of one message. | Token | Required |
/Response/DataLists/OriginDestList/OriginDest/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <DestCode> | IATA defined code identifying a city or station. | Token | Required |
| <OriginCode> | IATA defined code identifying a city or station. | Token | Required |
| <OriginDestID> | Uniquely identifies an origin destination within the context of one message. | Token | Required |
| <PaxJourneyRefID> | Uniquely identifies a passenger journey within the context of one message. | Token | Optional |
/Response/DataLists/PaxJourneyList/PaxJourney/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <PaxJourneyID> | Uniquely identifies a Passenger Journey within the context of one message. | Token | Required |
| <PaxSegmentRefID> | Reference to a Passenger Segment ID within this message. | Token | Required |
| <Duration> | Total journey time including the combined air time and connection times. In case of stopover, this may or may not include stopover durations. | Duration | Optional |
/Response/DataLists/PaxList/Pax/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <ContactInfoRefID> | Uniquely identifies a set of contact information, within the context of one message. | Token | Optional |
| <PaxID> | Uniquely identifies a passenger within the context of one message. | Token | Required |
| <PTC> | Type code applying to the passenger which typically drives pricing. | String | Optional |
| <GivenName> | A personal name given to the individual at birth and used before a family name. Also called first name. | Token | Optional |
| <Surname> | Individuals hereditary name(s) common to all members of a family. Also known as family name or last name. | Token | Required |
| <IndivdualID> | Uniquely Identifies an Individual within the context of one message. | Token | Optional |
| <GenderCode> | Gender of the individual. Refer to PADIS Codeset 6353. | Token | Optional |
| <Birthdate> | Holder's date of birth as written on the document. | Date | Optional |
| <RemarkText> | Additional, supplementary information about the document or service. | String | Optional |
| <RedressCaseID> | A unique government-issued identifier assigned to a redress case. | Token | Optional |
/Response/DataLists/PaxList/Pax/IdentityDoc/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <IdentityDocID> | Uniquely identifies the document from all other identity documents issued by the state or organization. e.g. passport number, driver’s license number, known traveler number. | Token | Required |
| <IdentityDocTypeCode> | The type of passenger document. Examples: PT = Passport, CR = KTN. | Token | Required |
| <Surname> | An individual’s hereditary name common to all members of a family. Also known as family name or last name. | Token | Required |
| <Birthdate> | Holder's date of birth as written on the document. | Date | Optional |
| <CitizenshipCountryCode> | ISO Country Code (can be extended by bilateral agreement in case of exceptions, e.g. Kosovo). Examples: US, FR. | Token | Optional |
| <ExpiryDate> | The date the identity document expires. | Date | Optional |
| <GenderCode> | Gender of the individual. Refer to PADIS Codeset 6353. | Token | Optional |
| <GivenName> | Holder's first or given name, as written on the document. E.g. JOHN. | Token | Optional |
| <IssuingCountryCode> | ISO Country Code (can be extended by bilateral agreement in case of exceptions, e.g. Kosovo). Examples: US, FR. | Token | Optional |
/Response/DataLists/PaxList/Pax/LoyaltyProgramAccount/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <AccountNumber> | Loyalty program account number. | Token | Optional |
| <AirlineDesigCode> | Airline code assigned to a carrier. | Token | Required |
| <TierName> | Loyalty Program status level name. | String | Optional |
/Response/DataLists/PaxSegmentList/PaxSegment/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <DatedMarketingSegmentRefId> | A reference to a unique identifier of a dated marketing segment used in a message. | Token | Required |
| <PaxSegmentID> | Uniquely identifies a passenger segment within the context of one message. | Token | Required |
| <MarketingCarrierRBD_Code> | Code used to identify a particular RBD (e.g. P, J, W, M, etc.). | Token | Required |
/Response/DataLists/PaxSegmentList/PaxSegment/CabinTypeAssociationChoice/SegmentCabinType/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <CabinTypeCode> |
Cabin Type Code as defined by ATSB codeset 9873. For AS NDC:
|
Token | Optional |
| <CabinTypeName> | Name given to a cabin compartment (e.g. Business, First, Economy). | Token | Optional |
/Response/Order/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <OrderID> | Carrier assigned ID which uniquely identifies a specific Order across several messages. | Token | Required |
| <OwnerCode> | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. | Token | Required |
| <CreationDateTime> | The date time by which the order is created. Examples: 2018-09-05T15:52:01Z. | DateTime | Optional |
| <StatusCode> | Status of the Order Status instance. See ATSB Codeset OrderStatus for possible values. | Token | Optional |
/Response/Order/OrderItem/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <OrderItemID> | Carrier assigned ID which exists uniquely within an order. | Token | Required |
| <OwnerCode> | Airline code assigned to a carrier. Either ICAO- defined 3-character code or IATA-defined 2-character code. | Token | Required |
| <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. | DateTime | Optional |
| <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. | DateTime | Optional |
/Response/Order/OrderItem/CancelRestrictions/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <DescText> | Describes what this restriction is. E.G -Cancellation allowed within dates(1) specified with no fee. -Cancellation allowed within dates(2) specified with fee. -Cancellation not allowed. | String | Optional |
/Response/Order/OrderItem/ChangeRestrictions/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <DescText> | Describes what this restriction is. E.G -Cancellation allowed within dates(1) specified with no fee. -Cancellation allowed within dates(2) specified with fee. -Cancellation not allowed. | String | Optional |
| <PaymentTypeCode> | This stores a code to represent the form of payment to be used to reimburse the customer/passenger. | Token | Required |
| <MaximumAmount> | Stores a maximum refund amount which will be applied when a variable fee amount is effective. | Decimal | Required |
| <LevelTypeCode> | This will identify the type of re-fundability for the condition. This will be one of the following. Fully Refundable Partly Refundable Non-Refundable. | Token | Required |
/Response/Order/OrderItem/FareDetail/FareComponent/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <FareBasisCode> | Fare basis code. | Token | Optional |
| <CabinTypeCode> |
Cabin Type Code as defined by ATSB codeset 9873. For AS NDC:
|
Token | Optional |
| <CabinTypeName> | Name given to a cabin compartment. | Token | Optional |
/Response/Order/OrderItem/FareDetail/FareWaiver/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <FareRuleWaiverCode> | Code assigned by the validating carrier that allows fare rule modification or override. | Token | Optional |
| <FareWaiverTypeCode> | Waiver type code. | Token | Optional |
/Response/Order/OrderItem/FareDetail/FareComponent/FareRule/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <RuleCode> | Fare category number as defined by ATPCO. | Token | Optional |
/Response/Order/OrderItem/FareDetail/Price/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <BaseAmount> @CurCode | Total base fare amount. | Decimal | Optional |
| <TotalAmount> @CurCode | Total monetary price amount, including all tax, surcharge, and fee amounts. | Decimal | Optional |
/Response/Order/OrderItem/FareDetail/Price/TaxSummary/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <Add1TaxCode> | A qualifier to the tax code to distinguish taxes/fees/charges with the same tax code but with different business uses. | Token | Optional |
| <Amount> | Tax amount. | Decimal | Required |
| <DescText> | Tax short description. | String | Optional |
| <TaxCode> | IATA TTBS tax code. | Token | Optional |
| <TotalTaxAmount> | Total of all applicable tax amounts included in the price. If tax breakdowns are provided, this amount should match the sum of the tax breakdown amounts. | Decimal | Optional |
/Response/Order/OrderItem/Price/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <BaseAmount (@CurCode)> | Total base fare amount. | Decimal | Optional |
| <TotalAmount (@CurCode)> | Total monetary price amount, including all tax, surcharge, and fee amounts. | Decimal | Optional |
/Response/Order/OrderItem/Price/TaxSummary/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <Add1TaxCode> | A qualifier to the tax code to distinguish taxes/fees/charges with the same tax code but with different business uses. | Token | Optional |
| <Amount> | Tax amount. | Decimal | Required |
| <DescText> | Tax short description. | String | Optional |
| <TaxCode> | IATA TTBS tax code. | Token | Optional |
| <TotalTaxAmount> | Total of all applicable tax amounts included in the price. If tax breakdowns are provided, this amount should match the sum of the tax breakdown amounts. | Decimal | Optional |
/Response/Order/OrderItem/Service/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <PaxRefID> | Reference to a Passenger ID within this message. | Token | Required |
| <ServiceID> | Uniquely Identifies a Service within the context of one message. | Token | Required |
| <DeliveryStatusCode> | Status of the Service Delivery Service Status instance. See ATSB Codeset DeliveryService for possible values:
|
Token | Required |
| <StatusCode> | Status of the Order Service Status instance. See ATSB Codeset OrderService for possible values:
|
Token | Optional |
/Response/Order/OrderItem/Service/BookingRef/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <BookingID> | Existing booking reference identifier. | Token | Required |
/Response/Order/OrderItem/Service/BookingRef/BookingEntity/Carrier/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <AirlineDesigCode> | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. | Token | Required |
/Response/Order/OrderItem/Service/OrderServiceAssociation/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <PaxSegmentRefID> | Reference to a PaxSegmentID. | Token | Required |
| <RowNumber> | Ordinal number identifying a seat row in an aircraft. | Integer | Required |
| <ColumnID> | Alphabetic character identifying a seat within a row. | Token Pattern [A-Z] | Required |
/Response/Order/TotalPrice/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <BaseAmount (@CurCode)> | Total base fare amount. | Decimal | Optional |
| <TotalAmount (@CurCode)> | Total monetary price amount, including all tax, surcharge, and fee amounts. | Decimal | Optional |
/Response/TicketDocInfo/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <PaxRefID> | Reference to a Passenger ID. | Token | Required |
| <ReportingTypeCode> | For billing and settlement purposes, each time a travel agent requests an airline to perform an action on a document (Issuance, Refund, Exchange), he needs to know how to reconcile this action (via BSP, ARC, directly by ORA, etc.). | Token | Required |
| <TicketDocTypeCode> | Document type code as defined by PADIS 1001 (Document/ Message Name, coded). | Token | Required |
| <TicketNumber> | The document number comprised of the airline code, form code, and serial number. | String | Required |
/Response/TicketDocInfo/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <PaxRefID> | Reference to a Passenger ID. | Token | Required |
| <TicketNumber> | The document number comprised of the airline code, form code, and serial number. | String | Required |
| <PaymentRefID> | References a payment transaction within this message. | Token | Required |
| <CouponStatusCode> | Current status of the flight/ value coupon. Example: E (Exchanged/Reissued):
|
Token | Optional |
| <ReportingTypeCode> | For billing and settlement purposes, each time a travel agent requests an airline to perform an action on a document (Issuance, Refund, Exchange), he needs to know how to reconcile this action (via BSP, ARC, directly by ORA, etc.):
|
Token | Required |
| <TicketDocTypeCode> | Document type code as defined by PADIS 1001 (Document/ Message Name, coded):
|
Token | Required |
/Response/TicketDocInfo/OriginalIssueInfo/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <IssueDate> | The date that the document was originally issued. | Date | Optional |
| <IssueTime> | The time that the document was originally issued. | Time | Optional |
| <AirlineDesigCode> | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. | Token | Optional |
| <TicketNumber> | The document number comprised of the airline code, form code, and serial number. | String | Optional |
/Response/TicketDocInfo/Ticket/Coupon/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <CouponNumber> | Number assigned to the issued coupon. | Decimal | Optional |
| <FareBasisCode> | Fare basis code as ticketed. Example: Y26. | Token | Optional |
/PayloadAttributes/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <CorrelationID> | Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message. | Token | Required |
| <VersionNumber> | For all IATA versioned messages, the version of the message is indicated by a decimal value. | Decimal | Required |
/PaymentFunctions/OrderAssociation/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <OrderItemRefID> | Reference to an Order Item ID for which this payment method applies. | Token | Optional |
/PaymentFunctions/OrderAssociation/PaymentProcessingSummary/
| Field | Description | Type | Required /Optional |
|---|---|---|---|
| <Amount> @CurCode | The amount applied to the associated payment method. Example: 300 USD. | Decimal | Required |
| <PaymentID> | Uniquely identifies payment information within a message. | Token | Required |
| <PaymentTypeCode> | This stores a code to represent the form of payment to be used to reimburse the customer/passenger. | Token | Optional |
| <PaymentStatusCode> | Indicates the current status of this payment information. | Token | Optional |
| <TimestampDateTime> | 3DS transaction timestamp. | DateTime | Optional |