Data Model

Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.

Data Model

Itinerary JSON Example

Itinerary Example

✅ Sample JSON

{
  "pnr": "WSVM7K",
  "externalItineraryId": "38842385",
  "itineraryStatus": "Active",
  "itinerarySource": "TT5 Manual Trip",
  "createdDate": "2022-09-22T08:45:00Z",
  "lastModifiedDate": "2022-09-22T08:45:00Z",
  "extendedInfo": {
    "startDate": "2022-10-22T08:45:00Z",
    "endDate": "2022-10-25T12:00:00Z",
    "diType": "I",
    "bookedBy": "Jim Green",
    "isTicketed": false,
    "reasonDesc": "Business Travel",
    "approver": "Alice Brown",
    "costCenter": "A123",
    "travelAuthCode": "ABCD123456",
    "emailAddresses": [
      "[email protected]"
    ],
    "travelAgencyInfo": {
      "externalAgencyId": 123,
      "agencyName": "Universal Travel Agency",
      "agencyContact": "Tom Miller",
      "agencyEmail": "[email protected]",
      "agencyTel1": "+13317987654",
      "agencyTel2": "+13317987655",
      "gdsName": "Sabre"
    }
  },
  "segments": [
    {
      "type": "Air",
      "supplierCode": "EY",
      "supplierName": "Etihad Airways",
      "airRailNumber": "301",
      "fromDateTimeLocal": "2022-10-22T08:15:00",
      "fromTimeZone": "Asia/Dubai",
      "toDateTimeLocal": "2022-10-23T09:05:00",
      "toTimeZone": "Asia/Kuwait",
      "fromIataCode": "AUH",
      "toIataCode": "KWI",
      "fromAddress": {
        "country": "AE",
        "city": "Abu Dhabi",
        "latitude": 24.432972,
        "longitude": 54.651138
      },
      "toAddress": {
        "country": "KW",
        "city": "Kuwait",
        "latitude": 29.226567,
        "longitude": 47.968928
      },
      "extendedInfo": {
        "externalSegmentId": 232028393,
        "externalSegmentIndex": 0
      }
    },
    {
      "type": "Air",
      "supplierCode": "EY",
      "supplierName": "Etihad Airways",
      "airRailNumber": "301",
      "fromDateTimeLocal": "2022-10-23T09:40:00",
      "fromTimeZone": "Asia/Dubai",
      "toDateTimeLocal": "2022-10-23T15:05:00",
      "toTimeZone": "Asia/Kuwait",
      "fromIataCode": "KWI",
      "toIataCode": "YIA",
      "fromAddress": {
        "country": "KW",
        "city": "Kuwait",
        "latitude": 24.432972,
        "longitude": 54.651138
      },
      "toAddress": {
        "country": "ID",
        "city": "Yogyakarta",
        "latitude": -7.8981411,
        "longitude": 110.0574766
      },
      "extendedInfo": {
        "externalSegmentId": 232028394,
        "externalSegmentIndex": 1
      }
    },
    {
      "type": "Hotel",
      "supplierCode": "HH",
      "supplierName": "Hilton",
      "fromDateTimeLocal": "2022-10-23T17:59:59",
      "fromDateTime": "2022-10-23T21:59:59Z",
      "toDateTimeLocal": "2022-10-23T23:59:00",
      "toDateTime": "2022-10-24T03:59:00Z",
      "fromTimeZone": "America/New_York",
      "toTimeZone": "America/New_York",
      "fromAddress": {
        "locationName": "Hilton New York Fashion District Hotel",
        "country": "US",
        "state": "New York",
        "city": "New York",
        "streetAddress": "152 West 26th Street",
        "postalCode": "10001",
        "latitude": 40.745529,
        "longitude": -73.993713
      },
      "extendedInfo": {
        "externalSegmentId": 232028393,
        "externalSegmentIndex": 0,
        "carHotelExtraInfo": {
          "telephoneNo": "+13729302030",
          "confirmationNo": "729123",
          "rateInfo": "100",
          "currencyCode": "840",
          "chainCode": "am",
          "guestCount": 2,
          "noOfNights": 2,
          "noOfRooms": 1,
          "roomType": "Single room"
        }
      }
    },
    {
      "type": "Rail",
      "supplierCode": "2V",
      "supplierName": "Amtrak",
      "airRailNumber": "42",
      "fromDateTimeLocal": "2022-10-24T13:23:00",
      "fromTimeZone": "Europe/Amsterdam",
      "toDateTimeLocal": "2022-10-24T16:50:00",
      "toTimeZone": "Europe/Amsterdam",
      "fromIataCode": "ZYE",
      "toIataCode": "ZYA",
      "extendedInfo": {
        "externalSegmentId": 23202830,
        "externalSegmentIndex": 0
      }
    },
    {
      "type": "Car",
      "supplierCode": "ET",
      "supplierName": "Enterprise",
      "fromDateTime": "2022-10-25T08:00:00Z",
      "toDateTime": "2022-10-25T11:00:00Z",
      "fromIataCode": "DEN",
      "toIataCode": "DEN",
      "extendedInfo": {
        "externalSegmentId": 232028391,
        "externalSegmentIndex": 0,
        "carHotelExtraInfo": {
          "telephoneNo": "+13729302030",
          "confirmationNo": "729123",
          "rateInfo": "100"
        }
      }
    }
  ],
  "passengers": [
    {
      "contactId": 241901148045320,
      "employeeId": "E001",
      "firstName": "Tom",
      "lastName": "Hans",
      "middleName": "A",
      "emailAddresses": [
        "[email protected]",
        "[email protected]"
      ],
      "phoneNumbers": [
        {
          "phoneNumber": "15712345678",
          "countryName": "CN"
        }
      ],
      "extendedInfo": {
        "externalTravelerId": 10001,
        "isExpat": false,
        "vipStatusCode": "ABC123",
        "jobBand": "GUEST",
        "jobTitle": "Senior Engineer",
        "clusterTag": "Engineering",
        "emergencyContacts": [
          {
            "externalNextOfKinId": "1001",
            "relationship": "partner",
            "firstName": "Alice",
            "lastName": "Hans",
            "telHome": "+15712345678",
            "telWork": "+15712345677",
            "telCell": "+15712345676",
            "emailAddress": "[email protected]",
            "address": "4260 Mitchell Way"
          }
        ]
      }
    }
  ],
  "travelArranger": {
    "contactId": 241901148045321,
    "employeeId": "E002",
    "firstName": "Mike",
    "lastName": "Smith",
    "middleName": "A",
    "emailAddresses": [
      "[email protected]",
      "[email protected]"
    ],
    "phoneNumbers": [
      {
        "phoneNumber": "15712348765",
        "countryName": "CN"
      }
    ]
  }
}

