Skip to main content
POST
创建配送标签

授权

x-rr-apikey
string
header
必填
x-rr-apitoken
string
header
必填

请求体

application/json

创建配送标签的请求载荷。

创建配送标签的请求载荷。

idempotencyKey
string
必填

客户端生成的唯一密钥,用于确保幂等标签创建。使用相同密钥重发请求将返回原始结果。

Required string length: 1 - 100
示例:

"unique-key-per-request"

courier
string
必填

要使用的物流商代码。调用 GET /couriers 以列出您账户可用的有效物流商代码,然后传入其中一个返回的 code 值。

Minimum string length: 1
示例:

"yunexpress"

service
object
必填

物流商服务配置。

shipment
object
必填

包含发件地、目的地及包裹的货件详情。

label
object

标签输出偏好设置。

units
object

重量与尺寸的计量单位。

order
object

订单参考信息。

customs
object

跨境货件的报关信息。

serviceOptions
object[]

以代码与值配对方式提供的额外服务选项。

dangerousGoods
object

危险品申报。

pickup
object

取件点配置。

courierOptions
object

物流商专属选项。

响应

标签创建请求的结果。

标签创建请求的结果。

id
string<uuid>
必填

唯一标签标识符。

示例:

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

status
必填

标签创建结果 — created 或 failed。

可用选项:
created
示例:

"created"

courier
string
必填

使用的物流商。

示例:

"yunexpress"

customerOrderNumber
string
必填

与此标签关联的客户订单编号。

示例:

"N-2026-05-27-TEST-03"

courierOrderNumber
string | null
必填

物流商分配的订单编号,失败时为 null。

示例:

"YT2503010001"

courierTrackingNumber
string | null
必填

物流商分配的追踪编号,尚未获取时为 null。

示例:

"YT2503010001CN"

error
object | null
必填

标签创建失败时的错误详情,否则为 null。