List return inventories with pagination
退货库存
列出 Return Inventories(分页)
GET
List return inventories with pagination
返回退件库存记录的分页列表——即仓库侧的逐项状态。每条记录代表一个已收到的物品,包含当前的处理决定、RMA、SKU 映射与所属仓库。
仅在以下情况调用
- 一次性回填:首次集成时,于订阅 webhook 之前,将既有库存写入本地数据库。
- 定期对账:用以侦测遗漏或乱序的 webhook 推送——将本地缓存与本端点结果比对。
必要参数
createFrom/createTo— 均必填,ISO 8601 时间戳。范围上限为 62 天(SearchConfig.simpleRecordsMaxDays),超出会返回软错误。具体语义请见下方的 窗口语义。pageSize— 介于1与50之间。offset— 非负整数。配合pageSize用于按位移分页。
响应说明
totalNumberOfRecords(顶层字段,与data同层)为当前窗口的总条数——分页时以此作为上限。handlingCode反映当前的处理决定——可呼叫 更新退件库存处理 修改。handlingStatusCode反映该处理决定的工作流状态;可透过 取得所有处理状态 转译。- 物品的 RMA(
rma)是仓库分配的识别码,并非您卖家侧的参考号。
历史库存回填
可用本端点把每一条既有的退件库存载入您的本地数据库,之后一律改用 webhook 接收后续事件。由于 API 对每次请求的时间范围上限为 62 天,整体流程是「以 62 天为一格的滑动窗口,每格窗口内分页、窗口依序往前推」,直至覆盖账号开通日。窗口语义
开始写循环前,请先理解以下两条规则——这是「干净回填」与「静默漏一天」之间的分界线。-
验证器规则(日历日差):
比较前会先把两端的时分秒归零。所以
createFrom = 2024-03-13T15:00:00Z、createTo = 2024-05-14T09:00:00Z的请求仍然有效(May 14 − Mar 13 = 62天),即使实际墙钟时长略短于 62 × 24 小时。 -
数据过滤(两端整日均包含):
也就是说,服务端会把
createFrom扩展到当日00:00:00.000,createTo扩展到当日23:59:59.999,再进行过滤。因此一次合法请求实际覆盖 63 个连续日历日的数据(createFrom 当日整天、createTo 当日整天、以及之间所有天)。
createFrom 直接用作窗口 N+1 的 createTo,那一天会同时出现在两个窗口的结果中。这是重复,不是漏单——算法绝不会漏单,仅在每个窗口接缝处多抓约一天的数据。只要本地数据表以 returnInventoryId 为主键并使用 UPSERT(或 INSERT IGNORE),重复自动合并,最终数据完全正确。
如要彻底避免重复抓取,每次迭代后改为 windowEnd = windowStart − 1 day(而非 windowEnd = windowStart),每个窗口就是无重叠的全新 63 天切片。两种写法都正确;下方示例采用「容许接缝重叠」版本,因为它对客户端与服务端之间的时钟漂移更宽容,是推荐的默认。
回填算法
- 选定
historyStart(例如账号开通日)。 - 以
windowEnd = now()起步。 - 计算
windowStart = max(windowEnd − 62 天, historyStart)。 - 在窗口内,从
offset = 0开始按pageSize翻页,直到offset ≥ totalNumberOfRecords。每条记录以returnInventoryId为主键 UPSERT 写入本地数据库。 - 设
windowEnd = windowStart,回到第 3 步继续,直至windowEnd ≤ historyStart。 - 之后改由
newInventoryCreatedwebhook(以及其他库存生命周期事件)维护本地数据;除非怀疑 webhook 数据丢失,否则无需重跑本回填。
代码示例
相关
- 取得退件库存详情 — 当 webhook 提及未缓存的
returnInventoryId时,按 ID 取得单条记录。 - 按行项目 ID 取得退件库存 — 按您的
returnRequestLineItemId查询。 - 更新退件库存处理 — 写入侧端点。
- 取得所有处理状态 与 取得所有处理类型 — 代码到标签的映射。
- Webhooks — 库存生命周期事件的标准管道。请先设置 webhook 再使用本端点。
授权
Your API key
Your API token — keep this private
查询参数
Number of records per page (1–50)
必填范围:
1 <= x <= 50