API Overview & Authentication

The TrackLogy API is a RESTful HTTP API. All requests and responses use JSON. Use it to create and manage shipments, configure notifications, and integrate tracking into your platform.

Base URL

https://api.tracklogy.com

All endpoints are versioned under /v1:

https://api.tracklogy.com/v1/shipments
https://api.tracklogy.com/v1/notifications/settings

Authentication

All API requests must be authenticated using a Bearer token — your workspace API key.

Authorization: Bearer YOUR_API_KEY

Get your API key from Dashboard → Settings → API Keys.

Example

curl https://api.tracklogy.com/v1/shipments \
  -H "Authorization: Bearer YOUR_API_KEY"

Request Format

• Method: Standard HTTP verbs (GET, POST, PUT, DELETE)
• Content-Type: application/json for POST/PUT requests
• Encoding: UTF-8

curl -X POST https://api.tracklogy.com/v1/shipments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "tracking_number": "1Z999AA10123456784" }'

Response Format

All responses follow a consistent JSON envelope:

Success:

{
  "success": true,
  "message": "Shipment created",
  "data": {
    "shipment": { ... }
  }
}

Error:

{
  "success": false,
  "error": {
    "code": 422,
    "message": "Tracking number is required"
  },
  "data": {}
}

HTTP Status Codes

Rate Limiting

The API enforces rate limits to ensure fair usage across all workspaces. If you exceed the rate limit, you'll receive a 429 Too Many Requests response.

Retry with exponential backoff after receiving a 429. For higher rate limit needs, contact [email protected].

Pagination

List endpoints support pagination via query parameters:

Paginated responses include:

{
  "success": true,
  "data": {
    "items": [ ... ],
    "total": 142,
    "page": 1,
    "per_page": 25,
    "total_pages": 6
  }
}

Available Endpoints