上游系统与CNAP接口平台的通信协议
协议描述
接口遵循REST规范,使用HTTP POST方式进行通讯。 标准协议的HTTP入口地址为:
ERP发给CNAP接口平台:
http://[CNAP_gateway_url]?method=[qimen_API]
&session=[1000]
×tamp=[2015-02-01 00:00:00]
&format=xml
&app_key=[erp_appkey]
&v=2.0
&sign=[xxxxxxxxxxxxxxxxxxxxxx]
&sign_method=md5
&customerId=[QIMENUSR1]
CNAP接口平台发给ERP:
http://[erp_webservice_url]?method=[erp_API] ×tamp=[2015-02-01 00:00:00] &format=xml &app_key=[wms_appkey] &v=2.0 &sign=[xxxxxxxxxxxxxxxxxxxxxx] &sign_method=md5 &customerId=[QIMENUSR1]
注:
1.[]中需要根据具体业务进行填写。CNAP_API,erp_API具体见下方的API名称。
2.URL需要做URL Encoding处理。
3.请求和响应的消息主体使用XML格式。
请求参数说明
请求参数包含URL中带的系统参数和body中带的相关业务参数,系统参数如下
名称 | 类型 | 约束 | 描述 |
---|---|---|---|
method | String | 必须 | ERP相关的业务接口名称,如商品信息同步的请求, method=taobao.qimen.item.synchronize |
timestamp | String | 必须 | 时间戳,格式为yyyy-mm-dd HH:mm:ss |
format | String | JSON/XML,默认XML | content格式 |
app_key | String | 必须 | 应用接入时分配的app_key |
v | String | 2.0 | 协议版本号,1.0或者2.0 |
sign | String | 必须 | 根据url和密钥计算的结果。具体算法参看签名算法文档 |
sign_method | String | 必须 | 参数加密方法,md5 |
customerid | String | 必须 | WMS颁发给用户的ID |
响应参数说明
响应参数说明 | 名称 | 类型 | 约束 | 描述 | | —- | —- | —- | —- | | flag | String | 必须 | success/failure | | code | String | 必须 | 返回状态码 | | message | String | 必须 | 返回状态描述 |
错误码解释
API错误码
下游WMS错误码
适用级别:商品同步接口
code | 备注 | 解决方案 |
---|---|---|
2001 | 仓库编码获取仓库编号引发异常 | 仓库编码错误,检查仓库编码 |
2003 | 数据类型转换失败 | 字段类型不匹配,核对参数类型 |
2004 | 扩展信息处理引发异常 | 扩展字段格式不对(建议联系技术支持) |
2008 | 通过货主编码获取货主编号引发异常 | 核对货主编码是否正确 |
适用级别:库存查询接口(多商品)
code | 备注 | 解决方案 |
---|---|---|
2001 | 仓库编码获取仓库编号引发异常 | 仓库编码错误,检查仓库编码 |
2003 | 数据类型转换失败 | 字段类型不匹配,核对参数类型 |
2008 | 通过货主编码获取货主编号引发异常 | 核对货主编码是否正确 |
适用级别:入库单创建接口
code | 备注 | 解决方案 |
---|---|---|
2001 | 仓库编码获取仓库编号引发异常 | 仓库编码错误,检查仓库编码 |
2002 | 基础查询出多条信息 | 在对应信息管理里停用其中一条(建议联系技术支持) |
2003 | 数据类型转换失败 | 字段类型不匹配,核对参数类型 |
2004 | 扩展信息处理引发异常 | 扩展字段格式不对(建议联系技术支持) |
2005 | 批次号在商品缓存中没查到!请确认商品批次是否存在 | 稍后重试,问题依然存在联系技术支持 |
2007 | 传入的商品在仓库不存在 | 检查商品编码在系统中是否存在;或者是否停用了 |
2008 | 通过货主编码获取货主编号引发异常 | 核对货主编码是否正确 |
2101 | 入参订单为空-101 | 检查商品编码在系统中是否存在;或者是否停用了 |
2102 | 参数校验错误-100 | 报文缺失检查报文 |
2103 | 数据重复插入-11 | 联系技术支持 |
2015 | 商品停用或者未启用-16 | 同步商品状态信息 |
2201 | 下发到货通知单参数校验错误 | 检查必填参数是否都填写完整 |
2202 | 创建到货通知单失败,相同的单据正在创建中 | 建议增加下发同一单据时间间隔,问题依旧联系技术支持 |
2203 | 创建到货通知单失败,单据已存在且状态不是通知状态 | 请勿重复下发该通知单 |
2204 | 创建到货通知单失败,生成通知单号失败 | 联系技术支持 |
2205 | 创建到货通知单失败,下发的通知单明细商品已存在 | 不再下发已经下发过的SKU |
适用级别:出库单创建接口
code | 备注 | 解决方案 |
---|---|---|
2001 | 仓库编码获取仓库编号引发异常 | 仓库编码错误,检查仓库编码 |
2002 | 基础查询出多条信息 | 在对应信息管理里停用其中一条(建议联系技术支持) |
2003 | 数据类型转换失败 | 字段类型不匹配,核对参数类型 |
2004 | 扩展信息处理引发异常 | 扩展字段格式不对(建议联系技术支持) |
2005 | 批次号在商品缓存中没查到!请确认商品批次是否存在 | 稍后重试,问题依然存在联系技术支持 |
2007 | 传入的商品在仓库不存在 | 检查商品编码在系统中是否存在;或者是否停用了 |
2008 | 通过货主编码获取货主编号引发异常 | 核对货主编码是否正确 |
2101 | 入参订单为空-101 | 报文缺失订单信息,检查报文 |
2102 | 参数校验错误-100 | 报文缺失检查报文 |
2103 | 数据重复插入-11 | 联系技术支持 |
2104 | 仓内不存在订单明细商品-13 | 同步商品信息 |
2105 | 商品停用或者未启用-16 | 同步商品状态信息 |
2106 | 不同订单明细的商品id重复-15 | 检查报文,商品信息重复 |
2107 | 该商品已经下发过,不允许重复下发-108 | 检查报文,分批次下发,商品信息重复 |
适用级别:发货单创建接口
code | 备注 | 解决方案 |
---|---|---|
2001 | 仓库编码获取仓库编号引发异常 | 仓库编码错误,检查仓库编码 |
2002 | 基础查询出多条信息 | 在对应信息管理里停用其中一条(建议联系技术支持) |
2003 | 数据类型转换失败 | 字段类型不匹配,核对参数类型 |
2004 | 扩展信息处理引发异常 | 扩展字段格式不对(建议联系技术支持) |
2005 | 批次号在商品缓存中没查到!请确认商品批次是否存在 | 稍后重试,问题依然存在联系技术支持 |
2006 | 没有对应的商店地址信息,商铺编码 | 查看下地址库规则设置是什么,选择对应规则 |
2007 | 传入的商品在仓库不存在 | 检查商品编码在系统中是否存在;或者是否停用了 |
2101 | 入参订单为空-101 | 报文缺失订单信息,检查报文 |
2102 | 参数校验错误-100 | 报文缺失检查报文 |
2103 | 数据重复插入-11 | 联系技术支持 |
2008 | 通过货主编码获取货主编号引发异常 | 核对货主编码是否正确 |
2104 | 仓内不存在订单明细商品-13 | 同步商品信息 |
2105 | 商品停用或者未启用-16 | 同步商品状态信息 |
2106 | 不同订单明细的商品id重复-15 | 检查报文,商品信息重复 |
2107 | 该商品已经下发过,不允许重复下发-108 | 检查报文,分批次下发,商品信息重复 |
适用级别:退货入库单创建接口
code | 备注 | 解决方案 |
---|---|---|
2001 | 仓库编码获取仓库编号引发异常 | 仓库编码错误,检查仓库编码 |
2002 | 基础查询出多条信息 | 在对应信息管理里停用其中一条(建议联系技术支持) |
2003 | 数据类型转换失败 | 字段类型不匹配,核对参数类型 |
2004 | 扩展信息处理引发异常 | 扩展字段格式不对(建议联系技术支持) |
2005 | 批次号在商品缓存中没查到!请确认商品批次是否存在 | 稍后重试,问题依然存在联系技术支持 |
2007 | 传入的商品在仓库不存在 | 检查商品编码在系统中是否存在;或者是否停用了 |
2008 | 通过货主编码获取货主编号引发异常 | 核对货主编码是否正确 |
2104 | 仓内不存在订单明细商品-13 | 同步商品信息 |
2105 | 商品停用或者未启用-16 | 同步商品状态信息 |
2106 | 不同订单明细的商品id重复-15 | 检查报文,商品信息重复 |
2107 | 该商品已经下发过,不允许重复下发-108 | 检查报文,分批次下发,商品信息重复 |
适用级别:单据取消接口
code | 备注 | 解决方案 |
---|---|---|
2206 | 已经下架过的出库单不能取消 | 正常返回值 |
2207 | 不存在对应的出库单 | 正常返回值 |
2208 | B2C取消引发异常 | 稍后重试!重试3次还是报错,联系CNAP技术。 |
2209 | 订单已质检的包裹不能被取消 | 正常返回值 |
2210 | 订单已有出库的包裹不能被取消 | 正常返回值 |
2211 | 该入库单已有收货作业,不能取消 | 正常返回值 |
2212 | 该销退入库单已收货,不能取消 | 正常返回值 |