getAirlines
The method will allow you to receive the list of airlines hosted by AeroCRS.
The method will response with a list of airlines, including country and additional information.
companyname
String
Company name
companycode
String
Airline designator, used in getSchedule, getDestinations
companyiatacode
String
IATA code (if exists)
country
String
Country name
logourl
String
Logo URL
mandatorynationality
Boolean
Is the passenger nationailty mandatory in the process of confirmBooking
mandatorydocumentnumber
Boolean
Is the passenger document type and number mandatory in the process of confirmBooking
mandatorydocumentexpiry
Boolean
Is the passenger document expiry mandatory in the process of confirmBooking
mandatorydocumentissueingcountry
Boolean
Is the passenger document issuing country mandatory in the process of confirmBooking
mandatoryplaceofbirth
Boolean
Is the passenger place of birth mandatory in the process of confirmBooking
mandatorydateofbirth
Boolean
Is the passenger date of birth mandatory in the process of confirmBooking
mandatorydateofbirthforchild
Boolean
Is the date of birth for child mandatory in the process of confirmBooking
onlinecheckinavailable
Boolean
Does the airline offers online check-in
airlineacceptsapicreditcardpayments
Boolean
Does the airlines enables acceptance of credit cards via the API using makePayment
getTicketTerms
The request will give you a list of all airlines ticket terms
The method will response with all the ticket terms in English.
airlineid
Number
Airline number in AeroCRS
ticketterms
URL
URL for full ticket terms in airline's website (where exists)
name
String
The name of the airline
ticketTerms
String
Ticket terms
The ticket terms are formatted in HTML
getDestinations
The method will allow you to receive the list of destinations served by AeroCRS airlines.
The method will response with a list of destinations, including country and additional information.
name
String
Destination name
iatacode
String
IATA code (if exists)
icaocode
String
ICAO code (if exists)
country
String
Country name
dstid
Numeric
Destination ID
Important
The list might update from time to time and is not related to a specific airline, although might change occasionally due to added/removed destinations.
getSchedule
This method will give you a list of served routes by airline
fltsFROMperiod
Date
YYYY/MM/DD start period of the required data
fltsTOperiod
Date
YYYY/MM/DD end period of the required data
codeformat
String
IATA / ICAO / INTERNAL / AIRLINE – output of codes
IATA - the system will generate the output only for routes with IATA codes, and the output codes will be IATA
ICAO - the system will generate the output only for routes with ICAO codes, and the output codes will be ICAO
INTERNAL - The system will generate the output with internal assigned codes for non IATA destinations, note that AeroCRS internal codes can conflict with real IATA destinations, the rest of the destinations will be in IATA codes.
AIRLINE - The system will output the destinations in the airline defined codes
companycode
String*
Company short code (as supplied to you by the team) - Adding this element will narrow the search of the data for the specific airline.
soldonline
Boolean
true / false - when set to true will show only flights which are sold online.
ssim
Boolean
1 - when the response should be in an SSIM format, 0 - string SSIM format (for non SSIM results do not send this prameter)
The method will response with the airlines hosted inventory information.
fltnumber
String
Flight number
airlinename
String
Airline name
airlineid
Number
Number of airline ID
fromdestination
String
Destination FROM code
todestination
String
Destination TO code
std
String
HH:MM departure time
sta
String
HH:MM arrival time
weekdaysun
Boolean
Sunday operating (true/false)
weekdaymon
Boolean
Monday operating (true/false)
weekdaytue
Boolean
Tuesday operating (true/false)
weekdaywed
Boolean
Wednesday operating (true/false)
weekdaythu
Boolean
Thursday operating (true/false)
weekdayfri
Boolean
Friday operating (true/false)
weekdaysat
Boolean
Saturday operating (true/false)
accode
String
Aircraft code (might not appear to all airlines)
fltsfromperiod
String
Start period of the flight active
fltstoperiod
Number
End period of the flight active
* Mandatory parameters
Cached information
Please note, due to the face that the information from the airlines does not change on an hourly basis, you can pull a cached version of the information from the following links:
NOTE - The information is updated daily up to 00:30 GMT.
getAvailability
This method returns availability of the different classes according to flight number or destination combination
fltnum
String
(optional)
Flight number to search
from
String
(optional)
destination of departure
to
String
(optional)
destination of arrival
start
Date
YYYY/MM/DD beginning of date range
end
Date
YYYY/MM/DD End of date range
The method will response with a list of available flights, class codes and their respected available seats.
count
Number
number of flights found
airlineDesignator
String
Airline Designator
airlinename
String
Airline name
fltnum
Number
Flight number
fromCode
String
Destination FROM code
toCode
String
Destination TO code
std
Date
YYYY/MM/DD HH:MM departure time
sta
Date
YYYY/MM/DD HH:MM arrival time
classes
Array
List of class codes and the quantity available for each one
flighttype
String
Type of Flight (Direct / Connection)
numberOfLegs
Number
Number of legs for this trip for connection flights
flights
Array
For connection flights - array of flights on the trip
Connection Parameters
airlineName
String
Name of airline
fltnum
String
Flight number
fromcode
String
Departure airport code
tocode
String
Arrival airport code
STD
String
YYYY/MM/DD HH:MM departure time
STA
String
YYYY/MM/DD HH:MM arrival time
legNumber
Number
Leg number for the trip
Activation
This method will be available starting August 1st, 2018.
getFares
This method will return the current fares for the selected route and date
start
Date
Begging of date range
end
Date
End of date range
from
String
(Optional) - Departure destination code
to
String
(Optional) - Arrival destinaion code
chargetype
String
(Optional)
The iataCode chargetype
currency
String
(optional)
The currency short code. This will force prices to be in this requested currency
The method will response with a list of fares sellable as on the time of the request.
count
Number
number of fares found
airlineDesginator
String
Airline Designator
airlinename
String
Airline name
fromCode
String
Destination FROM code
toCode
String
Destination TO code
fromDate
String
Fare flight date range start
toDate
String
Fare flight date range end
classes
Array
List of class codes and the quantity available for each one
adultFareRT
Money
Fare for Adult (Round trip)
childFareRT
Money
Fare for Child (Round trip)
infantFareRT
Money
Fare for Infant (Round trip)
tax1RT
Money
Tax (Round trip)
tax2RT
Money
Tax (Round trip)
tax3RT
Money
Tax (Round trip)
tax4RT
Money
Tax (Round trip)
adultFareOW
Money
Fare for Adult (One Way)
childFareOW
Money
Fare for Child (One Way)
infantFareOW
Money
Fare for Infant (One Way)
tax1OW
Money
Tax (One Way)
tax2OW
Money
Tax (One Way)
tax3OW
Money
Tax (One Way)
tax4OW
Money
Tax (One Way)
Activation
This method will be available starting August 1st, 2018.
getFlights
The method will allow you to get a list of flights over all the airlines which host their inventory on AeroCRS.
triptype
String*
Type of request:
OW: One-way
RT: Return
flightdate1
Date*
YYYY/MM/DD date of the departure flight
flightdate2
Date
YYYY/MM/DD date of the return flight (if requested)
adults
Numeric*
Number of adults
child
Numeric*
Number of children
infant
Numeric
Number of infants
currency
String
Currency Code ('USD' for example)
chargetype
String
The iataCode chargetype
The method will reply with the available flights on AeroCRS, note that some of the flights might not be "bookable" according to your agreement type.
airline
String
Name of the airline
airlineid
Number
ID of airline in AeroCRS systems
airlinelogo
Link
Country name
childagefrom
Number
Applicable chid start age according to airline rules
childageto
Number
Applicable chid start end (inclusive) according to airline rules
chargetaxoninfant
Boolean
Airline charge tax on infant
from
String
Name of destination of departure
to
String
Name of destination of arrival
fromcode
String
Code of destination of departure
tocode
String
Code of destination of arrival
direction
String
Direction of the flight (outbound/inbound)
flightdate
Date
YYYY/MM/DD date of the flight
depart
Time
HH:MM 24hours time of departure
arrive
Time
HH:MM 24hours time of arrival
number
String
Flight number
bookable
Boolean
Is the flight bookable with this username and password via the API
via
String
Text if the flight is VIA or connecting at a specific location.
totalminutes
Number
The number of minutes of the flight.
linktowebsite
Link
The "deeplink" to the website itinerary page, you can redirect the customer to this page for continuation of his booking on the airline IBE
CompanyWebDiscount
Number
Percentage of discount from RACK FARE below if booked on the website.
rule
String
Free text of flight specific rule
flightcode
Number
Flight internal code
classes
Element
Each class of a flight will be represented in a
class element, all classes per flight are represented within classes element
class
Element
Include all the class details
attributes
Element
attribute within class, include flightcode parameter
flightcode
String
Flight internal code (within class element)
classcode
String
Class code
classname
String
Class name
cabinclass
String
Cabin Class
rackfare_adult
Money
Rack fare for adult (per passenger)
rackfare_child
Money
Rack fare for child (per passenger)
rackfare_infant
Money
Rack fare for infant (per passenger)
agtfare_adult
Money
Agent’s fare for adult (per passenger)
agtfare_child
Money
Agent’s fare for child (per passenger)
agtfare_infant
Money
Agent's fare for infant (per passenger)
tax
Money
Tax for adult / child (per passenger)
rackfare_adult_no_vat
Money
Rack fare for adult without VAT (per passenger)
rackfare_child_no_vat
Money
Rack fare for child without VAT (per passenger)
rackfare_infant_no_vat
Money
Rack fare for infant without VAT (per passenger)
agtfare_adult_no_vat
Money
Agent’s fare for adult without VAT (per passenger)
agtfare_child_no_vat
Money
Agent’s fare for child without VAT(per passenger)
agtfare_infant_no_vat
Money
Agent's fare for infant without VAT(per passenger)
tax_no_vat
Money
Tax for adult / child without VAT (per passenger)
vat_on_fare
Number
VAT percentage on fare
vat_on_tax
Number
VAT percentage on TAX
currency
String
The currency used in the fare (ISO-4217)
converttousd
Number
The conversion to USD from the local currency of displayed fare.
ttl
Date
Ticketing time limit in GMT time zone YYYY/MM/DD HH:MM
baggage
String
Baggage string number and mass unit
classshowonweb
Boolean
Is the class show on web
CompanyAllowDifClass
Boolean
If the airline allows booking of two different classes for a RT booking
Important
Flight information will be based on the number of passengers and availability to book, you will not receive flight information which does not match your query.
* Mandatory parameters
getFlight
The method will allow you to validate selling information about a specific flight
Use this method after retrieving the information from getDestinations, you should enter additional information on dates, number of passengers etc.
The method will reply with the available flights on AeroCRS, note that some of the flights might not be "bookable" according to your agreement type.
request
String*
getFlight (method name)
id
String*
Identification token
password
String*
Password
triptype
String*
Type of request:
OW: One-way
RT: Return
adults
Numeric*
Number of adults
child
Numeric*
Number of children
infant
Numeric
Number of infants
flightid1
Numeric*
The flightid of the departure flight
flightid2
Numeric
The flightid of the return flight (if requested)
currency
String
Currency Code ('USD' for example)
chargetype
String
The iataCode chargetype
flights
Element
The following elements are within <flight> which represents a flight within <flights>
flight
Element
The following parameters are within flight
airline
String
Name of the airline
airlineid
Number
ID of airline in AeroCRS systems
airlinelogo
Link
Country name
childagefrom
Number
Applicable chid agt start according to airline rules
childageto
Number
Applicable chid age end (inclusive) according to airline rules
chargetaxoninfant
Boolean
Should you charge tax on infant
from
String
Name of destination of departure
to
String
Name of destination of arrival
via
String
Text if the flight is VIA or connecting at a specific location.
fromcode
String
Code of destination of departure
tocode
String
Code of destination of arrival
direction
String
Direction of the flight (outbound/inbound)
flightdate
Date
YYYY/MM/DD date of the flight
depart
Time
HH:MM 24hours time of departure
arrive
Time
HH:MM 24hours time of arrival
number
String
Flight number
bookable
Boolean
Is the flight bookable with this username and password via the API
via
String
Text if the flight is VIA or connecting at a specific location.
totalminutes
Number
The number of minutes of the flight.
flightcode
Number
Flight internal code
linktowebsite
Element
an element within 'flight' which can be built to redirect to the airline website, each element besides the 'url' should be put in GET in the URL line.
url
Link
The link to the airline website
DepartureDateVal
Date
The date in YYYY/MM/DD format
TripType
String
Trip type for the website
FromDSTid
Number
From Destination ID
ToDSTid
Number
To Destination ID
ReturnDateVal
Link
The date in YYYY/MM/DD format
invAdlt
Number
Number of adults flying
invKids
Link
Number of children flying
CompanyWebDiscount
Number
Percentage of discount from RACK FARE below if booked on the website.
Rules
Element
Each rule of a flight will be represented in a <rule>element, all rules per flight are represented within<Rules> element
rule
String
Free text of flight specific rule
Classes
Element
Each class of a flight will be represented in a <class>element, all classes per flight are represented within<Classes> element
classcode
String
Class code
classname
String
Class name
cabinclass
String
Cabin Class
flightid
Number
Flight ID to be used in API for createBooking
rackfare_adult
Money
Rack fare for adult (per passenger)
rackfare_child
Money
Rack fare for child (per passenger)
rackfare_infant
Money
Rack fare for infant (per passenger)
agtfare_adult
Money
Agent’s fare for adult (per passenger)
agtfare_child
Money
Agent’s fare for child (per passenger)
agtfare_infant
Money
Agent's fare for infant (per passenger)
tax
Money
Tax for adult / child (per passenger)
rackfare_adult_no_vat
Money (4 decimals)
Rack fare for adult without VAT (per passenger)
rackfare_child_no_vat
Money (4 decimals)
Rack fare for child without VAT (per passenger)
rackfare_infant_no_vat
Money (4 decimals)
Rack fare for infant without VAT (per passenger)
agtfare_adult_no_vat
Money (4 decimals)
Agent’s fare for adult without VAT (per passenger)
agtfare_child_no_vat
Money (4 decimals)
Agent’s fare for child without VAT(per passenger)
agtfare_infant_no_vat
Money (4 decimals)
Agent's fare for infant without VAT(per passenger)
tax_no_vat
Money (4 decimals)
Tax for adult / child without VAT (per passenger)
vat_on_fare
Number (4 decimals)
VAT percentage on fare
vat_on_tax
Number (4 decimals)
VAT percentage on TAX
currency
String
The currency used in the fare (ISO-4217)
ttl
Date
Ticketing time limit in GMT time zone YYYY/MM/DD HH:MM
baggage
String
Baggage string number and mass unit
classshowonweb
Boolean
If class is show on website.(true/false)
Important
Flight information will be based on number of passengers and availability to book, you will not receive flight information which does not match your query.
* Mandatory parameters
createBooking
This method will create a booking according to one or more flight id.
triptype
String*
Type of request:
OW: One-way
RT: Return
adults
Number*
Number of adults
child
Number*
Number of children
infant
Number
Number of infants (not mandatory)
bookflight
Element*
Include the flight details
fromcode
String*
Origin code from getDestinations
tocode
String*
Destination code from getDestinations
flightid
Number*
flightid received from getFlights
currency
String (Optional)
Requested currency ISO (Example - USD)
chargetype
String*
The iataCode chargetype
The method will response with all the details and a booking ID which you can use in other methods in AeroCRS API.
booking
Element
The booking information, Holds items element
items
Element
Holds several other elements e.g. flight, hotel etc.
flight
Element
Holds the following elements:
airline
String
Name of airline
airlineid
Number
ID of airline in AeroCRS systems
from
String
Name of destination of departure
to
String
Name of destination of arrival
flightdate
Date
YYYY/MM/DD date of the flight
depart
Time
HH:MM 24hours time of departure
arrive
Time
HH:MM 24hours time of arrival
number
String
Flight number
class
String
Class code
invid
Number
ID of booked flight (internal use)
invpricing
Money
Total charged in the currency for the flight
Adultfare
Money
Adult RACK fare (per 1 adult)
Childfare
Money
Child RACK fare (per 1 child)
Infantfare
Money
Infant RACK fare (per 1 infant)
tax
Money
Total TAX
net_fare
Money
Total NET fare (charged)
rack_fare
Money
Total rack fare
totaltax
Money
Total TAX for flight
currency
String
The currency used in the fare (ISO-4217)
converttousd
Number
The conversion rate to USD as defined by the airline.
terms
String
Related terms of the fare / booking class.
adults
Number
Number of adults booked
child
Number
Number of children booked
infant
Number
Number of infants booked
totalprice
Money
Total amount for all booking
bookingid
Number
Booking ID to be used in the confirmBooking API
pnrref
String
PNR Reference (Record locator) to show customer
pnrptl
Date
Payment time limit in GMT time zone YYYY/MM/DD HH:MM
pnrttl
Date
Ticketing time limit in GMT time zone YYYY/MM/DD HH:MM
infaspax
Boolean
In case the airline defined infant as passenger
Important
Creating a booking must be actioned on one airline each time, if you wish to book from 2 different airlines, you will need to run createBooking separtly for each airline.
* Mandatory parameters
confirmBooking
This method will confirm a booking according to a booking id.
agentconfirmation
String*
Agent reference
remarks
String
Free text (not mandatory)
passenger
Element*
Include the passenger details to update
paxtitle
String*
Mr./Mrs./Miss./Child/INFANT
firstname
String*
First name of passenger
lastname
String*
Last name of passenger
paxage
Number
Age of passenger – Mandatory only for children
paxnationailty
String
Passenger nationality (ISO country code)
paxdoctype
String
Document type PP- Passport / ID-National ID
paxdocnumber
String
Document number
paxdocissuer
String
Document issuer (ISO country code)
paxdocexpiry
Date
Document expiry (YYYY/MM/DD)
paxbirthdate
Date
Passenger birth date (YYYY/MM/DD)
paxphone
String
Passenger phone
paxemail
Passenger e-mail
paxcarringinfant
Boolean
Passenger is caring an infant (1- true, 0- false) (mandatory in case booking has at least one infant)
confirmationemail
Confirmation e-mail will be sent to this e-mail, please fill valid e-mail (not mandatory)
bookingid
Number
Booking ID used
bookingconfirmation
String
Booking confirmation string
linktobooking
Link
The link to the booking in the airline website
pnrref
String
The PNR ref (record locator)
topay
Money
Amount left to pay
currency
String
Currency of payment
pnrptl
Date
Payment time limit in GMT time zone YYYY/MM/DD hh:mm
pnrttl
Date
Ticketing time limit in GMT time zone YYYY/MM/DD hh:mm
status
String
OK – PNR is OK and approved
* Mandatory parameters
makePayment
This method will allow you to pay a booking using a valid credit card number and details.
You should use it when you wan to pay a booking with the end-customer / agency credit card and when you do not have any deposit on your account.
The method will response with a confirmation / rejection reason, you should ticketBooking once done with this method.
bookingid
Number*
The bookingid you got from createBooking
creditcardpayer
String*
The credit card holder name and last name
creditcardnumber
Number*
The credit card number
creditcardexpiry
Number*
The credit card expiry in 4 digits MMYY
creditcardcvv
Number
The credit card CVV
currency
String (Optional)
Currency ISO format (Example - USD)
The method will response with a confirmation / rejection reason, you should ticketBooking once done with this method.
bookingid
Number
The booking ID
paymentstatus
String
The response:
OK - Confirmed
XX - Rejected
paymentstatusexplanation
String
Free text of explanation
Important
Not all of AeroCRS hosted airlines support this feature.
Critical
Calling the makePayment with a valid post, will charge the total summary of the booking on the system, there is no option to select the charge amount.
* Mandatory parameters
Testing
For testing use this credit card number: 5326445577889977
You can only test "northair" test company
createPayment
This method will allow you to enter a payment to the booking.
bookingconfirmation
String*
bookingconfirmation as accepted on confirmBooking or getBooking
paymentmethodtoken
String*
Token received from AeroCRS support.
amountpaid
Money*
Total amount paid
amountcurrency
String*
Currency as allowed by the company
paymentref
String
Payment reference number which will be shown to company and in receipt
The method will response whether the payment was successful and the receipt link if so.
paymentreceived
Money
Amount received by the system in the currency of the company
receiptnumber
Number
Receipt number
receiptlink
Link
Receipt link to print to the customer if needed
Important
You must get the Token for your payment method from the airline.
* Mandatory parameters
ticketBooking
The method will allow you to ticket a confirmed booking.
bookingid
Number*
bookingid taken from createBooking
bookingid
Number
Booking ID used
bookingconfirmation
String
Booking confirmation string
pnrref
String
The PNR ref (record locator)
ticketnumber
Number
Ticket number ID in AeroCRS system
invoicenumber
Number
Invoice number in airline
status
String
OK – PNR is OK and approved
* Mandatory parameters
getBooking
This method will give you the booking details according to the booking confirmation
bookingconfirmation
String*
as accepted from confirmBooking
OR
PNR ref
passengerlastname
String
Passenger last name – MANDATORY if you are giving the PNR ref., otherwise OPTIONAL
booking
Element
Include all the information regarding the booking
bookingid
Number
Booking ID used
bookingconfirmation
String
Booking confirmation string
linktobooking
Link
The link to the booking in the airline website
pnrref
String
The PNR ref (record locator)
ticketnumber
Number
Ticket number ID in AeroCRS system (if ticketed)
invoicenumber
Number
Invoice number in airline (if ticketed)
status
String
OK – PNR is OK and approvedPN – PNR is in PENDING status and will be kept for 24 hours for manual approving with the airline
flights
Element
Holds all flights information in the booking, each flight is represented by a flight element
flight
Element
Holds the flight information in the booking
airline
String
Airline name
airlinedesignator
String
Airline 2 letter code in IATA (if exists)
from
String
From destination name
fromcode
String
From destination code
to
String
To destination name
tocode
String
To destination code
class
String
Class code
flightdate
Date
YYYY/MM/DD date of flight
depart
Time
HH:MM time of departure
arrive
Time
HH:MM time of arrival
number
String
Flight number
invid
Number
ID of booked flight (used internal)
invpricing
Money
Total pricing in USD for the flight
passengers
Element
Holds all passenger elements
passenger
Element
Holds the passenger information in the booking
paxtitle
String
Passenger title
lastname
String
Passenger last name
firstname
String
Passenger first name
paxtype
String
Passenger type
remarks
Element
Each remark in the PNR will be represented in a <remarks>element
remark
Element
The Element will include a single text element
text
String
Remark text
vouchers
Element
Each voucher in the PNR will be represented in a <vouchers>element
voucher
Element
The Element include information regarding to the voucher
agentconfirmation
String
Agent reference as inserted in createBooking
vccreated
Date
YYYY/MM/DD date time of the system when creating the voucher
vctotal
Money
Pricing of voucher
Balanceinformation
Element
Balance DUE payment of this booking.
PNRtotal
Number
Total amount of the booking
PNRoutstandingpayment
Number
Balance DUE payment of this booking.
BalanceInCurrencies
Element
Balance DUE payment of this booking in currencies, the same nodes as balanceInformation
* Mandatory parameters
cancelBooking
The method will allow you to cancel a booking
bookingid
Number*
bookingid taken from createBooking
The API will response with the end result of the cancellation request.
bookingid
Number
Booking ID
status
String
Status:
OK – confirmed
XX – Cancelled
RQ – On Request
PN – Pending action
HN – Holding needs
pnrref
String
The PNR ref (record locator)
Important
There is an option that the booking will not be cancelled if it is already ticketed.
* Mandatory parameters
getDeepLink
The method will allow you to receive the list of destinations served by AeroCRS airlines.
The method will response with a list of destinations, including country and additional information.
count
Number
Number of results
fltid
Number / Array
Flight ID. Array for connection flights
airlineDesginator
String
Airline Designator
airlineName
String
Airline name
fltnum
String
Flight number
fromcode
String
Destination FROM code
tocode
String
Destination TO code
via
String
If this flight is via another destination. (Not a connection flight)
STD
String
YYYY/MM/DD HH:MM departure time
STDinUTC
String
YYYY/MM/DD HH:MM departure time in UTC
STA
String
YYYY/MM/DD HH:MM arrival time
STAinUTC
String
YYYY/MM/DD HH:MM arrival time in UTC
airlineLogo
Link
Link to the airline logo
CompanyChildAgeStart
Number
Applicable child start age according to airline rules
CompanyChildAgeEnd
Number
Applicable chid start end (inclusive) according to airline rules
companyINFchargeTAX
Boolean
Airline charge tax on infant
deeplink
Link
The "deeplink" to the website itinerary page, you can redirect the customer to this page for continuation of his booking on the airline IBE
direction
String
Direction of the flight (outbound/inbound)
classes
Array
Array of class codes and their details
freeseats
Number
Number of free seats for this class
currency
String
The currency used in the fare
chargeType
String
Charge type (e.g citizen, foreigner)
chargeTypeCode
String
IATA code for charge type
baggageAllowance
Number
Baggage weight allowed on the flight
baggageUnit
String
Weight unit (e.g Kg)
fare
Element
Details about the fare related to this class
rackFare
Element
Details about the rack fare
adultFare
Money
Fare for adult
childFare
Money
Fare for child
infantFare
Money
Fare for infant
tax
Money
Tax rate
websiteDiscount
Money
Discount for web bookings. If you are redirecting to company's website, you should multiply this number to the fare
flighttype
text
Trip type(Direct / Connection)
numberOfLegs
number
Number of legs for connection trip
flights
array
Will appear on connections
services
array
Available options by the airline for this fare: Baggage on flight, etc.
classCode
string
Class code
className
string
Class name
minimumPassengersForBooking
number
Minimum passengers required for this flight
Connection flight structure
airlineName
String
Name of the airline
fltnum
String
Flight Number
fromcode
String
Departure destination code
tocode
String
Arrival destination code
STD
String
YYYY/MM/DD HH:MM departure time
STA
String
YYYY/MM/DD HH:MM arrival time
airlineLogo
text
Link to airline logo
legNumber
number
Leg number in flight
More understanding of chargetype usage can be found here: https://docs.aerocrs.com/v4.0/reference#available-charge-types
* Mandatory parameters
getFareRules
Rules for flight and or class
fromcode
String
Departure airport code. All flights needs to depart from the same airport
tocode
String
Departure airport code. All flights needs to depart from the same airport
flights
Element
An array of flights
flightid
int
The flightid from getDeepLink response
flightid
int
Flightid from getDeepLink
*Mandatory
All of the request parameters are mandatory
Flights
Element
Holds all the responses and rules
flightid
int
Same as the requested parameter
rules
Element
Holds all the rules applicable for this flight
type
String
Specifies if this is a destination notification, fare notification or flight notification
text
String
The rule
Response explaination
If you will not get any response, it means there are no rules applicable for this flight
getPassengersByFlight
This method will give you a list of passengers according to a flight number and date
shownonticketed
Boolean
true/false (lowercase), will show the non ticketed bookings if set to true
flightnumber
String*
The flight number requested
flightdate
Date*
The flight date requested
generatetokens
Boolean
If you would like to generate PAX tokens for the check-in system queries API
showcancelled
Boolean
If you would like to see cancelled bookings in the call
The method will response with all the information about the passengers in the requested flights.
flight
Element
The following parameters are within flight (The element flight will be for each flight)
flightid
Number
The flight id
flightnumber
String
Flight number requested
flightdate
Date
YYYY/MM/DD date of the flight
serviceload
Number
Will be displayed per flight
opsremark
String
Flight OPS remark
paxDetails
Container
All the information regarding the passenger
firstname
String
First name of the passenger
lastname
String
Last name of the passenger
age
Number
Age of the passenger
paxtitle
Title
The title of the passenger
paxwithinfant
Boolean
Is the passenger carrying infant
paxcountry
String
Country of the passenger
paxcountryiso
String
Passenger ISO country
fromdestination
String
Destination “from” code
todestination
String
Destination “To” code
pnrref
String
The PNR reference
pnrstatus
String
The PNR status (OK/PN/RQ)
pnrname
String
PNR name
servicestatus
String
Service status (Active / Cancelled)
servicebookingdate
Date
YYYY/MM/DD HH:MM - Service booking date
servicechangedate
Date
YYYY/MM/DD HH:MM - Service last change date (if cancelled)
pnrbookingdate
Date
YYYY/MM/DD HH:MM - PNR booking date
agencyname
String
Agency name (if the booking is from an agency)
agencycontact
String
The first contact in the agency
agencyphone
String
Agency phone number
agencycode
String
Agency code
agencyaccountingcode
String
Agency accounting code
classcode
String
Class code
paxtoken
Unique identifer
PAX token to be used in DCS related queries
paxunq
String
Identifier of the passenger
inboundflight
String
Flight number of inbound flight
inboundflightorigin
String
The origin of the inbound flight
outboundflight
String
Flight number of outbound flight
outboundflightdestination
String
The destination of the outbound flight
accommodationfrom
String
Accommodation from name (if exist)
accommodationto
String
Accommodation to name (if exist)
remarks
Container
The container will hold PNR remarks in several <remark> variables
paxtype
String
The title of the passenger
seat
String
Seat name
sequencenumber
String
Check-in sequence number
tailnumber
String
The tail number
status
String
Passenger check-in status
ffnumber
Number
Frequent flyer number
phonenumber
String
Passenger phone number
Passenger E-mail
eticketnumber
Number
identifier number of the passenger.
notes
String
Check-in sequence number
ssrs
Container
The container will hold PNR SSR's in several <ssr> variables
ssr
Container
The SSR name
allowances
Container
The container will hold a single bag_kg variable
bag_kg
Number
Allowed baggage weight (according to origin)
ancillaries
Container
The container will hold PNR ancillaries in several <ancillary> variables
ancillary
Container
The ancillary name
apisdata
Container
Advance API Information
nationality
String
ISO code of the passenger
type
String
Type of identification document (PASSPORT as default)
passportname
String
Passport holder name
docnumber
String
Number of document (passport number, I.D. number)
passportissuer
String
ISO code of the passport issuer
passportexpiry
Date
Date of expiry
gender
String
Gender (M-Male, F-Female, C-Child)
dateofbirth
Date
Passenger date of birth
paxgender
String
Gender (M-Male, F-Female, C-Child)
error
String
Will show incase the flight searched does not exist.
Important
You can search up to 10 flights at a time
* Mandatory parameters
getLoads
This request will give you a list of loads on flights according to the legs of each flight
fromdate
Date*
Start date of flight requested
todate
Date*
End date of flight requested
The method will response with all the information about the loads of flights according to the legs of each flight in the requested dates.
flightid
Number
Flight internal code
flightnumber
String
Flight number
actype
String
The aircraft type
serviceloadqty
Number
The service load quantity
rules
Element
Each rule of a flight will be represented in a <rule>element, all rules per flight are represented within<rules> element
rule
String
Free text of flight specific rule
legs
Element
The following elements are within <leg> which represents a leg within<legs>
leg
Element
The following parameters are within leg
legSTD
Time
Departure leg
legSTA
Time
Arrival leg
from
String
Destination “from” code
to
String
Destination “to” code
paxqty
Number
Passengers quantity of current leg
legRestrict
Number
Quantity restrict of current leg
Important
Range of dates must be up to a week.
* Mandatory parameters
getFlightLoads
flightnumber
String*
Number of flight
flightdate
Date*
Date of flight
The method will response with all the information about the loads of flights according to the legs of each flight in the requested dates.
flightnumber
String
Flight number
actype
String
The aircraft type
serviceloadqty
Number
The service load quantity
rules
Element
Each rule of a flight will be represented in a <rule>element, all rules per flight are represented within<rules> element
legs
Element
The following elements are within <leg> which represents a leg within<legs>
leg
Element
The following parameters are within leg
legSTD
Time
Departure leg
legSTA
Time
Arrival leg
from
String
Destination “from” code
to
String
Destination “to” code
classes
Element
The following elements are within <class> which represents a leg within<classes>
class
Element
The following parameters are within leg
classcode
String
Class Code
paxqty
Number
number of passengers
genderqty
Element
Element containing the passenger' gender breakdown
Male
Number
Number of male passengers
Female
Number
Number of female passengers
Child
Number
Number of children
Infant
Number
Number of infants
totalpaxqty
Number
Total number of passengers on the flight
totalgenderqty
Element
Element containing the passenger' gender breakdown, the same as for each leg
Important
Both parameters are mandatory
* Mandatory parameters
updatePassenger
This method will change the information about the passenger
flightid
Number*
The flight id
paxtoken
Unique identifer*
PAX token to be used in DCS related queries
firstname
String
Passenger new first name
lastname
String
Passenger new last name
age
Number
Passenger new age
seat
String
Passenger new seat
ffnumber
Number
Passenger new frequent flyer number
phonenumber
String
Passenger new phone number
Passenger new E-mail
nationality
String
Passenger new nationality
docnumber
String
Passenger new passport number
passportissuer
String
Passenger new passport issuing country (ISO code)
passportexpiry
Date
Passenger new passport expiry date
dateofbirth
Date
Passenger new date of birth
status
String
Passenger new check-in status
sequencenumber
String
Check in Sequence number
paxgender
String
Passenger gender (M/F/C)
ssrs
Element
The element will hold PNR SSR's in several 'ssr' variables
ssr
String
SSR code
The method will respond with "success" true if classes successfully leveled down.
Important
With this method you can not update information from other airlines.
* Mandatory parameters
Notice!
The request should contain all passenger data. In case some field is skipped - this field data will be erased.
getPaxDetailsByCharter
This method will give you a list of passengers according to a charter date.
chartersDate
Date*
Charter date
The method will response with all the information about the passengers in the charter.
charter
Element
The element will contain all the information regarding to the charter
routedetails
Element
The element will contain all the information regarding the route
charterRouting
String
The charter route
chrtrETD
Time
Estimated Time of Departure
chrtrETA
Time
Estimated Time of Arrival
paxdetails
Element
The element will holds all the passenger information (For each passenger)
firstname
String
First number requested
lastname
String
Last name of the passenger
age
Number
Age name of the passenger
paxtitle
String
The title of the passenger
paxwithinfant
Boolean
Phone Is the passenger carrying infant of the customer
paxcountry
String
Country of the passenger
paxcountryiso
String
Passenger ISO country
paxtype
String
Type of the pasengers
phonenumber
String
Phone number of the passenger
Email of the passenger
ffnumber
Number
Frequent flyer number of the passenger
pnrref
String
The PNR reference
pnrstatus
String
The PNR status (OK/PN/RQ)
pnrname
String
PNR name
servicestatus
String
Service status (Active / Inactive)
servicebookingdate
Date
YYYY/MM/DD HH:MM - Service booking date
servicechangedate
Date
YYYY/MM/DD HH:MM - Service last change date (if cancelled)
pnrbookingdate
Date
YYYY/MM/DD HH:MM - PNR booking date
agencyname
String
Agency name (if the booking is from an agency)
agencycontact
String
The first contact in the agency
agencyphone
String
Agency phone number
agencyacccode
String
Agency accounting code
agencywebcode
String
Agency web code
apisdata
Element
Advance API Information
nationality
String
Nationality of the passenger
type
String
Type of document
passportname
String
Passport name of the passenger
docnumber
Number
Passport number
passportissuer
Number
Passport country
passportexpiry
Date
Passport expiry
gender
String
Gender (M-Male, F-Female, C-Child)
dateofbirth
Date
The date of birth of the passenger
remarks
Element
Each remark in the PNR will be represented in a <remarks>element
remark
String
Remark text
paxgender
String
Gender (M-Male, F-Female, C-Child)
* Mandatory parameters
getPassengerDetail
This method will give you a list of passengers according to a flight id and pax token
requestdetails
Container*
The container will separate parameters for each passenger
flightid
Number*
The flight id
paxtoken
Unique identifer*
PAX token to be used in DCS related queries
The method will response with all the information about the passenger in the requested flight.
paxdetails
Element
All the information regarding the passenger (paxdetails for each passenger)
paxtoken
Unique identifer
PAX token to be used in DCS related queries
firstname
String
First name of the passenger
lastname
String
Last name of the passenger
age
Number
Age of the passenger
paxtitle
Title
The title of the passenger
paxwithinfant
Boolean
Is the passenger carrying infant
seat
String
Passenger seat
sequencenumber
String
The sequence number
carrierclass
String
The carrier class
origin
String
The origin code
destination
String
The destination code
tailnumber
String
The tail number
status
String
Passenger check-in status
ffnumber
Number
Frequent flyer number
phonenumber
String
Passenger Phone number
Passenger E-mail
notes
String
Passenger remarks (future use)
ssrs
Container
The container will hold PNR SSR's in several <ssr> variables
ssr
String
The SSR name
allowances
Container
The container will hold a single bag_kg variable
bag_kg
Number
Allowed baggage weight (according to origin)
ancillaries
Container
The container will hold PNR ancillaries in several <ancillary> variables
ancillary
String
The ancillary name
apisdata
Container
Advance API Information
nationality
String
ISO code of the passenger
type
String
Type of identification document
passportname
String
Passport holder name
docnumber
String
number of document (passport or I.D)
passportissuer
String
ISO code of the passport issuer
passportexpiry
Date
Date of expiry
gender
String
Gender (M-Male, F-Female, C-Child)
dateofbirth
Date
Passenger date of birth
bookingref
String
The PNR reference
eticketnumber
Number
identifier number of the passenger.
paxgender
String
Gender (M-Male, F-Female, C-Child)
* Mandatory parameters
getCustomer
This method allows you to retrieve customers details by email address.
Customers
Element*
The following elements are within <Customer> which represents a <Customer> within <Customers>
Customer
Element*
The Element hold the Email of the customer
E-mail*
The customer email
This method will respond with a list of customers, including personal details and additional information.
Customers
Element
The following elements are within <Customer> which represents a Customer within <Customers>
Customer
Element
The following parameters are within <Customer> (The element Customer will be for each customer)
custemail
Customer E-mail
title
String
Customer title
country
String
Country of the customer
firstname
String
First name of the customer
lastname
String
Last name of the customer
phonenumber
String
Phone number of the customer
mobile
String
Mobile number of the customer
fax
String
Fax number of the customer
birthdate
Date
YYYY/MM/DD date of customer birth date
address1
String
Customer address
address2
String
Customer additional address
zipcode
Number
Customer zip code
city
String
City of the customer
customercompanyname
String
Company of the customer (if applicable)
jobtitle
String
Job title of the customer (if applicable)
companywebsite
String
company website of the customer (if applicable)
customerremark
String
Remark text
vatnum
Number
VAT number of the customer
ffnumber
Number
Customer frequent flyer number
companyid
Number
ID of airline in AeroCRS systems
createddate
Date
YYYY/MM/DD date time of the system when creating the customer
Important
This method cannot retrieve customers' information from other airlines.
* Mandatory parameters
getPassengerIdentifierByName
This method allows you to search for a passenger by name in a specific flight
flightid
Number*
The flight id
paxname
String*
Passenger name (First name or last name)
The method will response with the pax token for the requested passenger.
paxtoken
Unique identifer
PAX token to be used in DCS related queries
* Mandatory parameters
getPassengerIdentifierByNameMulti
This method allows you to search for a passenger on multiple flights according to origin of flight
origin
String*
Destination code
startdate
Date*
From date
enddate
Date*
To date
paxname
String
Passenger name (First name or last name)
The method will response with paxtokens for usage in other methods
pax
Element
The element pax holds the following parameters
flightid
Number
The flight id
paxtoken
Unique identifer
PAX token to be used in DCS related queries
* Mandatory parameters
getPassengerIdentifiersByBookingReference
This method allows you to search for passengers according to booking reference on a specific flight
flightid
Number*
The flight id
bookingref
String*
The PNR reference
The method will response with pax tokens of the requested passengers.
errcode
String
The error code returned
errdescription
String
The error description
pax
Element
The element pax holds the following parameters
paxtoken
Unique identifer
PAX token to be used in DCS related queries
fltid
Number
The flight id
* Mandatory parameters
getAllFlightsFromOrigin
This method allows you to get all flights departing from an origin
origin
String*
Destination code
startdate
Date*
From date
enddate
Date*
To date
The method will response with a list of segments departing from the given origin.
flights
Element
The following elements are within <flight> which represents a flight within<flights>
flight
Element
The following parameters are within flight
flightid
Number
The flight id
flightnumber
String
The flight number
flightdate
Date
The flight date
flightequipment
String
Aircraft used
tailnumber
String
The tail number
seat_plan_reference
String
type of aircraft seat plan
opsremarks
String
Operational remarks (future use)
flightlegs
Element
The following elements are within <leg> which represents a leg within<flightlegs>
leg
Element
The following parameters are within leg
origin
String
The origin code
destination
String
The destination code
STD
Time
Departure leg
STA
Time
Arrival leg
daydiff
number
Returns 1 if flight lands on a different day.
* Mandatory parameters
getSeatMap
The method will return the flight seat map
origin
Number
The destination code
flightid
Number*
The flight id
The method will response the seat map that defined for the flight.
seatmap
Element
The element contain all the information regarding the seat map
row
Element
Contain all the seats in the row.
rownumber
Number
The row number in the map
seats
Element
The following elements are within <seat> which represents a seat within<seats>
seat
Element
The following parameters are within seat
seatname
String
The seat name
seattype
String
The seat type
seatpref
Element
Include the following atributes
attributes
Element
This element is exist only in JSON format
window
Boolean
If the seat is next to a window
extralegroom
Boolean
if the seat has extra leg room
exitrow
Boolean
if the seat is in an exit row
rearfacing
Boolean
if the seat a rear facing one
blocked
Boolean
if the seat block from reserving
preferredseating
Boolean
if the seat falls under preferred seating criteria
wheelchair
Boolean
if the seat suitable for a wheel chair
seatclass
String
The class name
seatpaxtoken
Unique identifer
PAX token to be used in DCS related queries
seatfromdestination
String
The from destination code
seattodestination
String
The to destination code
* Mandatory parameters
getTailList
This method will give you a list of all the tails (aircraft registrations) in the airline
pullQueue
Pull the queue according to queue ID
queid
string*
Unique ID of the requested queue
FlightNumber
String
Flight Number
FlightDate
String
Date of the flight in format: "Mon dd yyyy"
ChangeDate
String
Date of when the record was inserted to queue in format:
"yyyy-mm-dd hh:mm"
* Mandatory parameters
webLogin
The method will allow you to login a user directly to AeroCRS IBE from a form you can build on your website
logintype
String*
"web_cust" or "web_agent" only
usrname
String*
Customer e-mail for web_cust
Agent user name or e-mail for web_agent
usrpass
String*
Password
The method will response with a link with a token which you can redirect the customer to.
redirecturl
String
Redirection URL
Important
Redirection url includes a unique token. Note that the token is only valid for 30 minutes, after that re-login is required.
* Mandatory parameters
getCompanyDestinations
The method will give you a list of destinations served by the airline in question.
companycode
String
The companycode returned from getAirlines
The method will response with the list of destinations for a specific airline requested
destinations
Element
The following elements are within <destination> which represents a destination within <destinations>
destination
Element
The following parameters are within destination
name
String
Destination name
id
Number
Destination number to be used in the form
code
String
Destination code
iatacode
String
IATA code (if exists)
* Mandatory parameters
Important
CompanyID integer was replaced. Companycode can be requested at: http://support.aerocrs.com
Complete integration
The complete widget that includes all the design and functionality of the AeroCRS search engine - Just add and use.
To use the full vertical widget all you need to do is add an iframe element to your page at the location you desire. the iframe code should be:
<iframe src="http://devsandbox.aerocrs.systems/widget/searchelement.php?action=avl,fnd,ock&lang=en" frameborder="0" width="440" height="438"></iframe>The widget will already incorporate all your website settings and colors.
To use the full horizontal widget all you need to do is add an iframe element to your page at the location you desire. the iframe code should be:
<iframe src="http://devsandbox.aerocrs.systems/widget/searchelement.php?action=avl,fnd,ock&direction=horizontal" frameborder="0" width="100%" height="400"></iframe>
Domain to be used
Note, that "devsandbox.aerocrs.systems" should be replaced with your URL on the AeroCRS server.
Parameter
Note, that it is possible to send a language parameter (&lang=es) for the IBE.
Element Widget
This option allows you to implement only a specific element of the widget
The element widget is the same Complete integration widget, but you can break it down and display only part of the widget according to the following elements.
avl
Flights search engine
fnd
Find reservation
ock
Online Check-in
car
Car rental (if applicable)
"Action" should be placed in the action section in the URL of the iframe.
This widget will inherit design from the IBE settings.
To use the widget all you need to do is add an iframe element to your page at the location you desire. The iframe code should be:
<iframe src="http://devsandbox.aerocrs.systems/widget/searchelement.php?action=avl&lang=en" frameborder="0" width="440" height="438"></iframe><iframe src="http://devsandbox.aerocrs.systems/widget/searchelement.php?action=fnd&lang=en" frameborder="0" width="440" height="438"></iframe><iframe src="http://devsandbox.aerocrs.systems/widget/searchelement.php?action=ock&lang=en" frameborder="0" width="440" height="438"></iframe><iframe src="http://devsandbox.aerocrs.systems/widget/searchelement.php?action=car&lang=en" frameborder="0" width="440" height="438"></iframe>This widget will inherit design from the used page.
To use the widget all you need to do is add an iframe element to your page at the location you desire. the iframe code should be
<iframe src="http://devsandbox.aerocrs.systems/widget/searchelement.php?action=avl&type=bare&fonts=blackamp&buttons=grey&button-fonts=black" frameborder="0" width="440" height="438"></iframe>
<iframe src="http://devsandbox.aerocrs.systems/widget/searchelement.php?action=fnd&type=bare&fonts=blackamp&buttons=grey&button-fonts=black" frameborder="0" width="440" height="438"></iframe>
<iframe src="http://devsandbox.aerocrs.systems/widget/searchelement.php?action=ock&type=bare&fonts=blackamp&buttons=grey&button-fonts=black" frameborder="0" width="440" height="438"></iframe><iframe src="http://devsandbox.aerocrs.systems/widget/searchelement.php?action=car&type=bare&fonts=blackamp&buttons=grey&button-fonts=black" frameborder="0" width="440" height="438"></iframe>
Height and Width
Please note that height and width are different among implementations.
Deep Linking
This page is a description of the website template deep link when redirecting the customer from search engines.
Should you have developed your own Search engine on your hosted website, please see the following "deep linking" instructions:
The url should look like this:
Structure: http://www.airlineibe.com/LANG/flight-results/DST1-DST2/YYYY-MM-DD/YYYY-MM-DD/ADLT/CHLD/INF/CURR
Example: http://www.airlineibe.com/flight-results/TLV-LON/2017-01-27/2017-02-10/1/0/0/EUR
www.airlineibe.com
Domain of hosted IBE
Qualified Domain name
flight-results
fixed name
text
YYYY-MM-DD
Outbound date
YYYY-MM-DD
YYYY-MM-DD
Inbound date
"NA" if booking a oneway
YYYY-MM-DD
ADLT
Number of adults
integer
CHLD
Number of kids
integer
INF
Number of infants
integer
Error Messages
In cases where the API method has come across an error in the process, an error message will appear with the key "success" set to false.
Unlike empty results which will still return "success" true, but with an empty array.
{
"aerocrs": {
"success": false,
"details": {
"detail": [
"Wrong credentials"
]
}
}
}<aerocrs>
<success>False</success>
<details>
<detail>Wrong credentials</detail>
</details>
</aerocrs>{
"aerocrs": {
"success": false,
"details": {
"detail": [
"Wrong destinations input"
]
}
}
}<aerocrs>
<success>False</success>
<details>
<detail>Wrong destination input</detail>
</details>
</aerocrs>Available charge types
Available charge types to be used in V4 API
Currently we support the following:
NTL
National/Citizen of a Specified Country
ADT
Foreigner
STR
State Resident
You can get this value as returned by getDeepLink and use it as chargetype on getFlight
Getting Started With Your API
This page will help you get started with AeroCRS Payments.
This is where you show your users how to set it up. You can use code samples, like this:
$http.post('/someUrl', data).success(successCallback);
alert('test');Try dragging a block from the right to see how easy it is to add more content!