顺丰速运快递查询接口API和电子面单接口怎么对接?
除了通过顺丰自己的接口对接外,用的最多的就是第三方通过快递鸟对接了,通过顺丰单号和手机号后四位查询轨迹信息,如果是通过快递鸟下单获得的顺丰单号,可通过单号直接查询,具体下载快递鸟接口技术文档查看接口说明。ShipperCode为SF,且快递单号非快递鸟渠道返回时,必填,对应收件人/寄件人手机号后四位;ShipperCode为SF,且快递单号为快递鸟渠道返回时,不填。
一、接入前准备(TO商家业务人员)
1、申请快递鸟用户ID和API key
1.1登录快递鸟官网注册页面http://www.kdniao.com/reg注册快递鸟账号;
1.2登录快递鸟用户管理后台,进入“我的会员中心”进行实名认证;
1.3认证成功后,进入“产品服务管理”,开通会员服务(可开通免费套餐测试)。
2、申请顺丰速运月结账号
顺丰月结账号需要线下与当地顺丰分部签订收派合同,签定后顺丰会提供10位数字的顺丰月结账号,用于发货结算运费;
注:获取到的月结账号不需要在快递鸟官网后台添加,直接通过接口传值下单即可;
3、购买打印机、打印纸
3.1打印机:
电子面单模板对打印机品牌、型号等没有要求,只要是热敏打印机即可,常见品牌如:斑马、得力、快麦、汉印、佳博等。
打印机可由快递网点提供或者在淘宝京东上购买,安装打印机及驱动程序联系打印机提供方;
3.2打印纸:
顺丰速运使用的打印纸有100mm150mm(切点90/60)、100mm180mm(切点110/70)、100mm*210mm(切点90/60/60)三种,打印纸可由快递网点提供或者在淘宝京东上购买,购买时可选择全白热敏纸。
二、开发接入(TO商家技术开发人员)
1、下载最新快递鸟技术文档和对接攻略
在技术QQ群/快递鸟官网http://kdniao.com/documents下载;
2、参照技术文档开发
2.1 关于请求内容
以java为例:
2.2关于顺丰月结账号接口传值
MonthCode传值顺丰月结账号(PayType为1、2时不填,为3、4时必填),
PayType传值付款方式(包含:1-现付,2-到付,3-月结,4-第三方付),
客户号配置页需留两个栏位(需正确对应以上两个字段)由发货商家填写,商家自己开发的系统也建议保留配置页,万一账号更换了呢?
2.3 关于快递类型
顺丰速运快递类型如下:
快递类型ExpType传值
顺丰标快1
顺丰特惠2
电商特惠3
四日件4
顺丰次晨5
顺丰即日6
电商速配7
医药常温11
医药温控12
物流普运13
冷运到家14
生鲜速配15
大闸蟹专递16
汽配吉运17
重货快运18
行邮专列20
医药专运(常温)21
医药专运(温控)22
电商专配28
即日220034
物资配送35
汇票专送36
证照专递产品110
顺丰空配112
专线普运125
夜配134
重货包裹154
小票零担155
医药常温(陆)195
顺丰微小件202
医药快运203
陆运微小件204
特惠专配208
注:商家的顺丰月结账号是否能发对应的快递类型,请事先和顺丰速运分部人员确认,除1、2、5、6外,其他快递类型都需单独再签协议。
2.4 关于顺丰速运增值服务传值
保价
字段传值:"AddService": [{"Name":"INSURE ","Value":"1000"}]
代收货款
字段传值:
"AddService":[{"Name":"COD","Value":"1000","CustomerID":"1234567891"}]
子母件
Quantity传值大于等于2表示子母件,并且会返回对应的SubCount子单数量、SubOrders子单单号、SubPrintTemplates子单html模板;
签回单
IsReturnSignBill传1表示需要签回单,并且会返回对应的SignBillPrintTemplate签回单html模板,默认为0不需要;
OperateRequire表示回单操作要求(如:签名、盖章、×××复印件等);
预约快递员上门
IsNotice表示是否通知快递员上门揽件,0-通知,1-不通知,默认为1;
关于是否需要预约快递员上门揽件:
1、如寄件点是全国各地不固定,需要快递员上门揽件则预约(此类情况务必对预约用户做限制,必须本人预约,通过手机验证码验证成功后方可预约,不然会造成用户恶意下单预约,导致顺丰速运投诉);
2、如是固定几个地点发货,且每天都需要发货,可线下与快递员协商定时定点定人上门揽件,接口上不需要预约;
3、如是固定地点发货,只是偶尔发几票,自己打印面单则随机预约其中一个订单,如需要快递员打印则全部预约(快递员是否能打印取决于顺丰速运当地网点);
注:如出现恶意预约,导致顺丰速运向快递鸟投诉超过3次的,快递鸟将停用用户此接口权限;
订阅物流节点短信通知
物流节点短信包含:寄件短信、派件短信、签收短信、问题件短信等;
字段传值:IsSendMessage 0-不需要,1-需要
短信通知是收费服务,需联系商务同事购买会员套餐或短信套餐后方可使用。
3、电子面单模板样式
顺丰速运模板共5个规格,具体如下
二联150(默认模板,TemplateSize传值为空)
三联210(TemplateSize传值210)
二联150新(TemplateSize传值15001)
二联180新(TemplateSize传值180)
三联210(TemplateSize传值21001)
4、电子面单模板处理
用户可根据自身的实际情况及未来发展的需要来决定是否需要接口返回模板(参数:IsReturnPrintTemplate 0-不需要,1-需要),推荐平台/工具/ERP类用户自行开发设计,直接发货商家使用接口返回的模板,如有特殊需求可自行开发;
4.1 平台性/工具/ERP类用户
因其系统使用商家较多,同一模板无法满足所有商家需求,推荐根据商家需求自行设计面单模板。
优势:灵活性高,不受快递鸟模板变动的影响,商家体验更好
劣势:对用户技术能力有一定要求
4.2 直接发货商家
A、对模板无要求,快递鸟接口返回的模板已能满足的商家,可直接使用。
优势:接入成本低,方便易用,可使用快递鸟批量打印功能
劣势:灵活性不高
B、对模板有一定要求,快递鸟接口返回的模板无法完全满足的商家,可对返回的html模板报文进行处理,或自行设计面单模板样式。
优势:接入成本较低,方便快捷
劣势:对用户技术能力稍有要求
三、接口使用(TO商家系统操作人员)
使用过程中如遇到问题,先联系公司内部技术人员排查,如需快递鸟协助请让技术人员联系。
可能遇到的问题:
1、接口返回“校验码有误”是什么原因?
答:快递公司不支持的特殊字符:' " # & + % \ < >
请确认请求数据(包含收寄方姓名、电话、地址、商品名称等所有订单数据)中是否含有以上特殊字符;
2、电子面单下单返回结果false,错误码106,订单号已下单成功?
答:电子面单下单接口订单号OrderCode不能重复使用,重复使用会报错且返回的面单是此订单号上次下单的内容;
3、电子面单返回“暂无打印模板”是什么原因?
答:默认的模板TemplateSize无需传值,非默认模板传对应模板尺寸,不可传不存在的模板尺寸代码;
4、电子面单生成后可以取消吗?不发货的话单号会作废吗?
答:下单成功后如不需要发货,直接撕掉面单即可,不需要取消(如果一定要取消可对接”电子面单取消接口”),快递员揽件后才收费,单号不收费;
5、调用电子面单时,接口返回“不可派送”?
答:不可派送表示派件地址不在顺丰速运服务范围,具体收派范围可在顺丰速运官网查看http://www.sf-express.com/cn/sc/dynamic_function/range/...,可更换其他快递发货;
6、调用电子面单时,接口返回”您的预约超出今日营业时间,无法上门取件。”?
答:顺丰速运每个区域每个分部上门取件的服务时间不固定,建议更换时间预约,一般预约9:00—17:00内;
顺丰快递单号查询接口对接指南
目的
便于快递鸟用户理解快递单号查询接口作用并正确应用到实际场景。
接口作用
轨迹类接口包含:即时查询接口和物流跟踪接口。
即时查询接口:实时查询某个快递单号当前的物流状态;
物流跟踪接口:监控某个快递单号完整的物流状态。
应用场景
可应用于电商平台、自营商城、ERP、打单工具、楼宇/物业系统、云打印、微信小程序/公众号、APP、OA等需要查看物流信息的场景。
接口逻辑
说明:
快递鸟接口作为数据中转站,不对物流信息做处理,不做语言转换,只对数据字段做转换,分析物流状态;
快递鸟接口返回的物流轨迹信息按照发生时间的升序排列。
应用方法:
接口返回物流信息后直接展示
优势:方便简单
劣势:受网络影响,响应较慢,用户体验欠佳
接口返回物流信息后保存在本地数据库,当用户查询时调用本地数据再做展示
优势:本地调用响应快,不受网络影响,用户体验好
劣势:需本地保存
应用实例
类似微信扫一扫查快递,通过扫一扫功能扫描面单上的条码跟踪物流状态(需结合快递鸟单号识别接口使用);——适用即时查询接口
前端展示单号轨迹框,由用户填写单号后查询对应物流信息(可结合快递鸟单号识别接口使用);——适用即时查询接口
输入顺丰快递单号,显示可能属于的快递公司列表
选择顺丰快递公司后,展示详细的物流信息。
电商平台、自营商城等展示订单的物流信息,可监控平台商家是否按时发货;——适用物流跟踪接口
APP上展示订单流转路径;——适用物流跟踪接口
发送物流节点短信通知;——适用物流跟踪接口
数据报表;——适用物流跟踪接口
物流体验:分析每天快件状态,统计揽收率、签收率、问题件率等;——适用物流跟踪接口
退货险:平台根据快件流转的时间、揽件城市、签收城市等数据判断商家是否虚假退货;——适用物流跟踪接口
轨迹拼接:转动公司/平台,将海外订单的物流信息和国内清关后的物流信息拼接在一起,方便买家查询海淘订单;——适用物流跟踪接口
对接指南
1、登录快递鸟官网注册页面注册快递鸟账号
网址:快递单号查询接口_电子面单_APIKey授权申请-快递鸟账号注册
2、登录快递鸟用户管理后台
网址:用户登录_快递鸟API让物流接口对接更简单
注:登录快递鸟用户管理后台后获得用户ID和APIKey,此用于保证应用来源的可靠性,避免应用伪造,被不法使用。
3、进入“我的会员中心”进行实名认证
注:
3.1、认证类型、应用类型根据用户实际情况选择即可,接口返回数据与选择结果无关;
3.2、标记为*的为必填,要求上传清晰、jpg格式且小于2M的证件图片;
3.3、技术对接人信息为用户方对接工程师的信息;
3.4、如有其他疑问可进入官网加入商务合作群进行咨询。
4、认证成功后,进入“产品服务管理”,开通相关会员服务
注:
4.1、物流查询(免费版)会员套餐为免费版,有效期1年结束后,如在近3个月内有数据交互系统会自动免费续期;
4.2、如有其他疑问可进入官网加入商务合作群进行咨询。
5、开发对接
5.1、即时查询(RequestType:1002/8001)
5.1.1、请求接口之前需要先实名认证,开通相关会员服务,否则会请求失败并返回提示“未申请开通接口”;
5.1.2、接口开发可以下载“快递鸟接口技术文档”进行参考;即时查询,参考技术文档中的4.1或5.1.1部分;
5.1.3、接口开发可以下载“即时查询demo”进行参考(仅提供了.NET、Java、PHP三种语言demo);
5.1.4、查看快递公司对应快递鸟的编码可以下载“2019快递鸟接口支持快递公司编码列表.xlsx”。
5.1.5、接入过程中如有疑问请先参考快递鸟官网常见问题进行解决(http://www.kdniao.com/help),也可以进入快递鸟官网加入技术对接群进行咨询。
注:快递鸟官网-帮助与文档地址(快递物流api接口文档下载_电子面单接口文档-快递鸟code接口文档 )
快递鸟API接口DEMO下载:快递鸟「即时查询DEMO」让对接更简单