快递鸟物流接口技术.pdf
《快递鸟物流接口技术.pdf》由会员分享,可在线阅读,更多相关《快递鸟物流接口技术.pdf(102页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、快快 递递 鸟鸟 接接 口口(A A P P I I)技技 术术 文文 档档版本版本日期日期版版本本2014-12-012014-01-112014-01-132015-03-112015-10-122016-01-192016-03-012016-03-012016-04-072016-05-1电子面单新增通知快递员上门字詹益伟推送接口更新任海洋分发及订阅接口更新任海洋增加智选物流接口曹强新增批量订阅推送接口,删除版本推送接口新增订单分发接口,整理电子面单接口重新调整在线下单接口曹强曹强杨文胜重新整理,根据功能分类,部分有调整对接口的说明进行了注释,提高可读性新增推送接口杨汉汶杨汉汶杨文胜说
2、明说明作者作者12016-07-01段,推送接口新增货款状态推送全新接口,新增单号识别接口、智选物流接口、更新物流轨迹接口(订阅查询)詹益伟2016-9-26推送接口新增 DataSign 字段、订阅新增仓库标识 ID、智选物流接口新增字段胡蕾蕾2016-11-032016-12-132017-1-102017-2-162017-4-13新增在途监控(增值服务)曹强电 子 面 单 新 增 第 三 方 订 单 号ThrOrderCode胡蕾蕾新增隐私快递新增代收货款业务1、即时查询接口中轨迹状态新增 0-无轨迹2、普通回调接口中删除 201 状态3、修改智选物流接口文档4、电子面单接口添加特殊字
3、符提示胡蕾蕾胡蕾蕾陈爱2017-4-251、新增申请电子面单客户号接口2、新增电子面单余额查询接口3、新增电子面单单号回收接口4、新增申请客户号信息推送接口陈爱2017-6-222017-7-14新增短信接口安李旭电子面单接口新增支持邮政快递包裹名词定义名词定义吴明必须要求必须要求ROC说明说明必填(Required)。可选(Optional)报文中该参数在一定条件下可选(Conditional)1 1 前言前言快递鸟 API 旨在为电商、电商平台、物流工具、仓储系统等等系统提供专业、稳定、优质的物流服务,为不同的用户量身定做了专业的API 接口服务,供不同的用户各取所需。本文档就各个 API
4、 接口进行详细的说明,方便快递鸟的用户快速对接,方便快捷使用快递鸟服务。2 2 概述概述2.12.1用户使用流程图用户使用流程图快递鸟 API 全流程服务(电商)流程图基于电商现有的服务流程,快递鸟为电商、电商平台、ERP 系统、仓储系统等系统在用户下单、选择物流、下单、打单、轨迹跟踪等关键节点,均提供了专业、高效的API接口,方便各个平台实现一次接入,便可使用国内外主流物理公司的服务。快递鸟 API 全流程服务(工具)流程图对于物流工具,基于用户的操作习惯,只需要输入单号,快递鸟即可完成后续的物流公司识别、查询轨迹等工作,为工具类用户提供一站式的服务。2.22.2接口规范及说明接口规范及说明
5、2.2.12.2.1报文及报文编码报文及报文编码 Json 格式。编码格式:UTF-8交互协议上统一用 UTF-8,避免传递中文数据出现乱码。2.2.22.2.2接入步骤接入步骤注册成为快递鸟用户注册成为快递鸟用户(注:注册成功后进行实名认证,申请开通接口,后续会再对用户的注册信息进行审批)。注册成功后,登录用户管理后台就可以查看到用户所属唯一的商户 ID 和 API key。按照快递鸟官网提示进行注册申请,注册成功后登录用户管理后台,您将得到由快递鸟提供的一组商户 ID 和 API Key。商户 ID 是调用接口服务的身份证明,不可更改、不可转用,API Key 是应用访问 API 的签名附
6、加密钥,必须妥善保存。两者关系类似于登录帐号和密码,两者都会在签名和业务参数中使用。注册成功登录用户管理后台可以查看商户 ID 和 API Key,需实名认证后才能申请开通接口。(1)开发服务开发自身业务的服务,服务需遵循接口的定义规则。(2)查看接口调用的 DEMO快递鸟物流技术接口提供调用快递鸟物流接口的 DEMO(.Net 版本,Java版本,PHP 版本),包括网上在线订单下单、物流轨迹查询等物流行业标准化的下单操作流程与数据查询格式。提交接入处理的相关代码如有不明白的地方可与快递鸟物流技术接口人协作开发。DEMO 下载地址:(如链接无法打开,请打开浏览器,在浏览器中输入)2.2.32
7、.2.3接口数据包结构接口数据包结构图例-数据包结构(系统级数据)2.2.42.2.4JSONJSON 范例范例 string userID=1109259;2.2.52.2.5 stringstringkeyValuekeyValue=56da2cf8-c8a2-44b2-b6fa-476cd7d1ba1756da2cf8-c8a2-44b2-b6fa-476cd7d1ba17;2.2.62.2.62.2.72.2.72.2.82.2.82.2.92.2.92.2.102.2.102.2.112.2.112.2.122.2.122.2.132.2.132.2.142.2.142.2.152.
8、2.152.2.162.2.162.2.172.2.172.2.182.2.182.2.192.2.192.2.202.2.202.2.212.2.212.2.222.2.222.2.232.2.232.2.242.2.242.2.252.2.252.32.32.3.12.3.1身发件人信息,3.同时隐藏收件人,发件人信息)StriEBusinessIDngStriRequestTypengStriDataSignngStriDataTypengR据类型:请求、返回数R数据内容签名R型:3001请求指令类R商户 ID2-json;2.3.22.3.2返回结果参数返回结果参数参数名称参数名称Or
9、derCodeExpCodeExpNoReceiverSafePhoneReceiverPhoneSenderSafePhoneSenderPhoneDialPageSuccessResultCode类型类型StringStringStringStringStringStringStringStringBoolStringString必填必填RRROO00R说明说明订单编号快递公司编码快递单号收件人安全电话收件人电话寄件人安全电话寄件人电话拨号页面网址(转换成二维码可扫描拨号)RRO成功与否错误编码Reason失败原因2.3.32.3.3JSONJSON 请求示例请求示例 ShipperCod
10、e:SF,Receiver:Company:LV,Name:张勇,ProvinceName:重庆市,CityName:重庆市,ExpAreaName:九龙坡,Address:九龙 35 号 ,Sender:Company:GCCUI,Name:张勇,ProvinceName:北京,CityName:北京,ExpAreaName:朝阳区,Address:三里屯街道雅秀大厦 ,HideType:3 2.3.42.3.4JSONJSON 请求返回示例请求返回示例 EBusinessID:1261600,ShipperCode:SF,Success:true,Reason:,ResultCode:10
11、0,3 3 轨迹查询轨迹查询3.13.1物流轨迹(即时查询)物流轨迹(即时查询)3.1.13.1.1功能说明功能说明物流轨迹查询-使用的物流单号和快递单号即可实现查询物流信息。3.1.23.1.2接口规则接口规则(1)、查询接口支持按照运单号查询(单个查询,并发不超过 10 个/S)。(2)、指定的物流运单号选择相应的快递公司编码,格式不对或则编码错误都会返失败的信息。如 EMS 物流单号应选择快递公司编码(EMS)(3)、返回的物流跟踪信息按照发生的时间升序排列。(4)、接口指令 1002。(5)、请求地址:3.1.33.1.3系统级和应用级输入参数系统级和应用级输入参数系统级输系统级输类型
12、类型应用级输应用级输必须必须说明说明入参数入参数入参数入参数OrderCodeShipperCo要求要求OR订单编号请求内容,快递公司编JSON 格式,码和 DataTypeR物流单号一致RequestDaStringtaLogisticCodeEBusinessStringIDRequestTyStringpeDataSignDataTypeStringStringdeR电商 IDRRR请求指令类型:1002数据内容签名请求、返回数据类型:2-json;3.1.43.1.4返回结果参数返回结果参数参数名称参数名称EBusinessIStringDOrderCodeShipperCodStri
13、ngeLogisticCoStringR物流运单号R快递公司编码StringO订单编号R电商用户 ID类型类型必须要求必须要求说明说明deCallBackSuccessReasonStateStringBoolStringStringOROR在途中,3-签收,4-问题件Traces/物流轨迹详情AcceptTimeStringAcceptStatStringionRemarkStringO备注R描述R时间用户标识成功与否失败原因物流状态:0-无轨迹 2-3.1.53.1.5JSONJSON 请求示例请求示例 OrderCode:,ShipperCode:SF,3.1.63.1.6JSONJSO
14、N 返回示例返回示例没有物流轨迹的没有物流轨迹的 EBusinessID:1109259,Traces:,OrderCode:,ShipperCode:SF,Success:true,Reason:null有物流轨迹的有物流轨迹的 EBusinessID:1109259,OrderCode:,ShipperCode:SF,Success:true,CallBack:,State:3,Reason:null,Traces:AcceptTime:2014/06/25 08:05:37,Remark:null ,AcceptTime:2014/06/25 04:01:28,AcceptStation
15、:快件在 深圳集散中心,准备送往下一站 深圳 深圳市,Remark:null ,AcceptTime:2014/06/25 01:41:06,AcceptStation:快件在 深圳集散中心 深圳市,Remark:null ,AcceptTime:2014/06/24 20:18:58,AcceptStation:已收件深圳市,Remark:null ,AcceptTime:2014/06/24 20:55:28,AcceptStation:快件在 深圳,准备送往下一站深圳集散中心 深圳市,Remark:null ,AcceptTime:2014/06/25 10:23:03,AcceptSt
16、ation:派件已签收深圳市,Remark:null ,AcceptTime:2014/06/25 10:23:03,AcceptStation:签收人是:已签收深圳市,Remark:null 3.23.2物流轨迹(订阅查询)物流轨迹(订阅查询)3.2.13.2.1功能说明功能说明订阅查询接口是快递鸟为用户提供的定制化服务,用户可将订单信息通过快递鸟订阅给快递公司,快递公司更新轨迹后,快递鸟将实时转换成快递鸟标准接口形式,推送给用户,起到实时推送的作用,提高效率。同时用户订阅的数据还能选择是否通知快递员上门,实现在线下单功能。3.2.23.2.2接口规则接口规则 (1)、订单接收的信息(分给了
17、的网点,业务员的信息),会通过推送接口推给客户(订阅并发不超过 30 次/S)客户需要按要求实现接口。(2)、仅支持 Json 格式。(3)、请求指令 1008。(4)、测试接口地址:(5)、联调通过后请更换为正式地址:(6)、分发及订阅接口需要客户方实现回调接口,回调 RequestType(1008)3.2.33.2.3系统级和应用级输入参数系统级和应用级输入参数系统级输入参系统级输入参应用级输入参数应用级输入参数数数StriCallBackngStriMemberIDngRequestDataStri(必填参数,请求内容,JSON格式,须和DataType 一Stri致)Customer
18、PwdCustomerName是否是否类型类型必须必须用户自定义回O调信息会员标识(备O用字段)仓库标识(备OngStriOngOngStriSendSite描述描述WareHouseID用字段)电子面单客户账号(与快递网点申请)电子面单密码OngStriR收件网点标识ShipperCode快递公司编码ngStriLogisticCodengStriOrderCodengStriMonthCodeng邮费支付方式:PayTypeIntO1-现付,2-到付,3-月结,4-第三方支付StriExpTypengDoubCostleDoubOtherCostleStriCompanyReceiverN
19、amengngStriO收件人O收件人公司O其他费用O寄件费(运费)O标准快件快递类型:1-O月结编码O订单编号R快递单号StriTelngStriMobilengStriPostCodeng收件省(如广ProvinceNameStriOng少“省”)收件市(如深StriCityNameng少“市”)收件区(如福ExpAreaNameStriOng少“区”或“县”)StriAddressngStriCompanyngSenderStriNamengO发件人O发件人公司O址收件人详细地田区,不要缺O圳市,不要缺东省,不要缺O收件人邮编O手机O电话StriTelngStriMobilengStri
20、PostCodeng发件省(如广ProvinceNameStriOng少“省”)发件市(如深StriCityNameng少“市”)发件区(如福ExpAreaNameStriOng少“区”或“县”)StriAddressngStriStartDatengStriEndDatengOHH:mm:ss格O段:yyyy-MM-dd上门取货时间O发件详细地址田区,不要缺O圳市,不要缺东省,不要缺O发件人邮编O发件人手机O发件人电话式化,本文中所有时间格式相同DoubWeightleQuantityVolumeleStriRemarkng是否分发到快递公司:1-不IsNoticeIntO分发;0-分发.默
21、认为 0是否订阅短信IsSendMessageIntO0-不需要;1-需要StriNameOIntDoubOO物品总重量 kg件数/包裹数物品总体积 m3O备注0ngStri0ngStri0AddServiceValue增值服务值客户标识(选CustomerIDngStriGoodsNamengStriGoodsCodengGoodsquanInttityCommodityGoodsPriceGoodsWeightGoodsDescngDoubGoodsVolleStriEBusinessIDngStriRequestTypeDataSignngDataTypeStriRngStriRRROD
22、oubOleDoubOleStriOOOO填)商品名称商品编码件数商品价格商品重量 kg商品描述商品体积 m3商户 ID请求指令类型:1008数据内容签名请求、返回数ng据类型:2-json;3.2.43.2.4返回结果参数返回结果参数同步返回同步返回参数名称参数名称EBusinessIDUpdateTimeSuccessReason类型类型StringStringBoolStringString必须要求必须要求RRROO说明说明电商用户 ID时间成功与否:true,false失败原因订单预计到货时间EstimatedDeliveryTimeyyyy-mm-dd3.2.53.2.5JSONJS
23、ON 请求示例请求示例 ShipperCode:SF,PayType:1,ExpType:1,CustomerName:,CustomerPwd:,MonthCode:,IsNotice:0,Sender:Name:1255760,Tel:,ProvinceName:广东省,CityName:深圳市,ExpAreaName:福田区,Address:测试地址 ,Receiver:Name:1255760,Tel:,ProvinceName:广东省,CityName:深圳市,ExpAreaName:龙华新区,Address:测试地址2 ,Commodity:GoodsName:书本 3.2.63.
24、2.6JSONJSON 返回示例返回示例 EBusinessID:1151847,UpdateTime:2016-08-09 16:42:38,Success:true,Reason:EstimatedDeliveryTime:2016-8-124 4 异步推送(回调)接口异步推送(回调)接口4.14.1功能说明功能说明客户通过下单、订阅接口,把运单号在快递鸟系统订阅。运单物流信息有更新,快递鸟通过推送接口把更新的信息推送给客户。推送接口由用户按照快递鸟规则实现。商户开放接口,快递鸟定时将最新的物流轨迹推送到商户平台。优点:客户不需要关注轨迹变化,一旦有更新,快递鸟自动推送。缺点:对客户的服务
25、器性能有所要求,快递鸟定时请求接口,对客户的服务器有一定的影响,客户服务器异常将接受不到最新数据。快递鸟推送接口根据业务不同,会根据 RequestType 的分类推送不同的数据,用户需对推送的数据进行分类保存。原推送接口无需变化,快递鸟会根据推送版本进行推送。4.24.2接口规则接口规则 (1)、客户服务器必须稳定,并且有一定的接受数据能力(需要在5S 内给快递鸟返回成功示例,超时会判断推送失败)。快递鸟通过多线程推送物流信息给客户。(2)、客户需要按快递鸟要求开发接口,保证信息的正常接收。客户接数据后,存储并马上返回接收响应。如果客户对数据进行处理,再做出响应。这会造成网络超时,传输效率低
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 快递 物流 接口 技术
限制150内