[关闭]
@zhuchao941 2017-02-08T14:46:45.000000Z 字数 69140 阅读 1262

点我达骑手加盟商版接口文档

1. 点我达配送平台与终端接口定义

 接口为点我达配送客户端和平台之间的接口,客户端通过此接口获取用户和内容信息,并且完成用户操作数据的上传

2. 接口内容

2.1.接口定义约

2.2.消息体约

 请求消息和应答消息体采用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

2.3. 接口定义

2.3.1登录接口(login)

接口描述
 在登录界面,用户登录时必须经过手机及验证码验证
接口消息定义
请求地址:/ 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
}

2.3.2获取验证码接口(getCaptcha)

接口描述
登录时点击获取验证码按钮,下发验证码短信
接口消息定义
请求地址: /apis/common/get-captcha.json
请求方法: post
请求消息体:


{
   mobile:手机号,类型:String
   type:验证码类型,类型:String
   isVoice:语音验证码,类型:String
   systemCode: “spider“(商家端) or “flash”(骑手端)
}

响应消息


{
   status : 请求成功标志,1 成功 0 失败, 类型 : number
   data: “1234”验证码内容
   msg:错误提示信息,如没有,则为空,类型:String
}


2.3.3 获取城市接口(getCity)

接口描述
登录时点击获取验证码按钮,下发验证码短信。
接口消息定义
请求地址: /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
}


2.3.4开始接单(startWork)

接口描述
开始接单
接口消息定义
请求地址: /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
}


2.3.5 停止接单(goOffWork)

接口描述
停止接单,下班
接口消息定义
请求地址: /rider/come-off-work.json
请求方法: post
请求消息体:


{
  riderId: 骑士Id
  cityId:城市Id
  lat:经纬度,类型:int
  lng:经纬度,类型:int
}

响应消息


{
   status : 请求成功标志,1 成功 0 失败, 类型 : number
   data:提示信息
   msg:错误提示信息,如没有,则为空,类型:String
}


2.3.6 未完成订单列表接口(getOrderList)

接口描述
通过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:[
                {
                  code:标签code,类型:String
                  title:标签文案,类型:String
                  type:标签类型,1:红字白底,2:白字红底,3:蓝字白底,
                          4:白底灰字-商家标签名
                          5:橙底红字-超额|即将超额|点点送
                          6:准点奖励背景红色字体
                          类型:int
                  desc:标签描述,类型:String
                }
              ]
              requireTm:要求送达时间,类型:String
              serviceTm:服务器当前时间,类型:String
              punctualAmount:准点奖励额金额,类型:String
              collection:代收,类型:String
              collection2:代收,类型:float
              locatorNo:货位号,类型:String
              waybillNo:运单号,类型:String
            }
            ]
            labelList: [
              {
                code:标签code,类型:String
                title:标签标题,类型:String
                desc:标签描述,类型:String
                type:标签类型,类型:int
              }
              ]
            platformDesc:渠道描述,类型:String
            finishedOrderNum:当日骑手在商家完成的订单数,类型:int 
      }
      ]
    }
  },
  msg:提示信息,类型:String 状态值为1的时候此字段为空
  errorCode:错误码,9002:账号禁用,类型:int
}


2.3.7 线路经纬度获取接口(getRoute)

接口描述
获取所有订单经纬度。
接口消息定义
请求地址: /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:” ”
}


2.3.8 上传经纬度(uploadPosition)

接口描述
每隔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 修改单,类型:int
        shopId:商家ID,类型: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
}


2.3.9 取餐离店接口(obtainGood)

接口描述
取得餐品调用该接口。
接口消息定义
请求地址: /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
}


2.3.10 完成订单接口(finishOrder)

接口描述
完成订单调用该接口。
接口消息定义
请求地址: /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
}


2.3.11 订单详细信息获取接口(viewOrderDetail)

接口描述
通过订单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:“”
}


2.3.12 上传拍照(uploadPicture)

接口描述
上传小票拍照
接口消息定义
请求地址: /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
}


2.3.13 历史订单列表接口(getOrderHisList)

接口描述
通过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的时候此字段为空
}


2.3.14 获取个人中心信息接口(getRiderInfo)

接口描述
获取个人信息。
接口消息定义
请求地址: /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:“”
}


2.3.15 申请提现接口(applyWithdrawal)

接口描述
申请提现
接口消息定义
请求地址: /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
}


2.3.16 交易列表接口(getTradeList)

接口描述
获取交易明细接口。
接口消息定义
请求地址: /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:””
}


2.3.17 提交邀请码接口(submitInvitationCode)

接口描述
输入邀请码。
接口消息定义
请求地址: /rider/submit-invitation-code.json
请求方法: post
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:用户名,骑士Id,类型:String
  invitationCode:邀请码,类型:String
}

响应消息


{
  status: 1,
  data:{
    successText :提示信息,类型:String
  },
  msg:“”
}


2.3.18 提交身份验证信息接口(submitAuthenticationInfo)

接口描述
验证身份证。
接口消息定义
请求地址:/rider/submit-authentication-info.json
请求方法: post
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:用户名,骑士Id,类型:String
  realName:真实姓名,类型:String
  identityCard:身份证号,类型:String
  tradingAreaId:所属商圈,类型:String
}

响应消息


{
  status: 1,
  data:{
    successText:成功提示信息,类型:String
  }
  msg:“”
}


2.3.19 查询骑手账户详情接口(queryTotalDetail)

接口描述
查询骑手账户中心
接口消息定义
请求地址:/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:“”
}


2.3.21 接收通知反馈接口(receiveNotify)

接口描述
接收通知反馈
接口消息定义
请求地址:/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:“”
}


2.3.22 获取分享信息接口(getInvitationInfo)

接口描述
获取分享信息
接口消息定义
请求地址:/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:“”
}


