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

Compare with Current View Page History

« Previous Version 16 Next »

Table of contents:

Check out

Parameters

Main. 
/Envelope /Body /AirShoppingRS

#DescriptionMandMultDefaultRef/FormatxPathExample
1NDC API version
(error)

@Version
 <AirShoppingRS Version="2.000">
2List of airline offers
(tick)
AirlineOfferOffersGroup /AirlineOffers /AirlineOffer

3Travelers information
(tick)
AnonymousTravelerDataLists /AnonymousTravelerList

4Carry on allowance information
(tick)
CarryOnAllowanceDataLists /CarryOnAllowanceList
5Checked bag allowance information
(tick)
CheckedBagAllowanceDataLists /CheckedBagAllowanceList
6Flight segments informarion
(tick)
FlightSegmentDataLists /FlightSegmentList
7Journey details
(tick)
OriginDestinationDataLists /OriginDestinationList
8Media information
(tick)
MediaDataLists /MediaList
9Penalty information
(tick)
PenaltyDetailDataLists /PenaltyList
10Information about services

(tick)
ServiceDataLists /ServiceList

11Information about advanced search options

(tick)
MetadataMetadata

AirlineOffer (OF).
/Envelope /Body /AirShoppingRS /OffersGroup /AirlineOffers /AirlineOffer

#DescriptionMandMultDefaultRef/FormatxPathExample
1ID
(error)
OF1OfferID
<OfferID Owner="S7">OF1</OfferID>
2AirlineOffer owner
(error)
S7OfferID /@Owner
<OfferID Owner="S7">OF1</OfferID>
3Total price for all itinerary (including all slices and passengers)

(error)

TotalPrice /DetailCurrencyPrice /Total
<Total Code="RUB">54407</Total>
4Total price currency code

(error)
Currency codeTotalPrice /DetailCurrencyPrice /Total /@Code
<Total Code="RUB">54407</Total>
5Total fare for all itinerary (including all slices and passengers)
(error)

TotalPrice /DetailCurrencyPrice /Details /Detail[Application="Fare"] /SubTotal
<Detail>
  <SubTotal Code="RUB">44250</SubTotal>
  <Application>Fare</Application>
</Detail>
6Total fare currency code
(error)
Currency codeTotalPrice /DetailCurrencyPrice /Details /Detail[Application="Fare"] /SubTotal@Code
<Detail>
  <SubTotal Code="RUB">44250</SubTotal>
  <Application>Fare</Application>
</Detail>
7Total taxes for all itinerary (including all slices and passengers)
(error)

TotalPrice /DetailCurrencyPrice /Taxes /Total
<Taxes>
  <Total Code="RUB">4668</Total>
</Taxes
8Total taxes currency code
(error)
Currency codeTotalPrice /DetailCurrencyPrice /Taxes /Total@Code
<Taxes>
  <Total Code="RUB">4668</Total>
</Taxes
9AirlineOffer BrandedFares Type
(error)

Possible values:

  1. basicEconomy
  2. flexEconomy
  3. basicBusiness
  4. flexBusiness
Disclosure /Description /Text
<Disclosure>
  <Description>
    <Text>BASIC BUSINESS</Text>
  </Description>
</Disclosure>
10AirlineOffer details
(error)

PricedOffer

PricedOffer. 
/Envelope /Body /AirShoppingRS /OffersGroup /AirlineOffers /AirlineOffer /PricedOffer /OfferPrice (Multiple)

#DescriptionMandMultDefaultRef/FormatxPathExample
1Offer Price ID, where OfferPrice contains detailed information about a specific slice
(error)

Possible values:

  1. hash - for searching slice
  2. SELECTED+OfferID+SliceID - for previously selected slices
  3. PRESELECTED+OfferID+SliceID - for pre-selected cheapest solutions (for subsequent slices after the current)
@OfferItemID
<OfferPrice OfferItemID="1Fj0V55jpoN6hfHlDqfFOHRNx/0BdSbZeF7P2TPhhr4NuptT5/3i8yxAYbEmDLsK4gCj2wbS00F/1"> 
<OfferPrice OfferItemID="SELECTEDOF1SL2">
<OfferPrice OfferItemID="PRESELECTEDOF1SL3">
2Total price per slice (including all passengers)
(error)

RequestedDate /PriceDetail /TotalAmount /DetailCurrencyPrice /Total
<Total Code="RUB">54407</Total>
3Total price per slice currency code
(error)
Currency codeRequestedDate /PriceDetail /TotalAmount /DetailCurrencyPrice /Total /@Code
<Total Code="RUB">54407</Total>
4Total taxes per slice (including all passengers)
(error)

