Skip to main content
GET
Get return shipment details
このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。
Return Shipment を作成 から返される returnRequestId を使って、単一の返品シップメントの完全なレコード(シップメント、明細、ラベル、カスタムフィールド)を取得します。 返品シップメントは倉庫到着前のパーセルを表します。倉庫がパーセルを登録すると返品在庫アイテムになります。その段階以降は、入荷後の処理データを持つ 取得 返品在庫 詳細 を使用してください。

見逃したラベルの復旧

ラベルは shipments[].label.labelUrl にあります。このエンドポイントの主な用途はシステム障害後の突合です。受信側がラベル通知を見逃した場合、returnRequestId で呼び出して現在の labelUrltrackingNumber を直接読み取れます。labelUrl が空の場合は生成が未完了(または失敗)であることを意味します——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.