当前位置: 文档中心

自研系统&三方系统接入奇门自定义场景

注:对接奇门自定义API对接旺店通开放平台标准API,可实现的业务场景是相同的,所有需要从旺店通ERP获取淘系非敏感数据的,都需通过奇门自定义接口实现。


一、 奇门自定义API对接背景说明

1.1  国家在2017年6月1号正式实施《网络安全法》,法规明确网络运营者保障消费者数据的责任和义务。(阿里生态的合作伙伴,商家都属于网络运营者)
1.2  淘宝开放平台2017年5月18号发布数据安全违规排查公告,将于2017年6月1号开始做排查。公告地址:http://open.taobao.com/support/announcementDetail.htm?spm=a219a.7839801.0.0.xZ5mBu&id=25247
1.3  为了达到用户隐私数据安全保护的规范要求,奇门自定义中涉及到的用户隐私的字段数据将无法提供。

隐私字段列表

字段描述字段名
买家支付宝账号buyer_alipay_no
卖家支付宝IDalipay_id
收货人姓名receiver_name
收货人详细地址receiver_address
收货人手机号码receiver_mobile
收货人电话号码receiver_phone
收货人邮箱receiver_email
证件号id_card
买家网名

buyer_nick



二、申请奇门appkey及创建应用

1.1 自研系统:商家自研发系统,参考“自研系统接入”流程申请appkey,“查看详情”。

1.2 三方系统:线下ERP(SAP、金蝶、用友等)、线下CRM,线下POS、WMS参考“三方系统接入”流程申请appkey,“查看详情”。

1.3 其他业务系统:自研及上述三方系统以外的系统,参考淘宝开放平台新手指南申请appkey,https://open.taobao.com/doc.htm?docId=118395&docType=1

注:只要拥有任意应用类型的淘宝开放平台appkey都可以对接奇门自定义场景下的API。



三、奇门自定义API对接实现

1.1  奇门介绍

  • 奇门只是一个数据传输的通道,卖家只需要与奇门对接,将请求发送给奇门。奇门通过卖家请求参数中的目标appkey:target_app_key来锁定卖家目标请求的是旺店通,因此请求到旺店通接口,旺店通再通过奇门将数据返回给卖家。

  • 针对原始形式的接口,如果客户需要对接三个系统,那么需要开发三套对接逻辑。改造成奇门接口之后,只要开发一套对接奇门的逻辑,改变参数target_app_key就可以对接任意系统。(前提是,该系统支持奇门对接)。



1.2 数据传输描述:

   

1.3旺店通对商家(服务商)奇门appkey授权,方式如下,授权后可开始进行测试开发

1.3.1 如果是奇门ERP-CRM场景、奇门自定义场景如下步骤申请联调

