跳转到主要内容
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