You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

556 lines
35 KiB

# 恒健(HengJian / Efulfill)接入
语雀接口文档:<https://ehengjian.yuque.com/org-wiki-ehengjian-ocq8pc/tvzvkk>(book `tvzvkk`)
核对时间:2026-11-12(文档 `toc_updated_at` = 2026-11-10)
## 1. 基本信息
| 项 | 值 |
|---|---|
| 适配器 ID / provider | `hengjian` / `WarehouseProvider.HENGJIAN`(code 50) |
| 测试环境 | `https://pr-open-api.ehengjian.com` |
| 生产环境 | `https://open-api.ehengjian.com` |
| 鉴权 | 组织级固定 token,放请求头**两个**:`Authorization` + `x-api-key`,取值相同 |
| token 获取 | 文档未写自助方式:测试参数需联系 `bianyuqi@henglin.com` |
| token 续期 | 文档未提 refresh;先按固定 token 处理(不经过 `TokenManager`) |
| 限流 | 未公开,保守默认 2 req/s/仓 |
| 成功判定 | body 里 `code = 200`;HTTP 通常恒为 200 |
| 时间口径 | 文档多处注明 **UTC**(`paidAt`、`expectedShipDate`、订单列表的时间参数) |
| 单位 | 商品尺寸 cm、重量 g;费用单位为 USD(试算接口另有单位入参) |
| 文档结构 | 67 个目录项,其中 64 个可见接口页(3 个 `visible=0`,1 个抓取 403);另有 `CloudShip接口文档` / `加拿大邮政` 两个不相关目录,其下文档均不可见 |
### 鉴权真机结论(2026-11-12,未拿到有效 token)
| 请求 | 结果 |
|---|---|
| 不带任何授权头 | **HTTP 200** + `{"statusCode":500,"status":1,"code":999999,"message":"查询失败Unauthorized"}` |
| 只带 `Authorization`(无效值) | HTTP 500 + `{"status":500,"error":"Internal Server Error","message":"未知的账户!"}` |
| 只带 `x-api-key`(无效值) | 同上 |
| 两个都带(无效值) | 同上 |
**结论**:
- 未授权有两种表现(HTTP 200 + `code=999999`;HTTP 500 + 「未知的账户」),
适配器把两者都映射成 `AuthException`,**不能**当普通业务失败或瞬时故障——
否则宿主不会去刷新凭据,还会无意义重试。
- 用无效 token 区分不出「两个头是否都必须」,所以按文档两个都带。拿到有效 token 后
应补一次对照实验(各只带一个),再决定能否精简。
### 文档与实际不一致(待真机逐条确认)
| # | 文档写的 | 问题 |
|---|---|---|
| 1 | 《基础API调用》:`Authorization` 与 `x-api-key` 都必填、都叫「授权Token」 | 没说两者是否同值;两个头是否都必须未验证(见上) |
| 2 | 《库存变动明细查询》(2026-10-20 新增):「沿用现有 OpenAPI 凭证,请求头使用 `Authorization: Bearer <token>`」 | 与《基础API调用》的双头要求**冲突**;该页是后来单独写的,可能代表新约定 |
| 3 | 《获取仓库支持的物流渠道》:`warehouseCodes` 类型写 `STRING` | 请求示例是数组 `["..."]`;按数组下发 |
| 4 | 《批量查询库存》:GET,参数是 `warehouseCodes` LIST | HTTP GET 不能可靠表达数组;先按重复 query 参数下发 |
| 5 | 《查询库存》《查询 sku》等页:`code` 类型写 `STRING` | 其它页写 INTEGER;信封按文本读再转数字,两种都认 |
| 6 | 多个接口页**不写路径 / 请求方式**(调拨取消、销毁计划、退货 v2、计费类) | 只能从标题和相邻页推断;这几类未接入前不需要 |
| 7 | 《创建/编辑 产品》`length` vs 《查询 sku》`itemLength` | 同一概念两个字段名;接入商品前要真机确认哪个是「产品长」 |
| 8 | 试算 / 地址属性文档的路径写的是 `open-api.ehenglin.com`、`thebizark.com` | 与 `ehengjian.com` 不同域,疑似旧域名或从别家文档复制;接入前必须真机核对 |
| 9 | 几乎所有接口页**没有验签 / 请求头说明** | 真机返回早于业务码的 Spring 错误页,说明鉴权在网关层,文档没覆盖 |
| 10 | 《创建销售发货单》与 "Create Sale Order With Label" 是同一路径的两页 | 中文页把 `createdAt` 标必填、也没有 `isPrime`;英文页有 `isPrime`、没有 `customerRemark` / `warehouseRemark`。字段表按两页并集实现 |
| 11 | 建单页 `isPrime` 类型写 STRING | 请求示例给的是数字 `0`;按示例发 Integer |
| 12 | 建单页行级 `isSignature` 是 0~3 | 统一模型只有布尔,2 / 3(成人 / 间接签收)暂不可表达 |
> 运去哪的教训:只按文档写代码,有 4 处接口一个都跑不通。恒健的文档完整度更差
> (路径缺失、类型不一致、域名不一致),**接入任何写接口前必须先跑只读探针**。
## 2. 已接入(本期)
| # | 接口 | 路径 | 能力位 | 状态 |
|---|---|---|---|---|
| 1 | 获取当前组织仓库 | `POST /v2/warehouse/getWarehouse` | `DIRECTORY` | ✅ |
| 2 | 获取物流渠道(全量) | `POST /v2/carrierGroup/getCarrierGroup` | `DIRECTORY` / `LOGISTICS_PRODUCT` | ✅ |
| 3 | 获取仓库支持的物流渠道 | `POST /v2/carrierGroup/getWarehouseCarrierGroupServices` | 同上(适配器方法,非 capability) | ✅ |
| 4 | 创建 / 编辑产品 | `POST /v1/product/save` | `PRODUCT` | ✅ |
| 5 | 创建销售发货单 | `POST /v1/saleOrder/create` | `OUTBOUND` / `PLATFORM_LABEL_DELIVERY` | ✅ |
| 6 | 订单详情 | `POST /v1/saleOrder/findOne` | `OUTBOUND` | ✅ |
| 7 | 订单列表 | `GET /v1/saleOrder/findByPage` | `OUTBOUND` | ✅ |
| 8 | 订单取消 | `POST /v1/saleOrder/cancel` | `OUTBOUND` | ✅ |
| 9 | 物流异动单创建 | `POST /v1/trackingChange/create` | `TRACKING_CHANGE` | ✅ |
| 10 | 物流异动单查询 | `POST /v1/trackingChange/findOrder` | `TRACKING_CHANGE` | ✅ |
| 11 | 仓储费明细 | `POST /v1/chargingSettlement/getChargingStorageSettlement` | `FEE_SETTLEMENT` | ✅ |
| 12 | 尾程配送费明细 | `POST /v1/chargingSettlement/getChargingTailDeliverySettlement` | `FEE_SETTLEMENT` | ✅ |
| 13 | 作业费明细 | `POST /v1/chargingSettlement/getChargingOperationSettlement` | `FEE_SETTLEMENT` | ✅ |
| 14 | 回调 | — | — | ❌ 文档无回调页 |
前三个接口是无副作用查询、不依赖单号,用来先验证鉴权与信封;商品保存是写接口,
但只写主数据、不产生履约单据,所以放在第二阶段。出库下单是真正的履约写操作,
门面强制经幂等守卫(`warehouseCode + outboundRequestNo + create`)。
### 返回形状差异
| 接口 | `data` |
|---|---|
| `getWarehouse` | 数组 |
| `getCarrierGroup` | 数组 |
| `getWarehouseCarrierGroupServices` | **对象**:`{"EFCA":[{...}], "EFGA":[...]}` |
第三个接口只取请求的那个仓的键——别的仓的渠道混进来,会把「仓不支持该渠道」
推到仓方去报错。
### 字段口径
| 统一模型字段 | 恒健字段 | 说明 |
|---|---|---|
| `WarehouseFacility.warehouseCode` | `warehouseCode` | 唯一标识,下单也用它 |
| `WarehouseFacility.providerWarehouseId` | — | 恒健没有独立内部 id,恒为 null |
| `WarehouseFacility.contactName/mobilePhone/email` | — | 文档仓对象没有这三个字段,**恒为 null**(平台限制) |
| `WarehouseFacility.postcode` | `postal` | 字段名不同 |
| `LogisticsProduct.logisticsProductCode` | `code` | 下单的 `carrierCode` 用它 |
| `LogisticsProduct.logisticsProductName` | `carrier` + `carrierServiceName` | 统一模型只有一个名称字段,拼成「UPS - Ground」 |
| `LogisticsProduct.crossCountry` | — | 恒健无此维度,恒 false(**不是**「不支持跨国」) |
### 商品保存(`/v1/product/save`)
**保存语义**:同一 SKU 再调即更新,没有单独的 create / update 接口,也不像信仓那样
要先查一次再决定调哪个。响应只有 `code / message`,**没有 data**,所以:
- `ProductResult.status` 固定为 `SAVED`;
- `ProductResult.rawStatus` 取仓方的 `message`(如「产品创建成功」);
- 仓方不告诉这次是新建还是更新,**不替它编** `ADDED` / `UPDATED`。
**三组尺寸不能互相顶替**:
| 恒健字段 | 含义 | 必填 | 统一模型 |
|---|---|---|---|
| `length / width / height / weight` | 产品(发货单元)尺寸与重量 | 是 | `lengthCm / widthCm / heightCm / weightGrams` |
| `itemLength / itemWidth / itemHeight` | 单品尺寸 | 否 | `itemLengthCm / …`(未给不发) |
| `packedLength / packedWidth / packedHeight / packedWeight / packedQty` | 外箱尺寸、外箱重量、装箱数量 | 是 | `packedLengthCm / … / packedQuantity` |
把单品尺寸填进 `length` 会让仓方的计费重与货架位算错,所以适配器不做任何回退填充。
**本地拒绝的必填项**(恒健要求、统一模型不强制):
`nameEn`、`description`、`packingType`(0 原包装 / 1 重新打包)、外箱四项尺寸重量、
`packedQty`。缺任何一项直接抛 `IllegalArgumentException`,**一个请求都不发**。
**不在报文里编造字段**:
| 统一模型字段 | 为什么不发 |
|---|---|
| `imageUrl` | 恒健的 `imageUrls` 是「产品测量图片」(复核长宽高用),不是商品主图;语义不同 |
| `packageStyle` | 恒健的 `isSpecialOuterPackaging` 是「是否特殊外包装」,不是同一套码 |
| `requireSn` / `snManagementMode` / `lotControl*` | 文档无对应字段 |
| `hsCode` / `countryOfOrigin` / `declaredValue` | 恒健只收报关名称(`customName` / `customNameEn`),没有 HS 与原产国 |
| `link` / `returnDealMethod` / `productCategory` | 文档无对应字段 |
**其它口径**:
- `isInsuranceFlag` 是 `Y` / `N`(不是 0 / 1);未指定则整组不发。
- `expirationDate` 只在 `expirationControl = 1` 时发送,避免仓方存「有天数但未启用」的脏数据。
- `cost` 与 `currency` 成对发送;`cost` 缺失则两个都不发。
- 单位与统一模型一致(cm / g),**不做换算**。
### 创建销售发货单(`/v1/saleOrder/create`)
中英文两页文档是**同一个接口**(中文页「创建销售发货单(带附件的)」、英文页
「Create Sale Order With Label」),按两页并集实现。
**必填字段**:`orderNo`、`shipToCountry`、`shipToState`、`shipToCity`、`shipToPostal`、
`shipToAddress1`、`shipToContact`、`shipToTelephone`、`createdAt`、`productItems`、
`attachInfoItems`。适配器在本地逐项校验,缺任何一项直接抛 `IllegalArgumentException`,
**一个请求都不发**。
**几个关键口径**:
| 项 | 处理 |
|---|---|
| `createdAt` | 统一模型没有该字段,用调用方注入的 `Clock` 生成下单时刻(请求侧时间戳,不是编造数据)。恒健不拿它去重 |
| 时间格式 | 恒健是 **UTC** 的 `yyyy-MM-dd HH:mm:ss`,固定按 UTC 格式化,**不用** `WarehouseContext.zone()`——那个时区是给「仓方回传的无时区本地时间」用的,方向相反 |
| `skuAmount` | 是「当前 SKU **总**金额」,不是单价:有 `totalAmount` 直接用,没有就用申报单价 × 数量 |
| `isSign` / `isSignature` | 恒健挂在**行**上且必填;统一模型挂在**命令**上(布尔)。取命令值套到每一行 |
| 签收类型 | 统一模型只有布尔,表达不了成人签收(2) / 间接签收(3),统一映射成**直接签收(1)**——比静默降成「不签收(0)」安全 |
| `isInsure` / `insureAmount` | 由「行是否有保价金额」推导;有金额即视为保价并带上金额 |
| `attachInfoItems` | **必填**。没有附件时发**空数组**而不是省略字段;平台面单(base64)会剥掉 `data:` 前缀后放进 `file`,`type=0`,名称优先用跟踪号 |
| `salesPlatform` | 恒健没有平台维度(店铺路由走 `channelAccount`),**不发**,也**不**拿它推 `isDFOrder`——VC 订单里只有一部分是 DF |
| `splitOrder` / `packages` | 恒健没有拆单与包裹入参,忽略 |
| `estimatedDeliveryTime` | 恒健只有 `expectedShipDate`(要求发货时间),没有送达时间 |
**响应**:只回 `data.orderId`(仓内部**数字** id,不是字符串单号)。取消接口要
`orderId` + `orderNo` 两个都传,所以这个 id 必须随 `OutboundReceipt.providerOrderId()`
落库;拿不到就报错,**不当创建成功**。
**未接入**:订单上传附件、物流异动单取消。调用这些方法会显式抛异常,不返回 null——
静默返回空会让调用方以为「仓说没有这单」。
## 3. 未接入(文档已有,按需排期)
按能力位分组,路径取自文档(**标注 ⚠ 的表示文档没写路径或路径可疑,需真机核对**):
### 出库(`OUTBOUND`)
| 接口 | 路径 | 状态 |
|---|---|---|
| 创建销售发货单(中文页「带附件」/ 英文页 "With Label",同路径) | `POST /v1/saleOrder/create` → `data.orderId` | ✅ 已接入 |
| 订单详情 | `POST /v1/saleOrder/findOne` | ✅ 已接入 |
| 订单列表 | `GET /v1/saleOrder/findByPage` | ✅ 已接入 |
| 订单取消 | `POST /v1/saleOrder/cancel`(`orderId` + `orderNo` 都必填) | ✅ 已接入 |
| 订单上传附件 | `POST /v1/saleOrder/createAttachment` | ⬜ |
| 物流异动单 创建 | `POST /v1/trackingChange/create` | ✅ 已接入(`TRACKING_CHANGE`) |
| 物流异动单 查询 | `POST /v1/trackingChange/findOrder`(⚠ 文档写的是 `/v1/saleOrder/findOrder`,真机 404) | ✅ 已接入 |
| 物流异动单 取消 | `POST /v1/trackingChange/cancel` | ⬜ |
#### 物流异动单(召回 / 换址 / 在途异常)
与「轨迹查询」是两件事:轨迹只读,异动会向承运商提工单、可能产生费用,
所以单独一个能力位 `TRACKING_CHANGE`。
**真机已验证的必填项**(文档标错 / 漏标):
| 字段 | 文档 | 真机 |
|---|---|---|
| `trackingNo` | 是 | 是 |
| `orderNo` | **否** | **是**(缺了回「来源单号不能为空」) |
| `remark` | 是 | 是 |
| `handleType` | 是 | 是 |
| `newRecipientName/Phone/Address` | 换址时必填 | 换址时必填(校验顺序 姓名 → 电话 → 地址) |
另外仓方会校验**「来源单号和 trackingNo 不匹配」**——两者必须属于同一张单。
这条本地挡不住,只能在联调时给一对真实存在的单号 + 运单号。
**路径纠正(真机 2026-11-13)**:查询页写的 `/v1/saleOrder/findOrder` 返回
`404 No handler found`;实际路径是 **`/v1/trackingChange/findOrder`**
(疑似从销售订单页复制)。适配器用后者。
**两个状态别混**:
| 字段 | 含义 | 落到 |
|---|---|---|
| `orderStatus` 0~6 | 异动单**受理**状态(草稿 / 待受理 / 受理中 / 已受理 / 受理成功 / 受理失败 / 取消) | `rawStatus()` |
| `logisticsStatus` 0~9 | **运单**物流状态(PRE TRANSIT / IN TRANSIT / … / RETURN TO SENDER) | `rawLogisticsStatus()` |
两者各存各的:一张异动单可能「已受理」而运单还在途,不能互相覆盖。
`accepted()` / `failed()` / `cancelled()` 是按 `orderStatus` 的便捷判断。
**未能确认**:`handleType` 文档标 STRING、示例给数字。真机字符串和数字都试过,
两种都能过(都走到后续业务校验),**区分不出**类型要求,按示例发 Integer。
**未接入**:订单上传附件、物流异动单取消。调用这些方法会显式抛异常,不返回 null——
静默返回空会让调用方以为「仓说没有这单」。
#### 订单详情(`/v1/saleOrder/findOne`)
- 请求只有 `orderNo`(来源单号)。
- **响应不回 `orderId`**:详情查回来的单拿不到仓内部 id。要取消的话,
得走列表接口按 `orderNos` 查一次补 `orderId`。
- 统一模型映射:`outboundRequestNo = orderNo`、`providerOrderId = null`、`orderRef = null`。
- `skuAmount` 是**行总额**,落 `OutboundLine.totalAmount`;恒健不回申报单价,
`declareValue` 保持 null,**不把总额当单价再乘一次**。
- 时间按 **UTC** 解析(`yyyy-MM-dd HH:mm:ss`),不用 `WarehouseContext.zone()`。
- `errorCode = "unexception"` 归一成 `exceptionCode = null`。
- 发货信息里 `packageFlag=1` 是面单信息行,取运单号 / 发货时间时只认 `0`(实际包裹)。
- `data` 为空 → 返回 `null`(「查不到」),不造空单。
#### 订单列表(`/v1/saleOrder/findByPage`)
- `GET`;分页四件套 `page / rows / sidx / sort` 都必填,适配器固定
`sidx=id&sort=desc`,`rows` 超过 100 截断到 100。
- **时间、订单号、订单 id 三者必填其一**:给 `outboundRequestNo` 就按 `orderNos` 查;
给时间窗就按 `beginDateTime / endDateTime`(UTC 日期)查;都没有 →
**本地拒绝**,不发必然被仓方拒的请求。
- 时间跨度上限 **30 天**,超过也本地拒绝。
- 不支持状态过滤:`OutboundQuery.statuses()` 非空时**拒绝**而不是静默忽略
(静默忽略会让调用方以为过滤生效了)。
- `OutboundQuery.orderRef`(平台单号)恒健**没有**对应参数:传了就**拒绝**,
不静默忽略(静默忽略会让调用方以为过滤生效了)。
- **排序可配**:`sortField` / `sortDirection` 由调用方指定,未指定才用文档默认
(`sidx=id`、`sort=desc`)。文档说 `sidx`「可写死 id」,不是「只能 id」;
`sort` 本来就是 `asc` / `desc` 两个可选值。
- **`rows` 上限 100 是文档明写的**,超过时**拒绝**而不是静默截断——
截断后调用方按自己的 `pageSize` 判末页会误判「还有下一页」。
- **列表是唯一回 `orderId` 的接口**,映射进 `providerOrderId` 与 `providerId`。
- 翻页游标是字符串页码(恒健入参 1 基,响应 `number` 是 0 基);
是否末页以仓方 `last` 为准。
- 列表独有 `amount`(整单销售金额)落 `totalAmount`;`taxPrice` 统一模型无对应字段,不落。
#### 包裹(`packages`)
恒健没有独立包裹接口,从详情 `shipmentPackages` 提取。按 `trackingNo` 去重
(同一包裹可能同时以「实际包裹」和「面单信息」两行出现),实际包裹优先。
#### 状态枚举
`HengjianOrderStatus` 全量 8 个值:
| 恒健 | 含义 | core `OutboundStatus` |
|---|---|---|
| `pending` | 未支付 | `CREATED` |
| `unshipped` | 未发货 | `SUBMITTED` |
| `approved` | 已审核 | `ACCEPTED` |
| `assigned` | 已分配 | `ACCEPTED` |
| `picked` | 已配货 | `PICKING` |
| `shipped` | 已发货 | `SHIPPED` |
| `canceled` | 已取消 | `CANCELLED` |
| `refunded` | 已退款 | `REFUNDED`(core 新增,码 180) |
> `refunded` 为此新增了 core 枚举值:退款是履约后的资金退回,与取消语义不同,
> 合并就分不出「这单有没有发出去」。core 枚举**只追加**,不动已有码值。
**精确匹配**,不用 `contains`;`unshipped` 与 `shipped` 是前缀关系,
用子串判断会把未发货判成交运。
#### 订单取消(`/v1/saleOrder/cancel`)
恒健要求 **`orderId` + `orderNo` 两个都传**,而统一模型的 `CancelCommand` 允许只给一个。
适配器的处理:
| 给了什么 | 行为 |
|---|---|
| `outboundRequestNo` + `providerOrderId` | 直接用,只发一次取消请求 |
| 只有 `outboundRequestNo` | 先按 `orderNos` 查列表补 `orderId`,再取消 |
| 只有 `providerOrderId` | 先按 `orderIds` 查列表补 `orderNo`,再取消 |
| 两个都没有 | 构造期就拒绝 |
| 列表补不到(仓里没有这单) | **本地拒绝**,不发必然被拒的取消请求 |
- 列表查回来的结果要**逐条精确比对**单号 / id 之后才用——`orderNos` 是否精确匹配文档没写,
拿近似结果去取消会取消错单。
- `orderId` 用 `Long`(文档标 INTEGER):九位数的 id 用 int 迟早出事,溢出是静默错单。
- 恒健没有取消费概念,`CancelCommand.acceptCharge()` 不生效。
- 仓方拒绝取消 → `OutboundCancelBlockedException`;**认证失败不会被包装**成不可取消,
否则宿主不会去刷新凭据。
#### 取消预判(`checkCancel`)
恒健没有独立的预判接口,按详情状态推断:`shipped` / `canceled` / `refunded` / `deleted`
以及 **`UNKNOWN`** 判 `BLOCKED`,其余 `FREE`。查不到单时也判 `BLOCKED`——
猜成 FREE 会发出注定被拒的取消。`UNKNOWN` 一并挡住,是因为恒健的词表将来可能加值,
认不出时不该凭猜下写请求。
### 库存(`INVENTORY_QUERY`)
| 接口 | 路径 |
|---|---|
| 查询库存(按 SKU) | `POST /v1/inventory/getInventory`(`skus` 必填) |
| 批量查询库存(分页) | `GET /v2/inventory/get_inventory_by_page` |
| 批次库存查询 | `POST v1/inventory/batch/getInventoryBatchByWarehouseCode`(⚠ 文档少了前导 `/`) |
| 库存批次快照 | `POST /v1/inventory/batch/getInventoryBatchSnapshotByPage` |
| 库存变动明细(流水) | `POST /v1/inventory/task/query`(该页要求 `Authorization: Bearer`,见冲突 #2) |
库存字段:`inventoryType`(0 可售 / 1 不可售)、`inventoryAvailable`、`inventoryReserved`、
`inventoryTransport`、`inventoryCurrent`、`updatedAt`。注意 `inventoryTransport` 与
`inventoryCurrent` 文档标成 STRING,数量类最终要转 int。
### 商品(`PRODUCT`)
| 接口 | 路径 | 状态 |
|---|---|---|
| 创建 / 编辑产品 | `POST /v1/product/save` | ✅ 已接入 |
| 查询 sku | `POST /v1/product/getBySku` | ⬜ |
| 分页查询 SKU / 产品打托信息 | `POST /v2/product/queryPage` | ⬜ |
| 渠道产品关系查询 | `GET /v1/productChannel/findByPage` | ⬜ |
| 创建产品识别码 | `POST /v1/product/createProductAlias` | ⬜ |
尺寸 cm / 重量 g,与统一模型一致(不需要换算)。
保存接口的字段口径见上一节。注意《查询 sku》页把「产品长」写作 `itemLength`,
而《创建/编辑产品》页写作 `length`——**两页对同一概念用了不同字段名**,
接查询接口时必须真机确认哪个才是产品长(见风险表 #7)。
### 入库(`INBOUND`)
入库计划创建 / 列表 / 查询 / 取消 / 加附件 / 上传附件 / 发运 / 更新到仓日期 / 生成箱标,
预约单创建 / 修改 / 取消 / 信息查询 / 日期查询。路径以 `/v1/inbound/...`、`/v3/booking_order/...` 为主。
### 计费明细(`FEE_SETTLEMENT`)—— 已接入
恒健把三类费用拆成<b>三个独立接口</b>,行字段完全不同:
| `FeeQuery.costType` | 接口 | 行特征 |
|---|---|---|
| `STORAGE` | `getChargingStorageSettlement` | 批次 / 库存类型 / 存储天数 / 计费量(CBM) |
| `LAST_MILE` | `getChargingTailDeliverySettlement` | 承运商 / 物流产品 / 计费重 / 分区 / 跟踪号 |
| `OPERATION` | `getChargingOperationSettlement` | 五级费用分类 / 计费阈值 / 箱数 |
**必须用 `costType` 指定查哪一类**:统一模型只有一个 `settlements()`,而三类接口的
返回结构不同。不指定就**拒绝**,而不是「三个都查再合并」——合并会让调用方以为
拿到完整账单,实际只覆盖了一部分。`VALUE_ADDED`(增值服务费)恒健没有独立接口,显式拒绝。
**请求**(三个接口一致):`orgWarehouseCodes` / `relOrderNos` / `sourceNos` /
`btChargeAt` 可选,`page` / `size` 必填。
| 统一模型 | 恒健 |
|---|---|
| `billingTransNo` | `relOrderNos`(计费单号) |
| `saleOrderNo` / `externalOrderNo` | `sourceNos`(来源单号,两者都当来源单号,重复只发一个) |
| `settledAfter/Before` 或 `snapshotDateRange` | `btChargeAt`,格式 `yyyy-MM-dd ~ yyyy-MM-dd` |
| 账户仓代码 | 自动带上 `orgWarehouseCodes`,避免跨仓混账 |
- **一条过滤条件都没有时本地拒绝**:等于拉全量账单。
- **仓过滤可配**:`FeeQuery.warehouseCodes()` 非空时用它(接口本就是复数仓),
空才退回账户仓。写死账户仓会让调用方无法表达「查全部仓」或「查其中几个仓」。
- **`providerSku` / `noType` 不支持**:恒健三个计费接口没有 SKU 维度、也没有
单号类型参数,传了就**拒绝**,不静默忽略。
- **`pageSize` 超上限(200)拒绝**:这个上限文档没写,是保守值。不静默截断——
截断会让调用方按自己的 pageSize 误判末页,漏账。
- **分页**:统一方法返回 `List`、不带游标,翻页靠
`query.toBuilder().pageCursor("2").build()`。判末页的约定是
**返回条数 < 本次请求的 `pageSize`**。`size` 未给时默认 100;超过 200 会拒绝
(上限文档没写,是保守值,待真机确认)。
- **状态口径**:三项都是账单明细(带 `billNo`),是<b>已发生账目</b>,
不是预估 → `estimated(false)`。
- **金额**:`cost` 是<b>该行总费用</b>,不是单价。`cost` 缺失的行**跳过**,
不用 0 兜底——0 会让对账金额偏小且查不出是哪行缺的。
- **费用类型由接口决定**,不靠猜 `settlementName`(作业费的名字形如
「退货入库->入库费->…」,靠字符串归类型迟早错)。
- **单号口径**:仓储费取 `sourceNo`;尾程费按 发货单号 → 来源单号 → 订单号 → 平台单号
依次兜底;作业费取 `relOrderNo` → `sourceNo`。`transactionNo` → `serialNumber`,
`billNo` → `documentNo`。
**文档问题**:作业费页的标题和链接都写成了「测算费用(接口)」和
`open-api.ehenglin.com/v2/api/shipping/calculate`(从测算页复制),只有路径与示例是对的。
另有两处类型不一致:仓储页 `btChargeAt` 是字符串、作业页字段表标 List;尾程页的
`sourceOrderNo` 中文名也写成「售后单号」。均按示例实现,待真机确认。
### 调拨 / 退货 / 销毁 / 测算
| 领域 | 规模 |
|---|---|
| 调拨 | 创建 / 查询 / 取消 / 上传附件(`/v1/transferPlan/...`) |
| 退货 | 旧版 3 个(标「废弃」)+ v2 10 个(`/v1/saleReturn/...`、`/v3/hj_wms/receiptReturn`) |
| 销毁 | 创建 / 取消 / 批量查询(`/v2/destroyPlanOrder/...`) |
| 测算 | 测算费用 `/v2/api/shipping/calculate`、地址属性 `/v2/api/shipping/addressClassification`(⚠ 域名可疑) |
## 4. 代码结构
```
warehouse-sdk-hengjian/
├── pom.xml
└── src/
├── main/java/common/ecommerce/hengjian/
│ ├── HengjianConstants.java 端点 / 路径 / 两个授权头 / 成功码 / 未授权码 / 限流
│ ├── adapter/
│ │ ├── HengjianAdapter.java 目录 + 渠道 + 商品 + 出库全链路 + 物流异动单
│ │ ├── HengjianAdapterFactory.java
│ │ ├── HengjianDirectoryMapper.java 仓库 / 渠道字段搬运
│ │ ├── HengjianProductMapper.java 商品报文 + 恒健必填项本地校验
│ │ ├── HengjianOutboundMapper.java 出库下单报文(UTC 时间 / 行总额 / 面单附件)
│ │ ├── HengjianOrderMapper.java 订单详情 / 列表 → 统一模型
│ │ ├── HengjianTrackingChangeMapper.java 异动单 → 统一模型
│ │ └── HengjianFeeMapper.java 三个计费接口的请求构造 + 行映射
│ ├── dto/
│ │ ├── HengjianWarehouseDtos.java
│ │ ├── HengjianCarrierGroupDtos.java 两个渠道接口共用行模型
│ │ ├── HengjianProductSaveDtos.java /v1/product/save
│ │ ├── HengjianCreateOrderDtos.java /v1/saleOrder/create
│ │ ├── HengjianOrderDetailDtos.java /v1/saleOrder/findOne
│ │ ├── HengjianOrderListDtos.java /v1/saleOrder/findByPage
│ │ ├── HengjianCancelOrderDtos.java /v1/saleOrder/cancel
│ │ ├── HengjianTrackingChangeDtos.java /v1/trackingChange/create
│ │ ├── HengjianTrackingChangeQueryDtos.java /v1/trackingChange/findOrder
│ │ ├── HengjianStorageFeeDtos.java 仓储费明细
│ │ ├── HengjianTailDeliveryFeeDtos.java 尾程配送费明细
│ │ └── HengjianOperationFeeDtos.java 作业费明细
│ ├── enums
│ │ ├── HengjianOrderStatus.java orderStatusEnum → OutboundStatus
│ │ └── package-info.java 其余状态枚举约定(待建)
│ ├── http/
│ │ ├── HengjianRequestFactory.java 双授权头 + 链路 ID
│ │ ├── HengjianEnvelope.java 三种形态信封校验
│ │ └── HengjianRateLimiter.java
│ └── webhook/package-info.java 文档无回调,未实现
└── test/java/common/ecommerce/hengjian/
├── adapter/HengjianDirectoryTest.java 13 个:请求形状 / 鉴权头 / 映射 / 能力位
├── adapter/HengjianProductSaveTest.java 20 个:必填拒绝 / 三组尺寸 / 不编造字段
├── adapter/HengjianCreateOrderTest.java 23 个:必填拒绝 / UTC 时间 / 行总额 / 面单 / 未接入拒绝
├── adapter/HengjianOrderQueryTest.java 29 个:详情映射 / 分页 / 排序可配 / 时间窗 / 包裹去重
├── adapter/HengjianCancelOrderTest.java 10 个:双键补齐 / 精确匹配 / 拒绝路径 / 预判
├── adapter/HengjianTrackingChangeTest.java 19 个:必填拒绝 / 换址三项 / 路径 / 双状态
├── adapter/HengjianFeeTest.java 22 个:三接口路由 / 分页 / 仓过滤 / 行映射 / 缺金额跳过
├── adapter/HengjianAdapterTest.java 5 个:注册 / 能力拒绝 / 枚举
├── http/HengjianEnvelopeTest.java 12 个:三种信封形态 + 通用失败码 + 错误路径
├── probe/HengjianReadOnlyProbeTest.java 默认跳过,凭据走系统属性
└── probe/HengjianWriteProbeTest.java 默认跳过,另需 -Dhengjian.probe.write=true
```
已验证:`mvn -pl warehouse-sdk-hengjian -am test` 全部通过(157 个 + 4 个跳过)。
## 5. 探针用法
只读探针:
```bash
mvn -pl warehouse-sdk-hengjian -DfailIfNoTests=false \
-Dhengjian.probe=true \
-Dhengjian.probe.token=<组织token> \
-Dhengjian.probe.providerWarehouseId=EFCA \
-Dtest=HengjianReadOnlyProbeTest test
```
- 默认跳过;token 不入库、只走系统属性。
- 6 个用例:仓库目录 / 全量渠道 / 按仓渠道 / 承运商代码去重 / 订单详情 / 订单列表。
异常只打印不中断。
- 计费明细的只读探针在 `HengjianReadOnlyProbeTest` 之外,
用 `-Dhengjian.probe.begin=` / `-Dhengjian.probe.end=` 加 `-Dhengjian.probe.feeType=`
(STORAGE / LAST_MILE / OPERATION)指定查哪一类。
- 订单详情需 `-Dhengjian.probe.orderNo=`;订单列表需 `-Dhengjian.probe.begin=` 与 `-Dhengjian.probe.end=`
(`yyyy-MM-dd`,跨度 ≤30 天)。没给就跳过对应用例。
- 只读,不建单。
异动单查询探针(只读):
```bash
mvn -pl warehouse-sdk-hengjian -DfailIfNoTests=false \
-Dhengjian.probe=true -Dhengjian.probe.token=<组织token> \
-Dhengjian.probe.changeOrderNo=<仓方异动单号> \
-Dtest=HengjianTrackingChangeProbeTest test
```
- 验证查询路径是 `/v1/trackingChange/findOrder`(文档写的 `/v1/saleOrder/findOrder` 是 404)。
写探针(会留下真实数据):
```bash
mvn -pl warehouse-sdk-hengjian -DfailIfNoTests=false \
-Dhengjian.probe=true -Dhengjian.probe.write=true \
-Dhengjian.probe.token=<组织token> \
-Dhengjian.probe.sku=PROBE-SKU-001 \
-Dhengjian.probe.postcode=90001 \
-Dhengjian.probe.cancelOrderNo=<要取消的探针单号> \
-Dtest=HengjianWriteProbeTest test
```
- 两个开关同时打开才跑;SKU 默认带时间戳,重跑不撞唯一约束。
- 5 个用例:建商品、同 SKU 再存一次(验证保存语义是否幂等)、建销售发货单、
取消订单、取消预判。
- 建单需 `-Dhengjian.probe.postcode`(可选 `carrierCode` / `shopName` / `state` / `city`);
- 取消与预判需 `-Dhengjian.probe.cancelOrderNo`,取消只在给了单号时执行
(验证「只给单号自动补 orderId」这条路)。
- **恒健没有删除产品的接口**,跑完需要人工在 Efulfill 后台清理;
**取消探针会真实取消一张单**,只对测试环境的探针单用。
## 6. 待确认(交给业务方 / 恒健)
| # | 要确认 | 影响 |
|---|---|---|
| 1 | **有效 token 与测试仓代码** | 没有就无法跑探针,后续接口一律「未验证」 |
| 2 | 两个授权头是否必须同时带、是否同值 | 决定 `HengjianRequestFactory` 能否精简 |
| 3 | 新约定(`Authorization: Bearer`)与旧双头是否二选一 | 冲突 #2,决定后续接口按哪套实现 |
| 4 | **是否有回调(Webhook)文档** | 没有回调就只能轮询订单状态 |
| 5 | 限流值、单日配额 | 现在是保守默认 2 req/s |
| 6 | 能否在 PR 环境走写操作(建单 / 取消) | 决定全链路探针怎么设计 |
| 7 | 计费 / 测算接口的真实域名 | 文档写的是 `ehenglin.com` / `thebizark.com` |
| 8 | 商品「产品长」到底是 `length` 还是 `itemLength` | 《创建/编辑产品》写 `length`、《查询 sku》写 `itemLength`;接查询接口前必须确认,否则尺寸错位 |
| 9 | 是否有沙箱测试 SKU | 建单需要仓方系统里真实存在的 SKU(运去哪的 `lineCode` 就踩过这个坑) |
| 10 | 时区口径 | 文档多处写 UTC,但仓在美国;需真机确认返回的时间到底是不是 UTC |
| 11 | 建单的 `channelAccount` 是否必填 | 两页文档都标「否」,但写的是「必须在 Efulfill 店铺管理中维护」;未给时仓方按什么路由需真机确认 |
| 12 | `isPrime` 的真实类型 | 文档类型列写 STRING,请求示例却是数字 `0`;适配器按示例发 Integer,真机报类型错就问仓方 |
| 13 | 签收类型能否区分成人 / 间接签收 | 统一模型只有布尔,目前全部映射成「直接签收(1)」;业务若需要 2 / 3,要在 `OutboundCommand` 上加行级签收类型 |
| 14 | 列表分页是 1 基入参还是 0 基 | 文档参数示例 `page: 1`,响应 `number: 0`;适配器按「入参 1 基、响应 0 基」处理,真机若错位只改 `pageNumberOf` |
| 15 | 详情 / 列表的 `paidAt` 是否真是 UTC | 两页都没写时区,只有创建接口注明 utc;适配器按 UTC 解析,若仓方回的是本地时间,时间会整体平移 |
| 16 | 列表 `enclosure[].type` 到底回字符串还是数字 | 列表页标 INTEGER、详情页标 STRING 且示例是 `"Shippinglabel"`;适配器按文本读,两种都能接住 |
## 7. 下一步
1. 拿到 token 后跑 `HengjianReadOnlyProbeTest` 与 `HengjianWriteProbeTest`,把结论补进本文档
「文档与实际不一致」表;重点验商品保存的必填组合、保存语义、建单的必填组合与 `orderId` 回传、
详情 / 列表的分页与时间口径、取消的双键与预判。
2. 按 [onboarding-checklist.md](../onboarding-checklist.md) 阶段 2 逐接口接入,建议顺序:
**库存(按 SKU + 分页)→ 商品查询 → 入库 → 退货 v2 → 订单上传附件 / 物流异动单**。
3. 每个写接口接入前先确认第 6 节的 1 / 6 / 9 三项,否则写接口只能停在「有代码、未验证」。
出库子能力到此全部接完(下单 / 详情 / 列表 / 取消 / 预判 / 包裹)。剩下与出库相关的是
订单上传附件与物流异动单,都不影响主链路,按需排期。