OrderCreate 16.2 Live
v16.2 - R2.62 - R2019.20
Message Examples
Functionality | Examples Complete Flows(All RQ/RS) |
Basic |
|
Payments Methods |
|
Private Fare |
|
Resident Discount |
|
Large Family |
|
Seats And Bags |
|
Special Needs |
|
Agency Contact / Passenger Emergency Contact |
|
Remarks - External Reference |
|
Frequent Flyer |
|
(Fiscal ID) |
|
ENDPOINT | |
---|---|
BETA | test.api.iberia.com/beta/ndc/OrderCreate/v2 |
New or Modified field
HTTP Headers
api_key | Your unique key used to authorize access to the API. | Mandatory:Yes |
Request Body
NAME |
DESCRIPTION |
FORMAT |
ALLOWED VALUES |
MANDATORY FOR |
PrimaryLangID |
Two character ISO Language Code, for the agent’s preferred language. This is used for comunications such as: error messages, legal waivers, warnings, email confirmations and notifications. If PrimaryLangID is not avalaible for the comunication, it will be sent in the market point of sale default language. |
2 alphabetic | Depends of the Country code | |
Version | The IATA version of the message | numeric | any | Schema |
<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 | |||
Type |
Agency Type
|
alphabetic | any | |
IATA_Number |
Sender IATA or Pseudo IATA number |
numeric |
7/8 numbers |
NDC Mandatory |
AgencyID |
Agency identification |
alphanumeric |
any |
Schema |
Name | Agency Name | alphanumeric | 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 | alphabetic | any | Mandatory for schema if 'Name' tag is indicated. |
Name / Given | Reference Agency contact given | alphabetic | 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 | alphanumeric | Any | |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Surname | Reference Agency contact surname | alphabetic | Any | |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given | Reference Agency contact name | alphabetic | 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) |
numeric | 7/8 Numbers | Mandatory for schema if 'Participants' tag is indicated. |
<Query> | Schema | |||
< Query / Passengers / Passenger > | NDC Mandatory | |||
Passenger Attribute ObjectKey |
Passenger Object Key. This value is used as the passenger identifier passenger references as example:
|
alphanumeric |
any |
NDC Mandatory |
PTC | Passenger Type Code | 3 alpha | Passenger Types | |
PassengerAssociation | Reference to the associated passenger | alphanumeric | any | |
Age / Birthdate |
Birthdate of the passenger (Mandatory for secure flights for all passengers) Birthdate of the passenger (Always mandatory for CHD and INF Passengers) |
Date | Date depends of the PTC | Mandatory for schema if 'Age' tag is indicated. |
Name / Surname | Surname of the passenger | alphabetic | any | Mandatory for schema if 'Name' tag is indicated (2 characters minimun for NDC) |
Name / SurnameSuffix |
Passenger suffix for duplicate names It must necessarily be predefined as text (see example) *<SurnameSuffix xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">MR</SurnameSuffix>* |
alphabetic |
any
|
|
Name / Given | Name of the passenger | alphabetic | any | NDC Mandatory (2 characters minimun) |
Name / Title |
Title of the passenger (Mandatory for secure flights) NDC supports followings fields (MR, MRS, MS, MSS, MISS). If another field is introduced no error is shown, only this field is ignored. |
alphabetic |
|
Mandatory for secure flights |
Contacts / Contact / PhoneContact / Number | Number of the phone contact | alphanumeric | any | Mandatory for at least one Adult. |
Contacts / Contact / EmailContact / Address | Email address | alphanumeric | any | Mandatory for schema if 'EmailContact' tag is indicated. Mandatory for at least one Adult |
For emergency contact information. Attribute ContactType="Emergency" |
Emergency contact information is identified throught the Contact attribute ContactType with the "Emergency" value. | alphanumeric | "Emergency" | |
PhoneContact / Number | Phone to emergency contact the passenger. | alphanumeric | any | |
Name / Surname | Surname of the emergency contact | alphabetic | any | Mandatory for schema if 'Name' tag is indicated. |
Name / Given | Name of the emergency contact | alphabetic | any | |
EmailContact / Address |
Email to contact the passenger. | alphanumeric |
any |
Mandatory if the current passenger has been marked as the main contact. |
PhoneContact / Number |
Phone to contact the passenger. | alphanumeric | any | Mandatory if the current passenger has been marked as the main contact. |
Remarks / Remark | Relationship emergency contact of passenger | alphanumeric | any | Mandatory for schema if 'Remarks' tag is indicated. |
Gender | Gender of the passenger (Mandatory for infant passengers in secure flights) | alphabetic |
|
NDC Mandatory for Secure Flights |
FQTVs / TravelerFQTV_Information / AirlineID | Airline for the frequent flyer | alphabetic | Any | Manndatory for schmea if "FQTVs" tag is indicated |
FQTVs / TravelerFQTV_Information / Account / Number | Number for the frequent flyer | Numeric | Any | Manndatory for schmea if "FQTVs" tag is indicated |
Passenger / PassengerIDInfo / FOID / Type | Type of the passenger ID Info | 2 alpha |
|
Mandatory for schema if 'FOID' tag is indicated. |
Passenger / PassengerIDInfo / FOID / ID |
ID of the passenger.
|
alphanumeric | any | Mandatory for schema if 'FOID' tag is indicated. |
Passenger / PassengerIDInfo / PassengerDocument / Type |
Type of document
|
2 alpha |
|
Mandatory for schema if 'PassengerDocument' tag is indicated. NDC Mandatory for Special Discounts Orders (Residente & large Family) NDC Mandatory for POS PE & EC (FiscalId) |
Passenger / PassengerIDInfo / PassengerDocument / ID |
If Type of document is:
example "RUC/12345678X/BIG COMPANY" This fiscal information will be included on the tickets as required by local laws. |
alphanumeric |
|
Mandatory for schema if 'PassengerDocument' tag is indicated. NDC Mandatory for Special Discounts Orders (Residente & large Family) NDC Mandatory for POS PE & EC (FiscalId) |
Passenger / PassengerIDInfo / PassengerDocument / ApplicabilityLocation |
Municipality of residence / Community code for large family | alphanumeric | ApplicabilityLocationCodes - Resident & Large Family Discounts | NDC Mandatory for Special Discounts Orders (Residente & large Family) |
AdditionalRoles Attribute PrimaryContactInd |
Use to flag the current passenger as the primary contact. If none is marked the first passenger who provides contact information is considered the primary contact. When a passenger is explicitly marked as the primary contact, its contact information is required |
true |
Activated PrimaryContactInd attributed. <AdditionalRoles PrimaryContactInd="true"/> |
|
< Query / Order Items / ShoppingResponse> | Schema | |||
Owner | Owner of the offer | 2 alpha | IB | Schema |
Response ID | Response ID | alphanumeric | any | Schema |
Offers / Offer / OfferID | Offer ID with mandatory attribute Owner | alphanumeric | any | Schema |
Offers / Offer / OfferItems / OfferItem / OfferItemID | Offer Item ID of the Offer ID with mandatory attribute Owner | alphanumeric | any | Schema |
< Query / Order Items / ShoppingResponse / Offers / Offer / OfferItems / OfferItem> | Schema | |||
Passengers / PassengerReference | Passeger reference of the Offer Item | alphanumeric | any | Mandatory for schema if 'Passengers' tag is indicated. |
AssociatedServices / AssociatedService | Associated service, can be baggage, seat o special need | alphanumeric | any | Mandatory for schema if 'AssociatedServices' tag is indicated. |
AssociatedServices / AssociatedService / Service ID | Service ID | alphanumeric | any | |
AssociatedServices / AssociatedService / Passengers / PassengerReference | Passenger reference of the associated service | alphanumeric | any | Mandatory for schema if 'Passengers' tag is indicated. |
<Query / Payments / Payment > | Mandatory for schema if 'Payments' tag is indicated. | |||
Method | Payment Method, can be Cash payment, Card payment or Other payment (for service fee). | alphabetic |
|
Mandatory for schema if 'Payments' tag is indicated. |
-- This refers to Credit Card method -- | ||||
Method / PaymentCard / CardType |
Type of credit card
|
alphanumeric | 1-6 characters | |
Method / PaymentCard / CardNumber | Number of credit card | numeric |
1-19 characters
|
|
Method / PaymentCard / SeriesCode | Series Code of credit card | numeric | 1-8 characters | |
Method / PaymentCard / CardHolderName | Card Holder Name | alphanumeric | 0-50 characters | |
Method / PaymentCard / CardHolderBillingAddress / Street |
Street of the billing address of the cardholder
|
alphanumeric | 1-40 characters | |
Method / PaymentCard / CardHolderBillingAddress / CityName | City of the Billing Address of cardholder | alphanumeric | 1-24 characters | |
Method / PaymentCard / CardHolderBillingAddress / StateProv | State Prov. of the Billing Address of cardholder | alphanumeric | 1-40 characters | |
Method / PaymentCard / CardHolderBillingAddress / PostalCode | Postal Code of the Billing Address of cardholder | alphanumeric | 2-10 characters | |
Method / PaymentCard / CardHolderBillingAddress / CountryCode | Country Code of the Billing Address of cardholder | alphabetic | 2 characters | |
Method / PaymentCard / EffectiveExpireDate / Expiration | Effective expiration date of the credit card | numeric | 2 characters | |
---- | ||||
Amount | Total amount of the offer | numeric | any | Mandatory for schema if 'Payments' tag is indicated. |
Payer / Name / Surname | Payer's surname | alphabetic | 2-25 characters | Mandatory for schema if 'Payments' tag is indicated. |
Payer / Name / Given | Payer´s Given name | alphabetic | 2-45 characters | |
Payer / Name / Title | Payer´s title | alphabetic | any | |
Contacts / Contact / PhoneContact / Number | telephone number | numeric |
20 characters maximum |
|
Contacts / Contact / EmailContact / Address | Email adress | alphanumeric |
correct email format
|
Mandatory for schema if 'EmailContact' tag is indicated. |
< Query / Datalist > | ||||
< Query / Datalist / ServiceList> | ||||
Service | Service with mandatory ObjectKey | alphabetic | any | |
Service / ServiceID | Service ID with mandatory owner | alphanumeric | any | Mandatory for schema if 'Service' tag is indicated. |
Service / Name | Service's name | alphanumeric | any | Mandatory for schema if 'Service' tag is indicated. |
Service / Descriptions / Description / Text | Information text of the special need (Limited to a maximum of 90 characters). | alphanumeric | any (Limited to a maximum of 90 characters). | |
Service / BookingInstructions / SSRCode | SSR code | alphabetic | DisabilityAssistance | |
< Query / Datalist / SeatList> | ||||
Seats | Seat ID with mandatory ListKey | alphanumeric | any | Mandatory for schema if 'SeatList' tag is indicated. |
Seats / Location / Column | Number of column | character | A,B,C... | |
Seats / Location / Row / Number | Number of row | numerical | ....flight size | |
<Query / Metadata> | ||||
Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata / MetadataKey Attribute MetadataKey |
Type of Currency | alphanumeric | any available currency | Mandatory for schema if 'CurrencyMetadata' tag is indicated. |
Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata / Decimals | Decimals of Currency | numeric | any | |
<Query / BookingReferences> | ||||
BookingReference / ID | External reference ID | character | XRef | Mandatory for Sender External Reference |
BookingReference / OtherID | Sender's external reference | alphanumeric | any (strings exceeding 30 chars will be truncated) | Mandatory for Sender External Reference |
BookingReference / OtherID Attribute Name |
This attribute must contain the senders IATA Number and will be matched against the Senders IATANumber from TravelAgencySender | numeric | 7/8 numbers | Mandatory for Sender External Reference |
Response Body
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".
HTTP STATUS CODE |
EXAMPLE MESSAGE ERROR |
REASON |
911 | Booking error: selected flight/cabin is not available | Not available |
486 | Additional services only available with instant purchase | Order create with baggage and without payment |
466 | Form of payment missing or invalid for ticket/document | Order create without timelimit and without payment |
795 | Passenger titles are required | Secure flight without passenger's title |
795 | Passenger genders are required | Secure flight without passenger's gender |
795 | Passenger dates of birth are required | Secure flight without passenger's date of birth |
Warning | There's a mismatch between payment amount and total offer prices. | Mismatch between payment amount and total offer prices. |
399 | Duplicate Name | Order created with duplicate passenger names. |
486 | Required dni or resident certificate number | Resident discount eithout DNI or certificate number |
911 | A minor exceeds the allowed age.Please check dates of birth. | Erroneus date of birth |
144 | Invalid Requestor Identification | Invalidad agency |
486 | We remind you that you must present your credit card at the check-in desk for verification. | PMT Error |
486 | Street of Address Payer must have between 1 and 40 characters | Incorrect format of street in payment section |
486 | City of Address Payer must have between 1 and 24 characters | Incorrect format of city in payment section |
486 | State prov of Address Payer must have between 1 and 40 characters | Incorrect format of state prov in payment section |
486 | Postal code of Address Payer must have between 2 and 10 characters | Incorrect format of postal code in payment section |
486 | Name of payer must have betweeen 2 and 45 characters | Incorrect format of payer name in payment section |
486 | Phone number of payer not match the expected pattern | Incorrect format of phone number in payment section |
486 | Phone number must have less than 20 characters | Incorrect format of phone number in payment section |
486 | Email of payer not match the expected pattern | Incorrect format of email in payment section |
486 | Surname of payer must have betweeen 2 and 25 | Incorrect format of surname in payment section |
486 | Country code of Address Payer must have 2 characters | Incorrect format of country code in payment section |
75F | Fare expired for reservation. | When the offer to be booked has been expired. |