[关闭]
@zhuchao941 2018-06-27T09:15:31.000000Z 字数 31471 阅读 1457

点我达商家接口文档完整版(整理中)


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接口定义

1 商家录入订单

接口描述
商家录入订单
接口消息定义
请求url:/order/place.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    shopAdreess:商家地址,类型:String
    shopLng:商家纬度,类型:int
    shopLat:该商经度,类型:int

    customerAddress:客户地址,类型:String
    customerLng:客户经度,类型:int
    customerLat:客户纬度,类型:int
    customerMobile:客户联系方式,类型:String
    customerTel:客户联系方式,类型:String
    price:订单价格(价格*100,与骑手保持一致),类型:int
    fee:配送费用(费用*100,与骑手保持一致),类型:int
    distance:配送距离,类型:String
    orderSource:订单来源,类型:int
    serialId:流水号,类型:int
    remark:备注,非必填,类型:String
    tip:小费,类型:int
    supplemented:是否为追加单,类型:String
    repeatJudged:是否判断重复发单,类型:bool
    feeCouponId:运费券id,类型:int,用户没用传0
    feeCouponValue:运费券金额,类型:int,单位:元,没用传0
    tipsCouponId:小费券id,类型:int,用户没用传0
    tipsCouponValue:小费券金额,类型:int,单位:元,没用传0
    placeType:0 手动录入,1:一键发单 ,2:批量发单,类型:int
    weight:重量,类型:int
    serverTime:时间戳,类型:string
    externalOrderId:一键发单外部订单号,类型:string
    riderId:追加骑手的ID,类型:string
}

响应消息体:



{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
    successText:提示文案,类型:String(正常下单成功后该字段为空,当余额不足时传当前账户余额已不足20元,请及时充值并弹窗提醒)
  }
  msg:错误提示信息,如没有,则为空,类型:String
  errorCode:错误码
      9006:超出配送距离错误码
      3012:当前账户余额小于未支付订单总费用(订单在离店时进行结算),请充值后再试(弹窗提醒)
      8002:账号被禁用
}


2 快递下单接口

接口描述
快递下单
接口消息定义
请求url:/order/place-express-order.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    customerAddress:客户地址,类型:String
    customerLng:客户经度,类型:int
    customerLat:客户纬度,类型:int
    waybillNo:面单号,格式:22222|33333|44444,类型:String
    extraFee:小费,单位:分,类型:int(每一单的小费值)
    remark:备注,非必填,类型:String
    distance:距离(m),类型:int
    serverTime:时间戳 类型:String
}

响应消息体:



{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: {
    successText:提示文案,类型:String
  }
  msg:错误提示信息,如没有,则为空,类型:String
  errorCode:错误码
      3012:当前账户余额小于未支付订单总费用(订单在离店时进行结算),请充值后再试(弹窗提醒)
      8002:账号被禁用
      3014:时间戳不同步
  }
  msg:
}


3 芝麻信用审核接口

接口描述
新增调用芝麻信用审核接口
接口消息定义
请求url:/shop/zhima-verify.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    name:姓名,类型:String
    identifyId:身份证号,类型:String
}

响应消息体:



{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
      result:芝麻信用分查询结果,-1:未知, 0:信用不满足, 1:满足,类型:int  
  }
  msg:
}


4 审核接口

接口描述
审核接口
接口消息定义
请求url:/shop/submit-verify.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    shopName:商户名称,类型:String
    phone:商户联系手机,类型:String
    tel:商户联系座机,类型:String
    address:商户地址,类型:String
    shopOwner:商家真实姓名,类型:String
    identifyId:身份证,类型:String
    shopName:商户名称,类型:String
    lng:经度,类型:int
    lat:纬度,类型:int
    bdCode:BD编号,非必传,类型:strong
    credentialsType:证件类型,0:身份证,1:护照
    zhimaVerified:是否是芝麻信用提审,类型:BOOL,TRUE:是 FALSE:否
    exSiteCode:快递站点编码,商家类型非快递类型时非必传,类型:String
    shopPlatformType:商户类型,0:餐饮,1:同城,2:快递,类型:int,
    expressType:快递类型,商家类型非快递类型时非必传,类型:int
}

响应消息体:



{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: {

  }
  msg:若errorCode==5002,msg为所填站点编码已注册,不能重复注册,若有疑问请联系BD解决~|180XXXXXXXX,电话号码为BD电话
    errorCode==5003,msg为“若请输入真实的商户名”
  errorCode:错误码,类型:int 
  5002:站点编码已注册,5003:商户名包含关键字值集
}


5 重新发布订单

接口描述
重新发布订单
接口消息定义
请求url:/order/re-place.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    orderId:需要重新发布的订单ID,类型:string
    groupId:需要重新发布的订单包Id,类型:String
}

响应消息体:



{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: {

  }
  msg:
}


6 获取配送费

接口描述
获取配送费
接口消息定义
请求url:/order/distribution-charge.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    fromLat:商家经度,类型:int
    fromLng商家纬度,类型:int
    toLng:客人纬度,类型:int
    toLat:客人经度,类型:int
    distance:距离(m),类型:int
    weight:重量(克),类型:int (非必填值)
}

响应消息体:



{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: {
    distributionFee:单位为分的配送费,类型:int
    desc:配送费:¥5.1,类型:String
    serviceCharge : 优质商家服务费,单位:元,类型:double,如果不是优质商家返回0
    weatherChargeStr: 雨天服务费说明文案,类型:string,例:(含恶劣天气服务费¥0.5)
    chargeDetailList:费用明细,类型:list
    [
        {
            name:费用名称,类型:String
            fee:费用,类型:String
        },...
    ]

  }
  msg:
}


7 增加小费

接口描述
在商家端主页和订单详情页增加订单小费,在订单原小费基础上增加
接口消息定义
请求url:/order/add-tip.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    orderId:订单ID,类型:String
    tip:小费,单位:分,类型:int
    couponId:小费券Id,类型:int
    couponValue:小费券金额,类型:int,单位:元,没用传0
    groupId:订单包ID,类型:String
}

相应消息体:


{
    {
    status:1,
    data:
    {
        successText:增加成功,
    }
    errorCode:3012,账户余额不足请充值
    msg:账户余额不足请充值
} 


8 查询商家订单

接口描述
查询商家订单
接口消息定义
请求url:/order/query-order.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    orderStatus:订单状态,0-未完成的所有订单,1-发布中(派单中),2-待取货(已派单,到店前,已到店),3-配送中,4-已到店,5-已离店,6-异常(取消单,异常完成单)
}

相应消息体:


