一、 商家寄件运力接口

查询全国快递公司运力覆盖情况。

1.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

1.2 请求地址

https://order.kuaidi100.com/order/borderbestapi.do

请求参数:

参数名是否必填类型说明
methodstring业务类型(默认:querymkt)
keystring授权码,请到快递100页面<a href="https://api.kuaidi100.com/register/enterprise" target="_blank" rel="nofollow noopener noreferrer" style="color: #017eff;">申请企业版</a>接口获取
signstring32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号 secret可在企业管理后台查看
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
sendAddrstring寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10

1.3 返回结果

字段类型说明备注
resultboolean提交结果true提交成功,false失败
returnCodestring返回编码
messagestring返回报文描述
datadata

data数据结构

字段类型说明备注
provincestring
citystring
districtstring
addrstring地址
latitudestring经度
longitudestring纬度
mktInfomktInfo覆盖运力快递公司列表

mktInfo数据结构

字段类型说明备注
serviceTypestring业务服务类型
mktIdstring内部属性忽略
kuaidiComstring支持的快递公司编码
bigCustPriceDOListstring内部属性忽略

1.4 提供数据内容

  1. {
  2. "data": {
  3. "province": "广东",
  4. "city": "深圳市",
  5. "district": "南山区",
  6. "latitude": "22.465335763306832",
  7. "mktInfo": [
  8. {
  9. "serviceType": [
  10. "快递包裹"
  11. ],
  12. "mktId": 98959397,
  13. "kuaidiCom": "youzhengguonei",
  14. "bigCustPriceDOList": null
  15. },
  16. {
  17. "serviceType": null,
  18. "mktId": 98959397,
  19. "kuaidiCom": "zhaijisong",
  20. "bigCustPriceDOList": null
  21. }
  22. ],
  23. "addr": "海运大厦",
  24. "longitude": "113.88346197876328"
  25. },
  26. "message": "成功",
  27. "result": true,
  28. "returnCode": "200"
  29. }

1.5 信息代码含义

信息代码信息内容描述原因及建议处理方式
200提交成功提交成功
201无法获取运力该地址没有快递公司运力,需联系快递100工作人员添加
400参数错误请根据技术文档请求,注意参数类型及是否必填。
400非法IP请联系快递100工作人员添加白名单
500服务器错误快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误
500没法识别到寄件地址/地址缺失市区/地址缺失区信息/没有填入寄件人地址地址错误,请填写完整的地址信息
503签名认证失败请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号
600您不是合法的用户(即授权Key出错)账号无可用单量,需要充值
601KEY已过期账号无可用单量,需要充值

二 、商家寄件(优选)下单接口

选择快递公司进行下单。

2.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

2.2 请求地址

https://order.kuaidi100.com/order/borderbestapi.do

请求参数:

参数名是否必填类型说明
methodstring业务类型(默认:bOrderBest)
keystring授权码,请<a href="https://api.kuaidi100.com/register/enterprise" target="_blank">申请企业版</a>获取
signstring32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret在企业管理后台查看
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
kuaidicomstring快递公司的编码,一律用小写字母,见《快递公司编码》
recManNamestring收件人姓名
recManMobilestring收件人的手机号,手机号和电话号二者其一必填
recManPrintAddrstring收件人所在完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园
sendManNamestring寄件人姓名
sendManMobilestring寄件人的手机号,手机号和电话号二者其一必填
sendManPrintAddrstring寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10
callBackUrlstringcallBackUrl订单信息回调
cargostring物品名称,例:文件
weightstring物品总重量KG,不需带单位,例:1.5
serviceTypestring快递业务服务类型,例:标准快递,默认为标准快递
remarkstring备注
saltstring签名用随机字符串

2.3 返回结果

字段类型说明备注
resultboolean提交结果true提交成功,false失败
returnCodestring返回编码
messagestring返回报文描述
datadata

data数据结构

字段类型说明备注
taskIdstring任务ID
orderIdstring订单ID

2.4 返回结果示例

  1. {
  2. "result": true,
  3. "returnCode": "200",
  4. "message": "提交成功",
  5. "data": {
  6. "taskId": "****", // 任务ID
  7. "orderId ": "****" // 订单ID
  8. }
  9. }

2.5 信息代码含义

信息代码信息内容描述原因及建议处理方式
200提交成功提交成功
400参数错误请根据技术文档请求,注意参数类型及是否必填。
500服务器错误快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误
500下单失败请根据技术文档请求,注意参数类型及是否必填。
503签名认证失败请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号
600您不是合法的用户(即授权Key出错)账号无可用单量,需要充值
601KEY已过期账号无可用单量,需要充值
700错误的回调地址检查回调地址,或者联系快递100工作人员

