POST/v1/flights/order/required-fields/:gdsprovider/:offerId

Consultar campos requeridos para reservar vuelo

Devuelve los campos dinámicos de pasajero, documentos e identidad necesarios para completar la reserva de una oferta de vuelo seleccionada.

POST/v1/flights/order/required-fields/:gdsprovider/:offerId

Consola API

Pruébalo

Envía una petición real al entorno sandbox e inspecciona la respuesta.

Credenciales

Profile code

Public key

Secret key

Inicia sesión para elegir entre tus API keys guardadas en vez de pegarlas.

Parámetros de ruta

2 campos

gdsproviderenumObligatorio

Proveedor GDS

Sistema de distribución global usado para obtener contenido de vuelos. Selecciona 0 para el proveedor predeterminado.

offerIdstringObligatorio

ID de oferta

Identificador de la oferta devuelta por una búsqueda de vuelos anterior.

Cuerpo de la petición

{
  "offerId": "off_0000B7VCW4q5OD5G49hmKn",
  "passengers": [
    {
      "type": "adult"
    }
  ]
}

Petición cURL

cURL

bash

curl -X POST 'https://api.sandbox.travelandz.com/v1/flights/order/required-fields/0/:offerId' \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'X-Travelandz-Id: YOUR_PUBLIC_KEY:YOUR_PROFILE_CODE' \
  -H 'Content-Type: application/json' \
  -d '{"offerId":"off_0000B7VCW4q5OD5G49hmKn","passengers":[{"type":"adult"}]}'

Añade tus credenciales para enviar una petición.

Respuesta

Pulsa «¡Pruébalo!» para enviar una petición y ver la respuesta aquí.

Devuelve los campos dinámicos de pasajero, documentos e identidad necesarios para completar la reserva de una oferta de vuelo seleccionada.

Endpoint

Método	Ruta	Auth
`POST`	`/v1/flights/order/required-fields/:gdsprovider/:offerId`	API key requerida

Headers obligatorios:

Header	Descripción
`Authorization`	`Bearer <secret_key>`. El secret se muestra una sola vez al crear la credencial.
`X-Travelandz-Id`	`<public_key>:<profile_code>`. El `profile_code` es el codigo de Developer Profile con prefijo `dp_` que ves en el dashboard. Esto vincula la peticion con un perfil y una credencial.
`Content-Type`	Usa `application/json` para peticiones con cuerpo.

Esquema de parámetros de la petición

gdsprovider

numberSí

Valores aceptados: 0, 1

offerId

stringSí

Esquema del cuerpo de la petición

offerId

stringSí

Id de la oferta seleccionada

passengers

arraySí

passengers[]type

enum

adultchildinfant_without_seat

Sí

Respuesta exitosa

Devuelve required field definitions for the offer.

Esquema del cuerpo de la respuesta

holder

objectSí

holderphone

booleanSí

Cuando sea true, envia passengers[0].phone_number en formato E.164 para flujos que consumen datos de contacto del titular

holderemail

booleanSí

Cuando sea true, envia passengers[0].email para flujos que consumen email del titular

holdercountryCode

booleanSí

No existe un campo separado en create-order. En flujos gdsprovider=1 se deriva de passengers[0].phone_number en formato E.164

passengers

arraySí

passengers[]idx

numberSí

Indice del pasajero en la respuesta de required-fields

passengers[]title

booleanSí

Mapea a passengers[].title

passengers[]type

booleanSí

Mapea a passengers[].type

passengers[]name

booleanSí

Mapea a passengers[].firstName

passengers[]lastName

booleanSí

Mapea a passengers[].lastName

passengers[]age

booleanSí

Solo informativo. No existe campo directo en create-order y actualmente es false en flujos publicos de vuelos

passengers[]nationality

booleanSí

Cuando sea true, mapea a passengers[].country

passengers[]gender

booleanSí

Mapea a passengers[].gender

passengers[]phone

booleanSí

Cuando sea true, mapea a passengers[].phone_number

passengers[]email

booleanSí

Cuando sea true, mapea a passengers[].email. Algunos flujos gdsprovider=1 solo consumen el email del primer pasajero

passengers[]address

booleanSí

