OrderRetrieve

1.1 Functional Description

version: 2.47 

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

HTTP Headers

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

Request Body

NAMEDESCRIPTIONFORMATALLOWED VALUESMANDATORY 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 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 Numeric 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 / Filters> Order by OrderID

OrderID

Attribute

Owner

Order owner Alphanumeric IB Schema
OrderID Order identification Alphanumeric Any Schema
<Query / Filters> Order by Locator and Surname
Passengers / Individual / Surname Passenger's surname Alphanumeric Any Schema
BookingReferences / BookingReference / ID Order's locator Alphanumeric Any Schema
BookingReferences / BookingReference / AirlineID Airline ID 2 Alphanumeric IB Schema

Response Body

NAMEDESCRIPTIONFORMATALLOWED VALUESNullable
<Document>
ReferenceVersion The IATA version of the message Numeric Any False
<OrderViewProcessing>
Remarks / Remark Additional information for the order Alphanumeric Any True
<Order>

Order

Attribute

OrderID

ID for the Order Alphanumeric Any False
BookingReferences / BookingReference / ID Order's Locator Alphanumeric Any False
BookingReferences / BookingReference / AirlineID ID for the Airline Alphanumeric Any False
TotalOrderPrice / DetailCurrencyPrice / Total Total price for the Order Numeric
False
TotalOrderPrice / DetailCurrencyPrice / Taxes / Total Total taxes amount for the Order Numeric Any False
<Order / OrderItems>

OrderItem

Attribute

OrderItemID

ID for the OfferItem Alphanumeric Any False
OrderItem / PriceDetail / TotalAmount / SimpleCurrencyPrice Total price for the OfferItem Numeric Any False
OrderItem / PriceDetail / BaseAmount Amount of the OrderItem without taxes Numeric Any False

OrderItem / PriceDetail / Taxes / Total

Total amount of taxes and breakdown Numeric Any False
OrderItem / PriceDetail / Taxes / Breakdown / Tax / Amount Amount for a tax Numeric Any False
OrderItem / PriceDetail / Taxes / Breakdown / Tax / TaxCode Code for the tax Alphanumeric Any False

OrderItem / Service

Attribute

ServiceID

ID for the Service Alphanumeric Any False
OrderItem / Service / PassengerRef Passenger Identifier Alphanumeric Any False
OrderItem / Service / SegmentRef Segment Identifier Alphanumeric Any False
OrderItem / Service / SelectedSeat / Seat / Row Row of the seat Numeric Any True
OrderItem / Service / SelectedSeat / Seat / Column Column of the seat Alphabetical Any True
OrderItem / Service / ServiceDefinitionRef Definition of the service Alphanumeric Any True
Commission / Percentage Percentage of commision that applicates to the OfferItem Numeric Any True
Commission / Amount Amount of commision that applicates to the OfferItem Numeric Any True
<TicketDocInfos / TicketDocInfo>
TicketDocument / TicketDocNbr Number for the ticket Numeric Any True
TicketDocument / Type Type of ticket Alphanumeric Any True
TicketDocument / NumberofBooklets Number of tickets Numeric Any True
TicketDocument / DateOfIssue Date of ticket issue Date Any True
TicketDocument / TimeOfIssue Hour of ticket issue Hour Any True
TicketDocument / CouponInfo / CouponNumber Number of coupons Numeric Any True
TicketDocument / CouponInfo / FareBasisCode / Code Code of the farebasis Alphanumeric Any True
TicketDocument / CouponInfo / CouponValid / EffectiveDatePeriod / Effective Date of effective for the coupon Date Any True
TicketDocument / CouponInfo / Status Coupon's status Alphabetical Any True
TicketDocument / CouponInfo / SoldAirlineInfo / Departure / AirportCode IATA 3 character code for the departure city/airport/station 3 Alphanumeric Any True
TicketDocument / CouponInfo / SoldAirlineInfo / Departure / Date Date of departure Date (yyyy-MM-dd) Any True
TicketDocument / CouponInfo / SoldAirlineInfo / Departure / Time Time of departure Hour (HH:mm) Any True
TicketDocument / CouponInfo / SoldAirlineInfo / Arrival / AirportCode IATA 3 character code for the arrival city/airport/station 3 Alphanumeric Any True
TicketDocument / CouponInfo / SoldAirlineInfo / MarketingCarrier / AirlineID Id for the airline that markets the flight Alphabetical Any True
TicketDocument / CouponInfo / SoldAirlineInfo / MarketingCarrier / FlightNumber Flight number for the airline that markets the flight Numeric Any True

TicketDocument / CouponInfo / AddlBaggageInfo / AllowableBag

Attribute

Number

Number of allowed baggages Numeric Any True
TicketDocument / CouponInfo / InConnectionWithInfo / InConnectionDocNbr Number of InConnectionDoc Numeric Any True
TicketDocument / CouponInfo / InConnectionWithInfo / InConnectonCpnNbr Number of InConnectonCpn Numeric Any True
TicketDocument / CouponInfo / ReasonForIssuance / RFIC RFIC reference Alphanumeric Any True
TicketDocument / CouponInfo / ReasonForIssuance / Code Code reference Alphanumeric Any True
TicketDocument / CouponInfo / ReasonForIssuance / Description Description reference Alphanumeric Any True
TicketDocument / ReportingType Type of reporting Alphanumeric Any True
TicketDocument / PassengerReference Reference for passenger of the ticket Alphanumeric Any True
<DataLists / Passenger>

Passenger

Attribute

PassengerID

