OrderChange 19.2

Attachments

Introduction

The OrderChange Web service provides Travel Agents with the ability to modify the PNR/Reservation and issue documents

OrderChange Webservice

This service is used to make changes (add/remove services, add/change DOCS, add/change Frequent Flyer Program (FFP), issue E-TKT and EMD). OrderViewRS is a reply on OrderChangeRQ, it returns updated PNR/Reservation.

Limitations (This list is not exhaustive):

PNR should be active at the moment of modification;
ANC services and Seats can be removed per one service in the request;
Supported only Form of payment Cash;
Issue refund EMD.

Add ANC services and Seats request parameters

Several services can be added in one request.

OfferID - returned in ServiceListRS or SeatVailabilityRS;
OfferItemRefID - returned in ServiceListRS or SeatVailabilityRS;
PaxRefID - PAX ID to whom service will be added. Returned in OrderViewRS on OrderRetrieveRQ;
ShoppingResponseRefID - received in ServiceListRS or SeatVailabilityRS;
OrderID - returned in OrderViewRS on OrderRetrieveRQ;
OwnerCode.

Delete ANC and Seats request parameters and Confirm Refund

OfferID - OrderItemID returned in OrderViewRS on OrderRetrieveRQ;
OrderID - returned in OrderViewRS on OrderRetrieveRQ;
OwnerCode.

Add/update DOCS and Frequest Flayer Program (FFP) data reqeust parameters

PaxRefID - PAX ID to whom service will be added. Returned in OrderViewRS on OrderRetrieveRQ;
OrderID - returned in OrderViewRS on OrderRetrieveRQ;
OwnerCode;
PaxID - PAX ID in the DataLists node.

DOCS

Birthdate;
CitizenshipCountryCode;
ExpiryDate;
IdentityDocID;
IdentityDocTypeCode;
IssuingCountryCode.

Frequent Flyer Program

AccountNumber;
ProgramCode.

Accept repriced order to reissue the tickets

OfferRefID - returned in OrderReshopRS;
ShoppingResponseRefID - returned in OrderReshopRS;
OrderID - returned in OrderViewRS on OrderRetrieveRQ;
OwnerCode;

Issue Documents

OrderID - returned in OrderViewRS on OrderRetrieveRQ;
OwnerCode;
OrderItemRefID - returned in OrderViewRS on OrderRetrieveRQ;
TypeCode - Form of payment. Supported value Cash only.

Confirm Refund

OfferRefID - returned in OrderReshopRS;
OrderID - returned in OrderViewRS on OrderRetrieveRQ;
OwnerCode;

Access

In order to access API, you will need to pass the following two headers for each call.

Authentication and authorization stand on the protocol layer using basic HTTP authentication. Given username and password with separator “:” MUST be base64-encoded and passed as HTTP header “Authorization”. This header is mandatory for all requests. For example, if "TestLogin" set as the username and "TestPass" set as the password, then the field's value is: base64-encoding of TestLogin: TestPass, or QWxhZGRpbjpPcGVuU2VzYW1l. Then the Authorization header will appear as: Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l

Header 'Content-Type: text/xml'
Message structure: <soapenv:Envelope><soapenv:Body> Message... </soapenv:Body></soapenv:Envelope>

OrderChangeRQ structure

OrderChangeRQ. Add ANC and Seat

