Versions Compared

Old Version 8

changes.mady.by.user Yulia Komarova

Saved on

compared with

New Version Current

changes.mady.by.user Uliana Arefina

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of contents:

Table of Contents

Check out

  • Operation overview, its main purpose and use cases

  • Response message with detailed explanation of output parameters

  • Variety of request and response samples

Parameters

Access. 
/Envelope /Body /IATA_OrderChangeRQ/Party /Sender /TravelAgency


Description

Mand

Mult

Default

Ref/Format/Desc

xPath

Example

1

AgencyID

(tick)

(error)

(error)

Code Block



AgencyID
code

<iata:
AgencyID>Agent<
AgencyID>test</iata:AgencyID>
2
PseudoCityID
(tick)
(error)
(error)
 Code Block


PseudoCityID
code

<iata:
PseudoCityID>OVBS728AB<
PseudoCityID>S7AGN8224</iata:PseudoCityID>
Replace text 'test' with the login from the authorization to the S7 Agent API service.

Main. 
/Envelope /Body /IATA_OrderChangeRQ/Request

Description
Mand
Mult
Default
Ref/Format/Desc
xPath
Example
1
Booking information
(tick)
(error)
(error)
BookingRef
 Code Block
BookingRef

2
Order information
(tick)
(error)
(error)
CreateOrderItem
 Code Block
ChangeOrder/UpdateOrderItem/AcceptOffer/CreateOrderItem

3
Data lists
(tick)
(error)
(error)
DataLists

code
DataLists


4
Order number
(tick)
(error)
(tick)
DFRРLDH
 Code Block
Order/OrderID
 Code Block
<iata:OrderID>DFRРLDH</iata:OrderID>
5
Order owner airline code
(tick)
(error)
(tick)
S7
code
Order/OwnerCode
code
<iata:OwnerCode>S7</iata:OwnerCode>
 Anchor
BookingRef
BookingRef
Booking information. 
/Envelope /Body /IATA_OrderChangeRQ/Request/BookingRef

Description
Mand
Mult
Default
Ref/Format/Desc
xPath
Example
1
Airline code
(tick)
(error)
(error)
S7
code
BookingEntity/Carrier/AirlineDesigCode
code
<AirlineDesigCode>S7</AirlineDesigCode>

2
Booking number
(tick)
(error)
(error)
 Code Block

BookingID
 Code Block

<iata:BookingID>JGIZV2</iata:BookingID>



 Anchor
CreateOrderItem
CreateOrderItem
Order information. 
/Envelope /Body /IATA_OrderChangeRQ/Request/ChangeOrder/UpdateOrderItem/AcceptOffer/CreateOrderItem

Description
Mand
Mult
Default
Ref/Format/Desc
xPathPaxSegmentList
Example
1
Offer item ID
(tick)
(error)
(error)
code

OfferItemID
 Code Block

<iata:OfferItemID>OI2</iata:OfferItemID>

2
Baggage ID
(tick)
(error)
(error)
 Code Block

OfferItemType/BaggageItem/BagItemDetails/BaggageAllowanceRefID
code

<iata:BaggageAllowanceRefID>BG2</iata:BaggageAllowanceRefID>

3
Baggage total price
(tick)
(error)
(error)
 Code Block

OfferItemType/BaggageItem/Price/TotalAmount
 Code Block

<iata:TotalAmount CurCode="RUB">3300</iata:TotalAmount>

4
Baggage price currency
(tick)
(error)
(error)
code


OfferItemType/BaggageItem/Price/TotalAmount@CurCode
code

<iata:TotalAmount CurCode="RUB">3300</iata:TotalAmount>
5
Baggage base price
(tick)
(error)
(error)

OfferItemType/BaggageItem/Price/BaseAmount
<iata:BaseAmount CurCode="RUB">3500</iata:BaseAmount>
6
Baggage base currency
(tick)
(error)
(error)

