OrderReshopRQ NDC 2017.2

OrderReshopRQ

XPath: /OrderReshopRQ

Data Type Value: OrderReshopRQ

Description: The OrderReshop transaction set passes new shopping requests to an airline to replace existing specified order or order items in an Order or for new shopping requests to add to an existing Order. Airline responds with product offers within the context of the existing Order.

There is no change to the Order or Order Items, in response to a Reshop request - typically, the Reshop response will be followed by an OrderChangeRQ or OrderCancelRQ transaction, to commit the re-shop offer. In the response, the Airline can provide exact instructions as to what actions can finally be executed, as a solution to the initially requested action.

Version

XPath: /OrderReshopRQ/@Version

Data Type Value: string

Description: For all IATA versioned messages, the version of the message is indicated by a decimal value.

Target

XPath: /OrderReshopRQ/@Target

Data Type Value: Target

Description: Used to indicate whether the request is for the Test or Production system.

PrimaryLangID

XPath: /OrderReshopRQ/@PrimaryLangID

Data Type Value: language

Description: Identifes the primary language preference for the message. The human language is identified by ISO 639 codes.

AltLangID

XPath: /OrderReshopRQ/@AltLangID

Data Type Value: language

Description: Identifies the alternate language for a customer or message. The human language is identified by ISO 639 codes.

RetransmissionIndicator

XPath: /OrderReshopRQ/@RetransmissionIndicator

Data Type Value: boolean

Description: When true, indicates the message is being re-sent after a failure. It is recommended that this attribute is used (i.e., set to true) only when a message is retransmitted.

TimeStamp

XPath: /OrderReshopRQ/@TimeStamp

Data Type Value: dateTime

Description: Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24-hour clock (e.g., 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).

TransactionIdentifier

XPath: /OrderReshopRQ/@TransactionIdentifier

Data Type Value: StringLength1to32

Description: A unique identifier to relate all messages within a transaction (e.g., this would be sent in all request and response messages that are part of an on-going transaction).

SequenceNmbr

XPath: /OrderReshopRQ/@SequenceNmbr

Data Type Value: nonNegativeInteger

Description: Used to identify the sequence number of the transaction as assigned by the sending system; allows for an application to process messages in a certain order or to request a resynchronization of messages if a system has been off-line and needs to retrieve messages that were missed.

TransactionStatusCode

XPath: /OrderReshopRQ/@TransactionStatusCode

Data Type Value: TransactionStatusCode

Description: This indicates where this message falls within a sequence of messages.

EchoToken

XPath: /OrderReshopRQ/@EchoToken

Data Type Value: StringLength1to128

Description: A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.

PointOfSale

XPath: /OrderReshopRQ/PointOfSale

Data Type Value: PointOfSaleType

Description: A data type for Point of Sale.

CountryCode

XPath: /OrderReshopRQ/PointOfSale/Location/CountryCode

Data Type Value: CountryCode

Description: Country Code. Examples: US, FR. Encoding Scheme: ISO 3166-1 (two character) Country Code.

Code

XPath: /OrderReshopRQ/PointOfSale/TouchPoint/Device/Code

Data Type Value: CodesetValueSimpleType

Description: Code value. Example: 003.

Definition

XPath: /OrderReshopRQ/PointOfSale/TouchPoint/Device/Definition

Data Type Value: ProperNameSimpleType

Description: Code Definition. Example: Travel Agency.

TableName

XPath: /OrderReshopRQ/PointOfSale/TouchPoint/Device/TableName

Data Type Value: ProperNameSimpleType

Description: Code set table name.

Document

id

XPath: /OrderReshopRQ/Document/@id

Data Type Value: ID

Description: A globally unique identifier for this object instance.

Name

XPath: /OrderReshopRQ/Document/Name

Data Type Value: ProperNameSimpleType

Description: NDC Implementation Name. Example: ThisAirline Gateway

ReferenceVersion

XPath: /OrderReshopRQ/Document/ReferenceVersion

Data Type Value: ContextSimpleType

Description: NDC Framework Version. Example: SOAP 2015.1.

Party

AgencyID

XPath: /OrderReshopRQ/Party/Sender/TravelAgencySender/AgencyID

