接口快递员持刀砍客户
快递员持刀砍客户 时间:2021-04-28 阅读:()
/快递鸟接口(API)技术文档快递鸟接口技术文档21前言-62接口规范说明-62.
1接口规范及说明-62.
1.
1报文及报文编码-62.
1.
2接口数据包结构-62.
1.
3JSON示例-62.
1.
4系统级参数-72.
1.
5流程示意图-72.
1.
6名词定义-82.
2签名说明-82.
2.
1关于签名-82.
2.
2(C#)DataSign签名加密代码-102.
3接入步骤-113下单类接口-123.
1预约取件接口-123.
1.
1功能说明-123.
1.
2基本信息-133.
1.
3接口规则-133.
1.
4支持情况-133.
1.
5应用场景-133.
1.
6应用级参数-143.
1.
7返回参数-173.
2预约取件取消接口-183.
2.
1功能说明-183.
2.
2基本信息-183.
2.
3接口规则-193.
2.
4支持情况-193.
2.
5应用场景-193.
2.
6应用级参数-193.
2.
7返回参数-193.
3电子面单接口-203.
3.
1功能说明-203.
3.
2基本信息-20快递鸟接口技术文档33.
3.
3接口规则-213.
3.
4支持情况-213.
3.
5应用场景-223.
3.
6应用级参数-223.
3.
7返回参数-283.
4电子面单取消接口-323.
4.
1功能说明-323.
4.
2基本信息-333.
4.
3接口规则-333.
4.
4支持情况-333.
4.
5应用级参数-333.
4.
6返回参数-343.
5单号余量查询接口-343.
5.
1功能说明-343.
5.
2基本信息-343.
5.
3支持情况-353.
5.
4应用级参数-353.
5.
5返回参数-353.
6客户号申请接口-363.
6.
1功能说明-363.
6.
2基本信息-363.
6.
3支持情况-363.
6.
4应用级参数-373.
6.
5返回参数-383.
7客户号推送接口-393.
7.
1功能说明-393.
7.
2基本信息-393.
7.
3接口规则-393.
7.
4支持情况-393.
7.
5应用级参数-393.
7.
6返回参数-403.
8实名寄递接口-40快递鸟接口技术文档43.
8.
1功能说明-403.
8.
2基本信息-413.
8.
3接口规则-413.
8.
4支持情况-413.
8.
5应用级参数-413.
8.
6返回参数-434轨迹查询类接口-434.
1即时查询接口-434.
1.
1功能说明-434.
1.
2基本信息-444.
1.
3接口规则-444.
1.
4支持情况-444.
1.
5应用场景-444.
1.
6应用级参数-444.
1.
7返回参数-454.
2物流跟踪-474.
2.
1轨迹订阅接口-474.
2.
2轨迹推送接口-534.
3单号识别接口-614.
3.
1功能说明-614.
3.
2基本信息-614.
3.
3接口规则-614.
3.
4应用场景-624.
3.
5应用级参数-624.
3.
6返回参数-625增值类接口-635.
1在途监控-635.
1.
1即时查询接口(增值版)635.
1.
2物流跟踪接口(增值版)685.
2智选物流-755.
2.
1运费模板导入接口-755.
2.
2智选物流接口-795.
3短信服务-85快递鸟接口技术文档55.
3.
1短信模板接口-865.
3.
2短信发送接口-885.
3.
3短信黑名单接口-906附录-916.
1接口指令汇总-916.
2对接相关资料-926.
3电子面单模板规格-926.
4返回编码列表-987技术支持-99快递鸟接口技术文档61前言快递鸟API旨在为电商、电商平台、物流工具、打单工具、仓储系统、移动APP等系统提供专业、稳定、优质的API接口服务,满足不同用户的物流管理需求.
本文档就各个API接口进行详细说明,方便用户快速对接及使用快递鸟服务.
2接口规范说明2.
1接口规范及说明2.
1.
1报文及报文编码报文格式:Json格式请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"交互协议上统一用UTF-8,避免传递中文数据出现乱码.
2.
1.
2接口数据包结构图例-数据包结构(系统级{数据})2.
1.
3JSON示例stringused="1237100";//仅作为示例ID,不可用来实际使用//加密私钥,由快递鸟提供stringkeyValue="56da2cf8-c8a2-44b2-b6fa-476cd7d1ba17";//仅作为示例Key,不可用来实际使用//请求地址stringurl="http://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx";快递鸟接口技术文档7//2-jsonstringDataType="2";//字符编码采用UTF-8stringcharset="UTF-8";//JSON字符串stringstringjsonStr="{\"OrderCode\ShipperCode\":\"SF\",\"LogisticCode\":\"118461988807\"}";//把(jsonStr+APIKey)进行MD5加密,然后Base64编码,最后进行URL(utf-8)编码datasign=HttpUtility.
UrlEncode(base64(MD5(jsonStr+keyValue,"UTF-8"),"UTF-8"),Encoding.
UTF8);//请求报文参数stringPostStr="RequestType=1002&EBusinessID=used&RequestData=jsonStr&DataSign=datasign&DataType=DataType";//通讯协议使用Http协议Post请求方式stringpost=this.
DoPost(url,PostStr);2.
1.
4系统级参数名称类型(字符长度)是否必须描述RequestDataStringR请求内容为JSON格式EBusinessIDStringR用户IDRequestTypeStringR请求接口指令DataSignStringR数据内容签名DataTypeStringRDataType=2,请求、返回数据类型均为JSON格式*快递所有接口统一使用此系统级参数,根据不同的请求接口指令接入不同的接口.
2.
1.
5流程示意图快递鸟接口技术文档82.
1.
6名词定义必须要求说明R必填(Required).
O可选(Optional)C一定条件下可选(Conditional)2.
2签名说明2.
2.
1关于签名快递鸟和第三方电子商务公司系统进行对接,有一定的安全机制.
采用IP认证加签名的方式对接,具体方案如下:1.
防止数据被篡改在POST请求中会传递5个必须(R)参数RequestData==数据内容(URL编码:UTF-8)EBusinessID==用户IDRequestType=请求指令类型DataSign==数据内容签名:把(请求内容(未编码)+ApiKey)进行MD5加密,然后Base64编码,最后进行URL(utf-8)编码DataType==2(返回数据类型为json)注:DataSign生成后,对方接收到数据后,以同样的算法进行签名(推送接口RequestType为101/102不需要进行URL编码),生成摘要,对比两者的摘要是否相同,如果不同,说明传递过程中发生数据篡改.
2.
调用接口的身份认证注册成为快递鸟用户后,会生成对应的用户ID和APIKey,用户ID相当于用户名,APIKey相当于密码.
举例:1.
假设RequestData(JSON)内容为:{'OrderCode':'','ShipperCode':'SF','LogisticCode':'118954907573'}经过URL(UTF-8)编码的内容为:%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27SF%27%2c%2快递鸟接口技术文档97LogisticCode%27%3a%27118954907573%27%7d;EBusinessID=1237100【示例ID,不可用来实际使用】APIKey=56da2cf8-c8a2-44b2-b6fa-476cd7d1ba17【示例Key,不可用来实际使用】2.
那么DataSign签名的内容为{'OrderCode':'','ShipperCode':'SF','LogisticCode':'118954907573'}56da2cf8-c8a2-44b2-b6fa-476cd7d1ba17经过md5和base64后的内容就为:OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE=,在经过URL(UTF-8)编码的内容为:OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE%3d最终要发送的数据为:RequestType=1002&EBusinessID=1237100&RequestData=%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27SF%27%2c%27LogisticCode%27%3a%27118954907573%27%7d&DataSign=OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE%3d&DataType=23.
接收方收到数据后,获得EBusinessID和RequestData和DataSign等这几个数据.
4.
接收方对EBusinessID得到APIKey,RequestData+APIKey的数据进行md5和base64后的内容就为OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE=5.
接收方判断签名后的数据跟传递过来的DataSign是否一致,如果一致进行业务操作,如果不一致返回错误.
快递鸟接口技术文档102.
2.
2(C#)DataSign签名加密代码//////电商Sign签名//////内容///APIkey///URL编码///DataSign签名PublicStringEncrypt(Stringcontent,StringkeyValue,Stringcharset){if(keyValue!
=null){returnbase64(MD5(content+keyValue,charset),charset);}returnbase64(MD5(content,charset),charset);}//////字符串MD5加密//////要加密的字符串///密文PrivatestringMD5(stringText,stringcharset){byte[]buffer=System.
Text.
Encoding.
GetEncoding(charset).
GetBytes(Text);try{System.
Security.
Cryptography.
MD5CryptoServiceProvidercheck;check=newSystem.
Security.
Cryptography.
MD5CryptoServiceProvider();byte[]somme=check.
ComputeHash(buffer);stringret="";foreach(byteainsomme){if(a、联昊通速递、极兔速递、丹鸟物流、苏宁物流.
2.
支持预约取件服务的快递公司:圆通速递、中通快递、申通快递、韵达速递、百世快递、顺丰速运、EMS、宅急送、德邦快递、天天快递、跨越速运、优速快递、京东快递、邮政国内标快、品骏快递.
3.
支持保价服务的快递公司:EMS、天天快递、顺丰速运、邮政快递包裹、宅急送、德邦快递、京东快递、丹鸟物流、苏宁物流.
4.
支持子母件功能(一票多件)的快递公司:顺丰速运、优速快递、德邦快递、京东快递、速尔快递、宅急送、跨越速运、苏宁物流.
5.
支持签回单功能的快递公司:顺丰速运、德邦快递、跨越速运、联昊通速递、苏宁物流.
6.
支持代收货款服务的快递公司:顺丰速运、龙邦、速腾、京广、韵达速递、圆通速递、百世快递、中通快递、EMS、速尔快递、京东快递、宅急送、极兔速递、丹鸟物流、苏宁物流;快运公司支持情况:1.
支持电子面单服务的快运公司:德邦快运、安能快运、京东快运、龙邦快运、百世快运、中通快运、天地华宇、佳吉快运、腾林物流、韵达快运、顺心捷达.
2.
支持子母件功能(一票多件)的快运公司:德邦快运、安能快运、京东快运、龙邦快运、百世快运、中通快运、天地华宇、佳吉快运、腾林物流、韵达快运、顺心捷达.
快递鸟接口技术文档223.
支持保价服务的快运公司:德邦快运、安能快运、京东快运、龙邦快运、百世快运、中通快运、天地华宇、佳吉快运、腾林物流、韵达快运、顺心捷达.
3.
3.
5应用场景电商平台、打单工具、ERP系统、WEB端、APP移动端、小程序3.
3.
6应用级参数名称类型(字符长度)是否必须描述CallbackString(50)O用户自定义回传字段MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户CustomerNameString(50)C电子面单客户号,需要下载《快递鸟电子面单客户号参数对照表.
xlsx》,参考对应字段传值CustomerPwdString(30)CSendSiteString(30)CSendStaffString(30)CMonthCodeString(20)CCustomAreaString(500)O商家自定义区域(支持情况见6.
3部分)WareHouseIDString(30)C发货仓编码(ShipperCode为JD或JDKY时必填)TransTypeInt(2)O京东快递(ShipperCode为JD)的产品类型:1:特惠送2:特快送4:城际闪送5:同城当日达6:次晨达7:微小件8:生鲜专送16:生鲜速达17:生鲜惠达京东快运(ShipperCode为JDKY)的类型:1:零担2:整车快递鸟接口技术文档233:特惠送4:特快送5:特惠运6:特准运7:航空代理8:航空直客9:铁路直客10:特惠整车11:特惠拼车12:同城直配13:冷链卡班14:冷链专车15:冷链成配16:送货到仓17:医药零担18:医药整车25:特快重货ShipperCodeString(10)R快递公司编码详细编码参考《快递鸟接口支持快递公司编码.
xlsx》LogisticCodeString(30)O快递单号(仅宅急送可用)ThrOrderCodeString(50)C京东商城的订单号(ShipperCode为JD且ExpType为1时必填)OrderCodeString(30)R订单编号(自定义,不可重复)PayTypeInt(1)R运费支付方式:1-现付,2-到付,3-月结,4-第三方付(仅SF、KYSY支持)ExpTypeString(2)R详细快递类型参考《快递公司快递业务类型.
xlsx》IsReturnSignBillInt(1)O是否要求签回单0-不要求,1-要求OperateRequireString(20)O签回单操作要求(如:签名、盖章、身份证复印件等)CostDouble(5)O快递运费OtherCostDouble(5)O其他费用Receiver.
CompanyString(30)O收件人公司Receiver.
NameString(30)R收件人Receiver.
TelString(20)R电话与手机,必填一个Receiver.
MobileString(20)快递鸟接口技术文档24Receiver.
PostCodeString(10)C收件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)Receiver.
ProvinceNameString(20)R收件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Receiver.
CityNameString(20)R收件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")Receiver.
ExpAreaNameString(20)R收件区/县(如福田区,不要缺少"区"或"县")Receiver.
AddressString(100)R收件人详细地址Sender.
CompanyString(30)O发件人公司Sender.
NameString(30)R发件人Sender.
TelString(20)R电话与手机,必填一个Sender.
MobileString(20)Sender.
PostCodeString(10)C发件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)Sender.
ProvinceNameString(20)R发件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Sender.
CityNameString(20)R发件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")Sender.
ExpAreaNameString(20)R发件区/县(如福田区,不要缺少"区"或"县")Sender.
AddressString(100)R发件人详细地址IsNoticeInt(1)O是否通知快递员上门揽件0-通知,1-不通知,不填则默认为1StartDateDateO上门揽件时间段,格式:快递鸟接口技术文档25YYYY-MM-DDHH24:MM:SSEndDateWeightDouble(10,3)C包裹总重量kg1、当为快运的订单时必填;2、ShipperCode为JD时必填;QuantityInt(2)R包裹数(最多支持300件)一个包裹对应一个运单号,如果是大于1个包裹,返回则按照子母件的方式返回母运单号和子运单号VolumeDouble(20,3)C包裹总体积m31、当为快运的订单时必填;2、ShipperCode为JD时必填;RemarkString(60)O备注AddService.
NameString(20)C增值服务名称(数组形式,可以有多个增值服务)AddService.
ValueString(30)C增值服务值AddService.
CustomerIDString(30)O客户标识Commodity.
GoodsNameString(100)R商品名称Commodity.
GoodsCodeString(20)O商品编码Commodity.
GoodsquantityInt(5)O商品件数Commodity.
GoodsPriceDouble(10)O商品价格Commodity.
GoodsWeightDouble(10,3)O商品重量kgCommodity.
GoodsDescString(50)O商品描述Commodity.
GoodsVolDouble(15,3)O商品体积m3IsReturnPrintTemplateString(1)O是否返回电子面单模板:0-不需要,1-需要IsSendMessageInt(1)O是否订阅短信:0-不需要,1-需要IsSubscribeString(1)O是否订阅轨迹推送0-不订阅,1-订阅,不填默认为1TemplateSizeString(10)O模板规格(默认的模板无需传值,非默认模板传对应模板尺寸)PackingTypeInt(2)C包装类型(快运字段);快递鸟接口技术文档260-纸,1-纤,2-木,3-托膜,4-木托,99-其他DeliveryMethodInt(1)C送货方式(快运字段);0-自提,1-送货上门(不含上楼),2-送货上楼CurrencyCodeString(10)C货物单价的币种:CNY:人民币HKD:港币NTD:新台币MOP:澳门元(ShipperCode为SF且收件地址为港澳台地区,必填)Dutiable.
DeclaredValueNumber(15,3)C申报价值:订单货物总声明价值,包含子母件,精确到小数点后3位(ShipperCode为SF且收件地址为港澳台地区,必填)增值服务说明:名称代码说明备注保价INSUREvalue为声明价值,保留3位小数快运的订单时必填代收货款CODValue为货款,保留3位小数.
CustomerID为代收货款卡号快递公司代收货款业务配送类型DeliveryValue为配送类型数字代码,如:5京东快递专用1:普通,2:生鲜常温3:填仓,4:特配,5:鲜活6:控温,7:冷藏,8:冷冻,9:深冷请求示例:{"OrderCode":"012657018199","ShipperCode":"SF","PayType":1,快递鸟接口技术文档27"MonthCode":"1234567890","ExpType":1,"Cost":1.
0,"OtherCost":1.
0,"Sender":{"Company":"LV","Name":"Taylor","Mobile":"15018442396","ProvinceName":"上海","CityName":"上海市","ExpAreaName":"青浦区","Address":"明珠路"},"Receiver":{"Company":"GCCUI","Name":"Yann","Mobile":"15018442396","ProvinceName":"北京","CityName":"北京市","ExpAreaName":"朝阳区","Address":"三里屯街道"},"Commodity":[{"GoodsName":"鞋子","Goodsquantity":1,"GoodsWeight":1.
0},{"GoodsName":"衣服","Goodsquantity":1,"GoodsWeight":1.
0}],"AddService":[{"Name":"INSURE","Value":"1000"快递鸟接口技术文档28},{"Name":"COD","Value":"1020","CustomerID":"1234567890"}],"Weight":1.
0,"Quantity":1,"Volume":0.
0,"Remark":"小心轻放"}3.
3.
7返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDOrder.
OrderCodeString(30)R订单编号Order.
ShipperCodeString(10)R快递公司编码Order.
LogisticCodeString(400)R快递单号Order.
MarkDestinationString(20)O大头笔Order.
SignWaybillCodeString(15)O签回单单号Order.
OriginCodeString(20)O始发地区域编码Order.
OriginNameString(20)O始发地/始发网点Order.
DestinatioCodeString(20)O目的地区域编码Order.
DestinatioNameString(20)O目的地/到达网点Order.
SortingCodeString(20)O分拣编码Order.
PackageCodeString(20)O集包编码Order.
PackageNameString(50)O集包地Order.
DestinationAllocationCentreString(50)O目的地分拨O京东快递(ShipperCode为JD)的产品类型:1:特惠送2:特快送4:城际闪送快递鸟接口技术文档29Order.
TransTypeInt(2)5:同城当日达6:次晨达7:微小件8:生鲜专送16:生鲜速达17:生鲜惠达京东快运(ShipperCode为JDKY)的类型:1:零担2:整车3:特惠送4:特快送5:特惠运6:特准运7:航空代理8:航空直客9:铁路直客10:特惠整车11:特惠拼车12:同城直配13:冷链卡班14:冷链专车15:冷链成配16:送货到仓17:医药零担18:医药整车25:特快重货Order.
TransportTypeInt(2)O运输方式(用于自行设计京东模板):0:陆运1:航空Order.
ShipperInfoString(300)C自行设计模板用(仅ShipperCode为SF时返回)SuccessBool(10)R成功与否(true/false)ResultCodeString(5)R返回编码ReasonString(50)O失败原因UniquerRequestNumberString(50)O唯一标识PrintTemplateStringO面单打印模板内容(html格式)EstimatedDeliveryTimeDateO订单预计到货时间(暂未上线)SubCountInt(5)O子单数量快递鸟接口技术文档30SubOrdersString(400)O子单单号SubPrintTemplatesString(2000)O子单模板内容(html格式)SignBillPrintTemplateStringO签回单模板内容(html格式)ShipperInfo参数说明(仅ShipperCode为SF时返回):格式:ShipperInfo={"Details":[{"Detail":{主单号的信息}},{"Detail":{签回单的信息}}]}名称类型(字符长度)是否必须描述Details.
Detail.
LogisticCodeString(30)O快递单号Details.
Detail.
OriginTransferCodeString(60)O原寄地中转场Details.
Detail.
OriginCityCodeString(60)O原寄地城市代码Details.
Detail.
OriginDeptCodeString(60)O原寄地网点代码Details.
Detail.
OriginTeamCodeString(60)O原寄地单元区域Details.
Detail.
DestCityCodeString(60)O目的地城市代码Details.
Detail.
DestDeptCodeString(60)O目的地网点代码Details.
Detail.
DestDeptCodeMappingString(60)O目的地网点代码映射码Details.
Detail.
DestTeamCodeString(60)O目的地单元区域Details.
Detail.
DestTeamCodeMappingString(60)O目的地单元区域映射码Details.
Detail.
DestTransferCodeString(60)O目的地中转场Details.
Detail.
DestRouteLabelString(200)O打单时的路由标签信息Details.
Detail.
CodingMappingString(60)O入港映射码Details.
Detail.
CodingMappingOutString(60)O出港映射码Details.
Detail.
XbFlagString(30)OXB标志0:不需要打印1:需要打印快递鸟接口技术文档31Details.
Detail.
PrintFlagString(60)O打印标志返回值总共有9位,每一位只有0和1两种,0表示按丰密运单默认的规则,1表示显示,顺序如下,如111110000表示打印寄方姓名、寄方电话、寄方公司名、寄方地址和重量,收方姓名、收方电话、收方公司名和收方地址按丰密运单默认规则:1:寄方姓名2:寄方电话3:寄方公司名4:寄方地址5:重量6:收方姓名7:收方电话8:收方公司名9:收方地址Details.
Detail.
TwoDimensionCodeString(600)O二维码根据规则生成字符串信息,格式为:MMM={'k1':'(目的地中转场代码)','k2':'(目的地原始网点代码)','k3':'(目的地单元区域)','k4':'(通过三维码(express_type_code、limit_type_code、cargo_type_code)映射时效类型)','k5':'(运单号)','k6':'(AB标识)'}Details.
Detail.
ProCodeString(30)O时效类型:值为二维码中的K4Details.
Detail.
PrintIconString(100)O打印图标Details.
Detail.
AbFlagString(30)OAB标快递鸟接口技术文档32返回示例:失败:{"EBusinessID":"1237100","ResultCode":"106","Reason":"该订单号已下单成功","UniquerRequestNumber":"5e66486b-8fbc-4131-b875-9b13d2ad1354"}成功:{"EBusinessID":"1237100","Order":{"OrderCode":"012657700387","ShipperCode":"HTKY","LogisticCode":"50002498503427","MarkDestination":"京-朝阳(京-1)","OriginCode":"200000","OriginName":"上海分拨中心","PackageCode":"北京"},"PrintTemplate":"此处省略打印模板HTML内容","EstimatedDeliveryTime":"2016-03-06","Success":true,"ResultCode":"100","Reason":"成功"}3.
4电子面单取消接口3.
4.
1功能说明此接口用于取消"电子面单接口"下单成功的订单,回收快递单号.
快递鸟接口技术文档333.
4.
2基本信息3.
4.
3接口规则1.
只支持取消通过电子面单接口下单成功的订单;2.
只支持取消未揽件的订单;3.
订单取消后,订单号仍不可重复使用;4.
订单取消后快递单号的回收规则以快递公司为准.
3.
4.
4支持情况支持快递公司:顺丰速运、优速快递、百世快递、承诺达、腾林物流.
3.
4.
5应用级参数名称类型(字符长度)是否必须描述ShipperCodeString(10)R快递公司编码OrderCodeString(30)R订单编号ExpNoString(30)R快递单号CustomerNameString(50)R电子面单客户号CustomerPwdString(30)R电子面单密码(顺丰不需要)请求示例:接口指令1147批量请求不支持接口地址正式地址(不加密):http://api.
kdniao.
com/api/EOrderService正式地址(加密):https://api.
kdniao.
com/api/EOrderService{"ShipperCode":"UC","OrderCode":"TEST201209211045","ExpNo":"900008664480","CustomerName":"80238728","CustomerPwd":"c0bfe0ba86b66bae5426303c53db0a8b"快递鸟接口技术文档343.
4.
6返回参数名称类型(字符长度)是否必须描述EbusinessIDString(10)R用户IDSuccessBool(10)R成功与否(true/false)ResultCodeString(5)R返回编码ReasonString(50)O失败原因返回示例:3.
5单号余量查询接口3.
5.
1功能说明此接口用于向快递公司查询电子面单客户号中剩余的可用单号数量.
3.
5.
2基本信息}{"EBusinessID":"1237100","Success":true,"ResultCode":"100"}接口指令1127支持格式只支持Json格式、UTF-8编码请求方式POST请求接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/api/EOrderService正式地址(加密):https://api.
kdniao.
com/api/EOrderService快递鸟接口技术文档353.
5.
3支持情况支持快递公司:优速快递、中通快递、韵达速递、百世快递.
3.
5.
4应用级参数名称类型(字符长度)是否必须描述ShipperCodeString(10)R快递公司编码CustomerNameString(50)R电子面单客户号CustomerPwdString(30)R电子面单密码StationCodeString(30)R网点编码StationNameString(30)R网点名称请求示例:3.
5.
5返回参数{"ShipperCode":"UC","CustomerName":"80238728","CustomerPwd":"c0bfe0ba86b66bae5426303c53db0a81","StationCode":"3001","StationName":"福田网点"}名称类型(字符长度)是否必须描述EbusinessIDString(10)R用户IDSuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因ResultCodeString(10)R返回编码EorderBalance.
TotalNumInt(10)O累计充值数量,电子面单总量(包含已使用/未使用)EorderBalance.
AvailInt(10)R剩余可用量快递鸟接口技术文档36返回示例:3.
6客户号申请接口3.
6.
1功能说明此接口用于向快递公司申请电子面单客户号.
3.
6.
2基本信息3.
6.
3支持情况1.
支持快递公司:优速快递、韵达速递、圆通速、百世快递、远成快运(YCWL)、安能快递、中通快递、顺心捷达.
2.
快递鸟官网支持线上直接申请,申请途径:登录快递鸟官网—电子面单—申请新的物流服务商;ableNum{"EBusinessID":"1237100","Success":true,"Reason":"","ResultCode":"100","EorderBalance":{"AvailableNum":0,"TotalNum":0}}接口指令1107支持格式只支持Json格式、UTF-8编码接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/api/apiservice正式地址(加密):https://api.
kdniao.
com/api/apiservice快递鸟接口技术文档373.
电子面单客户号可通过快递鸟官网在线申请和联系网点线下申请两种方式,推荐线下直接联系当地网点申请.
3.
6.
4应用级参数名称类型(字符长度)是否必须描述SubscriptionIDString(30)O客户申请唯一标识ShipperCodeString(10)R快递公司编码StationCodeString(30)R网点编码StationNameString(30)R网点名称ApplyIDString(30)O申请ID(用户记录在快递公司的标识)CompanyString(30)O公司名称NameString(30)R联系人TelString(20)C电话MobileString(20)C手机ProvinceNameString(20)R省份ProivnceCodeString(20)O省份编码CityNameString(20)R城市CityCodeString(20)O城市编码ExpAreaNameString(20)R区县ExpAreaCodeString(20)O区县编码AddressString(100)R详细地址CardTypeIntC证件类型:1-身份证(ShipperCode为ZTO时必填)CardNoString(30)C证件号码(ShipperCode为ZTO时必填)请求示例:{"ShipperCode":"UC","Company":"快递鸟","ApplyID":"1237100",快递鸟接口技术文档383.
6.
5返回参数名称类型(字符长度)是否必须描述EbusinessIDString(10)R用户IDApplyCodeString(30)R客户编号SuccessBool(10)R成功与否(true/false)ResultCodeString(5)R返回编码ReasonString(50)O失败原因返回示例:"Name":"hoo123","Tel":"07558812345","Mobile":"15612344567","ProvinceName":"广东省","ProivnceCode":"440000","CityName":"深圳市","CityCode":"440300","ExpAreaName":"宝安区","ExpAreaCode":"440306","Address":"西乡1路","StationCode":"西乡网点","StationName":"西乡网点"}{"EBusinessID":"1237100","ApplyCode":"test123456""Success":true,"Reason":"提交申请成功","ResultCode":"100"}快递鸟接口技术文档393.
7客户号推送接口3.
7.
1功能说明此接口用于向客户推送快递公司审核通过的电子面单客户号信息.
3.
7.
2基本信息3.
7.
3接口规则推送时会推送RequestType、RequestData和DataSign三个参数(格式:RequestData={数据}&EBusinessID=1237100&PushTime=2017-04-1823:34:29&RequestType=1117)3.
7.
4支持情况目前支持快递公司:优速快递、韵达速递、圆通速递、百世快递、远成快运(YCWL)、安能快递、中通快递、佳吉快运、顺心捷达.
3.
7.
5应用级参数名称类型(字符长度)是否必须描述ApplyCodeString(30)R客户编号CustomerNameString(50)O电子面单客户号CustomerPwdString(30)O电子面单密码StationCodeString(30)O网点编码StationNameString(30)O网点名称SubscriptionIDString(30)O客户申请唯一标识SuccessBool(10)R成功与否(true/false)ResultCodeString(5)O返回编码ReasonString(50)O失败原因接口指令1117快递鸟接口技术文档40请求示例:3.
7.
6返回参数名称类型(字符长度)是否必须描述EBusinessIDStringR用户IDRequestTypeStringR接口指令SuccessBoolR成功(true)MessageStringO返回消息返回示例:3.
8实名寄递接口3.
8.
1功能说明此接口用于下单时向快递公司提交用户实名信息,实现用户实名寄件时免出示身份证的功能.
{"ApplyCode":"test123456","CustomerName":"80237910","CustomerPwd":"c0bfe0ba86b66bae5426303c53db0a8b","StationCode":"闵行八部","StationName":"闵行八部"}{"EBusinessID":"1237100","Message":"成功","RequestType":"1117","Success":true}快递鸟接口技术文档413.
8.
2基本信息3.
8.
3接口规则1.
请求报文中不允许出现以下特殊字符:2.
下单时通过校验"寄件人手机号"确认向快递公司提交的用户实名信息.
3.
一次实名终生使用.
3.
8.
4支持情况1.
支持同步实名信息的接口:预约取件接口、电子面单接口、轨迹订阅接口(包含收寄方信息).
2.
支持的快递公司:安能快递(ANE)、中通快递(ZTO)、韵达速递(YD)、德邦快递(DBL)、百世快递(HTKY)、优速快递(UC).
3.
支持的快递柜:丰巢快递柜(FCBOX).
3.
8.
5应用级参数接口指令1021支持格式只支持Json格式接口地址正式地址(不加密):http://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx正式地址(加密):https://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx名称类型(字符长度)是否必须描述MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户NameString(30)R发件人GenderInt(1)O性别1-男2-女TypeOfIdInt(1)R证件类型:1-身份证NumberOfIdStringR证件号快递鸟接口技术文档42请求示例:ContactArrayR联系方式,可提交多条[{"Mobile":"123","Phone":"123"},{"Mobile":"1223","Phone":"123"}]ProvinceString(20)R发件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)CityString(20)R发件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")AreaString(20)R发件区/县(如福田区,不要缺少"区"或"县")AddressString(100)R发件人详细地址CodeOfWeixinString(50)O微信号CollectMethodInt(1)R用户信息采集方式1-身份证件识别设备,2-NFC+SAM方式,3-OCR读取方式ImageFrontStringR身份证正面照(图片转成base64字符串)ImageBackStringR身份证反面照(图片转成base64字符串)ImageHandStringO手持身份证正面照(图片转成base64字符串){"MemberID":"","Name":"1234567","Gender":"2","TypeOfId":"1","NumberOfId":"420211199901011234","Contact":[{"Mobile":"13500000000","Phone":""},{"Mobile":"15817289472",快递鸟接口技术文档433.
8.
6返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDSuccessBool(10)R成功与否ReasonString(50)O失败原因返回示例:4轨迹查询类接口4.
1即时查询接口4.
1.
1功能说明此接口用于向快递公司实时查询物流轨迹信息.
"Phone":"07558651234"}],"Province":"广东省","City":"深圳市","Area":"福田区","Address":"金花路11号","CodeOfWeixin":"","CollectMethod":"3","ImageFront":"Base64Z","ImageBack":"Base64F","ImageHand":""}{"UpdateTime":"2018-02-0213:59:02","EBusinessID":"1261799","Success":true}快递鸟接口技术文档444.
1.
2基本信息4.
1.
3接口规则返回的物流轨迹信息按照发生时间的升序排列.
4.
1.
4支持情况1.
主流快递仅支持中通快递、申通快递、圆通速递3家,不支持EMS、邮政快递包裹、顺丰速运、韵达速递、京东快递、百世快递、天天快递;如需查询所有主流快递公司,请选用在途监控服务;4.
1.
5应用场景打单工具、查询工具、WEB端、APP移动端、小程序4.
1.
6应用级参数名称类型(字符长度)是否必须描述OrderCodeString(30)O订单编号ShipperCodeString(10)R快递公司编码详细编码参考《快递鸟接口支持快递公司编码.
xlsx》接口指令1002支持格式只支持Json格式批量请求不支持,并发不超过10次/S查询次数限制500次/天接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx正式地址(加密):https://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx快递鸟接口技术文档45LogisticCodeString(30)R快递单号CustomerNameString(50)CShipperCode为JD,必填,对应京东的青龙配送编码,也叫商家编码,格式:数字+字母+数字,9位数字加一个字母,共10位,举例:001K123450;ShipperCode为其他快递时,不填请求示例:4.
1.
7返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDOrderCodeString(30)O订单编号ShipperCodeString(10)R快递公司编码LogisticCodeString(30)R快递单号SuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因StateString(5)R物流状态:0-暂无轨迹信息1-已揽收ZTO请求示例:{"OrderCode":"","ShipperCode":"ZTO","LogisticCode":"638650888018",}JD请求示例:{"OrderCode":"","CustomerName":"001K12345","ShipperCode":"JD","LogisticCode":"VA00003618100",}快递鸟接口技术文档462-在途中3-签收4-问题件Traces.
AcceptTimeDateR轨迹发生时间Traces.
AcceptStationString(100)R轨迹描述返回示例:无物流轨迹:{"EBusinessID":"1237100","Traces":[],"State":"0","ShipperCode":"ZTO","LogisticCode":"638650888018","Success":true,"Reason":"暂无轨迹信息"}有物流轨迹:{"EBusinessID":"1237100","OrderCode":"","ShipperCode":"ZTO","LogisticCode":"638650888018","Success":true,"State":3,"Traces":[{"AcceptTime":"2014-06-2420:18:58","AcceptStation":"已收件[深圳市]",},{"AcceptTime":"2014-06-2420:55:28","AcceptStation":"快件在深圳,准备送往下一站深圳集散中心[深圳市]",},{"AcceptTime":"2014-06-2510:23:03",快递鸟接口技术文档474.
2物流跟踪物流跟踪由轨迹订阅接口和轨迹推送接口组成,对接时需要对接以下二个接口.
4.
2.
1轨迹订阅接口4.
2.
1.
1功能说明1.
此接口用于向快递鸟订阅物流轨迹信息.
2.
支持服务:预约取件.
4.
2.
1.
2基本信息4.
2.
1.
3接口规则1.
接口对订阅的数据不做判断和校验,不校验快递公司编码和单号是否匹配,不判断快递单号是否合法、是否正确、是否重复订阅.
"AcceptStation":"派件已签收[深圳市]",},{"AcceptTime":"2014-06-2510:23:03","AcceptStation":"签收人是:已签收[深圳市]",}]}接口指令1008支持格式只支持Json格式批量请求不支持,并发不超过30次/S查询次数限制订阅时只有快递公司编码、快递单号,限制100次/天订阅时带有收寄方全量信息,限制500次/天推送时效6至24小时内接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/api/dist正式地址(加密):https://api.
kdniao.
com/api/dist快递鸟接口技术文档482.
接口支持的消息接收方式为HTTPPOST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8".
3.
轨迹订阅接口只返回是否订阅成功的结果,不返回实际轨迹信息,需再开发轨迹推送接口用于接收快递鸟推送的轨迹数据.
4.
接口工作原理:用户将快递单号和订单信息向快递鸟订阅成功后,快递鸟向快递公司订阅轨迹,当轨迹有更新时,快递公司推送至快递鸟,快递鸟再同步推送至用户,直到运单签收.
4.
2.
1.
4支持情况1.
主流快递仅支持中通快递、申通快递、圆通速递3家,不支持EMS、邮政快递包裹、顺丰速运、韵达速递、京东快递、百世快递、天天快递;如需查询所有主流快递公司,请选用在途监控服务;4.
2.
1.
5应用场景电商平台、打单工具、查询工具、ERP系统、WEB端、APP移动端、小程序4.
2.
1.
6应用级参数名称类型(字符长度)是否必须描述CallbackString(50)O用户自定义回传字段MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户WareHouseIDString(30)O仓库标识(备用字段)ShipperCodeString(10)R快递公司编码详细编码参考《快递鸟接口支持快递公司编码.
xlsx》LogisticCodeString(30)R快递单号CustomerNameString(50)CShipperCode为JD,必填,对应京东的青龙配送编码,也叫商家编码,格式:数字快递鸟接口技术文档49+字母+数字,9位数字加一个字母,共10位,举例:001K123450;ShipperCode为其他快递时,不填OrderCodeString(30)O订单编号MonthCodeString(20)O月结编号PayTypeInt(1)O运费支付方式:1-现付,2-到付,3-月结,4-第三方付(仅SF、KYSY支持)ExpTypeString(2)O详细快递类型参考《快递公司快递业务类型.
xlsx》CostDouble(5)O快递运费OtherCostDouble(5)O其他费用Receiver.
CompanyString(30)O收件人公司Receiver.
NameString(30)R收件人Receiver.
TelString(20)R电话与手机,必填一个Receiver.
MobileString(20)Receiver.
PostCodeString(10)C收件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)Receiver.
ProvinceNameString(20)R收件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Receiver.
CityNameString(20)R收件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")Receiver.
ExpAreaNameString(20)R收件区/县(如福田区,不要缺少"区"或"县")Receiver.
AddressString(100)R收件人详细地址Sender.
CompanyString(30)O发件人公司Sender.
NameString(30)R发件人Sender.
TelString(20)R电话与手机,必填一个快递鸟接口技术文档50Sender.
MobileString(20)Sender.
PostCodeString(10)C发件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)Sender.
ProvinceNameString(20)R发件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Sender.
CityNameString(20)R发件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")Sender.
ExpAreaNameString(20)R发件区/县(如福田区,不要缺少"区"或"县")Sender.
AddressString(100)R发件人详细地址IsNoticeInt(1)O是否通知快递员上门揽件0-通知,1-不通知,不填则默认为1StartDateDateO上门揽件时间段,格式:YYYY-MM-DDHH24:MM:SSEndDateWeightDouble(10,3)O包裹总重量kgQuantityInt(2)O包裹数,一个包裹对应一个运单号,如果是大于1个包裹,返回则按照子母件的方式返回母运单号和子运单号VolumeDouble(20,3)O包裹总体积m3RemarkString(60)O备注IsSendMessageInt(1)O是否订阅短信:0-不需要,1-需要AddService.
NameString(20)O增值服务名称AddService.
ValueString(30)O增值服务值AddService.
CustomerIDString(30)O客户标识Commodity.
GoodsNameString(100)O商品名称Commodity.
GoodsCodeString(20)O商品编码Commodity.
GoodsquantityInt(5)O商品件数快递鸟接口技术文档51Commodity.
GoodsPriceDouble(10)O商品价格Commodity.
GoodsWeightDouble(10,3)O商品重量kgCommodity.
GoodsDescString(50)O商品描述Commodity.
GoodsVolDouble(15,3)O商品体积m3请求示例:ZTO请求示例:{"ShipperCode":"ZTO","OrderCode":"","LogisticCode":"3100707578976","PayType":"1","ExpType":"1","CustomerName":"","CustomerPwd":"","MonthCode":"","IsNotice":"0","Sender":{"Name":"1255760","Tel":"","Mobile":"13700000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Address":"测试地址"},"Receiver":{"Name":"1255760","Tel":"","Mobile":"13800000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"龙华新区","Address":"测试地址2"},"Commodity":[{快递鸟接口技术文档52"GoodsName":"书本"}]}JD请求示例:{"ShipperCode":"JD","OrderCode":"","CustomerName":"001K12345","LogisticCode":"VA00003618100","PayType":"1","ExpType":"1","CustomerName":"","CustomerPwd":"","MonthCode":"","IsNotice":"0","Sender":{"Name":"1255760","Tel":"","Mobile":"13700000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Address":"测试地址"},"Receiver":{"Name":"1255760","Tel":"","Mobile":"13800000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"龙华新区","Address":"测试地址2"},"Commodity":[{"GoodsName":"书本"快递鸟接口技术文档534.
2.
1.
7返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDUpdateTimeDateR更新时间YYYY-MM-DDHH24:MM:SSSuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因EstimatedDeliveryTimeDateO订单预计到货时间(暂未上线)返回示例:4.
2.
2轨迹推送接口4.
2.
2.
1功能说明此接口用于用户接收快递鸟推送的物流轨迹信息.
4.
2.
2.
2基本信息}]}{"EBusinessID":"1237100","UpdateTime":"2016-08-0916:42:38","Success":true,"Reason":""}接口指令101/102支持格式只支持Json格式请求方式POST请求推送方式每次全量推送,一次最多推送10单快递鸟接口技术文档544.
2.
2.
3接口规则1.
返回的物流轨迹信息按照发生时间的升序排列.
2.
轨迹推送是异步推送的,系统拉取到轨迹后调用用户推送接口推送轨迹数据.
3.
若Data接收到推送Success为false,且Reason为三天无轨迹,需重新发起订阅.
4.
若Data接收到推送Success为false,且Reason为七天内无轨迹变化,需重新发起订阅.
5.
若Data接收到推送Success为false,且State为0,属于正常推送,需耐心等待下次推送即可.
6.
在没有返回信息或者返回不符合规定的情况下,会判断为推送失败.
推送失败后会重试推送2次,首次间隔15分钟,二次间隔半个小时,两次都失败就不会再推送,直到下次有轨迹更新才会再次推送,建议您严格按照技术文档进行返回.
4.
2.
2.
4接口要求1.
客户服务器必须稳定,并且有一定的接受数据能力,快递鸟通过多线程推送物流信息给客户.
2.
客户需按快递鸟要求开发接口,保证信息的正常接收.
必须在5S内对快递鸟请求做出响应(数据存储后马上返回响应结果,然后再处理数据),响应结果按接口格式要求返回.
3.
客户需提供接收地址(回调地址),登陆快递鸟官网http://www.
kdniao.
com/UserCenter/v2/SandBox/PushQueryParam.
aspx完成配置(沙箱调试后台测试通过后,点击右上角的配置按钮,配置保存后会自动同步到正式环境).
4.
2.
2.
5应用级参数轨迹订阅接口(1008)返回结果(RequestType:101)通过轨迹订阅接口订阅的数据,快递鸟推送时RequestType的值为101,同时返回以下数据:名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDPushTimeDateR推送时间CountString(2)R推送轨迹的快递单号个数DataStringR推送轨迹的轨迹数据集合Data.
EBusinessIDString(10)R用户IDData.
ShipperCodeString(10)R快递公司编码Data.
LogisticCodeString(30)R快递单号Data.
SuccessBool(10)R成功与否(true/false)快递鸟接口技术文档55Data.
ReasonString(50)O失败原因Data.
OrderCodeString(30)O订单编号Data.
StateString(5)R物流状态:0-暂无轨迹信息1-已揽收2-在途中3-签收4-问题件Data.
CallbackString(50)O用户自定义回传字段Data.
EstimatedDeliveryTimeDateO预计到达时间(暂未上线)Data.
Traces.
AcceptTimeDateR轨迹发生时间Data.
Traces.
AcceptStationString(100)R轨迹描述Data.
Traces.
RemarkString(60)O备注请求示例:{"EBusinessID":"1237100","Count":"2","PushTime":"2015-03-1116:21:06","Data":[{"EBusinessID":"1237100","ShipperCode":"EMS","LogisticCode":"5042260908504","Success":true,"Reason":"","State":"2","CallBack":"0","OrderCode":"0","Traces":[{"AcceptTime":"2016-10-2618:31:38","AcceptStation":"【北京环铁站】的【互优图书】已收件",},{快递鸟接口技术文档56"AcceptTime":"2016-10-2619:53:50","AcceptStation":"快件在【北京环铁站】装车,正发往【北京分拨中心】",},{"AcceptTime":"2016-10-2621:00:13","AcceptStation":"快件到达【北京分拨中心】,上一站是【北京环铁站】",},{"AcceptTime":"2016-10-2621:06:27","AcceptStation":"快件在【北京分拨中心】装车,正发往【青州分拨中心】",},]},{"EBusinessID":"1237100","ShipperCode":"EMS","LogisticCode":"5042260908504","Success":true,"Reason":"","State":"2","CallBack":"0","OrderCode":"0","Traces":[{"AcceptTime":"2016-10-2618:31:38","AcceptStation":"【北京环铁站】的【互优图书】已收件",},{"AcceptTime":"2016-10-2619:53:50","AcceptStation":"快件在【北京环铁站】装车,正发往【北京分拨中心】",},{"AcceptTime":"2016-10-2621:00:13","AcceptStation":"快件到达【北京分拨中心】,上一站是【北京环铁站】",},{"AcceptTime":"2016-10-2621:06:27",快递鸟接口技术文档57"AcceptStation":"快件在【北京分拨中心】装车,正发往【青州分拨中心】",},{"AcceptTime":"2016-10-2711:04:43","AcceptStation":"快件到达【北京分拨中心】,上一站是【】",},]}]}轨迹订阅接口(8008增值版)返回结果(RequestType:102)通过轨迹订阅接口订阅的数据,快递鸟推送时RequestType的值为102,同时返回以下数据:名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDPushTimeDateR推送时间CountString(2)R推送轨迹的快递单号个数DataStringR推送轨迹的轨迹数据集合Data.
EBusinessIDString(10)R用户IDData.
ShipperCodeString(10)R快递公司编码Data.
LogisticCodeString(30)R快递单号Data.
SuccessBool(10)R成功与否(true/false)Data.
ReasonString(50)O失败原因Data.
OrderCodeString(30)O订单编号Data.
StateString(5)R物流状态:0-暂无轨迹信息1-已揽收2-在途中3-签收4-问题件Data.
StateExString(5)R增值物流状态:0-暂无轨迹信息1-已揽收2-在途中201-到达派件城市快递鸟接口技术文档58202-派件中211-已放入快递柜或驿站3-已签收301-正常签收302-派件异常后最终签收304-代收签收311-快递柜或驿站签收4-问题件401-发货无信息402-超时未签收403-超时未更新404-拒收(退件)405-派件异常406-退货签收407-退货未签收412-快递柜或驿站超时未取Data.
LocationString(20)R所在城市Data.
CallbackString(50)O用户自定义回传字段Data.
EstimatedDeliveryTimeDateO预计到达时间(暂未上线)Data.
Traces.
AcceptTimeDateR轨迹发生时间Data.
Traces.
AcceptStationString(100)R轨迹描述Data.
Traces.
LocationString(20)R当前城市Data.
Traces.
ActionString(50)R当前状态(同StateEx)Data.
Traces.
RemarkString(60)O备注请求示例:{"EBusinessID":"1237100","Count":"2","PushTime":"2015-03-1116:21:06","Data":[{"EBusinessID":"1237100","ShipperCode":"EMS","LogisticCode":"5042260908504",快递鸟接口技术文档59"Success":true,"Reason":"","State":"2","StateEx":"2","CallBack":"0","OrderCode":"0","Traces":[{"AcceptTime":"2016-10-2618:31:38","AcceptStation":"【北京环铁站】的【互优图书】已收件","Location":"北京市","Action":"1"},{"AcceptTime":"2016-10-2619:53:50","AcceptStation":"快件在【北京环铁站】装车,正发往【北京分拨中心】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2621:00:13","AcceptStation":"快件到达【北京分拨中心】,上一站是【北京环铁站】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2621:06:27","AcceptStation":"快件在【北京分拨中心】装车,正发往【青州分拨中心】","Location":"北京市","Action":"2"},]},{"EBusinessID":"1237100","ShipperCode":"EMS","LogisticCode":"5042260908504",快递鸟接口技术文档60"Success":true,"Reason":"","State":"2","StateEx":"2","CallBack":"0","OrderCode":"0","Traces":[{"AcceptTime":"2016-10-2618:31:38","AcceptStation":"【北京环铁站】的【互优图书】已收件","Location":"北京市","Action":"1"},{"AcceptTime":"2016-10-2619:53:50","AcceptStation":"快件在【北京环铁站】装车,正发往【北京分拨中心】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2621:00:13","AcceptStation":"快件到达【北京分拨中心】,上一站是【北京环铁站】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2621:06:27","AcceptStation":"快件在【北京分拨中心】装车,正发往【青州分拨中心】","Location":"北京市","Action":"2"},]},4.
2.
2.
6返回参数名称类型(字符长度)是否必须描述快递鸟接口技术文档61EBusinessIDString(10)R用户IDUpdateTimeDateR更新时间SuccessBool(10)R成功(true)ReasonString(50)O失败原因返回示例:{"EBusinessID":"1237100","UpdateTime":"2015-03-1116:26:11","Success":true,"Reason":""}4.
3单号识别接口4.
3.
1功能说明此接口用于识别快递单号所属快递公司.
4.
3.
2基本信息4.
3.
3接口规则1.
接口只对快递单号进行识别,返回可能属于的一家或多家快递公司,可能性最高的排名接口指令2002支持格式只支持Json格式、utf-8编码请求方式POST请求查询次数限制30000次/天接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx正式地址(加密):https://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx快递鸟接口技术文档62靠前,实际归属哪家快递公司仍需用户判断.
2.
识别失败,接口返回为空.
3.
快递公司新上线的号段首次会识别失败;进行轨迹订阅并拉取到轨迹后,单号识别接口学习机制会完善此类单号的识别.
4.
3.
4应用场景电商平台、打单工具、ERP系统、WEB端、APP移动端、小程序4.
3.
5应用级参数名称类型(字符长度)是否必须描述LogisticCodeString(30)R快递单号请求示例:{"LogisticCode":"3967950525457"}4.
3.
6返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDLogisticCodeString(30)R快递单号SuccessBool(10)R成功与否(true/false)Codeint(50)O失败原因Shippers.
ShipperCodeString(10)O快递公司编码Shippers.
ShipperNameString(30)O快递公司名称返回示例:{"EBusinessID":"1237100","Success":true,"LogisticCode":"3967950525457",快递鸟接口技术文档63"Shippers":[{"ShipperCode":"YD","ShipperName":"韵达速递"},{"ShipperCode":"YTO","ShipperName":"圆通速递"}]}5增值类接口5.
1在途监控在途监控包含即时查询(增值版)和物流跟踪(增值版),相比普通版,增值版返回报文中增加如下几个参数:1.
增加增值物流状态StateEx和所在城市Location;2.
物流轨迹中增加当前城市Location和当前状态Action.
5.
1.
1即时查询接口(增值版)5.
1.
1.
1功能说明此接口用于向快递公司实时查询物流轨迹信息.
5.
1.
1.
2基本信息接口指令8001支持格式只支持Json格式批量请求不支持,并发不超过10次/S查询次数限制一个自然月内一个单号不限查询次数接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):快递鸟接口技术文档645.
1.
1.
3接口规则1.
返回的物流轨迹信息按照发生时间的升序排列.
2.
快递鸟会员套餐(付费版)自开通当日起一个月(30天)内,免费即时查询接口(RequestType为1002)仍可继续请求测试使用,一个月后将关闭测试权限,会员用户(付费版会员套餐)需调用在途监控接口(RequestType为8001).
5.
1.
1.
4支持情况1.
主流快递公司均支持;2.
顺丰速运:通过快递鸟预约取件接口/电子面单接口返回的顺丰单号,发货后方可查询;其他渠道的顺丰单号,必须通过CustomerName传值正确的收件人/寄件人的手机号码后四位方可查询;3.
京东快递:查询时,必须传商家编码(由发货方提供),且快递单号必须是通过该商家编码下单获取的方可查询.
5.
1.
1.
5应用场景打单工具、查询工具、WEB端、APP移动端、小程序5.
1.
1.
6应用级参数名称类型(字符长度)是否必须描述OrderCodeString(30)O订单编号CustomerNameString(50)CShipperCode为JD,必填,对应京东的青龙配送编码,也叫商家编码,格式:数字+字母+数字,9位数字加一个字母,共10位,举例:001K123450;ShipperCode为SF,且快递单号非快递鸟渠道返回时,必填,对应收件人/寄件人手机号后四位;ShipperCode为SF,且快递单号为快递鸟渠道返回时,不填;ShipperCode为其他快递时,不填ShipperCodeString(10)R快递公司编码详细编码参考《快递鸟接口支持快递公司http://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx正式地址(加密):https://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx快递鸟接口技术文档65编码.
xlsx》LogisticCodeString(30)R快递单号请求示例:5.
1.
1.
7返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDOrderCodeString(30)O订单编号ShipperCodeString(10)R快递公司编码LogisticCodeString(30)R快递单号CallbackString(50)O用户自定义回传字段SuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因StateString(5)R物流状态:0-暂无轨迹信息1-已揽收2-在途中3-签收4-问题件StateExString(5)R增值物流状态:0-暂无轨迹信息1-已揽收ZTO请求示例:{"OrderCode":"","ShipperCode":"ZTO","LogisticCode":"638650888018",}JD请求示例:{"OrderCode":"","CustomerName":"001K12345","ShipperCode":"JD","LogisticCode":"VA00003618100",}快递鸟接口技术文档662-在途中201-到达派件城市202-派件中211-已放入快递柜或驿站3-已签收301-正常签收302-派件异常后最终签收304-代收签收311-快递柜或驿站签收4-问题件401-发货无信息402-超时未签收403-超时未更新404-拒收(退件)405-派件异常406-退货签收407-退货未签收412-快递柜或驿站超时未取LocationString(20)R所在城市Traces.
AcceptTimeDateR轨迹发生时间Traces.
AcceptStationString(100)R轨迹描述Traces.
LocationString(20)R当前城市Traces.
ActionString(50)R当前状态(同StateEx)Traces.
RemarkString(60)O备注返回示例:{"EBusinessID":"1237100","ShipperCode":"YD","Success":true,"LogisticCode":"390141793061","State":"3","StateEx":"3","Location":"威海市","Traces":[{"AcceptTime":"2016-10-2618:31:38","AcceptStation":"【北京环铁站】的【互优图书】已收件",快递鸟接口技术文档67"Location":"北京市","Action":"1"},{"AcceptTime":"2016-10-2619:53:50","AcceptStation":"快件在【北京环铁站】装车,正发往【北京分拨中心】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2621:00:13","AcceptStation":"快件到达【北京分拨中心】,上一站是【北京环铁站】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2621:06:27","AcceptStation":"快件在【北京分拨中心】装车,正发往【青州分拨中心】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2711:04:43","AcceptStation":"快件到达【北京分拨中心】,上一站是【】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2713:04:43","AcceptStation":"快件在【北京分拨中心】装车,正发往【青州分拨中心】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2720:06:03","AcceptStation":"快件到达【青州分拨中心】,上一站是【】","Location":"潍坊市","Action":"2"快递鸟接口技术文档685.
1.
2物流跟踪接口(增值版)物流跟踪由轨迹订阅接口和轨迹推送接口组成,接入时需要对接二个接口.
},{"AcceptTime":"2016-10-2722:06:03","AcceptStation":"快件在【青州分拨中心】装车,正发往【威海】","Location":"潍坊市","Action":"2"},{"AcceptTime":"2016-10-2809:53:53","AcceptStation":"快件到达【威海】,上一站是【青州分拨中心】","Location":"威海市","Action":"2"},{"AcceptTime":"2016-10-2810:44:39","AcceptStation":"快件到达【威海】,上一站是【青州分拨中心】","Location":"威海市","Action":"2"},{"AcceptTime":"2016-10-2810:48:03","AcceptStation":"【威海】的【王奕凯】正在派件","Location":"威海市","Action":"202"},{"AcceptTime":"2016-10-2818:09:45","AcceptStation":"已签收,签收人是【毕森】,签收网点是【威海】","Location":"威海市","Action":"3"}]}快递鸟接口技术文档695.
1.
2.
1轨迹订阅接口5.
1.
2.
1.
1功能说明1.
此接口用于向快递鸟订阅物流轨迹信息.
2.
支持服务:预约取件.
5.
1.
2.
1.
2基本信息5.
1.
2.
1.
3接口规则1.
接口对订阅的数据不做判断和校验,不校验快递公司编码和单号是否匹配,不判断快递单号是否合法、是否正确、是否重复订阅.
2.
轨迹订阅接口只返回是否订阅成功,不会返回轨迹信息,需开发轨迹推送接口用于接收快递鸟推送的轨迹数据.
3.
快递鸟会员套餐(付费版)自开通当日起一个月(30天)内,免费物流跟踪接口(RequestType为1008)仍可继续请求测试使用,一个月后将关闭测试权限,会员用户(付费版会员套餐)需调用在途监控接口(RequestType为8008).
4.
接口工作原理:用户将快递单号和订单信息向快递鸟订阅成功后,快递鸟向快递公司注册轨迹,当轨迹有更新时,快递公司推送至快递鸟,快递鸟再同步推送至用户,直到运单签收.
5.
1.
2.
1.
4支持情况1.
主流快递公司均支持;接口指令8008支持格式只支持Json格式批量请求不支持,并发不超过30次/S查询次数限制一个自然月内一个单号不限查询次数推送时效0.
5至4小时内接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/api/dist正式地址(加密):https://api.
kdniao.
com/api/dist快递鸟接口技术文档702.
顺丰速运:通过快递鸟预约取件接口/电子面单接口返回的顺丰单号,发货后方可查询;其他渠道的顺丰单号,必须通过CustomerName传值正确的收件人/寄件人的手机号码后四位方可查询;3.
京东快递:订阅时,必须传商家编码(由发货方提供),且快递单号必须是通过该商家编码下单获取的方可查询.
5.
1.
2.
1.
5应用场景电商平台、打单工具、查询工具、ERP系统、WEB端、APP移动端、小程序5.
1.
2.
1.
6应用级参数名称类型(字符长度)是否必须描述CallbackString(50)O用户自定义回传字段MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户WareHouseIDString(30)O仓库标识(备用字段)CustomerNameString(50)CShipperCode为JD,必填,对应京东的青龙配送编码,也叫商家编码,格式:数字+字母+数字,9位数字加一个字母,共10位,举例:001K123450;ShipperCode为SF,且快递单号非快递鸟渠道返回时,必填,对应收件人/寄件人手机号后四位;ShipperCode为SF,且快递单号为快递鸟渠道返回时,不填;ShipperCode为其他快递时,不填ShipperCodeString(10)R快递公司编码详细编码参考《快递鸟接口支持快递公司编码.
xlsx》LogisticCodeString(30)R快递单号OrderCodeString(30)O订单编号快递鸟接口技术文档71MonthCodeString(20)O月结编号PayTypeInt(1)O运费支付方式:1-现付,2-到付,3-月结,4-第三方付(仅SF、KYSY支持)ExpTypeString(2)O详细快递类型参考《快递公司快递业务类型.
xlsx》CostDouble(5)O快递运费OtherCostDouble(5)O其他费用Receiver.
CompanyString(30)O收件人公司Receiver.
NameString(30)R收件人Receiver.
TelString(20)R电话与手机,必填一个Receiver.
MobileString(20)Receiver.
PostCodeString(10)C收件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)Receiver.
ProvinceNameString(20)R收件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Receiver.
CityNameString(20)R收件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")Receiver.
ExpAreaNameString(20)R收件区/县(如福田区,不要缺少"区"或"县")Receiver.
AddressString(100)R收件人详细地址Sender.
CompanyString(30)O发件人公司Sender.
NameString(30)R发件人Sender.
TelString(20)R电话与手机,必填一个Sender.
MobileString(20)Sender.
PostCodeString(10)C发件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)Sender.
ProvinceNameString(20)R发件省(如广东省,不要缺少"省";快递鸟接口技术文档72如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Sender.
CityNameString(20)R发件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")Sender.
ExpAreaNameString(20)R发件区/县(如福田区,不要缺少"区"或"县")Sender.
AddressString(100)R发件人详细地址IsNoticeInt(1)O是否通知快递员上门揽件0-通知,1-不通知,不填则默认为1StartDateDateO上门揽件时间段,格式:YYYY-MM-DDHH24:MM:SSEndDateWeightDouble(10,3)O包裹总重量kgQuantityInt(2)O包裹数,一个包裹对应一个运单号,如果是大于1个包裹,返回则按照子母件的方式返回母运单号和子运单号VolumeDouble(20,3)O包裹总体积m3RemarkString(60)O备注IsSendMessageInt(1)O是否订阅短信:0-不需要,1-需要AddService.
NameString(20)O增值服务名称AddService.
ValueString(30)O增值服务值AddService.
CustomerIDString(30)O客户标识Commodity.
GoodsNameString(100)O商品名称Commodity.
GoodsCodeString(20)O商品编码Commodity.
GoodsquantityInt(5)O商品件数Commodity.
GoodsPriceDouble(10)O商品价格Commodity.
GoodsWeightDouble(10,3)O商品重量kgCommodity.
GoodsDescString(50)O商品描述Commodity.
GoodsVolDouble(15,3)O商品体积m3快递鸟接口技术文档73请求示例:YD请求示例:{"ShipperCode":"YD","OrderCode":"","LogisticCode":"3100707578976","PayType":"1","ExpType":"1","CustomerName":"","CustomerPwd":"","MonthCode":"","IsNotice":"0","Sender":{"Name":"1255760","Tel":"","Mobile":"13700000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Address":"测试地址"},"Receiver":{"Name":"1255760","Tel":"","Mobile":"13800000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"龙华新区","Address":"测试地址2"},"Commodity":[{"GoodsName":"书本"}]}快递鸟接口技术文档745.
1.
2.
1.
7返回参数名称类型(字符长度)是否必须描述JD请求示例:{"ShipperCode":"JD","OrderCode":"","CustomerName":"001K12345","LogisticCode":"VA00003618100","PayType":"1","ExpType":"1","CustomerName":"","CustomerPwd":"","MonthCode":"","IsNotice":"0","Sender":{"Name":"1255760","Tel":"","Mobile":"13700000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Address":"测试地址"},"Receiver":{"Name":"1255760","Tel":"","Mobile":"13800000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"龙华新区","Address":"测试地址2"},"Commodity":[{"GoodsName":"书本"}]快递鸟接口技术文档75EBusinessIDString(10)R用户IDUpdateTimeDateR更新时间YYYY-MM-DDHH24:MM:SSSuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因EstimatedDeliveryTimeDateO订单预计到货时间(暂未上线)返回示例:5.
1.
2.
2轨迹推送接口参照4.
2.
3轨迹推送接口5.
2智选物流5.
2.
1运费模板导入接口5.
2.
1.
1功能说明此接口用于向快递鸟传入协议快递公司的运费数据.
5.
2.
1.
2基本信息{"EBusinessID":"1237100","UpdateTime":"2016-08-0916:42:38","Success":true,"Reason":""}接口指令2004支持格式只支持Json格式、UTF-8编码请求方式POST请求接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx快递鸟接口技术文档765.
2.
1.
3接口规则1.
若用户的协议价格发生变化(新增、修改或删除),用户需将运费全量数据同步至快递鸟,快递鸟将对运费数据进行全量更新.
2.
MemberID和WarehouseID二个字段的传值必须与智选物流接口中的保持一致,可不传值,若传值则必须一致,否则影响计算结果.
5.
2.
1.
4应用级参数名称类型(字符长度)是否必须描述MemberIDString(50)RERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户WarehouseIDString(50)O仓库ID(备用字段)Detail.
ShipperCodeString(10)R快递公司编码Detail.
ExpenseTemplateString(50)O运费模板名称Detail.
SendProvinceString(20)R发件省Detail.
SendCityString(20)O发件市Detail.
SendExpAreaString(20)O发件区Detail.
ReceiveProvinceString(20)R收件省Detail.
ReceiveCityString(20)O收件市Detail.
ReceiveExpAreaString(20)O收件区Detail.
ShippingTypeInt(1)R运费类型0-首续计费1-区间计费2-重量公式Detail.
FirstWeightDouble(10)C首重(KG)(Detail.
ShippingType为0时必填)Detail.
FirstFeeDouble(10)首重价格(Detail.
ShippingType为0时必填)正式地址(加密):https://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx快递鸟接口技术文档77Detail.
AdditionalWeightDouble(10)续重(KG)(Detail.
ShippingType为0时必填)Detail.
AdditionalFeeDouble(10)续重价格(Detail.
ShippingType为0时必填)Detail.
IntervalList.
StartWeightDouble(10)C开始重量(KG)(Detail.
ShippingType为1时必填)Detail.
IntervalList.
EndWeightDouble(10)结束重量(KG)(Detail.
ShippingType为1时必填)Detail.
IntervalList.
FeeDouble(10)费用(元)(Detail.
ShippingType为1时必填)Detail.
WeightFormulaString(200)C重量公式(有重量计算公式的默认使用公式进行计算,用户可使用W代替重量,使用{[()]}大中小括号进行公式的计算,如:{{w-0}-0.
4}*{{{1000-w}-0.
4}+1}*4.
700+{{w-1000}-0.
6}*[(w-1000)/1000]*4.
700)请求示例:{"MemberID":"123456","WarehouseID":"123456","Detail":[{"ShipperCode":"SF","ExpenseTemplate":"次日达","SendProvince":"广东","SendCity":"广州","SendExpArea":"天河",快递鸟接口技术文档78"ReceiveProvince":"广东","ReceiveCity":"深圳","ReceiveExpArea":"龙岗","ShippingType":0"FirstWeight":"1","FirstFee":"8","AdditionalWeight":"1","AdditionalFee":"10","WeightFormula":""},{"ShipperCode":"YD","ExpenseTemplate":"","SendProvince":"广东","SendCity":"广州","SendExpArea":"天河","ReceiveProvince":"湖南","ReceiveCity":"长沙","ReceiveExpArea":"雨花","ShippingType":0"FirstWeight":"","FirstFee":"","AdditionalWeight":"","AdditionalFee":"","WeightFormula":"{{w-0}-0.
4}*{{{1000-w}-0.
4}+1}*4.
700+{{w-1000}-0.
6}*[(w-1000)/1000]*4.
700"}]}5.
2.
1.
5返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDMemberIDString(50)RERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户快递鸟接口技术文档79SuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因返回示例:{"EBusinessID":"1237100","Success":true,"MemberID":"123456"}5.
2.
2智选物流接口5.
2.
2.
1功能说明此接口用于快递鸟向用户智能推荐快递公司.
5.
2.
2.
2基本信息5.
2.
2.
3接口规则MemberID和WarehouseID二个字段的传值必须与运费模板导入接口的传值保持一致,可不传值,若传值则必须一致,否则影响计算结果.
5.
2.
2.
4应用级参数名称类型(字符长度)是否必须描述MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户接口指令2006支持格式只支持Json格式、UTF-8编码请求方式POST请求接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/api/exrecommend正式地址(加密):https://api.
kdniao.
com/api/exrecommend快递鸟接口技术文档80WarehouseIDString(50)O仓库IDDetail.
OrderCodeString(30)R订单编号(自定义,不可重复)Detail.
OriginalExpCodeString(10)O原使用快递公司编码Detail.
EstimatedShipTimeDateO预计发货时间,格式:YYYY-MM-DDHH24:MM:SSDetail.
Receiver.
ProvinceNameString(20)R收件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Detail.
Receiver.
CityNameString(20)R收件市(如深圳市,不要缺少"市")Detail.
Receiver.
ExpAreaNameString(20)R收件区(如福田区,不要缺少"区"或"县")Detail.
Receiver.
SubdistrictString(50)O收件街道(如华强北街道)Detail.
Receiver.
AddressString(100)R收件人详细地址Detail.
Sender.
ProvinceNameString(20)R发件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Detail.
Sender.
CityNameString(20)R发件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")Detail.
Sender.
ExpAreaNameString(20)R发件区(如福田区,不要缺少"区"或"县")Detail.
Sender.
SubdistrictString(50)O发件街道(如华强北街道)Detail.
Sender.
AddressString(100)R发件人详细地址Detail.
IsCODInt(1)R是否代收货款:0.
否,1.
是Detail.
ExpressList.
ExpCodeString(10)R快递公司编码Detail.
ExpressList.
FirstWeightDouble(10)O首重(KG)Detail.
ExpressList.
FirstDouble(10)O首重价格(元)Detail.
ExpressList.
AdditionalWeightDouble(10)O续重(KG)Detail.
ExpressList.
AdditionalDouble(10)O续重价格(元)Detail.
ExpressList.
WeightFormulaString(200)O重量公式【+号使用@替换】(有重量计算公式的默认使用公式快递鸟接口技术文档81进行计算,用户可使用W代替重量,使用{[()]}大中小括号进行公式的计算,如:{{w-0}-0.
4}*{{{1000-w}-0.
4}+1}*4.
700+{{w-1000}-0.
6}*[(w-1000)/1000]*4.
700)Detail.
Goods.
ProductNameString(100)R商品名称Detail.
Goods.
VolumeDouble(20)O商品体积m3Detail.
Goods.
WeightDouble(10)O商品重量kgDetail.
NonuseExpressstring(100)O不使用的物流公司列表(格式为:快递公司编码1,快递公司编码2)Detail.
BuyerRemarkString(100)O买家留言Detail.
CustomerRemarkString(100)O客服备注Detail.
EnableAirlinesInt(1)O是否航空禁运:0.
否,1.
是请求示例:{"MemberID":"123456","WarehouseID":"1","Detail":[{"OrderCode":"12345","OriginalExpCode":"SF","EstimatedShipTime":"2017-02-1612:13:12""IsCOD":0,"Sender":{"ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Subdistrict":"福保街道","Address":"保税区金花路29号"},"Receiver":{"ProvinceName":"广东省","CityName":"深圳市",快递鸟接口技术文档82"ExpAreaName":"福田区","Subdistrict":"福保街道","Address":"保税区金花路29号"},"Goods":[{"ProductName":"包","Volume":"","Weight":"1"}]},{"OrderCode":"12346","IsCOD":0,"Sender":{"ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Subdistrict":"福保街道","Address":"保税区金花路29号"},"Receiver":{"ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Subdistrict":"福保街道","Address":"保税区金花路29号"},"Goods":[{"ProductName":"包","Volume":"","Weight":"1"}]}]快递鸟接口技术文档83}5.
2.
2.
5返回参数名称类型(字符长度)是否必须描述RecommendDetail.
OrderCodeString(30)R订单编号RecommendDetail.
ExpressList.
ExpCodeString(10)R快递公司编码RecommendDetail.
ExpressList.
ExpNameString(50)R快递公司名称RecommendDetail.
ExpressList.
ExpenseTemplateString(50)R运费模板名称RecommendDetail.
ExpressList.
RecommendReasonInt(1)R0-综合1-最便宜2-最快3-备选RecommendDetail.
ExpressList.
IsSupportInt(1)R是否在派送范围0-不在,1-在RecommendDetail.
ExpressList.
FeeDouble(10)O总运费(元)RecommendDetail.
ExpressList.
EstimatedDeliveryTimeDouble(10)O时效(预计到达时长:小时)RecommendDetail.
ExpressList.
SpecificDeliveryTimeDateO到达时间YYYY-MM-DDHH24:MMRecommendDetail.
ExpressList.
ShipperTemplateString(10)O快递类型RecommendDetail.
ExpressList.
RemarkString(60)O备注返回示例:{"EBusinessID":"1237100","Success":true,"RecommendDetail":[{"ExpressList":[{快递鸟接口技术文档84"ExpCode":"ZTO","ExpName":"中通快递","LineName":"","Fee":10.
00,"EstimatedDeliveryTime":44.
20,"SpecificDeliveryTime":"2017-02-1209:12","IsSupport":"1","RecommendReason":0,"Remark":""},{"ExpCode":"ZTO","ExpName":"中通快递","LineName":"","Fee":10.
00,"EstimatedDeliveryTime":44.
20,"IsSupport":"1","RecommendReason":1,"Remark":""},{"ExpCode":"JYM","ExpName":"加运美","SpecificDeliveryTime":"2017-02-1209:12","LineName":"","EstimatedDeliveryTime":15.
23,"IsSupport":"1","RecommendReason":2,"Remark":""}],"OrderCode":"12345"},{"ExpressList":[{"ExpCode":"ZTO","ExpName":"中通快递",快递鸟接口技术文档85"SpecificDeliveryTime":"2017-02-1209:12","LineName":"","Fee":16.
00,"EstimatedDeliveryTime":48.
26,"IsSupport":"1","RecommendReason":0,"Remark":""},{"ExpCode":"ZTO","ExpName":"中通快递","SpecificDeliveryTime":"2017-02-1209:12","LineName":"","Fee":16.
00,"EstimatedDeliveryTime":48.
26,"IsSupport":"1","RecommendReason":1,"Remark":""},{"ExpCode":"SF","ExpName":"顺丰速运","LineName":"","EstimatedDeliveryTime":38.
33,"IsSupport":"1","RecommendReason":2,"Remark":""}],"OrderCode":"12346"}]}5.
3短信服务通过电子面单接口、轨迹订阅接口、短信发送接口要求订阅短信的,可以触发短信服务.
快递鸟接口技术文档865.
3.
1短信模板接口5.
3.
1.
1功能说明此接口用于发送短信前事先设置短信模板和发送规则.
5.
3.
1.
2基本信息5.
3.
1.
3接口规则1.
非平台性的客户,可直接在快递鸟官网-物流短信中设置相应的短信模板,无需对接此接口.
2.
所有接入短信业务的用户先必须在用户管理后台报备签名,否则无法发送.
3.
短信内容需遵守《互联网新闻信息服务管理规定》,严禁发送非法、反动、色情、暴力、谩骂、诈骗、恐吓等被禁止的内容.
4.
短信模板内容少于10个字或者发送重复的文字等都会被识别为无用信息,否则无法发送.
5.
3.
1.
4应用级参数名称类型(字符长度)是否必须描述Detail.
TemplateTypeInt(1)R模板ID:1-寄件通知短信接口指令8102支持格式只支持Json格式接口地址测试地址:http://testapi.
kdniao.
com:8081/api/dist正式地址(不加密):http://api.
kdniao.
com/api/dist正式地址(加密):https://api.
kdniao.
com/api/dist快递鸟接口技术文档872-到达派件城市通知短信3-派件中通快递知短信4-问题件通知短信5-已签收通知短信6-纯营销短信7-自定义通知短信Detail.
MessageTemplateString(500)R模板内容Detail.
IsOpenString(1)R是否开启(0否1是)Detail.
SendTypeInt(1)C发送人类型(0-收件人,1-寄件人,2-收寄件人)TemplateType为6或7时不填MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户请求示例:{"Detail":[{"TemplateType":"6","MessageTemplate":"短信模板","IsOpen":0,"SendType":2}],"MemberID":"123456"}5.
3.
1.
5返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDSuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因返回示例:快递鸟接口技术文档88{"EBusinessID":"1237100","Success":true}5.
3.
2短信发送接口5.
3.
2.
1功能说明此接口用于实时发送短信(如:纯营销短信、自定义通知短信).
5.
3.
2.
2基本信息5.
3.
2.
3接口规则1.
营销短信模板需添加【回复TD退订】字样,否则无法发送.
2.
营销类短信发送时间为8:30-20:00,其他时间提交的短信则顺延至次日8:30之后.
3.
自定义通知短信发送无时间限制.
5.
3.
2.
4应用级参数名称类型(字符长度)是否必须描述MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户(与短信模板接口MemberID接口指令8101支持格式只支持Json格式批量交易支持,每次请求不超过100条接口地址测试地址:http://testapi.
kdniao.
com:8081/api/dist正式地址(不加密):http://api.
kdniao.
com/api/dist正式地址(加密):https://api.
kdniao.
com/api/dist快递鸟接口技术文档89一致,如未传则为空)CallbackString(50)O用户自定义回传字段TemplateTypeIntR模板ID(请在快递鸟官网-物流短信查看对应模板ID)Detail.
ReceiverNameString(30)O姓名Detail.
ReceiverMobileString(20)R手机号码Detail.
Data.
ShipperCodeString(20)C快递公司编码TemplateType为自定义通知短信时至少必填一个Detail.
Data.
LogisticCodeString(30)C快递单号Detail.
Data.
CreateTimeDateC时间Detail.
Data.
CodeString(30)C验证码Detail.
Data.
MobileString(20)C手机号码请求示例:{"Detail":[{"ReceiverMobile":"180******71","ReceiverName":"张三","Data":"{'Password':'123456','Account':'test'}"}],"TemplateType":7,"CallBack":""}5.
3.
2.
5返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDOrderCodeString(30)R订单编号SuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因返回示例:快递鸟接口技术文档90{"EBusinessID":"1237100","OrderCode":"17052314055137647350","Success":true,}5.
3.
3短信黑名单接口5.
3.
3.
1功能说明此接口用于设置短信黑名单.
5.
3.
3.
2基本信息5.
3.
3.
3接口规则黑名单中的手机号码与用户ID绑定,只影响绑定ID通过快递鸟通道的短信发送.
5.
3.
3.
4应用级参数名称类型(字符长度)是否必须描述Detail.
MobileString(20)R手机号码Detail.
IsBlackInt(1)R是否黑名单(0否,1是)MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户请求示例:{接口指令8103支持格式只支持Json格式接口地址测试地址:http://testapi.
kdniao.
com:8081/api/dist正式地址(不加密):http://api.
kdniao.
com/api/dist正式地址(加密):https://api.
kdniao.
com/api/dist快递鸟接口技术文档91"Detail":[{"Mobile":"15814460948","IsBlack":0}],"MemberID":"123456"}5.
3.
3.
5返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDSuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因返回示例:{"EBusinessID":"1237100","Success":true}6附录6.
1接口指令汇总接口名称接口指令下单类接口预约取件接口1001预约取件取消接口1004电子面单接口1007电子面单取消接口1147单号余量查询接口1127客户号申请接口1107客户号推送接口1117快递鸟接口技术文档92实名寄递接口1021轨迹查询类接口即时查询接口1002轨迹订阅接口1008轨迹推送接口101单号识别接口2002增值类接口即时查询(增值版)8001轨迹订阅(增值版)8008轨迹推送接口102运费模板导入接口2004智选物流接口2006短信模板接口8102短信发送接口8101短信黑名单接口81036.
2对接相关资料1.
技术对接产品文档:http://kdniao.
com/documents2.
技术对接常见问题:http://kdniao.
com/help3.
各群文件6.
3电子面单模板规格快递公司名称编码模板样式尺寸规格TemplateSize字段CustomArea字段安能快递ANE二联180宽100m高180mm切点110/70默认返回,不能传值/安能快运ANEKY二联180宽100m高180mm切点110/70默认返回,不能传值支持承诺达CND二联180宽100m高180mm默认返回,不能传值支持快递鸟接口技术文档93切点110/70德邦快递DBL二联177宽100mm高177mm切点107/70默认返回,不能传值/二联177新宽100mm高177mm切点107/70传值18001/三联177新宽100mm高177mm切点107/30/40传值18002/德邦快运DBLKY三联180宽100mm高180mm切点110/30/40默认返回,不能传值支持丹鸟物流DNWL一联130宽76m高130mm传值130支持EMSEMS二联150宽100mm高150mm切点90/60默认返回,不能传值/二联180宽100m高180mm切点110/70传值180/百世快递HTKY二联180宽100m高180mm切点110/70默认返回,不能传值/二联180新宽100m高180mm切点110/70传值180支持一联130宽76m高130mm传值130支持百世快运HTKYKY二联180宽100m高180mm切点110/70默认返回,不能传值支持佳吉快运CNEX一联100宽90m高100mm默认返回,不能传值/快递鸟接口技术文档94京东快递JD二联110宽100mm高110mm切点60/50默认返回,不能传值/二联110新宽100mm高110mm切点60/50传值110/京东快运JDKY二联110宽100mm高110mm切点60/50默认返回,不能传值/极兔速递JTSD一联130宽76m高130mm传值130支持二联180宽100m高180mm切点110/70默认返回,不能传值支持跨越速运KYSY二联137宽100mm高137mm切点101/36默认返回,不能传值支持三联210宽100mm高210mm切点90/60/60传值210支持龙邦快运LB三联104宽75mm高104mm默认返回,不能传值/联昊通速递LHT二联150宽100mm高150mm切点90/60默认返回,不能传值/品骏快递PJ一联120宽80mm高120mm默认返回,不能传值/全一快递UAPEX二联150宽100mm高150mm切点90/60默认返回,不能传值支持顺丰速运SF二联150宽100mm高150mm切点90/60默认返回,不能传值/快递鸟接口技术文档95三联210宽100mm高210mm切点90/60/60传值210/二联150新宽100mm高150mm切点90/60传值15001支持二联180新宽100m高180mm切点110/70传值180支持三联210新宽100mm高210mm切点90/60/60传值21001支持申通快递STO二联150宽100mm高150mm切点90/60传值150/二联180宽100m高180mm切点110/70默认返回,不能传值/二联180新宽100m高180mm切点110/70传值180支持三联180新宽100mm高180mm切点110/30/40传值18003支持一联130宽76m高130mm传值130支持速尔快递SURE二联150宽100mm高150mm切点90/60默认返回,不能传值/二联150新宽100mm高150mm切点90/60传值150支持二联180新宽100m高180mm传值180支持快递鸟接口技术文档96切点110/70顺心捷达SX一联105宽75mm高105mm默认返回,不能传值/苏宁物流SNWL二联180宽100m高180mm切点110/70默认返回,不能传值支持腾林物流TLWL一联70宽100mm高70mm默认返回,不能传值/天地华宇HOAU二联180宽100m高180mm切点110/70默认返回,不能传值支持天天快递HHTT二联180宽100m高180mm切点110/70默认返回,不能传值/信丰物流XFEX二联150宽100mm高150mm切点90/60默认返回,不能传值/韵达速递YD二联203宽100mm高203mm切点152/51默认返回,不能传值/二联180宽100m高180mm切点110/70传值180支持一联130宽76m高130mm传值130支持韵达快运YDKY二联180宽100m高180mm切点110/70默认返回,不能传值支持圆通速递YTO二联180宽100m高180mm切点110/70默认返回,不能传值/三联180宽100mm高180mm切点110/30/40传值180/快递鸟接口技术文档97二联180新宽100m高180mm切点110/70传值18001支持一联130宽76m高130mm传值130支持邮政国内标快YZBK二联150宽100mm高150mm切点90/60默认返回,不能传值/邮政快递包裹YZPY二联180宽100m高180mm切点110/70默认返回,不能传值/二联180新宽100m高180mm切点110/70传值180支持优速快递UC二联180宽100m高180mm切点110/70默认返回,不能传值/远成快运YCWL二联180宽100m高180mm切点110/70默认返回,不能传值/宅急送ZJS二联120宽100mm高116mm切点98/18默认返回,不能传值/二联180宽100m高180mm切点110/70传值180支持二联120新宽100mm高116mm切点98/18传值120/中通快递ZTO二联180宽100m高180mm切点110/70默认返回,不能传值/快递鸟接口技术文档98二联180新宽100m高180mm切点110/70传值180支持一联130宽76m高130mm传值130支持中通快运ZTOKY二联180宽100m高180mm切点110/70默认返回,不能传值/6.
4返回编码列表成功编码描述100成功错误编码描述101缺少必要参数102校验问题103格式问题104用户问题105其他错误201填写的寄件方信息有误,请核实确认202填写的到件方信息有误,请核实确认203填写的快递公司电子面单账号密码有误,请核实确认204账户余额不足请联系快递网点充值205订单编号重复,请勿重复下单206订单编号不能为空207单号不足请联系快递网点充值208快递类型不能为空209运费支付方式有误210增值服务名称有误211月结编号不合法212代收货款信息有误213预约时间超出网点营业时间,请更换预约时间214日期格式错误215商品名称不能为空216手机或电话存在特殊字符快递鸟接口技术文档99217数据含有特殊字符218数据内容太长219限寄物品220预约时间小于当前时间或用户取消订单221包裹总体积不合法222必填项不能为空223订单备注超长224京东正在人工筛选是否可派送,请15分钟后重试225该订单地址已超出京东派送范围106该订单号已下单成功401RequestData格式有误402缺少快递单号403快递单号有特殊字符404快递单号长度不符405超出查询次数限制(日查询次数<=3万)7技术支持联系方式号码技术支持QQ群665031725/844089794商务咨询群526574204投诉建议反馈QQ3185726742400热线400-9633-321END
1接口规范及说明-62.
1.
1报文及报文编码-62.
1.
2接口数据包结构-62.
1.
3JSON示例-62.
1.
4系统级参数-72.
1.
5流程示意图-72.
1.
6名词定义-82.
2签名说明-82.
2.
1关于签名-82.
2.
2(C#)DataSign签名加密代码-102.
3接入步骤-113下单类接口-123.
1预约取件接口-123.
1.
1功能说明-123.
1.
2基本信息-133.
1.
3接口规则-133.
1.
4支持情况-133.
1.
5应用场景-133.
1.
6应用级参数-143.
1.
7返回参数-173.
2预约取件取消接口-183.
2.
1功能说明-183.
2.
2基本信息-183.
2.
3接口规则-193.
2.
4支持情况-193.
2.
5应用场景-193.
2.
6应用级参数-193.
2.
7返回参数-193.
3电子面单接口-203.
3.
1功能说明-203.
3.
2基本信息-20快递鸟接口技术文档33.
3.
3接口规则-213.
3.
4支持情况-213.
3.
5应用场景-223.
3.
6应用级参数-223.
3.
7返回参数-283.
4电子面单取消接口-323.
4.
1功能说明-323.
4.
2基本信息-333.
4.
3接口规则-333.
4.
4支持情况-333.
4.
5应用级参数-333.
4.
6返回参数-343.
5单号余量查询接口-343.
5.
1功能说明-343.
5.
2基本信息-343.
5.
3支持情况-353.
5.
4应用级参数-353.
5.
5返回参数-353.
6客户号申请接口-363.
6.
1功能说明-363.
6.
2基本信息-363.
6.
3支持情况-363.
6.
4应用级参数-373.
6.
5返回参数-383.
7客户号推送接口-393.
7.
1功能说明-393.
7.
2基本信息-393.
7.
3接口规则-393.
7.
4支持情况-393.
7.
5应用级参数-393.
7.
6返回参数-403.
8实名寄递接口-40快递鸟接口技术文档43.
8.
1功能说明-403.
8.
2基本信息-413.
8.
3接口规则-413.
8.
4支持情况-413.
8.
5应用级参数-413.
8.
6返回参数-434轨迹查询类接口-434.
1即时查询接口-434.
1.
1功能说明-434.
1.
2基本信息-444.
1.
3接口规则-444.
1.
4支持情况-444.
1.
5应用场景-444.
1.
6应用级参数-444.
1.
7返回参数-454.
2物流跟踪-474.
2.
1轨迹订阅接口-474.
2.
2轨迹推送接口-534.
3单号识别接口-614.
3.
1功能说明-614.
3.
2基本信息-614.
3.
3接口规则-614.
3.
4应用场景-624.
3.
5应用级参数-624.
3.
6返回参数-625增值类接口-635.
1在途监控-635.
1.
1即时查询接口(增值版)635.
1.
2物流跟踪接口(增值版)685.
2智选物流-755.
2.
1运费模板导入接口-755.
2.
2智选物流接口-795.
3短信服务-85快递鸟接口技术文档55.
3.
1短信模板接口-865.
3.
2短信发送接口-885.
3.
3短信黑名单接口-906附录-916.
1接口指令汇总-916.
2对接相关资料-926.
3电子面单模板规格-926.
4返回编码列表-987技术支持-99快递鸟接口技术文档61前言快递鸟API旨在为电商、电商平台、物流工具、打单工具、仓储系统、移动APP等系统提供专业、稳定、优质的API接口服务,满足不同用户的物流管理需求.
本文档就各个API接口进行详细说明,方便用户快速对接及使用快递鸟服务.
2接口规范说明2.
1接口规范及说明2.
1.
1报文及报文编码报文格式:Json格式请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"交互协议上统一用UTF-8,避免传递中文数据出现乱码.
2.
1.
2接口数据包结构图例-数据包结构(系统级{数据})2.
1.
3JSON示例stringused="1237100";//仅作为示例ID,不可用来实际使用//加密私钥,由快递鸟提供stringkeyValue="56da2cf8-c8a2-44b2-b6fa-476cd7d1ba17";//仅作为示例Key,不可用来实际使用//请求地址stringurl="http://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx";快递鸟接口技术文档7//2-jsonstringDataType="2";//字符编码采用UTF-8stringcharset="UTF-8";//JSON字符串stringstringjsonStr="{\"OrderCode\ShipperCode\":\"SF\",\"LogisticCode\":\"118461988807\"}";//把(jsonStr+APIKey)进行MD5加密,然后Base64编码,最后进行URL(utf-8)编码datasign=HttpUtility.
UrlEncode(base64(MD5(jsonStr+keyValue,"UTF-8"),"UTF-8"),Encoding.
UTF8);//请求报文参数stringPostStr="RequestType=1002&EBusinessID=used&RequestData=jsonStr&DataSign=datasign&DataType=DataType";//通讯协议使用Http协议Post请求方式stringpost=this.
DoPost(url,PostStr);2.
1.
4系统级参数名称类型(字符长度)是否必须描述RequestDataStringR请求内容为JSON格式EBusinessIDStringR用户IDRequestTypeStringR请求接口指令DataSignStringR数据内容签名DataTypeStringRDataType=2,请求、返回数据类型均为JSON格式*快递所有接口统一使用此系统级参数,根据不同的请求接口指令接入不同的接口.
2.
1.
5流程示意图快递鸟接口技术文档82.
1.
6名词定义必须要求说明R必填(Required).
O可选(Optional)C一定条件下可选(Conditional)2.
2签名说明2.
2.
1关于签名快递鸟和第三方电子商务公司系统进行对接,有一定的安全机制.
采用IP认证加签名的方式对接,具体方案如下:1.
防止数据被篡改在POST请求中会传递5个必须(R)参数RequestData==数据内容(URL编码:UTF-8)EBusinessID==用户IDRequestType=请求指令类型DataSign==数据内容签名:把(请求内容(未编码)+ApiKey)进行MD5加密,然后Base64编码,最后进行URL(utf-8)编码DataType==2(返回数据类型为json)注:DataSign生成后,对方接收到数据后,以同样的算法进行签名(推送接口RequestType为101/102不需要进行URL编码),生成摘要,对比两者的摘要是否相同,如果不同,说明传递过程中发生数据篡改.
2.
调用接口的身份认证注册成为快递鸟用户后,会生成对应的用户ID和APIKey,用户ID相当于用户名,APIKey相当于密码.
举例:1.
假设RequestData(JSON)内容为:{'OrderCode':'','ShipperCode':'SF','LogisticCode':'118954907573'}经过URL(UTF-8)编码的内容为:%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27SF%27%2c%2快递鸟接口技术文档97LogisticCode%27%3a%27118954907573%27%7d;EBusinessID=1237100【示例ID,不可用来实际使用】APIKey=56da2cf8-c8a2-44b2-b6fa-476cd7d1ba17【示例Key,不可用来实际使用】2.
那么DataSign签名的内容为{'OrderCode':'','ShipperCode':'SF','LogisticCode':'118954907573'}56da2cf8-c8a2-44b2-b6fa-476cd7d1ba17经过md5和base64后的内容就为:OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE=,在经过URL(UTF-8)编码的内容为:OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE%3d最终要发送的数据为:RequestType=1002&EBusinessID=1237100&RequestData=%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27SF%27%2c%27LogisticCode%27%3a%27118954907573%27%7d&DataSign=OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE%3d&DataType=23.
接收方收到数据后,获得EBusinessID和RequestData和DataSign等这几个数据.
4.
接收方对EBusinessID得到APIKey,RequestData+APIKey的数据进行md5和base64后的内容就为OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE=5.
接收方判断签名后的数据跟传递过来的DataSign是否一致,如果一致进行业务操作,如果不一致返回错误.
快递鸟接口技术文档102.
2.
2(C#)DataSign签名加密代码//////电商Sign签名//////内容///APIkey///URL编码///DataSign签名PublicStringEncrypt(Stringcontent,StringkeyValue,Stringcharset){if(keyValue!
=null){returnbase64(MD5(content+keyValue,charset),charset);}returnbase64(MD5(content,charset),charset);}//////字符串MD5加密//////要加密的字符串///密文PrivatestringMD5(stringText,stringcharset){byte[]buffer=System.
Text.
Encoding.
GetEncoding(charset).
GetBytes(Text);try{System.
Security.
Cryptography.
MD5CryptoServiceProvidercheck;check=newSystem.
Security.
Cryptography.
MD5CryptoServiceProvider();byte[]somme=check.
ComputeHash(buffer);stringret="";foreach(byteainsomme){if(a、联昊通速递、极兔速递、丹鸟物流、苏宁物流.
2.
支持预约取件服务的快递公司:圆通速递、中通快递、申通快递、韵达速递、百世快递、顺丰速运、EMS、宅急送、德邦快递、天天快递、跨越速运、优速快递、京东快递、邮政国内标快、品骏快递.
3.
支持保价服务的快递公司:EMS、天天快递、顺丰速运、邮政快递包裹、宅急送、德邦快递、京东快递、丹鸟物流、苏宁物流.
4.
支持子母件功能(一票多件)的快递公司:顺丰速运、优速快递、德邦快递、京东快递、速尔快递、宅急送、跨越速运、苏宁物流.
5.
支持签回单功能的快递公司:顺丰速运、德邦快递、跨越速运、联昊通速递、苏宁物流.
6.
支持代收货款服务的快递公司:顺丰速运、龙邦、速腾、京广、韵达速递、圆通速递、百世快递、中通快递、EMS、速尔快递、京东快递、宅急送、极兔速递、丹鸟物流、苏宁物流;快运公司支持情况:1.
支持电子面单服务的快运公司:德邦快运、安能快运、京东快运、龙邦快运、百世快运、中通快运、天地华宇、佳吉快运、腾林物流、韵达快运、顺心捷达.
2.
支持子母件功能(一票多件)的快运公司:德邦快运、安能快运、京东快运、龙邦快运、百世快运、中通快运、天地华宇、佳吉快运、腾林物流、韵达快运、顺心捷达.
快递鸟接口技术文档223.
支持保价服务的快运公司:德邦快运、安能快运、京东快运、龙邦快运、百世快运、中通快运、天地华宇、佳吉快运、腾林物流、韵达快运、顺心捷达.
3.
3.
5应用场景电商平台、打单工具、ERP系统、WEB端、APP移动端、小程序3.
3.
6应用级参数名称类型(字符长度)是否必须描述CallbackString(50)O用户自定义回传字段MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户CustomerNameString(50)C电子面单客户号,需要下载《快递鸟电子面单客户号参数对照表.
xlsx》,参考对应字段传值CustomerPwdString(30)CSendSiteString(30)CSendStaffString(30)CMonthCodeString(20)CCustomAreaString(500)O商家自定义区域(支持情况见6.
3部分)WareHouseIDString(30)C发货仓编码(ShipperCode为JD或JDKY时必填)TransTypeInt(2)O京东快递(ShipperCode为JD)的产品类型:1:特惠送2:特快送4:城际闪送5:同城当日达6:次晨达7:微小件8:生鲜专送16:生鲜速达17:生鲜惠达京东快运(ShipperCode为JDKY)的类型:1:零担2:整车快递鸟接口技术文档233:特惠送4:特快送5:特惠运6:特准运7:航空代理8:航空直客9:铁路直客10:特惠整车11:特惠拼车12:同城直配13:冷链卡班14:冷链专车15:冷链成配16:送货到仓17:医药零担18:医药整车25:特快重货ShipperCodeString(10)R快递公司编码详细编码参考《快递鸟接口支持快递公司编码.
xlsx》LogisticCodeString(30)O快递单号(仅宅急送可用)ThrOrderCodeString(50)C京东商城的订单号(ShipperCode为JD且ExpType为1时必填)OrderCodeString(30)R订单编号(自定义,不可重复)PayTypeInt(1)R运费支付方式:1-现付,2-到付,3-月结,4-第三方付(仅SF、KYSY支持)ExpTypeString(2)R详细快递类型参考《快递公司快递业务类型.
xlsx》IsReturnSignBillInt(1)O是否要求签回单0-不要求,1-要求OperateRequireString(20)O签回单操作要求(如:签名、盖章、身份证复印件等)CostDouble(5)O快递运费OtherCostDouble(5)O其他费用Receiver.
CompanyString(30)O收件人公司Receiver.
NameString(30)R收件人Receiver.
TelString(20)R电话与手机,必填一个Receiver.
MobileString(20)快递鸟接口技术文档24Receiver.
PostCodeString(10)C收件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)Receiver.
ProvinceNameString(20)R收件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Receiver.
CityNameString(20)R收件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")Receiver.
ExpAreaNameString(20)R收件区/县(如福田区,不要缺少"区"或"县")Receiver.
AddressString(100)R收件人详细地址Sender.
CompanyString(30)O发件人公司Sender.
NameString(30)R发件人Sender.
TelString(20)R电话与手机,必填一个Sender.
MobileString(20)Sender.
PostCodeString(10)C发件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)Sender.
ProvinceNameString(20)R发件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Sender.
CityNameString(20)R发件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")Sender.
ExpAreaNameString(20)R发件区/县(如福田区,不要缺少"区"或"县")Sender.
AddressString(100)R发件人详细地址IsNoticeInt(1)O是否通知快递员上门揽件0-通知,1-不通知,不填则默认为1StartDateDateO上门揽件时间段,格式:快递鸟接口技术文档25YYYY-MM-DDHH24:MM:SSEndDateWeightDouble(10,3)C包裹总重量kg1、当为快运的订单时必填;2、ShipperCode为JD时必填;QuantityInt(2)R包裹数(最多支持300件)一个包裹对应一个运单号,如果是大于1个包裹,返回则按照子母件的方式返回母运单号和子运单号VolumeDouble(20,3)C包裹总体积m31、当为快运的订单时必填;2、ShipperCode为JD时必填;RemarkString(60)O备注AddService.
NameString(20)C增值服务名称(数组形式,可以有多个增值服务)AddService.
ValueString(30)C增值服务值AddService.
CustomerIDString(30)O客户标识Commodity.
GoodsNameString(100)R商品名称Commodity.
GoodsCodeString(20)O商品编码Commodity.
GoodsquantityInt(5)O商品件数Commodity.
GoodsPriceDouble(10)O商品价格Commodity.
GoodsWeightDouble(10,3)O商品重量kgCommodity.
GoodsDescString(50)O商品描述Commodity.
GoodsVolDouble(15,3)O商品体积m3IsReturnPrintTemplateString(1)O是否返回电子面单模板:0-不需要,1-需要IsSendMessageInt(1)O是否订阅短信:0-不需要,1-需要IsSubscribeString(1)O是否订阅轨迹推送0-不订阅,1-订阅,不填默认为1TemplateSizeString(10)O模板规格(默认的模板无需传值,非默认模板传对应模板尺寸)PackingTypeInt(2)C包装类型(快运字段);快递鸟接口技术文档260-纸,1-纤,2-木,3-托膜,4-木托,99-其他DeliveryMethodInt(1)C送货方式(快运字段);0-自提,1-送货上门(不含上楼),2-送货上楼CurrencyCodeString(10)C货物单价的币种:CNY:人民币HKD:港币NTD:新台币MOP:澳门元(ShipperCode为SF且收件地址为港澳台地区,必填)Dutiable.
DeclaredValueNumber(15,3)C申报价值:订单货物总声明价值,包含子母件,精确到小数点后3位(ShipperCode为SF且收件地址为港澳台地区,必填)增值服务说明:名称代码说明备注保价INSUREvalue为声明价值,保留3位小数快运的订单时必填代收货款CODValue为货款,保留3位小数.
CustomerID为代收货款卡号快递公司代收货款业务配送类型DeliveryValue为配送类型数字代码,如:5京东快递专用1:普通,2:生鲜常温3:填仓,4:特配,5:鲜活6:控温,7:冷藏,8:冷冻,9:深冷请求示例:{"OrderCode":"012657018199","ShipperCode":"SF","PayType":1,快递鸟接口技术文档27"MonthCode":"1234567890","ExpType":1,"Cost":1.
0,"OtherCost":1.
0,"Sender":{"Company":"LV","Name":"Taylor","Mobile":"15018442396","ProvinceName":"上海","CityName":"上海市","ExpAreaName":"青浦区","Address":"明珠路"},"Receiver":{"Company":"GCCUI","Name":"Yann","Mobile":"15018442396","ProvinceName":"北京","CityName":"北京市","ExpAreaName":"朝阳区","Address":"三里屯街道"},"Commodity":[{"GoodsName":"鞋子","Goodsquantity":1,"GoodsWeight":1.
0},{"GoodsName":"衣服","Goodsquantity":1,"GoodsWeight":1.
0}],"AddService":[{"Name":"INSURE","Value":"1000"快递鸟接口技术文档28},{"Name":"COD","Value":"1020","CustomerID":"1234567890"}],"Weight":1.
0,"Quantity":1,"Volume":0.
0,"Remark":"小心轻放"}3.
3.
7返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDOrder.
OrderCodeString(30)R订单编号Order.
ShipperCodeString(10)R快递公司编码Order.
LogisticCodeString(400)R快递单号Order.
MarkDestinationString(20)O大头笔Order.
SignWaybillCodeString(15)O签回单单号Order.
OriginCodeString(20)O始发地区域编码Order.
OriginNameString(20)O始发地/始发网点Order.
DestinatioCodeString(20)O目的地区域编码Order.
DestinatioNameString(20)O目的地/到达网点Order.
SortingCodeString(20)O分拣编码Order.
PackageCodeString(20)O集包编码Order.
PackageNameString(50)O集包地Order.
DestinationAllocationCentreString(50)O目的地分拨O京东快递(ShipperCode为JD)的产品类型:1:特惠送2:特快送4:城际闪送快递鸟接口技术文档29Order.
TransTypeInt(2)5:同城当日达6:次晨达7:微小件8:生鲜专送16:生鲜速达17:生鲜惠达京东快运(ShipperCode为JDKY)的类型:1:零担2:整车3:特惠送4:特快送5:特惠运6:特准运7:航空代理8:航空直客9:铁路直客10:特惠整车11:特惠拼车12:同城直配13:冷链卡班14:冷链专车15:冷链成配16:送货到仓17:医药零担18:医药整车25:特快重货Order.
TransportTypeInt(2)O运输方式(用于自行设计京东模板):0:陆运1:航空Order.
ShipperInfoString(300)C自行设计模板用(仅ShipperCode为SF时返回)SuccessBool(10)R成功与否(true/false)ResultCodeString(5)R返回编码ReasonString(50)O失败原因UniquerRequestNumberString(50)O唯一标识PrintTemplateStringO面单打印模板内容(html格式)EstimatedDeliveryTimeDateO订单预计到货时间(暂未上线)SubCountInt(5)O子单数量快递鸟接口技术文档30SubOrdersString(400)O子单单号SubPrintTemplatesString(2000)O子单模板内容(html格式)SignBillPrintTemplateStringO签回单模板内容(html格式)ShipperInfo参数说明(仅ShipperCode为SF时返回):格式:ShipperInfo={"Details":[{"Detail":{主单号的信息}},{"Detail":{签回单的信息}}]}名称类型(字符长度)是否必须描述Details.
Detail.
LogisticCodeString(30)O快递单号Details.
Detail.
OriginTransferCodeString(60)O原寄地中转场Details.
Detail.
OriginCityCodeString(60)O原寄地城市代码Details.
Detail.
OriginDeptCodeString(60)O原寄地网点代码Details.
Detail.
OriginTeamCodeString(60)O原寄地单元区域Details.
Detail.
DestCityCodeString(60)O目的地城市代码Details.
Detail.
DestDeptCodeString(60)O目的地网点代码Details.
Detail.
DestDeptCodeMappingString(60)O目的地网点代码映射码Details.
Detail.
DestTeamCodeString(60)O目的地单元区域Details.
Detail.
DestTeamCodeMappingString(60)O目的地单元区域映射码Details.
Detail.
DestTransferCodeString(60)O目的地中转场Details.
Detail.
DestRouteLabelString(200)O打单时的路由标签信息Details.
Detail.
CodingMappingString(60)O入港映射码Details.
Detail.
CodingMappingOutString(60)O出港映射码Details.
Detail.
XbFlagString(30)OXB标志0:不需要打印1:需要打印快递鸟接口技术文档31Details.
Detail.
PrintFlagString(60)O打印标志返回值总共有9位,每一位只有0和1两种,0表示按丰密运单默认的规则,1表示显示,顺序如下,如111110000表示打印寄方姓名、寄方电话、寄方公司名、寄方地址和重量,收方姓名、收方电话、收方公司名和收方地址按丰密运单默认规则:1:寄方姓名2:寄方电话3:寄方公司名4:寄方地址5:重量6:收方姓名7:收方电话8:收方公司名9:收方地址Details.
Detail.
TwoDimensionCodeString(600)O二维码根据规则生成字符串信息,格式为:MMM={'k1':'(目的地中转场代码)','k2':'(目的地原始网点代码)','k3':'(目的地单元区域)','k4':'(通过三维码(express_type_code、limit_type_code、cargo_type_code)映射时效类型)','k5':'(运单号)','k6':'(AB标识)'}Details.
Detail.
ProCodeString(30)O时效类型:值为二维码中的K4Details.
Detail.
PrintIconString(100)O打印图标Details.
Detail.
AbFlagString(30)OAB标快递鸟接口技术文档32返回示例:失败:{"EBusinessID":"1237100","ResultCode":"106","Reason":"该订单号已下单成功","UniquerRequestNumber":"5e66486b-8fbc-4131-b875-9b13d2ad1354"}成功:{"EBusinessID":"1237100","Order":{"OrderCode":"012657700387","ShipperCode":"HTKY","LogisticCode":"50002498503427","MarkDestination":"京-朝阳(京-1)","OriginCode":"200000","OriginName":"上海分拨中心","PackageCode":"北京"},"PrintTemplate":"此处省略打印模板HTML内容","EstimatedDeliveryTime":"2016-03-06","Success":true,"ResultCode":"100","Reason":"成功"}3.
4电子面单取消接口3.
4.
1功能说明此接口用于取消"电子面单接口"下单成功的订单,回收快递单号.
快递鸟接口技术文档333.
4.
2基本信息3.
4.
3接口规则1.
只支持取消通过电子面单接口下单成功的订单;2.
只支持取消未揽件的订单;3.
订单取消后,订单号仍不可重复使用;4.
订单取消后快递单号的回收规则以快递公司为准.
3.
4.
4支持情况支持快递公司:顺丰速运、优速快递、百世快递、承诺达、腾林物流.
3.
4.
5应用级参数名称类型(字符长度)是否必须描述ShipperCodeString(10)R快递公司编码OrderCodeString(30)R订单编号ExpNoString(30)R快递单号CustomerNameString(50)R电子面单客户号CustomerPwdString(30)R电子面单密码(顺丰不需要)请求示例:接口指令1147批量请求不支持接口地址正式地址(不加密):http://api.
kdniao.
com/api/EOrderService正式地址(加密):https://api.
kdniao.
com/api/EOrderService{"ShipperCode":"UC","OrderCode":"TEST201209211045","ExpNo":"900008664480","CustomerName":"80238728","CustomerPwd":"c0bfe0ba86b66bae5426303c53db0a8b"快递鸟接口技术文档343.
4.
6返回参数名称类型(字符长度)是否必须描述EbusinessIDString(10)R用户IDSuccessBool(10)R成功与否(true/false)ResultCodeString(5)R返回编码ReasonString(50)O失败原因返回示例:3.
5单号余量查询接口3.
5.
1功能说明此接口用于向快递公司查询电子面单客户号中剩余的可用单号数量.
3.
5.
2基本信息}{"EBusinessID":"1237100","Success":true,"ResultCode":"100"}接口指令1127支持格式只支持Json格式、UTF-8编码请求方式POST请求接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/api/EOrderService正式地址(加密):https://api.
kdniao.
com/api/EOrderService快递鸟接口技术文档353.
5.
3支持情况支持快递公司:优速快递、中通快递、韵达速递、百世快递.
3.
5.
4应用级参数名称类型(字符长度)是否必须描述ShipperCodeString(10)R快递公司编码CustomerNameString(50)R电子面单客户号CustomerPwdString(30)R电子面单密码StationCodeString(30)R网点编码StationNameString(30)R网点名称请求示例:3.
5.
5返回参数{"ShipperCode":"UC","CustomerName":"80238728","CustomerPwd":"c0bfe0ba86b66bae5426303c53db0a81","StationCode":"3001","StationName":"福田网点"}名称类型(字符长度)是否必须描述EbusinessIDString(10)R用户IDSuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因ResultCodeString(10)R返回编码EorderBalance.
TotalNumInt(10)O累计充值数量,电子面单总量(包含已使用/未使用)EorderBalance.
AvailInt(10)R剩余可用量快递鸟接口技术文档36返回示例:3.
6客户号申请接口3.
6.
1功能说明此接口用于向快递公司申请电子面单客户号.
3.
6.
2基本信息3.
6.
3支持情况1.
支持快递公司:优速快递、韵达速递、圆通速、百世快递、远成快运(YCWL)、安能快递、中通快递、顺心捷达.
2.
快递鸟官网支持线上直接申请,申请途径:登录快递鸟官网—电子面单—申请新的物流服务商;ableNum{"EBusinessID":"1237100","Success":true,"Reason":"","ResultCode":"100","EorderBalance":{"AvailableNum":0,"TotalNum":0}}接口指令1107支持格式只支持Json格式、UTF-8编码接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/api/apiservice正式地址(加密):https://api.
kdniao.
com/api/apiservice快递鸟接口技术文档373.
电子面单客户号可通过快递鸟官网在线申请和联系网点线下申请两种方式,推荐线下直接联系当地网点申请.
3.
6.
4应用级参数名称类型(字符长度)是否必须描述SubscriptionIDString(30)O客户申请唯一标识ShipperCodeString(10)R快递公司编码StationCodeString(30)R网点编码StationNameString(30)R网点名称ApplyIDString(30)O申请ID(用户记录在快递公司的标识)CompanyString(30)O公司名称NameString(30)R联系人TelString(20)C电话MobileString(20)C手机ProvinceNameString(20)R省份ProivnceCodeString(20)O省份编码CityNameString(20)R城市CityCodeString(20)O城市编码ExpAreaNameString(20)R区县ExpAreaCodeString(20)O区县编码AddressString(100)R详细地址CardTypeIntC证件类型:1-身份证(ShipperCode为ZTO时必填)CardNoString(30)C证件号码(ShipperCode为ZTO时必填)请求示例:{"ShipperCode":"UC","Company":"快递鸟","ApplyID":"1237100",快递鸟接口技术文档383.
6.
5返回参数名称类型(字符长度)是否必须描述EbusinessIDString(10)R用户IDApplyCodeString(30)R客户编号SuccessBool(10)R成功与否(true/false)ResultCodeString(5)R返回编码ReasonString(50)O失败原因返回示例:"Name":"hoo123","Tel":"07558812345","Mobile":"15612344567","ProvinceName":"广东省","ProivnceCode":"440000","CityName":"深圳市","CityCode":"440300","ExpAreaName":"宝安区","ExpAreaCode":"440306","Address":"西乡1路","StationCode":"西乡网点","StationName":"西乡网点"}{"EBusinessID":"1237100","ApplyCode":"test123456""Success":true,"Reason":"提交申请成功","ResultCode":"100"}快递鸟接口技术文档393.
7客户号推送接口3.
7.
1功能说明此接口用于向客户推送快递公司审核通过的电子面单客户号信息.
3.
7.
2基本信息3.
7.
3接口规则推送时会推送RequestType、RequestData和DataSign三个参数(格式:RequestData={数据}&EBusinessID=1237100&PushTime=2017-04-1823:34:29&RequestType=1117)3.
7.
4支持情况目前支持快递公司:优速快递、韵达速递、圆通速递、百世快递、远成快运(YCWL)、安能快递、中通快递、佳吉快运、顺心捷达.
3.
7.
5应用级参数名称类型(字符长度)是否必须描述ApplyCodeString(30)R客户编号CustomerNameString(50)O电子面单客户号CustomerPwdString(30)O电子面单密码StationCodeString(30)O网点编码StationNameString(30)O网点名称SubscriptionIDString(30)O客户申请唯一标识SuccessBool(10)R成功与否(true/false)ResultCodeString(5)O返回编码ReasonString(50)O失败原因接口指令1117快递鸟接口技术文档40请求示例:3.
7.
6返回参数名称类型(字符长度)是否必须描述EBusinessIDStringR用户IDRequestTypeStringR接口指令SuccessBoolR成功(true)MessageStringO返回消息返回示例:3.
8实名寄递接口3.
8.
1功能说明此接口用于下单时向快递公司提交用户实名信息,实现用户实名寄件时免出示身份证的功能.
{"ApplyCode":"test123456","CustomerName":"80237910","CustomerPwd":"c0bfe0ba86b66bae5426303c53db0a8b","StationCode":"闵行八部","StationName":"闵行八部"}{"EBusinessID":"1237100","Message":"成功","RequestType":"1117","Success":true}快递鸟接口技术文档413.
8.
2基本信息3.
8.
3接口规则1.
请求报文中不允许出现以下特殊字符:2.
下单时通过校验"寄件人手机号"确认向快递公司提交的用户实名信息.
3.
一次实名终生使用.
3.
8.
4支持情况1.
支持同步实名信息的接口:预约取件接口、电子面单接口、轨迹订阅接口(包含收寄方信息).
2.
支持的快递公司:安能快递(ANE)、中通快递(ZTO)、韵达速递(YD)、德邦快递(DBL)、百世快递(HTKY)、优速快递(UC).
3.
支持的快递柜:丰巢快递柜(FCBOX).
3.
8.
5应用级参数接口指令1021支持格式只支持Json格式接口地址正式地址(不加密):http://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx正式地址(加密):https://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx名称类型(字符长度)是否必须描述MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户NameString(30)R发件人GenderInt(1)O性别1-男2-女TypeOfIdInt(1)R证件类型:1-身份证NumberOfIdStringR证件号快递鸟接口技术文档42请求示例:ContactArrayR联系方式,可提交多条[{"Mobile":"123","Phone":"123"},{"Mobile":"1223","Phone":"123"}]ProvinceString(20)R发件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)CityString(20)R发件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")AreaString(20)R发件区/县(如福田区,不要缺少"区"或"县")AddressString(100)R发件人详细地址CodeOfWeixinString(50)O微信号CollectMethodInt(1)R用户信息采集方式1-身份证件识别设备,2-NFC+SAM方式,3-OCR读取方式ImageFrontStringR身份证正面照(图片转成base64字符串)ImageBackStringR身份证反面照(图片转成base64字符串)ImageHandStringO手持身份证正面照(图片转成base64字符串){"MemberID":"","Name":"1234567","Gender":"2","TypeOfId":"1","NumberOfId":"420211199901011234","Contact":[{"Mobile":"13500000000","Phone":""},{"Mobile":"15817289472",快递鸟接口技术文档433.
8.
6返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDSuccessBool(10)R成功与否ReasonString(50)O失败原因返回示例:4轨迹查询类接口4.
1即时查询接口4.
1.
1功能说明此接口用于向快递公司实时查询物流轨迹信息.
"Phone":"07558651234"}],"Province":"广东省","City":"深圳市","Area":"福田区","Address":"金花路11号","CodeOfWeixin":"","CollectMethod":"3","ImageFront":"Base64Z","ImageBack":"Base64F","ImageHand":""}{"UpdateTime":"2018-02-0213:59:02","EBusinessID":"1261799","Success":true}快递鸟接口技术文档444.
1.
2基本信息4.
1.
3接口规则返回的物流轨迹信息按照发生时间的升序排列.
4.
1.
4支持情况1.
主流快递仅支持中通快递、申通快递、圆通速递3家,不支持EMS、邮政快递包裹、顺丰速运、韵达速递、京东快递、百世快递、天天快递;如需查询所有主流快递公司,请选用在途监控服务;4.
1.
5应用场景打单工具、查询工具、WEB端、APP移动端、小程序4.
1.
6应用级参数名称类型(字符长度)是否必须描述OrderCodeString(30)O订单编号ShipperCodeString(10)R快递公司编码详细编码参考《快递鸟接口支持快递公司编码.
xlsx》接口指令1002支持格式只支持Json格式批量请求不支持,并发不超过10次/S查询次数限制500次/天接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx正式地址(加密):https://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx快递鸟接口技术文档45LogisticCodeString(30)R快递单号CustomerNameString(50)CShipperCode为JD,必填,对应京东的青龙配送编码,也叫商家编码,格式:数字+字母+数字,9位数字加一个字母,共10位,举例:001K123450;ShipperCode为其他快递时,不填请求示例:4.
1.
7返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDOrderCodeString(30)O订单编号ShipperCodeString(10)R快递公司编码LogisticCodeString(30)R快递单号SuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因StateString(5)R物流状态:0-暂无轨迹信息1-已揽收ZTO请求示例:{"OrderCode":"","ShipperCode":"ZTO","LogisticCode":"638650888018",}JD请求示例:{"OrderCode":"","CustomerName":"001K12345","ShipperCode":"JD","LogisticCode":"VA00003618100",}快递鸟接口技术文档462-在途中3-签收4-问题件Traces.
AcceptTimeDateR轨迹发生时间Traces.
AcceptStationString(100)R轨迹描述返回示例:无物流轨迹:{"EBusinessID":"1237100","Traces":[],"State":"0","ShipperCode":"ZTO","LogisticCode":"638650888018","Success":true,"Reason":"暂无轨迹信息"}有物流轨迹:{"EBusinessID":"1237100","OrderCode":"","ShipperCode":"ZTO","LogisticCode":"638650888018","Success":true,"State":3,"Traces":[{"AcceptTime":"2014-06-2420:18:58","AcceptStation":"已收件[深圳市]",},{"AcceptTime":"2014-06-2420:55:28","AcceptStation":"快件在深圳,准备送往下一站深圳集散中心[深圳市]",},{"AcceptTime":"2014-06-2510:23:03",快递鸟接口技术文档474.
2物流跟踪物流跟踪由轨迹订阅接口和轨迹推送接口组成,对接时需要对接以下二个接口.
4.
2.
1轨迹订阅接口4.
2.
1.
1功能说明1.
此接口用于向快递鸟订阅物流轨迹信息.
2.
支持服务:预约取件.
4.
2.
1.
2基本信息4.
2.
1.
3接口规则1.
接口对订阅的数据不做判断和校验,不校验快递公司编码和单号是否匹配,不判断快递单号是否合法、是否正确、是否重复订阅.
"AcceptStation":"派件已签收[深圳市]",},{"AcceptTime":"2014-06-2510:23:03","AcceptStation":"签收人是:已签收[深圳市]",}]}接口指令1008支持格式只支持Json格式批量请求不支持,并发不超过30次/S查询次数限制订阅时只有快递公司编码、快递单号,限制100次/天订阅时带有收寄方全量信息,限制500次/天推送时效6至24小时内接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/api/dist正式地址(加密):https://api.
kdniao.
com/api/dist快递鸟接口技术文档482.
接口支持的消息接收方式为HTTPPOST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8".
3.
轨迹订阅接口只返回是否订阅成功的结果,不返回实际轨迹信息,需再开发轨迹推送接口用于接收快递鸟推送的轨迹数据.
4.
接口工作原理:用户将快递单号和订单信息向快递鸟订阅成功后,快递鸟向快递公司订阅轨迹,当轨迹有更新时,快递公司推送至快递鸟,快递鸟再同步推送至用户,直到运单签收.
4.
2.
1.
4支持情况1.
主流快递仅支持中通快递、申通快递、圆通速递3家,不支持EMS、邮政快递包裹、顺丰速运、韵达速递、京东快递、百世快递、天天快递;如需查询所有主流快递公司,请选用在途监控服务;4.
2.
1.
5应用场景电商平台、打单工具、查询工具、ERP系统、WEB端、APP移动端、小程序4.
2.
1.
6应用级参数名称类型(字符长度)是否必须描述CallbackString(50)O用户自定义回传字段MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户WareHouseIDString(30)O仓库标识(备用字段)ShipperCodeString(10)R快递公司编码详细编码参考《快递鸟接口支持快递公司编码.
xlsx》LogisticCodeString(30)R快递单号CustomerNameString(50)CShipperCode为JD,必填,对应京东的青龙配送编码,也叫商家编码,格式:数字快递鸟接口技术文档49+字母+数字,9位数字加一个字母,共10位,举例:001K123450;ShipperCode为其他快递时,不填OrderCodeString(30)O订单编号MonthCodeString(20)O月结编号PayTypeInt(1)O运费支付方式:1-现付,2-到付,3-月结,4-第三方付(仅SF、KYSY支持)ExpTypeString(2)O详细快递类型参考《快递公司快递业务类型.
xlsx》CostDouble(5)O快递运费OtherCostDouble(5)O其他费用Receiver.
CompanyString(30)O收件人公司Receiver.
NameString(30)R收件人Receiver.
TelString(20)R电话与手机,必填一个Receiver.
MobileString(20)Receiver.
PostCodeString(10)C收件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)Receiver.
ProvinceNameString(20)R收件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Receiver.
CityNameString(20)R收件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")Receiver.
ExpAreaNameString(20)R收件区/县(如福田区,不要缺少"区"或"县")Receiver.
AddressString(100)R收件人详细地址Sender.
CompanyString(30)O发件人公司Sender.
NameString(30)R发件人Sender.
TelString(20)R电话与手机,必填一个快递鸟接口技术文档50Sender.
MobileString(20)Sender.
PostCodeString(10)C发件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)Sender.
ProvinceNameString(20)R发件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Sender.
CityNameString(20)R发件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")Sender.
ExpAreaNameString(20)R发件区/县(如福田区,不要缺少"区"或"县")Sender.
AddressString(100)R发件人详细地址IsNoticeInt(1)O是否通知快递员上门揽件0-通知,1-不通知,不填则默认为1StartDateDateO上门揽件时间段,格式:YYYY-MM-DDHH24:MM:SSEndDateWeightDouble(10,3)O包裹总重量kgQuantityInt(2)O包裹数,一个包裹对应一个运单号,如果是大于1个包裹,返回则按照子母件的方式返回母运单号和子运单号VolumeDouble(20,3)O包裹总体积m3RemarkString(60)O备注IsSendMessageInt(1)O是否订阅短信:0-不需要,1-需要AddService.
NameString(20)O增值服务名称AddService.
ValueString(30)O增值服务值AddService.
CustomerIDString(30)O客户标识Commodity.
GoodsNameString(100)O商品名称Commodity.
GoodsCodeString(20)O商品编码Commodity.
GoodsquantityInt(5)O商品件数快递鸟接口技术文档51Commodity.
GoodsPriceDouble(10)O商品价格Commodity.
GoodsWeightDouble(10,3)O商品重量kgCommodity.
GoodsDescString(50)O商品描述Commodity.
GoodsVolDouble(15,3)O商品体积m3请求示例:ZTO请求示例:{"ShipperCode":"ZTO","OrderCode":"","LogisticCode":"3100707578976","PayType":"1","ExpType":"1","CustomerName":"","CustomerPwd":"","MonthCode":"","IsNotice":"0","Sender":{"Name":"1255760","Tel":"","Mobile":"13700000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Address":"测试地址"},"Receiver":{"Name":"1255760","Tel":"","Mobile":"13800000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"龙华新区","Address":"测试地址2"},"Commodity":[{快递鸟接口技术文档52"GoodsName":"书本"}]}JD请求示例:{"ShipperCode":"JD","OrderCode":"","CustomerName":"001K12345","LogisticCode":"VA00003618100","PayType":"1","ExpType":"1","CustomerName":"","CustomerPwd":"","MonthCode":"","IsNotice":"0","Sender":{"Name":"1255760","Tel":"","Mobile":"13700000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Address":"测试地址"},"Receiver":{"Name":"1255760","Tel":"","Mobile":"13800000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"龙华新区","Address":"测试地址2"},"Commodity":[{"GoodsName":"书本"快递鸟接口技术文档534.
2.
1.
7返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDUpdateTimeDateR更新时间YYYY-MM-DDHH24:MM:SSSuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因EstimatedDeliveryTimeDateO订单预计到货时间(暂未上线)返回示例:4.
2.
2轨迹推送接口4.
2.
2.
1功能说明此接口用于用户接收快递鸟推送的物流轨迹信息.
4.
2.
2.
2基本信息}]}{"EBusinessID":"1237100","UpdateTime":"2016-08-0916:42:38","Success":true,"Reason":""}接口指令101/102支持格式只支持Json格式请求方式POST请求推送方式每次全量推送,一次最多推送10单快递鸟接口技术文档544.
2.
2.
3接口规则1.
返回的物流轨迹信息按照发生时间的升序排列.
2.
轨迹推送是异步推送的,系统拉取到轨迹后调用用户推送接口推送轨迹数据.
3.
若Data接收到推送Success为false,且Reason为三天无轨迹,需重新发起订阅.
4.
若Data接收到推送Success为false,且Reason为七天内无轨迹变化,需重新发起订阅.
5.
若Data接收到推送Success为false,且State为0,属于正常推送,需耐心等待下次推送即可.
6.
在没有返回信息或者返回不符合规定的情况下,会判断为推送失败.
推送失败后会重试推送2次,首次间隔15分钟,二次间隔半个小时,两次都失败就不会再推送,直到下次有轨迹更新才会再次推送,建议您严格按照技术文档进行返回.
4.
2.
2.
4接口要求1.
客户服务器必须稳定,并且有一定的接受数据能力,快递鸟通过多线程推送物流信息给客户.
2.
客户需按快递鸟要求开发接口,保证信息的正常接收.
必须在5S内对快递鸟请求做出响应(数据存储后马上返回响应结果,然后再处理数据),响应结果按接口格式要求返回.
3.
客户需提供接收地址(回调地址),登陆快递鸟官网http://www.
kdniao.
com/UserCenter/v2/SandBox/PushQueryParam.
aspx完成配置(沙箱调试后台测试通过后,点击右上角的配置按钮,配置保存后会自动同步到正式环境).
4.
2.
2.
5应用级参数轨迹订阅接口(1008)返回结果(RequestType:101)通过轨迹订阅接口订阅的数据,快递鸟推送时RequestType的值为101,同时返回以下数据:名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDPushTimeDateR推送时间CountString(2)R推送轨迹的快递单号个数DataStringR推送轨迹的轨迹数据集合Data.
EBusinessIDString(10)R用户IDData.
ShipperCodeString(10)R快递公司编码Data.
LogisticCodeString(30)R快递单号Data.
SuccessBool(10)R成功与否(true/false)快递鸟接口技术文档55Data.
ReasonString(50)O失败原因Data.
OrderCodeString(30)O订单编号Data.
StateString(5)R物流状态:0-暂无轨迹信息1-已揽收2-在途中3-签收4-问题件Data.
CallbackString(50)O用户自定义回传字段Data.
EstimatedDeliveryTimeDateO预计到达时间(暂未上线)Data.
Traces.
AcceptTimeDateR轨迹发生时间Data.
Traces.
AcceptStationString(100)R轨迹描述Data.
Traces.
RemarkString(60)O备注请求示例:{"EBusinessID":"1237100","Count":"2","PushTime":"2015-03-1116:21:06","Data":[{"EBusinessID":"1237100","ShipperCode":"EMS","LogisticCode":"5042260908504","Success":true,"Reason":"","State":"2","CallBack":"0","OrderCode":"0","Traces":[{"AcceptTime":"2016-10-2618:31:38","AcceptStation":"【北京环铁站】的【互优图书】已收件",},{快递鸟接口技术文档56"AcceptTime":"2016-10-2619:53:50","AcceptStation":"快件在【北京环铁站】装车,正发往【北京分拨中心】",},{"AcceptTime":"2016-10-2621:00:13","AcceptStation":"快件到达【北京分拨中心】,上一站是【北京环铁站】",},{"AcceptTime":"2016-10-2621:06:27","AcceptStation":"快件在【北京分拨中心】装车,正发往【青州分拨中心】",},]},{"EBusinessID":"1237100","ShipperCode":"EMS","LogisticCode":"5042260908504","Success":true,"Reason":"","State":"2","CallBack":"0","OrderCode":"0","Traces":[{"AcceptTime":"2016-10-2618:31:38","AcceptStation":"【北京环铁站】的【互优图书】已收件",},{"AcceptTime":"2016-10-2619:53:50","AcceptStation":"快件在【北京环铁站】装车,正发往【北京分拨中心】",},{"AcceptTime":"2016-10-2621:00:13","AcceptStation":"快件到达【北京分拨中心】,上一站是【北京环铁站】",},{"AcceptTime":"2016-10-2621:06:27",快递鸟接口技术文档57"AcceptStation":"快件在【北京分拨中心】装车,正发往【青州分拨中心】",},{"AcceptTime":"2016-10-2711:04:43","AcceptStation":"快件到达【北京分拨中心】,上一站是【】",},]}]}轨迹订阅接口(8008增值版)返回结果(RequestType:102)通过轨迹订阅接口订阅的数据,快递鸟推送时RequestType的值为102,同时返回以下数据:名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDPushTimeDateR推送时间CountString(2)R推送轨迹的快递单号个数DataStringR推送轨迹的轨迹数据集合Data.
EBusinessIDString(10)R用户IDData.
ShipperCodeString(10)R快递公司编码Data.
LogisticCodeString(30)R快递单号Data.
SuccessBool(10)R成功与否(true/false)Data.
ReasonString(50)O失败原因Data.
OrderCodeString(30)O订单编号Data.
StateString(5)R物流状态:0-暂无轨迹信息1-已揽收2-在途中3-签收4-问题件Data.
StateExString(5)R增值物流状态:0-暂无轨迹信息1-已揽收2-在途中201-到达派件城市快递鸟接口技术文档58202-派件中211-已放入快递柜或驿站3-已签收301-正常签收302-派件异常后最终签收304-代收签收311-快递柜或驿站签收4-问题件401-发货无信息402-超时未签收403-超时未更新404-拒收(退件)405-派件异常406-退货签收407-退货未签收412-快递柜或驿站超时未取Data.
LocationString(20)R所在城市Data.
CallbackString(50)O用户自定义回传字段Data.
EstimatedDeliveryTimeDateO预计到达时间(暂未上线)Data.
Traces.
AcceptTimeDateR轨迹发生时间Data.
Traces.
AcceptStationString(100)R轨迹描述Data.
Traces.
LocationString(20)R当前城市Data.
Traces.
ActionString(50)R当前状态(同StateEx)Data.
Traces.
RemarkString(60)O备注请求示例:{"EBusinessID":"1237100","Count":"2","PushTime":"2015-03-1116:21:06","Data":[{"EBusinessID":"1237100","ShipperCode":"EMS","LogisticCode":"5042260908504",快递鸟接口技术文档59"Success":true,"Reason":"","State":"2","StateEx":"2","CallBack":"0","OrderCode":"0","Traces":[{"AcceptTime":"2016-10-2618:31:38","AcceptStation":"【北京环铁站】的【互优图书】已收件","Location":"北京市","Action":"1"},{"AcceptTime":"2016-10-2619:53:50","AcceptStation":"快件在【北京环铁站】装车,正发往【北京分拨中心】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2621:00:13","AcceptStation":"快件到达【北京分拨中心】,上一站是【北京环铁站】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2621:06:27","AcceptStation":"快件在【北京分拨中心】装车,正发往【青州分拨中心】","Location":"北京市","Action":"2"},]},{"EBusinessID":"1237100","ShipperCode":"EMS","LogisticCode":"5042260908504",快递鸟接口技术文档60"Success":true,"Reason":"","State":"2","StateEx":"2","CallBack":"0","OrderCode":"0","Traces":[{"AcceptTime":"2016-10-2618:31:38","AcceptStation":"【北京环铁站】的【互优图书】已收件","Location":"北京市","Action":"1"},{"AcceptTime":"2016-10-2619:53:50","AcceptStation":"快件在【北京环铁站】装车,正发往【北京分拨中心】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2621:00:13","AcceptStation":"快件到达【北京分拨中心】,上一站是【北京环铁站】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2621:06:27","AcceptStation":"快件在【北京分拨中心】装车,正发往【青州分拨中心】","Location":"北京市","Action":"2"},]},4.
2.
2.
6返回参数名称类型(字符长度)是否必须描述快递鸟接口技术文档61EBusinessIDString(10)R用户IDUpdateTimeDateR更新时间SuccessBool(10)R成功(true)ReasonString(50)O失败原因返回示例:{"EBusinessID":"1237100","UpdateTime":"2015-03-1116:26:11","Success":true,"Reason":""}4.
3单号识别接口4.
3.
1功能说明此接口用于识别快递单号所属快递公司.
4.
3.
2基本信息4.
3.
3接口规则1.
接口只对快递单号进行识别,返回可能属于的一家或多家快递公司,可能性最高的排名接口指令2002支持格式只支持Json格式、utf-8编码请求方式POST请求查询次数限制30000次/天接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx正式地址(加密):https://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx快递鸟接口技术文档62靠前,实际归属哪家快递公司仍需用户判断.
2.
识别失败,接口返回为空.
3.
快递公司新上线的号段首次会识别失败;进行轨迹订阅并拉取到轨迹后,单号识别接口学习机制会完善此类单号的识别.
4.
3.
4应用场景电商平台、打单工具、ERP系统、WEB端、APP移动端、小程序4.
3.
5应用级参数名称类型(字符长度)是否必须描述LogisticCodeString(30)R快递单号请求示例:{"LogisticCode":"3967950525457"}4.
3.
6返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDLogisticCodeString(30)R快递单号SuccessBool(10)R成功与否(true/false)Codeint(50)O失败原因Shippers.
ShipperCodeString(10)O快递公司编码Shippers.
ShipperNameString(30)O快递公司名称返回示例:{"EBusinessID":"1237100","Success":true,"LogisticCode":"3967950525457",快递鸟接口技术文档63"Shippers":[{"ShipperCode":"YD","ShipperName":"韵达速递"},{"ShipperCode":"YTO","ShipperName":"圆通速递"}]}5增值类接口5.
1在途监控在途监控包含即时查询(增值版)和物流跟踪(增值版),相比普通版,增值版返回报文中增加如下几个参数:1.
增加增值物流状态StateEx和所在城市Location;2.
物流轨迹中增加当前城市Location和当前状态Action.
5.
1.
1即时查询接口(增值版)5.
1.
1.
1功能说明此接口用于向快递公司实时查询物流轨迹信息.
5.
1.
1.
2基本信息接口指令8001支持格式只支持Json格式批量请求不支持,并发不超过10次/S查询次数限制一个自然月内一个单号不限查询次数接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):快递鸟接口技术文档645.
1.
1.
3接口规则1.
返回的物流轨迹信息按照发生时间的升序排列.
2.
快递鸟会员套餐(付费版)自开通当日起一个月(30天)内,免费即时查询接口(RequestType为1002)仍可继续请求测试使用,一个月后将关闭测试权限,会员用户(付费版会员套餐)需调用在途监控接口(RequestType为8001).
5.
1.
1.
4支持情况1.
主流快递公司均支持;2.
顺丰速运:通过快递鸟预约取件接口/电子面单接口返回的顺丰单号,发货后方可查询;其他渠道的顺丰单号,必须通过CustomerName传值正确的收件人/寄件人的手机号码后四位方可查询;3.
京东快递:查询时,必须传商家编码(由发货方提供),且快递单号必须是通过该商家编码下单获取的方可查询.
5.
1.
1.
5应用场景打单工具、查询工具、WEB端、APP移动端、小程序5.
1.
1.
6应用级参数名称类型(字符长度)是否必须描述OrderCodeString(30)O订单编号CustomerNameString(50)CShipperCode为JD,必填,对应京东的青龙配送编码,也叫商家编码,格式:数字+字母+数字,9位数字加一个字母,共10位,举例:001K123450;ShipperCode为SF,且快递单号非快递鸟渠道返回时,必填,对应收件人/寄件人手机号后四位;ShipperCode为SF,且快递单号为快递鸟渠道返回时,不填;ShipperCode为其他快递时,不填ShipperCodeString(10)R快递公司编码详细编码参考《快递鸟接口支持快递公司http://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx正式地址(加密):https://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx快递鸟接口技术文档65编码.
xlsx》LogisticCodeString(30)R快递单号请求示例:5.
1.
1.
7返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDOrderCodeString(30)O订单编号ShipperCodeString(10)R快递公司编码LogisticCodeString(30)R快递单号CallbackString(50)O用户自定义回传字段SuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因StateString(5)R物流状态:0-暂无轨迹信息1-已揽收2-在途中3-签收4-问题件StateExString(5)R增值物流状态:0-暂无轨迹信息1-已揽收ZTO请求示例:{"OrderCode":"","ShipperCode":"ZTO","LogisticCode":"638650888018",}JD请求示例:{"OrderCode":"","CustomerName":"001K12345","ShipperCode":"JD","LogisticCode":"VA00003618100",}快递鸟接口技术文档662-在途中201-到达派件城市202-派件中211-已放入快递柜或驿站3-已签收301-正常签收302-派件异常后最终签收304-代收签收311-快递柜或驿站签收4-问题件401-发货无信息402-超时未签收403-超时未更新404-拒收(退件)405-派件异常406-退货签收407-退货未签收412-快递柜或驿站超时未取LocationString(20)R所在城市Traces.
AcceptTimeDateR轨迹发生时间Traces.
AcceptStationString(100)R轨迹描述Traces.
LocationString(20)R当前城市Traces.
ActionString(50)R当前状态(同StateEx)Traces.
RemarkString(60)O备注返回示例:{"EBusinessID":"1237100","ShipperCode":"YD","Success":true,"LogisticCode":"390141793061","State":"3","StateEx":"3","Location":"威海市","Traces":[{"AcceptTime":"2016-10-2618:31:38","AcceptStation":"【北京环铁站】的【互优图书】已收件",快递鸟接口技术文档67"Location":"北京市","Action":"1"},{"AcceptTime":"2016-10-2619:53:50","AcceptStation":"快件在【北京环铁站】装车,正发往【北京分拨中心】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2621:00:13","AcceptStation":"快件到达【北京分拨中心】,上一站是【北京环铁站】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2621:06:27","AcceptStation":"快件在【北京分拨中心】装车,正发往【青州分拨中心】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2711:04:43","AcceptStation":"快件到达【北京分拨中心】,上一站是【】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2713:04:43","AcceptStation":"快件在【北京分拨中心】装车,正发往【青州分拨中心】","Location":"北京市","Action":"2"},{"AcceptTime":"2016-10-2720:06:03","AcceptStation":"快件到达【青州分拨中心】,上一站是【】","Location":"潍坊市","Action":"2"快递鸟接口技术文档685.
1.
2物流跟踪接口(增值版)物流跟踪由轨迹订阅接口和轨迹推送接口组成,接入时需要对接二个接口.
},{"AcceptTime":"2016-10-2722:06:03","AcceptStation":"快件在【青州分拨中心】装车,正发往【威海】","Location":"潍坊市","Action":"2"},{"AcceptTime":"2016-10-2809:53:53","AcceptStation":"快件到达【威海】,上一站是【青州分拨中心】","Location":"威海市","Action":"2"},{"AcceptTime":"2016-10-2810:44:39","AcceptStation":"快件到达【威海】,上一站是【青州分拨中心】","Location":"威海市","Action":"2"},{"AcceptTime":"2016-10-2810:48:03","AcceptStation":"【威海】的【王奕凯】正在派件","Location":"威海市","Action":"202"},{"AcceptTime":"2016-10-2818:09:45","AcceptStation":"已签收,签收人是【毕森】,签收网点是【威海】","Location":"威海市","Action":"3"}]}快递鸟接口技术文档695.
1.
2.
1轨迹订阅接口5.
1.
2.
1.
1功能说明1.
此接口用于向快递鸟订阅物流轨迹信息.
2.
支持服务:预约取件.
5.
1.
2.
1.
2基本信息5.
1.
2.
1.
3接口规则1.
接口对订阅的数据不做判断和校验,不校验快递公司编码和单号是否匹配,不判断快递单号是否合法、是否正确、是否重复订阅.
2.
轨迹订阅接口只返回是否订阅成功,不会返回轨迹信息,需开发轨迹推送接口用于接收快递鸟推送的轨迹数据.
3.
快递鸟会员套餐(付费版)自开通当日起一个月(30天)内,免费物流跟踪接口(RequestType为1008)仍可继续请求测试使用,一个月后将关闭测试权限,会员用户(付费版会员套餐)需调用在途监控接口(RequestType为8008).
4.
接口工作原理:用户将快递单号和订单信息向快递鸟订阅成功后,快递鸟向快递公司注册轨迹,当轨迹有更新时,快递公司推送至快递鸟,快递鸟再同步推送至用户,直到运单签收.
5.
1.
2.
1.
4支持情况1.
主流快递公司均支持;接口指令8008支持格式只支持Json格式批量请求不支持,并发不超过30次/S查询次数限制一个自然月内一个单号不限查询次数推送时效0.
5至4小时内接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/api/dist正式地址(加密):https://api.
kdniao.
com/api/dist快递鸟接口技术文档702.
顺丰速运:通过快递鸟预约取件接口/电子面单接口返回的顺丰单号,发货后方可查询;其他渠道的顺丰单号,必须通过CustomerName传值正确的收件人/寄件人的手机号码后四位方可查询;3.
京东快递:订阅时,必须传商家编码(由发货方提供),且快递单号必须是通过该商家编码下单获取的方可查询.
5.
1.
2.
1.
5应用场景电商平台、打单工具、查询工具、ERP系统、WEB端、APP移动端、小程序5.
1.
2.
1.
6应用级参数名称类型(字符长度)是否必须描述CallbackString(50)O用户自定义回传字段MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户WareHouseIDString(30)O仓库标识(备用字段)CustomerNameString(50)CShipperCode为JD,必填,对应京东的青龙配送编码,也叫商家编码,格式:数字+字母+数字,9位数字加一个字母,共10位,举例:001K123450;ShipperCode为SF,且快递单号非快递鸟渠道返回时,必填,对应收件人/寄件人手机号后四位;ShipperCode为SF,且快递单号为快递鸟渠道返回时,不填;ShipperCode为其他快递时,不填ShipperCodeString(10)R快递公司编码详细编码参考《快递鸟接口支持快递公司编码.
xlsx》LogisticCodeString(30)R快递单号OrderCodeString(30)O订单编号快递鸟接口技术文档71MonthCodeString(20)O月结编号PayTypeInt(1)O运费支付方式:1-现付,2-到付,3-月结,4-第三方付(仅SF、KYSY支持)ExpTypeString(2)O详细快递类型参考《快递公司快递业务类型.
xlsx》CostDouble(5)O快递运费OtherCostDouble(5)O其他费用Receiver.
CompanyString(30)O收件人公司Receiver.
NameString(30)R收件人Receiver.
TelString(20)R电话与手机,必填一个Receiver.
MobileString(20)Receiver.
PostCodeString(10)C收件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)Receiver.
ProvinceNameString(20)R收件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Receiver.
CityNameString(20)R收件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")Receiver.
ExpAreaNameString(20)R收件区/县(如福田区,不要缺少"区"或"县")Receiver.
AddressString(100)R收件人详细地址Sender.
CompanyString(30)O发件人公司Sender.
NameString(30)R发件人Sender.
TelString(20)R电话与手机,必填一个Sender.
MobileString(20)Sender.
PostCodeString(10)C发件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)Sender.
ProvinceNameString(20)R发件省(如广东省,不要缺少"省";快递鸟接口技术文档72如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Sender.
CityNameString(20)R发件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")Sender.
ExpAreaNameString(20)R发件区/县(如福田区,不要缺少"区"或"县")Sender.
AddressString(100)R发件人详细地址IsNoticeInt(1)O是否通知快递员上门揽件0-通知,1-不通知,不填则默认为1StartDateDateO上门揽件时间段,格式:YYYY-MM-DDHH24:MM:SSEndDateWeightDouble(10,3)O包裹总重量kgQuantityInt(2)O包裹数,一个包裹对应一个运单号,如果是大于1个包裹,返回则按照子母件的方式返回母运单号和子运单号VolumeDouble(20,3)O包裹总体积m3RemarkString(60)O备注IsSendMessageInt(1)O是否订阅短信:0-不需要,1-需要AddService.
NameString(20)O增值服务名称AddService.
ValueString(30)O增值服务值AddService.
CustomerIDString(30)O客户标识Commodity.
GoodsNameString(100)O商品名称Commodity.
GoodsCodeString(20)O商品编码Commodity.
GoodsquantityInt(5)O商品件数Commodity.
GoodsPriceDouble(10)O商品价格Commodity.
GoodsWeightDouble(10,3)O商品重量kgCommodity.
GoodsDescString(50)O商品描述Commodity.
GoodsVolDouble(15,3)O商品体积m3快递鸟接口技术文档73请求示例:YD请求示例:{"ShipperCode":"YD","OrderCode":"","LogisticCode":"3100707578976","PayType":"1","ExpType":"1","CustomerName":"","CustomerPwd":"","MonthCode":"","IsNotice":"0","Sender":{"Name":"1255760","Tel":"","Mobile":"13700000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Address":"测试地址"},"Receiver":{"Name":"1255760","Tel":"","Mobile":"13800000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"龙华新区","Address":"测试地址2"},"Commodity":[{"GoodsName":"书本"}]}快递鸟接口技术文档745.
1.
2.
1.
7返回参数名称类型(字符长度)是否必须描述JD请求示例:{"ShipperCode":"JD","OrderCode":"","CustomerName":"001K12345","LogisticCode":"VA00003618100","PayType":"1","ExpType":"1","CustomerName":"","CustomerPwd":"","MonthCode":"","IsNotice":"0","Sender":{"Name":"1255760","Tel":"","Mobile":"13700000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Address":"测试地址"},"Receiver":{"Name":"1255760","Tel":"","Mobile":"13800000000","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"龙华新区","Address":"测试地址2"},"Commodity":[{"GoodsName":"书本"}]快递鸟接口技术文档75EBusinessIDString(10)R用户IDUpdateTimeDateR更新时间YYYY-MM-DDHH24:MM:SSSuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因EstimatedDeliveryTimeDateO订单预计到货时间(暂未上线)返回示例:5.
1.
2.
2轨迹推送接口参照4.
2.
3轨迹推送接口5.
2智选物流5.
2.
1运费模板导入接口5.
2.
1.
1功能说明此接口用于向快递鸟传入协议快递公司的运费数据.
5.
2.
1.
2基本信息{"EBusinessID":"1237100","UpdateTime":"2016-08-0916:42:38","Success":true,"Reason":""}接口指令2004支持格式只支持Json格式、UTF-8编码请求方式POST请求接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx快递鸟接口技术文档765.
2.
1.
3接口规则1.
若用户的协议价格发生变化(新增、修改或删除),用户需将运费全量数据同步至快递鸟,快递鸟将对运费数据进行全量更新.
2.
MemberID和WarehouseID二个字段的传值必须与智选物流接口中的保持一致,可不传值,若传值则必须一致,否则影响计算结果.
5.
2.
1.
4应用级参数名称类型(字符长度)是否必须描述MemberIDString(50)RERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户WarehouseIDString(50)O仓库ID(备用字段)Detail.
ShipperCodeString(10)R快递公司编码Detail.
ExpenseTemplateString(50)O运费模板名称Detail.
SendProvinceString(20)R发件省Detail.
SendCityString(20)O发件市Detail.
SendExpAreaString(20)O发件区Detail.
ReceiveProvinceString(20)R收件省Detail.
ReceiveCityString(20)O收件市Detail.
ReceiveExpAreaString(20)O收件区Detail.
ShippingTypeInt(1)R运费类型0-首续计费1-区间计费2-重量公式Detail.
FirstWeightDouble(10)C首重(KG)(Detail.
ShippingType为0时必填)Detail.
FirstFeeDouble(10)首重价格(Detail.
ShippingType为0时必填)正式地址(加密):https://api.
kdniao.
com/Ebusiness/EbusinessOrderHandle.
aspx快递鸟接口技术文档77Detail.
AdditionalWeightDouble(10)续重(KG)(Detail.
ShippingType为0时必填)Detail.
AdditionalFeeDouble(10)续重价格(Detail.
ShippingType为0时必填)Detail.
IntervalList.
StartWeightDouble(10)C开始重量(KG)(Detail.
ShippingType为1时必填)Detail.
IntervalList.
EndWeightDouble(10)结束重量(KG)(Detail.
ShippingType为1时必填)Detail.
IntervalList.
FeeDouble(10)费用(元)(Detail.
ShippingType为1时必填)Detail.
WeightFormulaString(200)C重量公式(有重量计算公式的默认使用公式进行计算,用户可使用W代替重量,使用{[()]}大中小括号进行公式的计算,如:{{w-0}-0.
4}*{{{1000-w}-0.
4}+1}*4.
700+{{w-1000}-0.
6}*[(w-1000)/1000]*4.
700)请求示例:{"MemberID":"123456","WarehouseID":"123456","Detail":[{"ShipperCode":"SF","ExpenseTemplate":"次日达","SendProvince":"广东","SendCity":"广州","SendExpArea":"天河",快递鸟接口技术文档78"ReceiveProvince":"广东","ReceiveCity":"深圳","ReceiveExpArea":"龙岗","ShippingType":0"FirstWeight":"1","FirstFee":"8","AdditionalWeight":"1","AdditionalFee":"10","WeightFormula":""},{"ShipperCode":"YD","ExpenseTemplate":"","SendProvince":"广东","SendCity":"广州","SendExpArea":"天河","ReceiveProvince":"湖南","ReceiveCity":"长沙","ReceiveExpArea":"雨花","ShippingType":0"FirstWeight":"","FirstFee":"","AdditionalWeight":"","AdditionalFee":"","WeightFormula":"{{w-0}-0.
4}*{{{1000-w}-0.
4}+1}*4.
700+{{w-1000}-0.
6}*[(w-1000)/1000]*4.
700"}]}5.
2.
1.
5返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDMemberIDString(50)RERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户快递鸟接口技术文档79SuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因返回示例:{"EBusinessID":"1237100","Success":true,"MemberID":"123456"}5.
2.
2智选物流接口5.
2.
2.
1功能说明此接口用于快递鸟向用户智能推荐快递公司.
5.
2.
2.
2基本信息5.
2.
2.
3接口规则MemberID和WarehouseID二个字段的传值必须与运费模板导入接口的传值保持一致,可不传值,若传值则必须一致,否则影响计算结果.
5.
2.
2.
4应用级参数名称类型(字符长度)是否必须描述MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户接口指令2006支持格式只支持Json格式、UTF-8编码请求方式POST请求接口地址沙箱地址:http://sandboxapi.
kdniao.
com:8080/kdniaosandbox/gateway/exterfaceInvoke.
json正式地址(不加密):http://api.
kdniao.
com/api/exrecommend正式地址(加密):https://api.
kdniao.
com/api/exrecommend快递鸟接口技术文档80WarehouseIDString(50)O仓库IDDetail.
OrderCodeString(30)R订单编号(自定义,不可重复)Detail.
OriginalExpCodeString(10)O原使用快递公司编码Detail.
EstimatedShipTimeDateO预计发货时间,格式:YYYY-MM-DDHH24:MM:SSDetail.
Receiver.
ProvinceNameString(20)R收件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Detail.
Receiver.
CityNameString(20)R收件市(如深圳市,不要缺少"市")Detail.
Receiver.
ExpAreaNameString(20)R收件区(如福田区,不要缺少"区"或"县")Detail.
Receiver.
SubdistrictString(50)O收件街道(如华强北街道)Detail.
Receiver.
AddressString(100)R收件人详细地址Detail.
Sender.
ProvinceNameString(20)R发件省(如广东省,不要缺少"省";如是直辖市,请直接传北京、上海等;如是自治区,请直接传广西壮族自治区等)Detail.
Sender.
CityNameString(20)R发件市(如深圳市,不要缺少"市;如是市辖区,请直接传北京市、上海市等")Detail.
Sender.
ExpAreaNameString(20)R发件区(如福田区,不要缺少"区"或"县")Detail.
Sender.
SubdistrictString(50)O发件街道(如华强北街道)Detail.
Sender.
AddressString(100)R发件人详细地址Detail.
IsCODInt(1)R是否代收货款:0.
否,1.
是Detail.
ExpressList.
ExpCodeString(10)R快递公司编码Detail.
ExpressList.
FirstWeightDouble(10)O首重(KG)Detail.
ExpressList.
FirstDouble(10)O首重价格(元)Detail.
ExpressList.
AdditionalWeightDouble(10)O续重(KG)Detail.
ExpressList.
AdditionalDouble(10)O续重价格(元)Detail.
ExpressList.
WeightFormulaString(200)O重量公式【+号使用@替换】(有重量计算公式的默认使用公式快递鸟接口技术文档81进行计算,用户可使用W代替重量,使用{[()]}大中小括号进行公式的计算,如:{{w-0}-0.
4}*{{{1000-w}-0.
4}+1}*4.
700+{{w-1000}-0.
6}*[(w-1000)/1000]*4.
700)Detail.
Goods.
ProductNameString(100)R商品名称Detail.
Goods.
VolumeDouble(20)O商品体积m3Detail.
Goods.
WeightDouble(10)O商品重量kgDetail.
NonuseExpressstring(100)O不使用的物流公司列表(格式为:快递公司编码1,快递公司编码2)Detail.
BuyerRemarkString(100)O买家留言Detail.
CustomerRemarkString(100)O客服备注Detail.
EnableAirlinesInt(1)O是否航空禁运:0.
否,1.
是请求示例:{"MemberID":"123456","WarehouseID":"1","Detail":[{"OrderCode":"12345","OriginalExpCode":"SF","EstimatedShipTime":"2017-02-1612:13:12""IsCOD":0,"Sender":{"ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Subdistrict":"福保街道","Address":"保税区金花路29号"},"Receiver":{"ProvinceName":"广东省","CityName":"深圳市",快递鸟接口技术文档82"ExpAreaName":"福田区","Subdistrict":"福保街道","Address":"保税区金花路29号"},"Goods":[{"ProductName":"包","Volume":"","Weight":"1"}]},{"OrderCode":"12346","IsCOD":0,"Sender":{"ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Subdistrict":"福保街道","Address":"保税区金花路29号"},"Receiver":{"ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Subdistrict":"福保街道","Address":"保税区金花路29号"},"Goods":[{"ProductName":"包","Volume":"","Weight":"1"}]}]快递鸟接口技术文档83}5.
2.
2.
5返回参数名称类型(字符长度)是否必须描述RecommendDetail.
OrderCodeString(30)R订单编号RecommendDetail.
ExpressList.
ExpCodeString(10)R快递公司编码RecommendDetail.
ExpressList.
ExpNameString(50)R快递公司名称RecommendDetail.
ExpressList.
ExpenseTemplateString(50)R运费模板名称RecommendDetail.
ExpressList.
RecommendReasonInt(1)R0-综合1-最便宜2-最快3-备选RecommendDetail.
ExpressList.
IsSupportInt(1)R是否在派送范围0-不在,1-在RecommendDetail.
ExpressList.
FeeDouble(10)O总运费(元)RecommendDetail.
ExpressList.
EstimatedDeliveryTimeDouble(10)O时效(预计到达时长:小时)RecommendDetail.
ExpressList.
SpecificDeliveryTimeDateO到达时间YYYY-MM-DDHH24:MMRecommendDetail.
ExpressList.
ShipperTemplateString(10)O快递类型RecommendDetail.
ExpressList.
RemarkString(60)O备注返回示例:{"EBusinessID":"1237100","Success":true,"RecommendDetail":[{"ExpressList":[{快递鸟接口技术文档84"ExpCode":"ZTO","ExpName":"中通快递","LineName":"","Fee":10.
00,"EstimatedDeliveryTime":44.
20,"SpecificDeliveryTime":"2017-02-1209:12","IsSupport":"1","RecommendReason":0,"Remark":""},{"ExpCode":"ZTO","ExpName":"中通快递","LineName":"","Fee":10.
00,"EstimatedDeliveryTime":44.
20,"IsSupport":"1","RecommendReason":1,"Remark":""},{"ExpCode":"JYM","ExpName":"加运美","SpecificDeliveryTime":"2017-02-1209:12","LineName":"","EstimatedDeliveryTime":15.
23,"IsSupport":"1","RecommendReason":2,"Remark":""}],"OrderCode":"12345"},{"ExpressList":[{"ExpCode":"ZTO","ExpName":"中通快递",快递鸟接口技术文档85"SpecificDeliveryTime":"2017-02-1209:12","LineName":"","Fee":16.
00,"EstimatedDeliveryTime":48.
26,"IsSupport":"1","RecommendReason":0,"Remark":""},{"ExpCode":"ZTO","ExpName":"中通快递","SpecificDeliveryTime":"2017-02-1209:12","LineName":"","Fee":16.
00,"EstimatedDeliveryTime":48.
26,"IsSupport":"1","RecommendReason":1,"Remark":""},{"ExpCode":"SF","ExpName":"顺丰速运","LineName":"","EstimatedDeliveryTime":38.
33,"IsSupport":"1","RecommendReason":2,"Remark":""}],"OrderCode":"12346"}]}5.
3短信服务通过电子面单接口、轨迹订阅接口、短信发送接口要求订阅短信的,可以触发短信服务.
快递鸟接口技术文档865.
3.
1短信模板接口5.
3.
1.
1功能说明此接口用于发送短信前事先设置短信模板和发送规则.
5.
3.
1.
2基本信息5.
3.
1.
3接口规则1.
非平台性的客户,可直接在快递鸟官网-物流短信中设置相应的短信模板,无需对接此接口.
2.
所有接入短信业务的用户先必须在用户管理后台报备签名,否则无法发送.
3.
短信内容需遵守《互联网新闻信息服务管理规定》,严禁发送非法、反动、色情、暴力、谩骂、诈骗、恐吓等被禁止的内容.
4.
短信模板内容少于10个字或者发送重复的文字等都会被识别为无用信息,否则无法发送.
5.
3.
1.
4应用级参数名称类型(字符长度)是否必须描述Detail.
TemplateTypeInt(1)R模板ID:1-寄件通知短信接口指令8102支持格式只支持Json格式接口地址测试地址:http://testapi.
kdniao.
com:8081/api/dist正式地址(不加密):http://api.
kdniao.
com/api/dist正式地址(加密):https://api.
kdniao.
com/api/dist快递鸟接口技术文档872-到达派件城市通知短信3-派件中通快递知短信4-问题件通知短信5-已签收通知短信6-纯营销短信7-自定义通知短信Detail.
MessageTemplateString(500)R模板内容Detail.
IsOpenString(1)R是否开启(0否1是)Detail.
SendTypeInt(1)C发送人类型(0-收件人,1-寄件人,2-收寄件人)TemplateType为6或7时不填MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户请求示例:{"Detail":[{"TemplateType":"6","MessageTemplate":"短信模板","IsOpen":0,"SendType":2}],"MemberID":"123456"}5.
3.
1.
5返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDSuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因返回示例:快递鸟接口技术文档88{"EBusinessID":"1237100","Success":true}5.
3.
2短信发送接口5.
3.
2.
1功能说明此接口用于实时发送短信(如:纯营销短信、自定义通知短信).
5.
3.
2.
2基本信息5.
3.
2.
3接口规则1.
营销短信模板需添加【回复TD退订】字样,否则无法发送.
2.
营销类短信发送时间为8:30-20:00,其他时间提交的短信则顺延至次日8:30之后.
3.
自定义通知短信发送无时间限制.
5.
3.
2.
4应用级参数名称类型(字符长度)是否必须描述MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户(与短信模板接口MemberID接口指令8101支持格式只支持Json格式批量交易支持,每次请求不超过100条接口地址测试地址:http://testapi.
kdniao.
com:8081/api/dist正式地址(不加密):http://api.
kdniao.
com/api/dist正式地址(加密):https://api.
kdniao.
com/api/dist快递鸟接口技术文档89一致,如未传则为空)CallbackString(50)O用户自定义回传字段TemplateTypeIntR模板ID(请在快递鸟官网-物流短信查看对应模板ID)Detail.
ReceiverNameString(30)O姓名Detail.
ReceiverMobileString(20)R手机号码Detail.
Data.
ShipperCodeString(20)C快递公司编码TemplateType为自定义通知短信时至少必填一个Detail.
Data.
LogisticCodeString(30)C快递单号Detail.
Data.
CreateTimeDateC时间Detail.
Data.
CodeString(30)C验证码Detail.
Data.
MobileString(20)C手机号码请求示例:{"Detail":[{"ReceiverMobile":"180******71","ReceiverName":"张三","Data":"{'Password':'123456','Account':'test'}"}],"TemplateType":7,"CallBack":""}5.
3.
2.
5返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDOrderCodeString(30)R订单编号SuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因返回示例:快递鸟接口技术文档90{"EBusinessID":"1237100","OrderCode":"17052314055137647350","Success":true,}5.
3.
3短信黑名单接口5.
3.
3.
1功能说明此接口用于设置短信黑名单.
5.
3.
3.
2基本信息5.
3.
3.
3接口规则黑名单中的手机号码与用户ID绑定,只影响绑定ID通过快递鸟通道的短信发送.
5.
3.
3.
4应用级参数名称类型(字符长度)是否必须描述Detail.
MobileString(20)R手机号码Detail.
IsBlackInt(1)R是否黑名单(0否,1是)MemberIDString(50)OERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户请求示例:{接口指令8103支持格式只支持Json格式接口地址测试地址:http://testapi.
kdniao.
com:8081/api/dist正式地址(不加密):http://api.
kdniao.
com/api/dist正式地址(加密):https://api.
kdniao.
com/api/dist快递鸟接口技术文档91"Detail":[{"Mobile":"15814460948","IsBlack":0}],"MemberID":"123456"}5.
3.
3.
5返回参数名称类型(字符长度)是否必须描述EBusinessIDString(10)R用户IDSuccessBool(10)R成功与否(true/false)ReasonString(50)O失败原因返回示例:{"EBusinessID":"1237100","Success":true}6附录6.
1接口指令汇总接口名称接口指令下单类接口预约取件接口1001预约取件取消接口1004电子面单接口1007电子面单取消接口1147单号余量查询接口1127客户号申请接口1107客户号推送接口1117快递鸟接口技术文档92实名寄递接口1021轨迹查询类接口即时查询接口1002轨迹订阅接口1008轨迹推送接口101单号识别接口2002增值类接口即时查询(增值版)8001轨迹订阅(增值版)8008轨迹推送接口102运费模板导入接口2004智选物流接口2006短信模板接口8102短信发送接口8101短信黑名单接口81036.
2对接相关资料1.
技术对接产品文档:http://kdniao.
com/documents2.
技术对接常见问题:http://kdniao.
com/help3.
各群文件6.
3电子面单模板规格快递公司名称编码模板样式尺寸规格TemplateSize字段CustomArea字段安能快递ANE二联180宽100m高180mm切点110/70默认返回,不能传值/安能快运ANEKY二联180宽100m高180mm切点110/70默认返回,不能传值支持承诺达CND二联180宽100m高180mm默认返回,不能传值支持快递鸟接口技术文档93切点110/70德邦快递DBL二联177宽100mm高177mm切点107/70默认返回,不能传值/二联177新宽100mm高177mm切点107/70传值18001/三联177新宽100mm高177mm切点107/30/40传值18002/德邦快运DBLKY三联180宽100mm高180mm切点110/30/40默认返回,不能传值支持丹鸟物流DNWL一联130宽76m高130mm传值130支持EMSEMS二联150宽100mm高150mm切点90/60默认返回,不能传值/二联180宽100m高180mm切点110/70传值180/百世快递HTKY二联180宽100m高180mm切点110/70默认返回,不能传值/二联180新宽100m高180mm切点110/70传值180支持一联130宽76m高130mm传值130支持百世快运HTKYKY二联180宽100m高180mm切点110/70默认返回,不能传值支持佳吉快运CNEX一联100宽90m高100mm默认返回,不能传值/快递鸟接口技术文档94京东快递JD二联110宽100mm高110mm切点60/50默认返回,不能传值/二联110新宽100mm高110mm切点60/50传值110/京东快运JDKY二联110宽100mm高110mm切点60/50默认返回,不能传值/极兔速递JTSD一联130宽76m高130mm传值130支持二联180宽100m高180mm切点110/70默认返回,不能传值支持跨越速运KYSY二联137宽100mm高137mm切点101/36默认返回,不能传值支持三联210宽100mm高210mm切点90/60/60传值210支持龙邦快运LB三联104宽75mm高104mm默认返回,不能传值/联昊通速递LHT二联150宽100mm高150mm切点90/60默认返回,不能传值/品骏快递PJ一联120宽80mm高120mm默认返回,不能传值/全一快递UAPEX二联150宽100mm高150mm切点90/60默认返回,不能传值支持顺丰速运SF二联150宽100mm高150mm切点90/60默认返回,不能传值/快递鸟接口技术文档95三联210宽100mm高210mm切点90/60/60传值210/二联150新宽100mm高150mm切点90/60传值15001支持二联180新宽100m高180mm切点110/70传值180支持三联210新宽100mm高210mm切点90/60/60传值21001支持申通快递STO二联150宽100mm高150mm切点90/60传值150/二联180宽100m高180mm切点110/70默认返回,不能传值/二联180新宽100m高180mm切点110/70传值180支持三联180新宽100mm高180mm切点110/30/40传值18003支持一联130宽76m高130mm传值130支持速尔快递SURE二联150宽100mm高150mm切点90/60默认返回,不能传值/二联150新宽100mm高150mm切点90/60传值150支持二联180新宽100m高180mm传值180支持快递鸟接口技术文档96切点110/70顺心捷达SX一联105宽75mm高105mm默认返回,不能传值/苏宁物流SNWL二联180宽100m高180mm切点110/70默认返回,不能传值支持腾林物流TLWL一联70宽100mm高70mm默认返回,不能传值/天地华宇HOAU二联180宽100m高180mm切点110/70默认返回,不能传值支持天天快递HHTT二联180宽100m高180mm切点110/70默认返回,不能传值/信丰物流XFEX二联150宽100mm高150mm切点90/60默认返回,不能传值/韵达速递YD二联203宽100mm高203mm切点152/51默认返回,不能传值/二联180宽100m高180mm切点110/70传值180支持一联130宽76m高130mm传值130支持韵达快运YDKY二联180宽100m高180mm切点110/70默认返回,不能传值支持圆通速递YTO二联180宽100m高180mm切点110/70默认返回,不能传值/三联180宽100mm高180mm切点110/30/40传值180/快递鸟接口技术文档97二联180新宽100m高180mm切点110/70传值18001支持一联130宽76m高130mm传值130支持邮政国内标快YZBK二联150宽100mm高150mm切点90/60默认返回,不能传值/邮政快递包裹YZPY二联180宽100m高180mm切点110/70默认返回,不能传值/二联180新宽100m高180mm切点110/70传值180支持优速快递UC二联180宽100m高180mm切点110/70默认返回,不能传值/远成快运YCWL二联180宽100m高180mm切点110/70默认返回,不能传值/宅急送ZJS二联120宽100mm高116mm切点98/18默认返回,不能传值/二联180宽100m高180mm切点110/70传值180支持二联120新宽100mm高116mm切点98/18传值120/中通快递ZTO二联180宽100m高180mm切点110/70默认返回,不能传值/快递鸟接口技术文档98二联180新宽100m高180mm切点110/70传值180支持一联130宽76m高130mm传值130支持中通快运ZTOKY二联180宽100m高180mm切点110/70默认返回,不能传值/6.
4返回编码列表成功编码描述100成功错误编码描述101缺少必要参数102校验问题103格式问题104用户问题105其他错误201填写的寄件方信息有误,请核实确认202填写的到件方信息有误,请核实确认203填写的快递公司电子面单账号密码有误,请核实确认204账户余额不足请联系快递网点充值205订单编号重复,请勿重复下单206订单编号不能为空207单号不足请联系快递网点充值208快递类型不能为空209运费支付方式有误210增值服务名称有误211月结编号不合法212代收货款信息有误213预约时间超出网点营业时间,请更换预约时间214日期格式错误215商品名称不能为空216手机或电话存在特殊字符快递鸟接口技术文档99217数据含有特殊字符218数据内容太长219限寄物品220预约时间小于当前时间或用户取消订单221包裹总体积不合法222必填项不能为空223订单备注超长224京东正在人工筛选是否可派送,请15分钟后重试225该订单地址已超出京东派送范围106该订单号已下单成功401RequestData格式有误402缺少快递单号403快递单号有特殊字符404快递单号长度不符405超出查询次数限制(日查询次数<=3万)7技术支持联系方式号码技术支持QQ群665031725/844089794商务咨询群526574204投诉建议反馈QQ3185726742400热线400-9633-321END
- 接口快递员持刀砍客户相关文档
- 回访快递员持刀砍客户
- 月亮快递员持刀砍客户
- 报告快递员持刀砍客户
- 快递快递员持刀砍客户
- 送达快递员持刀砍客户
- 接口快递员持刀砍客户
iON Cloud：新加坡cn2 gia vps/1核/2G内存/25G SSD/250G流量/10M带宽,$35/月
iON Cloud怎么样?iON Cloud升级了新加坡CN2 VPS的带宽和流量最低配的原先带宽5M现在升级为10M，流量也从原先的150G升级为250G。注意，流量也仅计算出站方向。iON Cloud是Krypt旗下的云服务器品牌，成立于2019年，是美国老牌机房(1998~)krypt旗下的VPS云服务器品牌，主打国外VPS云服务器业务，均采用KVM架构，整体性能配置较高，云服务器产品质量靠...
半月湾($59.99/年),升级带宽至200M起步 三网CN2 GIA线路
在前面的文章中就有介绍到半月湾Half Moon Bay Cloud服务商有提供洛杉矶DC5数据中心云服务器，这个堪比我们可能熟悉的某服务商，如果我们有用过的话会发现这个服务商的价格比较贵，而且一直缺货。这里，于是半月湾服务商看到机会来了，于是有新增同机房的CN2 GIA优化线路。在之前的文章中介绍到Half Moon Bay Cloud DC5机房且进行过测评。这次的变化是从原来基础的年付49....
零途云：香港站群云服务器16IP220元/月，云服务器低至39元/月
零途云(Lingtuyun.com)新上了香港站群云服务器 – CN2精品线路，香港多ip站群云服务器16IP/5M带宽,4H4G仅220元/月，还有美国200g高防云服务器低至39元/月起。零途云是一家香港公司，主要产品香港cn2 gia线路、美国Cera线路云主机，美国CERA高防服务器，日本CN2直连服务器;同时提供香港多ip站群云服务器。即日起，购买香港/美国/日本云服务器享受9折优惠，新...
快递员持刀砍客户为你推荐
-
uctools为什么一直服务器暂不可用phpcms模板phpcms为什么PHPCMS就是不能出一套好看的默认模板新iphone也将禁售苹果手机现在在中国是不是不能卖了汉字cuteftp加多宝和王老吉加多宝和王老吉什么关系 王老吉和加多宝哪个正宗我爱试用网我发现我对性爱这个话题好敏感！来吧看谁能把我下面说湿了？要200以上的才好评啊！35互联在中国哪家服务商提供的企业邮箱好呢?三五互联股票三五互联是干什么的？什么是seoSEO网站优化是什么啊？最土团购程序团购网真实吗，流程是什么？