收货人信息接口文档(receiverinfo)
基本信息
- 接口地址:
/index.php/api - 请求方法:
POST - 接口类型:接收方接口(第三方 WMS 平台推送 → OMS 接收)
- 路由参数:
method = wms.receiverinfo.{action}
接口方法列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
| wms.receiverinfo.query | 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.receiverinfo.query |
| sign | string | 是 | 签名 | 用于验证请求合法性 |
签名算法说明
- 生成公式:
sign = strtoupper(md5(strtoupper(md5(assemble($params))). $token)) - 要点:
- 参与签名的参数集合不包含
sign本身;常以键名排序后按约定拼装 - 首次 md5 后转大写,与
token拼接后再 md5,最终再转大写 - 保持编码一致、去除多余空白
- 参与签名的参数集合不包含
接收参数(业务参数)
基础字段
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| delivery_order_code | string | 是 | 发货单号 |
| oaid | string | 否 | OAID(订单地址ID) |
| owner_code | string | 否 | 货主编码(仓库编码) |
响应参数
响应格式统一为 JSON,包含以下字段:
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| rsp | string | 是 | 响应状态:succ(成功)或 fail(失败) |
| msg | string | 否 | 响应消息(成功时包含操作描述,失败时包含错误信息) |
| data | object | 否 | 响应数据(成功时包含收货人地址明文信息) |
数据示例
请求示例(发货单地址明文查询)
json
{
"flag": "erpapi",
"app_id": "ecos.ome",
"method": "wms.receiverinfo.query",
"timestamp": 1700000000,
"sign": "...",
"delivery_order_code": "D20250101001",
"oaid": "OAID001",
"owner_code": "WH001"
}响应示例
响应成功
发货单地址明文查询成功(wms.receiverinfo.query):
json
{
"rsp": "succ",
"msg": "查询成功",
"data": {
"delivery_bn": "D20250101001",
"receiver_name": "张三",
"receiver_mobile": "13800138000",
"receiver_address": "北京市朝阳区xxx街道xxx号"
}
}响应失败
发货单地址明文查询失败(发货单号必填):
json
{
"rsp": "fail",
"msg": "发货单号必填"
}业务描述
功能说明
此接口用于查询发货单的收货人地址明文信息,适用于需要获取完整收货地址的场景。
查询条件
delivery_order_code:发货单号(必填)oaid:OAID(订单地址ID),可选owner_code:货主编码(仓库编码),可选
错误码定义
- E_PARAM:参数缺失或格式不正确(如:发货单号必填等)
- E_INTERNAL:内部处理异常