Data Type Value: AgencyID_Type

Description: A data type for Agency (Seller) ID.

IATA_Number

XPath: /OrderReshopRQ/Party/Sender/TravelAgencySender/IATA_Number

Data Type Value: IATA_NbrSimpleType

Description: Agency Seller IATA number. Example: 98417900.

PseudoCity

XPath: /OrderReshopRQ/Party/Sender/TravelAgencySender/PseudoCity

Data Type Value: PseudoCity

Description: Pseudo City code. Example: AAA2.

AgentUserID

XPath: /OrderReshopRQ/Party/Sender/TravelAgencySender/AgentUser/AgentUserID

Data Type Value: AgentUserID

Description: Agent User ID. Example: ksmith212.

UserRole

XPath: /OrderReshopRQ/Party/Sender/TravelAgencySender/AgentUser/UserRole

Data Type Value: ProperNameSimpleType

Description: Agent role. Example: Authorized User.

Surname

XPath: /OrderReshopRQ/Party/Sender/TravelAgencySender/AgentUser/Contacts/Contact/Name/Surname

Data Type Value: Surname

Description: Family name, last name. Example: SMITH.

Given

XPath: /OrderReshopRQ/Party/Sender/TravelAgencySender/AgentUser/Contacts/Contact/Name/Given

Data Type Value: Given[]

Description: Given name, first name or names.

Name

XPath: /OrderReshopRQ/Party/Sender/TravelAgencySender/Name

Data Type Value: ProperNameSimpleType

Description: Agency Seller Name. Example: Carson Travel.

Type

XPath: /OrderReshopRQ/Party/Sender/TravelAgencySender/Type

Data Type Value: AgencyCategorySimpleType

Description: Agency Seller Type. Examples: TravelAgency, OnlineTravelAgency, TravelManagementCompany.

SystemID

XPath: /OrderReshopRQ/Party/Participants/Participant/EnabledSystemParticipant/SystemID

Data Type Value: SystemID_Type

Description: A data type for Unique NDC-Enabled System ID.

SequenceNumber

XPath: /OrderReshopRQ/Party/Participants/Participant/EnabledSystemParticipant/@SequenceNumber

Data Type Value: positiveInteger

Description: The sequence number of this participating Party within the collection of parties. Example: 1.

Note: A sequence number of 1 indicates that this is the first Participant involved in the transaction.

Owner

XPath: /OrderReshopRQ/Party/Participants/Participant/EnabledSystemParticipant/SystemID/@Owner

Data Type Value: ContextSimpleType

Description: Airline designator or CRS code of the owner/assigner of the Offer ID, typically used for offer ordering purposes. Example: UA, BA. Encoding Scheme: IATA/A4A (two or three character) Airline or CRS Designator Code.

ReshopParameters

Reason

XPath: /OrderReshopRQ/ReshopParameters/Reason

Data Type Value: IATA_CodeType

Description: Reason for change. Encoding Scheme: IATA Padis Codeset REA.

LanguageCode

XPath: /OrderReshopRQ/ReshopParameters/Notices/Localization/Languages/LanguageCode

Data Type Value: LanguageCodeType

Description: Language Code representation.

Notes:

Language code. Example: en, en-US.
Encoding Schemes: ISO 639-1 Code OR Microsoft National Language Support (NLS) Code
Supports ISO 639-1 (two alpha character) neutral language encoding indicated by a name such as "en" for English.
Supports MNLS geographically specific language encoding indicated by a name that includes both locale and country/region information. For example, the locale English (United States) has the language name "en-US".

CurrCode

XPath: /OrderReshopRQ/ReshopParameters/CurrCodes/CurrCode

Data Type Value: CurrCode[]

Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.

Query

OrderID

XPath: /OrderReshopRQ/Query/OrderID

Data Type Value: string

Description: Reference to existing Order to which the Seller wants to add, udpate, delete an OrderItem.

ActionContext

XPath: /OrderReshopRQ/Query/ActionContext

Data Type Value: IATA_CodeType

Description: Reference to PADIS codeset REA. When used, provides context for the change being requested.

ObjectKey

XPath: /OrderReshopRQ/Query/Reshop/OrderServicing/Add/FlightQuery/Affinity/KeywordPreferences/KeywordPreference/@ObjectKey