{
    {
    status:1,
    data:
    {
        publishingNum:发布中订单包数量,类型:Int
        waitForSendNum:待取货订单包数量,类型:Int
        sendingNum:配送中订单包数量,类型:Int
        exceptionNum:异常订单包数量,类型:Int
        orderList:订单列表集合
        [
            {
                serialId:订单流水号,类型:int
                orderId:订单ID,类型:String
                riderTel:骑手联系方式,类型:String
                customerTel:客户联系方式,类型:String
                address:订单客户地址,类型:String
                extraFee:已加小费,单位分,类型:int
                distance:配送距离,带单位,如2.5km,类型:String
                sinceOrdered:已下单时间,单位:秒,该字段对于发布中订单来说,取值范围大于等于0,对于进行中订单,该值为-1,类型:int
                isAddExtraFee:是否已加消费,类型:BOOL
                orderStatusCn:订单状态中文,类型:String
                            枚举类型{派单中,未到店,未离店,配送中}
                platformDesc:订单所属外卖平台中文名称,类型:string,包括百度外卖、美团外卖、饿了么,其他(商家手发单)
                superiorShowed:是否显示优质商家标记,类型:bool,TRUE显示,FALSE不显示
                riderId:骑手ID,类型:int
                orderStatus:订单状态类型数值,类型:int
                arriveShopNum:已到店订单数,类型:Int
                sendMsgShowed:短信通知收件人按钮展示,类型:bool
                hasSendMsg:已发送过短信,类型:bool
                msgCharge:发短信费用,如:“收费0.1元”,若免费发送短信,则传空,类型:string
                useTipCoupon:该订单是否用过小费券,类型:bool
                groupId:快递包Id,类型:String
                groupOrderCount:快递包订单量,类型:String
                cancelCount:取消订单量,类型:Int
                abnormalCount:异常完成订单量,类型:Int
            },
            {...}
        ]
    }
} 


9 订单详情接口(调用老接口)

接口描述
商家端订单详情页,请求参数不变
接口消息定义
请求url:/order/detail.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    orderId:订单ID,类型:String
    groupId:订单包Id,类型:String
}

响应消息体:


{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
    waybillNoList:面单号列表,类型:list[
        E125389076123,
        E125389076124,
        E125389076125,
    ...
    ],
    code:展示用的订单号,类型:String
    groupId:订单包Id,类型:String,
    groupOrderCount:快递包总订单量,类型:Int
    cancelCount:取消订单量,类型:Int
    abnormalCount:异常完成订单量,类型:Int
    groupComplainingCount:订单包投诉中的数量,类型:int
    groupComplainedCount:订单包已完成投诉的数量,类型:int
    orderType:订单类型, 0:普通订单,1:同城直送,2:手发订单,3:揽件订单,4:派件订单,5:保险订单,类型:int
    platformDesc:平台名称,类型:String,包括百度外卖、美团外卖、饿了么,其他
    extraFee:已加小费,单位分,类型:int
    remark:备注,类型:int
    riderLng:配送员经度,类型:String
    riderLat:配送员纬度,类型:String
    extraFeeDisplay:小费显示,类型:String
    cancelUserType:取消类型,类型:int,1-配送员,2-商家
    feeExplainList:[
         {
            item:运费构成说明,类型:string,例如:自费 ¥2
         },{...}
     ],
     tipsExplainList:[
         {
            item:小费构成说明,类型:string,例如:平台追加 ¥3
         },{...}
     ]
     riderId:该订单骑手ID,类型:int,如果该订单没派到骑手的时候,该字段值为0
     placeYear:下单时的年份,类型:String,用于取消订单跨年时计算时间
     platformId:int
     riderText:地图上显示的骑手状态文案(html格式),部分文案有颜色差异,类型:String
     rePlaceOrder:是否是重新发布的订单,类型:Bool
     hasEvaluationed:是否已对骑手进行评价,类型:bool
     canRePlace:是否可重新发布,类型:bool
     feeDisplay:配送费显示,非取消状态,格式为:¥ 4.0;取消状态,格式为:¥ 4.0(已返还)
     extraFeeDisplay:小费显示,非取消状态,格式为:¥ 4.0;取消状态,格式为:¥ 4.0(已返还),若当小费为0的时候,小费栏去除“已返还”字样
     sendMsgShowed:短信通知收件人按钮展示,类型:bool
     hasSendMsg:已发送过短信,类型:bool
     msgCharge:发短信费用,如:“收费0.1元”,若免费发送短信,则传空,类型:string
     useTipCoupon:该订单是否用过小费券,类型:bool
     dispatchTimeDisplay:订单派单时间,类型:string 格式 2017-10-12-11:30
  }
  errorCode:3016,订单包有骑手接单
  msg:骑手已接单
}




10 登陆接口

接口描述
登录接口
接口消息定义
请求url:/common/login.json
请求方法:GET/POST
请求消息体:


    {
        phoneNumber:手机号码,类型:String
        cityId:城市ID,类型:String
        appVersion:app版本号,类型:String
        source:当前操作系统版本号,类型:String
        shopId:商家ID,类型:String
        captcha:验证码,类型:String
        deviceId:设备编号,类型:String
        deviceIdentifier:设备绑定标识,类型:string
        password:密码,类型:String
    }

响应消息体:


{
    {
    status:1,
    data:
    {
       token:String
       shopId:int
       needSetPassword:需要设置登录密码,类型:bool
       needAgreeRule:需要同意服务协议,类型:bool
       certificate:校验验证码接口返回的凭证,类型:String
    },
    errorCode:
    9200:手机号格式正确但未注册
    9201:手机号已注册单未设置登录密码
    9202:密码不正确达到10次以上
} 


11 面单详情

接口描述
订单包Id搜索面单信息列表
接口消息定义
请求url:/group/waybill-detail.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    waybillNo:面单号,类型:String
    orderId:订单号,类型:String
}

响应消息体:


{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
    status:面单当前状态排序值,类型:int
    statusText:状态文案 类型String
    list:面单详情内容列表
       [{
            name: 标题 类型:String
            value:内容 类型:String,若需要展示不同颜色的内容,则传格式为html的字符串,如《html》《body》《font color='#FE751A'》¥ 4.0《/font》《/body》《/html》;取消状态,格式为:《html》《body》《font color='#FE751A'》¥ 114.0《/font》《font color='#929292'》(已返还)《/font》 
       }...]
  }
}


12 取消订单

接口描述
商家取消订单,请求体加是否确认取消
接口消息定义
请求url:/order/new-cancel.json
请求方法:GET/POST
请求消息体:


    {
        cityId:城市ID,类型:String
        shopId:商家ID,类型:String
        orderId:订单ID,类型 String
        groupId:订单包ID,类型 String
        sureCancel:确认取消,类型:Bool
    }

响应消息体:


    {
        status : 请求成功标志,1 成功 0 失败, 类型 : int
        data: 
        {
            successText:成功文案,类型:String
        }
        errorCode:3021,继续等待弹窗
                3022,建议增加小费弹窗
                3023,已加小费继续等待
        msg:提示文案,若文案中部分文案有颜色设置,则传html格式,如:《html》《body》您的订单预计在《font color='#1d6ff1'》0.1《/font》分钟内派出,建议继续等待~《/body》《/html》,类型:String
  }
}



13 商家登录信息

接口描述
商家登录接口
接口消息定义
请求url:/shop/shop-info.json
请求方法:GET/POST
请求消息体:


    {
        phoneNumber:手机号码,类型:String
        cityId:城市ID,类型:String
        appVersion:app版本号,类型:String
        source:当前操作系统版本号,类型:String
        shopId:商家ID,类型:String
        captcha:验证码,类型:String
        deviceId:设备编号,类型:String
        channelId:渠道编号,类型:String
        deviceIdentifier:设备绑定标识,类型:string
    }

响应消息体:


{
    {
    status:1,
    data:
    {
        verified: 验证状态,int
        verifyCn: 验证中文描述,string
        shopId: 商户id,int
        shopName: 商户名,string
        shopOwner: 商户店主名,string
        isBanned: 商家是否被禁用,0否1是
        bannedMsg: 商家被禁用文案信息,string
        tipPromptTime: 登录接口增加订单发布后给予增加小费的提示时间间隔,int
        addressInfo: 商户地址信息
        [{
            mobile: 手机号,string
            address: 地址,string
            lng: 经度(120165761),int
            lat: 维度(30315621),int
            distributionFee:单位为分的配送费 ,int
        }],
        bannerInfo: (下发了但无用,定义略)
        {
            bannerImageUrl: ,
            bannerJumpUrl: ,
            title: 
        },
        amMobile: AM电话,string
        areaCode: 区域编码,string
        hasNotify: 是否有强制阅读,0否1是
        notifyId: 强制阅读的ID,string
        notifyTitle: 强制阅读的标题,string
        notifyUrl: 强制阅读跳转URL,string
        cityId: 城市ID,int
        cityName: 城市名,string
        server: 服务地址,string
        token: apptoken,string
        distanceForTips: 增加小费提示的订单距离临界值,单位:米,int
        priceForTips: 增加小费提示的订单价格临界值,单位:元,double
        superiorReviewStatus: 商家优质商家审核状态,int
    0:未申请过优质商家,1:审核中,2:审核被拒,3:审核通过
        signRemindSevenDay:  是否7天未签约 类型 boolean true:是 false:否
        adPicUrl:登录页广告图片URL ,string
        weightList: 货品重量列表
        [
            {
                text:重量文案:例如:0-2公斤,类型:String
                weight:重量 例如1000;单位g,类型:int
            },
        ...
        ],
        addTipAmount: 提示增加多少小费 例:2.0 ,String 
        maxWeight:发单最大配置重量阈值 ,int
        loginMobile: 登录号码,string
        platformId: 平台ID ,int
        shopPlatformType: 商户类型,0:餐饮,1:同城,2:快递,int
        maxWaybillCount: 快递发单的最大单数,类型:int (默认40)

    }
} 


14 订单包Id搜索面单信息列表

接口描述
订单包Id搜索面单信息列表
接口消息定义
请求url:/group/query-waybill.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    groupId:订单包Id,类型:int
    cardType:卡片样式,0:不需要展示已投诉标签,1:需要展示已投诉标签
}

响应消息体:


{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
    groupId:快递包Id,类型:long
    groupCode:快递包Code,类型:String
    groupOrderCount:快递包订单量,类型:Int
    cancelCount:取消订单量,类型:Int
    abnormalCount:异常完成订单量,类型:Int
    currentStatusSort: 订单当前状态排序值,类型:int
    cancelList:已取消货品
        [
            {
                waybillNo:面单号,类型:String,
                orderId:订单ID,类型:String
                orderCode:订单Code,类型:String
                title:取消title,类型:String,
                reason:取消原因,类型:String
                complaintId:投诉Id,类型:String
            },
             ...
        ],
    abnormalList:异常完成货品
        [
            {
                waybillNo:面单号,类型:String,
                orderId:订单ID,类型:String
                orderCode:订单Code,类型:String
                finishTime:完成时间,类型:String
                title:异常title,类型:String,
                reason:异常原因,类型:String
                complaintId:投诉Id,类型:String
            },
             ...
        ],   
    normalList:发布中货品/待取货品/配送中货品/已完成货品
        [
            {
                waybillNo:面单号,类型:String,
                orderId:订单ID,类型:String
                orderCode:订单Code,类型:String
                finishTime:完成时间,类型:String
                complaintId:投诉Id,类型:String
            },
            ...
        ]
  }
}




15 快递下单获取配送费

接口描述
快递下单
接口消息定义
请求url:/order/express-charge.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    waybillNum:面单数,类型:Int
    toLng:客户纬度,类型:int
    toLat:客户经度,类型:int
}

响应消息体:



{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: {
    distributionFee: 总费用,int,单位:分
    desc: 费用描述,String
    serviceCharge: 优质商家服务费,String (快递商家无用)
    weatherChargeStr: 恶劣天气费,String (快递商家无用)
    chargeDetailList:费用明细,类型:list
    [
        {
            name:费用名称,类型:String
            fee:费用,类型:String
            desc: 费用中文描述,String
        },...
    ]
  }
  msg:
}


16 获取交易详情

接口描述
获取交易详情
接口消息定义
请求地址:/shop/get-balance-detail.json?
请求方法: get/post
请求消息体:


{
    shopId:商家Id,类型:String
    balanceId:交易Id,类型:int
}

响应消息体:


    {
    status: 1,
    data:{
        tradeType:交易类型,分为(1:适用交易类型:配送费、小费、退回配送费、退回小费)、(2:适用交易类型:取消订单扣款)、(3:适用交易类型:违规扣款(违规扣款)、工单扣款(违规扣款)、余额返回(申诉退款)、工单还款(申诉退款)、人工调整-增(系统补款)、人工调整-减(系统扣款))、(4:适用交易类型:充值、充值券充值)
        tradeTime:交易时间,取记录创建时间,时间为MM-DD HH:MM,类型:String
        desc:交易名(如 取消订单扣款),类型:String
        cost:金额,区分正负,类型:string
        rechargeWay:充值方式,支付宝或者银行卡,类型:String
        orderId:订单号,类型:long
        orderCode: 订单Code,String
        groupId:订单包Id,long
        groupCode:订单包Code,String
        tips:说明(多个原因以|分割),类型:String
        urlDesc:页面底部按钮文案,类型:String,如商家管理规则
        url:页面底部h5链接,类型:String
    },
    msg:“”
    errorCode:错误码,类型:int
}




17 查询余额接口

接口描述
查询余额接口
接口消息定义
请求url:/shop/balance.json
请求方法:GET/POST
请求消息体:


    {
        cityId:城市ID,类型:String
        shopId:商家ID,类型:String
    }

响应消息体:


    {
        balance: 账号余额,int,单位:分
        balanceDisplay: 账号余额中文,String
        rechargeDiscountTip:充值满多少赠多少活动文案,无活动传空字符串,类型:string ,
        rechargePriceList: 快捷输入金额,无活动传空list
    [
        100,类型:int
        200,
        300,...
    ]
        couponCount: 优惠券数量,int
        score: 积分值,int
    },
        errorCode:10011,绑定异常,类型:int
        msg:
    }




18 工单进度列表

接口描述
获取工单进度(投诉、申诉、举报)列表
接口消息定义
请求url:/common/complaint-list.json
请求方法:GET/POST
请求消息体:


    {
        cityId:城市ID,类型:String
        shopId:商家ID,类型:String
        workorderType:工单类型,0:投诉-处理中,1:投诉-已完成,2:申诉记录,3:反馈举报
        page:分页索引,类型:int
        groupId:订单包ID(查询订单包的投诉详情时才传值,其他情况不校验),类型:String
        orderIds:订单包组合集(用|分割)(查询订单包组的投诉详情时才传值,与groupId互斥),类型:String
    }

响应消息体:


