主要改进是,将下载订单的控制点放在客户端,服务器端不需要做读取标记,以降低对环境的依赖。另外,发货同步增加原始订单号参数,便于对应网店系统的订单。
《网店管家》网络商城接口 2.0
《网店管家》商城接口包括两个部分,一是订单下载接口,由《网店管家》的附件“网店蜘蛛”实现,二是订单状态、库存同步、客户资料、发货通知接口,由《网店管家》的附件“管家助理”实现。接口采用Post方法实现,采用UTF8编码。
一. 订单下载接口
1.机制
《网店蜘蛛》或《网店管家》主动发起获取订单请求,网店系统验证请求后,返回信息。结果信息为XML格式,每次返回一个。
2.消息格式
1)订单查询
参数 |
说明 |
uCode |
接入码,用于验证请求的有效性。接入码的值在网店系统和网店蜘蛛中设置。 |
mType |
请求类别。订单查询时该值为:mOrderSearch |
TimeStamp1 |
起始时间(时间戳),0表示不限制起始时间 |
TimeStamp2 |
截止时间(时间戳),0表示不限制截止时间 |
OrderStatus |
0:表示所有,1:表示已经付款,2:表示未付款,3:表示已经取消,4:已经发货 |
接口文件接收消息后,将符合条件的订单按照如下格式返回
标记 |
定义 |
说明 |
OrderCount |
订单数量 |
|
OrderNO |
订单号 |
不能重复 |
例如,要查询当前所有已经付款的订单:
http://www.XShop.com/interface.asp? uCode=123456& mType=mOrderSearch&TimeStamp1=0&TimeStamp2=0&OrderStatus=1
返回结果示例如下:
<?xml version='1.0' encoding='gb2312'?>
<OrderList>
<OrderCount>3</ OrderCount >
<OrderNO>07081001</OrderNO>
<OrderNO>07081002</OrderNO>
<OrderNO>07081003</OrderNO>
</OrderList>
2)订单下载
参数 |
说明 |
uCode |
接入码,用于验证请求的有效性。接入码的值在网店系统和网店蜘蛛中设置。 |
mType |
请求类别。订单查询时该值为:mGetOrder |
OrderNO |
订单号 |
接口文件接收消息后,将符合条件的订单按照如下格式返回
标记 |
定义 |
说明 |
OrderNO |
订单号 |
不能重复 |
DateTime |
成交日期 |
|
BuyerID |
买家用户名 |
|
BuyerName |
买家姓名 |
|
Country |
国家 |
|
Province |
省/州 |
|
City |
市/县 |
|
Town |
区/镇 |
|
Adr |
地址 |
|
Zip |
邮编 |
|
Email |
Email |
|
Phone |
联系电话 |
|
Total |
货款总额 |
|
Postage |
货运费用 |
|
PayAccount |
支付方式 |
|
PayID |
支付编号 |
|
CustomerRemark |
客户备注 |
|
Remark |
客服备注 |
|
Item |
成交商品集 |
|
|
GoodsID |
库存编码 |
|
GoodsName |
货品名称 |
|
GoodsSpec |
货品规格 |
|
Count |
数量 |
|
Price |
单价 |
|
需要说明的是,为了避免特殊字符的干扰,对于字符型数据建议增加CDATA标记(以"<![CDATA["作为前缀,并以"]]>"结束。)。
一个符合规范的订单描述:
<?xml version='1.0' encoding='gb2312'?>
<Order>
<OrderNO>07081001</ OrderNO >
<DateTime>2006-06-08 12:30</DateTime>
<BuyerID>huadog</BuyerID>
<BuyerName>张三</BuyerName>
<Country>中国</Country>
<Province>浙江</Province>
<City>杭州</City>
<Town>西湖区</Town>
<Adr>文三路90号</Adr>
<Zip>310012</Zip>
<Email>zhangsan@163.com</Email>
<Phone>0571-85642212</Phone>
<Total>250</Total>
<Postage>10</Postage>
<CustomerRemark>用申通快递</CustomerRemark>
<Remark></Remark>
<Item>
<GoodsID>YF001</ GoodsID>
<GoodsName>衣服</GoodsName>
<Price>1.0</Price>
<Count>2</Count>
</Item>
<Item>
<GoodsID>PJ002</ GoodsID>
<GoodsName>皮带</GoodsName>
<Price>76.5</Price>
<Count>1</Count>
</Item>
</Order>
二. 货品和库存同步
当库存发送变化时,《网店管家》会产生一条库存同步消息。参数如下:
参数 |
说明 |
uCode |
接入码,用于验证请求的有效性。接入码的值在网店系统和《网店管家》中设置,必须一致。 |
mType |
请求类别,同步库存时,该值为“mUpdateStock”。 |
GoodsNO |
货品编号 |
GoodsSpec |
货品规格 |
Stock |
库存量 |
成功:<rsp><result>1</result></rsp>
失败:<rsp><result>0</result><cause>拒绝原因</cause></rsp>
初始建立货品时,可以先同步一条货品信息:
参数 |
说明 |
uCode |
接入码,用于验证请求的有效性。接入码的值在网店系统和《网店管家》中设置,必须一致。 |
mType |
mNewGoods |
GoodsNO |
货品编号 |
GoodsName |
货品名称 |
GoodsSpec |
货品规格 |
GoodsUnit |
货品单位 |
dPriceDetail |
零售价 |
dPricewholesale1 |
批发价1 |
dPricewholesale2 |
批发价2 |
dPricewholesale3 |
批发价3 |
Stock |
库存量 |
bMultiSpec |
是否存在多规格 |
Remark |
备注 |
成功:<rsp><result>1</result></rsp>
失败:<rsp><result>0</result><cause>拒绝原因</cause></rsp>
同步规格信息:
参数 |
说明 |
uCode |
接入码,用于验证请求的有效性。接入码的值在网店系统和《网店管家》中设置,必须一致。 |
mType |
mNewGoodsSpec |
GoodsNO |
货品编号 |
GoodsSpec |
货品规格 |
Stock |
库存量 |
成功:<rsp><result>1</result></rsp>
失败:<rsp><result>0</result><cause>拒绝原因</cause></rsp>
删除货品:
参数 |
说明 |
uCode |
接入码,用于验证请求的有效性。接入码的值在网店系统和《网店管家》中设置,必须一致。 |
mType |
mDelGoods |
GoodsNO |
货品编号 |
成功:<rsp><result>1</result></rsp>
失败:<rsp><result>0</result><cause>拒绝原因</cause></rsp>
删除货品的规格:
参数 |
说明 |
uCode |
接入码,用于验证请求的有效性。接入码的值在网店系统和《网店管家》中设置,必须一致。 |
mType |
mDelGoods |
GoodsNO |
货品编号 |
GoodsSpec |
货品规格 |
成功:<rsp><result>1</result></rsp>
失败:<rsp><result>0</result><cause>拒绝原因</cause></rsp>
三. 发货通知
当订单发货时,《网店管家》会产生对应的发货通知消息。参数如下:
参数 |
说明 |
uCode |
接入码,用于验证请求的有效性。接入码的值在网店系统和《网店管家》中设置,必须一致。 |
mType |
请求类别,发货通知时,该值为“mSndGoods”。 |
OrderID |
订单编号 |
OrderNO |
原始订单编号 |
CustomerID |
客户网名 |
SndStyle |
发货方式 |
BillID |
货运单号 |
SndDate |
发货时间 |
成功:<rsp><result>1</result></rsp>
失败:<rsp><result>0</result><cause>拒绝原因</cause></rsp>
四. 订单状态同步
当订单状态发生变化时,《网店管家》会产生对应的同步消息。参数如下:
参数 |
说明 |
uCode |
接入码,用于验证请求的有效性。接入码的值在网店系统和《网店管家》中设置,必须一致。 |
mType |
请求类别,发货通知时,该值为“mChgStatus”。 |
OrderID |
订单编号 |
sStatus |
状态 |
成功:<rsp><result>1</result></rsp>
失败:<rsp><result>0</result><cause>拒绝原因</cause></rsp>
五. 客户资料同步
客户资料接口用于同步客户的积分和预存款资料。
参数 |
说明 |
uCode |
接入码,用于验证请求的有效性。接入码的值在网店系统和《网店管家》中设置,必须一致。 |
mType |
请求类别,发货通知时,该值为“mCustomerInfo”。 |
CustomerID |
客户编号 |
sScores |
积分 |
sBalance |
预存款 |
成功:<rsp><result>1</result></rsp>
失败:<rsp><result>0</result><cause>拒绝原因</cause></rsp>
六. 接口测试
《网店管家》启动消息同步之前,会测试接口有效性,务必接受该消息。参数如下:
参数 |
说明 |
uCode |
接入码,用于验证请求的有效性。接入码的值在网店系统和《网店管家》中设置,必须一致。 |
mType |
请求类别,测试时,该值为“mTest”。 |
成功:<rsp><result>1</result></rsp>
失败:<rsp><result>0</result><cause>拒绝原因</cause></rsp>
例子
返回订单的asp例子
<%
str = "<?xml version='1.0' encoding='gb2312'?>" & chr(13)
str = str & "<Order>" & chr(13)
str = str & "<Ver>1.0</Ver>" & chr(13)
str = str & "<OrderID>a4fd5a4fda1f2a1d</OrderID>" & chr(13)
str = str & "<DateTime>2006-06-08:12:30</DateTime>" & chr(13)
str = str & "<BuyerID>huadog</BuyerID>" & chr(13)
str = str & "<BuyerName>张三</BuyerName>" & chr(13)
str = str & "<Country>中国</Country>" & chr(13)
str = str & "<Province>浙江省</Province>" & chr(13)
str = str & "<City>杭州</City>" & chr(13)
str = str & "<Town>西湖区</Town>" & chr(13)
str = str & "<Adr>文三路90号</Adr>" & chr(13)
str = str & "<Zip>310012</Zip>" & chr(13)
str = str & "<Email>zhangsan@163.com</Email>" & chr(13)
str = str & "<Phone>0571-85642212</Phone>" & chr(13)
str = str & "<Total>250</Total>" & chr(13)
str = str & "<Postage>10</Postage>" & chr(13)
str = str & "<Remark></Remark>" & chr(13)
str = str & "<Item>" & chr(13)
str = str & "<GoodsID>YF001</GoodsID>" & chr(13)
str = str & "<GoodsName>衣服</GoodsName>" & chr(13)
str = str & "<Price>185.00</Price>" & chr(13)
str = str & "<Count>1</Count>" & chr(13)
str = str & "</Item>" & chr(13)
str = str & "<Item>" & chr(13)
str = str & "<GoodsID>PJ002</GoodsID>" & chr(13)
str = str & "<GoodsName>皮带</GoodsName>" & chr(13)
str = str & "<Price>65.00</Price>" & chr(13)
str = str & "<Count>2</Count>" & chr(13)
str = str & "</Item>" & chr(13)
str = str & "</Order>" & chr(13)
Response.write str
%>
------该帖子于2010-8-6 12:32:25被作者编辑过------
------该帖子于2011-11-9 21:57:52被作者编辑过------
------该帖子于2011-11-9 22:02:44被作者编辑过------