OrderReshop Request Field Descriptions

/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:  Distributor MUST BE 1 Seller MUST BE 2 Aggregator B2C: Aggregator as Distributor AND Seller OTA Direct Connect: OTA as Distributor AND Seller	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/BookingRef/

Field	Description	Type	Required /Optional
<BookingID>	Existing booking reference Identifier.	Token	Required

/Request/ContactInfoList/ContactInfo/

Field	Description	Type	Required /Optional
<ContactInfoID>	Uniquely Identifies a set of Contact Information, within the context of one message.	Token	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	Required

/Request/

Field	Description	Type	Required /Optional
<OrderRefID>	Reference to an existing Order to which the Seller wants to add, update or delete an Order Item.	Token	Required

/Request/UpdateOrder/CancelOrderRef/

Field	Description	Type	Required /Optional
<OrderRefID>	Reference to a specific Order ID.	Token	Required

/Request/UpdateOrder/ReshopOrder/ReshopOrderChoice/ServiceOrder/AddOfferItems/

FlightRequest/FlightRequestOriginDestinationsCriteria/OriginDestCriteria/

Field	Description	Type	Required /Optional
<Date>	The customer's requested departure date.	Date	Required
<IATA_LocationCodeType>	IATA 3-letter code defining the city or airport code.	Token	Required

/Request/UpdateOrder/ReshopOrder/ReshopOrderChoice/ServiceOrder/DeleteOrderItem/

Field	Description	Type	Required /Optional
<OrderItemRefID>	Reference to the Order Item requested for deletion.	Token	Required
<RetainServiceID>	Reference to the Service within the specified Order Item which the Passenger would like the Airline to retain and return within the proposed Offer Item(s) in the OrderReshopRS.	Token	Optional

 

Order Reshop Response Field Descriptions

/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
<Surname>	Individuals hereditary name(s) common to all members of a family. Also known as family name or last name.	Token	Optional
<AreaCodeNumber>	Phone number area code.	String	Optional
<ContactTypeText>	PADIS code list: Contact type.	String	Optional
<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
<IATA_LocationCode>	IATA 3-letter code defining the city or airport code.	Token	Required
<MarketingCarrierFlightNumberText>	The numerical designation of a flight as it is marketed by a carrier.	String	Required
<AircraftScheduledDateTime>	The scheduled date and time of arrival of the aircraft at the terminal or departure gate in an airport.	DateTime	Optional
<CarrierDesigCode>	Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code.	Token	Required
<DatedOperatingSegmentRefId>	Reference to a unique identifier of a dated operating segment used in a message.	Token	Required
<DatedMarketingSegmentID>	Unique identifier of a dated marketing segment used in a message.	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	Optional
<CarrierAircraftTypeCode>	Internal code used by an carrier to identify the type of aircraft.	Token	Optional
<AircraftScheduledDateTime>	Internal name given by the carrier to this aircraft type.	Token	Optional

/Response/DataLists/DatedOperatingSegmentList/DatedOperatingSegment/

Field	Description	Type	Required /Optional
<CarrierName>	Commercial name of the carrier.	Token	Optional
<OperatingCarrierFlightNumberText>	The numerical designation of a flight as it is operated by a carrier.	Token	Optional
<CarrierDesigCode>	Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. Example: "AS"	Token	Required
<DatedOperatingSegmentId>	Unique identifier of a dated operating segment used in a message.	Token	Required
<Duration>	Total segment time including the combined air time and connection times of any legs.	Duration	Optional

/Response/DataLists/DisclosureList/Disclosure/

Field	Description	Type	Required /Optional
<DisclosureID>	Uniquely Identifies a disclosure within the context of one message.	Token	Required
<DescText>	Description text value.	String	Optional

/Response/DataList/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
<Duration>	Total segment time including the combined air time and connection times of any legs.	Duration	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

/Response/DataLists/PaxList/Pax/

Field	Description	Type	Required /Optional
<IndividualID>	Uniquely Identifies an Individual within the context of one message.	Token	Optional
<PaxID>	Uniquely identifies a Passenger within the context of one message.	Token	Required
<GivenName>	A personal name given to the individual at birth and used before a family name. Also called first name. E.g. JOHN.	Token	Optional
<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	Required
<PTC>	Type code applying to the passenger which typically drives pricing.	String	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

/Response/DataLists/PaxList/Pax/LoyaltyProgramAccount/

Field	Description	Type	Required /Optional
<AccountNumber>	Loyalty Program account number. Example: ABC123456	Token	Optional
<AirlineDesigCode>	Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code.	Token	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	Optional
<MarketingCarrierRBD_Code>	Code used to identify a particular RBD (e.g. P, J, W, M, etc.).	Token	Optional
<CabinTypeCode>	Cabin Type Code as defined by ATSB codeset 9873. For AS NDC: 1: First Class (Includinig Refundable First) 2: Business Class (Includinig Refundable Business) 4: Main (Premium Economy) 5: Main 6: Main (Saver) 7: All else	Token	Optional
<CabinTypeName>	Name given to a cabin compartment (e.g. Business, First, Economy).	Token	Optional

