Versions Compared

Old Version 2

changes.mady.by.user Alvaro Chaparro

Saved on

compared with

New Version Current

changes.mady.by.user Alvaro Chaparro

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Insert excerpt
NDC2:New 17.2 COMBINEDNDC2:New 17.2 COMBINEDAPI Messages with Examples
API Messages with Examples
nameLegend
nopaneltrue

Excerpt
nameQuery_OrderCreate
1-19

characters

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<Query / Order>

Offer

Info

Attribute

Offer@OfferIDOfferID

Info

Attribute

Offer@Owner

Owner

Info

Attribute

Offer@ResponseID

ResponseID

Id of a returned offer

Airline code

Id of the response

Alphanumeric

Alphabetical

Alphanumeric

Any

Any

Any

Offer / OfferItem

Info

Attribute

OfferItem@OfferItemIDOfferItemID

Id for OfferItem

Alphanumeric

Any

Offer / OfferItem / PassengerRefs

Type of passenger

Alphanumeric

Type of Passengers

Offer / OfferItem / ALaCarteSelection / Quantity

Quantity of ancillaries

Mandatory for schema if "ALaCarteSelection" tag is indicated

Numeric

Any

Offer / OfferItem / ALaCarteSelection / SegmentID

Id for the segment that applies the ancillaries

Alphanumeric

Any

Offer / OfferItem / SeatSelection / Row

Row for the seat

Mandatory for schema if "SeatSelection" tag is indicated

Numeric

Any

Offer / OfferItem / Seat Selection / Column

Column for the seat

Mandatory for schema if "SeatSelection" tag is indicated

Alphabetical

Any

Offer / OfferItem / ServiceSelection

Info

Attribute

ServiceSelection@ServiceIDServiceID

Id for the special service

NDC Mandatory for Special Needs selections.

Alphanumeric

Any

Offer / OfferItem / ServiceSelection / ServiceDefinitionID

Definition for the special service

Mandatory for schema if "ServiceSelection" tag is indicated

4 Alphabetical

Special Services

<Query / Payments / Payment>

Type

Payment Methods can vary depending on market and type of seller.

Please check here.

Alphabetical

  • CA (Cash)

  • CC (Credit Card)

  • MS (Voucher)

  • SF (ServiceFee)

--  This refers to Cash payment method  --

Method / Cash

Info

Attribute

Cash@CashIndCashInd

Cash payment method.

Alphabetical

true

Amount

Info

Attribute

Code

Total amount of the offer.

Code refers to currency code for payment.

Numeric

Any

Payer / ContactInfoRefs

Reference for the payer info, that must be associated correctly in the XML below.

In Cash Payment Method is OPTIONAL

Alphanumeric

Any valid reference associated in the XML below.

-- This refers to Credit Card method  – If Secure Payment applies additional info needed is defined below in 3DS INFO --

Method / PaymentCard

Info

Attribute

PaymentCard@refsrefs

NDC Mandatory for 3DS and/or intallments installments payment.

This is used to reference the associated 3DS info in PaymentCardSecureInfo ObjectKey, and/or the intallment installment payment info in PaymentFormMetadata MetadataKey.

If both 3DS and installment payments are being used for the same Order, then the two references are included here together separated by a space.

Example:

Code Block
languagexml
<PaymentCard refs="KEY_3DS KEY_QUOTAS">

Alphanumeric

Any

Method / PaymentCard / CardType 

code

Type

of

credit

card

Alphanumeric

1-6 characters

Method / PaymentCard / CardNumber

Number of credit card

Numeric

Code Block

Method / PaymentCard / SeriesCode

Series Code of credit card

Numeric

1-8 characters

Method / PaymentCard / CardHolderName

Card Holder Name

Alphanumeric

0-50 characters

Method / PaymentCard / CardHolderBillingAddress / Street

code

Street

of

the

billing

address

of

the

cardholder.

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

If tag is indicated once, only first 40 characters will be considered

If tag is indicated twice, only first 80 characters will be considered

Method / PaymentCard / CardHolderBillingAddress / CityName

City of the Billing Address of cardholder

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

Only first 50 characters will be considered

Method / PaymentCard / CardHolderBillingAddress / StateProv

State Prov. of the Billing Address of cardholder

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

1-40 characters

Method / PaymentCard / CardHolderBillingAddress / PostalCode

Postal Code of the Billing Address of cardholder

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

2-10 characters

Method / PaymentCard / CardHolderBillingAddress / CountryCode

Country Code of the Billing Address of cardholder

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphabetical

