一、 C端寄件运力查询接口
查询全国快递公司运力覆盖情况。
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
https://order.kuaidi100.com/order/corderapi.do
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:queryNearExpressList) |
key | 是 | string | 授权码,请到快递100页面申请企业版接口获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号 secret可在企业管理后台查看 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
sendManPrintAddr | 是 | string | 寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园 |
recManPrintAddr | 是 | string | 收件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园 |
1.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
com | string | 快递公司编码 | |
longitude | string | 经度 | |
latitude | string | 纬度 | |
type | Integer | 运力类型,1:官方运力;2:优选运力 | |
mktid | string | 内部参数,type为2时返回,请忽略 |
1.4 返回结果示例
{
"result": true,
"returnCode": "200",
"message": "提交成功",
"data": [{
"com": "zhongtong",
"mktid": 243138403,
"logitude": 113.905289,
"latitude": 22.537058,
"type": 2
},
{
"com": "debangkuaidi",
"logitude": "113.905289",
"latitude": "22.537058",
"type": 1
}
]
}
1.5 信息代码含义
信息代码 | 信息内容描述 | 原因及建议处理方式 | |
---|---|---|---|
200 | 提交成功 | 提交成功 | |
400 | 参数错误 | 请根据技术文档请求,注意参数类型及是否必填。 | |
400 | 非法IP | 请联系快递100工作人员添加白名单 | |
500 | 服务器错误 | 快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 | |
503 | 签名认证失败 | 请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号 | |
600 | 您不是合法的用户(即授权Key出错) | 检查KEY是否填写正确或账号无可用单量,需要充值 | |
601 | KEY已过期 | 账号无可用单量,需要充值 |
二 、C端寄件下单接口
选择快递公司进行下单。
2.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
2.2 请求地址
https://order.kuaidi100.com/order/corderapi.do
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:cOrder) |
key | 是 | string | 授权码,请申请企业版获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret在企业管理后台查看 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
kuaidicom | 是 | string | 快递公司的编码,一律用小写字母,见《快递公司编码》 |
recManName | 是 | string | 收件人姓名 |
recManMobile | 是 | string | 收件人的手机号,手机号和电话号二者其一必填 |
recManPrintAddr | 是 | string | 收件人所在完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园 |
sendManName | 是 | string | 寄件人姓名 |
sendManMobile | 是 | string | 寄件人的手机号,手机号和电话号二者其一必填 |
sendManPrintAddr | 是 | string | 寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10 |
callBackUrl | 是 | string | callBackUrl订单信息回调 |
cargo | 否 | string | 物品名称,例:文件 |
payment | 否 | string | 支付方式,SHIPPER: 寄方付(默认),CONSIGNEE: 到付 |
weight | 否 | string | 物品总重量KG,不需带单位,例:1.5 |
remark | 否 | string | 备注 |
dayType | 否 | string | 预约日期,例如:今天/明天/后天 |
pickupStartTime | 否 | string | 预约起始时间,24小时制(HH:mm),例如:09:00 |
pickupEndTime | 否 | string | 预约截止时间,24小时制(HH:mm),例如:10:00 |
salt | 否 | string | 签名用随机字符串 |
2.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskId | string | 任务ID | |
orderId | string | 订单ID |
2.4 返回结果示例
{
"result": true,
"returnCode": "200",
"message": "提交成功",
"data": {
"taskId": "****", // 任务ID
"orderId ": "****" // 订单ID
}
}
2.5 信息代码含义
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
200 | 提交成功 | 提交成功 |
400 | 参数错误 | 请根据技术文档请求,注意参数类型及是否必填。 |
500 | 服务器错误 | 快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
501 | 重复提交 | |
503 | 签名认证失败 | 请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号 |
600 | 您不是合法的用户(即授权Key出错) | 检查KEY是否填写正确或账号无可用单量,需要充值 |
601 | KEY已过期 | 账号无可用单量,需要充值 |
700 | 错误的回调地址 | 检查回调地址,或者联系快递100工作人员 |
三、下单回调接口
订单有状态变更是会触发回调,回调后如果没有得到合作方正确返回,会重复回调多2次,即最多回调3次。间隔30分钟。
3.1 接口格式
提供统一格式的HTTP POST,并返回统一格式JSON数据。
请求报头:Content-Type=application/x-www-form-urlencoded;charset=UTF-8
3.2 请求地址
由贵司在下单请求中通过callBackUrl字段提供
<form method="post" name="" action="[callbackurl]">
<input type="text" name="taskId" value="{XXX}" >
<input type="text" name="param" value="{XXX}" >
<input type="text" name="sign" value="签名字符串" />
</form>
请求参数:
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskId | string | 任务ID | |
sign | string | 签名 | MD5 (param +salt) |
param | param | 参数主体 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
kuaidicom | 是 | string | 快递公司的编码,一律用小写字母,见《快递公司编码》 |
kuaidinum | 是 | string | 快递单号,单号的最大长度是32个字符 |
status | 是 | string | 状态码 |
message | 是 | string | 状态描述 |
data | 是 | data | 订单内容 |
data数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
orderId | 是 | string | 平台订单ID |
status | 是 | string | 订单状态,0:'下单成功';1:'已接单';2:'收件中';9:'用户主动取消';10:'已取件';11:'揽货失败';12:'已退回';13:'已签收';14:'异常签收';99:'订单已取消' |
courierName | 否 | string | 快递员姓名 |
courierMobile | 否 | string | 快递员电话 |
weight | 否 | string | 重量 |
freight | 否 | string | 运费 |
3.3 返回结果
字段 | 说明 | 备注 |
---|---|---|
result | 提交结果 | true提交成功,false失败 |
returnCode | 返回编码 | |
message | 返回报文描述 |
3.4 返回结果示例
{
"result": true,
"returnCode": "200",
"message": "提交成功"
}
3.5 回调响应报文及错误码解释
字段名称 | 字段含义 |
---|---|
result | true表示成功,false表示失败。如果提交回调接口的地址失败,30分钟后重新回调,3次仍旧失败的,自动放弃 |
returnCode | 200: 提交成功 500: 服务器错误 其他错误请自行定义 |
message | 返回的提示 |
其他信息快递100会忽略。
四、C端寄件下单取消接口
对下完的单进行取消操作
4.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
4.2 请求地址
https://order.kuaidi100.com/order/corderapi.do
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:cancel) |
key | 是 | string | 授权码, 请申请企业版获取 |
sign | 是 | string | **32****位大写,**签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号。secret在企业管理后台可以查看。 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
taskId | 是 | string | 任务ID |
orderId | 是 | string | 订单ID |
cancelMsg | 是 | string | 取消原因,例:暂时不寄件了 |
4.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data | 这里默认为空 |
4.4 返回结果示例
{
"result": true,
"returnCode": "200",
"message": "提交成功",
"data": {}
}
4.5 信息代码含义
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
200 | 提交成功 | 提交成功 |
400 | 参数错误 | 请根据技术文档请求,注意参数类型及是否必填。 |
500 | 服务器错误 | 快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,或者对已取消的订单重复操作取消,也会报此错误 |
501 | 重复提交 | 重复提交了请求 |
503 | 签名认证失败 | 请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号 |
600 | 您不是合法的用户(即授权Key出错) | 检查KEY是否填写正确或账号无可用单量,需要充值 |
601 | KEY已过期 | 账号无可用单量,需要充值 |
五、C端寄件价格查询接口
查看从出发地到目的地的价格
5.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
5.2 请求地址
https://order.kuaidi100.com/order/corderapi.do
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:price) |
key | 是 | string | 授权码,请到快递100页面申请企业版接口获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在授权邮件里面有 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
kuaidiCom | 是 | string | 快递公司编码 |
sendManPrintAddr | 是 | string | 出发地地址,最小颗粒到市级,例如:广东省深圳市 |
recManPrintAddr | 是 | string | 目的地地址,最小颗粒到市级,例如:广东省深圳市 |
weight | 否 | string | 重量,单位:kg,默认:1 |
5.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data | 运力对象 |
data数据结构:
参数名 | 类型 | 说明 |
---|---|---|
price | string | 运费,单位:元 |
4.4 提供数据内容
返回结果示例
{
"result": true,
"returnCode": "200",
"message": "提交成功",
"data": {
"price": "23.0"
}
}
说明:
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
200 | 提交成功 | 提交成功 |
400 | 参数错误等 | 请根据技术文档请求,注意参数类型及是否必填 |
500 | 服务器错误 | 快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
503 | 验证签名失败 | 请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号 |
600 | 您不是合法的用户(即授权Key出错) | 检查KEY是否填写正确或账号无可用余额,需要充值 |
601 | KEY已过期 | 账号无可用余额,需要充值 |
六、快递公司编码
快递公司 | 编码 | 快递类型 |
---|---|---|
京东物流 | jd | 官方 |
德邦快递 | debangkuaidi | 官方 |
顺丰速运 | shunfeng | 官方 |
圆通速递 | yuantong | 官方 |
申通快递 | shentong | 官方 |
中通快递 | zhongtong | 官方 |
顺丰快运 | shunfengkuaiyun | 官方 |
顺心捷达 | sxjdfreight | 官方 |
顺丰冷运 | shunfenglengyun | 官方 |
百世快运 | baishiwuliu | 官方 |
中通快递 | zhongtong | 优选 |
圆通速递 | yuantong | 优选 |
天天快递 | tiantian | 优选 |