Passenger Identifier Alphanumeric Any False
PTC Attribute Passenger Type Code PaxType (3 Alphabetical) Passenger Types False
Birthdate Birthdate of the passenger Date Date depends of the PTC False
Individual / Gender Gender of the passenger Alphabetical
  • Male
  • Female
True
Individual / NameTittle Title of the passenger Alphabetical
  • MR
  • MRS
  • MS
  • MSS
True
Individual / GivenName Name of the passenger Alphabetical Any False
Individual / Surname Surname of the passenger Alphabetical Any False
Individual / SurnameSuffix Passenger suffix Alphabetical Any True
(plus) LoyaltyProgramAccount / Airline / AirlineDesignator Airline ID Alphanumeric Any True
(plus) LoyaltyProgramAccount / AccountNumber FF number account Numeric 8 digits True
FOID / FOID_Number Number for the document Alphanumeric Any False
FOID / FOID_Type Type of the passenger ID Info 2 Alphanumeric
  • NI
  • PP
False
IdentityDocument / IdentityDocumentNumber Number of identity document Numeric Any True
IdentityDocument / IdentityDocumentType Type of document Alphanumeric Any
  • F1 (Other Documents, Resident Discount)
  • AI (Additional information, Large Family Discount)
True 
ContactInfoRef Reference for passenger's contact info Alphanumeric Any True
Remark / Remark Description of remark Alphanumeric Any True
<DataLists / ContactList>

ContactInformation

Attribute

ContactID

ID for the contact information Alphanumeric Any True
ContactInformation / ContactProvided / ContactType Description of contact type Alphanumeric Any True
ContactInformation / ContactProvided / EmailAddress / EmailAddressValue Email address for the contact Alphanumeric Any True
ContactInformation / ContactProvided / Phone / PhoneNumber Phone number for the contact Numeric Any True
ContactInformation / Individual / Gender Gender of the passenger Alphabetical
  • Male
  • Female
True
ContactInformation / Individual / NameTitle Title of the passenger Alphabetical
  • MR
  • MRS
  • MS
  • MSS
True
ContactInformation / Individual / GivenName Name of the passenger Alphanumeric Any True
ContactInformation / Individual / Surname Surname of the passenger Alphanumeric Any True
ContactInformation / Individual / SurnameSuffix Passenger suffix Alphanumeric Any True
<DataLists / FlightSegment / FlightSegment>

FlightSegment

Attribute

SegmentKey

ID for the segment Alphanumeric Any False
Departure / AirportCode IATA 3 character code for the departure city/airport/station 3 Alphanumeric Any False
Departure / Date Date of departure Date yyyy-MM-dd False
Departure / Time Time of departure Hour (HH:mm False
Departure / AirportName Name of the departure city/airport/station Alphanumeric Any False
Departure / Terminal / Name Name of the departure terminal at city/airport/station Alphanumeric Any False
Arrival / AirportCode IATA 3 character code for the departure city/airport/station 3 Alphanumeric Any False
Arrival / Date Date of arrival Date yyyy-MM-dd False
Arrival / Time Time of arrival Hour HH:mm False
Arrival / ChangeOfDay Number of days change Numeric Any False
Arrival / AirportName Name of the arrival city/airport/station Alphanumeric Any False
Arrival / Terminal / Name Name of the arrival terminal at city/airport/station Alphanumeric Any False
MarketingCarrier / AirlineID Id for the airline that markets the flight Alphabetical Any False
MarketingCarrier / Name Name for the airline that markets the flight Alphanumeric Any False
MarketingCarrier / FlightNumber Number for the flight Numeric Any False
OperatingCarrier / AirlineID Id for the airline that operates the flight Alphabetical Any False
OperatingCarrier / Name Name for the airline that operates the flight Alphanumeric Any False
OperatingCarrier / FlightNumber Number for the flight Alphanumeric Any False
OperatingCarrier / Disclosures / Description / Text Description of the airline Alphanumeric Any False
Equipment / AircraftCode Code for the aircraft that operates the flight Alphanumeric Any False
Equipment / Name Name for the aircraft that operates the flight Alphanumeric Any False
FlightDetail / FlightDuration / Value Duration of the flight Alphanumeric Any False
<DataLists / FlightList>

Flight

Attribute

FlightKey

ID for the flight Alphanumeric Any False
Journey / Time Duration of the flight Alphanumeric Any False
SegmentReferences References for the segments Alphanumeric Any False
<DataLists / OriginDestinationList>

OriginDestination

Attribute

OriginDestinationKey

ID for the origin-destination Alphanumeric Any False
DepartureCode IATA 3 character code for the departure city/airport/station 3 Alphanumeric Any False
ArrivalCode IATA 3 character code for the arrival city/airport/station 3 Alphanumeric Any False
FlightReferences References for the flight Alphanumeric Any False
<DataLists / MediaList>

Media

Attribute

ListKey

Id for the Media Item Alphanumeric Any False
Media / MediaLink Http link referring to the Media Item Alphanumeric Any False
<ServiceDefinitionList / ServiceDefinition>

ServiceDefinition

Attribute

ServiceDefinitionID

Id for the service Alphanumeric Any True
Name Name for the service Alphanumeric Any True
ServiceBundle / ServiceDefinitionRef Reference for the service Alphanumeric Any True
Descriptions / Description / Text Descripition for the service Alphanumeric Any True
BookingInstructions / SSRCode Code for the service Alphabetical Any True
<Metadata / Other / OtherMetadata / CurrencyMetadatas>

CurrencyMetadata

Attribute

MetadataKey

ID for the Metadata Alphanumeric Any True
CurrencyMetada / Decimals Number of decimals Numeric Any 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.