Skip to main content
GET
Get tracking events for a label

Authorizations

x-rr-apikey
string
header
required
x-rr-apitoken
string
header
required

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.