Return Inventory ID で VAS を作成

Create VAS by return inventory ID

curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "createVasList": [
    {
      "returnInventoryId": "<string>",
      "createVasDetailList": [
        {
          "vasCode": "<string>",
          "notes": "<string>",
          "metaQuantity": 123,
          "vasFileList": [
            {
              "filename": "<string>",
              "fileKey": "<string>"
            }
          ]
        }
      ]
    }
  ]
}
'

{
  "data": [
    {
      "returnRequestLineItemId": 123,
      "createVasDetailList": [
        {}
      ]
    }
  ]
}

POST

api

Vas

CreateByReturnInventoryId

Create VAS by return inventory ID

curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "createVasList": [
    {
      "returnInventoryId": "<string>",
      "createVasDetailList": [
        {
          "vasCode": "<string>",
          "notes": "<string>",
          "metaQuantity": 123,
          "vasFileList": [
            {
              "filename": "<string>",
              "fileKey": "<string>"
            }
          ]
        }
      ]
    }
  ]
}
'

{
  "data": [
    {
      "returnRequestLineItemId": 123,
      "createVasDetailList": [
        {}
      ]
    }
  ]
}

このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。

受領済みの返品在庫に対して 1 件以上の付加価値サービス（VAS）——品質検査、再梱包、撮影、パーセル分割など——をリクエストします。倉庫が VAS を実行し、結果は後続の webhook イベントで報告されます。

前提条件

対象在庫アイテムがアカウントに存在していること。returnInventoryId は newInventoryCreated webhook イベントで配信されるため、自社側でキャッシュしてください。
各対象在庫の handlingCode が ohd（保留）であること。VAS は在庫が保留状態のときのみ許可されます。すでに別のハンドリング経路に入っている場合は、まず返品在庫ハンドリングを更新で ohd に戻してください。
有効な vasCode 値はすべての VAS を取得から選んでください。

必須フィールド

createVasList — 空でないペイロードのリスト。各ペイロードが 1 件の在庫と、その上の 1 件以上の VAS リクエストをカバーします。

ペイロードごと：

returnInventoryId — long にパース可能な文字列。存在し、保留状態であること。
createVasDetailList — VAS 詳細オブジェクトのリスト。各項目は vasCode とその VAS 固有のフィールドを保持します。

returnInventoryId はバッチ全体でユニークである必要があります——同一呼び出しで同じ在庫に 2 つのペイロードを作ることはできません。

分割パーセルルール

ペイロード内のいずれかの VAS が vasCode: SPLIT_PARCEL を使う場合：

そのペイロードの createVasDetailList における 唯一の VAS でなければなりません（同じ在庫の 1 つのペイロード内で他の VAS と組み合わせることはできません）。
ファイル添付は SPLIT_PARCEL のみで許可され（通常必須）、他の VAS コードでは添付できません。

このルールが課されているのは、分割が物理在庫の形態を変えるためで、他の VAS と同梱すると処理順序が曖昧になります。

副作用

VAS が保留中の間、在庫のハンドリングは ohd のままです。
後続の webhook イベントが進捗を報告します：vasUpdated、そして分割パーセルの場合は splitLineItem および newInventoryCreated（分割アイテム用）。
分割パーセル VAS の完了により、追加の在庫レコード（分割後のアイテム）が生成される場合があります。

Return Inventory ID で VAS を作成

前提条件

必須フィールド

分割パーセルルール

副作用

関連

承認

ボディ

レスポンス

​前提条件

​必須フィールド

​分割パーセル ルール

​副作用

​関連

承認

ボディ

レスポンス

前提条件

必須フィールド

分割パーセルルール

副作用

関連