Versions Compared

Old Version 1

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)

(tick)

(error)

(error)

(error)

(error)



AgencyID


<iata:
AgencyID>Agent<
AgencyID>test</iata:AgencyID>
2

PseudoCityID

(tick)

(tick)

(error)

(error)

(error)

(error)



PseudoCityID


<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
BookingRef

Booking information

(tick)

(tick)

(error)

(error)

(error)

(error)

BookingRef

<iata:BookingID>JUL17A</iata:BookingID>
BookingRef

2
Pax

Order information

(tick)

(tick)

(error)

(error)

(error)

addAncillariesIATA_OrderChangeRQ | v0.52 | split operation

DataLists/PaxList/Pax

(error)

CreateOrderItem

ChangeOrder/UpdateOrderItem/AcceptOffer/CreateOrderItem

3

Data lists

(tick)

(error)

(error)

DataLists

DataLists


4

Order number

(tick)

(error)

(tick)

3

Order

(tick)

(error)

(error)

DFRРLDH

Order/OrderID
<iata:OrderID>DFRРLDH</iata:OrderID>

4

Airline owner code

(tick)

(error)

(error)

Order/
5

Order owner airline code

(tick)

(error)

(tick)

S7

Order/OwnerCode
<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

BookingEntity/Carrier/AirlineDesigCode
<AirlineDesigCode>S7</AirlineDesigCode>

2

Booking number

(tick)

(error)

(error)


BookingID

<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)


OfferItemID

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

2

Baggage ID

(tick)

(error)

(error)


OfferItemType/BaggageItem/BagItemDetails/BaggageAllowanceRefID

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

3

Baggage total price

(tick)

(error)

(error)


OfferItemType/BaggageItem/Price/TotalAmount

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

4

Baggage price currency

(tick)

(error)

(error)



OfferItemType/BaggageItem/Price/TotalAmount@CurCode

<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)


OfferItemType/SeatItem/ColumnID
<iata:ColumnID>C</iata:ColumnID>
11

Seat segment association

(tick)

(error)

(error)



OfferItemType/SeatItem/PaxSegmentRefID

<iata:PaxSegmentRefID>SEG2</iata:PaxSegmentRefID>
12

Seat total price

(tick)

(error)

(error)


OfferItemType/SeatItem/Price/TotalAmount

<iata:TotalAmount 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>

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)


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/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 CurCode="RUB">500</iata:DiscountAmount>
</iata:Discount>
19

Seat row

(tick)

(error)

(error)


OfferItemType/SeatItem/RowNumber


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


20

Seat association

(tick)

(error)

(error)


OfferItemType/SeatItem/SeatProfileRefID


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


21

Meal ID

(tick)

(error)

(error)


OfferItemType/OtherItem/DescText


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


22

Meal total price

(tick)

(error)

(error)


OfferItemType/OtherItem/Price/TotalAmount


<iata:TotalAmount 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>


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)

(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/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 CurCode="RUB">500</iata:DiscountAmount>
</iata:Discount>
29

Airline code

(tick)

(error)

(error)

S7

OwnerCode


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




Anchor

Passenger informationPassenger informationPassenger

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

BaggageAllowanceList



2

Form of payment

(tick)

(error)

(error)

FareList

FareList


3

OriginDestination information

(tick)

(error)

(error)

PaxJourneyList

PaxJourneyList



4

Passengers information

(tick)

(error)

(error)

PaxList

PaxList



5

Segment information

(tick)

(error)

(error)

PaxSegmentList

PaxSegmentList



6

Seat information

(tick)

(error)

(error)

SeatProfileList

SeatProfileList



7

Meal information

(tick)

(error)

(error)

ServiceDefinitionList

ServiceDefinitionList





Anchor
BaggageAllowanceList
BaggageAllowanceList
Baggage information. 
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/

PaxList/Pax

BaggageAllowanceList/BaggageAllowance(Multiple)


Description

Mand

Mult

Default

Ref/Format/Desc

xPath

Example

1

OriginDestination association

(tick)

(error)

(error)


ApplicableBagText


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


2

Passenger association

(tick)

(error)

(error)


ApplicablePartyText


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


3

Baggage ID

(tick)

(error)

(error)


BaggageAllowanceID


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


4

Baggage service code

(tick)

(error)

(error)


DescText


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


5

Baggage status

(tick)

(error)

(error)


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)


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>






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)



PaxJourneyID

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


2

Segment association

(tick)

(tick)

(error)



PaxSegmentRefID


<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)



PaxID



<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



PTC



<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

Arrival



2

Depature information

(tick)

(error)

(error)

Dep

Dep



3

Marketing carrier information

(tick)

(error)

(error)

MarketingCarrierInfo

MarketingCarrierInfo



4

Operating carrier information

(tick)

(error)

(error)

OperatingCarrierInfo

OperatingCarrierInfo



5

Segment ID

(tick)

(error)

(error)


PaxSegmentID


<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

CharacteristicCode


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


2

Passenger association

(tick)

(error)

(error)


CharacteristicCode

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


3

Seat service ID

(tick)

(error)

(error)


SeatProfileID

<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 association

(tick)

(error)

(error)


Desc/DescText


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


2

Passenger association

(tick)

(error)

(error)


Desc/DescText


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


3

Service name

(tick)

(error)

(error)

meal

SeatProfileID


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


4

Meal service code

(tick)

(error)

(error)


ServiceCode


<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

(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>

GenderCode

(tick)

(error)

(error)

M — Male

F — Famale

Individual/GenderCode

<AirlineDesigCode>S7</AirlineDesigCode>

2

GivenName

(tick)

(error)

(error)

Individual/GivenName

<iata:GivenName>CHARLES</iata:GivenName>

3

Surname

(tick)

(error)

(error)

Individual/Surname

<iata:Surname>XAVIER</iata:Surname>

4

PaxID

(tick)

(error)

(error)

PaxID

<iata:PaxID>SH2</iata:PaxID>

5

Passenger type

(tick)

(error)

(error)

  1. ADT — Adult

  2. CHD — Child

PTC

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