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.