Get booking label

v4 API

This page documents the v4 API (https://www.transdirect.com.au/api), the existing API — fully supported. For new integrations, prefer the v5 typed SDK. New to Transdirect? See v4 vs v5 — which should I use?. The v5 equivalent is the SDK function getApiV5BookingsV4ByIdLabel (A6 label: getApiV5BookingsV4ByIdA6Label; manifest: getApiV5BookingsV4ByIdManifest).

Endpoint

GET /api/bookings/v4/{id}/label

Returns the shipping label for a confirmed booking as a PDF file. Labels are generated by the courier after a booking is confirmed.

Tip

Labels are typically available within a few seconds of confirming a booking. If the label is not yet ready, wait a moment and try again.

Path parameters

Parameter	Type	Required	Description
id	integer	Yes	The booking ID

Request

curl -X GET \
  -H "Api-key: YOUR_API_KEY" \
  -o label.pdf \
  https://www.transdirect.com.au/api/bookings/v4/123456/label

Response

A successful response returns a 200 status code with the PDF label as the response body. The Content-Type header is set to application/pdf.

Save the response body directly to a .pdf file.

Demo mode

When a booking is confirmed with payment_method: "demo", it is placed on the synthetic Demo courier and receives a watermarked test label (and a DEMO-… connote). The label endpoint returns that PDF so you can test download and print workflows without transmitting anything to a real carrier.

Note

Demo labels are watermarked test PDFs. They are for integration testing only and are not valid for shipping.

Related endpoints

Endpoint	Purpose
GET /api/bookings/v4/{id}/a6label	A6-format label PDF
GET /api/bookings/v4/{id}/manifest	Manifest PDF
GET /api/bookings/v4/{id}/tntregeneralabel	Force-regenerate TNT label
GET /api/bookings/v4/{id}/public_url	Time-limited signed public label URL

Error responses

Status code	Meaning
401	Unauthorised — invalid credentials or API key
404	Not found — the booking does not exist, does not belong to your account, or has not been confirmed