OfferItemType/BaggageItem/Price/BaseAmount@CurCode
<iata:BaseAmount CurCode="RUB">3500</iata:BaseAmount>
7
Baggage percent discount
(error)
(error)
(error)
Use if ServicePrice operation RS include percent discount
OfferItemType/BaggageItem/Price/Discount/DiscountPercent
<iata:Discount>
<iata:DiscountPercent>10</iata:DiscountPercent>
</iata:Discount>
8
Baggage fix (currency) discount 
(error)
(error)
(error)
Use if ServicePrice operation RS include fix discount
OfferItemType/BaggageItem/Price/Discount/DiscountAmount
<iata:Discount>
 <iata:DiscountAmount CurCode="RUB">500</iata:DiscountAmount>
</iata:Discount>
9
Baggage fix (currency) discount currency 
(error)
(error)
(error)
Use if ServicePrice operation RS include fix discount
OfferItemType/BaggageItem/Price/Discount/DiscountAmount@CurCode
<iata:Discount>
 <iata:DiscountAmount CurCode="RUB">500</iata:DiscountAmount>
</iata:Discount>
10
Seat column
(tick)
(error)
(error)
 Code Block

OfferItemType/SeatItem/ColumnID
 Code Block
<iata:ColumnID>C</iata:ColumnID>
6
11
Seat segment 
 assotiation
association
(tick)
(error)
(error)
 Code Block


OfferItemType/SeatItem/PaxSegmentRefID
code

<iata:PaxSegmentRefID>SEG2</iata:PaxSegmentRefID>
7
12
Seat total price
(tick)
(error)
(error)
code

OfferItemType/SeatItem/Price/TotalAmount
<iata:TotalAmount 
code
CurCode="RUB">500</iata:TotalAmount>

13
Seat total price currency
(tick)
(error)
(error)

OfferItemType/SeatItem/Price/TotalAmount@CurCode
<iata:TotalAmount 
 
 CurCode="RUB">500</iata:TotalAmount>
8
14
Seat base price
(tick)
(error)
(error)

OfferItemType/SeatItem/Price/BaseAmount
<iata:BaseAmount CurCode="RUB">3500</iata:BaseAmount>
15
Seat base currency
(tick)
(error)
(error)
code

OfferItemType/SeatItem/Price/BaseAmount@CurCode
<iata:BaseAmount CurCode="RUB">3500</iata:BaseAmount>
16
Seat percent discount
(error)
(error)
(error)
Use if ServicePrice operation RS include percent discount
OfferItemType/SeatItem/Price/Discount/DiscountPercent
<iata:Discount>
<iata:DiscountPercent>10</iata:DiscountPercent>
</iata:Discount>
17
Seat fix (currency) discount 
(error)
(error)
(error)
Use if ServicePrice operation RS include fix discount
OfferItemType/SeatItem/Price
/TotalAmount@CurCode
/Discount/DiscountAmount
<iata:Discount>
 <iata:DiscountAmount CurCode="RUB">500</iata:DiscountAmount>
</iata:Discount>
18
Seat fix (currency) discount currency 
(error)
(error)
(error)
Use if ServicePrice operation RS include fix discount
OfferItemType/SeatItem/Price/Discount/DiscountAmount@CurCode
<iata:Discount>
 <iata:DiscountAmount
 Code Block<iata:TotalAmount
 CurCode="RUB">500</iata:
TotalAmount>9
DiscountAmount>
</iata:Discount>
19
Seat row
(tick)
(error)
(error)
code

OfferItemType/SeatItem/RowNumber
code

<iata:RowNumber>4</iata:RowNumber>
10

20
Seat 
 assotiation
association
(tick)
(error)
(error)
 Code Block

OfferItemType/SeatItem/SeatProfileRefID
 Code Block

<iata:SeatProfileRefID>ST1</iata:SeatProfileRefID>
11

21
Meal ID
(tick)
(error)
(error)
code

OfferItemType/OtherItem/DescText
 Code Block

<iata:DescText>ML1</iata:DescText>
12

