快递鸟API电子面单接口说明文档Word文档下载推荐.docx
《快递鸟API电子面单接口说明文档Word文档下载推荐.docx》由会员分享，可在线阅读，更多相关《快递鸟API电子面单接口说明文档Word文档下载推荐.docx（28页珍藏版）》请在冰点文库上搜索。
2
大客户
与快递公司签订合作协议的客户，有快递公司客户号或月结账号。
此类客户支持运费月结、到付、现付。
3
散户
与快递公司无合作关系，无客户号，支持运费现付/到付运费。
二、快递鸟电子面单方案
1、编码规范
目前接口支持了：
顺丰（SF）、EMS（EMS）、宅急送（ZJS）、圆通（YTO）、百世快递（HTKY）、中通（ZTO）、韵达（YD）、申通（STO）、德邦（DBL）、优速（UC）、京东（JD）、信丰（XFEX）、全峰（QFKD）、跨越速运（KYSY）、安能小包（ANE）、快捷快递（FAST）、国通（GTO）、天天快递（HHTT），后续更多的快递公司正在对接中。
散户模式（无需电子面单客户号）支持快递公司：
顺丰（SF）、EMS（EMS）（仅支持广东省内发货）、快捷快递（FAST）、宅急送（ZJS），后续更多的快递公司正在对接中。
电子面单客户号在线申请支持快递公司：
优速（UC）、后续更多的快递公司正在对接中。
余量查询接口支持快递公司：
中通（ZTO）、韵达（YD）、优速（UC）、后续更多的快递公司正在对接中。
面单回收接口支持快递公司：
2、业务流程
n商家需要做什么
l商家使用流程
l配置物料
a）电子面单需要使用热敏打印机，可与当地网点申请或自行通过淘宝、京东等电商平台购买，目前市场上支持的厂家和型号包括：
斑马G886T、启锐、佳博等
b）打印纸：
电子面单需要使用热敏纸，可与当地网点申请打印纸物料或者自行在淘宝等电商平台、线下文具店购买，打印纸尺寸需要根据打印模板尺寸购买或定制。
l商家在线申请电子面单客户号
截图：
申请服务商的界面截图
申请服务商的提交界面截图
选择网点：
网点为根据发货地址自动匹配，若有多个需您自行选择，快递公司总部审核通过后会分配正确的网点。
l申请快递公司电子面单客户号说明：
a）电子面单客户号即请求打印面单时的用户账号或月结编码或客户编码，不同物流服务商的叫法不同而已。
b）若商家无需月结运费，电子面单API请求参数CustomerName“电子面单客户账号”无需填写可直接请求打单，无需申请电子面单客户号。
支持快递公司：
c）若商家已有电子面单客户号，则对接快递鸟电子面单API请求参数CustomerName“电子面单客户号”输入商家的客户号和密码通过验证即可打单。
d）在线申请客户号说明：
因为物流快递商运营模式的不同（分为加盟和直营），加盟型运营商是以网点为单位进行账户核算，所以您需要和每个快递网点建立合作，通过快递鸟申请服务后，网点会联系您审核并且办理单量充值。
而直营型服务商由快递总部与发货人绑定运费结算关系，无需再联系快递公司充值单号，直营快递公司审核通过后即可打单。
目前支持在线申请客户号的快递公司：
优速（UC），后续更多的快递公司正在对接中。
l电子面单余量提醒值设置
快递鸟官网-用户管理后台-电子面单-账户信息-批量设置余量不足提醒值。
n系统对接需要做什么
l快递鸟接口对接通用流程：
l电子面单接口对接流程：
a）注册快递鸟ID：
b）实名认证：
c）申请电子面单API：
在快递鸟用户管理后台--申请API页面，点击申请电子面单API，快递鸟审核通过后即可开始对接。
d）对接联合注册接口：
若贵司平台系统有多家发货商家，建议同时对接联合注册接口，以便区分您平台用户，并实现各发货商家独立使用代收货款服务。
接口文档参考：
《快递鸟代收货款》-1.1用户注册接口。
非必需接入。
e）对接电子面单接口：
请参考第三章：
接口说明
f）前端界面开发：
您需要为商家增加打印电子面单的组件，包括：
添加电子面单打印模板（模板保存在系统本地或通过接口即时在线获取均可）、商家绑定电子面单客户账号（账号、密码、取件网点等信息，具体参考《快递鸟电子面单参数配置对照表》，建议在商家选择快递公司打印模板时让商家输入提交保存。
）、打印界面和控件调试（偏移调试）。
3、系统设计规范
添加电子面单打印模板/添加快递公司界面示例：
商家需要绑定电子面单账号信息，建议根据《快递鸟电子面单参数配置对照表》显示各家快递公司需要输入的字段。
4、应用场景说明
n下单+打印
a）商家操作发货时同步订单的发/收件人信息、货物信息，通过接口直接发送到快递公司获取电子面单单号、大头笔、电子面单打印模板等信息。
通过浏览器或CS结构客户端打印工具进行打印电子面单。
n筛单
a）电子面单下单时快递公司需要确认订单是否在收派范围之内，故需要将订单信息的收件地址和寄件地址进行筛单校验。
n取消/回收单号
a）已生成电子面单运单号的面单，在快递公司未揽件前可申请取消面单。
b）面单号取消后，加盟型快递公司大客户号的面单会按每家快递公司规则回收，余量对应加1。
c）每个面单号只支持取消一次。
d）每个客户号取消的单号总量不能超过获取单号数量的20%。
e）快递公司回收单号机制配置表如下：
快递公司
手动取消
自动取消/回收
EMS
不支持
顺丰
圆通
每月10日左右回收往前两个月一整月浪费面单号。
如当前月为4月，则回收2月整月已拉取无物流路由信息的电子面单单号，返款给站点，由站点与商家结算回收单号。
百世
支持
单号获取后2个月内无路由信息，自动回收单号，返款给站点，由站点与商家结算回收单号。
中通
快递鸟暂不支持
韵达
单号获取后30天无路由信息，自动回收单号，单号可以再次使用。
申通
德邦
单号获取后30天无路由信息，自动回收单号.
优速
请求取消后15天无路由信息回收单号
宅急送
京东
信丰
全峰
跨越速运
安能
单号获取后30天无路由信息，自动回收单号。
快捷
天天
国通
n余量查询
a）与网点预充值单量情况下才需要查询余量。
散户模式无需查询余量。
b）直营快递公司无需查询余量。
c）单量查询快递公司配置表。
是否支持
快递鸟暂不支持，请至官网查询
三、接口说明
1.1电子面单
1.1.1功能说明
电子面单接口是快递鸟提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口，满足客户在线发货需求并提供打印面单的服务，客户通过网络选择物流公司发送请求通知贵公司有快递要发货，贵公司把数据通过此接口转发到快递鸟，由快递鸟为您通知对应的快递公司快递员上门取件。
电子面单成功下单后，快递鸟系统内将自动订阅，一旦轨迹发生变化时，快递鸟将调用客户方推送接收接口。
同时若客户使用代收货款服务，快递鸟会将代收货款的货款状态独立推送给用户。
1.1.2接口规则
（1）、只支持Json格式。
接口指令1007。
（2）、订单编号（OrderCode）不可重复提交，重复提交系统会返回具体错误代码。
（3）、目前接口支持了：
顺丰（SF）、EMS（EMS）（仅支持广东省内发货）、优速（UC）、快捷快递（FAST）、宅急送（ZJS），后续更多的快递公司正在对接中。
（4）、测试地址：
http:
//testapi.kdniao.cc:
8081/api/eorderservice/
（5）、正式地址：
//api.kdniao.cc/api/EOrderService
（6）、请求报文中不允许出现以下特殊字符：
'
"
#&
+<
>
1.1.3系统级和应用级输入参数
系统级输入参数
应用级输入参数
类型
是否必须
描述
RequestData（必填参数，请求内容，JSON格式,须和DataType一致）
CallBack
String
O
用户自定义回调信息
MemberID
会员标识
平台方与快递鸟统一用户标识的商家ID
CustomerName
电子面单客户账号
（与快递网点申请或通过快递鸟官网申请或通过申请电子面单客户号申请）
CustomerPwd
电子面单密码
SendSite
收件网点标识
ShipperCode
R
快递公司编码
LogisticCode
快递单号
ThrOrderCode
第三方订单号
OrderCode
订单编号
MonthCode
C
月结编码
PayType
Int
邮费支付方式:
1-现付，2-到付，3-月结，4-第三方支付
ExpType
快递类型：
1-标准快件
IsNotice
是否通知快递员上门揽件：
0-通知；
1-不通知；
不填则默认为1
Cost
Double
寄件费（运费）
OtherCost
其他费用
Receiver
Company
收件人公司
Name
收件人
Tel
电话与手机，必填一个
Mobile
PostCode
收件人邮编
ProvinceName
收件省（如广东省，不要缺少“省”）
CityName
收件市（如深圳市，不要缺少“市”）
ExpAreaName
收件区（如福田区，不要缺少“区”或“县”）
Address
收件人详细地址
Sender
发件人公司
发件人
发件人邮编
发件省（如广东省，不要缺少“省”）
发件市（如深圳市，不要缺少“市”）
发件区（如福田区，不要缺少“区”或“县”）
发件详细地址
StartDate
上门取货时间段:
"
yyyy-MM-ddHH:
mm:
ss"
格式化，本文中所有时间格式相同
EndDate
Weight
物品总重量kg
Quantity
件数/包裹数
Volume
物品总体积m3
Remark
备注
AddService
增值服务名称
Value
增值服务值
CustomerID
客户标识（选填）
Commodity
GoodsName
商品名称
GoodsCode
商品编码
Goodsquantity
件数
GoodsPrice
商品价格
GoodsWeight
商品重量kg
GoodsDesc
商品描述
GoodsVol
商品体积m3
IsReturnPrintTemplate
返回电子面单模板：
0-不需要；
1-需要
TemplateSize
模板尺寸
EBusinessID
商户ID
RequestType
请求指令类型：
1007
DataSign
数据内容签名
DataType
请求、返回数据类型：
2-json
1.1.4返回结果参数
l同步返回
参数名称
必须要求
电商用户ID
Order
MarkDestination
大头笔
OriginCode
始发地区域编码
OriginName
始发地/始发网点
DestinatioCode
目的地区域编码
DestinatioName
目的地/到达网点
SortingCode
分拣编码
PackageCode
集包编码
Success
Bool
成功与否
ResultCode
错误编码
Reason
失败原因
UniquerRequestNumber
唯一标识
PrintTemplate
面单打印模板
EstimatedDeliveryTime
订单预计到货时间yyyy-mm-dd
Callback
SubCount
子单数量
SubOrders
子单号
SubPrintTemplates
子单模板
ReceiverSafePhone
收件人安全电话
SenderSafePhone
寄件人安全电话
DialPage
拨号页面网址（转换成二维码可扫描拨号）
1.2电子面单余量查询接口
1.2.1功能说明
用户查询客户号在快递公司的单号剩余量。
1.2.2接口规则
（1）、接口只支持Json格式参数，接口指令1127。
只支持POST请求方式，utf-8编码。
（2）、目前支持快递公司：
优速，后续更多的快递公司正在对接中。
1.2.3系统级和应用级输入参数
电子面单账号
StationCode
网点编码
StationName
网点
电商ID
1127
2-json；
1.2.4返回结果参数
EbusinessID
用户ID
成功与否：
true,false
原因
返回结果编号
EorderBalance
TotalNum
累计充值数量，电子面单总量（包含已使用/未使用）
AvailableNum
可用量（剩余量）
{
"
ShipperCode"
:
"
UC"
CustomerName"
80238728"
CustomerPwd"
c0bfe0ba86b66bae5426303c53db0a81"
StationCode"
3001"
StationName"
福田网点"
}
1.2.5JSON请求示例
1.2.6JSON返回示例
"
EBusinessID"
1261602"
Success"
true,
Reason"
ResultCode"
100"
EorderBalance"
{
AvailableNum"
0,
TotalNum"
0
}
1.3电子面单单号取消
1.3.1功能说明
快递鸟通用接口提交快递公司编码、快递单号，则可以取消提交单号。
仅支持未揽件状态快递单进行取消，取消后的回收规则以快递公司为准。
1.3.2接口规则
（1）、接口指令1147。
1.3.3系统级和应用级输入参数
ExpNo
运单号
客户号
客户号密码
1147
1.3.4返回结果参数
结果编码
1.3.5Json请求示例
ExpNo"
900008664480"
c0bfe0ba86b66bae5426303c53db0a8b"
1.3.6Json请求返回示例
t
升级会员 