Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

User Guidance - Service Input Parameters

Input Parameters

Type

Optional/Mandatory

Request Object

IATA_OrderReshopRS

M

  • <AugmentationPoint>

  • <Response>

<Response>

Elements

Details

Mandatory/Optional

Response

Order Reshop RS response information.

M

<DataLists>

Elements

Details

Mandatory/Optional

DataListss

Data List definition for this message.

O

<ContactInfoList>

Elements

Details

Mandatory/Optional

ContactInfoList

Contact info data list definition.

O

XML Example for the following elements

<ns2:ContactInfo>
                     <ns2:ContactInfoID>V1_CNTCT.1696943859231</ns2:ContactInfoID>
                     <ns2:ContactPurposeText>HOME_PRIMARY</ns2:ContactPurposeText>
                     <ns2:EmailAddress>
                        <ns2:ContactTypeText>EMAIL_ID</ns2:ContactTypeText>
                        <ns2:EmailAddressText>andy@hotmail.com</ns2:EmailAddressText>
                     </ns2:EmailAddress>
                     <ns2:Individual>
                        <ns2:GivenName>AUTOFIRSTNAME</ns2:GivenName>
                        <ns2:Surname>AUTOLASTNAME</ns2:Surname>
                        <ns2:TitleName>MR</ns2:TitleName>
                     </ns2:Individual>
                     <ns2:Phone>
                        <ns2:ContactTypeText>CELL_NUMBER</ns2:ContactTypeText>
                        <ns2:CountryDialingCode>+90</ns2:CountryDialingCode>
                        <ns2:PhoneNumber>9876543210</ns2:PhoneNumber>
                     </ns2:Phone>
                     <ns2:PostalAddress>
                        <ns2:CityName>Bristol</ns2:CityName>
                        <ns2:ContactTypeText>AddressAtOrigin</ns2:ContactTypeText>
                        <ns2:CountryName>UNITED KINGDOM</ns2:CountryName>
                        <ns2:PostalCode>BS1 5UL</ns2:PostalCode>
                        <ns2:StreetText>3 St. Georges Road</ns2:StreetText>
                        <ns2:StreetText>Clifton</ns2:StreetText>
                     </ns2:PostalAddress>
 </ns2:ContactInfo>

Elements

Details

Mandatory/Optional

ContactInfo

The electronic or geographic address which a party has provided as the contact channel.

M

ContactInfoID

Uniquely Identifies a set of Contact Information.

M

ContactPurposeText

To identify the contact purpose 

O

EmailAddress

The email address which should be used for contact purpose

O

ContactTypeText

PADIS code list: Contact Type (to identify the technical contact type information)

O

EmailAddressText

The email address which should be used for contact purposes.

M

Individual

A single human being as distinct from a group, class, or family.

O

GivenName

A personal name given to the individual at birth and used before a family name.

O

Surname

 Family name or last name. 

M

TitleName

A word that is used before an individual's name to indicate the gender, profession or marital status.

O

Phone

A telephone number

O

CountryDialingCode

Numeric telephone dialing prefixes for the member countries of the International Telecommunication Union

O

PhoneNumber

Phone number text

O

PostalAddress

Natural or physical address used for postal service. 

O

CityName

The name, expressed as text, of the city, town or village.

O

CountryName

The name, expressed as text, of the country.

O

PostalCode

Postal code. 

O

StreetText

Street name and number

O

<DatedMarketingSegmentList>

XML Example for the following elements