<IATA_OrderChangeRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ ../NDC/19_2_schemas/IATA_OrderChangeRQ.xsd">
	<MessageDoc>
		<RefVersionNumber>19.2</RefVersionNumber>
	</MessageDoc>
	<Party>
		<Sender>
			<TravelAgency>
				<AgencyID>TA123</AgencyID>
				<Name>AgentName</Name>
				<PseudoCityID>IEVPS28NDC</PseudoCityID>
			</TravelAgency>
		</Sender>
	</Party>
	<Request>
		<ChangeOrder>
			<UpdateOrderItem>
				<AcceptOffer>
					<SelectedOffer>
						<OfferRefID>1d4ab6ed2af7106e20430bfd</OfferRefID>
						<OwnerCode>PS</OwnerCode>
						<SelectedOfferItem>
							<OfferItemRefID>AncillaryMeal:5d4ab6ed2af7106e20430bfd</OfferItemRefID>
							<PaxRefID>PAX1</PaxRefID>
						</SelectedOfferItem>
						<SelectedOfferItem>
							<OfferItemRefID>AncillaryBag:5ef31712699e9b26b3149ff3</OfferItemRefID>
							<PaxRefID>PAX1</PaxRefID>
						</SelectedOfferItem>
						<SelectedOfferItem>
							<OfferItemRefID>AncillaryMeal:5ef31712699e9b26b3149ff2</OfferItemRefID>
							<PaxRefID>PAX1</PaxRefID>
						</SelectedOfferItem>
						<ShoppingResponseRefID>a37f7bae-c5ed-40db-a661-4539c73c05df</ShoppingResponseRefID>
					</SelectedOffer>
					<SelectedOffer>
						<OfferRefID>2d4ab6ed2af7106e20430bss</OfferRefID>
						<OwnerCode>PS</OwnerCode>
						<SelectedOfferItem>
							<OfferItemRefID>AncillarySeat:5ef31712699e9b26b3149ff0</OfferItemRefID>
							<PaxRefID>PAX1</PaxRefID>
						</SelectedOfferItem>
						<SelectedOfferItem>
							<OfferItemRefID>AncillarySeat:5ef31712699e9b26b3149ff1</OfferItemRefID>
							<PaxRefID>PAX2</PaxRefID>
						</SelectedOfferItem>
						<SelectedOfferItem>
							<OfferItemRefID>AncillarySeat:5ef31712699e9b26b3149ff2</OfferItemRefID>
							<PaxRefID>PAX3</PaxRefID>
						</SelectedOfferItem>
						<ShoppingResponseRefID>b37f7bae-c5ed-40db-a661-4539c73c05bb</ShoppingResponseRefID>
					</SelectedOffer>
				</AcceptOffer>
			</UpdateOrderItem>
		</ChangeOrder>
		<DataLists>
			<PaxList>
				<Pax>
					<PaxID>PAX1</PaxID>
				</Pax>
				<Pax>
					<PaxID>PAX2</PaxID>
				</Pax>
				<Pax>
					<PaxID>PAX3</PaxID>
				</Pax>
			</PaxList>
		</DataLists>
		<Order>
			<OrderID>92878857-b173-4af9-bd75-60da96f30b09</OrderID>
			<OwnerCode>PS</OwnerCode>
		</Order>
	</Request>
</IATA_OrderChangeRQ>

OrderChangeRQ. Delete ANC

<IATA_OrderChangeRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ ../NDC/19_2_schemas/IATA_OrderChangeRQ.xsd">
	<MessageDoc>
		<RefVersionNumber>19.2</RefVersionNumber>
	</MessageDoc>
	<Party>
		<Sender>
			<TravelAgency>
				<AgencyID>TA123</AgencyID>
				<Name>AgentName</Name>
				<PseudoCityID>IEVPS28NDC</PseudoCityID>
			</TravelAgency>
		</Sender>
	</Party>
	<Request>
		<ChangeOrder>
			<UpdateOrderItem>
				<DeleteOrderItem>
					<OfferID>AncillaryLuggage:5f74a6b64eb9b706ee6b4cef</OfferID> <!-- OrderItemID returned in OrderViewRS -->
				</DeleteOrderItem>
			</UpdateOrderItem>
		</ChangeOrder>
		<Order>
			<OrderID>92878857-b173-4af9-bd75-60da96f30b09</OrderID>
			<OwnerCode>PS</OwnerCode>
		</Order>
	</Request>
</IATA_OrderChangeRQ>

OrderChangeRQ. DOCS and FFP update

<IATA_OrderChangeRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ ../NDC/19_2_schemas/IATA_OrderChangeRQ.xsd">
	<MessageDoc>
		<RefVersionNumber>19.2</RefVersionNumber>
	</MessageDoc>
	<Party>
		<Sender>
			<TravelAgency>
				<AgencyID>TA123</AgencyID>
				<Name>AgentName</Name>
				<PseudoCityID>IEVPS28NDC</PseudoCityID>
			</TravelAgency>
		</Sender>
	</Party>
	<Request>
		<ChangeOrder>
			<UpdatePax>
				<Current>
					<PaxRefID>PAX1</PaxRefID>
				</Current>
			</UpdatePax>
		</ChangeOrder>
		<DataLists>
			<PaxList>
				<Pax>
					<IdentityDoc>
						<Birthdate>2000-11-07</Birthdate>
						<CitizenshipCountryCode>UA</CitizenshipCountryCode>
						<ExpiryDate>2021-11-07</ExpiryDate><!-- Date format 1980-09-25T00:00:00 is not allowd -->
						<IdentityDocID>ABC7891</IdentityDocID>
						<IdentityDocTypeCode>PT</IdentityDocTypeCode>
						<IssuingCountryCode>UA</IssuingCountryCode>
					</IdentityDoc>
					<LoyaltyProgramAccount>
						<AccountNumber>2342342342</AccountNumber>
						<LoyaltyProgram>
							<ProgramCode>PC</ProgramCode>
						</LoyaltyProgram>
					</LoyaltyProgramAccount>
					<LoyaltyProgramAccount>
						<AccountNumber>2342342555</AccountNumber>
						<LoyaltyProgram>
							<ProgramCode>PCC</ProgramCode>
						</LoyaltyProgram>
					</LoyaltyProgramAccount>
					<PaxID>PAX1</PaxID>
				</Pax>
			</PaxList>
		</DataLists>
		<Order>
			<OrderID>92878857-b173-4af9-bd75-60da96f30b09</OrderID>
			<OwnerCode>PS</OwnerCode>
		</Order>
	</Request>