{
    status:"1",
    data:
    {
        currentPage:分页索引,返回该请求上发的page值,类型 : int
        pageCount:总页数,类型 : int
        list:[{
            wid:工单Id,类型:String
            type:列表的标题 类型string 如:申诉 ,投诉商家,投诉平台等;
            time:投诉、申诉、举报时间,类型:String 如:2017-09-20 20:20 或者 今天 10:10
            resasonDesc: 工单原因描述 类型String 如 投诉原因、举报原因、申诉原因
            reason:工单原因,类型:String
            resultDesc: 工单结果描述 类型String 如 投诉结果、举报结果、申诉结果
            result:工单结果,类型:String
            status:进度状态,0:处理中,1:已完成,类型:Int
            waybillNo:面单号,类型:String (仅针对快递商家)

        },...],

        }
    msg:
} 




19 处罚记录列表

接口描述
获取商家处罚记录列表
接口消息定义
请求url:/common/punish-list.json
请求方法:GET/POST
请求消息体:


    {
        cityId:城市ID,类型:String
        shopId:商家ID,类型:String
        page:分页索引,类型:int
    }

响应消息体:


{
    status:"1",
    data:
    {
        currentPage:分页索引,返回该请求上发的page值,类型 : int
        pageCount:总页数,类型 : int
        list:[{
            orderId:订单Id,类型:String
            serialId:订单流水号,类型:String
            platformDesc :平台中文描述,类型:String (如:美团外卖)

            timeDesc:扣罚时间描述,类型:String 如今天只显示“12:34”,昨天显示“昨天 12:34”,更早显示“2018-02-01 12:34"
            time:扣罚时间,类型:String 如"2018-02-01 12:34"
            resasonDesc: 商家取消订单的原因
            resultDesc:扣罚结果,类型:String 如 (-6.0元(扣罚))
            status:申诉状态,0:未申诉,1:已发起过申诉,类型:Int
            platformId:平台ID ,int 如 饿了么 0;
            appealId:申诉ID,string
        },...],

        }
    msg:
} 


20 获取所有商家类型列表

接口描述
获取所有商家类型列表信息
接口消息定义
请求url:/common/get-shop-type-list.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
}

响应消息体:


{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: {
    list:[
        {
            shopType:商户类型,类型:int
            shopTypeCn:商户类型中文,类型:string
            hasDetailBranch:有无细分渠道类型,类型:bool
            tip:商户类型描述,类型:string
        },...
    ]
  }
  msg:
}


21 验证能否追加订单接口

接口描述
商家向骑手追加订单时,点击追加订单按钮时进行校验是否能给骑手追加订单
接口消息定义
请求url:/shop/judgeSupplemented.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:int
    shopId:商家ID,类型:int
    riderId:骑手ID,类型:int
}

响应消息体:


{
    status:能否追加,1:可以,0:不可以,类型:int
    data:
    {
        successText:""
    }
    msg:不能追加的错误信息提示,类型:String
} 


22 优惠券列表查询接口

接口描述
APP端优惠券列表获取数据,根据优惠券状态不同类型,分页请求,每页最多20条数据
接口消息定义
请求url:/shop/get-coupon-list.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    status:优惠券状态,类型:int 1.未使用 2.已使用 3.已过期
    page:分页索引,类型:int 第一页索引为1
}

响应消息体:


{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
    page:分页索引,返回该请求上发的page值
    totalCount:该类型下的优惠券总张数
    list:[
        {
            id:优惠券id,类型:int
            value:优惠券面值,类型:double,单位:元, 如果是折扣券,该字段为最高抵扣面值
            name:优惠券名称,类型:string
            validDate:优惠券有效期,类型:string,格式:YYYY-MM-DD
            validTime:优惠券使用时间段,类型:string,例:仅11:30-13:30、16:30-18:30可用
            thresholdCn:优惠券启用门槛提示文案,类型:string,例:满25可以用
            threshold:优惠券启用门槛金额,类型:double,单位:元
            discount:折扣,如0.7,类型:double
            discountCoupon:是否是折扣券,类型:bool
            useStatus:优惠券使用状态,类型:int 
            0:可使用,1:已使用,2:已过期,3:使用中
            couponType:优惠券种类 类型:int  1:小费券 2:运费券 3:充值券
            overdueDate:过期时间 类型:string 如:2天后过期
        }
        ...],
    ]
  }
}


23 微信支付接口

接口描述
获取微信支付接口
接口消息定义
请求地址:/abcbank/weixin-pay-paramstr.json?
请求方法: get/post
请求消息体:


{
    shopId:商家Id,类型:String
    amount:金额double,单位为元
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    couponId:优惠券ID,类型:String
}

响应消息体:


{ 
    status:1 
    data:{ 
        partnerId:商家向财付通申请的商家id,类型:String
        prepayId:预支付订单,类型:String
        nonceStr:随机串,防重发,类型:String
        timeStamp:时间戳,防重发,类型:String
        packageValue:商家根据财付通文档填写的数据和签名,类型:String
        wxSign:商家根据微信开放平台文档对数据做的签名,类型:String
        tradeNo:微信支付交易单号,类型:String
        } 
    msg:优惠券已锁定
}          


24 支付宝支付接口

接口描述
获取支付宝支付接口
接口消息定义
请求地址:/abcbank/pay-paramstr.json?
请求方法: get/post
请求消息体:


{
    shopId:商家Id,类型:String
    amount:金额double,单位为元
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    couponId:优惠券ID,类型:String
}

响应消息体:


{ 
    status:1 
    data:{ 
        paramStr:"_input_charset=\"utf-8\"&body=\"\U70b9\U6211\U5427VIP\U5f00\U901a\"&it_b_pay=\"30m\"¬ify_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\""
        } 
    msg:优惠券已锁定
}          

25 确认微信支付结果

接口描述
微信SDK返回客户端支付成功信息后,客户端需要向服务器确认支付结果
接口消息定义
请求url: /common/check-pay-result.json
请求方法:GET/POST
请求消息体:


    {
        cityId:城市ID,类型:String
        shopId:商家ID,类型:String
        tradeNo:交易单号,类型:String
    }

响应消息体:


    {
        tradeStatus: 0|未查询到成功记录,1|成功,类型:int
    }


26 银联支付的url接口

接口描述
银联支付的url接口
接口消息定义
请求地址:/abcbank/getIePaymentUrl.json
请求方法: get/post
请求消息体:


{

    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    amount:金额,类型:String
    couponId:优惠券ID,类型:string
    notifyUrl:
}

响应消息体:


{
    status:"1",
    data:
    {
        paymentUrl:"",回签地址
    }
    msg:优惠券已锁定
} 


27 交易列表接口

接口描述
交易列表查询
接口消息定义
请求url:/shop/trade-list.json
请求消息体:


{
    shopId:商家Id,类型:String
    cityId:城市Id,类型:String
    page:分页索引,类型:int
}

响应消息体:


    {
        status : 请求成功标志,1 成功 0 失败, 类型 : int
        data: 
        {
            currentPage:分页索引,返回该请求上发的page值,类型 : int
            pageCount:总页数,类型 : int
            list:[
                {
                    monthCN:月份中文描述,类型 : String,如果是当月就显示本月,如果不是本月,则显示yyyy年mm月
                    month:类型String ,月份,格式YYYY-MM
                    monthlyTradeList:[
                        {
                            weekDay:周几,类型:String,除今天、昨天、前天之外的天数显示周几
                            day:具体日期,格式:YYYY-MM-DD,类型String,用于查询日交易明细列表
                            date:日期,格式为mm-dd,类型:String
                            recharge:充值,类型:String
                            expend:支出,类型:String
                            refund:退款,类型:String
                        }


                    ]
                },
                ...]
         }
    }


