Skip to main content
GET
Fetch the courier-hosted label URL by label id or customer order number

Authorizations

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

Path Parameters

id
string
required

Label UUID, customer order number, or comma-separated identifiers.

Minimum string length: 1

Response

Default Response

Label document retrieval result.

id
string<uuid>
required

Label identifier.

Example:

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

customerOrderNumber
string
required

Customer order number associated with this label.

Minimum string length: 1
Example:

"N2026-05-13-TEST-01"

url
string<uri>
required

URL to download the label document.

Example:

"https://label-cdn.yunexpress.cn/labels/YT2503010001.pdf"

labelFormat
string
required

Document format (pdf or png).

Minimum string length: 1
Example:

"pdf"