</IATA_OrderChangeRQ>

OrderChangeRQ. Accept OrderReshop offer

<IATA_OrderChangeRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ ../NDC/19_2_schemas/IATA_OrderChangeRQ.xsd">
	<MessageDoc>
		<RefVersionNumber>19.2</RefVersionNumber>
	</MessageDoc>
	<Party>
		<Sender>
			<TravelAgency>
				<AgencyID>TA123</AgencyID>
				<Name>AgentName</Name>
				<PseudoCityID>IEVPS28NDC</PseudoCityID>
			</TravelAgency>
		</Sender>
	</Party>
	<Request>
		<ChangeOrder>
			<AcceptRepricedOrder>
				<OfferRefID>bdd9fc4b-7648-49d8-8950-23835e0a2a8f</OfferRefID>
				<!-- Returned in OrderReshopRS -->
				<ShoppingResponseRefID>3e1efac2-ce51-4d4e-8134-eb31d7f224e2</ShoppingResponseRefID>
				<!-- Returned in OrderReshopRS -->
			</AcceptRepricedOrder>
		</ChangeOrder>
		<Order>
			<OrderID>92878857-b173-4af9-bd75-60da96f30b09</OrderID>
			<!-- Returned in OrderViewRS -->
			<OwnerCode>PS</OwnerCode>
		</Order>
	</Request>
</IATA_OrderChangeRQ>

OrderChangeRQ. Issue TKT and EMD

<IATA_OrderChangeRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ ../NDC/19_2_schemas/IATA_OrderChangeRQ.xsd">
	<MessageDoc>
		<RefVersionNumber>19.2</RefVersionNumber>
	</MessageDoc>
	<Party>
		<Sender>
			<TravelAgency>
				<AgencyID>TA123</AgencyID>
				<Name>AgentName</Name>
				<PseudoCityID>IEVPS28NDC</PseudoCityID>
			</TravelAgency>
		</Sender>
	</Party>
	<Request>
		<Order>
			<OrderID>92878857-b173-4af9-bd75-60da96f30b09</OrderID>
			<OwnerCode>PS</OwnerCode>
		</Order>
		<PaymentFunctions>
			<PaymentMethodCriteria>
				<OrderAssociation>
					<OrderItemRefID>OD-PAX1</OrderItemRefID>
					<OrderItemRefID>OD-PAX2</OrderItemRefID>
					<OrderItemRefID>AncillaryLuggage5f5201077ee3a80b2e65dbed</OrderItemRefID>
					<OrderItemRefID>AncillarySeatfed86bac-3313-4cf9-9765-f161af0f8970</OrderItemRefID>
					<OrderItemRefID>AncillaryMealed86bac-3313-4cf9-9765-f161af0f1111</OrderItemRefID>
				</OrderAssociation>
				<TypeCode>Cash</TypeCode>
			</PaymentMethodCriteria>
		</PaymentFunctions>
	</Request>
</IATA_OrderChangeRQ>

OrderChangeRQ. Confirm Refund

<IATA_OrderChangeRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ">
	<MessageDoc>
		<RefVersionNumber>19.2</RefVersionNumber>
	</MessageDoc>
	<Party>
		<Sender>
			<TravelAgency>
				<AgencyID>TA123</AgencyID>
				<Name>AgentName</Name>
				<PseudoCityID>IEVPS28ND</PseudoCityID>
			</TravelAgency>
		</Sender>
	</Party>
	<Request>
		<ChangeOrder>
			<UpdateOrderItem>
				<DeleteOrderItem>
					<OfferID>RefundID1</OfferID>
					<OfferID>RefundID2</OfferID>
				</DeleteOrderItem>
			</UpdateOrderItem>
		</ChangeOrder>
		<Order>
			<OrderID>a79cbabb-6e00-43fc-9104-ca4a584a81ed</OrderID>
			<OwnerCode>PS</OwnerCode>
		</Order>
	</Request>
