Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Request Body -

...

Name

...

Description

...

Format

...

Avail RQ

...

NAME

DESCRIPTION

FORMAT

ALLOWED VALUES

MANDATORY

Availability Request

query

availabilityPriceRequest

token

your token

string

yes

target

criterias

search criteria

string

yes

SearchCriteria

connectors

connectors to launch

[ 1A, 1G, TF, IB, NV, RN, VY, KL, AF, BA, PY ]

no

max_responses

Max num of results

250

no

rules

combined

Mix diferent providers

values true or false

"combined": false

no

query/token

Token request. If you do not specify a value to the token, a token is generated automatically. If desired, a custom token can be added.

String

No

query/criterias

Search Criteria

Array [Object]

Yes

query/criterias/connectors

criterias/connectors

Connectors to launch.

According to the connector that the client has activated.

If no connector is indicated, those will be launched and will be configured.

Array [String]

  • 1A = Amadeus.

  • 1G = Galileo.

  • TF = Travel Fusion.

  • IB = Iberia.

  • NV = Ticketya.

  • RN = Renfe

  • VY = Vueling.

  • KL = Klm

  • AF = Air France.

  • BA = British Airways.

  • PY = Pyton.

  • LH = Lufthansa.

  • AA = American irlines.

  • TU = Tui.

  • AV = Avianca.

  • EK = Emirates.

  • AY = Finnair.

  • EV = Evelop.

  • 3O = Air Arabia.

No

query/criterias/rule

rule/combined

Mix diferent providers

Bool

  • True

  • False

No

rule/duplicated

Remove duplicate flights from providers

values true or false

"duplicate": false

no

Bool

  • True

  • False

No

rule/show_data

Show Data Information

"show_data": false

no

: displays more descriptive information for identifiers that are part of avail

values true or false

Bool

  • True

  • False

No

rule/show_partial

 Show

Show Partial Solutions

: allows to receive one way solutions to be able to build a round trip solution from customer side

values true or false

"show_partial": false

no

Bool

  • True

  • False

No

rules/show_origin_destination

Show Origin

Destinations

Destination.

Show IATA codes into Origien and Destination flag

values true or false

"show_origin_destination": false

no

.

Bool

  • True

  • False

No

rules/show_public_fares

Show Public fares only.

If the flag is in False for default you will receive Public and Nego fares

values true or false

"show_public_fares": false

no

corporate code

corporate account

string

no

TransportRequest

product type

Enums\ProductType

string

no

paxes_distribution

ages of all passengers

example: 30
maximum: 99
minimum: 0]

yes

Journey Request

every request pair origin and destination

"origin": "MAD",
"destination": "SVQ"

yes

dates

date to travel

 2019-12-13

yes

origin

origin iata

MAD

yes

destination

destination iata

BCN

yes

connections

list of locations to include or exclude

ADD|AVOID|iata codes

ADD/MIA

AVOID/DEL

no

schedules

Specify only one departure time or a range of hours to departure adding 2 hours

?

no

schedules_arrival

Specify only one arrival time or a range of hours to arrival adding 2 hours

?

no

origin_radius

title: Determine the airports near of the origin the specified N kilometers around

example: 1
default: 0

no

destination_radius

Determine the airports near of the destination the specified N kilometers around

example: 1
default: 0

no

arrival same date

To get travels that departure date and arrival date are the same

example: false
default: false

no

range_dates

prev

Days before date selected
example: 1

.

Bool

  • True

  • False

No

query/criterias/travel (mandatory)

travel/currency

Currency requested by the user

String

EUR

No

travel/companies

Choosse companies IATA codes to add or avoid results.

  • To add = ADD + ConnectorID. Ex: [ADD, AF].

  • To avoid = AVOID + ConnectorID. Ex: [AVOID, BA].

  • To add Alliances = ADD + *AlliancesCode. Ex: [ADD, *O].

  • Alliance One World = *O

  • Alliance Star Alliance = *S

  • Alliance Sky team = *A

