Skip to main content
GET
Get return shipment details
此页面由 AI 自动翻译。API 技术规格以英文呈现为标准。如有任何疑问,请参阅英文版本
通过 创建 Return Shipment 返回的 returnRequestId,获取单个退件运货单的完整记录——包含运货单、其明细、面单与任何自定义字段。 退件运货单代表仓库收件前的包裹。一旦仓库登记该包裹,它便成为退货库存项目;自该阶段起,请改用 获取 退货库存 详情,其中带有收件后的处理数据。

找回遗漏的面单

面单位于 shipments[].label.labelUrl。此端点的主要用途是系统异常后的对账:若您的接收端遗漏了某次面单通知,可使用 returnRequestId 调用本端点,直接读取当前的 labelUrltrackingNumberlabelUrl 为空表示面单尚未生成完成(或已失败)——请检查 shipments[].label.labelRequestStatusCode
这是备用途径,并非主要途径。面单以异步方式生成,并通过 labelGenerated webhook 推送,那才是真实数据源。请勿在正常运作下轮询本端点来探知面单——请订阅 Webhooks,仅在通知遗漏或推送失败后,才用本端点补数据。

授权

x-rr-apikey
string
header
必填

Your API key

x-rr-apitoken
string
header
必填

Your API token — keep this private

查询参数

returnRequestId
integer<int32>

Return request identifier, as returned by Create return shipment.

响应

Success

Full record of a return shipment. Successful responses also carry the standard envelope fields (correlationId, meta) alongside the fields below.

returnRequestId
integer<int32>

Return request identifier

returnRequestNumber
string

Return request number

sellerReferenceNumber
string

Your merchant-supplied reference, echoed back for reconciliation

returnStatusCode
string

Current return status code

returnTitle
string

Return title

totalValue
number

Declared total value of the return

totalValueCurrency
string

ISO 4217 currency code of totalValue (e.g. USD)

rma
string

Warehouse-assigned RMA reference (uppercased). Populated once the warehouse processes the parcel.

remarks
string

Free-text remarks

isArchived
boolean

Whether the return request is archived

returnRequestFrom
string

Origin/source of the return request

shipments
object[]

Shipments belonging to this return request, each with its label.

returnRequestLineItems
object[]

Line items included in the return request.

returnInventoryList
object[]

Return inventory records derived from this request, populated once the warehouse has received the parcel. Empty before receipt — use Get return inventory details for full inventory data at that stage.

returnShipmentCustomFieldList
object[]

Custom fields attached to the return shipment.