金蝶云星辰物流公司查询接口字段手册权威教程
聚水潭金蝶云星辰聚水潭集成物流公司主数据轻易云 OpenAPI轻易云教程跨系统同步
这个接口解决什么问题
在零售业跨系统集成里,物流公司是销售出库、发货、运输结算的共同主数据。聚水潭侧需要稳定的物流公司编码与联系方式,金蝶云星辰侧负责维护官方主数据。通过 /jdy/v2/bd/logistics_company 这个查询接口,可以把金蝶的物流公司主数据稳定地同步到聚水潭,支撑发货单映射、物流费用结算和编码对照,避免两边手工维护。
接口能力总览
- 认证方式:金蝶云星辰 V2 标准的 OpenAPI 鉴权,需在请求头携带 AccessToken(通过
/jdy/v2/oauth/token获取),通常配合 AppKey/AppSecret 使用。 - 请求结构:GET
/jdy/v2/bd/logistics_company,支持page、page_size两个分页参数;明细数据通过otherRequest.detailAPI(/jdy/v2/bd/logistics_company_detail)获取。 - 响应结构:标准 JSON,包含
data(数组)与分页元数据(总条数、总页数)。每条记录同时提供id(主键)和number/bill_no(业务编码)。 - 分页/增量模式:基于页码分页(默认
page_size=10),定时任务按*/5 * * * *轮询;增量判断一般依赖modify_time做时间戳增量。 - 策略类型:
effect: QUERY,Target 配置为「写入空操作」,属于纯查询主数据策略。
典型字段映射
| 字段名 | 类型 | 含义 | 实战注意事项 |
|---|---|---|---|
| id | string | 金蝶内部主键 | 跨系统传输时映射为聚水潭的 logistics_company_id,建议做幂等键 |
| bill_no | string | 物流公司单据编号 | 跨系统匹配的核心编码,务必做唯一性校验 |
| contact_linkman / contact_phone | string | 联系人 / 联系电话 | 常用于聚水潭承运商档案 |
| contact_country/province/city/district_*** | string | 联系地址四要素 | 国家/省/市/区以 ID、Name、Number 三种形式返回,按需映射 |
| contact_address | string | 联系地址详情 | 拼接省市区使用,建议目标侧统一存全地址 |
| dispatcher_country/province/city/district_*** | string | 发货地址四要素 | 适用于「联系地 ≠ 发货地」的物流公司 |
| dispatcher_address / dispatcher_linkman / dispatcher_phone | string | 发货地址与联系人 | 在轻易云字段映射器里通常作为独立分组映射 |
| recevice_delivery | string | 接货方式 | 字段名存在拼写(应为 receive),目标侧建议做兼容映射 |
| delivery_type_id/name/number | string | 配送方式 | 跨系统时按编码对照,避免名称歧义 |
| payment_entry / cus_bear_fee_entry / attachments_url / custom_field | object | 付款/费用/附件/扩展 | 结构化对象,需参考金蝶官方文档解析 |
| total_amount / total_un_settle_amount / deduction_balance / all_debt / last_debt | string | 结算与欠款 | 字符串型数字,建议 BigDecimal 解析,警惕精度问题 |
| setting_term_*** / currency_id / due_date | string | 结算条款 / 币种 / 到期日 | 用于运费结算对账 |
| bill_status / trans_type / io_status | string | 业务状态 | 用于增量同步过滤条件 |
| creator_*** / modifier_*** / auditor_*** / create_time / modify_time / audit_time | string | 审计字段 | 增量同步常以 modify_time 为锚 |
| f_logistics_id / customer_id / dept_*** / emp_*** | string | 业务关联 | 用于物流公司层级、客户归属与责任划分 |
在轻易云上如何配置
- 适配器:在轻易云「数据源管理」里新建「金蝶云星辰 V2」连接,填入租户 ID、AppKey/AppSecret,先调用
/jdy/v2/oauth/token拿到 AccessToken。 - 接口封装:选择「金蝶云星辰 · 业务单据」分类下的「物流公司查询」模板,请求方法默认 GET,自动追加
page、page_size。 - 元数据映射:metadata 中将
id指向id字段,number指向bill_no,并开启idCheck: true与autoFillResponse: true。轻易云字段映射器会自动展开contact_*、dispatcher_*分组,并支持「省/市/区 + 详情地址 → 全地址」合并规则。 - 明细下钻:在「其他请求」里勾选
detailAPI,把/jdy/v2/bd/logistics_company_detail作为明细接口,主表查询后自动按id拉取明细。 - 写入策略:本策略为纯查询,Target 配置为「写入空操作」,通常作为主数据前置任务,依赖它的下游任务(如销售出库单同步)按
depends_on串行执行。
跨方案实战要点
- 主键 + 编码双轨制:金蝶侧同时返回
id和bill_no,在轻易云里我们坚持「id 做幂等键、bill_no 做业务编码」,避免下游因编码变更导致匹配失败。 - 地址分组要分别处理:contact_(联系地址)与 dispatcher_(发货地址)结构完全一致但语义不同,绝不能合并到同一个目标字段,否则发货地址会被覆盖。
- object 字段按需解析:
payment_entry、cus_bear_fee_entry、attachments_url、custom_field都是结构化对象,轻易云支持 JSONPath 提取,但建议先在「响应预览」里看完整结构再写表达式。 - 增量同步选 modify_time:在多个零售客户项目里,物流公司变更频率低但偶有调整,用
modify_time做增量过滤比全量扫描稳得多,建议每 5 分钟跑一次。 - 金额字段统一 BigDecimal:
total_amount、all_debt等都是 string 类型,跨系统传输时务必用 BigDecimal 解析,避免浮点精度差导致对账不平。 - 拼写兼容:
recevice_delivery是金蝶接口保留的拼写问题,目标侧最好同时兼容receive_delivery与recevice_delivery,防止后续升级被清空。
踩坑复盘
- page_size 默认 10,导致首次同步漏数据:金蝶默认每页仅 10 条,物流公司超过 10 家就会被分页截断。稳妥做法是在轻易云策略里显式把
page_size调到 50 或 100,并在分页器里设置最大页数保护。 - 把 id 当编码同步:直接把金蝶的
id同步成聚水潭的物流公司编码,后续若金蝶侧重建主键,聚水潭端就找不到对应记录。我们一律用bill_no作为业务编码,id仅做内部幂等。 - 发货地址被联系地址覆盖:源数据两条地址都叫「address」,映射时容易配错字段。轻易云字段映射器会按
dispatcher_*前缀明确分组,工程师只需把分组对齐即可。 - object 字段被当成字符串写入:
payment_entry等 object 类型若原样写入目标,会变成[object Object],必须用轻易云的 JSONPath 或脚本节点展开后再映射。 - 增量字段缺失导致全量重跑:少数客户未启用
modify_time,策略每次都全量。建议在轻易云「字段设置」里把modify_time标为「增量字段」,并在过滤器里启用「按修改时间增量」。
何时选用
适合「需要把金蝶云星辰作为物流公司主数据来源,跨系统同步到电商 ERP、零售中台或 WMS」的场景;如果只是单向从金蝶读取发货单物流信息,可直接复用销售出库单接口;若目标侧已是物流公司主数据源,则本接口可省去。
本文为原创内容,转载请注明出处:https://www.qeasy.cloud/insights/engineering/hb-p2-249-0f42