API文档

当前位置： API文档

订单类

接口服务名	接口名	接口描述	客户端路径
wms.stockout.Sales.queryWithDetail	销售出库单查询	为了达到保护用户隐私数据安全的目的，本接口中涉及到用户隐私的字段数据仅自有平台订单返回，具体字段详见下述“隐私字段列表”。	仓储-销售出库-销售出库单
sales.LogisticsSync.update	物流同步状态回传	物流同步状态回传	销售-信息同步-物流同步
sales.RawTrade.pushSelf	原始单推送	①推送销售订单给ERP ②更新已推送成功的销售订单	销售--订单管理--原始订单
sales.LogisticsSync.getSyncListExt	待同步列表查询	查询待同步物流列表	销售-物流同步
wms.stockout.Sales.weighingExt	重量回传	自动化称重机、自动化分拣系统、仓储设备控制系统等称重以后，将重量回传写入旺店通ERP销售出库单
wms.stockout.Sales.onceWeighing	重量回传2	自动化称重机、自动化分拣系统、仓储设备控制系统等称重以后，将重量回传写入旺店通ERP销售出库单，并返回部分相关信息
finance.invoice.InvoiceOrder.search	发票信息查询	获取发票信息	账款-发票管理-发票管理
finance.invoice.InvoiceOrder.updateInvoice	发票信息更新	更新发票信息
finance.RawPayment.search	平台账单查询	获取ERP内的平台账单	账款-收款付款-平台账单
finance.RawPayment.push	平台账单推送	推送平台账单给ERP
sales.StockSync.cancelSync	取消当前同步	取消库存同步
sales.StockSync.syncFail	库存同步失败	库存同步失败时调用
sales.StockSync.syncSuccess	库存同步成功	库存同步成功时调用
sales.StockSync.getSelfWaitSyncIdListOpen	获取自有平台货品需要同步信息	获取自有平台货品需要同步信息	货品-平台货品
wms.stockout.Sales.queryHistoryWithDetail	历史销售出库单查询	获取ERP历史销售出库单信息	仓储-销售出库-历史销售出库单
finance.AlipayAccountCheck.search	平台对账单查询	获取ERP平台对账单信息	账款--收款付款--平台对账
sales.TradeQuery.getTradeMergedLog	被合并订单查询	查询被合并订单信息
finance.Payment.search	收付款单查询	获取ERP内收付款单信息	账款--收款付款--收付款单
wms.stockout.Sales.onceWeighingByNo	重量回传3	自动化称重机、自动化分拣系统、仓储设备控制系统等称重以后，将重量回传写入旺店通ERP销售出库单，并返回部分相关信息
sales.StockSync.calcStock	库存同步计算查询	计算自有平台货品应该同步的库存，原sales.StockSync.calcStockWithAuth替代接口
wms.stockout.Sales.salesWeighing	重量回传4	外部应用回传包裹重量\包裹长宽高\发货
sales.TradeEdit.modifyRemark	订单客服备注修改	修改未审核订单客服备注，一次最多100条	销售--订单审核
wms.stockout.Sales.searchLogistics	物流单查询	查询包含多物流的出库物流单信息	账款--单据结算--邮资结算--物流单管理
sales.jit.JitRefund.search	JIT退货单查询	获取ERP内JIT退货单信息	销售--唯品会JIT--JIT退货单
sales.RawTrade.pushSelf2	原始单推送2	推送自有平台订单给ERP
wms.stockout.Sales.searchPositionDetail	销售出库实际出库明细查询	获取销售出库实际出库明细数据	仓储--销售出库--销售出库信息--实际出库明细
sales.Payment.queryWithDetail	销售收付单查询	获取ERP内销售收付单数据	销售--销售收付单
sales.TradeImport.upload	已完成订单推送	推送已完成订单给ERP	销售-新增订单-订单导入
wms.stockout.Sales.searchCancel	已取消出库单查询	获取已取消的销售出库单
sales.TradeQuery.getLog	订单日志查询	查询订单日志
setting.CustomAttr.getTradeLabel	订单标签查询	获取订单标签数据
sales.TradeEdit.toException	订单转异常订单	将订单转入异常订单
sales.StockSync.batchCalcStock	库存同步计算查询（批量）	批量获取库存同步结果
sales.TradeQuery.querySelfOrderWithDetail	订单查询（仅返回自有平台、线下平台订单信息）	仅返回自有平台、线下平台订单信息
sales.RawTrade.searchHistorySelfOrder	历史原始单查询（仅返回自有平台、线下平台订单）	仅返回自有平台及线下平台订单
sales.TradeQuery.queryHistorySelfOrderWithDetail	历史订单查询（仅返回自有平台、线下平台订单）	仅返回自有平台、线下平台订单信息
sales.RawTrade.searchSelfOrder	原始单查询（仅返回自有平台、线下平台订单）	仅返回自有平台、线下平台订单

