21.3 IATA_OrderViewRS (SSR Addition In Modification Flow)
- Nadhiya S M (Unlicensed)
- Gopika R
User Guidance - Service Input Parameters | ||
Input Parameters | Type | Optional/Mandatory |
Request Object | IATA_OrderViewRS | M |
Â
<Response>
<DistributionChain>
<PayloadAttributes>
<PaymentFunctions>
<PayloadAttributes> | ||
|---|---|---|
XML Example for the following elements<ns4:PayloadAttributes> | ||
Elements | Details | Mandatory/Optional |
PayloadAttributes | IATA payload standard attributes. | O |
VersionNumber | The version of the message | O |
<DistributionChain> | ||
|---|---|---|
XML Example for the following elementsB2B Flow <iata:DistributionChain> B2C Flow <iata:DistributionChain> | ||
Elements | Details | Optional/Mandatory |
DistributionChain | The set of organizations involved in the development of the current transaction. | O |
DistributionChainLink | An organization playing a participating role in an instance of a distribution channel. | M |
Ordinal | The number defining the position of the distribution chain link in the distribution chain indicating the order in which the organization participated. | M |
OrgRole | The distribution chain role performed by the participating organization | M |
ParticipatingOrg | An organized structure set up for a particular purpose | M |
Name | Name of the organization | O |
OrgID | Organization code | M |
SalesAgent | An individual conducting sales activities on behalf of a sales branch or organization. | O |
SalesAgentID | The unique identifier of the sales agent. This value must be accompanied by the appropriate Sales Branch Identifier | M |
SalesBranch | An organizational unit with responsibility over sales in a market, for a product or service and under any other specified criteria. | O |
SalesBranchID | The industry wide unique identifier of the sales branch. | M |
<Response> | ||
Elements | Details | Mandatory/Optional |
Response | Order View RS response information. | M |
<DataLists> | ||
Elements | Details | Mandatory/Optional |
DataLists | Data List definition for this message. | O |
<BaggageAllowanceList> | ||
XML Example for the following elements <ns2:BaggageAllowanceList> | ||
Elements | Details | Mandatory/Optional |
BaggageAllowanceList | Baggage allowance data list definition | O |
BaggageAllowance | The amount of checked or carry-on luggage the airline will allow per passenger. | M |
BaggageAllowanceID | Unique identifier of this Baggage Allowance. | M |
TypeCode | Type of Baggage Allowance. | M |
WeightAllowance | Baggage weight allowance | O |
MaximumWeightMeasure | Maximum weight value and unit of measure. | O |
WeightUnitOfMeasurement | The unit of measurement of weight defined as imperial or metric. | M |
<ContactInfoList> | ||
<ns2:ContactInfoList> | ||
Elements | Details | Mandatory/Optional |
ContactInfoList | Contact info data list definition | O |
ContactInfo | The electronic or geographic address which a party has provided as the contact channel. For example, contact email, contact postal address, contact phone number. | M |
ContactInfoID | Â | M |
ContactPurposeText | Uniquely Identifies a set of Contact Information, | O |
EmailAddress | The email address which should be used for contact purposes. | O |
ContactTypeText | Uniquely Identifies a set of Contact 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 |
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 |
GivenName | A personal name given to the individual at birth and used before a family name. Also called first name. | O |
Surname | Individual's hereditary name(s) common to all members of a family. Also known as family name or last name. | M |
Phone | A telephone number | O |
ContactTypeText | PADIS code list | 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 |
StreetText | Street name and number | O |
PostalCode | Postal Code | O |
<DatedMarketingSegmentList> | ||
XML Example for the following elements<ns2:DatedMarketingSegmentList> Â Â Â Â Â Â Â Â Â Â Â Â </ns2:DatedMarketingSegment> | ||
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 |
<DatedOperatingLegList> | ||
XML Example for the following elements<ns2:DatedOperatingLegList> | ||
Elements | Details | Mandatory/Optional |
DatedOperatingLegList | A list of dated operating legs | O |
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 |
DatedOperatingLegID | Uniquely identifies a leg | M |
Dep | Departure transport point location | M |
IATA_AircraftType | Grouping of aircrafts with the same form, function and specification, currently flown, or soon to be flown | O |
IATA_AircraftTypeCode | Code assigned to an aircraft type in IATA SSIM. | O |
<DatedOperatingSegmentList> | ||
XML Example for the following elements<ns2:DatedOperatingSegmentList> Â Â Â Â Â Â Â Â Â Â Â Â Â Â <ns2:CarrierDesigCode>Airline Code</ns2:CarrierDesigCode> | ||
Elements | Details | Mandatory/Optional |
DatedOperatingSegmentList | A list of dated operating segments | O |
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> | ||
XML Example for the following elements<ns2:OriginDestList> | ||
Elements | Details | Mandatory/Optional |
OriginDestList | Origin Destination data list definition. | O |
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> | ||
XML Example for the following elements<ns2:PaxJourneyList> | ||
Elements | Details | Mandatory/Optional |
PaxJourneyList | Journey data list definition. | O |
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> | ||
XML Example for the following elements <ns2:PaxList> | ||
Elements | Details | Mandatory/Optional |
PaxList | Passenger data list definition | O |
Pax | Any person except members of the crew carried or to be carried with the consent of the carrie | 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> | ||
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 |
<PriceClassList> | ||
XML Example for the following elements<ns2:PriceClassList> | ||
PriceClassList | Price Class data list definition. | O |
PriceClass | A price point within a particular Cabin Type . | M |
FareBasisCode | Fare basis code. | O |
Name | Price class name. | M |
PriceClassID | Uniquely Identifies a Price Class within the context of one message. | M |
<ServiceDefinitionList> | ||
Elements | Details | Mandatory/Optional |
ServiceDefinitionList | Service Definition data list definition. | O |
<ServiceDefinition> | ||
XML Example for the following elements<ns2:ServiceDefinition>                <!--Optional, This item is to be populated for baggage SSR-->                <ns2:ServiceDefinitionAssociation>               <ns2:ServiceDefinitionID>V1_SSR.500</ns2:ServiceDefinitionID> | ||
Elements | Details | Mandatory/Optional |
ServiceDefinition | Description and characteristics of a non-flight product or service that can be separately sold and delivered. | M |
AirlineTaxonomy | Used in the context of the Airline Taxonomy to define a product or service to the seller or to request a collection of products and services from an airline. | O |
TaxonomyCode | Used for defining a product or service within the Shared Industry Taxonomy or bilaterally. | O |
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 |
ServiceDefinitionAssociation | Service Definition Association Choice to determine if the information of this ServiceDefinition needs to be extended with specific Bag or Seat characteristics or whether the ServiceDefinition is used as a bundle of further ServiceDefinitions. | O |
BaggageAllowanceRef | Reference to a Baggage Allowance. | M |
BaggageAllowanceRefID | Reference to a Bag Allowance ID. | M |
 |  |  |
