OrderCreate

Our latest version 17.2: OrderCreate v17.2

v16.2 - R2.62 - R2019.20

Functional Description

The OrderCreate service generates a booking for the supplied itinerary and passenger details, returning an OrderID.

Subject to the conditions of the Offer a time limit may be proffered or instant purchase may be required.

The payment methods available today are Credit Card payment (for Non-IATA entities) and Cash (for IATA Travel Agents).

Actually, in an order generation could be up to 16 flight segments, which corresponds to 4 tickets associated.

Although the Order Create service is stateless it is assumed that in most cases it will be called as part of a specific sequence such as:

  • AirShopping
  • FlightPrice (Direct or through a previous Air Shopping)
    • SeatAvailability (if Seat selection is required)
    • BaggageList (if pre-purchased excess baggage is required)
  • OrderCreate
Functionality Use Examples Complete Flows(All RQ/RS)
Basic The reservation can be made with or without payment. If you do not have payment, the reservation will have a TimeLimit.
  • OrderCreate - One Way.zip
  • OrderCreate - Round Trip.zip
  • OrderCreate - 1 Adult 1 Child 1 Infant.zip
  • OrderCreate - 7ADT - MultiCity - 5 Airports.zip
  • Download examples
Payments Methods

These reservations can be made with this payment methods:

  • Cash
  • Credit Card

Also, we can create an order without payment. To issue the tickets and EMDs, we need to call AirDocIssue service to pay the order we created without payment.

 

  • OrderCreate - Cash.zip
  • OrderCreate - Credit Card .zip
  • OrderCreate - No Payment.zip
  • Download examples
Private Fare It will give the possibility to obtain orders with  private fares. To obtain this behaviour, the request must provide a fare preference type with the 758 code (private fares one) and the suitable product code to be applied.
  • OrderCreate - Private Fare.zip
  • OrderCreate - 1ADT - Resident and Family Discount - Private Fare.zip
  • Download examples
Resident Discount

Unique to the Spanish market, you are able to create orders with Resident Discount, also combineable with the Large Family Discount. It is implemented for Canary Islands, Balearic Islands and Melilla and only with POINT OF SALE SPAIN.To obtain the discount, the flight has to have an Origin/Destination airport included in this modality.

The types of residents are:

  • RC (Residente Canarias)
  • BP (Residente Baleares)
  • RM (Residente Melilla)
  • BI (Para en interior de Baleares)
  • DC (Para el interior de Canarias)

There are some restrictions in resident discount

  • All the resident discount must been selling in spain market.
  • Can't be two types of resident discount in the same reserve.
  • The routes of the trip must have the departure or arrival in once of the cities of the resident discount.
  • Passenger document type, if it is informed must be DNI or NIE.
  • OrderCreate - Balearic Resident.zip
  • OrderCreate - Canary Resident.zip
  • OrderCreate - Melilla Resident.zip
  • OrderCreate - Cash - Resident & LF - Service Fee.zip
  • Download examples
Large Family

Also unique to the Spanish market, you are able to create orders with Large Family Discount, combineable with the Resident Discount. Only applicable to Spanish domestic flights and with POINT OF SALE SPAIN.

The types of residents are:

  • F1 (General Discount - 3 children)
  • F2 (Special Discount - More than 3 children)

There are some restrictions in large family discount

  • All the large familydiscount must been selling in Spain market.
  • Can't be two types of large familydiscount in the same reserve.
  • Passenger document type, if it is informed must be DNI or NIE.
  • OrderCreate - Large Family F1 Type.zip
  • OrderCreate - Large Family F2 Type.zip
  • OrderCreate - Cash - Resident & LF - Service Fee.zip
  • Download examples
Seats And Bags

Seats can be booked at the same time as the flights.

Up to 9 additional bags, per adult or child, can be purchased at the same time as the flights.

Both seats and bags can also be added as part of the servicing flow.

  • OrderCreate - 1ADT - RT (Indirect Flight) - EUR - 2 Baggage each Slice and Seat.zip
  • OrderCreate - Add a baggage.zip
  • OrderCreate - Add a seat.zip
  • OrderCreate - 1ADT 1CHD 1INF - With Baggage and Seat for each one.zip
  • Download examples
Special Needs

The ability to request special services is implemented for:

  • BLND (Blind)
  • DEAF (Deaf Passenger)
  • DPNA (Disabled Passenger)
  • ESAN (Emotional Support Animal)
  • SVAN (Service Animal)
  • WCHR (Wheelchair for Ramp)
  • WCHS (Wheelchair for Steps)
  • OrderCreate - 1ADT - DISA with BLND and SVAN.zip
  • OrderCreate - 1ADT - DISA with DEAF and SVAN.zip
  • OrderCreate - 1ADT - DISA with DPNA and ESAN.zip
  • Download examples
