商品接口文档(goods)
基本信息
- 接口地址:
/index.php/api - 请求方法:
POST - 接口类型:接收方接口(第三方平台推送 → OMS 接收)
- 路由参数:
method = {app_id}.goods.{action}
接口方法列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
| ome.goods.add | POST | 新增商品/SPU 与 SKU |
| ome.goods.delete | POST | 删除商品 |
| ome.goods.sku_delete | POST | 删除 SKU |
| ome.goods.aoxiang_update | POST | 奥翔渠道商品更新 |
| ome.goods.aoxiang_combine_update | POST | 奥翔组合商品更新 |
| ome.goods.aoxiang_delete | POST | 奥翔渠道商品删除 |
| ome.goods.aoxiang_mapping | 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 | 是 | 接口方法名 | 形如 {app_id}.goods.add |
| sign | string | 是 | 签名 | 用于验证请求合法性 |
签名算法说明
- 生成公式:
sign = strtoupper(md5(strtoupper(md5(assemble($params))). $token)) - 要点:
- 参与签名的参数集合不包含
sign本身;常以键名排序后按约定拼装 - 首次 md5 后转大写,与
token拼接后再 md5,最终再转大写 - 保持编码一致、去除多余空白
- 参与签名的参数集合不包含
接收参数(业务参数)
| 参数名/路径 | 类型 | 必填 | 适用方法 | 说明 |
|---|---|---|---|---|
| goods.bn | string | 是 | add | SPU 编码 |
| goods.name | string | 是 | add | SPU 名称 |
| goods.price | number | 否 | add | 含税价 |
| goods.barcode | string | 否 | add | 条码 |
| goods.brand | string | 否 | add | 品牌 |
| goods.spec | string | 否 | add | 规格描述 |
| skus[] | array | 否 | add | SKU 列表 |
| skus[].sku_id | string | 是 | add | SKU 唯一编码 |
| skus[].bn | string | 是 | add | SKU 货号 |
| skus[].name | string | 否 | add | SKU 名称 |
| skus[].price | number | 否 | add | 售价 |
| skus[].barcode | string | 否 | add | 条码 |
| mapping/* | object | 否 | aoxiang_mapping | 渠道映射(店铺货品、平台SKU等) |
响应参数
响应格式统一为 JSON,包含以下字段:
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| rsp | string | 是 | 响应状态:succ(成功)或 fail(失败) |
| msg | string | 否 | 响应消息(成功时包含操作描述,失败时包含错误信息) |
| data | object | 否 | 响应数据(成功时可能包含商品ID等信息) |
数据示例
请求示例(新增商品)
json
{
"flag":"erpapi",
"app_id":"ecos.ome",
"method":"ome.goods.add",
"timestamp":1700000000,
"sign":"...",
"goods":{
"bn":"SPU001",
"name":"示例商品",
"price":199,
"skus":[{"sku_id":"SKU001","bn":"SKU001","price":199}]
}
}响应示例
响应成功
新增商品成功(ome.goods.add):
json
{
"rsp": "succ",
"msg": "商品创建成功"
}响应失败
新增商品失败(参数缺失):
json
{
"rsp": "fail",
"msg": "参数缺失"
}新增商品失败(重复条目):
json
{
"rsp": "fail",
"msg": "商品已存在"
}错误码定义(示例)
- E_PARAM:参数缺失
- E_DUPLICATE:重复条目
- E_STATE:状态不允许
