GET/v1/trains/book/:gdsprovider/:bookingId/required-fields

Consultar campos requeridos para trenes

Resuelve los campos de pasajero y titular requeridos para crear una orden.

Compartir

Resuelve los campos de pasajero y titular requeridos para crear una orden.

Autenticación y headers

HeaderDescripción
AuthorizationBearer <secret_key>. Conserva el secret en el servidor y nunca lo escribas en logs del cliente.
X-Travelandz-Id<public_key>:<profile_code>, donde el profile code persistido tiene el formato dp_<12 alfanuméricos>.
Content-Typeapplication/json para peticiones con body JSON.

Petición

Parámetros de path: gdsprovider actualmente es 0; bookingId viene de prebook.

Schema de parámetros

gdsprovider
enum
0
Sí
Currently 0
bookingId
stringSí
Booking id returned by prebook.

Respuesta exitosa

Devuelve flags de holder y passengers[]. Cada boolean indica si el campo correspondiente debe enviarse al crear la orden; idx identifica la posición del pasajero.

Schema de respuesta

holder
objectSí
holderphone
booleanSí
holderemail
booleanSí
holdercountryCode
booleanSí
passengers
arraySí
passengers[]idx
numberSí
passengers[]title
booleanSí
passengers[]type
booleanSí
passengers[]name
booleanSí
passengers[]lastName
booleanSí
passengers[]age
booleanSí
passengers[]nationality
booleanSí
passengers[]gender
booleanSí
passengers[]phone
booleanSí
passengers[]email
booleanSí
passengers[]countryCode
booleanSí
passengers[]address
booleanSí
passengers[]city
booleanSí
passengers[]postalCode
booleanSí
passengers[]bornDate
booleanSí
passengers[]cityOfBirth
booleanSí
passengers[]countryOfBirth
booleanSí
passengers[]documentIdentifier
booleanSí
passengers[]documentType
booleanSí
passengers[]documentIssuedAt
booleanSí
passengers[]documentExpiresAt
booleanSí
passengers[]documentCountryCode
booleanSí
passengers[]allowedDocuments
arraySí
passengers[]allowedDocuments[]
string[]Sí

Errores

  • 400 por validación o campos desconocidos.
  • 401 o 403 por credenciales API inválidas.
  • 500 internal_communication_error o unknown_error por fallos del proveedor.
  • booking_not_found cuando la pre-reserva no existe o expiró.

Notas de uso

Construye el formulario con los campos marcados como true; no asumas que todas las reservas requieren los mismos datos.

Ejemplo cURL

bash
bash
curl --request GET \
  --url "https://api.sandbox.travelandz.com/v1/trains/book/0/booking_123/required-fields" \
  --header "Authorization: Bearer $TRAVELANDZ_SECRET_KEY" \
  --header "X-Travelandz-Id: $TRAVELANDZ_PUBLIC_KEY:$TRAVELANDZ_PROFILE_CODE"