OrderCreate 19.2

Attachments:

Introduction

The OrderCreate Webservice provides Travel Agents with the ability to create reservations. OrderViewRS is a reply on OrderCreateRQ, it returns PNR/Reservation details. The service also returns BilateralTimeLimit (Ticket Time Limit). The client must pay for the booking using OrderChange Webservice before the time limit expires otherwise booking will automatically be cancelled.

OrderCreate Webservice

This service creates an Order (PNR)

Limitations (This list is not exhaustive)

The service supports the creation of bookings, for parties of up to 9 passengers
Itinerary with only children passengers and with only infant passengers will not be priced
Unaccompanied minors

This web service is called with the following inputs:

OfferID and ShoppingResponseID are returned in the previous AirShopping or FlightPrice response
Passengers name details
Passengers documents details
Contacts details

The output data this service returns include:

Booking reference (PNR)
Offer Expiry Time Limit and Price Guarantee Time Limit
Passengers name details
Passengers documents details
Contacts details
Total Order Price
Tax breakdown
Base amount
Fare base code and Record Booking Designator (RBD)
Flight details such as Flight Number, Flight schedule information, Equipment, Cabin, etc.
Checked baggage details

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>

OrderCreateRQ structure

OrderCreateRQ

<IATA_OrderCreateRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCreateRQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCreateRQ NDC/19_2_schemas/IATA_OrderCreateRQ.xsd">
	<MessageDoc>
		<RefVersionNumber>19.2</RefVersionNumber>
	</MessageDoc>
	<Party>
		<Sender>
			<TravelAgency>
				<AgencyID>TA123</AgencyID>
				<Name>TravelAgent</Name>
				<PseudoCityID>IEVPS28ND</PseudoCityID>
			</TravelAgency>
		</Sender>
	</Party>
	<Request>
		<Commission>
			<Amount CurCode="UAH">1</Amount>
			<!-- OR <Percentage>5</Percentage>-->
		</Commission>
		<CreateOrder>
			<SelectedOffer>
				<OfferRefID>97482365-a144-4009-b280-6a8cddf59f42</OfferRefID>
				<OwnerCode>PS</OwnerCode>
				<SelectedOfferItem>
					<OfferItemRefID>97482365-a144-4009-b280-6a8cddf59f42-PAX1</OfferItemRefID>
					<PaxRefID>PAX1</PaxRefID>
				</SelectedOfferItem>
				<SelectedOfferItem>
					<OfferItemRefID>97482365-a144-4009-b280-6a8cddf59f42-PAX2</OfferItemRefID>
					<PaxRefID>PAX2</PaxRefID>
				</SelectedOfferItem>
				<ShoppingResponseRefID>c838fd37-7fc6-457b-8fe6-a98567c5c012</ShoppingResponseRefID>
			</SelectedOffer>
		</CreateOrder>
		<DataLists>
			<ContactInfoList>
				<ContactInfo>
					<ContactInfoID>ContactInfo-PAX</ContactInfoID>
					<EmailAddress>
						<EmailAddressText>mail@mail.com</EmailAddressText>
					</EmailAddress>
					<Phone>
						<PhoneNumber>1208953712</PhoneNumber>
					</Phone>
				</ContactInfo>
			</ContactInfoList>
			<PaxList>
				<Pax>
					<ContactInfoRefID>ContactInfo-PAX</ContactInfoRefID>
					<IdentityDoc>
						<CitizenshipCountryCode>UA</CitizenshipCountryCode>
						<ExpiryDate>2021-11-07</ExpiryDate>
						<IdentityDocID>ABC7891</IdentityDocID>
						<IdentityDocTypeCode>PT</IdentityDocTypeCode>
						<IssuingCountryCode>UA</IssuingCountryCode>
					</IdentityDoc>
					<Individual>
						<Birthdate>1980-09-25</Birthdate>
						<GenderCode>M</GenderCode>
						<GivenName>ONE</GivenName>
						<IndividualID>PAX123</IndividualID>
						<Surname>TRAVELLER</Surname>
						<TitleName>Mrs</TitleName>
					</Individual>
					<LoyaltyProgramAccount>
						<AccountNumber>2342342342</AccountNumber>
						<LoyaltyProgram>
							<ProgramCode>PC</ProgramCode>
						</LoyaltyProgram>
					</LoyaltyProgramAccount>
					<LoyaltyProgramAccount>
						<AccountNumber>2342342555</AccountNumber>
						<LoyaltyProgram>
							<ProgramCode>PCC</ProgramCode>
						</LoyaltyProgram>
					</LoyaltyProgramAccount>
					<PaxID>PAX1</PaxID>
					<PaxRefID>PAX2</PaxRefID>
					<PTC>ADT</PTC>
				</Pax>
				<Pax><!--Only for SEA passenger type-->
					<ContactInfoRefID>ContactInfo-PAX</ContactInfoRefID>
					<IdentityDoc>
						<CitizenshipCountryCode>UA</CitizenshipCountryCode>
						<ExpiryDate>2021-11-07</ExpiryDate>
						<IdentityDocID>ABC7891</IdentityDocID>
						<IdentityDocTypeCode>PT</IdentityDocTypeCode>
						<IssuingCountryCode>UA</IssuingCountryCode>
					</IdentityDoc>
					<Individual>
						<Birthdate>1980-09-25</Birthdate>
						<GenderCode>M</GenderCode>
						<GivenName>ONE</GivenName>
						<IndividualID>PAX123</IndividualID>
						<Surname>TRAVELLER</Surname>
						<TitleName>Mrs</TitleName>
					</Individual>
					<LoyaltyProgramAccount>
						<AccountNumber>2342342342</AccountNumber>
						<LoyaltyProgram>
							<ProgramCode>PC</ProgramCode>
						</LoyaltyProgram>
					</LoyaltyProgramAccount>
					<LoyaltyProgramAccount>
						<AccountNumber>2342342555</AccountNumber>
						<LoyaltyProgram>
							<ProgramCode>PCC</ProgramCode>
						</LoyaltyProgram>
					</LoyaltyProgramAccount>
					<PaxID>PAX2</PaxID>
					<PTC>SEA</PTC>
					<Remark>
						<RemarkText>EEVRGREEN/THAILAND/1234567</RemarkText><!--vessel name/country of registration/TA IATA number-->
					</Remark>
				</Pax>
				<Pax>
					<IdentityDoc>
						<CitizenshipCountryCode>UA</CitizenshipCountryCode>
						<ExpiryDate>2021-11-07</ExpiryDate>
						<IdentityDocID>XYZ7891</IdentityDocID>
						<IdentityDocTypeCode>PT</IdentityDocTypeCode>
						<IssuingCountryCode>UA</IssuingCountryCode>
					</IdentityDoc>
					<Individual>
						<Birthdate>2019-09-25</Birthdate>
						<GenderCode>F</GenderCode>
						<GivenName>ONE</GivenName>
						<Surname>INFANT</Surname>
						<TitleName>Mrs</TitleName>
					</Individual>
					<LoyaltyProgramAccount>
						<AccountNumber>2342342555</AccountNumber>
						<LoyaltyProgram>
							<ProgramCode>PCC</ProgramCode>
						</LoyaltyProgram>
					</LoyaltyProgramAccount>
					<PaxID>PAX3</PaxID>
					<PTC>INF</PTC>
				</Pax>
			</PaxList>
		</DataLists>
	</Request>
