Versions Compared

Old Version 3

changes.mady.by.user Ricardo Berzal

Saved on

compared with

New Version Current

changes.mady.by.user Maria Vega

Saved on

Key

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

...

Description

...

format

...

mandatory

...

title: Element index on client system.

...

BookingQuery

...

token : request token

example: 52e6e452090b

...

Status
colourRed
titleyes

...

SolutionQuery

...

solutionid : solution selected to book

...

string
title: Solution identifier.

...

Status
colourRed
titleyes

...

journeys: list of journeys into solution id

...

string
example: IB210020190820]

...

Status
colourRed
titleyes

...

element_no

...

title: Element index on client system.

...

Status
titleno

...

holder

...

traveller id

...

[string]

...

Status
colourRed
titleyes

...

code

...

[string]
title: Traveller id

...

Status
colourRed
titleyes

...

type: traveller type

...

[ADT, CHD, INF]

...

Status
colourRed
titleyes

...

gender : traveler gender

...

[ Male, Female ]

...

Status
colourRed
titleyes

...

title : traveller title

...

[ Mr, Mrs, Ms, Miss ]

...

Status
colourRed
titleyes

...

name: traveller name

...

Example : Miguel

...

Status
colourRed
titleyes

...

surnemes: traveller surnames

...

Example : perezun

...

Status
colourRed
titleyes

...

birth_date: date of birth of traveller required for child and infant

...

: "1992-01-06"

...

Status
colourRed
titleyes
for child and infant traveller type

...

contact

...

type Contact data type, Passenger or Emergency

...

[string]

...

Status
colourRed
titleyes

...

name Contact name (Emergency)

...

[string]

...

Status
titleno

...

surnames Contact surname (Emergency)

...

[string]

...

Status
titleno

...

mails List of contact mails.

...

[string]

...

Status
titleno

...

List of contact phones.

...

phones  title: List of contact phones

...

[string]

...

Telephone

...

country_pref

...

[0034]

...

Status
titleno

...

number

...

[649540022]

...

Status
titleno

...

