跳轉到主要內容
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 技術規格以英文呈現為標準。如有任何疑問,請參閱英文版本
為已收到的退件庫存請求一項或多項加值服務(VAS)——品質檢驗、重新包裝、拍照、拆分包裹等。倉庫執行 VAS 後,會透過後續 webhook 事件回報結果。

前置條件

  • 目標庫存項已存在於您的帳戶。returnInventoryIdnewInventoryCreated webhook 事件推送——請在自有端快取。
  • 每筆目標庫存的 handlingCode 必須為 ohd(暫存)。VAS 僅在庫存為暫存時允許;若已進入其他處理路徑,請先透過 更新退件庫存處理 移回 ohd
  • 取得所有 VAS 選擇有效的 vasCode

必填欄位

  • createVasList — 非空 payload 列表。每個 payload 對應一筆庫存與一項或多項 VAS 請求。
每個 payload 內:
  • returnInventoryId — 字串,必須可解析為 long;必須存在且為暫存狀態。
  • createVasDetailList — VAS 明細物件列表,每項含 vasCode 與該 VAS 專屬欄位。
整批請求中 returnInventoryId 必須唯一——同一呼叫中不可對同一庫存建立兩個 payload。

拆分包裹規則

若任一 payload 中的 VAS 使用 vasCode: SPLIT_PARCEL
  • 該 VAS 必須是該 payload createVasDetailList 中的唯一一項(不能與其他 VAS 同 payload 同庫存併用)。
  • SPLIT_PARCEL 允許(且通常需要)檔案附件。其他 VAS 代碼不可附件。
之所以強制此規則,是因為拆分會改變物理庫存形態;與其他 VAS 同 payload 會造成處理順序不明。

副作用

  • VAS 處理期間,庫存的處理保持在 ohd
  • 後續 webhook 事件會回報進度:vasUpdated,以及拆分包裹時的 splitLineItemnewInventoryCreated(針對拆分件)。
  • 拆分包裹 VAS 完成時,可能產生額外的庫存紀錄(拆分後的物品)。

相關

授權

x-rr-apikey
string
header
必填

Your API key

x-rr-apitoken
string
header
必填

Your API token — keep this private

主體

application/json
createVasList
object[]
必填

List of VAS creation payloads grouped by return inventory ID

回應

Success

data
object[]

List of created VAS