吉客云退换补货单分页查询接口字段手册:从拍扁结构到增量同步的实战权威教程
这个接口解决什么问题
在零售与电商的供应链集成中,售后单据(退货、换货、补货)的高频回流是库存回冲、对账结算与财务核算的核心数据源。吉客云「分页查询退换补货单」接口正是承担这一职责的主数据出口——它把源系统里的售后单主表与明细数组一次性吐出,经「拍扁」处理后供金蝶云星空等下游 ERP 进行供应链单据落库。本接口的存在,直接打通了电商售后与 ERP 财务库存之间的数据断点。
接口能力总览
吉客云采用标准的 AppKey + 签名 token 的认证模式,请求体以 JSON 形式提交,典型入参包含 pageNo、pageSize、startModified、endModified、tradeAfterStatus 等。响应体为分页结构,核心字段包络在 data 列表中,每条记录内含一个嵌套数组 returnChangeGoodsDetail,需经过拍扁后变为多行。增量同步以 gmtModified 字段为时间窗依据,分页游标以页码递进为主,pageSize 一般控制在 50-200 条以平衡吞吐与超时风险。
典型字段映射
| 字段名 | 类型 | 含义 | 实战注意事项 |
|---|---|---|---|
| tradeAfterId | string | 售后单在源系统中的唯一标识 | 主键,下游落库的去重键 |
| returnChangeNo | string | 退换补货单业务编号 | 对账与业务追溯的核心编码 |
| tradeNo | string | 关联原始销售订单号 | 跨单据关联的桥梁字段 |
| tradeAfterFrom | string | 售后单来源(1手工/4纠纷/5Excel/6门店/7网店/8错漏) | 字典值需完整映射,8 个枚举不可遗漏 |
| tradeAfterStatus | string | 售后单状态 | 状态机超过 14 个码值,需全量维护 |
| deliveryNo | string | 关联收货/入库单号 | 与金蝶入库单联查的关键 |
| consignTime | datetime | 原订单发货时间 | 时区为源系统本地时区 |
| gmtCreate | datetime | 售后单创建时间 | 用于首次全量拉取排序 |
| auditTime | datetime | 审核时间 | 状态机跳变点,常用于触发器 |
| deliveryTime | datetime | 收货/入库时间 | 库存回冲业务的核心时间戳 |
| gmtModified | datetime | 最后修改时间 | 增量同步的基准字段 |
| shopCode / shopName | string | 销售渠道编码/名称 | 与金蝶客户档案关联 |
| flagNames | string | 业务标记/标签 | 复合值,需拆分后使用 |
| returnChangeGoodsDetail | array | 退换货明细(嵌套) | 拍扁前必须展开 |
| returnChangeGoodsDetail_goodsNo | string | 拍扁后:明细货品编码 | 落库到金蝶物料档案的唯一键 |
| returnChangeGoodsDetail_goodsName | string | 拍扁后:明细货品名称 | 注意特殊字符与编码 |
| returnChangeGoodsDetail_returnCount | float | 拍扁后:退货/换货数量 | 数值精度保留 4 位 |
| returnChangeGoodsDetail_shareShouldReturnFee | float | 拍扁后:明细分摊应退金额 | 财务对账的核心字段 |
| returnChangeGoodsDetail_subTradeId | string | 拍扁后:明细行唯一标识 | 幂等去重的关键 |
| aa | string | 占位/扩展字段 | KEY 变量,非业务含义 |
在轻易云上如何配置
在轻易云数据集成平台里,这个接口通常以「吉客云适配器 → 拍扁转换器 → 字段映射器」三段式封装。适配器负责签名拼装与分页拉取,平台会自动管理 pageNo 递进与 gmtModified 时间窗;拍扁转换器把嵌套数组展开为扁平行,字段后缀(_goodsNo、_returnCount 等)由平台自动派生;字段映射器则把拍扁后的字段拖拽映射到金蝶云星空的售后入库单、收款单等目标单据,并支持表达式做单位换算、码值翻译与空值兜底。在多个客户项目里,我们发现这种三段式配置能把售后单同步策略的开发周期从一周压缩到半天。
跨方案实战要点
- 拍扁是必修课,不是可选项。真实场景中,售后单几乎都是一主多细结构,直接落库会让下游金蝶星空只收到主表,明细全部丢失,库存回冲必然错乱。
- 状态机码值必须全量维护。吉客云售后单状态超过 14 个(含 10081、10082 等子状态),缺一个就可能把「已取消-被合并」当成「已取消」处理,造成重复入库。
- 增量窗口要预留缓冲。
gmtModified在源系统存在秒级精度与时区偏移,稳妥做法是把startModified往前回拨 2-5 分钟,避免边界数据漏拉。 subTradeId是明细幂等键。拍扁后用「主键 +subTradeId」组合去重,比单独用tradeAfterId可靠得多。- 金额分摊字段要二次校验。
shareShouldReturnFee在源系统可能存在四舍五入差,合计与主表金额偶尔偏差 0.01 元,落库前最好做一次尾差吸收。 flagNames拆分后再用。多个业务标记以分隔符拼接,不要直接当维度字段,拆分为多值字段后再参与过滤逻辑。
踩坑复盘
- 坑一:明细被压平成空数组。某零售企业的第一版集成方案忘了挂拍扁转换器,导致金蝶侧只看到主表,退货数量永远为 0,库存回冲直接错乱一周才被发现。稳妥的做法是配置完成后立刻抽样验证明细行数。
- 坑二:状态 10081/10082 被忽略。这两个子状态在旧版文档里没有,工程师直接按 8 位状态写判断,结果「已取消-被合并」的单据被当成正常取消,触发了重复结算。
- 坑三:增量边界漏单。仅按整点对齐
gmtModified,在分页跨越整点时会丢掉 1-2 条变更。建议把窗口往前回拨并增加补跑机制。 - 坑四:
aa字段被误当业务字段。这个字段本质是 KEY 变量占位符,某次方案里被工程师映射成下游的备注,导致金蝶侧出现大量「aa」字符串。 - 坑五:
shareShouldReturnFee精度丢失。直接用 float 类型映射到金蝶的 decimal 字段,被截断到 2 位后,合计出现分差。稳妥做法是在映射器里显式保留 4 位小数。
何时选用
该接口适用于售后单回流密集、需要与 ERP 财务库存强联动的零售、电商、分销场景;当业务仅需要售后主表概览、不涉及明细落库时,可考虑其他轻量接口;当业务需要实时单笔查询而非批量同步时,分页接口并非最优选择。