Get required flight booking fields

Returns the dynamic passenger, document and identity fields required to complete booking for a selected flight offer.

Endpoint

Request Params Schema

Request Body Schema

Success Response

Returns required field definitions for the offer.

Response Body Schema

Operational Notes

• Prefer this POST endpoint because it accepts passenger context in the request body.
• GET /v1/flights/order/required-fields/:gdsprovider/:offerId exists for compatibility, but integrations should use POST.
• The real response contract is holder plus passengers[]; it is not a requiredFields[] wrapper.
• Use the response to decide whether identity_documents, NationalID, nationality or document expiration must be collected before booking.
• allowedDocuments limits valid values for passengers[].identity_documents[].type. If it includes dni, also collect passengers[].NationalID even though the current response does not expose a dedicated nationalId boolean.
• In gdsprovider=1 flows, holder.countryCode does not correspond to a separate booking field. It is satisfied by passengers[0].phone_number in E.164 format.
• In gdsprovider=1 flows, passengers[].email can be marked as required even though only the first passenger email may be consumed as the holder email.

Example

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"}]}'

Request Body - Example Value

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

Responses

200 Response Body

Media type: application/json

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