2.3.23 检查应用版本及补丁接口(checkVersion)

接口描述
检查应用及补丁版本号,更新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:""
}


2.3.25 在线考试结果接口(getTrainResult)

接口描述
查询考试结果
接口消息定义
请求地址:/rider/is-passed-exam.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String 
}

响应消息


{
  status: 1,
  data:{
    passedExamStatus:0 未通过 10 已通过,类型:int
    passedExamStatusText:状态文案,类型:String
  }
  msg:“”
}


2.3.26 获取提现记录列表接口(getWithdrawalList)

接口描述
获取提现记录
接口消息定义
请求地址:/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:“”
}


2.3.29 到店接口(arriveShop)

接口描述
我已到店
接口消息定义
请求地址:/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
}

2.3.30 订单录入接口(fillOrder)

接口描述
订单录入
接口消息定义
请求地址:/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:“”
}


2.3.31 设置异常单接口(setOrderAbnormal)

接口描述
设置异常单:联系不到客人或者客人拒收
接口消息定义
请求地址:/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
}


2.3.33 通知已读接口(readyNotification)

接口描述
通知已读
接口消息定义
请求地址:/rider/read-notification.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String
  notificationId:通知ID,类型:String
}

响应消息


{
  status:1,
  data:{ 
    successText:提示文案,类型:String
  },
  msg:提示信息,类型:String 状态值为1的时候此字段为空
}


2.3.34 选择接单区域并开始接单(selectWorkAra)

接口描述
选择接单区域后开始接单
接口消息定义
请求地址: /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
}


2.3.35 查询接单区域(getWorkingArea)

接口描述
查询接单区域信息
接口消息定义
请求地址: /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
}


2.3.36 设置接单区域(setWorkingArea)

接口描述
设置接单区域信息
接口消息定义
请求地址: /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
}


2.3.37 修改手机号(modiyMobile)

接口描述
修改手机号
接口消息定义
请求地址: /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
}


2.3.38 获取冻结列表(getBlockedList)

接口描述
获取冻结列表
接口消息定义
请求地址: /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
}


2.3.39 选择订单列表(getShopOrderList)

接口描述
选择订单列表
接口消息定义
请求地址: /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
}


2.3.40 转单(switchOrder)

接口描述
转单
接口消息定义
请求地址: /rider/switch-order.json
请求方法: get
请求消息体:


{
  riderId: 骑士Id
  cityId:城市Id
  orderId:订单ID,类型:String
}

响应消息


{
  status : 请求成功标志,1 成功 0 失败, 类型 : number
  data: {
    successText:提示文案,类型:String
  }
  msg:错误提示信息,如没有,则为空,类型:String
}


2.3.41 屏蔽商家列表(getShopList)

接口描述
屏蔽商家列表
接口消息定义
请求地址: /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
}


2.3.42 屏蔽商家(addBlack)

接口描述
屏蔽商家
接口消息定义
请求地址: /rider/add-to-black-list.json
请求方法: get
请求消息体:


{
  riderId: 骑士Id
  cityId:城市Id
  shopId:商家ID,类型:String
}

响应消息


{
  status : 请求成功标志,1 成功 0 失败, 类型 : number
  data: {
    successText:提示文案,类型:String
  }
  msg:错误提示信息,如没有,则为空,类型:String
}


2.3.43 取消屏蔽商家(removeFromBlack)

接口描述
取消屏蔽商家
接口消息定义
请求地址: /rider/remove-from-black-list.json
请求方法: get
请求消息体:


{
  riderId: 骑士Id
  cityId:城市Id
  shopId:商家ID,类型:String
}

响应消息


{
  status : 请求成功标志,1 成功 0 失败, 类型 : number
  data: {
    successText:提示文案,类型:String
  }
  msg:错误提示信息,如没有,则为空,类型:String
}


2.3.44 录入订单页获取订单信息(getOrderInfo)

接口描述
获取订单信息
接口消息定义
请求地址: /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
}


2.3.45 查询配送费(getDistributionCharge)

接口描述
查询配送费
接口消息定义
请求地址: /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
}


2.3.46 获取提现信息接口(getWithdrawalInfo)

接口描述
获取提现信息
接口消息定义
请求地址:/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:“”
}


2.3.47 设置接单上限(setUpdateNumber)

接口描述
设置接单上限
接口消息定义
请求地址:/rider/set-order-celling.json
请求方法: get


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String 
  celling:接单上限,类型:int
}

响应消息


{
  status: 1,
  data:{
    successText:提示信息,类型:String
  }
  msg:“”
}


2.3.48 获取接单上限(getUpdateNumber)

接口描述
设置接单上限
接口消息定义
请求地址:/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:“”
}


2.3.49 查询历史地址列表(getAddressList)

接口描述
查询历史地址列表
接口消息定义
请求地址:/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:“”
}


2.3.50 获取所属商圈(getDistrictList)

接口描述
获取所属商圈
接口消息定义
请求地址:/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:“”
}


2.3.51 查询通知中心列表(queryNotificationList)

接口描述
查新通知中心列表数据
接口消息定义
请求地址:/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:“”
}


2.3.52 提现详情(getWithdrawalDetails)

接口描述
查询提现详情信息
接口消息定义
请求地址:/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:“”
}


2.3.53 通知标记已读(readNotification)

接口描述
通知标记已读
接口消息定义
请求地址:/rider/read-notify.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String 
  notifyId:通知Id,类型:String
}

响应消息


{
  status: 1,
  data:{
    successText:提示信息,类型:String
  },
  msg:“”
}


2.3.54 绑定提现账户(bindAccount)

接口描述
绑定提现账户
接口消息定义
请求地址:/rider/set-rider-withdrawal-account.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String 
  account:账户,类型:String
  accountType:账户类型,90支付宝 小于90表示银行卡
}

