TrackMyParcel REST API

Parcel tracking for 30+ South African and international couriers (SAPO, Aramex, The Courier Guy, PostNet, DHL, …) as one Bearer-authenticated JSON API.

Pointing an AI agent at this API?

Hand it the LLM-ready Markdown version — self-contained instructions an agent can follow with just a URL and an API key.

Open /docs/llm/api.md

Getting started

Base URL

All endpoints live under `https://fujugz4e.vibecode.cloud/api/v1`. `https://fujugz4e.vibecode.cloud` is the origin you were given (scheme + host, e.g. `https://example.com`). Do not add a trailing slash.

Authentication

Every endpoint requires an API key sent as a Bearer token: `Authorization: Bearer sk_your_key_here`. Keys always start with `sk_`. A missing or invalid key returns `401 { "error": "Invalid or missing API key" }`. Create keys in the app under Profile → API Keys.

Content type

Responses are JSON unless noted (file download returns raw bytes). Request bodies are JSON (`Content-Type: application/json`) except file upload, which is `multipart/form-data`.

Rate limiting

Requests are rate limited per API key. When you exceed a limit you get `429` (or `403` if the limit is configured to block) with an `error` message and, when applicable, a `Retry-After` header (seconds). Back off and retry.

Errors

Errors are JSON with an `error` string and a matching HTTP status (`400` bad input, `401` unauthenticated, `403` forbidden, `404` not found, `413` payload too large, `429` rate limited, `500` server error).

Your base URL is https://fujugz4e.vibecode.cloud. Create API keys under Profile → API Keys.

Endpoints

GET

/api/v1/carriers

List supported couriers

Returns every courier TrackMyParcel can track. Use the `uuid` as the `:carrier` path segment of `GET /api/v1/track/:carrier/:code`. `region` is `za` (South African courier) or `intl`; `codeHint` describes what a tracking number of that courier looks like.

Auth: Bearer tokenAccess: Any valid API key.

Request

curl https://fujugz4e.vibecode.cloud/api/v1/carriers \
  -H "Authorization: Bearer sk_your_key_here"

Response

{
  "carriers": [
    { "uuid": "sapo", "name": "South African Post Office (SAPO)", "region": "za", "codeHint": "e.g. RD123456789ZA, PE123456789ZA", "website": "https://www.postoffice.co.za" },
    { "uuid": "thecourierguy", "name": "The Courier Guy", "region": "za", "codeHint": "Waybill / tracking reference", "website": "https://www.thecourierguy.co.za" }
  ]
}

GET

/api/v1/track/:carrier/:code

Track a parcel

Fetches the live tracking history of one parcel from the courier and returns it normalised: an overall `status`, the courier wording of the latest status, and all scan `events` newest first (ISO 8601 dates, SAST +02:00 when the courier gives local time). Results are cached for up to 10 minutes; add `?refresh=1` to force a new courier lookup. A lookup can take up to ~60 s when the courier is slow.

Auth: Bearer tokenAccess: Any valid API key. Rate limited per key (functionality `track.api`).

Name	In	Type	Req.	Description
carrier	path	string	yes	Courier uuid from GET /api/v1/carriers, e.g. `sapo`, `aramex`, `thecourierguy`, `dhl`.
code	path	string	yes	Tracking / waybill number. Spaces are ignored, case-insensitive. URL-encode it.
refresh	query	"1"	no	Bypass the 10-minute cache.

Request

curl https://fujugz4e.vibecode.cloud/api/v1/track/sapo/PE664820353ZA \
  -H "Authorization: Bearer sk_your_key_here"

Response

{
  "carrier": "sapo",
  "code": "PE664820353ZA",
  "ok": true,
  "status": "delivered",
  "statusText": "Delivered",
  "events": [
    { "date": "2023-05-02T11:04:00+02:00", "location": "PRETORIA", "status": "Delivered" },
    { "date": "2023-05-02T07:15:00+02:00", "location": "PRETORIA", "status": "Out for delivery" }
  ],
  "origin": null,
  "destination": null,
  "source": "SAPO track & trace",
  "officialUrl": "https://trackingnew.postoffice.co.za/?ParcelId=PE664820353ZA",
  "fetchedAt": "2026-10-01T12:00:00.000Z"
}

`status` is one of: pending, in_transit, out_for_delivery, ready_for_collection, delivered, exception, not_found, unknown.
`ok: false` (HTTP 502) means the courier could not be reached or changed its site; `error` explains why and `officialUrl` links to the courier's own page.
`ok: true` with `status: "not_found"` means the courier answered but does not know the code (yet) — new parcels can take 24–48 h to appear.
Unknown `:carrier` returns 404.

GET

/api/v1/health

Health check

Confirms the API is up and your key is valid. Handy as a first call to verify credentials and connectivity.

Auth: Bearer tokenAccess: Any valid API key.

Request

curl https://fujugz4e.vibecode.cloud/api/v1/health \
  -H "Authorization: Bearer sk_your_key_here"