</IATA_OrderChangeRQ>

OrderChangeRQ fields description

M = Mandatory; O = Optional; C = Conditional

Field name	Description	M/O/C	Example
IATA_OrderChangeRQ	The ServiceList transaction set returns a list of all applicable ancillary services that meet request qualifiers and flights. The message also returns multi-media content at the message level and media references at the individual service level.	M O	<IATA_OrderChangeRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderChangeRQ ../NDC/19_2_schemas/IATA_OrderChangeRQ.xsd">
↳ MessageDoc	NDC Message Document information.	M
↳ RefVersionNumber	Service Version.	M	<RefVersionNumber>19.2</RefVersionNumber>
↳ Party	NDC Message/ Transaction Party(s) information. Note that information about parties is intended for business use, it is not intended for transaction authentication and routing of the message.	M
↳ Sender	Information related to the party sending this message.	M
↳ TravelAgency	SELLER: Travel Agency	M
↳ AgencyID	Unique Agency Seller ID. Example: TA123	M	<AgencyID>TA123</AgencyID>
↳ Name	Agency name. Example: Carson Travel	M	<Name>TravelAgent</Name>
↳ PseudoCityID	Travel Agent's Office ID.	M	<PseudoCityID>IEVPS28ND</PseudoCityID>
↳ Request	Order Change Query.	M
↳ ChangeOrder
↳ AcceptRepricedOrder	Function used by seller to inform the airline that it is accepting the proposed Order, as it has been repriced and returned in the preceding OrderReshopRS.	C
↳ OfferRefID	Reference to an Offer ID for which this Payment applies.	M	<OfferRefID>bdd9fc4b-7648-49d8-8950-23835e0a2a8f</OfferRefID>
↳ ShoppingResponseRefID	Reference to a shopping response ID.	M	<ShoppingResponseRefID>3e1efac2-ce51-4d4e-8134-eb31d7f224e2</ShoppingResponseRefID>
↳ UpdateOrderItem	Collection of functions used by the seller to request the airline to commit changes to an existing Order.	C
↳ AcceptOffer	Function to accept a new OfferItem and adding it to the existing Order.	C
↳ SelectedOffer	Offer selected by the Passenger for requesting an Order to be created. Multiple Offers can be requested at the same time, each of which could originate from different shopping responses.	M
↳ OfferRefID	Reference to the OfferID of the selected Offer (either a standard Offer or an a-la-carte Offer) returned in a previous shopping response.	M	<OfferRefID>1d4ab6ed2af7106e20430bfd</OfferRefID>
↳ OwnerCode	Designator of Airline that owns/ assigned these IDs	M	<OwnerCode>PS</OwnerCode>
↳ SelectedOfferItem	OfferItem selected by the Passenger for inclusion in the requested Order. Repeat occurrence of OfferItem (once per passenger) if different passengers want to select different service options, different quantities of a-la-carte items or different seat locations.	M
↳ OfferItemRefID	Reference to the OfferItemID of the selected OfferItem (contained in either a standard Offer or an a-la-carte Offer) returned in a previous shopping response.	M	<OfferItemRefID>AncillaryMeal:5d4ab6ed2af7106e20430bfd</OfferItemRefID>
↳ PaxRefID	Reference to passenger(s) for which this OfferItem and selected Services (in case of Service Bundles) applies.	M	<PaxRefID>PAX1</PaxRefID>
↳ ShoppingResponseRefID	Reference to unique shopping session response ID, as provided in the airline's previous shopping response.	M	<ShoppingResponseRefID>a37f7bae-c5ed-40db-a661-4539c73c05df</ShoppingResponseRefID>
↳ DeleteOrderItem	Function to accept the deletion of an OrderItem from the existing Order.	C
↳ OfferID	Carrier assigned ID which uniquely identifies a specific Offer across several messages.	M	<OfferID>AncillaryLuggage:5f74a6b64eb9b706ee6b4cef</OfferID>
↳ UpdatePax	Function to Add, Remove or Update the Passenger Details.	C
↳ Current	Any person except members of the crew carried or to be carried with the consent of the carrier, on board of any transport vehicle such as aircraft, train, bus, ship. Holds the attributes specific to one booking, from shopping to fulfilment.	M
↳ PaxRefID	Reference to a Pax ID within this message.	M	<PaxRefID>PAX1</PaxRefID>
↳ DataLists	Data List definition for this message.	O
↳ PaxList	Passenger data list definition.	M
↳ Pax	Any person except members of the crew carried or to be carried with the consent of the carrier, on board of any transport vehicle such as aircraft, train, bus, ship. Holds the attributes specific to one booking, from shopping to fulfilment.	M
↳ IdentityDoc	Any document which may be used to identify a person or verify aspects of a person's personal identity.	O
↳ Birthdate	The date on which an individual was born.	M	<Birthdate>1980-09-25</Birthdate>
↳ CitizenshipCountryCode	ISO Country Code	M	<CitizenshipCountryCode>UA</CitizenshipCountryCode>
↳ ExpiryDate	The date the identity document expires.	M	<ExpiryDate>2021-11-07</ExpiryDate>
↳ IdentityDocID	Uniquely identifies the document from all other identity documents issued by the state or organization.	M	<IdentityDocID>ABC7891</IdentityDocID>
↳ IdentityDocTypeCode	The type of passenger document.	M	<IdentityDocTypeCode>PT</IdentityDocTypeCode>
↳ IssuingCountryCode	ISO Country Code	M	<IssuingCountryCode>UA</IssuingCountryCode>
↳ LoyaltyProgramAccount	An account set up for a customer within a rewards program which holds funds on behalf of that customer.	O
↳ AccountNumber	Loyalty Program account number.	O	<AccountNumber>2342342555</AccountNumber>
↳ LoyaltyProgram	A rewards program offered by a company to customers who frequently make purchases, which may give a customer advanced access to new products, special sales coupons or free merchandise.	M
↳ ProgramCode	Loyalty Program ID Supported codes: PC - Panorama Club PCC - Panorama Club Corporate	M	<ProgramCode>PC</ProgramCode>
↳ PaxID	Uniquely identifies a Passenger within the context of one message.	M	<PaxID>PAX1</PaxID>
↳ Order	A uniquely identified record of the agreement of one party with another to receive products and services under specified terms and conditions.	M
↳ OrderID	Carrier assigned ID which uniquely identifies a specific Order across several messages.	M	<OrderID>92878857-b173-4af9-bd75-60da96f30b09</OrderID>
↳ OwnerCode	Airline code assigned to a carrier.	M	<OwnerCode>PS</OwnerCode>
↳ PaymentFunctions	Is the container of all payment relevant functions.	O
↳ PaymentMethodCriteria	Criteria for: A form of procedure for the payment of goods or services, plus any transactional information specific to the payment method other than the amount.	M
↳ OrderAssociation	Associations to Offers and Offer Items.	M
↳ OrderItemRefID	Reference to an Offer ID for which the payment preference applies.	M	<OrderItemRefID>AncillaryMealed86bac-3313-4cf9-9765-f161af0f1111</OrderItemRefID>
↳ TypeCode	The payment method type. Only supported value Cash.	M	<TypeCode>Cash</TypeCode>

