APIs Guide

This method is used for searching flight.

Request:

Field Name

Data Type

Description

Username

string

Password

string

OriginDestinations

list

List of origin(s) and destination(s)

Adult

integer

Number of adults (Over 12 years old)

Child

integer

Number of children (2 to 12 years old)

Infant

integer

Number of infants (Under 2 years old)

OriginDestinations

list

list of origin(s) and destination(s)

Field Name	Data Type	Description
Origin	string	Origin code (city or airport)
originiscity	boolean	true: Origin is a city false: Origin is an airport
Destination	string	Destination code (city or airport)
Destinationiscity	boolean	true: Destination is a city false: Destination is an airport
DepartureDate	date	Departure date (Format: YYYY-MM-DD)

Response:

Field Name

Data Type

Description

Successful

boolean

true: Successful
false: Failed

Status

string

"Successful" or "Failed"

ErrorCode

string

Error code (null: No error)

ErrorMessage

string

Error message (null: No error)

FlightProposals

list

list of flight proposal(s)

Field Name

Data Type

Description

string

Required for booking, issuing and retrieving

Type

integer

ItemNumber

string

System

string

Reference system code

IsCharter

boolean

true: Charter
false: Scheduled

ReservationType

string

"Hold"
"Revalidation"
"Reservation"
"Unknown"

RefundMethod

string

"Offline"
"NonRefundable"
"Online"
"Unknown"

IsDeferredIssuance

boolean

DeferredIssuanceTimeLimit

string

AdultCount

integer

Number of adults

ChildCount

integer

Number of children

InfantCount

integer

Number of infants

FareType

string

Total

decimal

Total price

TotalFare

decimal

Total Fare

TotalSingleAdultFare

decimal

Total price for one adult

Pricing

list

Prices of age categories

Baggages

list

Baggage allowances

BaggageFreeAllowance

int

RouteType

integer

Route

string

MarketingCarrier

string

Marketing airline(s) code

FlightGroups

list

GroupKey

string

IsEnabled

boolean

true: Enable
false: Disable

Currency

string

Pricing

list

prices of age categories

Field Name

Data Type

Description

PaxType

string

"Adult"
"Child"
"Infant"

Total

decimal

Total price for age category

Fare

decimal

PricingMessage

list

Field Name	Data Type	Description
Type	string	--
Description	string	--

Baggages

list

Baggage allowances

Field Name	Data Type	Description
Id	string	--
From	string	Origin airport code
To	string	Destination airport code
FlightNo	string	Flight number
PassengerType	string	"Adult", "Child", "Infant"
BaggageType	string	"Hand" (Hand carry) "Checked" (Checked baggage)
BaggagePiece	string	Number of baggage pieces
BaggageWeight	string	Maximum weight of baggages
BaggageWeightMeasureUnit	string	Baggage measure unit (Example: "KG")

FlightDetails

list

Field Name

Data Type

Description

Index

integer

string

InternalId

string

Origin

string

Origin airport code

OriginAirportName

string

Origin airport name

OriginCity

string

Origin city name

Destination

string

Destination airport code

DestinationAirportName

string

Destination airport name

DestinationCity

string

Destination city name

MarketingCarrier

string

Marketing airline code

OperatingCarrier

string

Operating airline code

FlightNumber

string

Flight number

Aircraft

string

Aircraft type

Class

string

Flight class

Baggages

list

Baggage allowances

Field Name	Data Type	Description
Id	string	--
From	string	Origin airport code
To	string	Destination airport code
FlightNo	string	Flight number
PassengerType	string	"Adult", "Child", "Infant"
BaggageType	string	"Hand" (Hand carry), "Checkin" (Checked baggage)
BaggagePiece	string	Number of baggage pieces
BaggageWeight	string	Maximum weight of baggages
BaggageWeightMeasureUnit	string	Baggage measure unit (Example: "KG")

DepartureDateTime

datetime

Departure date and time

DepartureDate

string

Departure date (Format: YYYY-MM-DD)

DepartureDay

string

Departure day

DepartureTime

string

Departure time (Format: HH:mm)

DepartureTerminal

string

Departure terminal (nullable)

ArrivalDateTime

datetime

Arrival date and time

ArrivalDate

string

