• Register

OrderChange 17.2

Functional Description

OrderChange API allows an existing Order to be updated.Order Change API currently supports the following types of changes:

  • Name Correction → Only one change per request and per passenger if not previously reissued. Documents are reissued. (therefore no further changes that require reissue are allowed). 
    • Up to 3 characters once.
    • Not available when tickets are already re-issued, one segment has been flown, there has been a previous Name Correction or ticket control is not in Iberia (Code-share flights).
    • Only for ADT passengers (not CHLD) without any INFT or Ancillary Services (BAG and SEATS) associated.
    • NOT allowed for Residents Discounts
    • Allowed for Private Fares & Large Family Discounts
    • Allowed for Time Limit Orders that have not been payed & issued.
    • Allowed for Conjunction tickets orders.
    • Allowed to change name and contact info for the same passenger in the same request.
  • Contact Info Correction → Only one change per request. For more changes we will have to add similar requests.
    • Phone correction.
    • Mail correction.
  • Pay Services (flights) → The purpose of this service is to pay services (flights) in a previously created OrderAvailable Form of Payments.
    • Cash Payment
    • Credit Card Payment
    • IBPay
  • Delete Some Passengers with mandatory OrderReShop → Deletes one or more passengers (but not all) from an order. Passenger/s can be deleted when at least one flight has not been used, using Order Change after a previous order reshop. Available when ticket control is not in Iberia (Code-share flights). It is possibe to delete passengers from unpaid orders.
  • Cancel → The purpose of this service is to cancel partially an initial order.

    • Previous Order Reshop type 'Cancel' is not mandatory.
    • Refunds partially an order for all passengers of the order.
    • Coupons have to combine Used/Flown status and Open for Use/Airport Control status.
  • Add Seats and Bags → Adds seat/baggages postsale only for segments which have not been flown. This action type allows adding one or more additional services (baggages/seats) in the same request. Not available when ticket control is not in Iberia (Code-share flights). It is possible to add ancillaries to a Corporate Sender Order.
  • Voluntary Change → Changes of date, time(flight number) and class of flight(s) only before use of any service (all tickets in Open for Use/Airport Control). It can be made for only some passengers of the order or for all passengers of the order, and no previous change has been made. Furthermore, when original order has associated ancillaries or special needs, if change is finalized, these elements are lost and a warning is shown in NDC response (Itin Reshop type reprice and Order Change). Available when ticket control is not in Iberia (Code-share flights).

The Order Change API currently supports the following types of changes:

Functionality    


Use  


Examples → Complete Flow (All RQ/RS)

Click here to dowload all examples from the list below:
Delete 

The purpose of this service is to delete some passengers (not all of them) from an initial order.

  • Previous Order Reshop is mandatory.
  • Available for Unpaid Orders.
  • Available when ticket control is not in Iberia (Code-share flights).
  • If there are coupons, they have to be in Open for Use/Airport Control status.
  • OrderChange Delete - Corporates.zip
  • OrderChange Delete - 2 ADT 1 CHD - Delete 1 ADT 1 CHD.zip
Add

This action  is intended to perform changes of:

  • Name Correction (up to 3 characters once)
  • Mail Correction
  • Phone Correction
  • Add ancillaries (Baggages and Seats)

It is only one change allowed for request/passenger for Name Correction & Update Contact information. For more changes we will have to add similar requests. Several ancillaries can be added in the same request.

It is mandatory to include ContactList for at least one ADT passenger if all ADT passengers make a name correction.

  • Order Change - Phone Correction.zip
  • OrderChange - Add Baggage - 2 ADT 1 CHD 1 INF.zip
  • OrderChange - Add Baggage - IBPay.zip
  • OrderChange - Corporates - Add Baggages.zip
  • OrderChange - Corporates - Add Seats.zip
  • OrderChange - Mail Correction.zip
  • OrderChange - Name Correction - 1 ADT.zip
  • OrderChange - RT - 1 ADT - 1 Baggage IDA + 2 Baggages VUELTA PreSale - 1 Baggage IDA + 1 Baggage VUELTA PostSale.zip
Cancel

The purpose of this service is to cancel partially an initial order.

  • Previous Order Reshop type 'Cancel' is not mandatory.
  • Refunds partially an order for all passengers of the order.
  • Coupons have to combine Used/Flown status and Open for Use/Airport Control status.
  • OrderChange - Partial Refund.zip
Payment

The purpose of this service is to pay services (flights) in a previously created Order. Although the OrderChange Payment is a stateless method, it is mandatory to invoke OrderCreate to obtain an Order with Time Limit. This service can be use with two payment methods:

  • Cash Payment
  • Credit Card Payment
  • IBPay
  • OrderChange - Cash Payment.zip
  • OrderChange - Credit Card Payment.zip
Voluntary Change

