文档中心
一、商家寄件(官方)下单接口 二、下单回调接口 三、商家寄件下单取消接口 四、商家寄件下单运力价格接口 五、快递公司编码

快递公司寄件接口

一、商家寄件(官方)下单接口

选择快递公司进行下单。

1.1 接口格式

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

1.2 请求地址

https://poll.kuaidi100.com/order/borderapi.do

请求参数:

参数名是否必填类型说明
methodstring业务类型(默认:bOrder)
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在授权邮件里面有
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
kuaidicomstring快递公司的编码,一律用小写字母,见《快递公司编码》
recManNamestring收件人姓名
recManMobilestring收件人的手机号,手机号和电话号二者其一必填
recManPrintAddrstring收件人所在完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园
sendManNamestring寄件人姓名
sendManMobilestring寄件人的手机号,手机号和电话号二者其一必填
sendManPrintAddrstring寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10
callBackUrlstringcallBackUrl订单信息回调
cargostring物品名称,例:文件。当kuaidicom=jd时,必填
paymentstring支付方式,SHIPPER: 寄付(默认)。不支持到付
weightstring物品总重量KG,不需带单位,例:1.5
remarkstring备注
saltstring签名用随机字符串
dayTypestring预约日期,例如:今天/明天/后天
pickupStartTimestring预约起始时间(HH:mm),例如:09:00
pickupEndTimestring预约截止时间(HH:mm),例如:10:00

1.3 返回结果

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

data数据结构

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

1.4 返回结果示例

{
    "result": true,
    "returnCode": "200",
    "message": "提交成功",
    "data": {
		"taskId": "",	// 任务ID
		"orderId": ""	// 订单ID
    }
} 

说明:

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

二、下单回调接口

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

2.1 接口格式

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

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

2.2 请求地址

请求参数:

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

param数据结构:

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

data数据结构:

参数名是否必填类型说明
orderIdstring平台订单ID
statusstring订单状态: '0,'下单成功', 1,'已接单', 2,'收件中', 9,'用户主动取消', 10,'已取件', 11,'揽货失败', 12,'已退回', 13,'已签收', 14,'异常签收',15,'已结算' 99,'订单已取消'101,'运输中'
courierNamestring快递员姓名
courierMobilestring快递员电话
weightstring重量
freightstring运费

2.3 返回结果

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

2.4 返回结果示例

{

		"result":true,

		"returnCode":"200",

		"message":"成功"

} 

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

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

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

对下完单进行取消操作

3.1 接口格式

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

3.2 请求地址

https://poll.kuaidi100.com/order/borderapi.do

请求参数:

参数名是否必填类型说明
methodstring业务类型(默认:cancel)
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在授权邮件里面有
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

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

3.3 返回结果

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

3.4 返回结果示例

{

		"result":true,

		"returnCode":"200",

		"message":"取消成功",

		"data":{}

} 

说明:

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

四、商家寄件下单运力价格接口

查看从出发地到全国的运力价格

4.1 接口格式

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

4.2 请求地址

https://poll.kuaidi100.com/order/borderapi.do

请求参数:

参数名是否必填类型说明
methodstring业务类型(默认:queryPrice)
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在授权邮件里面有
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
kuaidiComstring快递公司编码
addressstring出发地地址,最小颗粒到市级,例如:广东省深圳市

4.3 返回结果

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

4.4 返回结果示例

{

		"result":true,

		"returnCode":"200",

		"message":"成功",

		"data":{

        "youzhengguonei":{

        "山东":{

        "overPrice":{

          "0-0":"5"

        },

        "recAddress":"山东",

        "sendAddress":"深圳市",

        "firstPrice":"14.00"

      },

      "福建":{

        "overPrice":{

          "0-0":"4"

        },

        "recAddress":"福建",

        "sendAddress":"深圳市",

        "firstPrice":"14.00"

      },

    ……},  

    "youshuwuliu":{

      "山东":{

        "overPrice":{

          "0-0":"5.0"

        },

        "recAddress":"山东",

        "sendAddress":"深圳市",

        "firstPrice":"11.00"

      },

      "福建":{

        "overPrice":{

          "0-0":"3.5"

        },

        "recAddress":"福建",

        "sendAddress":"深圳市",

        "firstPrice":"11.00"

      },

      ……

    }

  }

} 

说明:

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

五、快递公司编码

快递公司编码
京东jd
德邦debangkuaidi
极兔jtexpress
圆通yuantong
申通shentong