<ns2:DatedMarketingSegmentList>
                <!--1 or more repetitions:-->
                  <ns2:DatedMarketingSegment>
                     <ns2:Arrival>
                        <ns2:AircraftScheduledDateTime>2022-07-15T05:30:00Z</ns2:AircraftScheduledDateTime>
                        <ns2:IATA_LocationCode>FRA</ns2:IATA_LocationCode>
                     </ns2:Arrival>
                     <ns2:CarrierDesigCode>Airline Code</ns2:CarrierDesigCode>
                     <ns2:DatedMarketingSegmentId>V1_DATEDMARKETINGSEG.1656602568344</ns2:DatedMarketingSegmentId>
                     <ns2:DatedOperatingSegmentRefId>V1_DATEDOPERATINGSEG.1656602568345</ns2:DatedOperatingSegmentRefId>
                     <ns2:Dep>
                        <ns2:AircraftScheduledDateTime>2022-07-15T01:00:00Z</ns2:AircraftScheduledDateTime>
                        <ns2:IATA_LocationCode>AYT</ns2:IATA_LocationCode>
                     </ns2:Dep>

                     <ns2:MarketingCarrierFlightNumberText>650</ns2:MarketingCarrierFlightNumberText>

                     <ns2:OperationalSuffixText>*</ns2:OperationalSuffixText>
                  </ns2:DatedMarketingSegment>
</ns2:DatedMarketingSegmentList>

Elements

Details

Mandatory/Optional

DatedMarketingSegmentList

A list of dated marketing segments 

O

DatedMarketingSegment

The commercial designation under which a Dated Operating Segment can be booked, either under the operating carrier's designator or that of another carrier 

M

Arrival

Arrival Transport point location

M

AircraftScheduledDateTime

The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport.

O

IATA_LocationCode

IATA 3-letter code defining the city or airport code.

M

CarrierDesigCode

Airline code assigned to a carrier. 

M

DatedMarketingSegmentId

Unique identifier of a dated marketing segment

M

DatedOperatingSegmentRefId

Reference to a unique identifier of a dated operating segment 

M

Dep

Departure Transport point Location

M

MarketingCarrierFlightNumberText

The numerical designation of a flight as it is marketed by a carrier.

M

OperationalSuffixText

Used to distinguish two flights having the same flight number and departing from their respective Origin Stations on the same date.

O

<DatedOperatingLegList>

Elements

Details

Mandatory/Optional

DatedOperatingLegList

A list of dated operating legs 

O

<DatedOperatingLeg>

XML Example for the following elements

  <ns2:DatedOperatingLeg>
                     <ns2:Arrival>
                        <ns2:AircraftScheduledDateTime>2023-10-08T12:00:00Z</ns2:AircraftScheduledDateTime>
                        <ns2:IATA_LocationCode>FRA</ns2:IATA_LocationCode>
                     </ns2:Arrival>
                     <ns2:CarrierAircraftType>
                        <ns2:CarrierAircraftTypeCode>800</ns2:CarrierAircraftTypeCode>
                        <ns2:CarrierAircraftTypeName>737</ns2:CarrierAircraftTypeName>
                     </ns2:CarrierAircraftType>
                     <ns2:DatedOperatingLegID>V1_EQPT.1696932958384</ns2:DatedOperatingLegID>
                     <ns2:Dep>
                        <ns2:AircraftScheduledDateTime>2023-10-08T02:00:00Z</ns2:AircraftScheduledDateTime>
                        <ns2:IATA_LocationCode>AYT</ns2:IATA_LocationCode>
                     </ns2:Dep>

  </ns2:DatedOperatingLeg>

Elements

Details

Mandatory/Optional

DatedOperatingLeg

The nonstop operation of a transport vehicle between the departure station and the arrival station

M

Arrival

Arrival transport point location

M

AircraftScheduledDateTime

The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport.

O

IATA_LocationCode

IATA 3-letter code defining the city or airport code.

M

CarrierAircraftType

Carrier defined internal grouping of aircrafts with the same form, function and specification.

O

CarrierAircraftTypeCode

Internal code used by an carrier to identify the type of aircraft.

O

CarrierAircraftTypeName

Internal name given by the carrier to this aircraft type.

O

DatedOperatingLegID

Uniquely identifies a leg

M

Dep

