OrderChange 16.2 Live
version: 2.46
New Functionality:
(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>
Message Examples
OrderChange.zip message examples
EndPoint:
- IATA NDC Schema Version 16.2: https://test.api.iberia.com/iberia/beta/ndc/OrderChange/v2
HTTP Headers
api_key | Your unique key used to authorise access to the API. | Mandatory:Yes |
New or modify field
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 | 2 alphabetic | Depends of the Country Code | |
Version |
The IATA version of the message |
numeric | any | Schema |
xmlns | IATA oficial website | alphabetic | any | |
<PointOfSale> | ||||
Location / CountryCode |
Country code |
alphabetic |
NDC Mandatory If toggle feature for market validation is activated. | |
<Document> | Schema | |||
ReferenceVersion |
The IATA Schema version. |
alphanumeric |
any |
|
<Party / Sender / TravelAgencySender> | Schema | |||
IATA_Number | Sender IATA or Pseudo IATA number | numeric | 7/8 numbers | NDC Mandatory |
AgencyID | AgencyID | alphanumeric | any | Schema |
Name |
Agency name | alphabetic | any | |
<Party / Sender / TravelAgencySender / Contacts / Contact> | Mandatory for schema if 'Contacts' tag is indicated. | |||
EmailContact / Address | Email to contact the Agency | alphanumeric | any | Mandatory for schema if 'EmailContact' tag is indicated. |
PhoneContact / Application | Agency phone type | alphabetic |
|
|
PhoneContact / Number Attribute CountryCode |
Country code phone number to contact the Agency | alphanumeric | any | |
Name / Surname |
Reference Agency contact surname |
alphanumeric |
numbers |
Mandatory for schema if 'Name' tag is indicated. |
Name / Given |
Reference Agency contact given |
alphanumeric |
any |
|
<Party / Participants> | ||||
Participants / Participant Attribute SequenceNumber |
Number of aggregator secuency connection
|
numeric | any | |
Participant / AggregatorID | Aggregator ID of the participant which is connecting | 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 |
|
|
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Number | Phone number to contact the Agency | Numeric | Any | |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Surname | Reference Agency contact surname | Alphanumeric | Any | |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given | Reference Agency contact name | Alphanumeric | 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 | 7/8 Numbers |
Participants / Participant / TravelAgencyParticipant / AgencyID | Id for the Agency | Alphanumeric | Alphanumeric | 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) |
7 Numeric | 7 Numbers | Mandatory for schema if 'Participants' tag is indicated |
<Query> | Schema | |||
<Query / Passengers> |
NDC Mandatory for the following action types:
Passenger List is NOT mandatory and NOT validated for Voluntary Change Flow (D&C). |
|||
Passenger |
ObjectKey attribute Identifier for a passenger. |
alphanumeric |
|
Mandatory for schema if 'Passengers' tag is indicated. |
Passenger / Name / Surname | Surname of the passenger | alphabetic | any | Mandatory for schema if 'Passengers' tag is indicated. |
Passenger / Name / Given | Name of the passenger | alphabetic | any | |
Passenger / Name / Title | Title of the passenger | alpha |
|
NDC Mandatory for secure flights |
Passenger / Contacts / Contact / EmailContact / Address | Email address | alphanumeric | any | Mandatory for schema if 'EmailContact' tag is indicated. |
Passenger / Contacts / Contact / PhoneContact / Application | Application | alphabetic | any | |
Passenger / Contacts / Contact / PhoneContact / Number | Telephone number | numeric | any | |
ActionType | Action type | alphabetic |
|
NDC Mandatory |
<Query / Order> | Schema | |||
OrderID | Order ID previously generated | alphanumeric | any | Schema |
TotalOrderItemQuantity | Total Order Quantity → This field is not validated | numeric | any | Schema |
ActionType | Action type to realize | alphabetic |
|
NDC Mandatory |
<Query / Order> | Schema | |||
OrderItemID | OrderItem ID to generate for additional services | alphanumeric | any | Schema |
ActionType | Action type to realize | alphabetic |
|
NDC Mandatory |
Associations / Passengers / PassengerReferences | Reference to the ObjectKey of the passenger of the OrderItem | alphanumeric | any | |
Associations / Flight / SegmentReferences | Reference to the suitable SegmentKey of the DataList/FlightSegmentList/Flight. | alphanumeric | any | |
<Query / Order / OrderItems / OrderItem / SeatItem> | NDC Mandatory | |||
Price / Total Code | total seat price with currency code | numeric | any | NDC Mandatory |
Location / Column | column where the seat is located | alphabetic | any | NDC Mandatory |
Location / Row/ Number | row where the seat is located | numeric | any | NDC Mandatory |
<Query / Order / OrderItems / OrderItem / BaggageItem> | NDC Mandatory | |||
BagDetails / BagDetail / ValidatingCarrier | Id for the carrier, for example 'IB' | alphabetic | any | Mandatory for schema if 'BaggageItem' tag is indicated. |
BagDetails / BagDetail / CheckedBags / CheckedBag / PieceAllowance / ApplicableParty | Associated traveler | alphabetic | any | Mandatory for schema if 'BaggageItem' tag is indicated. |
BagDetails / BagDetail / CheckedBags / CheckedBag / PieceAllowance / TotalQuantity | total amount of bagage | numeric | any | Mandatory for schema if 'BaggageItem' tag is indicated. |
BagDetails / BagDetail / CheckedBags / CheckedBag / PieceAllowance / PieceMeasurements |
Bagage units Only the value 1 is allowed, and any other value will be ignored |
numeric | any | Mandatory for schema if 'BaggageItem' tag is indicated. |
BagDetails / BagDetail / Price / DetailCurrencyPrice / Total Code | Total baggage price with currency code | numeric | any | NDC Mandatory |
<Query / Payments> → This refers to Cash method. |
NDC Mandatory if additional payment is needed. | |||
Payment / Method | Payment Method, can be Cash payment, Card payment or Other payment (for service fee) | alphabetic | any | Mandatory for schema if 'Payments' tag is indicated. |
For other FOPs, see attached docs | ||||
Payment / Amount Attribute Code |
Total amount of the offer with associated currency. Code refers to currency code for payment. |
numeric | any | Mandatory for schema if 'Payments' tag is indicated. |
Payer / Name / Surname | Payer's surname | alphabetic | any | Mandatory for schema if 'Payments' tag is indicated. |
Payer / Name / Given | Payer's name | alphabetic | any | NDC Mandatory |
Payer / Contacts / Contact / Phone Contact / Number | telephone number | numeric | any | |
Payer / Contacts / Contact / Phone Contact / Address | Email adress | alphanumeric | any | |
<DataLists / FlightSegmentList> |
NDC Mandatory |
|||
---|---|---|---|---|
FlightSegment Attribute SegmentKey |
SegmentKey attribute Identifier for a segment. |
alphanumeric | any | Mandatory for schema if 'FlightSegmentList ' tag is indicated. |
Departure / AirportCode | Code of the departure airport | alphabetic | any | Mandatory for schema if 'FlightSegmentList ' tag is indicated. |
Departure / Date | Date associated to departure flight | numeric | any | Mandatory for schema if 'FlightSegmentList ' tag is indicated. |
Arrival / AirportCode | Code of the arrival airport | alphabetic | any | Mandatory for schema if 'FlightSegmentList ' tag is indicated. |
MarketingCarrier / AirlineID | Airline identifier | alphanumeric | any | Mandatory for schema if 'FlightSegmentList ' tag is indicated. |
MarketingCarrier / FlightNumber | Flight number corresponding to the segment | numeric | any | Mandatory for schema if 'FlightSegmentList ' tag is indicated. |
<Query / OrderChangeMetadata> | ||||
Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata / MetadataKey Attribute MetadataKey |
Type of currency Currency will be validated if toggle feature associated is activated. |
alphanumeric | any available currency | Mandatory for schema if 'OrderChangeMetadata' tag is indicated. |
Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata / Decimals | Decimals of currency | numeric | any | Mandatory for schema if 'OrderChangeMetadata' tag is indicated. |
Response Body
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".