Transaction and Trace IDs

The JSON Air APIs support transaction and trace IDs for both GDS Global Distribution System. A GDS aggregates and distributes air, hotel, and car rental content such as schedules, fares, and upsells. In the JSON APIs, GDS content is distributed from Travelport. and NDC New Distribution Capability, an XML standard for exchanging data that supports airlines in distributing their content directly to online travel agencies. See the NDC Guide. content. These IDs can be used to assist in tracking and troubleshooting if you need Support Options.

Tracking IDs in the Request

The JSON APIs support two separate tracking IDs, one issued by Travelport by default (transactionId) and another that customers can send by choice (traceId). The traceId is sent in the message request header, and both transactionId and traceId are returned in the response header and/or response payload depending on transaction type.

transactionId is unique to a single transaction and returned in most APIs. Note that the header may be titled e2etrackingid instead of transactionId. See the table below. When returned, the response payload object is always transactionId.
traceId is returned only if sent by the customer. Can be sent in all transaction types to add the same common identifier to all transactions in a workflow.

Do not confuse traceId with the Open Telemetry TraceId header.

Show table for transactionId and e2etrackingid

This table lists whether the Travelport-issued tracking ID is returned in the response header as e2etrackingid or transactionid, and whether returned in the response payload, always as transactionid. N/A means transactionId is not returned in the response payload. This list is not inclusive of all JSON APIs.

API	Response header	Response payload
Search	e2etrackingid	transactionId
AirPrice reference payload In the JSON APIs, an API call that sends identifers referring to a previous response for the itinerary to be shopped, priced, added, etc. instead of full itinerary details.	e2etrackingid	N/A
Create Workbench	transactionid	N/A
Add Offer reference payload	transactionid	N/A
Add Traveler	transactionid	N/A
Pre-commit API call that ends a workbench session, finalizing all changes and requests in that session. Depending on the workbench transactions, the commit workbench request may create a reservation, issue a ticket or EMD, exchange tickets, or modify a reservation. workbench retrieve	transactionid	N/A
Seat map in workbench	e2etrackingid	N/A
Seat Book	transactionid	transactionId
Ancillary Shop	e2etrackingid	transactionId
Ancillary Price	e2etrackingid	transactionId
Ancillary Book	transactionid	transactionId
Add remarks (reservation comments)	transactionid	N/A
Accounting remarks	transactionid	N/A
Primary contact remarks	transactionid	N/A
Special services list remarks	transactionid	N/A
Profile move	transactionid	N/A
Traveler updatable item	transactionid	transactionId
Traveler update	transactionid	N/A
Commit workbench	transactionid	N/A
Reservation retrieve	transactionid	N/A
Fare rules	e2etrackingid	transactionId
Post commit workbench	transactionid	N/A
Add form of payment	transactionid	N/A
Add payment	transactionid	N/A

For more about headers, see Common Air Headers.

Do not change the TraceID value in subsequent transactions in the same flow, such as between transactions in the same workbench session. For example, don't send a value of ABC in the header of the request to establish a workbench and then change that value to 123 when you add an offer

In the JSON Search APIs, an offer is a product available at a specific price under a set of terms and conditions. An offer includes the flight or connecting flights for one leg of the itinerary, plus a service level that includes the cabin class and any fare codes that may apply. At booking, the selected offer from the Search response - including the flight/s, service level, price, terms and conditions, and brand if applicable - is converted into a single Offer object that is subsequently returned for that booking..

Tracking IDs in the Response

All JSON API responses return the system-generated transaction ID A tracking id returned in the transactionId object under the first top-level object of every response in the JSON APIs. This system-generated ID assists Travelport and customers with troubleshooting if needed. In addition, developers can send a custom traceId in the header as their own tracking number. See Transaction and Trace IDs on the General menu.. Most responses return the ID in the transactionId object in the first object of the response payload (object name varies by API) and in the e2etrackingid field in the response header, although some APIs return it only in the header.

If you send a trace ID in the header, the response returns that ID. Most responses return a traceId object with your traceID value in the first object in the response payload and in the TraceID field in the response header, although some APIs return it only in the header. If you do not send a trace ID, traceId is not returned.

The following example shows the transaction and trace IDs as returned in the headers and response payloads of different APIs.

Depending on the API, the transactionId is returned in a response header titled either transactionid or e2etrackingid.In the response payload, the transactionId is always returned in the transactionId object.

Show Example payload response excerpts with transactionId only

{
    "CatalogProductOfferingsResponse": {
        "@type": "CatalogProductOfferingsResponse",
        "transactionId": "452a28d3-67d8-4c77-a867-b1d0fdece7d5",

{
    "OfferListResponse": {
        "@type": "OfferListResponse",
        "transactionId": "aeac4215-fffa-a8fc-d5f3-ad09b4e5a13d:ppn",

Show Example payload response excerpts with transactionId and traceId

{
    "CatalogProductOfferingsResponse": {
        "@type": "CatalogProductOfferingsResponse",
        "transactionId": "7f665ede-abde-4fe7-b8b7-54fa153f6246",
        "traceId": "TVP123",
        "CatalogProductOfferings": {
            "@type": "CatalogProductOfferings",
            "Identifier": {
                "value": "1a763955-d784-431f-89c1-4de207f9db44"
            },

{
    "CatalogOfferingsAncillaryListResponse": {
        "@type": "CatalogOfferingsAncillaryListResponse",
        "transactionId": "5085fef3-c0b3-4c15-86e1-2e7bc80b23cb",
        "traceId": "38168bbf-c8b7-4171-866a-8f3d22e2dc61",

{
    "ReservationResponse": {
        "@type": "ReservationResponse",
        "transactionId": "a1c2e9da-1deb-4c82-bb22-746994f468c4",
        "traceId": "18717099-fa41-4452-b75b-54a7eaddfa8b",