/Response/DataList/PriceClassList/PriceClass/

Field	Description	Type	Required /Optional
<CabinTypeName>	Name given to a cabin compartment (e.g. Business, First, Economy).	Token	Optional
<CabinTypeCode>	Cabin Type Code as defined by ATSB codeset 9873. For AS NDC: 1: First Class (Includinig Refundable First) 2: Business Class (Includinig Refundable Business) 4: Main (Premium Economy) 5: Main 6: Main (Saver) 7: All else	Token	Optional
<Code>	Price class code. Example: 1, ABC.	Token	Optional
<Name>	Price class name, also known as fare family names.	Token	Required
<FareBasisCode>	Fare basis code. Example: Y26.	Token	Optional
<PriceClassID>	Uniquely Identifies a Price Class within the context of one message.	Token	Required

/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. Example: AS.	Token	Required

/Response/ReshopResults/ReshopOffers/Offer/

Field	Description	Type	Required /Optional
<OfferID>	Reference to an Offer ID requested in the OrderReshopRQ.	Token	Required
<OwnerCode>	Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. Example: AS.	Token	Required
<TotalAmount> @CurCode	Total monetary price amount, including all tax, surcharge, and fee amounts.	Decimal	Optional

/Response/ReshopResults/ReshopOffers/Offer/AddOfferItem/

Field	Description	Type	Required /Optional
<OfferItemID>	Carrier assigned ID which exists uniquely within an Offer. Exceeding 64 characters or use of dashes is not recommended.	Token	Required

/IATA_OrderReshopRS/Response/ReshopResults/ReshopOffers/Offer/AddedOfferItem/ExistingOrderItem/

Field	Description	Type	Required /Optional
<FutureStatusCode>	Status of the Order Service Status instance. See ATSB Codeset OrderService for possible values.	Token	Optional
<ServiceRefID>	Reference to another service instance.	Token	Required

/Response/ReshopResults/ReshopOffers/Offer/DeleteOrderItem/

Field	Description	Type	Required /Optional
<OfferItemID>	Carrier assigned ID which exists uniquely within an Offer. Exceeding 64 characters or use of dashes is not recommended.	Token	Required

/Response/ReshopResults/ReshopOffers/Offer/DeleteOrderItem/ExistingOrderItem/

Field	Description	Type	Required /Optional
<OrderItemRefID>	Reference to an Offer ID requested in the OrderReshopRQ.	Token	Required

/Response/ReshopResults/ReshopOffers/Offer/DeleteOrderItem/PriceDifferential/

OR

/Response/ReshopResults/ReshopOffers/Offer/AddOfferItem/ReshopPrice/PriceDifferential/

Field	Description	Type	Required /Optional
<DifferentialTypeCode>	Several types of action are possible when the customer selects a reshopped offer. Enumeration: AddCol AddColAndRefund AddColAndResidual EvenExchange Refund Residual Reusable Void	Token	Required
<PaxRefID>	Reference to a Passenger ID.	Token	Optional
<BaseAmount (@CurCode)>	Total base fare amount.	Decimal	Optional
<DueByAirlineAmount (@CurCode)>	Total base fare amount.	Decimal	Optional
<DueToAirlineAmount (@CurCode)>	Total base fare amount.	Decimal	Optional
<TotalAmount (@CurCode)>	Total monetary price amount, including all tax, surcharge, and fee amounts.	Decimal	Optional
<Amount (@CurCode)>	Fee Amount. Example: 500 USD.	Decimal	Required
<DescText>	Fee/surcharge Description. Example: U.S Customs User Fee.	String	Optional
<TaxCode>	IATA TTBS Tax Code. Example: AY, GB	Token	Optional
<PaxSegmentRefID>	Reference to a Passenger Segment ID within this message.	Token	Required
<CabinTypeCode>	Cabin Type Code as defined by ATSB codeset 9873. For AS NDC: 1: First Class (Includinig Refundable First) 2: Business Class (Includinig Refundable Business) 4: Main (Premium Economy) 5: Main 6: Main (Saver) 7: All else	Token	Optional
<CabinTypeName>	Name given to a cabin compartment (e.g. Business, First, Economy).	Token	Optional
<AllowedModificationInd>	Flags if cancellation is allowed used in conjunction with defined date ranges.	Boolean	Optional
<DescText>	Description text value.	String	Optional
<FareBasisCode>	Fare basis code. Example: Y26.	Token	Optional
<PriceClassRefID>	A price point within a particular Cabin Type (sometimes referred to as 'Fare Families').	Token	Optional
<RBD_Code>	Code used to identify a particular RBD (e.g. P, J, W, M, etc.). (Reservation booking code).	Token	Required

/Response/ReshopResults/ReshopOffers/Offer/AddOfferItem/Service/

Field	Description	Type	Required /Optional
<PaxJourneyRefID>	Uniquely identifies a Passenger Journey within the context of one message.	Token	Optional
<PaxRefID>	Reference to a Passenger ID.	Token	Optional
<ServiceID>	Uniquely Identifies a Service within the context of one message.	Token	Required

/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
<Timestamp>	Indicates the creation date and time of the message in UTC.	DateTime	Required