Response

{
  "status": "healthy",
  "timestamp": "2026-07-19T12:00:00.000Z",
  "uptime": 1234.56,
  "version": "1.0.0",
  "apiKey": "My key",
  "userId": "usr_...",
  "message": "API is running successfully"
}

GET

/api/v1/stats

Account & API usage stats

Returns the calling user together with API-usage counters (requests today / this week / this month, error rate, API-key count).

Auth: Bearer tokenAccess: Any valid API key (scoped to the key owner).

Request

curl https://fujugz4e.vibecode.cloud/api/v1/stats \
  -H "Authorization: Bearer sk_your_key_here"

Response

{
  "user": { "id": "usr_...", "email": "you@example.com", "name": "You", "role": "user", "createdAt": "..." },
  "apiStats": {
    "totalApiKeys": 2,
    "requestsToday": 14,
    "requestsThisWeek": 98,
    "requestsThisMonth": 412,
    "errorRate": "1.20%",
    "errorCount": 5
  },
  "meta": { "timestamp": "...", "apiKey": "My key" }
}

GET

/api/v1/users

List users

Lists users. A regular key returns only its own user record; an admin key returns all users with pagination.

Auth: Bearer tokenAccess: Any valid API key (admin keys see all users; others see themselves).

Name	In	Type	Req.	Description
limit	query	integer	no	Page size, 1–100 (default 10). Admin only; ignored for non-admins.
offset	query	integer	no	Rows to skip (default 0). Admin only.

Request

curl "https://fujugz4e.vibecode.cloud/api/v1/users?limit=20&offset=0" \
  -H "Authorization: Bearer sk_your_key_here"

Response

{
  "users": [
    { "id": "usr_...", "email": "you@example.com", "name": "You", "role": "user", "emailVerified": null, "createdAt": "..." }
  ],
  "meta": { "limit": 20, "offset": 0, "total": 1, "apiKey": "My key" }
}

POST

/api/v1/users

Create user (scaffold)

Admin-only endpoint scaffold for creating a user. Ships as a stub in this starter — it validates input and echoes it back rather than persisting. Fill in real creation logic before relying on it.

Auth: Bearer tokenAccess: Admin API keys only (others get 403).

Name	In	Type	Req.	Description
email	body	string	yes	New user email.
name	body	string	yes	New user display name.
role	body	string	no	'user' (default) or 'admin'.

Request

curl -X POST https://fujugz4e.vibecode.cloud/api/v1/users \
  -H "Authorization: Bearer sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"email":"new@example.com","name":"New User","role":"user"}'

Response

{
  "message": "User creation endpoint - implementation needed",
  "requestedData": { "email": "new@example.com", "name": "New User", "role": "user" },
  "apiKey": "My key"
}

This is a template stub — no user is actually created yet.

POST

/api/v1/files

Upload a file

Uploads a file and stores its raw bytes. Use this instead of a form/Server Action for any real upload (Server Actions cap the body at ~1MB; this endpoint does not). Send `multipart/form-data` with a single `file` field.

Auth: Bearer tokenAccess: Any valid API key (the file is owned by the key owner).

Name	In	Type	Req.	Description
file	form	file	yes	The file to upload (multipart field name must be "file").

Request

curl -X POST https://fujugz4e.vibecode.cloud/api/v1/files \
  -H "Authorization: Bearer sk_your_key_here" \
  -F "file=@./photo.png"

Response

{
  "id": "fil_...",
  "filename": "photo.png",
  "url": "/api/v1/files/fil_..."
}

Default max size is 100MB (configurable via MAX_FILE_SIZE). Oversized uploads return 413.
The returned `url` is the Bearer-gated download endpoint below.

GET

/api/v1/files/:id

Download / preview a file

Streams the raw file bytes with the stored Content-Type. Because it is Bearer-gated you cannot put it directly in an `<img src>`; fetch it with the token and build an object URL client-side.

Auth: Bearer tokenAccess: Any valid API key.

Name	In	Type	Req.	Description
id	path	string	yes	File id returned by the upload endpoint.

Request

curl https://fujugz4e.vibecode.cloud/api/v1/files/fil_your_file_id \
  -H "Authorization: Bearer sk_your_key_here" \
  --output downloaded-file

Response

Raw binary body with the stored `Content-Type` and `Content-Disposition: inline; filename="..."`. Returns `404 { "error": "File not found" }` if unknown.

DELETE

/api/v1/files/:id

Delete a file

Deletes a file owned by the calling key.

Auth: Bearer tokenAccess: Any valid API key (only the owner may delete).

Name	In	Type	Req.	Description
id	path	string	yes	File id to delete.

Request

curl -X DELETE https://fujugz4e.vibecode.cloud/api/v1/files/fil_your_file_id \
  -H "Authorization: Bearer sk_your_key_here"

Response

{ "deleted": true }   // { "deleted": false } with status 404 if not found / not owned