Data Type Value: ID

Description: Object globally unique Instance ID. Example: obj1.

Account

XPath: /OrderReshopRQ/Query/Reshop/OrderServicing/Add/Qualifier/SpecialFareQualifiers/Account

Data Type Value: Account

Description: Corporate account name or ID used for pricing special fares. Example: 675124.

Type

XPath: /OrderReshopRQ/Query/BookingReferences/BookingReference/Type

Data Type Value: IATA_CodeType

Description: Booking Reference Type. Example: 6 (Passenger confirmation number). Encoding Scheme: IATA Padis Codeset - List for data element [1153] Reference Qualifier.

ID

XPath: /OrderReshopRQ/Query/BookingReferences/BookingReference/ID

Data Type Value: ID

Description: Existing Booking Reference ID. Example: R1A3SK.

AirlineID

XPath: /OrderReshopRQ/Query/BookingReferences/BookingReference/AirlineID

Data Type Value: AirlineID

Description: A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory.

Reprice

XPath: /OrderReshopRQ/Query/Reprice

Data Type Value: Reprice

Description: Function to reprice entire Order (if only OrderID is supplied within Query) or Specific OrderItems (if defined in nested OrderItem elements).

Value

XPath: /OrderReshopRQ/Query/Reshop/OrderServicing/Add/FlightQuery/Affinity/KeywordPreferences/KeywordPreference/Value

Data Type Value: Value[]

Description: Key-Word Value(s). Example: SkyCouch.

OrderItemID

XPath: /OrderReshopRQ/Query/Reshop/OrderServicing/Delete/OrderItem/@OrderItemID

Data Type Value: string

Description: Reference to the Order Item requested for deletion.

ServiceRetainRequestIDs

XPath: /OrderReshopRQ/Query/Reshop/OrderServicing/Delete/OrderItem/ServiceRetainRequestIDs

Data Type Value: string

Description: Reference to the Services 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.

OriginDestination

XPath: /OrderReshopRQ/Query/Reshop/OrderServicing/Add/FlightQuery/OriginDestinations/OriginDestination

Data Type Value: OriginDestination[]

Description: Flight origin/ destination information.

Departure

XPath: /OrderReshopRQ/Query/Reshop/OrderServicing/Add/FlightQuery/OriginDestinations/OriginDestination/Departure

Data Type Value: Departure

Description: FLIGHT DEPARTURE (ORIGIN).

AirportCode

XPath: /OrderReshopRQ/Query/Reshop/OrderServicing/Add/FlightQuery/OriginDestinations/OriginDestination/Departure/AirportCode

Data Type Value: AirportCode

Description: Airport or a city code. Use a three-letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory . Example: TPA.

AirportCode

XPath: /OrderReshopRQ/Query/Reshop/OrderServicing/Add/FlightQuery/OriginDestinations/OriginDestination/Arrival/AirportCode

Data Type Value: AirportCode

Description: Airport or a city code. Use a three-letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory. Example: TPA.

DaysBefore

XPath: /OrderReshopRQ/Query/Reshop/OrderServicing/Add/FlightQuery/OriginDestinations/OriginDestination/CalendarDates/@DaysBefore

Data Type Value: int

Description: Number of days before the specified date.

DaysAfter

XPath: /OrderReshopRQ/Query/Reshop/OrderServicing/Add/FlightQuery/OriginDestinations/OriginDestination/CalendarDates/@DaysAfter

Data Type Value: int

Description: Number of days after the specified date.

DataLists

PassengerID

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/@PassengerID

Data Type Value: ID

Description: Uniquely identifies a Passenger within the context of one message.

PTC

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/PTC

Data Type Value: PassengerTypeCodeType

Description: Type code applying to the Passenger which typically drives pricing (e.g., ADT, CHD, etc).

Remark

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/Remark

Data Type Value: Remark[]

Description: Additional, supplementary information about the document or service.

NameTitle

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/Individual/NameTitle

Data Type Value: ShortNameType

Description: Individual's name title. Examples: MR, MRS, DRn.

SurnameSuffix

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/Individual/SurnameSuffix