22
Meal total price
(tick)
(error)
(error)
code

OfferItemType/OtherItem/Price/TotalAmount

<iata:TotalAmount 
code
CurCode="RUB">300</iata:TotalAmount>

23
Meal total price currency
(tick)
(error)
(error)

OfferItemType/OtherItem/Price/TotalAmount@CurCode

<iata:TotalAmount 
 
 CurCode="RUB">300</iata:TotalAmount>
13

24
Meal base price
(tick)
(error)
(error)

OfferItemType/OtherItem/Price/BaseAmount
<iata:BaseAmount CurCode="RUB">3500</iata:BaseAmount>
25
Meal base currency
(tick)
(error)
(error)

OfferItemType/OtherItem/Price/BaseAmount@CurCode
<iata:BaseAmount CurCode="RUB">3500</iata:BaseAmount>
26
Meal percent discount
(error)
(error)
code
(error)
Use if ServicePrice operation RS include percent discount
OfferItemType/OtherItem/Price/Discount/DiscountPercent
<iata:Discount>
<iata:DiscountPercent>10</iata:DiscountPercent>
</iata:Discount>
27
Meal fix (currency) discount 
(error)
(error)
(error)
Use if ServicePrice operation RS include fix discount
OfferItemType/OtherItem/Price
/TotalAmount@CurCode
/Discount/DiscountAmount
<iata:Discount>
 <iata:DiscountAmount CurCode="RUB">500</iata:DiscountAmount>
</iata:Discount>
28
Meal fix (currency) discount currency 
(error)
(error)
(error)
Use if ServicePrice operation RS include fix discount
OfferItemType/OtherItem/Price/Discount/DiscountAmount@CurCode
<iata:Discount>
 <iata:DiscountAmount
 Code Block<iata:TotalAmount
 CurCode="RUB"
>300<
>500</iata:DiscountAmount>
</iata:
TotalAmount>
Discount>
14
29
Airline code
(tick)
(error)
(error)
S7
code
OwnerCode
code

<iata:OwnerCode>S7</iata:OwnerCode>



 Anchor
DataLists
DataLists
Data lists. 
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists

Description
Mand
Mult
Default
Ref/Format/Desc
xPath
Example
1
Baggage information
(tick)
(error)
(error)
BaggageAllowanceList
code
BaggageAllowanceList


2
Form of payment
(tick)
(error)
(error)
FareList
FareList

3
OriginDestination information
(tick)
(error)
(error)
PaxJourneyList

code
PaxJourneyList
3


4
Passengers information
(tick)
(error)
(error)
PaxList
code
PaxList
4


5
Segment information
(tick)
(error)
(error)
PaxSegmentList
code
PaxSegmentList
5


6
Seat information
(tick)
(error)
(error)
SeatProfileList
code
SeatProfileList
6


7
Meal information
(tick)
(error)
(error)
ServiceDefinitionList
 Code Block
ServiceDefinitionList




 Anchor
BaggageAllowanceList
BaggageAllowanceList
Baggage information. 
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/BaggageAllowanceList/BaggageAllowance(Multiple)

Description
Mand
Mult
Default
Ref/Format/Desc
xPath
Example
1
OriginDestination 
 assotiation
association
(tick)
(error)
(error)
code

ApplicableBagText
 Code Block

<iata:ApplicableBagText>OD1</iata:ApplicableBagText>

2
Passenger 
 assotiation
association
(tick)
(error)
(error)
code

ApplicablePartyText
code

<iata:ApplicablePartyText>P2</iata:ApplicablePartyText>

3
Baggage ID
(tick)
(error)
(error)
code

BaggageAllowanceID
code

<iata:BaggageAllowanceID>BG1</iata:BaggageAllowanceID>

4
Baggage service code
(tick)
(error)
(error)

DescText

<iata:DescText>0CC</iata:DescText>

5
Baggage status
(tick)
(error)
(error)
0CC - first bag
0CD - second bag
0DD - ski equipment
0IK - overweight
 Code Block
