OrderChange operation

The order change method allows to make additional updates after order creation in the airline system. For example, it must be used to

  • add payment to issue tickets
  • accept disruption (schedule change)

Table of contents

  1. Release notes
  2. Mandatory HTTP header
  3. OrderChangeRQ
  4. OrderChange - OrderViewRS
  5. Samples

Release notes

VersionNotes
1.0Initial version.

Mandatory HTTP header

  • AuthToken: token value retrieved from login response

OrderChangeRQ

ElementDescriptionOptional/Mandatory
PartyMust contain agency ID as senderMandatory
PayloadAttributesVersion + CorrelationID (to group log messages)Optional
RequestThe request element detailed belowMandatory

Request

ElementDescriptionOptional/Mandatory
DataListsThe request data lists detailed belowMandatory
OrderThe order to change, detailed belowMandatory
PaymentFunctionsMust contain an element ‘PaymentProcessingDetails’ with Cash method to issue ticketsMandatory for ticket issue
ChangeOrderMust contain an element ‘AcceptChange’ with order item references to accept disruptionMandatory for disruption acceptance

DataLists

ElementDescriptionOptional/Mandatory
ContactInfoListList of contactsOptional
PaxListList of passengersOptional

Order

ElementDescriptionOptional/Mandatory
OrderIDID of the order to changeMandatory

OrderChange - OrderViewRS

ElementDescriptionOptional/Mandatory
PayloadAttributesSame as requested + timestampMandatory
ResponseThe response element detailed belowMandatory
PaymentFunctionsPayment information used to issue ticketsMandatory if ticket issued

Response

ElementDescriptionOptional/Mandatory
WarningsList of warnings returned by providerOptional
DataListsThe response data lists (journeys, segments, service definitions, etc)Mandatory
OrderThe order element detailed belowMandatory
TicketDocInfoList of tickets issued for each passengers, detailed belowMandatory if ticket issued

Order

ElementDescriptionOptional/Mandatory
OrderIDThe order ID (to use for servicing)Mandatory
BookingRefsList of booking referencesMandatory
StatusCodeThe order status
  • OPENED: order confirmed
  • CLOSED: order cancelled
Mandatory
TotalPriceThe total price of the whole orderMandatory
OrderItemsList of order items detailed belowMandatory

OrderItem

ElementDescriptionOptional/Mandatory
OrderItemIDID of the order itemMandatory
FareDetailContains the PAX associations, the unit price in FarePriceType, and more information for each segment in FareComponentMandatory
PriceThe total price of this offer itemMandatory
ServicesList of flight/serviceDefinition associations with PAX and StatusCode:
  • SB: issuance in progress (waiting to be confirmed, OrderRetrieveRQ has to be called periodically until status is updated)
  • T: tickets issued
Mandatory

TicketDocInfo

ElementDescriptionOptional/Mandatory
BookingRefThe booking reference linkedMandatory
PaxRefIDThe passenger reference linked to the ticketsMandatory
TicketList of tickets for the given booking reference and passenger reference, detailed belowMandatory

Ticket

ElementDescriptionOptional/Mandatory
CouponThe coupon informationMandatory
ReportingTypeCodeBSPMandatory
TicketDocTypeCodeThe ticket type: T (ticket), J (EMD-Associated), Y (EMD-Standalone)Mandatory
TicketNumberThe ticket numberMandatory

Samples

