Shipments Overview
Shipments are the core of TrackLogy. A shipment represents a single tracked package identified by a carrier tracking number.
How Tracking Works
Add shipment → Carrier detected → Status polled → Notifications fired- Add a tracking number — via the dashboard or API. Provide the tracking number, optional carrier slug, and customer details.
- Carrier detection — if you don't specify a carrier, TrackLogy auto-detects it from the tracking number format.
- Registration — the shipment is registered with the tracking engine, which begins polling the carrier for status.
- Status updates — the tracking engine polls the carrier periodically. When the status changes, events are recorded and notifications are dispatched to the customer.
- Delivery — once the shipment reaches
deliveredstatus, polling stops for that shipment.
Tracker Balance
Every workspace has a tracker balance — a pool of tracking credits. Creating a new shipment consumes one tracker from your balance.
| Plan | Tracker Allowance | Notes |
|---|---|---|
| Free Trial | 100 total | Valid for 14 days from signup |
| Free20 | 20 per month | Auto-resets monthly after trial ends |
| Starter | 500 per month | Billed via Stripe at $29/mo |
| Growth | 2,000 per month | Billed via Stripe at $79/mo |
| Pro | 10,000 per month | Billed via Stripe at $199/mo |
If your tracker balance reaches zero, new shipment creation will return a 402 Payment Required error. Upgrade your plan or wait for the monthly reset to continue adding shipments.
Deleted shipments do not refund the consumed tracker — plan accordingly.
Shipment Fields
When creating a shipment, you can provide:
| Field | Required | Description |
|---|---|---|
tracking_number | Yes | The carrier-assigned tracking number |
tracking_provider | No | Carrier slug (e.g. ups, fedex). Auto-detected if omitted |
customer_name | No | Customer's full name (used in notification templates) |
customer_email | No | Customer email address for email notifications |
customer_phone | No | Customer phone number for SMS notifications |
order_id | No | Your internal order ID |
order_number | No | Human-readable order number shown in notifications |
destination_country | No | ISO country code (e.g. US, GB) |
postal_code | No | Destination postal code (helps some carriers) |
est_delivery_date | No | Estimated delivery date (ISO 8601) |
notes | No | Internal notes (not shown to customers) |
Shipment Sources
Shipments can have one of three sources:
manual— Created through the dashboard or API directlyapi— Created programmatically via the REST APIwoocommerce— Created automatically by the WooCommerce plugin
WooCommerce Shipments
Shipments from WooCommerce stores have email notifications skipped — WooCommerce handles its own customer notification flow. SMS notifications are also not applicable for WooCommerce-sourced shipments.
See the WooCommerce integration guide →