DescText
 Code Block
<iata:DescText>0CC</iata:DescText>
5Baggage status

TypeCode

<iata:TypeCode>Checked</iata:TypeCode>

 Anchor
FareList
FareList
Form of Payment
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/FareList

Description
Mand
Mult
Default
Ref/Format/Desc
xPath
Example
1
Total price for all ancillaries
(tick)
(error)
(error)

FareGroup/FareDetail/FarePriceType/Price/TotalAmount

<iata:Price>
<iata:TotalAmount CurCode="RUB">7600</iata:TotalAmount>
</iata:Price>

2
Total price for all ancillaries currency
(tick)
(error)
(error)
Checked
 Code Block
TypeCode

FareGroup/FareDetail/FarePriceType/Price/TotalAmount@CurCode

<iata:Price>
<iata:TotalAmount CurCode="RUB">7600</iata:TotalAmount>
</iata:Price>

3Payment Type
(tick)
(error)
(error)
Constant. Always "MS"
FareGroup/FareDetail/PricingSystemCodeText
<iata:PricingSystemCodeText>MS</iata:PricingSystemCodeText>
4
Form of payment text
(tick)
(error)
(error)
*A*FREETEXT

'FREETEXT' you might replace with you own FOP text
FareGroup/FareDetail/StatisticalCodeText

 <iata:StatisticalCodeText>*A*FREETEXT</iata:StatisticalCodeText>
 Code Block<iata:TypeCode>Checked</iata:TypeCode>





 Anchor
PaxJourneyListBaggageAllowanceList
PaxJourneyListBaggageAllowanceList
OriginDestination information. 
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/PaxJourneyList/PaxJourney(Multiple)

Description
Mand
Mult
Default
Ref/Format/Desc
xPath
Example
1
OriginDestination ID
(tick)
(error)
(error)
code


PaxJourneyID
code
<iata:PaxJourneyID>OD1</iata:PaxJourneyID>

2
Segment 
 assotiation
association
(tick)
(tick)
(error)
code


PaxSegmentRefID
 Code Block

<iata:PaxSegmentRefID>SEG1</iata:PaxSegmentRefID>


 Anchor
PaxList
PaxList
Passengers information. 
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/PaxList/Pax(Multiple)

Description
Mand
Mult
Default
Ref/Format/Desc
xPath
Example
1
Passenger ID
(tick)
(error)
(error)
 Code Block


PaxID
code


<iata:PaxID>P2</iata:PaxID>
2
Passenger type
(tick)
(tick)
(error)
ADT - adult
CHD - child
INF -inf
SRC - subsidised adult
YTR - subsidised adult
CHR - subsidised child
INR -subsidised infant
code


PTC
 Code Block


<iata:PTC>ADT</iata:PTC>

 Anchor
SeatProfileList
SeatProfileList
Segment information. 
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/PaxSegmentList/PaxSegment(Multiple)

Description
Mand
Mult
Default
Ref/Format/Desc
xPath
Example
1
Arrival information
(tick)
(error)
(error)
Arrival
code
Arrival


2
Depature information
(tick)
(error)
(error)
Dep
code
Dep


3
Marketing carrier information
(tick)
(error)
(error)
MarketingCarrierInfo
code
MarketingCarrierInfo


4
Operating carrier information
(tick)
(error)
(error)
OperatingCarrierInfo
code
OperatingCarrierInfo


5
Segment ID
(tick)
(error)
(error)
code

PaxSegmentID
code

<iata:PaxSegmentID>SEG1</iata:PaxSegmentID>


 Anchor
SeatProfileList
SeatProfileList
Seat information. 
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/SeatProfileList/SeatProfile(Multiple)

Description
Mand
Mult
Default
Ref/Format/Desc
xPath
Example
1
Seat service code
(tick)
(error)
(error)
0B5
code
CharacteristicCode
 Code Block