RequestedDate /PriceDetail /TotalAmount /DetailCurrencyPrice /Taxes /Total
<Taxes>
  <Total Code="RUB">4551</Total>
</Taxes>
5Total taxes per slice currency code
(error)
Currency codeRequestedDate /PriceDetail /TotalAmount /DetailCurrencyPrice /Taxes /Total /@Code
<Taxes>
  <Total Code="RUB">4551</Total>
</Taxes>
6Total fare per slice
(error)

RequestedDate /PriceDetail /BaseAmount
<BaseAmount Code="RUB">49205</BaseAmount>
7Total fare per slice currency code
(error)
Currency codeRequestedDate /PriceDetail /BaseAmount /@Code
<BaseAmount Code="RUB">49205</BaseAmount>
8Segment information
(error)
Segment ID + ODRequestedDate /Associations /OtherAssociation /OtherAssociation /Type
<Associations>
  <OtherAssociation>
    <OtherAssociation>
      <Type>SEG1 MUC-DME</Type>
      <ReferenceValue>Meal_L</ReferenceValue>
    </OtherAssociation>
  </OtherAssociation>
</Associations>
9Reference to the meal type on the segment
(error)

RequestedDate /Associations /OtherAssociation /OtherAssociation /ReferenceValue
<Associations>
  <OtherAssociation>
    <OtherAssociation>
      <Type>SEG1 MUC-DME</Type>
      <ReferenceValue>Meal_L</ReferenceValue>
    </OtherAssociation>
  </OtherAssociation>
</Associations>
10Traveler reference 
(error)
SH1RequestedDate /Associations /AssociatedTraveler /TravelerReferences
<AssociatedTraveler>
  <TravelerReferences>SH1</TravelerReferences>
</AssociatedTraveler>
11Slice reference 
(error)
OD1RequestedDate /Associations /ApplicableFlight /OriginDestinationReferences
<OriginDestinationReferences>OD1</OriginDestinationReferences>
12Segment reference 
(error)
SEG1RequestedDate /Associations /ApplicableFlight /FlightSegmentReference@ref
 <FlightSegmentReference ref="SEG1">
13Cabin code
(error)

Possible values:

  • Y - COACH
  • F - FIRST
  • B - BUSINESS
  • P - PREMIUM-COACH
RequestedDate /Associations /ApplicableFlight /FlightSegmentReference /Cabin /CabinDesignator
<Cabin>
  <CabinDesignator>Y</CabinDesignator>
  <MarketingName>BASIC ECONOMY</MarketingName>
</Cabin>
14BrandedFares type on segment
(error)

Possible values:

  1. basicEconomy
  2. flexEconomy
  3. basicBusiness
  4. flexBusiness
RequestedDate /Associations /ApplicableFlight /FlightSegmentReference /Cabin /MarketingName
<Cabin>
  <CabinDesignator>Y</CabinDesignator>
  <MarketingName>BASIC ECONOMY</MarketingName>
</Cabin>
15Class of service (RBD) per segment
(error)
Letter RequestedDate /Associations /ApplicableFlight /FlightSegmentReference /ClassOfService /Code
<Code SeatsLeft="2">Q</ns3:Code>
16Seats left of class of service
(error)

RequestedDate /Associations /ApplicableFlight /FlightSegmentReference /ClassOfService /Code@SeatsLeft
<Code SeatsLeft="2">Q</ns3:Code>
17Fare basis code per segment
(error)

RequestedDate /Associations /ApplicableFlight /FlightSegmentReference /ClassOfService /MarketingName
<MarketingName>QBSRT</MarketingName>
18Free baggage allowance reference
(error)

RequestedDate /Associations /ApplicableFlight /FlightSegmentReference /BagDetailAssociation /CheckedBagReferences
<BagDetailAssociation>
  <CheckedBagReferences>BG1</CheckedBagReferences>
  <CarryOnReferences>CO1</CarryOnReferences>
</BagDetailAssociation>
19Carry-on baggage allowance reference
(error)

RequestedDate /Associations /ApplicableFlight /FlightSegmentReference /BagDetailAssociation /CarryOnReferences
<BagDetailAssociation>
  <CheckedBagReferences>BG1</CheckedBagReferences>
  <CarryOnReferences>CO1</CarryOnReferences>