28 月交易明细统计

接口描述
每日交易详细查询
接口消息定义
请求地址:/shop/trade-month-info.json?
请求方法: get/post
请求消息体:


{
    shopId:商家Id,类型:String
    cityId:城市Id,类型:String
    month:具体月份,格式:或者YYYY-MM,类型String
}

响应消息体:


{
    status:"1",
    data:
    {
        startDate:月统计可选日期区间的开始时间(具体到月份),如:2017-06,类型:String
        endDate:月统计可选日期区间的结束时间(具体到月份),如:2017-06,类型:String
        recharge:充值
        {
            total:充值总额,类型:String,如+100.0
            list:[
                {
                    title:名称,类型:String
                    percent:占比,类型:double
                    amount:金额,类型:String
                    tradeType:交易类型,类型:String
                },...
            ]
        }
        expend:支出
        {
            total:支出总额,类型:String,如+100.0
            list:[
                {
                    title:名称,类型:String
                    percent:占比,类型:double
                    amount:金额,类型:String
                    tradeType:交易类型,类型:String
                },...
            ]

        }
        refund:退款
        {
            total:退款总额,类型:String,如+100.0
            list:[
                {
                    title:名称,类型:String
                    percent:占比,类型:double
                    amount:金额,类型:String
                    tradeType:交易类型,类型:String
                },...
            ]
        }
    }
}    


29 筛选日交易明细

接口描述
每日交易详细查询
接口消息定义
请求地址:/shop/trade-day-list.json?
请求方法: get/post
请求消息体:


{
    shopId:商家Id,类型:String
    cityId:城市Id,类型:String
    page:分页索引,类型:int
    day:具体日期,格式:YYYY-MM-DD,类型String
    queryType:筛选条件,类型:int,0:全部,1:支付配送费,2:退款,3:支付消费,4:充值,5:其它
}

响应消息体:


{
    status:"1",
    data:
    {
        recharge:充值,类型:String
        expend:支出,类型:String
        refund:退款,类型:String
        queryTitle:有筛选条件时的标题,类型:String,例如:共支付配送费
        queryAmount:有筛选条件时的金额,类型:String,例如:-22.0
        list:
        [
            {
                tradeDesc:"支付宝充值",
                tradeTime:"19:10"
                tradeAmtDesc:"+6.0"
                tradeId:交易Id
                orderId:订单Id
                orderCode:订单code
                queryType:分类,类型:1:支付配送费,2:退款,3:支付小费,4:充值,5:其它
            },
            {...}
        ],

        currentPage = 1;
        pageCount = 1;
    }
}    


30 获取所有商家类型列表

接口描述
获取所有商家类型列表信息
接口消息定义
请求url:/common/get-shop-type-list.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
}

响应消息体:


{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: {
    list:[
        {
            shopType:商户类型,类型:int
            shopTypeCn:商户类型中文,类型:string
            hasDetailBranch:有无细分渠道类型,类型:bool
            tip:商户类型描述,类型:string
        },...
    ]
  }
  msg:
}


31 获取优质商家套餐列表接口

接口描述
获取优质商家可选套餐列表
接口消息定义
请求url:/shop/superiorChooseList.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
}

响应消息体:



{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
    list:[
        {
            name:商家套餐名称,类型:string
            id:商家套餐Id,类型:int
            price:对应商家套餐价格,类型:int
        },
        {...}
    ]
  }
  msg:
}


32 申请开通优质商家接口

接口描述
商家发起开通优质商家请求
接口消息定义
请求url:/shop/requestSuperior.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    superiorId:可选套餐Id,类型:int
}

响应消息体:



{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
    successText:"申请成功"
  }
  msg:
}


33 可用优惠券数量接口

接口描述
可用优惠券数量接口
接口消息定义
请求url:/common/coupon-count.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    type:优惠券类型,类型:int, 1.小费券 2.运费券 3.充值券,4:小费券+运费券 
    distance:配送距离,类型:int,type包含运费券时,必传
    fee:配送费用(单位为分),类型:int,type包含运费券时,必传
    extraFee:已加小费,单位分,类型:int,type包含小费券时,必传
    rechargeFee:充值金额,单位为分,类型:int,type包含充值券时,必传
}

响应消息体:


{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
    totalCount:可用并满足筛选条件的优惠券总张数
  }
}


34 搜索今日订单接口

接口描述
搜索商家当日订单
接口消息定义
请求url:/order/query-today-order.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    riderId:骑手ID,类型:String,传0不指定骑手
    searchStr:搜索内容,类型:String
    page:页面索引,类型:int
}

响应消息体:


{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
     orderList:[
     {
        serialId:订单流水号,类型:int
        platformDesc:平台名称,类型:String
     },{...}
     ]
  }
}


35 今日订单列表接口

接口描述
新增下发字段,流水号、接单时间、取消时间
接口消息定义
请求url:/order/today-list.json
请求方法:GET/POST
请求消息体:


{
    shopId:商家id,类型:int
    cityId:城市id,类型:int
    status:订单状态,类型:int
    0:所有,1:已完成,2:未完成,3:异常
    page:分页索引,类型:int
    cardType:卡片样式,0:不需要展示已投诉标签,1:需要展示已投诉标签
}

响应消息体:


{
    {
    status:"1",
    data:
    {
        totalNum:今日订单数量总计,类型:int
        finishNum:已完成订单数量,仅当请求参数status为0时返回值,类型:int
        unfinishNum:未完成订单数量,仅当请求参数status为0时返回值,类型:int
        exceptionNum:异常订单数量,仅当请求参数status为0时返回值,类型:int
        orderList:订单列表集合
        [
            {
                orderId: 订单编号,类型:int,
                orderCode:订单code, string
                isResident: 是否为驻店单,类型:BOOL
                address: 客户地址,类型:String
                currentStatus: 订单当前状态,类型:int
                currentStatusCn: 订单当前状态文字,类型:String
                currentStatusSort: 订单当前状态排序值,类型:int
                platformDesc: 订单平台类型中文,类型:String

                placeTime: 下单时间,类型:String,格式"HH:mm"
                isTodayOrder: 是否是今日订单,类型:BOOL,
                phone: 客户电话,类型:String
                feeDisplay: 配送费中文显示,类型:String
                timeStr:各状态时间文案,如:"取消时间:2017-07-25 12:34" 类型:String
                groupId: 订单编号,类型:int,
                groupCode:订单code,string
                groupOrderCount:快递包订单量,类型:String
                cancelCount:取消订单量,类型:Int
                abnormalCount:异常完成订单量,类型:Int
                hasComplaint:已发起投诉,类型:Bool

            },
            {...}
        ]
    }
} 


36 更早订单列表接口

接口描述
我的订单页面更早订单列表页面,下单时间早于今天的,查询最多30天,分页查询,每页最多20条
接口消息定义
请求url:/order/earlier-list.json
请求方法:GET/POST
请求消息体:


{
    shopId:商家id,类型:int
    cityId:城市id,类型:int
    timeType:时间搜索条件,类型:int
    0:近30天,1:近一周,2:指定时间段
    startDate:查询开始时间,类型:String,格式:YYYY-mm-DD,该字段仅当timeType=2有效
    endDate:查询结束时间,类型:String,格式:YYYY-mm-DD,该字段仅当timeType=2有效
    page:分页索引,类型:int
    cardType:卡片样式,0:不需要展示已投诉标签,1:需要展示已投诉标签
}

响应消息体:


{
    {
    status:"1",
    data:
    {
        earlierNum:近30订单数量总计,类型:int
        weekNum:近一周订单数量总计,类型:int
        dateIntervalNum:指定查询时段数量总计,类型:int ,仅在timeType=2时返回
        todayDate:今天的日期,类型:String 如:2017-5-28
        startDate:选择查询时段开始日期,类型:String,如:2017-5-28
        endDate:选择查询时段结束日期,类型:String 如:2017-5-28
        yesterdayNum:昨天订单数量总计,类型:int
        beforeYestserNum:前天订单数量总计,类型:int
        orderList:订单列表集合
        [
            {
                orderId: 订单编号,类型:int,
                address: 客户地址,类型:String
                currentStatus: 订单当前状态,类型:int
                currentStatusCn: 订单当前状态文字,类型:String
                currentStatusSort: 订单当前状态排序值,类型:int
                platformDesc: 订单平台类型中文,类型:String
                feeDisplay: 配送费中文显示,类型:String
                isResident: 是否为驻店单,类型:BOOL
                isTodayOrder: 是否是今日订单,类型:BOOL,
                phone: 客户电话,类型:String

                placeTime: 下单时间,类型:String,格式"HH:mm"
                timeStr:各状态时间文案,如:"取消时间:2017-07-25 12:34" 类型:String

                groupId: 订单编号,类型:int,
                hasComplaint:已发起投诉,类型:Bool
                groupOrderCount:快递包订单量,类型:String
                cancelCount:取消订单量,类型:Int
                abnormalCount:异常完成订单量,类型:Int
            },
            {...}
        ]
    }
} 


37 搜索今日+近30日订单接口

接口描述
我的订单页面根据用户输入,搜索今日+近30日,总计31天的订单,分页查询,每页最多20条
根据用户输入内容,从订单流水号、客人地址、客人电话三个维度搜索
接口消息定义
请求url:/order/search-all.json
请求方法:GET/POST
请求消息体:


{
    shopId:商家id,类型:int
    cityId:城市id,类型:int
    page:分页索引,类型:int
    searchStr:搜索字符串,类型:String
}

响应消息体:


{
    {
    status:"1",
    data:
    {
        orderSum:匹配到的订单总数,用于分页,类型:int
        orderList:订单列表集合
        [
            {
                orderId: 订单编号,类型:int,
                address: 客户地址,类型:String
                phone: 客户电话,类型:String
                currentStatus: 订单当前状态,类型:int
                currentStatusCn: 订单当前状态文字,类型:String
                currentStatusSort: 订单当前状态排序值,类型:int
                isResident: 是否为驻店单,类型:BOOL
                feeDisplay: 配送费中文显示,类型:String
                isTodayOrder: 是否是今日订单,类型:BOOL,
                platformDesc: 订单平台类型中文,类型:String

                placeTime: 下单时间,类型:String,格式"HH:mm"
                timeStr:各状态时间文案,如:"取消时间:2017-07-25 12:34" 类型:String
            },
            {...}
        ]
    }
} 


38 快递商家搜索今日或今日+30日订单接口

接口描述
快递商家搜索今日或今日+30日订单订单接口
接口消息定义
请求url:/group/search-all.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    searchType:搜索类型,0:今日,1:今日+30日订单,类型:int
    searchStr:搜索内容为面单号或地址,类型:String
    page:页面索引,类型:int
}

响应消息体:


{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
     currentPage:当前页面 类型 int
     pageCount: 页面总数 类型int
     orderList:[
        {
            groupId:快递包Id,类型:String
            groupOrderCount:快递包订单量,类型:Int
            cancelCount:取消订单量,类型:Int
            abnormalCount:异常完成订单量,类型:Int
            serialId:订单流水号,类型:int
            address:收件地址,类型:String
            distance:配送距离,带单位,如"2.5km",类型:String
            waybillNoList:面单号搜索结果
            [
                E134365431545,
                E134365431545,
                E134365431545,
                ...
            ]
     },{...}
     ]
  }
}




39 获取骑手定位接口(修改)

接口描述
新增根据订单(包)id获取骑手定位和订单状态
接口消息定义
请求url:/order/get-rider-location.json
请求方法:GET/POST
请求消息体:


{
    shopId:商家id,类型:int
    cityId:城市id,类型:int
    orderId:订单id,类型:int
    groupId:订单包id,类型:int
}

响应消息体:


{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
    riderLng:配送员经度,类型:String
    riderLat:配送员纬度,类型:String
    riderText:地图上显示的骑手状态文案(html格式),部分文案有颜色差异,类型:String
    currentStatusSort: 订单当前状态排序值,类型:int
  }
}


40 服务中心异常单列表

接口描述
服务中心可能有疑问的订单列表
接口消息定义
请求url:/order/exception-order-list.json
请求方法:GET/POST
请求消息体:


{
    shopId:商家id,类型:int
    cityId:城市id,类型:int
}

响应消息体:


{
    status:"1",
    data:
    {
        orderList:订单列表集合
        [
            {
                orderId: 订单编号,类型:string,
                serialId: 流水号,类型:int
                currentStatus: 订单当前状态,类型:int
                currentStatusCn: 订单当前状态文字,类型:String
                orderSourceCn: 订单平台类型中文,类型:String
                phone: 客户电话,类型:String  
                address: 客户地址,类型:String
                timeStr:各状态时间文案,如:"取消时间:2017-07-25 12:34" 类型:String
            },
            {...}
        ]
    }


41 服务中心常见问题配置

接口描述
服务中心常见问题配置
接口消息定义
请求url:/common/question-setting.json
请求方法:GET/POST
请求消息体:


{
    shopId:商家id,类型:int
    cityId:城市id,类型:int
}

响应消息体:


{
    status:"1",
    data:
    {
        list:
        [
            {
            code:0,序号,类型:int
            questions:
            [
                {
                name:列表标题,类型:string (如:我要反馈)
                url:跳转的H5链接,类型:string
                },
                ...
            ]
            },
            {
            code:1,
            questions:
            [
                {
                name:列表标题,类型:string (如:我要反馈)
                url:跳转的H5链接,类型:string
                },
                ...
            ]
            },
            ...
        ]
    }




42 通知消息列表

接口描述
通知消息列表
接口消息定义
请求url:/common/notifyList.json
请求方法:GET/POST
请求消息体:


{
    lastNotifyId:long
}

响应消息体:


{
    {
    status:"1",
    data:
    {
    sum: 总数,int
        notifyList: [{
            id: 通知id,int
            title: 标题,string
            content:内容 ,string
            time: 时间,string
            url: H5展示地址,string
            status: 状态,int
            isRead: 是否已读,bool
            categoryId: 分组ID,int
            priority: ,
            labelText: 通知文案提醒,
            h5TemplateId: H5,
            image:图片地址,String
            displayMode: 展示类型,int
            jumpMethod: 跳转枚举,int
        }, {
        ...
    }
} 


43 BD信息获取

接口描述
BD信息获取
接口消息定义
请求url:/common/get-bd-list.json
请求方法:GET/POST
请求消息体:


    {
        cityId:城市ID,类型:String
        shopId:商家ID,类型:String
        lng:商家经度,类型:String
        lat:商家纬度,类型:String
        shopType:商家类型,类型:int
        branchType:商家子类型,类型:int
        bdName:bd姓名,类型:string
    }

响应消息体:


{
    {
    status:"1",
    data:
    {
       list:[
       {
           name:BD姓名,类型:String
           code:bdCode,类型:int
       },...]
    }
} 


44 设置登录密码

接口描述
设置登录密码
接口消息定义
请求url:/common/set-password.json
请求方法:GET/POST
请求消息体:


    {
        cityId:城市ID,类型:String
        phoneNumber:手机号码,类型:String
        password:密码,类型:String,
        type:业务类型,类型:String
            (1)setPassword:设置登录密码
            (2)findPassword:找回密码
        certificate:校验凭证,类型:String
    }

响应消息体:


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


45 城市列表

接口描述
获取城市列表
接口消息定义
请求url:/common/city-list.json
请求方法:GET/POST
请求消息体:


{
    shopId:商家id,类型:int

}

响应消息体:


{
    status:"1",
    data:
    {
        list:[
            {
                initial:城市首字母索引,类型:String
                cityList:[
                    {
                        cityName:城市名称,类型:String
                        lat:城市纬度,类型:int
                        lng:城市经度,类型:int
                    },
                    ...
                ]
            },
            ...
        ]
    }




46 获取cityId

接口描述
获取cityID
接口消息定义
请求url:/apis/common/shop/get-city.json
请求方法:GET/POST
请求消息体:


{
    lng,
    lat,
    appVersion,app版本号
    source,平台,ios,android
    cityName,城市中文名,String
}

响应消息体:



{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: {
    cityOpen:城市是否开通,类型:bool
    cityId:城市ID,int
    cityName:城市名称,String
    server:服务地址,string
  }
  msg:
}

47 检测更新

接口描述
检测更新
接口消息定义
请求url:/common/check-app-update.json
请求方法:GET/POST
请求消息体:


    {
        cityId:城市ID,类型:String
        shopId:商家ID,类型:String
        version:版本号,类型:String
        source:手机厂商,类型:String
        client:系统版本号,类型:String
        systemCode:请求来源,类型:String
    }

响应消息体:


   {
    "status": 1,
    "data": {
        "updateType": 更新类型,类型:int
        "url": 安装包URL,类型:String
        "latestVersion": "4.1.1",
        "tips": "1.骑手评价功能,可以对骑手进行打分、评价\n2.追加发单方式,在首页就可以便捷追加单\n3.订单详情页,状态更新更及时",
        "md5": "",
        "apkMd5": "f4afb11b1434d429eeb4823ea34a6ff8",
        "weexConfigVersion": "",
        "weexConfigUrl": "",
        "weexConfigMD5": "",
        forceUpdateVersion:{  强更版本信息
            updateType: 更新类型,类型:int
            url: 安装包URL,类型:String
            version:版本号,类型:String
            tips:更新文案,类型:String
            apkMd5: apk的md5值
        }
    },
    "msg": "",
    "errorCode": "",
    "extraMsg": ""
}


48 定时轮询接口

接口描述
每15秒请求
接口消息定义
请求url:/common/monitor.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    lng:商家经度,类型:int
    lat:商家纬度,类型:int
    deviceId:商家设备码,类型:String
    patchVersion:补丁版本号,类型:String
}

响应消息体:



{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
   fastArrivalTime:最近骑士到达时间,单位分钟,类型:int
    fastArrivalTimeDisplay:最近骑士到达时间显示文案,类型String
    hasNotify:是否有新通知(1有,0无),类型:int
    isBanned:黑名单(1-是,0-不是),类型:int
    bannedMsg:禁用文案,类型:String
    isKick:是否被下线(1下线,0正常),类型:int
    reviewStatus:商家审核状态,类型:int
    0-未审核,5-审核中,9-审核被拒,10-审核通过
    hasResident:定向服务(0-无,1-有),类型:int
    radius:下单最大距离限制(单位:米),类型:int
    orderNotify:是否有订单变化(1有,0无),类型:int
    hasOrderCancel:骑手取消订单且选择“商家要求我取消”(0-无,1-有),类型:int
    reviewStatus : 商家审核状态 类型 String  0-未备案 5-验证中 7-备案成功未签约 8-验证失败 9-签约失败 10-已验证
        reviewStatusDisplay: 审核状态描述 类型 String 0-“” 5-验证中 7-待签约 8-验证失败 9-签约失败 10-已验证
        supplementedOpened:是否开启追加单功能,类型:BOOL,TRUE:是,FALSE:否
        signRemindSevenDay: 是否7天未签约 类型 boolean true:是 false:否
        exceptionOrder: 订单主页是否需要显示异常tab,类型:BOOL
        orderTimeOutCancel: 订单超时取消语音播报,类型:BOOL
        shopPlatformType:商家业务类型 0:默认 1:同城(跑腿)业务,类型:int
        serverTime:服务器时间,类型:String
        levelUpgrade: 等级升级,类型:Bool
        shopLevel:当前等级,类型:Int
        shopLevelName:当前等级名称,类型:String
        couponBag:优惠券大礼包,类型:Bool
        bannerNotify:banner变化通知,ture为有变化,类型:Bool
        reviewPassCouponBag:验证通过新人大礼包,类型:Bool
        couponOverdueRemind:优惠券过期提醒,包含首页气泡文案和侧边栏气泡文案,用|分割,如:价值400元运费券即将过期|4张优惠券即将过期,类型:String
  }
  msg:
}


49 轮询回执接口

接口描述
接到通知后,回执给服务端
接口消息定义
请求url:/common/monitor-response.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    receiveOrderTimeOutCancelNotify:收到系统取消单回执,类型:int
    receiveLevelUpgradeNotify:收到等级升级回执,类型:int
    receiveCouponBagNotify:收到优惠券大礼包回执,类型:int
    receiveBannerNotify:收到新广告回执,类型:int
    receiveReviewPassCouponBagNotify:收到验证通过新人大礼包回执,类型:int
    receiveCouponOverdueRemindNotify:收到优惠券过期提醒回执,类型:int

}

响应消息体:


{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
  }
}




50 获取历史地址

接口描述
根据手机号获取历史地址
接口消息定义
请求url:/order/get-address-list.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    mobile:电话号码,类型:String
    num:显示的地址的条数,类型:int
}

响应消息体:



{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: {
    "addressList":[
        {
             addr:历史地址,类型:String
             lng:历史地址经度,类型:int
             lat:历史地址纬度,类型:int
             outOfRange:是否超范围,类型:boolean
             matchType:地址匹配类型,类型:int
                    1:手机号匹配类型
                    2:录入人匹配类型
        }
    ]
  }
  msg:
}


51 等级体系详情

接口描述
等级体系,相应特权
接口消息定义
请求URL:/shop/levels.json
请求方法: get/post
请求消息体:


{
  cityId: 城市Id,类型:int
  shopId:商家Id,类型:int
}

响应消息


{
  status: 1,
  data:{
    shopLevel:当前等级,类型:int
    shopLevelName:当前等级名称文案,类型:string
    examCycle:考核周期,类型:String
    levelExplainUrl:等级说明URL,类型:String
    privilegeUrl:等级权限URL,类型:String
    upgradeUrl:等级升级跳转Url,类型:String
    levelList:[
        {
         level:等级,类型:int
         levelName:等级名称,类型:String
         rightList:[
            {
                rightType:特权类型,1:积分类型|2:优惠券|3:折扣|4:客服|5:短信|6:优先派单|7:免责取消,类型:int
                text:专属特权文案,类型:String
                rightEnjoy:是否拥有该特权,类型:bool
                redPoint:是否显示提示标记

            },...
         ]
       }
    ]
    upgradeTitle:升级标题,类型:String
    upgrade:[
        {
            chartTitle:图表标题,类型:String
            scale:进度条比例,类型:double
            progress:进度,如:还需\r\n20单
            bigText:需要放大的text:专属特权文案,类型:String
        },...
    ]
  },
  msg:“”
}




52 获取商家信息

接口描述
获取商家信息
接口消息定义
请求url:/shop/detail.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
}

响应消息体:



{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: {
    shopId: 商家ID,
    shopName: 商家名,string
    shopOwner: 店主名,string
    username: 登录号码,stirng
    phone: 电话号码,string
    tel: 电话号码,string
    address: 地址,string
    lng: 120165761,double
    lat: 30315621,double
    identifyId: 身份证号,string
    credentialsType: 证件类型,int
    zhimaVerified: 芝麻认证,bool
    identifyImgUrl:身份证照图片地址 ,string
    identifyBackImgUrl: 身份证背面照图片地址 ,string
    photoImgUrl: ,//废弃
    identifyWithShopImgUrl: ,//废弃
    verified: 认证状态,int
    verifyTime: 认证时间,string
    verifyCn: 认证状态中文,string
    shopType: ,
    shopTypeCn: ,
    failedReason:失败原因枚举 ,string
    failedReasonCn:失败原因中文 ,string
    tradingAreaId:区域id ,int
    tradingAreaName: 区域描述,string
    amMobile: am电话,string
    newServiceType: 服务类型,int
    newServiceName: 服务类型中问,string
    regionId: ,
    cityId: ,
    bdCode: ,
    bdName: ,
    insTm: 2017-08-30 15:44:29,
    csTel: 客服电话,   
    htmlSignature:h5签名,类型:String
    buyRiderLocMsgShowed:是否需要显示购买骑手定位短信入口,类型:boolean 
    true  显示 false 不显示(接口下发:riderLocMsgShowed)
    riderLocMsgBuyed:是否购买过骑手定位短信,类型:BOOL
    true:购买过 false:未购买
    verified:类型:int  0:"" 5:"验证中" 7:"待签约" 8:"验证失败" 9:"签约失败" 10:"已验证"
    verifyCn:类型:String  0:"" 5:"验证中" 7:"待签约" 8:"验证失败" 9:"签约失败" 10:"已验证"
    signRemindSevenDay: 7天未签约提醒,类型:boolean 
    customerMsgOpen:收货人短信通知,类型:Bool
    shopPlatformType:商家业务类型 (0.默认餐饮业务,1. 同城业务)类型:int
    shopLevel:商家等级枚举,类型:int
        1:普通商家  2:青铜商家  3:白银商家  4:黄金商家  5:钻石商家
     superiorTime:优质商家服务剩余使用期限,类型:String 例:剩余期限:4天
    superiorReviewStatus:商家优质商家审核状态,类型:int
    0:未申请过优质商家,1:审核中,2:审核被拒,3:审核通过
    shopLevelName:商家等级名称,类型:String
    couponCount:优惠券总张数,类型:Int
    score:我的积分,类型:int
    exSiteCode:快递站点编码,类型:String
    balance:当前可用余额,单位:分
    shopNameOnly:商户名称,类型:String
    branchType:商户细分类型,类型:String
    branchTypeCn:商户细分类型中文,类型:String

  }
  msg:
}


53 短信验证码校验

接口描述
获取短信验证码
接口消息定义
请求url:/common/check-captcha.json
请求方法:GET/POST
请求消息体:


    {
        cityId:城市ID,类型:String
        mobile:手机号,类型:String
        captcha:验证码,类型:String
        type:业务类型,1:设置登录密码“setPassword” 2:找回密码“findPassword”,类型:String
    }

响应消息体:


{
    {
    status:"1",
    data:
    {

       hasSetPassword:是否已经设置过密码,类型:boolean
       successText:成功文案
       certificate:剩余操作需要的验证码校验成功凭证,类型:String
    }
    msg:
} 


54 设置收货人短信通知

接口描述
设置收货人短信通知
接口消息定义
请求url:/shop/set-customer-message.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    open:收货人短信通知,类型:Bool
}

响应消息体:



{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: {
    customerMsgOpen:收货人短信通知,类型:Bool
  }
  msg:
}




55 获取天气指数接口

接口描述
APP端获取商家注册经纬度天气指数,客户端5分钟请求一次
接口消息定义
请求url:/shop/weather-pressure.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    lat:商家注册地址纬度,类型:int
    lng:商家注册地址经度,类型:int
}