Arrival date (Format: YYYY-MM-DD)

ArrivalDay

string

Arrival day

ArrivalTime

string

Arrival time (Format: HH:mm)

ArrivalTerminal

string

Arrival terminal (nullable)

Duration

string

Flight duration ("HH:MM")

DurationTotalMinutes

integer

Total travel duration in minutes

Status

string

Available capacity

Important Information

Note: All the flight dates and times (departure and arrival) from the web service responses returned are according to the departure and arrival locations time zone.

This method is used for booking a flight before payment.

Request:

Field Name

Data Type

Description

Username

string

Password

string

FlightProposalID

string

FlightProposal ID (returned in the “FlightSearch” method)

Passengers

list

list of passenger(s) information

Field Name	Data Type	Description
Type	string	“ADL”: Adult “CHD”: Child “INF”: Infant
FirstName	string	First name
LastName	string	Last name
Gender	string	“Male” “Female”
IdentityNumber	string	--
DateOfBirth	date	Date of birth (Format: YYYY-MM-DD)
PlaceOfBirth	string	Place of birth country code (Example: “AZ”)
PlaceOfIssue	string	Passport issuing country code
PassportNumber	string	Passport number
PassportExpiryDate	date	Passport expiry date (Format: YYYY-MM-DD)

Mobile

string

Phone

string

Response:

Field Name

Data Type

Description

Successful

boolean

true: Successful
false: Failed

Status

string

“Successful” or “Failed”

RequestType

integer

RequestID

string

ReservationID

string

Reservation ID (Required for issuing)

Reference

string

Reference / PNR

ErrorCode

string

Error code (null: No error)

ErrorMessage

string

Error message (null: No error)

EndUserMessageCode

string

End-User message code (null: No error)

EndUserMessage

string

End-User message (null: No error)

RequestDateTime

datetime

Request date and time

TimeLimit

datetime

Time limit for issuance

IsDeferredIssuance

boolean

DeferredIssuanceTimeLimit

int

TotalPrice

decimal

Total price

Currency

string

PriceChanged

boolean

Price changed or not

NewPrice

list

New price information

Field Name

Data Type

Total

decimal

TotalFare

decimal

TotalSingleAdultFare

decimal

Pricing

list

New price information

Field Name	Data Type
PaxType	string	"Adult" "Child" "Infant"
Total	decimal
Fare	decimal	--

This method is used for issuing tickets after payment.

Request:

Field Name	Data Type	Description
Username	string	--
Password	string	--
FlightProposalID	string	FlightProposal ID (returned in the "FlightSearch" method)
ReservationID	string	Reservation ID (returned in the "FlightBook" method)

Response:

Field Name	Data Type	Description
Successful	boolean	true: Successful false: Failed
Status	string	"Successful" or "Failed"
RequestType	integer	--
ReservationID	string	Reservation ID (Required for retrieving)
Reference	string	Reference / PNR
ErrorCode	string	Error code (null: No error)
ErrorMessage	string	Error message (null: No error)
EndUserMessageCode	string	End-User message code (null: No error)
EndUserMessage	string	End-User message (null: No error)
RequestDateTime	datetime	Request date and time
IsDeferredIssuance	boolean	--
IssuanceDeadline	datetime	--
TotalPrice	decimal	Total price
Currency	string	--
PriceChanged	boolean	--

This method retrieves the request that is already created. This method is used to get the ticket(s) after issuance. Please note that the “IssueTicket” method does not return the issued ticket(s) information. You can call the “RetrieveRequest” method after at least 10 seconds after successful ticket(s) issuance for retrieving the information of the issued ticket(s).

Request:

Field Name	Data Type	Description
Username	string	--
Password	string	--
FlightProposalID	string	FlightProposal ID (returned in the "FlightSearch" method)
ReservationID	string	Reservation ID (returned in the "IssueTicket" method)

Response:

Field Name

Data Type

Description

Successful

boolean

true: Successful
false: Failed

Status

string

"Successful" or "Failed"

RequestType

integer

0: Reserve, 1: Issue

ReservationID

string

Reservation ID

Reference

string

Reference / PNR

ErrorCode

string

Error code (null: No error)

ErrorMessage

string

Error message (null: No error)

EndUserMessageCode

string

End-User message code (null: No error)