Solo informativo. No existe campo directo en create-order y actualmente es false en flujos publicos de vuelos

passengers[]city

booleanSí

Solo informativo. No existe campo directo en create-order y actualmente es false en flujos publicos de vuelos

passengers[]postalCode

booleanSí

Solo informativo. No existe campo directo en create-order y actualmente es false en flujos publicos de vuelos

passengers[]bornDate

booleanSí

Cuando sea true, mapea a passengers[].bornDate

passengers[]documentIdentifier

booleanSí

Cuando sea true, mapea a passengers[].identity_documents[].unique_identifier

passengers[]documentType

booleanSí

Cuando sea true, mapea a passengers[].identity_documents[].type cuando se usa un objeto de documento

passengers[]documentIssuedAt

booleanSí

Solo informativo. No existe campo directo en create-order y actualmente es false en flujos publicos de vuelos

passengers[]documentExpiresAt

booleanSí

Cuando sea true, mapea a passengers[].identity_documents[].expires_on

passengers[]documentCountryCode

booleanSí

Cuando sea true, mapea a passengers[].identity_documents[].issuing_country_code

passengers[]allowedDocuments

arrayNulable

Valores permitidos para el flujo de documentos de reserva: passport, tax_id, known_traveler_number, passenger_redress_number, dni. Si dni esta permitido, tambien recoge passengers[].NationalID porque la respuesta actual no expone un flag dedicado nationalId

liveMode

booleanSí

True cuando la peticion se sirve desde el entorno live de Travelandz. Este valor viene de Travelandz, no del payload del proveedor.

Notas operativas

Prefiere este endpoint POST porque acepta contexto de pasajeros en el cuerpo de la peticion.
GET /v1/flights/order/required-fields/:gdsprovider/:offerId existe por compatibilidad, pero las integraciones deberian usar POST.
El contrato real de respuesta es holder mas passengers[]; no es un wrapper requiredFields[].
Usa la respuesta para decidir si antes de reservar debes recoger identity_documents, NationalID, nacionalidad o vencimiento de documento.
allowedDocuments limita los valores validos de passengers[].identity_documents[].type. Si incluye dni, recoge tambien passengers[].NationalID, aunque la respuesta actual no exponga un boolean dedicado nationalId.
En flujos gdsprovider=1, holder.countryCode no corresponde a un campo separado de reserva. Se satisface con passengers[0].phone_number en formato E.164.
En flujos gdsprovider=1, passengers[].email puede aparecer como requerido aunque solo el email del primer pasajero se consuma como email del titular.

Ejemplo

bash

curl -X POST https://api.sandbox.travelandz.com/v1/flights/order/required-fields/0/offer_123 \
  -H "Authorization: Bearer $TRAVELANDZ_SECRET_KEY" \
  -H "X-Travelandz-Id: $TRAVELANDZ_PUBLIC_KEY:$TRAVELANDZ_PROFILE_CODE" \
  -H "Content-Type: application/json" \
  -d '{"offerId":"offer_123","passengers":[{"type":"adult"}]}'

Cuerpo de la petición - Ejemplo

json

{
  "offerId": "off_0000B7VCW4q5OD5G49hmKn",
  "passengers": [
    {
      "type": "adult"
    }
  ]
}

Respuestas

Código	Descripción
`200`	Campos requeridos de reserva resueltos correctamente.
`400`	Solicitud inválida: payload no válido.
`401`	No autorizado: credenciales inválidas o ausentes.
`403`	Prohibido: credenciales inválidas.
`500`	Error interno del servidor

200 Cuerpo de la respuesta

Tipo de contenido: application/json

json

{
  "holder": {
    "phone": false,
    "email": false,
    "countryCode": false
  },
  "passengers": [
    {
      "idx": 0,
      "title": true,
      "type": true,
      "name": true,
      "lastName": true,
      "age": false,
      "nationality": false,
      "gender": true,
      "phone": true,
      "email": true,
      "address": false,
      "city": false,
      "postalCode": false,
      "bornDate": true,
      "documentIdentifier": false,
      "documentType": false,
      "documentIssuedAt": false,
      "documentExpiresAt": false,
      "documentCountryCode": false,
      "allowedDocuments": null
    }
  ],
  "liveMode": false
}