Give your customers a ready-to-open tracking page.
The API gives you tracking data through the orderTrack link and the Track & Trace webhook. If you want to hand your own customers a ready-to-open tracking page, use one of the two link types below.
Both links open the same tracking page, but they differ in how access is granted:
| Reference link | Order ID link (platformTrackingUrl) | |
|---|---|---|
| Access | User must open the page and solve a captcha | Unlocks the shipment directly, no captcha |
| Source | Build it yourself from data.reference | Delivered ready-to-use in the Place Order response |
| Use case | Legacy / manual integration | Recommended for new integrations |
The public tracking link (Reference-based)
https://my.cargoboard.com/de/tracking?reference={reference}&secret={postcode}{reference}— the shipment reference returned in the order response (data.reference).{postcode}— the postcode of the consignee (acts as the access secret so only people who know the destination can open the page).
Example
https://my.cargoboard.com/de/tracking?reference=11453140&secret=41061Both values are part of the data you already have after booking, so you can generate the link automatically inside your own platform — no extra API call needed.
Captcha requiredOpening this link does not unlock the shipment automatically. The user still has to solve a captcha before tracking data is shown.
The platform tracking link (Order ID-based)
The response of POST /v1/orders contains:
"platformTrackingUrl": "https://my.cargoboard.com/tracking?order-id={orderId}&consignee-post-code={postCode}"order-id— the Order ID of the created order.consignee-post-code— the postcode of the consignee (acts as the access secret so only people who know the destination can open the page).
Example
https://my.cargoboard.com/tracking?order-id=cmrlp4gnl00133pbgdp6ghvkl&consignee-post-code=10115
RecommendedThis link unlocks the shipment directly — no captcha required. Use it whenever your customers should reach tracking with a single click.
Where to get the values
After placing an order, the response contains data.reference and, for the direct-unlock variant, data.platformTrackingUrl already assembled. The consignee postcode is the one you sent in consignee.address.postCode.