</BagDetailAssociation>
20Fare basis code per segment
(error)

RequestedDate /Associations /OtherAssociation /OtherAssociation /Type
<OtherAssociation>
  <Type>DBSRT</Type>
  <ReferenceValue>PL1</ReferenceValue>
</OtherAssociation>
21Penalty reference
(error)

RequestedDate /Associations /OtherAssociation /OtherAssociation /ReferenceValue
<OtherAssociation>
  <Type>DBSRT</Type>
  <ReferenceValue>PL1</ReferenceValue>
</OtherAssociation>
22Passenger type reference
(error)

FareDetail /FareComponent@refs
<FareComponent refs="SH1" ObjectKey="FC1">
23Fare component ID, where FareComponent contains detailed information about the price per slice for 1 passenger of a certain PTC
(error)

FareDetail /FareComponent@ObjectKey
<FareComponent refs="SH1" ObjectKey="FC1">
24Indicates that the component contains the calculation of the price for 1 passenger
(error)
1FareDetail /FareComponent /Parameters@Quantity
 <Parameters Quantity="1"/>
25Fare per passenger of a certain PTC (on slice)
(error)

FareDetail /FareComponent /PriceBreakdown /Price /BaseAmount

<BaseAmount Code="RUB">5806</BaseAmount>
26Fare per passenger currency code
(error)
Currency codeFareDetail /FareComponent /PriceBreakdown /Price /BaseAmount@Code
<BaseAmount Code="RUB">5806</BaseAmount>
27Taxes per passenger of a certain PTC (on slice)
(error)

FareDetail /FareComponent /PriceBreakdown /Price /Taxes /Total
<Taxes>
  <Total Code="RUB">4783</Total>
</Taxes>
28Taxes per passenger currency code
(error)
Currency codeFareDetail /FareComponent /PriceBreakdown /Price /Taxes /Total@Code
<Taxes>
  <Total Code="RUB">4783</Total>
</Taxes>

AnonymousTraveler (SH).
/Envelope /Body /AirShoppingRS /DataLists /AnonymousTravelerList /AnonymousTraveler (Multiple)

#DescriptionMandMultDefaultRef/FormatxPathExample
1Passenger Type Code ID
(error)

@ObjectKey
<AnonymousTraveler ObjectKey="SH1">
2Passenger Type Code
(error)
Value from requestPTC
<PTC Quantity="3">ADT</PTC>
3Quantity of passengers of the same PTC
(error)
Value from requestPTC /@Quantity
<PTC Quantity="2">CHD</PTC>

CarryOnAllowance (CO).
/Envelope /Body /AirShoppingRS /DataLists /CarryOnAllowanceList /CarryOnAllowance (Multiple)

#DescriptionMandMultDefaultRef/FormatxPathExample
1ID
(error)

@ListKey
<ns3:CarryOnAllowance ListKey="CO1">
2Describes for whom

the carry on allowance applies


(error)TravelerConstantAllowanceDescription /ApplicableParty
<ApplicableParty>Traveler</ApplicableParty>
3Bags quantity
(error)

AllowanceDescription /ApplicableBag
<ApplicableBag>1PC</ApplicableBag>
4Bag description
(error)

AllowanceDescription /Descriptions /Description /Text
<Description>
  <Text>10KG</Text>
</Description>

CheckedBagAllowance (BG).
/Envelope /Body /AirShoppingRS /DataLists /CheckedBagAllowanceList /CheckedBagAllowance (Multiple)

#DescriptionMandMultDefaultRef/FormatxPathExample
1ID
(error)

@ListKey
<CheckedBagAllowance ListKey="BG1">
2Describes for whom

the baggage allowance applies


(error)TravelerConstantAllowanceDescription /ApplicableParty
<ApplicableParty>Traveler</ApplicableParty>
3Bags quantity
(error)

AllowanceDescription /ApplicableBag
<ApplicableBag>1PC</ApplicableBag>
4Bag description
(tick)

AllowanceDescription /Descriptions /Description /Text
<Description>
  <Text>10KG</Text>
</Description>

<Description>
  <Text>Bicycle</Text>
</Description>

FlightSegment (SEG).
/Envelope /Body /AirShoppingRS /DataLists /FlightSegmentList /FlightSegment (Multiple)

#DescriptionMandMultDefaultRef/FormatxPathExample
1Departure IATA airport code
(error)