Air Segment JSON Example

Air Segment Example

✅ Sample JSON

{
  "type": "Air",
  "supplierCode": "EY",
  "supplierName": "Etihad Airways",
  "airRailNumber": "301",
  "fromDateTimeLocal": "2022-10-23T09:40:00",
  "fromTimeZone": "Asia/Dubai",
  "toDateTimeLocal": "2022-10-23T15:05:00",
  "toTimeZone": "Asia/Kuwait",
  "fromIataCode": "KWI",
  "toIataCode": "YIA",
  "fromAddress": {
    "country": "KW",
    "city": "Kuwait",
    "latitude": 24.432972,
    "longitude": 54.651138
  },
  "toAddress": {
    "country": "ID",
    "city": "Yogyakarta",
    "latitude": -7.8981411,
    "longitude": 110.0574766
  },
  "extendedInfo": {
    "externalSegmentId": 232028394,
    "externalSegmentIndex": 1
  }
}

Rail Segment JSON Example

Rail Segment Example

✅ Sample JSON

{
  "type": "Rail",
  "supplierCode": "2V",
  "supplierName": "Amtrak",
  "airRailNumber": "42",
  "fromDateTimeLocal": "2022-10-24T13:23:00",
  "fromTimeZone": "Europe/Amsterdam",
  "toDateTimeLocal": "2022-10-24T16:50:00",
  "toTimeZone": "Europe/Amsterdam",
  "fromIataCode": "ZYE",
  "toIataCode": "ZYA",
  "extendedInfo": {
    "externalSegmentId": 23202830,
    "externalSegmentIndex": 0
  }
}

Car Segment JSON Example

Car Segment Example

✅ Sample JSON

{
  "type": "Car",
  "supplierCode": "ET",
  "supplierName": "Enterprise",
  "fromDateTime": "2022-10-25T08:00:00Z",
  "toDateTime": "2022-10-25T11:00:00Z",
  "fromIataCode": "DEN",
  "toIataCode": "DEN",
  "extendedInfo": {
    "externalSegmentId": 232028391,
    "externalSegmentIndex": 0,
    "carHotelExtraInfo": {
      "telephoneNo": "+13729302030",
      "confirmationNo": "729123",
      "rateInfo": "100"
    }
  }
}

Hotel Segment JSON Example

Hotel Segment Example

✅ Sample JSON

{
  "type": "Hotel",
  "supplierCode": "HH",
  "supplierName": "Hilton",
  "fromDateTimeLocal": "2022-10-23T17:59:59",
  "fromDateTime": "2022-10-23T21:59:59Z",
  "toDateTimeLocal": "2022-10-23T23:59:00",
  "toDateTime": "2022-10-24T03:59:00Z",
  "fromTimeZone": "America/New_York",
  "toTimeZone": "America/New_York",
  "fromAddress": {
    "locationName": "Hilton New York Fashion District Hotel",
    "country": "US",
    "state": "New York",
    "city": "New York",
    "streetAddress": "152 West 26th Street",
    "postalCode": "10001",
    "latitude": 40.745529,
    "longitude": -73.993713
  },
  "extendedInfo": {
    "externalSegmentId": 232028393,
    "externalSegmentIndex": 0,
    "carHotelExtraInfo": {
      "telephoneNo": "+13729302030",
      "confirmationNo": "729123",
      "rateInfo": "100",
      "currencyCode": "840",
      "chainCode": "am",
      "guestCount": 2,
      "noOfNights": 2,
      "noOfRooms": 1,
      "roomType": "Single room"
    }
  }
}