基础类

接口服务名	接口名	接口描述	客户端路径
setting.Logistics.queryLogistics	物流公司查询	获取ERP的物流公司档案资料	设置-基本设置-物流
setting.PurchaseProvider.queryDetail	供应商查询	获取ERP的供应商档案资料	设置-基本设置-供应商
setting.Warehouse.queryWarehouse	仓库查询	获取ERP的仓库档案资料	设基-基本设置-仓库
setting.Shop.queryShop	店铺查询	获取ERP的店铺档案资料	设置-基本设置-店铺
setting.PurchaseProvider.push	供应商信息推送	推送供应商档案资料给ERP	设置-基本设置-供应商
setting.Shop.updateShop	店铺更新	更新ERP的店铺档案资料	设置-基本设置-店铺
setting.Employee.search	员工查询	获取ERP内员工信息	设置--基本设置-员工
setting.strategy.VirtualWarehouse.warehouseSearch	虚拟仓仓库查询	获取ERP虚拟仓仓库信息	设置--策略设置--虚拟仓策略--虚拟仓
setting.OperationReason.search	退换原因查询	查询客户端的退换原因	设置-基本设置-原因列表-退换说明
setting.Address.provinceSearch	地址查询-省	查询省份信息
setting.Address.citySearch	地址查询-市	查询城市信息
setting.Address.districtSearch	地址查询-区	查询区域信息

货品类

接口服务名	接口名	接口描述	客户端路径
goods.Goods.push	货品推送	①推送货品资料给ERP ②更新ERP货品档案资料	货品-货品档案
goods.Suite.search	组合装查询	获取ERP中组合装界面的组合装资料	货品-组合装
goods.Goods.queryWithSpec	货品档案查询	获取ERP的货品档案资料	货品-货品档案
goods.ApiGoods.search	平台货品查询	获取ERP内平台货品资料	货品-平台货品
goods.ApiGoods.upload	平台货品推送	推送自研商城平台货品给ERP	货品--平台货品
process.Bom.upload	物料清单推送	推送物料清单给旺店通	货品--生产--物料清单
process.Process.upload	生产单推送	推送生产单给ERP	货品--生产--生产开单
process.Process.search	生产单查询	获取ERP内生产单信息	货品--生产--生产单管理
goods.GoodsClass.search	货品分类查询	获取ERP货品分类信息	货品--货品分类
goods.GoodsBrand.search	品牌查询	获取ERP内货品品牌信息	货品--货品品牌
goods.Category.search	平台类目查询	获取ERP平台类目信息	货品--平台类目
goods.Goods.batchPush	货品批量推送	1、批量推送货品资料给ERP 2、更新ERP货品档案资料
process.Bom.search	物料清单查询	获取ERP内的物料清单数据	货品--生产--物料清单
goods.Barcode.upload	条码上传	新建或更新条码
goods.Goods.push2	货品推送2	①推送货品资料给ERP ②更新ERP货品档案资料	货品-货品档案
goods.GoodsClass.upload	新建分类	新建货品分类	货品-货品分类

采购类