EndUserMessage

string

End-User message (null: No error)

RequestDateTime

string (datetime)

Request date and time

TimeLimit

string (datetime)

If request is Reserve, time limit for issuance

IsDeferredIssuance

boolean

true: Deferred issuance, false: Immediate issuance

DeferredIssuanceTimeLimit

int?

Deferred issuance time limit in minutes (nullable)

TotalPrice

decimal?

Total price (nullable)

Currency

string

Currency code (e.g., USD, EUR, IRR)

ItineraryInfo

list

Itinerary information

Field Name

Data Type

Description

Type

int?

Itinerary type (nullable)

IsCharter

bool?

true: Charter flight, false: Scheduled flight

RefundMethod

string

Refund method description

MarketingAirlineCode

string

Marketing airline code

MarketingAirlineName

string

Marketing airline name

Route

string

Route description

FlightGroups

list

Field Name

Data Type

Description

Index

string

Flight group index

RouteNo

int?

Route number

Origin

string

Origin airport code

OriginAirport

string

Origin airport name

OriginCity

string

Origin city name

Destination

string

Destination airport code

DestinationAirport

string

Destination airport name

DestinationCity

string

Destination city name

AirlineCode

string

Airline code

AirlineName

string

Airline name

ClassType

string

Cabin type (e.g., Economy, Business)

ClassTypeName

string

Cabin name

Class

string

Class of service

DepartureDateTime

DateTime?

Departure date and time

DepartureDate

string

Departure date (Format: YYYY-MM-DD)

DepartureDay

string

Departure day of week

DepartureTime

string

Departure time (Format: HH:mm)

ArrivalDateTime

DateTime?

Arrival date and time

ArrivalDate

string

Arrival date (Format: YYYY-MM-DD)

ArrivalDay

string

Arrival day of week

ArrivalTime

string

Arrival time (Format: HH:mm)

NumberOfStops

string

Number of stops

TimeOfStop

int?

Stop duration in minutes (nullable)

Duration

string

Flight duration as string

DurationTotalMinutes

int?

Total duration in minutes

FlightDetails

list

Field Name

Data Type

Description

Index

int?

Flight detail index

string

Flight detail ID

Origin

string

Origin airport code

OriginAirport

string

Origin airport name

OriginCity

string

Origin city name

Destination

string

Destination airport code

DestinationAirport

string

Destination airport name

DestinationCity

string

Destination city name

MarketingAirlineCode

string

Marketing airline code

MarketingAirlineName

string

Marketing airline name

OperatingAirlineCode

string

Operating airline code

OperatingAirlineName

string

Operating airline name

FlightNumber

string

Flight number

Aircraft

string

Aircraft type

Class

string

Flight class

Baggages

list

Field Name	Data Type	Description
Id	string	Baggage ID
PassengerType	string	Passenger type (ADL, CHD, INF)
BaggageType	string	Type of baggage (checked, carry-on)
BaggagePiece	string	Number of pieces
BaggageWeight	string	Weight amount
BaggageWeightMeasureUnit	string	Weight unit (kg, lb)

DepartureDateTime

DateTime?

Departure date and time

DepartureDate

string

Departure date (Format: YYYY-MM-DD)

DepartureDay

string

Departure day of week

DepartureTime

string

Departure time (Format: HH:mm)

DepartureTerminal

string

Departure terminal name

ArrivalDateTime

DateTime?

Arrival date and time

ArrivalDate

string

Arrival date (Format: YYYY-MM-DD)

ArrivalDay

string

Arrival day of week

ArrivalTime

string

Arrival time (Format: HH:mm)

ArrivalTerminal

string

Arrival terminal name

Duration

string

Flight duration as string

DurationTotalMinutes

int?

Total duration in minutes

Tickets

list

ticket(s) details

Field Name	Data Type	Description
RouteNo	int?	Route number
Status	string	Ticket status
AgeType	string	"ADL": Adult, "CHD": Child, "INF": Infant
Title	string	"MR", "MS", "MRS", etc.
PaxName	string	First name of passenger
PaxFamily	string	Last name of passenger
PassportNumber	string	Passport number
PNR	string	Reference / PNR
TicketNumber	string	Ticket number
Total	decimal?	Total price for this ticket