当前位置: 文档中心

接口规范说明


1. 通讯协议

  • REST风格的API,使用HTTP协议发送POST请求调用接口。

  • HTTP请求头类型为 Content-Type: application/json 或者 Content-Type: application/xml,暂不支持Content-Type: application/x-www-form-urlencoded


2. 报文及报文编码

  • 报文为UTF8编码,支持半角、中文、英文、数字、基本标点符号,请注意不要有表情符号等各种非法字符,会导致数据库写入失败。

  • 请求报文body为json或xml格式

  • 为了保证传输数据的安全性,API采用了对称加密的方式,旺店通开放平台会为每个接入客户分配appkey和appsecret,通过计算sign(签名)来防止恶意的数据篡改,具体的sign计算方式请参考 sign算法” 文档

  • 编码示例:key=urlencode(value)&key=urlencode(value) urlencode() 为进行编码的方法。(每个语言的编码函数可能不同,请开发者自主选择具体的url编码方式)。

  • 注意:appsecret不要作为请求参数发送到互联网中。

  • 注意:旺店通ERP存在商品明细的单据中可以存在多行商家编码一样的商品,如果对接的系统不支持此情况,需进行合并处理。


3. 接口文档说明

3.1 接口说明

  • 用于接口描述、接口级别注意事项、敏感数据以及建议调用方式等。

3.2 调用场景

  • 用于说明接口适用对接的系统。

3.3请求参数说明

  • 描述了请求报文所有输入参数的含义及注意事项。

3.3.1 请求地址(url)

  • 接口文档该部分描述了每个接口的测试和正式环境请求地址。

       1)测试环境:http://47.92.239.46/openapi

       2)正式环境:http://wdt.wangdian.cn/openapi

3.3.2 公共请求参数

  • 每个接口都必须输入的参数。接口文档该部分阐述了请求报文中公共请求参数的含义及注意事项,参数详见下述表格。

  • 注:appsecret作为校验数据安全使用,不要将它作为公共参数传输到互联网中。

名称字段类型长度
必须描述
卖家账号sidString
购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。
接口账号keyString
由旺店通分配appkey, 在发送的数据中对应 key 字段
密钥appsecretString
由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt.
接口名称
methodString
调用的接口名称
版本号vString
1.0
秒级时间戳timestampint
秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。
签名signString
签名
分页大小page_sizeint
分页大小,分页查询必传
分页编号page_noint
分页编号,分页查询必传,标准接口page_no从0开始
是否计算查询结果的总条数calc_totalint
是否计算查询结果的总条数, 需要计算则1, 否则填0   


3.3.3 业务请求参数

  • 可根据业务不同,选择输入的参数。接口文档该部分阐述了请求报文中业务请求参数的含义及注意事项。

4 .1响应参数

  • 接口文档该部分描述了所有响应参数的含义及注意事项

  1)公共响应参数

  • 接口文档该部分描述了,请求的当前接口,不论请求失败还是成功,一定会返回的参数,文档该部分描述了公共响应参数的含义。

  2)业务响应参数

  • 根据请求的参数输入值不同,做不同响应的参数,文档该部分描述了业务响应参数的含义

3.3.5 请求示例

  • 调用接口的请求示例,有PHP、JAVA、C#三种示例。

3.3.6 响应示例

  • 调用接口后返回的json格式数据 ,需要使用json解析函数进行解析,使用Unicode转换具体的字段含义解释,并且给出了正常响应和异常响应两种响应示例。


4. 接口流量及调用频率限制

 4.1 流量限制

  • 限制条件:sid+appkey+接口

  • 限制规则:100万次/日

  • 涉及接口:所有接口

 4.2 频率限制

  • 限制条件:sid+appkey+接口

  • 限制规则:

         ①仅限制并发量:并发量是指调用开放平台API接口允许同时请求的线程个数。

         ②同时限制并发量和调用频率:调用频率旺店通旗舰版开放平台的定义为每分钟允许请求的次数。

  • 限制说明详情如下

基础类