1.3.1 申请步骤:奇门场景申请联调,点击查看奇门自助指南(https://open.wangdian.cn/qjb/open/abut/zzzn_qimen

1.3.2 邮件回复授权结果,并附带旺店通appkey(奇门API请求必传参数target_app_key)

1.4 测试开发

  • SDK下载(含使用说明):淘宝SDK及使用说明.zip 

  • 测试开发过程问题解决:联调时会有相应联调群,问题再群中处理

  • 奇门自定义API与旺店通标准API参数对比说明。

请求地址:

接口环境 

奇门自定义api

测试地址 

http://3ldsmu02o9.api.taobao.com/router/qmtest                     

正式地址 

http://3ldsmu02o9.api.taobao.com/router/qm                           

 接口名:


奇门自定义api

接口名举例

method= wdt.purchase.purchasereturn.cancelorder(入参参数)             

 公共参数:


奇门自定义api

卖家账号  

sid

wdtapi3

应用授权

app_key

奇门授权应用(213XXXX

时间戳

timestamp

格式化后的时间戳2019-12-06   10:37:00

签名

sign

API输入参数签名结果,签名算法介绍请点击这里

奇门接口名

method

参考原接口名转化refund_query=wdt.refund.query

目标appkey

target_app_key

旺店通在奇门授权应用(授权通知邮件中提供)

响应数据格式

format

响应格式。默认为xml格式,可选值:xml,json。

sign计算加密方式

sign_method

API输入参数签名结果,签名算法介绍请点击这里

版本

v

固定值2.0

业务参数:

与旺店通标准API相同,可通过下述1.5奇门API与旺店通标准API对应关系,查看准确业务参数。查看旺店通标准API

 响应参数:


奇门自定义api

正确响应

data(与标准接口返回的data节点内容一致)

 


错误响应

"flag":"failure"(奇门增加一个flag字段,固定为failure)代表响应失败。

request_id(请求id

code(奇门错误码)

message(奇门错误信息)

sub_code(旺店通错误码)

sub_message(旺店通错误信息)


1.5奇门自定义API列表

分类                  奇门接口名称(method)                               旺店通标准接口名称                                           接口描述                                         
基础类wdt.setting.shop.queryshopsetting.Shop.queryShop查询店铺详细信息
基础类

wdt.setting.warehouse.querywarehouse

setting.Warehouse.queryWarehouse查询仓库详情信息
基础类wdt.setting.logistics.querylogisticssetting.Logistics. queryLogistics查询物流档案
基础类wdt.setting.purchaseprovider.querydetailsetting.PurchaseProvider.queryDetail查询供应商信息
基础类wdt.setting.purchaseprovider.push      setting.PurchaseProvider.push推送供应商信息
货品类wdt.goods.goods.pushgoods.Goods.push推送货品档案
货品类wdt.goods.goods.querywithspecgoods.Goods.queryWithSpec查询货品档案
货品类wdt.purchase.providergoods.querydetailpurchase.ProviderGoods.queryDetail查询供应商货品
货品类wdt.goods.suite.search      goods.Suite.search查询组合装货品
货品类wdt.goods.apigoods.searchgoods.ApiGoods.search查询平台货品
订单类wdt.sales.rawtrade.pushselfsales.RawTrade.pushSelf推送原始单
订单类wdt.sales.tradequery.querywithdetailsales.TradeQuery.queryWithDetail查询订单
订单类wdt.wms.stockout.sales.querywithdetailwms.stockout.Sales.queryWithDetail查询销售出库单
订单类wdt.sales.logisticssync.update        sales.LogisticsSync.update物流同步回传
订单类wdt.sales.logisticssync.getsynclistextsales.LogisticsSync.getSyncListExt获取待同步列表
订单类wdt.sales.logisticssync.getspecialoidssales.LogisticsSync.getSpecialOids获取特殊oids订单
订单类wdt.statistic.statsalesstatistic.querysales  statistic.StatSalesStatistic.statSalesBySpecShopWarehouse销售汇总查询
订单类wdt.finance.rawpayment.searchfinance.RawPayment.search平台账单查询
订单类wdt.sales.tradequery.queryhistorywithdetailsales.TradeQuery.queryHistoryWithDetail 历史订单查询
订单类wdt.wms.stockout.sales.queryhistorywithdetail wms.stockout.Sales.queryHistoryWithDetail历史销售出库单查询
售后类wdt.aftersales.refund.rawrefund.uploadaftersales.refund.RawRefund.upload推送原始退款单
售后类wdt.wms.stockin.refund.querywithdetail         wms.stockin.Refund.queryWithDetail查询退货入库单
售后类wdt.aftersales.refund.refund.searchaftersales.refund.Refund.search查询退换单
售后类wdt.wms.stockin.smartrefund.createextwms.stockin.SmartRefund.createExt快速退货
售后类wdt.wms.stockout.sales.queryhistorywithdetail aftersales.refund.Refund.searchHistory历史退换单查询
采购类wdt.purchase.purchaseorder.createorderpurchase.PurchaseOrder.createOrder创建采购单
采购类wdt.wms.stockin.purchase.uploadwms.stockin.Purchase.upload创建采购入库单
采购类wdt.purchase.purchaseorder.querywithdetailpurchase.PurchaseOrder.queryWithDetail查询采购单信息
采购类wdt.wms.stockin.purchase.querywithdetailwms.stockin.Purchase.queryWithDetail查询采购入库单
采购类wdt.purchase.purchasereturn.createorderpurchase.PurchaseReturn.createOrder创建采购退货单
采购类wdt.purchase.purchasereturn.querywithdetailpurchase.PurchaseReturn. queryWithDetail查询采购退货单
采购类wdt.wms.stockout.purchasereturn.querywithdetailwms.stockout.PurchaseReturn.queryWithDetail查询采购退货出库单
采购类wdt.purchase.purchasereturn.cancleorderpurchase.PurchaseReturn.cancelOrder取消采购退货单
采购类wdt.finance.settle.purchase.searchfinance.settle.purchase.search查询采购结算单
库存类wdt.wms.stockspec.searchwms.StockSpec.search库存查询
库存类wdt.wms.stockspec.queryavailablestockwms.StockSpec.queryAvailableStock可用库存查询
库存类wdt.wms.stockpd.stocksyncbypd      wms.StockPd.stockSyncByPd执行盘点
库存类wdt.wms.stockin.other.createotherstockinorderwms.stockin.Other.createOtherOrder创建其他入库
库存类wdt.wms.stockout.other.createotherstockoutorderwms.stockout.Other.createOther创建其他出库单
库存类wdt.wms.stockin.other.querywithdetailwms.stockin.Other.queryWithDetail查询其他入库单
库存类wdt.wms.stockout.otherquery.querywithdetailwms.stockout.OtherQuery.queryWithDetail查询其他出库单
库存类wdt.wms.stocktransfer.edit.createorderwms.stocktransfer.Edit.createOrder创建调拨单
库存类wdt.wms.stockout.transfer.createorderwms.stockout.Transfer.createOrder创建调拨出库单
库存类wdt.wms.stockin.transfer.querywithdetailwms.stockin.Transfer.queryWithDetail创建调拨入库单
库存类wdt.wms.stocktransfer.manage.querywithdetailwms.stocktransfer.Manage.queryWithDetail查询调拨单信息
库存类wdt.wms.moveorder.querywithdetailwms.MoveOrder.queryWithDetail查询移位单
库存类wdt.wms.stockin.prestockin.searchwms.stockin.PreStockin.search查询预入库单
库存类wdt.wms.stockpd.querystockpdindetailwms.StockPd.queryStockPdInDetail盘点入库单查询
库存类wdt.wms.stockpd.querystockpdoutdetailwms.StockPd.queryStockPdOutDetail盘点出库单查询
库存类wdt.wms.stockother.in.pushwms.stockother.in.push其它入库业务单创建
库存类wdt.wms.stockother.out.pushwms.stockother.out.push其它出库业务单创建
库存类wdt.wms.stockshelve.querywithdetailwms.StockShelve.queryWithDetail补货单查询


四、上线