<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 |
OrderID | Carrier assigned ID which uniquely identifies a specific Order across several messages. | M |
OwnerCode | Airline code assigned to a carrier. | M |
StatusCode | Status of the Order Status instance. | O |
<OrderItem> | ||
Elements | Details | Mandatory/Optional |
OrderItem | An Ordered individually priced item within an Ordered Order, made up of one or more Services. | M |
OrderItemID | Carrier assigned ID which exists uniquely within an Offer. | M |
OwnerCode | Airline code assigned to a carrier. | M |
<FareDetail> | ||
Elements | Details | Mandatory/Optional |
FareDetail | The amount charged by the carrier for the carriage of a passenger and his allowable free baggage. | O |
<FareComponent> | ||
XML Example for the following elements<!--1 or more repetitions:--> Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â <ns2:LocalAmount CurCode = "TRY">29.14</ns2:LocalAmount> Â Â Â Â Â Â Â Â Â Â Â Â <ns2:PriceClassRefID>V1_PC.1696943854284</ns2:PriceClassRefID> | ||
Elements | Details | Mandatory/Optional |
FareComponent | A portion of an itinerary between two consecutive fare construction points. | O |
CabinType | Type of compartment of an aircraft, offering specific services | O |
CabinTypeCode | Cabin Type Code | O |
CabinTypeName | Name given to a cabin compartment | O |
FareBasisCode | Fare basis code. | O |
FareTypeCode | Fare Amount Type Code | O |
PaxSegmentRefID | Reference to a Pax Segment ID. | O |
Price | The amount of money expected, required, or given in payment for something. | O |
BaseAmount | Total Base Fare Amount. | O |
EquivAmount | The entire amount of transaction stated in the local currency at the point of sale, or the currency as defined by the Currency Indicator Code. | O |
Surcharge | Amount added on to a usual charge for a specific product, purpose, or service. | O |
Breakdown | 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 |
LocalAmount | Fee amount specified in a local currency. | O |
TotalAmount | Summary of all fee amounts. | O |
TaxSummary | Tax summary information. | O |
Tax | A compulsory contribution to state revenue, levied by the government on workers' income and business profits or added to the cost of some goods, services, and transactions. | O |
Amount | Tax amount | M |
Country | Country | O |
CountryCode | ISO Country Code | O |
TaxCode | IATA TTBS Tax Code. | O |
TaxName | The name given to describe the tax. | 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 |
PriceClassRefID | A price point within a particular Cabin Type | O |
RBD | Reservation Booking Designator. | O |
RBD_Code | Code used to identify a particular RBD | M |
TicketDesigCode | The Fare Basis Code Designator shall be placed within this element and removed from the Fare Basis Code element | O |
<Price> | ||
XML Example for the following elements <ns2:Price> | ||
Elements | Details | Mandatory/Optional |
Price | The amount of money expected, required, or given in payment for something. | O |
BaseAmount | Total Base Fare | O |
Discount | Deduction from the price amount, made in advance of its payment | O |
DiscountAmount | Discount amount applied to a price. | O |
Surcharge | Amount added on to a usual charge for a specific product, purpose, or service. | O |
TotalAmount | Summary of all fee amounts. | O |
TaxSummary | Tax summary information | 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 |
<PriceDifferential> | ||
Elements | Details | Mandatory/Optional |
PriceDifferential | For each OfferItem, this function allows the airline to inform the seller about amount differential type if this OfferItem is chosen. | O |
<DiffPrice> | ||
XML Example for the following elements <ns2:DiffPrice> | ||
Elements | Details | Mandatory/Optional |
DiffPrice | A specialization of a container for Price and Fare detail information. | M |
FareDetail | The amount charged by the carrier for the carriage of a passenger and his allowable free baggage. | O |
PaxRefID | Reference to a Passenger ID | O |
Price | A specialization of price used for price differentials. | O |
DueByAirlineAmount | Total monetary price amount, including all tax, surcharge, and fee amounts. | O |
EquivAmount | The entire amount of transaction stated in the local currency at the point of sale, or the currency as defined by the Currency Indicator Code. | O |
TaxSummary | Tax summary information. | O |
Tax | A compulsory contribution to state revenue, levied by the government | O |
Amount | Tax amount | M |
TaxCode | IATA TTBS Tax Code. | O |
TotalAmount | Total monetary price amount, including all tax, surcharge, and fee amounts. | O |
<Service> | ||
XML Example for the following elements <!--1 or more repetitions:-->            <!--AirlineTaxonomy item is to be populated only if it is seat offer item-->            <ns2:AirlineTaxonomy>             <ns2:OrderServiceAssociation>             <!-- PaxSegmentRef is to be populated only if its Flight offer Item-->              <!--SeatOnLeg is to be populated only if it is Seat offer item-->             <ns2:SeatOnLeg>             <!--ServiceDefinitionRef  is to be populated only if it is SSR offer item-->             <ns2:ServiceDefinitionRef>            </ns2:OrderServiceAssociation>            <ns2:StatusCode>CONFIRMED</ns2:StatusCode> | ||
Elements | Details | Mandatory/Optional |
Service | Ordered Service is the instance of a specific flight or Service Definition as it has been offered. | M |
AirlineTaxonomy | Used in the context of the Airline Taxonomy to define a product or service to the seller or to request a collection of products and services from an airline. | O |
DescText | To enable the Airline to describe the Taxonomy without the need for the Seller to refer to a specific Taxonomy optionally. | O |
TaxonomyFeature | Bilaterally agreed mechanism to describe specific product and service information to the Seller as defined by the Airline. | O |
OrderServiceAssociation | Order Service Association. | M |
CodesetNameCode | Defines the codeset that is being used in each entry to define the codeset code and the associated value text. | O |
ValueText | The textural description associated to the codeset code for a given defined codeset. | O |
SeatOnLeg | A sitting place for a passenger or crew in a cabin compartment on a Dated Operating Leg. | M |
Seat | A sitting place for a passenger or crew in a cabin compartment on a transport vehicle. | M |
ColumnID | Alphabetic character identifying a seat within a row. | M |
RowNumber | Ordinal number identifying a seat row in an aircraft. | M |
SeatAssignmentAssociations | Seat Assignment Associations. | M |
ServiceDefinitionRef | Airline specific definition of a product or service that can be separately sold and delivered. | M |
OrderFlightAssociations | Order Service Definition Ref Flight Associations. | O |
ServiceDefinitionRefID | References a Service Definition ID. | M |
PaxSegmentRef | Reference to a PaxSegmentID. | M |
PaxSegmentRefID | Reference to a PaxSegmentID. | M |
PaxRefID | Reference to a Passenger ID. | M |
ServiceID | Uniquely Identifies a Service. | M |
StatusCode | Status of the Order Status instance. | O |
<TotalPrice> | ||
XML Example for the following elements <!--1 or more repetitions:--> | ||
Elements | Details | Mandatory/Optional |
TotalPrice | The amount of money expected, required, or given in payment for something. | O |
TotalAmount | Total monetary price amount, including all tax, surcharge, and fee amounts. | O |
 | ||