2 characters

Method / PaymentCard / CardNumber

Number of credit card

Numeric

1-9 characters

Method / PaymentCard / EffectiveExpireDate / Expiration

Effective expiration date of the credit card

Numeric

4 characters

Amount

Info

Attribute

Code

Total amount of the offer.

Code refers to currency code for payment.

Numeric

Any

Payer / ContactInfoRefs

Reference for the payer info, that must be associated correctly in the XML below.

Alphanumeric

Any valid reference associated in the XML below.

-- This refers to Voucher payment method  --

Method / Voucher

Voucher payment method.

Alphabetical

true

Method / Voucher / Number 

Number of the voucher

Alphanumeric

any

Amount

Info

Attribute

Code

Total amount of the offer.

Code refers to currency code for payment.

Numeric

Any

Payer / ContactInfoRefs

Reference for the payer info, that must be associated correctly in the XML below.

Alphanumeric

Any valid reference associated in the XML below.

-- This refers to Service Fee method  --

Method / Other / Remarks

Info

Attribute

Remarks@refsrefs

References for all passengers of the order

Alphanumeric

any

Method / Other / Remarks / Remark

Service Fee payment method

Mandatory for schema if "Remarks" tag is indicated

Alphabetical

ServiceFee

Amount

Info

Attribute

Code

Total amount of the offer

Numeric

Any

Payer / ContactInfoRefs

Reference for the payer info, that must be associated correctly in the XML below.

In Cash Payment Method is OPTIONAL

Alphanumeric

Any valid reference associated in the XML below.Service Fee

Code refers to currency code for payment.

Numeric

Any

<Query / BookingReferences / BookingReference>

ID

External reference ID

Mandatory for Sender External Reference

Alphabetical

XRef

OtherID

Info

Attribute

OtherID@NameName

This attribute must contain the senders IATA Number and will be matched against the Senders IATANumber from TravelAgencySender

Mandatory for Sender External Reference

Numeric

7/8 Numbers

OtherID

Sender's external reference

Mandatory for Sender External Reference

Alphanumeric

Any (Strings exceeding 30 chars will be truncated)

OrderCreateRQ Query example

