文档中心
同城配送查询订单

同城配送查询单号技术文档

一、同城配送查询订单

查询订单信息

1.1 接口格式

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

1.2 请求地址

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

请求参数:

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

param数据结构:

参数名是否必填类型说明
taskIdstring任务ID
orderIdstring订单ID

1.3 返回结果

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

data数据结构

字段类型说明备注
courierNamestring骑手名称部分状态下为空
courierPhonestring骑手电话部分状态下为空
latstring当前骑手位置(纬度)部分状态下为空
lngstring当前骑手位置(经度)部分状态下为空
statusint订单状态0-下单成功 1-已接单 10-已取货 13-已签收 9-用户主动取消 99-订单已取消
comstring快递公司编码
numstring快递公司订单号
predictDeliveryTimeString预计到达时间闪送、快服务支持、部分状态下为空
traiUrlString地图链接顺丰支持部分状态下为空

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加密,加密后字符串转大写
601key已过期没有可用单量,账号需要充值使用