1. Disclaimer
This document is confidential and for the sole use of the company to whom it was issued. Any transmission of this document to third parties remains subject to Oman Air (hereinafter referred to as Oman) or TP Connects Technologies LLC (hereinafter referred to as TPConnects) prior approval.
The NDC Standard enhances the capability of communications between airlines and travel agents and brings lower cost, innovation, ease of comparison and interoperability. TPConnects, working with Oman as an NDC service provider, has integrated directly to the airline’s NDC APIs with a b2b reseller platform and Internet Booking Engine for Online Travel Agencies and NDC APIs. Travel Agents using the NDC APIs will be able to access the airlines’ offerings directly including ancillary products and perform after sales service like refund, change of date and flight etc. Moreover, travel agents will have the ability to offer personalized products benefiting the end consumers. With this direct connect integration travel agents will be able to access rich content that includes videos, pictures and personalized preferences as well.
Please note that this document is for information only and does not necessarily imply that Oman will be allowing the reader to access its Application Program Interfaces (API). All information on how to get access to the APIs can be found on support@tpconnects.com
As Oman implements new products and features following International Air transport Associations (IATA) New Distribution Capability (NDC), this document will be updated. Oman will keep its users informed of any significant change to the product, and the latest version of this user guide can always be provided upon request from support@tpconnects.com
In no circumstances shall Oman have any liability for losses (whether direct or indirect) arising from the participation in this trial, implementation or for any inaccuracies, errors in, or omissions from this document.
2. Introduction
The AirShopping Webservice provides IATA Accredited Travel Agents, new retailers and Service Providers the ability to shop (availability) for flights as per IATA NDC schema standards.
AirShopping – this service returns priced availability for the requested origin and destination, date and cabin.
3. Sequence Diagram
4. Implementation
This section describes the implementation of the input message based on the NDC schema version 18.2.
4.1. Request Parameters
4.1.1. MessageDoc Attributes
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Description |
| MessageDoc | 1 | o | Message document information. | |
| Name | 0..1 | MessageDoc/Name | o | Implementation Name.
Example: ThisAirline Gateway |
| RefVersionNumber | 0..1 | o | Framework Version. Example: SOAP 2015.1 |
| <iata:MessageDoc>
<iata:Name>NDC</iata:Name> <iata:RefVersionNumber>18.2</iata:RefVersionNumber> </iata:MessageDoc> |
4.1.2. Party
NDC Message/ Transaction Party(s) information.
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Description |
| Party | M | Party Information | ||
| Sender | 1 | Party/Sender | Message Sender Information | |
| TravelAgency | 1 | Party/Sender/TravelAgency | A private retailer or public service that provides travel and tourism related services to the public on behalf of suppliers such as airline activities. | |
| AgencyId | 1 | Party/Sender/TravelAgency/AgencyId | M | Unique Agency Seller ID.
Example: CTRV |
| IATANumber | 0..1 | Party/Sender/TravelAgency/IATANumber | O | IATA-assigned agency number. Example: 98417900 |
| Name | 0..1 | Party/Sender/TravelAgency/Name | N | Agency name. Example: Carson Travel |
| PseudoCityID | 0..1 | Party/Sender/TravelAgency/ PseudoCityID | N | An identifier for a corporate user of a computer reservation system (CRS) or global distribution system (GDS), typically a travel agency. Also known as Office ID. |
| TravelAgent | 0..1 | Party/Sender/TravelAgency/TravelAgent | N | Individual agent who solicits and procures business from potential customers on behalf of one or more principals, usually against payment of a percentage of the realized sales revenue as commission. |
| TravelAgentId | Party/Sender/TravelAgency/TravelAgent/TravelAgentId | Y | Booking and Servicing Agent information ID. Example: 98417900
Note: The ID correlates to the specified ID Type. |
|
| TypeCode | Party/Sender/TravelAgency/TravelAgent/TypeCode | N | Agency/ Agent Identification Type. Example: B – Booking Agent | |
| TypeCode | 0 | Party/Sender/TravelAgency/TypeCode | N | Agency type code. Examples TravelAgency, OnlineTravelAgency, or TravelManagementCompany. |
|
<iata:Party> <iata:Sender> <iata:TravelAgency> <iata:AgencyID>MCT1234567</iata:AgencyID> <iata:IATANumber>12345678</iata:IATANumber> <iata:Name>ABCD TOURISM and TRAVELS</iata:Name> <iata:PseudoCityID>GCCT</iata:PseudoCityID> <iata:TravelAgent> <iata:TravelAgentID>12345678-212</iata:TravelAgentID> </iata:TravelAgent> </iata:TravelAgency> </iata:Sender> </iatParty>
|
4.1.3. Passengers
This structure provides the information on how many travelers of a given PTC are to be considered for the search.
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Description |
| Paxs | Passenger and Passenger Group information. | |||
| Passenger | 1..n | Paxs/Pax | Y | Any person except members of the crew carried or to be carried with the consent of the carrier, on board of any transport vehicle such as aircraft. Holds the attributes specific to a one booking, from shopping to |
| PassengerID | 1 | Paxs/Pax/PaxID | Y | Uniquely identifies a Passenger within the context of one message. |
| PassengerType | 0..1 | Paxs/Pax/PTC | N | Type code applying to the Passenger which typically drives pricing (e.g. ADT, CHD, etc). |
| <iata:Paxs>
<iata:Pax> <iata:PaxID>PAX1</iata:PaxID> <iata:PTC>ADT</iata:PTC> </iata:Pax> <iata:Pax> <iata:PaxID>PAX2</iata:PaxID> <iata:PTC>ADT</iata:PTC> </iata:Pax> <iata:Pax> <iata:PaxID>PAX3</iata:PaxID> <iata:PTC>CHD</iata:PTC> </iata:Pax> </iata:Paxs> |
4.1.4. Flight Criteria (Origin & Destination)
This section describes on which itinerary (from/to which location) and dates the client is looking for travel solutions.
The departure/arrival location can be either Airport code or City code. If Airport code is requested, the searching focuses on the specific search. However, if City code is requested, the system searches among all available airports of the city. Both are located in the same field.
On top of the specific departure date, the client can specify a date range, by defining how many days before and days after is he willing to travel. The maximum date range the user is able to request is +/-7 days (date range equals to 15 days) for OneWay and +/-3 days (date range equals to 7 days) for each bound in RoundTrip requests.
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Description |
| FlightCriteria | 1..n | Y | Choice of Affinity, Origin Destination, or Journey flight information for this shopping request. | |
| OriginDestCriteria | Request/FlightCriteria/ OriginDestCriteria | N | The Origin and Destination airport/city pair which confines a passenger journey or an aircraft flight. | |
| DestArrivalCriteria | 1 | Request/FlightCriteria/ DestArrivalCriteria | Y | A Customer’s requested Destination arrival time and location. |
| IATALocationCode | 0..1 | Request/FlightCriteria/ DestArrivalCriteria/ IATALocationCode | Y | IATA defined code identifying a city or station. |
| OriginDepCriteria | 1 | Request/FlightCriteria/ OriginDestCriteria/ OriginDepCriteria | Y | A Customer’s requested Origin departure time and location. |
| Date | 1 | Request/FlightCriteria/ OriginDestCriteria/ OriginDepCriteria/Date | Y | The customer’s requested departure date. |
| IATALocationCode | 1 | Request/FlightCriteria/ OriginDestCriteria/ OriginDepCriteria/ IATALocationCode | Y | IATA defined code identifying a city or station. |
| <iata:FlightCriteria>
<iata:OriginDestCriteria> <iata:DestArrivalCriteria> <iata:IATALocationCode>DXB</iata:IATALocationCode> </iata:DestArrivalCriteria> <iata:OriginDepCriteria> <iata:Date>2019-02-15</iata:Date> <iata:IATALocationCode>MCT</iata:IATALocationCode> </iata:OriginDepCriteria> </iata:OriginDestCriteria> <iata:OriginDestCriteria> <iata:DestArrivalCriteria> <iata:IATALocationCode>MCT</iata:IATALocationCode> </iata:DestArrivalCriteria> <iata:OriginDepCriteria> <iata:Date>2019-02-25</iata:Date> <iata:IATALocationCode>DXB</iata:IATALocationCode> </iata:OriginDepCriteria> </iata:OriginDestCriteria> </iata:FlightCriteria>
|
4.1.5. ShoppingCriteria
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Description |
| ShoppingCriteria | 0..1 | Y | Further qualifies the flight request by influencing which results are returned in the shopping response, including preferred or required criteria. | |
| CabinTypeCriteria | 0..n | Request/ ShoppingCriteria / CabinTypeCriteria | N | Type of compartment of an aircraft, offering specific services (e.g. business class, economy). |
| CabinTypeCode | 0..1 | Request/ ShoppingCriteria / CabinTypeCriteria/ CabinTypeCode | N | Cabin Type Code as defined by PADIS codeset (e.g. 1, 2, 3, etc.) |
| CabinTypeName | 0..1 | Request/ ShoppingCriteria / CabinTypeCriteria/ CabinTypeName | N | Name given to a cabin compartment (e.g. Business, First, Economy). |
|
<iata:ShoppingCriteria> <iata:CabinTypeCriteria> <iata:CabinTypeCode>Y</iata:CabinTypeCode> <iata:CabinTypeName>Economy</iata:CabinTypeName> </iata:CabinTypeCriteria> </iata:ShoppingCriteria>
|
4.2. Response Parameters
4.2.1. Payload Attributes
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Description |
| PayloadAttributes | 0..1 | Y | IATA standard payload attributes. | |
| EchoTokenText | 0..1 | PayloadAttributes / EchoTokenText | 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. | |
| VersionNumber | 1 | PayloadAttributes / VersionNumber | For all IATA versioned messages, the version of the message is indicated by a decimal value. |
|
<ns4:PayloadAttributes> <ns4:EchoTokenText>d1dsnn3c16-690-4c3c-b08-9d71e7e42156</ns4:EchoTokenText> <ns4:VersionNumber>18.2</ns4:VersionNumber> </ns4:PayloadAttributes> |
4.2.2. DataLists
4.2.2.1. OriginDestList
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Description |
| DataLists | 0..1 | N | Data List definition for this message. | |
| OriginDestList | 1..n | DataLists/OriginDestList | N | Origin Destination data list definition. |
| OriginDest | 1..n | DataLists/OriginDestList/ OriginDest | The Origin and Destination airport/city pair which confines a passenger journey or an aircraft flight. | |
| DestCode | 1 | DataLists/OriginDestList/ OriginDest /DestCode | Y | IATA defined code identifying a city or station. |
| OriginCode | 1 | DataLists/OriginDestList/ OriginDest /OriginDestList | Y | IATA defined code identifying a city or station. |
| OriginDestID | 0..1 | N | Uniquely identifies an Origin Destination within the context of one message. | |
| PaxJourneyRefID | 0..n | N | Uniquely identifies a Passenger Journey within the context of one message. |
| <ns4:OriginDestList>
<ns4:OriginDest> <ns4:DestCode>DXB</ns4:DestCode> <ns4:OriginCode>MCT</ns4:OriginCode> <ns4:OriginDestID>MCTDXB-1</ns4:OriginDestID> <ns4:PaxJourneyRefID>WY-WY613-1</ns4:PaxJourneyRefID> <ns4:PaxJourneyRefID>WY-WY603-2</ns4:PaxJourneyRefID> <ns4:PaxJourneyRefID>WY-WY607-3</ns4:PaxJourneyRefID> <ns4:PaxJourneyRefID>WY-WY609-4</ns4:PaxJourneyRefID> <ns4:PaxJourneyRefID>WY-WY623-5</ns4:PaxJourneyRefID> <ns4:PaxJourneyRefID>WY-WY611-6</ns4:PaxJourneyRefID> <ns4:PaxJourneyRefID>WY-WY601-7</ns4:PaxJourneyRefID> </ns4:OriginDest> <ns4:OriginDest> <ns4:DestCode>MCT</ns4:DestCode> <ns4:OriginCode>DXB</ns4:OriginCode> <ns4:OriginDestID>DXBMCT-2</ns4:OriginDestID> <ns4:PaxJourneyRefID>WY-WY610-8</ns4:PaxJourneyRefID> <ns4:PaxJourneyRefID>WY-WY608-9</ns4:PaxJourneyRefID> <ns4:PaxJourneyRefID>WY-WY612-10</ns4:PaxJourneyRefID> <ns4:PaxJourneyRefID>WY-WY614-11</ns4:PaxJourneyRefID> <ns4:PaxJourneyRefID>WY-WY602-12</ns4:PaxJourneyRefID> <ns4:PaxJourneyRefID>WY-WY604-13</ns4:PaxJourneyRefID> <ns4:PaxJourneyRefID>WY-WY606-14</ns4:PaxJourneyRefID> </ns4:OriginDest> </ns4:OriginDestList>
|
4.2.2.2. PaxJourneyList
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Description |
| PaxJourneyList | 0..1 | N | Journey data list definition. | |
| PaxJourney | 1..n | DataLists/ PaxJourneyList/ PaxJourney | Y | A collection of segments which satisfies transportation of a passenger for a given origin and destination. |
| Duration | 0..1 | DataLists/ PaxJourneyList/ PaxJourney/Duration | N | Total journey time including the combined air time and connection times. In case of stopover, this may or may not include stopover durations. |
| PaxJourneyID | 0..1 | DataLists/ PaxJourneyList/ PaxJourney/PaxJourneyID | N | Uniquely identifies a Passenger Journey within the context of one message. |
| PaxSegmentRefID | 1..n | DataLists/ PaxJourneyList/ PaxJourney/PaxSegmentRefID | Y | Reference to a Passenger Segment ID within this message. |
| <ns4:PaxJourneyList>
<ns4:PaxJourney> <ns4:Duration>PT1H10M</ns4:Duration> <ns4:PaxJourneyID>WY-WY613-1</ns4:PaxJourneyID> <ns4:PaxSegmentRefID>WY-WY613-WY613-2019021521-2019021522</ns4:PaxSegmentRefID> </ns4:PaxJourney> <ns4:PaxJourney> <ns4:Duration>PT1H5M</ns4:Duration> <ns4:PaxJourneyID>WY-WY603-2</ns4:PaxJourneyID> <ns4:PaxSegmentRefID>WY-WY603-WY603-2019021508-2019021509</ns4:PaxSegmentRefID> </ns4:PaxJourney> <ns4:PaxJourney> <ns4:Duration>PT1H5M</ns4:Duration> <ns4:PaxJourneyID>WY-WY607-3</ns4:PaxJourneyID> <ns4:PaxSegmentRefID>WY-WY607-WY607-2019021517-2019021518</ns4:PaxSegmentRefID> </ns4:PaxJourney> <ns4:PaxJourney> <ns4:Duration>PT1H15M</ns4:Duration> <ns4:PaxJourneyID>WY-WY609-4</ns4:PaxJourneyID> <ns4:PaxSegmentRefID>WY-WY609-WY609-2019021514-2019021515</ns4:PaxSegmentRefID> </ns4:PaxJourney> </ns4:PaxJourneyList>
|
4.2.2.3. PaxList
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Description |
| PaxList | 0..1 | Passenger data list definition. | ||
| Passenger | 1..n | Pax | Y | Any person except members of the crew carried or to be carried with the consent of the carrier, on board of any transport vehicle such as aircraft, train, bus, ship. Holds the attributes specific to a one booking, from shopping to f |
| PassengerID | 1 | Pax/PaxID | Y | Uniquely identifies a Passenger within the context of one message. |
| PassengerType | 1..n | Pax/PTC | N | Type code applying to the Passenger which typically drives pricing (e.g. ADT, CHD, etc). |
|
<ns4:PaxList> <ns4:Pax> <ns4:PaxID>PAX1</ns4:PaxID> <ns4:PTC>ADT</ns4:PTC> </ns4:Pax> <ns4:Pax> <ns4:PaxID>PAX2</ns4:PaxID> <ns4:PTC>ADT</ns4:PTC> </ns4:Pax> <ns4:Pax> <ns4:PaxID>PAX3</ns4:PaxID> <ns4:PTC>CHD</ns4:PTC> </ns4:Pax> </ns4:PaxList> |
4.2.2.4. PaxSegmentList
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Comments |
| PaxSegmentList | 0..1 | N | Segment data list definition. | |
| PaxSegment | 1..n | PaxSegmentList/ PaxSegment | Y | Transportation of a passenger on a Dated Operating Segment. |
| Arrival | 1 | PaxSegmentList/ PaxSegment /Arrival | Y | The action or process of arriving of a transport vehicle in any place or location. |
| AircraftScheduledDateTime | PaxSegmentList/ PaxSegment /Arrival/ AircraftScheduledDateTime | N | The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport. | |
| IATALocationCode | PaxSegmentList/ PaxSegment /Arrival/ IATALocationCode | N | IATA defined code identifying a city or station. | |
| TerminalName | PaxSegmentList/ PaxSegment/Arrival/ TerminalName | N | The name of the terminal. | |
| DatedOperatingLeg | 1 | PaxSegmentList/ PaxSegment/ DatedOperatingLeg | N | The nonstop operation of a transport vehicle between the departure station and the arrival station. Can be used for aircrafts as well as other transport vehicles such as train or bus etc. |
| CarrierAircraftType | 0..1 | PaxSegmentList/ PaxSegment/ CarrierAircraftType | N | Carrier defined internal grouping of aircrafts with the same form, function and specification. |
| CarrierAircraftTypeCode | 0..1 | PaxSegmentList/ PaxSegment/ CarrierAircraftType/ CarrierAircraftTypeCode | N | Internal code used by an carrier to identify the type of aircraft. |
| Dep | PaxSegmentList/ PaxSegment/Dep | Y | The action or process of leaving of a transport vehicle from any place or location. | |
| AircraftScheduledDateTime | PaxSegmentList/ PaxSegment/Dep/ AircraftScheduledDateTime | N | The Scheduled Date and Time of Departure of the aircraft at the terminal or departure gate at an airport. | |
| IATALocationCode | PaxSegmentList/ PaxSegment/Dep/ IATALocationCode | N | IATA defined code identifying a city or station. | |
| Duration | PaxSegmentList/ PaxSegment/Duration | N | Total segment time including the combined air time and connection times of any legs. | |
| MarketingCarrierInfo | PaxSegmentList/ PaxSegment/ MarketingCarrierInfo | Y | The commercial designation under which a Dated Operating Segment can be booked, either under the operating carrier’s designator or that of another carrier (codeshare). | |
| CarrierDesigCode | PaxSegmentList/ PaxSegment/ MarketingCarrierInfo/ CarrierDesigCode | Y | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. | |
| MarketingCarrierFlightNumberText | PaxSegmentList/ PaxSegment/ MarketingCarrierInfo/ MarketingCarrierFlightNumberText | Y | The numerical designation of a flight as it is marketed by a carrier. | |
| OperatingCarrierInfo | PaxSegmentList/ PaxSegment/ OperatingCarrierInfo | N | An operation between board point and any subsequent off point within the same flight designator. Could be one or more legs. Could also be used for other transport vehicles such as train or bus etc. | |
| CarrierDesigCode | PaxSegmentList/ PaxSegment/ OperatingCarrierInfo/ CarrierDesigCode | N | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. | |
| OperatingCarrierFlightNumberText | PaxSegmentList/ PaxSegment/ OperatingCarrierInfo/ OperatingCarrierFlightNumberText | N | The numerical designation of a flight as it is marketed by a carrier. | |
| PaxSegmentID | PaxSegmentList/ PaxSegment/PaxSegmentID | Y | Uniquely identifies a Passenger Segment within the context of one message. | |
| SecureFlightInd | PaxSegmentList/ PaxSegment/ SecureFlightInd | N | When TRUE, this segment is subject to US TSA ‘Secure Flight’ passenger prescreening program. | |
| SegmentTypeCode | PaxSegmentList/ PaxSegment/ SegmentTypeCode | N | Defines the operational flight segment type (e.g. Open, Passive, Service). Encoding Scheme: IATA PADIS 1.4 Codeset FST – Flight Segment Type |
| <ns4:PaxSegmentList>
<ns4:PaxSegment> <ns4:Arrival> <ns4:AircraftScheduledDateTime>2019-02-15T22:25:00.000</ns4:AircraftScheduledDateTime> <ns4:IATALocationCode>DXB</ns4:IATALocationCode> <ns4:TerminalName>1</ns4:TerminalName> </ns4:Arrival> <ns4:DatedOperatingLeg> <ns4:CarrierAircraftType> <ns4:CarrierAircraftTypeCode>738</ns4:CarrierAircraftTypeCode> </ns4:CarrierAircraftType> </ns4:DatedOperatingLeg> <ns4:Dep> <ns4:AircraftScheduledDateTime>2019-02-15T21:15:00.000</ns4:AircraftScheduledDateTime> <ns4:IATALocationCode>MCT</ns4:IATALocationCode> </ns4:Dep> <ns4:Duration>PT1H10M</ns4:Duration> <ns4:MarketingCarrierInfo> <ns4:CarrierDesigCode>WY</ns4:CarrierDesigCode> <ns4:MarketingCarrierFlightNumberText>613</ns4:MarketingCarrierFlightNumberText> </ns4:MarketingCarrierInfo> <ns4:OperatingCarrierInfo> <ns4:CarrierDesigCode>WY</ns4:CarrierDesigCode> <ns4:OperatingCarrierFlightNumberText>613</ns4:OperatingCarrierFlightNumberText> </ns4:OperatingCarrierInfo> <ns4:PaxSegmentID>WY-WY613-WY613-2019021521-2019021522</ns4:PaxSegmentID> <ns4:SecureFlightInd>false</ns4:SecureFlightInd> <ns4:SegmentTypeCode>Open</ns4:SegmentTypeCode> </ns4:PaxSegment> … <ns4:PaxSegment> … </ns4:PaxSegment> </ns4:PaxSegmentList>
|
4.2.2.5. PriceClassList
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Comments |
| PriceClassList | 0..1 | PriceClassList | N | Price Class data list definition. |
| PriceClass | 1..n | PriceClassList/ PriceClass | Y | A price point within a particular Cabin Type (sometimes referred to as ‘Fare Families’). |
| Code | 0..1 | PriceClassList/PriceClass/ Code | N | Price class code. Example: 1, ABC |
| Name | 1 | PriceClassList/PriceClass/ Name | Y | Price class name. Example: SUPERSAVER |
| PriceClassID | 0..1 | PriceClassList/PriceClass/ PriceClassID | N | Uniquely Identifies a Price Class within the context of one message. |
| <ns4:PriceClassList>
<ns4:PriceClass> <ns4:Code>SE</ns4:Code> <ns4:Name>ECONOMY LITE</ns4:Name> <ns4:PriceClassID>ECONOMY LITE</ns4:PriceClassID> </ns4:PriceClass> … <ns4:PriceClass> … </ns4:PriceClass> </ns4:PriceClassList>
|
4.2.2.6. OffersGroup
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Comments |
| CarrierOffers | 1..n | OffersGroup/CarrierOffers | Y | Offers grouped by Carrier. |
| CarrierOffersSummary | 0..1 | OffersGroup/CarrierOffers/ CarrierOffersSummary | N | Offer summary that includes highest, lowest, and number of matched offers included in the response. |
| HighestOfferPrice | 0..1 | OffersGroup/CarrierOffers/ CarrierOffersSummary/ HighestOfferPrice | N | The amount of money expected, required, or given in payment for something. |
| TotalAmount | 0..1 | OffersGroup/CarrierOffers/ CarrierOffersSummary/ HighestOfferPrice/ TotalAmount | N | |
| LowestOfferPrice | 0..1 | OffersGroup/CarrierOffers/ CarrierOffersSummary/ LowestOfferPrice | N | The amount of money expected, required, or given in payment for something. |
| TotalAmount | 0..1 | OffersGroup/CarrierOffers/ CarrierOffersSummary/ LowestOfferPrice/ TotalAmount | N | |
| MatchedOfferQty | 0..1 | OffersGroup/CarrierOffers/ CarrierOffersSummary/ MatchedOfferQty | N |
| <ns4:CarrierOffersSummary>
<ns4:HighestOfferPrice> <ns4:TotalAmount CurCode=”OMR”>218.900</ns4:TotalAmount> </ns4:HighestOfferPrice> <ns4:LowestOfferPrice> <ns4:TotalAmount CurCode=”OMR”>137.100</ns4:TotalAmount> </ns4:LowestOfferPrice> <ns4:MatchedOfferQty>28</ns4:MatchedOfferQty> </ns4:CarrierOffersSummary> |
4.2.2.7. CarrierOffers
2.2.2.7.1 Offer/JourneyOverview
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Comments | |
| JourneyOverview | 0 | CarrierOffers/Offer/ JourneyOverview
|
N | Summary of proposed Journey information in the context of this specific Offer. | |
| JourneyPriceClass | 1..n | CarrierOffers/Offer/ JourneyOverview/ JourneyPriceClass
|
Y | Price class information per Journey. | |
| PaxJourneyRefID | 1 | CarrierOffers/Offer/ JourneyOverview/ JourneyPriceClass/ PaxJourneyRefID
|
Y | Reference to a Passenger Journey ID within this message. | |
| PriceClassRefID | 0 | CarrierOffers/Offer/ JourneyOverview/ PriceClassRefID
|
N | Reference to a PriceClassID within this message. | |
| OfferID | 1 | Offer/OfferID | Y | Carrier assigned ID which uniquely identifies a specific Offer across several messages. |
| <ns4:Offer>
<ns4:JourneyOverview> <ns4:JourneyPriceClass> <ns4:PaxJourneyRefID>WY-WY613-1</ns4:PaxJourneyRefID> </ns4:JourneyPriceClass> <ns4:PriceClassRefID>ECONOMY LITE</ns4:PriceClassRefID> </ns4:JourneyOverview> <ns4:OfferID>WY-OFFER-1</ns4:OfferID> <ns4:OfferItem> …… </ ns4:OfferItem> ….. </ns4:Offer>
|
4.2.2.7.2. OfferItem
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Comments |
| OfferItem | Offer/OfferItem | A priced grouping of one or more services within an Offer. |
4.2.2.7.2.1. FareDetail
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Comments |
| FareDetail | Offer/OfferItem/FareDetail | The amount charged by the carrier for the carriage of a passenger and his allowable free baggage. |
4.2.2.7.2.1.1. FareComponent
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Comments |
| FareDetail | Offer/OfferItem/FareDetail | The amount charged by the carrier for the carriage of a passenger and his allowable free baggage. | ||
| FareComponent | Offer/OfferItem/FareDetail/ FareComponent | A portion of an itinerary between two consecutive fare construction points. If the journey has only one fare component, the points of origin and destination are the only fare construction points | ||
| FareBasisCityPairText | Offer/OfferItem/FareDetail/ FareComponent/ FareBasisCityPairText | Identified published fare. Origin and destination city codes and two character designator of fare owning airline associated with Fare Basis Code. Example: MIANCEDL | ||
| FareBasisCode | Offer/OfferItem/FareDetail/ FareComponent/ FareBasisCode | Fare basis code. Example: Y26 | ||
| PaxSegmentRefID | Offer/OfferItem/FareDetail/ FareComponent/ PaxSegmentRefID | Reference to a Pax Segment ID. | ||
| RBD | Offer/OfferItem/FareDetail/ FareComponent/RBD | Reservation Booking Designator. A categorization used to facilitate access to inventory, application of filed fares, and to identify cabin entitlement. Identified using a single alpha character. E.g. ‘J’ for Business Class Premium, ‘D’ for Business Disc | ||
| RBDCode | Offer/OfferItem/FareDetail/ FareComponent/RBD/ RBDCode | Code used to identify a particular RBD (e.g. P, J, W, M, etc.). |
| <ns4:FareDetail>
<ns4:FareComponent> <ns4:FareBasisCityPairText>MCTDXB</ns4:FareBasisCityPairText> <ns4:FareBasisCode>OSE3MOM</ns4:FareBasisCode> <ns4:PaxSegmentRefID>WY-WY613-WY613-2019-</ns4:PaxSegmentRefID> <ns4:RBD> <ns4:RBDCode>O</ns4:RBDCode> </ns4:RBD> </ns4:FareComponent> <ns4:FarePriceType> … <ns4:Price> … </ns4:Price> … </ns4:FarePriceType> </s4:FareDetail>
|
4.2.2.7.2.1.2. FarePriceType
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Comments |
| FarePriceType | Offer/OfferItem/FareDetail/ FarePriceType | The type of fair price applied to a Fare Detail (e.g. filed amount, net amount, or a sell amount). | ||
| FarePriceTypeCode | Offer/OfferItem/FareDetail/ FarePriceType/ FarePriceTypeCode | Indicates if the fare price provided is a filed amount, net amount, or a sell amount. | ||
| Price | Offer/OfferItem/FareDetail/ FarePriceType/Price | The amount of money expected, required, or given in payment for something. | ||
| BaseAmount | Offer/OfferItem/FareDetail/ FarePriceType/Price/ BaseAmount | Total Base Fare Amount. Example: 200000 | ||
| TaxSummary | Offer/OfferItem/FareDetail/ FarePriceType/Price/ BaseAmount/TaxSummary | The sum of all tax amounts applied on a given price. | ||
| Tax | Offer/OfferItem/FareDetail/ FarePriceType/Price/ BaseAmount/TaxSummary/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. | ||
| Amount | Offer/OfferItem/FareDetail/ FarePriceType/Price/ BaseAmount/TaxSummary/Tax/Amount | Tax amount. Example: 15000 USD | ||
| TaxCode | Offer/OfferItem/FareDetail/ FarePriceType/Price/ BaseAmount/TaxSummary/Tax/TaxCode | IATA TTBS Tax Code. Example: AY, GB | ||
| TotalTaxAmount | Offer/OfferItem/FareDetail/ FarePriceType/Price/ BaseAmount/TaxSummary/ 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. | ||
| TotalAmount | Offer/OfferItem/FareDetail/ FarePriceType/Price/ TotalAmount | Total monetary price amount, including all tax, surcharge, and fee amounts. | ||
| OfferItemID | Offer/OfferItem/FareDetail/ OfferItemID | Carrier assigned ID which exists uniquely within an Offer. |
| <Offer>
… <ns4:FareDetail> <ns4:FareComponent> … </ns4:FareComponent> <ns4:FarePriceType> <ns4:FarePriceTypeCode>filed amount</ns4:FarePriceTypeCode> <ns4:Price> <ns4:BaseAmount CurCode=”OMR”>26.000</ns4:BaseAmount> <ns4:TaxSummary> <ns4:Tax> <ns4:Amount CurCode=”OMR”>9.500</ns4:Amount> <ns4:TaxCode>YQF</ns4:TaxCode> </ns4:Tax> … <ns4:Tax> … </ns4:Tax> <ns4:TotalTaxAmount CurCode=”OMR”>21.700</ns4:TotalTaxAmount> </ns4:TaxSummary> <ns4:TotalAmount CurCode=”OMR”>47.700</ns4:TotalAmount> </ns4:Price> </ns4:FarePriceType> </ns4:FareDetail> <ns4:OfferItemID>WY-OFFERITEM-1</ns4:OfferItemID> <ns4:Price> … </ns4:Price> <ns4:Service> …
</ns4:Service> … </Offer>
|
4.2.2.7.2.1.3. Price
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Comments |
| Price | 1 | Offer/OfferItem/Price | Y | The amount of money expected, required, or given in payment for something. |
| BaseAmount | 0..1 | Offer/OfferItem/Price/ BaseAmount | N | Total Base Fare Amount. Example: 200000 |
| TaxSummary | 0..n | Offer/OfferItem/Price/TaxSummary | N | The sum of all tax amounts applied on a given price. |
| Tax | 0..n | Offer/OfferItem/Price/TaxSummary/Tax | N | 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. |
| Amount | 1 | Offer/OfferItem/Price/TaxSummary/Tax/Amount | Y | Tax amount. Example: 15000 USD |
| TaxCode | 0..1 | Offer/OfferItem/Price/TaxSummary/Tax/TaxCode | N | IATA TTBS Tax Code. Example: AY, GB |
| TotalTaxAmount | 0..1 | Offer/OfferItem/Price/TaxSummary/TotalTaxAmount | N | 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. |
| TotalAmount | 0..1 | Offer/OfferItem/Price/TotalAmount | N | Total monetary price amount, including all tax, surcharge, and fee amounts. |
| <Offer>
… <ns4:FareDetail> <ns4:FareComponent> … </ns4:FareComponent> <ns4:FarePriceType> … </ns4:FarePriceType> </ns4:FareDetail> <ns4:OfferItemID>WY-OFFERITEM-1</ns4:OfferItemID> <ns4:Price> <ns4:BaseAmount CurCode=”OMR”>26.000</ns4:BaseAmount> <ns4:TaxSummary> <ns4:Tax> <ns4:Amount CurCode=”OMR”>9.500</ns4:Amount> <ns4:TaxCode>YQF</ns4:TaxCode> </ns4:Tax> <ns4:Tax> <ns4:Amount CurCode=”OMR”>0.600</ns4:Amount> <ns4:TaxCode>ZR</ns4:TaxCode> </ns4:Tax> <ns4:TotalTaxAmount CurCode=”OMR”>21.700</ns4:TotalTaxAmount> </ns4:TaxSummary> <ns4:TotalAmount CurCode=”OMR”>47.700</ns4:TotalAmount> </ns4:Price> <ns4:Service> … </ns4:Service> … </Offer>
|
4.2.2.7.2.1.4. Service and OfferParameters
| Field Type | Repetition | Schema Definition | Optional/Mandatory | Comments |
| PaxRefID | 0..n | Offer/OfferItem/Service/ PaxRefID | N | Reference to a Passenger ID within this message. The Passenger is the recipient entitled to receive/consume the Service(s) offered by the Airline, whether the Service(s) are flight-related or not. |
| ServiceAssociations | Offer/OfferItem/Service/ ServiceAssociations | Y | References to the details of this Service. May include either Passenger Journeys, a Service Definition, or a Selected Seat. | |
| PaxJourneyRefID | 0..n | Offer/OfferItem/Service/ ServiceAssociations/ PaxJourneyRefID | N | Reference to one Journey in the Datalists that are being sold as part of this OfferItem/Service. |
| ServiceID | 1 | Offer/OfferItem/Service/ ServiceID | Y | Service ID assigned by the carrier. |
| OwnerCode | 0..1 | Offer/ OwnerCode | Y | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. |
| PTC_OfferParameters | 0..n | Offer/PTC_OfferParameters | N | Passenger Type summary information for an offer. |
| PricedPaxNumber | .2.1.2 | Offer/PTC_OfferParameters/PricedPaxNumber | N | Number of Passenger(s) for associated passenger type. Example: 2 |
| PTC_PricedCode | Offer/PTC_OfferParameters/PTC_PricedCode | N | Actual passenger type code used for pricing. Example: ADT | |
| TotalPrice | Offer/TotalPrice | N | The amount of money expected, required, or given in payment for something. | |
| BaseAmount | Offer/TotalPrice/BaseAmount | N | Total Base Fare Amount. Example: 200000 | |
| TaxSummary | Offer/TotalPrice/ TaxSummary | N | The sum of all tax amounts applied on a given price. | |
| Tax | Offer/TotalPrice/ TaxSummary/Tax | N | 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. | |
| Amount | Offer/TotalPrice/ TaxSummary/Tax/Amount | Y | Tax amount. Example: 15000 USD | |
| TaxCode | Offer/TotalPrice/ TaxSummary/Tax/TaxCode | N | IATA TTBS Tax Code. Example: AY, GB | |
| TotalTaxAmount | Offer/TotalPrice/ TaxSummary/ TotalTaxAmount | N | 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. | |
| TotalAmount | Offer/TotalPrice/TotalAmount | N | Total monetary price amount, including all tax, surcharge, and fee amounts. | |
| ValidatingCarrierCode | Offer/ValidatingCarrierCode | N | Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. |
| <ns4:CarrierOffers>
… <ns4:Offer> … <ns4:Service> <ns4:PaxRefID>PAX3</ns4:PaxRefID> <ns4:ServiceAssociations> <ns4:PaxJourneyRefID>WY-WY606-14</ns4:PaxJourneyRefID> </ns4:ServiceAssociations> <ns4:ServiceID>SERVICE-CHD</ns4:ServiceID> </ns4:Service> </ns4:OfferItem> <ns4:OwnerCode>WY</ns4:OwnerCode> <ns4:PTC_OfferParameters> <ns4:PricedPaxNumber>2</ns4:PricedPaxNumber> <ns4:PTC_PricedCode>ADT</ns4:PTC_PricedCode> </ns4:PTC_OfferParameters> <ns4:PTC_OfferParameters> <ns4:PricedPaxNumber>1</ns4:PricedPaxNumber> <ns4:PTC_PricedCode>CHD</ns4:PTC_PricedCode> </ns4:PTC_OfferParameters> <ns4:TotalPrice> <ns4:BaseAmount CurCode=”OMR”>341.000</ns4:BaseAmount> <ns4:TaxSummary> <ns4:Tax> <ns4:Amount CurCode=”OMR”>105.900</ns4:Amount> <ns4:TaxCode>TOTALTAX</ns4:TaxCode> </ns4:Tax> <ns4:TotalTaxAmount CurCode=”OMR”>105.900</ns4:TotalTaxAmount> </ns4:TaxSummary> <ns4:TotalAmount CurCode=”OMR”>446.900</ns4:TotalAmount> </ns4:TotalPrice> <ns4:ValidatingCarrierCode>WY</ns4:ValidatingCarrierCode> … </ns4:Offer> … </ns4:CarrierOffers> |