address Contact address (mandatory for low cost, check the flag 'need_address' in PricingRS

...

[string]

...

Status
titleno

...

city Contact city (mandatory for low cost, check the flag 'need_address' in PricingRS)

...

[string]

...

Status
titleno

...

postal_codes postalCode (mandatory for low cost, check the flag 'need_address' in PricingRS)

...

[string]

...

Status
titleno

...

country Contact country (mandatory for low cost, check the flag 'need_address' in PricingRS)

...

[string]

...

Status
titleno

...

Traveller documents

...

title: Traveller documents.

...

Document

...

🔹 Request Body - Booking

...

NAME

DESCRIPTION

FORMAT

ALLOWED VALUES

MANDATORY

Booking Request

query

query/token

Request Token

String

LZ63453a81cc00e

No

query/solutions

Solutions to book

Array[Object]

Yes

solutions/journeys

Array of Journeys ids

Array[String]

  • FR232920221107

  • FR232820221111

Yes

solutions/id

Solution identifier

String

VZ63453a86505da0022

Yes

query/travellers

Array[Object]

Yes

travellers/type

Traveller type [ADT, CHD, INF, YCD, YTH]

String

ADT

Yes

travellers/title

Traveller title [Mr, Mrs, Ms, Miss]

String

Mr

Yes

travellers/name

Traveller Name

String

Pepe

Yes

travellers/documents

Array[Object]

documents/type

Document Type

Enum

  • PP: Passport

  • NI: National identity document

  • TR: Resident Card (N.I.E)

  • FF: Frequent Flyer VA+numeración (cía VY)

    IB+numeración (cía IB) example: IB50159953 (For AF NDC provider you have to send it FB+numbering. In the case of LH NDC, as it provides service to several airlines in its group, it would be necessary to indicate the company code. LH- Lufthansa, LX- Swiss airlines, SN- Brussels airlines, OS- Austrian airlines.)

  • CE: Census (for Spanish residents)

-

  • DL: Driving license (for rental car bookings)

- OB: On Business

[ PP, NI, TR, FF, CE, DL, OB ]

Status
colourRed
titleyes

number Document Number.

[string]

Status
colourRed
titleyes

city  Municipality of residence. Mandatory for resident discount.

[string]

Status
titleno

country Document emission country.

[string]

Status
titleno

nationality Document nationality

[string]

Status
titleno

issue_date document issue date

($date-time)

Status
titleno

expiry_date expiration document date

($date-time)

Status
titleno

validated Indicates if the document was validated by the provider. Used by residents, validation S.A.R.A.

[string]

Status
titleno

Person in charge of the traveler

responsibles :person in charge of travelers used by UNMR unaccompanied minors travelling alone

PersonInCharge

location  IATA

Yes

documents/number

Document Number

String

BWE840580S

Yes

documents/nationality

Document nationality

String

ES

Yes

documents/issue_date

Document issue date

Date

2021-11-11

Yes

documents/expiry_date

Document expiration date

DateTime

2025-11-11

Yes

documents/country

Document emission country

String

ES

Yes

travellers/responsibles

Array[Object]

No

responsibles/locations

IATA or ID location for pick-up or drop-off

.

[string]name

LHR

Status
titleno

No

responsibles/name

Contact's full name

.

[string]

String

status

Pepa

title

No

no

responsibles/address

address

Contact's address

.phone

[string]

Status
titleno

String

c/ de la llegada

No

responsibles/phones

Contact's phone

.

[string]

String

status

711223344

title

No

no

responsibles/origin_destination_ref

OriginDestination references for person in charge

[string]

Integer

status

0

titleno

contact

Status
colourRed
titleyes

type

No

travellers

Travellers data  Travellers data.

Traveller

code Traveller id

[string]

Status
colourRed
titleyes

type traveller type

[ADT, CHD, INF]

Status
colourRed
titleyes

gender traveller gender

[ Male, Female ]

Status
colourRed
titleyes

title traveller title

[ Mr, Mrs, Ms, Miss ]

Status
colourRed
titleyes

name traveller name

"testina"

Status
colourRed
titleyes

surname traveller surname

example ["test"],

Status
colourRed
titleyes

birth_date only mandatory for child and infant

"1992-05-11",

Status
titleno

/surnames

Surnames

Array[String]

Lleego Adulto

Yes

travellers/birth_date

Birth date

DateTime

1989-12-12

No

travellers/contact

Object

contact/type

Contact data type, Passenger or Emergency

[string]

String

statusname

Emergency

colourRed
titleyes

No

contact/name

Contact name (Emergency)

[string]

String

status

Pepe

title

No

no

contact/surnames

surnames

Contact surname (Emergency)

[string]

Status
titleno

traveller documents

type title: Document Type - PP: Passport - NI: National identity document - TR: Resident Card - FF: Frequent Flyer - CE: Census (for Spanish residents) - DL: Driving license (for rental car bookings) - OB: On Business

[ PP, NI, TR, FF, CE, DL, OB ]

Status
colourRed
titleyes

number Document Number.

[string]

Status
colourRed
titleyes

city  Municipality of residence. Mandatory for resident discount.

[string]

Status
titleno

country Document emission country.

[string]

Status
titleno

nationality Document nationality

[string]

Status
titleno

issue_date document issue date

($date-time)

Status
titleno

expiry_date expiration document date

($date-time)

Status
titleno

validated Indicates if the document was validated by the provider. Used by residents, validation S.A.R.A.

[string]

Status
titleno

responsabilities

person in charge of traveller

responsibles :person in charge of travelers used by UNMR unaccompanied minors travelling alone

PersonInCharge

location  IATA or ID location for pick-up or drop-off.

[string]

Status
titleno

name Contact's full name.

[string]

Status
titleno

address Contact's address.

[string]

Status
titleno

phone Contact's phone.

[string]

Status
titleno

origin_destination_ref OriginDestination references for person in charge

[string]

Status
titleno

fees

Booking Fees by traveller type.

FeeQuery

pax_type Passenger Type Code.

[ADT,CHD,INF]

Status
colourRed
titleyes

amount

number ($double)

Status
colourRed
titleyes

amount_markup integer

[string]

Status
titleno

ancilliaries

Add extra baggage in booking request

TransportSupplement

id

[string]

Status
titleno

short_name

[string] example: BUSINESS

Status
titleno

long_name

[string] example: Business Flexible

Status
titleno

source_i_d Supplement identification

number($double)

Status
titleno

extensions

?

base title: Price of the service without fees.

number($double)

Status
titleno

fee title: Supplement fee

number($double)

price title: Supplement total price, base + fee

number($double)

Status
titleno

total title: Supplement total price

number($double)

Status
titleno

included title: Is supplement included?

boolean

Status
titleno

mandatory title: Is supplement mandatory?

boolean

Status
titleno

selected title: Is supplement selected?

boolean

Status
titleno

direct_payment title: Has supplement direct payment

string

Status
titleno

category title: Supplement category.

string

pattern quantity integer

string

Status
titleno

units Number of unitis by unitQualifier

integer

Status
titleno

unit_qualifier Unit type

string

Status
titleno

status connector i_d refundable

string

Status
titleno

distribution Wich distribution apply for

string

Status
titleno

value Supplement identify

string

Status
titleno

pax_reference

Passenger references for supplement

string

seg_reference

Status
titleno

Segment references for supplement

string

journey_reference

Status
titleno

Journey references for supplement

string

selection  How many supplements of this type could be selected together?

[one | multiple]

Status
titleno

seat_preference

TransportSeat

id

string

Status
titleno

short_name example: BUSINESS

string

Status
titleno

long_name example: Business Flexible

string

Status
titleno

extensions

example: BUSINESS

Status
titleno

situation : Situation type (aisle or window)

string

(aisle or window)

Status
titleno

direction : Direction of pax regard to running

string

Status
titleno

emergency_contact

traveller

code title: Traveller id

string

Status
titleno

type : Traveller type [ADT, CHD, INF]

string

Status
titleno

gender Traveller genterEnum

[ Male, Female ]

Status
titleno

title Traveller title.

[ Mr, Mrs, Ms, Miss ]

Status
titleno

name Traveller Name

string

Status
titleno

birth_date Traveller birth date [Require for children and infants]

string

($date-time)

Status
titleno

contact

type title: Contact data type, Passenger or Emergency

string

Status
titleno

name title: Contact name (Emergency)

string

Status
titleno

surnames title: Contact surname (Emergency)

string

Status
titleno

mails List of contact mails.
title: List of contact mails.

[string]

Status
titleno

phones List of contact phones.[
title: List of contact phones.Telephone

{...}]

Status
titleno

address title: Contact

String

Test Lleego

No

contact/phones

Array[Object]

phones/country_pref

Country prefix

String

34

No

phones/number

Phone number without prefix

String

711287654

No

contact/country

Contact country (mandatory for low cost, check the flag 'need_address' in PricingRS)

String

VA

No

query/payment

Object

payment/type

Type of payment.

  • 1: credit

  • 2: transfer

  • 3: deposit

  • 4: uatp / card

  • 5: cash

  • 8: picard

  • 11: voucher
    Please, keep in mind which payment options you have availables.

Integer

  • 1

  • 2

  • 3

  • 4

  • 5

  • 8

  • 11

No

payment/cash

If payment cash true

Bool

  • True

  • False

No

payment/card

Object

card/form

Dynamic, Internal form (for avoris)

String

Null

No

card/category

Debit or credit card. ("CREDITCARD | DEBITCARD")

String

  • CREDITCARD

  • DEBITCARD

No

card/card_type

Credit card type code Please, check the card types returned by pricing method.

If no types are returned, you can user ["VI" | "CA" | "AX" | "DC"]

String

MasterCard

No

card/holder

Credit card holder complete name

String

NOMBRETEST MORENO SANCHEZ

No

card/number

Credit card number

String

5486207058370274

No

card/expire_month

Credit card month as string of 2 digits

String

10

No

card/expire_year

Credit card year as string of 4 digits

String

2026

No

card/cvv

Credit card security code

String

309

No

query/voucher_url

URL for external verification payment

String

http://localhost:4200/transport/voucher/

No

query/holder

Yes

holder/name

Traveller Name

String

Miguel

Yes

holder/surnames

Traveller surnames

Array[String]

Perezuno

Yes

holder/contact

Object

Yes

contact/mails

List of contact mails

Array[String]

ag@gmail.com

Yes

contact/phones

List of contact phones

Array[Object]

Yes

phones/country_pref

Country prefix

String

34

Yes

phones/number

Phone number without prefix

String

722331122

Yes

contact/address

Contact address (mandatory for low cost, check the flag 'need_address' in PricingRS)

string

Status
titleno

city title: Contact

String

c/ de la alegria

Yes

contact/city

Contact city (mandatory for low cost, check the flag 'need_address' in PricingRS)

string

String

status

Antequera

title

Yes

no

contact/postal_code

title: Contact

Contact postalCode (mandatory for low cost, check the flag 'need_address' in PricingRS)

string

String

status

29200

title

Yes

nocountry title: Contact

contact/country

Contact country (mandatory for low cost, check the flag 'need_address' in PricingRS)

string

String

documents

ES

traveller documents

 Document Type - PP: Passport - NI: National identity document - TR: Resident Card - FF: Frequent Flyer - CE: Census (for Spanish residents) - DL: Driving license (for rental car bookings) - OB: On Business

[ PP, NI, TR, FF, CE, DL, OB ]

Status
colourRed
titleyes

number Document Number.

[string]

Status
colourRed
titleyes

city  Municipality of residence. Mandatory for resident discount.

[string]

Status
titleno

country Document emission country.

[string]

Status
titleno

nationality Document nationality

[string]

Status
titleno

issue_date document issue date

($date-time)

Status
titleno

expiry_date expiration document date

($date-time)

Status
titleno

validated Indicates if the document was validated by the provider. Used by residents, validation S.A.R.A.

[string]

Status
titleno

responsibles

Person in charge of the traveler

PersonInCharge

Location title: IATA or ID location for pick-up or drSpecialServiceQueryop-off.

string

Status
titleno

name title: Contact's full name.

string

Status
titleno

address title: Contact's address.

string

Status
titleno

phone title: Contact's phone.

string

Status
titleno

origin_destination_ref title: OriginDestination references for person in charge

integer

Status
titleno

Special services

Yes

query/ancillaries

Array[Object]

No

ancillaries/pax_references

Passenger references for supplement

Array[String]

0

No

ancillaries/id

ID

String

6c634561f833f0d-0LttLxyo

No

ancillaries/seg_references

Segment references for supplement

Array[String]

VY306920221114

No

query/seats

No

seats/row

Seat row

Integer

17

No

seats/column

Seat column

String

D

No

seats/segment

Seat segment

String

1

No

seats/pax

Seat pax

String

0

No

query/fees

Array[Object]

No

fees/pax_type

Passenger Type Code

ADT

No

fees/amount_markup

Amount markup

Double

0

No

fees/amount_emission_fee

Amount emission

Double

0

No

fees/amount

Passenger Booking Fee amount

Double

9

No

query/special_services

Request for special needs. (Blind, Service Animal, Wheelchair...

SpecialServiceQuery

) [ONLY NDC]

Status
titleno

Array[Object]

No

special_services/pax_reference

Passenger Reference to apply

.

string

String

status

category title: SSR category code.

string

Status
titleno

more_info More information if is required by de SSR

string

Status
titleno

T1

titleno

No

special_services/category

SSR category code

String

DEAF

No

query/large_family_discount

LargeFamilyDiscountQuery

type* title: F1 (General Discount - 3 children) | F2 (Special Discount - More than 3 children).Enum:

[ F1, F2 ]

Status
colourRed
titleyes

document* Docunent number for large family discount.

string

Status
colourRed
titleyes

location* title: Location

No

large_family_discount/location

Location code to apply the large family discount

.

string
sample

notes

Notes for booking

In Amadeus this notes convert into RM in RP

[...]

Status
titleno

String

  • 410917 ANDALUCIA

  • 471868 CASTILLA LEON

  • 330447 ASTURIAS

  • 060830 EXTRAMADURA

  • 502973 ARAGON

  • 451685 CASTILLA LA MANCHA

  • 150780 GALICIA

  • 462508 VALENCIA

  • 390759 CANTABRIA

  • 300308 MURCIA

  • 010590 PAIS VASCO

  • 260892 LA RIOJA

  • 312016 NAVARRA

  • 070407 ISLAS BALEARES

  • 080193 CATALUNA

  • 380380 CANARIAS

  • 280796 MADRID

  • 510013 CEUTA

  • 520018 MELILLA

Status
colourRed
titleyes

No

large_family_discount/document

Docunent number for large family discount

String

380380

No

large_family_discount/type

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

String

  • F1

  • F2

No

query/dynamic_parameters

Specific data requested by provider to finish booking

Array[

ONLY TRAVELFUSION

DynamicParameterQuery

Object]

Status
titleno

dynamic_parameters/key

string

Key

status

String

titleno

No

dynamic_parameters/value

string

Value

status

String

title

No

no

query/target

target  

Set request target: test|production

[ test, prod ]

Status
titleno

payment : Type of payment.

type

integer

  • 1: credit

  • 2: transfer

  • 3: deposit

  • 4: uatp / card

  • 5: cash

  • 8: picard

  • 11: voucher
    Please, keep in mind which payment options you have availables.

Status
titleno

card_apply title: Payment by card to all or only lowcost. ["ALL", "LC"] by default "LC"

string

Status
titleno

cash : If payment cash true.

boolean

Status
titleno

card

card type

card_type : Credit card type code Please, check the card types returned by pricing method.

If no types are returned, you can user

["VI" | "CA" | "AX" | "DC"]

Status
titleno

category : Debit or credit card.

("CREDITCARD | DEBITCARD")

Status
titleno

number  Credit card number

string

Status
titleno

holder : Credit card holder complete name.

string

Status
titleno

expire_month Credit card month as string of 2 digits.

string

Status
titleno

expire_year  Credit card year as string of 4 digits.

string

Status
titleno

cvv Credit card security code

string

Status
titleno

id_v_card Credit card id virtualCard.

string

Status
titleno

voucher special form of payment credit voucher to pay tickets

Status
titleno

type  Type of the voucher.

The type is given by the provider.

string

Status
titleno

number* : Number or identifier of the voucher to pay
example: BON1000EUR

string

Status
colourRed
titleyes

mail : Email register with the voucher

string

Status
titleno

url : URL for external verification payment

string

Status
titleno

expedient_number : Expedient number.

string

Status
titleno

quote_number

string

Status
titleno

crm : Crm id.

string

Status
titleno

confirm  

Enum

  • test

  • prod

No

query/expedient_number

Expedient number

String

No

query/expedient

Expedient

String

123

No

query/quote_number

Quote number

String

321

No

query/crm

Crm id

String

422112725

No

query/confirm

Flag to confirm or not confirm (emit) in booking transaction.

Only available for Renfe bookings.
Renfe: true by default
If (not confirm and the travel allows booking in 2 steps) => return booking without confirm (status=RSVD)
If (confirm) => return booking confirmed (status=CNFD)

 boolean

Bool

status

  • True

title

  • False

no

No

query/cancel_if_not_docs

: Flag

Flag to cancel or not when external docs for the booking are not gotten

Bool

  • True

  • False

No

query/corportate_code

Currently, only available for Renfe bookings, when ticket on pdf format are not achieved.
Default value: false
If (unable-to-get-docs and cancelIfNotDocs) then the booking is cancelled.
If (unable-to-get-docs and not cancelIfNotDocs) then the booking is returned

Bool

  • True

  • False

No

query/delegation

Corporate code.

boolean

Status
titleno

delegation

title: [OPTIONAL] Source_Id of delegation

string

Statustitleno

Necesita activación por parte de LLeego

Object

delegation/id

ID

Integer

x

No

delegation/code_account

Code_account

String

x

No

query/notes

Add remarks in booking

Array[Object]

No

notes/description

Message to add as remark

String

AVEDES-R

Yes

notes/type

Remark type (RM|RC), by default RM

String

  • RM

  • RC

No

notes/mode

Remark mode type '*' or PRIORITY, when PRIORITY is received, base is mandatory and this value will be set instance of the configuration one.

String

  • *

  • PRIORITY

No

notes/base

Remark name or structure, only use when mode PRIORITY is received

String

AVEDES

No

Time Limit (contacta con tu key account para el uso de estas opciones)

Estas opciones permiten al momento de crear la reserva, indicar el tiempo límite de emisión deseado por parte del cliente.

Solo se aplicará si el tiempo límite deseado es más restrictivo que el ofrecido por el proveedor.

Dicho de otra manera, si el proveedor informa de un Tiempo Límite más restrictivo, se respetará ese.

query/time_limit

Fecha en formato YYYY-MM-DD HH:II:SS

Ejemplo: 2024-01-01 23:30:00

DateTime

No

query/time_limit_type

Solo aplicable a Amadeus.

String

TL|XL

No