Agency Contact / Passenger Emergency Contact

It will give you the possibility to accept telephone numbers of less than 9 characters with the country code separately. It is implemented to:

  • Several passengers with / without country code.

  • Several passengers with emergency contact with / without country code.

  • Agency contact with / without country code.

  • Payer data with / without country code.

  • Order Create - PhoneContact.zip
  • OrderCreate - RT - Cash - Agency Contact & Passengers Emergency Contact.zip
  • Dowload examples
Remarks - External Reference

It will give the possibility to include an External Reference in the system for future correlation. This reference will be saved in database and showed in OrderViewRS from OrderCreate, OrderRetrieve and OrderChange services.

The max length for this reference is 30 characters. If the limit is exceeded, the reference will be saved only with 30 characters.

If this reference is not saved in database, OrderViewRS from OrderCreate will show an Warning message with the following text: "The Reserve Reference has not been registered in NDC". This message will be not appears in OrderViewRS from OrderRetrieve and OrderChange services.

  • OrderCreate - Remark - Less than 30 characters.zip
  • OrderCreate - Remark - More than 30 characters.zip
  • OrderCreate - Remark - Many Remarks.zip
  • OrderCreate - Remark - Incorrect IATA code.zip
  • OrderCreate - Remark - Without ID XRef.zip
  • Dowload examples
Frequent Flyer

Iberia Frequent Flyer information can be included in the OrderCreate for all passengers (except infants) and will be validated.

If we are unable to validate the Iberia Frequent Flyer number and name then the Order will be created and the OrderView will be returned with a warning.

 

If incorrect Frequent Flyer information is sent (i.e. other airline code, without numbers, etc) then an error will be returned and no Order created.

  • OrderCreate - FrecuentFlyer - Error INF passenger.zip
  • OrderCreate - FrecuentFlyer - FQTV para 3ADT y 3CHD.zip
  • OrderCreate - FrecuentFlyer - Validaciones de campos.zip
  • OrderCreate - Cash - 1 ADT - FF Not Validated.zip
  • Dowload examples
(Fiscal ID)

The possibility to include Fiscal ID associated to passengers. This information is mandatory for Orders to be paid and issued in Ecuador & Perú.

Legend

(plus) 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

List of countries

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

  • Online (Default)
  • Offline
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
  • BUSINESS
  • MOBILE

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
  • Business
  • Mobile

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:

  • ADULT_01
  • ADULT_02
  • CHIILD_01
  • INFANT_01

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

  • JR
  • SR

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
  • MR
  • MRS
  • MS
  • MSS
  • MISS
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
  • Male
  • Female
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
  • PP (Not valid for resident/large family discounts)
  • NI (DNI or NIE)
Mandatory for schema if 'FOID' tag is indicated.
Passenger / PassengerIDInfo / FOID / ID

ID of the passenger.

  • Two different passengers can only introduce the same document identification if market is different from ES.
  • Mandatory for resident adults flights unless they are between 12 and 14 years.
alphanumeric any Mandatory for schema if 'FOID' tag is indicated.
Passenger / PassengerIDInfo / PassengerDocument / Type 

Type of document

  • For Fiscal ID it is not necessary for infants since they inherit the one from the associated adult. Anything sent will be ignored.
2 alpha
  • F1 (Resident Discount)
  • AI (Additional information, Large Family Discount)
  • F (FiscalId)

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:

  • F1 - then this will be the Residence certificate number 
  • AI - then this will be the Large Family certificate number
  • F - then this should be the relevant fiscal information for the country. In the case of Ecuador and Peru this should be constructed using the following two or three elements separated by obliques "/":
    • Document type
    • Document number/id
    • Company name (optional)

example "RUC/12345678X/BIG COMPANY"

This fiscal information will be included on the tickets as required by local laws.

alphanumeric
  • 12 fields maximum for residence document only if DNI/NIE is not informed.
  • 20 fields maximum for large family document
  • 80 fields maximum for FiscalId

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
  • Credit Card
  • Cash
  • Other: Added in 2.16. The Service Fee associated to Resident and Large Family booking must be provided as a special payment method. To identify this situation the payment method is of Other type with a Remarks with the ServiceFee value.
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

1.3 Response Body

OrderView RS

1.4 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.