取得 Return Shipment 詳情
returnRequestId,取得單一退件運貨單的完整紀錄——包含運貨單、其明細、面單與任何自訂欄位。
退件運貨單代表倉庫收件前的包裹。一旦倉庫登錄該包裹,它便成為退貨庫存項目;自該階段起,請改用 取得 退貨庫存 詳情,其中帶有收件後的處理資料。
找回遺漏的面單
面單位於shipments[].label.labelUrl。此端點的主要用途是系統異常後的對帳:若您的接收端遺漏了某次面單通知,可使用 returnRequestId 呼叫本端點,直接讀取目前的 labelUrl 與 trackingNumber。labelUrl 為空表示面單尚未產生完成(或已失敗)——請檢查 shipments[].label.labelRequestStatusCode。
授權
Your API key
Your API token — keep this private
查詢參數
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.
Return request identifier
Return request number
Your merchant-supplied reference, echoed back for reconciliation
Current return status code
Return title
Declared total value of the return
ISO 4217 currency code of totalValue (e.g. USD)
Warehouse-assigned RMA reference (uppercased). Populated once the warehouse processes the parcel.
Free-text remarks
Whether the return request is archived
Origin/source of the return request
Shipments belonging to this return request, each with its label.
Line items included in the return request.
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.
Custom fields attached to the return shipment.