メインコンテンツへスキップ
POST
/
api
/
ReturnInventory
/
UpdateReturnInventoryHandling
Update return inventory handling
curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/ReturnInventory/UpdateReturnInventoryHandling \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "returnInventoryId": 123,
  "handlingCode": "<string>"
}
'
{
  "correlationId": "<string>",
  "meta": {
    "status": 123,
    "data": {},
    "errorCode": "<string>",
    "error": {}
  }
}
このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。
1 件の返品在庫レコードのハンドリング決定を更新します——つまり、倉庫が受領したパーセルをどう扱うかを指示します。多くは倉庫がパーセルをログ済みの後に呼び出されます。これ以降、在庫は選択されたハンドリング(再入庫、廃棄、リコール、再送など)の経路を辿ります。

呼び出すタイミング

  • カスタマーサポートまたはオペレーションチームがハンドリングを決定した後。

必須フィールド

  • returnInventoryId — long。存在し、アカウントに属していること。倉庫でパーセルがログされたタイミングの newInventoryCreated webhook イベントで配信されます。後続の処理に備え、自社側でキャッシュしてください。webhook ストリームが在庫 ID の真実のソースです。
  • handlingCode — 文字列。すべてのハンドリングタイプを取得 が返す値のいずれかである必要があります。直接 rsd(再送)や tbc(未確定)には設定できません——専用エンドポイントを使ってください。よく使う値:ohd(保留)、rtn(リコール)、rst(再入庫)、dsp(廃棄)。
明示的な例外:現在の handlingStatusCodepending で、新しいハンドリングが ohd(保留)の場合は常に許可されます——調査中に在庫を保留状態へ移すのに便利です。 次の場合はハンドリングを更新できません
  • 在庫の所属ラインアイテムに保留中の VAS(付加価値サービス)リクエストがある。先に すべての VAS を取得 と VAS エンドポイントで VAS をキャンセルまたは完了させてください。

副作用

  • 在庫レコードの handlingCodehandlingStatusCode が更新されます。
  • 新しいハンドリングが ohd または oth(その他)でない場合、当該在庫の RMA スワップを防ぐため RMA マッピングがロックされます。

関連

承認

x-rr-apikey
string
header
必須

Your API key

x-rr-apitoken
string
header
必須

Your API token — keep this private

ボディ

application/json
returnInventoryId
integer<int64>
必須

Return inventory ID to update handling for

handlingCode
string
必須

Handling code to apply

レスポンス

Success

Universal response envelope. Successful responses include the business payload as additional top-level fields alongside correlationId and meta. Failed responses (auth errors, validation errors) only populate correlationId and meta, with meta.errorCode and meta.error describing the failure.

correlationId
string | null

Unique correlation ID for tracing the request through Return Helper systems.

meta
object

Application-level metadata for every API response. Inspect status and errorCode to detect soft-error responses (validation failures arrive as HTTP 200 with meta.status: 400).