OrderRetrieve

1.1 Functional Description

version: 2.38

The OrderRetrieve service is to retrieve orders that have been created previously.

Functionality:

OrderRetrieve.zip message examples

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

EndPoints:

Add = New

1.2 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 alpha

EN

ES


Version

The IATA version of the message

numeric

any

Schema

<PointOfSale>

CountryCode

Country code

alphabetic

List of countries

If toggle feature for market validation is activated.

<Document>

ReferenceVersion

The IATA Schema version.

numeric

any


<Party / TravelAgencySender>

Sender / IATA_Number

Sender unique identifier such as:

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

NDC Mandatory

Sender / AgencyID

Name of the Sender / Agency

alphanumeric

any

Schema

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 / Filtrers> Order by OrderID

OrderID

OrderID

64 alphanumeric

any

Schema
OrderID Owner Order owner alphanumeric IB Schema

<Query / Filtrers> Order by Locator and Surname

Passengers / Name / Surname

Passenger's surname

alphanumeric

any

Schema

BookingReference / ID

Order's locator

alphanumeric

any

Schema

BookingReference/  Airline ID

Airline ID

2 alpha

any

Schema

1.3 Response Body

NAME

DESCRIPTION

FORMAT

Nullable

<Party>  
 
Sender / IATA_Number
Sender IATA number (if you have one)  numeric False
 Sender / AgencyID
 Agency ID  alphanumeric  True
 Sender / Name
 Agency name
 alphanumeric  False
<Sender / Contact>       
 EmailContact / Address
Email to contact the Agency alphanumeric True
 PhoneContact / Application
Agency phone type alphabetic True
 PhoneContact / Number
