Traveler Updatable Items API Reference

POST

book/updatableItem/reservationworkbench/{workbenchID}/travelerupdatableitems/buildfromtraveler

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

Base path:

Pre-production https://api.pp.travelport.com/11/air/

Production https://api.travelport.com/11/air/

Related Content: Booking Guide, Traveler Modify Guide

Use the Updatable Items request to return a list of updatable traveler information. Updatable Items retrieves by one or more traveler IDs a list of objects that are updatable for that traveler/s, and returns for each an indicator for whether that item can be added, modified, or deleted. It is sent as part of a workbench session, either during the initial booking workflow or a post-commit workbench for an existing reservation. It is followed by a Traveler Update request to implement changes.

See the Traveler Modify Guide for currently supported changes.

Request

Also see Authorization and Common Headers.

Query Parameters

None.

Request Body

Show Request Body Table

Object	Description
TravelerUpdatableItemsQueryBuildFromTraveler	Top level object.
Identifier	Array. Sends identifier/s as string/s for the traveler/s to retrieve a list of updatable items for.

After you establish a post-commit workbench session, send a request for updatable items with the traveler identifier for each traveler to update. You can request one or more travelers on the same reservation. If you need the traveler identifiers, retrieve the reservation before you create the workbench, or retrieve the workbench to get full reservation details.

The payload must send the traveler identifier for each passenger with information to update.

Response

Show Response Body Table

Object	Description
TravelerUpdatableItemsListResponse	Top level object. Key value pairs: transactionId: System-generated unique ID for this response. Can be used for internal tracking and troubleshooting. traceId: Returned if a custom trace ID was sent in the request header. See Transaction and Trace IDs for details. See Identifiers in the JSON APIs for more about identifiers across all JSON APIs. Includes Identifier and TravelerUpdatableItemsID.
TravelerUpdatableItemsListResponse/Identifier	Returns an identifier for the response as a whole in these key value pairs: authority: Source of information. value: Unique system-generated identifier.
TravelerUpdatableItemsID	Key value pairs: travelerIdentifier: Traveler identifier for traveler to which this updatable item applies. id: Short id for TravelerUpdatableItemsID object. Includes Identifier object.
TravelerUpdatableItemsID/Identifier	Returns an identifier for the TravelerUpdatableItemsID object in these key value pairs: authority: Source of information. value: Unique system-generated identifier.
TravelerUpdatableItem	Returns array of updatable objects Key value pairs; any of the following that are false are not returned: addableInd: true indicates the data does not exist and can added. Returned in its own instance of TravelerUpdatableItem. modifiableInd: true indicates the data exists and can be modified. Returned in an instance of TravelerUpdatableItem with deletableInd, if applicable. deletableInd: true indicates the data exists and can be deleted. Returned in an instance of TravelerUpdatableItem with modifiableInd, if applicable. All instances of TravelerUpdatableItem include an Identifier object. Instances that return deletableInd and/or modifiable also include an {ItemName} object for the type of data that can be modified or deleted.
TravelerUpdatableItem/Identifier	A unique system-generated identifier for this data element. The Identifier value must be sent in any subsequent Traveler Update request to modify this data.
TravelerUpdatableItem/{ItemName}	Name of the type of data that can be modified or deleted. Supported objects are: Email Telephone Address CustomerLoyalty (NDC only; not supported for GDS.) TravelDocument PersonNameUpdatable

Example Request

Show Example Updatable Items Request for one traveler

{
    "TravelerUpdatableItemsQueryBuildFromTraveler": {
        "TravelerIdentifier": [
            "QURUfFQx"
        ]
    }
}

Example Response

Show Example Response

The example response below returns a list of all traveler data (instances of TravelerUpdatableItem) for each traveler requested (TravelerUpdatableItemsID/travelerIdentifier).

{
 "TravelerUpdatableItemsListResponse": {
  "transactionId": "720515a2-ee81-4d2b-a787-0f31ec3be8ab",
  "traceId": "123",
  "TravelerUpdatableItemsID": [
   {
    "@type": "TravelerUpdatableItems",
    "travelerIdentifier": "QURUfFQx",
    "id": "travelerUpdatableItems1",
    "Identifier": {
     "authority": "Travelport",
     "value": "6f0ae183-1ffd-4862-89a3-c8df0bd4be42"
    },
    "TravelerUpdatableItem": [
     {
      "@type": "TravelerUpdatableItemEmail",
      "modifiableInd": true,
      "deletableInd": true,
      "Identifier": "a895908a-2e52-426f-9a4c-7d879814c69e",
      "Email": {
       "id": "email_1",
       "emailType": "Operational",
       "validInd": true,
       "value": "TRAVELERONE@GMAIL.COM"
      }
     },
     {
      "@type": "TravelerUpdatableItemEmail",
      "addableInd": true,
      "Identifier": "6418369b-e5fc-493c-8ef7-1079e37193e1"
     },
     {
      "@type": "TravelerUpdatableItemTelephone",
      "modifiableInd": true,
      "deletableInd": true,
      "Identifier": "f2ead6af-b91b-4ab9-a6bc-57ce24d79702",
      "Telephone": {
       "@type": "Telephone",
       "phoneNumber": "1212456121",
       "id": "telephone_1"
      }
     },
     {
      "@type": "TravelerUpdatableItemTelephone",
      "addableInd": true,
      "Identifier": "d1d1bb93-036b-47da-9d0b-ef06576cc3c3"
     },
     {
      "@type": "TravelerUpdatableItemAddress",
      "addableInd": true,
      "Identifier": "cbaacdcc-4e49-4a82-ad4b-0436b7cba162"
     },
     {
      "@type": "TravelerUpdatableItemCustomerLoyalty",
      "addableInd": true,
      "Identifier": "92c8db7d-d9fd-4764-b582-1351f94bdfc8"
     },
     {
      "@type": "TravelerUpdatableItemTravelDocument",
      "modifiableInd": true,
      "deletableInd": true,
      "Identifier": "ada2b058-c63c-403a-8e15-a19472a4dc94",
      "TravelDocument": {
       "@type": "TravelDocumentDetail",
       "docNumber": "A123123",
       "docType": "Passport",
       "expireDate": "2022-10-20",
       "issueCountry": "US",
       "birthDate": "1986-11-11",
       "birthCountry": "US",
       "Gender": "Male",
       "PersonName": {
        "@type": "PersonName",
        "Given": "TestFirst",
        "Surname": "TestLast"
       }
      }
     },
     {
      "@type": "TravelerUpdatableItemTravelDocument",
      "addableInd": true,
      "Identifier": "c0f9f419-4767-46ae-94c4-dbd7fb763a20"
     },
     {
      "@type": "TravelerUpdatableItemPersonName",
      "modifiableInd": true,
      "Identifier": "91e7bae1-7026-4560-93e0-ff29c62e04b0",
      "PersonNameUpdatable": {
       "Given": "TESTFIRST",
       "Surname": "TESTLAST"
      }
     }
    ]
   }
  ],
  "Identifier": {
   "authority": "Travelport",
   "value": "db2951ec-2484-44db-9c10-9f6992f6e49a"
  }
 }
}