Data Type Value: ShortNameType

Description: Individual's surname suffixes and letters. Examples: Jr., Sr., III, Ret., Esq.

GivenName

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/Individual/GivenName

Data Type Value: ProperNameType[]

Description: Individual's first or given name. Example: JOHN.

Surname

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/Individual/Surname

Data Type Value: ProperNameType

Description: Individual's family name, last name. Example: SMITH.

MiddleName

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/Individual/MiddleName

Data Type Value: ProperNameType[]

Description: Individual's middle name or initial. Examples: G, GEORGE.

Gender

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/IdentityDocument/Gender

Data Type Value: GenderCodeContentType

Description: Holder’s gender as specified on the document (M, F, or X for unspecified).

BirthDate

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/IdentityDocument/@BirthDate

Data Type Value:

Description:

IdentityDocumentNumber

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/IdentityDocument/IdentityDocumentNumber

Data Type Value: SimpleCodeType

Description: Uniquely identifies the document from all other identity documents issued by the state or organization. Example: passport number, drive license number.

IdentityDocumentType

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/IdentityDocument/IdentityDocumentType

Data Type Value: IdentityDocumentTypeCodeType

Description: The type of passenger document. Examples: PT (Passport).

CitizenshipCountryCode

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/IdentityDocument/CitizenshipCountryCode

Data Type Value: ISO_3166CountryCodeContentType

Description: Citizenship Country Code. Examples: US, FR.

ExpiryDate

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/IdentityDocument/ExpiryDate

Data Type Value: DateType

Description: The date the identity document expires.

IssuingCountryCode

XPath: /OrderReshopRQ/DataLists/PassengerList/Passenger/IdentityDocument/IssuingCountryCode

Data Type Value: ISO_3166CountryCodeContentType

Description: Issuing country code of the identity document.

AreaCode

XPath: /OrderReshopRQ/DataLists/ContactList/ContactInformation/ContactProvided/Phone/AreaCode

Data Type Value: NumberType

Description: Phone number area code. Example: 813.

CountryDialingCode

XPath: /OrderReshopRQ/DataLists/ContactList/ContactInformation/ContactProvided/Phone/CountryDialingCode

Data Type Value: CountryDialiingCodeType

Description: Numeric telephone dialing prefixes for the member countries of the International Telecommunication Union (ITU).

PhoneNumber

XPath: /OrderReshopRQ/DataLists/ContactList/ContactInformation/ContactProvided/Phone/PhoneNumber

Data Type Value: NumberType

Description: Phone number text. Example: +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 the additional attributes to create a structured phone number.

Extension

XPath: /OrderReshopRQ/DataLists/ContactList/ContactInformation/ContactProvided/Phone/Extension

Data Type Value: NumberType

Description: Phone extension number. Example: 1234.

Label

XPath: /OrderReshopRQ/DataLists/ContactList/ContactInformation/ContactProvided/Phone/Label

Data Type Value: SimpleTextType

Description: Used to differentiate multiple Phone numbers of one contact. Examples: Work, Home, Mobile.

ContactType

XPath: /OrderReshopRQ/DataLists/ContactList/ContactInformation/ContactType

Data Type Value: SimpleTextType

Description: Classification for a particular set of contact information (e.g., Primary, Payment, etc.).

EmailAddressValue

XPath: /OrderReshopRQ/DataLists/ContactList/ContactInformation/ContactProvided/EmailAddress/EmailAddressValue

Data Type Value: SimpleTextType

Description: The email address which should be used for contact purposes.

Name

XPath: /OrderReshopRQ/DataLists/ServiceDefinitionList/ServiceDefinition/Name

Data Type Value: Name

Description: Service name. Example: Lounge Pass.

Code

XPath: /OrderReshopRQ/DataLists/ServiceDefinitionList/ServiceDefinition/Encoding/Code

Data Type Value: Code

Description: Service code. Examples: XLEG (Extra Leg Room Seat, implementer encoding); XBAG (Extra Bag, implementer encoding). Used in conjunction with SubCode (Associated Reason for Issuance SubCode).

refs

XPath: /OrderReshopRQ/DataLists/ServiceDefinitionList/ServiceDefinition/Descriptions/Description/@refs

