...
Description
...
format
...
mandatory
...
title: Element index on client system.
...
BookingQuery
...
token : request token
example: 52e6e452090b
...
| Status | ||||
|---|---|---|---|---|
|
...
SolutionQuery
...
solutionid : solution selected to book
...
string
title: Solution identifier.
...
| Status | ||||
|---|---|---|---|---|
|
...
journeys: list of journeys into solution id
...
string
example: IB210020190820]
...
| Status | ||||
|---|---|---|---|---|
|
...
element_no
...
title: Element index on client system.
...
| Status | ||
|---|---|---|
|
...
holder
...
title : traveller title
...
[ Mr, Mrs, Ms, Miss ]
...
| Status | ||||
|---|---|---|---|---|
|
...
name: traveller name
...
Example : Miguel
...
| Status | ||||
|---|---|---|---|---|
|
...
surnemes: traveller surnames
...
Example : perezun
...
| Status | ||||
|---|---|---|---|---|
|
...
contact
...
type Contact data type, Passenger or Emergency
...
[string]
...
| Status | ||||
|---|---|---|---|---|
|
...
name Contact name (Emergency)
...
[string]
...
| Status | ||
|---|---|---|
|
...
surnames Contact surname (Emergency)
...
[string]
...
| Status | ||
|---|---|---|
|
...
mails List of contact mails.
...
[string]
...
| Status | ||
|---|---|---|
|
...
List of contact phones.
...
phones title: List of contact phones
...
[string]
...
Telephone
...
country_pref
...
[0034]
...
| Status | ||
|---|---|---|
|
...
number
...
[649540022]
...
| Status | ||
|---|---|---|
|
...
address Contact address (mandatory for low cost, check the flag 'need_address' in PricingRS
...
[string]
...
| Status | ||
|---|---|---|
|
...
city Contact city (mandatory for low cost, check the flag 'need_address' in PricingRS)
...
[string]
...
| Status | ||
|---|---|---|
|
...
postal_codes postalCode (mandatory for low cost, check the flag 'need_address' in PricingRS)
...
[string]
...
| Status | ||
|---|---|---|
|
...
country Contact country (mandatory for low cost, check the flag 'need_address' in PricingRS)
...
[string]
...
| Status | ||
|---|---|---|
|
...
travellers
...
Travellers data Travellers data.
...
Traveller
...
code Traveller id
...
[string]
...
| Status | ||||
|---|---|---|---|---|
|
...
type traveller type
...
[ADT, CHD, INF]
...
| Status | ||||
|---|---|---|---|---|
|
...
gender traveller gender
...
[ Male, Female ]
...
| Status | ||||
|---|---|---|---|---|
|
...
title traveller title
...
[ Mr, Mrs, Ms, Miss ]
...
| Status | ||||
|---|---|---|---|---|
|
...
name traveller name
...
"testina"
...
| Status | ||||
|---|---|---|---|---|
|
...
surname traveller surname
...
example ["test"],
...
| Status | ||||
|---|---|---|---|---|
|
...
birth_date only mandatory for child and infant
...
"1992-05-11",
...
| Status | ||
|---|---|---|
|
...
contact
...
| Status | ||||
|---|---|---|---|---|
|
...
type Contact data type, Passenger or Emergency
...
[string]
...
| Status | ||||
|---|---|---|---|---|
|
...
name Contact name (Emergency)
...
[string]
...
| Status | ||
|---|---|---|
|
...
surnames Contact surname (Emergency)
...
[string]
...
| Status | ||
|---|---|---|
|
...
traveller documents
...
🔹 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] |
| 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 | String | Mr | Yes |
travellers/name | Traveller Name | String | Pepe | Yes |
travellers/documents | Array[Object] | |||
documents/type | 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, OB ]
| Status | ||||
|---|---|---|---|---|
|
number Document Number.
[string]
| Status | ||||
|---|---|---|---|---|
|
city Municipality of residence. Mandatory for resident discount.
[string]
| Status | ||
|---|---|---|
|
country Document emission country.
[string]
| Status | ||
|---|---|---|
|
nationality Document nationality
[string]
| Status | ||
|---|---|---|
|
issue_date document issue date
($date-time)
| Status | ||
|---|---|---|
|
expiry_date expiration document date
($date-time)
| Status | ||
|---|---|---|
|
validated Indicates if the document was validated by the provider. Used by residents, validation S.A.R.A.
[string]
| Status | ||
|---|---|---|
|
responsabilities
person in charge of traveller
responsibles :person in charge of travelers used by UNMR unaccompanied minors travelling alone
PersonInCharge
Enum |
| 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 |
LHR |
| Status | ||
|---|---|---|
|
No | |
responsibles/name | Contact's full name |
String |
Pepa |
No |
responsibles/address |
Contact's address |
[string]
| Status | ||
|---|---|---|
|
String | c/ de la llegada | No |
responsibles/phones | Contact's phone |
String |
711223344 |
No |
responsibles/origin_destination_ref | OriginDestination references for person in charge |
Integer |
0 |
No |
travellers/surnames |
fees
Booking Fees by traveller type.
FeeQuery
pax_type Passenger Type Code.
[ADT,CHD,INF]
| Status | ||||
|---|---|---|---|---|
|
amount
number ($double)
| Status | ||||
|---|---|---|---|---|
|
amount_markup integer
[string]
| Status | ||
|---|---|---|
|
ancilliaries
TransportSupplement
id
[string]
| Status | ||
|---|---|---|
|
short_name
[string] example: BUSINESS
| Status | ||
|---|---|---|
|
long_name
[string] example: Business Flexible
| Status | ||
|---|---|---|
|
source_i_d Supplement identification
number($double)
| Status | ||
|---|---|---|
|
extensions
?
base title: Price of the service without fees.
number($double)
| Status | ||
|---|---|---|
|
fee title: Supplement fee
number($double)
price title: Supplement total price, base + fee
number($double)
| Status | ||
|---|---|---|
|
total title: Supplement total price
number($double)
| Status | ||
|---|---|---|
|
included title: Is supplement included?
boolean
| Status | ||
|---|---|---|
|
mandatory title: Is supplement mandatory?
boolean
| Status | ||
|---|---|---|
|
selected title: Is supplement selected?
boolean
| Status | ||
|---|---|---|
|
direct_payment title: Has supplement direct payment
string
| Status | ||
|---|---|---|
|
category title: Supplement category.
string
pattern quantity integer
| Status | ||
|---|---|---|
|
units Number of unitis by unitQualifier
integer
| Status | ||
|---|---|---|
|
unit_qualifier Unit type
string
| Status | ||
|---|---|---|
|
status connector i_d refundable
string
| Status | ||
|---|---|---|
|
distribution Wich distribution apply for
string
| Status | ||
|---|---|---|
|
value Supplement identify
string
| Status | ||
|---|---|---|
|
pax_reference
Passenger references for supplement
string
seg_reference
| Status | ||
|---|---|---|
|
Segment references for supplement
string
journey_reference
| Status | ||
|---|---|---|
|
Journey references for supplement
string
selection How many supplements of this type could be selected together?
[one | multiple]
| Status | ||
|---|---|---|
|
seat_preference
TransportSeat
id
string
| Status | ||
|---|---|---|
|
short_name example: BUSINESS
string
| Status | ||
|---|---|---|
|
long_name example: Business Flexible
string
| Status | ||
|---|---|---|
|
extensions
example: BUSINESS
| Status | ||
|---|---|---|
|
situation : Situation type (aisle or window)
string
(aisle or window)
| Status | ||
|---|---|---|
|
direction : Direction of pax regard to running
string
| Status | ||
|---|---|---|
|
emergency_contact
traveller
code title: Traveller id
string
| Status | ||
|---|---|---|
|
type : Traveller type [ADT, CHD, INF]
string
| Status | ||
|---|---|---|
|
gender Traveller genterEnum
[ Male, Female ]
| Status | ||
|---|---|---|
|
title Traveller title.
| Status | ||
|---|---|---|
|
name Traveller Name
string
| Status | ||
|---|---|---|
|
birth_date Traveller birth date [Require for children and infants]
string
($date-time)
| Status | ||
|---|---|---|
|
contact
type title: Contact data type, Passenger or Emergency
string
| Status | ||
|---|---|---|
|
name title: Contact name (Emergency)
string
| Status | ||
|---|---|---|
|
surnames title: Contact surname (Emergency)
string
| Status | ||
|---|---|---|
|
mails List of contact mails.
title: List of contact mails.
[string]
| Status | ||
|---|---|---|
|
phones List of contact phones.[
title: List of contact phones.Telephone
{...}]
| Status | ||
|---|---|---|
|
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 | Emergency | No |
contact/name | Contact name (Emergency) | String | Pepe | No |
contact/surnames | Contact surname (Emergency) | 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.
| Integer |
| No |
payment/cash | If payment cash true | Bool |
| No |
payment/card | Object | |||
card/form | Dynamic, Internal form (for avoris) | String | Null | No |
card/category | Debit or credit card. ("CREDITCARD | DEBITCARD") | String |
| 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 | 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] | 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 | ||
|---|---|---|
|
String | c/ de la alegria | Yes |
contact/city | Contact city (mandatory for low cost, check the flag 'need_address' in PricingRS) |
String |
Antequera |
Yes |
contact/postal_code |
Contact postalCode (mandatory for low cost, check the flag 'need_address' in PricingRS) |
String |
29200 |
Yes |
contact/country | Contact country |
(mandatory for low cost, check the flag 'need_address' in PricingRS) |
String |
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 | ||||
|---|---|---|---|---|
|
number Document Number.
[string]
| Status | ||||
|---|---|---|---|---|
|
city Municipality of residence. Mandatory for resident discount.
[string]
| Status | ||
|---|---|---|
|
country Document emission country.
[string]
| Status | ||
|---|---|---|
|
nationality Document nationality
[string]
| Status | ||
|---|---|---|
|
issue_date document issue date
($date-time)
| Status | ||
|---|---|---|
|
expiry_date expiration document date
($date-time)
| Status | ||
|---|---|---|
|
validated Indicates if the document was validated by the provider. Used by residents, validation S.A.R.A.
[string]
| Status | ||
|---|---|---|
|
responsibles
Person in charge of the traveler
PersonInCharge
Location title: IATA or ID location for pick-up or drSpecialServiceQueryop-off.
string
| Status | ||
|---|---|---|
|
name title: Contact's full name.
string
| Status | ||
|---|---|---|
|
address title: Contact's address.
string
| Status | ||
|---|---|---|
|
phone title: Contact's phone.
string
| Status | ||
|---|---|---|
|
origin_destination_ref title: OriginDestination references for person in charge
integer
| Status | ||
|---|---|---|
|
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 | ||
|---|---|---|
|
Array[Object] | No | |
special_services/pax_reference | Passenger Reference to apply |
String |
T1 |
| title | no |
|---|
category title: SSR category code.
string
| Status | ||
|---|---|---|
|
more_info More information if is required by de SSR
string
| Status | ||
|---|---|---|
|
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:
| Status | ||||
|---|---|---|---|---|
|
document* Docunent number for large family discount.
string
| Status | ||||
|---|---|---|---|---|
|
No | |||
large_family_discount/location | Location code to apply the large family discount |
sample
notes
In Amadeus this notes convert into RM in RP
[...]
| Status | ||
|---|---|---|
|
String |
|
| Status | ||||
|---|---|---|---|---|
|
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 |
| No |
query/dynamic_parameters | Specific data requested by provider to finish booking | Array[ |
DynamicParameterQuery
Object] |
| Status | ||
|---|---|---|
|
dynamic_parameters/key |
Key |
String |
| title | no |
|---|
No | |
dynamic_parameters/value |
Value |
String |
No |
query/target |
Set request target: test|production |
[ test, prod ]
| Status | ||
|---|---|---|
|
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 | ||
|---|---|---|
|
card_apply title: Payment by card to all or only lowcost. ["ALL", "LC"] by default "LC"
string
| Status | ||
|---|---|---|
|
cash : If payment cash true.
boolean
| Status | ||
|---|---|---|
|
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
| Status | ||
|---|---|---|
|
category : Debit or credit card.
| Status | ||
|---|---|---|
|
number Credit card number
string
| Status | ||
|---|---|---|
|
holder : Credit card holder complete name.
string
| Status | ||
|---|---|---|
|
expire_month Credit card month as string of 2 digits.
string
| Status | ||
|---|---|---|
|
expire_year Credit card year as string of 4 digits.
string
| Status | ||
|---|---|---|
|
cvv Credit card security code
string
| Status | ||
|---|---|---|
|
id_v_card Credit card id virtualCard.
string
| Status | ||
|---|---|---|
|
voucher special form of payment credit voucher to pay tickets
| Status | ||
|---|---|---|
|
type Type of the voucher.
The type is given by the provider.
string
| Status | ||
|---|---|---|
|
number* : Number or identifier of the voucher to pay
example: BON1000EUR
string
| Status | ||||
|---|---|---|---|---|
|
mail : Email register with the voucher
string
| Status | ||
|---|---|---|
|
url : URL for external verification payment
string
| Status | ||
|---|---|---|
|
expedient_number : Expedient number.
string
| Status | ||
|---|---|---|
|
quote_number
| Status | ||
|---|---|---|
|
crm : Crm id.
string
| Status | ||
|---|---|---|
|
Enum |
| No | ||
query/expedient_number | Expedient number | String | No | |
query/expedient | Expedient | String | No | |
query/quote_number | Quote number | String | No | |
query/crm | Crm id | String | No | |
query/confirm | Flag to confirm or not confirm (emit) in booking transaction. Only available for Renfe bookings. |
Bool |
|
|
No |
query/cancel_if_not_docs |
Flag to cancel or not when external docs for the booking are not gotten |
Bool |
|
|
delegation
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
No | ||||
query/corportate_code | Currently, only available for Renfe bookings, when ticket on pdf format are not achieved. | Bool |
| No |
query/delegation | Corporate code | Object | ||
delegation/id | ID | Integer | No | |
delegation/code_account | Code_account | String | No |