转储单接口文档(stockdump)
基本信息
- 接口地址:
/index.php/api - 请求方法:
POST - 接口类型:接收方接口(第三方 WMS 平台推送 → OMS 接收)
- 路由参数:
method = wms.stockdump.{action}
接口方法列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
| wms.stockdump.status_update | POST | 转储单状态更新(简化版) |
系统级参数
| 参数名 | 类型 | 必填 | 名称 | 描述 |
|---|---|---|---|---|
| flag | string | 是 | 接入标识 | 固定值 erpapi |
| app_id | string | 是 | 应用ID | 如 ecos.ome |
| certi_id | string | 是 | 证书ID | 系统证书编号 |
| from_node_id | string | 是 | 来源节点 | 推送方节点ID |
| node_id | string | 是 | 目标节点 | 店铺节点ID(OMS节点) |
| node_type | string | 是 | 节点类型 | 如 ecos.ome |
| timestamp | int | 是 | 时间戳 | 10位时间戳 |
| method | string | 是 | 接口方法名 | 形如 wms.stockdump.status_update |
| sign | string | 是 | 签名 | 用于验证请求合法性 |
签名算法说明
- 生成公式:
sign = strtoupper(md5(strtoupper(md5(assemble($params))). $token)) - 要点:
- 参与签名的参数集合不包含
sign本身;常以键名排序后按约定拼装 - 首次 md5 后转大写,与
token拼接后再 md5,最终再转大写 - 保持编码一致、去除多余空白
- 参与签名的参数集合不包含
接收参数(业务参数)
基础字段
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| stockdump_bn | string | 是 | 转储单号 |
| warehouse | string | 否 | 仓库编码 |
| status | string | 否 | 转储单状态 |
| io_status | string | 否 | 转储状态(当 status 为空时使用) |
| operate_time | string | 否 | 操作时间,格式:Y-m-d H:i:s,默认当前时间 |
| remark | string | 否 | 备注 |
转储明细(item)
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| item | string | 否 | 转储明细(JSON字符串),数组格式 |
item 数组元素字段:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| product_bn | string | 是 | 商品货号 |
| num | int | 是 | 数量 |
注意:
item参数需要 JSON 编码后传递- 此接口为简化版转储单接口,只支持基本的转储功能
响应参数
响应格式统一为 JSON,包含以下字段:
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| rsp | string | 是 | 响应状态:succ(成功)或 fail(失败) |
| msg | string | 否 | 响应消息(成功时包含操作描述,失败时包含错误信息) |
| data | object | 否 | 响应数据(成功时可能包含转储单号等信息) |
数据示例
请求示例(转储单状态更新)
json
{
"flag": "erpapi",
"app_id": "ecos.ome",
"method": "wms.stockdump.status_update",
"timestamp": 1700000000,
"sign": "...",
"stockdump_bn": "SD20250101001",
"warehouse": "WH001",
"status": "FINISH",
"operate_time": "2025-01-01 10:00:00",
"item": "[{\"product_bn\":\"SKU001\",\"num\":10}]"
}响应示例
响应成功
转储单状态更新成功(wms.stockdump.status_update):
json
{
"rsp": "succ",
"msg": "转储单状态更新成功",
"data": {
"stockdump_bn": "SD20250101001"
}
}响应失败
转储单状态更新失败(转储单号必填):
json
{
"rsp": "fail",
"msg": "转储单号必填"
}业务描述
功能说明
此接口为简化版转储单接口,用于处理基本的转储业务。
明细处理
- 数量处理:记录转储的商品和数量
- 简化处理:不支持批次、唯一码等复杂功能
错误码定义
- E_PARAM:参数缺失或格式不正确(如:转储单号必填等)
- E_STATE:业务状态不允许
- E_DUPLICATE:重复提交
- E_INTERNAL:内部处理异常