Departure transport point location

M

<DatedOperatingSegmentList>

Elements

Details

Mandatory/Optional

DatedOperatingSegmentList

A list of dated operating segments

O

<DatedOperatingSegment>

XML Example for the following elements

<ns2:DatedOperatingSegment>
                     <ns2:CarrierDesigCode>Airline Code</ns2:CarrierDesigCode>
                     <ns2:DatedOperatingLegRefID>V1_EQPT.1696943859229</ns2:DatedOperatingLegRefID>
                     <ns2:DatedOperatingSegmentId>V1_DATEDOPERATINGSEG.1696943859227</ns2:DatedOperatingSegmentId>
                     <ns2:Duration>P0Y0M0DT11H0M0.000S</ns2:Duration>
 </ns2:DatedOperatingSegment>

Elements

Details

Mandatory/Optional

DatedOperatingSegment

An operation between board point and any subsequent off point within the same flight designator. Could be one or more legs

M

CarrierDesigCode

Airline code assigned to a carrier. 

M

DatedOperatingLegRefID

Uniquely identifies a leg.

O

DatedOperatingSegmentId

Unique identifier of a dated operating segment

M

Duration

Total segment time including the combined air time and connection times of any legs

O

<OriginDestList>

Elements

Details

Mandatory/Optional

OriginDestList

Origin Destination data list definition.

O

<OriginDest>

XML Example for the following elements

<ns2:OriginDest>
                     <ns2:DestCode>FRA</ns2:DestCode>
                     <ns2:OriginCode>AYT</ns2:OriginCode>
                     <ns2:OriginDestID>V1_OD.1656447765617</ns2:OriginDestID>
                     <ns2:PaxJourneyRefID>V1_FL.1656447765630</ns2:PaxJourneyRefID>     
</ns2:OriginDest>

Elements

Details

Mandatory/Optional

OriginDest

The Origin and Destination airport/city pair which confines a passenger journey or an aircraft flight.

M

DestCode

IATA defined code identifying Destination city or station.

M

OriginCode

IATA defined code identifying Origin city or station.

M

OriginDestID

Uniquely identifies an Origin Destination

M

PaxJourneyRefID

Uniquely identifies a Passenger Journey

O

<PaxJourneyList>

Elements

Details

Mandatory/Optional

PaxJourneyList

Journey data list definition.

O

<PaxJourney>

XML Example for the following elements

             <ns2:PaxJourney>
                     <ns2:Duration>P0Y0M0DT11H0M0.000S</ns2:Duration>
                     <ns2:PaxJourneyID>V1_FL.1696932958390</ns2:PaxJourneyID>
                     <ns2:PaxSegmentRefID>V1_SEG.1696932958387</ns2:PaxSegmentRefID>
              </ns2:PaxJourney>
 

PaxJourney

A collection of segments which satisfies transportation of a passenger for a given origin and destination. 

M

Duration

Total journey time including the combined air time and connection times.

O

PaxJourneyID

Uniquely identifies a Passenger Journey.

M

PaxSegmentRefID

Reference to a Passenger Segment ID

M

<PaxList>

Elements

Details

Mandatory/Optional

PaxList

Passenger data list definition.

O

<Pax>

XML Example for the following elements

<ns2:Pax>
                     <ns2:Individual>
                        <ns2:Birthdate>1998-07-09Z</ns2:Birthdate>
                        <ns2:GenderCode>M</ns2:GenderCode>
                        <ns2:GivenName>AEWLYBXXN</ns2:GivenName>
                        <ns2:Surname>BAHFJ</ns2:Surname>
                        <ns2:TitleName>MR</ns2:TitleName>
                     </ns2:Individual>
                     <ns2:LangUsage>
                        <ns2:LangCode>en</ns2:LangCode>
                        <ns2:LangUsageText>English</ns2:LangUsageText>
                     </ns2:LangUsage>
                     <ns2:PaxID>V1_PAX.714686</ns2:PaxID>
                     <ns2:PTC>ADT</ns2:PTC>
  </ns2:Pax>

