Rest接口文档1.0.doc

Rest接口文档目录目录1一、系统级参数2二、接口列表6三、接口描述71.订单API71.1.edbdeliverGoodsGet 【发货订单信息】71.2.edbGoodsReturnGet 【查询退货的订单】91.3.edbGuideInventory 【订单导入进销存】111.4.edbHebOrderInfoGet【合并订单信息】131.5.edbooOrderList【获取缺货订单列表】151.6.edbOrderadd 【订单导入E店宝】191.7.edbOrderByAuditGet【取出导入进销存订单信息】241.8.edborderCancel 【订单作废】311.9.edbOrderDeliveryBatch 【订单批量发货】321.10.edbOrderDeliveryByOrderNoGet【单个订单发货】341.11.edbOrderHis 【历史订单查询】361.12.edbOrderStatusUpdate【订单状态更新】361.13.edbProductClassDelivery【产品级发货信息】381.14.edbSalesIncomeGet【销售出库产品信息】401.15.edbStatusIsSuccessGet 【回写订单接收状态信息】442.库存信息API442.1.edbProductAddStoreGet442.2.edbResponseStockTakeGet【发起盘点】472.3.edbStockOnlineGet 【库存同步】472.4.edbStockTakeGet 【库存盘点】492.5.edbStoreGet【库房信息获取】493.客户信息API493.1.edbCustomerGet【获取客户信息】493.2.edbStoreinformation【客户评价下载】524.产品信息API554.1.edbBarCodeStockGet【获取产品库存信息】554.2.edbProductBatchCreate 【产品批量创建】554.3.edbProductBrandCreate【产品品牌创建】574.4.edbProductBrandGet 【获取产品品牌】594.5.edbProductClassCreate 【写入产品分类】604.6.edbProductClassGet 【获取产品分类】614.7.edbProductClassUpdate【更新产品分类】634.8.edbProductCreate【写入产品信息】634.9.edbProductGet 【产品编号级产品信息】644.10.edbProductLocationGet【产品库房库位信息获取】674.11.edbProductsGet【条码级产品信息】674.12.edbProductUpdate【更新产品信息】674.13.edbShopProPerSet【网店产品百分比设置】684.14.edbSuitInfoGet【套装信息获取】695.供应商API725.1.edbSupplierCreate 【创建供应商】726.出入库API736.1.edbLibraryGet【获取出库单信息】736.2.edbOutOfStorageByIdGet【出入库采购确认】766.3.edbStockCancel【取消出入库】786.4.edbStockTradeadd【提交一笔出入库单】786.5.edbStorageGet【取出入库单信息】807.WMS出入库回复API847.1.edbAsn_ReplyGetAdd【科捷专有销售出入库回复】848.酷武API858.1.edbResponseCheckInventoryadd【盘点商品对象】858.2.edbResponseOrderadd【出库发货反馈接口】868.3.edbResponseReceiptadd【入库单反馈接口】889.金税API899.1.edbOrderUpdateBackadd【回写发票信息接口】8910.快递信息API9010.1.edbExpressCompare 【快递公司代码对照查询】90一、 系统级参数字段名含义类型长度是否为空Dbhost软件注册用户，比如edb_aXXXXX（接口调用的唯一标识）StringNWfpuser由注册用户分配StringNAppkey签名验证(用户名+密码经过MD5加密) MD5(wfpuser+wfppwd)StringNformat返回值类型：json、xml（选择json 则返回json否则是xml）StringYMethodedbStockTradeaddNXmlValues传递的入库数据（应用参数）String不限N沙箱环境测试地址：/api/rest/test.aspx接口调用地址：/api/rest/api.aspx沙箱环境账号：dbhost:edb_a88888 wfpuser:edb_b00001 wfppwd:test123abc接口调用示例：get示例：/api/rest/api.aspx?dbhost=edb_a88888&wfpuser=edb_b00001&appKey= 2c8f8f0e398a676ab0d41333fc2aba5c&method=edbCustomerGet&format=XML&fields=&v=1.0&customerNo=4post示例：/api/rest/api.aspx?dbhost=edb_a88888&wfpuser=edb_b00001&appKey= 2c8f8f0e398a676ab0d41333fc2aba5c&method=edbResponseCheckInventoryadd&format=XML&fields=&v=1.0&xmlValues=%3cResponseItemCheck%3e%3cCustomerId%3eHEINZ%3c%2fCustomerId%3e%3cWareHouse%3eKUWU-0004%3c%2fWareHouse%3e%3cCheckCode%3e002%3c%2fCheckCode%3e%3cSpuCode%3e6921956655073%3c%2fSpuCode%3e%3cInventoryType%3e1%3c%2fInventoryType%3e%3cQuantity%3e1.00000%3c%2fQuantity%3e%3cCheckType%3e1%3c%2fCheckType%3e%3c%2fResponseItemCheck%3e注：针对post格式，请求参数字段一律采用xml字符串传值格式，使用应用参数xmlValues参数接收经过url编码的xml字符串Xml编码方式：String Urlxml=HttpUtility.UrlEncode(xml);系统错误代码err_code：一、 业务级错误：5（如：试图将处理完订单更新为待处理）二、 条件不匹配错误：1（如：更新某一不存在的订单的订单状态）三、 正确结果：200系统参数的构建：string appKey = Encrypt(3ubtotal + pass);/用户名+密码通过MD5加密 string fields = HttpUtility.UrlEncode(tbFields.Text.Trim();/对中文进行编码 string sysParm = string.Format(“dbhost=0&wfpuser=1&appKey=2&method=3&format=4&fields=5&v=1.0&”, dbhost, 3ubtotal, appKey, method, format, fields);/系统参数对应用参数的解析：代码开放string ParmTXT = Parm;/应用参数 if (Parm.Split(=)0.ToLower().Equals(“xmlvalues”) | Parm.Split(=)0.ToLower().Equals(“content”) string index = Parm.Substring(Parm.IndexOf(“=”) + 1); int endSplit = index.LastIndexOf(“”)+1;/先找到XML结尾 string strSplit = index.Substring(endSplit, index.Length endSplit).Trim();/取到XML后面是否还有值 string indexSplit = index.Substring(0,endSplit);/取出XML的值 StringBuilder sb1 = new StringBuilder(“”); sb1.Append(String.Format(“0=1”, Parm.Split(=)0, HttpUtility.UrlEncode(indexSplit).Append(“&”); if (!string.IsNullOrEmpty(strSplit)/如果取到的值不为空，并且包括&把里面值取出来 if (strSplit.Contains(“&”) foreach (string str in strSplit.Split(&) if (str.Contains(“=”) sb1.Append(str.Split(=)0); sb1.Append(“=”); sb1.Append(HttpUtility.UrlEncode(str.Split(=)1).Append(“&”); else lblMsg.Text= “提交的XML结尾有误，请重新提交”; return; /Parm = Parm.Split(=)0 + “=” + HttpUtility.UrlEncode(index); sb1.Remove(sb1.Length 1, 1);/把最后一个&移除 Parm = sb1.ToString(); else StringBuilder sb = new StringBuilder(“”); if (Parm.Contains(“&”) foreach (string str in Parm.Split(&) sb.Append(str.Split(=)0); sb.Append(“=”); sb.Append(HttpUtility.UrlEncode(str.Split(=)1).Append(“&”); sb.Remove(sb.Length 1, 1); Parm = sb.ToString(); else if (Parm.Contains(“=”) sb.Append(ParmTXT.Split(=)0); sb.Append(“=”); sb.Append(HttpUtility.UrlEncode(ParmTXT.Split(=)1); Parm = sb.ToString(); else Parm = ParmTXT; 二、 接口列表接口分类序号接口名称接口描述订单API1.1edbDeliverGoodsGet发货订单信息1.2edbGoodsReturnGet查询退货的订单1.3edbGuideInventory订单导入进销存1.4edbHebOrderInfoGet合并订单信息1.5edbooOrderList获取缺货订单列表1.6edbOrderadd订单导入E店宝1.7edbOrderByAuditGet取出导入进销存订单信息1.8edborderCancel订单作废1.9edbOrderDeliveryBatch订单批量发货1.10edbOrderDeliveryByOrderNoGet单个订单发货1.11edbOrderHis3个月前的历史订单查询1.12edbOrderStatusUpdate订单状态更新1.13edbProductClassDelivery产品级发货信息1.14edbSalesIncomeGet销售出库产品信息1.15edbStatusIsSuccessGet回写订单接收状态信息库存API2.1edbProductAddStoreGet产品库存增量查询2.2edbResponseStockTakeGet发起盘点2.3edbStockOnlineGet库存同步2.4edbStockTakeGet库存盘点2.5edbStoreGet库房信息获取客户API3.1edbCustomerGet获取客户信息3.2edbStoreinformation客户评价下载产品API4.1edbBarCodeStockGet产品库存信息获取4.2edbProductBatchCreate产品批量创建4.3edbProductBrandCreate产品品牌创建4.4edbProductBrandGet获取产品品牌4.5edbProductClassCreate写入产品分类4.6edbProductClassGet获取产品分类4.7edbProductClassUpdate更新产品分类4.8edbProductCreate写入产品信息4.9edbProductGet产品编号级产品信息4.10edbProductLocationGet产品库房库位信息获取4.11edbProductsGet条码级产品信息4.12edbProductUpdate更新产品信息4.13edbShopProPerSet网店产品百分比设置4.14edbSuitInfoGet套装信息获取供应商API5.1edbSupplierCreate创建供应商出入库API6.1edbLibraryGet取出出库单信息6.2edbOutOfStorageByIdGet出入库采购确认6.3edbStockCancel取消出入库6.4edbStockTradeAdd提交一笔出入库单6.5edbStorageGet取出入库单信息WMS出入库7.1edbAsn_ReplyGetAdd科捷专有销售出入库回复酷武API8.1edbResponseCheckInventoryadd盘点信息接口8.2edbResponseOrderadd出库发货反馈接口8.3edbResponseReceiptadd入库反馈接口金税API9.1edbOrderUpdateBackadd回写发票信息接口快递API10.1edbExpressCompare快递公司代码对照查询三、 接口描述1. 订单API1.1. edbdeliverGoodsGet 【发货订单信息】1.1.1. 简要描述获取发货订单1.1.2. 应用级输入参数名称类型是否必须描述示例值默认值pageNoString是要显示的页数1pageSizeString是页显示的条数200outOrderNoString否外部订单编码shopIDString否店铺IDStoreIDString否库房IDtranscationStateString否transcationState交易状态：标记订单现在的状态，是否支付等。传入数据与订单状态对应关系：传值 说明1 已确认已付款2 已发货3 已签收交易成功4 已取消1 已归档11 货到付款21 部分发货41 已部分退货42 已全部退货43 退货到货0 未确认未付款1orderGetStartTimeString否订单获取开始时间2010-03-20 12：22：33orderGetEndTimeString订单获取结束时间2010-04-20 12：22：33isWeightBit否是否称过重（0/1）101.1.3. 返回结果名称类型示例值描述outOrderNostring外部订单编码expressOrderNoString快递单号expressCompanyString快递公司inOrderPersoString下单员orderStateString订单状态weightPersonString称重员assessorString审单员inspectorString验货员shopIDString店铺IDstoreIDString仓库IDWeightDouble订单净重1.1.4. 正确返回结果 XML数据格式 2100385173539291|wms203223申通edb_b00001edb_b00001edb_b00001531 JSON数据格式error_code:50,error_msg:错误50:未知错误,请重新提交,request_args:key:dbhost,value:edb_a88888,key:wfpuser,value:edb_b00001,key:appKey,value:2c8f8f0e398a676ab0d41333fc2aba5c,key:method,value:edbDeliverGoodsGet,key:format,value:JSON,key:fields,value:,key:v,value:1.0,key:pageNo,value:1,key:pageSize,value:2,key:dbhost,value:edb_a88888,key:wfpuser,value:edb_b00001,key:appKey,value:2c8f8f0e398a676ab0d41333fc2aba5c,key:method,value:edbDeliverGoodsGet,key:format,value:JSON,key:fields,value:,key:v,value:1.0,key:pageNo,value:1,key:pageSize,value:21.2. edbGoodsReturnGet 【查询退货的订单】1.2.1. 简要描述查询退货的订单1.2.2. 应用级输入参数名称类型是否必须描述示例值默认值DatetypeString日期类型（生成时间/确认时间/到货时间）beginTimeDatetime开始时间endTimeDatetime结束时间 PagenumInt当前页码PagesizeInt页大小1.2.3. 返回结果名称类型示例值描述resultstring返回结果goodsReturnNoStringTrue退货单号riseTimeString退货单生成时间OperatorString生成操作员confirmTimedateTime退货单确认时间ConfirmerString确认操作员arriverTimeDatetime退货到货时间arriverOperatorString退货到货操作员riseWaybillNoString退货运单号expressCompanyString退货快递公司StatusString退货单状态yuanOrderNoString原订单编号outOrderNoString外部订单号yuanWaybillNoString原运单号buyerNoString买家IDConsigneeString收货人AddressString收货地址goodsTotalMoneyDouble商品总金额mailNoString邮编TelephoneString电话MobilString手机child_orderNoString订单编码child_goodsReturnNoString退货单号child_brandString品牌child_productNoString产品编号child_standardString规格child_OrderNumInt订货数量child_deliverNumInt发货数量child_riseNumInt退货数量child_PriceDouble单价child_goodsReturnPriceDouble实际退货价child_remarkString备注调用示例：/api/rest/api.aspx?dbhost=edb_a88888&wfpuser=edb_b00001&appKey=2c8f8f0e398a676ab0d41333fc2aba5c&method=edborderCancel&format=XML&fields=&v=1.0&orderId=1173628460658821.2.4. 正确返回结果 XML数据格式 1true0作废成功!SC11112100004 json数据格式 Success:total_results:1,items:item:is_success:false,err_code:5,err_msg:该订单不能作废处理!SC111121000041.2.5. 结果列表is_successerr_codeerr_msgFalse1单据没有确认,不需要取消false5退回产品子库位不正确！false5打印中订单或已打印订单只能由“快递单打印专员”作废false5处理失败false5该订单不能作废处理! +订单编码true200作废成功+订单编码false5退回产品子库位不正确！1.3. edbGuideInventory 【订单导入进销存】1.3.1. 简要描述订单导入进销存1、 传入外部订单编号，支持批量。批量格式：234234234,2342532342,234234234,2、 如果想单个导入进销存,请在单号后同样加一个, 如: 323423,3、 导入进销存条件：1、 订单中的产品条形码需要在软件中存在2、 订单需要有库房和店铺信息3、 缺货产品导入进销存在软件中有配置4、订单交易状态在以下状态可以导入进销存（已确认已付款，已发货，已签收交易成功，货到付款）5、启用财审后在客审通过后订单将不能导入进销存1.3.2. 应用级输入参数名称类型是否必须描述示例值默认值orderIdsVarchar（1000）是订单编码1.3.3. 返回结果名称类型示例值描述resultstring提示CodeInt200结果代码信息FieldString错误字段MsgInt结果文字信息调用示例：/rest/api.aspx?dbhost=edb_a88888&wfpuser=edb_b00001&appKey= 2c8f8f0e398a676ab0d41333fc2aba5c&method=edbGuideInventory&format=XML&fields=&v=1.0&orderIds=123123434,34235325,353453451.3.4. 正确返回结果 XML数据格式 1200导入成功 json数据格式 Success:total_results:1,items:item:Code:200,field:,Msg:导入成功1.3.5. 错误列表错误代码错误字段错误信息CodeFieldMsg200导入成功5订单编码不存在5订单产品中的条形码在软件中不存在4库房为空不能导入进销存4店铺为空不能导入进销存3订单还没有付款或订单状态不在可以导入进销存的范围3缺货订单不能导入进销存3启用财审后客审通过订单不能导入进销存1.4. edbHebOrderInfoGet【合并订单信息】1.4.1. 简要描述根据合并类型，合并时间，合并单号查询订单合并情况默认返回第一页50条，每页最多返回200条1.4.2. 应用级输入参数名称类型是否必须描述示例值默认值orderIdString(50)否合并订单号HebTypeint否合并类型(0:自动 1：手动)HebBeginTimedatetime否合并开始时间当前时间一个月之前的时间HebEndTimeDatetime否合并结束时间当前时间pageNoInt否当前页码1pageSizeInt否每页显示条数501.4.3. 返回结果名称类型示例值描述totalResultsInt3返回结果数totalResultsAllInt200总条数（需要在field字段添加“总数量”做返回，field字段为空默认返回所有字段，不用添加“总数量”）OrderIdString原订单号mainOrderIdString主订单号isMainInt是否主订单TODTimeOfDeliveryDatetime订单发货时间（为空表示未发货）shopIdString店铺IDconsigneeString收货人remarkInfoString备注说明sellerRemarkString卖家备注buyerIDString买家IDbuyerAddressString买家收货地址telephoneString电话mobilePhoneString手机HebTypeString合并类型HebTimeDatetime合并时间调用示例：/rest/api.aspx?dbhost=edb_a88888&wfpuser=edb_b00001&appKey= 2c8f8f0e398a676ab0d41333fc2aba5c&method=edbHebOrderInfoGet&format=XML&fields=&v=1.0&pageNo=3&pageSize=41.4.4. 正确返回结果 XML数据格式 22264599333-20110720-558455093|64599333-20110720-558455093|1拍拍乔娟edb_b00395,圆通快递 麻烦仔细包装下哈！ 眼影最好发带珠光的吧 麻烦了！379074293河北 邯郸市 邯山区 光明南大街24号6-4-11号 (056001动合并07 20 2011 6:37PM64599333-20110720-558548293|64599333-20110720-558455093|0拍拍乔娟上次说有小礼物的379074293河北 邯郸市 邯山区 光明南大街24号6-4-11号 (056001动合并07 20 2011 6:37PM json数据格式 Success:total_results:2,items:item:OrderId:64599333-20110720-558455093|,mainOrderId:64599333-20110720-558455093|,isMain:1,TODTimeOfDelivery:,shopId:拍拍,consignee:乔娟,remarkInfo:edb_b00395,sellerRemark:圆通快递 麻烦仔细包装下哈！ 眼影最好发带珠光的吧 麻烦了！,buyerID:379074293,buyerAddress:河北 邯郸市 邯山区 光明南大街24号6-4-11号 (056001),telephone:,mobilePhoneHebType:自动合并,HebTime:07 20 2011 6:37PM,总数量:22,OrderId:64599333-20110720-558548293|,mainOrderId:64599333-20110720-558455093|,isMain:0,TODTimeOfDelivery:,shopId:拍拍,consignee:乔娟,remarkInfo:,sellerRemark:上次说有小礼物的,buyerID:379074293,buyerAddress:河北 邯郸市 邯山区 光明南大街24号6-4-11号 (056001),telephone:,mobilePhoneHebType:自动合并,HebTime:07 20 2011 6:37PM,总数量:221.5. edbooOrderList【获取缺货订单列表】1.5.1. 简要描述返回缺货订单列表1.5.2. 应用级输入参数名称类型是否