Quickstart

Add your first tracking and get a webhook when it changes. It takes about five minutes.

Embed
Preview of the card
<a href="https://forumulate.com/p/trackified/docs/quickstart"><img src="https://forumulate.com/api/public/orgs/trackified/spaces/docs/pages/14c68536-5d2f-426d-b4ca-dca0eebf2765/social-card.svg?v=3e7ae33eec8b" alt="Quickstart" width="600" height="315"></a>
  1. Create an API key

    Sign up, then open API keys in the dashboard and create a test key. Send it as a bearer token on every request.

    Authorization: Bearer test_...
  2. Add a tracking

    Send the tracking number. Add carrier if you know it, and custom_id to attach your own order reference.

    curl -X POST https://api.trackified.15-204-158-166.sslip.io/v1/trackings \
  -H "Authorization: Bearer $TRACKIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tracking_number": "1Z999AA10123456784", "custom_id": "order_1042"}'

    We check the carrier within a minute, then keep checking on a schedule: every 4 hours until the first scan, every 2 hours in transit, and every 30 minutes once it's out for delivery.

  3. Add a webhook

    Register a URL and pick the events you want.

    curl -X POST https://api.trackified.15-204-158-166.sslip.io/v1/webhooks \
  -H "Authorization: Bearer $TRACKIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/webhooks/tracking",
    "event_types": ["tracking.status_changed", "tracking.delivered"]
  }'

    Every event is signed. Verify the signature before you trust it.

  4. Read a tracking
    curl https://api.trackified.15-204-158-166.sslip.io/v1/trackings/trk_... \
  -H "Authorization: Bearer $TRACKIFIED_KEY"

    The response has the current status and every carrier event, newest first.

Every endpoint is in the API reference, in the sidebar.

Updated