{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/stays/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Trace and Transaction IDs","description":"Create AI-native travel products with Travelport's powerful, flexible APIs.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"trace-and-transaction-ids","__idx":0},"children":["Trace and Transaction IDs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The TripServices Stays APIs support a tracking ID that can be used to correlate transactions across workflows, and to provide tracking capabilities if you need to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/resources/support#mytravelport"},"children":["contact support"]},". This ID can be either a custom value that you send or that Travelport generates if none is sent."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If sent, the tracking ID is sent in a message request header, and returned in both in the response header and response payload."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/stays/guides/stays-general-guide#api-versions-11-and-12"},"children":["v11"]}," APIs, the header parameter is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TraceId"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/stays/guides/stays-general-guide#api-versions-11-and-12"},"children":["v12"]}," APIs,  (SearchComplete and SearchComplete Pagination only), the tracking header is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TVP-Trace-Id"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you don't send a value in these parameters, the API generates a value. When generated by Travelport, the value is unique to a single transaction and returned in all APIs. In both cases, the value entered or generated is returned in both the header and response payload:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The response header, either ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["tvp-trace-id"]}," for v12 or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["traceId"]}," for v11."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In all versions, the response payload object ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["traceId"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more about headers, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/stays/general/common-stays-api-headers"},"children":["Common Stays API Headers"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Some APIs also have the header parameter ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["transactionId"]},", and some response payloads may return a transactionId object. This object is not consistently returned and not intended for customer use. It should be ignored."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example shows traceId as returned in the response payloads of different APIs, first a v11 API and then v12. Note that the second example returns transactionId, which should be ignored."]},{"$$mdtype":"Tag","name":"details","attributes":{"className":"example-box"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Show Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"PropertiesResponse\": {\n        \"Properties\": {...},\n        \"traceId\": \"d81201dc-4648-485c-a83d-29de3ce4dac0\",\n        ...\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"traceId\": \"33f87e85-867b-4865-a09f-5c41d626752f\",\n    \"transactionId\": \"f949c424-51d4-423e-9408-41b3dcfa7c60\",\n    \"pagination\": {\n        \"page\": 1,\n        \"pageSize\": 2,\n        \"totalPages\": 1,\n        \"totalItems\": 2\n    },...\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"best-practices-for-creating-a-trace-id","__idx":1},"children":["Best Practices for Creating a Trace ID"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you choose to generate your own tracking ID, recommended best practice is to generate an ID in the following format:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["   xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["   Example: d497d8c9-5a79-4a79-9164-f948989078cc"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do not use static values - each value should be unique for the transaction or transaction workflow to track."]}]},"headings":[{"value":"Trace and Transaction IDs","id":"trace-and-transaction-ids","depth":1},{"value":"Best Practices for Creating a Trace ID","id":"best-practices-for-creating-a-trace-id","depth":2}],"frontmatter":{"seo":{"title":"Trace and Transaction IDs"}},"lastModified":"2026-05-27T15:34:23.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/stays/general/trace-and-transaction-ids","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}