Booking · Structure RQ

Owned by Oliver Martin
Last updated: Nov 11, 2024 by Maria Vega
3 min read

 

Request Body - Booking

NAME

DESCRIPTION

FORMAT

ALLOWED VALUES

MANDATORY

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)

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

No

responsibles/name

Contact's full name

String

Pepa

No

responsibles/address

Contact's address

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

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.

  • 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

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

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...) [ONLY NDC]

Array[Object]

 

No

special_services/pax_reference

Passenger Reference to apply

String

T1

No

special_services/category

SSR category code

String

DEAF

No

query/large_family_discount

 

 

 

No

large_family_discount/location

Location code to apply the large family discount

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

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[Object]

 

 

dynamic_parameters/key

Key

String

 

No

dynamic_parameters/value

Value

String

 

No

query/target

Set request target: test|production

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)

Bool

  • True

  • False

No

query/cancel_if_not_docs

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