Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

 New or modified element

To be removed/deprecated

Unique to v2 - Branded Fares

Unique to V1 - Fare Families

Query - Common

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<Query> (Common)

OrderID

Order ID previously generated

Alphanumeric

Any

IATA Schema

OrderChangeRQ Query Common example

 OrderChangeRQ Query Common example
<Query>
	<OrderID>IB2f9657fdab8e458e90a30e15fd1d1f19OC</OrderID>
</Query>

Query - AcceptRepricedOrder

The PriceGuaranteeTimeLimit (PGTL) element will appear in all Offers and Orders for all markets. Note that this element will have the same value as the PaymentTimeLimit (PTL), except for those markets where the new Reprice on hold is required.

The first market requiring this is Argentina. The PGTL element will be different to the PTL, forcing all users to use the new Reprice on hold functionality.

The price of an Order on hold (un paid) is only guaranteed until the PGTL expires, after which the new Reprice functionality must be used together with the OrderChange-Accept function.

The PTL, is not affected and if expires, the Order is no longer available.

There are three scenarios:

  1. Before both the PTL and the PGTL expire,

    1. This is as today, whereby any Reprice will return the same price and conditions (including PGTL) given when booked. An OrderChange-Accept is not necessary in this case, and an OrderChange-Payment can be sent to fulfill the Order.

  2. After both the PTL and the PGTL have expired.

    1. The Order is cancelled, you need to create a new one.

  3. After the PGTL has expired, but before the PTL expires. In this case, you must Reprice the Order, as per the following flow:

    1. Send a new OrderReshopRQ-Reprice to get the applicable fare and conditions

    2. If the price has not changed, send an OrderChange-Payment (No OrderChange-Accept is necessary)

    3. If the price has changed the system will generate a new Offer which must be accepted using the OrderChange-Accept. Once accepted it can then be paid for. The steps would be as per the following:

Then in the OrderChangeRQ> you can:

  • Accept the modification of the order: <AcceptRepricedOrder> you will have the new PGTL with the original PTL from the Order. The PGTL will never be greater than the PTL, the Order has to be paid before the PTL expires.

  • If the Order has ancillaries, you will get a warning message at OrderReshop-Reprice indicating that they have not been repriced: “Repricing is not allowed for additional services”, as the prices, today, are maintained at the original cost.

  • When accepting the reprice, an OrderView is generated ONLY with the repriced Flight OrderItems and their associated costs, and if you try to pay this value, and your Order has other OrderItems (such as ancillaries) you will get an error “Incorrect amount”. You must do an OrderRetrieve to recover a complete OrderView, with all the OrderItems of the Order and their costs. After that, you can pay by OrderChange-Payment.

Query - AcceptRepricedOrder

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<Query / AcceptRepricedOrder>

ResponseID

The ID of the response from which the new offer is being accepted and applied to the Order on hold

Alphanumeric

Any

AcceptRepriceOrder example

 AcceptRepriceOrder Example
<Query>
  <OrderID>IB4b0ea07906aa4a078895421c19dc6f1dOC</OrderID>
  <AcceptRepricedOrder>
    <ResponseID>Qm9va2luZ0AxNjk3Nzg5ODA2MDU1LUVDSG8x</ResponseID>
  </AcceptRepricedOrder>
</Query>

Query - PassengerServicing

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<Query / PassengerServicing> (Update contact info flows, name, e-mail, phone, frequent flyer info…)

New

Attribute

PassengerID

The unique identifier of the Passenger whose information is being updated.

Alphanumeric

The PassengerID obtained from the previous OrderViewRS having previously retrieved the Order.

IATA Schema if 'PassengerServicing / New' tag is indicated.

New / ContactInfoRef

Contact info reference, which contact info filled in below will update original contact info.

Alphanumeric

Any

Iberia NDC in case of:

  • Contact info (email & phone) correction flow

New / Individual / Given

Name of the passenger to change