Array[Array<string>]

  • [ADD, IB]

  • [AVOID, VY]

  • [ADD, *S]

  • [ADD,*A]

  • [ADD, *O]

No

travel/include_train

To include train travels in results.

Default: true

Bool

  • True

  • False

No

travel/include_bus

If this flag is false, solutions including segments by bus will be excluded.

Default: true

Bool

  • True

  • False

No

travel/only_flight

Get only flight.

Default: false

Bool

  • True

  • False

No

travel/low_cost

To include Low cost flights.

Default: true

Bool

  • True

  • False

No

travel/include_gds

Option to show GDS providers.

Default: true

GDS Providers:

  • 1A Amadeus

  • 1G Galileo

  • 1S Sabre

Bool

  • True

  • False

No

travel/include_ndc

Option to show NDC providers.

Default: true

Bool

  • True

  • False

No

travel/baggage

Select only flights that include baggages.

Default: false

Bool

  • True

  • False

No

travel/cabin

Type of cabin.

The indicated cabin field of the AvailRQ allows you to request only one type of cabin.

Economic = Y.

Economic Standard = M.

Economic Premium = W.

Business = C.

First = F.

Enum

  • Y

  • M

  • W

  • C

  • F

No

travel/currency

Currency requested

String

ISO-4217

Ejemplo: EUR, USD

No

travel/range_dates

ranges_dates/prev

Days before date selected.

The maximum allowed range between 'prev' and 'post' is 3 days.

Integer

prev: 1

No

ranges_dates/post

Days after date selected.

example: 1

The maximum allowed range between 'prev' and 'post' is 3 days.

example: 1

Integer

example

post:

 1

cabin

Type of cabin

Economic = Y, Economic Standard = M, Economic Premium = W, Business = C, First = F

Enum:
[ Y, M, W, C, F ]

[ Y, M, W, C, F ]

no

direct

To return only direct flight, without scales

true or false

default: false

"direct": false

no

3

no

No

travel/flexible_dates

Get flights with flexible +/- 3 days


example:false

no

.

Bool

  • True

  • False

No

travel/refundable

To return only refundable

fares

.

example

Default:

 false
default: false

no

low_cost

To include Low cost flights in results

example: true
default: true

no

baggage

select only flights with baggage included

example: false
default: false

no

companies

select comany to add or avoid on response

example

ADD/IB

AVOID/AA

no

send_fee_resi_gds_agency

indicates if the agency need to send the carrier resident fee

?

no

int_dif_fee_gds_agency

resident fee to send to gds in configured aency Form of payment

?

no

is_iata_agency

indocates if agency is IATA

?

no

include_train

To include train travels in results

example: true
default: true

no

include_ndc

Get flight results from NDC

example :true
default: true

no

fare_type

to select only one fare type on results

(PUBLIC = Public fares, PRIVATE = Private fares)

default: null to return all fares types

[ PUBLIC, PRIVATE ]

no

false.

Bool

  • True

  • False

No

travel/large_family_discount

Request large family discount. Only spanish market

F1 = general.

F2 = special.

Enum

  • F1

  • F2

No

travel/disney

Request Disney fares

Bool

  • True

  • False

No

travel/exclude_usa

To exclude USA flights in results.

Default: true.

Bool

  • True

  • False

No

travel/exclude_russia

To exclude Russia flights in results.

Default: true.

Bool

  • True

  • False

No

travel/group_by

Group by: Price (by default)

String

  • Price Data

No

travel/exclude_fares

Fare types or codes to exclude (TTOO, ETNIC, GL320, etc) You can exclude fare types (as TTOO, ETNIC, etc) or codes for some providers as renfe (GL320, GL010, etc)

array<string>

no

disney

Request Disney fares

example: false
default: false

no

Array [String]

  • TTOO

  • ETNIC

  • CUPO

No

travel/fare_type

