Description | format | mandatory |
title: Element index on client system. | BookingQuery | |
token : request token | example: 52e6e452090b | YES |
SolutionQuery | ||
solutionid : solution selected to book | string | YES |
journeys: list of journeys into solution id | string | YES |
element_no | title: Element index on client system. | NO |
holder | ||
title : traveller title | [ Mr, Mrs, Ms, Miss ] | YES |
name: traveller name | Example : Miguel | YES |
surnemes: traveller surnames | Example : perezun | YES |
contact | ||
type Contact data type, Passenger or Emergency | [string] | YES |
name Contact name (Emergency) | [string] | NO |
surnames Contact surname (Emergency) | [string] | NO |
| ||
mails List of contact mails. | [string] | NO |
List of contact phones. | ||
phones title: List of contact phones | [string] | |
Telephone | ||
country_pref | [0034] | NO |
number | [649540022] | NO |
address Contact address (mandatory for low cost, check the flag 'need_address' in PricingRS | [string] | NO |
city Contact city (mandatory for low cost, check the flag 'need_address' in PricingRS) | [string] | NO |
postal_codes postalCode (mandatory for low cost, check the flag 'need_address' in PricingRS) | [string] | NO |
country Contact country (mandatory for low cost, check the flag 'need_address' in PricingRS) | [string] | NO |
travellers | ||
Travellers data Travellers data. | ||
Traveller | ||
code Traveller id | [string] | YES |
type traveller type | [ADT, CHD, INF] | YES |
gender traveller gender | [ Male, Female ] | YES |
title traveller title | [ Mr, Mrs, Ms, Miss ] | YES |
name traveller name | "testina" | YES |
surname traveller surname | example ["test"], | YES |
birth_date only mandatory for child and infant | "1992-05-11", | NO |
contact | YES | |
type Contact data type, Passenger or Emergency | [string] | YES |
name Contact name (Emergency) | [string] | NO |
surnames Contact surname (Emergency) | [string] | NO |
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 ] | YES |
number Document Number. | [string] | YES |
city Municipality of residence. Mandatory for resident discount. | [string] | NO |
country Document emission country. | [string] | NO |
nationality Document nationality | [string] | NO |
issue_date document issue date | ($date-time) | NO |
expiry_date expiration document date | ($date-time) | NO |
validated Indicates if the document was validated by the provider. Used by residents, validation S.A.R.A. | [string] | NO |
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] | NO |
name Contact's full name. | [string] | NO |
address Contact's address. | [string] | NO |
phone Contact's phone. | [string] | NO |
origin_destination_ref OriginDestination references for person in charge | [string] | NO |
fees | ||
Booking Fees by traveller type. | ||
FeeQuery | ||
pax_type Passenger Type Code. | [ADT,CHD,INF] | YES |
amount | number ($double) | YES |
amount_markup integer | [string] | NO |
ancilliaries | ||
| ||
TransportSupplement | ||
id | [string] | NO |
short_name | [string] example: BUSINESS | NO |
long_name | [string] example: Business Flexible | NO |
source_i_d Supplement identification | number($double) | NO |
extensions | ? | |
base title: Price of the service without fees. | number($double) | NO |
fee title: Supplement fee | number($double) | |
price title: Supplement total price, base + fee | number($double) | NO |
total title: Supplement total price | number($double) | NO |
included title: Is supplement included? | boolean | NO |
mandatory title: Is supplement mandatory? | boolean | NO |
selected title: Is supplement selected? | boolean | NO |
direct_payment title: Has supplement direct payment | string | NO |
category title: Supplement category. | string | |
pattern quantity integer |
| NO |
units Number of unitis by unitQualifier | integer | NO |
unit_qualifier Unit type | string | NO |
status connector i_d refundable | string | NO |
distribution Wich distribution apply for | string | NO |
value Supplement identify | string | NO |
pax_reference | ||
Passenger references for supplement | string | |
seg_reference | NO | |
Segment references for supplement | string | |
journey_reference | NO | |
Journey references for supplement | string | |
selection How many supplements of this type could be selected together? | [one | multiple] | NO |
seat_preference | ||
TransportSeat | ||
id | string | NO |
short_name example: BUSINESS | string | NO |
long_name example: Business Flexible | string | NO |
extensions | example: BUSINESS | NO |
situation : Situation type (aisle or window) | string (aisle or window) | NO |
direction : Direction of pax regard to running | string | NO |
emergency_contact | ||
traveller | ||
code title: Traveller id | string | NO |
type : Traveller type [ADT, CHD, INF] | string | NO |
gender Traveller genterEnum | [ Male, Female ] | NO |
title Traveller title. |
| NO |
name Traveller Name | string | NO |
birth_date Traveller birth date [Require for children and infants] | string ($date-time) | NO |
contact | ||
type title: Contact data type, Passenger or Emergency | string | NO |
name title: Contact name (Emergency) | string | NO |
surnames title: Contact surname (Emergency) | string | NO |
mails List of contact mails. | [string] | NO |
phones List of contact phones.[ | {...}] | NO |
address title: Contact address (mandatory for low cost, check the flag 'need_address' in PricingRS) | string | NO |
city title: Contact city (mandatory for low cost, check the flag 'need_address' in PricingRS) | string | NO |
postal_code title: Contact postalCode (mandatory for low cost, check the flag 'need_address' in PricingRS) | string | NO |
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) - OB: On Business | [ PP, NI, TR, FF, CE, DL, OB ] | YES |
number Document Number. | [string] | YES |
city Municipality of residence. Mandatory for resident discount. | [string] | NO |
country Document emission country. | [string] | NO |
nationality Document nationality | [string] | NO |
issue_date document issue date | ($date-time) | NO |
expiry_date expiration document date | ($date-time) | NO |
validated Indicates if the document was validated by the provider. Used by residents, validation S.A.R.A. | [string] | NO |
responsibles | ||
Person in charge of the traveler | ||
PersonInCharge | ||
Location title: IATA or ID location for pick-up or drSpecialServiceQueryop-off. | string | NO |
name title: Contact's full name. | string | NO |
address title: Contact's address. | string | NO |
phone title: Contact's phone. | string | NO |
origin_destination_ref title: OriginDestination references for person in charge | integer | NO |
Special services Request for special needs. (Blind, Service Animal, Wheelchair... | [ONLY NDC] | NO |
SpecialServiceQuery | ||
pax_reference Passenger Reference to apply. | string | NO |
category title: SSR category code. | string | NO |
more_info More information if is required by de SSR | string | NO |
large_family_discount | ||
LargeFamilyDiscountQuery | ||
type* title: F1 (General Discount - 3 children) | F2 (Special Discount - More than 3 children).Enum: |
| YES |
document* Docunent number for large family discount. | string | YES |
location* title: Location code to apply the large family discount. | string 410917 ANDALUCIA 471868 CASTILLA LEON | YES |
notes | ||
| ||
In Amadeus this notes convert into RM in RP | [...] | NO |
dynamic_parameters | Specific data requested by provider to finish booking [ONLY TRAVELFUSION] | NO |
DynamicParameterQuery | ||
key | string | NO |
value | string | NO |
target Set request target: test|production | [ test, prod ] | NO |
payment : Type of payment. | ||
type | integer
| NO |
card_apply title: Payment by card to all or only lowcost. ["ALL", "LC"] by default "LC" | string | NO |
cash : If payment cash true. | boolean | NO |
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 |
| NO |
category : Debit or credit card. |
| NO |
number Credit card number | string | NO |
holder : Credit card holder complete name. | string | NO |
expire_month Credit card month as string of 2 digits. | string | NO |
expire_year Credit card year as string of 4 digits. | string | NO |
cvv Credit card security code | string | NO |
id_v_card Credit card id virtualCard. | string | NO |
voucher special form of payment credit voucher to pay tickets | NO | |
type Type of the voucher. The type is given by the provider. | string | NO |
number* : Number or identifier of the voucher to pay | string | YES |
mail : Email register with the voucher | string | NO |
url : URL for external verification payment | string | NO |
expedient_number : Expedient number. | string | NO |
quote_number |
| NO |
crm : Crm id. | string | NO |
confirm Flag to confirm or not confirm (emit) in booking transaction. Only available for Renfe bookings. | boolean | NO |
cancel_if_not_docs : Flag to cancel or not when external docs for the booking are not gotten. | boolean | NO |
delegation Source_Id of delegation Use this parameter to act on behalf of another delegation. | string | NO |
General
Content
Integrations