Alphanumeric

Any

Iberia NDC in case of:

  • Name correction flow

New / Individual / Surname

Surname of the passenger to change

  • (Agency can specify separated by a special character "@" first and second surname → Ex: De la Morena@López)

Alphanumeric

Any

IATA Schema if 'New / Individual' tag is indicated

New / LoyaltyProgramAccount / Airline / AirlineDesignator

Airline ID associated to frequent flyer number

Alphanumeric

Any

Iberia NDC in case of:

  • Add/Update Frequent Flyer Number

New / LoyaltyProgramAccount / AccountNumber

Frequent Flyer or On Business number account

Alphanumeric

Any

Iberia NDC in case of:

  • Add/Update Frequent Flyer Number

  • Add/Update On Business Number

New / ActionType

Action type

Alphabetical

  • Add

  • Remove

Iberia NDC in case of:

  • Name correction flow

  • Contact info (email & phone) correction flow

  • Add/Update Frequent Flyer Number

  • Add/Update On Business Number

Previous

Attribute

PassengerID

Passenger ID, which info will be updated

PassengerID attribute value can be indicated in PassengerID attribute from AirShopping request.

Alphanumeric

Alphanumeric

Type of Passengers

Value indicated in PassengerID attribute from AirShopping request

IATA Schema if 'PassengerServicing / Previous' tag is indicated.

Previous / Individual / GivenName

Old passenger given name, not mandatory, but if informed and does not match, an error will be shown

Alphanumeric

Any

Previous / Individual / Surname

Old passenger surname, not mandatory, but if informed and does not match, an error will be shown

Alphanumeric

Any

IATA Schema if 'Previous / Individual' tag is indicated

Previous / ContactInfoRef

Old contact info reference

Alphanumeric

Any

Previous / ActionType

Action type

Alphabetical

  • Add

  • Remove

PassengerServicing example

 PassengerServicing example
<Query>
      <OrderID>xxxxxxxxxxxxxxxxxxx</OrderID>
      <PassengerServicing>
         <New PassengerID="ADULT_01">
            <LoyaltyProgramAccount>
               <Airline>
                  <AirlineDesignator>IB</AirlineDesignator>
               </Airline>
               <AccountNumber>#########</AccountNumber>
            </LoyaltyProgramAccount>
            <ActionType>Add</ActionType>
         </New>
      </PassengerServicing>
</Query>

Query - OrderServicing

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<Query / OrderServicing> (Add ancillaries, delete paxes, partial refund and voluntary flight change flows…)

AcceptOffer / Offer

Attribute

OfferID

Identification of the service Offer

SeatAvailability ResponseID / ServiceList ResponseID / New Offer Identification (Voluntary Change Flow)

Alphanumeric

Any

IATA Schema if 'AcceptOffer' tag is indicated and Iberia NDC in case of:

  • Add ancillaries flow

  • Voluntary Change flow

  • Delete Passengers flow

  • Partial Refund flow

AcceptOffer / Offer

Attribute

Owner

Airline identification

Alphabetical

IB

IATA Schema if 'AcceptOffer' tag is indicated and Iberia NDC in case of:

  • Add ancillaries flow

  • Voluntary Change flow

  • Delete Passengers flow

  • Partial Refund flow

AcceptOffer / Offer

Attribute

ResponseID

Response Identification

Alphanumeric

Any

IATA Schema if 'AcceptOffer' tag is indicated and Iberia NDC in case of:

  • Add ancillaries flow

  • Voluntary Change flow

  • Delete Passengers flow

  • Partial Refund flow

AcceptOffer / Offer / OfferItem

Attribute

OfferItemID

Offer item identification of the new service to add

Alphanumeric

Any

IATA Schema if 'Offer' tag is indicated and Iberia NDC in case of:

  • Add ancillaries flow

  • Voluntary Change flow

  • Delete Passengers flow

  • Partial Refund flow