三、下单回调接口

订单有状态变更是会触发回调,回调后如果没有得到合作方正确返回,会重复回调多2次,即最多回调3次。间隔30分钟。

3.1 接口格式

提供统一格式的HTTP POST,并返回统一格式JSON数据。

请求报头:Content-Type=application/x-www-form-urlencoded;charset=UTF-8

3.2 请求地址

请求参数:

字段类型说明备注
taskIdstring任务ID
signstring签名MD5 (param +salt)
paramparam参数主体

param数据结构:

参数名是否必填类型说明
kuaidicomstring快递公司的编码,一律用小写字母,见《快递公司编码》,选填。
kuaidinumstring快递单号,单号的最大长度是32个字符。
statusstring状态码
messagestring状态描述
datadata订单内容

data数据结构:

参数名是否必填类型说明
orderIdstring平台订单ID
statusstring订单状态: 1,’已接单’, 2,’收件中’, 3,’改派’, 7,’快递员修改订单信息’, 9,’用户主动取消’, 10,’已取件’, 15,’已结算’, 99,’订单已取消’, 101, ‘运输中’
courierNamestring快递员姓名
courierMobilestring快递员电话
weightstring重量
freightstring运费

3.3 返回结果

字段说明备注
result提交结果true提交成功,false失败
returnCode返回编码
message返回报文描述

3.4 返回结果示例

  1. {
  2. "result": true,
  3. "returnCode": "200",
  4. "message": "提交成功"
  5. }

3.5 回调响应报文及错误码解释

字段名称字段含义
resulttrue表示成功,false表示失败。如果提交回调接口的地址失败,30分钟后重新回调,3次仍旧失败的,自动放弃
returnCode200: 提交成功 500: 服务器错误 其他错误请自行定义
message返回的提示

其他信息快递100会忽略。

四、商家寄件下单取消接口

对下完单进行取消操作

4.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

4.2 请求地址

https://order.kuaidi100.com/order/borderbestapi.do

请求参数:

参数名是否必填类型说明
methodstring业务类型(默认:cancelBest)
keystring授权码, 请<a href="https://api.kuaidi100.com/register/enterprise" target="_blank">申请企业版</a>获取
signstring32**位大写,**签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号。secret在企业管理后台可以查看。
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
taskIdstring任务ID
orderIdstring订单ID
cancelMsgstring取消原因,例:暂时不寄件了

4.3 返回结果

字段类型说明备注
resultboolean提交结果true提交成功,false失败
returnCodestring返回编码
messagestring返回报文描述
datadata这里默认为空

4.4 返回结果示例

  1. {
  2. "result": true,
  3. "returnCode": "200",
  4. "message": "提交成功",
  5. "data": {}
  6. }

4.5 信息代码含义

信息代码信息内容描述原因及建议处理方式
200提交成功提交成功
400参数错误请根据技术文档请求,注意参数类型及是否必填。
500服务器错误快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误
501重复提交重复提交了请求
503签名认证失败请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号
600您不是合法的用户(即授权Key出错)账号无可用单量,需要充值
601KEY已过期账号无可用单量,需要充值

五、快递公司编码

快递公司编码
中通zhongtong
圆通yuantong
申通shentong
韵达yunda
天天tiantian
百世(汇通)huitongkuaidi
宅急送zhaijisong
极兔jtexpress

官方文档:

http://api.kuaidi100.com/document/5f0ff0a5bc8da837cbd8aef7.html

更多相关文章

  1. 快递物流官方商家寄件下单API接口案例代码-非第三方集成
  2. SpringMVC_Day01
  3. 电商快递物流电子面单复打API接口案例
  4. python学习随笔-数据类型
  5. $()的四种类型; jQuery方法;jQuery对象转js对象的方法----0413
  6. 一文读懂java中的Reference和引用类型
  7. java中的类型擦除type erasure
  8. java 8中构建无限的stream
  9. Java泛型Type

随机推荐

  1. Android之开发常用颜色
  2. 像写Flutter一样开发Android原生应用
  3. Android 中文API (67) —— BluetoothClass
  4. 使用ImageView 加上 Edittext做出自定义
  5. android和PC(Python)通过USB(adb模式)基于Soc
  6. Android 中文API (68) —— BluetoothClass
  7. Android(安卓)驱动之旅 第五章: 在Android
  8. [Android]-图片JNI(C++\Java)高斯模糊的实
  9. Android(安卓)滑动绘制流程探究 系统是如
  10. Android(安卓)微信支付总结