快递100集成多家快递同城配送公司查询订单API接口案例

一、同城配送查询订单

查询订单信息

1.1 接口格式

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

1.2 请求地址

https://order.kuaidi100.com/sameCity/order

请求参数：

参数名	是否必填	类型	说明
method	是	string	业务类型（默认：query）
key	是	string	授权码， 请到快递100页面申请企业版接口获取 https://api.kuaidi100.com/register
sign	是	string	32位大写，签名，用于验证身份，按MD5 (param +t+key+ secret)的顺序进行MD5加密，不需要加上“+”号secret在授权邮件里面有
t	是	string	时间戳如：1576123932000
param	是	param	由其他字段拼接

param数据结构：

参数名	是否必填	类型	说明
taskId	是	string	任务ID
orderId	是	string	订单ID

1.3 返回结果

字段	类型	说明	备注
result	boolean	提交结果	true提交成功，false失败
returnCode	string	返回编码
message	string	返回报文描述
data	data

data数据结构

字段	类型	说明	备注
courierName	string	骑手名称	部分状态下为空
courierPhone	string	骑手电话	部分状态下为空
lat	string	当前骑手位置（纬度）	部分状态下为空
lnt	string	当前骑手位置（经度）	部分状态下为空
status	int	订单状态0-下单成功 1-已接单 10-已取货 13-已签收 9-用户主动取消 99-订单已取消
com	string	快递公司编码
num	string	快递公司订单号
predictDeliveryTime	String	预计到达时间	闪送、快服务支持、部分状态下为空
traiUrl	String	地图链接	顺丰支持部分状态下为空

1.4 提供数据内容

param例子

{
         "taskId": "2B389A891A2C4AF8AB29927050DA52CC",
         "orderId": "1000086"
}

返回结果例子

{
          "returnCode": "200",
          "result": true,
          "message": "提交成功",
      "data": {
            "courierName": "G师傅",
            "courierPhone": "15010033036",
            "predictDeliveryTime": "2021-03-10 11:00:37",
            "lat": "29.24303",
            "lng": "91.77957",
            "status": 1
}
}

说明：

部分状态指的是，下单成功、签收 以及取消状态下某些参数是不存在的

1.5 信息代码含义

信息代码	信息内容描述	原因及建议处理方式
200	成功	成功
400	参数错误等	提交数据不完整， 检查提交的格式是否为x-www-form-urlencoded的post格式
500	服务器错误	快递100的服务器出理间隙或临时性异常，有时如果因为不按规范提交请求，比如快递公司参数没有按照文档规定填写等，也会报此错误
501	重复提交	快递100的服务器出理间隙或临时性异常，有时如果因为不按规范提交请求，比如快递公司参数没有按照文档规定填写等，也会报此错误
503	验证签名失败	请检查加密方式，param + t + key+ secret 的顺序进行MD5加密，加密后字符串转大写
601	key已过期	没有可用单量，账号需要充值使用

一、同城配送取消下单接口

对下完单的订单进行取消操作

1.1 接口格式

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

1.2 请求地址

https://order.kuaidi100.com/sameCity/order

请求参数：

参数名	是否必填	类型	说明
method	是	string	业务类型（默认：cancelBest）
key	是	string	授权码， 请到快递100页面申请企业版接口获取 https://api.kuaidi100.com/register
sign	是	string	32位大写，签名，用于验证身份，按MD5 (param +t+key+ secret)的顺序进行MD5加密，不需要加上“+”号secret在授权邮件里面有
t	是	string	时间戳如：1576123932000
param	是	param	由其他字段拼接

param数据结构：

参数名	是否必填	类型	说明
taskId	是	string	任务ID
orderId	是	string	订单ID
cancelMsg	是	string	取消原因，例：暂时不寄件了

1.3 返回结果

字段	类型	说明	备注
result	boolean	提交结果	true提交成功，false失败
returnCode	string	返回编码
message	string	返回报文描述
data	data		这里默认为空

1.4 提供数据内容

param例子

{
          "taskId":"2B389A891A2C4AF8AB29927050DA52CC",
          "orderId":"1000086",
          "cancelMsg":"地址信息填错啦，重新下单"
   }

返回结果例子

{
          "returnCode": "200",
          "result": true,
          "message": "取消成功"
   }

1.5 信息代码含义

信息代码	信息内容描述	原因及建议处理方式
200	成功	成功
400	参数错误等	提交数据不完整， 检查提交的格式是否为x-www-form-urlencoded的post格式
500	服务器错误	快递100的服务器出理间隙或临时性异常，有时如果因为不按规范提交请求，比如快递公司参数没有按照文档规定填写等，也会报此错误
501	重复提交	快递100的服务器出理间隙或临时性异常，有时如果因为不按规范提交请求，比如快递公司参数没有按照文档规定填写等，也会报此错误
503	验证签名失败	请检查加密方式，param + t + key+ secret 的顺序进行MD5加密，加密后字符串转大写
601	key已过期	没有可用单量，账号需要充值使用

官方文档：

http://api.kuaidi100.com/document/60643c894344bf6fb00db219.html

http://api.kuaidi100.com/document/60643d2e4344bf6fb00db21a.html