响应消息


{
  status: 1,
  data:{
    successText:提示信息,类型:String
  },
  msg:“”
}


2.3.55 查询未读通知数量(getUnreadNotifyNum)

接口描述
查询未读通知数量
接口消息定义
请求地址:/rider/get-unread-notify-num.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String 
}

响应消息


{
  status: 1,
  data:{
    num:未读消息数量,类型:String
  },
  msg:“”
}


2.3.56 查询骑手认证信息(getPersonalData)

接口描述
查询未读通知数量
接口消息定义
请求地址:/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:“”
}


2.3.57 查询历史成交记录列表(getTradeHistory)

接口描述
查询历史成交记录列表
接口消息定义
请求地址:/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:“”
}


2.3.58 设置商圈(setTradeArea)

接口描述
设置商圈
接口消息定义
请求地址:/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
}


2.3.59 退出登录(logout)

接口描述
退出登录
接口消息定义
请求地址:/rider/logout.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String 
  lat:纬度,类型:int
  lng:经度,类型:int
  imei:设备号,类型:String
}

响应消息


{
  status: 1,
  data:{
    successText:提示信息,类型:String
  },
  msg:“”
}


2.3.60 收集竞品信息(submitCompetitorResult)

接口描述
退出登录
接口消息定义
请求地址:/rider/competitor.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String
  isCoinCide:达达骑手和点我达骑手同时安装,类型:int
  isNew:昨天没安装达达骑手但今天装了,类型:int 
  isUninstall:是否已卸载,类型:int
}

响应消息


{
  status: 1,
  data:{
    successTxt:提示信息,类型:String
  },
  msg:“”
}


2.3.61 定位错误信息上报(monitor)

接口描述
定位错误信息上报
接口消息定义
请求地址:/rider/monitor.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String
  errorCode:错误码,类型:String

}

响应消息


{
  status: 1,
  data:{
    successText:提示信息,类型:String
  },
  msg:“”
}


2.3.62 抢单(grabOrder)

接口描述
口碑订单选择订单页抢单
接口消息定义
请求地址:/rider/grab-order.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String
  orderId:订单Id,类型:String
  dispatched:订单是否已经派出,类型:int
}

响应消息


{
  status: 1,
  data:{
    successText:提示信息,类型:String
  },
  msg:“”
  errorCode:错误码
}


2.3.63 抢单取消(cancelGrabOrder)

接口描述
取消所抢的订单
接口消息定义
请求地址:/rider/pullback-order.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String
  orderId:订单Id,类型:String
}

响应消息


{
  status: 1,
  data:{
    successText:提示信息,类型:String
  },
  msg:“”
  errorCode:错误码
}


2.3.64 标记为虚假订单(setOrderFake)

接口描述
标记为虚假订单
接口消息定义
请求地址:/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
}


2.3.65 订单超距取消(cancelOrderForOutOfBounds)

接口描述
订单超距取消
接口消息定义
请求地址:/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
}


2.3.66 交易详情(queryTradeDetail)

接口描述
交易详情
接口消息定义
请求地址:/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
}


2.3.67 标记所有通知已读(setAllNoticationRead)

