跳轉到主要內容
POST
/
api
/
Recall
/
createRecallByReturnInventoryId
Create recall by return inventory IDs
curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/Recall/createRecallByReturnInventoryId \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "returnInventoryIdList": [
    123
  ]
}
'
{
  "recallList": [
    {
      "apiId": 123,
      "recallId": 123,
      "warehouseId": 123,
      "recallNumber": "<string>",
      "recallStatusCode": "<string>",
      "warehouseRemarks": "<string>",
      "recallInventoryList": [
        {}
      ]
    }
  ]
}
此頁面由 AI 自動翻譯。API 技術規格以英文呈現為標準。如有任何疑問,請參閱英文版本
為已抵達倉庫的一個或多個退件庫存項建立召回請求。召回會將物品從倉庫再次寄出,目的地為我們的香港倉庫。

前置條件

  • 目標庫存項必須已存在於您的帳戶。returnInventoryIdnewInventoryCreated webhook 事件推送——整合應在自有端快取。
  • 每筆庫存目前的 handlingStatusCode 必須可依處理狀態機推進至召回(Handling.rtn)——通常 pendingohd 狀態可用。
  • 任何一項都不可處於已啟用(未取消)的召回中。
  • 任何項所屬行項目都不可存在待處理的 VAS——請先處理。

必填欄位

  • returnInventoryIdList — 非空 List<long>

副作用

  • 每筆庫存的 handlingCode 會被設為 rtn
  • 每筆庫存的 RMA 對映會被鎖定,禁止交換。
  • 召回履行為非同步;狀態更新透過 webhook 推送(recallShipmentDispatchedrecallDelivered 等)。

相關

授權

x-rr-apikey
string
header
必填

Your API key

x-rr-apitoken
string
header
必填

Your API token — keep this private

主體

application/json
returnInventoryIdList
integer<int64>[]
必填

List of return inventory IDs

回應

Success

recallList
object[]

List of created recalls