获取退货库存详情

Get return inventory details

curl --request GET \
  --url https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventory \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>'

{
  "returnInventoryId": 123
}

GET

api

ReturnInventory

GetReturnInventory

Get return inventory details

curl --request GET \
  --url https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventory \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>'

{
  "returnInventoryId": 123
}

此页面由 AI 自动翻译。API 技术规格以英文呈现为标准。如有任何疑问，请参阅英文版本。

依据 returnInventoryId 获取单条退件库存记录的完整内容。常在收到 webhook（例如 inventoryCreated）后调用，以读取当前状态。

库存图片

响应中包含 returnRequestLineItemImages[] 数组，列出附加到库存对应行项目上的图片。该端点返回的是 S3 key，而不是 URL —— 要展示或拉取图片，请用您所在环境的主机名与 key 拼接出 URL。

条目结构

每条记录提供同一张图片的四种尺寸变体，便于您按 UI 用途选用：

字段	典型用途
`s3SmallFileKey`	列表视图的缩略图
`s3MediumFileKey`	详情视图的预览
`s3LargeFileKey`	全屏预览
`s3OriginalFileKey`	原始上传（最大；仅在需要未缩放图时使用）

构造 URL

按环境选择主机名：

环境	图片主机名
沙箱（UAT）	`rr-dev-files.returnshelper.com`
生产	`file.returnhelpercentre.com`

公式：

URL = "https://" + <图片主机名> + "/" + <key>

生产环境示例：

s3MediumFileKey = "img/returns/202606/27_1000040536_lmpiohbx.5n3_medium.jpg"
                  ↓ 拼接
URL             = "https://file.returnhelpercentre.com/img/returns/202606/27_1000040536_lmpiohbx.5n3_medium.jpg"

key 已经包含完整的 S3 路径。拼接出来的 URL 公网可访问，不需要认证头，也不会过期；URL 与图片内容均可在客户端安全缓存。

请将路径视为不透明。 Return Helper 历史上使用过多种路径前缀（例如 img/returns/... 与 images/returns/...）；只有主机名是稳定的。请勿解析、校验或对路径/文件名做任何模式匹配。

无图片时的空状态：returnRequestLineItemImages: []。

本端点返回的是查询那一刻的当前状态。如需在仓库人员添加、替换或删除图片时实时收到通知，请订阅 changeLineItemImage webhook，而非反复轮询本端点。

库存图片

条目结构

构造 URL

相关

授权

查询参数

响应

​库存图片

​条目结构

​构造 URL

​相关

授权

查询参数

响应

库存图片

条目结构

构造 URL

相关