Versions Compared

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 : Miguelname

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


List of contact mails.

no

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

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)

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

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

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

contact

Status
colourRed
titleyes

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

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)

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

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)$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
string
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

stringno

seg_reference

Status
titleno

Segment references for supplement

stringno

journey_reference

Status
titleno

Journey references for supplement

string

no

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 address (mandatory for low cost, check the flag 'need_address' in PricingRS)

string

Status
titleno

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

string

Status
titleno

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

string

Status
titleno

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

string

documents

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)

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

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 Request for special needs. (Blind, Service Animal, Wheelchair...

[ONLY NDC]

Status
titleno

SpecialServiceQuery

pax_reference Passenger Reference to apply.

string

Status
titleno

category title: SSR category code.

string

Status
titleno

more_info More information if is required by de SSR

string

Status
titleno

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 code to apply the large family discount.

string
sample

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

notes


Notes for booking

In Amadeus this notes convert into RM in RP

[...]

Status
titleno

dynamic_parameters

Specific data requested by provider to finish booking [ONLY TRAVELFUSION]

Status
titleno

DynamicParameterQuery

key

string

Status
titleno

value

string

Status
titleno

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

Status
titleno

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

boolean

Status
titleno

delegation

title: [OPTIONAL] Source_Id of delegation

string

Status
titleno