响应消息体:


{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
    weatherType:天气类型,类型:int,具体枚举值已服务端给的为准
    0:普通 1:雨 2:雪 3:高温
    pressured:是否开启客户端压力提示,类型:int,1:开,0:关
  }
}


56 广告banner页面

接口描述
广告banner页面
接口消息定义
请求url:/common/banner.json
请求方法:GET/POST
请求消息体:


{
    cityId:城市ID,类型:String
    shopId:商家ID,类型:String
    locationPage:位置标志(1-首页滚动广告位,2-首页弹窗广告位,3-首页小黄条,4-充值页面小黄条),类型:int
}

响应消息体:


{
  status : 请求成功标志,1 成功 0 失败, 类型 : int
  data: 
  {
    bannerList:[
        {
            bannerId:标志ID,类型:int
            imageUrl:显示图片下载地址,类型:String
            url:跳转url(如果是跳转到普通网页,则为空),类型:String
            paramType:跳转到原生界面,类型:int,1:充值界面,2:查看优惠券界面,3:等级权益界面
            message:黄条文案,类型:String
            appearType:banner展示机制,类型:int,
                0:点击查看后消失
                1:点击x号后消失
                2:有效期内一直展示
                3:有效期内每天只展示一次
                4:有效期内每次都展示
        },...
    ]
  }
}

57 客服SDK降级

接口描述
客服系统SDK降级
接口消息定义
请求url:/common/get-sdk-open.json
请求方法:GET/POST
请求消息体:


    {
        cityId:城市ID,类型:String
        shopId:商家ID,类型:String
    }

响应消息体:


    {
        status : 请求成功标志,1 成功 0 失败, 类型 : int
        data: 
        {
            nySDKOpen:南邮SDK是否使用,类型:bool
            appId: 南邮sdk账号id
            appPsd: 南邮sdk 账号密码
        }
  }
}




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