To select only one fare type on results. If no fare type is specified, all are shown.

PUBLIC = Public fares.

PRIVATE = Private fares.

Default: null, to return all fares types.

String

  • PUBLIC

  • PRIVATE

No

travel/product type

ProductType

String

  • Flight

  • Train

No

travel/cruise

Request Cruise fares

example: false
default: false

large_family_discount

Request large family discount 

F1, Special = F2)
default: nullEnum:
[ F1, F2 ]

[ F1, F2 ]

no

delegation

 Source_Id of delegation

numeric

no

Bool

  • True

  • False

No

travel/special_pricings

special_pricings/ptcs

Array of passenger type code. Specify passenger type code.

  • HOF = Head of family (Amadeus).

  • FNN = free or discounted child.

  • CNN = payment child (subgroup of UMNR).

Array[String]

  • HOF

  • FNN

  • CNN

No

special_pricings/codes

Array of search codes (rates).

Specify search codes (rates).

Array[String]

  • 401977

  • 403134

No

special_pricings/companies

Array of companies affected by this request.

Specify companies affected by this request.

Array[String]

  • IB

  • AF

No

query/criterias/travel/journeys (mandatory)

journeys/max_layover_total_time

The sum of all scales time is less or equal (<=) than this value, in seconds.

Default: null.

Integer

86400

No

journeys/max_layover_time

The duration of each scale is less or equal (<=) than this value, in seconds.

Default: null.

Integer

24000

journeys/max_layover_count

Maximum number of scales.

  • 0 = To return only direct flight.

  • 1 = 1 scale.

  • 2 = 2 scale.

  • Null = any.

Default: null

Integer

  • null

  • 0

  • 1

  • 2

No

journeys/origin

Origin IATA

String

MAD

Yes

journeys/destination

Destination IATA

String

BCN

Yes

journeys/date

Date to travel. Format date: yyyy-mm-dd

Date

2022-10-14

Yes

journeys/range_dates

journeys/range_dates/prev

Prev: Days before date selected.

The maximum allowed range between 'prev' and 'post' is 3 days.

Days before date selected.

Interger

prev: 3

No

journeys/range_dates/post

Post: Days after date selected.

The maximum allowed range between 'prev' and 'post' is 3 days.

Interger

post: 3

No

journeys/schedules

Specify only one departure time or a range of hours to departure adding 2 hours

Array[String]

  • “4:00“

  • “12:00“

No

journeys/schedules_arrival

Specify only one arrival time or a range of hours to arrival adding 2 hours

Array[String]

  • “21:00“

  • “23:00“

No

journeys/arrival_same_day

To get travels that departure date and arrival date are the same.

Default: false

Bool

  • True

  • False

No

journeys/connections

List of locations to include or exclude.

  • ADD + IATA

  • AVOID + IATA

Array[Array]

  • [ADD, AGP]

  • [AVOID, PAR]

No

journeys/origin_radius

Determine the airports near of the origin the specified N kilometers around

Integer

100

No

journeys/destination_radius

Determine the airports near of the destination the specified N kilometers around

Integer

100

No

query/criterias/travel/paxes_distribution (mandatory)

paxes_distribution/passengers_ages

Ages of all passengers:

  • INF = [0,2] (Infant)

  • CHD = [2,12] (Child)

  • YTH = [12,16] (Young)

  • ADT = [12,150] (Adult)

  • YCD = [60, 150] (Senior)

  • UMN = [12,16] (Unaccompanied minor)

Array [Integer]

30

7

1

Yes

query/criterias/max_responses

Max num of results.

Default: 250.

Integer

100

No

query/criterias/corporate_code

corporate_code/id

Corporate code ID

Integer

1047

No

delegation

[OPTIONAL] Source_Id of delegation.

Use this parameter to act on behalf of another delegation.When using this parameter, the reservations will be executed and created on the office whose source id has been sent in the "delegation" parameter.

String

Sourde_ID_Delegation

No