接口描述
标记所有通知已读
接口消息定义
请求地址:/rider/*.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String
}

响应消息


{
  status: 1,
  data:{
    successText:提示信息,类型:String
  },
  msg:“”
}


2.3.69 获取支持的银行列表(****)

接口描述
多商家奖励详情信息

接口消息定义
请求地址:/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:“”
}


2.3.70 换城市(****)

接口描述
换城市
接口消息定义
请求地址:/rider/change-city.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String 该字段即变为需要切换到的城市id
  riderId:骑士Id,类型:String
}

响应消息


{
  status: 1,
  data:{
   successText:成功提示,类型:String
  },
  msg:“”
  errorCode 9009骑手切换失败,9010骑士切换失败
}




2.3.70获取附近商家热力分布(****)

接口描述
获取附近商家热力分布

接口消息定义
请求地址:/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 
           }]
       }
    }
   



2.3.71 查询骑士业绩(****)

接口描述
查询骑士业绩
接口消息定义
请求地址:/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:""

   }
   



2.3.72 查询身份审核失败信息(****)

接口描述
身份审核失败信息展示
接口消息定义
请求地址:/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:""
   }
   



2.3.73 通过新手引导(****)

接口描述
身份审核失败信息展示
接口消息定义
请求地址:/v9/rider/pass-exam.json
请求方法:get/post
请求消息体:

 
    {
      cityId: 城市Id,类型:String
      riderId:骑士Id,类型:String
      guideVersion:当前用户的接单引导版本号,类型int
    }
 

响应消息

   
   {
      status: 1,
      data:{
        successText:"操作成功"
      },
      msg:""
   }
   



2.3.74 获取服务器地址(getServerAddress)

接口描述
登录前获取服务器地址
接口消息定义
请求地址:/v9/rider/get-server-address.json
请求方法:get/post
请求消息体:

 
    {
      mobile: 电话号码,类型:String
      riderId:骑士Id,类型:String
      cityId: 城市Id,类型:String
    }
 

响应消息

   
   {
      status: 1,
      data:{
        serverAddress:服务器地址,类型:String
      },
      msg:""
   }
   

2.3.76 推广赚钱已读(readSpread)

接口描述
推广赚钱页面已读上报
接口消息定义
请求地址:/rider/read-red-point.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String 
}

响应消息


{
  status:1,
  data:{ 
    successText:提示文案,类型:String
  },
  msg:“”
}


2.3.77 获取投诉或申诉详情(getComplaintOrAppealDetail)

接口描述
获取投诉或者申请结果详情
接口消息定义
请求地址:/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:“”
}


2.3.78 获取商家或订单标签信息(queryLabelList)

接口描述
获取商家或订单标签信息
接口消息定义
请求地址:/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:“”
}


2.3.79 获取商家当前未完成订单信息(queryShopOrderList)

接口描述
获取商家当前未完成订单信息
接口消息定义
请求地址:/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:“”
}




以下三个接口为骑士融合版本新增接口(added by Zhu)

另外有一个接口有更改,view-order-detail接口字段调整

  1. balanceInfo:对账信息,是一个String的list,遍历展示即可,包含对账所有信息

2.3.80 获取餐品信息

接口描述
获取餐品信息
接口消息定义
请求地址:/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:""
}




2.3.81 获取七日对账信息列表

接口描述
获取七日对账信息列表,该接口所有金额不带元,都为数字类型
接口消息定义
请求地址:/rider/view-account-checking.json
请求方法: get
请求消息体:


{
  cityId
  riderId
}

响应消息


{
  status:1,
  data:{ 
     list:[
       {
         date:日期(格式为yyyy年MM月dd日),类型:String
         fontColorType:类型:int  0:绿色 1:红色
         amount:金额文案,类型:String
        }
    ]
  },
  msg:""
}




2.3.82 获取单日对账列表

接口描述
获取单日对账详细列表,该接口所有金额不带元,都为数字类型
接口消息定义
请求地址:/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:""
}





2.3.83 查询通知中心列表(queryNotificationList,3.1.0开始版使用这个接口

接口描述
查新通知中心列表数据
接口消息定义
请求地址:/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:“”
}





2.3.84 获取所有通知分类

接口描述
查新通知中心列表数据
接口消息定义
请求地址:/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:“”
}




2.3.84 智能推荐订单热点区域中心坐标

接口描述
查新通知中心列表数据
接口消息定义
请求地址:/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:“”
}




2.3.85 扫码录入

接口描述
菜鸟订单扫码录入
接口消息定义
请求地址:/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:运单号核对失败
}


2.3.86 物流订单异常原因列表

接口描述
展示物流订单异常原因
接口消息定义
请求地址:/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:“”
}


2.3.87 物流订单异常提交

接口描述
提交选择异常原因
接口消息定义
请求地址:/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:“”
}


2.3.6 未完成订单列表接口(getOrderList)

接口描述
通过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
}




2.3.88 抢单订单列表(robOrderList)

接口描述
抢单列表
接口消息定义
请求地址:/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:“”
}


2.3.89 驻店订单抢单(rob)

接口描述
抢单,不同于口碑订单的选择订单
接口消息定义
请求地址:/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:“”
}


2.3.90 等级体系详情(levelInfo)

接口描述
等级体系,相应特权
接口消息定义
请求地址:/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:“”
}


2.3.91 骑手升级免责协议签署

接口描述
等级体系,相应特权
接口消息定义
请求地址:/rider/upgradeProSign.json
请求方法: get/post
请求消息体:


{
  cityId: 城市Id,类型:int
  riderId:骑士Id,类型:int
  agree:是否同意,0:不同意,1:同意,类型:int
}

响应消息


{
  status: 1,
  data:{
     successText:成功提示文案,类型:String
  },
  msg:“”
}


2.3.92 小票上传成功回执

接口描述
小票上传成功之后,调用此接口
接口消息定义
请求地址:/rider/ticket-uploaded.json
请求方法: get/post
请求消息体:



{
  cityId: 城市Id,类型:int
  riderId:骑士Id,类型:int
  orderId:订单ID,类型:String
}


响应消息


{
  status: 1,
  data:{
     successText:成功提示文案,类型:String
  },
  msg:“”
}

4.0.0版本废弃,新的接口替代


2.3.93 发送取货码/收货码(sendPickOrReceivingCode)

接口描述
重新发送取货码或者收货码
接口消息定义
请求地址:/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:“”
}


2.3.94 取货(pickUpByCode)

接口描述
凭借取货码取货
接口消息定义
请求地址:/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:“”
}


2.3.95 获取支付地址(getPayUrl)

接口描述
获取支付地址生成二维码
接口消息定义
请求地址:/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:“”
}


2.3.96 查询支付结果(queryPayResult)

接口描述
查询支付结果
接口消息定义
请求地址:/rider/query-pay-status.json
请求方法: get/post
请求消息体:


{
  cityId: 城市Id,类型:int
  riderId:骑士Id,类型:int
  orderId:订单ID,类型:String
}

响应消息


{
  status: 1,
  data:{
     status:0 失败 1 成功,类型:int
  },
  msg:“”
}


2.3.97 申请解绑(applyUnbunding)

接口描述
申请解除绑定设备
接口消息定义
请求地址:/rider/****.json
请求方法: get/post
请求消息体:


{
  cityId: 城市Id,类型:int
  mobile:手机号,类型:int
  imei:设备ID,类型:String
}

响应消息


{
  status: 1,
  data:{
    successText:成功文案,类型:String
  },
  msg:“”
  errorCode:9014:申请解绑异常,类型:int
}


4.0.0版本接口修改


2.3.10 完成订单接口(finishOrder)

接口描述
完成订单调用该接口。
接口消息定义
请求地址: /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
}


2.3.88 抢单订单列表(robOrderList)

接口描述
抢单列表
接口消息定义
请求地址:/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:""
}



2.3.89 订单抢单(rob)

接口描述
抢单,不同于口碑订单的选择订单
接口消息定义
请求地址:/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:""
}


2.3.97 扫码抢单(robByScan)

接口描述
扫码抢单
接口消息定义
请求地址:/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
}


2.3.99 赏金任务列表(rewardTaskList)

接口描述
获取赏金任务列表
接口消息定义
请求地址:/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:“”
}


2.3.100 赏金任务历史列表(rewardTaskHisList)

接口描述
获取赏金任务历史列表
接口消息定义
请求地址:/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:""
}


2.3.101 赏金任务详情(viewRewardTaskDetail)

接口描述
获取赏金任务详情
接口消息定义
请求地址:/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:""
}


2.3.102 赏金任务报名(joinBountyTask)

接口描述
参加赏金任务报名
接口消息定义
请求地址:/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:""
}


2.3.103 取消赏金任务报名(dropBountyTask)

接口描述
获取赏金任务详情
接口消息定义
请求地址:/rider/drop-bounty-task.json
请求方法: get/post
请求消息体:


{
  cityId: 城市Id,类型:int
  riderId:骑手Id,类型:int
  id:任务ID,类型:string
}

响应消息


{
  status: 1,
  data:{
    successText:成功文案,类型:string
  },
  msg:""
}


2.3.104 获取快递公司列表(viewExpressList)

接口描述
获取快递公司列表信息
接口消息定义
请求地址:/rider/view-express-list.json
请求方法: get/post
请求消息体:


{
  cityId: 城市Id,类型:int
  riderId:骑手Id,类型:int
}

响应消息


{
  status: 1,
  data:{
    list:[
      {
        code:快递公司ID,类型:string
        name:名称,类型:string
      }
    ]
  },
  msg:""
}


2.3.105 获取个人中心信息接口(getRiderInfo)

接口描述
获取个人信息。
接口消息定义
请求地址: /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:“”
}


2.3.6 未完成订单列表接口(getOrderList)

接口描述
通过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
}


2.3.106 图片上传成功回执

接口描述
图片上传成功之后,调用此接口
接口消息定义
请求地址:/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:“”
}



4.0.1版本接口修改


2.3.88 抢单订单列表(robOrderList)

接口描述
抢单列表
接口消息定义
请求地址:/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:""
}




2.3.6 未完成订单列表接口(getOrderList)

接口描述
通过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
          fetchRequireTm:要求取货时间,类型:String
          remainDeliveryTime:要求送达时间倒计时,以秒为单位 类型:int
          remainFetchTime:要求取货时间倒计时,以秒为单位,类型:int
          distanceToShop:到商家的距离,类型: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:{
               deliveryTimeOut:送达超时时间点,类型:long
               fetchTimeOut:取件/到店超时时间点,类型long
           }
           ]
          }
        }
      ] 
    }
  },
  msg:提示信息,类型:String 状态值为1的时候此字段为空
  errorCode:错误码,9002:账号禁用,类型:int
}

2.3.7 判断是银行卡所属银行(getCreditBank)

接口描述
通过骑手输入的银行卡号判断所属银行
接口消息定义
请求地址: /v19/rider/getCreditBank.json
请求方法: post
请求消息体:
{
riderId:骑手Id
credit:银行卡号
}

响应消息:
{
data: {
bankId:客户热线
bankName:银行名称
}
}

2.3.8 K码支付获取验证码(getPaymentVerifyCode)

接口描述
根据用户的卡号和手机号,获取支付短信验证码,同时服务端下发生成的交易编号给客户端,用来之后重发验证码
接口请求成功后,服务端发出验证码
接口消息定义
请求地址: /v19/rider/getPaymentVerifyCode.json
请求方法: post
请求消息体:
{
credit:银行卡号 string
amount:金额 int
mobile:手机号码 string
cityId:cityId int
name:持卡人姓名 string
idNo:身份证号码 string
riderId:骑手Id int
credit:银行卡号 string
notifyUrl:回调地址 string
}

响应消息:
{
status:1
data: {
tradeNo:交易编号
paymentUrl:跳转url
}
}

2.3.9 支付重新获取验证码接口(resendPaymentVerifyCode)

接口描述
用来重新获取支付验证码
接口消息定义
请求地址: /v19/rider/resendPaymentVerifyCode.json
请求方法: post
请求消息体:
{
tradeNo:交易编号 string
amount:金额 int
mobile:手机号码 string
cityId:cityId int
riderId:骑手Id int
}

响应消息:
{
status:1
}

2.4.0 K码确认支付接口(kPaymentRequest)

接口描述
用来重新获取支付验证码
接口消息定义
请求地址: /v19/rider/kPaymentRequest.json
请求方法: post
请求消息体:
{
tradeNo:交易编号 string
verifyCode:验证码 string
cityId:cityId int
riderId:骑手Id int
}

响应消息:
{
status:1
}

2.4.1 银联支付获取url接口(getIePaymentUrl)

接口描述
用来重新获取支付验证码
接口消息定义
请求地址: /v19/rider/getIePaymentUrl.json
请求方法: post
请求消息体:
{
amount:int
riderId:riderId
cityId:cityId int
notifyUrl:回调url
}

响应消息:
{
status:1
data{
paymentUrl:""
}
}

2.4.1 支付宝支付接口(getAliPayParamStr)

接口描述
用来重新获取支付验证码
接口消息定义
请求地址: /v19/rider/payParamStr.json
请求方法: post
请求消息体:
{
amount:金额int
riderId:riderId
cityId:cityId int
tradeNo:外部订单号
orderId:订单id
type:1-充值 2-代收
notifyUrl:回调url
}

响应消息:
{
status:1
data{
paramStr:"_input_charset=\"utf-8\"&body=\"\U70b9\U6211\U5427VIP\U5f00\U901a\"&it_b_pay=\"30m\"&notify_url=\"http://60.191.68.46:18080/app/payment/vip/alipay/notify\"&out_trade_no=\"AVC5656\"&partner=\"2088311985540545\"&payment_type=\"1\"&seller_id=\"marketing@dianwoba.com\"&service=\"mobile.securitypay.pay\"&show_url=\"m.alipay.com\"&sign=\"Zg17xRPZaegkcny3yc0N9IE%2FaByY3S5sR09uNQvtlwy%2F0M2HAn7YorzcW0qn2qPOLJTwxVTNSMBo6pVGzPr%2FJwZ8UDxOmQywHh9yhHQmvxxOXYhpR865CnHu99KNYZzm9CkC1kadSjvIMhDoHDXhXaWatkW1aGC3wzYuRGt%2Fn6c%3D\"&sign_type=\"RSA\"&subject=\"\U70b9\U6211\U5427VIP\U5f00\U901a\U8ba2\U5355:AVC5656\"&total_fee=\"36.0\""
}
}

2.3.13历史订单列表接口(getOrderHisList)

接口描述
通过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
          platformLabel:渠道标签,类型:String
          onlinePayStatus:0:不显示,1:显示【线下支付】标签,2:显示【可申诉补款】标签
        }
        ]
    },
  },
  msg:提示信息,类型:String 状态值为1的时候此字段为空
}



4.1.1版本接口修改



2.3.13历史订单列表接口(getOrderHisList)

接口描述
通过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
          platformLabel:渠道标签,类型:String
          onlinePayStatus:0:不显示,1:显示【线下支付】标签,2:显示【可申诉补款】标签
          
          labelList:[
            title,标签文案,类型:String
          ]
          
        }
        ]
    }
  }
  

2.3.11 订单详细信息获取接口(viewOrderDetail)

接口描述
通过订单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:{
      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:是否超时,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
    orderIncomeRuleUrl:订单收入规则,类型:String
  },
  msg:“”
}




1.0.0 版本加盟商骑手接口修改


1. 获取城市接口(getCity)

接口描述
通过经纬度定位城市
接口消息定义
请求地址: /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
}




2. 检查应用版本及补丁接口(checkVersion)

接口描述
检查应用及补丁版本号,更新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:""
}




3. 获取验证码接口(getCaptcha)

接口描述
登录时点击获取验证码按钮,下发验证码短信
接口消息定义
请求地址: /apis/common/get-captcha.json
请求方法: post
请求消息体:


{
   mobile:手机号,类型:String
   type:验证码类型,类型:String
   isVoice:语音验证码,类型:String
   systemCode: “spider“(商家端) or “flash”(骑手端)
}

响应消息


{
   status : 请求成功标志,1 成功 0 失败, 类型 : number
   data: 
   msg:错误提示信息,如没有,则为空,类型:String
}




4. 登录接口(login)

接口描述
 在登录界面,用户登录时必须经过手机及验证码验证
接口消息定义
请求地址:/ 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,之后服务端和客户端交流的凭证
    tips:更新提示文案,类型:String
    areaCode:区号,类型:String
    identityCard:身份证,类型:String
    riderName:骑手姓名,类型:String
    token:登录token,类型:String
    serverAddress:服务器地址,类型:string
    distanceThreshold:超距判断距离,如3KM,类型:double
    targetRadius:目标半径,引导骑手去设置,如1km,类型:double
    distanceTimeInterval:超距提示时间间隔,如10分钟,类型:int
    waitForDistanceThreshold:等待超时超距判断距离,如0.5KM,类型:double
    firstLogin:是否首次登陆,类型:boolean
  }
  msg:错误提示信息,如没有,则为空,类型:String
  errorCode:类型:int
}




5. 上传经纬度(uploadPosition)

接口描述
每隔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
    notSelfText: 别人登陆后的通知,类型:String
    orderNotifyList:[
      {
        orderId:订单ID,类型:String
        type:通知类型,1 新订单 2 取消单 3 修改单,类型:int
        orderTip:订单提示信息,类型:String
      }
      ],
    lostConnectionNotify:强行休息的通知,类型:String
    updateType:0不需要升级 1正常升级 2强制升级,类型:int
    url:更新下载地址,类型:String
    latestVersion:最新版本号,类型:String
    tips:提示信息,类型:String
    cancelOrderPunishNotify:订单取消扣款通知,类型:String
    patchUpdateNotify:补丁下发通知,类型:int
    forbiddenNotify:禁用 启用通知,格式:1|提示信息,1 禁用 2启用,类型:String
    upgradeProtocolNotify:升级协议通知,格式:0|不显示协议浮层,1|显示协议浮层,类型:int
    robOrderNotify:有可抢单通知,1  无订单  2 有订单 类型:int
    serviceTimeStamp:服务器上的时间戳,用于校验接口,类型:long
  },
  msg:提示信息,类型:String 状态值为1的时候此字段为空
  errorCode:错误码,类型:int
}




6. 获取个人中心信息接口(getRiderInfo)

接口描述
获取个人信息。
接口消息定义
请求地址: /rider/get-rider-info
请求方法: post
请求消息体:


{
  cityId: 城市Id
  riderId:骑士Id
}

响应消息


{
  status: 1,
  data:{
    riderStatus:骑手状态,类型:int
    forbiddenReason:禁用原因,类型:String
    todayIncome:今日收入,类型:String
    finishedOrderNumber:本月完成订单数,类型:String
    riderName:姓名,身份认证填写的姓名,类型:String
    riderMobile:手机号,类型:String
    csTel:客服电话,类型:String
    },
  msg:“”
}




7. 抢单订单列表(robOrderList)

接口描述
抢单列表
接口消息定义
请求地址:/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
     riderStatus:骑手状态,类型:int
                0:休息中 5:工作中 99:禁用
     verifiedStatus:验证状态,0:未认证 5:审核中 9:未通过 10:已认证,类型:int
     tips:提示文本,类型:String
     btnText:按钮文本,类型:String
    groupList:[{
        orderId:订单ID,类型:number
        groupId:订单分组,类型:String
        platformId:渠道ID,类型:number
        income:收入(分组单),类型:String
        platformText:渠道名称(分组单),类型:string
        requireTm:要求送达时间,类型:String
        orderList:[{
           id:订单id,类型:String
           income:收入,类型:String
           platformText:渠道名称,类型:string
           shopName:商家名称,类型:string
           shopAddr:商家地址,类型:string
           shopLat:商家地址纬度,类型:number
           shopLng:商家地址经度,类型:number
           distanceToMe:距你距离,类型:String
           serialId:流水号,类型:String
           customerAddr:客户地址,类型:String
           customerLat:客户地址纬度,类型;int 
           customerLng:客户地址经度,类型:int
           distanceToCustomer:距离,类型:String
           advance:垫付,类型:String
           pickupTm:应取货时间,类型:string
           priceText:餐品金额,类型:String
        }]
     }]
  },
  msg:""
}



------------

8. 抢单(grabOrder)

接口描述
口碑订单选择订单页抢单
接口消息定义
请求地址:/rider/grab-order.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String
  orderId:订单Id,类型:String
  dispatched:订单是否已经派出,类型:int
}

响应消息


{
  status: 1,
  data:{
    successText:提示信息,类型:String
  },
  msg:“”
  errorCode:错误码
}




9. 未完成订单列表接口(getOrderList

接口描述
通过code获取未完成订单列表信息。
接口消息定义
请求地址: /rider/view-order-list.json
请求方法: post
请求消息体:


{
   riderId: 骑士Id
   cityId:城市Id
   lat:经纬度,类型:int
   lng:经纬度,类型:int
}

响应消息


{
  status:1,
  data:{ 
    { 
      riderStatus:骑手状态,类型:int
      statusText:骑手状态文案,类型:String
      tips:提示文本,类型:String
      unTerminativeOrderNum:总订单数量,类型:number
      guideVersion:当前用户的接单引导版本号,类型:int
      arriveThreshold:到店时间阀值,类型:int
      multiShopReward:多商家奖励,类型:String
      orderList:[
        {
          id:订单id,类型:String
          income:收入,类型:String
          platformId:订单渠道编号,类型:int
          platformName:渠道名称,类型:String
          shopId:商家id,类型:number
          shopName:商家名称,类型:String
          shopAddr:商家发货地址,类型:String
          shopLat:商家地址纬度,类型:number
          shopLng:商家地址经度,类型:number
          serialId:流水号,类型:String
          customerAddr:客户地址,类型:String
          customerLat:客户地址纬度,类型;int 
          customerLng:客户地址经度,类型:int
          distanceToShop:到商家的距离,类型:String
          distanceToCustomer:距离,类型:String
          typeStatus:录入状态,类型:number
          (0:未录入 5:未拍小票 10:已录入 15:已取货 99:未选择订单)


          sinceObtained:配送时长,类型:long
          punctualTm:准点奖励要求时间,只做标签显示用,类型:String
          deliveryThreshold:配送时长阀值,单位:秒,类型:int
          requireTm:要求送达时间,标签显示,类型:String
          requireTm2:要求送达时间,类型:Date
          serviceTm:服务器当前时间,类型:String
          fetchRequireTm:要求取货时间,类型:String
          remainDeliveryTime:要求送达时间倒计时,以秒为单位 类型:int
          remainFetchTime:要求取货时间倒计时,以秒为单位,类型:int
          btnValue:按钮状态, 5:我已到店 10:录入新订单 15:还有订单未拍小票 20:离店配送 25:配送中 11:选择订单,类型:int
          btnText:按钮状态文案,类型:String
          status:订单状态,5:已派单 10:到店 15:已取单 98:异常 99:已取消 100:已完成,类型:int
          leaveTm:离店时间,类型:long
          arriveTm:到店时间,类型:long
        }
      ] 
    }
  },
  msg:提示信息,类型:String 状态值为1的时候此字段为空
  errorCode:错误码,9002:账号禁用,类型:int
}




10. 开始接单(startWork)

接口描述
开始接单
接口消息定义
请求地址: /rider/come-to-work.json
请求方法: post
请求消息体:


{
  riderId: 骑士Id
  cityId:城市Id
  lat:经纬度,类型:int
  lng:经纬度,类型:int
  cityName:城市名称,类型:String
}

响应消息


{
  status : 请求成功标志,1 成功 0 失败, 类型 : number
  data: {
    statusText:工作状态文案,类型:String
  }
  msg:错误提示信息,如没有,则为空,类型:String
  errorCode:错误码,9009:骑手跨城市,9010:骑手跨城市,9001: 此城市未开通, 9002:账号禁用 类型:int
}


11. 停止接单(goOffWork)

接口描述
停止接单,下班
接口消息定义
请求地址: /rider/come-off-work.json
请求方法: post
请求消息体:


{
  riderId: 骑士Id
  cityId:城市Id
  lat:经纬度,类型:int
  lng:经纬度,类型:int
}

响应消息


{
   status : 请求成功标志,1 成功 0 失败, 类型 : number
   data:提示信息
   msg:错误提示信息,如没有,则为空,类型:String
}


12. 订单详细信息获取接口(viewOrderDetail)

接口描述
通过订单id获取订单详细信息。
接口消息定义
请求地址: /rider/view-order-detail.json
请求方法: post
请求消息体:


{
  cityId: 城市Id
  riderId:骑士Id
  orderId: 订单号 类型:String
  history:是否是历史订单,类型:boolean
  terminalTm:交易详情中的交易时间,类型:String
  lat:当前骑手所在位置的纬度,类型:int
  lng:当前骑手所在位置的经度,类型:int
}

响应消息


{
  status: 1,
  data:{
    id:订单ID ,类型:String
    shopId:商家id,类型:number
    shopName:发货用户名,类型:String
    platformId:渠道ID,类型:int
    platformName:渠道名称,类型:String
    shopAddr:发货地址,类型:String
    shopLat:商家纬度,类型:int
    shopLng:商家经度,类型:int
    distanceToShop:骑手到商家的距离,类型:String
    customerAddr:收货地址,类型:String
    customerLat:用户纬度,类型:int
    customerLng:用户经度,类型:int
    distanceToCustomer:商家到客人的距离,类型:String
    requireTm:应送达时间,类型:String
    fetchRequireTm:应取货时间,类型:String
    advance:垫付,类型:String
    collection:代收,类型:float
    goodsMoney:餐品金额,类型:string
    weight:重量,类型:String
    remark:备注,类型:String
    predictIncome:预计收入,类型:String
    shopTel: 发货电话,类型:String
    customerTel:收货人联系方式,类型:String
    dispatchTm:派单时间,类型:String
    arriveTm:到店时间,类型:String
    getGoodsTm:取货时间,类型String
    leaveTm:离店时间,类型:String
    finishTm:完成时间,类型:String
    cancelTm:取消时间,类型:String
    incomeInfo:{
      incomeMsg:收入提示文案,类型:String
      totalIncome:收入总计,类型:String
      incomeList:[{
        name:收入名称,类型:String
        income:收入金额,类型:String
        incomeDetailList:[{
          name:名称,类型:String
          income:收入金额,类型:String
          incomeText:收入名称,类型:String
        }]
      }]
    }
    status: 订单状态 5:已派单 10:到店 15:已取单 98:异常 99:已取消 100:已完成,类型:int
    btnText:按钮显示字样,类型:String
    btnValue:按钮状态,按钮状态 5:我已到店 10:录入新订单 15:还有订单未拍小票 20:离店配送 25:配送中 11:选择订单,类型:int


    ticketUrl:小票URL,类型:String
    distanceToDestination:骑手到目的地的距离,类型:String
    arriveConsume:到店用时,类型:long
    deliveryConsume:配送用时,类型:long 
    hasArrived:是否已经到店,类型:boolean
    timeout:是否超时,1 已超时 类型:int
    outOfDispatchingRange:是否超距,超过5公里,按照4.9计费,类型:int
    distanceForFee:配送范围,比如4.9公里,类型:int
    orderIncomeRuleUrl:订单收入规则,类型:String
    arriveTmTips:到店是否超时提示,类型String
    deliveryTmTips:送达是否超时提示,类型String
    customerName:收货人姓名,类型:String
  },
  msg:“”
}




13. 到店接口(arriveShop)

接口描述
我已到店
接口消息定义
请求地址:/rider/arrive-shop.json
请求方法: get
请求消息体:


{
  cityId:城市Id,类型:String
  riderId:骑士Id,类型:String
  shopId:商家ID,类型:String
  orderId: 订单号id 类型:String
  lat:经纬度,类型:int
  lng:经纬度,类型:int
  considerDis :是否判断距离超限,判断 1, 不判断 0,类型:int
}

响应消息


{
  status: 1,
  data:{
    successText:提示文案,类型:String
    successIds:到店成功ID,类型:String
  }
  msg:“”
  errorCode:9003:超距,类型:int
}



14. 上传拍照(uploadPicture)

接口描述
上传小票拍照
接口消息定义
请求地址: /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
}




15. 图片上传成功回执

接口描述
图片上传成功之后,调用此接口
接口消息定义
请求地址:/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:“”
}




16. 取餐离店接口(obtainGood)

接口描述
取得餐品调用该接口。
接口消息定义
请求地址: /rider/obtain-good.json
请求方法: post
请求消息体:


{
  cityId:城市Id
  riderId:骑士ID
  orderIds: 所有订单号id,为空时批量离店,类型:String
  lat:经纬度,类型:int
  lng:经纬度,类型:int
  shopId:商家ID,类型:String
  orderId: 订单号id 类型:String
  considerDis:是否判断距离超限, 判断 1, 不判断 0,类型:int
}

响应消息


{
  status: 1,
  data:{
    successText:提示信息,类型:String
    hasObtain:是否还有订单未取餐,类型:boolean
    successIds:离店成功订单id,类型:string
  },
  msg:””
  errorCode:9003:超距,类型:int
}



----------

17. 完成订单接口(finishOrder)

接口描述
完成订单调用该接口。
接口消息定义
请求地址: /rider/finish-order
请求方法: post
请求消息体:


{
  cityId:城市Id,类型:String   
  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
}




18. 历史订单列表接口(getOrderHisList)

接口描述
通过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
          platformLabel:渠道标签,类型:String
          onlinePayStatus:0:不显示,1:显示【线下支付】标签,2:显示【可申诉补款】标签

          labelList:[
            title,标签文案,类型:String
          ]
        }
        ]
    },
  },
  msg:提示信息,类型:String 状态值为1的时候此字段为空
}


19. 查询骑手账户详情接口(queryTotalDetail)

接口描述
查询骑手账户中心
接口消息定义
请求地址:/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:“”
}


20. 交易列表接口(getTradeList)

接口描述
获取交易明细接口。
接口消息定义
请求地址: /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:””
}


21. 交易详情(queryTradeDetail)

接口描述
交易详情
接口消息定义
请求地址:/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
}


22. 提现详情(getWithdrawalDetails)

接口描述
查询提现详情信息
接口消息定义
请求地址:/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:“”
}


23. 退出登录(logout)

接口描述
退出登录
接口消息定义
请求地址:/rider/logout.json
请求方法: get
请求消息体:


{
  cityId: 城市Id,类型:String
  riderId:骑士Id,类型:String 
  lat:纬度,类型:int
  lng:经度,类型:int
  imei:设备号,类型:String
}

响应消息


{
  status: 1,
  data:{
    successText:提示信息,类型:String
  },
  msg:“”
}


添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注