接口服务名	接口名	接口描述	客户端路径
purchase.ProviderGoods.queryDetail	供应商货品查询	获取ERP中供应商货品界面的供应商货品资料	采购-供应商货品
purchase.PurchaseReturn.queryWithDetail	采购退货单及明细查询	获取ERP的采购退货单信息	采购-采购退货单管理
purchase.PurchaseReturn.cancelOrder	采购退货单取消	推送取消已生成的采购退货单据给ERP。	采购-采购退货开单
purchase.PurchaseReturn.createOrder	采购退货单新建	推送采购退货单据给ERP	采购-采购退货开单
wms.stockin.Purchase.upload	采购入库单推送	推送采购单对应的入库单给ERP	仓储-入库管理-采购入库-入库开单
purchase.PurchaseOrder.queryWithDetail	采购单及明细查询	获取ERP的采购单信息	采购→采购单管理
purchase.PurchaseOrder.createOrder	采购单新建	推送采购单据给ERP	采购-采购开单
finance.settle.Purchase.search	采购结算单查询	获取ERP采购结算单信息	账款-单据结算-采购结算
wms.stockin.Purchase.queryWithDetail	采购入库单查询	获取ERP采购单对应的入库单信息	仓储-入库管理-采购入库-入库管理
wms.stockout.PurchaseReturn.queryWithDetail	采购退货出库单查询	获取ERP采购退货出库单信息	仓储-出库管理-采购退货-出库管理
wms.stockin.Purchase.cancel	采购入库单取消	采购入库单取消	仓储-入库管理-采购入库-入库管理
purchase.PurchaseOrder.cancelOrder	采购单取消	取消采购单	采购-采购单管理
purchase.PurchaseOrder.pending	采购单停止等待	采购单停止等待	采购-采购单管理
purchase.PurchaseReturn.pending	采购退货单停止等待	采购退货单停止等待，注意事项: 一次请求退货单数量不可大于500	采购-采购退货管理
purchase.ProviderGoods.upload	供应商货品推送	推送供应商货品信息	采购--供应商货品
wms.stockout.PurchaseReturn.createOrder	采购退货出库单创建	推送采购退货出库单据给ERP	仓储-出库管理-采购退货-出库开单
purchase.PurchaseOrder.updatePurchaseInfo	采购单标记更新	更新ERP采购单标记	采购--采购单管理
purchase.PurchaseApply.upload	采购申请单创建	推送采购申请单据给ERP	采购--采购申请开单
purchase.PurchaseApply.search	采购申请单查询	获取ERP内采购申请单数据	采购--采购申请单管理
purchase.PurchaseReturn.batchCancelOrder	采购退货批量取消	推送取消已生成的采购退货单据给ERP	采购-采购退货单管理
finance.settle.Purchase.upload	创建采购结算单	推送采购结算单给ERP	账款-单据结算-采购单结算
purchase.PurchaseOrder.cancelByType	采购单取消（新）	根据传入的类型进行采购单取消或停止等待	采购-采购单管理
purchase.PurchaseApply.cancelForApi	采购申请单取消	取消采购申请单	采购-采购申请单管理
purchase.PurchaseApply.stopForApi	采购申请单停止引用	部分引用状态的采购申请单停止引用	采购-采购申请单管理
purchase.StockInPreOrder.search	预约入库单查询	预入库预约单管理，分页查询接口	采购-入库预约单管理
finance.settle.PurchaseReturn.upload	创建采购退货结算单

库存类