Departure /AirportCode
<AirportCode>LED</AirportCode>
2Departure date (local)
(error)
YYYY-MM-DDDeparture /Date
<Date>2020-07-21</Date>
3Departure time (local)
(error)
HH:MMDeparture /Time
<Time>13:00</Time>
4Departure terminal name
(error)
letter  or numberDeparture /Terminal /Name
<Name>1</Name>
<Name>F</Name>
5Arrival IATA airport code
(error)

Arrival /AirportCode
<AirportCode>OVB</AirportCode>
6Arrival date (local)
(error)
YYYY-MM-DDArrival /Date
<Date>2020-08-11</Date>
7Arrival time (local)
(error)
HH:MMArrival /Time
<Time>23:00</Time>
8Arrival terminal name
(error)
letter  or numberArrival /Terminal /Name
<Name>1</Name>
<Name>B</Name>
9Marketing carrier IATA airline code
(error)

MarketingCarrier /AirlineID
<AirlineID>S7</AirlineID>
10Marketing carrier flight number
(error)

MarketingCarrier /FlightNumber
<FlightNumber>3340</FlightNumber>
11Operating carrier IATA airline code
(error)

OperatingCarrier /AirlineID
<AirlineID>BA</AirlineID>
12Operating carrier flight number
(error)

OperatingCarrier /FlightNumber
<FlightNumber>63</FlightNumber>
13Rich media content reference
(error)

Equipment@refs
<Equipment refs="ML1">
14Aircraft type information
(error)

Equipment /AircraftCode
<AircraftCode>320</AircraftCode>
15Aircraft type information
(error)

Equipment /AirlineEquipCode
<AirlineEquipCode>Airbus A320-100/200</AirlineEquipCode>
16Flight distance value
(error)

FlightDetail /FlightDistance /Value
<Value>1923</Value>
17Flight distance units of measurement
(error)

FlightDetail /FlightDistance /UOM
<UOM>Miles</UOM>
18Flight duration
(error)

FlightDetail /FlightDuration /Value
<Value>PT4H15M</Value>

OriginDestination (OD).
/Envelope /Body /AirShoppingRS /DataLists /OriginDestinationList /OriginDestination (Multiple)

#DescriptionMandMultDefaultRef/FormatxPathExample
1ID, where OriginDestination = slice
(error)

@OriginDestinationKey
<OriginDestination OriginDestinationKey="OD3">
2Departure IATA airport code
(error)

DepartureCode
<DepartureCode>OVB</DepartureCode>
3Arrival IATA airport code
(error)

ArrivalCode
<ArrivalCode>KHV</ArrivalCode>
4Segment (SEG) reference - contains list of segments of which the slice consists
(tick)

FlightReferences
<FlightReferences>SEG1 SEG2</FlightReferences>

Media (ML).
/Envelope /Body /AirShoppingRS /DataLists /MediaList /Media (Multiple)

#DescriptionMandMultDefaultRef/FormatxPathExample
1ID
(error)

@ListKey
<Media ListKey="ML1">
2Link to the image of the type of aircraft
(error)

MediaLink
<MediaLink>https://static.s7cdn.online/hermes/IBE/image_airplane/a320.png</ns3:MediaLink>

PenaltyDetail (PL). 
/Envelope /Body /AirShoppingRS /DataLists /PenaltyList /Penalty (Multiple)

#DescriptionMandMultDefaultRef/Format/DescxPathExample
1ID



@ObjectKey
<Penalty ObjectKey="PL1">
2Penalty type
(error)

Possible values:

  1. "BEFORE-DEPARTURE"
  2. "AFTER-DEPARTURE"
  3. "NO-SHOW"
Details /Detail /Type
<Type>BEFORE-DEPARTURE</ns3:Type>
3Minimum penalty amount
(error)

Amounts /Amount[AmountApplication="MinimumPenaltyAmount"] /CurrencyAmountValue
<Amount>
  <CurrencyAmountValue Code="RUB">3000</CurrencyAmountValue>
  <AmountApplication>MinimumPenaltyAmount</AmountApplication>
</Amount>
4Minimum penalty amount currency code
(error)

Amounts /Amount[AmountApplication="MinimumPenaltyAmount"] /CurrencyAmountValue /@Code
<Amount>
  <CurrencyAmountValue Code="RUB">3000</CurrencyAmountValue>
  <AmountApplication>MinimumPenaltyAmount</AmountApplication>
</Amount>
5Maximum penalty amount
(error)

