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