<iata:CharacteristicCode>0B5</iata:CharacteristicCode>

2
Passenger 
 assotiation
association
(tick)
(error)
(error)
 Code Block

CharacteristicCode
code
<iata:CharacteristicCode>P2</iata:CharacteristicCode>

3
Seat service ID
(tick)
(error)
(error)
 Code Block

SeatProfileID
 Code Block
<iata:SeatProfileID>ST1</iata:SeatProfileID>

 Anchor
ServiceDefinitionList
ServiceDefinitionList
Meal information. 
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/ServiceDefinitionList/ServiceDefinition(Multiple)

Description
Mand
Mult
Default
Ref/Format/Desc
xPath
Example
1
Segment 
 assotiation
association
(tick)
(error)
(error)
code

Desc/DescText
code

<iata:DescText>SEG1</iata:DescText>

2
Passenger 
 assotiation
association
(tick)
(error)
(error)
 Code Block

Desc/DescText
 Code Block

<iata:DescText>P2</iata:DescText>

3
Service name
(tick)
(error)
(error)
meal
code
SeatProfileID
 Code Block

<iata:Name>meal</iata:Name>

4
Meal service code
(tick)
(error)
(error)
 Code Block

ServiceCode
code

<iata:ServiceCode>0AN</iata:ServiceCode>

5
Meal service ID
(tick)
(error)
(error)

ServiceDefinitionID

<iata:ServiceDefinitionID>ML1</iata:ServiceDefinitionID>


 Anchor
Arrival
Arrival
Arrival information. 
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/PaxSegmentList/PaxSegment/Arrival

Description
Mand
Mult
Default
Ref/Format/Desc
xPath
Example
1
Arrival datetime
(tick)
(error)
(error)

AircraftScheduledDateTime
<iata:AircraftScheduledDateTime>2020-12-28T13:35:00</iata:AircraftScheduledDateTime>
2
Arrival airport
(tick)
(error)
(error)

IATA_LocationCode
<iata:IATA_LocationCode>DME</iata:IATA_LocationCode>

 Anchor
Dep
Dep
Depature information 
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/PaxSegmentList/PaxSegment/Dep

Description
Mand
Mult
Default
Ref/Format/Desc
xPath
Example
1
Depature datetime
(tick)
(error)
(error)

AircraftScheduledDateTime

<iata:AircraftScheduledDateTime>2020-12-28T21:40:00</iata:AircraftScheduledDateTime>

2
Depature airport
(tick)
(error)
(error)

IATA_LocationCode
<iata:IATA_LocationCode>OVB</iata:IATA_LocationCode>

 Anchor
MarketingCarrierInfo
MarketingCarrierInfo
Marketing carrier information
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/PaxSegmentList/PaxSegment/MarketingCarrierInfo

Description
Mand
Mult
Default
Ref/Format/Desc
xPath
Example
1
Marketing airline code
ServiceDefinitionID
(tick)
(error)
(error)

CarrierDesigCode

<iata:CarrierDesigCode>S7</iata:CarrierDesigCode>

2
Marketing airline flight number
(tick)
(error)
(error)

MarketingCarrierFlightNumberText
<iata:MarketingCarrierFlightNumberText>2507</iata:MarketingCarrierFlightNumberText>

 Anchor
OperatingCarrierInfo
OperatingCarrierInfo
Operating carrier information
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/PaxSegmentList/PaxSegment/MarketingCarrierInfo

Description
Mand
Mult
Default
Ref/Format/Desc
xPath
Example
1
Operating airline code
(tick)
(error)
(error)

CarrierDesigCode

<iata:CarrierDesigCode>S7</iata:CarrierDesigCode>

2
Operating airline flight number
(tick)
(error)
(error)

OperatingCarrierFlightNumberText

<iata:OperatingCarrierFlightNumberText>2507</iata:OperatingCarrierFlightNumberText>
 Code Block<iata:ServiceDefinitionID>ML1</iata:ServiceDefinitionID>