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 |
|
|
|
AgencyID |
<iata: |
AgencyID>test</iata:AgencyID> | ||||
| 2 | PseudoCityID |
|
|
|
PseudoCityID |
<iata: |
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 |
|
|
|
BookingRef | |||||
| 2 | Order information |
|
|
|
ChangeOrder/UpdateOrderItem/AcceptOffer/CreateOrderItem | |||||||
| 3 | Data lists |
|
|
| DataLists | ||
| 4 | Order number |
|
|
| DFRРLDH | Order/OrderID | <iata:OrderID>DFRРLDH</iata:OrderID> |
| 5 | Order owner airline code |
|
|
| S7 | Order/OwnerCode | <iata:OwnerCode>S7</iata:OwnerCode> |
| Anchor | ||||
|---|---|---|---|---|
|
/Envelope /Body /IATA_OrderChangeRQ/Request/BookingRef
Description | Mand | Mult | Default | Ref/Format/Desc | xPath | Example | |
|---|---|---|---|---|---|---|---|
| 1 | Airline code |
|
|
| S7 |
BookingEntity/Carrier/AirlineDesigCode |
<AirlineDesigCode>S7</AirlineDesigCode> | ||||
| 2 | Booking number |
|
|
|
BookingID |
<iata:BookingID>JGIZV2</iata:BookingID> |
| Anchor | ||||
|---|---|---|---|---|
|
/Envelope /Body /IATA_OrderChangeRQ/Request/ChangeOrder/UpdateOrderItem/AcceptOffer/CreateOrderItem
Description | Mand | Mult | Default | Ref/Format/Desc |
|---|
xPathPaxSegmentList | Example | |||
|---|---|---|---|---|
| 1 | Offer item ID |
|
|
|
OfferItemID |
<iata:OfferItemID>OI2</iata:OfferItemID> | ||||
| 2 | Baggage ID |
|
|
|
OfferItemType/BaggageItem/BagItemDetails/BaggageAllowanceRefID |
<iata:BaggageAllowanceRefID>BG2</iata:BaggageAllowanceRefID> | ||||
| 3 | Baggage total price |
|
|
|
OfferItemType/BaggageItem/Price/TotalAmount |
<iata:TotalAmount CurCode="RUB">3300</iata:TotalAmount> | ||||
| 4 | Baggage price currency |
|
|
|
|
| |||||||
| 5 | Baggage base price |
|
|
| OfferItemType/BaggageItem/Price/BaseAmount | <iata:BaseAmount CurCode="RUB">3500</iata:BaseAmount> | |
| 6 | Baggage base currency |
|
|
| OfferItemType/BaggageItem/Price/BaseAmount@CurCode | <iata:BaseAmount CurCode="RUB">3500</iata:BaseAmount> | |
| 7 | Baggage percent discount |
|
|
| Use if ServicePrice operation RS include percent discount | OfferItemType/BaggageItem/Price/Discount/DiscountPercent | <iata:Discount> |
| 8 | Baggage fix (currency) discount |
|
|
| Use if ServicePrice operation RS include fix discount | OfferItemType/BaggageItem/Price/Discount/DiscountAmount | <iata:Discount> |
| 9 | Baggage fix (currency) discount currency |
|
|
| Use if ServicePrice operation RS include fix discount | OfferItemType/BaggageItem/Price/Discount/DiscountAmount@CurCode | <iata:Discount> |
| 10 | Seat column |
|
|
|
OfferItemType/SeatItem/ColumnID |
<iata:ColumnID>C</iata:ColumnID> |
| 11 | Seat segment |
association |
|
|
|
|
|
| 12 | Seat total price |
|
|
|
OfferItemType/SeatItem/Price/TotalAmount | <iata:TotalAmount |
CurCode="RUB">500</iata:TotalAmount> | |||||||
| 13 | Seat total price currency |
|
|
| OfferItemType/SeatItem/Price/TotalAmount@CurCode | <iata:TotalAmount |
CurCode="RUB">500</iata:TotalAmount> |
| 14 | Seat base price |
|
|
| OfferItemType/SeatItem/Price/BaseAmount | <iata:BaseAmount CurCode="RUB">3500</iata:BaseAmount> | |
| 15 | Seat base currency |
|
|
| OfferItemType/SeatItem/Price/BaseAmount@CurCode | <iata:BaseAmount CurCode="RUB">3500</iata:BaseAmount> | |
| 16 | Seat percent discount |
|
|
| Use if ServicePrice operation RS include percent discount | OfferItemType/SeatItem/Price/Discount/DiscountPercent | <iata:Discount> |
| 17 | Seat fix (currency) discount |
|
|
|
Use if ServicePrice operation RS include fix discount | OfferItemType/SeatItem/Price |
/Discount/DiscountAmount | <iata:Discount> | ||||||
| 18 | Seat fix (currency) discount currency |
|
|
| Use if ServicePrice operation RS include fix discount | OfferItemType/SeatItem/Price/Discount/DiscountAmount@CurCode | <iata:Discount> |
CurCode="RUB">500</iata:DiscountAmount> |
Discount> |
| 19 | Seat row |
|
|
|
OfferItemType/SeatItem/RowNumber |
<iata:RowNumber>4</iata:RowNumber> |
| 20 | Seat |
association |
|
|
|
OfferItemType/SeatItem/SeatProfileRefID |
<iata:SeatProfileRefID>ST1</iata:SeatProfileRefID> |
| 21 | Meal ID |
|
|
|
OfferItemType/OtherItem/DescText |
<iata:DescText>ML1</iata:DescText> |
| 22 | Meal total price |
|
|
|
OfferItemType/OtherItem/Price/TotalAmount | <iata:TotalAmount |
CurCode="RUB">300</iata:TotalAmount> | |||||||
| 23 | Meal total price currency |
|
|
| OfferItemType/OtherItem/Price/TotalAmount@CurCode | <iata:TotalAmount |
CurCode="RUB">300</iata:TotalAmount> |
| 24 | Meal base price |
|
|
| OfferItemType/OtherItem/Price/BaseAmount | <iata:BaseAmount CurCode="RUB">3500</iata:BaseAmount> | |
| 25 | Meal base currency |
|
|
|
OfferItemType/OtherItem/Price/BaseAmount@CurCode | <iata:BaseAmount CurCode="RUB">3500</iata:BaseAmount> | ||||||
| 26 | Meal percent discount |
|
|
| Use if ServicePrice operation RS include percent discount | OfferItemType/OtherItem/Price/Discount/DiscountPercent | <iata:Discount> |
| 27 | Meal fix (currency) discount |
|
|
| Use if ServicePrice operation RS include fix discount |
OfferItemType/OtherItem/Price |
/Discount/DiscountAmount | <iata:Discount> | ||||||
| 28 | Meal fix (currency) discount currency |
|
|
| Use if ServicePrice operation RS include fix discount | OfferItemType/OtherItem/Price/Discount/DiscountAmount@CurCode | <iata:Discount> |
CurCode="RUB" |
>500</iata:DiscountAmount> |
Discount> |
| 29 | Airline code |
|
|
| S7 |
OwnerCode |
<iata:OwnerCode>S7</iata:OwnerCode> |
| Anchor | ||||
|---|---|---|---|---|
|
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists
Description | Mand | Mult | Default | Ref/Format/Desc | xPath | Example | |
|---|---|---|---|---|---|---|---|
| 1 | Baggage information |
|
|
|
BaggageAllowanceList | |||||||
| 2 | Form of payment |
|
|
| FareList | ||
| 3 | OriginDestination information |
|
|
|
code
PaxJourneyList |
| 4 | Passengers information |
|
|
|
PaxList |
| 5 | Segment information |
|
|
| PaxSegmentList |
| 6 | Seat information |
|
|
| SeatProfileList |
| 7 | Meal information |
|
|
| ServiceDefinitionList |
| Anchor | ||||
|---|---|---|---|---|
|
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/BaggageAllowanceList/BaggageAllowance(Multiple)
Description | Mand | Mult | Default | Ref/Format/Desc | xPath | Example | |
|---|---|---|---|---|---|---|---|
| 1 | OriginDestination |
association |
|
|
|
ApplicableBagText |
<iata:ApplicableBagText>OD1</iata:ApplicableBagText> | |
| 2 | Passenger |
association |
|
|
|
ApplicablePartyText |
<iata:ApplicablePartyText>P2</iata:ApplicablePartyText> | ||||
| 3 | Baggage ID |
|
|
|
BaggageAllowanceID |
<iata:BaggageAllowanceID>BG1</iata:BaggageAllowanceID> | ||||
| 4 | Baggage service code |
|
|
|
0CC
0CD
0DD
0IK
| Code Block |
|---|
DescText |
| Code Block |
|---|
<iata:DescText>0CC</iata:DescText> |
Baggage status
Checked
| Code Block |
|---|
TypeCode |
DescText | <iata:DescText>0CC</iata:DescText> | ||||||
| 5 | Baggage status |
|
|
| TypeCode | <iata:TypeCode>Checked</iata:TypeCode> |
| Anchor | ||||
|---|---|---|---|---|
|
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/FareList
Description | Mand | Mult | Default | Ref/Format/Desc | xPath | Example | |
|---|---|---|---|---|---|---|---|
| 1 | Total price for all ancillaries |
|
|
| FareGroup/FareDetail/FarePriceType/Price/TotalAmount | <iata:Price> | |
| 2 | Total price for all ancillaries currency |
|
|
| FareGroup/FareDetail/FarePriceType/Price/TotalAmount@CurCode | <iata:Price> | |
| 3 | Payment Type |
|
|
| Constant. Always "MS" | FareGroup/FareDetail/PricingSystemCodeText | <iata:PricingSystemCodeText>MS</iata:PricingSystemCodeText> |
| 4 | Form of payment text |
|
|
| *A*FREETEXT | FareGroup/FareDetail/StatisticalCodeText | <iata:StatisticalCodeText>*A*FREETEXT</iata:StatisticalCodeText> |
| Anchor | ||||
|---|---|---|---|---|
|
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/PaxJourneyList/PaxJourney(Multiple)
Description | Mand | Mult | Default | Ref/Format/Desc | xPath | Example | |
|---|---|---|---|---|---|---|---|
| 1 | OriginDestination ID |
|
|
|
PaxJourneyID |
<iata:PaxJourneyID>OD1</iata:PaxJourneyID> | |
| 2 | Segment |
association |
|
|
|
PaxSegmentRefID |
<iata:PaxSegmentRefID>SEG1</iata:PaxSegmentRefID> |
| Anchor | ||||
|---|---|---|---|---|
|
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/PaxList/PaxJourney
/Pax(Multiple)
Description | Mand | Mult | Default | Ref/Format/Desc | xPath | Example | |
|---|---|---|---|---|---|---|---|
| 1 | Passenger ID |
|
|
| PaxID | <iata:PaxID>P2</iata:PaxID> | |
| 2 | Passenger type |
|
|
| ADT - adult CHD - child INF -inf SRC - subsidised adult YTR - subsidised adult CHR - subsidised child INR -subsidised infant | PTC |
|
| Anchor | ||||
|---|---|---|---|---|
|
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/PaxSegmentList/PaxSegment(Multiple)
Description | Mand | Mult | Default | Ref/Format/Desc | xPath | Example | |
|---|---|---|---|---|---|---|---|
| 1 |
Arrival information |
|
|
| Arrival | |||
| 2 | Depature information |
|
|
| Dep | ||
| 3 | Marketing carrier information |
|
|
| MarketingCarrierInfo | ||
| 4 | Operating carrier information |
|
|
| OperatingCarrierInfo | ||
| 5 | Segment ID |
|
|
| PaxSegmentID | <iata:PaxSegmentID>SEG1</iata:PaxSegmentID> |
| Anchor | ||||
|---|---|---|---|---|
|
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/SeatProfileList/SeatProfile(Multiple)
Description | Mand | Mult | Default | Ref/Format/Desc | xPath | Example | |
|---|---|---|---|---|---|---|---|
| 1 | Seat service code |
PaxJourneyID
|
|
| 0B5 | CharacteristicCode | <iata:CharacteristicCode>0B5</iata:CharacteristicCode> | ||
| 2 | Passenger association |
|
|
| CharacteristicCode | <iata:CharacteristicCode>P2</iata:CharacteristicCode> | |
| 3 | Seat service ID |
|
|
| SeatProfileID | <iata:SeatProfileID>ST1</iata:SeatProfileID> |
| Anchor | ||||
|---|---|---|---|---|
|
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/ServiceDefinitionList/ServiceDefinition(Multiple)
Description | Mand | Mult | Default | Ref/Format/Desc | xPath | Example | |
|---|---|---|---|---|---|---|---|
| 1 | Segment association |
|
|
| Desc/DescText | <iata:DescText>SEG1</iata:DescText> | |
| 2 | Passenger association |
|
|
| Desc/DescText | <iata:DescText>P2</iata:DescText> | |
| 3 | Service name |
|
|
| meal | SeatProfileID | <iata:Name>meal</iata:Name> |
| 4 | Meal service code |
|
|
| ServiceCode | <iata:ServiceCode>0AN</iata:ServiceCode> | |
| 5 | Meal service ID |
|
|
| ServiceDefinitionID | <iata:ServiceDefinitionID>ML1</iata:ServiceDefinitionID> |
| Anchor | ||||
|---|---|---|---|---|
|
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/PaxSegmentList/PaxSegment/Arrival
Description | Mand | Mult | Default | Ref/Format/Desc | xPath | Example | |
|---|---|---|---|---|---|---|---|
| 1 | Arrival datetime |
|
|
| AircraftScheduledDateTime | <iata:AircraftScheduledDateTime>2020-12-28T13:35:00</iata:AircraftScheduledDateTime> | |
| 2 | Arrival airport |
|
|
| IATA_LocationCode | <iata:IATA_LocationCode>DME</iata:IATA_LocationCode> |
| Anchor | ||||
|---|---|---|---|---|
|
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/PaxSegmentList/PaxSegment/Dep
Description | Mand | Mult | Default | Ref/Format/Desc | xPath | Example | |
|---|---|---|---|---|---|---|---|
| 1 | Depature datetime |
|
|
| AircraftScheduledDateTime | <iata:AircraftScheduledDateTime>2020-12-28T21:40:00</iata:AircraftScheduledDateTime> | |
| 2 | Depature airport |
|
|
| IATA_LocationCode | <iata:IATA_LocationCode>OVB</iata:IATA_LocationCode> |
| Anchor | ||||
|---|---|---|---|---|
|
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/PaxSegmentList/PaxSegment/MarketingCarrierInfo
Description | Mand | Mult | Default | Ref/Format/Desc | xPath | Example | |
|---|---|---|---|---|---|---|---|
| 1 | Marketing airline code |
|
|
| CarrierDesigCode | <iata:CarrierDesigCode>S7</iata:CarrierDesigCode> | |
| 2 | Marketing airline flight number |
|
|
| MarketingCarrierFlightNumberText | <iata:MarketingCarrierFlightNumberText>2507</iata:MarketingCarrierFlightNumberText> |
| Anchor | ||||
|---|---|---|---|---|
|
/Envelope /Body /IATA_OrderChangeRQ/Request/DataLists/PaxSegmentList/PaxSegment/MarketingCarrierInfo
Description | Mand | Mult | Default | Ref/Format/Desc | xPath | Example | |
|---|---|---|---|---|---|---|---|
| 1 | Operating airline code |
|
|
| CarrierDesigCode | <iata:CarrierDesigCode>S7</iata:CarrierDesigCode> | |
| 2 | Operating airline flight number |
|
|
| OperatingCarrierFlightNumberText | <iata:OperatingCarrierFlightNumberText>2507</iata:OperatingCarrierFlightNumberText> |
| Code Block |
|---|
<iata:PaxJourneyID>OD1</iata:PaxJourneyID> |
Segment reference
| Code Block |
|---|
PaxSegmentRefID |