OrderRetrieve 19.2 (Standalone)

Attachments:

Introduction

The OrderRetrieve Webservice provides Travel Agents with the ability to retrieve the order.

This service returns the order details along with TKT/EMD details. OrderViewRS is a reply on OrderRetrieveRQ, it returns PNR/Reservation details. 

OrderRetrieve Webservice

This service returns the order details. This service can only be used on existing bookings. 

Limitations (This list is not exhaustive)


  • PNR which was not created by the requester is not returned 
  • Other Airline's business rules can influence on PNR retrieve functionality

This web service is called with the following inputs:

  • Booking/PNR reference

The output data this service returns include:

  • OrderID (Booking reference or PNR reference)
  • Passenger details
  • Price details
  • Ancillary service details
  • Flight details
  • Payment Time Limit (OPC/Ticket Time Limit), if applicable
  • Commission info 
  • Bag details
  • E-TKT details with passenger association
  • EMD details with passenger association
  • Error message if something went wrong during payment or ticketing process

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>

OrderRetrieveRQ structure

OrderRetrieveRQ
<IATA_OrderRetrieveRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderRetrieveRQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderRetrieveRQ NDC/19_2_schemas/IATA_OrderRetrieveRQ.xsd">
	<MessageDoc>
		<RefVersionNumber>19.2</RefVersionNumber>
	</MessageDoc>
	<Party>
		<Sender>
			<TravelAgency>
				<AgencyID>TA123</AgencyID>
				<Name>TravelAgent</Name>
				<PseudoCityID>IEVPS28ND</PseudoCityID>
			</TravelAgency>
		</Sender>
	</Party>
	<Request>
		<OrderFilterCriteria>
			<BookingRefFilterCriteria>
				<BookingEntity>
					<Carrier>
						<AirlineDesigCode>PS</AirlineDesigCode>
					</Carrier>
				</BookingEntity>
				<BookingID>PNR123</BookingID>
			</BookingRefFilterCriteria>
		</OrderFilterCriteria>
	</Request>
</IATA_OrderRetrieveRQ>
  OrderRetrieveRQ fields description

M = Mandatory; O = Optional; C = Conditional

Field name

Description

M/O/C

Example

OrderCreateRQ

The OrderRetrieve/ OrderView transaction set retrieves a specified order that matches one or more search criteria.

M


<IATA_OrderRetrieveRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderRetrieveRQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderRetrieveRQ NDC/19_2_schemas/IATA_OrderRetrieveRQ.xsd">

↳ MessageDoc

NDC Message Document information.M


   ↳ RefVersionNumberService 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>
↳ RequestOrder retrieve request information.M
   ↳ OrderFilterCriteriaOrder list request filter criteria.M
      ↳ BookingRefFilterCriteriaInformation related to booking or reservation.M
         ↳ BookingEntityAirline or Organization assigning the booking information.M
            ↳ CarrierThe organization which carries the passenger.M
               ↳ AirlineDesigCodeAirline code assigned to a carrier.M

<AirlineDesigCode>PS</AirlineDesigCode>

         ↳ BookingIDExisting booking reference Identifier.M

<BookingID>PNR123</BookingID>

OrderRetrieve Error/Validation Checks

 Click here to expand...
PADIS Error CodePADIS Error TextCases
System errors
911Unable to process - system error / Invalid queryInvalid query
486UnknownThe equivalent of -1 error
304System Temporarily unavailableThe system is not available/HOST problem
916EDIFACT version not supportedNot supported NDC service version.
Agent authorization errors
368Not authorizedWrong agent authentication key. Agent is inactive
79AInvalid office identificationOID is missing or incorrect
Query errors

129 

No PNR Match FoundInvalid PNR locator
912 Incomplete message - data missing in queryMandatory parameters are missing in the query
486PNR cancelledPNR is cancelled or does not have flight segments



© 2021 SOLRING HOLDINGS LIMITED. All rights reserved.