OrderChangeRQ - Ticket Issue
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<IATA_OrderChangeRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ">
    <Party>
        <Sender>
            <TravelAgency>
                <AgencyID>agency1234</AgencyID>
            </TravelAgency>
        </Sender>
    </Party>
    <PayloadAttributes>
        <CorrelationID>dbc121be-c27b-4b63-9eab-5e73dfb8b6c4</CorrelationID>
        <VersionNumber>19.2</VersionNumber>
    </PayloadAttributes>
    <Request>
        <DataLists>
            <ContactInfoList>
                <ContactInfo>
                    <ContactInfoID>CONT1</ContactInfoID>
                    <EmailAddress>
                        <EmailAddressText>florian.garnier@orchestra.eu</EmailAddressText>
                    </EmailAddress>
                    <Phone>
                        <AreaCodeNumber></AreaCodeNumber>
                        <CountryDialingCode>33</CountryDialingCode>
                        <PhoneNumber>0622761972</PhoneNumber>
                    </Phone>
                    <PostalAddress>
                        <CityName>Paris</CityName>
                        <CountryCode>FR</CountryCode>
                        <PostalCode>75002</PostalCode>
                        <StreetText>38 avenue de l'opera</StreetText>
                    </PostalAddress>
                </ContactInfo>
            </ContactInfoList>
            <PaxList>
                <Pax>
                    <Birthdate>1986-02-02</Birthdate>
                    <ContactInfoRefID>CONT1</ContactInfoRefID>
                    <Individual>
                        <Birthdate>1986-02-02</Birthdate>
                        <GivenName>Florian</GivenName>
                        <IndividualID>IND1</IndividualID>
                        <Surname>Garnier</Surname>
                        <TitleName>MR</TitleName>
                    </Individual>
                    <PaxID>PAX1</PaxID>
                    <PTC>ADT</PTC>
                </Pax>
                <Pax>
                    <Birthdate>1986-03-03</Birthdate>
                    <ContactInfoRefID>CONT1</ContactInfoRefID>
                    <Individual>
                        <Birthdate>1986-03-03</Birthdate>
                        <GivenName>Floria</GivenName>
                        <IndividualID>IND2</IndividualID>
                        <Surname>Garnier</Surname>
                        <TitleName>MRS</TitleName>
                    </Individual>
                    <PaxID>PAX2</PaxID>
                    <PTC>ADT</PTC>
                </Pax>
            </PaxList>
        </DataLists>
        <Order>
            <OrderID>544755</OrderID>
            <OwnerCode>BA</OwnerCode>
        </Order>
        <PaymentFunctions>
            <PaymentProcessingDetails>
                <Amount CurCode="EUR">690.32000000000000000000</Amount>
                <OrderAssociation>
                    <OrderItemRefID>32764ce2-5548-4498-b36f-58a10c3906f9</OrderItemRefID>
                    <OrderItemRefID>1dbb3411-1bc3-4e6c-896e-b90cc7a585b6</OrderItemRefID>
                    <OrderItemRefID>6863b890-9fae-4dee-928c-5387050fda95</OrderItemRefID>
                    <OrderItemRefID>55fe8531-08db-4b23-afe3-00f9c467c1bd</OrderItemRefID>
                </OrderAssociation>
                <PaymentMethod>
                    <Cash/>
                </PaymentMethod>
                <TypeCode>CA</TypeCode>
            </PaymentProcessingDetails>
        </PaymentFunctions>
    </Request>