<TicketDocInfo> | ||
Elements | Details | Mandatory/Optional |
TicketDocInfo | Information corresponding to a group of 1 to 4Â | O |
BookletQty | Number of booklets issued for a given ticket/ document set. | O |
<OriginalIssueInfo> | ||
Elements | Details | Mandatory/Optional |
XML Example for the following elements <ns2:OriginalIssueInfo> | ||
Elements | Details | Mandatory/Optional |
OriginalIssueInfo | An Original issuing carrier and issuing location and ticket number. | O |
IssueDate | The date that the document was originally issued. | O |
IssuingCarrier | The organization which carries the passenger, baggage, or goods, and/or commits to delivering the carriage as well as any related services | M |
<TicketDocInfo> | ||
Elements | Details | Mandatory/Optional |
XML Example for the following elements <ns2:Ticket> | ||
Elements | Details | Mandatory/Optional |
Ticket | The accountable document issued by or on behalf of a carrier which includes notices and the flight and passenger coupons contained therein. | O |
Coupon | The portion of the Passenger Ticket and Baggage Check or Excess Baggage Ticket that indicates particular places between which the coupon is good for carriage. | M |
BaggageAllowanceRefID | Reference to a BaggageAllowanceID | O |
CouponNumber | Number assigned to the issued coupon. | M |
CouponStatusCode | Current status of the flight/ value coupon. | O |
CouponValidityPeriod | Date range a coupon is valid for with an optional time component. | O |
EffectiveDate | Start date for when a coupon is valid. | O |
ExpirationDate | End date for when a coupon is valid. | O |
ResChangeInfo | Reservation change information which describes new flight information as it relates to a changed reservation. | O |
ResStatusCode | This field contains the Reservation Status Code of the 'Reservation Change' flight. | M |
SoldAirlineInfo | Reference to a PaxSegmentID's - 1 or more pax segments references. | O |
PaxSegmentRefID | Reference to a PaxSegmentID | M |
PrimaryDocInd | When TRUE, this is the primary ticket/document number. | O |
ReportingTypeCode | For billing and settlement purposes, each time a travel agent requests an airline to perform an action on a document | M |
TicketDocTypeCode | Document type code as defined by PADIS 1001Â | O |
TicketNumber | The document number comprised of the airline code, form code, and serial number. | O |
 |  |  |
<PaymentFunctions> | ||
Elements | Details | Mandatory/Optional |
PaymentFunctions | Information related to the settlement of a transaction through monetary or other compensations. | O |
<PaymentProcessingSummary> | Â | Â |
XML Example for the following elements <ns2:PaymentProcessingSummary> | ||
Elements | Details | Mandatory/Optional |
PaymentProcessingSummary | Information relating to a payment transaction including payment status. | O |
Amount | The amount applied to the associated payment method. | M |
PaymentCommitmentDateTime | The date when the Payment including information about amount and payment method is accepted by ORA to be enough to lead to successful payment. | O |
PaymentID | Uniquely identifies payment information. | M |
PaymentRefID | If creating the order after payment authorization it is a way of linking an order to an existing payment reference. | O |
PaymentStatusCode | Indicates the current status of this payment information. | O |
<PaymentSupportedMethod> | Â | Â |
XML Example for the following elements <ns2:PaymentSupportedMethod> | ||
PaymentSupportedMethod | Contains information relating to payment method acceptance. | O |
PaymentTypeCode | A Payment Type code assigned according to ATS Codeset PAYT | M |