Data Type Value: InstanceClassRefSimpleType

Description: Object association(s) between this object and any other object or metadata instance(s).

Text

XPath: /OrderReshopRQ/DataLists/ServiceDefinitionList/ServiceDefinition/Descriptions/Description/Text

Data Type Value: Text

Description: Description value.

FlightSegment

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment

Data Type Value: ListOfFlightSegmentType[]

Description: Flight origin/destination information.

SegmentKey

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/@SegmentKey

Data Type Value: KeyIdentifier

Description: A globally unique identifier for this Flight Segment instance. Example: segment1.

refs

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/ClassOfService/@refs

Data Type Value: InstanceClassRefSimpleType

Description: Object association(s) between this object and any other object or metadata instance(s).

Code

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/ClassOfService/Code

Data Type Value: Code

Description: Class of Service Code. Example: B.

FlightSegmentType

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/FlightDetail/FlightSegmentType

Data Type Value: IATA_CodeType

Description: Used for codes in the IATA code tables. Possible values of this pattern are 1, 101, EQP.

Date

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/Departure/Date

Data Type Value: date

Description: Departure date. Example: 2017-01-13. Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD).

Time

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/Departure/Time

Data Type Value: TimeSimpleType

Description: Departure time. Example: 09:15. Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM).

Date

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/Arrival/Date

Data Type Value: date

Description: Arrival date. Example: 2017-01-14. Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD).

StopQuantity

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopQuantity

Data Type Value: integer

Description: Stop Quantity. Example: 1.

FlightNumber

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/FlightNumber

Data Type Value: FlightNumber

Description: Flight Number. Example: 1234, or OPEN, or ARNK.

ResBookDesigCode

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/ResBookDesigCode

Data Type Value: ResBookDesigCode

Description: The Reservation Booking Designator (booking class) of the Marketing Carrier. Example: Y.

AirportCode

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/Departure/AirportCode

Data Type Value: AirportCode

Description: Airport or a city code. Use a three-letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory. Example: TPA.

AirportCode

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/Arrival/AirportCode

Data Type Value: AirportCode

Description: Airport or a city code. Use a three-letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory. Example: TPA.

Name

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Name

Data Type Value: CarrierNameType

Description: Airline Name. Example: British Airways.

AirlineID

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/AirlineID

Data Type Value: AirlineID

Description: A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory.

ResBookDesigCode

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/ResBookDesigCode

Data Type Value: CodesetValueSimpleType

Description: The Reservation Booking Designator (booking class) of the Operating Carrier if different from the Marketing Carrier. Example: Y.

Equipment

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/Equipment

Data Type Value: AircraftSummaryType

Description: AIRCRAFT SUMMARY representation.

AircraftCode

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/Equipment/AircraftCode

Data Type Value: AircraftCode

Description: Equipment Code. Example: 737. Encoding Scheme: IATA/ A4A Equipment Code.

MarketingCarrier

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier

Data Type Value: MarketingCarrierFlightType

Description: Marketing Carrier information.

AirlineID

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/AirlineID

Data Type Value: AirlineID

Description: A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory.

Name

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/Name

Data Type Value: CarrierNameType

Description: Airline Name. Example: British Airways.

ElectronicTicketInd

XPath: /OrderReshopRQ/DataLists/FlightSegmentList/FlightSegment/@ElectronicTicketInd

Data Type Value: boolean

Description: When true, an electronic ticket may be issued.

ListKey

XPath: /OrderReshopRQ/DataLists/FareList/FareGroup/@ListKey

Data Type Value: ID

Description: Globally unique id for this Data List instance.

TourCode

XPath: /OrderReshopRQ/DataLists/FareList/FareGroup/Fare/FareDetail/TourCode

Data Type Value: TourCode

Description: Tour Code. Example: ITGF12.

Name

XPath: /OrderReshopRQ/DataLists/PriceClassList/PriceClass/Name

Data Type Value: ProperNameSimpleType

Description: Price class name. Example: SUPERSAVER.

PriceClassID

XPath: /OrderReshopRQ/DataLists/PriceClassList/PriceClass/@PriceClassID

Data Type Value: ID

Description: Object globally unique Instance ID.