接口服务名接口名并发量&频率/min
setting.Logistics.queryLogistics物流公司查询3 & 60次/min
setting.PurchaseProvider.queryDetail供应商查询3 & 60次/min
setting.Warehouse.queryWarehouse仓库查询
3 & 60次/min
setting.Shop.queryShop店铺查询
3 & 60次/min
setting.PurchaseProvider.push供应商信息推送3 & 60次/min
setting.Shop.updateShop店铺更新3 & 60次/min
setting.Employee.search员工查询3 & 60次/min
setting.strategy.VirtualWarehouse.warehouseSearch虚拟仓库存查询3 & 60次/min
setting.CustomAttr.getTradeProp订单自定义属性查询3 & 60次/min

货品类

接口服务名接口名并发量&频率/min
goods.Goods.push货品推送
3 & 60次/min
goods.Suite.search组合装查询3 & 60次/min
goods.Goods.queryWithSpec货品档案查询3 & 60次/min
goods.ApiGoods.search平台货品查询3 & 60次/min
goods.ApiGoods.upload平台货品推送3 & 60次/min
process.Bom.upload物料清单推送3 & 60次/min
process.Process.upload生产单推送3 & 60次/min
process.Process.search生产单查询3 & 60次/min
goods.GoodsClass.search货品分类查询3 & 60次/min
goods.GoodsBrand.search货品品牌查询3 & 60次/min
goods.Category.search
平台类目查询
3 & 60次/min
goods.Goods.batchPush货品批量推送
3 & 60次/min
process.Bom.search物料清单查询
3 & 60次/min
goods.Barcode.upload条码上传
3 & 60次/min
goods.GoodsClass.upload新建分类3 & 60次/min

订单类

接口服务名接口名并发量&频率/min
sales.LogisticsSync.update物流同步状态回传3 & 60次/min
sales.RawTrade.pushSelf原始单推送3 & 60次/min
sales.TradeQuery.queryWithDetail订单查询3 & 60次/min
wms.stockout.Sales.queryWithDetail销售出库单查询3 & 60次/min
wms.stockout.Sales.weighingExt重量回传
3 & 60次/min
wms.stockout.Sales.onceWeighing重量回传23 & 60次/min
wms.stockout.Sales.onceWeighingByNo重量回传33 & 60次/min
wms.stockout.Sales.salesWeighing重量回传43 & 60次/min
sales.LogisticsSync.getSyncListExt待同步列表查询3 & 60次/min
sales.LogisticsSync.getSpecialOids特殊oids查询3 & 60次/min
finance.RawPayment.search平台账单查询3 & 60次/min
finance.RawPayment.push平台账单推送3 & 60次/min
sales.TradeQuery.queryHistoryWithDetail历史订单查询3 & 60次/min
sales.StockSync.cancelSync取消当前同步
3 & 60次/min
sales.StockSync.syncFail库存同步失败3 & 60次/min
sales.StockSync.syncSuccess库存同步成功3 & 60次/min
sales.StockSync.getSelfWaitSyncIdListOpen获取自有平台货品信息3 & 60次/min
sales.StockSync.calcStock计算自有平台货品应该同步的库存3 & 60次/min
finance.RawPayment.search平台账单查询3 & 60次/min
finance.invoice.InvoiceOrder.search发票信息查询3 & 60次/min
finance.invoice.InvoiceOrder.updateInvoice发票信息更新3 & 60次/min
finance.AlipayAccountCheck.search
平台对账单查询3 & 60次/min
sales.RawTrade.search原始单查询3 & 60次/min
wms.stockout.Sales.queryHistoryWithDetail历史销售出库单查询3 & 60次/min
sales.TradeQuery.getTradeMergedLog被合并订单查询3 & 60次/min
finance.Payment.search收付款单查询3 & 60次/min
sales.TradeEdit.modifyRemark订单客服备注修改3 & 60次/min
wms.stockout.Sales.searchLogistics物流单查询3 & 60次/min
sales.RawTrade.searchHistory
历史原始单查询
3 & 60次/min
sales.jit.JitRefund.search
JIT退货单查询

3 & 60次/min