Phone number to contact the Agency numeric True
Name / Surname
Reference Agency contact name and surname alphanumeric False
< OrderViewProcessing >
Remarks / Remark DisplayInd
boolean False
Remarks / Remark Information indicating whether or not passengers should present residence documentation at the airport. alphanumeric True
<Passengers / Passenger>
ObjectKey
alphanumeric False
PTC Passenger Type Code 3 alpha False
PassengerAssociation  Reference to the PassengerID alphanumeric False
Age / Birthdate Birthdate of the passenger Date False
Name / Surname Surname of the passenger alpha False
Name / Given Name of the passenger alphanumeric False
Name / Title Title of the passenger (Mandatory for secure flights) alpha True
Contacts / Contact / PhoneContact / Number Number of the phone contact alphanumeric False
Contacts / Contact / EmailContact / Address Email address alphanumeric False
Gender Gender of the passenger (Mandatory for Infants) alphabetic True
PassengerIDInfo / FOID / Type Type of the passenger ID Info alphanumeric False
PassengerIDInfo / FOID / ID Residence certificate number / Large Family certificate number alphanumeric False
PassengerDocument / Type Type of the passenger ID Info alphanumeric False
PassengerDocument / ID Residence certificate number / Large Family certificate number alphanumeric False
PassengerDocument / ApplicabilityLocation Municipality of residence / Community code for large family alphanumeric False
AdditionalRoles PrimaryContactInd
boolean True
< Order >
OrderID Owner OrderID Owner alphanumeric False
OrderID Order ID alphanumeric False
< Order / BookingReferences / BookinReference >
ID Order`s Locator alphanumeric False
Airline ID Airline ID 2 alpha False
< Order / Status / StatusCode>
Code Shows if the order is unserviciable (UNS) alpha any
< Order / TotalOrderPrice >
DetailCurrencyPrice / Total Code Currency code alpha False
DetailCurrencyPrice / Total Total amount of the order numeric False
DetailCurrencyPrice / Taxes / Total Code Currency code alpha False
DetailCurrencyPrice / Taxes / Total Taxes amount numeric False
< Order / OrderItems / OrderItem >
OrderItemID Owner Owner code alpha False
OrderItemID OrderItem ID alphanumeric False
Payment TimeLimit Payment time limit expired date True
< Order / OrderItems / OrderItem / FlightItem / Price >
BaseAmount Code Currency code alpha False
BaseAmount Amount of the OrderItem numeric False
< Order / OrderItems / OrderItem / FlightItem / Price / Taxes >
Total Code Currency code alpha False
Total Total amount of taxes and breakdown numeric False
Breakdown / Tax / Amount Code Amount code of breakdown alpha False
Breakdown / Tax / Amount Amount tax numeric False
Breakdown / Tax / TaxCode Amount tax code alpha False
< Order / OrderItems / OrderItem / FlightItem / OriginDestination >
OriginDestinatioKey OriginDestination Key alphanumeric False
< Order / OrderItems / OrderItem / FlightItem / OriginDestination / Flight >
SegmentKey Segment Key alphanumeric False
< Order / OrderItems / OrderItem / FlightItem / OriginDestination / Flight / Departure >
AirportCode Departure airport code 3 alpha False
Date Departure date date False
Time Departure time time False
AirportName Departure airport alpha False
Terminal / Name Departure Terminal number numeric False
< Order / OrderItems / OrderItem / FlightItem / OriginDestination / Flight / Arrival>
AirportCode Arrival airport code 3 alpha False
Date Arrival date date False
Time Arrival time time False
ChangeOfDay Days between the departure and the arrival numeric False
AirportName Arrival airport alpha False
Terminal / Name Arrival Terminal number numeric False
< Order / OrderItems / OrderItem / FlightItem / OriginDestination / Flight / MarketingCarrier >
AirlineID Airline ID of marketing carrier 2 alpha False
Name Airline name of marketing carrier alpha False
FlghtNumber Flight Number of marketing carrier numeric False
< Order / OrderItems / OrderItem / FlightItem / OriginDestination / Flight / OperatingCarrier >
AirlineID Airline ID of operating carrier alpha False
Name Airline name of operating carrier alpha False
FlightNumber Flight Number of operating carrier numeric False
Disclosures / Description / Text Disclosures text 2 alpha False
< Order / OrderItems / OrderItem / FlightItem / FareDetail >
FareComponent refs
alpha False
FareComponent / FareBasis / FareBasisCode / Code Fare basis code alpha False
FareComponent / FareBasis / RBD Booking Code 1 alpha False
FareComponent / TicketDesig Designator alpha False
< Order / OrderItems / OrderItem / FlightItem / Associations >
Passengers / PassengerReferences Passenger references of OrderItem alpha False
< Payments / Payment>
Method / OtherMethod / Remarks / Remark To indicate what payment method is alphanumeric False
Amount Payment amount numeric False
Associations / Passengers / PassengerReference Association to one Passenger instance alphanumeric False
< TicketDocInfos / TicketDocInfo / TicketDocument >
TicketDocNbr Ticket number numeric True
Type / Code  Ticket code 3 alpha True
Type / Definition  Ticket definition alpha True
Type / TableName  Ticket tablename alpha True
NumberofBooklets Number of tickets numeric True
DateofIssue Date of issue date True
TimeOfIssue Time of issue time True
< TicketDocInfos / TicketDocInfo / TicketDocument / CouponInfo >
CouponNumber Numbers of coupons numeric True
FareBasisCode / Code Fare basis code alpha False
CouponValid / EffectiveDatePeriod / Effective Effective date date False
Status / Code Coupon status alphabetic True
SoldAirlineInfo / DepartureDateTime ShortDate Departure Date date False
SoldAirlineInfo / DepartureDateTime / Time Departure Time time False
SoldAirlineInfo / Departure / AirportCode Airport Code 3 alpha False
SoldAirlineInfo / Departure / Date Date time False
SoldAirlineInfo / Departure / Time Time date False
SoldAirlineInfo / Arrival / AirportCode Airpot Code 3 alpha False
SoldAirlineInfo / OperatingCarrier / Airline ID Airline ID 2 alpha False
SoldAirlineInfo / MarketingCarrier / Airline ID Airline ID 2 alpha False
SoldAirlineInfo / MarketingCarrier / FlightNumber Fliht number 4 numbers False
SoldAirlineInfo / Status / Code Code 2 alpha False
DateOfService Departure date date False
Value Coupon Price numeric False
InConnectionWithInfo / InConnectionDocNumber Ticket Reference numeric False
InConnectionWithInfo / InConnectionCpnNbr Coupon number numeric False
ReasonForIssuance / RFIC RFIC code 1 alpha False
ReasonForIssuance / code Code 3 alphanumeric False
ReasonForIssuance / Description Description alphabetic False
< TicketDocInfos / TicketDocInfo >
/ PassengerReference Ticket Passenger Reference alphanumeric True
< Commission >
Percentage Percentage of commission numeric any
Amount Amount of commission numeric any
<DataList / ServiceList>
Service Service with mandatory ObjectKey alphabetic True
ServiceID Service ID with mandatory owner alphanumeric True
Name Service`s name alphanumeric True
Total Total amount of the service numeric True
Taxes Total taxes of the service numeric True
SSRCode SSR code alphabetic True
<DataLists / FareList>
FareGroup ListKey FareGroup with mandatory ObjectKey alphabetic True
Fare / FareCode / Code FareGroup Service ID with mandatory service code numeric True
Fare / FareCode / Definition FareGroup product mandatory definition alpha True
FareBasisCode / Code Fare basis code alpha True

1.1 Error messages

NDC Standard allow errors and warnings to be returned inside a 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".

PADIS STATUS CODE

EXAMPLE MESSAGE ERROR

REASON

911 PNR Error: Invalid PNR PNR invalid
401 Order not found Order not found
486 The reservation has been cancelled PNR Canceled
486 Changes have been made to the reservation from outside of NDC. Sorry we can’t process the request.

Reserve modificated outside NDC.