快马跑腿代送对外接口文档
说明:
使用授权手机号和其他参数外加发起接口请求时间戳使用密码对接口参数进行加密标签产生验证签名,将产生签名字符串作为 signature的值,添加到接口请求参数中
测试DOMAIN:
https://apitest.kuaimapaotui.com
正式DOMAIN:
https://api.kuaimapaotui.com

加密/效验
说明:
1.将所有参数(sign除外)按照参数名的字母顺序排序,并用&连接
例:1.app_id=123456789&b=1&c=2×tamp=1532218981
2.将以上字符串与 &app_key进行连接,得到加密前的字符串
例:app_id=123456789&b=1&c=2×tamp=1532218981&app_key=99f8286ed488c6ba
3.对加密前的字符串进行MD5加密,并转换成小写字母,得到签名
例:a46f51e808ed2ec0fc6ff049176820f9
注意:
1.参数中包含中文时,中文保持原文即可,无需对其单独转码
2.时间戳timestamp在2分钟之内有效
3.在调用接口时,请勿传递app_key,以免信息泄露
4.加密的时候参数值为url,请以原值,非urlencode的值进行加密
账号绑定以及解绑
简要描述:
平台上进行快马跑腿账号的绑定以及解绑
一、平台上的各个商家可以自行注册快马跑腿账号进行绑定发单;
二、可以由平台统一使用一个快马跑腿账号进行绑定发单(该平台充值要开票外加6%税点)。
绑定之后,配送订单将由绑定的快马跑腿账号发布,订单的发布需要从账户余额内扣款,商家需要在注册的快马跑腿账户内进行充值。
绑定URL:
·DOMAIN/index.php?m=Api&c=PublishOpen&a=bindUser
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
redirect_url | 重定向url地址 | www.baidu.com | 是 |
notify_url | 订单状态回调URL | www.baidu.com | 是 |
timestamp | unix时间戳 | 1481252461(当前时间) | 是 |
signature | 参数合法性验证 | 31238e2b48b9c6 | 是 |
phone | 绑定手机号 | 13555555555 | 否 |
password | 绑定账号对应的密码 | 123456 | 否 |
unique_id | 第三方平台门店id(绑定成功之后,会回传) | 123456 | 否 |
绑定页面url大致如下:
·DOMAIN/index.php?m=Api&c=PublishOpen&a=bindUser &app_id=123456789&redirect_url=xxx¬ify_url=xxx&signature=xxx ×tamp=1481252461
打开网页,输入快马跑腿账号对应的密码,进行授权绑定
在有传password的情况下,开发者可以直接post调用接口(·DOMAIN/index.php?m=Api&c=PublishOpen&a= bindUser),完成账号绑定
解绑URL:
·DOMAIN/index.php?m=Api&c=PublishOpen&a=unbindUser
请求方式:
POST
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
phone | 绑定手机号 | 13555555555 | 是 |
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
timestamp | unix时间戳 | 1481252461(当前时间) | 是 |
signature | 参数合法性验证 | 31238e2b48b9c6 | 是 |
订单价格查询
简要描述:
查询订单的配送价格
请求URL:
·DOMAIN/index.php?m=Api&c=PublishOpen&a=getOrderPrice
请求方式:
POST
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
phone | 授权手机号 | 150****0101 | 是 |
start_city | 开始城市 | 杭州市 | 是 |
start_address | 开始地址 | 杭州东站 | 是 |
start_location | 开始坐标(百度) | 125.719989,28.000158 | 是 |
end_city | 结束城市 | 杭州市 | 是 |
end_address | 结束地址 | 江干区浙江理工大学 | 是 |
end_location | 结束坐标(百度) | 125.737562,27.979623 | 是 |
timestamp | unix时间戳 | 1681252461(当前时间) | 是 |
signature | 参数合法性验证 | d1237b8480fad3e | 是 |
weight | 物品重量(千克) | 5 | 否 |
send_start_phones | 发货人手机号 | 181****0909 | 否 |
pickup_time | 取货时间 | 1681252461 | 否 |
transport | 配送方式 | 电瓶车:0;开车:1;三轮车:2。默认电瓶车 | 否 |
good_info | 物品信息 | 鲜花、蛋糕 | 否 |
end_addrs | 多终点地址(使用该参数,end_address、end_location不需要传) | [{"end_location":"122.3957050,34.6636070","end_address":"大学城","phone":"13937975525","third_order_id":"1201","good_info":"外卖","content":"备注"},{"end_location":"122.3857050,34.6536070","end_address":"大学城","phone":"13937975525","third_order_id":"1202","good_info":"外卖","content":"备注"}] | 否 |
返回示例
{ "State": "Success", "info": "操作成功", "data": { "price": 16, //订单配送费原价(元) "cut_price": 14, //优惠券后订单配送费(元) "length": 5.124, //订单距离(千米) "can_pay":1, //账户余额是否足够支付订单。1,足够;0,不足 }, "code": 1 }
发布配送订单
简要描述:
发布配送订单,由快马跑腿进行配送
请求URL:
·DOMAIN/index.php?m=Api&c=PublishOpen&a=addOrder
请求方式:
POST
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
phone | 授权手机号 | 150****0101 | 是 |
start_city | 开始城市 | 杭州市 | 是 |
start_address | 开始地址 | 杭州东站 | 是 |
start_location | 开始坐标(百度坐标) | 125.719989,28.000158 | 是 |
end_city | 结束城市 | 杭州市 | 是 |
end_address | 结束地址 | 江干区浙江理工大学 | 是 |
end_location | 结束坐标(百度坐标) | 125.737562,27.979623 | 是 |
timestamp | unix时间戳 | 1691252461(当前时间) | 是 |
signature | 参数合法性验证 | d1237b8480fad3e | 是 |
send_start_phones | 发货人联系方式 | 181****0909或区号-座机号 | 是 |
send_finish_key_phones | 收货人联系方式 | 181****0909或虚拟号_分机号 | 是 |
consignee_name | 收货人姓名 | 张 | 是 |
good_info | 物品 | 饿了么100号单或者食品、文件 | 是 |
content | 备注 | 辣椒多点 | 否 |
weight | 物品重量(千克) | 5 | 否 |
pickup_time | 预约取货时间 | 1691252461 | 否 |
service_time | 预约完成时间 | 1701252461 | 否 |
third_order_id | 第三方平台订单ID | 2020062711515 | 否 |
use_coupon | 是否使用优惠 | 不使用:0;使用:1。(默认使用) | 否 |
add_price | 订单加价(加小费) | 5 | 否 |
transport | 配送方式 | 电瓶车:0;开车:1;三轮车:2。默认电瓶车 | 否 |
end_addrs | 多终点地址(使用该参数,end_address、end_location、send_finish_key_phones、consignee_name不需要传) | [{"end_location":"122.3957050,34.6636070","end_address":"科技园","phone":"13937975525","third_order_id":"1201","good_info":"外卖","content":"备注"},{"end_location":"122.3857050,34.6536070","end_address":"科技园","phone":"13937975525","third_order_id":"1202","good_info":"外卖","content":"备注"}] | 否 |
返回示例
{ "State": "Success", //下单成功 "info": "发布成功", "data": { "order_id": "33044841", //订单ID "state": "已发布", // 订单状态 "price" : 16, //订单配送费原价(元) "cut_price": 14, //优惠券后订单配送费(元) "add_price": 5, //加价金额(元) "statecode": 1, "localphone" : "13566666666" , //订单的区域代理商投诉电话 //多单子地址ID,需要记录,在订单状态回调接口内有使用到 "sub_addrs" : '[{"end_id":123,"end_address":"***"},{"end_id":124,"end_address":"***"}]', }, "code": 1 }
订单加价
简要描述:
对发布的配送订单进行加价
请求URL:
·DOMAIN/index.php?m=Api&c=PublishOpen&a=addOrderPrice
请求方式:
POST
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
phone | 授权手机号 | 150****0101 | 是 |
order_id | 订单号 | 38398798 | 是 |
add_price | 加价金额 | 2 | 是 |
timestamp | unix时间戳 | 1881333175 | 是 |
signature | 参数合法性验证 | 31238e2b48b9c6 | 是 |
返回示例
{ "State": "Success", "info": "操作成功", "data": { "order_id": "33055011", //订单ID "state": "已发布", // 订单状态 "statecode": "1", "state_id": "1", "price" : "18.00", //加价后订单配送费(元) }, "code": 1 }
订单列表查询
简要描述:
获取该账号已经发布的订单
请求URL:
·DOMAIN/index.php?m=Api&c=PublishOpen&a=getOrderList
请求方式:
POST
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
phone | 授权手机号 | 150****0101 | 否 |
page | 页码号 | 0 | 是 |
size | 一页大小 | 10 | 是 |
timestamp | unix时间戳 | 169333175 | 是 |
signature | 参数合法性验证 | 31238e2b48b9c6 | 是 |
返回示例
{ "State": "Success", "info": "执行成功", "data": { "total_rows": "57", "total_pages": 5, "size": "10", "now_page": "0", "next_page": 1, "data": [ { "order_id": "3302670", // 订单id "title": "浙江省杭州市杭州东站", //标题 "state": "已发布", //订单状态 "add_time": "2023-06-14 11:28:01", //订单添加时间 "price": "11", //订单价格(元) },... ], "code": 1 }
订单详情查询
简要描述:
查询某个发布订单的详情信息
请求URL:
·DOMAIN/index.php?m=Api&c=PublishOpen&a=getOrderInfo
请求方式:
POST
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
phone | 授权手机号 | 150****0101 | 是 |
order_id | 查询订单id | 3305187 | 是 |
timestamp | unix时间戳 | 1681333175 | 是 |
signature | 参数合法性验证 | 31238e2b48b9c6 | 是 |
返回示例
{ "State": "Success", "info": "操作成功", "data": { "order_id": "1630183", "title": "杭州市杭州东站3楼到杭州市江干区杭州理工大学", "start_address": "杭州市杭州东站3楼", "end_address": "杭州市江干区杭州理工大学", "start_location": "125.818031,27.926274", "end_location": "125.712339,27.9794", "start_city": "杭州市", "end_city": "杭州市", "state": "待评价", "statecode" : "10", "add_time": "2018-11-12 10:57:27", "length": "14km", "receive": "跑男4", "receive_phone": "138****0101" "price": "14.00元", "content": "农场香辣鸡腿堡x3 48.00元, ", "good_info": "测试店铺名称 #1", "send_finish_key_phones": "13587866718" }, "code": 1 }
订单完成
简要描述:
完成某个发布的订单
请求URL:
·DOMAIN/index.php?m=Api&c=PublishOpen&a=finishOrder
请求方式:
POST
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
phone | 授权手机号 | 150****0101 | 是 |
order_id | 查询订单id | 3809073 | 是 |
timestamp | unix时间戳 | 1481333175 | 是 |
signature | 参数合法性验证 | 31238e2b48b9c6 | 是 |
返回示例
{ "State": "Success", "info": "执行成功", "data": { "order_id": "3005187", //订单ID "state": "待评价", // 订单状态 "statecode": 10 }, "code": 1 }
订单取消
简要描述:
取消某个发布的订单。
骑手接单3分钟内,平台申请取消,可以直接取消;骑手接单时间超过3分钟,取消订单需要骑手同意。
已取货订单不能取消。
请求URL:
·DOMAIN/index.php?m=Api&c=PublishOpen&a=cancelOrder
请求方式:
POST
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
phone | 授权手机号 | 150****0101 | 是 |
order_id | 查询订单id | 33335187 | 是 |
timestamp | unix时间戳 | 1991333175 | 是 |
signature | 参数合法性验证 | 31238e2b48b9c6 | 是 |
返回示例(直接取消)
{ "State": "Success", //执行成功 "info": "执行成功", "data": { "order_id": "300809073", //订单ID "state": "已取消", //订单状态 "statecode": "7", "refund_price": "17", //实际退回金额 "fine_money":"2" //扣款金额 }, "code": 1 }
返回示例(需骑手同意)
{ "State": "Success", //执行成功 "info": "执行成功", "data": { "order_id": "300809073", //订单ID "state": "待同意放弃", //订单状态 "statecode": 5 }, "code": 1 }
获取账户余额
简要描述:
获取对应账户的余额信息
请求URL:
·DOMAIN/index.php?m=Api&c=PublishOpen&a=getBalance
请求方式:
POST
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
phone | 授权手机号 | 150****0101 | 是 |
timestamp | unix时间戳 | 1991333175 | 是 |
signature | 参数合法性验证 | 31238e2b48b9c6 | 是 |
返回示例
{ "State": "Success", "info": "操作成功", "data": { "balance": "9746.00", //账户余额(元) "free": "9746.00", //可用余额(元) "freeze": "254.00", //冻结余额(元) "bond": "0.00", "total_income": "0.00", "total_expenses": "0.00", "total_integral": "0", "withdraw_show": "0", "coupon_count": "0" }, "code": 1 }
获取账户账单
简要描述:
获取对应账户的账单信息
请求URL:
·DOMAIN/index.php?m=Api&c=PublishOpen&a=getFinanceBills
请求方式:
POST
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
phone | 授权手机号 | 150****0101 | 是 |
timestamp | unix时间戳 | 1991333175 | 是 |
signature | 参数合法性验证 | 31238e2b48b9c6 | 是 |
last_id | 分页参数 | 第一次传0,后面分页传从接口获取的值 | 是 |
返回示例
{ "State": "Success", "info": "操作成功", "data": { "list": [ { "bill_id": "1917198", "user_balance": "888.18", "money": "5.00", "description": "付款给订单成功 (33514182)", "add_time": "1528432542" }, { "bill_id": "1907050", "user_balance": "883.18", "money": "5.00", "description": "付款给订单成功 (33014181)", "add_time": "1528430823" }, ], "last_id": "19880" }, "code": 1 }
获取骑手GPS
简要描述:
获取对应骑手的位置信息
请求URL:
·DOMAIN/index.php?m=Api&c=PublishOpen&a=getGPS
请求方式:
POST
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
phone | 授权手机号 | 150****0101 | 是 |
order_id | 查询订单id | 50005187 | 是 |
timestamp | unix时间戳 | 1991333175 | 是 |
signature | 参数合法性验证 | 31238e2b48b9c6 | 是 |
返回示例
{ "State": "Success", "info": "操作成功", "data": { "receive": "张三", "receive_phone": "186****1111", "gps": "125.729638,30.990437", //百度坐标系 }, "code": 1 }
订单状态回调
简要描述:
状态回调接口
请求URL:
由被调用第三方平台提供,在账号绑定的时候进行提交
请求方式:
POST
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
order_id | 查询订单id | 5605187 | 是 |
time | unix时间戳 | 1991333175 | 是 |
signature | 参数合法性验证 | 31238e2b48b9c6 | 是 |
state | 状态码 | 3, 8, 9, 10, 19 | 是 |
state_name | 状态名 | 7订单取消退款, 8接单进行中, 9订单请求确认, 10订单完成, 19子订单送达 | 是 |
receive | 接单者 | 张三 | 是 |
receive_phone | 接单者手机号 | 189****0101 | 是 |
gps | 接单者当前GPS | 125.729638,27.990437 | 是 |
part | part=1表示有补偿,part=0就没有 | 1 | 是(state为7时才有字段) |
fine_money | 补偿金额 | 3.00 | 是(state为7时才有字段) |
third_order_id | 第三方平台订单ID | 2020062711515 | 否 |
end_id | 多单子地址ID | 123 | 否 |
sub_third_order_id | 多单子订单,第三方平台订单ID | 1201 | 否 |
State
state=1 订单发布中等待骑手接单 state=8 订单已接单 state=31 订单已接单(转派订单) state=19 多单子地址送达 state=21 已经到店 state=22 已经取货 (可以判断送货中) state=9 订单请求完成 state=10 订单待评价 state=11 订单已完成 state=7 订单取消退款
返回示例
{ "State": "Success", "info": "回调接收成功", "code": "1", }
门店绑定回调
简要描述:
门店绑定回调接口,在平台完成账号绑定之后,会调用该接口
请求URL:
由被调用第三方平台提供,在个人信息页面设置
请求方式:
POST
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
state | 状态(固定值) | bind | 是 |
timestamp | unix时间戳 | 1991333175 | 是 |
signature | 参数合法性验证 | 31238e2b48b9c6 | 是 |
phone | 门店绑定的爱跑腿账号 | 181****0909 | 是 |
unique_id | 第三方平台门店id,绑定的时候有第三方上传 | 123456 | 否 |
返回示例
{ "State": "Success", "info": "回调接收成功", "code": "1", }
充值接口
简要描述:
获取充值网页
请求URL:
·DOMAIN/index.php?m=Api&c=PublishOpen&a=getRechargeUrl
请求方式:
POST
参数:
参数名 | 说明 | 示例 | 必选 |
---|---|---|---|
app_id | 第三方应用ID | 492d9e8f72e45c843a893f5c6fe4361b | 是 |
phone | 授权手机号 | 150****0101 | 是 |
timestamp | unix时间戳 | 1991333175 | 是 |
signature | 参数合法性验证 | 31238e2b48b9c6 | 是 |
返回示例
{ "State": "Success", "info": "操作成功", "data": { "url": "https://api.kuaimapaotui.com/index.php?m=Api&c=PublishOpen&a=wapRechargeUrl&openid=28937ff3ab*******59372959cc184" //充值网页 }, "code": 1 }