sales.RawTrade.pushSelf2原始单推送2
3 & 60次/min
wms.stockout.Sales.searchPositionDetail实际出库明细查询
3 & 60次/min
sales.Payment.queryWithDetail销售收付单查询3 & 60次/min
sales.TradeImport.upload已完成订单推送3 & 60次/min
wms.stockout.Sales.searchCancel已取消出库单查询3 & 60次/min
sales.TradeQuery.getLog订单日志查询3 & 60次/min
setting.CustomAttr.getTradeLabel订单标签查询3 & 60次/min
sales.TradeEdit.toException
订单转异常订单3 & 60次/min
setting.OperationReason.search
退换原因查询3 & 60次/min

售后类

接口服务名接口名并发量&频率/min
wms.stockin.SmartRefund.upload快速退货3 & 60次/min
wms.stockin.Refund.queryWithDetail退货入库单查询3 & 60次/min
wms.stockin.PreStockin.cancel退货预入库单取消
3 & 60次/min
aftersales.refund.RawRefund.upload原始退款单推送

3 & 60次/min

aftersales.refund.Refund.search退换单查询3 & 60次/min
aftersales.refund.Refund.searchHistory历史退换单查询3 & 60次/min
aftersales.refund.RawRefund.search原始退款单查询3 & 60次/min
wms.stockin.PreStockin.createExt创建退货预入库3 & 60次/min
aftersales.refund.RawRefund.upload2原始退款单推送2
3 & 60次/min
wms.stockin.Refund.createOrder退货入库单推送
3 & 60次/min
wms.stockin.Refund.queryHisWithDetail历史退货入库单查询3 & 60次/min
aftersales.refund.RawRefund.searchHistory历史原始退款单查询3 & 60次/min

采购类

接口服务名接口名并发量&频率/min
purchase.PurchaseReturn.queryWithDetail采购退货单及明细查询3 & 60次/min
purchase.PurchaseReturn.cancleOrder采购退货单取消3 & 60次/min
purchase.PurchaseReturn.createOrder采购退货单新建3 & 60次/min
purchase.PurchaseOrder.queryWithDetail采购单及明细查询3 & 60次/min
purchase.PurchaseOrder.createOrder采购单新建3 & 60次/min
finance.settle.Purchase.search采购结算单查询3 & 60次/min
wms.stockin.Purchase.upload采购入库单推送3 & 60次/min
wms.stockout.PurchaseReturn.queryWithDetail采购退货出库单查询3 & 60次/min
wms.stockin.Purchase.cancel采购入库单取消3 & 60次/min
wms.stockin.Purchase.queryWithDetail采购入库单查询3 & 60次/min
purchase.PurchaseOrder.cancelOrder采购单取消3 & 60次/min
purchase.PurchaseOrder.pending采购单停止等待3 & 60次/min
purchase.ProviderGoods.queryDetail供应商货品查询
3 & 60次/min
purchase.ProviderGoods.upload供应商货品推送3 & 60次/min
purchase.PurchaseReturn.pending采购退货单停止等待3 & 60次/min
wms.stockout.PurchaseReturn.createOrder采购退货出库单创建3 & 60次/min
purchase.PurchaseOrder.updatePurchaseInfo采购单信息更新3 & 60次/min
purchase.PurchaseApply.upload
采购申请单创建3 & 60次/min
purchase.PurchaseApply.search
采购申请单查询3 & 60次/min
purchase.PurchaseReturn.batchCancelOrder采购退货批量取消
3 & 60次/min
finance.settle.Purchase.upload创建采购结算单
3 & 60次/min
purchase.PurchaseOrder.cancelByType采购单取消(新)3 & 60次/min
purchase.PurchaseApply.cancelForApi
采购申请单取消3 & 60次/min
purchase.PurchaseApply.stopForApi
采购申请单停止引用3 & 60次/min

库存类

