Documentation
How to use TrackJet — by audience, with examples that were actually run.
For users
Getting started: track your first shipment
What TrackJet is, what you can paste into the box, and what happens next.
Tracking number formats by vertical
Air waybills, containers, bills of lading, postal S10 and parcel formats — with valid examples.
Saved shipments & email alerts
Your board, status-change alerts, per-shipment muting and one-click unsubscribe.
Reading the timeline
The seven canonical statuses, multi-leg chains, and what the verification badges mean.
Track by email (mail-in)
Forward carrier emails to your private address and shipments appear on your board.
Sharing with Privacy Lens
Share a shipment publicly while hiding the fields you choose — enforced server-side.
Shipment passports & verification
Export a signed passport and verify any timeline was never rewritten.
Your data: export, delete, crypto-shred
Take everything out, or delete your account and make remains unreadable.
Smart Tracking Links
A short, stable /t/{code} link for any shipment — the foundation the QR, email, status page and badge all point to.
Shared tracking you can revoke
Share a shipment by a link, and turn that link off whenever you want (revoked links return 410 Gone).
Returns & re-forwarding
A clear return checklist after delivery — honest about what the carrier issues vs what we do.
Delay Guard: proactive delay signals
A forward-looking "likely delayed / at risk" signal based on the route's own history — or honest silence.
Customs reminders (with anti-phishing)
A heads-up on international crossings — and a clear warning that any payment is asked by the carrier, never by TrackJet.
For business
API quickstart: first track in 5 minutes
Mint a key, call /api/v1/track, understand the envelope — curl, PHP, JS, Python.
Webhooks: signatures, retries, dead letters
HMAC verification done right, the retry ladder, and test-firing your endpoint.
The deterministic sandbox
TJTEST-* fixtures for every lifecycle — pin your integration tests on byte-stable responses.
Embeddable tracking widget
Put tracking on your own order page with a signed embed token.
Rate limits & plans
Per-key limits, the headers to watch, and what each tier unlocks.
Carbon estimates for reporting
How the CO₂ numbers are computed, what they are good for, and their honest limits.
Air Cargo Intelligence tools
Pre-check, document builder, transit risk, route recommender, cold-chain mode, carrier scorecard and saved cargo defaults — what each does and where it honestly says "not connected".
Delivery forecast & transit stats
How TrackJet estimates a delivery window from its own anonymous observations — mature routes only, and silent when the data is thin.
The anomaly engine
Sequence rules plus an own-data statistical check flag out-of-order events and unusually slow routes — with no false alarms on immature data.
Congestion radar & network status
Where TrackJet sees slowdowns building from its own observations, surfaced on /network-status — signal, not a feed it resells.
Customs friction warnings
A heads-up when a nationwide holiday lands at either end of a live border crossing in the next 10 days — a hint, not a customs-status feed.
Pharma / cold-chain mode
The GDP-cited pre-check at /cargo/pharma — every requirement sourced, and an explicit line where live cold-chain data is "not connected".
The tracking chat assistant
An embeddable assistant that answers "where is my order?" from the real status — grounded, never invented.
The "Verified by TrackJet" trust badge
A self-contained badge for your store that links to verifiable tracking — no JavaScript, no external request.
Embeddable status page
A branded "where is my order?" page you iframe into your store — your name and colour, zero PII.
Carbon at checkout
An estimated CO₂e figure for a shipping route, embeddable at checkout — always labelled as an estimate.
QR codes for shipments
A printable QR that opens a shipment's Smart Link — generated natively, no external service.
Branded shipment emails
Status-update emails that carry your brand and the live Smart Link, DKIM-signed with one-click unsubscribe.
WooCommerce plugin
Turn each order's tracking number into a TrackJet link, on the order page and in WooCommerce emails.
For enterprise
EPCIS 2.0 onboarding
Capture and query supply-chain events in the GS1 shape — the implemented subset, honestly.
Multi-party attestations
Signed custody statements bound to sealed timelines.
PII vault & compliance
What is encrypted at rest, how crypto-shredding works, and what an auditor should ask.
The Verifiable Timeline
Every recorded event is sealed into a SHA-256 hash chain — proof a history was not rewritten, checkable at /verify. What it proves, and what it does not.
The public transparency log
Sealed heads anchor into an append-only Merkle root log (tjmt1) so even TrackJet cannot silently rewrite the past — with the live root endpoint.
Cryptographic transparency for auditors
Verify tjvt2 chains and tjmt1 Merkle proofs offline with tjverify — no trust required.
Security & operations summary
A prudent public summary: sealed audit logs, restore drills, read-only degradation.
Teams, roles & single sign-on (SSO)
Create a workspace, invite members with owner/admin/member roles, read the audit log, and connect your identity provider over OpenID Connect (OIDC).
Proof-of-Delivery API
A signed, offline-verifiable proof of a recorded delivery for disputes, insurance and refunds — with a 30-day window.
White-label tracking domains
Serve tracking on your own domain with your brand — the app resolves the brand by host; you point DNS + TLS.
The SME panel
One at-a-glance page for a non-developer: status mix, what needs attention, a monthly report and a carbon figure.
For developers
Status ontology: how TrackJet normalises carrier statuses
The seven canonical states (pending, in transit, out for delivery, delivered, exception, returned, unknown), the progress order, and how raw multilingual carrier wording maps onto them.
Logistics glossary: AWB, MAWB, HAWB, BoL, ISO 6346, demurrage and more
Plain-language definitions of the air-cargo, ocean, postal, customs and tracking terms — AWB/MAWB/HAWB, MBL/HBL, FCL/LCL, TEU, demurrage vs detention, UPU S10, HS code, Incoterms, ETA, POD.
The developer surface: API, MCP, EPCIS, SSE
One map of every machine interface — docs explain here, /developers holds the reference.
MCP server for AI agents
Connect an agent over JSON-RPC 2.0 and call TrackJet detection, routing, carbon and verification as tools — read-only, no PII.