</IATA_OrderChangeRQ>
OrderViewRS - Ticket Issue
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<IATA_OrderViewRS xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderViewRS">
    <Response>
        <DataLists>
            <ContactInfoList>
                <ContactInfo>
                    <ContactInfoID>CONT1</ContactInfoID>
                    <EmailAddress>
                        <EmailAddressText>florian.garnier@orchestra.eu</EmailAddressText>
                    </EmailAddress>
                    <PostalAddress>
                        <CityName>Paris</CityName>
                        <CountryCode>FR</CountryCode>
                        <PostalCode>75002</PostalCode>
                        <StreetText>38 avenue de l'opera</StreetText>
                    </PostalAddress>
                </ContactInfo>
            </ContactInfoList>
            <PaxList>
                <Pax>
                    <Birthdate>1986-02-02+01:00</Birthdate>
                    <ContactInfoRefID>CONT1</ContactInfoRefID>
                    <PaxID>PAX1</PaxID>
                    <PTC>ADT</PTC>
                </Pax>
                <Pax>
                    <Birthdate>1986-03-03+01:00</Birthdate>
                    <ContactInfoRefID>CONT1</ContactInfoRefID>
                    <PaxID>PAX2</PaxID>
                    <PTC>ADT</PTC>
                </Pax>
            </PaxList>
        </DataLists>
        <Order>
            <BookingRef>
                <BookingEntity>
                    <Carrier>
                        <AirlineDesigCode>BA</AirlineDesigCode>
                    </Carrier>
                </BookingEntity>
                <BookingID>T72IXL</BookingID>
            </BookingRef>
            <OrderID>544755</OrderID>
        </Order>
        <TicketDocInfo>
            <BookingRef>
                <BookingEntity>
                    <Carrier>
                        <AirlineDesigCode>BA</AirlineDesigCode>
                    </Carrier>
                </BookingEntity>
                <BookingID>T72IXL</BookingID>
            </BookingRef>
            <PaxRefID>PAX3</PaxRefID>
            <PaymentInfoRefID>PAY1</PaymentInfoRefID>
            <Ticket>
                <Coupon>
                    <CouponNumber>1</CouponNumber>
                    <CouponStatusCode>I</CouponStatusCode>
                </Coupon>
                <ReportingTypeCode>BSP</ReportingTypeCode>
                <TicketDocTypeCode>T</TicketDocTypeCode>
                <TicketNumber>125</TicketNumber>
            </Ticket>
            <Ticket>
                <Coupon>
                    <CouponNumber>1</CouponNumber>
                    <CouponStatusCode>I</CouponStatusCode>
                </Coupon>
                <ReportingTypeCode>BSP</ReportingTypeCode>
                <TicketDocTypeCode>T</TicketDocTypeCode>
                <TicketNumber>2113793590</TicketNumber>
            </Ticket>
        </TicketDocInfo>
        <TicketDocInfo>
            <BookingRef>
                <BookingEntity>
                    <Carrier>
                        <AirlineDesigCode>BA</AirlineDesigCode>
                    </Carrier>
                </BookingEntity>
                <BookingID>T72IXL</BookingID>
            </BookingRef>
            <PaxRefID>PAX4</PaxRefID>
            <PaymentInfoRefID>PAY1</PaymentInfoRefID>
            <Ticket>
                <Coupon>
                    <CouponNumber>1</CouponNumber>
                    <CouponStatusCode>I</CouponStatusCode>
                </Coupon>
                <ReportingTypeCode>BSP</ReportingTypeCode>
                <TicketDocTypeCode>T</TicketDocTypeCode>
                <TicketNumber>125</TicketNumber>
            </Ticket>
            <Ticket>
                <Coupon>
                    <CouponNumber>1</CouponNumber>
                    <CouponStatusCode>I</CouponStatusCode>
                </Coupon>
                <ReportingTypeCode>BSP</ReportingTypeCode>
                <TicketDocTypeCode>T</TicketDocTypeCode>
                <TicketNumber>2113793591</TicketNumber>
            </Ticket>
        </TicketDocInfo>
    </Response>
    <PayloadAttributes>
        <CorrelationID>dbc121be-c27b-4b63-9eab-5e73dfb8b6c4</CorrelationID>
        <Timestamp>2021-02-04T09:40:28.309+01:00</Timestamp>
        <VersionNumber>19.2</VersionNumber>
    </PayloadAttributes>
    <PaymentFunctions>
        <PaymentProcessingSummary>
            <Amount CurCode="EUR">690.32</Amount>
            <PaymentID>PAY1</PaymentID>
            <PaymentMethod>
                <Cash/>
            </PaymentMethod>
            <TypeCode>Cash</TypeCode>
        </PaymentProcessingSummary>
    </PaymentFunctions>
</IATA_OrderViewRS>
OrderChangeRQ - Accept disruption
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<IATA_OrderChangeRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ">
    <Party>
        <Sender>
            <TravelAgency>
                <AgencyID>agency1234</AgencyID>
            </TravelAgency>
        </Sender>
    </Party>
    <PayloadAttributes>
        <CorrelationID>dbc121be-c27b-4b63-9eab-5e73dfb8b6c4</CorrelationID>
        <VersionNumber>19.2</VersionNumber>
    </PayloadAttributes>
    <Request>
        <ChangeOrder>
            <AcceptChange>
                <OrderItemRefID>32764ce2-5548-4498-b36f-58a10c3906f9</OrderItemRefID>
                <OrderItemRefID>1dbb3411-1bc3-4e6c-896e-b90cc7a585b6</OrderItemRefID>
            </AcceptChange>
        </ChangeOrder>
        <Order>
            <OrderID>544755</OrderID>
            <OwnerCode>BA</OwnerCode>
        </Order>
    </Request>
</IATA_OrderChangeRQ>