...
...
Include the separator in <Surname> field.
Functional Description
| Excerpt |
|---|
OrderRetrieve service is used to retrieve live orders that have been created previously. In the response will appear only confirmed segments from retrieved order. This service also allows consulting NDC orders that have been modified outside NDC. Actually this service shows info when segments are the same quantity between original and updated order and when changes are refered to class, date or flight number. In this case a warning is shown an order is unserviciable. 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. |
...
Functionality
...
Use
...
Examples - Complete Flow (All RQ/RS)
...
Retrieve by Order ID filter
...
Retrieve live orders that have been created previously. It will show only confirmed segments from retrieved order.
Retrieve orders updated outside NDC where segments are the same quantity and there have changes in class, date or flight number.
It will show only confirmed segments from retrieved order.
...
OrderRetrieve - With OrderID - 1 ADT 1 CHD 1 INF - Resident & Large Family Discount.zip
Order Retrieve - Round Trip - Cash - 4 Adults - Flight Hour Change Outside NDC - OrderID.zip
Order Retrieve - Round Trip - Cash - 2 Adults - Corporate Seller.zip
Order Retrieve - Round Trip - Cash - 1 Adult 1 Child 1 Infant - Ancillaries.zip
OrderRetrieve - With OrderID - 1 ADT 1 CHD 1 INF - Private Fare.zip
Order Retrieve - Round Trip - Cash - Add Seats Outside NDC.zip
Order Retrieve - Round Trip - Cash - Add Seats Outside NDC From Another Operating Company.zip
...
etrieve by PNR & Surname filter
...
Same funcionality as retrieves above in this case filtering by Iata Number, PNR, it airlineID associated & Surname.
If Surname characters are two, Surname introduced in RQ will filter these two characters.
If Surname characters are three or more, if first three surname characters introduced in the request matches, Order View RS will be correctly displayed.
...
Order Retrieve - Round Trip - Cash - 4 Adults - Flight Hour Change Outside NDC - PNR & Surname.zip
Order Retrieve - Round Trip - Cash - 1 Adult - Special Needs v16.zip
...
Retrieve by PNR filter
...
Same funcionality as retrieve above in this case filtering by Iata Number, PNR and it airlineID associated.
...
...
ENDPOINTS
...
BETA
...
https://test.api.iberia.com/iberia/beta/ndc/OrderRetrieve/17.2/v1
...
UATB
...
https://test.api.iberia.com/iberia/uatb/ndc/OrderRetrieve/17.2/v1
...
UATD
...
https://test.api.iberia.com/iberia/uatd/ndc/OrderRetrieve/17.2/v1
...
| Status | ||||
|---|---|---|---|---|
|
...
https://api.iberia.com/iberia/ndc/test/OrderRetrieve/17.2/v1
| Panel | ||||
|---|---|---|---|---|
| ||||
|
HTTP Headers
...
HEADER NAME
...
DESCRIPTION
...
MANDATORY?
...
EXAMPLE
...
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.
...
2 Alphabetical
...
EN
ES
...
Version
...
The IATA version of the message
...
Numeric
...
Any
...
Schema
...
<PointOfSale>
...
Location / CountryCode
...
Country code
...
2 Alphabetical
...
...
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 Numeric
...
NDC Mandatory
...
<Party>
...
Schema
...
Sender / CorporateSender / ID
...
Corporate ID
...
Alphanumeric
...
Any
...
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 / 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.
...
<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
...
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
...
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)
...
7 Numeric
...
7 Numbers
...
Mandatory for schema if 'Participants' tag is indicated.
...
<Query / Filters> Order by OrderID
OrderID
| Info |
|---|
AttributeOwner |
...
Order owner
...
Alphanumeric
...
IB
...
Schema
...
OrderID
...
Order identification
...
Alphanumeric
...
Any
...
Schema
...
<Query / Filters> Order by Locator and Surname
...
Passengers / Individual / Surname
...
Passenger's surname
(Agency can specify separated by a special character "@" first and second surname → Ex: De la Morena@López)
...
Alphanumeric
...
Any
...
Schema
...
BookingReferences / BookingReference / ID
...
Order's locator
...
Alphanumeric
...
Any
...
Schema
...
BookingReferences / BookingReference / AirlineID
...
Airline ID
...
2 Alphanumeric
...
IB
...
Schema
Response Body
Error messages
For further information about all kind of error messages, please go to the following link:
...
Functional Description
Please, visit our New OrderRetrieve page.
