Skip to main content
GET
/
tracking
/
{id}
Get tracking events for a label
curl --request GET \
  --url https://api.flexforwardship.com/tracking/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "trackingNumber": "YT2503010001CN",
  "tag": "InTransit",
  "subtag": "InTransit_001",
  "subtagMessage": "In transit",
  "slug": "yunexpress",
  "checkpoints": [
    {
      "checkpointTime": "2025-03-02T10:30:00.000Z",
      "city": "Shenzhen",
      "state": "Guangdong",
      "countryRegion": "CN",
      "location": "<string>",
      "message": "Shipment departed from sorting center",
      "tag": "InTransit",
      "subtag": "InTransit_001",
      "subtagMessage": "In transit",
      "slug": "yunexpress"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Label UUID or customer order number.

Minimum string length: 1

Response

Tracking information for a shipment.

Tracking information for a shipment.

​
id
string<uuid>
required

Label identifier.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
trackingNumber
string | null
required

Courier-assigned tracking number, or null if not yet available.

Example:

"YT2503010001CN"

​
tag
string
required

High-level tracking status. Possible values: Pending, InfoReceived, InTransit, Delivered, Exception, Cancelled, Unknown.

Example:

"InTransit"

​
subtag
string
required

Detailed status sub-tag.

Example:

"InTransit_001"

​
subtagMessage
string
required

Human-readable description of the sub-tag.

Example:

"In transit"

​
slug
string
required

Courier service slug.

Example:

"yunexpress"

​
checkpoints
object[]
required

Chronological list of tracking events.