Elements

Details

Mandatory/Optional

Pax

Any person except members of the crew carried or to be carried with the consent of the carrier.

M

Individual

A single human being as distinct from a group, class, or family.

O

Birthdate

Birth date

O

GenderCode

Gender of the individual

O

GivenName

A personal name given to the individual at birth and used before a family name.

O

Surname

Individual's hereditary name(s) common to all members of a family.

M

TitleName

A word such as Mr., Mrs., Miss or Dr that is used before an individual's name to indicate the gender, profession or marital status

O

LangUsage

Language Code representation.

O

LangCode

Language Code representation.

M

LangUsageText

Written or Spoken language.

O

PaxID

Uniquely identifies a Passenger 

M

PTC

Type code applying to the Passenger

O

<PaxSegmentList>

XML Example for the following elements

<ns2:PaxSegmentList>
                       
                        <ns2:PaxSegment>
                            <ns2:CabinTypeAssociationChoice>
                                <ns2:SegmentCabinType>
                                    <ns2:CabinTypeCode>3</ns2:CabinTypeCode>
                                    <ns2:CabinTypeName>ECONOMY</ns2:CabinTypeName>
                                </ns2:SegmentCabinType>
                            </ns2:CabinTypeAssociationChoice>
                            <ns2:DatedMarketingSegmentRefId>V1_DATEDMARKETINGSEG.1656602569199</ns2:DatedMarketingSegmentRefId>
                            <ns2:MarketingCarrierRBD_Code>B</ns2:MarketingCarrierRBD_Code>
                            <ns2:PaxSegmentID>V1_SEG.500</ns2:PaxSegmentID>
                        </ns2:PaxSegment>
</ns2:PaxSegmentList>

Elements

Details

Mandatory/Optional

PaxSegmentList

Segment data list definition.

O

PaxSegment

Transportation of a passenger on a Dated Operating Segment. 

M

CabinTypeAssociationChoice

A choice of Cabin Type Association to leg(s) or a segment

O

SegmentCabinType

Type of compartment of an aircraft, offering specific services

M

CabinTypeCode

Cabin Type Code as defined by ATSB codeset 9873.

O

CabinTypeName

Name given to a cabin compartment 

O

DatedMarketingSegmentRefId

A reference to a unique identifier of a dated marketing segment 

M

MarketingCarrierRBD_Code

Code used to identify a particular RBD 

O

PaxSegmentId

Uniquely identifies a Passenger Segment

M

<ServiceDefinitionList>

Elements

Details

Mandatory/Optional

ServiceDefinitionList

Service Definition data list definition.

O

<ServiceDefinition>

XML Example for the following elements

<ns2:ServiceDefinition>
                            <ns2:Desc>
                                <ns2:DescText>DESCRIPTION=Vegetarian Snack Vegan</ns2:DescText>
                            </ns2:Desc>
                            <ns2:Desc>
                                <ns2:DescText>RULE_TEXT=ONE MEAL REQUEST PER PAX</ns2:DescText>
                            </ns2:Desc>
                            <ns2:Name>VEAL MEAL 1</ns2:Name>
                            <ns2:OwnerCode>Airline Code</ns2:OwnerCode>
                            <ns2:RFIC>G</ns2:RFIC>
                            <ns2:RFISC>0LJ</ns2:RFISC>
                            <ns2:ServiceCode>VGML</ns2:ServiceCode>

                            <ns2:ServiceDefinitionID>V1_SSR.1697326329407</ns2:ServiceDefinitionID>
 </ns2:ServiceDefinition>
             

Elements

Details

Mandatory/Optional

ServiceDefinition

Description and characteristics of a non-flight product or service that can be separately sold and delivered.

M

Desc