</IATA_OrderCreateRQ>

OrderCreateRQ fields description

Click here to expand...

M = Mandatory; O = Optional; C = Conditional

Field name	Description	M/O/C	Example
OrderCreateRQ	The OrderCreate/ OrderView transaction requests that an order to be created (returning the complete view of the Order)	M O	<IATA_OrderCreateRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCreateRQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCreateRQ NDC/19_2_schemas/IATA_OrderCreateRQ.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 create request	M
↳ Commission	An amount of money, typically a set percentage of the value involved, paid to an agent in a commercial transaction.	O
↳ Amount	Commission amount	C	<Amount>1</Amount> !!! Please kindly note that the mentioned value "1" is given as an example, and Agent should verify and put the relevant value according to the Contract.
↳ Percentage	Commission percentage.	C	<Percentage>5</Percentage> !!! Please kindly note that the mentioned value "5" is given as an example, and Agent should verify and put the relevant value according to the Contract.
↳ CreateOrder	Specifyindividual Order Item Sets and their associated Offer Item(s).	M
↳ SelectedOffer	Offer selected by the Passenger for requesting an Order to be created.	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>97482365-a144-4009-b280-6a8cddf59f42</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.	O
↳ 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>97482365-a144-4009-b280-6a8cddf59f42-PAX1</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>c838fd37-7fc6-457b-8fe6-a98567c5c012</ShoppingResponseRefID>
↳ DataLists	Data List definition for this message.	M
↳ ContactInfoList	Contact info data list definition.	M
↳ ContactInfo	The electronic or geographic address which a party has provided as the contact channel. For example, contact email, contact postal address, contact phone number.	M
↳ ContactInfoID	Uniquely Identifies a set of Contact Information, within the context of one message.	M	<ContactInfoID>ContactInfo-PAX</ContactInfoID>
↳ EmailAddress	The email address which should be used for contact purposes.	M
↳ EmailAddressText	The email address which should be used for contact purposes.	M	<EmailAddressText>TEST-AGENT@MAIL.COM</EmailAddressText>
↳ Phone	A telephone number is a sequence of digits.	M
↳ PhoneNumber	Phone number text.	M	<PhoneNumber>1208953712</PhoneNumber>
↳ 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
↳ ContactInfoRefID	Reference to a Contact Info ID within this message.	M	<ContactInfoRefID>ContactInfo-PAX</ContactInfoRefID>
↳ IdentityDoc	Any document which may be used to identify a person or verify aspects of a person's personal identity.	O
↳ 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>
↳ Individual	A single human being as distinct from a group, class, or family.	M
↳ Birthdate	The date on which an individual was born.	M	<Birthdate>1980-09-25</Birthdate>
↳ GenderCode	Gender of the individual (M, F, or X for unspecified).	M	<GenderCode>M</GenderCode>
↳ GivenName	Individual's first or given name.	M	<GivenName>ONE</GivenName>
↳ Surname	Individual's family name, last name. Note! The total First and Last name length of ADT + associated INF should not exceed 35 symbols.	M	<Surname>TRAVELLER</Surname>
↳ TitleName	A word such as Mr., Mrs., Miss or Dr that is used before an individual's name to indicate the gender, profession or marital status.	M	<TitleName>Mrs</TitleName>
↳ 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.	M	<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>
↳ PaxRefID	Reference to a Passenger ID within this message, associating an infant on lap to this adult Passenger.	O	<PaxRefID>PAX2</PaxRefID>
↳ PTC	Type code applying to the Passenger which typically drives pricing. Supported values: ADT / CHD / INF / YTH / YCD / STU / SEA		<PTC>ADT</PTC>
↳ Remark	Mandatory for SEA passenger type	M
↳ RemarkText	Additional, supplementary information about the document or service. Message structure: vessel name/country of registration/TA IATA number	M	<RemarkText>EEVRGREEN/THAILAND/1234567</RemarkText>

OrderCreate Error/Validation Checks

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
150	Given Name/Title too Long	PAX First/Last name validation fails
149	Surname too Long	PAX First/Last name validation fails
151	Surname Mandatory	Surname is missing
152	Given Name/Title Mandatory	Given name is missing
718	Invalid or missing document type	Invalid data in IdentityDocument. Expiry Date is older than last flight departure date
324	Number of infants exceeds the maximum allowed per adult passenger	In case INF validation fails. Associated INF is >1
318	Contact element (phone and/or address) missing or invalid	Invalid or missing tel and email data
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
900	Inactivity Timeout Value Exceeded	Offer limit has been expired
727	Invalid amount	Invalid commission amount