Tracking Statuses

Tracking statuses define the customer-facing milestones shown during shipment tracking. Use them to create and manage the status labels, codes, and descriptions surfaced in tracking flows.

The Tracking Status object

A tracking status is a timeline event for a tracking number. It stores status text, details, a code, location, and address context.

Attributes

idstringoptional

Public tracking status identifier.

statusstringoptional

Human-readable status.

detailsstringoptional

Status details.

codestringoptional

Machine-readable status code.

completebooleanoptional

Whether this status marks the tracked workflow complete.

tracking_numberobjectoptional

Tracking number associated with the status.

citystringoptional

City where the status occurred.

provincestringoptional

Province or region where the status occurred.

postal_codestringoptional

Postal code where the status occurred.

countrystringoptional

Country code where the status occurred.

locationobjectoptional

Location where the status occurred.

updated_attimestampoptional

Timestamp when the tracking status was last updated.

created_attimestampoptional

Timestamp when the tracking status was created.

The Tracking Status object

{
  "id": "tracking_status_6zV1KqN9pR",
  "status": "Created",
  "details": "Order was created.",
  "code": "created",
  "complete": false,
  "tracking_number": "tracking_3Nf8Qw2YxM",
  "city": "Singapore",
  "province": null,
  "postal_code": null,
  "country": "SG",
  "location": {
    "latitude": 1.3521,
    "longitude": 103.8198
  },
  "updated_at": "2026-05-07T08:30:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}

POST/v1/tracking-statuses

Create a Tracking Status

Create a new Tracking Status.

Body parameters

tracking_numberstringoptional

Tracking number ID to attach the status to. Required unless order is supplied.

orderstringoptional

Order ID used to resolve the order's tracking number when tracking_number is not supplied.

statusstringrequired

Human-readable tracking status.

codestringrequired

Machine-readable tracking status code.

detailsstringrequired

Status details visible to tracking consumers.

locationobjectoptional

Resolvable point where the status occurred. Required unless latitude and longitude are supplied.

latitudenumberoptional

Decimal latitude for the status location.

longitudenumberoptional

Decimal longitude for the status location.

citystringoptional

City where the status occurred.

provincestringoptional

Province or region where the status occurred.

postal_codestringoptional

Postal code where the status occurred.

countrystringoptional

Two-letter country code where the status occurred.

duplicatebooleanoptional

When true, allows duplicate status text for the same order or tracking number.

POST/v1/tracking-statuses

curl -X POST https://api.fleetbase.io/v1/tracking-statuses \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "status": "Delivery is en-route",
    "code": "delivery-en-route",
    "details": "Our driver has picked up your order and is on the way to your address!",
    "tracking_number": "{{tracking_number_id}}",
    "location": [1.3521, 103.8198],
    "city": "Singapore"
}'

200 OK

{
  "id": "<string>",
  "status": "<string>",
  "details": "<string>",
  "code": "<string>",
  "tracking_number": "<string>",
  "city": "<string>",
  "province": "<string>",
  "postal_code": "<string>",
  "country": "<string>",
  "location": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

PUT/v1/tracking-statuses/:id

Update a Tracking Status

Updates an existing tracking status. The response returns the tracking status with the new values applied.

Body parameters

statusstringoptional

Human-readable tracking status.

codestringoptional

Machine-readable tracking status code.

detailsstringoptional

Status details visible to tracking consumers.

locationobjectoptional

Resolvable point where the status occurred.

latitudenumberoptional

Decimal latitude for the status location.

longitudenumberoptional

Decimal longitude for the status location.

citystringoptional

City where the status occurred.

provincestringoptional

Province or region where the status occurred.

postal_codestringoptional

Postal code where the status occurred.

countrystringoptional

Two-letter country code where the status occurred.

PUT/v1/tracking-statuses/:id

curl -X PUT https://api.fleetbase.io/v1/tracking-statuses/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "country": "SG"
}'

200 OK

{
  "id": "<string>",
  "status": "<string>",
  "details": "<string>",
  "code": "<string>",
  "tracking_number": "<string>",
  "city": "<string>",
  "province": "<string>",
  "postal_code": "<string>",
  "country": "<string>",
  "location": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

GET/v1/tracking-statuses/:id

Retrieve a Tracking Status

Retrieve a Tracking Status.

GET/v1/tracking-statuses/:id

curl https://api.fleetbase.io/v1/tracking-statuses/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

200 OK

{
  "id": "<string>",
  "status": "<string>",
  "details": "<string>",
  "code": "<string>",
  "tracking_number": "<string>",
  "city": "<string>",
  "province": "<string>",
  "postal_code": "<string>",
  "country": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

GET/v1/tracking-statuses

Query Tracking Statuses

List all Tracking Statuses

Query parameters

limitintegeroptional

Maximum number of tracking statuses to return.

offsetintegeroptional

Number of tracking statuses to skip before returning results.

sortstringoptional

Sort expression for the tracking status query.

tracking_numberstringoptional

Filters statuses by tracking number ID.

GET/v1/tracking-statuses

curl https://api.fleetbase.io/v1/tracking-statuses?limit=25&tracking_number={{tracking_number_id}} \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

200 OK

{
  "id": "<string>",
  "status": "<string>",
  "details": "<string>",
  "code": "<string>",
  "tracking_number": "<string>",
  "city": "<string>",
  "postal_code": "<string>",
  "country": "<string>",
  "location": "<string>",
  "updated_at": "<string>"
}

DELETE/v1/tracking-statuses/:id

Delete a Tracking Status

Delete a Tracking Status.

DELETE/v1/tracking-statuses/:id

curl -X DELETE https://api.fleetbase.io/v1/tracking-statuses/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

200 OK

{
  "id": "<string>",
  "status": "<string>",
  "details": "<string>",
  "code": "<string>",
  "tracking_number": "<string>",
  "city": "<string>",
  "province": "<string>",
  "postal_code": "<string>",
  "country": "<string>",
  "location": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}