接口服务名	接口名	接口描述	客户端路径
wms.MoveOrder.queryWithDetail	移位单查询	获取ERP移位单信息	仓储-移位单-移位单管理
wms.StockSpec.search	库存查询	获取ERP单品（sku）的库存量	仓储→库存信息→库存管理
wms.StockPd.stockSyncByPd	创建盘点单	ERP库存需要调整时，推送盘点库存单据给ERP	仓储-货品盘点
wms.stockin.Other.createOtherOrder	其他入库单新建	ERP需要增加库存且入库单据没有对应的业务类型，推送其他入库单给ERP	仓储-入库管理-其他入库-入库开单
wms.stocktransfer.Manage.queryWithDetail	调拨单查询	获取ERP的调拨单据信息	仓储-货品调拨-调拨单管理
wms.stockout.OtherQuery.queryWithDetail	其他出库单查询	获取ERP其他出库单信息	仓储-出库管理--其他出库-出库管理
wms.stockin.Other.queryWithDetail	其他入库单查询	获取ERP其他入库单单据信息	仓储-入库管理--其他入库-入库管理
wms.stockin.Transfer.queryWithDetail	调拨入库单查询	获取ERP调拨入库单单据信息	仓储-入库管理-调拨入库-入库管理
wms.StockSpec.queryAvailableStock	可用库存查询	获取ERP内单品的可用库存量	仓储→可用库存
wms.stockout.Other.createOther	其他出库单新建	ERP需要减少库存且出库单据没有对应的业务类型，推送其他出库单给ERP	仓储-出库管理-其它出库-出库开单
wms.stockout.Transfer.queryWithDetail	调拨出库单查询	获取ERP调拨出库单信息	仓储-出库管理-调拨出库-出库管理
wms.stockin.Transfer.cancelOrder	调拨单入库取消	取消预调拨入库单
wms.StockPd.queryStockPdInDetail	盘点入库单查询	获取ERP盘点入库单信息
wms.StockPd.queryStockPdOutDetail	盘点出库单查询	获取ERP盘点出库单信息
wms.stockout.Transfer.cancelOrder	调拨单出库取消	取消预调拨出库单
wms.stocktransfer.Manage.cancelOrder	调拨单取消	取消预调拨单
wms.stockin.Transfer.createOrder	调拨入库单新建	推送调拨入库单据给ERP
wms.stockout.Transfer.createOrder	调拨出库单新建	推送调拨出库单据给ERP
wms.stocktransfer.Edit.createOrder	调拨单新建	推送调拨单给ERP	仓储-货品调拨-调拨开单
wms.StockShelve.queryWithDetail	补货单查询	查询补货单	仓储-货品上架-补货单
wms.StockSpec.queryChangeHistory	库存变化查询	获取ERP库存变化信息
finance.StockCost.search	存货成本查询	获取ERP内存货成本信息	账款-收入成本-存货成本
wms.stocktransfer.Manage.pending	调拨单停止等待	调拨单停止等待
wms.stockother.Out.push	其它出库业务单创建	其它出库业务单创建
wms.stockother.In.push	其它入库业务单创建	其它入库业务单创建
wms.stockout.Process.queryWithDetail	生产出库查询	获取ERP生产出库信息	仓储-出库管理-生产出库-出库管理
wms.stockin.Process.queryWithDetail	生产入库查询	获取ERP生产入库信息，注意事项：传入参数如果没有入库单号或者生产单号，就必须传入时间，和时间类型作为参数	仓储-入库管理-生产入库-入库管理
wms.outer.OuterOut.createOrder	外仓调整出库单创建	外仓调整出库单创建
wms.outer.OuterIn.createOrder	外仓调整入库单创建	外仓调整入库单创建
wms.outer.OuterOut.queryWithDetail	外仓调整出库单查询	获取ERP外仓调整出库信息	仓储-外仓调整-调整出库-出库管理
wms.outer.OuterIn.queryWithDetail	外仓调整入库单查询	获取ERP外仓调整入信息	仓储-外仓调整-调整入库-入库管理
finance.settle.Transfer.search	调拨结算查询	获取ERP调拨结算单信息	账款-单据结算-调拨结算
wms.stockdefect.DefectChange.search	正残转换单查询	获取ERP正残转换单信息	仓储--正残转换--正残转换单管理
wms.stockother.OutQuery.queryWithDetail	其它出库业务单查询	获取ERP其他出库业务单信息	仓储--其它出库业务--其它出库业务管理
wms.stockother.InQuery.queryWithDetail	其它入库业务单查询	获取ERP其他入库业务单单据信息	仓储--其它入库业务--其它入库业务管理
wms.stockout.SalesPick.pickListOverviewForApi	分拣单全览	分拣波次查询	仓储--销售出库--波次管理
wms.PositionCapacity.search	默认货位查询	获取ERP单品（sku）默认货位	仓储--货品上架--拣货货位管理/备货货位管理
setting.strategy.VirtualWarehouse.stockSearch	虚拟仓库存查询	获取虚拟仓库存信息	设置--策略设置--虚拟仓策略--虚拟仓库存
setting.strategy.VirtualWarehouse.create	虚拟仓单据创建	创建虚拟仓订单给ERP	设置--策略设置--虚拟仓策略--虚拟仓单据
setting.strategy.VirtualWarehouse.orderSearch	虚拟仓单据查询	查询虚拟仓单据信息	设置--策略设置--虚拟仓策略--虚拟仓单据
wms.stockout.Pack.search	装箱单查询	查询系统内非jit类型的装箱单	仓储--出库装箱--装箱单管理
wms.stockin.JitRefund.searchOrderWithDetail	JIT退货入库单查询	获取ERP内JIT退货入库单数据	仓储--入库管理--JIT退货入库--入库管理
wms.stockout.JitOrder.search	JIT出库单查询	获取ERP内JIT出库单数据	仓储--出库管理--JIT出库--出库管理
wms.GoodsSN.queryWithDetail	SN码查询	获取ERP序列号管理页面的数据	仓储--流通码管理--序列号管理
finance.settle.OtherIn.upload	其它入库业务结算单创建	创建其它入库业务结算单	账款--单据结算--其它结算--入库业务结算
wms.StockSpec.search2	库存查询2	获取ERP单品的库存量	仓储--库存信息--库存管理
statistic.StockoutCollect.queryCostWithDetail	出库瞬时成本查询	获取ERP出库瞬时成本信息	统计--库存--出库瞬时成本
statistic.StockinCollect.queryCostWithDetail	入库瞬时成本查询	获取ERP入库瞬时成本信息	统计--库存--入库瞬时成本
wms.StockPd.queryStockPd	盘点单查询	获取ERP盘点单数据	仓储--货品盘点--盘点单管理
wms.StockPd.queryStockPdDetail	盘点单明细查询	获取ERP的盘点单明细数据	仓储--货品盘点--盘点单管理
wms.stockin.Base.search	入库单查询	查询入库单
wms.stockout.Base.search	出库单查询	查询出库单
wms.StockSpec.stockDetailSearch	库存明细查询	库存管理页面下明细库存tab	仓储-库存信息-库存管理-明细库存tab
wms.stockout.Base.searchSN	出库SN查询	获取已出库的SN信息
wms.stockin.Base.searchSN	入库SN查询	查询入库SN信息
wms.stockin.Base.uploadSN	入库SN明细推送	针对已经创建好的入库单，推送关联的SN信息
wms.stockout.Base.uploadSN	出库SN明细推送	针对已经创建好的出库单，推送关联的SN信息
wms.stockin.Other.cancelOtherOrder	其他入库单取消	取消待审核或者编辑中状态的其他入库单	仓储-入库管理--其他入库-入库管理
wms.stockout.Other.cancelOtherOrder	其他出库单取消	取消待审核或未确认状态的其他出库单	仓储-出库管理--其他出库-出库管理
finance.settle.Logistics.search	电子面单号查询	查询电子面单号管理数据	仓储-电子面单号管理
wms.GoodsPack.upload	箱码新建	创建箱码信息
wms.stockother.In.cancelOrder	其他入库业务单据取消	其他入库业务单据取消支持取消"已审核"、"待审核"、"编辑中"状态的单据
wms.stockother.Out.cancelOrder	其他出库业务单据取消	其他出库业务单据取消支持取消"已审核"、"待审核"、"编辑中"状态的单据
setting.strategy.VirtualWarehouse.strategyAllocationCreate	虚拟仓库存分配策略创建	虚拟仓库存分配, 功能类似于客户端: 设置-策略设置-虚拟仓策略-虚拟仓库存分配
setting.strategy.VirtualWarehouse.reserveExtractAdd	虚拟仓库存释放策略新建	虚拟仓库存分配, 功能类似于客户端: 设置-策略设置-虚拟仓策略-虚拟仓库存分配

