Getting Started
Quick Start

Quick Start

Get from zero to tracking your first shipment in under 5 minutes.

Create your account

Go to my.tracklogy.com (opens in a new tab) and sign up for a free account. You'll automatically start a 14-day free trial with 100 tracker credits — no credit card required.

Get your API key

Once logged in, navigate to Settings → API Keys in the dashboard. Your workspace API key is auto-generated and shown there.

Copy the key — it looks like this:

tlk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
⚠️

Keep your API key secret. Never expose it in client-side code or commit it to version control. Use environment variables instead.

Create your first shipment

Use the API to register a tracking number. Replace YOUR_API_KEY and the tracking number with your real values:

curl -X POST https://api.tracklogy.com/v1/shipments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tracking_number": "1Z999AA10123456784",
    "tracking_provider": "ups",
    "customer_name": "Jane Smith",
    "customer_email": "[email protected]",
    "order_id": "ORD-1001"
  }'

A successful response looks like:

{
  "success": true,
  "message": "Shipment created",
  "data": {
    "shipment": {
      "id": 42,
      "tracking_number": "1Z999AA10123456784",
      "tracking_provider": "ups",
      "status": "pending",
      "customer_email": "[email protected]",
      "order_id": "ORD-1001",
      "created_at": "2025-05-07T10:00:00Z"
    },
    "detected_tracking_provider": "ups"
  }
}

If you don't know the carrier slug, omit tracking_provider and TrackLogy will attempt to auto-detect it from the tracking number format.

Check tracking status

Retrieve the shipment to see its current status:

curl https://api.tracklogy.com/v1/shipments/show?id=42 \
  -H "Authorization: Bearer YOUR_API_KEY"

The status field will update automatically as the carrier scans the package. Common statuses include pending, in_transit, out_for_delivery, and delivered.

See the full Shipment Statuses reference →

Set up notifications

By default, email notifications are enabled for in_transit, out_for_delivery, delivered, and exception events. SMS is disabled by default.

To configure notifications, go to Dashboard → Notifications or use the API:

curl -X PUT https://api.tracklogy.com/v1/notifications/settings \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channels": { "email": true, "sms": false },
    "triggers": {
      "shipment.created":         { "email": true,  "sms": false },
      "shipment.in_transit":      { "email": true,  "sms": false },
      "shipment.out_for_delivery":{ "email": true,  "sms": false },
      "shipment.delivered":       { "email": true,  "sms": false },
      "shipment.exception":       { "email": true,  "sms": false },
      "shipment.returned":        { "email": true,  "sms": false }
    }
  }'

For email notifications to send, you also need to configure a Brevo API key in Dashboard → Store Settings → Email.

What's Next?

OverviewAPI Keys