An account or representation of the certain or major aspects, characteristics, or features of a person, object, or event.

O

DescText

Description text value.

O

Name

Service name. 

M

OwnerCode

Airline code assigned to a carrier.

M

RFIC

Reason For Issuance Code 

O

RFISC

Reason For Issuance Sub Code. 

O

ServiceCode

Airline specific service code which can be associated with the Reason for Issuance Sub Code.

O

ServiceDefinitionID

Uniquely Identifies a Service Definition.

M

<Order>

XML Example for the following elements

<ns2:Order>
               <ns2:CreationDateTime>2023-10-17T06:20:50.267Z</ns2:CreationDateTime>
               <ns2:OrderID>AD3HXG</ns2:OrderID>
               <ns2:OwnerCode>Airline Code</ns2:OwnerCode>

   </ns2:Order>

Elements

Details

Mandatory/Optional

Order

A uniquely identified record of the agreement of one party with another to receive products and services under specified terms and conditions.

M

CreationDateTime

The date time by which the order is created. 

O

OrderID

Carrier assigned ID which uniquely identifies a specific Order across several messages.

M

OwnerCode

Airline code assigned to a carrier. 

M

<ReshopResults>

Elements

Details

Mandatory/Optional

ReshopResults

ReshopResults

M

<ReshopOffers>

ReshopOffers

Reshopped Carrier Offers.

M

<RequotedOffer>

<ns2:RequotedOffer>
                     <ns2:AddedOfferItem>
                        <ns2:OfferItemID>OO1-eJwzNTCID3P39Yk38PGK1zUF8nT9-Q3jLc0sTYwtTC2NjA0Am3gIdQ__</ns2:OfferItemID>
                        <ns2:ReshopPrice>
                           <ns2:PriceAndFareDetails>
                              <ns2:Price>
                                 <ns2:Fee>
                                    <ns2:Amount CurCode="TRY">116.54</ns2:Amount>
                                    <ns2:DescText>Snack</ns2:DescText>
                                    <ns2:DesigText>SNML</ns2:DesigText>
                                 </ns2:Fee>
                                 <ns2:TaxSummary>
                                    <ns2:Tax>
                                       <ns2:Amount CurCode="TRY">9.32</ns2:Amount>
                                       <ns2:Country>
                                          <ns2:CountryCode>TR</ns2:CountryCode>
                                       </ns2:Country>
                                       <ns2:DescText>VAT</ns2:DescText>
                                    </ns2:Tax>
                                    <ns2:TotalTaxAmount CurCode="TRY">9.32</ns2:TotalTaxAmount>
                                 </ns2:TaxSummary>
                                 <ns2:TotalAmount CurCode="TRY">125.86</ns2:TotalAmount>
                              </ns2:Price>
                           </ns2:PriceAndFareDetails>
                        </ns2:ReshopPrice>
                        <ns2:Service>
                           <ns2:OfferServiceAssociation>                             

                              <ns2:ServiceDefinitionRef>
                                 <ns2:OfferFlightAssociations>
                                    <ns2:PaxSegmentReferences>
                                       <ns2:PaxSegmentRefID>V1_SEG.500</ns2:PaxSegmentRefID>
                                    </ns2:PaxSegmentReferences>
                                 </ns2:OfferFlightAssociations>
                                 <ns2:ServiceDefinitionRefID>V1_SSR.500</ns2:ServiceDefinitionRefID>
                              </ns2:ServiceDefinitionRef>
                           </ns2:OfferServiceAssociation>
                           <ns2:PaxRefID>V1_PAX.714686</ns2:PaxRefID>
                           <ns2:ServiceID>V1_SRVC_PAX.714686_SSR.500</ns2:ServiceID>
                        </ns2:Service>
                     </ns2:AddedOfferItem>
                     <ns2:OfferExpirationTimeLimitDateTime>2023-10-17T06:38:55.610Z</ns2:OfferExpirationTimeLimitDateTime>
                     <ns2:OfferID>PO1-eJwli0EKgCAUBe8TBN-0-3QpURSUVrjI1buAtOv.GQ3MZmCYCD6n6fRQ4nqxZOkD1wFhQl7nJSTcTykYhxjilqG1EZa-ZTApEJpqaAl7VHDijLbsOl3-FzEgGyY_</ns2:OfferID>
                     <ns2:OwnerCode>Airline Code</ns2:OwnerCode>
                     <ns2:TotalPrice>
                        <ns2:TotalAmount CurCode="TRY">621.18</ns2:TotalAmount>
                     </ns2:TotalPrice>

 </ns2:RequotedOffer>