售后类

接口服务名	接口名	接口描述	客户端路径
wms.stockin.Refund.queryWithDetail	退货入库单查询	获取ERP的退货入库单单据信息	仓储-入库管理-销售退货-入库管理
aftersales.refund.RawRefund.upload	原始退款单推送	该接口不做新增系统退换单使用，该接口可以更新售后单退货物流信息、更新退货金额、变更退换类型等	销售-售后管理-原始退款单
wms.stockin.PreStockin.createExt	创建退货预入库	推送退货预入库单据给ERP	仓储-入库管理-销售退货-预入库单
aftersales.refund.Refund.search	退换单查询	获取ERP销售退货（换货）订单信息	销售-售后管理-退换管理
wms.stockin.PreStockin.search	预入库单据查询	获取ERP预入库单单据信息	仓储-入库管理-销售退货-预入库单
wms.stockin.PreStockin.cancel	退货预入库单取消	取消预入库单
aftersales.refund.Refund.searchHistory	历史退换单查询	查询已经归档的退换单信息	销售-历史订单-历史退换单
aftersales.refund.RawRefund.search	原始退款单查询	获取ERP原始退款单数据	销售--售后管理--原始退款单
aftersales.refund.RawRefund.upload2	原始退款单推送2	推送自有平台原始退款单给ERP	销售-售后管理-原始退款单
wms.stockin.Refund.createOrder	退货入库单推送	推送退货入库单给ERP	仓储--入库管理--销售退货--入库开单
wms.stockin.SmartRefund.upload	快速退货	推送快速退货单据信息给ERP	仓储-入库管理-销售退货-快速入库
wms.stockin.Refund.queryHisWithDetail	历史退货入库单查询	获取已归档的退货入库单数据
aftersales.refund.RawRefund.searchHistory	历史原始退款单查询	获取ERP已归档的原始退款单数据
wms.stockin.Refund.returnLogisticsPackageQuery	退货物流包裹查询	退货物流分页查询	仓储-入库管理-退货物流登记