接口服务名接口名并发量&频率/min
wms.MoveOrder.queryWithDetail移位单查询3 & 60次/min
wms.StockSpec.search库存查询3 & 60次/min
wms.StockPd.stockSyncByPd创建盘点单3 & 60次/min
wms.stockin.Other.createOtherOrder其他入库单新建3 & 60次/min
wms.stocktransfer.Manage.queryWithDetail调拨单查询3 & 60次/min
wms.stockout.OtherQuery.queryWithDetail其他出库单查询3 & 60次/min
wms.stockin.Other.queryWithDetail其他入库单查询3 & 60次/min
wms.stockin.Transfer.queryWithDetail调拨入库单查询3 & 60次/min
wms.StockSpec.queryAvailableStock可用库存查询3 & 60次/min
wms.stockout.Transfer.queryWithDetail调拨出库单查询3 & 60次/min
wms.stockout.Other.createOther其他出库单新建3 & 60次/min
wms.stockin.Transfer.cancelOrder调拨单入库取消3 & 60次/min
wms.StockPd.queryStockPdInDetail盘点入库单查询3 & 60次/min
wms.StockPd.queryStockPdOutDetail盘点出库单查询3 & 60次/min
wms.stockout.Transfer.cancelOrder调拨单出库取消3 & 60次/min
wms.stocktransfer.Manage.cancelOrder调拨单取消3 & 60次/min
wms.stockin.Transfer.createOrder调拨入库单新建3 & 60次/min
wms.stockout.Transfer.createOrder调拨出库单新建3 & 60次/min
wms.StockShelve.queryWithDetail补货单查询3 & 60次/min
wms.StockSpec.queryChangeHistory库存变化查询
3 & 60次/min
finance.StockCost.search存货成本查询
3 & 60次/min
wms.stocktransfer.Manage.pending调拨单停止等待
3 & 60次/min
wms.stockother.Out.push其他出库业务单创建
3 & 60次/min
wms.stockother.In.push其他入库业务单创建
3 & 60次/min
wms.stockout.Process.queryWithDetail生产出库查询
3 & 60次/min
wms.stockin.Process.queryWithDetail生产入库查询
3 & 60次/min
wms.outer.OuterOut.createOrder外仓调整出库单创建
3 & 60次/min
wms.outer.OuterIn.createOrder外仓调整入库单创建
3 & 60次/min
wms.outer.OuterOut.queryWithDetail外仓调整出库单查询
3 & 60次/min
wms.outer.OuterIn.queryWithDetail外仓调整入库单查询
3 & 60次/min
finance.settle.Transfer.search调拨结算查询
3 & 60次/min
wms.stockdefect.DefectChange.search正残转换单查询3 & 60次/min
wms.stockother.OutQuery.queryWithDetail其它出库业务单查询3 & 60次/min
wms.stockother.InQuery.queryWithDetail其它入库业务单查询3 & 60次/min
wms.stockout.SalesPick.pickListOverviewForApi分拣单全览3 & 60次/min
wms.PositionCapacity.search默认货位查询3 & 60次/min
setting.strategy.VirtualWarehouse.stockSearch虚拟仓库存查询3 & 60次/min
setting.strategy.VirtualWarehouse.create虚拟仓订单创建3 & 60次/min
setting.strategy.VirtualWarehouse.orderSearch虚拟仓单据查询3 & 60次/min
wms.stockout.Pack.search装箱单查询3 & 60次/min
wms.stockin.JitRefund.searchOrderWithDetailJIT退货入库单查询3 & 60次/min
wms.GoodsSN.queryWithDetailSN码查询
3 & 60次/min
finance.settle.OtherIn.upload其它入库业务结算单创建
3 & 60次/min
wms.StockSpec.search2库存查询2
3 & 60次/min
statistic.StockoutCollect.queryCostWithDetail出库瞬时成本查询
3 & 60次/min
statistic.StockinCollect.queryCostWithDetail入库瞬时成本查询
3 & 60次/min
wms.StockPd.queryStockPd盘点单查询
3 & 60次/min
wms.StockPd.queryStockPdDetail盘点单明细查询
3 & 60次/min
wms.stockin.Base.search入库单查询3 & 60次/min
wms.stockout.Base.search出库单查询3 & 60次/min
wms.StockSpec.stockDetailSearch
库存明细查询3 & 60次/min
wms.stockout.Base.searchSN
出库SN查询3 & 60次/min
wms.stockin.Base.searchSN
入库SN查询3 & 60次/min
wms.stockin.Base.uploadSN
入库SN明细推送3 & 60次/min
wms.stockout.Base.uploadSN
出库SN明细推送3 & 60次/min
wms.stockin.Other.cancelOtherOrder
其他入库单取消3 & 60次/min
wms.stockout.Other.cancelOtherOrder
其他出库单取消3 & 60次/min