AcceptOffer / Offer / OfferItem / PassengerRefs

Reference for the passengers

Alphanumeric

Type of Passengers

IATA Schema if 'Offer' tag is indicated and Iberia NDC in case of:

  • Add ancillaries flow

  • Voluntary Change flow

  • Delete Passengers flow

  • Partial Refund flow

AcceptOffer / Offer / OfferItem / SeatSelection / Row

Row for the seat

Numeric

Any

IATA Schema if 'SeatSelection' tag is indicated and Iberia NDC in case of:

  • Add ancillaries flow

AcceptOffer / Offer / OfferItem / SeatSelection / Column

Column for the seat

Alphabetical

Any

IATA Schema if 'SeatSelection' tag is indicated and Iberia NDC in case of:

  • Add ancillaries flow

Delete / OrderItemID

OrderItem identification to be deleted.

When cancelling flights with Ancillaries or other associated services it is only necessary to include the OrderItemIDs of the flights, as all associated services will automatically be cancelled with the flights.

Alphanumeric

Any

IATA Schema if 'Delete' tag is indicated

OrderServicing example

 OrderServicing example
<OrderServicing>
	<AcceptOffer>
		<Offer OfferID="IB1ce71d2c930a46afbca517f2feb15730OP" Owner="IB" ResponseID="Qm9va2luZ0AxNjk3NzE4ODAyNjA0LXlpdWlx">
			<OfferItem OfferItemID="IB1ce71d2c930a46afbca517f2feb15730OP_01">
				<PassengerRefs>ADULT_01</PassengerRefs>
			</OfferItem>
		</Offer>
	</AcceptOffer>
	<Delete>
		<OrderItemID>IB79563e1e6cd94495a58513924d3cd894OC_01</OrderItemID>
	</Delete>
</OrderServicing>

Query - Payments

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<Query / Payments / Payment> (Add ancillaries and voluntary flight change flows…)

Type

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

Please check here.

Alphabetical

  • CA (Cash)

  • CC (Credit Card)

  • MS (Voucher)

--  This refers to Cash payment method  --

Method / Cash

Attribute

CashInd

Cash payment method.

Alphabetical

true

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

Method / PaymentCard

Attribute

refs

NDC Mandatory for 3DS and/or installments payment.

This is used to reference the associated 3DS info in PaymentCardSecureInfo ObjectKey, and/or the 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:

<PaymentCard refs="KEY_3DS KEY_QUOTAS">

Alphanumeric

Any

Method / PaymentCard / CardType 

Type of credit card

Alphanumeric

1-6 characters

Method / PaymentCard / CardNumber

Number of credit card

Numeric

1-19 characters

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

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 / EffectiveExpireDate / Expiration

Effective expiration date of the credit card

Numeric

4 characters

--  This refers to Voucher payment method  --

Method / Voucher

Voucher payment method.

IATA Schema if 'Payment' tag is indicated and Iberia NDC

Alphabetic

true

Method / Voucher / Number 

Number of voucher

Alphanumeric

any

Amount

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.

Payments example

 Payments example
<Payments>
	<Payment>
		<Type>CC</Type>
		<Method>
			<PaymentCard refs="MISCUOTAS"> 
				<CardType>VI</CardType>
				<CardNumber>##########</CardNumber>
				<SeriesCode>382</SeriesCode>
				<CardHolderName>Dinel Garcia Garcia</CardHolderName>
				<CardHolderBillingAddress>
					<Street>#####</Street>
					<CityName>MA</CityName>
					<StateProv>28</StateProv>
					<PostalCode>#####</PostalCode>
					<CountryCode>ES</CountryCode>
				</CardHolderBillingAddress>
				<EffectiveExpireDate>
					<Expiration>####</Expiration>
				</EffectiveExpireDate>
			</PaymentCard>
		</Method>
		<Amount Code="EUR">194.74</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
</Payments>

  • No labels