Errors and Warnings

In case warning received in the OrderVieweRS it is recommended to re-request Service catalogue and repeat OrderChangeRQ call with valid service.

Click here to expand...

PADIS Error Code	PADIS Error Text	Cases
System errors
911	Unable to process - system error / Invalid query	Invalid query
486	Unknown	The equivalent of -1 error
304	System Temporarily unavailable	The system is not available/HOST problem
916	EDIFACT version not supported	Not supported NDC service version.
Agent authorization errors
368	Not authorized	Wrong agent authentication key. Agent is inactive
79A	Invalid office identification	OID is missing or incorrect
Query errors
719	No fares available	No fares on the requested PAX types
911	Unable to process - system error / Invalid ResponseID	Invalid ResponseID
486	Unknown - Can't find search product by id	Invalid OfferID
911	Unable to process - system error / ResponseID does not match OfferID	ResponseID does not match OfferID
486	Unknown - Invalid Passenger Reference	Invalid Passenger Reference
903	Unable to process – syntax error / Invalid Gender	Invalid Gender
143	Invalid or Ineligible Passenger Type Code	Invalid PAX type
914	Invalid format/data - data does not match syntax rules	Incorrect date format
73	Invalid age for PTC	Age validation per PTC failed
718	Invalid or missing document type	Invalid data in IdentityDocument. Expiry Date is older than last flight departure date
376	Pricing/ticketing error, text information specified	Error on TST creation step
702	Error at End of Transaction	PNR commit fails.
348	Invalid flight status	Flight HK status is not received
293	Unable to Sell Due to Sales Limit being Reached	Offer limit has been expired
768	Changes not allowed on re-priced segments - process manually	Refund EMD is present in the PNR.
900	Inactivity Timeout Value Exceeded	Offer limit has been expired