Expand
titleExampleOrderCreateRQ Query example
Code Block
languagexml
<Query>
	<Order>
		<Offer OfferID="IBe649417035c240f6a0adf62dc53b6e2cOP" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzAxMjUxODg1MDAyLVp3QUxm">
			<OfferItem OfferItemID="IBe649417035c240f6a0adf62dc53b6e2cOP_01">
				<PassengerRefs>ADULT_01</PassengerRefs>
			</OfferItem>
			<OfferItem OfferItemID="IBe649417035c240f6a0adf62dc53b6e2cOP_02">
				<PassengerRefs>INFANT_01</PassengerRefs>
			</OfferItem>
		</Offer>
		<Offer OfferID="ALACARTE_SSR_IB0d64d517455348e59b7f14c2fbc4defa" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzAxMjUxODg1MDAyLVp3QUxm">
			<OfferItem OfferItemID="IB47fcd3adcf4a44d5937c30729ca059b4OC_WCHR">
				<PassengerRefs>ADULT_01</PassengerRefs>
				<ServiceSelection ServiceID="SSR_SN_94f652ab-d4bc-43a4-b3b6-761c714450bb">
					<ServiceDefinitionID>SPECIAL_NEED-WCHR</ServiceDefinitionID>
				</ServiceSelection>
			</OfferItem>
		</Offer>
	</Order>
	<Payments>
		<Payment>
			<Type>MS</Type>
			<Method>
				<Voucher>
					<Number>BONO1000EUR</Number>
				</Voucher>
			</Method>
			<Amount Code="EUR">219.44</Amount>
			<Payer>
				<ContactInfoRefs>VoucherValidation</ContactInfoRefs>
			</Payer>
		</Payment>
	</Payments>
	<DataLists>
		<PassengerList>
			<Passenger PassengerID="ADULT_01">
				<PTC>ADT</PTC>
				<Birthdate>1967-11-03</Birthdate>
				<Individual IndividualID="IND_ADULT_01">
					<Gender>Male</Gender>
					<NameTitle>MR</NameTitle>
					<GivenName>JANE</GivenName>
					<Surname>SMITH</Surname>
				</Individual>
				<FOID>
					<FOID_Number>30000529L</FOID_Number>
					<FOID_Type>NI</FOID_Type>
				</FOID>
				<ContactInfoRef>ADULT_01_CONTACT</ContactInfoRef>
			</Passenger>
			<Passenger PassengerID="INFANT_01">
				<PTC>INF</PTC>
				<Birthdate>2023-08-02</Birthdate>
				<Individual IndividualID="IND_INFANT_01">
					<Gender>Male</Gender>
					<NameTitle>MR</NameTitle>
					<GivenName>INFANT</GivenName>
					<Surname>UNO</Surname>
				</Individual>
				<FOID>
					<FOID_Number>30000056Y</FOID_Number>
					<FOID_Type>NI</FOID_Type>
				</FOID>
				<ContactInfoRef>ADULT_01_CONTACT</ContactInfoRef>
			</Passenger>
		</PassengerList>
		<ContactList>
			<ContactInformation ContactID="ADULT_01_CONTACT">
				<ContactType/>
				<ContactProvided>
					<EmailAddress>
						<EmailAddressValue>acamino@iteggo.com</EmailAddressValue>
					</EmailAddress>
				</ContactProvided>
				<ContactProvided>
					<Phone>
						<Label>Passenger</Label>
						<PhoneNumber>+34666554433</PhoneNumber>
					</Phone>
					<Phone>
						<Label>Emergency</Label>
						<PhoneNumber>34666554433</PhoneNumber>
					</Phone>
				</ContactProvided>
				<Individual>
					<GivenName>CONTACTO</GivenName>
					<Surname>EMERGENCIA</Surname>
				</Individual>
			</ContactInformation>
			<ContactInformation ContactID="VoucherValidation">
				<ContactType>VoucherValidation</ContactType>
				<ContactProvided>
					<EmailAddress>
						<EmailAddressValue>QA@IBERIA.ES</EmailAddressValue>
					</EmailAddress>
				</ContactProvided>
			</ContactInformation>
		</ContactList>
		<ServiceDefinitionList>
			<ServiceDefinition ServiceDefinitionID="SPECIAL_NEED-WCHR">
				<Name>Silla de ruedas para rampas</Name>
				<Descriptions>
					<Description refs="ADULT_01">
						<Text>Necesito la silla de ruedas para cubrir la distancia hasta / desde la puerta
                                        de embarque. Puedo acceder al avión por escaleras y desplazarme dentro del
                                        mismo sin necesidad de asistencia.</Text>
					</Description>
				</Descriptions>
				<BookingInstructions>
					<SSRCode>WCHR</SSRCode>
				</BookingInstructions>
			</ServiceDefinition>
		</ServiceDefinitionList>
		<FlightSegmentList>
			<FlightSegment SegmentKey="IB044820240401">
				<Departure>
					<AirportCode>MAD</AirportCode>
					<Date>2024-04-01</Date>
					<Time>07:25</Time>
					<AirportName>Madrid Adolfo Suarez-Barajas</AirportName>
					<Terminal>
						<Name>4</Name>
					</Terminal>
				</Departure>
				<Arrival>
					<AirportCode>BIO</AirportCode>
					<Date>2024-04-01</Date>
					<Time>08:30</Time>
					<ChangeOfDay>0</ChangeOfDay>
					<AirportName>Bilbao</AirportName>
				</Arrival>
				<MarketingCarrier>
					<AirlineID>IB</AirlineID>
					<Name>Iberia</Name>
					<FlightNumber>0448</FlightNumber>
				</MarketingCarrier>
				<OperatingCarrier>
					<AirlineID>IB</AirlineID>
					<Name>Iberia</Name>
					<FlightNumber>0448</FlightNumber>
					<Disclosures>
						<Description>
							<Text>IB</Text>
						</Description>
					</Disclosures>
				</OperatingCarrier>
				<Equipment>
					<AircraftCode>320</AircraftCode>
					<Name>Airbus A320</Name>
				</Equipment>
				<FlightDetail>
					<FlightDuration>
						<Value>PT1H5M</Value>
					</FlightDuration>
				</FlightDetail>
			</FlightSegment>
		</FlightSegmentList>
		<InstructionsList>
			<Instruction ListKey="Instruction_01">
				<FreeFormTextInstruction refs="ADULT_01 IB044820240401">
					<Remark>BAGGAGE/SP/0D4</Remark>
				</FreeFormTextInstruction>
			</Instruction>
			<Instruction ListKey="Instruction_02">
				<FreeFormTextInstruction refs="ADULT_01 IB044820240401">
					<Remark>BAGGAGE/SP/0DD</Remark>
				</FreeFormTextInstruction>
			</Instruction>
		</InstructionsList>
	</DataLists>
</Query>

Image RemovedImage Added