Elements

Details

Mandatory/Optional

RequotedOffer

Changed Offer.

O

AddedOfferItem

A priced grouping of one or more services within an Added Offer. 

O

OfferItemID

Carrier assigned ID which exists uniquely within an Offer. 

M

ReshopPrice

Reshop Price

M

PriceAndFareDetails

A container for Price and Fare detail information.

M

Price

The amount of money expecte or given in payment for something.

O

Fee

Amount added on to a charge for a specific product, purpose, or service.

O

Amount

Fee Amount. 

M

DescText

Fee/ surcharge Description.

O

DesigText

Fee designator code.

O

TaxSummary

Tax summary information.

O

Tax

A compulsory contribution to state revenue, levied by the government.

O

Amount

Tax amount.

M

Country

A nation.

O

CountryCode

ISO Country Code 

O

TotalTaxAmount

Total of all applicable tax amounts included in the price.

O

TotalAmount

Total monetary price amount, including all tax, surcharge, and fee amounts.

O

Service

Offered Service is the instance of a specific flight or Service Definition as it has been offered 

M

OfferServiceAssociation

Offer Service Association

M

ServiceDefinitionRef

Airline specific definition of a product or service that can be separately sold and delivered. 

M

OfferFlightAssociations

Offer Flight Associations

O

PaxSegmentReferences

Reference to a PaxSegmentID's

M

PaxSegmentRefID

Reference to a PaxSegmentID.

M

ServiceDefinitionRefID

References a Service Definition ID

M

PaxRefID

Reference to a Passenger ID 

M

ServiceID

Uniquely Identifies a Service 

M

OfferExpirationTimeLimitDateTime

The length of time an offer will persist in an airline's offer management system for use in subsequent transactions. 

O

OfferID

Carrier assigned ID which uniquely identifies a specific Offer across several messages.

M

OwnerCode

Airline code assigned to a carrier.

M

TotalPrice

The amount of money expected,

O

TotalAmount

Total monetary price amount, including all tax, surcharge, and fee amounts.

O

<AugmentationPoint>

XML Example for the following elements

<ns3:AugmentationPoint>
            <ns4:ItineraryAmountDetailAugPoint>
               <TotalPriceAmount Code="TRY">495.32</TotalPriceAmount>
               <TotalFeeAmount Code="TRY">125.86</TotalFeeAmount>
               <TotalAmount Code="TRY">621.18</TotalAmount>
               <TotalAmountToBePaid Code="TRY">125.86</TotalAmountToBePaid>
               <TotalAmountPaid Code="TRY">495.32</TotalAmountPaid>
            </ns4:ItineraryAmountDetailAugPoint>
  </ns3:AugmentationPoint>

Elements

Details

Mandatory/Optional

AugmentationPoint

Augmented Structure.

O

ItineraryAmountDetailAugPoint

Itinerary Amount details.

M

TotalPriceAmount

The total Price Amount.

M

TotalFeeAmount

The total Fee Amount.

M

TotalAmount

TotalAmount of the Price and fee.

M

TotalAmountToBePaid

The total due amount (including fare and fee).

M

TotalAmountPaid

Total Paid Amount of the Price and Fee.

M

  • No labels