快递鸟电子面单接口说明文档快递鸟2017-04-25版本一、前言1、业务背景随着电子商务和物流信息化服务的迅猛发展,电子面单已经成为了商家快速发货并连接订单与物流的有力工具。
快递鸟电子面单接口是快递鸟提供给独立电商、仓储管理系统、打单软件、物流供应链等物流系统平台使用的物流下单接口,满足商家在线发货需求并提供打印电子面单的服务。
商家通过贵司系统选择物流公司发送请求通知快递公司有快递要发货,贵公司把数据通过此接口转发到快递鸟,由快递鸟为商家通知对应的快递公司快递员上门取件。
电子面单成功下单后,快递鸟系统内将自动订阅,一旦轨迹发生变化时,快递鸟将调用贵司推送接收接口将物流信息反向推送至商家。
同时若客户使用代收货款服务,快递鸟会将代收货款的货款状态独立推送给商家用户。
电子面单具有如下特点:●打印效率高相比传统针式打印机套打模式,打印速度提升6-8倍,热敏打印机打印速度平均30-40张/分。
●发货效率高包裹出库时减少了抽底单的工序,降低了操作成本、提升操作效率,运单和订单即时绑定,无需人工再次扫描绑定发货。
目前商家在使用电子面单的过程中也存在一些情况导致部分用户无法顺畅使用,例如:●大电商有多家合作快递公司,各家快递公司的模板尺寸不一,需要使用多个打印机打印面单。
●单号作废后回收机制不完善导致电商成本升高。
●二联电子面单无底单,运费核账存在问题(部分商家货物重量以称重为准)。
●打印时发现面单号余额不足,耽误发货。
●小B电商发货量不够申请网点的电子面单服务。
快递鸟电子面单接口为解决客户以上问题,新增如下解决方案:●电子面单余量查询:可通过电子面单余量查询接口查询,并且在快递鸟官网可设置余额不足提醒值(后续会加上余额不足短信/邮件提醒功能)●电子面单取消/回收:可通过电子面单取消接口,回收部分加盟快递公司的面单号。
●通用电子面单模板,含二联、三联模板●快递公司电子面单客户号在线申请●散户模式电子面单:部分快递公司无需申请电子面单客户号即可直接打印电子面单。
二、快递鸟电子面单方案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)、后续更多的快递公司正在对接中。
面单回收接口支持快递公司:优速(UC)、后续更多的快递公司正在对接中。
2、业务流程⏹商家需要做什么●商家使用流程●配置物料a)电子面单需要使用热敏打印机,可与当地网点申请或自行通过淘宝、京东等电商平台购买,目前市场上支持的厂家和型号包括:斑马G886T、启锐、佳博等b)打印纸:电子面单需要使用热敏纸,可与当地网点申请打印纸物料或者自行在淘宝等电商平台、线下文具店购买,打印纸尺寸需要根据打印模板尺寸购买或定制。
●商家在线申请电子面单客户号截图:申请服务商的界面截图截图:申请服务商的提交界面截图选择网点:网点为根据发货地址自动匹配,若有多个需您自行选择,快递公司总部审核通过后会分配正确的网点。
●申请快递公司电子面单客户号说明:a)电子面单客户号即请求打印面单时的用户账号或月结编码或客户编码,不同物流服务商的叫法不同而已。
b)若商家无需月结运费,电子面单API请求参数CustomerName“电子面单客户账号”无需填写可直接请求打单,无需申请电子面单客户号。
支持快递公司:顺丰(SF)、EMS(EMS)(仅支持广东省内发货)、快捷快递(FAST)、宅急送(ZJS),后续更多的快递公司正在对接中。
c)若商家已有电子面单客户号,则对接快递鸟电子面单API请求参数CustomerName“电子面单客户号”输入商家的客户号和密码通过验证即可打单。
d)在线申请客户号说明:因为物流快递商运营模式的不同(分为加盟和直营),加盟型运营商是以网点为单位进行账户核算,所以您需要和每个快递网点建立合作,通过快递鸟申请服务后,网点会联系您审核并且办理单量充值。
而直营型服务商由快递总部与发货人绑定运费结算关系,无需再联系快递公司充值单号,直营快递公司审核通过后即可打单。
目前支持在线申请客户号的快递公司:优速(UC),后续更多的快递公司正在对接中。
●电子面单余量提醒值设置快递鸟官网-用户管理后台-电子面单-账户信息-批量设置余量不足提醒值。
⏹系统对接需要做什么●快递鸟接口对接通用流程:电子面单接口对接流程:a)注册快递鸟ID:b)实名认证:c)申请电子面单API:在快递鸟用户管理后台--申请API页面,点击申请电子面单API,快递鸟审核通过后即可开始对接。
d)对接联合注册接口:若贵司平台系统有多家发货商家,建议同时对接联合注册接口,以便区分您平台用户,并实现各发货商家独立使用代收货款服务。
接口文档参考:《快递鸟代收货款》-1.1 用户注册接口。
非必需接入。
e)对接电子面单接口:请参考第三章:接口说明f)前端界面开发:您需要为商家增加打印电子面单的组件,包括:添加电子面单打印模板(模板保存在系统本地或通过接口即时在线获取均可)、商家绑定电子面单客户账号(账号、密码、取件网点等信息,具体参考《快递鸟电子面单参数配置对照表》,建议在商家选择快递公司打印模板时让商家输入提交保存。
)、打印界面和控件调试(偏移调试)。
3、系统设计规范添加电子面单打印模板/添加快递公司界面示例:商家需要绑定电子面单账号信息,建议根据《快递鸟电子面单参数配置对照表》显示各家快递公司需要输入的字段。
4、应用场景说明下单+打印a) 商家操作发货时同步订单的发/收件人信息、货物信息,通过接口直接发送到快递公司获取电子面单单号、大头笔、电子面单打印模板等信息。
通过浏览器或CS结构客户端打印工具进行打印电子面单。
⏹筛单a)电子面单下单时快递公司需要确认订单是否在收派范围之内,故需要将订单信息的收件地址和寄件地址进行筛单校验。
⏹取消/回收单号a)已生成电子面单运单号的面单,在快递公司未揽件前可申请取消面单。
b)面单号取消后,加盟型快递公司大客户号的面单会按每家快递公司规则回收,余量对应加1。
c)每个面单号只支持取消一次。
d)每个客户号取消的单号总量不能超过获取单号数量的20%。
e)快递公司回收单号机制配置表如下:余量查询a)与网点预充值单量情况下才需要查询余量。
散户模式无需查询余量。
b)直营快递公司无需查询余量。
三、接口说明1.1电子面单1.1.1功能说明电子面单接口是快递鸟提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口,满足客户在线发货需求并提供打印面单的服务,客户通过网络选择物流公司发送请求通知贵公司有快递要发货,贵公司把数据通过此接口转发到快递鸟,由快递鸟为您通知对应的快递公司快递员上门取件。
电子面单成功下单后,快递鸟系统内将自动订阅,一旦轨迹发生变化时,快递鸟将调用客户方推送接收接口。
同时若客户使用代收货款服务,快递鸟会将代收货款的货款状态独立推送给用户。
1.1.2接口规则(1)、只支持Json格式。
接口指令1007。
(2)、订单编号(OrderCode)不可重复提交,重复提交系统会返回具体错误代码。
(3)、目前接口支持了:顺丰(SF)、EMS(EMS)、宅急送(ZJS)、圆通(YTO)、百世快递(HTKY)、中通(ZTO)、韵达(YD)、申通(STO)、德邦(DBL)、优速(UC)、京东(JD)、信丰(XFEX)、全峰(QFKD)、跨越速运(KYSY)、安能小包(ANE)、快捷快递(FAST)、国通(GTO)、天天快递(HHTT),后续更多的快递公司正在对接中。
散户模式(无需电子面单客户号)支持快递公司:顺丰(SF)、EMS(EMS)(仅支持广东省内发货)、优速(UC)、快捷快递(FAST)、宅急送(ZJS),后续更多的快递公司正在对接中。
(4)、测试地址:(5)、正式地址:(6)、请求报文中不允许出现以下特殊字符: ' " # & + < >1.1.3系统级和应用级输入参数1.1.4返回结果参数1.2电子面单余量查询接口1.2.1功能说明用户查询客户号在快递公司的单号剩余量。
1.2.2接口规则(1)、接口只支持Json格式参数,接口指令1127。
只支持POST请求方式,utf-8编码。
(2)、目前支持快递公司:优速,后续更多的快递公司正在对接中。
1.2.3系统级和应用级输入参数1.2.4返回结果参数1.2.5JSON请求示例1.2.6JSON返回示例1.3电子面单单号取消1.3.1功能说明快递鸟通用接口提交快递公司编码、快递单号,则可以取消提交单号。
仅支持未揽件状态快递单进行取消,取消后的回收规则以快递公司为准。
1.3.2接口规则(1)、接口指令1147。
(2)、目前支持快递公司:优速,后续更多的快递公司正在对接中。
1.3.3系统级和应用级输入参数1.3.4返回结果参数1.3.5Json请求示例1.3.6Json请求返回示例1.4申请电子面单客户号1.4.1功能说明客户通过快递鸟平台向快递公司申请客户号1.4.2接口规则(1)、接口只支持Json格式参数,接口指令1107。
只支持POST请求方式,utf-8编码。
(2)、测试地址:/api/apiservice(3)、正式地址:/api/apiservice(4)、目前支持快递公司:优速,后续更多的快递公司正在对接中。
1.4.3系统级和应用级输入参数1.4.4返回结果参数1.4.5Json请求示例1.4.6Json请求返回示例1.5申请客户号信息推送1.5.1功能说明将审核通过客户号信息发送到用户配置的接收地址。
1.5.2接口规则(1)、接口指令1117。
(2)目前支持快递公司:优速,后续更多的快递公司正在对接中。
1.5.3系统级和应用级输入参数1.5.4返回结果参数1.5.5Json请求示例1.5.6Json请求返回示例1.6增值服务列表信息。
四、电子面单模板五、常见问题解答Q&A➢联系快递鸟工作人员:六、返回编码列表七、技术支持文档结束。