@zhuchao941
2018-06-19T07:51:43.000000Z
字数 226788
阅读 9406
列表项
列表项
接口为点我达配送客户端和平台之间的接口,客户端通过此接口获取用户和内容信息,并且完成用户操作数据的上传
请求消息和应答消息体采用JSON格式,字符编码采用UTF-8。
请求消息如下:
{
userId:1234,
password:123456
}
应答消息体以JSON格式传送内容。如:
{
status:1,
data:{
list:[
{
id:132,
name:'张三'
},
{
......
}
],
sum:132
},
msg:""
}
status :1为成功 0为失败
data : 接口具体返回值 当响应值为-1则为未取到数据
msg:错误提示信息,如没有,则为空,类型:String
接口描述
在登录界面,用户登录时必须经过手机及验证码验证
接口消息定义
请求地址:/ rider/login.json
请求方法: post
请求消息体:
{
mobile:用户名,实际为手机号,类型:String
captcha:验证码,类型:String
cityId:城市ID,类型:String
version:应用版本号,类型:String
imei:手机IMEI号,类型:String
riderId:骑手ID,类型:String
lat:骑手位置经纬度,类型:int
lng:骑手位置经纬度,类型:int
source:手机厂商,类型:String
client:系统版本,类型:String
channelId:渠道ID,类型:String
phoneVersion:手机型号,类型:String
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
updateType:0不需要升级 1正常升级 2强制升级 , 类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
riderId:用户id,类型:String,之后服务端和客户端交流的凭证
insuranceFee:保险费用,类型:float
riderType:骑手类型0:骑手 1:骑士 ,类型:int
tips:更新提示文案,类型:String
areaCode:区号,类型:String
identityCard:身份证,类型:String
tradingAreaId:工作商圈,类型:int
riderName:骑手姓名,类型:String
forceReadNotify:{
id:强制阅读消息ID,类型:String
url:消息URL,类型:String
title:消息标题,类型:String
}
token:登录token,类型:String
serverAddress:服务器地址,类型:string
distanceThreshold:超距判断距离,如3KM,类型:double
targetRadius:目标半径,引导骑手去设置,如1km,类型:double
distanceTimeInterval:超距提示时间间隔,如10分钟,类型:int
waitForDistanceThreshold:等待超时超距判断距离,如0.5KM,类型:double
newUserReward:新手5单奖励活动是否开启,类型:boolean
spreadRedPoint:推广赚钱红点显示,类型:boolean
csTel:客服电话,类型:String
firstLogin:是否首次登陆,类型:boolean
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:10011,设备已绑定其它账号,类型:int
}
接口描述
登录时点击获取验证码按钮,下发验证码短信
接口消息定义
请求地址: /apis/common/get-captcha.json
请求方法: post
请求消息体:
{
mobile:手机号,类型:String
type:验证码类型,类型:String
isVoice:语音验证码,类型:String
systemCode: “spider“(商家端) or “flash”(骑手端)
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: “1234”验证码内容
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
登录时点击获取验证码按钮,下发验证码短信。
接口消息定义
请求地址: /apis/common/get-city.json
请求方法: post
请求消息体:
{
lat:经纬度,类型:int
lng:经纬度,类型:int
systemCode: “spider“(商家端) or “flash”(骑手端)
mobile:手机号,类型:String
locationType:定位类型,类型:int
remoteSupported:是否支持异地登录,默认true,类型:boolean
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
cityId:城市ID,类型:String
cityName:城市名,类型:String
server:服务器地址,类型:String
}
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
开始接单
接口消息定义
请求地址: /rider/come-to-work.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
cityName:城市名称,类型:String
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
statusText:工作状态文案,类型:String
hasWorkArea:是否已经设定区域 0 未设置 1 已设置,类型:int
radiusRange:{
min:最小工作范围半径,类型:double
max:最大工作范围半径,类型:double
defaultRadius:默认半径,类型:double
step:工作范围调整间隔值,类型:double
}
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:错误码,9009:骑手跨城市,9010:骑士跨城市,9001: 此城市未开通, 9002:账号禁用 类型:int
}
接口描述
停止接单,下班
接口消息定义
请求地址: /rider/come-off-work.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data:提示信息
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
}
响应消息
{
status:1,
data:{
{
riderStatus:骑手状态,类型:int
statusText:骑手状态文案,类型:String
verifiedStatus:验证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
tips:提示文本,类型:String
btnText:按钮文案,类型:String
unTerminativeOrderNum:总订单数量,类型:number
passexamStatus :培训通过pass状态,类型:number
guideVersion:当前用户的接单引导版本号,类型:int
arriveThreshold:到店时间阀值,类型:int
multiShopReward:多商家奖励,类型:String
hasCompletedOrderNum:已完成单量,类型:int
totalRewardOrderNum:奖励总单量,类型:int
newUserRewardAmount:新手奖励金额,类型:double
shopInfoList:[
{
shopId:商家id,类型:number
shopAddr:商家发货地址,类型:String
shopName:商家名称,类型:String
orderNum:此商家订单数量,类型:String
notTyped :订单ID,类型:String
channel:渠道单,类型:number
shopLat:商家地址纬度,类型:number
shopLng:商家地址经度,类型:number
shopTel:商家电话,类型:String
btnValue:按钮状态,按钮状态 5:我已到店 10:录入新订单 15:还有订单未拍小票 20:离店配送 25:配送中 11:选择订单,类型:int
btnText:按钮状态文案,类型:String
remainTime:到店剩余时间,类型:long
platformId:点点送订单,类型:int,增加菜鸟订单类型
platformName:渠道名称,类型:String
exceedStatus:超额状态 -1 未超额 0 即将超额 1 已超额,类型:int
orderNumThreshold:配送订单额度,类型:int
receivedOrderNum:完成数+当前列表该商家的订单数量,类型:int
feeReductionRatio:配送费减少比例,类型:double
remainNum:剩余订单数量,类型:int
shopHeaderPicUrl:商家店铺照片url,类型:String
orderList:[
{
id:订单id,类型:String
income:收入,类型:String
advance:垫付,类型:String
customerAddr:客户地址,类型:String
distanceToCustomer:距离,类型:String
typeStatus:录入状态,类型:number
customerName:收货人姓名,类型:String
customerTel:收货人电话,类型:String
customerLat:客户地址纬度,类型;int
customerLng:客户地址经度,类型:int
urge:是否催单,类型:int
sinceObtained:配送时长,类型:long
serialId:渠道订单序号,类型:String
punctualTm:准点奖励要求时间,类型:String
deliveryThreshold:配送时长阀值,单位:秒,类型:int
punctualTm2:准点奖励要求时间,类型:Date
labelList:[
...
]
requireTm:要求送达时间,类型:String
serviceTm:服务器当前时间,类型:String
punctualAmount:准点奖励额金额,类型:String
collection:代收,类型:String
collection2:代收,类型:float
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
}
]
labelList2: [
{
title:标签标题,类型:String
desc:标签描述,类型:String
}
...
]
platformDesc:渠道描述,类型:String
finishedOrderNum:当日骑手在商家完成的订单数,类型:int
}
]
}
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,9002:账号禁用,类型:int
}
接口描述
获取所有订单经纬度。
接口消息定义
请求地址: /rider/get-route.json
请求方法: post
请求消息体:
{
riderId:骑士Id,类型:String
cityId:城市Id,类型:String
}
响应消息
{
status: 1,
data:{
route: [
{
lat:纬度,类型:String
lng:经度,类型:String
type: 用户点10,商家点5,类型:int
name:商家名或者客人名称,类型:String
address:地址,类型:String
isGot:是否已取 0 未取 1 已取,类型:int
orderId:订单ID,类型:String
},
]
},
msg:” ”
}
接口描述
每隔15秒上传一次骑手位置经纬度。
接口消息定义
请求地址: /rider/ upload-position.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
imei:设备号,类型:String
version:版本号,类型:String
token:token,类型:String
locationType:定位类型,类型:int
}
响应消息
{
status:1,
data:{
isSelf: 是否是自己登录 1 正常登录 0 非自己登录,类型:int
verifyResult: 身份验证通知,类型:String
notSelfText: 别人登陆后的通知,类型:String
verifiedOvertime:审核超时,类型:boolean
orderNotifyList:[
{
orderId:订单ID,类型:String
type:通知类型,1 新订单 2 取消单 3 修改单,13 离店后取消 类型:int
shopId:商家ID,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
customerAddr:客户地址,类型:String
platformId:渠道id,类型:int
elemeWaybillNo:饿了么运单号,类型:String
income:订单金额,类型:String
}
],
lostConnectionNotify:强行休息的通知,类型:String
updateType:0不需要升级 1正常升级 2强制升级,类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
tips:提示信息,类型:String
orderCellingChangedNotify: 修改接单上限通知,类型:String
riderTypeChangeNotify:骑手身份变更通知,类型:String
cancelOrderPunishNotify:订单取消扣款通知,类型:String
patchUpdateNotify:补丁下发通知,类型:int
forbiddenNotify:禁用 启用通知,格式:1|提示信息,1 禁用 2启用,类型:String
upgradeProtocolNotify:升级协议通知,格式:0|不显示协议浮层,1|显示协议浮层,类型:int
robOrderNotify:有可抢单通知,1 无订单 2 有订单 类型:int
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,类型:int
}
接口描述
取得餐品调用该接口。
接口消息定义
请求地址: /rider/obtain-good.json
请求方法: post
请求消息体:
{
cityId:城市Id
riderId:骑士ID
orderIds: 所有订单号id,为空时批量离店,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
shopId:商家ID,类型:String
considerDis:是否判断距离超限, 判断 1, 不判断 0,类型:int
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
hasObtain:是否还有订单未取餐,类型:boolean
successIds:离店成功订单id,类型:string
},
msg:””
errorCode:距离超限提示码,类型:int
}
接口描述
完成订单调用该接口。
接口消息定义
请求地址: /rider/finish-order
请求方法: post
请求消息体:
{
cityId:城市Id
riderId:骑士Id,类型:String
orderId: 订单号id 类型:String
considerDis:是否判断距离超限,判断 1, 不判断 0,类型:int
lat:骑手位置纬度,类型:int
lng:骑手位置经度,类型:int
receivingCode:收货码,类型:string
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
},
msg:””
errorCode:距离超限提示码,类型:int
errorCode:客人未支付提示码,类型:Int
}
接口描述
通过订单id获取订单详细信息。
接口消息定义
请求地址: /rider/view-order-detail.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
orderId: 订单号 类型:String
history:是否是历史订单,类型:boolean
terminalTm:交易详情中的交易时间,类型:String
}
响应消息
{
status: 1,
data:{
id:订单ID ,类型:String
shopAddr:发货地址,类型:String
shopTel: 发货电话,类型:String
shopName:发货用户名,类型:String
customerAddr:收货地址,类型:String
customerTel:收货人联系方式,类型:String
distributingfee:配送费,类型:String
subsidyfee:补贴,类型:String
payPrice:向发货方支付金额,类型:String
chargePrice : 向发货方收取配送费,类型:String
status: 订单状态 5:已派单 10:到店 15:已取单 98:异常 99:已取消 100:已完成,类型:int
btnText:按钮显示字样,类型:String
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
customerLat:用户纬度,类型:int
customerLng:用户经度,类型:int
remark:备注,类型:String
chargeUserPrice:向用户收取,类型:String
dispatchTm:派单时间,类型:String
leaveTm:离店时间,类型:String
finishTm:完成时间,类型:String
tradingAreaName:订单所属商圈,类型:String
ticketUrl:小票URL,类型:String
incomeInfo:{
totalIncome:收入总计,类型:String
incomeList:[{
name:收入名称,类型:String
income:收入金额,类型:String
incomeDetailList:[{
name:名称,类型:String
income:收入金额,类型:String
incomeText:收入名称,类型:String
}]
}]
}
arriveConsume:到店用时,类型:long
deliveryConsume:配送用时,类型:long
hasArrived:是否已经到店,类型:boolean
punctualRewardText:订单准点奖励文案,类型:String
timeout:是否超时,1 已超时 类型:int
outOfDispatchingRange:是否超距,超过5公里,按照4.9计费,类型:int
distanceForFee:配送范围,比如4.9公里,类型:int
orderCancelReason:订单取消原因,类型:String
cancelPunishment:取消惩罚,类型:String
appealStatusText:申诉状态文案,类型:String
appealId:申诉ID,类型:String
complaintStatusText:投诉状态文案,类型:String
complaintId:投诉ID,类型:String
punishDate:受到惩罚时间
hasFoodInfo:是否有餐品信息,类型:int
collection:代收,类型:float
orderType:订单类型,0 普通订单 1 同城直送订单,类型:int
notPaidAmount:客人未支付金额,类型:double
dispatchMode:调度模式,1:系统派单,2:抢单,3:人工派单,4:分组派单,类型:int
contractType:商家类别:0:非驻店,1:全驻店,2:半驻店,类型:int
onlinePayType:0:不区分线上线下支付,1:线下支付,2:线上支付;类型:int
paidAmount:客人已支付金额,类型:float
},
msg:“”
}
接口描述
上传小票拍照
接口消息定义
请求地址: /apis/image/upload.json
请求方法: post
请求消息体:
{
cityId: 城市Id,类型:String
userId:骑士Id,类型:String
orderCode : 订单号 类型:String
systemCode:应用编码 flash,类型:String
imageType:照片类型,11:货品图片 12:签收单 类型:String
file:照片,类型:文件
}
响应消息
{
status : 1,
data : {},
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-orderhis-list.json
请求方法: post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
currentPage:当前页,类型:int
today:订单类型,0 今日订单 1历史订单,类型:int
}
响应消息
{
status:1,
data:{
todayTotal:今日订单数量,类型:int
historyTotal:历史订单数量,类型:int
pagination:{
currentPage:当前页码,类型:int
pageCount,总页数,类型:int
list:[
{
id:订单id,类型:String
income:收入,类型:String
customerAddr:客户地址,类型:String
distanceToCustomer:距离,类型:String
status:订单状态,类型:String
shopName:商家名,类型:String
shopAddr:商家地址:类型:String
isResident:是否驻店, 类型:boolean
onlinePayStatus:0:不显示,1:显示【线下支付】标签,2:显示【可申诉补款】标签
}
]
},
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
}
接口描述
获取个人信息。
接口消息定义
请求地址: /rider/get-rider-info
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
authenticationStatus:认证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
authenticationInfo:认证信息 类型:String
riderName:姓名,身份认证填写的姓名,类型:String
finishedOrderNumber:完成订单数,类型:String
accumulatedIncome:累计收入,类型:String
balance:余额,类型:String
csTel:客服电话,类型:String
passexamStatus:是否通过考试,类型:int
monthlyIncome:当月收入,类型:String
riderType:骑手身份类型,0 骑手 5 骑士,类型:int
riderLevelText:骑手身份等级,类型:String
amTel:商圈负责人联系方式,类型:String
trainStatus:培训报名状态 类型int
0:不需要弹窗
1:去报名弹窗
2:查看报名信息弹窗
},
msg:“”
}
接口描述
申请提现
接口消息定义
请求地址: /rider/apply-withdrawal.json
请求方法: post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:用户名,骑士Id,类型:String
account:账户,类型:String
accountType:账户类型,1 支付宝 2 银行卡 类型:int
withdrawalPrice:提现金额,类型:String
}
响应消息
{
status: 1,
data:{
successText :提示信息,类型:String
},
msg:“”
errorCode:错误码,9002:账号禁用,类型:int
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/get-balance-log.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
currentPage:当前页,类型:number
}
响应消息
{
status: 1,
data:{
currentPage:当前页码,类型:int
pageCount,总页数,类型:int
list:[
{
tradeId:交易Id,类型:String
tradeMoney:交易金额,类型:String
tradeType:交易类型,类型:String 1收入 -1支出
tradeName:交易名称,类型:String
tradeTime:交易时间,类型:String
subtitle:备注,类型:String
tradeClassify:冻结类型 违规冻结:30,类型:int
tradeNumber:订单编号,类型:String
templateType:模板类型,类型:int 1订单相关 2特殊条目 3提现 4违规扣除 5:工单扣款
tradeDate:交易日期,“今日\r\n13:00”,类型:String
},
]
},
msg:””
}
接口描述
输入邀请码。
接口消息定义
请求地址: /rider/submit-invitation-code.json
请求方法: post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:用户名,骑士Id,类型:String
invitationCode:邀请码,类型:String
}
响应消息
{
status: 1,
data:{
successText :提示信息,类型:String
},
msg:“”
}
接口描述
验证身份证。
接口消息定义
请求地址:/rider/submit-authentication-info.json
请求方法: post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:用户名,骑士Id,类型:String
realName:真实姓名,类型:String
identityCard:身份证号,类型:String
tradingAreaId:所属商圈,类型:String
}
响应消息
{
status: 1,
data:{
successText:成功提示信息,类型:String
}
msg:“”
}
接口描述
查询骑手账户中心
接口消息定义
请求地址:/rider/view-account-center.json
请求方法: post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:用户名,骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
balance:余额,类型:double
frozenProvision:提现中,类型:double
blockedFund:冻结中,类型:double
uncheckedBalance:待审核收入,类型:double
monthlyIncome:当月收入,类型:String
incomeDetail:{
distributionFee:配送费,类型:double
reward:奖励额,类型:double
other:其它收入:类型:double
}
monthlyExpense:本月花费,类型:double
expenseDetail:{
riskBlockedFund:违规扣除,类型:double
insurancefee:保险扣费,类型:double
successWithdrawal:已提现,类型:double
equipmentDeposit:装备押金,类型:double
other:其它支出,类型:double
}
canWithdrawalsMoney:可提现资金,类型:double
blockedFundDetail:{
blockedGoodfee:押金,类型:double
blockedRiskfee:违规冻结,类型:double
}
uncheckedBalanceDetail:待审核资金详情{
distributionFee:本月线上配送费,类型:double
reward:奖励额,类型:double
other:其它收入,类型:double
}
accountCheckingVisible:垫付资金统计入口是否可见,类型:int
0:不可见 1:可见
},
msg:“”
}
接口描述
获取账户中心相关信息
接口消息定义
请求地址:/rider/get-account-center-info.json
请求方法: post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:用户名,骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
monthlyIncome:本月收入,类型:double
monthlyIncomeDetails:{
onlineDistributionCharge:本月线上配送费,类型:double
distributionCharge:本月线下配送费,类型:double
subsidyFee:补贴,类型:double
invitationAward:邀请奖励,类型:double
otherIncome:其它收入,类型:double
},
monthlyCosts:本月支出,类型:double
monthlyCostsDetails:{
illegalDeduction:违规扣除,类型:double
insuranceDeduction:保险扣费,类型:double
alreadyWithdrawals:已提现,类型:double
equipmentDeposit:装备押金,类型:double
otherCosts:其它支出,类型:double
},
canWithdrawalsMoney:可提现资金,类型:double
frozenProvision:提现中,类型:double
blockedFund:冻结中,类型:double
blockedFundDetails:{
deposit:押金,类型:double
illegalBlocked:违规冻结,类型:double
},
uncheckedBalance:待审核资金,类型:double
uncheckedBalanceDetails:{
onlineDistributionCharge:本月线上配送费,类型:double
subsidyFee:补贴,类型:double
other:其它收入,类型:double
},
}
msg:“”
}
接口描述
接收通知反馈
接口消息定义
请求地址:/rider/receive-notify.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:用户名,骑士Id,类型:String
receiveOrderNotify:接收订单变更通知,类型:int
receiveKickImeiNotify:退出登录通知,类型:int
receiveLostConnectionNotify:掉线通知,类型:int
receiveVerifyNotify:身份审核通知,类型:int
receiveRiderTypeChangeNotify:骑手身份变更通知,类型:int
receiveLimitedNumberChanged:骑士接单上限通知,类型:int
receiveCancelOrderNotify:取消订单扣款通知,类型:int
receiveForbiddenNotify:禁用及启用通知,类型:int
receiveOrderIds:接收订单通知ID,类型:String
}
响应消息
{
status: 1,
data:””
msg:“”
}
接口描述
获取分享信息
接口消息定义
请求地址:/rider/get-invitation-info.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:用户名,骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
invitationPeopleNum:邀请人数,类型:int
invitationReward:邀请奖励,类型:String
invitationCode:邀请码,类型:String
downloadUrl:下载地址,类型:String
invitationIncome:邀请收入,类型:String
}
msg:“”
}
接口描述
检查应用及补丁版本号,更新app或者下载补丁
接口消息定义
请求地址:/rider/check-app-update.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
version:应用版本号,类型:String
patchVersion:补丁版本号,类型:String
source:手机厂商,类型:String
client:系统版本,类型:String
systemCode:应用编码,骑手 flash ,类型:String
}
响应消息
{
status: 1,
data:{
updateType:app更新类型,0不需要升级 1正常升级 2强制升级 3下载补丁, 类型:int
url:下载地址,类型:String
latestVersion:版本号,类型:String
tips:应用更新提示文案,类型:String
md5:md5,类型:String
}
msg:""
}
接口描述
获取提现账户信息
接口消息定义
请求地址:/rider/get-account-info.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
defaultAlipayAccount:历史提现支付宝账户,类型:String
defaultBankAccount:默认提现银行卡账户,类型:String
accounts:[
{
account:账户,类型:String
accountType:账户类型,0 支付宝 1 银行卡,类型:int
bankName:银行名称,类型:String
},
],
}
msg:“”
}
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
passedExamStatus:0 未通过 10 已通过,类型:int
passedExamStatusText:状态文案,类型:String
}
msg:“”
}
接口描述
获取提现记录
接口消息定义
请求地址:/rider/view-withdrawal-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
currentPage:当前页,类型:int
}
响应消息
{
status: 1,
data:{
currentPage:当前页码,类型:int
pageCount,总页数,类型:int
list: [
{
id:提现交易ID,类型:String
statusText:提现状态文案,类型:String
status:提现状态,类型:int
amount:提现金额,类型:String
applyTime:提现时间,类型:String
},
]
}
msg:“”
}
接口描述
获取提现详情
接口消息定义
请求地址:/rider/get-withdrawal-details.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
balanceId:提现交易ID,类型:String
}
响应消息
{
status: 1,
data:{
status:提现状态,类型:int
statusText:提现状态文案,类型:String
amount:提现金额,类型:double
applyTime:提现时间,类型:String
account:提现账户,类型:String
accountType:账户类型,1 支付宝 1 银行卡,类型:int
accountTypeName:银行名称,类型:String
phases :[{
name:当前操作文案,类型:String
tips:操作标注,类型:String
date:操作时间,类型:String
}
]
}
msg:“”
}
接口描述
获取城市商圈
接口消息定义
请求地址:/rider/get-city-district.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
districtList: [
{
districtName:商圈名称,类型:String
},
]
}
msg:“”
}
接口描述
我已到店
接口消息定义
请求地址:/rider/arrive-shop.json
请求方法: get
请求消息体:
{
cityId:城市Id,类型:String
riderId:骑士Id,类型:String
shopId:商家ID,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
considerDis :是否判断距离超限,判断 1, 不判断 0,类型:int
}
响应消息
{
status: 1,
data:{
successText:提示文案,类型:String
successIds:到店成功ID,类型:String
}
msg:“”
errorCode:距离超限提示码,类型:int
}
接口描述
订单录入
接口消息定义
请求地址:/rider/fill-order.json
请求方法: get
请求消息体:
{
cityId:城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单ID,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
customerAddress:客户地址,类型:String
customerLng:客户地址经度,类型:int
customerLat:客户地址纬度,类型:int
customerMobile:客户联系方式,类型:String
price:订单价格,类型:int
fee:配送费,类型:int
payStatus:支付状态,类型:int
distance:距离,类型:int
userAddressId:用户地址ID,类型:String
phoneType:客户电话类型,类型:int
}
响应消息
{
status: 1,
data:{
successText:提示文案,类型:String
}
msg:“”
}
接口描述
设置异常单:联系不到客人或者客人拒收
接口消息定义
请求地址:/rider/ set-order-abnormal.json
请求方法: get
请求消息体:
{
cityId:城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单ID,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
abnormalReason:异常类型 50 客人拒收 51 联系不到客人,类型:int
considerDis:是否判断距离超限,判断 1, 不判断 0,类型:int
}
响应消息
{
status: 1,
data:{
successText:提示文案,类型:String
}
msg:“”
errorCode:距离超限提示码,类型:int
}
接口描述
通知中心列表
接口消息定义
请求地址:/rider/ view-notification-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
currentPage:当前页,类型:int
}
响应消息
{
status:1,
data:{
currentPage:当前页码,类型:int
pageCount,总页数,类型:int
list:[
{
id:通知id,类型:String
title:通知标题,类型:String
subtitle:副标题,类型:String
time:时间,类型:String
redPoint:红点显示 0 不显示 1 显示,类型:int
}
]
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
}
接口描述
通知已读
接口消息定义
请求地址:/rider/read-notification.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
notificationId:通知ID,类型:String
}
响应消息
{
status:1,
data:{
successText:提示文案,类型:String
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
}
接口描述
选择接单区域后开始接单
接口消息定义
请求地址: /rider/come-to-work.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
workingAreaLat:接单区域中心点纬度,类型:int
workingAreaLng:接单区域中心点经度,类型:int
radius:接单区域半径,类型:double
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
statusText:工作状态文案,类型:String
hasWorkArea:是否已经设定区域 0 未设置 1 已设置,类型:int
radiusRange:{
min:最小工作范围半径,类型:double
max:最大工作范围半径,类型:double
defaultRadius:默认半径,类型:double
step:工作范围调整间隔值,类型:double
}
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:错误码,9002:账号禁用,类型:int
}
接口描述
查询接单区域信息
接口消息定义
请求地址: /rider/get-working-area.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
workingAreaLat:当前工作区域中心点纬度,类型:int
workingAreaLng:当前工作区域中心点经度,类型:int
radius:工作区域半径,类型:double
hasWorkArea:是否已经设定区域,1 已设置,类型:int
markLat:接单区域上方Marker的纬度(工作区域中心点纬度-接单半径占据的纬度), 类型:int
markLng:接单区域上方Marker的经度 类型:int
leftLat:接单范围圆圈最左侧的切点的纬度,
leftLng:接单范围圆圈最左侧切点的经度,
rightLat:接单范围圆圈最右侧的切点的纬度,
rightLng:接单范围圆圈最右侧切点的经度,
bottomLat:接单范围圆圈最下侧的切点的纬度,
bottomLng:接单范围圆圈最下侧的切点的经度,
radiusRange:{
min:最小工作范围半径,类型:double
max:最大工作范围半径,类型:double
defaultRadius:默认半径,类型:double
step:工作范围调整间隔值,类型:double
}
}
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
设置接单区域信息
接口消息定义
请求地址: /rider/set-working-area.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
workingAreaLat:接单区域中心点纬度,类型:int
workingAreaLng:接单区域中心点经度,类型:int
radius:接单区域半径,类型:double
cityName:城市名称,类型:String
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
successText:提示文案,类型:String
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:错误码,9009:骑手跨城市,9010:骑士跨城市,9001: 此城市未开通 类型:int
}
接口描述
修改手机号
接口消息定义
请求地址: /rider/change-rider-mobile.json
请求方法: get
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
realName:真实姓名,类型:String
identityCard:身份证号码,类型:String
oldMobile:旧手机号,类型:String
newMobile:新手机号,类型:String
captcha:验证码,类型:String
imei:设备唯一识别号,类型:String
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
successText:提示文案,类型:String
}
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
获取冻结列表
接口消息定义
请求地址: /rider/get-blocked-list.json
请求方法: get
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
currentPage:当前页,类型:int
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
currentPage:当前页码,类型:int
pageCount,总页数,类型:int
list:[
{
tradeMoney:交易金额,类型:String
tradeName:交易名称,类型:String
tradeTime:交易时间,类型:String
subtitle:备注,类型:String
tradeClassify:冻结类型 违规冻结:30,类型:int
tradeNumber:订单编号,类型:String
}
]
}
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
选择订单列表
接口消息定义
请求地址: /rider/view-shop-order-list.json
请求方法: get
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
shopId:商家ID,类型:String
dispatched:是否已派单,类型:int
keyWord:搜索关键字,类型:String
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
remainNum:还需要选择订单数量,类型:int
list:[
{
orderId:订单id,类型:String
address:客人地址,类型:String
grabbed:是否已接单,类型:boolean
distance:客人距离,类型:String
mobile:客人电话,类型:String
income:收入,类型:String
serialId:口碑订单序列号,类型:String
}
]
}
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
转单
接口消息定义
请求地址: /rider/switch-order.json
请求方法: get
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
orderId:订单ID,类型:String
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
successText:提示文案,类型:String
}
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
屏蔽商家列表
接口消息定义
请求地址: /rider/get-shop-list.json
请求方法: get
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
black:是否屏蔽,类型:int
currentPage:当前页,类型:String
workingAreaLat:接单区域中心点纬度,类型:int
workingAreaLng:接单区域中心点经度,类型:int
radius:接单区域半径,类型:double
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
currentPage:当前页,类型:int
pageCount:页数,类型:int
list:[
{
shopId:商家id,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
black:是否屏蔽 1屏蔽,类型:int
outOfRange:是否超出服务范围,超出:1 类型:int
}
]
}
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
屏蔽商家
接口消息定义
请求地址: /rider/add-to-black-list.json
请求方法: get
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
shopId:商家ID,类型:String
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
successText:提示文案,类型:String
}
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
取消屏蔽商家
接口消息定义
请求地址: /rider/remove-from-black-list.json
请求方法: get
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
shopId:商家ID,类型:String
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
successText:提示文案,类型:String
}
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
获取订单信息
接口消息定义
请求地址: /rider/get-order-info.json
请求方法: get
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
orderId:订单ID,类型:String
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
orderId:订单id,类型:String
customerAddress:客户地址,类型:String
customerLng:客户地址经度,类型:int
customerLat:客户地址纬度,类型:int
customerMobile:客户电话,类型:String
price:价格,类型:double
fee:配送费,类型:String
payStatus:支付状态,类型:int
radius:配送半径,类型:int
editable:是否可编辑,类型:int
phoneType:电话类型,1:座机,类型:int
}
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
查询配送费
接口消息定义
请求地址: /rider/get-distribution-charge.json
请求方法: get
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
orderId:订单ID,类型:String
distance:距离,类型:int
toLat:目的地纬度,类型:int
toLng:目的地经度,类型:int
riderType:骑手类型,类型:int
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
distanceFee:配送费,单位为分,类型:int
}
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
获取提现信息
接口消息定义
请求地址:/rider/get-withdrawal-info.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
accountType:账户类型,类型:Integer 获取所有直接传null,支付宝90
}
响应消息(注意:accounts第一个表示最近一次提现的账户)
{
status: 1,
data:{
avaliableApplyTimes:还可以提现次数,类型:int
accounts:[
{
account:账户,类型:String
accountType:账户类型,90 支付宝 小于90表示银行卡,具体值域看接口get-support-bank-list,类型:int
bankName:银行名称,类型:String
},
],
}
msg:“”
}
接口描述
设置接单上限
接口消息定义
请求地址:/rider/set-order-celling.json
请求方法: get
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
celling:接单上限,类型:int
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
}
msg:“”
}
接口描述
设置接单上限
接口消息定义
请求地址:/rider/get-order-celling.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
minOrderCelling:设置接单上限最小值,类型:int
maxOrderCelling:设置接单上限最大值,类型:int
celling:接单上限,类型:int
usableMaxOrderCelling:实际可选的最大接单上限,类型:int
usableThresholdOrderNum:可选的最大接单上限变化的阈值,类型:int
advisalbeOrderCelling:提示警告接单上限,类型:int
finishedOrderNum:已完成订单数
},
msg:“”
}
接口描述
查询历史地址列表
接口消息定义
请求地址:/rider/get-address-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
mobile:客户电话,类型:String
num:根据客户电话查询地址数量,类型:int
numByRider:根据骑手查询地址数量,类型:int
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
}
响应消息
{
status: 1,
data:{
adressList:[{
id:地址id,类型:String
addr:地址,类型:String
lng:经度,类型:int
lat:纬度,类型:int
outOfRange:是否超出范围,类型:boolean
matchType:匹配类型,1 手机号,2 录入人,类型:int
},
],
},
msg:“”
}
接口描述
获取所属商圈
接口消息定义
请求地址:/rider/get-trading-area-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
cityName:城市名称,类型:String
}
响应消息
{
status: 1,
data:{
tradingAreaList:[{
id:商圈ID,类型:int
name:商圈名字,类型:String
},
],
},
msg:“”
}
接口描述
查新通知中心列表数据
接口消息定义
请求地址:/rider/view-notify-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
currentPage:当前页,类型:int
}
响应消息
{
status: 1,
data:{
currentPage:当前页,类型:int
pageCount:总页数,类型:int
list:[{
id:通知ID,类型:int
title:通知标题,类型:String
content:通知副标题,类型:String
time:时间,类型:String
isRead:通知是否已读,1 已读,类型:int
url:通知连接,类型:String
},
],
},
msg:“”
}
接口描述
查询提现详情信息
接口消息定义
请求地址:/rider/view-withdrawal-detail.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
balanceId:提现Id,类型:String
}
响应消息
{
status: 1,
data:{
statusText:提现状态文案,类型:String
status:提现状态 0 未审核 5 已审核 9 失败 10 成功,类型:int
amount:提现金额,类型:String
applyTiem:提现时间,类型:String
account:账户,类型:String
accountType:账户类型,类型:int
accountTypeName:账户名称,类型:String
phases:[{
name:当前操作文案,类型:String
tips:操作标注,类型:String
date:操作时间,类型:String
},
],
},
msg:“”
}
接口描述
通知标记已读
接口消息定义
请求地址:/rider/read-notify.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
notifyId:通知Id,类型:String
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
},
msg:“”
}
接口描述
绑定提现账户
接口消息定义
请求地址:/rider/set-rider-withdrawal-account.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
account:账户,类型:String
accountType:账户类型,90支付宝 小于90表示银行卡
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
},
msg:“”
}
接口描述
查询未读通知数量
接口消息定义
请求地址:/rider/get-unread-notify-num.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
num:未读消息数量,类型:String
},
msg:“”
}
接口描述
查询未读通知数量
接口消息定义
请求地址:/rider/view-rider-authentication.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
phone:骑手号码,类型:String
realName:骑手姓名,类型:String
identityCard:骑手身份证,类型:String
holdUrl:手持照片URL,类型:String
backUrl:身份证反面照URL,类型:String
frontUrl:身份证正面照URL,类型:String
},
msg:“”
}
接口描述
查询历史成交记录列表
接口消息定义
请求地址:/rider/view-history-aggregate-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
currentPage:当前页,类型:int
}
响应消息
{
status: 1,
data:{
currentPage:当前页,类型:int
pageCount:页码数量,类型:int
list:[{
date:时间,类型:String
finishedNum:完成数量,类型:String
income:收入,类型:String
expense:开支,类型:String
},
],
},
msg:“”
}
接口描述
设置商圈
接口消息定义
请求地址:/rider/set-trading-area.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
tradingAreaId:商圈ID,类型:String
cityName:城市名称,类型:String
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
},
msg:“”
errorCode:错误码,9009:骑手跨城市,9010:骑士跨城市,9001: 此城市未开通 类型:int
}
接口描述
退出登录
接口消息定义
请求地址:/rider/logout.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
lat:纬度,类型:int
lng:经度,类型:int
imei:设备号,类型:String
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
},
msg:“”
}
接口描述
退出登录
接口消息定义
请求地址:/rider/competitor.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
isCoinCide:达达骑手和点我达骑手同时安装,类型:int
isNew:昨天没安装达达骑手但今天装了,类型:int
isUninstall:是否已卸载,类型:int
}
响应消息
{
status: 1,
data:{
successTxt:提示信息,类型:String
},
msg:“”
}
接口描述
定位错误信息上报
接口消息定义
请求地址:/rider/monitor.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
errorCode:错误码,类型:String
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
},
msg:“”
}
接口描述
口碑订单选择订单页抢单
接口消息定义
请求地址:/rider/grab-order.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单Id,类型:String
dispatched:订单是否已经派出,类型:int
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
},
msg:“”
errorCode:错误码
}
接口描述
取消所抢的订单
接口消息定义
请求地址:/rider/pullback-order.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单Id,类型:String
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
},
msg:“”
errorCode:错误码
}
接口描述
标记为虚假订单
接口消息定义
请求地址:/rider/set-order-fake.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单Id,类型:String
lat:经度,类型:int
lng:纬度,类型:int
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
},
msg:“”
errorCode:错误码,类型:int
}
接口描述
订单超距取消
接口消息定义
请求地址:/rider/cancel-order.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单Id,类型:String
lat:经度,类型:int
lng:纬度,类型:int
reason:取消原因,89 超距类型:int
reasonOther:其他取消原因,类型:String
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
},
msg:“”
errorCode:错误码,类型:int
}
接口描述
交易详情
接口消息定义
请求地址:/rider/get-balance-detail.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
balanceId:交易Id,类型:String
appTemplate:类型,分为 1订单相关 2特殊条目 3提现 4扣款,类型:int
history:是否是历史订单交易记录,类型 int 0否 1是
}
响应消息
{
status: 1,
data:{
orderId:订单号,类型:long
shopName:商家名,类型:String
cost:金额,类型:double
applyTime:时间,类型:String
desc:交易名(如 取消订单扣款),类型:String
csTel:客服电话,类型:String
account:提现账户,类型:String
tips:说明(多个原因以|分割),类型:String
helpStr:如何申报保险?|http://....,类型:string
},
msg:“”
errorCode:错误码,类型:int
}
接口描述
标记所有通知已读
接口消息定义
请求地址:/rider/*.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
},
msg:“”
}
接口描述
多商家奖励详情信息
接口消息定义
请求地址:/rider/*.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
tips:完成情况提示语,类型:String
shopList:[{
shopName:商家名称,类型:String
finishOrderNum:完成订单数量,类型:int
taskFinished:任务是否已完成,类型:int
isExceed:是否超额,类型:int
}
]
rules:[{
content:活动规则,类型:String
}
]
},
msg:“”
}
接口描述
多商家奖励详情信息
接口消息定义
请求地址:/rider/get-supported-bank-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
tips:完成情况提示语,类型:String
bankList:[{
name:银行名称,类型:String
id:银行id,类型:int
}]
},
msg:“”
}
接口描述
换城市
接口消息定义
请求地址:/rider/change-city.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String 该字段即变为需要切换到的城市id
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
successText:成功提示,类型:String
},
msg:“”
errorCode 9009骑手切换失败,9010骑士切换失败
}
接口描述
获取附近商家热力分布
接口消息定义
请求地址:/v9/rider/hotareas.json
请求方法:get/post
请求消息体:
{
"cityId":1,
"riderId":2323,
"lng":120089387, //经度
"lat":30098765 //维度
}
响应消息
{
"status":1,
"msg":"成功",
"errorCode":9999,
"data": {
"areas:" [{
"lng":120.089387, //经度
"lat":30.098765, //维度
"pressure":2.0, //热力值
"shopId":2323 //shopId
}]
}
}
接口描述
查询骑士业绩
接口消息定义
请求地址:/v9/rider/achievement.json
请求方法:get/post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
month:月份,1 本月 2 上个月,类型:int
}
响应消息
{
status: 1,
data:{
entryDate:入职日期,类型:String
todayOnlineTime:今日在线时长,类型:float
monthlyAverageOnlineTime:本月平均在线时长,类型:float
onlineBaseTime:在线时长基数,类型:float
scheduleDdays:排班天数,类型:float
attendanceDays:已出勤天数,类型:float
orderNum:{
ordinaryOrder:普通订单,类型:int
seniorOrder:高级服务订单,类型:int
koubeiOrder:口碑订单,类型:int
otherOrder:其它订单,类型:int
}
info:{
arriveTimeOutOrder:到店超时订单,类型:int
storeTimeOutOrder:店内超时订单,类型:int
sendTimeOutOrder:配送超时订单,类型:int
locateAbnormalOrder:定位异常订单,类型:int
cancelOrder:取消订单,类型:int
}
},
msg:""
}
接口描述
身份审核失败信息展示
接口消息定义
请求地址:/v9/rider/auth-feedback.json
请求方法:get/post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
realName:真实姓名,类型:String
identityCard:身份证号,类型:String
frontIdentityImageUrl:身份证正面照片地址,类型:String
backIdentityImageUrl:身份证反面照片地址,类型:String
IdentityImageUrl:手持身份证照片地址,类型:String
reason:失败原因,类型:String
reasonDetails:[
{
type:失败类型,
10:真实姓名与身份证不符;
20:身份证号与身份证不符;
40:身份证正面照不清晰;
50:身份证背面照不清晰;
60:手持身份证照不清晰;
51:身份证上方无“点我达合作骑手”字条
类型:int
details:失败明细信息,类型:String
}
]
},
msg:""
}
接口描述
身份审核失败信息展示
接口消息定义
请求地址:/v9/rider/pass-exam.json
请求方法:get/post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
guideVersion:当前用户的接单引导版本号,类型int
}
响应消息
{
status: 1,
data:{
successText:"操作成功"
},
msg:""
}
接口描述
登录前获取服务器地址
接口消息定义
请求地址:/v9/rider/get-server-address.json
请求方法:get/post
请求消息体:
{
mobile: 电话号码,类型:String
riderId:骑士Id,类型:String
cityId: 城市Id,类型:String
}
响应消息
{
status: 1,
data:{
serverAddress:服务器地址,类型:String
},
msg:""
}
接口描述
推广赚钱页面已读上报
接口消息定义
请求地址:/rider/read-red-point.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status:1,
data:{
successText:提示文案,类型:String
},
msg:“”
}
接口描述
获取投诉或者申请结果详情
接口消息定义
请求地址:/rider/****.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
id:投诉或者申诉ID,类型:string
}
响应消息
{
status:1,
data:{
status:状态,类型:int
statusText:状态文案,类型:String
list:[
{
name:标题,类型:String
value:内容,类型:String
}
]
},
msg:“”
}
接口描述
获取商家或订单标签信息
接口消息定义
请求地址:/rider/get-label-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单Id,类型:String
shopId:商家Id,类型:String
platformId:平台Id,类型:String
}
响应消息
{
status:1,
data:{
list:[
{
code:标签类型int类型
title:标签文案,类型:String
type:标签显示样式,类型:int
1:红字白底,
2:白字红底,
3:蓝字白底,
4:白底灰字-商家标签名
5:橙底红字-超额|即将超额|点点送
6:准点奖励背景红色字体
desc:标签解释说明(html格式),类型:String
}
]
},
msg:“”
}
接口描述
获取商家当前未完成订单信息
接口消息定义
请求地址:/rider/****.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
shopId:商家Id,类型:string
}
响应消息
{
status:1,
data:{
orderList:[
{
id:订单id,类型:String
income:收入,类型:String
advance:垫付,类型:String
customerAddr:客户地址,类型:String
typeStatus:录入状态,类型:number
customerTel:收货人电话,类型:String
serialId:渠道订单序号,类型:String
punctualTm:准点奖励要求时间,类型:String
deliveryThreshold:配送时长阀值,单位:秒,类型:int
labelList:[
{
labelText:标签文案,类型:String
labelType:标签类型,1:红字白底,2:白字红底,3:蓝字白底,类型:int
}
]
requireTm:要求送达时间,类型:String
punctualAmount:准点奖励额金额,类型:double
}
]
},
msg:“”
}
另外有一个接口有更改,view-order-detail接口字段调整
接口描述
获取餐品信息
接口消息定义
请求地址:/rider/view-order-foods.json
请求方法: get
请求消息体:
{
cityId
riderId
orderId
history: 0或1,表示当日订单(0)或历史订单(1)
}
响应消息
{
status:1,
data:{
foodList:[
{
name:餐品名称,类型:String
quantity:数量,类型:int
price:单个商品总价,类型:double
}
]
},
msg:""
}
接口描述
获取七日对账信息列表,该接口所有金额不带元,都为数字类型
接口消息定义
请求地址:/rider/view-account-checking.json
请求方法: get
请求消息体:
{
cityId
riderId
}
响应消息
{
status:1,
data:{
list:[
{
date:日期(格式为yyyy年MM月dd日),类型:String
fontColorType:类型:int 0:绿色 1:红色
amount:金额文案,类型:String
}
]
},
msg:""
}
接口描述
获取单日对账详细列表,该接口所有金额不带元,都为数字类型
接口消息定义
请求地址:/rider/view-checking-detail.json
请求方法: get
请求消息体:
{
cityId
riderId
date:日期,格式为yyyy年MM月dd日,直接传上个接口的date参数即可
}
响应消息
{
status:1,
data:{
list:[
{
orderId:订单号,类型:String
fontColorType:类型:int 0:绿色 1:红色
amount:金额文案,类型:String
}
]
},
msg:""
}
接口描述
查新通知中心列表数据
接口消息定义
请求地址:/rider/view-notify-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
categoryId:0 分类id,类型:int -1 获取全部消息,0系统消息,2管理规则,3活动消息,4培训,5,计费调整,6违规扣款,7其他
lastNotifyId:2323 新增分页参数,第一次请求不传该参数,后面的请求传最后一条数据的id
client: 客户端类型.android或者ios
}
响应消息
{
status: 1,
data:{
currentPage:当前页,类型:int
pageCount:总页数,类型:int
list:[{
id:通知ID,类型:int
title:通知标题,类型:String
content:通知副标题,类型:String
time:时间,类型:String
isRead:通知是否已读,1 已读,类型:int
url:通知连接,类型:String
categoryId:通知类别, 类型:int
},
],
},
msg:“”
}
接口描述
查新通知中心列表数据
接口消息定义
请求地址:/rider/view-notify-category.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
client: 客户端类型.android或者ios
}
响应消息
{
status: 1,
data:{
categoryList:[{
id:通知分类ID,类型:int
name:分类名字,类型:String
unReadCount:99, 类型:int 分类未读通知数
unReadCountView:"99+",类型:String 未读通知数的展示。超过99的显示"99+"
}]
},
msg:“”
}
接口描述
查新通知中心列表数据
接口消息定义
请求地址:/rider/rec-hot-area.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
radius:当前调整的接单半径(非确认修改之后的接单半径) 类型:double,km为单位
}
响应消息
{
status: 1,
data:{
"lat":23.2323, //纬度
"lng":120.2323 //经度
},
msg:“”
}
接口描述
菜鸟订单扫码录入
接口消息定义
请求地址:/rider/pick-up.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
shopId:商家id,类型:string
waybillNo:条形码,类型:string
}
响应消息
{
status: 1,
data:{
successText:成功提示文案,类型:string
orderId:已录入订单ID,类型:string
hasUnPickupOrder:是否有未录入运单号的订单 类型:int 1:有 0:没有
},
msg:“”
errorCode:录入失败错误码,类型:int
9012:运单重复录入
9011:运单号核对失败
}
接口描述
展示物流订单异常原因
接口消息定义
请求地址:/rider/get-special-reasons.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
orderId:订单ID,类型:String
parentId:上级原因ID,类型:String
}
响应消息
{
status: 1,
data:{
list:[{
id:原因ID,类型:String
name:标题,类型:String
desc:副标题,类型:String
tips:选择弹出提示文案,类型:String
useable:是否可选,类型:boolean
hasChild:是否有二级原因,类型:boolean
}
]
},
msg:“”
}
接口描述
提交选择异常原因
接口消息定义
请求地址:/rider/special-handle.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
orderId:订单ID,类型:String
lat:维度,类型:int
lng:经度,类型:int
reason:异常原因ID,类型:String
11:运单破损,无法提交
}
响应消息
{
status: 1,
data:{
handleType:处理类型,订单终结、延迟,0:延迟 99:取消 98:异常 100:完成 类型:int
},
msg:“”
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
sortType:订单排序类型,0 默认时间点排序,1 商家排序,2 订单号排序 类型:int
}
响应消息
{
status:1,
data:{
{
riderStatus:骑手状态,类型:int
statusText:骑手状态文案,类型:String
verifiedStatus:验证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
tips:提示文本,类型:String
unTerminativeOrderNum:总订单数量,类型:number
passexamStatus :培训通过pass状态,类型:number
guideVersion:当前用户的接单引导版本号,类型:int
arriveThreshold:到店时间阀值,类型:int
multiShopReward:多商家奖励,类型:String
hasCompletedOrderNum:已完成单量,类型:int
totalRewardOrderNum:奖励总单量,类型:int
newUserRewardAmount:新手奖励金额,类型:double
grabVisibiliy:抢单按钮显示逻辑,0 不显示 1 半透明 2 有订单亮起,类型:int
orderList:[
{
id:订单id,类型:String
income:收入,类型:String
advance:垫付,类型:String
customerAddr:客户地址,类型:String
distanceToCustomer:距离,类型:String
typeStatus:录入状态,类型:number
customerName:收货人姓名,类型:String
customerTel:收货人电话,类型:String
customerLat:客户地址纬度,类型;int
customerLng:客户地址经度,类型:int
urge:是否催单,类型:int
sinceObtained:配送时长,类型:long
serialId:渠道订单序号,类型:String
punctualTm:准点奖励要求时间,只做标签显示用,类型:String
deliveryThreshold:配送时长阀值,单位:秒,类型:int
punctualTm2:准点奖励要求时间,类型:Date
labelList:[
{
code:标签code,类型:String
title:标签文案,类型:String
type:标签类型,1:红字白底,2:白字红底,3:蓝字白底,4:白底灰字-商家标签名,5:橙底红字-超额|即将超额|点点送,6:准点奖励背景红色字体,类型:int
desc:标签描述,类型:String
}
]
requireTm:要求送达时间,标签显示,类型:String
requireTm2:要求送达时间,类型:Date
serviceTm:服务器当前时间,类型:String
punctualAmount:准点奖励额金额,类型:String
collection:代收,类型:String
collection2:代收,类型:float
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
btnValue:按钮状态,按钮状态 5:我已到店 10:录入新订单 15:还有订单未拍小票 20:离店配送 25:配送中 11:选择订单,类型:int
btnText:按钮状态文案,类型:String
platformId:点点送订单,类型:int,增加菜鸟订单类型
platformName:渠道名称,类型:String
orderType:订单类型,0、普通订单(手发单);1、同城直送;2、外卖订单;3、揽件订单;4、派件订单,类型:int
status:订单状态,5:已派单 10:到店 15:已取单 98:异常 99:已取消 100:已完成,类型:int
leaveTm:离店时间,类型:long
notPaidAmount:客人未支付金额,类型:float
tripId:趟ID,类型:string
dispatchMode:调度模式,1、系统派单;2、抢单;3、人工派单;4、分组派单;5、扫码抢单,类型:int
contractType:商家类别:0:非驻店,1:全驻店,2:半驻店,类型:int
arriveTm:到店时间,类型:long
shopInfo:{
shopId:商家id,类型:number
shopAddr:商家发货地址,类型:String
shopName:商家名称,类型:String
channel:渠道单,类型:number
shopLat:商家地址纬度,类型:number
shopLng:商家地址经度,类型:number
shopTel:商家电话,类型:String
notTyped:未录入订单ID,类型:List
notObtained:未离店订单ID,类型:List
remainTime:到店剩余时间,类型:long
exceedStatus:超额状态 -1 未超额 0 即将超额 1 已超额,类型:int
orderNumThreshold:配送订单额度,类型:int
receivedOrderNum:完成数+当前列表该商家的订单数量,类型:int
feeReductionRatio:配送费减少比例,类型:double
remainNum:未选择剩余订单数量,类型:int
shopHeaderPicUrl:商家店铺照片url,类型:String
labelList: [
{
code:标签code,类型:String
title:标签标题,类型:String
desc:标签描述,类型:String
type:标签类型,类型:int
}
]
platformDesc:渠道描述,类型:String
finishedOrderNum:当日骑手在商家完成的订单数,类型:int
}
}
]
}
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,9002:账号禁用,类型:int
}
接口描述
抢单列表
接口消息定义
请求地址:/rider/rob-order-list.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
currentPage:当前页,类型:int
keyWord:搜索关键字,若为空则显示全部,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
}
响应消息
{
status: 1,
data:{
residentShopList:[
{
shopName:驻店商家名称,驻店订单,类型:string
shopLat:商家地址纬度,驻店订单,类型:number
shopLng:商家地址经度,驻店订单,类型:number
residentTm:驻店时间,类型:Sting
}
]
currentPage:当前页码,类型:int
pageCount:总页数,类型:int
orderType:订单类型,0 普通订单 1 同城直送订单,类型:int
orderList:[
{
id:订单id,类型:String
income:收入,类型:String
customerAddr:客户地址,类型:String
customerLat:客户地址纬度,类型;int
customerLng:客户地址经度,类型:int
distanceToCustomer:距离,类型:String
typeStatus:录入状态,类型:number
customerTel:收货人电话,类型:String
serialId:流水号,类型:String
requireTm:要求送达时间,类型:String
distanceToMe:距你距离,类型:String
weight:重量,类型:String
goodsType:货品类型,类型:string
remark:备注,类型:string
shopAddr:商家地址,类型:string
shopLat:商家地址纬度,类型:number
shopLng:商家地址经度,类型:number
shopName:商家名称,类型:string
}
]
},
msg:“”
}
接口描述
抢单,不同于口碑订单的选择订单
接口消息定义
请求地址:/rider/rob-order.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
orderId:订单Id,类型:string
lat:经纬度,类型:int
lng:经纬度,类型:int
}
响应消息
{
status: 1,
data:{
successText:成功提示文案,类型:string
isBooking:是否预约单,类型:boolean
},
msg:“”
}
接口描述
等级体系,相应特权
接口消息定义
请求地址:/rider/levels.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
}
响应消息
{
status: 1,
data:{
riderLevel:当前等级,类型:int
examCycle:考核周期,类型:String
levelList:[
{
level:等级,类型:int
rightList:[
{
rightID:特权id,类型:int
text:专属特权文案,类型:String
url:跳转url,类型:String
},...
]
upgradeTitle:升级标题,类型:String
upgrade:[
{
url:跳转url,类型:String
tel:电话,类型:String
telMessage:拨打电话提示信息,类型:String
chartTitle:图表标题,类型:String
scale:进度条比例,类型:double
progress:进度,如:还需\r\n20单
bigText:需要放大的text:专属特权文案,类型:String
},...
]
upgradeTips:升级说明,如:*活跃指当天跑单大于10单\r\n*考核期内完成400单,奖励400元,类型:String
keepGradeTitle:保持等级标题,otherTitle:qita
keepGradeotherTips:保持等级其他说明,如:•*活跃指当天跑单大于10单\r\n•*考核期内完成400单,奖励400元,类型:String
}
]
},
msg:“”
}
接口描述
等级体系,相应特权
接口消息定义
请求地址:/rider/upgradeProSign.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
agree:是否同意,0:不同意,1:同意,类型:int
}
响应消息
{
status: 1,
data:{
successText:成功提示文案,类型:String
},
msg:“”
}
接口描述
小票上传成功之后,调用此接口
接口消息定义
请求地址:/rider/ticket-uploaded.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
orderId:订单ID,类型:String
}
响应消息
{
status: 1,
data:{
successText:成功提示文案,类型:String
},
msg:“”
}
4.0.0版本废弃,新的接口替代
接口描述
重新发送取货码或者收货码
接口消息定义
请求地址:/rider/send-code-sms.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
orderId:订单ID,类型:String
codeType:1 取货码、2 收货码,类型:int
}
响应消息
{
status: 1,
data:{
successText:成功提示文案,类型:String
},
msg:“”
}
接口描述
凭借取货码取货
接口消息定义
请求地址:/rider/code-pick-up.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
orderId:订单ID,类型:String
pickCode:取货码,类型:String
shopId:商家ID,类型:string
}
响应消息
{
status: 1,
data:{
successText:成功提示文案,类型:String
},
msg:“”
}
接口描述
获取支付地址生成二维码
接口消息定义
请求地址:/rider/generate-qrcode.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
orderId:订单ID,类型:String
payType:支付类型,1 支付宝 2 微信,类型:int
}
响应消息
{
status: 1,
data:{
notPaidAmount:客人未支付金额,类型:string
qrCode:支付链接,类型:string
},
msg:“”
}
接口描述
查询支付结果
接口消息定义
请求地址:/rider/query-pay-status.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
orderId:订单ID,类型:String
}
响应消息
{
status: 1,
data:{
status:0 失败 1 成功,类型:int
},
msg:“”
}
接口描述
申请解除绑定设备
接口消息定义
请求地址:/rider/****.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
mobile:手机号,类型:int
imei:设备ID,类型:String
}
响应消息
{
status: 1,
data:{
successText:成功文案,类型:String
},
msg:“”
errorCode:9014:申请解绑异常,类型:int
}
接口描述
完成订单调用该接口。
接口消息定义
请求地址: /rider/finish-order
请求方法: post
请求消息体:
{
cityId:城市Id,类型:String
riderId:骑士Id,类型:String
orderId: 订单号id 类型:String
considerDis:是否判断距离超限,判断 1, 不判断 0,类型:int
lat:骑手位置纬度,类型:int
lng:骑手位置经度,类型:int
receivingCode:收货码,类型:string
waybillNo:运单号,类型:string
expressId:快递公司ID,类型:string(备注:运单号及快递公司用于揽件业务)
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
},
msg: ""
errorCode:距离超限提示码,类型:int
errorCode:客人未支付提示码,类型:int
}
接口描述
抢单列表
接口消息定义
请求地址:/rider/rob-order-list.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
currentPage:当前页,类型:int
keyWord:搜索关键字,若为空则显示全部,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
}
响应消息
{
status: 1,
data:{
currentPage:当前页码,类型:int
pageCount:总页数,类型:int
isScanCode:是否支持扫码抢单,类型:boolean
groupList:[{
orderId:订单ID,类型:number
groupId:订单分组,类型:String
platformId:渠道ID,类型:number
orderList:[{
id:订单id,类型:String
income:收入,类型:String
customerAddr:客户地址,类型:String
customerLat:客户地址纬度,类型;int
customerLng:客户地址经度,类型:int
distanceToCustomer:距离,类型:String
typeStatus:录入状态,类型:number
customerTel:收货人电话,类型:String
serialId:流水号,类型:String
requireTm:要求送达时间,类型:String
distanceToMe:距你距离,类型:String
weight:重量,类型:String
goodsType:货品类型,类型:string
remark:备注,类型:string
shopAddr:商家地址,类型:string
shopLat:商家地址纬度,类型:number
shopLng:商家地址经度,类型:number
shopName:商家名称,类型:string
pickupTm:应取货时间,类型:string
orderType:订单类型,类型:int
waybillNo:运单号,类型:string
platformText:渠道名称,类型:string
}]
}]
},
msg:""
}
接口描述
抢单,不同于口碑订单的选择订单
接口消息定义
请求地址:/rider/rob-order.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
orderId:订单ID,类型:number
groupId:订单分组,类型:String
platformId:渠道ID,类型:number
lat:经纬度,类型:int
lng:经纬度,类型:int
}
响应消息
{
status: 1,
data:{
successText:成功提示文案,类型:string
isBooking:是否预约单,类型:boolean
},
msg:""
}
接口描述
扫码抢单
接口消息定义
请求地址:/rider/scan-rob-order.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
waybillNo:运单号,类型:string
enterType:单号录入方式 0:扫码录入 1:手动录入,类型:int
lat:经纬度,类型:int
lng:经纬度,类型:int
}
响应消息
{
status: 1,
data:{
successText:成功提示文案,类型:string
},
msg:“”
errorCode:9007:通用强提示错误码,“运单号未找到”和“该订单已被其他配送员抢走”两种情况使用该枚举,同时下发msg为对应的文案,类型:int
}
接口描述
获取赏金任务列表
接口消息定义
请求地址:/rider/bounty-task-list.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑手Id,类型:int
}
响应消息
{
status: 1,
data:{
joined:[
{
id:任务id,类型:string
name:名称,类型:string
predictedOrderNum:订单数量,类型:String
time:时间段,类型:string
date:日期,类型:string
platformName:订单来源,类型:string
goodsType:货品类型,类型:string
predictedIncome:预计收入,类型:string
capacity:总需报名人数,类型:string
joinedNum:已报名人数,类型:string
}
]
unjoined:[
{
id:任务id,类型:string
name:名称,类型:string
predictedOrderNum:订单数量,类型:String
time:时间段,类型:string
date:日期,类型:string
platformName:订单来源,类型:string
goodsType:货品类型,类型:string
predictedIncome:预计收入,类型:string
capacity:总需报名人数,类型:string
joinedNum:已报名人数,类型:string
}
]
},
msg:“”
}
接口描述
获取赏金任务历史列表
接口消息定义
请求地址:/rider/****.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑手Id,类型:int
}
响应消息
{
status: 1,
data:{
taskList:[
{
id:任务id,类型:string
name:名称,类型:string
orderCount:订单数量,类型:String
time:时间段,类型:string
date:日期,类型:string
source:订单来源,类型:string
goodsType:货品类型,类型:string
income:预计收入,类型:string
taskStatus:任务状态,类型:int
}
]
},
msg:""
}
接口描述
获取赏金任务详情
接口消息定义
请求地址:/rider/bounty-task-detail.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑手Id,类型:int
id:任务ID,类型int
}
响应消息
{
status: 1,
data:{
id:任务id,类型:string
name:名称,类型:string
predictedOrderNum:订单数量,类型:String
date:任务日期,类型:string
time:时间段,类型:String
platformName:订单来源,类型:string
goodType:货品类型,类型:string
rangeLatLngs:[
{
lat:经纬度,类型:int
lng:经纬度,类型:int
}
]
taskStatus:任务状态,0:未开始、1:已开始、2:已结束、3:已完结、4:已取消,类型:int;
status:报名状态,0:未报名,1:已报名,类型:int
capacity:总需报名人数,类型:string
joinedNum:已报名人数,类型:string
requirement:[
"1.Lv2及以上骑手",
"2.裹裹直送;"
] 配送员要求,类型:string类型数组
dispatchMode:调度模式,类型:string
billingRule:计费规则,类型:string
remark:任务说明其它,类型:string
deposit:金额,类型:string
depositLength:押金返还时间,类型:string
amMobile:区域经理电话,类型:string
csTel:客服电话,类型:string
},
msg:""
}
接口描述
参加赏金任务报名
接口消息定义
请求地址:/rider/join-bounty-task.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑手Id,类型:int
id:任务ID,类型:string
}
响应消息
{
status: 1,
data:{
successText:报名成功文案,类型:string
},
errorCode:9007,报名失败并下发msg为报名失败原因,有"标签不符"原因时,"标签不符"文案用<a></a>包裹,如<a href='http://www.dianwoba.com'>标签不符</a>(同标签释义)
msg:""
}
接口描述
获取赏金任务详情
接口消息定义
请求地址:/rider/drop-bounty-task.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑手Id,类型:int
id:任务ID,类型:string
}
响应消息
{
status: 1,
data:{
successText:成功文案,类型:string
},
msg:""
}
接口描述
获取快递公司列表信息
接口消息定义
请求地址:/rider/view-express-list.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑手Id,类型:int
}
响应消息
{
status: 1,
data:{
list:[
{
code:快递公司ID,类型:string
name:名称,类型:string
}
]
},
msg:""
}
接口描述
获取个人信息。
接口消息定义
请求地址: /rider/get-rider-info
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
authenticationStatus:认证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
authenticationInfo:认证信息 类型:String
riderName:姓名,身份认证填写的姓名,类型:String
finishedOrderNumber:完成订单数,类型:String
accumulatedIncome:累计收入,类型:String
balance:余额,类型:String
csTel:客服电话,类型:String
passexamStatus:是否通过考试,类型:int
monthlyIncome:当月收入,类型:String
riderType:骑手身份类型,0 骑手 5 骑士,类型:int
riderLevelText:骑手身份等级,类型:String
amTel:商圈负责人联系方式,类型:String
trainStatus:培训报名状态 类型int
0:不需要弹窗
1:去报名弹窗
2:查看报名信息弹窗
btVisibiliy:赏金任务是否显示,1 显示,类型:int
todayJoinedBTNum:赏金任务角标数字,今日开始的任务数,类型:int
targetServiceVisibiliy:定向服务是否显示,1 显示,类型:int
},
msg:“”
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
sortType:订单排序类型,0 默认时间点排序,1 商家排序,2 订单号排序 类型:int
}
响应消息
{
status:1,
data:{
{
riderStatus:骑手状态,类型:int
statusText:骑手状态文案,类型:String
verifiedStatus:验证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
tips:提示文本,类型:String
unTerminativeOrderNum:总订单数量,类型:number
passexamStatus :培训通过pass状态,类型:number
guideVersion:当前用户的接单引导版本号,类型:int
arriveThreshold:到店时间阀值,类型:int
multiShopReward:多商家奖励,类型:String
hasCompletedOrderNum:已完成单量,类型:int
totalRewardOrderNum:奖励总单量,类型:int
newUserRewardAmount:新手奖励金额,类型:double
grabVisibiliy:抢单按钮显示逻辑,0 不显示 1 半透明 2 有订单亮起,类型:int
orderList:[
{
id:订单id,类型:String
income:收入,类型:String
advance:垫付,类型:String
customerAddr:客户地址,类型:String
distanceToCustomer:距离,类型:String
typeStatus:录入状态,类型:number
customerName:收货人姓名,类型:String
customerTel:收货人电话,类型:String
customerLat:客户地址纬度,类型;int
customerLng:客户地址经度,类型:int
urge:是否催单,类型:int
sinceObtained:配送时长,类型:long
serialId:渠道订单序号,类型:String
punctualTm:准点奖励要求时间,只做标签显示用,类型:String
deliveryThreshold:配送时长阀值,单位:秒,类型:int
punctualTm2:准点奖励要求时间,类型:Date
labelList:[
{
code:标签code,类型:String
title:标签文案,类型:String
type:标签类型,1:红字白底,2:白字红底,3:蓝字白底,4:白底灰字-商家标签名,5:橙底红字-超额|即将超额|点点送,6:准点奖励背景红色字体,类型:int
desc:标签描述,类型:String
}
]
requireTm:要求送达时间,标签显示,类型:String
requireTm2:要求送达时间,类型:Date
serviceTm:服务器当前时间,类型:String
punctualAmount:准点奖励额金额,类型:String
collection:代收,类型:String
collection2:代收,类型:float
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
btnValue:按钮状态,按钮状态 5:我已到店 10:录入新订单 15:还有订单未拍小票 20:离店配送 25:配送中 11:选择订单,类型:int
btnText:按钮状态文案,类型:String
platformId:点点送订单,类型:int,增加菜鸟订单类型
platformName:渠道名称,类型:String
orderType:订单类型,0、普通订单(手发单);1、同城直送;2、外卖订单;3、揽件订单;4、派件订单,类型:int
status:订单状态,5:已派单 10:到店 15:已取单 98:异常 99:已取消 100:已完成,类型:int
leaveTm:离店时间,类型:long
notPaidAmount:客人未支付金额,类型:float
tripId:趟ID,类型:string
dispatchMode:调度模式,1、系统派单;2、抢单;3、人工派单;4、分组派单;5、扫码抢单,类型:int
contractType:商家类别:0:非驻店,1:全驻店,2:半驻店,类型:int
arriveTm:到店时间,类型:long
onlinePayType:0:不区分线上线下支付,1:线下支付,2:线上支付;类型:int
paidAmount:客人已支付金额,类型:float
shopInfo:{
shopId:商家id,类型:number
shopAddr:商家发货地址,类型:String
shopName:商家名称,类型:String
channel:渠道单,类型:number
shopLat:商家地址纬度,类型:number
shopLng:商家地址经度,类型:number
shopTel:商家电话,类型:String
notTyped:未录入订单ID,类型:List
notObtained:未离店订单ID,类型:List
remainTime:到店剩余时间,类型:long
exceedStatus:超额状态 -1 未超额 0 即将超额 1 已超额,类型:int
orderNumThreshold:配送订单额度,类型:int
receivedOrderNum:完成数+当前列表该商家的订单数量,类型:int
feeReductionRatio:配送费减少比例,类型:double
remainNum:未选择剩余订单数量,类型:int
shopHeaderPicUrl:商家店铺照片url,类型:String
labelList: [
{
code:标签code,类型:String
title:标签标题,类型:String
desc:标签描述,类型:String
type:标签类型,类型:int
}
]
platformDesc:渠道描述,类型:String
finishedOrderNum:当日骑手在商家完成的订单数,类型:int
}
}
]
}
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,9002:账号禁用,类型:int
}
接口描述
图片上传成功之后,调用此接口
接口消息定义
请求地址:/rider/picture-uploaded-callback.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
orderId:订单ID,类型:String
type:图片类型, 1、小票;2、货物图片,类型:int
}
响应消息
{
status: 1,
data:{
successText:成功提示文案,类型:String
},
msg:“”
}
接口描述
抢单列表
接口消息定义
请求地址:/rider/rob-order-list.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
currentPage:当前页,类型:int
keyWord:搜索关键字,若为空则显示全部,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
}
响应消息
{
status: 1,
data:{
currentPage:当前页码,类型:int
pageCount:总页数,类型:int
isScanCode:是否支持扫码抢单,类型:boolean
groupList:[{
orderId:订单ID,类型:number
groupId:订单分组,类型:String
platformId:渠道ID,类型:number
orderList:[{
id:订单id,类型:String
income:收入,类型:String
customerAddr:客户地址,类型:String
customerLat:客户地址纬度,类型;int
customerLng:客户地址经度,类型:int
distanceToCustomer:距离,类型:String
typeStatus:录入状态,类型:number
customerTel:收货人电话,类型:String
serialId:流水号,类型:String
requireTm:要求送达时间,类型:String
distanceToMe:距你距离,类型:String
weight:重量,类型:String
goodsType:货品类型,类型:string
remark:备注,类型:string
shopAddr:商家地址,类型:string
shopLat:商家地址纬度,类型:number
shopLng:商家地址经度,类型:number
shopName:商家名称,类型:string
pickupTm:应取货时间,类型:string
orderType:订单类型,类型:int
waybillNo:运单号,类型:string
platformText:渠道名称,类型:string
customerName:客户姓名,类型:String
shopTel:商家电话,类型:String
}]
}]
},
msg:""
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
sortType:订单排序类型,0 默认时间点排序,1 商家排序,2 订单号排序 类型:int
}
响应消息
{
status:1,
data:{
{
riderStatus:骑手状态,类型:int
statusText:骑手状态文案,类型:String
verifiedStatus:验证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
tips:提示文本,类型:String
unTerminativeOrderNum:总订单数量,类型:number
passexamStatus :培训通过pass状态,类型:number
guideVersion:当前用户的接单引导版本号,类型:int
arriveThreshold:到店时间阀值,类型:int
multiShopReward:多商家奖励,类型:String
hasCompletedOrderNum:已完成单量,类型:int
totalRewardOrderNum:奖励总单量,类型:int
newUserRewardAmount:新手奖励金额,类型:double
grabVisibiliy:抢单按钮显示逻辑,0 不显示 1 半透明 2 有订单亮起,类型:int
orderList:[
{
id:订单id,类型:String
income:收入,类型:String
advance:垫付,类型:String
customerAddr:客户地址,类型:String
distanceToCustomer:距离,类型:String
typeStatus:录入状态,类型:number
customerName:收货人姓名,类型:String
customerTel:收货人电话,类型:String
customerLat:客户地址纬度,类型;int
customerLng:客户地址经度,类型:int
urge:是否催单,类型:int
sinceObtained:配送时长,类型:long
serialId:渠道订单序号,类型:String
punctualTm:准点奖励要求时间,只做标签显示用,类型:String
deliveryThreshold:配送时长阀值,单位:秒,类型:int
punctualTm2:准点奖励要求时间,类型:Date
labelList:[
{
code:标签code,类型:String
title:标签文案,类型:String
type:标签类型,1:红字白底,2:白字红底,3:蓝字白底,4:白底灰字-商家标签名,5:橙底红字-超额|即将超额|点点送,6:准点奖励背景红色字体,类型:int
desc:标签描述,类型:String
}
]
requireTm:要求送达时间,标签显示,类型:String
requireTm2:要求送达时间,类型:Date
serviceTm:服务器当前时间,类型:String
punctualAmount:准点奖励额金额,类型:String
collection:代收,类型:String
collection2:代收,类型:float
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
btnValue:按钮状态,按钮状态 5:我已到店 10:录入新订单 15:还有订单未拍小票 20:离店配送 25:配送中 11:选择订单,类型:int
btnText:按钮状态文案,类型:String
platformId:点点送订单,类型:int,增加菜鸟订单类型
platformName:渠道名称,类型:String
orderType:订单类型,0、普通订单(手发单);1、同城直送;2、外卖订单;3、揽件订单;4、派件订单,类型:int
status:订单状态,5:已派单 10:到店 15:已取单 98:异常 99:已取消 100:已完成,类型:int
leaveTm:离店时间,类型:long
notPaidAmount:客人未支付金额,类型:float
tripId:趟ID,类型:string
dispatchMode:调度模式,1、系统派单;2、抢单;3、人工派单;4、分组派单;5、扫码抢单,类型:int
contractType:商家类别:0:非驻店,1:全驻店,2:半驻店,类型:int
arriveTm:到店时间,类型:long
onlinePayType:0:不区分线上线下支付,1:线下支付,2:线上支付;类型:int
paidAmount:客人已支付金额,类型:float
shopInfo:{
shopId:商家id,类型:number
shopAddr:商家发货地址,类型:String
shopName:商家名称,类型:String
channel:渠道单,类型:number
shopLat:商家地址纬度,类型:number
shopLng:商家地址经度,类型:number
shopTel:商家电话,类型:String
notTyped:未录入订单ID,类型:List
notObtained:未离店订单ID,类型:List
remainTime:到店剩余时间,类型:long
exceedStatus:超额状态 -1 未超额 0 即将超额 1 已超额,类型:int
orderNumThreshold:配送订单额度,类型:int
receivedOrderNum:完成数+当前列表该商家的订单数量,类型:int
feeReductionRatio:配送费减少比例,类型:double
remainNum:未选择剩余订单数量,类型:int
shopHeaderPicUrl:商家店铺照片url,类型:String
labelList: [
{
code:标签code,类型:String
title:标签标题,类型:String
desc:标签描述,类型:String
type:标签类型,类型:int
}
]
platformDesc:渠道描述,类型:String
finishedOrderNum:当日骑手在商家完成的订单数,类型:int
}
}
]
}
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,9002:账号禁用,类型:int
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
sortType:订单排序类型,0 默认时间点排序,1 商家排序,2 订单号排序 类型:int
}
响应消息
{
status:1,
data:{
{
riderStatus:骑手状态,类型:int
statusText:骑手状态文案,类型:String
verifiedStatus:验证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
tips:提示文本,类型:String
unTerminativeOrderNum:总订单数量,类型:number
passexamStatus :培训通过pass状态,类型:number
guideVersion:当前用户的接单引导版本号,类型:int
arriveThreshold:到店时间阀值,类型:int
multiShopReward:多商家奖励,类型:String
hasCompletedOrderNum:已完成单量,类型:int
totalRewardOrderNum:奖励总单量,类型:int
newUserRewardAmount:新手奖励金额,类型:double
grabVisibiliy:抢单按钮显示逻辑,0 不显示 1 半透明 2 有订单亮起,类型:int
orderList:[
{
id:订单id,类型:String
income:收入,类型:String
advance:垫付,类型:String
customerAddr:客户地址,类型:String
distanceToCustomer:距离,类型:String
typeStatus:录入状态,类型:number
customerName:收货人姓名,类型:String
customerTel:收货人电话,类型:String
customerLat:客户地址纬度,类型;int
customerLng:客户地址经度,类型:int
urge:是否催单,类型:int
sinceObtained:配送时长,类型:long
serialId:渠道订单序号,类型:String
punctualTm:准点奖励要求时间,只做标签显示用,类型:String
deliveryThreshold:配送时长阀值,单位:秒,类型:int
punctualTm2:准点奖励要求时间,类型:Date
labelList:[
{
code:标签code,类型:String
title:标签文案,类型:String
type:标签类型,1:红字白底,2:白字红底,3:蓝字白底,4:白底灰字-商家标签名,5:橙底红字-超额|即将超额|点点送,6:准点奖励背景红色字体,类型:int
desc:标签描述,类型:String
}
]
requireTm:要求送达时间,标签显示,类型:String
requireTm2:要求送达时间,类型:Date
serviceTm:服务器当前时间,类型:String
punctualAmount:准点奖励额金额,类型:String
collection:代收,类型:String
collection2:代收,类型:float
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
btnValue:按钮状态,按钮状态 5:我已到店 10:录入新订单 15:还有订单未拍小票 20:离店配送 25:配送中 11:选择订单,类型:int
btnText:按钮状态文案,类型:String
platformId:点点送订单,类型:int,增加菜鸟订单类型
platformName:渠道名称,类型:String
orderType:订单类型,0、普通订单(手发单);1、同城直送;2、外卖订单;3、揽件订单;4、派件订单,类型:int
status:订单状态,5:已派单 10:到店 15:已取单 98:异常 99:已取消 100:已完成,类型:int
leaveTm:离店时间,类型:long
notPaidAmount:客人未支付金额,类型:float
tripId:趟ID,类型:string
dispatchMode:调度模式,1、系统派单;2、抢单;3、人工派单;4、分组派单;5、扫码抢单,类型:int
contractType:商家类别:0:非驻店,1:全驻店,2:半驻店,类型:int
arriveTm:到店时间,类型:long
onlinePayType:0:不区分线上线下支付,1:线下支付,2:线上支付;类型:int
paidAmount:客人已支付金额,类型:float
shopInfo:{
shopId:商家id,类型:number
shopAddr:商家发货地址,类型:String
shopName:商家名称,类型:String
channel:渠道单,类型:number
shopLat:商家地址纬度,类型:number
shopLng:商家地址经度,类型:number
shopTel:商家电话,类型:String
notTyped:未录入订单ID,类型:List
notObtained:未离店订单ID,类型:List
remainTime:到店剩余时间,类型:long
exceedStatus:超额状态 -1 未超额 0 即将超额 1 已超额,类型:int
orderNumThreshold:配送订单额度,类型:int
receivedOrderNum:完成数+当前列表该商家的订单数量,类型:int
feeReductionRatio:配送费减少比例,类型:double
remainNum:未选择剩余订单数量,类型:int
shopHeaderPicUrl:商家店铺照片url,类型:String
labelList: [
{
code:标签code,类型:String
title:标签标题,类型:String
desc:标签描述,类型:String
type:标签类型,类型:int
}
]
platformDesc:渠道描述,类型:String
finishedOrderNum:当日骑手在商家完成的订单数,类型:int
notifyList:{
evaluateTimeOut:考核超时提醒时间点,类型:long
fetchTimeOutForSameCity:同城订单取件超时提醒时间点,类型Long
deliveryTimeOutForSameCity:同城订单送达超时提醒时间点,类型:long
}
]
}
}
]
}
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,9002:账号禁用,类型:int
}
接口描述
通过骑手输入的银行卡号判断所属银行
接口消息定义
请求地址: /v181/rider/getCreditBank.json
请求方法: post
请求消息体:
{
riderId:骑手Id
credit:银行卡号
}
响应消息:
{
data: {
bankId:客户热线
bankName:银行名称
}
}
接口描述
通过骑手输入的银行卡号判断所属银行
接口消息定义
请求地址: /v181/rider/getCreditBank.json
请求方法: post
请求消息体:
{
riderId:骑手Id
credit:银行卡号
}
响应消息:
{
status:
data: {
bankId:客户热线
bankName:银行名称
}
}
接口描述
查新通知中心列表数据
接口消息定义
请求地址:/rider/view-notify-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
categoryId:0 分类id,类型:int -1 获取全部消息,0系统消息,2管理规则,3活动消息,4培训,5,计费调整,6违规扣款,7其他
lastNotifyId:2323 新增分页参数,第一次请求不传该参数,后面的请求传最后一条数据的id
client: 客户端类型.android或者ios
}
响应消息
{
status: 1,
data:{
currentPage:当前页,类型:int
pageCount:总页数,类型:int
list:[{
id:通知ID,类型:int
title:通知标题,类型:String
content:通知副标题,类型:String
time:时间,类型:String
isRead:通知是否已读,1 已读,类型:int
url:通知连接,类型:String
categoryId:通知类别, 类型:int
labelText:标签文案(目前只支持一个标签),如:"重要",类型:String
},
],
},
msg:“”
}
接口描述
查询是否可以免责取消
接口消息定义
请求地址:/rider/order-cancelable.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单Id,类型:String
}
响应消息
{
status: 1,
data:{
isOrderCancelable:订单是否可以取消,类型:boolean
restSeconds:剩余的免责取消时间,类型:int
isExceedLimit:是否超过免费取消额度,类型:int
0:不超过 1:超过
deductedMoney:超出额度后取消订单需扣除的费用,类型:String
title:取消文案标题,类型:String
message:取消文案内容,以html的格式返回(部分文案有颜色差异)类型:String
},
],
},
msg:“”
}
接口描述
查询是否可以免责取消
接口消息定义
请求地址:/rider/cancel-order-free.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单Id,类型:String
}
响应消息
{
status: 1,
data:{
successText:取消成功后的文案,类型:String
},
},
msg:""
errorCode:9019:已超过免费取消时间,请重新选择取消原因
9020:账户余额不足以支付本次取消的违约金
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
sortType:订单排序类型,0 默认时间点排序,1 商家排序,2 订单号排序 类型:int
}
响应消息
{
status:1,
data:{
riderStatus:骑手状态,类型:int
0:休息中,5:工作中,99:禁用
verifiedStatus:认证状态,类型:int
0:未认证 5:审核中 9:未通过 10:已认证
tips:提示文案,类型:String
btnText:按钮文案,类型:String
unTerminativeOrderNum:订单数量,类型:int
arriveThreshold:到店阈值,类型:long
verifiedOvertime:是否审核超时,类型:boolean
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
orderList:[ 订单列表
{
id:订单Id,类型:String
income:收入,类型:String
advance:垫付金额,类型:String
customerAddr:收货地址,类型:String
status:订单状态,类型:int
typeStatus:录入状态,类型:int
0:未录入 5:未拍小票 10:已录入 15:已取货 99:未选择订单
type:列表数据类型,类型:int(0:真实订单)
btnValue:按钮状态,类型:int
5:我已到店|取货
10:录入新订单
15:还有订单未拍小票
20:离店配送
25:配送中
22:拍摄货物图片
11:选择订单
btnText:状态文案,类型:String
sinceObtained:配送时长,类型:long
customerTel:收货人联系方式,类型:String
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
urge:是否催单,类型:int
serialId:订单序号,类型:String
punctualTm:准点奖励要求时间,类型:String
labelList:[
{
code:标签Code,类型:int
title:标签标题,类型:String
desc:标签文案,类型:String
type:标签样式类型,类型:int
}
...
]
requireTm:要求送达时间,类型:String
requireTm2:要求送达时间,类型:long
serviceTm:服务器当前时间,类型:long
punctualAmount:准点奖励金额,类型:String
collection:代收,类型:String
collection2:代收金额,类型:double
punctualTm2:准点奖励要求时间,类型:long
searchText:用于订单搜索的字段,类型:String
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
elemeWaybillNo:饿了么运单号,类型:String
shopInfo:{
shopId:商家ID,类型:String
shopAddr:发货地址,类型:String
shopName:商家名称,类型:String
orderNum:订单数量,类型:int
channel:是否是渠道单
0:非渠道单 1:渠道单
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
shopTel:商家电话,类型:String
notTyped:未录入订单ID,类型:List
notObtained:未离店订单ID,类型:List
remainTime:到店剩余时间,类型:long
finishedNum:当前完成商家订单数,类型:int
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
platformName:渠道名称,类型:String
}
isAppointmentOrder:是否是预约单,类型:int
payStatus:支付状态,类型:int
0:默认值,无意义
1:未支付
2:线上支付
3:线下支付
totalIncome:预计收入汇总值(预计收入+小费+困难单奖励),类型:String
orderOvertime:到店或者送达超时标识,类型:boolean
}
...
]
distanceToCustomer:配送距离,类型:String
leaveTm:离店时间,类型:long
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
notPaidAmount:未支付金额,类型:double
dispatchMode:调度模式,类型:int
1:系统派单
2:抢单
3:人工派单
4:分组派单
5:扫码抢单
contractType:驻店模式,类型:int
0:非驻店
1:全驻店
2:半驻店
arriveTm:到店时间,类型:long
onlinePayType:在线支付类型,类型:int
0:不区分线上线下支付
1:线下支付
2:线上支付
paidAmount:客人已支付金额,类型:float
customerName:客人姓名,类型:String
notifyList:{
fetchTimeOut:取货/到店超时时间点,类型:long
deliveryTimeOut:送达超时时间点,类型:long
}
distanceToShop:骑手到商家的距离,类型:String
fetchRequireTm:应取货时间,类型:String
remainDeliveryTime:应送达时间倒计时,类型:int
remainFetchTime:要求取货时间倒计时,类型:int
platformId:渠道编号
fee:小费
}
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/rob-order-list.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
currentPage:当前页码,类型:int
keyWord:搜索关键词,类型:String
lat:骑手当前纬度,类型:int
lng:骑手当前经度,类型:int
}
响应消息
{
status:1,
data:{
currentPage:当前页码,类型:int
pageCount:总页数,类型:int
riderStatus:骑手状态,类型:int
verifiedStatus:验证状态,类型:int
tips:提示文案
btnText:按钮文案
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
groupList:[
{
orderId:订单ID,类型:String
groupId:订单分组,类型:String
platformId:渠道ID,类型:String
income:收入(分组单),类型:String
fee:小费(分组单),类型:String
platformText:取单名称(分组单)
requireTm:要求送达时间(分组单),类型:String
isAppointmentOrder:是否是预约单,类型:int
matchingDegree:顺路度,类型:String
orderList:[
{
id:订单ID,类型:String
income:收入,类型:String
customerAddr:客人地址
distanceToCustomer:配送距离
status:订单状态
requireTm:要求送达时间
distanceToMe:距离你的距离,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
orderType:订单类型,类型:int
0、普通订单(手发单);
1、同城直送;
2、外卖订单;
3、揽件订单;
4、派件订单
customerName:收货人姓名
shopTel:商家电话,类型:String
mixedGrab:是否是抢派混合单,类型:int
}
...
]
}
...
]
isScanCode:是否支持扫码抢单
}
}
接口描述
收集竞品信息,以写日志的形式传递给大数据,具体日志格式参考骑手轨迹还原。
接口消息定义
无
请求方法: get
请求消息体:
event:competitor_detection
……
其它参数同骑手轨迹还原
args:{
appInfos:[
{
type:要监测的app类型,0:达达、1:美团众包,2:蜂鸟众包,3:闪送员,类型:int
isInstalled: 是否安装,0 未安装,1 已安装,类型:int
installTime:安装时间,若未取到传0,类型:long
lastUpdateTime:最近更新时间,类型:long
}
……
]
}
接口描述
退出登录
接口消息定义
请求地址:/rider/check-app-update.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
version:版本号
patchVersion:patch版本号
source:手机型号
client:系统版本号
systemCode:应用编码
}
响应消息
{
status: 1,
data:{
latestVersion:最新应用版本,类型:String
url:应用下载地址,类型:String
md5:patch的md5值,类型:String
updateType:升级模式,类型:int
0:不需要升级
1:正常升级
2:强制升级
3:下载补丁
tips:更新文案,类型:String
apkMd5:apk的md5值,用于校验本地下载的apk是否完整
},
msg:“”
}
接口描述
在登录界面,用户登录时必须经过手机及验证码验证
接口消息定义
请求地址:/ rider/login.json
请求方法: post
请求消息体:
{
mobile:用户名,实际为手机号,类型:String
captcha:验证码,类型:String
cityId:城市ID,类型:String
version:应用版本号,类型:String
imei:手机IMEI号,类型:String
riderId:骑手ID,类型:String
lat:骑手位置经纬度,类型:int
lng:骑手位置经纬度,类型:int
source:手机厂商,类型:String
client:系统版本,类型:String
channelId:渠道ID,类型:String
phoneVersion:手机型号,类型:String
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
updateType:0不需要升级 1正常升级 2强制升级 , 类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
riderId:用户id,类型:String,之后服务端和客户端交流的凭证
insuranceFee:保险费用,类型:float
riderType:骑手类型0:骑手 1:骑士 ,类型:int
tips:更新提示文案,类型:String
areaCode:区号,类型:String
identityCard:身份证,类型:String
tradingAreaId:工作商圈,类型:int
riderName:骑手姓名,类型:String
forceReadNotify:{
id:强制阅读消息ID,类型:String
url:消息URL,类型:String
title:消息标题,类型:String
}
token:登录token,类型:String
serverAddress:服务器地址,类型:string
distanceThreshold:超距判断距离,如3KM,类型:double
targetRadius:目标半径,引导骑手去设置,如1km,类型:double
distanceTimeInterval:超距提示时间间隔,如10分钟,类型:int
waitForDistanceThreshold:等待超时超距判断距离,如0.5KM,类型:double
newUserReward:新手5单奖励活动是否开启,类型:boolean
spreadRedPoint:推广赚钱红点显示,类型:boolean
csTel:客服电话,类型:String
firstLogin:是否首次登陆,类型:boolean
adPicUrl:首屏广告图片URL,类型:String
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:10011,设备已绑定其它账号,类型:int
}
接口描述
判断当前时间是否早于应送达时间前值
接口消息定义
请求地址:/rider/judge-before-require-time.json
请求方法: post
请求消息体
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
}
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
isBeforeRequireTm:是否早于应送达时间,类型:int
0:不早于应送达时间 1:早于应送达时间
}
}
接口描述
获取订单详细信息
接口消息定义
请求地址:/ rider/view-order-detail.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
history:是否是历史订单,类型:boolean
terminalTm:订单时间,类型:String
lat:纬度,类型:int
lng:经度,类型:int
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
id:订单ID
shopAddr:商家地址,类型:String
shopTel:商家电话,类型:String
shopName:商家名称,类型:String
customerAddr:客人地址,类型:String
customerTel:客人电话,类型:String
distributingfee:配送费,类型:String
subsidyfee:补贴,类型:String
payPrice:向发货方支付金额,类型:String
chargePrice:向发货方收取配送费,类型:String
status:订单状态,类型:int
btnText:按钮文案
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
remark:备注,类型:String
chargeUserPrice:向用户收取,类型:String
dispatchTm:派单时间,类型:String
ticketUrl:小票URL,类型:String
incomeInfo:{收入
incomeMsg:收入提示文案,类型:String
totalIncome:收入总计,类型:String
incomeList:[
{
name:收入名称,类型:String
income:收入金额,类型:String
incomeDetailList:[
name:收入名称,类型:String
income:收入金额,类型:String
incomeText:收入名称,类型:String
]
}
......
]
}
arriveConsume:到店用时,类型:long
deliveryConsume:配送剩余时间,类型:long
hasArrived:是否已到店,类型:boolean
punctualRewardText:订单准点奖励文案,类型:String
timeout:是否超时,类型:int
outOfDispatchingRange:是否超距,类型:int
distanceForFee:配送范围,类型:String
leaveTm:离店时间,类型:String
finishTm:完成时间,类型:String
tradingAreaName:订单所属商圈,类型:String
orderCancelReason:订单取消原因,类型:String
cancelPunishment:取消惩罚,类型:String
appealStatusText:申诉状态文案,类型:String
appealId:申诉ID,类型:String
complaintStatusText:投诉状态文案
complaintId:投诉ID,类型:String
punishDate:订单取消惩罚时间,类型:String
platformId:渠道ID,类型:int
balanceInfo:结算信息集合
hasFoodInfo:是否存在餐品信息,类型:int
collection:代收,类型:double
isResident:是否驻店,类型:int
orderType:订单类型,类型:int
notPaidAmount:客人未支付金额,类型:double
dispatchMode:调度模式,类型:int
contractType:驻店模式,类型:int
onlinePayType:支付模式,类型:int
paidAmount:客人已支付金额,类型:double
orderIncomeRuleUrl:订单收入规则URL
shopId:商家ID,类型:String
requireTm:应送达时间,类型:String
fetchRequireTm:应取货时间,类型:String
btnValue:按钮状态,类型:int
predictIncome:预计收入,类型:String
distanceToShop:骑手到商家的距离,类型:String
distanceToCustomer:骑手到客人的距离,类型:String
weight:重量,类型:String
punctualRewardMoney:准点奖励金额,类型:String
punctualRewardRequireTm:准点奖励要求送达时间,类型:String
fee:小费,类型:String
arriveTm:到店时间,类型:String
getGoodsTm:取货时间,类型:String
cancelGoodsTm:取消时间,类型:String
waybillNo:面单号,类型:String
arriveTmTips:到店是否超时提示,类型:String
deliveryTmTips:送达是否超时提示,类型:String
goodsMoney:货品金额,类型:String
distanceToDestination:骑手到目的地的距离,类型:String
customerName:收货人姓名,类型:String
getGoodsTmTips:取货时间(同城直送订单),类型:String
isAppointmentOrder:是否是预约单,类型:int
timeAssessList:[
{
assessName:考核名称,例:准点到店时间,类型:string
assessContent:考核内容,例:12:30前,类型:string
reward:奖励,例:奖 ¥2.5:,类型:string
overRewardTime:是否超过奖励时间,类型:boolean
timeover:是否超时,类型:boolean
},
……
]
}
}
接口描述
获取订单详细信息
接口消息定义
请求地址:/ rider/hotareas.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
ltLat:地图可视区域左上角纬度,类型:int
ltLng:地图可视区域左上角经度,类型:int
rtLat:地图可视区域右上角纬度,类型:int
rtLng:地图可视区域右上角经度,类型:int
lbLat:地图可视区域左下角纬度,类型:int
lbLng:地图可视区域左下角经度,类型:int
rbLat:地图可视区域右下角纬度,类型:int
rbLng:地图可视区域右下角经度,类型:int
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
areas:[
{
lat:热力点纬度,类型:double
lng:热力点经度,类型:double
pressure:压力值,类型:double
}
...
]
}
}
接口描述
抢单接口。
接口消息定义
请求地址:/ rider/rob-order.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
groupId:订单组ID,类型:String
platformId:平台ID,类型:int
lat:骑手当前纬度,类型:int
lng:骑手当前经度,类型:int
orderIndex:所抢订单在当前订单列表的序号,从1开始,类型:int
matchingDegree:顺路度,类型:String
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
successText:抢单成功的文案,类型:String
isBooking:是否是预约单,类型:boolean
}
}
接口描述
获取个人信息。
接口消息定义
请求地址: /rider/get-rider-info
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
authenticationStatus:认证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
authenticationInfo:认证信息 类型:String
riderName:姓名,身份认证填写的姓名,类型:String
finishedOrderNumber:完成订单数,类型:String
accumulatedIncome:累计收入,类型:String
balance:余额,类型:String
csTel:客服电话,类型:String
passexamStatus:是否通过考试,类型:int
monthlyIncome:当月收入,类型:String
riderType:骑手身份类型,0 骑手 5 骑士,类型:int
riderLevelText:骑手身份等级,类型:String
amTel:商圈负责人联系方式,类型:String
trainStatus:培训报名状态 类型int
0:不需要弹窗
1:去报名弹窗
2:查看报名信息弹窗
btVisibiliy:赏金任务是否显示,1 显示,类型:int
todayJoinedBTNum:赏金任务角标数字,今日开始的任务数,类型:int
targetServiceVisibiliy:定向服务是否显示,1 显示,类型:int
taskCenterUrl:任务中心URL,类型:String
taskCenterSignature:任务中心签名,类型:String
levelInfo:{
currentValue:骑手当前成长值,类型int
totalValue:升级成长值,类型int
levelInfoText:等级提示文案,类型:String
levelQuestionText:等级更新文案,类型String
taskDatas:[
{
upgradeTitle:任务描述,类型String
mission:[
{
title:“拥有点我达装备”,类型:String
buttonStr:按钮文案,类型:String
finished:true任务已完成|false任务未完成,类型:bool
},
]
},
]
privilegeList:[
{
type:标签背景图片类型,1:橙色五角星, 2:绿色三角形,3:蓝色五角星 4:青色六边形,5紫色正方形
value:标签文案,类型:string
name:标签描述,类型String
},
]
}
},
msg:“”
}
接口描述
等级体系,相应特权
接口消息定义
请求地址:/rider/new-levels.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
}
响应消息
{
status: 1,
data:{
riderLevel:当前等级,类型:int
examCycle:考核周期,类型:String
levelList:[
{
level:等级,类型:int
rightList:[
{
name:专属特权文案,类型:String
value:特权指数,类型:String
url:跳转url,类型:String
type:标签背景图片类型,1:橙色五角星, 2:绿色三角形,3:蓝色五角星 4:青色六边形,5紫色正方形
},...
]
}
]
upgradeExplainUrl:怎样升级的url,类型:string
upgradeTips:成长进度条上的文案,类型:String
curValue:当前成长值,类型:int
levelValue:等级成长值,类型:int
levelQuestionText:等级更新文案,类型String
upgradeList:[
{
upgradeTitle:“升级Lv.4 任务”,类型:String
mission:[
{
title:“拥有点我达装备”,类型:String
tip:任务解释,类型:string
buttonStr:按钮文案,类型:String
missionType:任务类型,1:装备购买|2:参加培训
finished:true任务已完成|false任务未完成,类型:bool
},...]
},...]
},
msg:“”
}
接口描述
等级体系,相应特权
接口消息定义
请求地址:/rider/get-withdrawal-info.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
accountType:账户类型,类型:int
}
响应消息
{
"status": 1,
"data": {
"accounts": [{
"account": 账户,类型:String,
"accountType": 账户类型,类型:int,
"bankName": 银行名称,类型:String
}],
"avaliableApplyTimes": 当天可提现次数,类型:int
chargeFee:提现手续费,单位:元,类型:float
},
"msg": "",
"errorCode": "",
"extraMsg": ""
}
接口描述
判断当前时间是否早于应送达时间前值
接口消息定义
请求地址:/rider/judge-before-require-time.json
请求方法: post
请求消息体
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
}
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
isBeforeRequireTm:是否早于应送达时间,类型:int
0:不早于应送达时间 1:早于应送达时间
message:弹窗文案,以html的格式返回,类型String
price:扣罚金额,类型float
}
}
接口描述
查询提现详情信息
接口消息定义
请求地址:/rider/view-withdrawal-detail.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
balanceId:提现Id,类型:String
}
响应消息
{
status: 1,
data:{
statusText:提现状态文案,类型:String
status:提现状态 0 未审核 5 已审核 9 失败 10 成功,类型:int
amount:提现金额,类型:String
applyTiem:提现时间,类型:String
account:账户,类型:String
accountType:账户类型,类型:int
accountTypeName:账户名称,类型:String
chargeFee:提现手续费 单位:元 类型:float
phases:[{
name:当前操作文案,类型:String
tips:操作标注,类型:String
date:操作时间,类型:String
},
],
},
msg:“”
}
ftype=1 fto=18
param新增url和imgUrl,分别表示链接url和弹窗图片url
接口描述
获取订单详细信息
接口消息定义
请求地址:/ rider/view-order-detail.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
history:是否是历史订单,类型:boolean
terminalTm:订单时间,类型:String
lat:纬度,类型:int
lng:经度,类型:int
}
响应消息:
{
errorCode:9020,订单详情刷新,订单被其他骑手抢走
msg:"" 当errorCode=9020时,msg="对不起,订单已被手更快的人抢走啦"
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
id:订单ID
shopAddr:商家地址,类型:String
shopTel:商家电话,类型:String
shopName:商家名称,类型:String
customerAddr:客人地址,类型:String
customerTel:客人电话,类型:String
distributingfee:配送费,类型:String
subsidyfee:补贴,类型:String
payPrice:向发货方支付金额,类型:String
chargePrice:向发货方收取配送费,类型:String
status:订单状态,类型:int
btnText:按钮文案
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
remark:备注,类型:String
chargeUserPrice:向用户收取,类型:String
dispatchTm:派单时间,类型:String
ticketUrl:小票URL,类型:String
incomeInfo:{收入
incomeMsg:收入提示文案,类型:String
totalIncome:收入总计,类型:String
incomeList:[
{
name:收入名称,类型:String
income:收入金额,类型:String
incomeDetailList:[
name:收入名称,类型:String
income:收入金额,类型:String
incomeText:收入名称,类型:String
]
}
......
]
}
arriveConsume:到店用时,类型:long
deliveryConsume:配送剩余时间,类型:long
hasArrived:是否已到店,类型:boolean
punctualRewardText:订单准点奖励文案,类型:String
timeout:是否超时,类型:int
outOfDispatchingRange:是否超距,类型:int
distanceForFee:配送范围,类型:String
leaveTm:离店时间,类型:String
finishTm:完成时间,类型:String
tradingAreaName:订单所属商圈,类型:String
orderCancelReason:订单取消原因,类型:String
cancelPunishment:取消惩罚,类型:String
appealStatusText:申诉状态文案,类型:String
appealId:申诉ID,类型:String
complaintStatusText:投诉状态文案
complaintId:投诉ID,类型:String
punishDate:订单取消惩罚时间,类型:String
platformId:渠道ID,类型:int
balanceInfo:结算信息集合
hasFoodInfo:是否存在餐品信息,类型:int
collection:代收,类型:double
isResident:是否驻店,类型:int
orderType:订单类型,类型:int
notPaidAmount:客人未支付金额,类型:double
dispatchMode:调度模式,类型:int
contractType:驻店模式,类型:int
onlinePayType:支付模式,类型:int
paidAmount:客人已支付金额,类型:double
orderIncomeRuleUrl:订单收入规则URL
shopId:商家ID,类型:String
requireTm:应送达时间,类型:String
fetchRequireTm:应取货时间,类型:String
btnValue:按钮状态,类型:int
predictIncome:预计收入,类型:String
distanceToShop:骑手到商家的距离,类型:String
distanceToCustomer:骑手到客人的距离,类型:String
weight:重量,类型:String
punctualRewardMoney:准点奖励金额,类型:String
punctualRewardRequireTm:准点奖励要求送达时间,类型:String
fee:小费,类型:String
arriveTm:到店时间,类型:String
getGoodsTm:取货时间,类型:String
cancelGoodsTm:取消时间,类型:String
waybillNo:面单号,类型:String
arriveTmTips:到店是否超时提示,类型:String
deliveryTmTips:送达是否超时提示,类型:String
goodsMoney:货品金额,类型:String
distanceToDestination:骑手到目的地的距离,类型:String
customerName:收货人姓名,类型:String
getGoodsTmTips:取货时间(同城直送订单),类型:String
isAppointmentOrder:是否是预约单,类型:int
timeAssessList:[
{
assessName:考核名称,例:准点到店时间,类型:string
assessContent:考核内容,例:12:30前,类型:string
reward:奖励,例:奖 ¥2.5:,类型:string
overRewardTime:是否超过奖励时间,类型:boolean
timeover:是否超时,类型:boolean
},
……
]
}
}
接口描述
获取所有订单经纬度。
接口消息定义
请求地址: /rider/get-route.json
请求方法: post
请求消息体:
{
riderId:骑士Id,类型:String
cityId:城市Id,类型:String
}
响应消息
{
status: 1,
data:{
route: [
{
lat:纬度,类型:String
lng:经度,类型:String
type: 用户点10,商家点5,类型:int
name:商家名或者客人名称,类型:String
address:地址,类型:String
isGot:是否已取 0 未取 1 已取,类型:int
orderId:订单ID,类型:String
orderModel:抢派混合模式下的订单类型 0:派单 1:抢单 类型:int
},
]
},
msg:” ”
}
接口描述
获取所有订单经纬度。
接口消息定义
请求地址: /rider/get-route.json
请求方法: post
请求消息体:
{
riderId:骑士Id,类型:String
cityId:城市Id,类型:String
}
响应消息
{
status: 1,
data:{
route: [
{
lat:纬度,类型:String
lng:经度,类型:String
type: 用户点10,商家点5,类型:int
name:商家名或者客人名称,类型:String
address:地址,类型:String
isGot:是否已取 0 未取 1 已取,类型:int
orderId:订单ID,类型:String
dispatchMode:订单模式,类型:int
1:派单模式 2:抢单模式
},
]
},
msg:” ”
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/get-balance-log.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
currentPage:当前页,类型:number
}
响应消息
{
status: 1,
data:{
currentPage:当前页码,类型:int
pageCount,总页数,类型:int
list:[
{
tradeId:交易Id,类型:String
tradeMoney:交易金额,类型:String
tradeType:交易类型,类型:String 1收入 -1支出
tradeName:交易名称,类型:String
tradeTime:交易时间,类型:String
subtitle:备注,类型:String
tradeClassify:冻结类型 违规冻结:30,类型:int
tradeNumber:订单编号,类型:String
templateType:模板类型,类型:int 1订单相关 2特殊条目 3提现 4违规扣除
tradeDate:交易日期,“今日\r\n13:00”,类型:String
},
]
},
msg:””
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/obtain-hema-goods.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
barCode:二维码/条形码 编号,类型:String
}
响应消息
{
status: 1,
data:{
successText:取货成功后的弹窗文案,类型:String
},
msg:取件失败后传失败原因
errorCode:错误码
3017:未签到,不能揽收
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/hema-check-in.json
请求方法: *粗体文本***post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
lat:骑手当前所在位置纬度,类型:int
lng:骑手当前所在位置精度,类型:int
}
响应消息
{
status: 1,
data:{
successText:签到成功后的文案,类型:String
},
msg:签到失败原因
errorCode:错误码
4003:地理位置有误,不能签到
}
接口描述
获取订单详细信息
接口消息定义
请求地址:/ rider/view-order-detail.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
history:是否是历史订单,类型:boolean
terminalTm:订单时间,类型:String
lat:纬度,类型:int
lng:经度,类型:int
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
id:订单ID
shopAddr:商家地址,类型:String
shopTel:商家电话,类型:String
shopName:商家名称,类型:String
customerAddr:客人地址,类型:String
customerTel:客人电话,类型:String
distributingfee:配送费,类型:String
subsidyfee:补贴,类型:String
payPrice:向发货方支付金额,类型:String
chargePrice:向发货方收取配送费,类型:String
status:订单状态,类型:int
btnText:按钮文案
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
remark:备注,类型:String
chargeUserPrice:向用户收取,类型:String
dispatchTm:派单时间,类型:String
ticketUrl:小票URL,类型:String
incomeInfo:{收入
incomeMsg:收入提示文案,类型:String
totalIncome:收入总计,类型:String
incomeList:[
{
name:收入名称,类型:String
income:收入金额,类型:String
incomeDetailList:[
name:收入名称,类型:String
income:收入金额,类型:String
incomeText:收入名称,类型:String
]
}
......
]
}
arriveConsume:到店用时,类型:long
deliveryConsume:配送剩余时间,类型:long
hasArrived:是否已到店,类型:boolean
punctualRewardText:订单准点奖励文案,类型:String
timeout:是否超时,类型:int
outOfDispatchingRange:是否超距,类型:int
distanceForFee:配送范围,类型:String
leaveTm:离店时间,类型:String
finishTm:完成时间,类型:String
tradingAreaName:订单所属商圈,类型:String
orderCancelReason:订单取消原因,类型:String
cancelPunishment:取消惩罚,类型:String
appealStatusText:申诉状态文案,类型:String
appealId:申诉ID,类型:String
complaintStatusText:投诉状态文案
complaintId:投诉ID,类型:String
punishDate:订单取消惩罚时间,类型:String
platformId:渠道ID,类型:int
新增盒马订单渠道,72
stockOut:是否缺货,1-缺货 0-未缺货 类型:int
difference:货品是否有差异 1-有差异 0-无差异 类型:int
balanceInfo:结算信息集合
hasFoodInfo:是否存在餐品信息,类型:int
collection:代收,类型:double
isResident:是否驻店,类型:int
orderType:订单类型,类型:int
notPaidAmount:客人未支付金额,类型:double
dispatchMode:调度模式,类型:int
contractType:驻店模式,类型:int
onlinePayType:支付模式,类型:int
paidAmount:客人已支付金额,类型:double
orderIncomeRuleUrl:订单收入规则URL
shopId:商家ID,类型:String
requireTm:应送达时间,类型:String
fetchRequireTm:应取货时间,类型:String
btnValue:按钮状态,类型:int
predictIncome:预计收入,类型:String
distanceToShop:骑手到商家的距离,类型:String
distanceToCustomer:骑手到客人的距离,类型:String
weight:重量,类型:String
punctualRewardMoney:准点奖励金额,类型:String
punctualRewardRequireTm:准点奖励要求送达时间,类型:String
fee:小费,类型:String
arriveTm:到店时间,类型:String
getGoodsTm:取货时间,类型:String
cancelGoodsTm:取消时间,类型:String
waybillNo:面单号,类型:String
arriveTmTips:到店是否超时提示,类型:String
deliveryTmTips:送达是否超时提示,类型:String
goodsMoney:货品金额,类型:String
distanceToDestination:骑手到目的地的距离,类型:String
customerName:收货人姓名,类型:String
getGoodsTmTips:取货时间(同城直送订单),类型:String
isAppointmentOrder:是否是预约单,类型:int
timeAssessList:[
{
assessName:考核名称,例:准点到店时间,类型:string
assessContent:考核内容,例:12:30前,类型:string
reward:奖励,例:奖 ¥2.5:,类型:string
overRewardTime:是否超过奖励时间,类型:boolean
timeover:是否超时,类型:boolean
},
……
]
}
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
sortType:订单排序类型,0 默认时间点排序,1 商家排序,2 订单号排序 类型:int
}
响应消息
{
status:1,
data:{
riderStatus:骑手状态,类型:int
0:休息中,5:工作中,99:禁用
verifiedStatus:认证状态,类型:int
0:未认证 5:审核中 9:未通过 10:已认证
tips:提示文案,类型:String
btnText:按钮文案,类型:String
unTerminativeOrderNum:订单数量,类型:int
arriveThreshold:到店阈值,类型:long
verifiedOvertime:是否审核超时,类型:boolean
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
orderList:[ 订单列表
{
id:订单Id,类型:String
income:收入,类型:String
advance:垫付金额,类型:String
customerAddr:收货地址,类型:String
status:订单状态,类型:int
typeStatus:录入状态,类型:int
0:未录入 5:未拍小票 10:已录入 15:已取货 99:未选择订单
type:列表数据类型,类型:int(0:真实订单)
btnValue:按钮状态,类型:int
5:我已到店|取货
10:录入新订单
15:还有订单未拍小票
20:离店配送
25:配送中
22:拍摄货物图片
11:选择订单
btnText:状态文案,类型:String
sinceObtained:配送时长,类型:long
customerTel:收货人联系方式,类型:String
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
urge:是否催单,类型:int
serialId:订单序号,类型:String
punctualTm:准点奖励要求时间,类型:String
labelList:[
{
code:标签Code,类型:int
title:标签标题,类型:String
desc:标签文案,类型:String
type:标签样式类型,类型:int
}
...
]
requireTm:要求送达时间,类型:String
requireTm2:要求送达时间,类型:long
serviceTm:服务器当前时间,类型:long
punctualAmount:准点奖励金额,类型:String
collection:代收,类型:String
collection2:代收金额,类型:double
punctualTm2:准点奖励要求时间,类型:long
searchText:用于订单搜索的字段,类型:String
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
elemeWaybillNo:饿了么运单号,类型:String
shopInfo:{
shopId:商家ID,类型:String
shopAddr:发货地址,类型:String
shopName:商家名称,类型:String
orderNum:订单数量,类型:int
channel:是否是渠道单
0:非渠道单 1:渠道单
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
shopTel:商家电话,类型:String
notTyped:未录入订单ID,类型:List
notObtained:未离店订单ID,类型:List
remainTime:到店剩余时间,类型:long
finishedNum:当前完成商家订单数,类型:int
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
platformName:渠道名称,类型:String
}
isAppointmentOrder:是否是预约单,类型:int
payStatus:支付状态,类型:int
0:默认值,无意义
1:未支付
2:线上支付
3:线下支付
totalIncome:预计收入汇总值(预计收入+小费+困难单奖励),类型:String
orderOvertime:到店或者送达超时标识,类型:boolean
}
...
]
distanceToCustomer:配送距离,类型:String
leaveTm:离店时间,类型:long
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
notPaidAmount:未支付金额,类型:double
dispatchMode:调度模式,类型:int
1:系统派单
2:抢单
3:人工派单
4:分组派单
5:扫码抢单
contractType:驻店模式,类型:int
0:非驻店
1:全驻店
2:半驻店
arriveTm:到店时间,类型:long
onlinePayType:在线支付类型,类型:int
0:不区分线上线下支付
1:线下支付
2:线上支付
paidAmount:客人已支付金额,类型:float
customerName:客人姓名,类型:String
notifyList:{
fetchTimeOut:取货/到店超时时间点,类型:long
deliveryTimeOut:送达超时时间点,类型:long
}
distanceToShop:骑手到商家的距离,类型:String
fetchRequireTm:应取货时间,类型:String
remainDeliveryTime:应送达时间倒计时,类型:int
remainFetchTime:要求取货时间倒计时,类型:int
platformId:渠道ID,类型:int
新增盒马订单渠道,72
newLabelList:[
{
labelText:标签文案,类型:String
labelColor:标签字体颜色,如:“#fe751a”,类型:String
bgColor:标签背景颜色,如:“#fe751a”,类型:String
}
...
]
fee:小费
}
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/rob-order-list.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
currentPage:当前页码,类型:int
keyWord:搜索关键词,类型:String
lat:骑手当前纬度,类型:int
lng:骑手当前经度,类型:int
}
响应消息
{
status:1,
data:{
currentPage:当前页码,类型:int
pageCount:总页数,类型:int
riderStatus:骑手状态,类型:int
verifiedStatus:验证状态,类型:int
tips:提示文案
btnText:按钮文案
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
groupList:[
{
orderId:订单ID,类型:String
groupId:订单分组,类型:String
platformId:渠道ID,类型:String
income:收入(分组单),类型:String
fee:小费(分组单),类型:String
platformText:取单名称(分组单)
requireTm:要求送达时间(分组单),类型:String
isAppointmentOrder:是否是预约单,类型:int
matchingDegree:顺路度,类型:String
orderList:[
{
id:订单ID,类型:String
income:收入,类型:String
customerAddr:客人地址
distanceToCustomer:配送距离
status:订单状态
requireTm:要求送达时间
distanceToMe:距离你的距离,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
orderType:订单类型,类型:int
0、普通订单(手发单);
1、同城直送;
2、外卖订单;
3、揽件订单;
4、派件订单
customerName:收货人姓名
shopTel:商家电话,类型:String
mixedGrab:是否是抢派混合单,类型:int
newLabelList:[
{
labelText:标签文案,类型:String
labelColor:标签字体颜色,如:“#fe751a”,类型:String
bgColor:标签背景颜色,如:“#fe751a”,类型:String
}
...
]
}
...
]
}
...
]
isScanCode:是否支持扫码抢单
}
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/view-hema-goods-list.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
orderId:订单Id
}
响应消息
{
status: 1,
data:{
goodsList:[
{
goodsId:商品Id,类型:String
skuId:与盒马对接的商品ID,类型:String
goodsName:货品名称,类型:String
placeGoods:用户下单时的商品规格,如:"下单:0.5kg x 4个",类型:String
pickingGoods:实际拣货后的商品规格,如:"1kg x 2个",类型:String
stockOut:是否缺货,1-缺货 0-未缺货 类型:int
difference:货品是否有差异 1-有差异 0-无差异 类型:int
btnText:按钮文案,如:拒收/已拒收等 类型:String
isRejectable:是否可以拒收,1-可拒收 0-不可拒收 类型:int
}
...
]
},
msg:""
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/get-hema-reject-reasons.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
reasons:[
{
reasonId:拒收原因Id,类型:int
reasonText:拒收原因文案,类型:String
}
...
]
},
msg:""
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/cancel-hema-goods.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
orderId:订单ID,不能为空,类型:String
reasonId:拒收/取消订单原因,不能为空,类型:int
goodsId:商品ID,可空
1.当goodsId为空时,表示无法送达取消订单
2.当goodsId不为空时,表示拒收部分商品
skuId:与盒马对接的商品ID,类型:String
lat:骑手纬度,类型:int
lng:骑手经度,类型:int
}
响应消息
{
status: 1,
data:{
successText:拒收/取消订单成功后的文案
},
msg:""
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/get-hema-delivery-reasons.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
reasons:[
{
reasonId:送达原因Id,类型:int
reasonText:送达原因文案,类型:String
}
...
]
},
msg:""
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/finish-hema-goods.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
orderId:订单ID,不能为空,类型:String
reasonId:送达原因Id,不能为空,类型:int
lat:骑手纬度,类型:int
lng:骑手经度,类型:int
}
响应消息
{
status: 1,
data:{
successText:货品送达成功后的文案
},
msg:""
}
接口描述
每隔15秒上传一次骑手位置经纬度。
接口消息定义
请求地址: /rider/ upload-position.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
imei:设备号,类型:String
version:版本号,类型:String
token:token,类型:String
locationType:定位类型,类型:int
}
响应消息
{
status:1,
data:{
isSelf: 是否是自己登录 1 正常登录 0 非自己登录,类型:int
verifyResult: 身份验证通知,类型:String
notSelfText: 别人登陆后的通知,类型:String
verifiedOvertime:审核超时,类型:boolean
orderNotifyList:[
{
orderId:订单ID,类型:String
type:通知类型,1:新订单 2:取消单 3:修改单, 12:离店后取消 13:追加单 类型:int
shopId:商家ID,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
customerAddr:客户地址,类型:String
platformId:渠道id,类型:int
elemeWaybillNo:饿了么运单号,类型:String
income:订单金额,类型:String
}
],
lostConnectionNotify:强行休息的通知,类型:String
updateType:0不需要升级 1正常升级 2强制升级,类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
tips:提示信息,类型:String
orderCellingChangedNotify: 修改接单上限通知,类型:String
riderTypeChangeNotify:骑手身份变更通知,类型:String
cancelOrderPunishNotify:订单取消扣款通知,类型:String
patchUpdateNotify:补丁下发通知,类型:int
forbiddenNotify:禁用 启用通知,格式:1|提示信息,1 禁用 2启用,类型:String
upgradeProtocolNotify:升级协议通知,格式:0|不显示协议浮层,1|显示协议浮层,类型:int
robOrderNotify:有可抢单通知,1 无订单 2 有订单 类型:int
bannerNotify:banner变化通知,1 无变化 2 有变化 类型:int
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,类型:int
}
接口描述
查询是否可以免责取消
接口消息定义
请求地址:/rider/cancel-order-free.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单Id,类型:String
}
响应消息
{
status: 1,
data:{
successText:取消成功后的文案,类型:String
isAppendOrder:是否是追加单,1-是 0-不是,类型:int
},
},
msg:""
errorCode:9019:已超过免费取消时间,请重新选择取消原因
9020:账户余额不足以支付本次取消的违约金
}
接口描述
接收通知反馈
接口消息定义
请求地址:/rider/receive-notify.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:用户名,骑士Id,类型:String
receiveOrderNotify:接收订单变更通知,类型:int
receiveKickImeiNotify:退出登录通知,类型:int
receiveLostConnectionNotify:掉线通知,类型:int
receiveVerifyNotify:身份审核通知,类型:int
receiveRiderTypeChangeNotify:骑手身份变更通知,类型:int
receiveLimitedNumberChanged:骑士接单上限通知,类型:int
receiveCancelOrderNotify:取消订单扣款通知,类型:int
receiveForbiddenNotify:禁用及启用通知,类型:int
receiveOrderIds:接收订单通知ID,类型:String
receiveBannerNotify:banner变化通知,1-收到,0-未收到,类型:int
}
响应消息
{
status: 1,
data:””
msg:“”
}
接口描述
查询banner信息
接口消息定义
请求地址:/rider/get-banner-info.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
locationPage:位置标志(1-抢单列表),类型:int
}
响应消息
{
status: 1,
data:{
locationId:位置标志ID,类型:int
bannerList:[
{
bannerId:标志ID,类型:int
imageUrl:显示图片下载地址,类型:String
url:跳转url(如果是跳转到普通网页),类型:String
param:跳转到原生界面,类型:String
}
...
]
},
}
接口描述
提交追加单取消原因
接口消息定义
请求地址:/rider/appendorder-cancel-reason.json
请求方法: get
请求消息体:
{
riderId:骑手Id,类型:String
orderId:追加单订单Id,类型:String
reasonType:取消原因类型,0:商家未与我沟通;1:订单不顺路;99:其他,类型:int
reason:取消原因文案,类型:String
}
响应消息
{
status: 1,
data:{
successText:提交成功,类型:String
},
},
msg:""
errorCode:""
}
接口描述
获取个人信息。
接口消息定义
请求地址: /rider/get-rider-info
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
authenticationStatus:认证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
authenticationInfo:认证信息 类型:String
riderName:姓名,身份认证填写的姓名,类型:String
finishedOrderNumber:完成订单数,类型:String
accumulatedIncome:累计收入,类型:String
balance:余额,类型:String
csTel:客服电话,类型:String
passexamStatus:是否通过考试,类型:int
monthlyIncome:当月收入,类型:String
riderType:骑手身份类型,0 骑手 5 骑士,类型:int
riderLevelText:骑手身份等级,类型:String
amTel:商圈负责人联系方式,类型:String
trainStatus:培训报名状态 类型int
0:不需要弹窗
1:去报名弹窗
2:查看报名信息弹窗
btVisibiliy:赏金任务是否显示,1 显示,类型:int
healthCardText:健康证状态文案,类型:String
todayJoinedBTNum:赏金任务角标数字,今日开始的任务数,类型:int
targetServiceVisibiliy:定向服务是否显示,1 显示,类型:int
taskCenterUrl:任务中心URL,类型:String
taskCenterSignature:任务中心签名,类型:String
levelInfo:{
currentValue:骑手当前成长值,类型int
totalValue:升级成长值,类型int
levelInfoText:等级提示文案,类型:String
levelQuestionText:等级更新文案,类型String
taskDatas:[
{
upgradeTitle:任务描述,类型String
mission:[
{
title:“拥有点我达装备”,类型:String
buttonStr:按钮文案,类型:String
finished:true任务已完成|false任务未完成,类型:bool
},
]
},
]
privilegeList:[
{
type:标签背景图片类型,1:橙色五角星, 2:绿色三角形,3:蓝色五角星 4:青色六边形,5紫色正方形
value:标签文案,类型:string
name:标签描述,类型String
},
]
}
},
msg:“”
}
1.ftype=5:表示刷新界面的动作
2.fto=25:表示上传健康证弹窗的动作
3.title:
格式:是否是登陆下发的推送(int类型 1:是 0:否)|弹窗文案(html格式返回的文案)
如:1|请在两周内办理并上传健康证,否则将无法配送饿了么订单
接口描述
获取个人信息。
接口消息定义
请求地址: /rider/get-rider-info
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
authenticationStatus:认证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
authenticationInfo:认证信息 类型:String
riderName:姓名,身份认证填写的姓名,类型:String
finishedOrderNumber:完成订单数,类型:String
accumulatedIncome:累计收入,类型:String
balance:余额,类型:String
csTel:客服电话,类型:String
passexamStatus:是否通过考试,类型:int
monthlyIncome:当月收入,类型:String
riderType:骑手身份类型,0 骑手 5 骑士,类型:int
riderLevelText:骑手身份等级,类型:String
amTel:商圈负责人联系方式,类型:String
trainStatus:培训报名状态 类型int
0:不需要弹窗
1:去报名弹窗
2:查看报名信息弹窗
btVisibiliy:赏金任务是否显示,1 显示,类型:int
healthCardText:健康证状态文案,类型:String
onlineDuration:今日在线时长,如:8小时32分 类型:String
isNewComer:是否是新手,1:是新手 0:不是新手 类型:int
todayJoinedBTNum:赏金任务角标数字,今日开始的任务数,类型:int
targetServiceVisibiliy:定向服务是否显示,1 显示,类型:int
taskCenterUrl:任务中心URL,类型:String
taskCenterSignature:任务中心签名,类型:String
levelInfo:{
currentValue:骑手当前成长值,类型int
totalValue:升级成长值,类型int
levelInfoText:等级提示文案,类型:String
levelQuestionText:等级更新文案,类型String
taskDatas:[
{
upgradeTitle:任务描述,类型String
mission:[
{
title:“拥有点我达装备”,类型:String
buttonStr:按钮文案,类型:String
finished:true任务已完成|false任务未完成,类型:bool
},
]
},
]
privilegeList:[
{
type:标签背景图片类型,1:橙色五角星, 2:绿色三角形,3:蓝色五角星 4:青色六边形,5紫色正方形
value:标签文案,类型:string
name:标签描述,类型String
newComerPrivilege:是否是新手特权 1:是 0:不是 类型:int
},
]
}
},
msg:“”
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
sortType:订单排序类型,0 默认时间点排序,1 商家排序,2 订单号排序 类型:int
}
响应消息
{
status:1,
data:{
riderStatus:骑手状态,类型:int
0:休息中,5:工作中,99:禁用
verifiedStatus:认证状态,类型:int
0:未认证 5:审核中 9:未通过 10:已认证
tips:提示文案,类型:String
btnText:按钮文案,类型:String
unTerminativeOrderNum:订单数量,类型:int
arriveThreshold:到店阈值,类型:long
verifiedOvertime:是否审核超时,类型:boolean
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
orderList:[ 订单列表
{
id:订单Id,类型:String
income:收入,类型:String
advance:垫付金额,类型:String
customerAddr:收货地址,类型:String
status:订单状态,类型:int
typeStatus:录入状态,类型:int
0:未录入 5:未拍小票 10:已录入 15:已取货 99:未选择订单
type:列表数据类型,类型:int(0:真实订单)
btnValue:按钮状态,类型:int
5:我已到店|取货
10:录入新订单
15:还有订单未拍小票
20:离店配送
25:配送中
22:拍摄货物图片
11:选择订单
btnText:状态文案,类型:String
sinceObtained:配送时长,类型:long
customerTel:收货人联系方式,类型:String
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
urge:是否催单,类型:int
serialId:订单序号,类型:String
punctualTm:准点奖励要求时间,类型:String
labelList:[
{
code:标签Code,类型:int
title:标签标题,类型:String
desc:标签文案,类型:String
type:标签样式类型,类型:int
}
...
]
requireTm:要求送达时间,类型:String
requireTm2:要求送达时间,类型:long
serviceTm:服务器当前时间,类型:long
punctualAmount:准点奖励金额,类型:String
collection:代收,类型:String
collection2:代收金额,类型:double
punctualTm2:准点奖励要求时间,类型:long
searchText:用于订单搜索的字段,类型:String
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
elemeWaybillNo:饿了么运单号,类型:String
shopInfo:{
shopId:商家ID,类型:String
shopAddr:发货地址,类型:String
shopName:商家名称,类型:String
orderNum:订单数量,类型:int
channel:是否是渠道单
0:非渠道单 1:渠道单
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
shopTel:商家电话,类型:String
notTyped:未录入订单ID,类型:List
notObtained:未离店订单ID,类型:List
remainTime:到店剩余时间,类型:long
finishedNum:当前完成商家订单数,类型:int
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
platformName:渠道名称,类型:String
}
isAppointmentOrder:是否是预约单,类型:int
payStatus:支付状态,类型:int
0:默认值,无意义
1:未支付
2:线上支付
3:线下支付
totalIncome:预计收入汇总值(预计收入+小费+困难单奖励),类型:String
orderOvertime:到店或者送达超时标识,类型:boolean
punishDesc:处罚文案 类型String 例:超时20分钟扣¥5.0
}
...
]
distanceToCustomer:配送距离,类型:String
leaveTm:离店时间,类型:long
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
notPaidAmount:未支付金额,类型:double
dispatchMode:调度模式,类型:int
1:系统派单
2:抢单
3:人工派单
4:分组派单
5:扫码抢单
contractType:驻店模式,类型:int
0:非驻店
1:全驻店
2:半驻店
arriveTm:到店时间,类型:long
onlinePayType:在线支付类型,类型:int
0:不区分线上线下支付
1:线下支付
2:线上支付
paidAmount:客人已支付金额,类型:float
customerName:客人姓名,类型:String
notifyList:{
fetchTimeOut:取货/到店超时时间点,类型:long
deliveryTimeOut:送达超时时间点,类型:long
}
distanceToShop:骑手到商家的距离,类型:String
fetchRequireTm:应取货时间,类型:String
remainDeliveryTime:应送达时间倒计时,类型:int
remainFetchTime:要求取货时间倒计时,类型:int
platformId:渠道ID,类型:int
新增盒马订单渠道,72
newLabelList:[
{
labelText:标签文案,类型:String
labelColor:标签字体颜色,如:“#fe751a”,类型:String
bgColor:标签背景颜色,如:“#fe751a”,类型:String
}
...
]
fee:小费
}
}
接口描述
查询是否可以免责取消
接口消息定义
请求地址:/rider/order-cancelable.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单Id,类型:String
}
响应消息
{
status: 1,
data:{
isOrderCancelable:订单是否可以取消,类型:boolean
restSeconds:剩余的免责取消时间,类型:int
isCountDown:是否有倒计时,1:有倒计时 0:无倒计时,类型:int
isExceedLimit:是否超过免费取消额度,类型:int
0:不超过 1:超过
deductedMoney:超出额度后取消订单需扣除的费用,类型:String
title:取消文案标题,类型:String
message:取消文案内容,以html的格式返回(部分文案有颜色差异)类型:String
},
],
},
msg:“”
}
接口描述
等级体系,相应特权
接口消息定义
请求地址:/rider/get-withdrawal-info.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
accountType:账户类型,类型:int
}
响应消息
{
"status": 1,
"data": {
"accounts": [{
"account": 账户,类型:String,
"accountType": 账户类型,类型:int,
"bankName": 银行名称,类型:String
}],
"avaliableApplyTimes": 当天可提现次数,类型:int
chargeFee:提现手续费,单位:元,类型:float
newComerPrivilege:是否是新手期特权,1:是 0:不是 类型:int
},
"msg": "",
"errorCode": "",
"extraMsg": ""
}
接口描述
设置接单上限
接口消息定义
请求地址:/rider/get-order-celling.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
minOrderCelling:设置接单上限最小值,类型:int
maxOrderCelling:设置接单上限最大值,类型:int
celling:接单上限,类型:int
usableMaxOrderCelling:实际可选的最大接单上限,类型:int
usableThresholdOrderNum:可选的最大接单上限变化的阈值,类型:int
advisalbeOrderCelling:提示警告接单上限,类型:int
finishedOrderNum:已完成订单数
isNewComer:是否是新手期 1:是 0:不是 类型:int
},
msg:“”
}
接口描述
获取订单详细信息
接口消息定义
请求地址:/ rider/view-order-detail.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
history:是否是历史订单,类型:boolean
terminalTm:订单时间,类型:String
lat:纬度,类型:int
lng:经度,类型:int
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
id:订单ID
shopAddr:商家地址,类型:String
shopTel:商家电话,类型:String
shopName:商家名称,类型:String
customerAddr:客人地址,类型:String
customerTel:客人电话,类型:String
distributingfee:配送费,类型:String
subsidyfee:补贴,类型:String
payPrice:向发货方支付金额,类型:String
chargePrice:向发货方收取配送费,类型:String
status:订单状态,类型:int
btnText:按钮文案
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
remark:备注,类型:String
chargeUserPrice:向用户收取,类型:String
dispatchTm:派单时间,类型:String
ticketUrl:小票URL,类型:String
incomeInfo:{收入
incomeMsg:收入提示文案,类型:String
totalIncome:收入总计,类型:String
incomeList:[
{
name:收入名称,类型:String
income:收入金额,类型:String
incomeDetailList:[
name:收入名称,类型:String
income:收入金额,类型:String
incomeText:收入名称,类型:String
]
}
......
]
}
arriveConsume:到店用时,类型:long
deliveryConsume:配送剩余时间,类型:long
hasArrived:是否已到店,类型:boolean
punctualRewardText:订单准点奖励文案,类型:String
timeout:是否超时,类型:int
outOfDispatchingRange:是否超距,类型:int
distanceForFee:配送范围,类型:String
leaveTm:离店时间,类型:String
finishTm:完成时间,类型:String
tradingAreaName:订单所属商圈,类型:String
orderCancelReason:订单取消原因,类型:String
cancelPunishment:取消惩罚,类型:String
appealStatusText:申诉状态文案,类型:String
appealId:申诉ID,类型:String
complaintStatusText:投诉状态文案
complaintId:投诉ID,类型:String
punishDate:订单取消惩罚时间,类型:String
platformId:渠道ID,类型:int
新增盒马订单渠道,72
stockOut:是否缺货,1-缺货 0-未缺货 类型:int
difference:货品是否有差异 1-有差异 0-无差异 类型:int
balanceInfo:结算信息集合
hasFoodInfo:是否存在餐品信息,类型:int
collection:代收,类型:double
isResident:是否驻店,类型:int
orderType:订单类型,类型:int
notPaidAmount:客人未支付金额,类型:double
dispatchMode:调度模式,类型:int
contractType:驻店模式,类型:int
onlinePayType:支付模式,类型:int
paidAmount:客人已支付金额,类型:double
orderIncomeRuleUrl:订单收入规则URL
shopId:商家ID,类型:String
requireTm:应送达时间,类型:String
fetchRequireTm:应取货时间,类型:String
btnValue:按钮状态,类型:int
predictIncome:预计收入,类型:String
distanceToShop:骑手到商家的距离,类型:String
distanceToCustomer:骑手到客人的距离,类型:String
weight:重量,类型:String
punctualRewardMoney:准点奖励金额,类型:String
punctualRewardRequireTm:准点奖励要求送达时间,类型:String
fee:小费,类型:String
arriveTm:到店时间,类型:String
getGoodsTm:取货时间,类型:String
cancelGoodsTm:取消时间,类型:String
waybillNo:面单号,类型:String
arriveTmTips:到店是否超时提示,类型:String
deliveryTmTips:送达是否超时提示,类型:String
goodsMoney:货品金额,类型:String
distanceToDestination:骑手到目的地的距离,类型:String
customerName:收货人姓名,类型:String
getGoodsTmTips:取货时间(同城直送订单),类型:String
isAppointmentOrder:是否是预约单,类型:int
timeAssessList:[
{
assessName:考核名称,例:准点到店时间,类型:string
assessContent:考核内容,例:12:30前,类型:string
reward:奖励,例:奖 ¥2.5:,类型:string
overRewardTime:是否超过奖励时间,类型:boolean
timeover:是否超时,类型:boolean
punishDesc: 处罚描述 例:超时20分钟扣¥5.0,类型String
oldAccessContent:旧考核内容,如:12:40前,类型:String
oldAccessDesc:旧考核描述,如:因接到新的订单,送达时间发生调整 类型:String
},
……
]
}
}
接口描述
在登录界面,用户登录时必须经过手机及验证码验证
接口消息定义
请求地址:/ rider/login.json
请求方法: post
请求消息体:
{
mobile:用户名,实际为手机号,类型:String
captcha:验证码,类型:String
cityId:城市ID,类型:String
version:应用版本号,类型:String
imei:手机IMEI号,类型:String
riderId:骑手ID,类型:String
lat:骑手位置经纬度,类型:int
lng:骑手位置经纬度,类型:int
source:手机厂商,类型:String
client:系统版本,类型:String
channelId:渠道ID,类型:String
phoneVersion:手机型号,类型:String
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
updateType:0不需要升级 1正常升级 2强制升级 , 类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
riderId:用户id,类型:String,之后服务端和客户端交流的凭证
insuranceFee:保险费用,类型:float
riderType:骑手类型0:骑手 1:骑士 ,类型:int
tips:更新提示文案,类型:String
areaCode:区号,类型:String
identityCard:身份证,类型:String
tradingAreaId:工作商圈,类型:int
riderName:骑手姓名,类型:String
forceReadNotify:{
id:强制阅读消息ID,类型:String
url:消息URL,类型:String
title:消息标题,类型:String
}
token:登录token,类型:String
serverAddress:服务器地址,类型:string
distanceThreshold:超距判断距离,如3KM,类型:double
targetRadius:目标半径,引导骑手去设置,如1km,类型:double
distanceTimeInterval:超距提示时间间隔,如10分钟,类型:int
waitForDistanceThreshold:等待超时超距判断距离,如0.5KM,类型:double
newUserReward:新手5单奖励活动是否开启,类型:boolean
spreadRedPoint:推广赚钱红点显示,类型:boolean
csTel:客服电话,类型:String
firstLogin:是否首次登陆,类型:boolean
serverTime:服务器当前时间戳,类型:long
isNewComer:是否是新骑手,1:是 0:否,类型:int
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:10011,设备已绑定其它账号,类型:int
}
接口描述
完成订单调用该接口。
接口消息定义
请求地址: /rider/finish-order
请求方法: post
请求消息体:
{
cityId:城市Id,类型:String
riderId:骑士Id,类型:String
orderId: 订单号id 类型:String
considerDis:是否判断距离超限,判断 1, 不判断 0,类型:int
lat:骑手位置纬度,类型:int
lng:骑手位置经度,类型:int
receivingCode:收货码,类型:string
waybillNo:运单号,类型:string
expressId:快递公司ID,类型:string(备注:运单号及快递公司用于揽件业务)
reasonId:盒马订单-送达原因Id,不能为空,类型:int
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
totalOrderNum:新手奖励订单总数量,类型:int
finishedOrderNum:已完成的订单总数量,类型:string 当改字段为空时,表示服务器超时,本地不更新
reward:每单的奖励金额,类型:float,一位小数
showBanner:是否展示Banner,1:是 0:否 类型:int
},
msg: ""
errorCode:距离超限提示码,类型:int
errorCode:客人未支付提示码,类型:int
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-orderhis-list.json
请求方法: post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
currentPage:当前页,类型:int
today:订单类型,0 今日订单 1历史订单,类型:int
}
响应消息
{
status:1,
data:{
todayTotal:今日订单数量,类型:int
historyTotal:历史订单数量,类型:int
pagination:{
currentPage:当前页码,类型:int
pageCount,总页数,类型:int
list:[
{
id:订单id,类型:String
income:收入,类型:String
customerAddr:客户地址,类型:String
distanceToCustomer:距离,类型:String
status:订单状态,类型:String
shopName:商家名,类型:String
shopAddr:商家地址:类型:String
isResident:是否驻店, 类型:boolean
onlinePayStatus:0:不显示,1:显示【线下支付】标签,2:显示【可申诉补款】标签
evaluateStatus:评价商家状态,类型:int,1:评论商家,2:查看评论,
}
]
},
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
}
** 接口描述
每隔15秒上传一次骑手位置经纬度。
接口消息定义
请求地址: /rider/ upload-position.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
imei:设备号,类型:String
version:版本号,类型:String
token:token,类型:String
locationType:定位类型,类型:int
}
响应消息
{
status:1,
data:{
isSelf: 是否是自己登录 1 正常登录 0 非自己登录,类型:int
verifyResult: 身份验证通知,类型:String
notSelfText: 别人登陆后的通知,类型:String
verifiedOvertime:审核超时,类型:boolean
orderNotifyList:[
{
orderId:订单ID,类型:String
type:通知类型,1:新订单 2:取消单 3:修改单, 12:离店后取消 13:追加单 类型:int
shopId:商家ID,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
customerAddr:客户地址,类型:String
platformId:渠道id,类型:int
elemeWaybillNo:饿了么运单号,类型:String
income:订单金额,类型:String
}
],
lostConnectionNotify:强行休息的通知,类型:String
updateType:0不需要升级 1正常升级 2强制升级,类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
tips:提示信息,类型:String
orderCellingChangedNotify: 修改接单上限通知,类型:String
riderTypeChangeNotify:骑手身份变更通知,类型:String
cancelOrderPunishNotify:订单取消扣款通知,类型:String
patchUpdateNotify:补丁下发通知,类型:int
forbiddenNotify:禁用 启用通知,格式:1|提示信息,1 禁用 2启用,类型:String
upgradeProtocolNotify:升级协议通知,格式:0|不显示协议浮层,1|显示协议浮层,类型:int
robOrderNotify:有可抢单通知,1 无订单 2 有订单 类型:int
bannerNotify:banner变化通知,1 无变化 2 有变化 类型:int
agingStatus:时效变更,类型:int,1:已变更,0:未变更,
authResult:认证结果 1:审核成功(仅在审核成功时下发) 2:审核失败(仅在审核失败时下发) 类型:int
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,类型:int
}
接口描述
等级体系,相应特权
接口消息定义
请求地址:/rider/new-levels.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
}
响应消息
{
status: 1,
data:{
riderLevel:当前等级,类型:int
examCycle:考核周期,类型:String
isNewComer:是否处于新手期 1:是 0:否 类型:int
bannerMessage:新手期Banner文案,如:新手期(6.28-7.11)享受新手特权 类型:String
levelList:[
{
level:等级,类型:int
rightList:[
{
name:专属特权文案,类型:String
value:特权指数,类型:String
url:跳转url,类型:String
type:标签背景图片类型,1:橙色五角星, 2:绿色三角形,3:蓝色五角星 4:青色六边形,5紫色正方形
newComerPrivilege:是否是新手期特权,1:是 0:不是 类型:int
privilegeText:新手期特权文案,如:(新手期额度+2) 类型:String
},...
]
}
]
upgradeExplainUrl:怎样升级的url,类型:string
upgradeTips:成长进度条上的文案,类型:String
curValue:当前成长值,类型:int
levelValue:等级成长值,类型:int
levelQuestionText:等级更新文案,类型String
upgradeList:[
{
upgradeTitle:“升级Lv.4 任务”,类型:String
mission:[
{
title:“拥有点我达装备”,类型:String
tip:任务解释,类型:string
buttonStr:按钮文案,类型:String
missionType:任务类型,1:装备购买|2:参加培训
finished:true任务已完成|false任务未完成,类型:bool
},...]
},...]
},
msg:“”
}
接口描述
交易详情
接口消息定义
请求地址:/rider/get-balance-detail.json
请求方法: get
请求消息体:
{
...
}
响应消息
{
status: 1,
data:{
...
isTransferredOrder:是否是转单,类型:boolean
},
msg:“”
errorCode:错误码,类型:int
}
接口描述
交易详情
接口消息定义
请求地址:/rider/get-finished-order-num.json
请求方法: get
请求消息体:
{
cityId:城市ID
riderId:骑手ID
}
响应消息
{
status: 1,
data:{
totalOrderNum:新手奖励订单总数量,类型:int
finishedOrderNum:已完成的订单总数量,类型:string
reward:每单的奖励金额,类型:float,一位小数
showBanner:是否展示Banner,1:是 0:否 类型:int
},
msg:“”
}
接口描述
设置异常单:联系不到客人或者客人拒收
接口消息定义
请求地址:/rider/ set-order-abnormal.json
请求方法: get
请求消息体:
{
cityId:城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单ID,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
abnormalReason:异常类型 50 客人拒收 51 联系不到客人,类型:int
considerDis:是否判断距离超限,判断 1, 不判断 0,类型:int
}
响应消息
{
status: 1,
data:{
successText:提示文案,类型:String
totalOrderNum:新手奖励订单总数量,类型:int
finishedOrderNum:已完成的订单总数量,类型:string 当改字段为空时,表示服务器超时,本地不更新
reward:每单的奖励金额,类型:float,一位小数
showBanner:是否展示Banner,1:是 0:否 类型:int
}
msg:“”
errorCode:距离超限提示码,类型:int
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/view-hema-goods-list.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
orderId:订单Id
}
响应消息
{
status: 1,
data:{
goodsList:[
{
goodsId:商品Id,类型:String
skuId:与盒马对接的商品ID,类型:String
goodsName:货品名称,类型:String
placeGoods:用户下单时的商品规格,如:"0.5kg x 4个",类型:String
pickingGoods:实际拣货后的商品规格,如:"1kg x 2个",类型:String
stockOut:是否缺货,1-缺货 0-未缺货 类型:int
difference:货品是否有差异 1-有差异 0-无差异 类型:int
btnText:按钮文案,如:拒收/已拒收等 类型:String
isRejectable:是否可以拒收,1-可拒收 0-不可拒收 类型:int
barcode:条形码,类型:String
}
...
]
},
msg:""
}
1.获得新手礼包推送协议
1.1 ftype=5
1.2 fto=26
1.3 params新增ts字段,类型:long,精确到毫秒
(1)ts具体时间戳意义跟fto有关
(2)新手礼包协议中,ts表示新手期截止时间戳
---------------------------------------------------
2.新手期结束推送协议
2.1 ftype=1
2.2 fto=27
2.3 title desc 传相关文案
2.4 params新增intParam,表示int类型的参数
(1)intParam含义根据具体协议而定
(2)新手期结束推送协议中,intParam表示新手期结束赠送给骑手的成长值,如:300
2.5 params新增strParam,表示String类型的参数
(1)strParam含义根据具体协议而定
(2)新手期结束推送协议中,strParam表示骑手姓名,如:黄晓明
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
sortType:订单排序类型,0 默认时间点排序,1 商家排序,2 订单号排序 类型:int
}
响应消息
{
status:1,
data:{
riderStatus:骑手状态,类型:int
0:休息中,5:工作中,99:禁用
verifiedStatus:认证状态,类型:int
0:未认证 5:审核中 9:未通过 10:已认证
tips:提示文案,类型:String
btnText:按钮文案,类型:String
unTerminativeOrderNum:订单数量,类型:int
arriveThreshold:到店阈值,类型:long
verifiedOvertime:是否审核超时,类型:boolean
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
orderList:[ 订单列表
{
id:订单Id,类型:String
income:收入,类型:String
advance:垫付金额,类型:String
customerAddr:收货地址,类型:String
status:订单状态,类型:int
typeStatus:录入状态,类型:int
0:未录入 5:未拍小票 10:已录入 15:已取货 99:未选择订单
type:列表数据类型,类型:int(0:真实订单)
btnValue:按钮状态,类型:int
5:我已到店|取货
10:录入新订单
15:还有订单未拍小票
20:离店配送
25:配送中
22:拍摄货物图片
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
btnText:状态文案,类型:String
sinceObtained:配送时长,类型:long
customerTel:收货人联系方式,类型:String
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
urge:是否催单,类型:int
serialId:订单序号,类型:String
punctualTm:准点奖励要求时间,类型:String
labelList:[
{
code:标签Code,类型:int
title:标签标题,类型:String
desc:标签文案,类型:String
type:标签样式类型,类型:int
}
...
]
requireTm:要求送达时间,类型:String
requireTm2:要求送达时间,类型:long
serviceTm:服务器当前时间,类型:long
punctualAmount:准点奖励金额,类型:String
collection:代收,类型:String
collection2:代收金额,类型:double
punctualTm2:准点奖励要求时间,类型:long
searchText:用于订单搜索的字段,类型:String
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
elemeWaybillNo:饿了么运单号,类型:String
shopInfo:{
shopId:商家ID,类型:String
shopAddr:发货地址,类型:String
shopName:商家名称,类型:String
orderNum:订单数量,类型:int
channel:是否是渠道单
0:非渠道单 1:渠道单
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
shopTel:商家电话,类型:String
notTyped:未录入订单ID,类型:List
notObtained:未离店订单ID,类型:List
remainTime:到店剩余时间,类型:long
finishedNum:当前完成商家订单数,类型:int
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
platformName:渠道名称,类型:String
}
isAppointmentOrder:是否是预约单,类型:int
payStatus:支付状态,类型:int
0:默认值,无意义
1:未支付
2:线上支付
3:线下支付
totalIncome:预计收入汇总值(预计收入+小费+困难单奖励),类型:String
orderOvertime:到店或者送达超时标识,类型:boolean
punishDesc:处罚文案 类型String 例:超时20分钟扣¥5.0
}
...
]
distanceToCustomer:配送距离,类型:String
leaveTm:离店时间,类型:long
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:未支付金额,类型:double
dispatchMode:调度模式,类型:int
1:系统派单
2:抢单
3:人工派单
4:分组派单
5:扫码抢单
contractType:驻店模式,类型:int
0:非驻店
1:全驻店
2:半驻店
arriveTm:到店时间,类型:long
onlinePayType:在线支付类型,类型:int
0:不区分线上线下支付
1:线下支付
2:线上支付
paidAmount:客人已支付金额,类型:float
customerName:客人姓名,类型:String
notifyList:{
fetchTimeOut:取货/到店超时时间点,类型:long
deliveryTimeOut:送达超时时间点,类型:long
}
distanceToShop:骑手到商家的距离,类型:String
fetchRequireTm:应取货时间,类型:String
remainDeliveryTime:应送达时间倒计时,类型:int
remainFetchTime:要求取货时间倒计时,类型:int
platformId:渠道ID,类型:int
新增盒马订单渠道,72
newLabelList:[
{
labelText:标签文案,类型:String
labelColor:标签字体颜色,如:“#fe751a”,类型:String
bgColor:标签背景颜色,如:“#fe751a”,类型:String
}
...
]
fee:小费
}
}
接口描述
获取订单详细信息
接口消息定义
请求地址:/ rider/view-order-detail.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
history:是否是历史订单,类型:boolean
terminalTm:订单时间,类型:String
lat:纬度,类型:int
lng:经度,类型:int
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
id:订单ID
shopAddr:商家地址,类型:String
shopTel:商家电话,类型:String
shopName:商家名称,类型:String
customerAddr:客人地址,类型:String
customerTel:客人电话,类型:String
distributingfee:配送费,类型:String
subsidyfee:补贴,类型:String
payPrice:向发货方支付金额,类型:String
chargePrice:向发货方收取配送费,类型:String
status:订单状态,类型:int
btnText:按钮文案
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
remark:备注,类型:String
chargeUserPrice:向用户收取,类型:String
dispatchTm:派单时间,类型:String
ticketUrl:小票URL,类型:String
incomeInfo:{收入
incomeMsg:收入提示文案,类型:String
totalIncome:收入总计,类型:String
incomeList:[
{
name:收入名称,类型:String
income:收入金额,类型:String
incomeDetailList:[
name:收入名称,类型:String
income:收入金额,类型:String
incomeText:收入名称,类型:String
]
}
......
]
}
arriveConsume:到店用时,类型:long
deliveryConsume:配送剩余时间,类型:long
hasArrived:是否已到店,类型:boolean
punctualRewardText:订单准点奖励文案,类型:String
timeout:是否超时,类型:int
outOfDispatchingRange:是否超距,类型:int
distanceForFee:配送范围,类型:String
leaveTm:离店时间,类型:String
finishTm:完成时间,类型:String
tradingAreaName:订单所属商圈,类型:String
orderCancelReason:订单取消原因,类型:String
cancelPunishment:取消惩罚,类型:String
appealStatusText:申诉状态文案,类型:String
appealId:申诉ID,类型:String
complaintStatusText:投诉状态文案
complaintId:投诉ID,类型:String
punishDate:订单取消惩罚时间,类型:String
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
stockOut:是否缺货,1-缺货 0-未缺货 类型:int
difference:货品是否有差异 1-有差异 0-无差异 类型:int
balanceInfo:结算信息集合
hasFoodInfo:是否存在餐品信息,类型:int
collection:代收,类型:double
isResident:是否驻店,类型:int
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:客人未支付金额,类型:double
dispatchMode:调度模式,类型:int
contractType:驻店模式,类型:int
onlinePayType:支付模式,类型:int
paidAmount:客人已支付金额,类型:double
orderIncomeRuleUrl:订单收入规则URL
shopId:商家ID,类型:String
requireTm:应送达时间,类型:String
fetchRequireTm:应取货时间,类型:String
btnValue:按钮状态,类型:int
5:我已到店|取货
10:录入新订单
15:还有订单未拍小票
20:离店配送
25:配送中
22:拍摄货物图片
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
predictIncome:预计收入,类型:String
distanceToShop:骑手到商家的距离,类型:String
distanceToCustomer:骑手到客人的距离,类型:String
weight:重量,类型:String
punctualRewardMoney:准点奖励金额,类型:String
punctualRewardRequireTm:准点奖励要求送达时间,类型:String
fee:小费,类型:String
arriveTm:到店时间,类型:String
getGoodsTm:取货时间,类型:String
cancelGoodsTm:取消时间,类型:String
waybillNo:面单号,类型:String
arriveTmTips:到店是否超时提示,类型:String
deliveryTmTips:送达是否超时提示,类型:String
goodsMoney:货品金额,类型:String
distanceToDestination:骑手到目的地的距离,类型:String
customerName:收货人姓名,类型:String
getGoodsTmTips:取货时间(同城直送订单),类型:String
isAppointmentOrder:是否是预约单,类型:int
goodsType:货品类型,类型:String
timeAssessList:[
{
assessName:考核名称,例:准点到店时间,类型:string
assessContent:考核内容,例:12:30前,类型:string
reward:奖励,例:奖 ¥2.5:,类型:string
overRewardTime:是否超过奖励时间,类型:boolean
timeover:是否超时,类型:boolean
punishDesc: 处罚描述 例:超时20分钟扣¥5.0,类型String
oldAccessContent:旧考核内容,如:12:40前,类型:String
oldAccessDesc:旧考核描述,如:因接到新的订单,送达时间发生调整 类型:String
},
……
]
}
}
接口描述
停止接单,下班
接口消息定义
请求地址: /rider/come-off-work.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data:提示信息
msg:错误提示信息,如没有,则为空,类型:String
errorCode:错误码
9021: 身上有未离店订单时不允许下线
}
接口描述
获取接单设置
接口消息定义
请求地址: /rider/get-order-settings.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:{
dispatchAfterLeave:是否开启离店后派单,类型:boolean
orderPattern:接单模式,如:送全部订单 类型:String
orderCelling:接单上限,如:5,类型:int
}
}
接口描述
设置是否开启离店后派单
接口消息定义
请求地址: /rider/set-dispatch-after-leave.json
请求方法: post
请求消息体:
{
riderId: 骑士Id,
cityId:城市Id,
dispatchAfterLeave:是否开启离店后派单,类型:boolean
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:{
},
msg:设置异常时的错误信息,类型:String
}
接口描述
获取接单模式
接口消息定义
请求地址: /rider/get-order-pattern-list.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
"data": {
"patternList": [{
"patternId": 0, 接单模式id,类型:int
"patternText": "送全部订单", 接单模式文案,类型:string
"isSelected": false,是否选择该模式,类型:bool
"patternContent": 选择模式前的弹窗文案,类型:string
},
...
]
},
"msg": "",
"errorCode": "",
"extraMsg": ""
}
** 接口描述
每隔15秒上传一次骑手位置经纬度。
接口消息定义
请求地址: /rider/ upload-position.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
imei:设备号,类型:String
version:版本号,类型:String
token:token,类型:String
locationType:定位类型,类型:int
}
响应消息
{
status:1,
data:{
isSelf: 是否是自己登录 1 正常登录 0 非自己登录,类型:int
verifyResult: 身份验证通知,类型:String
notSelfText: 别人登陆后的通知,类型:String
verifiedOvertime:审核超时,类型:boolean
orderNotifyList:[
{
orderId:订单ID,类型:String
type:通知类型,1:新订单 2:取消单 3:修改单, 12:离店后取消 13:追加单 类型:int
shopId:商家ID,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
customerAddr:客户地址,类型:String
platformId:渠道id,类型:int
elemeWaybillNo:饿了么运单号,类型:String
income:订单金额,类型:String
}
],
lostConnectionNotify:强行休息的通知,类型:String
updateType:0不需要升级 1正常升级 2强制升级,类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
tips:提示信息,类型:String
orderCellingChangedNotify: 修改接单上限通知,类型:String
riderTypeChangeNotify:骑手身份变更通知,类型:String
cancelOrderPunishNotify:订单取消扣款通知,类型:String
patchUpdateNotify:补丁下发通知,类型:int
forbiddenNotify:禁用 启用通知,格式:1|提示信息,1 禁用 2启用,类型:String
upgradeProtocolNotify:升级协议通知,格式:0|不显示协议浮层,1|显示协议浮层,类型:int
robOrderNotify:有可抢单通知,1 无订单 2 有订单 类型:int
bannerNotify:banner变化通知,1 无变化 2 有变化 类型:int
authResult:认证结果 1:审核成功(仅在审核成功时下发) 2:审核失败(仅在审核失败时下发) 类型:int
agingStatus:时效变更,类型:int,1:已变更,0:未变更,
zcOrderStatus:中车宝联订单状态修改,类型:int,1:审核通过或未通过,0:未变更
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,类型:int
}
接口描述
设置异常单:联系不到客人或者客人拒收
接口消息定义
请求地址:/rider/ set-order-abnormal.json
请求方法: get
请求消息体:
{
cityId:城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单ID,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
abnormalReason:异常类型 50 客人拒收/收件人拒收 51 联系不到客人/联系不到收件人,52 物品丢失或损毁 类型:int
considerDis:是否判断距离超限,判断 1, 不判断 0,类型:int
}
响应消息
{
status: 1,
data:{
successText:提示文案,类型:String
totalOrderNum:新手奖励订单总数量,类型:int
finishedOrderNum:已完成的订单总数量,类型:string 当改字段为空时,表示服务器超时,本地不更新
reward:每单的奖励金额,类型:float,一位小数
showBanner:是否展示Banner,1:是 0:否 类型:int
}
msg:“”
errorCode:距离超限提示码,类型:int
}
接口描述
此超距原因枚举对到店超距(arrive-shop.json)、离店超距(obtain-good.json)、送达超距(finish-order.json)通用,超距异常码为9003
接口消息定义
100:配送员忘点%s
101:配送员定位异常
102:商家地址错误
103:无法送到指定地点
104:客人地址错误
105:商家定位异常
106:客人定位异常
接口描述
校验注册用户身份证格式是否正确及年龄
接口消息定义
请求地址: /rider/check-user-idcard.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
identityNumber:身份证号码,类型String
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:{
}
msg:认证失败时返回失败原因
1.你的年龄不符合要求(18~60岁)
2.请输入正确格式的身份证号
}
接口描述
获取个人信息。
接口消息定义
请求地址: /rider/get-rider-info.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
authenticationStatus:认证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
authenticationInfo:认证信息 类型:String
riderName:姓名,身份认证填写的姓名,类型:String
finishedOrderNumber:完成订单数,类型:String
accumulatedIncome:累计收入,类型:String
balance:余额,类型:String
csTel:客服电话,类型:String
passexamStatus:是否通过考试,类型:int
monthlyIncome:当月收入,类型:String
riderType:骑手身份类型,0 骑手 5 骑士,类型:int
riderLevelText:骑手身份等级,类型:String
amTel:商圈负责人联系方式,类型:String
trainStatus:培训报名状态 类型int
0:不需要弹窗
1:去报名弹窗
2:查看报名信息弹窗
btVisibiliy:赏金任务是否显示,1 显示,类型:int
healthCardText:健康证状态文案,类型:String
equipmentDesc:我的装备描述信息,类型:String
例:完整度1/5
onlineDuration:今日在线时长,如:8小时32分 类型:String
isNewComer:是否是新手,1:是新手 0:不是新手 类型:int
todayJoinedBTNum:赏金任务角标数字,今日开始的任务数,类型:int
targetServiceVisibiliy:定向服务是否显示,1 显示,类型:int
taskCenterUrl:任务中心URL,类型:String
taskCenterSignature:任务中心签名,类型:String
levelInfo:{
currentValue:骑手当前成长值,类型int
totalValue:升级成长值,类型int
levelInfoText:等级提示文案,类型:String
levelQuestionText:等级更新文案,类型String
taskDatas:[
{
upgradeTitle:任务描述,类型String
mission:[
{
title:“拥有点我达装备”,类型:String
buttonStr:按钮文案,类型:String
finished:true任务已完成|false任务未完成,类型:bool
},
]
},
]
privilegeList:[
{
type:标签背景图片类型,1:橙色五角星, 2:绿色三角形,3:蓝色五角星 4:青色六边形,5紫色正方形
value:标签文案,类型:string
name:标签描述,类型String
newComerPrivilege:是否是新手特权 1:是 0:不是 类型:int
},
]
}
},
msg:“”
}
接口描述
登录时点击获取验证码按钮,下发验证码短信
接口消息定义
请求地址: /apis/common/sms/get-captcha.json
请求方法: post
请求消息体:
{
mobile:手机号,类型:String
type:验证码类型,类型:String
isVoice:语音验证码,类型:String
systemCode: “spider“(商家端) or “flash”(骑手端)
imei:imei号,类型:String
phoneVersion:手机系统版本号,类型:String
captcha:图形验证码,类型:String
PS:默认传空,需要图形验证码时填对应的图形验证码内容
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: “1234”验证码内容
msg:错误提示信息,如没有,则为空,类型:String
errorCode:错误码
9120,需输入图形验证码
9121:验证码错误
errorMsg:当errorCode=9120或9121时,返回图形验证码图片链接,如https://xxxx
}
接口描述
登录时点击获取验证码按钮,下发验证码短信
接口消息定义
请求地址: /apis/common/sms/refresh-image-captcha.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
mobile:手机号,类型:String
systemCode: “spider“(商家端) or “flash”(骑手端)
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
captchaUrl:图形验证码链接,类型:String
}
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
获取订单详细信息
接口消息定义
请求地址:/ rider/view-order-detail.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
history:是否是历史订单,类型:boolean
terminalTm:订单时间,类型:String
lat:纬度,类型:int
lng:经度,类型:int
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
id:订单ID
shopAddr:商家地址,类型:String
shopTel:商家电话,类型:String
shopName:商家名称,类型:String
customerAddr:客人地址,类型:String
customerTel:客人电话,类型:String
distributingfee:配送费,类型:String
subsidyfee:补贴,类型:String
payPrice:向发货方支付金额,类型:String
chargePrice:向发货方收取配送费,类型:String
status:订单状态,类型:int
btnText:按钮文案
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
remark:备注,类型:String
chargeUserPrice:向用户收取,类型:String
dispatchTm:派单时间,类型:String
ticketUrl:小票URL,类型:String
incomeInfo:{收入
incomeMsg:收入提示文案,类型:String
totalIncome:收入总计,类型:String
incomeList:[
{
name:收入名称,类型:String
income:收入金额,类型:String
incomeDetailList:[
name:收入名称,类型:String
income:收入金额,类型:String
incomeText:收入名称,类型:String
]
}
......
]
}
arriveConsume:到店用时,类型:long
deliveryConsume:配送剩余时间,类型:long
hasArrived:是否已到店,类型:boolean
punctualRewardText:订单准点奖励文案,类型:String
timeout:是否超时,类型:int
outOfDispatchingRange:是否超距,类型:int
distanceForFee:配送范围,类型:String
leaveTm:离店时间,类型:String
finishTm:完成时间,类型:String
tradingAreaName:订单所属商圈,类型:String
orderCancelReason:订单取消原因,类型:String
cancelPunishment:取消惩罚,类型:String
appealStatusText:申诉状态文案,类型:String
appealId:申诉ID,类型:String
complaintStatusText:投诉状态文案
complaintId:投诉ID,类型:String
punishDate:订单取消惩罚时间,类型:String
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
stockOut:是否缺货,1-缺货 0-未缺货 类型:int
difference:货品是否有差异 1-有差异 0-无差异 类型:int
balanceInfo:结算信息集合
hasFoodInfo:是否存在餐品信息,类型:int
collection:代收,类型:double
isResident:是否驻店,类型:int
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:客人未支付金额,类型:double
dispatchMode:调度模式,类型:int
contractType:驻店模式,类型:int
onlinePayType:支付模式,类型:int
paidAmount:客人已支付金额,类型:double
orderIncomeRuleUrl:订单收入规则URL
shopId:商家ID,类型:String
requireTm:应送达时间,类型:String
fetchRequireTm:应取货时间,类型:String
btnValue:按钮状态,类型:int
5:我已到店|取货
10:录入新订单
15:还有订单未拍小票
20:离店配送
25:配送中
22:拍摄货物图片
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
predictIncome:预计收入,类型:String
distanceToShop:骑手到商家的距离,类型:String
distanceToCustomer:骑手到客人的距离,类型:String
weight:重量,类型:String
punctualRewardMoney:准点奖励金额,类型:String
punctualRewardRequireTm:准点奖励要求送达时间,类型:String
fee:小费,类型:String
arriveTm:到店时间,类型:String
getGoodsTm:取货时间,类型:String
cancelGoodsTm:取消时间,类型:String
waybillNo:面单号,类型:String
arriveTmTips:到店是否超时提示,类型:String
deliveryTmTips:送达是否超时提示,类型:String
goodsMoney:货品金额,类型:String
distanceToDestination:骑手到目的地的距离,类型:String
customerName:收货人姓名,类型:String
getGoodsTmTips:取货时间(同城直送订单),类型:String
isAppointmentOrder:是否是预约单,类型:int
goodsType:货品类型,类型:String
labelList2: [
{
labelText:标签标题,类型:String
labelColor:标签字体颜色,类型:String
bgColor:标签背景颜色,类型:String
labelDesc:标签释义,类型:String
}
...
]
timeAssessList:[
{
assessName:考核名称,例:准点到店时间,类型:string
assessContent:考核内容,例:12:30前,类型:string
reward:奖励,例:奖 ¥2.5:,类型:string
overRewardTime:是否超过奖励时间,类型:boolean
timeover:是否超时,类型:boolean
punishDesc: 处罚描述 例:超时20分钟扣¥5.0,类型String
oldAccessContent:旧考核内容,如:12:40前,类型:String
oldAccessDesc:旧考核描述,如:因接到新的订单,送达时间发生调整 类型:String
},
……
]
}
}
接口描述
登录时点击获取验证码按钮,下发验证码短信
接口消息定义
请求地址: /rider/get-supported-bank-list.json
请求方法: post
请求消息体:
{
cityId:城市ID
riderId:骑手Id
cardNumber:银行卡卡号,类型:String
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
bankName:所输入银行卡卡号对应的银行名称,类型:String
bankId:所输入银行卡卡号对应的银行标识,类型:int
bankList:[
{
id:银行ID,类型:int
name:银行名称,类型:String
}
...
]
}
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/get-cancel-reasons.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
orderId:订单Id,类型:String
platformId:渠道ID,类型:int
}
响应消息
{
status: 1,
data:{
reasons:[
{
reasonId:送达原因Id,类型:int
reasonText:送达原因文案,类型:String
}
...
]
},
msg:""
}
接口描述
查询骑手账户中心
接口消息定义
请求地址:/rider/view-account-center.json
请求方法: post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:用户名,骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
todayIncome:今日收入,类型:double
todayExpand:今日支出,类型:double
balance:余额,类型:double
frozenProvision:提现中,类型:double
blockedFund:冻结中,类型:double
uncheckedBalance:待审核收入,类型:double
monthlyIncome:当月收入,类型:String
incomeDetail:{
distributionFee:配送费,类型:double
reward:奖励额,类型:double
other:其它收入:类型:double
}
monthlyExpense:本月花费,类型:double
expenseDetail:{
riskBlockedFund:违规扣除,类型:double
insurancefee:保险扣费,类型:double
successWithdrawal:已提现,类型:double
equipmentDeposit:装备押金,类型:double
other:其它支出,类型:double
}
canWithdrawalsMoney:可提现资金,类型:double
blockedFundDetail:{
blockedGoodfee:押金,类型:double
blockedRiskfee:违规冻结,类型:double
}
uncheckedBalanceDetail:待审核资金详情{
distributionFee:本月线上配送费,类型:double
reward:奖励额,类型:double
other:其它收入,类型:double
}
accountCheckingVisible:垫付资金统计入口是否可见,类型:int
0:不可见 1:可见
},
msg:“”
}
接口描述
设置接单上限
接口消息定义
请求地址:/rider/get-order-celling.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
minOrderCelling:设置接单上限最小值,类型:int
maxOrderCelling:设置接单上限最大值,类型:int
celling:接单上限,类型:int
usableMaxOrderCelling:实际可选的最大接单上限,类型:int
usableThresholdOrderNum:可选的最大接单上限变化的阈值,类型:int
advisalbeOrderCelling:提示警告接单上限,类型:int
finishedOrderNum:已完成订单数
isNewComer:是否是新手期 1:是 0:不是 类型:int
usableMinOrderCelling:实际可选的接单下限,类型:int
recommendMinOrderCelling:推荐接单下线,类型:int
},
msg:“”
}
接口描述
获取充值记录列表
接口消息定义
请求地址:/rider/get-recharge-record-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
currentPage:当前页 ,类型 int
}
响应消息
{
status: 1,
data:{
currentPage:当前页码,类型:int
pageCount:总页码数,类型:int
list:[
{
id:充值记录Id,类型:String
statusText:充值状态文案,类型:String
amount:充值金额,类型:String
applyTime:充值时间,类型:String
}
...
]
},
msg:“”
}
接口描述
退出登录
接口消息定义
请求地址:/rider/check-app-update.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
version:版本号
patchVersion:patch版本号
source:手机型号
client:系统版本号
systemCode:应用编码
}
响应消息
{
status: 1,
data:{
latestVersion:最新应用版本,类型:String
url:应用下载地址,类型:String
md5:patch的md5值,类型:String
updateType:升级模式,类型:int
0:不需要升级
1:正常升级
2:强制升级
3:下载补丁
tips:更新文案,类型:String
apkMd5:apk的md5值,用于校验本地下载的apk是否完整
weexConfigVersion:weex配置文件版本号,类型:String
weexConfigUrl:weex配置文件下载地址,类型:String
},
msg:“”
}
** 接口描述
每隔15秒上传一次骑手位置经纬度。
接口消息定义
请求地址: /rider/ upload-position.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
imei:设备号,类型:String
version:版本号,类型:String
token:token,类型:String
locationType:定位类型,类型:int
}
响应消息
{
status:1,
data:{
isSelf: 是否是自己登录 1 正常登录 0 非自己登录,类型:int
verifyResult: 身份验证通知,类型:String
notSelfText: 别人登陆后的通知,类型:String
verifiedOvertime:审核超时,类型:boolean
orderNotifyList:[
{
orderId:订单ID,类型:String
type:通知类型,1:新订单 2:取消单 3:修改单, 12:离店后取消 13:追加单 类型:int
shopId:商家ID,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
customerAddr:客户地址,类型:String
platformId:渠道id,类型:int
elemeWaybillNo:饿了么运单号,类型:String
income:订单金额,类型:String
}
],
lostConnectionNotify:强行休息的通知,类型:String
updateType:0不需要升级 1正常升级 2强制升级,类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
tips:提示信息,类型:String
orderCellingChangedNotify: 修改接单上限通知,类型:String
riderTypeChangeNotify:骑手身份变更通知,类型:String
cancelOrderPunishNotify:订单取消扣款通知,类型:String
patchUpdateNotify:补丁下发通知,类型:int
forbiddenNotify:禁用 启用通知,格式:1|提示信息,1 禁用 2启用,类型:String
upgradeProtocolNotify:升级协议通知,格式:0|不显示协议浮层,1|显示协议浮层,类型:int
robOrderNotify:有可抢单通知,1 无订单 2 有订单 类型:int
bannerNotify:banner变化通知,1 无变化 2 有变化 类型:int
authResult:认证结果 1:审核成功(仅在审核成功时下发) 2:审核失败(仅在审核失败时下发) 类型:int
agingStatus:时效变更,类型:int,1:已变更,0:未变更,
zcOrderStatus:中车宝联订单状态修改,类型:int,1:审核通过或未通过,0:未变更
weexConfigVersion:weex配置文件版本号,类型:String
weexConfigUrl:weex配置文件下载地址,类型:String
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,类型:int
}
接口描述
查询提现详情信息
接口消息定义
请求地址:/rider/view-withdrawal-detail.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
balanceId:提现Id,类型:String
}
响应消息
{
status: 1,
data:{
statusText:提现状态文案,类型:String
status:提现状态 0 未审核 5 已审核 9 失败 10 成功,类型:int
amount:提现金额,类型:double
amountStr:提现金额 类型:string
applyTiem:提现时间,类型:String
account:账户,类型:String
accountType:账户类型,类型:int
accountTypeName:账户名称,类型:String
chargeFee:提现手续费 单位:元 类型:float
chargeFeeStr:提现手续费 类型:string
phases:[{
name:当前操作文案,类型:String
tips:操作标注,类型:String
date:操作时间,类型:String
},
],
},
msg:“”
}
接口描述
获取提现记录
接口消息定义
请求地址:/rider/view-withdrawal-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
currentPage:当前页,类型:int
}
响应消息
{
status: 1,
data:{
currentPage:当前页码,类型:int
pageCount,总页数,类型:int
list: [
{
id:提现交易ID,类型:String
statusText:提现状态文案,类型:String
status:提现状态,类型:int
amount:提现金额,类型:double
amountStr:提现金额 类型:string
applyTime:提现时间,类型:String
},
]
}
msg:“”
}
1.形象抽查弹窗协议(通用协议,以后的弹窗推送可以复用该协议)
1.1 ftype=1
1.2 fto=29
1.3 param.imgUrl:弹窗背景图URL
1.4 param.url:点击弹窗背景图跳转的h5页面的url
2.XXX装备即将到期,请及时补充新装备 ||XXX装备已过期,请及时补充新装备
1.1 ftype=2
1.2 fto=30
1.4 param.url:我的装备h5页面的url
2.对应的形象抽查页面 ||形象抽查即将超时,请及时提交审核,以免影响正常接单||形象抽查审核通过,请注意查收奖励||形象抽查审核不通过,点击查看原因
1.1 ftype=2
1.2 fto=31
1.4 param.url:对应的形象抽查页面h5页面的url
接口描述
获取提现记录
接口消息定义
请求地址:/rider/get-income-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
totalIncome:本月总输入金额,类型:float
maxIncome:本月最大的收入金额,类型:float
incomeList: [
{
date:日期,类型:String
income:当前日期的收入金额,类型:float
today:是否是今天的记录,类型:int
0:不是 1:是
}
...
]
}
msg:“”
}
接口描述
获取提现记录
接口消息定义
请求地址:/rider/get-income—expense-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
currentPage:当前页码,类型:int
}
响应消息
{
"status": 1,
"data": {
"currentPage": 当前页码,类型:int
"pageSize": 每页展示的交易数量,默认为10,类型:int
"pageCount": 收支统计总页码数,类型:int
"list": [{
dateStr:日期文案描述,类型:String
如:2017年10月(不包含今日收入)
finishedNum:本月完成单量,类型:int
income: 本月收入金额,类型:float
expense: 本月支出金额,类型:float
incomeList:[ 收入明细列表
{
name:交易名称,如:配送费、奖励等,类型:String
value:交易金额,类型:float
}
...
],
expenseList:[ 支出明细列表
{
name:交易名称,如:违规扣款、购买奖励等,类型:String
value:交易金额,类型:float
}
...
]
}]
},
"msg": "",
"errorCode": "",
"extraMsg": ""
}
接口描述
获取提现记录
接口消息定义
请求地址:/rider/get-recommend-order-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
lat:骑手当前纬度,类型:int
lng:骑手当前经度,类型:int
}
响应消息
{
status:1,
data:{
currentPage:当前页码,类型:int
pageCount:总页数,类型:int
riderStatus:骑手状态,类型:int
verifiedStatus:验证状态,类型:int
tips:提示文案
btnText:按钮文案
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
groupList:[
{
orderId:订单ID,类型:String
groupId:订单分组,类型:String
platformId:渠道ID,类型:String
income:收入(分组单),类型:String
fee:小费(分组单),类型:String
platformText:取单名称(分组单)
requireTm:要求送达时间(分组单),类型:String
isAppointmentOrder:是否是预约单,类型:int
matchingDegree:顺路度,类型:String
orderList:[
{
id:订单ID,类型:String
income:收入,类型:String
customerAddr:客人地址
distanceToCustomer:配送距离
status:订单状态
requireTm:要求送达时间
distanceToMe:距离你的距离,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
orderType:订单类型,类型:int
0、普通订单(手发单);
1、同城直送;
2、外卖订单;
3、揽件订单;
4、派件订单
customerName:收货人姓名
shopTel:商家电话,类型:String
mixedGrab:是否是抢派混合单,类型:int
newLabelList:[
{
labelText:标签文案,类型:String
labelColor:标签字体颜色,如:“#fe751a”,类型:String
bgColor:标签背景颜色,如:“#fe751a”,类型:String
}
...
],
}
...
]
}
...
]
isScanCode:是否支持扫码抢单
}
}
** 接口描述
每隔15秒上传一次骑手位置经纬度。
接口消息定义
请求地址: /rider/ upload-position.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
imei:设备号,类型:String
version:版本号,类型:String
token:token,类型:String
locationType:定位类型,类型:int
}
响应消息
{
status:1,
data:{
isSelf: 是否是自己登录 1 正常登录 0 非自己登录,类型:int
verifyResult: 身份验证通知,类型:String
notSelfText: 别人登陆后的通知,类型:String
verifiedOvertime:审核超时,类型:boolean
orderNotifyList:[
{
orderId:订单ID,类型:String
type:通知类型,1:新订单 2:取消单 3:修改单, 12:离店后取消 13:追加单 类型:int
shopId:商家ID,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
customerAddr:客户地址,类型:String
platformId:渠道id,类型:int
elemeWaybillNo:饿了么运单号,类型:String
income:订单金额,类型:String
}
],
lostConnectionNotify:强行休息的通知,类型:String
updateType:0不需要升级 1正常升级 2强制升级,类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
tips:提示信息,类型:String
orderCellingChangedNotify: 修改接单上限通知,类型:String
riderTypeChangeNotify:骑手身份变更通知,类型:String
cancelOrderPunishNotify:订单取消扣款通知,类型:String
patchUpdateNotify:补丁下发通知,类型:int
forbiddenNotify:禁用 启用通知,格式:1|提示信息,1 禁用 2启用,类型:String
upgradeProtocolNotify:升级协议通知,格式:0|不显示协议浮层,1|显示协议浮层,类型:int
robOrderNotify:有可抢单通知,1 无订单 2 有订单 类型:int
bannerNotify:banner变化通知,1 无变化 2 有变化 类型:int
authResult:认证结果 1:审核成功(仅在审核成功时下发) 2:审核失败(仅在审核失败时下发) 类型:int
agingStatus:时效变更,类型:int,1:已变更,0:未变更,
zcOrderStatus:中车宝联订单状态修改,类型:int,1:审核通过或未通过,0:未变更
weexConfigVersion:weex配置文件版本号,类型:String
weexConfigUrl:weex配置文件下载地址,类型:String
recommendOrderNotify:是否有强推荐订单,类型:int 1:有 0:没有
httpdnsSwitch:是否打开httpdns解析,类型:int 1:打开 0:关闭
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,类型:int
}
接口描述
接收通知反馈
接口消息定义
请求地址:/rider/receive-notify.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:用户名,骑士Id,类型:String
receiveOrderNotify:接收订单变更通知,类型:int
receiveKickImeiNotify:退出登录通知,类型:int
receiveLostConnectionNotify:掉线通知,类型:int
receiveVerifyNotify:身份审核通知,类型:int
receiveRiderTypeChangeNotify:骑手身份变更通知,类型:int
receiveLimitedNumberChanged:骑士接单上限通知,类型:int
receiveCancelOrderNotify:取消订单扣款通知,类型:int
receiveForbiddenNotify:禁用及启用通知,类型:int
receiveOrderIds:接收订单通知ID,类型:String
receiveBannerNotify:banner变化通知,1-收到,0-未收到,类型:int
receiveRecommendOrderNotify:收到强推荐订单通知,类型:int
}
响应消息
{
status: 1,
data:””
msg:“”
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/get-balance-log.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
currentPage:当前页,类型:number
filterState:筛选状态,类型:int
0:全部状态 1:已审核 2:审核中
filterType:筛选类型,类型:int
0:全部类型
10:配送费 20:奖励 30:其他收入
40:违规扣款 50:购买保险 60:提现 70:购买装备 80:其他支出
}
响应消息
{
status: 1,
data:{
currentPage:当前页码,类型:int
pageCount,总页数,类型:int
list:[
{
tradeId:交易Id,类型:String
tradeMoney:交易金额,类型:String
tradeType:交易类型,类型:String 1收入 -1支出
tradeName:交易名称,类型:String
tradeTime:交易时间,类型:String
subtitle:备注,类型:String
tradeClassify:冻结类型 违规冻结:30,类型:int
tradeNumber:订单编号,类型:String
templateType:模板类型,类型:int 1订单相关 2特殊条目 3提现 4违规扣除
tradeDate:交易日期,“今日\r\n13:00”,类型:String
}
...
]
},
msg:””
}
接口描述
设置异常单:联系不到客人或者客人拒收
接口消息定义
请求地址:/rider/ set-order-abnormal.json
请求方法: get
请求消息体:
{
cityId:城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单ID,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
abnormalReason:异常类型,类型:int
50 客人拒收/收件人拒收 51 联系不到客人/联系不到收件人,52 物品丢失或损毁
53:配送原因导致客人拒收(餐品损坏、超时送达等) 54:客人自身原因拒收 55:订单已配送或商家拒绝给餐
considerDis:是否判断距离超限,判断 1, 不判断 0,类型:int
picUrl:图片URL,类型:String
}
响应消息
{
status: 1,
data:{
successText:提示文案,类型:String
totalOrderNum:新手奖励订单总数量,类型:int
finishedOrderNum:已完成的订单总数量,类型:string 当改字段为空时,表示服务器超时,本地不更新
reward:每单的奖励金额,类型:float,一位小数
showBanner:是否展示Banner,1:是 0:否 类型:int
}
msg:“”
errorCode:距离超限提示码,类型:int
}
接口描述
抢单,不同于口碑订单的选择订单
接口消息定义
请求地址:/rider/rob-order.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
orderId:订单ID,类型:number
groupId:订单分组,类型:String
platformId:渠道ID,类型:number
lat:经纬度,类型:int
lng:经纬度,类型:int
from:订单来源,类型:String
(1)默认为空表示从待接单列表抢到的订单
(2)recommend表示从强推荐订单列表抢到的订单
}
响应消息
{
status: 1,
data:{
successText:成功提示文案,类型:string
isBooking:是否预约单,类型:boolean
},
msg:""
errorCode: 新增以下枚举值
errorCode = 9300 菜鸟揽件接单 文案:订单异常,请刷新列表后重试
errorCode = 9301 点击接单时其他原因不符 文案:接单失败,请稍后重试
errorCode = 9302 菜鸟揽件接单 文案:系统异常,请刷新列表后重试
errorCode = 9303 抢单服务器接口超时
}
接口描述
交易详情
接口消息定义
请求地址:/rider/get-balance-detail.json
请求方法: get
请求消息体:
{
cityId:城市ID
riderId:骑手ID
balanceId:交易ID,类型:String
appTemplate:交易类型,类型:int
history:是否是历史交易记录,类型:int
}
响应消息
{
status: 1,
data:{
cost:交易金额,如:5.0 类型:float
desc:交易描述,如:购买意外险 类型:String
insTm:交易时间,类型:String
helpStr:帮助文案及链接,类型:String
例:如何申报保险?|http://60.191.68.46:19088/h5/insurance.jsp
appealEnable:是否可以申诉,类型:int
0:不可以 1:可以
list:[
{
name:交易明细类型名称,如:订单号,类型:String
desc:类型名称下面的描述文案,类型:String
value:交易明细类型值,与name是key-value关系,如:13547类型:String
clickable:该类型是否可点击(如果可点击,右边的箭头可见) 类型:int
0:不可点击 1:可点击
forward:点击之后打开的页面,类型:int
0:点击不打开页面 1:点击后进入订单详情页
2:点击进入h5页面
id:点击打开页面时需要传递的参数,如进入订单详情时为orderId,类型:String
forwardUrl:h5页面URL,类型:String
}
]
},
msg:“”
errorCode:错误码,类型:int
}
** 接口描述
每隔15秒上传一次骑手位置经纬度。
接口消息定义
请求地址: /rider/ upload-position.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
imei:设备号,类型:String
version:版本号,类型:String
token:token,类型:String
locationType:定位类型,类型:int
}
响应消息
{
status:1,
data:{
isSelf: 是否是自己登录 1 正常登录 0 非自己登录,类型:int
verifyResult: 身份验证通知,类型:String
notSelfText: 别人登陆后的通知,类型:String
verifiedOvertime:审核超时,类型:boolean
orderNotifyList:[
{
orderId:订单ID,类型:String
type:通知类型,1:新订单 2:取消单 3:修改单, 12:离店后取消 13:追加单 类型:int
shopId:商家ID,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
customerAddr:客户地址,类型:String
platformId:渠道id,类型:int
elemeWaybillNo:饿了么运单号,类型:String
income:订单金额,类型:String
}
],
lostConnectionNotify:强行休息的通知,类型:String
updateType:0不需要升级 1正常升级 2强制升级,类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
tips:提示信息,类型:String
orderCellingChangedNotify: 修改接单上限通知,类型:String
riderTypeChangeNotify:骑手身份变更通知,类型:String
cancelOrderPunishNotify:订单取消扣款通知,类型:String
patchUpdateNotify:补丁下发通知,类型:int
forbiddenNotify:禁用 启用通知,格式:1|提示信息,1 禁用 2启用,类型:String
upgradeProtocolNotify:升级协议通知,格式:0|不显示协议浮层,1|显示协议浮层,类型:int
robOrderNotify:有可抢单通知,1 无订单 2 有订单 类型:int
bannerNotify:banner变化通知,1 无变化 2 有变化 类型:int
authResult:认证结果 1:审核成功(仅在审核成功时下发) 2:审核失败(仅在审核失败时下发) 类型:int
agingStatus:时效变更,类型:int,1:已变更,0:未变更,
zcOrderStatus:中车宝联订单状态修改,类型:int,1:审核通过或未通过,0:未变更
weexConfigVersion:weex配置文件版本号,类型:String
weexConfigUrl:weex配置文件下载地址,类型:String
recommendOrderNotify:是否有强推荐订单,类型:int 1:有 0:没有
httpdnsSwitch:是否打开httpdns解析,类型:int 1:打开 0:关闭
dialogNotify:{
imgUrl:弹窗图片URL,类型:String
forwardUrl:点击弹窗进入的h5页面的URL,类型:String
}
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,类型:int
}
接口描述
接收通知反馈
接口消息定义
请求地址:/rider/receive-notify.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:用户名,骑士Id,类型:String
receiveOrderNotify:接收订单变更通知,类型:int
receiveKickImeiNotify:退出登录通知,类型:int
receiveLostConnectionNotify:掉线通知,类型:int
receiveVerifyNotify:身份审核通知,类型:int
receiveRiderTypeChangeNotify:骑手身份变更通知,类型:int
receiveLimitedNumberChanged:骑士接单上限通知,类型:int
receiveCancelOrderNotify:取消订单扣款通知,类型:int
receiveForbiddenNotify:禁用及启用通知,类型:int
receiveOrderIds:接收订单通知ID,类型:String
receiveBannerNotify:banner变化通知,1-收到,0-未收到,类型:int
receiveRecommendOrderNotify:收到强推荐订单通知,类型:int
receiveDialogNotify:收到弹窗提醒通知,类型:int
}
响应消息
{
status: 1,
data:””
msg:“”
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
sortType:订单排序类型,0 默认时间点排序,1 商家排序,2 订单号排序 类型:int
}
响应消息
{
status:1,
data:{
riderStatus:骑手状态,类型:int
0:休息中,5:工作中,99:禁用
verifiedStatus:认证状态,类型:int
0:未认证 5:审核中 9:未通过 10:已认证
tips:提示文案,类型:String
btnText:按钮文案,类型:String
unTerminativeOrderNum:订单数量,类型:int
arriveThreshold:到店阈值,类型:long
verifiedOvertime:是否审核超时,类型:boolean
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
orderList:[ 订单列表
{
id:订单Id,类型:String
income:收入,类型:String
advance:垫付金额,类型:String
customerAddr:收货地址,类型:String
status:订单状态,类型:int
typeStatus:录入状态,类型:int
0:未录入 5:未拍小票 10:已录入 15:已取货 99:未选择订单
type:列表数据类型,类型:int(0:真实订单)
btnValue:按钮状态,类型:int
4:到店并拍摄小票
5:我已到店|取货
10:录入新订单
15:还有订单未拍小票
20:离店配送
25:配送中
22:拍摄货物图片
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
btnText:状态文案,类型:String
sinceObtained:配送时长,类型:long
customerTel:收货人联系方式,类型:String
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
urge:是否催单,类型:int
serialId:订单序号,类型:String
punctualTm:准点奖励要求时间,类型:String
labelList:[
{
code:标签Code,类型:int
title:标签标题,类型:String
desc:标签文案,类型:String
type:标签样式类型,类型:int
}
...
]
requireTm:要求送达时间,类型:String
requireTm2:要求送达时间,类型:long
serviceTm:服务器当前时间,类型:long
punctualAmount:准点奖励金额,类型:String
collection:代收,类型:String
collection2:代收金额,类型:double
punctualTm2:准点奖励要求时间,类型:long
searchText:用于订单搜索的字段,类型:String
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
elemeWaybillNo:饿了么运单号,类型:String
shopInfo:{
shopId:商家ID,类型:String
shopAddr:发货地址,类型:String
shopName:商家名称,类型:String
orderNum:订单数量,类型:int
channel:是否是渠道单
0:非渠道单 1:渠道单
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
shopTel:商家电话,类型:String
notTyped:未录入订单ID,类型:List
notObtained:未离店订单ID,类型:List
remainTime:到店剩余时间,类型:long
finishedNum:当前完成商家订单数,类型:int
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
platformName:渠道名称,类型:String
}
isAppointmentOrder:是否是预约单,类型:int
payStatus:支付状态,类型:int
0:默认值,无意义
1:未支付
2:线上支付
3:线下支付
totalIncome:预计收入汇总值(预计收入+小费+困难单奖励),类型:String
orderOvertime:到店或者送达超时标识,类型:boolean
punishDesc:处罚文案 类型String 例:超时20分钟扣¥5.0
}
...
]
distanceToCustomer:配送距离,类型:String
leaveTm:离店时间,类型:long
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:未支付金额,类型:double
dispatchMode:调度模式,类型:int
1:系统派单
2:抢单
3:人工派单
4:分组派单
5:扫码抢单
contractType:驻店模式,类型:int
0:非驻店
1:全驻店
2:半驻店
arriveTm:到店时间,类型:long
onlinePayType:在线支付类型,类型:int
0:不区分线上线下支付
1:线下支付
2:线上支付
paidAmount:客人已支付金额,类型:float
customerName:客人姓名,类型:String
notifyList:{
fetchTimeOut:取货/到店超时时间点,类型:long
deliveryTimeOut:送达超时时间点,类型:long
}
distanceToShop:骑手到商家的距离,类型:String
fetchRequireTm:应取货时间,类型:String
remainDeliveryTime:应送达时间倒计时,类型:int
remainFetchTime:要求取货时间倒计时,类型:int
platformId:渠道ID,类型:int
新增盒马订单渠道,72
newLabelList:[
{
labelText:标签文案,类型:String
labelColor:标签字体颜色,如:“#fe751a”,类型:String
bgColor:标签背景颜色,如:“#fe751a”,类型:String
}
...
]
fee:小费
}
}
接口描述
获取订单详细信息
接口消息定义
请求地址:/rider/view-order-detail.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
history:是否是历史订单,类型:boolean
terminalTm:订单时间,类型:String
lat:纬度,类型:int
lng:经度,类型:int
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
id:订单ID
shopAddr:商家地址,类型:String
shopTel:商家电话,类型:String
shopName:商家名称,类型:String
customerAddr:客人地址,类型:String
customerTel:客人电话,类型:String
distributingfee:配送费,类型:String
subsidyfee:补贴,类型:String
payPrice:向发货方支付金额,类型:String
chargePrice:向发货方收取配送费,类型:String
status:订单状态,类型:int
btnText:按钮文案
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
remark:备注,类型:String
chargeUserPrice:向用户收取,类型:String
dispatchTm:派单时间,类型:String
ticketUrl:小票URL,类型:String
incomeInfo:{收入
incomeMsg:收入提示文案,类型:String
totalIncome:收入总计,类型:String
incomeList:[
{
name:收入名称,类型:String
income:收入金额,类型:String
incomeDetailList:[
name:收入名称,类型:String
income:收入金额,类型:String
incomeText:收入名称,类型:String
]
}
......
]
}
arriveConsume:到店用时,类型:long
deliveryConsume:配送剩余时间,类型:long
hasArrived:是否已到店,类型:boolean
punctualRewardText:订单准点奖励文案,类型:String
timeout:是否超时,类型:int
outOfDispatchingRange:是否超距,类型:int
distanceForFee:配送范围,类型:String
leaveTm:离店时间,类型:String
finishTm:完成时间,类型:String
tradingAreaName:订单所属商圈,类型:String
orderCancelReason:订单取消原因,类型:String
cancelPunishment:取消惩罚,类型:String
appealStatusText:申诉状态文案,类型:String
appealId:申诉ID,类型:String
complaintStatusText:投诉状态文案
complaintId:投诉ID,类型:String
punishDate:订单取消惩罚时间,类型:String
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
stockOut:是否缺货,1-缺货 0-未缺货 类型:int
difference:货品是否有差异 1-有差异 0-无差异 类型:int
balanceInfo:结算信息集合
hasFoodInfo:是否存在餐品信息,类型:int
collection:代收,类型:double
isResident:是否驻店,类型:int
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:客人未支付金额,类型:double
dispatchMode:调度模式,类型:int
contractType:驻店模式,类型:int
onlinePayType:支付模式,类型:int
paidAmount:客人已支付金额,类型:double
orderIncomeRuleUrl:订单收入规则URL
shopId:商家ID,类型:String
requireTm:应送达时间,类型:String
fetchRequireTm:应取货时间,类型:String
foodsReady:商家是否已出餐,类型:boolean
true:已出餐 false:未出餐
foodsReadyReported:是否已举报商家未出餐,类型:boolean
true:已举报 false:未举报
channelId:渠道订单号,类型:String
agingText:订单时效文案,类型:String
btnValue:按钮状态,类型:int
4:到店并拍摄小票
5:我已到店|取货
10:录入新订单
15:还有订单未拍小票
20:离店配送
25:配送中
22:拍摄货物图片
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
predictIncome:预计收入,类型:String
distanceToShop:骑手到商家的距离,类型:String
distanceToCustomer:骑手到客人的距离,类型:String
weight:重量,类型:String
punctualRewardMoney:准点奖励金额,类型:String
punctualRewardRequireTm:准点奖励要求送达时间,类型:String
fee:小费,类型:String
arriveTm:到店时间,类型:String
getGoodsTm:取货时间,类型:String
cancelGoodsTm:取消时间,类型:String
waybillNo:面单号,类型:String
arriveTmTips:到店是否超时提示,类型:String
deliveryTmTips:送达是否超时提示,类型:String
goodsMoney:货品金额,类型:String
distanceToDestination:骑手到目的地的距离,类型:String
customerName:收货人姓名,类型:String
getGoodsTmTips:取货时间(同城直送订单),类型:String
isAppointmentOrder:是否是预约单,类型:int
goodsType:货品类型,类型:String
labelList2: [
{
labelText:标签标题,类型:String
labelColor:标签字体颜色,类型:String
bgColor:标签背景颜色,类型:String
labelDesc:标签释义,类型:String
}
...
]
timeAssessList:[
{
assessName:考核名称,例:准点到店时间,类型:string
assessContent:考核内容,例:12:30前,类型:string
reward:奖励,例:奖 ¥2.5:,类型:string
overRewardTime:是否超过奖励时间,类型:boolean
timeover:是否超时,类型:boolean
punishDesc: 处罚描述 例:超时20分钟扣¥5.0,类型String
oldAccessContent:旧考核内容,如:12:40前,类型:String
oldAccessDesc:旧考核描述,如:因接到新的订单,送达时间发生调整 类型:String
},
……
]
}
}
接口描述
获取订单详细信息
接口消息定义
请求地址:/rider/foods-ready-feedback.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
lat:骑手当前位置的纬度,类型:int
lng:骑手当前位置的经度,类型:int
shopId:该订单对应的商家ID,类型:int
platformId:订单渠道Id,类型:int
channelId:渠道订单ID,类型:String
}
响应消息体:
{
status:请求成功标志,类型:int
data:{
successText:举报成功后的文案,类型:String
}
msg:Toast文案,类型:String
}
接口描述
申请提现
接口消息定义
请求地址: /rider/apply-withdrawal.json
请求方法: post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:用户名,骑士Id,类型:String
account:账户,类型:String
accountType:账户类型,1 支付宝 2 银行卡 类型:int
withdrawalPrice:提现金额,类型:String
forceApply:是否强制提现,类型:int
0:正常提现 1:强制提现(提现金额+手续费≤可用余额时,弹窗点击确认提现的情况)
}
响应消息
{
status: 1,
data:{
successText :提示信息,类型:String
},
msg:“”
errorCode:错误码,9002:账号禁用,类型:int
9400:显示提现弹窗提示
extraMsg:当errorCode=9400时返回弹窗文案,以html格式返回,类型:String
}
接口描述
申请提现
接口消息定义
请求地址: /rider/get-configure.json
请求方法: post
请求消息体:
{
//入参保持不变
}
响应消息
{
status: 1,
data:{
eleOpen:是否打开饿了么sdk,类型:boolean
debugLog:是否打印log,类型:boolean
packageList:[ 需要检测的三方apk的报名
{
appName:app名称,如:某达 类型:String
appType:app类型编号,如:a外挂是1,类型:int
packageName:应用的报名 类型:String
}
...
]
},
msg:“”
}
接口描述
申请提现
接口消息定义
请求地址: /rider/get-deposit-list.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
currentPage:当前页码,类型:int
}
响应消息
{
status: 1,
data:{
currentPage:当前页码,类型:int
pageCount,总页数,类型:int
list:[
{
title:保证金明细名称,类型:String
desc:描述文案,(title下面的文案)类型:String
time:时间字符串,类型:String
amountStr:保证金金额文案,如:“-¥50.0” 类型:String
colorType:金额文案颜色,类型:int
0:黑色,1:红色 2:绿色
}
]
},
msg:“”
}
接口描述
申请提现
接口消息定义
请求地址: /rider/get-deposit-info.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
}
响应消息
{
status: 1,
data:{
deposit:保证金金额,类型:double
balance:账户可用余额,(保证金充值页面用到)类型:double
},
msg:“”
}
接口描述
充值保证金
接口消息定义
请求地址: /rider/recharge-deposit.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
amount:充值的保证金金额,类型:float
}
响应消息
{
status: 1,
data:{
successText:成功文案,类型String
},
msg:“”
errorCode:9401 钱包余额不择弹窗
}
接口描述
充值保证金
接口消息定义
请求地址: /rider/return-deposit.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
}
响应消息
{
status: 1,
data:{
successText:成功文案,类型String
},
msg: Toast文案
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/rob-order-list.json
请求方法: GET
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
currentPage:当前页码,类型:int
keyWord:搜索关键词,类型:String
lat:骑手当前纬度,类型:int
lng:骑手当前经度,类型:int
}
响应消息
{
status:1,
data:{
currentPage:当前页码,类型:int
pageCount:总页数,类型:int
riderStatus:骑手状态,类型:int
verifiedStatus:验证状态,类型:int
tips:提示文案
btnText:按钮文案
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
groupList:[
{
orderId:订单ID,类型:String
groupId:订单分组,类型:String
platformId:渠道ID,类型:String
income:收入(分组单),类型:String
fee:小费(分组单),类型:String
platformText:取单名称(分组单)
requireTm:要求送达时间(分组单),类型:String
isAppointmentOrder:是否是预约单,类型:int
matchingDegree:顺路度,类型:String
orderCount:接单的订单总数量,类型:int
PS:不再判断orderList中有多少个订单,如果orderCount≤1,则展示“接单” 如果大于1,则展示"接xx单"
orderList:[
{
id:订单ID,类型:String
income:收入,类型:String
customerAddr:客人地址
distanceToCustomer:配送距离
status:订单状态
requireTm:要求送达时间
distanceToMe:距离你的距离,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
orderType:订单类型,类型:int
0、普通订单(手发单);
1、同城直送;
2、外卖订单;
3、揽件订单;
4、派件订单
customerName:收货人姓名
shopTel:商家电话,类型:String
mixedGrab:是否是抢派混合单,类型:int
newLabelList:[
{
labelText:标签文案,类型:String
labelColor:标签字体颜色,如:“#fe751a”,类型:String
bgColor:标签背景颜色,如:“#fe751a”,类型:String
}
...
]
}
...
]
}
...
]
isScanCode:是否支持扫码抢单
}
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: GET
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
sortType:订单排序类型,0 默认时间点排序,1 商家排序,2 订单号排序 类型:int
}
响应消息
{
status:1,
data:{
riderStatus:骑手状态,类型:int
0:休息中,5:工作中,99:禁用
verifiedStatus:认证状态,类型:int
0:未认证 5:审核中 9:未通过 10:已认证
tips:提示文案,类型:String
btnText:按钮文案,类型:String
unTerminativeOrderNum:订单数量,类型:int
arriveThreshold:到店阈值,类型:long
verifiedOvertime:是否审核超时,类型:boolean
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
orderList:[ 订单列表
{
id:订单Id,类型:String
groupId:订单组ID,类型:String
orderCount:接单的订单总数量,类型:int
orderScanned:是否有订单已经被扫码核验,类型:int
0:没有 1:有
income:收入,类型:String
advance:垫付金额,类型:String
customerAddr:收货地址,类型:String
status:订单状态,类型:int
typeStatus:录入状态,类型:int
0:未录入 5:未拍小票 10:已录入 15:已取货 99:未选择订单
type:列表数据类型,类型:int(0:真实订单)
btnValue:按钮状态,类型:int
4:到店并拍摄小票
5:我已到店|取货 | 全部到店
10:录入新订单
15:还有订单未拍小票 | 扫码核验
20:离店配送 | 全部离店
22:拍摄货物图片
23:全部妥投
25:货品送达 | 全部回执送达
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
btnText:状态文案,类型:String
sinceObtained:配送时长,类型:long
customerTel:收货人联系方式,类型:String
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
urge:是否催单,类型:int
serialId:订单序号,类型:String
punctualTm:准点奖励要求时间,类型:String
labelList:[
{
code:标签Code,类型:int
title:标签标题,类型:String
desc:标签文案,类型:String
type:标签样式类型,类型:int
}
...
]
requireTm:要求送达时间,类型:String
requireTm2:要求送达时间,类型:long
serviceTm:服务器当前时间,类型:long
punctualAmount:准点奖励金额,类型:String
collection:代收,类型:String
collection2:代收金额,类型:double
punctualTm2:准点奖励要求时间,类型:long
searchText:用于订单搜索的字段,类型:String
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
elemeWaybillNo:饿了么运单号,类型:String
shopInfo:{
shopId:商家ID,类型:String
shopAddr:发货地址,类型:String
shopName:商家名称,类型:String
orderNum:订单数量,类型:int
channel:是否是渠道单
0:非渠道单 1:渠道单
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
shopTel:商家电话,类型:String
notTyped:未录入订单ID,类型:List
notObtained:未离店订单ID,类型:List
remainTime:到店剩余时间,类型:long
finishedNum:当前完成商家订单数,类型:int
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
platformName:渠道名称,类型:String
}
isAppointmentOrder:是否是预约单,类型:int
payStatus:支付状态,类型:int
0:默认值,无意义
1:未支付
2:线上支付
3:线下支付
totalIncome:预计收入汇总值(预计收入+小费+困难单奖励),类型:String
orderOvertime:到店或者送达超时标识,类型:boolean
punishDesc:处罚文案 类型String 例:超时20分钟扣¥5.0
}
...
]
distanceToCustomer:配送距离,类型:String
leaveTm:离店时间,类型:long
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:未支付金额,类型:double
dispatchMode:调度模式,类型:int
1:系统派单
2:抢单
3:人工派单
4:分组派单
5:扫码抢单
contractType:驻店模式,类型:int
0:非驻店
1:全驻店
2:半驻店
arriveTm:到店时间,类型:long
onlinePayType:在线支付类型,类型:int
0:不区分线上线下支付
1:线下支付
2:线上支付
paidAmount:客人已支付金额,类型:float
customerName:客人姓名,类型:String
notifyList:{
fetchTimeOut:取货/到店超时时间点,类型:long
deliveryTimeOut:送达超时时间点,类型:long
}
distanceToShop:骑手到商家的距离,类型:String
fetchRequireTm:应取货时间,类型:String
remainDeliveryTime:应送达时间倒计时,类型:int
remainFetchTime:要求取货时间倒计时,类型:int
platformId:渠道ID,类型:int
新增盒马订单渠道,72
newLabelList:[
{
labelText:标签文案,类型:String
labelColor:标签字体颜色,如:“#fe751a”,类型:String
bgColor:标签背景颜色,如:“#fe751a”,类型:String
}
...
]
fee:小费
}
}
接口描述
获取订单详细信息
接口消息定义
请求地址:/rider/view-order-detail.json
请求方法: GET
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
history:是否是历史订单,类型:boolean
terminalTm:订单时间,类型:String
lat:纬度,类型:int
lng:经度,类型:int
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
id:订单ID
groupId:订单组ID,类型:String
groupIdStr:用于展示的订单组编号,类型:String
expressNo:快递单号,类型:String
shopAddr:商家地址,类型:String
shopTel:商家电话,类型:String
shopName:商家名称,类型:String
customerAddr:客人地址,类型:String
customerTel:客人电话,类型:String
distributingfee:配送费,类型:String
subsidyfee:补贴,类型:String
payPrice:向发货方支付金额,类型:String
chargePrice:向发货方收取配送费,类型:String
status:订单状态,类型:int
btnText:按钮文案
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
remark:备注,类型:String
chargeUserPrice:向用户收取,类型:String
dispatchTm:派单时间,类型:String
ticketUrl:小票URL,类型:String
incomeInfo:{收入
incomeMsg:收入提示文案,类型:String
totalIncome:收入总计,类型:String
incomeList:[
{
name:收入名称,类型:String
income:收入金额,类型:String
incomeDetailList:[
name:收入名称,类型:String
income:收入金额,类型:String
incomeText:收入名称,类型:String
]
}
......
]
}
arriveConsume:到店用时,类型:long
deliveryConsume:配送剩余时间,类型:long
hasArrived:是否已到店,类型:boolean
punctualRewardText:订单准点奖励文案,类型:String
timeout:是否超时,类型:int
outOfDispatchingRange:是否超距,类型:int
distanceForFee:配送范围,类型:String
leaveTm:离店时间,类型:String
finishTm:完成时间,类型:String
tradingAreaName:订单所属商圈,类型:String
orderCancelReason:订单取消原因,类型:String
cancelPunishment:取消惩罚,类型:String
appealStatusText:申诉状态文案,类型:String
appealId:申诉ID,类型:String
complaintStatusText:投诉状态文案
complaintId:投诉ID,类型:String
punishDate:订单取消惩罚时间,类型:String
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
stockOut:是否缺货,1-缺货 0-未缺货 类型:int
difference:货品是否有差异 1-有差异 0-无差异 类型:int
balanceInfo:结算信息集合
hasFoodInfo:是否存在餐品信息,类型:int
collection:代收,类型:double
isResident:是否驻店,类型:int
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:客人未支付金额,类型:double
dispatchMode:调度模式,类型:int
contractType:驻店模式,类型:int
onlinePayType:支付模式,类型:int
paidAmount:客人已支付金额,类型:double
orderIncomeRuleUrl:订单收入规则URL
shopId:商家ID,类型:String
deliveredTm:妥投时间,类型:String
orderScanned:是否有订单已经被扫码核验,类型:int
0:没有 1:有
requireTm:应送达时间,类型:String
fetchRequireTm:应取货时间,类型:String
foodsReady:商家是否已出餐,类型:boolean
true:已出餐 false:未出餐
foodsReadyReported:是否已举报商家未出餐,类型:boolean
true:已举报 false:未举报
channelId:渠道订单号,类型:String
agingText:订单时效文案,类型:String
expressCount:面单总数量,类型:int
canceledOrderCount:已被取消的订单数量,类型:int
notScannedOrderCount:未扫码的订单数量,类型:int
orderCount:接单的订单总数量,类型:int
btnValue:按钮状态,类型:int
4:到店并拍摄小票
5:我已到店|取货 | 全部到店
10:录入新订单
15:还有订单未拍小票 | 扫码核验
20:离店配送 | 全部离店
22:拍摄货物图片
23:全部妥投
25:货品送达 | 全部回执送达
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
predictIncome:预计收入,类型:String
distanceToShop:骑手到商家的距离,类型:String
distanceToCustomer:骑手到客人的距离,类型:String
weight:重量,类型:String
punctualRewardMoney:准点奖励金额,类型:String
punctualRewardRequireTm:准点奖励要求送达时间,类型:String
fee:小费,类型:String
arriveTm:到店时间,类型:String
getGoodsTm:取货时间,类型:String
cancelGoodsTm:取消时间,类型:String
waybillNo:面单号,类型:String
arriveTmTips:到店是否超时提示,类型:String
deliveryTmTips:送达是否超时提示,类型:String
goodsMoney:货品金额,类型:String
distanceToDestination:骑手到目的地的距离,类型:String
customerName:收货人姓名,类型:String
getGoodsTmTips:取货时间(同城直送订单),类型:String
isAppointmentOrder:是否是预约单,类型:int
goodsType:货品类型,类型:String
labelList2: [
{
labelText:标签标题,类型:String
labelColor:标签字体颜色,类型:String
bgColor:标签背景颜色,类型:String
labelDesc:标签释义,类型:String
}
...
]
timeAssessList:[
{
assessName:考核名称,例:准点到店时间,类型:string
assessContent:考核内容,例:12:30前,类型:string
reward:奖励,例:奖 ¥2.5:,类型:string
overRewardTime:是否超过奖励时间,类型:boolean
timeover:是否超时,类型:boolean
punishDesc: 处罚描述 例:超时20分钟扣¥5.0,类型String
oldAccessContent:旧考核内容,如:12:40前,类型:String
oldAccessDesc:旧考核描述,如:因接到新的订单,送达时间发生调整 类型:String
},
……
]
}
}
接口描述
获取订单包中的订单列表
接口消息定义
请求地址: /rider/view-express-order-list.json
请求方法: GET
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单订单ID,类型:String
groupId:订单包ID,类型:String
btnValue:当前订单的btnValue,类型:int
orderType:当前订单的类型,类型:int
sortType:排序规则,0:默认排序 1:从无法配送进入,类型:int
}
响应消息
{
status: 1,
data:{
expressCount:面单数量,类型:int
canceledOrderCount:已被取消的订单数量,类型:int
notScannedOrderCount:未扫码的订单数量,类型:int
notAvailableExpress:没有可用面单(即所有订单为完结状态 完成、异常、取消),类型:int
0:不是 1:是
availableOrderId:可用订单号,类型:String
list:[
{
id:订单Id,类型:String
expressNo:面单号,类型:String
statusStr:当前订单的状态,如:未扫码、已扫码、取消、异常等 类型:String
color:订单状态文案的颜色枚举,类型:int
0:灰色 1:绿色 2:红色
enabled:订单是否可操作(用于选择面单取消页面订单是否可以进行取消操作),类型:int
0:不可操作 1:可操作
}
]
},
msg: Toast文案
}
接口描述
扫码核验
接口消息定义
请求地址: /rider/pick-order-from-group.json
请求方法: GET
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单包订单ID,类型:String
groupId:订单组ID,类型:String
waybillNo:运单号,类型:String
}
响应消息
{
status: 1,
data:{
successText:扫码核验成功后的Toast文案,类型:String
lastExpress:是否是订单包中最后一个订单,类型:int
0:不是 1:是
},
msg: 核验失败后的文案
errorCode:
9402-订单已被取消 9403-订单不在订单包内
}
接口描述
全部妥投
接口消息定义
请求地址: /rider/set-order-delivered.json
请求方法: GET
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单包订单ID,类型:String
groupId:订单组ID,类型:String
}
响应消息
{
status: 1,
data:{
successText:全部妥投成功后的Toast文案,类型:String
},
msg: 全部妥投失败后的文案
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/get-cancel-reasons.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
orderId:订单Id,类型:String
platformId:渠道ID,类型:int
orderType:订单类型,类型:String
groupId:订单包ID,有就传,没有就不传,类型:String
}
响应消息
{
status: 1,
data:{
reasons:[
{
reasonId:送达原因Id,类型:int
reasonText:送达原因文案,类型:String
title:弹窗标题,类型:String
message:弹窗文案,类型:String
}
...
]
},
msg:""
}
接口描述
我已到店
接口消息定义
请求地址:/rider/arrive-shop.json
请求方法: GET
请求消息体:
{
...
groupId:订单组ID,类型:String
...
}
响应消息
{
status: 1,
data:{
successText:提示文案,类型:String
successIds:到店成功ID,类型:String
}
msg:“”
errorCode:距离超限提示码,类型:int
}
接口描述
取得餐品调用该接口。
接口消息定义
请求地址: /rider/obtain-good.json
请求方法: GET
请求消息体:
{
...
groupId:订单组ID,类型:String
...
}
响应消息
{
status: 1,
data:{
...
},
msg:””
errorCode:距离超限提示码,类型:int
}
接口描述
完成订单调用该接口。
接口消息定义
请求地址: /rider/finish-order
请求方法: post
请求消息体:
{
...
groupId:订单组ID,类型:String
...
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
totalOrderNum:新手奖励订单总数量,类型:int
finishedOrderNum:已完成的订单总数量,类型:string 当改字段为空时,表示服务器超时,本地不更新
reward:每单的奖励金额,类型:float,一位小数
showBanner:是否展示Banner,1:是 0:否 类型:int
successIds:完成的订单号,用逗号分隔,类型:String
},
msg: ""
errorCode:距离超限提示码,类型:int
errorCode:客人未支付提示码,类型:int
}
接口描述
设置异常单:联系不到客人或者客人拒收
接口消息定义
请求地址:/rider/ set-order-abnormal.json
请求方法: get
请求消息体:
{
...
groupId:订单组ID,类型:String
...
}
响应消息
{
status: 1,
data:{
successText:提示文案,类型:String
totalOrderNum:新手奖励订单总数量,类型:int
finishedOrderNum:已完成的订单总数量,类型:string 当改字段为空时,表示服务器超时,本地不更新
reward:每单的奖励金额,类型:float,一位小数
showBanner:是否展示Banner,1:是 0:否 类型:int
}
msg:“”
errorCode:距离超限提示码,类型:int
}
接口描述
在登录界面,用户登录时必须经过手机及验证码验证
接口消息定义
请求地址:/ rider/login.json
请求方法: post
请求消息体:
{
mobile:用户名,实际为手机号,类型:String
captcha:验证码,类型:String
cityId:城市ID,类型:String
version:应用版本号,类型:String
imei:手机IMEI号,类型:String
riderId:骑手ID,类型:String
lat:骑手位置经纬度,类型:int
lng:骑手位置经纬度,类型:int
source:手机厂商,类型:String
client:系统版本,类型:String
channelId:渠道ID,类型:String
phoneVersion:手机型号,类型:String
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
updateType:0不需要升级 1正常升级 2强制升级 , 类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
riderId:用户id,类型:String,之后服务端和客户端交流的凭证
insuranceFee:保险费用,类型:float
riderType:骑手类型0:骑手 1:骑士 ,类型:int
tips:更新提示文案,类型:String
areaCode:区号,类型:String
identityCard:身份证,类型:String
tradingAreaId:工作商圈,类型:int
riderName:骑手姓名,类型:String
forceReadNotify:{
id:强制阅读消息ID,类型:String
url:消息URL,类型:String
title:消息标题,类型:String
}
token:登录token,类型:String
serverAddress:服务器地址,类型:string
distanceThreshold:超距判断距离,如3KM,类型:double
targetRadius:目标半径,引导骑手去设置,如1km,类型:double
distanceTimeInterval:超距提示时间间隔,如10分钟,类型:int
waitForDistanceThreshold:等待超时超距判断距离,如0.5KM,类型:double
newUserReward:新手5单奖励活动是否开启,类型:boolean
spreadRedPoint:推广赚钱红点显示,类型:boolean
csTel:客服电话,类型:String
firstLogin:是否首次登陆,类型:boolean
serverTime:服务器当前时间戳,类型:long
isNewComer:是否是新骑手,1:是 0:否,类型:int
registCityId:骑手注册城市ID,类型:int
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:10011,设备已绑定其它账号,类型:int
}
接口描述
设置异常单:联系不到客人或者客人拒收
接口消息定义
请求地址:/rider/ get-red-packet-info.json
请求方法: get
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
}
响应消息
{
status: 1,
data:{
activityTitle:活动名称,如:类型:String
state:红包奖励活动当前状态,类型:int
1:活动已结束 2:活动即将开始 3:活动进行中
activityTime:活动时间戳,类型:long
(1)state=1时,传0
(2)state=2时,传活动开始时间戳
(3)state=3时,传活动结束时间戳
currentTime:当前时间戳,用于倒计时计算,类型:long
forwardUrl:查看活动详情h5页面链接,类型:String
redPacketVisible:红包活动入口是否展示,类型:int
0:不展示 1:展示
}
msg:“”
errorCode:距离超限提示码,类型:int
}
接口描述
在登录界面,用户登录时必须经过手机及验证码验证
接口消息定义
请求地址:/ rider/login.json
请求方法: post
请求消息体:
{
mobile:用户名,实际为手机号,类型:String
captcha:验证码,类型:String
cityId:城市ID,类型:String
version:应用版本号,类型:String
imei:手机IMEI号,类型:String
riderId:骑手ID,类型:String
lat:骑手位置经纬度,类型:int
lng:骑手位置经纬度,类型:int
source:手机厂商,类型:String
client:系统版本,类型:String
channelId:渠道ID,类型:String
phoneVersion:手机型号,类型:String
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
updateType:0不需要升级 1正常升级 2强制升级 , 类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
riderId:用户id,类型:String,之后服务端和客户端交流的凭证
insuranceFee:保险费用,类型:float
riderType:骑手类型0:骑手 1:骑士 ,类型:int
tips:更新提示文案,类型:String
areaCode:区号,类型:String
identityCard:身份证,类型:String
tradingAreaId:工作商圈,类型:int
riderName:骑手姓名,类型:String
forceReadNotify:{
id:强制阅读消息ID,类型:String
url:消息URL,类型:String
title:消息标题,类型:String
}
token:登录token,类型:String
serverAddress:服务器地址,类型:string
distanceThreshold:超距判断距离,如3KM,类型:double
targetRadius:目标半径,引导骑手去设置,如1km,类型:double
distanceTimeInterval:超距提示时间间隔,如10分钟,类型:int
waitForDistanceThreshold:等待超时超距判断距离,如0.5KM,类型:double
newUserReward:新手5单奖励活动是否开启,类型:boolean
spreadRedPoint:推广赚钱红点显示,类型:boolean
csTel:客服电话,类型:String
firstLogin:是否首次登陆,类型:boolean
serverTime:服务器当前时间戳,类型:long
isNewComer:是否是新骑手,1:是 0:否,类型:int
registCityId:骑手注册城市ID,类型:int
redPacketVisible:红包活动入口是否展示,类型:int
0:不展示 1:展示
originCityId:原始城市ID,仅在跨城市订单场景下发订单原始的城市ID,类型:String
跨城订单点击取消订单进入h5取消页面后,UserAgent中的cityId使用这个值
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:10011,设备已绑定其它账号,类型:int
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/rob-order-list.json
请求方法: GET
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
currentPage:当前页码,类型:int
keyWord:搜索关键词,类型:String
lat:骑手当前纬度,类型:int
lng:骑手当前经度,类型:int
}
响应消息
{
status:1,
data:{
currentPage:当前页码,类型:int
pageCount:总页数,类型:int
riderStatus:骑手状态,类型:int
verifiedStatus:验证状态,类型:int
tips:提示文案
btnText:按钮文案
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
groupList:[
{
orderId:订单ID,类型:String
groupId:订单分组,类型:String
platformId:渠道ID,类型:String
income:收入(分组单),类型:String
fee:小费(分组单),类型:String
platformText:取单名称(分组单)
requireTm:要求送达时间(分组单),类型:String
isAppointmentOrder:是否是预约单,类型:int
matchingDegree:顺路度,类型:String
orderCount:接单的订单总数量,类型:int
PS:不再判断orderList中有多少个订单,如果orderCount≤1,则展示“接单” 如果大于1,则展示"接xx单"
redPacket:是否是红包订单,类型:int
0:不是 1:是
orderList:[
{
id:订单ID,类型:String
income:收入,类型:String
customerAddr:客人地址
distanceToCustomer:配送距离
status:订单状态
requireTm:要求送达时间
distanceToMe:距离你的距离,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
orderType:订单类型,类型:int
0、普通订单(手发单);
1、同城直送;
2、外卖订单;
3、揽件订单;
4、派件订单
customerName:收货人姓名
shopTel:商家电话,类型:String
mixedGrab:是否是抢派混合单,类型:int
newLabelList:[
{
labelText:标签文案,类型:String
labelColor:标签字体颜色,如:“#fe751a”,类型:String
bgColor:标签背景颜色,如:“#fe751a”,类型:String
}
...
]
}
...
]
}
...
]
isScanCode:是否支持扫码抢单
}
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: GET
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
sortType:订单排序类型,0 默认时间点排序,1 商家排序,2 订单号排序 类型:int
}
响应消息
{
status:1,
data:{
riderStatus:骑手状态,类型:int
0:休息中,5:工作中,99:禁用
verifiedStatus:认证状态,类型:int
0:未认证 5:审核中 9:未通过 10:已认证
tips:提示文案,类型:String
btnText:按钮文案,类型:String
unTerminativeOrderNum:订单数量,类型:int
arriveThreshold:到店阈值,类型:long
verifiedOvertime:是否审核超时,类型:boolean
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
orderList:[ 订单列表
{
id:订单Id,类型:String
groupId:订单组ID,类型:String
orderCount:接单的订单总数量,类型:int
orderScanned:是否有订单已经被扫码核验,类型:int
0:没有 1:有
income:收入,类型:String
advance:垫付金额,类型:String
customerAddr:收货地址,类型:String
status:订单状态,类型:int
typeStatus:录入状态,类型:int
0:未录入 5:未拍小票 10:已录入 15:已取货 99:未选择订单
redPacket:是否是红包订单,类型:int
0:不是 1:是
type:列表数据类型,类型:int(0:真实订单)
btnValue:按钮状态,类型:int
4:到店并拍摄小票
5:我已到店|取货| 全部到店
10:录入新订单
15:还有订单未拍小票| 扫码核验
20:离店配送| 全部离店
22:拍摄货物图片
23:全部妥投
25:货品送达| 全部回执送达
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
btnText:状态文案,类型:String
sinceObtained:配送时长,类型:long
customerTel:收货人联系方式,类型:String
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
urge:是否催单,类型:int
serialId:订单序号,类型:String
punctualTm:准点奖励要求时间,类型:String
labelList:[
{
code:标签Code,类型:int
title:标签标题,类型:String
desc:标签文案,类型:String
type:标签样式类型,类型:int
}
...
]
requireTm:要求送达时间,类型:String
requireTm2:要求送达时间,类型:long
serviceTm:服务器当前时间,类型:long
punctualAmount:准点奖励金额,类型:String
collection:代收,类型:String
collection2:代收金额,类型:double
punctualTm2:准点奖励要求时间,类型:long
searchText:用于订单搜索的字段,类型:String
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
elemeWaybillNo:饿了么运单号,类型:String
shopInfo:{
shopId:商家ID,类型:String
shopAddr:发货地址,类型:String
shopName:商家名称,类型:String
orderNum:订单数量,类型:int
channel:是否是渠道单
0:非渠道单 1:渠道单
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
shopTel:商家电话,类型:String
notTyped:未录入订单ID,类型:List
notObtained:未离店订单ID,类型:List
remainTime:到店剩余时间,类型:long
finishedNum:当前完成商家订单数,类型:int
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
platformName:渠道名称,类型:String
}
isAppointmentOrder:是否是预约单,类型:int
payStatus:支付状态,类型:int
0:默认值,无意义
1:未支付
2:线上支付
3:线下支付
totalIncome:预计收入汇总值(预计收入+小费+困难单奖励),类型:String
orderOvertime:到店或者送达超时标识,类型:boolean
punishDesc:处罚文案 类型String 例:超时20分钟扣¥5.0
}
...
]
distanceToCustomer:配送距离,类型:String
leaveTm:离店时间,类型:long
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:未支付金额,类型:double
dispatchMode:调度模式,类型:int
1:系统派单
2:抢单
3:人工派单
4:分组派单
5:扫码抢单
contractType:驻店模式,类型:int
0:非驻店
1:全驻店
2:半驻店
arriveTm:到店时间,类型:long
onlinePayType:在线支付类型,类型:int
0:不区分线上线下支付
1:线下支付
2:线上支付
paidAmount:客人已支付金额,类型:float
customerName:客人姓名,类型:String
notifyList:{
fetchTimeOut:取货/到店超时时间点,类型:long
deliveryTimeOut:送达超时时间点,类型:long
}
distanceToShop:骑手到商家的距离,类型:String
fetchRequireTm:应取货时间,类型:String
remainDeliveryTime:应送达时间倒计时,类型:int
remainFetchTime:要求取货时间倒计时,类型:int
platformId:渠道ID,类型:int
新增盒马订单渠道,72
newLabelList:[
{
labelText:标签文案,类型:String
labelColor:标签字体颜色,如:“#fe751a”,类型:String
bgColor:标签背景颜色,如:“#fe751a”,类型:String
}
...
]
fee:小费
}
}
接口描述
完成订单调用该接口。
接口消息定义
请求地址: /rider/finish-order
请求方法: post
请求消息体:
{
...
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
totalOrderNum:新手奖励订单总数量,类型:int
finishedOrderNum:已完成的订单总数量,类型:string 当改字段为空时,表示服务器超时,本地不更新
reward:每单的奖励金额,类型:float,一位小数
redPacketReward:红包奖励金额,类型:float
showBanner:是否展示Banner,1:是 0:否 类型:int
successIds:完成的订单号,用逗号分隔,类型:String
},
msg: ""
errorCode:距离超限提示码,类型:int
errorCode:客人未支付提示码,类型:int
}
接口描述
抢单,不同于口碑订单的选择订单
接口消息定义
请求地址:/rider/rob-order.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
orderId:订单ID,类型:number
groupId:订单分组,类型:String
platformId:渠道ID,类型:number
lat:经纬度,类型:int
lng:经纬度,类型:int
from:订单来源,类型:String
(1)默认为空表示从待接单列表抢到的订单
(2)recommend表示从强推荐订单列表抢到的订单
forceRob:是否强制抢单,类型:int
默认传0表示不强制,当errorCode=9304并点击“继续接单”后传1表示继续接单
}
响应消息
{
status: 1,
data:{
successText:成功提示文案,类型:string
isBooking:是否预约单,类型:boolean
},
msg:""
extraMsg:当存在errorCode时的文案,类型:String
errorCode: 新增以下枚举值
errorCode = 9300 菜鸟揽件接单 文案:订单异常,请刷新列表后重试
errorCode = 9301 点击接单时其他原因不符 文案:接单失败,请稍后重试
errorCode = 9302 菜鸟揽件接单 文案:系统异常,请刷新列表后重试
errorCode = 9303 抢单服务器接口超时
errorCode = 9304 订单不顺路弹窗提醒,并在extraMsg中返回弹窗文案,类型:String
}
接口描述
停止接单,下班
接口消息定义
请求地址: /rider/come-off-work.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data:{
statusText:当前工作状态文案,类型:String
orderWarning:订单提醒文案,类型:String
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:错误码
9021: 身上有未离店订单时不允许下线
}
接口消息定义
请求地址: /rider/get-facepp-config.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data:{
enable:开发是否打开,类型:int
0:未打开 1:打开
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:错误码 :9501 身份证或者人脸识别超过三次
}
接口消息定义
请求地址: /rider/identity-ocr.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
frontImage:身份证正面照路径,类型:String
backImage:身份证反面照路径,类型:String
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data:{
name:姓名,类型:String
identityNumber:身份证号码,类型:String
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:错误码
}
接口消息定义
请求地址: /rider/identity-face-detection.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
name:姓名,类型:String
identityNumber:身份证号码,类型:String
faceImage:身份证头像URL,类型:String
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data:{
successText:头像鉴别成功文案
}
msg:错误提示信息,如没有,则为空,类型:String
当存在errorCode时,返回各种errorCode对应的文案
errorCode:错误码
9500:信息有误,请重新认证
9501:提交过于频繁,请明天再来认证
}
接口消息定义
请求地址: /rider/submit-facepp-authentication.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
name:姓名,类型:String
identityNumber:身份证号码,类型:String
action1Image:动作1图片,类型:String
action2Image:动作2图片,类型:String
action3Image:动作3图片,类型:String
bestImage:最佳图片,类型:String
envImage:环境照片,类型:String
delta:返回的delta字符串,类型:String
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data:{
successText:头像鉴别成功文案
}
msg:错误提示信息,如没有,则为空,类型:String
当存在errorCode时,返回各种errorCode对应的文案
errorCode:错误码
9500:信息有误,请重新认证
9501:提交过于频繁,请明天再来认证
9502:人脸识别失败,请重试
}
接口描述
身份审核失败信息展示
接口消息定义
请求地址:rider/auth-feedback.json
请求方法:get/post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status: 1,
data:{
realName:真实姓名,类型:String
identityCard:身份证号,类型:String
frontIdentityImageUrl:身份证正面照片地址,类型:String
backIdentityImageUrl:身份证反面照片地址,类型:String
IdentityImageUrl:手持身份证照片地址,类型:String
reason:失败原因,类型:String
from:认证流程来源,类型:int
0:普通认证流程 1:face++认证流程
faceImageUrl:人脸照片URL,类型:String
reasonDetails:[
{
type:失败类型,
10:真实姓名与身份证不符;
20:身份证号与身份证不符;
40:身份证正面照不清晰;
50:身份证背面照不清晰;
60:手持身份证照不清晰;
51:身份证上方无“点我达合作骑手”字条
类型:int
details:失败明细信息,类型:String
}
]
},
msg:""
}
接口描述
查询骑手用户评级信息
接口消息定义
请求地址:rider/rider-evaluate-info.json
请求方法:get/post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
type:评价类型(1-好评,2-中评,3-差评),类型:int
lastEvaluateId:上次请求数据最后一条评价的ID,类型:String
pageSize:每次查询评价条数,类型:int
}
响应消息
{
status: 1,
data:{
lastEvaluateId:请求传入的评价ID(网关直接返回即可),类型:String
//评价类型(请求的type=1并且lastEvaluateId为空时,返回数据)
evaluateTypeList:[{
name:评价类型名称(例:“好评”),类型:String
id:评价类型ID(1-好评,2-中评,3-差评),类型:int
count:好评/中评/差评的总评价量,类型:int
}
],
//评价记录
evaluateList:[{
id:评价记录ID,类型:String
evaluatorName:评价者名字,类型:String
type:评价类型(1-好评,2-中评,3-差评),类型:int
typeDesc:评价类型描述,类型:String
description:评价内容,类型:String
date:评价日期,类型:String
},...
],
//评价标签
tagList:[{
name:标签名称(例:“餐品完好 188”),类型:String
addNumber:新增该标签评价数量文案(例:“+23”),类型:String
}
],
evaluateNumber:本周获得的好评/中评/差评的评价数量(例:“32”,请求的lastEvaluateId为空时,返回数据),类型:String
evaluateType:本周获得的好评/中评/差评的评价类型(1-好评,2-中评,3-差评),类型:int
},
msg:""
}
接口描述
获取订单详细信息
接口消息定义
请求地址:/rider/view-order-detail.json
请求方法: GET
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
history:是否是历史订单,类型:boolean
terminalTm:订单时间,类型:String
lat:纬度,类型:int
lng:经度,类型:int
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
id:订单ID
groupId:订单组ID,类型:String
groupIdStr:用于展示的订单组编号,类型:String
shopAddr:商家地址,类型:String
shopTel:商家电话,类型:String
shopName:商家名称,类型:String
customerAddr:客人地址,类型:String
customerTel:客人电话,类型:String
distributingfee:配送费,类型:String
subsidyfee:补贴,类型:String
payPrice:向发货方支付金额,类型:String
chargePrice:向发货方收取配送费,类型:String
status:订单状态,类型:int
btnText:按钮文案
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
remark:备注,类型:String
chargeUserPrice:向用户收取,类型:String
dispatchTm:派单时间,类型:String
ticketUrl:小票URL,类型:String
incomeInfo:{收入
incomeMsg:收入提示文案,类型:String
totalIncome:收入总计,类型:String
incomeList:[
{
name:收入名称,类型:String
income:收入金额,类型:String
incomeDetailList:[
name:收入名称,类型:String
income:收入金额,类型:String
incomeText:收入名称,类型:String
]
}
......
]
}
arriveConsume:到店用时,类型:long
deliveryConsume:配送剩余时间,类型:long
hasArrived:是否已到店,类型:boolean
punctualRewardText:订单准点奖励文案,类型:String
timeout:是否超时,类型:int
outOfDispatchingRange:是否超距,类型:int
distanceForFee:配送范围,类型:String
leaveTm:离店时间,类型:String
finishTm:完成时间,类型:String
tradingAreaName:订单所属商圈,类型:String
orderCancelReason:订单取消原因,类型:String
cancelPunishment:取消惩罚,类型:String
changePhone:客人是否修改了手机号,类型:int
0:未修改 1:已修改
orderAbnormal:是否展示无法配送原因横条,类型:int
0:不展示 1:展示
orderAbnormalId:无法配送生成的工单ID,类型:String
appealStatusText:申诉状态文案,类型:String
appealId:申诉ID,类型:String
complaintStatusText:投诉状态文案
complaintId:投诉ID,类型:String
punishDate:订单取消惩罚时间,类型:String
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
stockOut:是否缺货,1-缺货 0-未缺货 类型:int
difference:货品是否有差异 1-有差异 0-无差异 类型:int
balanceInfo:结算信息集合
hasFoodInfo:是否存在餐品信息,类型:int
collection:代收,类型:double
isResident:是否驻店,类型:int
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:客人未支付金额,类型:double
dispatchMode:调度模式,类型:int
contractType:驻店模式,类型:int
onlinePayType:支付模式,类型:int
paidAmount:客人已支付金额,类型:double
orderIncomeRuleUrl:订单收入规则URL
shopId:商家ID,类型:String
deliveredTm:妥投时间,类型:String
orderScanned:是否有订单已经被扫码核验,类型:int
0:没有 1:有
requireTm:应送达时间,类型:String
fetchRequireTm:应取货时间,类型:String
foodsReady:商家是否已出餐,类型:boolean
true:已出餐 false:未出餐
foodsReadyReported:是否已举报商家未出餐,类型:boolean
true:已举报 false:未举报
channelId:渠道订单号,类型:String
agingText:订单时效文案,类型:String
expressCount:面单总数量,类型:int
canceledOrderCount:已被取消的订单数量,类型:int
notScannedOrderCount:未扫码的订单数量,类型:int
orderCount:接单的订单总数量,类型:int
btnValue:按钮状态,类型:int
4:到店并拍摄小票
5:我已到店|取货| 全部到店
10:录入新订单
15:还有订单未拍小票|扫码核验
20:离店配送| 全部离店
22:拍摄货物图片
23:全部妥投
25:货品送达| 全部回执送达
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
predictIncome:预计收入,类型:String
distanceToShop:骑手到商家的距离,类型:String
distanceToCustomer:骑手到客人的距离,类型:String
weight:重量,类型:String
punctualRewardMoney:准点奖励金额,类型:String
punctualRewardRequireTm:准点奖励要求送达时间,类型:String
fee:小费,类型:String
arriveTm:到店时间,类型:String
getGoodsTm:取货时间,类型:String
cancelGoodsTm:取消时间,类型:String
waybillNo:面单号,类型:String
arriveTmTips:到店是否超时提示,类型:String
deliveryTmTips:送达是否超时提示,类型:String
goodsMoney:货品金额,类型:String
distanceToDestination:骑手到目的地的距离,类型:String
customerName:收货人姓名,类型:String
getGoodsTmTips:取货时间(同城直送订单),类型:String
isAppointmentOrder:是否是预约单,类型:int
goodsType:货品类型,类型:String
labelList2: [
{
labelText:标签标题,类型:String
labelColor:标签字体颜色,类型:String
bgColor:标签背景颜色,类型:String
labelDesc:标签释义,类型:String
}
...
]
timeAssessList:[
{
assessName:考核名称,例:准点到店时间,类型:string
assessContent:考核内容,例:12:30前,类型:string
reward:奖励,例:奖 ¥2.5:,类型:string
overRewardTime:是否超过奖励时间,类型:boolean
timeover:是否超时,类型:boolean
punishDesc: 处罚描述 例:超时20分钟扣¥5.0,类型String
oldAccessContent:旧考核内容,如:12:40前,类型:String
oldAccessDesc:旧考核描述,如:因接到新的订单,送达时间发生调整 类型:String
},
……
]
}
}
接口描述
设置异常单:联系不到客人或者客人拒收
接口消息定义
请求地址:/rider/ set-order-abnormal.json
请求方法: get
请求消息体:
{
...
applyReport:是否申请报备,类型:int
0:默认不报备 1:报备
...
}
响应消息
{
status: 1,
data:{
successText:提示文案,类型:String
totalOrderNum:新手奖励订单总数量,类型:int
finishedOrderNum:已完成的订单总数量,类型:string 当改字段为空时,表示服务器超时,本地不更新
reward:每单的奖励金额,类型:float,一位小数
showBanner:是否展示Banner,1:是 0:否 类型:int
}
msg:“”
extraMsg:当errorCode=9310时返回弹窗文案
errorCode:距离超限提示码,类型:int
9310:申请报备弹窗
}
接口描述
设置异常单:联系不到客人或者客人拒收
接口消息定义
请求地址:/rider/ check-auth-info.json
请求方法: get
请求消息体:
{
cityId:城市ID,
riderId:骑手ID,
name:姓名,类型:String
identityNumber:身份证号码,类型:String
}
响应消息
{
status: 1,
data:{
successText:提示文案,类型:String
}
msg:“”
}
接口描述
账户提现信息
提现上下限金额由网关控制
接口消息定义
请求地址:/rider/get-withdrawal-info.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
accountType:账户类型,类型:int
}
响应消息
{
status: 1,
data: {
accounts: [{
account: 账户,类型:String,
accountType: 账户类型,类型:int,
bankName: 银行名称,类型:String
}],
avaliableApplyTimes: 当天可提现次数,类型:int
chargeFee:提现手续费,单位:元,类型:float
newComerPrivilege:是否是新手期特权,1:是 0:不是 类型:int
canWithdraw:是否可以提现(1-不可提现,0-可提现),类型:int
minLimit:提现金额下限,类型:int
maxLimit:提现金额上限,类型:int
limitTip:提现金额限制提示文案,类型:String
},
msg: "",
errorCode: "",
extraMsg: ""
}
接口描述
在登录界面,用户登录时必须经过手机及验证码验证
接口消息定义
请求地址:/ rider/login.json
请求方法: post
请求消息体:
{
mobile:用户名,实际为手机号,类型:String
captcha:验证码,类型:String
cityId:城市ID,类型:String
version:应用版本号,类型:String
imei:手机IMEI号,类型:String
riderId:骑手ID,类型:String
lat:骑手位置经纬度,类型:int
lng:骑手位置经纬度,类型:int
source:手机厂商,类型:String
client:系统版本,类型:String
channelId:渠道ID,类型:String
phoneVersion:手机型号,类型:String
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
updateType:0不需要升级 1正常升级 2强制升级 , 类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
riderId:用户id,类型:String,之后服务端和客户端交流的凭证
insuranceFee:保险费用,类型:float
riderType:骑手类型0:骑手 1:骑士 ,类型:int
tips:更新提示文案,类型:String
areaCode:区号,类型:String
identityCard:身份证,类型:String
tradingAreaId:工作商圈,类型:int
riderName:骑手姓名,类型:String
forceReadNotify:{
id:强制阅读消息ID,类型:String
type:强制阅读类型,类型:int
0:H5页面 1:图片弹窗
imageUrl:图片弹窗中图片的URL链接,仅在type=1时下发,类型:String
url:消息URL,类型:String
当type=1时,返回点击图片后进入h5页面的链接
title:消息标题,类型:String
}
token:登录token,类型:String
serverAddress:服务器地址,类型:string
distanceThreshold:超距判断距离,如3KM,类型:double
targetRadius:目标半径,引导骑手去设置,如1km,类型:double
distanceTimeInterval:超距提示时间间隔,如10分钟,类型:int
waitForDistanceThreshold:等待超时超距判断距离,如0.5KM,类型:double
newUserReward:新手5单奖励活动是否开启,类型:boolean
spreadRedPoint:推广赚钱红点显示,类型:boolean
csTel:客服电话,类型:String
firstLogin:是否首次登陆,类型:boolean
serverTime:服务器当前时间戳,类型:long
isNewComer:是否是新骑手,1:是 0:否,类型:int
registCityId:骑手注册城市ID,类型:int
redPacketVisible:红包活动入口是否展示,类型:int
0:不展示 1:展示
originCityId:原始城市ID,仅在跨城市订单场景下发订单原始的城市ID,类型:String
跨城订单点击取消订单进入h5取消页面后,UserAgent中的cityId使用这个值
needProtocal:是否已经同意用户协议,类型:int
0:不需要(已经同意过协议) 1:需要(未同意过协议)
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:10011,设备已绑定其它账号,类型:int
}
** 接口描述
每隔15秒上传一次骑手位置经纬度。
接口消息定义
请求地址: /rider/ upload-position.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
imei:设备号,类型:String
version:版本号,类型:String
token:token,类型:String
locationType:定位类型,类型:int
}
响应消息
{
status:1,
data:{
isSelf: 是否是自己登录 1 正常登录 0 非自己登录,类型:int
verifyResult: 身份验证通知,类型:String
notSelfText: 别人登陆后的通知,类型:String
verifiedOvertime:审核超时,类型:boolean
orderNotifyList:[
{
orderId:订单ID,类型:String
type:通知类型,1:新订单 2:取消单 3:修改单, 12:离店后取消 13:追加单 类型:int
shopId:商家ID,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
customerAddr:客户地址,类型:String
platformId:渠道id,类型:int
elemeWaybillNo:饿了么运单号,类型:String
income:订单金额,类型:String
}
],
lostConnectionNotify:强行休息的通知,类型:String
updateType:0不需要升级 1正常升级 2强制升级,类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
tips:提示信息,类型:String
orderCellingChangedNotify: 修改接单上限通知,类型:String
riderTypeChangeNotify:骑手身份变更通知,类型:String
cancelOrderPunishNotify:订单取消扣款通知,类型:String
patchUpdateNotify:补丁下发通知,类型:int
forbiddenNotify:禁用 启用通知,格式:1|提示信息,1 禁用 2启用,类型:String
upgradeProtocolNotify:升级协议通知,格式:0|不显示协议浮层,1|显示协议浮层,类型:int
robOrderNotify:有可抢单通知,1 无订单 2 有订单 类型:int
bannerNotify:banner变化通知,1 无变化 2 有变化 类型:int
authResult:认证结果 1:审核成功(仅在审核成功时下发) 2:审核失败(仅在审核失败时下发) 类型:int
agingStatus:时效变更,类型:int,1:已变更,0:未变更,
zcOrderStatus:中车宝联订单状态修改,类型:int,1:审核通过或未通过,0:未变更
weexConfigVersion:weex配置文件版本号,类型:String
weexConfigUrl:weex配置文件下载地址,类型:String
recommendOrderNotify:是否有强推荐订单,类型:int 1:有 0:没有
httpdnsSwitch:是否打开httpdns解析,类型:int 1:打开 0:关闭
dialogNotify:{
imgUrl:弹窗图片URL,类型:String
forwardUrl:点击弹窗进入的h5页面的URL,类型:String
},
residentNotify:{
shopName:驻店商家名称,类型:String
residentTaskId:驻店任务ID,类型:String
}
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,类型:int
}
接口描述
接收通知反馈
接口消息定义
请求地址:/rider/receive-notify.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:用户名,骑士Id,类型:String
receiveOrderNotify:接收订单变更通知,类型:int
receiveKickImeiNotify:退出登录通知,类型:int
receiveLostConnectionNotify:掉线通知,类型:int
receiveVerifyNotify:身份审核通知,类型:int
receiveRiderTypeChangeNotify:骑手身份变更通知,类型:int
receiveLimitedNumberChanged:骑士接单上限通知,类型:int
receiveCancelOrderNotify:取消订单扣款通知,类型:int
receiveForbiddenNotify:禁用及启用通知,类型:int
receiveOrderIds:接收订单通知ID,类型:String
receiveBannerNotify:banner变化通知,1-收到,0-未收到,类型:int
receiveRecommendOrderNotify:收到强推荐订单通知,类型:int
receiveDialogNotify:收到弹窗提醒通知,类型:int
receiveResident:收到驻店任务通知,类型:int
}
响应消息
{
status: 1,
data:””
msg:“”
}
接口描述
抢单,不同于口碑订单的选择订单
接口消息定义
请求地址:/rider/rob-order.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
orderId:订单ID,类型:number
groupId:订单分组,类型:String
platformId:渠道ID,类型:number
lat:经纬度,类型:int
lng:经纬度,类型:int
from:订单来源,类型:String
(1)默认为空表示从待接单列表抢到的订单
(2)recommend表示从强推荐订单列表抢到的订单
forceRob:是否强制抢单,类型:int
默认传0表示不强制,当errorCode=9304并点击“继续接单”后传1表示继续接单
}
响应消息
{
status: 1,
data:{
successText:成功提示文案,类型:string
isBooking:是否预约单,类型:boolean
},
msg:""
extraMsg:当存在errorCode时的文案,类型:String
errorCode: 新增以下枚举值
errorCode = 9300 菜鸟揽件接单 文案:订单异常,请刷新列表后重试
errorCode = 9301 点击接单时其他原因不符 文案:接单失败,请稍后重试
errorCode = 9302 菜鸟揽件接单 文案:系统异常,请刷新列表后重试
errorCode = 9303 抢单服务器接口超时
errorCode = 9304 订单不顺路弹窗提醒,并在extraMsg中返回弹窗文案,类型:String
errorCode = 9305 菜鸟订单抢单时,小件员未认证
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/view-hema-goods-list.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
orderId:订单Id
}
响应消息
{
status: 1,
data:{
goodsList:[
{
goodsId:商品Id,类型:String
groupId:商品组合ID,类型:String
groupName:商品组合名称,类型:String
skuId:与盒马对接的商品ID,类型:String
goodsName:货品名称,类型:String
placeGoods:用户下单时的商品规格,如:"下单:0.5kg x 4个",类型:String
pickingGoods:实际拣货后的商品规格,如:"1kg x 2个",类型:String
stockOut:是否缺货,1-缺货 0-未缺货 类型:int
difference:货品是否有差异 1-有差异 0-无差异 类型:int
btnText:按钮文案,如:拒收/已拒收等 类型:String
isRejectable:是否可以拒收,1-可拒收 0-不可拒收 类型:int
}
...
]
},
msg:""
}
接口描述
获取订单详细信息
接口消息定义
请求地址:/rider/view-order-detail.json
请求方法: GET
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
history:是否是历史订单,类型:boolean
terminalTm:订单时间,类型:String
lat:纬度,类型:int
lng:经度,类型:int
from:打开订单详情的入口来源(非抢单列表进入时传0),类型:int
1:待抢单列表
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
id:订单ID
groupId:订单组ID,类型:String
groupIdStr:用于展示的订单组编号,类型:String
shopAddr:商家地址,类型:String
shopTel:商家电话,类型:String
shopName:商家名称,类型:String
customerAddr:客人地址,类型:String
customerTel:客人电话,类型:String
distributingfee:配送费,类型:String
subsidyfee:补贴,类型:String
payPrice:向发货方支付金额,类型:String
chargePrice:向发货方收取配送费,类型:String
status:订单状态,类型:int
btnText:按钮文案
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
remark:备注,类型:String
chargeUserPrice:向用户收取,类型:String
dispatchTm:派单时间,类型:String
ticketUrl:小票URL,类型:String
incomeInfo:{收入
incomeMsg:收入提示文案,类型:String
totalIncome:收入总计,类型:String
incomeList:[
{
name:收入名称,类型:String
income:收入金额,类型:String
incomeDetailList:[
name:收入名称,类型:String
income:收入金额,类型:String
incomeText:收入名称,类型:String
]
}
......
]
}
arriveConsume:到店用时,类型:long
deliveryConsume:配送剩余时间,类型:long
hasArrived:是否已到店,类型:boolean
punctualRewardText:订单准点奖励文案,类型:String
timeout:是否超时,类型:int
outOfDispatchingRange:是否超距,类型:int
distanceForFee:配送范围,类型:String
leaveTm:离店时间,类型:String
finishTm:完成时间,类型:String
tradingAreaName:订单所属商圈,类型:String
orderCancelReason:订单取消原因,类型:String
cancelPunishment:取消惩罚,类型:String
changePhone:客人是否修改了手机号,类型:int
0:未修改 1:已修改
orderAbnormal:是否展示无法配送原因横条,类型:int
0:不展示 1:展示
orderAbnormalId:无法配送生成的工单ID,类型:String
appealStatusText:申诉状态文案,类型:String
appealId:申诉ID,类型:String
complaintStatusText:投诉状态文案
complaintId:投诉ID,类型:String
punishDate:订单取消惩罚时间,类型:String
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
stockOut:是否缺货,1-缺货 0-未缺货 类型:int
difference:货品是否有差异 1-有差异 0-无差异 类型:int
balanceInfo:结算信息集合
hasFoodInfo:是否存在餐品信息,类型:int
collection:代收,类型:double
isResident:是否驻店,类型:int
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:客人未支付金额,类型:double
dispatchMode:调度模式,类型:int
contractType:驻店模式,类型:int
onlinePayType:支付模式,类型:int
paidAmount:客人已支付金额,类型:double
orderIncomeRuleUrl:订单收入规则URL
shopId:商家ID,类型:String
deliveredTm:妥投时间,类型:String
orderScanned:是否有订单已经被扫码核验,类型:int
0:没有 1:有
requireTm:应送达时间,类型:String
fetchRequireTm:应取货时间,类型:String
foodsReady:商家是否已出餐,类型:boolean
true:已出餐 false:未出餐
foodsReadyReported:是否已举报商家未出餐,类型:boolean
true:已举报 false:未举报
channelId:渠道订单号,类型:String
agingText:订单时效文案,类型:String
expressCount:面单总数量,类型:int
canceledOrderCount:已被取消的订单数量,类型:int
notScannedOrderCount:未扫码的订单数量,类型:int
orderCount:接单的订单总数量,类型:int
btnValue:按钮状态,类型:int
4:到店并拍摄小票
5:我已到店|取货| 全部到店
10:录入新订单
15:还有订单未拍小票|扫码核验
20:离店配送| 全部离店
22:拍摄货物图片
23:全部妥投
25:货品送达| 全部回执送达
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
predictIncome:预计收入,类型:String
distanceToShop:骑手到商家的距离,类型:String
distanceToCustomer:骑手到客人的距离,类型:String
weight:重量,类型:String
punctualRewardMoney:准点奖励金额,类型:String
punctualRewardRequireTm:准点奖励要求送达时间,类型:String
fee:小费,类型:String
arriveTm:到店时间,类型:String
getGoodsTm:取货时间,类型:String
cancelGoodsTm:取消时间,类型:String
waybillNo:面单号,类型:String
arriveTmTips:到店是否超时提示,类型:String
deliveryTmTips:送达是否超时提示,类型:String
goodsMoney:货品金额,类型:String
distanceToDestination:骑手到目的地的距离,类型:String
customerName:收货人姓名,类型:String
getGoodsTmTips:取货时间(同城直送订单),类型:String
isAppointmentOrder:是否是预约单,类型:int
goodsType:货品类型,类型:String
labelList2: [
{
labelText:标签标题,类型:String
labelColor:标签字体颜色,类型:String
bgColor:标签背景颜色,类型:String
labelDesc:标签释义,类型:String
}
...
]
timeAssessList:[
{
assessName:考核名称,例:准点到店时间,类型:string
assessContent:考核内容,例:12:30前,类型:string
reward:奖励,例:奖 ¥2.5:,类型:string
overRewardTime:是否超过奖励时间,类型:boolean
timeover:是否超时,类型:boolean
punishDesc: 处罚描述 例:超时20分钟扣¥5.0,类型String
oldAccessContent:旧考核内容,如:12:40前,类型:String
oldAccessDesc:旧考核描述,如:因接到新的订单,送达时间发生调整 类型:String
},
……
]
}
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/get-finish-reasons.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
orderId:订单Id,类型:String
platformId:渠道ID,类型:int
orderType:订单类型,类型:int
groupId:订单包ID,有就传,没有就不传,类型:String
}
响应消息
{
status: 1,
data:{
reasons:[
{
reasonId:送达原因Id,类型:String
reasonText:送达原因文案,类型:String
title:弹窗标题,类型:String
message:弹窗文案,类型:String
}
...
]
},
msg:""
}
接口描述
完成订单调用该接口。
接口消息定义
请求地址: /rider/finish-order
请求方法: post
请求消息体:
{
...
reasonId:确认送达时选择的原因ID,有就传没有就不传,类型:String
reasonText:原因文案,类型:String
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
totalOrderNum:新手奖励订单总数量,类型:int
finishedOrderNum:已完成的订单总数量,类型:string 当改字段为空时,表示服务器超时,本地不更新
reward:每单的奖励金额,类型:float,一位小数
redPacketReward:红包奖励金额,类型:float
showBanner:是否展示Banner,1:是 0:否 类型:int
successIds:完成的订单号,用逗号分隔,类型:String
},
msg: ""
errorCode:距离超限提示码,类型:int
errorCode:客人未支付提示码,类型:int
}
接口描述
设置异常单:联系不到客人或者客人拒收
接口消息定义
请求地址:/rider/ set-order-abnormal.json
请求方法: get
请求消息体:
{
...
reasonText:异常原因文案,类型:String
...
}
响应消息
{
status: 1,
data:{
successText:提示文案,类型:String
totalOrderNum:新手奖励订单总数量,类型:int
finishedOrderNum:已完成的订单总数量,类型:string 当改字段为空时,表示服务器超时,本地不更新
reward:每单的奖励金额,类型:float,一位小数
showBanner:是否展示Banner,1:是 0:否 类型:int
}
msg:“”
extraMsg:当errorCode=9310时返回弹窗文案
errorCode:距离超限提示码,类型:int
9310:申请报备弹窗
}
接口描述
查询接单区域信息
接口消息定义
请求地址: /rider/get-working-area.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
workingAreaLat:当前工作区域中心点纬度,类型:int
workingAreaLng:当前工作区域中心点经度,类型:int
radius:工作区域半径,类型:double
hasWorkArea:是否已经设定区域,1 已设置,类型:int
markLat:接单区域上方Marker的纬度(工作区域中心点纬度-接单半径占据的纬度), 类型:int
markLng:接单区域上方Marker的经度 类型:int
leftLat:接单范围圆圈最左侧的切点的纬度,
leftLng:接单范围圆圈最左侧切点的经度,
rightLat:接单范围圆圈最右侧的切点的纬度,
rightLng:接单范围圆圈最右侧切点的经度,
bottomLat:接单范围圆圈最下侧的切点的纬度,
bottomLng:接单范围圆圈最下侧的切点的经度,
radiusRange:{
min:最小工作范围半径,类型:double
max:最大工作范围半径,类型:double
defaultRadius:默认半径,类型:double
step:工作范围调整间隔值,类型:double
}
regionCityId:当前region对应的cityId,类型:String
}
msg:错误提示信息,如没有,则为空,类型:String
}
1.异常完成刷新已接单列表
1.1 ftype = 5
1.2 fto = 32
接口描述
查询接单区域信息
接口消息定义
请求地址: /rider/get-virtual-mobile.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id,
orderId:订单ID,类型:String
platformId:渠道ID,类型:String
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
mobile:手机号码,类型:String
}
msg:错误提示信息,如没有,则为空,类型:String
}
** 接口描述
每隔15秒上传一次骑手位置经纬度。
接口消息定义
请求地址: /rider/ upload-position.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
imei:设备号,类型:String
version:版本号,类型:String
token:token,类型:String
locationType:定位类型,类型:int
jumpPoint:是否是跳点,类型:int
}
响应消息
{
status:1,
data:{
isSelf: 是否是自己登录 1 正常登录 0 非自己登录,类型:int
verifyResult: 身份验证通知,类型:String
notSelfText: 别人登陆后的通知,类型:String
verifiedOvertime:审核超时,类型:boolean
orderNotifyList:[
{
orderId:订单ID,类型:String
type:通知类型,1:新订单 2:取消单 3:修改单, 12:离店后取消 13:追加单 类型:int
shopId:商家ID,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
customerAddr:客户地址,类型:String
platformId:渠道id,类型:int
elemeWaybillNo:饿了么运单号,类型:String
income:订单金额,类型:String
voiceMessage:语音播报的内容,类型:String
}
],
lostConnectionNotify:强行休息的通知,类型:String
updateType:0不需要升级 1正常升级 2强制升级,类型:int
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
tips:提示信息,类型:String
orderCellingChangedNotify: 修改接单上限通知,类型:String
riderTypeChangeNotify:骑手身份变更通知,类型:String
cancelOrderPunishNotify:订单取消扣款通知,类型:String
patchUpdateNotify:补丁下发通知,类型:int
forbiddenNotify:禁用 启用通知,格式:1|提示信息,1 禁用 2启用,类型:String
upgradeProtocolNotify:升级协议通知,格式:0|不显示协议浮层,1|显示协议浮层,类型:int
robOrderNotify:有可抢单通知,1 无订单 2 有订单 类型:int
bannerNotify:banner变化通知,1 无变化 2 有变化 类型:int
authResult:认证结果 1:审核成功(仅在审核成功时下发) 2:审核失败(仅在审核失败时下发) 类型:int
agingStatus:时效变更,类型:int,1:已变更,0:未变更,
zcOrderStatus:中车宝联订单状态修改,类型:int,1:审核通过或未通过,0:未变更
weexConfigVersion:weex配置文件版本号,类型:String
weexConfigUrl:weex配置文件下载地址,类型:String
recommendOrderNotify:是否有强推荐订单,类型:int 1:有 0:没有
httpdnsSwitch:是否打开httpdns解析,类型:int 1:打开 0:关闭
dialogNotify:{
imgUrl:弹窗图片URL,类型:String
forwardUrl:点击弹窗进入的h5页面的URL,类型:String
},
residentNotify:{
shopName:驻店商家名称,类型:String
residentTaskId:驻店任务ID,类型:String
}
driftOpen:漂移判定开关是否打开,类型:int
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,类型:int
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-orderhis-list.json
请求方法: post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
currentPage:当前页,类型:int
today:订单类型,0 今日订单 1历史订单,类型:int
}
响应消息
{
status:1,
data:{
todayTotal:今日订单数量,类型:int
historyTotal:历史订单数量,类型:int
pagination:{
currentPage:当前页码,类型:int
pageCount,总页数,类型:int
list:[
{
id:订单id,类型:String
income:收入,类型:String
customerAddr:客户地址,类型:String
distanceToCustomer:距离,类型:String
status:订单状态,类型:String
shopName:商家名,类型:String
shopAddr:商家地址:类型:String
isResident:是否驻店, 类型:boolean
onlinePayStatus:0:不显示,1:显示【线下支付】标签,2:显示【可申诉补款】标签
evaluateStatus:评价商家状态,类型:int,1:评论商家,2:查看评论,
time:订单终结时间,类型:String
如:01月30日 18:30
exception:是否是异常订单,类型:int
0:不是 1:是
}
]
},
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
}
接口描述
抢单,不同于口碑订单的选择订单
接口消息定义
请求地址:/rider/rob-order.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
orderId:订单ID,类型:number
groupId:订单分组,类型:String
platformId:渠道ID,类型:number
lat:经纬度,类型:int
lng:经纬度,类型:int
from:订单来源,类型:String
(1)默认为空表示从待接单列表抢到的订单
(2)recommend表示从强推荐订单列表抢到的订单
forceRob:是否强制抢单,类型:int
默认传0表示不强制,当errorCode=9304并点击“继续接单”后传1表示继续接单
}
响应消息
{
status: 1,
data:{
successText:成功提示文案,类型:string
isBooking:是否预约单,类型:boolean
},
msg:""
extraMsg:当存在errorCode时的文案,类型:String
errorCode: 新增以下枚举值
errorCode = 9300 菜鸟揽件接单 文案:订单异常,请刷新列表后重试
errorCode = 9301 点击接单时其他原因不符 文案:接单失败,请稍后重试
errorCode = 9302 菜鸟揽件接单 文案:系统异常,请刷新列表后重试
errorCode = 9303 抢单服务器接口超时
errorCode = 9304 订单不顺路弹窗提醒,并在extraMsg中返回弹窗文案,类型:String
errorCode = 9305 菜鸟订单抢单时,小件员未认证
errorCode = 9306 保证金充值
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/get-hema-reject-reasons.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
subOrder:是否是子订单,类型:int
0:不是 1:是
}
响应消息
{
status: 1,
data:{
reasons:[
{
reasonId:拒收原因Id,类型:int
reasonText:拒收原因文案,类型:String
}
...
]
},
msg:""
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/get-voice-info.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
voiceUrl:语音URL,类型:String
}
响应消息
{
status: 1,
data:{
voiceMessage:语音内容,类型:String
serialId:流水号,类型:String
},
msg:""
}
接口描述
获取个人信息。
接口消息定义
请求地址: /rider/get-rider-info.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
authenticationStatus:认证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
authenticationInfo:认证信息 类型:String
riderName:姓名,身份认证填写的姓名,类型:String
finishedOrderNumber:完成订单数,类型:String
accumulatedIncome:累计收入,类型:String
balance:余额,类型:String
csTel:客服电话,类型:String
passexamStatus:是否通过考试,类型:int
monthlyIncome:当月收入,类型:String
riderType:骑手身份类型,0 骑手 5 骑士,类型:int
riderLevel:骑手等级,类型:int
5:青铜骑手 10:白银骑手 15:黄金骑手 20:钻石骑手 25:王者骑手
riderLevelText:骑手身份等级,类型:String
amTel:商圈负责人联系方式,类型:String
trainStatus:培训报名状态 类型int
0:不需要弹窗
1:去报名弹窗
2:查看报名信息弹窗
btVisibiliy:赏金任务是否显示,1 显示,类型:int
healthCardText:健康证状态文案,类型:String
equipmentDesc:我的装备描述信息,类型:String
例:完整度1/5
onlineDuration:今日在线时长,如:8小时32分 类型:String
isNewComer:是否是新手,1:是新手 0:不是新手 类型:int
todayJoinedBTNum:赏金任务角标数字,今日开始的任务数,类型:int
targetServiceVisibiliy:定向服务是否显示,1 显示,类型:int
taskCenterUrl:任务中心URL,类型:String
taskCenterSignature:任务中心签名,类型:String
levelInfo:{
currentValue:骑手当前成长值,类型int
totalValue:升级成长值,类型int
levelInfoText:等级提示文案,类型:String
levelQuestionText:等级更新文案,类型String
levelText:等级指标文案,类型:String
如:等级指标(3.5-3.11)
targetTaskLevel:当前任务指标的目标等级,类型:int
5:青铜骑手 10:白银骑手 15:黄金骑手 20:钻石骑手 25:王者骑手
targetList:[ 指标集合
{
targetText:指标文案,类型:String
如:完成单量≥30 派单接单率≥95%
totalProgress:指标完成总进度,类型:int
currentProgress:当前指标完成进度,类型:int
percent:是否是百分比,如果是百分比,则需手动添加“%”,类型:int
0:不是 1:是
reverse:是否需要反转比例值,类型:int
0:否 1:是
}
]
taskDatas:[ 任务集合
{
upgradeTitle:任务描述,类型String
taskText:任务名称,类型:String
如:完成xx培训
buttonText:按钮文案,类型:String
如:已完成,去购买
clickable:按钮是否可以点击,类型:int
0:不可以 1:可以
targetUrl:点击按钮后进入的h5页面的URL,类型:String
mission:[
{
title:“拥有点我达装备”,类型:String
buttonStr:按钮文案,类型:String
finished:true任务已完成|false任务未完成,类型:bool
},
]
},
]
privilegeList:[
{
type:标签背景图片类型,1:橙色五角星, 2:绿色三角形,3:蓝色五角星 4:青色六边形,5紫色正方形
value:标签文案,类型:string
name:标签描述,类型String
newComerPrivilege:是否是新手特权 1:是 0:不是 类型:int
},
]
}
hemaRider:是否有盒马鲜生渠道标签,类型:int
1-有,0-无
},
msg:“”
}
接口描述
等级体系,相应特权
接口消息定义
请求地址:/rider/new-levels.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
}
响应消息
{
status: 1,
data:{
riderLevel:当前等级,类型:int
5:青铜骑手 10:白银骑手 15:黄金骑手 20:钻石骑手 25:王者骑手
examCycle:考核周期,类型:String
isNewComer:是否处于新手期 1:是 0:否 类型:int
bannerMessage:新手期Banner文案,如:新手期(6.28-7.11)享受新手特权 类型:String
levelList:[
{
level:等级,类型:int
rightList:[
{
name:专属特权文案,类型:String
value:特权指数,类型:String
url:跳转url,类型:String
type:标签背景图片类型,类型:int
10:接单上限对应的ICON
11:取消额度对应的ICON
12:提现到账天数对应的ICON
13:提现手续费对应的ICON
dialogMessage:点击后弹窗显示的文案,类型:String
newComerPrivilege:是否是新手期特权,1:是 0:不是 类型:int
privilegeText:新手期特权文案,如:(新手期额度+2) 类型:String
},...
]
}
]
boxInfo:[
{
level:宝箱对应的骑手等级,类型:String
boxName:宝箱名称,类型:String
dialogMessage:点击后弹窗显示的文案,类型:String
}
]
upgradeExplainUrl:怎样升级的url,类型:string
upgradeTips:成长进度条上的文案,类型:String
curValue:当前成长值,类型:int
levelValue:等级成长值,类型:int
levelQuestionText:等级更新文案,类型String
upgradeList:[
{
upgradeTitle:“升级Lv.4 任务”,类型:String
mission:[
{
title:“拥有点我达装备”,类型:String
tip:任务解释,类型:string
buttonStr:按钮文案,类型:String
missionType:任务类型,1:装备购买|2:参加培训
finished:true任务已完成|false任务未完成,类型:bool
},...]
},...]
},
msg:“”
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/get-reward-info.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
riderLevel:当前骑手等级,类型:String
5:青铜骑手 10:白银骑手 15:黄金骑手 20:钻石骑手 25:王者骑手
todayReward:{
reward:今日24点前完成目标的奖励文案,类型:String
targetList:[ 指标集合
{
targetText:指标文案,类型:String
如:完成单量≥30 派单接单率≥95%
totalProgress:指标完成总进度,类型:int
currentProgress:当前指标完成进度,类型:int
percent:是否是百分比,如果是百分比,则需手动添加“%”,类型:int
0:不是 1:是
reverse:是否需要反转比例值,类型:int
0:否 1:是
}
]
receiveEnable:是否可以领取今日奖励(控制领取奖励按钮的状态),类型:int
0:不可以 1:可以
}
boxReward:{ 宝箱奖励
lastWeek:上周结算等级,类型:String
如:黄金骑手(3.3-3.11)
receiveEnable:是否可以领取宝箱奖励(控制领取奖励按钮的状态),类型:int
0:不可以 1:可以
thisWeekReward:本周奖励文案,类型:String
obtainRecords:[ 领取记录
{
time:领取时间,类型:String
如:2018-03-03 12:00:00
rewardName:奖励名称,类型:String
highLightText:高亮文案,类型:String
}
]
}
},
msg:""
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/obtain-reward.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
type:奖励类型:String
1:今日奖励 2:等级宝箱
}
响应消息
{
status: 1,
data:{
dialogMessage:领取成功后的弹窗文案,类型:String
type:奖励类型,类型:int
0:默认类型,显示“我知道了”按钮
1:每单补贴,显示“点击查看”按钮,点击进入我的钱包页面
2:积分奖励,显示“点击查看”按钮,点击进入我的积分页面
3:商城虚拟商品,显示“点击查看”按钮,点击进入骑手商城“我的”页面
4:商城优惠券 | 全额抵扣优惠券,显示“点击查看”按钮,点击进入骑手商城中的“我的优惠券”页面
forwardUrl:点击查看按钮进入的h5页面的URL,类型:String
}
},
msg:""
}
接口描述
获取盒马鲜生订单列表信息接口。
接口消息定义
请求地址: /rider/get-hema-order-list.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
riderStatus:配送员状态,类型:int
1-未签到,5-未到店,10-已到店,15-待配送
riderStatusText:配送员状态文案(操作按钮文案),类型:String
立即签到,到店排队,离店,离店配送
riderStatusTip:配送员状态提示文案
orderList:[{
batchNumber:批次号(例:129383),类型:String
labelText:标签文案(例:已过机),类型:String
requiredTime:时效(例:12:30前送达),类型:String
amount:规格(例:5箱/25个订单),类型:String
status:订单状态,类型:int
5-未接单,10-未扫码取货,15-待配送
statusText:订单状态文案,类型:String
接单,扫码取货,待配送
deliverZone:配送区域,类型:String
},...],
promptList:[{
promptId:顶部提示ID,类型:String
type:顶部提示类型,类型:int
1-不再派单,2-取消/改派
tipText:提示文案(例:你的批次66432已被取消),类型:String
bgColor:背景色(type=1,#ff4d44;type=2,#484850;),类型:String
},...],
},
msg:""
}
接口描述
盒马鲜生驻店配送员到店接口。
接口消息定义
请求地址: /rider/hema-rider-arrival.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
lat:经纬度,类型:int
lng:经纬度,类型:int
}
响应消息
{
status: 1,
data:{
},
msg:""
errorCode:错误码,类型:int
3021:尚未签到,无法到店排队
3022:你的当前位置离商家过远,请前往商家处操作,或重启APP
}
接口描述
盒马鲜生驻店配送员接单接口。
接口消息定义
请求地址: /rider/hema-rider-order.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
batchNumber:批次号(例:129383)
lat:经纬度,类型:int
lng:经纬度,类型:int
}
响应消息
{
status: 1,
data:{
},
msg:""
}
接口描述
盒马鲜生驻店配送员离店接口。
接口消息定义
请求地址: /rider/hema-rider-leave.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
lat:经纬度,类型:int
lng:经纬度,类型:int
}
响应消息
{
status: 1,
data:{
orderListStatus:订单列表订单状态,类型:int
1-没有订单,2-有订单,但没有待配送订单,3-有订单,且有待配送订单
},
msg:""
errorCode:错误码,类型:int
3021:尚未签到,无法离店
}
接口描述
盒马鲜生驻店配送员取消顶部某一条订单提示。
接口消息定义
请求地址: /rider/hema-rider-cancel-prompt.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
lat:经纬度,类型:int
lng:经纬度,类型:int
promptId:提示ID,类型:String
}
响应消息
{
status: 1,
data:{
},
msg:""
}
接口描述(5.1.4)
商家取消订单,请求体加是否确认取消
接口消息定义
请求url:/rider/get-sdk-open.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
nySDKOpen:南邮SDK是否使用,类型:bool
appId: 南邮sdk账号id
appPsd: 南邮sdk 账号密码
}
}
}
接口描述(5.1.4)
商家取消订单,请求体加是否确认取消
接口消息定义
请求url:/rider/get-target-detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
type:指标类型,类型:int
1:完成单量 2:派单接单率 3:准点率 4:违规率
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
numStr:指标完成程度文案(UI图中黑体加粗的数字,如105 | 50%),类型:String
period:考核周期文案,类型:String
如:3月5日-3月11日
statusStr:当前状态字符串,以h5格式返回(有字体颜色),类型:String
如:准点单量:5单 / 完成单量:10单
list:[
{
dateStr:日期,类型:String
list:[
{
title:订单标题,类型:String
如:订单:12356 | 人工调整
message:订单卡片上的信息,类型:String
如:工单事项 | 12:09:10接单 等
timeStr:订单时间文案,根据状态添加一些文案,类型:String
如:12:256:10 异常 | 12:12:10 被投诉
label:右下角标签文案,类型:String
如:违规单+1 | 准点单+1
}
]
}
]
}
}
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: GET
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
sortType:订单排序类型,0 默认时间点排序,1 商家排序,2 订单号排序 类型:int
}
响应消息
{
status:1,
data:{
riderStatus:骑手状态,类型:int
0:休息中,5:工作中,99:禁用
verifiedStatus:认证状态,类型:int
0:未认证 5:审核中 9:未通过 10:已认证
tips:提示文案,类型:String
btnText:按钮文案,类型:String
unTerminativeOrderNum:订单数量,类型:int
arriveThreshold:到店阈值,类型:long
verifiedOvertime:是否审核超时,类型:boolean
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
orderList:[ 订单列表
{
id:订单Id,类型:String
groupId:订单组ID,类型:String
orderCount:接单的订单总数量,类型:int
orderScanned:是否有订单已经被扫码核验,类型:int
0:没有 1:有
income:收入,类型:String
advance:垫付金额,类型:String
customerAddr:收货地址,类型:String
status:订单状态,类型:int
typeStatus:录入状态,类型:int
0:未录入 5:未拍小票 10:已录入 15:已取货 99:未选择订单
redPacket:是否是红包订单,类型:int
0:不是 1:是
type:列表数据类型,类型:int(0:真实订单)
btnValue:按钮状态,类型:int
4:到店并拍摄小票
5:我已到店|取货| 全部到店
10:录入新订单
15:还有订单未拍小票| 扫码核验
20:离店配送| 全部离店
22:拍摄货物图片
23:全部妥投
25:货品送达| 全部回执送达
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
btnText:状态文案,类型:String
sinceObtained:配送时长,类型:long
customerTel:收货人联系方式,类型:String
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
urge:是否催单,类型:int
serialId:订单序号,类型:String
simpleSerialId:订单流水号,(不包含渠道名称和#号)类型:String
punctualTm:准点奖励要求时间,类型:String
labelList:[
{
code:标签Code,类型:int
title:标签标题,类型:String
desc:标签文案,类型:String
type:标签样式类型,类型:int
}
...
]
requireTm:要求送达时间,类型:String
requireTm2:要求送达时间,类型:long
serviceTm:服务器当前时间,类型:long
punctualAmount:准点奖励金额,类型:String
collection:代收,类型:String
collection2:代收金额,类型:double
punctualTm2:准点奖励要求时间,类型:long
searchText:用于订单搜索的字段,类型:String
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
elemeWaybillNo:饿了么运单号,类型:String
shopInfo:{
shopId:商家ID,类型:String
shopAddr:发货地址,类型:String
shopName:商家名称,类型:String
orderNum:订单数量,类型:int
channel:是否是渠道单
0:非渠道单 1:渠道单
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
shopTel:商家电话,类型:String
notTyped:未录入订单ID,类型:List
notObtained:未离店订单ID,类型:List
remainTime:到店剩余时间,类型:long
finishedNum:当前完成商家订单数,类型:int
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
platformName:渠道名称,类型:String
}
isAppointmentOrder:是否是预约单,类型:int
payStatus:支付状态,类型:int
0:默认值,无意义
1:未支付
2:线上支付
3:线下支付
totalIncome:预计收入汇总值(预计收入+小费+困难单奖励),类型:String
orderOvertime:到店或者送达超时标识,类型:boolean
punishDesc:处罚文案 类型String 例:超时20分钟扣¥5.0
}
...
]
distanceToCustomer:配送距离,类型:String
leaveTm:离店时间,类型:long
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:未支付金额,类型:double
dispatchMode:调度模式,类型:int
1:系统派单
2:抢单
3:人工派单
4:分组派单
5:扫码抢单
contractType:驻店模式,类型:int
0:非驻店
1:全驻店
2:半驻店
arriveTm:到店时间,类型:long
onlinePayType:在线支付类型,类型:int
0:不区分线上线下支付
1:线下支付
2:线上支付
paidAmount:客人已支付金额,类型:float
customerName:客人姓名,类型:String
notifyList:{
fetchTimeOut:取货/到店超时时间点,类型:long
deliveryTimeOut:送达超时时间点,类型:long
}
distanceToShop:骑手到商家的距离,类型:String
fetchRequireTm:应取货时间,类型:String
remainDeliveryTime:应送达时间倒计时,类型:int
remainFetchTime:要求取货时间倒计时,类型:int
platformId:渠道ID,类型:int
新增盒马订单渠道,72
newLabelList:[
{
labelText:标签文案,类型:String
labelColor:标签字体颜色,如:“#fe751a”,类型:String
bgColor:标签背景颜色,如:“#fe751a”,类型:String
}
...
]
fee:小费
}
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: GET
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
sortType:订单排序类型,0 默认时间点排序,1 商家排序,2 订单号排序 类型:int
}
响应消息
{
status:1,
data:{
riderStatus:骑手状态,类型:int
0:休息中,5:工作中,99:禁用
verifiedStatus:认证状态,类型:int
0:未认证 5:审核中 9:未通过 10:已认证
tips:提示文案,类型:String
btnText:按钮文案,类型:String
unTerminativeOrderNum:订单数量,类型:int
arriveThreshold:到店阈值,类型:long
verifiedOvertime:是否审核超时,类型:boolean
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
orderList:[ 订单列表
{
id:订单Id,类型:String
groupId:订单组ID,类型:String
orderCount:接单的订单总数量,类型:int
orderScanned:是否有订单已经被扫码核验,类型:int
0:没有 1:有
income:收入,类型:String
advance:垫付金额,类型:String
customerAddr:收货地址,类型:String
status:订单状态,类型:int
typeStatus:录入状态,类型:int
0:未录入 5:未拍小票 10:已录入 15:已取货 99:未选择订单
redPacket:是否是红包订单,类型:int
0:不是 1:是
type:列表数据类型,类型:int(0:真实订单)
btnValue:按钮状态,类型:int
4:到店并拍摄小票
5:我已到店|取货| 全部到店
10:录入新订单
15:还有订单未拍小票| 扫码核验
20:离店配送| 全部离店
22:拍摄货物图片
23:全部妥投
25:货品送达| 全部回执送达
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
btnText:状态文案,类型:String
sinceObtained:配送时长,类型:long
customerTel:收货人联系方式,类型:String
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
urge:是否催单,类型:int
serialId:订单序号,类型:String
simpleSerialId:订单流水号,(不包含渠道名称和#号)类型:String
punctualTm:准点奖励要求时间,类型:String
labelList:[
{
code:标签Code,类型:int
title:标签标题,类型:String
desc:标签文案,类型:String
type:标签样式类型,类型:int
}
...
]
requireTm:要求送达时间,类型:String
requireTm2:要求送达时间,类型:long
serviceTm:服务器当前时间,类型:long
punctualAmount:准点奖励金额,类型:String
collection:代收,类型:String
collection2:代收金额,类型:double
punctualTm2:准点奖励要求时间,类型:long
searchText:用于订单搜索的字段,类型:String
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
elemeWaybillNo:饿了么运单号,类型:String
shopInfo:{
shopId:商家ID,类型:String
shopAddr:发货地址,类型:String
shopName:商家名称,类型:String
orderNum:订单数量,类型:int
channel:是否是渠道单
0:非渠道单 1:渠道单
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
shopTel:商家电话,类型:String
notTyped:未录入订单ID,类型:List
notObtained:未离店订单ID,类型:List
remainTime:到店剩余时间,类型:long
finishedNum:当前完成商家订单数,类型:int
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
platformName:渠道名称,类型:String
}
isAppointmentOrder:是否是预约单,类型:int
payStatus:支付状态,类型:int
0:默认值,无意义
1:未支付
2:线上支付
3:线下支付
totalIncome:预计收入汇总值(预计收入+小费+困难单奖励),类型:String
orderOvertime:到店或者送达超时标识,类型:boolean
punishDesc:处罚文案 类型String 例:超时20分钟扣¥5.0
}
...
]
distanceToCustomer:配送距离,类型:String
leaveTm:离店时间,类型:long
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:未支付金额,类型:double
dispatchMode:调度模式,类型:int
1:系统派单
2:抢单
3:人工派单
4:分组派单
5:扫码抢单
contractType:驻店模式,类型:int
0:非驻店
1:全驻店
2:半驻店
arriveTm:到店时间,类型:long
onlinePayType:在线支付类型,类型:int
0:不区分线上线下支付
1:线下支付
2:线上支付
paidAmount:客人已支付金额,类型:float
customerName:客人姓名,类型:String
notifyList:{
fetchTimeOut:取货/到店超时时间点,类型:long
deliveryTimeOut:送达超时时间点,类型:long
}
distanceToShop:骑手到商家的距离,类型:String
fetchRequireTm:应取货时间,类型:String
remainDeliveryTime:应送达时间倒计时,类型:int
remainFetchTime:要求取货时间倒计时,类型:int
platformId:渠道ID,类型:int
新增盒马订单渠道,72
newLabelList:[
{
labelText:标签文案,类型:String
labelColor:标签字体颜色,如:“#fe751a”,类型:String
bgColor:标签背景颜色,如:“#fe751a”,类型:String
}
...
]
fee:小费
}
}
接口描述
获取个人信息。
接口消息定义
请求地址: /rider/get-rider-info.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
authenticationStatus:认证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
authenticationInfo:认证信息 类型:String
riderName:姓名,身份认证填写的姓名,类型:String
finishedOrderNumber:完成订单数,类型:String
accumulatedIncome:累计收入,类型:String
balance:余额,类型:String
csTel:客服电话,类型:String
passexamStatus:是否通过考试,类型:int
monthlyIncome:当月收入,类型:String
riderType:骑手身份类型,0 骑手 5 骑士,类型:int
riderLevel:骑手等级,类型:int
5:青铜骑手 10:白银骑手 15:黄金骑手 20:钻石骑手 25:王者骑手
riderLevelText:骑手身份等级,类型:String
amTel:商圈负责人联系方式,类型:String
trainStatus:培训报名状态 类型int
0:不需要弹窗
1:去报名弹窗
2:查看报名信息弹窗
btVisibiliy:赏金任务是否显示,1 显示,类型:int
healthCardText:健康证状态文案,类型:String
equipmentDesc:我的装备描述信息,类型:String
例:完整度1/5
onlineDuration:今日在线时长,如:8小时32分 类型:String
isNewComer:是否是新手,1:是新手 0:不是新手 类型:int
todayJoinedBTNum:赏金任务角标数字,今日开始的任务数,类型:int
targetServiceVisibiliy:定向服务是否显示,1 显示,类型:int
taskCenterUrl:任务中心URL,类型:String
taskCenterSignature:任务中心签名,类型:String
levelInfo:{
levelText:等级指标文案,类型:String
如:等级指标(3.5-3.11)
targetTaskLevel:当前任务指标的目标等级,类型:int
5:青铜骑手 10:白银骑手 15:黄金骑手 20:钻石骑手 25:王者骑手
targetList:[ 指标集合
{
targetText:指标文案,类型:String
如:完成单量≥30 派单接单率≥95%
totalProgress:指标完成总进度,类型:int
currentProgress:当前指标完成进度,类型:int
percent:是否是百分比,如果是百分比,则需手动添加“%”,类型:int
0:不是 1:是
reverse:是否需要反转比例值,类型:int
0:否 1:是
}
]
taskDatas:[ 任务集合
{
taskText:任务名称,类型:String
如:完成xx培训
buttonText:按钮文案,类型:String
如:已完成,去购买
clickable:按钮是否可以点击,类型:int
0:不可以 1:可以
targetUrl:点击按钮后进入的h5页面的URL,类型:String
},
]
privilegeList:[
{
type:标签背景图片类型,1:橙色五角星, 2:绿色三角形,3:蓝色五角星 4:青色六边形,5紫色正方形
value:标签文案,类型:string
name:标签描述,类型String
newComerPrivilege:是否是新手特权 1:是 0:不是 类型:int
},
]
}
hemaRider:是否有盒马鲜生渠道标签,类型:int
1-有,0-无
riderStationIsOpen:该城市是否开通骑手驿站,类型:int
1-开通,0-无
},
msg:“”
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/get-balance-log.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
currentPage:当前页,类型:number
filterState:筛选状态,类型:int
0:全部状态 1:已审核 2:审核中
filterType:筛选类型,类型:int
0:全部类型
10:配送费 20:奖励 30:其他收入
40:违规扣款 50:购买保险 60:提现 70:购买装备 80:其他支出
filterDate:年月(例:“201803”),类型:String
为空时,默认请求当前年月
}
响应消息
{
status: 1,
data:{
currentPage:当前页码,类型:int
pageCount,总页数,类型:int
currentDateText:当前年月(例:2018年3月),类型:String
//当请求数据filterDate为空时,输出最近6个月的年月数据dateList;
dateList [{
yearAndMonth:年月(例:201803),类型:String
yearAndMonthText:年月(例:2018年3月),类型:String
}
],
list:[
{
tradeId:交易Id,类型:String
tradeMoney:交易金额,类型:String
tradeType:交易类型,类型:String 1收入 -1支出
tradeName:交易名称,类型:String
tradeTime:交易时间,类型:String
subtitle:备注,类型:String
tradeClassify:冻结类型 违规冻结:30,类型:int
tradeNumber:订单编号,类型:String
templateType:模板类型,类型:int 1订单相关 2特殊条目 3提现 4违规扣除
tradeDate:交易日期,“今日\r\n13:00”,类型:String
}
...
]
},
msg:””
}
接口描述
查新通知中心列表数据
接口消息定义
请求地址:/rider/view-notify-list.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
categoryId:0 分类id,类型:int -1 获取全部消息,0系统消息,2管理规则,3活动消息,4培训,5,计费调整,6违规扣款,7其他
lastNotifyId:2323 新增分页参数,第一次请求不传该参数,后面的请求传最后一条数据的id
client: 客户端类型.android或者ios
}
响应消息
{
status: 1,
data:{
currentPage:当前页,类型:int
pageCount:总页数,类型:int
list:[{
id:通知ID,类型:int
title:通知标题,类型:String
content:通知副标题,类型:String
time:时间,类型:String
isRead:通知是否已读,1 已读,类型:int
url:通知连接,类型:String
categoryId:通知类别, 类型:int
labelText:标签文案(目前只支持一个标签),如:"重要",类型:String
routerType:跳转类型,类型:int
0-外部链接;
1-我的装备;
2-我的积分;
3-骑手商城;
4-任务中心;
5-推广赚钱;
6-达人学院;
},
],
},
msg:“”
}
接口描述
选择接单区域后开始接单
接口消息定义
请求地址: /rider/come-to-work.json
请求方法: post
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
workingAreaLat:接单区域中心点纬度,类型:int
workingAreaLng:接单区域中心点经度,类型:int
radius:接单区域半径,类型:double
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
statusText:工作状态文案,类型:String
hasWorkArea:是否已经设定区域 0 未设置 1 已设置,类型:int
radiusRange:{
min:最小工作范围半径,类型:double
max:最大工作范围半径,类型:double
defaultRadius:默认半径,类型:double
step:工作范围调整间隔值,类型:double
}
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:错误码,
9002:账号禁用,类型:int
9600:展示新手引导弹窗
}
接口描述
退出登录
接口消息定义
请求地址:/rider/check-app-update.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
version:版本号
patchVersion:patch版本号
source:手机型号
client:系统版本号
systemCode:应用编码
interfaceVersion:app接口版本号,类型:String
如:"v44"
}
响应消息
{
status: 1,
data:{
latestVersion:最新应用版本,类型:String
url:应用下载地址,类型:String
md5:patch的md5值,类型:String
updateType:升级模式,类型:int
0:不需要升级
1:正常升级
2:强制升级(有进行中订单不显示更新弹窗)
3:下载补丁
4:立即更新(无论是否有进行中订单,都立即更新)
tips:更新文案,类型:String
apkMd5:apk的md5值,用于校验本地下载的apk是否完整
weexConfigVersion:weex配置文件版本号,类型:String
weexConfigUrl:weex配置文件下载地址,类型:String
},
msg:“”
}
** 接口描述
每隔15秒上传一次骑手位置经纬度。
接口消息定义
请求地址: /rider/ upload-position.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
imei:设备号,类型:String
version:版本号,类型:String
token:token,类型:String
locationType:定位类型,类型:int
jumpPoint:是否是跳点,类型:int
}
响应消息
{
status:1,
data:{
isSelf: 是否是自己登录 1 正常登录 0 非自己登录,类型:int
verifyResult: 身份验证通知,类型:String
notSelfText: 别人登陆后的通知,类型:String
verifiedOvertime:审核超时,类型:boolean
orderNotifyList:[
{
orderId:订单ID,类型:String
type:通知类型,1:新订单 2:取消单 3:修改单, 12:离店后取消 13:追加单 类型:int
shopId:商家ID,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
customerAddr:客户地址,类型:String
platformId:渠道id,类型:int
elemeWaybillNo:饿了么运单号,类型:String
income:订单金额,类型:String
voiceMessage:语音播报的内容,类型:String
}
],
lostConnectionNotify:强行休息的通知,类型:String
updateType:升级模式,类型:int
0:不需要升级
1:正常升级
2:强制升级(有进行中订单不显示更新弹窗)
3:下载补丁
4:立即更新(无论是否有进行中订单,都立即更新)
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
tips:提示信息,类型:String
orderCellingChangedNotify: 修改接单上限通知,类型:String
riderTypeChangeNotify:骑手身份变更通知,类型:String
cancelOrderPunishNotify:订单取消扣款通知,类型:String
patchUpdateNotify:补丁下发通知,类型:int
forbiddenNotify:禁用 启用通知,格式:1|提示信息,1 禁用 2启用,类型:String
upgradeProtocolNotify:升级协议通知,格式:0|不显示协议浮层,1|显示协议浮层,类型:int
robOrderNotify:有可抢单通知,1 无订单 2 有订单 类型:int
bannerNotify:banner变化通知,1 无变化 2 有变化 类型:int
authResult:认证结果 1:审核成功(仅在审核成功时下发) 2:审核失败(仅在审核失败时下发) 类型:int
agingStatus:时效变更,类型:int,1:已变更,0:未变更,
zcOrderStatus:中车宝联订单状态修改,类型:int,1:审核通过或未通过,0:未变更
weexConfigVersion:weex配置文件版本号,类型:String
weexConfigUrl:weex配置文件下载地址,类型:String
recommendOrderNotify:是否有强推荐订单,类型:int 1:有 0:没有
httpdnsSwitch:是否打开httpdns解析,类型:int 1:打开 0:关闭
dialogNotify:{
imgUrl:弹窗图片URL,类型:String
forwardUrl:点击弹窗进入的h5页面的URL,类型:String
},
residentNotify:{
shopName:驻店商家名称,类型:String
residentTaskId:驻店任务ID,类型:String
}
driftOpen:漂移判定开关是否打开,类型:int
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,类型:int
}
接口描述
获取餐品信息
接口消息定义
请求地址:/rider/view-order-foods.json
请求方法: get
请求消息体:
{
cityId
riderId
orderId
history: 0或1,表示当日订单(0)或历史订单(1)
}
响应消息
{
status:1,
data:{
foodList:[
{
name:餐品名称,类型:String
quantity:数量,类型:int
price:单个商品总价,类型:double
}
],
changedFoodList:[
{
name:餐品名称,类型:String
quantity:数量,类型:int
price:单个商品总价,类型:double
}
]
},
msg:""
}
接口描述
获取订单详细信息
接口消息定义
请求地址:/rider/view-order-detail.json
请求方法: GET
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
history:是否是历史订单,类型:boolean
terminalTm:订单时间,类型:String
lat:纬度,类型:int
lng:经度,类型:int
from:打开订单详情的入口来源(非抢单列表进入时传0),类型:int
1:待抢单列表
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
id:订单ID
idStr:用于展示的ID字符串,类型:String
groupId:订单组ID,类型:String
groupIdStr:用于展示的订单组编号,类型:String
shopAddr:商家地址,类型:String
shopTel:商家电话,类型:String
shopName:商家名称,类型:String
customerAddr:客人地址,类型:String
customerTel:客人电话,类型:String
distributingfee:配送费,类型:String
subsidyfee:补贴,类型:String
payPrice:向发货方支付金额,类型:String
chargePrice:向发货方收取配送费,类型:String
status:订单状态,类型:int
btnText:按钮文案
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
remark:备注,类型:String
chargeUserPrice:向用户收取,类型:String
dispatchTm:派单时间,类型:String
ticketUrl:小票URL,类型:String
incomeInfo2: {
"totalIncomeList": [{
"incomeList": [{
"incomeDetailList": [{
"name": "到店收入",
"income": "¥ 7.0"
}, {
"name": "送达收入",
"income": "¥ 1.0"
}],
"name": "配送收入",
"income": "¥ 8.0",
"type": 1
}
...
],
"name": "收入",
"incomeMsg": "",
"ruleUrl": "http://60.191.68.46:19088/h5/billingNew.html?cityId=1&orderId=144982&riderId=30247"
type:收入类型,类型:int
0:其他 1:收入
}
...
],
"incomeMsg": "",
"totalIncome2": "¥ 12.0",
"totalFee": "",
"totalIntegral": "4",
"totalIncome3": ""
}
arriveConsume:到店用时,类型:long
deliveryConsume:配送剩余时间,类型:long
hasArrived:是否已到店,类型:boolean
punctualRewardText:订单准点奖励文案,类型:String
timeout:是否超时,类型:int
outOfDispatchingRange:是否超距,类型:int
distanceForFee:配送范围,类型:String
leaveTm:离店时间,类型:String
finishTm:完成时间,类型:String
tradingAreaName:订单所属商圈,类型:String
orderCancelReason:订单取消原因,类型:String
cancelPunishment:取消惩罚,类型:String
changePhone:客人是否修改了手机号,类型:int
0:未修改 1:已修改
orderAbnormal:是否展示无法配送原因横条,类型:int
0:不展示 1:展示
orderAbnormalId:无法配送生成的工单ID,类型:String
appealStatusText:申诉状态文案,类型:String
appealId:申诉ID,类型:String
complaintStatusText:投诉状态文案
complaintId:投诉ID,类型:String
punishDate:订单取消惩罚时间,类型:String
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
stockOut:是否缺货,1-缺货 0-未缺货 类型:int
difference:货品是否有差异 1-有差异 0-无差异 类型:int
balanceInfo:结算信息集合
hasFoodInfo:是否存在餐品信息,类型:int
collection:代收,类型:double
isResident:是否驻店,类型:int
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:客人未支付金额,类型:double
dispatchMode:调度模式,类型:int
contractType:驻店模式,类型:int
onlinePayType:支付模式,类型:int
paidAmount:客人已支付金额,类型:double
orderIncomeRuleUrl:订单收入规则URL
shopId:商家ID,类型:String
deliveredTm:妥投时间,类型:String
orderScanned:是否有订单已经被扫码核验,类型:int
0:没有 1:有
requireTm:应送达时间,类型:String
fetchRequireTm:应取货时间,类型:String
foodsReady:商家是否已出餐,类型:boolean
true:已出餐 false:未出餐
foodsReadyReported:是否已举报商家未出餐,类型:boolean
true:已举报 false:未举报
channelId:渠道订单号,类型:String
agingText:订单时效文案,类型:String
expressCount:面单总数量,类型:int
canceledOrderCount:已被取消的订单数量,类型:int
notScannedOrderCount:未扫码的订单数量,类型:int
orderCount:接单的订单总数量,类型:int
btnValue:按钮状态,类型:int
4:到店并拍摄小票
5:我已到店|取货| 全部到店
10:录入新订单
15:还有订单未拍小票|扫码核验
20:离店配送| 全部离店
22:拍摄货物图片
23:全部妥投
25:货品送达| 全部回执送达
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
predictIncome:预计收入,类型:String
distanceToShop:骑手到商家的距离,类型:String
distanceToCustomer:骑手到客人的距离,类型:String
weight:重量,类型:String
punctualRewardMoney:准点奖励金额,类型:String
punctualRewardRequireTm:准点奖励要求送达时间,类型:String
fee:小费,类型:String
arriveTm:到店时间,类型:String
getGoodsTm:取货时间,类型:String
cancelGoodsTm:取消时间,类型:String
waybillNo:面单号,类型:String
arriveTmTips:到店是否超时提示,类型:String
deliveryTmTips:送达是否超时提示,类型:String
goodsMoney:货品金额,类型:String
distanceToDestination:骑手到目的地的距离,类型:String
customerName:收货人姓名,类型:String
getGoodsTmTips:取货时间(同城直送订单),类型:String
isAppointmentOrder:是否是预约单,类型:int
goodsType:货品类型,类型:String
labelList2: [
{
labelText:标签标题,类型:String
labelColor:标签字体颜色,类型:String
bgColor:标签背景颜色,类型:String
labelDesc:标签释义,类型:String
}
...
]
timeAssessList:[
{
assessName:考核名称,例:准点到店时间,类型:string
assessContent:考核内容,例:12:30前,类型:string
reward:奖励,例:奖 ¥2.5:,类型:string
overRewardTime:是否超过奖励时间,类型:boolean
timeover:是否超时,类型:boolean
punishDesc: 处罚描述 例:超时20分钟扣¥5.0,类型String
oldAccessContent:旧考核内容,如:12:40前,类型:String
oldAccessDesc:旧考核描述,如:因接到新的订单,送达时间发生调整 类型:String
},
……
]
}
}
接口描述
获取所有订单经纬度。
接口消息定义
请求地址: /rider/get-route.json
请求方法: post
请求消息体:
{
riderId:骑士Id,类型:String
cityId:城市Id,类型:String
lat:当前骑手所在位置的纬度,类型:int
lng:当前骑手所在位置的经度,类型:int
}
响应消息
{
status: 1,
data:{
open:是否显示推荐路线开关,类型:int
0:不显示 1:显示
timeout:获取推荐路线是否超时,类型:int
0:否 1:是
route: [
{
lat:纬度,类型:String
lng:经度,类型:String
type: 用户点10,商家点5,类型:int
name:商家名或者客人名称,类型:String
address:地址,类型:String
isGot:是否已取 0 未取 1 已取,类型:int
orderId:订单ID,类型:String
dispatchMode:订单模式,类型:int
1:派单模式 2:抢单模式
},
]
orderedRoutes:[ //按照顺序排列好的路线集合
{
lat:纬度,类型:String
lng:经度,类型:String
type: 用户点10,商家点5,类型:int
name:商家名或者客人名称,类型:String
address:地址,类型:String
isGot:是否已取 0 未取 1 已取,类型:int
orderId:订单ID,类型:String
dispatchMode:订单模式,类型:int
1:派单模式 2:抢单模式
}
]
existOtherType:是否存在除外卖单以外的其他订单类型,类型:int
0:bu
},
msg:” ”
}
接口描述
查询是否可以免责取消
接口消息定义
请求地址:/rider/order-cancelable.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
orderId:订单Id,类型:String
}
响应消息
{
status: 1,
data:{
isOrderCancelable:订单是否可以取消,类型:boolean
restSeconds:剩余的免责取消时间,类型:int
isCountDown:是否有倒计时,1:有倒计时 0:无倒计时,类型:int
idStr:用来展示的订单ID字符串,类型:String
isExceedLimit:是否超过免费取消额度,类型:int
0:不超过 1:超过
deductedMoney:超出额度后取消订单需扣除的费用,类型:String
title:取消文案标题,类型:String
message:取消文案内容,以html的格式返回(部分文案有颜色差异)类型:String
},
],
},
msg:“”
}
** 接口描述
每隔15秒上传一次骑手位置经纬度。
接口消息定义
请求地址: /rider/ upload-position.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
lat:经纬度,类型:int
lng:经纬度,类型:int
imei:设备号,类型:String
version:版本号,类型:String
token:token,类型:String
locationType:定位类型,类型:int
jumpPoint:是否是跳点,类型:int
}
响应消息
{
status:1,
data:{
isSelf: 是否是自己登录 1 正常登录 0 非自己登录,类型:int
verifyResult: 身份验证通知,类型:String
notSelfText: 别人登陆后的通知,类型:String
verifiedOvertime:审核超时,类型:boolean
orderNotifyList:[
{
orderId:订单ID,类型:String
type:通知类型,1:新订单 2:取消单 3:修改单, 12:离店后取消 13:追加单 类型:int
shopId:商家ID,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
customerAddr:客户地址,类型:String
platformId:渠道id,类型:int
elemeWaybillNo:饿了么运单号,类型:String
income:订单金额,类型:String
voiceMessage:语音播报的内容,类型:String
}
],
lostConnectionNotify:强行休息的通知,类型:String
updateType:升级模式,类型:int
0:不需要升级
1:正常升级
2:强制升级(有进行中订单不显示更新弹窗)
3:下载补丁
4:立即更新(无论是否有进行中订单,都立即更新)
url:更新下载地址,类型:String
latestVersion:最新版本号,类型:String
tips:提示信息,类型:String
orderCellingChangedNotify: 修改接单上限通知,类型:String
riderTypeChangeNotify:骑手身份变更通知,类型:String
cancelOrderPunishNotify:订单取消扣款通知,类型:String
patchUpdateNotify:补丁下发通知,类型:int
forbiddenNotify:禁用 启用通知,格式:1|提示信息,1 禁用 2启用,类型:String
upgradeProtocolNotify:升级协议通知,格式:0|不显示协议浮层,1|显示协议浮层,类型:int
robOrderNotify:有可抢单通知,1 无订单 2 有订单 类型:int
bannerNotify:banner变化通知,1 无变化 2 有变化 类型:int
authResult:认证结果 1:审核成功(仅在审核成功时下发) 2:审核失败(仅在审核失败时下发) 类型:int
agingStatus:时效变更,类型:int,1:已变更,0:未变更,
zcOrderStatus:中车宝联订单状态修改,类型:int,1:审核通过或未通过,0:未变更
weexConfigVersion:weex配置文件版本号,类型:String
weexConfigUrl:weex配置文件下载地址,类型:String
recommendOrderNotify:是否有强推荐订单,类型:int 1:有 0:没有
httpdnsSwitch:是否打开httpdns解析,类型:int 1:打开 0:关闭
dialogNotify:{
imgUrl:弹窗图片URL,类型:String
forwardUrl:点击弹窗进入的h5页面的URL,类型:String
},
residentNotify:{
shopName:驻店商家名称,类型:String
residentTaskId:驻店任务ID,类型:String
}
driftOpen:漂移判定开关是否打开,类型:int
wsOpen:WebSocket开关是否打开,类型:int
1:开启(默认开启) 2:关闭
hemaDispatch:盒马新派批次,类型:int
0:否 1:是
hemaChecked:盒马批次已过机,类型:int
0:否 1:是
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
errorCode:错误码,类型:int
}
接口描述
接收通知反馈
接口消息定义
请求地址:/rider/receive-notify.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:用户名,骑士Id,类型:String
receiveOrderNotify:接收订单变更通知,类型:int
receiveKickImeiNotify:退出登录通知,类型:int
receiveLostConnectionNotify:掉线通知,类型:int
receiveVerifyNotify:身份审核通知,类型:int
receiveRiderTypeChangeNotify:骑手身份变更通知,类型:int
receiveLimitedNumberChanged:骑士接单上限通知,类型:int
receiveCancelOrderNotify:取消订单扣款通知,类型:int
receiveForbiddenNotify:禁用及启用通知,类型:int
receiveOrderIds:接收订单通知ID,类型:String
receiveBannerNotify:banner变化通知,1-收到,0-未收到,类型:int
receiveRecommendOrderNotify:收到强推荐订单通知,类型:int
receiveDialogNotify:收到弹窗提醒通知,类型:int
receiveResident:收到驻店任务通知,类型:int
receiveHemaDispatch:收到盒马新派批次通知,类型:int
receiveHemaChecked:收到盒马批次过机通知,类型:int
}
响应消息
{
status: 1,
data:””
msg:“”
}
接口描述
获取个人信息。
接口消息定义
请求地址: /rider/get-rider-info.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
authenticationStatus:认证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
authenticationInfo:认证信息 类型:String
riderName:姓名,身份认证填写的姓名,类型:String
finishedOrderNumber:完成订单数,类型:String
accumulatedIncome:累计收入,类型:String
balance:余额,类型:String
csTel:客服电话,类型:String
passexamStatus:是否通过考试,类型:int
monthlyIncome:当月收入,类型:String
riderType:骑手身份类型,0 骑手 5 骑士,类型:int
riderLevel:骑手等级,类型:int
5:青铜骑手 10:白银骑手 15:黄金骑手 20:钻石骑手 25:王者骑手
riderLevelText:骑手身份等级,类型:String
amTel:商圈负责人联系方式,类型:String
trainStatus:培训报名状态 类型int
0:不需要弹窗
1:去报名弹窗
2:查看报名信息弹窗
btVisibiliy:赏金任务是否显示,1 显示,类型:int
healthCardText:健康证状态文案,类型:String
equipmentDesc:我的装备描述信息,类型:String
例:完整度1/5
onlineDuration:今日在线时长,如:8小时32分 类型:String
isNewComer:是否是新手,1:是新手 0:不是新手 类型:int
todayJoinedBTNum:赏金任务角标数字,今日开始的任务数,类型:int
targetServiceVisibiliy:定向服务是否显示,1 显示,类型:int
taskCenterUrl:任务中心URL,类型:String
taskCenterSignature:任务中心签名,类型:String
levelInfo:{
levelText:等级指标文案,类型:String
如:等级指标(3.5-3.11)
targetTaskLevel:当前任务指标的目标等级,类型:int
5:青铜骑手 10:白银骑手 15:黄金骑手 20:钻石骑手 25:王者骑手
targetList:[ 指标集合
{
targetText:指标文案,类型:String
如:完成单量≥30 派单接单率≥95%
totalProgress:指标完成总进度,类型:int
currentProgress:当前指标完成进度,类型:int
percent:是否是百分比,如果是百分比,则需手动添加“%”,类型:int
0:不是 1:是
reverse:是否需要反转比例值,类型:int
0:否 1:是
}
]
taskDatas:[ 任务集合
{
taskText:任务名称,类型:String
如:完成xx培训
buttonText:按钮文案,类型:String
如:已完成,去购买
clickable:按钮是否可以点击,类型:int
0:不可以 1:可以
targetUrl:点击按钮后进入的h5页面的URL,类型:String
},
]
privilegeList:[
{
type:标签背景图片类型,1:橙色五角星, 2:绿色三角形,3:蓝色五角星 4:青色六边形,5紫色正方形
value:标签文案,类型:string
name:标签描述,类型String
newComerPrivilege:是否是新手特权 1:是 0:不是 类型:int
},
]
}
hemaRider:是否有盒马鲜生渠道标签,类型:int
1-有,0-无
riderStationIsOpen:该城市是否开通骑手驿站,类型:int
1-开通,0-无
expressIsOpen:菜鸟仓配是否开通,类型:int
1-开通,0-无
},
msg:“”
}
接口描述
查询是否可以免责取消
接口消息定义
请求地址:/rider/delivery/createOrder
请求方法: get
请求消息体:
{
expressCode:运单号,类型:String
platformId:订单渠道ID,类型:String
transporterId:运力需求Id,类型:String
recordType:录入来源,类型:int
1:扫码录入 2:手动录入
lat:当前位置的纬度,类型:int
lng:当前位置的经度,类型:int
step:校验步骤,类型:int
1:初始请求步骤 2:确认过快递公司步骤
}
响应消息
{
status: 1,
data:{
successText:录入成功的文案,类型:String
}
msg:“”
}
接口描述
查询骑手的待处理订单
接口消息定义
请求地址: /api/rider/cainiao/process
请求方法: GET
请求消息体:
{
lat: '经度',
lng: '纬度',
size: '分页大小,默认20',
from: '起始页码,从0开始,默认0',
waybillNo: '面单号后4位'
}
响应消息体:
{
status: '响应状态,0失败,1成功',
// status 为 0 时存在
msg: '错误消息提示',
// status 为 1 时存在
data: [
{
code: '订单号',
waybillNo: '面单号'
toName: '收货人姓名',
toTel: '收货人手机号码',
toAddr: '收货人地址',
distance: '收货地址距离',
deadline: '截止时间',
status: '状态, 0:未派单 5;已派单 10已到店 15:已取单 98 异常单 99:已取消 100:已完成',
confirmDesc: "确认按钮的文案,枚举:[null, '签收', '确认送回站点']",
cancelDesc: "取消配送的文案,枚举:[null, '无法配送']"
}
],
code: 0,
// 分页信息,需要分页的列表才会存在
pager: {
size: '分页大小, 默认20条数据',
from: '当前页码, 从0开始',
count: '数量总数'
}
}
接口描述
查询骑手驻店任务
接口消息定义
请求地址: /api/rider/cainiao/queryContractTask
请求方法: GET
请求消息体:
{
date: '当前时间' Date
}
响应消息体:
{
status: '响应状态,0失败,1成功',
// status 为 0 时存在
msg: '错误消息提示',
// status 为 1 时存在
data: [
{
shopName: '商家名称'
platformId: '渠道id',
platformName: '渠道名称'
transporterId: '运力需求id',
contractDate: 'string 驻店时间'
contractMode: 'byte 驻店模式'
}
],
code: 0
}
}
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
}
响应消息
{
status: 1,
data:{
deposit:保证金金额,类型:double
balance:账户可用余额,(保证金充值页面用到)类型:double
freezeMoney:冻结账户金额 类型:double
},
msg:“”
}
----------
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
finalReturn:是否是确认退还, 0:提示 1:确认退还 类型:int
}
响应消息
{ status: 1, data:{ successText:成功文案,类型String }, msg: errorCode:错误码,9600:是否确认退还保证金,类型:int extraMsg:当errorCode=9600时返回弹窗文案,以html格式返回,类型:String }
接口描述
设置接单状态切换。
接口消息定义
请求地址: /rider/set-hema-order-accept-state.json
请求方法: get
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
state: 0,小休,1,接单 int
}
响应消息
{
status: 1,
data:{
},
msg:""
}
接口描述
获取批次单状态。
接口消息定义
请求地址: /rider/get-hema-batch-status.json
请求方法: get
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
batchNumber:批次号(例:129383)
}
响应消息
{
status: 1,
data:{
state:0,异常单提示toast 1,正常单跳转到批次详情
},
msg:""
}
接口描述
获取接单状态。
接口消息定义
请求地址: /rider/get-hema-order-accept-state.json
请求方法: get
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
state: 0,小休,1,接单 int
},
msg:""
}
接口描述
获取批次详情。
接口消息定义
请求地址: /rider/get-hema-batch-details.json
请求方法: get
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
batchNumber:批次号(例:129383)
}
响应消息
{
status: 1,
data:{
batchNumber: 批次号,
orderNumber: 订单个数 例:5个订单,
batchList:[
{ orderId:订单id
arriveTime: 送达时间,例:11点前到达
isMember:是否是会员,类型:boolean false ,true
address: 地址
name:名称 加密后名称 例:点**
customerLng:客户地址经度,类型:int
customerLat:客户地址纬度,类型:int
}
…
]
},
msg:""
}
接口描述
获取客户经纬度。
接口消息定义
请求地址: /rider/get-hema-location.json
请求方法: get
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
batchNumber:批次号(例:129383)
}
响应消息
{
status: 1,
data:{
batchList:[
{
customerLng:客户地址经度,类型:int
customerLat:客户地址纬度,类型:int
}
…
]
},
msg:""
}
接口描述
获取交易明细接口。
接口消息定义
请求地址: /rider/view-hema-goods-list.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
orderId:订单Id
source:来源,类型:int
0:已接单列表订单详情 1:未接单列表订单详情(weex页面)
}
响应消息
{
status: 1,
data:{
goodsList:[
{
goodsId:商品Id,类型:String
groupId:商品组合ID,类型:String
groupName:商品组合名称,类型:String
skuId:与盒马对接的商品ID,类型:String
goodsName:货品名称,类型:String
placeGoods:用户下单时的商品规格,如:"下单:0.5kg x 4个",类型:String
pickingGoods:实际拣货后的商品规格,如:"1kg x 2个",类型:String
stockOut:是否缺货,1-缺货 0-未缺货 类型:int
difference:货品是否有差异 1-有差异 0-无差异 类型:int
btnText:按钮文案,如:拒收/已拒收等 类型:String
isRejectable:是否可以拒收,1-可拒收 0-不可拒收 类型:int
imgUrl:货物图片地址,类型:String
mistake:是否是易错货品,类型:int
0:不是 1:是
secret:是否是隐私商品,类型:int
0:不是 1:是
}
...
]
},
msg:""
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/rob-order-list.json
请求方法: GET
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
currentPage:当前页码,类型:int
keyWord:搜索关键词,类型:String
lat:骑手当前纬度,类型:int
lng:骑手当前经度,类型:int
}
响应消息
{
status:1,
data:{
currentPage:当前页码,类型:int
pageCount:总页数,类型:int
riderStatus:骑手状态,类型:int
verifiedStatus:验证状态,类型:int
tips:提示文案
btnText:按钮文案
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
groupList:[
{
orderId:订单ID,类型:String
groupId:订单分组,类型:String
platformId:渠道ID,类型:String
income:收入(分组单),类型:String
fee:小费(分组单),类型:String
platformText:取单名称(分组单)
requireTm:要求送达时间(分组单),类型:String
isAppointmentOrder:是否是预约单,类型:int
matchingDegree:顺路度,类型:String
orderCount:接单的订单总数量,类型:int
PS:不再判断orderList中有多少个订单,如果orderCount≤1,则展示“接单” 如果大于1,则展示"接xx单"
redPacket:是否是红包订单,类型:int
0:不是 1:是
goodsInfo:购买商品信息,类型:String
例如:购买商品:xxxxxxx
orderList:[
{
id:订单ID,类型:String
income:收入,类型:String
customerAddr:客人地址
distanceToCustomer:配送距离
status:订单状态
requireTm:要求送达时间
distanceToMe:距离你的距离,类型:String
shopName:商家名称,类型:String
shopAddr:商家地址,类型:String
orderType:订单类型,类型:int
0、普通订单(手发单);
1、同城直送;
2、外卖订单;
3、揽件订单;
4、派件订单
customerName:收货人姓名
shopTel:商家电话,类型:String
mixedGrab:是否是抢派混合单,类型:int
newLabelList:[
{
labelText:标签文案,类型:String
labelColor:标签字体颜色,如:“#fe751a”,类型:String
bgColor:标签背景颜色,如:“#fe751a”,类型:String
}
...
]
}
...
]
}
...
]
isScanCode:是否支持扫码抢单
}
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: GET
请求消息体:
{
riderId: 骑士Id
cityId:城市Id
lat:经纬度,类型:int
lng:经纬度,类型:int
sortType:订单排序类型,0 默认时间点排序,1 商家排序,2 订单号排序 类型:int
}
响应消息
{
status:1,
data:{
riderStatus:骑手状态,类型:int
0:休息中,5:工作中,99:禁用
verifiedStatus:认证状态,类型:int
0:未认证 5:审核中 9:未通过 10:已认证
tips:提示文案,类型:String
btnText:按钮文案,类型:String
unTerminativeOrderNum:订单数量,类型:int
arriveThreshold:到店阈值,类型:long
verifiedOvertime:是否审核超时,类型:boolean
isHealthCertificateUploaded:是否上传了健康证,类型:int
healthCertificationText:健康证文案,类型:String
orderList:[ 订单列表
{
id:订单Id,类型:String
groupId:订单组ID,类型:String
orderCount:接单的订单总数量,类型:int
orderScanned:是否有订单已经被扫码核验,类型:int
0:没有 1:有
income:收入,类型:String
advance:垫付金额,类型:String
customerAddr:收货地址,类型:String
status:订单状态,类型:int
typeStatus:录入状态,类型:int
0:未录入 5:未拍小票 10:已录入 15:已取货 99:未选择订单
redPacket:是否是红包订单,类型:int
0:不是 1:是
type:列表数据类型,类型:int(0:真实订单)
btnValue:按钮状态,类型:int
4:到店并拍摄小票
5:我已到店|取货| 全部到店
10:录入新订单
15:拍小票| 扫码核验 | 拍摄货品和小票
20:离店配送| 全部离店
22:拍摄货物图片
23:全部妥投
25:货品送达| 全部回执送达
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
goodsInfo:购买商品信息,类型:String
例如:购买商品:xxxxxxx
btnText:状态文案,类型:String
sinceObtained:配送时长,类型:long
customerTel:收货人联系方式,类型:String
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
urge:是否催单,类型:int
serialId:订单序号,类型:String
simpleSerialId:订单流水号,(不包含渠道名称和#号)类型:String
punctualTm:准点奖励要求时间,类型:String
labelList:[
{
code:标签Code,类型:int
title:标签标题,类型:String
desc:标签文案,类型:String
type:标签样式类型,类型:int
}
...
]
requireTm:要求送达时间,类型:String
requireTm2:要求送达时间,类型:long
serviceTm:服务器当前时间,类型:long
punctualAmount:准点奖励金额,类型:String
collection:代收,类型:String
collection2:代收金额,类型:double
punctualTm2:准点奖励要求时间,类型:long
searchText:用于订单搜索的字段,类型:String
locatorNo:货位号,类型:String
waybillNo:运单号,类型:String
elemeWaybillNo:饿了么运单号,类型:String
shopInfo:{
shopId:商家ID,类型:String
shopAddr:发货地址,类型:String
virtualShop:是否是虚拟商家,类型:int
0:不是 1:是
shopName:商家名称,类型:String
orderNum:订单数量,类型:int
channel:是否是渠道单
0:非渠道单 1:渠道单
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
shopTel:商家电话,类型:String
notTyped:未录入订单ID,类型:List
notObtained:未离店订单ID,类型:List
remainTime:到店剩余时间,类型:long
finishedNum:当前完成商家订单数,类型:int
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
platformName:渠道名称,类型:String
}
isAppointmentOrder:是否是预约单,类型:int
payStatus:支付状态,类型:int
0:默认值,无意义
1:未支付
2:线上支付
3:线下支付
totalIncome:预计收入汇总值(预计收入+小费+困难单奖励),类型:String
orderOvertime:到店或者送达超时标识,类型:boolean
punishDesc:处罚文案 类型String 例:超时20分钟扣¥5.0
}
...
]
distanceToCustomer:配送距离,类型:String
leaveTm:离店时间,类型:long
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:未支付金额,类型:double
dispatchMode:调度模式,类型:int
1:系统派单
2:抢单
3:人工派单
4:分组派单
5:扫码抢单
contractType:驻店模式,类型:int
0:非驻店
1:全驻店
2:半驻店
arriveTm:到店时间,类型:long
onlinePayType:在线支付类型,类型:int
0:不区分线上线下支付
1:线下支付
2:线上支付
paidAmount:客人已支付金额,类型:float
customerName:客人姓名,类型:String
notifyList:{
fetchTimeOut:取货/到店超时时间点,类型:long
deliveryTimeOut:送达超时时间点,类型:long
}
distanceToShop:骑手到商家的距离,类型:String
fetchRequireTm:应取货时间,类型:String
remainDeliveryTime:应送达时间倒计时,类型:int
remainFetchTime:要求取货时间倒计时,类型:int
platformId:渠道ID,类型:int
新增盒马订单渠道,72
newLabelList:[
{
labelText:标签文案,类型:String
labelColor:标签字体颜色,如:“#fe751a”,类型:String
bgColor:标签背景颜色,如:“#fe751a”,类型:String
}
...
]
fee:小费
}
}
接口描述
获取订单详细信息
接口消息定义
请求地址:/rider/view-order-detail.json
请求方法: GET
请求消息体:
{
cityId:城市ID,类型:String
riderId:骑手ID,类型:String
orderId:订单ID,类型:String
history:是否是历史订单,类型:boolean
terminalTm:订单时间,类型:String
lat:纬度,类型:int
lng:经度,类型:int
from:打开订单详情的入口来源(非抢单列表进入时传0),类型:int
1:待抢单列表
}
响应消息:
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
id:订单ID
idStr:用于展示的ID字符串,类型:String
groupId:订单组ID,类型:String
groupIdStr:用于展示的订单组编号,类型:String
shopAddr:商家地址,类型:String
shopTel:商家电话,类型:String
shopName:商家名称,类型:String
customerAddr:客人地址,类型:String
customerTel:客人电话,类型:String
distributingfee:配送费,类型:String
subsidyfee:补贴,类型:String
payPrice:向发货方支付金额,类型:String
chargePrice:向发货方收取配送费,类型:String
status:订单状态,类型:int
btnText:按钮文案
shopLat:商家纬度,类型:int
shopLng:商家经度,类型:int
customerLat:客人纬度,类型:int
customerLng:客人经度,类型:int
remark:备注,类型:String
chargeUserPrice:向用户收取,类型:String
dispatchTm:派单时间,类型:String
ticketUrl:小票URL,类型:String
incomeInfo2: {
"totalIncomeList": [{
"incomeList": [{
"incomeDetailList": [{
"name": "到店收入",
"income": "¥ 7.0"
}, {
"name": "送达收入",
"income": "¥ 1.0"
}],
"name": "配送收入",
"income": "¥ 8.0",
"type": 1
}
...
],
"name": "收入",
"incomeMsg": "",
"ruleUrl": "http://60.191.68.46:19088/h5/billingNew.html?cityId=1&orderId=144982&riderId=30247"
type:收入类型,类型:int
0:其他 1:收入
}
...
],
"incomeMsg": "",
"totalIncome2": "¥ 12.0",
"totalFee": "",
"totalIntegral": "4",
"totalIncome3": ""
}
goodsInfo:购买商品信息,类型:String
例如:购买商品:xxxxxxx
hasGoodsPic:是否有货品图片,类型:int
0:没有 1:有
arriveConsume:到店用时,类型:long
deliveryConsume:配送剩余时间,类型:long
hasArrived:是否已到店,类型:boolean
punctualRewardText:订单准点奖励文案,类型:String
timeout:是否超时,类型:int
outOfDispatchingRange:是否超距,类型:int
distanceForFee:配送范围,类型:String
leaveTm:离店时间,类型:String
finishTm:完成时间,类型:String
tradingAreaName:订单所属商圈,类型:String
orderCancelReason:订单取消原因,类型:String
cancelPunishment:取消惩罚,类型:String
changePhone:客人是否修改了手机号,类型:int
0:未修改 1:已修改
orderAbnormal:是否展示无法配送原因横条,类型:int
0:不展示 1:展示
orderAbnormalId:无法配送生成的工单ID,类型:String
appealStatusText:申诉状态文案,类型:String
appealId:申诉ID,类型:String
complaintStatusText:投诉状态文案
complaintId:投诉ID,类型:String
punishDate:订单取消惩罚时间,类型:String
platformId:渠道订单编号
1:点我吧
2:点点送
4:点我达
20:菜鸟订单
26:裹裹直送
72:盒马订单
81:中车宝联
83:跑腿订单
stockOut:是否缺货,1-缺货 0-未缺货 类型:int
difference:货品是否有差异 1-有差异 0-无差异 类型:int
balanceInfo:结算信息集合
hasFoodInfo:是否存在餐品信息,类型:int
collection:代收,类型:double
isResident:是否驻店,类型:int
orderType:订单类型,类型:int
0:收发单
1:同城直送
2:外卖订单
3:揽件订单
4:派件订单
5:保险模式订单
notPaidAmount:客人未支付金额,类型:double
dispatchMode:调度模式,类型:int
contractType:驻店模式,类型:int
onlinePayType:支付模式,类型:int
paidAmount:客人已支付金额,类型:double
orderIncomeRuleUrl:订单收入规则URL
shopId:商家ID,类型:String
deliveredTm:妥投时间,类型:String
orderScanned:是否有订单已经被扫码核验,类型:int
0:没有 1:有
requireTm:应送达时间,类型:String
fetchRequireTm:应取货时间,类型:String
foodsReady:商家是否已出餐,类型:boolean
true:已出餐 false:未出餐
foodsReadyReported:是否已举报商家未出餐,类型:boolean
true:已举报 false:未举报
channelId:渠道订单号,类型:String
agingText:订单时效文案,类型:String
expressCount:面单总数量,类型:int
canceledOrderCount:已被取消的订单数量,类型:int
notScannedOrderCount:未扫码的订单数量,类型:int
orderCount:接单的订单总数量,类型:int
btnValue:按钮状态,类型:int
4:到店并拍摄小票
5:我已到店|取货| 全部到店
10:录入新订单
15:拍小票|扫码核验 | 拍摄货品和小票
20:离店配送| 全部离店
22:拍摄货物图片
23:全部妥投
25:货品送达| 全部回执送达
11:选择订单
30:到达现场
35:现场查勘
40:查勘审核中
45:查勘审核未通过
PS:#同城模式 btnValue值含义#
订单状态:
我已就位 5
拍摄货品 22
开始配送 20
货品送达 25
targetUrl:中车宝联订单相应状态下点击按钮进入的h5页面的url,类型:String
predictIncome:预计收入,类型:String
distanceToShop:骑手到商家的距离,类型:String
distanceToCustomer:骑手到客人的距离,类型:String
weight:重量,类型:String
punctualRewardMoney:准点奖励金额,类型:String
punctualRewardRequireTm:准点奖励要求送达时间,类型:String
fee:小费,类型:String
arriveTm:到店时间,类型:String
getGoodsTm:取货时间,类型:String
cancelGoodsTm:取消时间,类型:String
waybillNo:面单号,类型:String
arriveTmTips:到店是否超时提示,类型:String
deliveryTmTips:送达是否超时提示,类型:String
goodsMoney:货品金额,类型:String
distanceToDestination:骑手到目的地的距离,类型:String
customerName:收货人姓名,类型:String
getGoodsTmTips:取货时间(同城直送订单),类型:String
isAppointmentOrder:是否是预约单,类型:int
goodsType:货品类型,类型:String
labelList2: [
{
labelText:标签标题,类型:String
labelColor:标签字体颜色,类型:String
bgColor:标签背景颜色,类型:String
labelDesc:标签释义,类型:String
}
...
]
timeAssessList:[
{
assessName:考核名称,例:准点到店时间,类型:string
assessContent:考核内容,例:12:30前,类型:string
reward:奖励,例:奖 ¥2.5:,类型:string
overRewardTime:是否超过奖励时间,类型:boolean
timeover:是否超时,类型:boolean
punishDesc: 处罚描述 例:超时20分钟扣¥5.0,类型String
oldAccessContent:旧考核内容,如:12:40前,类型:String
oldAccessDesc:旧考核描述,如:因接到新的订单,送达时间发生调整 类型:String
},
……
]
}
}
接口描述
获取所有订单经纬度。
接口消息定义
请求地址: /rider/get-route.json
请求方法: post
请求消息体:
{
riderId:骑士Id,类型:String
cityId:城市Id,类型:String
lat:当前骑手所在位置的纬度,类型:int
lng:当前骑手所在位置的经度,类型:int
}
响应消息
{
status: 1,
data:{
open:是否显示推荐路线开关,类型:int
0:不显示 1:显示
timeout:获取推荐路线是否超时,类型:int
0:否 1:是
route: [
{
lat:纬度,类型:String
lng:经度,类型:String
type: 用户点10,商家点5,类型:int
name:商家名或者客人名称,类型:String
address:地址,类型:String
isGot:是否已取 0 未取 1 已取,类型:int
orderId:订单ID,类型:String
dispatchMode:订单模式,类型:int
1:派单模式 2:抢单模式
platformId:渠道ID,类型:int
},
]
orderedRoutes:[ //按照顺序排列好的路线集合
{
lat:纬度,类型:String
lng:经度,类型:String
type: 用户点10,商家点5,类型:int
name:商家名或者客人名称,类型:String
address:地址,类型:String
isGot:是否已取 0 未取 1 已取,类型:int
orderId:订单ID,类型:String
dispatchMode:订单模式,类型:int
1:派单模式 2:抢单模式
platformId:渠道ID,类型:int
}
]
existOtherType:是否存在除外卖单以外的其他订单类型,类型:int
},
msg:""
}
接口描述
获取所有订单经纬度。
接口消息定义
请求地址: /rider/get-picture-config.json
请求方法: post
请求消息体:
{
riderId:骑士Id,类型:String
cityId:城市Id,类型:String
orderId:订单ID,类型:String
platformId:渠道ID,类型:String
orderType:订单类型,类型:String
}
响应消息
{
status: 1,
data:{
rules:[ 拍照规范文案集合,
"请拍摄清晰的货品照片",
...
],
minCount:最少拍摄的照片张数,类型:int
maxCount:最多拍摄的照片张数,类型:int
},
msg:""
}
接口描述
获取所有订单经纬度。
接口消息定义
请求地址: /rider/submit-pictures.json
请求方法: post
请求消息体:
{
riderId:骑士Id,类型:String
cityId:城市Id,类型:String
orderId:订单ID,类型:String
platformId:渠道ID,类型:String
orderType:订单类型,类型:String
type:图片类型,类型:int
1:拍摄的货品图片
pictures:用逗号分隔的图片URL字符串,类型:String
如:http://www.baidu.com/1.jpg,http://www.baidu.com/2.jpg,http://www.baidu.com/3.jpg
}
响应消息
{
status: 1,
data:{
successText:照片上传成功后的文案提示,类型:String
},
msg:""
}
接口描述
获取所有订单经纬度。
接口消息定义
请求地址: /rider/get-pictures.json
请求方法: post
请求消息体:
{
riderId:骑士Id,类型:String
cityId:城市Id,类型:String
orderId:订单ID,类型:String
platformId:渠道ID,类型:String
orderType:订单类型,类型:String
type:图片类型,类型:int
1:骑手拍摄的小票/商品图片链接
2:渠道订单推单订单相关图片
}
响应消息
{
status: 1,
data:{
pictures:[ 图片链接集合对象
"http://www.dianwoda.com/1.jpg",
"http://www.dianwoda.com/2.jpg",
"http://www.dianwoda.com/3.jpg",
]
},
msg:""
}
接口描述
等级体系,相应特权
接口消息定义
请求地址:/rider/new-levels.json
请求方法: get/post
请求消息体:
{
cityId: 城市Id,类型:int
riderId:骑士Id,类型:int
}
响应消息
{
status: 1,
data:{
riderLevel:当前等级,类型:int
examCycle:考核周期,类型:String
levelList:[
{
level:等级,类型:int
rightList:[
{
name:专属特权文案,类型:String
value:特权指数,类型:String
url:跳转url,类型:String
type:标签背景图片类型,1:橙色五角星, 2:绿色三角形,3:蓝色五角星 4:青色六边形,5紫色正方形
},...
]
}
]
upgradeExplainUrl:怎样升级的url,类型:string
upgradeTips:成长进度条上的文案,类型:String
curValue:当前成长值,类型:int
levelValue:等级成长值,类型:int
levelQuestionText:等级更新文案,类型String
upgradeList:[
{
upgradeTitle:“升级Lv.4 任务”,类型:String
mission:[
{
title:“拥有点我达装备”,类型:String
tip:任务解释,类型:string
buttonStr:按钮文案,类型:String
missionType:任务类型,1:装备购买|2:参加培训 3:获取能力页面
finished:true任务已完成|false任务未完成,类型:bool
},...]
},...]
},
msg:“”
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-orderhis-list.json
请求方法: post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
currentPage:当前页,类型:int
today:订单类型,0 今日订单 1历史订单,类型:int
}
响应消息
{
status:1,
data:{
todayTotal:今日订单数量,类型:int
historyTotal:历史订单数量,类型:int
pagination:{
currentPage:当前页码,类型:int
pageCount,总页数,类型:int
list:[
{
id:订单id,类型:String
income:收入,类型:String
customerAddr:客户地址,类型:String
distanceToCustomer:距离,类型:String
status:订单状态,类型:String
shopName:商家名,类型:String
shopAddr:商家地址:类型:String
isResident:是否驻店, 类型:boolean
onlinePayStatus:0:不显示,1:显示【线下支付】标签,2:显示【可申诉补款】标签
evaluateStatus:评价商家状态,类型:int,0:不显示入口1:评论商家,2:查看评论,
time:订单终结时间,类型:String
如:01月30日 18:30
exception:是否是异常订单,类型:int
0:不是 1:是
}
]
},
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
}
接口描述
获取服务商中心三方合作员工登录url
接口消息定义
请求地址: /rider/base/get-alipay-url.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
}
响应消息
{
status:1,
data:{
isBind:是否绑定支付宝账号,类型:boolean
true:绑定过 false:未绑定
url:支付宝跳转URL,isBind为true时,跳转页面链接,类型:String
authInfo:跳转支付宝SDK需要的字符串,isBind为false时,跳转授权SDK,类型:String
},
msg:提示信息,类型:String 状态值为1的时候此字段为空
}
接口描述
获取服务商中心三方合作员工登录url
接口消息定义
请求地址: /rider/base/set-alipay-userid.json
请求方法: post
请求消息体:
{
cityId:城市ID
riderId:骑士Id,类型:String
alipayOpenId: 支付宝OpenId,类型:String
authCode:支付宝authCode,类型:String
}
响应消息
{
status: 1,
data:{
successText:提示信息,类型:String
forwardUrl:绑定成功后跳转的URL,类型:String
},
msg:“”
}
接口描述
获取个人信息。
接口消息定义
请求地址: /rider/get-rider-info.json
请求方法: post
请求消息体:
{
cityId: 城市Id
riderId:骑士Id
}
响应消息
{
status: 1,
data:{
authenticationStatus:认证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
authenticationInfo:认证信息 类型:String
riderName:姓名,身份认证填写的姓名,类型:String
finishedOrderNumber:完成订单数,类型:String
accumulatedIncome:累计收入,类型:String
balance:余额,类型:String
csTel:客服电话,类型:String
passexamStatus:是否通过考试,类型:int
monthlyIncome:当月收入,类型:String
riderType:骑手身份类型,0 骑手 5 骑士,类型:int
riderLevel:骑手等级,类型:int
5:青铜骑手 10:白银骑手 15:黄金骑手 20:钻石骑手 25:王者骑手
riderLevelText:骑手身份等级,类型:String
amTel:商圈负责人联系方式,类型:String
trainStatus:培训报名状态 类型int
0:不需要弹窗
1:去报名弹窗
2:查看报名信息弹窗
btVisibiliy:赏金任务是否显示,1 显示,类型:int
healthCardText:健康证状态文案,类型:String
equipmentDesc:我的装备描述信息,类型:String
例:完整度1/5
onlineDuration:今日在线时长,如:8小时32分 类型:String
isNewComer:是否是新手,1:是新手 0:不是新手 类型:int
todayJoinedBTNum:赏金任务角标数字,今日开始的任务数,类型:int
targetServiceVisibiliy:定向服务是否显示,1 显示,类型:int
taskCenterUrl:任务中心URL,类型:String
taskCenterSignature:任务中心签名,类型:String
levelInfo:{
levelText:等级指标文案,类型:String
如:等级指标(3.5-3.11)
targetTaskLevel:当前任务指标的目标等级,类型:int
5:青铜骑手 10:白银骑手 15:黄金骑手 20:钻石骑手 25:王者骑手
targetList:[ 指标集合
{
targetText:指标文案,类型:String
如:完成单量≥30 派单接单率≥95%
totalProgress:指标完成总进度,类型:int
currentProgress:当前指标完成进度,类型:int
percent:是否是百分比,如果是百分比,则需手动添加“%”,类型:int
0:不是 1:是
reverse:是否需要反转比例值,类型:int
0:否 1:是
}
]
taskDatas:[ 任务集合
{
taskText:任务名称,类型:String
如:完成xx培训
buttonText:按钮文案,类型:String
如:已完成,去购买
clickable:按钮是否可以点击,类型:int
0:不可以 1:可以
targetUrl:点击按钮后进入的h5页面的URL,类型:String
},
]
privilegeList:[
{
type:标签背景图片类型,1:橙色五角星, 2:绿色三角形,3:蓝色五角星 4:青色六边形,5紫色正方形
value:标签文案,类型:string
name:标签描述,类型String
newComerPrivilege:是否是新手特权 1:是 0:不是 类型:int
},
]
}
hemaRider:是否有盒马鲜生渠道标签,类型:int
1-有,0-无
riderStationIsOpen:该城市是否开通骑手驿站,类型:int
1-开通,0-无
expressIsOpen:菜鸟仓配是否开通,类型:int
1-开通,0-无
rewardTaskOpen:赏金任务是否开通,类型:int
0:未开通 1:已开通
},
msg:“”
}
接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-orderhis-list.json
请求方法: post
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
currentPage:当前页,类型:int
today:订单类型,0 今日订单 1历史订单,类型:int
}
响应消息
{ status:1, data:{ todayTotal:今日订单数量,类型:int historyTotal:历史订单数量,类型:int pagination:{ currentPage:当前页码,类型:int pageCount,总页数,类型:int list:[ { id:订单id,类型:String income:收入,类型:String customerAddr:客户地址,类型:String distanceToCustomer:距离,类型:String status:订单状态,类型:String shopName:商家名,类型:String shopAddr:商家地址:类型:String isResident:是否驻店, 类型:boolean onlinePayStatus:0:不显示,1:显示【线下支付】标签,2:显示【可申诉补款】标签 evaluateStatus:评价商家状态,类型:int,0:不显示入口1:评论商家,2:查看评论, time:订单终结时间,类型:String 如:01月30日 18:30 exception:是否是异常订单,类型:int 0:不是 1:是 orderType:订单类型,类型:int 0:收发单 1:同城直送 2:外卖订单 3:揽件订单 4:派件订单 5:保险模式订单
} ] }, }, msg:提示信息,类型:String 状态值为1的时候此字段为空 }