Skip to main content

Request IDs

Every response, success or error, carries an X-Request-Id header. Error bodies repeat it as error.request_id, and search responses also return their own request_id. Log it with every call: it is the fastest way for us to find your request.

Sending your own ID​

You may send your own X-Request-Id, for example your correlation id. It is kept when it is 8–128 characters from A–Z a–z 0–9 . _ : - and starts with a letter or digit. Anything else is replaced by an id we generate.

What to log​

ValueWhere
X-Request-IdResponse header (every call)
internal_referenceYour book request
supplier_booking_id, supplier_booking_refBook response
HTTP status and error.codeResponse

Never log the API key.

Send your own correlation id
curl -s -i -X POST "$TP_BASE_URL/v1/transfer/recheck" \
-H "X-API-Key: $TP_API_KEY" \
-H "X-Request-Id: grn-checkout-000123" \
-H "Content-Type: application/json" \
-d @recheck.json
Response headers
HTTP/1.1 200 OK
X-Request-Id: grn-checkout-000123
Content-Type: application/json