OrderChange

1.1 Functional Description

version: 2.46 

The  OrderChange API allows an existing Order to be updated.

Functionality:

OrderChange.zip message examples

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

  • Update passenger contact info (telephone or email) → Only one change is made per request and per passenger. The email and telephone information is saved in Resiber as an SSR element. Even if ticket is re-issued.
  • 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 or one segment has been flown.
    • Only for ADT passengers (not CHLD) without any INFT or Special Services or Ancillary Services (BAG and SEATS) associated.
    • NOT allowed for Residents and Large Family Discounts
    • Allowed for Private Fares
  • 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.
  • Voluntary Change → Changes of date, time(flt number) and class of flight(s) only before use of any service (all tickets in Open for Use/Airport Control). It can me made for only some passengers of the order or for all passengers of the order, and no previous change has been made. NOT allowed for Private Fare orders.
  • Partial cancelations (unused services).→ Refunds partially an order (At least one coupon must be in Used status and another one in Open for Use/Airport Control) and for all passengers in the Order.
  • Delete Some Passengers without ItinReShop → 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 type Delete 
  • Delete Some Passengers with ItinReShop -  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 type Delete & Create after a previous itin reshop type Delete.

 

The Order Change API currently supports the following types of changes differenced by action type:

ActionType Use
Create

It is provided in an OrderItem element level.

In this case, what NDC expects is an operation to include EMD (seat/baggage).

This action type allows adding one or more additional services in the same request.


Delete 

It is provided in the passenger level tag we want to delete.

This action type allows deleting one or more passengers of an initial order → Previous itin reshop type 'Delete' is not mandatory.


Delete & Create

It is provided in an OrderItem element level.

Allows following changes:

  • 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 itin reshop type 'Delete & Create' and 'Reprice' are both mandatory.
  • Allows deleting one or more passengers of an order (at least one coupon must be in Open for Use/Airport Control status) → Previous itin reshop type 'Delete' is mandatory.

 

Update

It is provided in an Order element level. It can be provided in a Passenger level but, if it exists, it is currently omitted by NDC.

This action type is intended to perform changes of:

  • Contact information (telephone or email).
  • Name Correction (up to 3 characters once).

This action type allows only one change for request/passenger. For more changes we will have to add similar requests.


Cancel

It is provided in an Order element level → Previous itin reshop type 'Cancel' is not mandatory.

Refunds partially an order for all passenger of the order. Coupons have to combine Used/Flown status and Open for Use/Airport Control status

If there is a voluntary change for some or all passengers of the initial order, there are several options like:

  • Additional charge has to be paid by the passenger with no penalty.
  • Additional charge has to be paid by the passenger with penalty (Penalty EMD is issued)
  • Airline has to return a specific amount to the passenger (Exchange EMD is issued)

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 ItinReshop and OrderCancel should be used for total refund.

 

(version: 2.20)Associate infants to any adult passenger.


(version: 2.24):Modify the flights of a passenger in a paid or issued reservation.

<Query>
 <Order>
   <OrderID Owner="IB">ORDER_ID_ORIGINAL</OrderID>
    <OrderItems>
     <OrderItem>
        <OrderItemID Owner="IB">ORDER_ITEM_ORIGINAL</OrderItemID>
            <ActionType>Delete</ActionType>
      </OrderItem>
      <OrderItem>

         <OrderItemID Owner="IB">OFFER_ID_SELECCIONADO</OrderItemID>
             <ActionType>create</ActionType>
      </OrderItem>
    </OrderItems>
  </Order>      
  <Payments>   
      data
  </Payments>
</Query>      

(version: 2.23): Validation of the currency we sell with the point of sale currency. This information will be optional.

    
    <Metadata>
        <Other>
            <OtherMetadata>
                <CurrencyMetadatas>
                    <CurrencyMetadata MetadataKey="EUR">
                    <Decimals>2</Decimals>
                    </CurrencyMetadata>
                </CurrencyMetadatas>
            </OtherMetadata>
        </Other>
    </Metadata>

 

 

EndPoint:


Add = New

 

HTTP Headers

api_key Your unique key used to authorise access to the API. Yes n/a

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. alpha
  • EN
  • ES

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 Numeric Any
Sender / TravelAgencySender / Contacts / Contact / Name / Surname Reference Agency contact surname Alphanumeric Any
Sender / TravelAgencySender / Contacts / Contact / Name / Given Reference Agency contact name Alphanumeric Any Mandatory for schema if 'Name' tag is indicated.
Sender / TravelAgencySender / AgencyID Id for the Agency Alphanumeric Any Schema
Participants / Participant / 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)

7 Numeric 7 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 / ActionType Action type Alphabetical
  • Add
  • Remove

New / Individual / Given Name of the passenger Alphanumeric Any
New / Individual / Surname Surname of the passenger Alphanumeric Any
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 / ContactInfoRef Old contact info reference Alphanumeric Any
Previous / ActionType Action type Alphabetical
  • Add
  • Remove

<Query / OrderServicing>

AcceptOffer / Offer

Attribute

OfferID

Attribute

ResponseID

Id of the Offer

SeatAvailability ResponseID / ServiceList ResponseID

Alphanumeric

Alphanumeric

Any

Any


AcceptOffer / Offer OfferItem

Attribute

OfferItemID

Id of the OfferItem 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 OrderItemID to be deleted Alphanumeric Any
<Query / Payments / Payment> Schema
Type Payment Method, can be Cash payment, Card payment or Other payment (for service fee). Alphabetic
  • Credit Card
  • Cash
  • Other: Added in 2.16. The Service Fee associated to Resident and Large Family booking must be provided as a special payment method. To identify this situation the payment method is of Other type with a Remarks with the ServiceFee value.
Schema
Amount Total amount of the offer 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 to contact passenger Alphanumeric Any
ContactInformation / ContactProvided / Phone / Label Label to identify the telephone Alphanumeric Any
ContactInformation / ContactProvided / Phone / PhoneNumber Phone number for the label Numeric Any
ContactInformation / Individual / GivenName Name for the emergency contact Alphanumeric Any
ContactInformation / Individual / Surname Surname for the emergency contact Alphanumeric Any

Response Body

Order View RS

1.4 Error messages

NDC Standard allow errors and warnings to be returned inside an 200 OK response. Errors returned with 200 OK will always be controlled errors result of external limitations as "Max accepted non-infant passengers is 9".

The following codes are enclosed in the response returned with a 200 OK.

PADIS STATUS CODE

EXAMPLE MESSAGE ERROR

REASON

486 Invalid action code Incorrect action
486 Action code missing Action missing
396 Invalid ticket/document coupon status Order without tickets
396 Invalid ticket/document coupon status Order with some ticket in status distinct of OPEN FOR USE
396 Invalid ticket/document coupon status Order with some ticket reissued
396 Refund request for tickets not issued. Please check the information entered and if the issue persists get in touch with us. Not Issued Tickets
911 Ha habido un error en tu localizador. Por favor ponte en contacto con nosotros. PNR cancelled
915 No action - processing host cannot support function Same flight
76D Modified itinerary – change options not allowed New origen/arrival
73H Changes not allowed in original itinerary Add a segment
74T Reembolso por cancelación no permitido Reissued ticket
486 Changes have been made to the reservation from outside of NDC. Sorry we can’t process the request. Reserve modificated outside NDC.

 

 

NDC Standard allow errors and warnings to be returned inside an 200 OK response. Errors returned with 200 OK will always be controlled errors result of external limitations as "Max accepted non-infant passengers is 9".