Allows following type of changes, including conjunction tickets orders:

  • Allows making changes in date, time or class for only some passengers of the order or for all passengers of the order (all coupons in Open for Use/Airport Control status) → Previous order reshops for new availability and fare are both mandatory.
  • Order Change Voluntary Change All Paxes - All Flights.zip
  • Order Change Voluntary Change Some Paxes - One Flight Date Change.zip

If there is a cancelation or a passenger is deleted from an order, and it is necessary to refund money to the client, the money is always refunded back to the original form of payment used for the tickets.

Partial refund should not be used if all of the ticket coupons are open for use, in that case Order Reshop and OrderCancel should be used for total refund.

NDC Servicing operations for corporate will only validate that travel agency indicated in the request is the same as generated the order. If corporateID is present in the request, it will only be checked when the order has been generated with corporateID.

 

Legend

(plus) New or modify field    

HTTP Headers

api_key Your unique key used to authorise access to the API. Mandatory:Yes

Request Body

NAME

DESCRIPTION

FORMAT

ALLOWED VALUES

MANDATORY FOR
PrimaryLangID Two character ISO Language Code, for the agent’s preferred language. This is for error messages and some other data such as legal waivers. If PrimaryLangID is not avalaible for the service, it will use default language alpha Depends of the Country Code
Version

The IATA version of the message

numeric any Schema
<PointOfSale>

Location / CountryCode

Country code of Point of Sale

alpha

List of countries

If toggle feature for market validation is activated.
<Document> Schema

ReferenceVersion

The IATA Schema version.

numeric

any


<Party / Sender> Only for Real IATA Schema
TravelAgencySender / IATA_Number

Sender unique identifier such as:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Numeric 7/8 Numbers NDC Mandatory
<Party / Sender> Only for Pseudo IATA Schema
TravelAgencySender / OtherIDs / OtherID Pseudo IATA (assigned by Iberia) Numeric 7/8 Numbers NDC Mandatory
<Party> Schema
Sender / TravelAgencySender / Name Agency Name Alphanumeric Any
Sender / TravelAgencySender / Contacts / Contact / EmailContact / Address Email to contact the Agency Alphanumeric Any Mandatory for schema if 'EmailContact' tag is indicated.
Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Application Agency phone type Alphabetical
  • Business
  • Mobile

Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Number Phone number to contact the Agency Alphanumeric Any
Sender / TravelAgencySender / Contacts / Contact / Name / Surname Reference Agency contact surname Alphabetic Any
Sender / TravelAgencySender / Contacts / Contact / Name / Given Reference Agency contact name Alphabetic Any Mandatory for schema if 'Name' tag is indicated.
Participants / Participant / TravelAgencyParticipant / TravelAgencySender / OtherIDs / OtherID Pseudo IATA Identification Numeric 7/8 Numbers NDC Mandatory
Sender / TravelAgencySender / AgencyID Id for the Agency Alphanumeric Any Schema
Participants / Participant / AggregatorParticipant / AggregatorID

Participant / Aggregator unique identifier:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Pseudo IATA(assigned by Iberia)

Numeric 7/8 Numbers Mandatory for schema if 'Participants' tag is indicated.
<Party> (With Corporates) Schema
Sender / CorporateSender / ID ID for the Corporate Alphanumeric Any NDC Mandatory
Participants / Participant / TravelAgencyParticipant / Name Agency Name Alphanumeric Any
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / EmailContact / Address Email to contact the Agency Alphanumeric Any Mandatory for schema if 'EmailContact' tag is indicated.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Application Agency phone type Alphabetical
  • Business
  • Mobile

Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Number Phone number to contact the Agency Alphanumeric Any
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Surname Reference Agency contact surname Alphabetic Any
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given Reference Agency contact name Alphabetic Any Mandatory for schema if 'Name' tag is indicated.
Participants / Participant / TravelAgencyParticipant / IATA_Number

Sender unique identifier such as:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Numeric 7/8 Numbers NDC Mandatory
Participants / Participant / TravelAgencyParticipant / AgencyID Id for the Agency Alphanumeric Any Schema
Participants / Participant / AggregatorParticipant / AggregatorID

Participant / Aggregator unique identifier:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Pseudo IATA(assigned by Iberia)

Numeric 7/8 Numbers Mandatory for schema if 'Participants' tag is indicated.
<Query> Schema
OrderID Order ID previously generated Alphanumeric Any Schema
AcceptRepricedOrder / ResponseID Id of response from reprice Alphanumeric Any
<Query / PassengerServicing>

New

Attribute

PassengerID

Type of passenger Alphanumeric Type of Passengers
New / ContactInfoRef New contact info reference Alphanumeric Any
New / Individual / Given Name of the passenger Alphanumeric Any
New / Individual / Surname Surname of the passenger Alphanumeric Any
New / ActionType Action type Alphabetical
  • Add
  • Remove

