商品接口文档(goods)
基本信息
- 接口地址:
/index.php/api - 请求方法:
POST - 接口类型:接收方接口(第三方 WMS 平台推送 → OMS 接收)
- 路由参数:
method = wms.goods.{action}
接口方法列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
| wms.goods.status_update | POST | 商品信息变更MQ消息推送(云交易商品信息变更) |
系统级参数
| 参数名 | 类型 | 必填 | 名称 | 描述 |
|---|---|---|---|---|
| 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.goods.status_update |
| sign | string | 是 | 签名 | 用于验证请求合法性 |
签名算法说明
- 生成公式:
sign = strtoupper(md5(strtoupper(md5(assemble($params))). $token)) - 要点:
- 参与签名的参数集合不包含
sign本身;常以键名排序后按约定拼装 - 首次 md5 后转大写,与
token拼接后再 md5,最终再转大写 - 保持编码一致、去除多余空白
- 参与签名的参数集合不包含
接收参数(业务参数)
基础字段
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sku_id | string | 是 | SKU ID |
| channel_id | string | 是 | 渠道ID |
| type | string | 是 | 变更类型 |
注意:此接口用于云交易商品信息变更MQ消息推送,具体参数根据MQ消息格式定义。
响应参数
响应格式统一为 JSON,包含以下字段:
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| rsp | string | 是 | 响应状态:succ(成功)或 fail(失败) |
| msg | string | 否 | 响应消息(成功时包含操作描述,失败时包含错误信息) |
| data | object | 否 | 响应数据 |
数据示例
请求示例(商品信息变更)
json
{
"flag": "erpapi",
"app_id": "ecos.ome",
"method": "wms.goods.status_update",
"timestamp": 1700000000,
"sign": "...",
"sku_id": "SKU001",
"channel_id": "CH001",
"type": "UPDATE"
}响应示例
响应成功
商品信息变更成功(wms.goods.status_update):
json
{
"rsp": "succ",
"msg": "商品信息变更成功"
}业务描述
功能说明
此接口用于接收云交易商品信息变更MQ消息,当WMS系统中的商品信息发生变化时,会通过MQ消息推送到OMS系统。
消息格式
具体消息格式根据云交易MQ消息定义,包含:
sku_id:SKU IDchannel_id:渠道IDtype:变更类型
错误码定义
- E_PARAM:参数缺失或格式不正确
- E_INTERNAL:内部处理异常
