关键词:
电子面单接口是快递鸟提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口,满足客户在线发货需求并提供打印面单的服务,客户通过网络选择物流公司发送请求通知贵公司有快递要发货,把数据通过此接口转发到快递鸟,由快递鸟为您通知对应的快递公司快递员上门取件。电子面单成功下单后,快递鸟系统内将自动订阅,一旦轨迹发生变化时,快递鸟将调用客户方推送接收接口。同时若客户使用代收货款服务,快递鸟会将代收货款的货款状态独立推送给用户。
一.接口描述
(1)订单编号(OrderCode)不可重复提交,重复提交系统会返回具体错误代码。
(2)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(3)接口地址:
API测试地址:http://testapi.kdniao.cc:8081/api/EOrderService
API正式地址:http://api.kdniao.cc/api/EOrderService
(4)圆通编码:YTO
二.接口参数
(1)请求系统级参数
参数名称 | 类型 | 说明 | 必须要求 |
---|---|---|---|
RequestData | String | 请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。 | R |
EBusinessID | String | 商户ID,请在我的服务页面查看。 | R |
RequestType | String | 请求指令类型:1007 | R |
DataSign | String | 数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后进行URL(utf-8)编码。详细过程请查看Demo。 | R |
DataType | String | 请求、返回数据类型:只支持JSON格式 | O |
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)。
(2)请求内容字段定义
参数名称 | 类型 | 说明 | 是否必须 | |
---|---|---|---|---|
CallBack | String | 用户自定义回调信息 | O | |
MemberID | String | 会员标识 | O | |
CustomerName | String | 电子面单客户账号(与快递网点申请) | O | |
CustomerPwd | String | 电子面单密码 | O | |
SendSite | String | 收件网点标识 | O | |
ShipperCode | String | 快递公司编码 | R | |
LogisticCode | String | 快递单号 | O | |
OrderCode | String | 订单编号 | R | |
MonthCode | String | 月结编码 | C | |
PayType | Int | 邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付 | R | |
ExpType | String | 快递类型:1-标准快件 | R | |
IsNotice | Int | 是否通知快递员上门揽件:0-通知;1-不通知;不填则默认为0 | O | |
Cost | Double | 寄件费(运费) | O | |
OtherCost | Double | 其他费用 | O | |
Receiver | Company | String | 收件人公司 | O |
Name | String | 收件人 | R | |
Tel | String | 电话与手机,必填一个 | R | |
Mobile | String | |||
PostCode | String | 收件人邮编 | O | |
ProvinceName | String | 收件省(如广东省,不要缺少“省”) | R | |
CityName | String | 收件市(如深圳市,不要缺少“市”) | R | |
ExpAreaName | String | 收件区(如福田区,不要缺少“区”或“县”) | O | |
Address | String | 收件人详细地址 | R | |
Sender | Company | String | 发件人公司 | O |
Name | String | 发件人 | R | |
Tel | String | 电话与手机,必填一个 | R | |
Mobile | String | |||
PostCode | String | 发件人邮编 | O | |
ProvinceName | String | 发件省(如广东省,不要缺少“省”) | R | |
CityName | String | 发件市(如深圳市,不要缺少“市”) | R | |
ExpAreaName | String | 发件区(如福田区,不要缺少“区”或“县”) | O | |
Address | String | 发件人详细地址 | R | |
StartDate | String | 上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同 | O | |
EndDate | String | O | ||
Weight | Double | 物品总重量kg | O | |
Quantity | Int | 件数/包裹数 | O | |
Volume | Double | 物品总体积m3 | O | |
Remark | String | 备注 | O | |
AddServices | ||||
AddService | Name | String | 增值服务名称 | O |
Value | String | 增值服务值 | O | |
CustomerID | String | 客户标识(选填) | O | |
Commoditys | ||||
Commodity | GoodsName | String | 商品名称 | R |
GoodsCode | String | 商品编码 | O | |
Goodsquantity | Int | 商品数量 | O | |
GoodsPrice | Double | 商品价格 | O | |
GoodsWeight | Double | 商品重量kg | O | |
GoodsDesc | String | 商品描述 | O | |
GoodsVol | Double | 商品体积m3 | O | |
IsReturnPrintTemplate | String | 返回电子面单模板:0-不需要;1-需要 | O |
(3)返回参数定义
参数名称 | 类型 | 说明 | 必须要求 | |
---|---|---|---|---|
EBusinessID | String | 用户ID | R | |
Order | OrderCode | String | 订单编号 | R |
ShipperCode | String | 快递公司编码 | R | |
LogisticCode | String | 快递单号 | R | |
MarkDestination | String | 大头笔 | O | |
OriginCode | String | 始发地区域编码 | O | |
OriginName | String | 始发地/始发网点 | O | |
DestinatioCode | String | 目的地区域编码 | O | |
DestinatioName | String | 目的地/到达网点 | O | |
SortingCode | String | 分拣编码 | O | |
PackageCode | String | 集包编码 | O | |
Success | Bool | 成功与否 | R | |
ResultCode | String | 错误编码 | R | |
Reason | String | 失败原因 | O | |
UniquerRequestNumber | String | 唯一标识 | R | |
PrintTemplate | String | 面单打印模板 | O | |
EstimatedDeliveryTime | String | 订单预计到货时间yyyy-mm-dd | O | |
Callback | String | 用户自定义回调信息 | O |
三.接口对接demo
import java.io.BufferedReader; import java.io.IOException; import java.io.InputStreamReader; import java.io.OutputStreamWriter; import java.io.UnsupportedEncodingException; import java.net.HttpURLConnection; import java.net.URL; import java.net.URLEncoder; import java.util.HashMap; import java.util.Map; import com.sun.org.apache.xerces.internal.impl.dv.util.Base64; import java.security.MessageDigest; public class KdGoldAPIDemo { //电商ID private String EBusinessID="请到快递鸟官网申请http://www.kdniao.com/ServiceApply.aspx"; //电商加密私钥,快递鸟提供,注意保管,不要泄漏 private String AppKey="请到快递鸟官网申请http://www.kdniao.com/ServiceApply.aspx"; //请求url, 正式环境地址:http://api.kdniao.cc/api/Eorderservice private String ReqURL="http://testapi.kdniao.cc:8081/api/Eorderservice"; /** * Json方式 电子面单 * @throws Exception */ public String orderOnlineByJson() throws Exception{ String requestData= "{‘OrderCode‘: ‘012657700387‘," + "‘ShipperCode‘:‘YTO‘," + "‘PayType‘:1," + "‘ExpType‘:1," + "‘Cost‘:1.0," + "‘OtherCost‘:1.0," + "‘Sender‘:" + "{" + "‘Company‘:‘LV‘,‘Name‘:‘Taylor‘,‘Mobile‘:‘15018442396‘,‘ProvinceName‘:‘上海‘,‘CityName‘:‘上海‘,‘ExpAreaName‘:‘青浦区‘,‘Address‘:‘明珠路73号‘}," + "‘Receiver‘:" + "{" + "‘Company‘:‘GCCUI‘,‘Name‘:‘Yann‘,‘Mobile‘:‘15018442396‘,‘ProvinceName‘:‘北京‘,‘CityName‘:‘北京‘,‘ExpAreaName‘:‘朝阳区‘,‘Address‘:‘三里屯街道雅秀大厦‘}," + "‘Commodity‘:" + "[{" + "‘GoodsName‘:‘鞋子‘,‘Goodsquantity‘:1,‘GoodsWeight‘:1.0}]," + "‘Weight‘:1.0," + "‘Quantity‘:1," + "‘Volume‘:0.0," + "‘Remark‘:‘小心轻放‘," + "‘IsReturnPrintTemplate‘:1}"; Map<String, String> params = new HashMap<String, String>(); params.put("RequestData", urlEncoder(requestData, "UTF-8")); params.put("EBusinessID", EBusinessID); params.put("RequestType", "1007"); String dataSign=encrypt(requestData, AppKey, "UTF-8"); params.put("DataSign", urlEncoder(dataSign, "UTF-8")); params.put("DataType", "2"); String result=sendPost(ReqURL, params); //根据公司业务处理返回的信息...... return result; } /** * MD5加密 * @param str 内容 * @param charset 编码方式 * @throws Exception */ @SuppressWarnings("unused") private String MD5(String str, String charset) throws Exception { MessageDigest md = MessageDigest.getInstance("MD5"); md.update(str.getBytes(charset)); byte[] result = md.digest(); StringBuffer sb = new StringBuffer(32); for (int i = 0; i < result.length; i++) { int val = result[i] & 0xff; if (val <= 0xf) { sb.append("0"); } sb.append(Integer.toHexString(val)); } return sb.toString().toLowerCase(); } /** * base64编码 * @param str 内容 * @param charset 编码方式 * @throws UnsupportedEncodingException */ private String base64(String str, String charset) throws UnsupportedEncodingException{ String encoded = Base64.encode(str.getBytes(charset)); return encoded; } @SuppressWarnings("unused") private String urlEncoder(String str, String charset) throws UnsupportedEncodingException{ String result = URLEncoder.encode(str, charset); return result; } /** * 电商Sign签名生成 * @param content 内容 * @param keyValue Appkey * @param charset 编码方式 * @throws UnsupportedEncodingException ,Exception * @return DataSign签名 */ @SuppressWarnings("unused") private String encrypt (String content, String keyValue, String charset) throws UnsupportedEncodingException, Exception { if (keyValue != null) { return base64(MD5(content + keyValue, charset), charset); } return base64(MD5(content, charset), charset); } /** * 向指定 URL 发送POST方法的请求 * @param url 发送请求的 URL * @param params 请求的参数集合 * @return 远程资源的响应结果 */ @SuppressWarnings("unused") private String sendPost(String url, Map<String, String> params) { OutputStreamWriter out = null; BufferedReader in = null; StringBuilder result = new StringBuilder(); try { URL realUrl = new URL(url); HttpURLConnection conn =(HttpURLConnection) realUrl.openConnection(); // 发送POST请求必须设置如下两行 conn.setDoOutput(true); conn.setDoInput(true); // POST方法 conn.setRequestMethod("POST"); // 设置通用的请求属性 conn.setRequestProperty("accept", "*/*"); conn.setRequestProperty("connection", "Keep-Alive"); conn.setRequestProperty("user-agent", "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;SV1)"); conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); conn.connect(); // 获取URLConnection对象对应的输出流 out = new OutputStreamWriter(conn.getOutputStream(), "UTF-8"); // 发送请求参数 if (params != null) { StringBuilder param = new StringBuilder(); for (Map.Entry<String, String> entry : params.entrySet()) { if(param.length()>0){ param.append("&"); } param.append(entry.getKey()); param.append("="); param.append(entry.getValue()); System.out.println(entry.getKey()+":"+entry.getValue()); } System.out.println("param:"+param.toString()); out.write(param.toString()); } // flush输出流的缓冲 out.flush(); // 定义BufferedReader输入流来读取URL的响应 in = new BufferedReader( new InputStreamReader(conn.getInputStream(), "UTF-8")); String line; while ((line = in.readLine()) != null) { result.append(line); } } catch (Exception e) { e.printStackTrace(); } //使用finally块来关闭输出流、输入流 finally{ try{ if(out!=null){ out.close(); } if(in!=null){ in.close(); } } catch(IOException ex){ ex.printStackTrace(); } } return result.toString(); } }
常用电子面单接口对接技术文档
一.电子面单接口类型及定义1.快递电子面单接口:快递公司自己开发的电子面单服务,商家使用必须快递公司上门做系统对接,使用一家快递则需要对接一次。2.菜鸟电子面单接口:可一次对接15家快递公司,无需和每一家... 查看详情
电商适用电子面单接口对接案例
电子面单接口现在有快递公司、菜鸟和快递鸟提供快递公司是一家家合作,要接口文档,逐一对接菜鸟和快递鸟是电子面单接口集成方,能打印多家快递电子面单,菜鸟目前支持15家,快递鸟支持20家,基本上都是常用的快递,... 查看详情
电子面单批量打印接口对接(含打印控件)
...打单工具、ERP系统、WEB端、APP移动端等企业发货量较大,电子面单打印接口的需求也日益增加,现在给大家做一下梳理和使用方法介绍。目前支持批量打印电子面单的有快递鸟、菜鸟和快递公司。但是快递公司仅能打印本公司的... 查看详情
顺丰电子面单api接口怎么接入?
图示的工具已经对接了顺丰的电子面单,你将订单同步到工具中,然后选择使用顺丰的模板打单,就可以使用顺丰的电子面单接口,非常便捷。参考技术A目前我国电子面单的接口主要有三种方式,分别是快递公司电子面单接口... 查看详情
各种电子面单_api接口
电子面单是一种通过热敏纸打印输出纸质物流面单的物流服务。通过热感应显示文字,打印速度比传统针式打印速度提升4~6倍。电子面单以接口形式嵌入到自己的系统、网站上,可以在自己的平台操作打印电子面单。&nb... 查看详情
关于菜鸟的圆通电子面单打印(代码片段)
1.https://open.taobao.com/docs/doc.htm?spm=a21da.7629140.0.0.97iBG8&docType=1&articleId=107052电子面单接入文档(LINK接入) 2. https://dayin.cainiao.com/miandan/subscription/branchRechargeInfo.ht 查看详情
电子面单打印模板规格汇总以及使用指南
1.完成前期准备工作1.1,去快递鸟免费注册一个对接账号1.2,免费获得一个apiKey(接口权限验证需要)1.3,完成实名认证流程1.4,订购一个免费套餐1.5,准备打印机、打印纸打印机:???电子面单模板对打印机品牌、型号等没有要求,只要是... 查看详情
圆通电子面单demo(代码片段)
自己写的,比较简单,没什么好多说的config.php<?phpreturn[‘Url‘=>‘请求地址‘,‘CustomerCode‘=>‘客户编码‘,‘CheckCode‘=>‘密钥‘,‘SenderName‘=>‘发件人名‘,‘SenderProvince‘=>‘发件人省‘,‘SenderCity‘=>‘发件人市... 查看详情
查快递,对接哪个接口比较好?
...一次性对接,让企业物流对接更简单,支持顺丰、中通、圆通、申通、韵达、百世、邮政EMS、Fedex、TNT、UPS等国内国际快递物流公司。参考技术A推荐使用快递100的接口。快递100接口覆盖的快递物流信息服务比较全面,包括物流查... 查看详情
各种电子面单-api接口(顺丰快递鸟菜鸟)(代码片段)
...口参数ResponseParamsJava栗子同类文章术语对于一般人,电子面单的意思可能并不是很了解;说白了,就是快递员给你打印的快递单的电子版。专业解释:电子面单是一种通过热敏纸打印输出纸质物流面单的物流服务... 查看详情
快递---快递鸟的电子面单取消操作-----------
...快递数据,这边由于业务需求,有可能会对已取号的快递电子面单做出处理为此自己东拉西扯总算完善了接口当然详细的明细还得各位有使用的朋友,自己去查看所提供的api----------------------------------------------------------仅限数据... 查看详情
电子面单api接口_java调用示例
电子面单是一种通过热敏纸打印输出纸质物流面单的物流服务。通过热感应显示文字,打印速度比传统针式打印速度提升4~6倍。电子面单以接口形式嵌入到自己的系统、网站上,可以在自己的平台操作打印电子面单。&nb... 查看详情
电子面单打印模板规格汇总以及使用指南
1.完成前期准备工作1.1,去快递鸟免费注册一个对接账号1.2,免费获得一个apiKey(接口权限验证需要)1.3,完成实名认证流程1.4,订购一个免费套餐1.5,准备打印机、打印纸打印机:???电子面单模板对打印机品牌、型号等没有要求,只要是... 查看详情
快递鸟电子面单打印功能基于java
之前的后天管理系统的电子面单打印使用的是灵通打单。使用相对比较麻烦,需要到处Excel之后再导入,麻烦。快递鸟有电子面单api,后台系统直接对接很是方便,不过也遇到了好些问题。不难是不难,但是遇到的坑着实是不少... 查看详情
电子面单开发流程
电子面单开发流程开放平台开发(登录、注册、登记,接口API和文档界面展示) 外网文档资格申请界面(查询、发送邮件、审核动作、删除)电子面单平台界面(增删改查)电子面单单号类型维护表(... 查看详情
电子面单开发流程
电子面单开发流程开放平台开发(登录、注册、登记,接口API和文档界面展示)外网文档资格申请界面(查询、发送邮件、审核动作、删除)电子面单平台界面(增删改查)电子面单单号类型维护表(增删改查,方便后期统计)... 查看详情
电子面单打印机如何使用
参考技术A 电子面单,亦可称为热敏纸快递标签、经济型面单,二维码面单等,指的是根据物流公司的规定要求,在不干胶热敏纸上打印客户收发件信息的面单。 电子面单在国外已经成功应用多年,如联邦快递(FedEx)和国... 查看详情
快递查询接口种类及对接方法
...sp;目前快递查询接口有两种方式可以对接,一是和顺丰、圆通、中通、天天、韵达、德邦这些快递公司一一对接接口,二是和快递鸟这样第三方集成接口一次性对接多家常用快递。第一种耗费时间长,但是是直接和快递公司合作... 查看详情