New / IdentityDocument / IdentityDocumentNumber Identity document number Alphanumeric Any
New / IdentityDocument / IdentityDocumentType Type of identity document Alphanumeric Any
New / IdentityDocument / IssuingCountryCode Country code for identity document issuing Alphabetical List of Countries
New / IdentityDocument / ExpiryDate Expire date for identity document Date Any future date
New / IdentityDocument / Birthplace Birth place for the identity document holder Alphabetical List of Countries
New / IdentityDocument / Visa / VisaNumber New visa number Numeric Any
New / IdentityDocument / Visa / VisaType New type of visa Alphabetical Any

Previous

Attribute

PassengerID

Type of passenger Alphanumeric Type of Passengers
Previous / Individual / GivenName Old passenger given name Alphanumeric Any
Previous / Individual / Surname Old passenger surname Alphanumeric Any
Previous / ContactInfoRef Old contact info reference Alphanumeric Any
Previous / ActionType Action type Alphabetical
  • Add
  • Remove

<Query / OrderServicing>

AcceptOffer / Offer

Attribute

OfferID

Identification of the service Offer

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

Alphanumeric

Alphanumeric

Any

Any


AcceptOffer / Offer

Attribute

Owner

Airline identification Alphabetical IB

AcceptOffer / Offer

Attribute

ResponseID

Response Identification Alphanumeric Any

AcceptOffer / Offer OfferItem

Attribute

OfferItemID

Offer item identification of the new service to add Alphanumeric Any
AcceptOffer / Offer / OfferItem / PassengerRefs Reference for the passengers Alphanumeric Type of Passengers
AcceptOffer / Offer / OfferItem / SeatSelection / Row Row for the seat Numeric Any
AcceptOffer / Offer / OfferItem / SeatSelection / Column Column for the seat Alphabetical Any
Delete / OrderItemID OrderItem identification to be deleted Alphanumeric Any
<Query / Payments / Payment> Schema
Type Payment Method, can be Cash payment, Card payment, IBPay or Other payment (for service fee). Alphabetic
  • Credit Card
  • Cash
Schema
--  This refers to Cash payment method  --

Method / Cash

Attribute

CashInd

Cash payment method. true any
----
--  This refers to Credit Card method  --
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 alphanumeric 1-40 characters
Method / PaymentCard / CardHolderBillingAddress / CityName City of the Billing Address of cardholder alphanumeric 1-24 characters
Method / PaymentCard / CardHolderBillingAddress / StateProv State Prov. of the Billing Address of cardholder alphanumeric 1-40 characters
Method / PaymentCard / CardHolderBillingAddress / PostalCode Postal Code of the Billing Address of cardholder alphanumeric 2-10 characters
Method / PaymentCard / CardHolderBillingAddress / CountryCode Country Code of the Billing Address of cardholder alphabetic 2 characters
Method / PaymentCard / EffectiveExpireDate / Expiration Effective expiration date of the credit card numeric 4 characters
----

Amount

Attribute

Code

Total amount of the offer.

Code refers to currency code for payment.

Numeric Any Schema
Payer / ContactInfoRefs Reference for payer contact info Alphanumeric Any Schema
<DataLists / PassengerList> Schema

Passenger

Attribute

PassengerID

Type of passenger Alphanumeric Type of Passengers Schema
Passenger / PTC Passenger Type Code 3 Alphabetical Type of Passengers Schema
Passenger / Individual / Gender Gender of the passenger (Mandatory for infant passengers in secure flights) Alphabetical
  • Male
  • Female

Passenger / Individual / NameTitle

Title of the passenger (Mandatory for secure flights)

NDC supports followings fields (MR, MRS, MS, MISS). If another field is introduced no error is shown, only this field is ignored.

Alphabetical
  • MR
  • MRS
  • MS
  • MISS

Passenger / Individual / GivenName Name of the passenger Alphanumeric Any
Passenger / Individual / Surname Surname of the passenger Alphanumeric Any Mandatory for schema if 'GivenName' tag is indicated.
Passenger / Individual / SurnameSuffix

Passenger suffix for duplicate names

It must necessarily be predefined as text (see example)

Alphanumeric Any
  • JR
  • SR

<DataLists / ContactList>

ContactInformation

Attribute

ContactID

Id for the contact info Alphanumeric Any Mandatory if 'ContactInfoRef' tag is indicated
ContactInformation / ContactType Type of contact info Alphabetical Any
ContactInformation / ContactProvided / EmailAddress / EmailAddressValue Email contact (It is used as payer email contact) Alphanumeric Any
ContactInformation / ContactProvided / Phone / Label Label to identify the telephone Alphanumeric Any
ContactInformation / ContactProvided / Phone / PhoneNumber Phone number (It is used as payer phone number contact) Numeric Any
ContactInformation / Individual / GivenName Name for the emergency contact Alphanumeric Any
ContactInformation / Individual / Surname Surname for the emergency contact Alphanumeric Any

Response Body

OrderView v17.2 RS

Order View 17