Amounts /Amount[AmountApplication="MaximumPenaltyAmount"] /CurrencyAmountValue
<Amount>
  <CurrencyAmountValue Code="RUB">5000</CurrencyAmountValue>
  <AmountApplication>MaximumPenaltyAmount</AmountApplication>
</Amount>
6Maximum penalty amount currency code
(error)

Amounts /Amount[AmountApplication="MaximumPenaltyAmount"] /CurrencyAmountValue /@Code
<Amount>
  <CurrencyAmountValue Code="RUB">5000</CurrencyAmountValue>
  <AmountApplication>MaximumPenaltyAmount</AmountApplication>
</Amount>

Service.
/Envelope /Body /AirShoppingRS /DataLists /ServiceList /Service (Multiple)

#DescriptionMandMultDefaultRef/FormatxPathExample
1Service ID
(error)

@ObjectKey
<Service ObjectKey="Meal_L">
2Service code
(error)

ServiceID
<ServiceID Owner="Any">L</ServiceID>
3Constant
(error)AnyConstantServiceID@Owner
<ServiceID Owner="Any">L</ServiceID>
4Service name
(error)

Name
<Name>Meal</Name>
5Service description
(error)

Descriptions /Description /Text
<Text>Lunch</Text>

Metadata.
/Envelope /Body /AirShoppingRS /Metadata /OtherMetadata (Multiple)

#DescriptionMandMultDefaultRef/FormatxPathExample
1Currency code
(error)
Currency codeCurrencyMetadatas /CurrencyMetadata@MetadataKey
<CurrencyMetadata MetadataKey="KZT">
  <Application>Sale currency</Application>
  <Decimals>2</Decimals>
</CurrencyMetadata>
2Indicates that the currency specified in the MetadataKey is the sale currency
(error)
Sale currencyCurrencyMetadatas /CurrencyMetadata /Application
<CurrencyMetadata MetadataKey="KZT">
  <Application>Sale currency</Application>
  <Decimals>2</Decimals>
</CurrencyMetadata>
3Number of decimal places
(error)
 numberCurrencyMetadatas /CurrencyMetadata /Decimals
<CurrencyMetadata MetadataKey="KZT">
  <Application>Sale currency</Application>
  <Decimals>2</Decimals>
</CurrencyMetadata>
4Currency code
(error)
Currency codeCurrencyMetadatas /CurrencyMetadata@MetadataKey
<CurrencyMetadata MetadataKey="RUB">
  <Application>5.90189013</Application>
  <Decimals>2</Decimals>
  <Name>Conversion rate from RUB to KZT</Name>
</CurrencyMetadata
5Сonversion rate of the specified in MetadataKey currency into the sale currency
(error)

CurrencyMetadatas /CurrencyMetadata /Application
<CurrencyMetadata MetadataKey="RUB">
  <Application>5.90189013</Application>
  <Decimals>2</Decimals>
  <Name>Conversion rate from RUB to KZT</Name>
</CurrencyMetadata
6Number of decimal places
(error)
numberCurrencyMetadatas /CurrencyMetadata /Decimals
<CurrencyMetadata MetadataKey="RUB">
  <Application>5.90189013</Application>
  <Decimals>2</Decimals>
  <Name>Conversion rate from RUB to KZT</Name>
</CurrencyMetadata
7Description of conversion rate from currency to currency 
(error)

CurrencyMetadatas /CurrencyMetadata /Name
<CurrencyMetadata MetadataKey="RUB">
  <Application>5.90189013</Application>
  <Decimals>2</Decimals>
  <Name>Conversion rate from RUB to KZT</Name>
</CurrencyMetadata
8Rule ID
(error)

RuleMetadatas /RuleMetadata@MetadataKey
<RuleMetadata MetadataKey="RM1">
9Rule name
(error)
Value from requestRuleMetadatas /RuleMetadata /RuleID
<RuleMetadata MetadataKey="RM3">
  <RuleID>FareOut</RuleID>
  <Status>LowFare</Status>
</RuleMetadata
10Rule value
(error)
Value from requestRuleMetadatas /RuleMetadata /Name
<RuleMetadata MetadataKey="RM4">
  <RuleID>PermittedCabin</RuleID>
  <Name>COACH, PREMIUM-COACH</Name>
  <Status>Y</Status>
</RuleMetadata
11Rule value
(error)
Value from requestRuleMetadatas /RuleMetadata /Status
<RuleMetadata MetadataKey="RM2">
  <RuleID>DirectPreferences</RuleID>
  <Status>Preferred</Status>
</RuleMetadata>
  • No labels