API Usage

The versioned REST API (/api/v1) is being finalized. This page describes the intended usage; endpoints are activated as they ship.

Authentication

Requests authenticate with a bearer token issued to your organization:

Authorization: Bearer <your-api-token>

Contact info@ace1group.com to request an API token.

Track a shipment

GET /api/v1/track/{trackingNumber}

Optionally force a specific carrier with the carrier query parameter; otherwise the carrier is auto-detected from the tracking-number format.

Example response

{
  "tracking_number": "AB123456789",
  "carrier": "demo",
  "carrier_name": "Demo Carrier",
  "status": "in_transit",
  "estimated_delivery_at": "2026-07-20T18:00:00Z",
  "last_location": "Memphis, TN",
  "events": [
    {
      "occurred_at": "2026-07-17T09:12:00Z",
      "status": "in_transit",
      "description": "Arrived at sorting hub",
      "location": "Memphis, TN"
    }
  ]
}

Status vocabulary

Status	Meaning
`pending`	Label created, not yet in the network
`info_received`	Carrier notified, awaiting pickup
`in_transit`	Moving through the carrier network
`out_for_delivery`	On the delivery vehicle
`delivered`	Delivered to the recipient
`exception`	A problem occurred (delay, address, …)
`returned`	Returned to sender
`unknown`	Status could not be determined

Rate limits

Public, unauthenticated tracking (including the home-page form) is rate limited per IP address. Authenticated API clients receive higher limits based on their plan.