@zhuchao941
2018-10-08T07:05:39.000000Z
字数 82909
阅读 5682
接口为点我达商家客户端和平台之间的接口,客户端通过此接口获取用户和内容信息,并且完成用户操作数据的上传
请求消息和应答消息体采用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
接口描述
查询商家周边骑手,调用机制保持和原先一致,monitor接口中下发的interval字段来决定该接口调用的频率
接口消息定义
请求地址:/shop/rider-nearby-list.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型String
shopId:商家ID,类型:String
lng:商家经度,类型:String
lat:商家纬度,类型:String
}
响应消息
{
status:"1",
data:
{
fastArrivalTime:最近一个可接单配送员(接单区域包含该商家且进行中订单数小于其接单上限)到商家的时间(直线距离(米)/200(米/分)) 类型:int
hasNotify:是否有新消息,类型:int
0:没有新消息 1:有新消息
riderList:附近骑手信息列表
[
{
lng:骑手经度,类型:int
lat:骑手纬度,类型:int
name:骑手姓名,类型String
orderNumber:该骑手身上该商家的订单数,类型:int
mobile:配送员电话,类型:String
},
{...}
]
}
}
接口描述
查询商家当日进行中的订单(已派成功 &&(未完成 || 未取消))
该接口调用机制不变,根据monitor接口中的orderNotify来决定刷新
如果某订单是配送中,已配送时间需要客户端本地进行定时刷新
接口消息定义
请求url:/order/query-inprogress-order.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
相应消息体:
{
{
status:"1",
data:
{
inProgressNum:当日进行中订单数,类型:int
finishNum:当日已完成订单数,类型:int
cancelNum:当日已取消订单数,类型:int
exceptionNum:当日异常订单数:类型:int
orderList:订单列表集合
[
{
orderId:订单ID,类型:String
riderType:骑手类型,类型:int
name:骑手姓名,类型:String
riderTel:骑手联系方式,类型:String
address:订单客户地址,类型:String
placeTime:下单时间,格式:HH-mm,类型:String
fee:配送费中文,带单位,如"5元",类型:String
distance:配送距离,带单位,如"2.5km",类型:String
orderStatus:订单状态,类型:int(0-已下单,5-已派单,10-已到店,15-已取单,98-异常,99-已取消,100-已完成)
orderStatusCn:订单状态中文,类型:String
枚举类型{派单中,未到店,未离店,配送中}
sinceObtain:已配送时间,单位:秒,未开始配送时候该字段为-1 类型:int
},
{...}
]
}
}
}
接口描述
商家录入订单
接口消息定义
请求url:/order/place.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
customerAddress:客户地址,类型:String
customerLng:客户经度,类型:int
customerLat:客户纬度,类型:int
lat:该商家当前所在位置的纬度,类型:int
lng:该商家当前所在位置的经度,类型:int
customerMobile:客户联系方式,类型:String
price:订单价格(价格*100,与骑手保持一致),类型:int
fee:配送费用(费用*100,与骑手保持一致),类型:int
payStatus:付款状态,类型:int
1:已付款 0:未付款
distance:配送距离,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
successText:提示文案,类型:String(正常下单成功后该字段为空,当余额不足时传"当前账户余额已不足20元,请及时充值"并弹窗提醒)
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:错误码
9006:超出配送距离错误码
3012:当前账户余额小于未支付订单总费用(订单在离店时进行结算),请充值后再试(弹窗提醒)
8002:账号被禁用
}
接口描述
根据手机号获取历史地址
接口消息定义
请求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:
}
接口描述
获取配送费
接口消息定义
请求url:/order/distribution-charge.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
toLng:商家纬度,类型:int
toLat:商家经度,类型:int
distance:距离(m),类型:int
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
}
msg:
}
接口描述
查看账户余额
接口消息定义
请求url:/order/canPlaceOrder.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderNumber:要发单的数量,类型:int
progressNumber:未扣款的进行中订单数量,类型:int
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
flag:发单条件结果枚举
0:可以下单
1:余额不足某值,可以发单
2:余额不足,不能发单
msg:相应发单条件下的描述信息
balance:当前可用余额,类型:float
}
msg:
}
接口描述
每15秒请求
接口消息定义
请求url:/shop/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:是否有新通知,类型:BOOL
isBanned:商家是否禁用,类型:BOOL
bannedMsg:商家禁用文案,类型:String
isKick:商家是否被踢下线,类型:BOOL
reviewStatus:商家审核状态,类型:int
reviewStatusDisplay:商家审核状态文案,类型:String
interval:查询周边骑手时间间隔,类型:int
orderNotify:是否有订单状态变化,类型:BOOL
hasResident:是否有驻店信息,类型:BOOL
radius:商家发单半径,单位米,类型:int
}
msg:
}
接口描述
登录接口
接口消息定义
请求url:/shop/login.json
请求方法:GET/POST
请求消息体:
{
phoneNumber:手机号码,类型:String
cityId:城市ID,类型:String
appVersion:app版本号,类型:String
source:当前操作系统版本号,类型:String
shopId:商家ID,类型:String
captcha:验证码,类型:String
deviceId:设备编号,类型:String
channelId:渠道编号,类型:String
deviceIdentifier:设备绑定标识,类型:string
}
响应消息体:
{
errorCode:10011,绑定异常,类型:int
msg:""
}
接口描述
申请解除绑定设备
接口消息定义
请求地址:/shop/apply-unbunding.json
请求方法: get/post
请求消息体:
{
phoneNumber:手机号码,类型:String
cityId:城市ID,类型:String
imei:设备ID,类型:String
}
响应消息体:
{
status: 1,
data:{
successText:成功文案,类型:String
},
msg:“”
errorCode:9014:申请解绑异常,类型:int
}
接口描述
查询商家当日进行中的订单(已派成功 &&(未完成 || 未取消))
该接口调用机制不变,根据monitor接口中的orderNotify来决定刷新
如果某订单是配送中,已配送时间需要客户端本地进行定时刷新
接口消息定义
请求url:/order/query-order.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderStatus:订单状态,0-发布中+进行中,1-发布中(派单中),2-进行中(已派单+已到店+已取单)
}
相应消息体:
{
{
status:"1",
data:
{
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
包括百度外卖、美团外卖、饿了么,其他(商家手发单)
},
{...}
]
}
}
接口描述
在商家端主页和订单详情页增加订单小费,在订单原小费基础上增加
增加成功后,不显示文案提示,直接刷新页面
接口消息定义
请求url:/order/add-tip.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderId:订单ID,类型:String
tip:小费,单位:分,类型:int
}
相应消息体:
{
{
status:"1",
data:
{
successText:"增加成功",
}
}
接口描述
登录接口增加订单发布后给予增加小费的提示时间间隔
接口消息定义
请求url:/shop/login.json
请求方法:GET/POST
请求消息体:
{
phoneNumber:手机号码,类型:String
cityId:城市ID,类型:String
appVersion:app版本号,类型:String
source:当前操作系统版本号,类型:String
shopId:商家ID,类型:String
captcha:验证码,类型:String
deviceId:设备编号,类型:String
channelId:渠道编号,类型:String
deviceIdentifier:设备绑定标识,类型:string
}
响应消息体:
{
data:
{
tipPromptTime:900,单位秒
}
errorCode:10011,绑定异常,类型:int
msg:""
}
接口描述
商家录入订单
接口消息定义
请求url:/order/place.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
customerAddress:客户地址,类型:String
customerLng:客户经度,类型:int
customerLat:客户纬度,类型:int
lat:该商家当前所在位置的纬度,类型:int
lng:该商家当前所在位置的经度,类型:int
customerMobile:客户联系方式,类型:String
price:订单价格,类型:int,单位分
fee:配送费用,类型:int,单位分
payStatus:付款状态,类型:int
1:已付款 0:未付款
distance:配送距离,类型:String
houseNumber:客户地址门牌号,类型:String
orderSource 外卖单类型,类型:int 0 饿了么 1 美团外卖 2 百度外卖 3 其他
serialId:流水号,类型String
remark:备注,类型:String
tip:小费,类型:int,单位分
注:楼层和门牌号统一拼接在客户地址后面customerAddress
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
successText:提示文案,类型:String(正常下单成功后该字段为空,当余额不足时传"当前账户余额已不足20元,请及时充值"并弹窗提醒)
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:错误码
9006:超出配送距离错误码
3012:当前账户余额小于未支付订单总费用(订单在离店时进行结算),请充值后再试(弹窗提醒)
8002:账号被禁用
}
接口描述
搜索商家当日订单,3.3.0版本中,请求参数不变,但是支持搜索流水号,响应参数增加serialId,platformDesc
接口消息定义
请求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
},{...}
]
}
}
接口描述
商家端订单详情页,请求参数不变
接口消息定义
请求url:/order/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderId:订单ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
platformDesc:平台名称,类型:String,包括百度外卖、美团外卖、饿了么,其他
extraFee:已加小费,单位分,类型:int
remark:备注,类型:int
riderLng:配送员经度,类型:String
riderLat:配送员纬度,类型:String
extraFeeDisplay:小费显示,类型:String
cancelUserType:取消类型,类型:int,1-配送员,2-商家
.....
}
}
接口描述
每15s请求一次,获取商家变更信息
接口消息定义
请求url:/shop/monitor.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
deviceId:设备ID,类型:String
lng:经纬度,类型:int
lat:经纬度,类型:int
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
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
}
}
接口描述
接到通知后,回执给服务端
接口消息定义
请求url:/shop/monitorResponse.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
receiveOrderNotify:其他单变化回执,类型:int
receiveKickImeiNotify:被下线回执,类型:int
receiveOrderCancelNotify:收到取消单回执,类型:int
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
}
}
(1)fto=15(ftype=1):对应优惠券页面(此时fto值为1),在向商家发放优惠券时候下发,同时下发param:增加ctype,类型:int 1.消费券 2.运费券 3.充值券
(2)fto=16(ftype=1):在商家申请优质商家成功或者拒绝时候下发 同时下发param:增加pid(商家申请优质商家的套餐id,业务无关,后续有id需要传递可直接复用该字段),类型:String,code:审核状态,类型int
0:未申请过优质商家,1:审核中,2:审核被拒,3:审核通过
(3)fto=17(ftype=0):当订单被转单多次时 param:增加oid,特指需要弹出因转单多次提示的订单id
接口描述
APP端优惠券列表获取数据,根据优惠券不同类型,分页请求,每页最多20条数据
接口消息定义
请求url:/shop/couponList.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
type:优惠券类型,类型:int 1.消费券 2.运费券 3.充值券
page:分页索引,类型:int 第一页索引为1
queryType:排序类型,类型:int, 1.查看排序 2.使用排序
该排序对应PRD需求如下:
CaseA、在券的查看页(从个人中心和账户中心入口进入),先分类,可用在前,不可用在后;然后按照券的发放时间倒序,该排序对应查看排序
CaseB、在券的使用页(从录入页入口、小费窗、充值页入口进入),先分类,可用在前,不可用在后;每个类中按面值倒序,该排序对应使用排序
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
type:优惠券类型,返回该请求上发的type值
page:分页索引,返回该请求上发的page值
list:[
{
id:优惠券id,类型:int
value:优惠券面值,类型:double,单位:元
name:优惠券名称,类型:string
validDate:优惠券有效期,类型:string,格式:YYYY-MM-DD
thresholdCn:优惠券启用门槛提示文案,类型:string,例:满25可以用
threshold:优惠券启用门槛金额,类型:double,单位:元
status:优惠券使用状态,类型:int
0:未使用且未过期,1:已用且未过期,2:已用且已过期,3:未用且已过期,4:充值优惠券锁定状态,5:未到开始使用期内
},
{...}
]
}
}
接口描述
增加使用小费券,小费券每个订单只能使用一张,已支付后不支持更改,如若该订单之前已使用小费券,服务端要给错误toast提示
最多允许将本次增加的小费抵扣为0,不支持抵扣为负数
接口消息定义
请求url:/order/add-tip.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderId:订单ID,类型:String
tip:小费,单位:分,类型:int
couponId:小费券Id,类型:int
couponValue:小费券金额,类型:int,单位:元,没用传0
}
相应消息体:
{
{
status:"1",
data:
{
successText:"增加成功",
}
}
接口描述
增加使用小费券、运费券功能
小费券每个订单只能使用一张,最多允许将本次增加的小费抵扣为0,不支持抵扣为负数
运费券每个订单只能使用一张,已支付后不支持更改,抵扣最多将运费减至0且不可抵扣优质商家的2元(可配置项)服务费
接口消息定义
请求url:/order/place.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
customerAddress:客户地址,类型:String
customerLng:客户经度,类型:int
customerLat:客户纬度,类型:int
lat:该商家当前所在位置的纬度,类型:int
lng:该商家当前所在位置的经度,类型:int
customerMobile:客户联系方式,类型:String
price:订单价格(价格*100,与骑手保持一致),类型:int
fee:配送费用(费用*100,与骑手保持一致),类型:int
payStatus:付款状态,类型:int
1:已付款 0:未付款
distance:配送距离,类型:String
feeCouponId:运费券id,类型:int,用户没用传0
feeCouponValue:运费券金额,类型:int,单位:元,没用传0
tipsCouponId:小费券id,类型:int,用户没用传0
tipsCouponValue:小费券金额,类型:int,单位:元,没用传0
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
successText:提示文案,类型:String(正常下单成功后该字段为空,当余额不足时传"当前账户余额已不足20元,请及时充值"并弹窗提醒)
}
msg:错误提示信息,如没有,则为空,类型:String
errorCode:错误码
9006:超出配送距离错误码
3012:当前账户余额小于未支付订单总费用(订单在离店时进行结算),请充值后再试(弹窗提醒)
8002:账号被禁用
}
接口描述
增加下发字段,充值活动提示文案、增加小费提示的订单距离以及订单价格临界值、增加下发商家优质商家状态、下发开通优质商家需要增加的额外服务费
接口消息定义
请求url:/shop/login.json
请求方法:GET/POST
请求消息体:
{
phoneNumber:手机号码,类型:String
cityId:城市ID,类型:String
appVersion:app版本号,类型:String
source:当前操作系统版本号,类型:String
shopId:商家ID,类型:String
captcha:验证码,类型:String
deviceId:设备编号,类型:String
channelId:渠道编号,类型:String
deviceIdentifier:设备绑定标识,类型:string
}
响应消息体:
{
distanceForTips:增加小费提示的订单距离临界值,单位:米,类型:int
priceForTips:增加小费提示的订单价格临界值,单位:元,类型:double
superiorReviewStatus:商家优质商家审核状态,类型:int
0:未申请过优质商家,1:审核中,2:审核被拒,3:审核通过
errorCode:10011,绑定异常,类型:int
msg:""
}
接口描述
是否显示优质商家标记
接口消息定义
请求url:/order/query-order.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderStatus:订单状态,0-发布中+进行中,1-发布中(派单中),2-进行中(已派单+已到店+已取单)
}
相应消息体:
{
{
status:"1",
data:
{
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不显示
},
{...}
]
}
}
接口描述
获取优质商家可选套餐列表
接口消息定义
请求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:
}
接口描述
商家发起开通优质商家请求
接口消息定义
请求url:/shop/requestSuperior.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
superiorId:可选套餐Id,类型:int
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
successText:"申请成功"
}
msg:
}
接口描述
增加下发字段,商家运费构成说明列表、商家小费构成说明列表
接口消息定义
请求url:/order/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderId:订单ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
feeExplainList:[
{
item:运费构成说明,类型:string,例如:自费 ¥2
},{...}
],
tipsExplainList:[
{
item:小费构成说明,类型:string,例如:平台追加 ¥3
},{...}
]
.....
}
}
接口描述
获取支付宝支付接口
接口消息定义
请求地址:/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:优惠券已锁定
}
接口描述
增加上传参数,充值优惠券Id,类型:String
接口消息定义
请求地址:/abcbank/getIePaymentUrl.json.json?
请求方法: get/post
请求消息体:
{
couponId:优惠券ID,类型:String
}
响应消息体:
{
status:"1",
data:
{
paymentUrl:"",
}
msg:优惠券已锁定
}
接口描述
增加上传参数,充值优惠券Id,类型:String
接口消息定义
请求地址:/abcbank/getPaymentVerifyCode.json?
请求方法: get/post
请求消息体:
{
couponId:优惠券ID,类型:String
}
响应消息体:
{
status:"1",
data:
{
tradeNo:交易号,类型:String
paymentUrl:跳转页面的url,类型:String
}
msg:优惠券已锁定
}
接口描述
增加下发字段,充值活动提示文案及快捷选项信息
接口消息定义
请求url:/shop/balance.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
rechargeDiscountTip:充值满多少赠多少活动文案,无活动传空字符串,类型:string
rechargePriceList:快捷输入金额,无活动传空list
[
100,类型:int
200,
300,...
]
errorCode:10011,绑定异常,类型:int
msg:""
}
接口描述
获取配送费
接口消息定义
请求url:/order/distribution-charge.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
toLng:商家纬度,类型:int
toLat:商家经度,类型:int
distance:距离(m),类型:int
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
serviceCharge : 优质商家服务费,单位:元,类型:double,如果不是优质商家返回0
}
msg:
}
(1)fto=20(ftype=1):对应等级页面
接口描述
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:关
}
}
接口描述
新增雨天服务费说明文案weatherChargeStr,请求参数不变
接口消息定义
请求url:/order/distribution-charge.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
toLng:商家纬度,类型:int
toLat:商家经度,类型:int
distance:距离(m),类型:int
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
weatherChargeStr: 雨天服务费说明文案,类型:string,例:(含恶劣天气服务费¥0.5)
...
}
msg:
}
接口描述
等级体系,相应特权
接口消息定义
请求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:优先派单,类型:int
text:专属特权文案,类型:String
},...
]
}
]
upgradeTitle:升级标题,类型:String
upgrade:[
{
chartTitle:图表标题,类型:String
scale:进度条比例,类型:double
progress:进度,如:还需\r\n20单
bigText:需要放大的text:专属特权文案,类型:String
},...
]
},
msg:“”
}
接口描述
新增商家等级文案levelStr和商家联系客服电话csTel(商家级别高,客服电话会不同),请求参数不变
接口消息定义
请求url:/shop/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
htmlSignature:h5签名,类型:String
...
}
msg:
}
(1)fto=20(ftype=1):对应积分页面
(2)备案成功,3天后签约未完成,增加推送,fto=16(ftype=1)
(3)7天未签约导致停号,增加推送,fto=3(ftype=1)
(4)骑手拒绝商家的追加单后,发送push给商家,fto=5(ftype=1),param带上oid(订单id)
接口描述
1.请求新增supplemented,用来标记是否为追加单
2.追加单情况下,增加追加的骑手id
接口消息定义
请求url:/shop/place.json
请求方法:GET/POST
请求消息体:
{
...
supplemented:是否为追加单,类型:int,1 是,0 否
riderId:追加单骑手,类型:int
repeatJudged:是否判断重复发单,类型:int,1:判断 0:不判断
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
}
msg:
errorCode:
3014,重复发单提醒错误码
}
接口描述
1.请求新增credentialsType,证书类型
2.去除是否有手持身份证合照和门店合照判断
3.当是港澳台同胞验证时候去除身份证校验
4.增加商家是否是通过芝麻引用提审
接口消息定义
请求url:/shop/submit-verify.json
请求方法:GET/POST
请求消息体:
{
...
credentialsType:证件类型,0:身份证,1:护照
zhimaVerified:是否是芝麻信用提审,类型:BOOL,TRUE:是 FALSE:否
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
}
msg:
}
接口描述
新增调用芝麻信用审核接口
接口消息定义
请求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:
}
接口描述
1.新增是否需要显示购买骑手定位服务,对已享受该服务的商家隐藏入口,包括优质商家和权益等级包含该条服务的商家
2.新增是否该商家已经购买过骑手定位服务
接口消息定义
请求url:/shop/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
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
...
}
msg:
}
### 3.7.6 修改骑手定位短信购买状态(修改) 此接口没有用到
接口描述
商家购买或者停用骑手定位短信
接口消息定义
请求url:/shop/locateMessageBuyed.json
请求方法:GET/POST
请求消息体:
{
shopId:商家id,类型:int
cityId:城市id,类型:int
buyed:购买或者停用,类型:int,0 停用, 1 购买
}
响应消息体:
{
data:
{
successText:"购买成功",类型:String
}
msg:""
}
接口描述
请求字段orderStatus增加状态值
接口消息定义
请求url:/order/query-order.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderStatus:订单状态,0-未完成的所有订单,1-发布中(派单中),2-待取货(已派单,到店前),3-配送中,4-已到店,5-已离店
}
相应消息体:
{
{
status:"1",
data:
{
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
},
{...}
]
}
}
接口描述
1.下发字段cancelPunishment的内容由原来的“可取消次数”减少变为“扣除违约金X元”
2.增加下发字段riderId,用来追加订单
3.增加下发字段placeYear,用于取消订单跨年时计算时间
接口消息定义
请求url:/order/detail.json
请求方法:GET/POST
请求消息体:
{
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
.....
riderId:该订单骑手ID,类型:int,如果该订单没派到骑手的时候,该字段值为0
placeYear:下单时的年份,类型:String,用于取消订单跨年时计算时间
}
}
接口描述
我的订单页面今日订单列表页面,分页查询,每页最多20条订单
接口消息定义
请求url:/order/today-list.json
请求方法:GET/POST
请求消息体:
{
shopId:商家id,类型:int
cityId:城市id,类型:int
status:订单状态,类型:int
0:所有,1:已完成,2:未完成,3:异常
page:分页索引,类型:int
}
响应消息体:
{
{
status:"1",
data:
{
totalNum:今日订单数量总计,类型:int
finishNum:已完成订单数量,仅当请求参数status为0时返回值,类型:int
unfinishNum:未完成订单数量,仅当请求参数status为0时返回值,类型:int
exceptionNum:异常订单数量,仅当请求参数status为0时返回值,类型:int
orderList:订单列表集合
[
{
address: 客户地址,类型:String
currentStatus: 订单当前状态,类型:int
currentStatusCn: 订单当前状态文字,类型:String
currentStatusSort: 订单当前状态排序值,类型:int
distanceDisplay: 订单距离文字显示,类型:String,
feeDisplay: 配送费中文显示,类型:String
isResident: 是否为驻店单,类型:BOOL
isTodayOrder: 是否是今日订单,类型:BOOL,
orderId: 订单编号,类型:int,
payStatusCn: 订单支付状态中文,类型:String
phone: 客户电话,类型:String
placeDate: 下单日期,类型:String,格式"MM-dd"
placeTime: 下单时间,类型:String,格式"HH:mm"
platformDesc: 订单平台类型中文,类型:String
priceDisplay: 订单价格中文显示,类型:String
},
{...}
]
}
}
接口描述
我的订单页面更早订单列表页面,下单时间早于今天的,查询最多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
}
响应消息体:
{
{
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
orderList:订单列表集合
[
{
address: 客户地址,类型:String
currentStatus: 订单当前状态,类型:int
currentStatusCn: 订单当前状态文字,类型:String
currentStatusSort: 订单当前状态排序值,类型:int
distanceDisplay: 订单距离文字显示,类型:String,
feeDisplay: 配送费中文显示,类型:String
isResident: 是否为驻店单,类型:BOOL
isTodayOrder: 是否是今日订单,类型:BOOL,
orderId: 订单编号,类型:int,
payStatusCn: 订单支付状态中文,类型:String
phone: 客户电话,类型:String
placeDate: 下单日期,类型:String,格式"MM-dd"
placeTime: 下单时间,类型:String,格式"HH:mm"
platformDesc: 订单平台类型中文,类型:String
priceDisplay: 订单价格中文显示,类型:String
},
{...}
]
}
}
接口描述
我的订单页面根据用户输入,搜索今日+近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:订单列表集合
[
{
address: 客户地址,类型:String
currentStatus: 订单当前状态,类型:int
currentStatusCn: 订单当前状态文字,类型:String
currentStatusSort: 订单当前状态排序值,类型:int
distanceDisplay: 订单距离文字显示,类型:String,
feeDisplay: 配送费中文显示,类型:String
isResident: 是否为驻店单,类型:BOOL
isTodayOrder: 是否是今日订单,类型:BOOL,
orderId: 订单编号,类型:int,
payStatusCn: 订单支付状态中文,类型:String
phone: 客户电话,类型:String
placeDate: 下单日期,类型:String,格式"MM-dd"
placeTime: 下单时间,类型:String,格式"HH:mm"
platformDesc: 订单平台类型中文,类型:String
priceDisplay: 订单价格中文显示,类型:String
},
{...}
]
}
}
接口描述
商家增加追加单功能,且要优先骑手端上线,新增是否开启追加单功能
接口消息定义
请求url:/shop/monitor.json
请求方法:GET/POST
请求消息体:
{
...
}
响应消息体:
{
{
status:"1",
data:
{
...
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:否
...
}
}
接口描述
商家向骑手追加订单时,点击追加订单按钮时进行校验是否能给骑手追加订单
接口消息定义
请求url:/shop/judgeSupplemented.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:int
shopId:商家ID,类型:int
riderId:骑手ID,类型:int
}
响应消息体:
{
status:能否追加,1:可以,0:不可以,类型:int
data:
{
successText:""
}
msg:不能追加的错误信息提示,类型:String
}
接口描述
增加审核的状态判断
接口消息定义
请求url:/shop/login.json
请求方法:GET/POST
请求消息体:
{
...
}
响应消息体:
{
...
verified:类型:int 0:"" 5:"验证中" 7:"待签约" 8:"验证失败" 9:"签约失败" 10:"已验证"
verifyCn:类型:String 0:"" 5:"验证中" 7:"待签约" 8:"验证失败" 9:"签约失败" 10:"已验证"
signRemindSevenDay: 7天未签约提醒,类型:boolean
...
}
接口描述
新增优惠券使用时间段
接口消息定义
请求url:/shop/couponList.json
请求消息体:
{
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
type:优惠券类型,返回该请求上发的type值
page:分页索引,返回该请求上发的page值
list:[
{
...
validTime:优惠券使用时间段,类型:string,例:仅11:30-13:30、16:30-18:30可用
status:优惠券使用状态,类型:int
0:未使用且未过期,1:已用且未过期,2:已用且已过期,3:未用且已过期,4:充值优惠券锁定状态,5:未到开始使用期内 6:不在使用时间段内(基于0的判断,老版本返回5)
...
},
{...}
]
}
}
接口描述
增加首屏广告图片URL
接口消息定义
请求url:/shop/login.json
请求消息体:
{
...
}
响应消息体:
{
...
adPicUrl:首屏广告图片URL,类型:String
...
}
接口描述
交易列表查询
接口消息定义
请求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
}
]
},
...]
}
}
接口描述
每日交易详细查询
接口消息定义
请求地址:/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
queryType:分类,类型:1:支付配送费,2:退款,3:支付小费,4:充值,5:其它
},
{...}
],
currentPage = 1;
pageCount = 1;
}
}
接口描述
每日交易详细查询
接口消息定义
请求地址:/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
},...
]
}
}
}
接口描述
每月交易详细查询
接口消息定义
请求地址:/shop/trade-month-list.json?
请求方法: get/post
请求消息体:
{
shopId:商家Id,类型:String
cityId:城市Id,类型:String
month:具体月份,格式:或者YYYY-MM,类型String
tradeType:查询某一类交易,类型:int
page:分页索引,类型:int
}
响应消息体:
{
status:"1",
data:
{
list:
[
{
tradeDesc:"支付宝充值",
tradeTime:"19:10"
tradeAmtDesc:"+6.0元"
tradeId:交易Id
orderId:该记录对应的OrderId,类型:String
},
{...}
],
queryTitle:查询某一类交易时的标题,类型:String,例如:共支付配送费
queryAmount:查询某一类交易时的金额,类型:String,例如:-250.0
currentPage = 1;
pageCount = 1;
}
}
接口描述
获取交易详情
接口消息定义
请求地址:/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
tips:说明(多个原因以|分割),类型:String
urlDesc:页面底部按钮文案,类型:String,如商家管理规则
url:页面底部h5链接,类型:String
},
msg:“”
errorCode:错误码,类型:int
}
接口描述
1.用于区分订单是通过手动录入、一键发单、批量发单
接口消息定义
请求url:/shop/place.json
请求方法:GET/POST
请求消息体:
{
...
placeType:用于区分订单是通过手动录入、一键发单、批量发单完成的,类型:int,0 手动录入,1:一键发单 ,2:批量发单
注:
placeType=2,errorCode传空,不判断重复发单、不判断余额小于20
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
}
msg:
errorCode:当placeType为2时,errorCode传空
}
(1)fto= 28 (ftype=0) 商家业务类型发生变更发推送;
接口描述
请求字段orderStatus增加状态值
接口消息定义
请求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
},
{...}
]
}
}
接口描述
获取可追加订单的配送员列表
接口消息定义
请求url:/order/supplemented-rider-list.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
相应消息体:
{
{
status:"1",
data:
{
riderList:追加骑手列表集合
[
{
riderName:配送员姓名,类型:string
riderId:配送员id,类型:int
},
{...}
]
}
}
接口描述
搜索历史客人电话
接口消息定义
请求url:/order/get-mobile-list.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
mobile:电话号码(从7位开始检索),类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
mobileList:[
历史手机号,类型:String,最多十条数据
]
}
msg:
}
接口描述
增加重量字段,废除已支付、未支付
接口消息定义
请求url:/shop/place.json
请求方法:GET/POST
请求消息体:
{
...
weight:重量范围,非必填,类型:int,例如:1000,(单位g)
payStatus:付款状态,类型:int,1:已付款 0:未付款
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
}
msg:
}
接口描述
增加下发字段,订单录入的货品重量列表
接口消息定义
请求url:/shop/login.json
请求方法:GET/POST
请求消息体:
{
phoneNumber:手机号码,类型:String
cityId:城市ID,类型:String
appVersion:app版本号,类型:String
source:当前操作系统版本号,类型:String
shopId:商家ID,类型:String
captcha:验证码,类型:String
deviceId:设备编号,类型:String
channelId:渠道编号,类型:String
deviceIdentifier:设备绑定标识,类型:string
}
响应消息体:
{
weightList:货品重量列表[
{
text:重量文案:例如:0-2公斤,类型:String
weight:重量 例如1000;单位g,类型:int
},
...
],
addTipAmount:提示增加多少小费 例:2.0 类型 String
errorCode:10011,绑定异常,类型:int
msg:""
}
接口描述
新增下发字段,流水号、接单时间、取消时间
接口消息定义
请求url:/order/today-list.json
请求方法:GET/POST
请求消息体:
{
shopId:商家id,类型:int
cityId:城市id,类型:int
status:订单状态,类型:int
0:所有,1:已完成,2:未完成,3:异常
page:分页索引,类型:int
}
响应消息体:
{
{
status:"1",
data:
{
totalNum:今日订单数量总计,类型:int
finishNum:已完成订单数量,仅当请求参数status为0时返回值,类型:int
unfinishNum:未完成订单数量,仅当请求参数status为0时返回值,类型:int
exceptionNum:异常订单数量,仅当请求参数status为0时返回值,类型:int
orderList:订单列表集合
[
{
orderId: 订单编号,类型:int,
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
payStatusCn: 订单支付状态中文,类型:String
priceDisplay: 订单价格中文显示,类型:String
distanceDisplay: 订单距离文字显示,类型:String
},
{...}
]
}
}
接口描述
我的订单页面更早订单列表页面,下单时间早于今天的,查询最多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
}
响应消息体:
{
{
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
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
payStatusCn: 订单支付状态中文,类型:String
priceDisplay: 订单价格中文显示,类型:String
distanceDisplay: 订单距离文字显示,类型:String,
},
{...}
]
}
}
接口描述
我的订单页面根据用户输入,搜索今日+近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
priceDisplay: 订单价格中文显示,类型:String
distanceDisplay: 订单距离文字显示,类型:String,
payStatusCn: 订单支付状态中文,类型:String
},
{...}
]
}
}
接口描述
1.下发字段地图上显示的骑手状态文案
接口消息定义
请求url:/order/detail.json
请求方法:GET/POST
请求消息体:
{
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
.....
platformId:int
riderText:地图上显示的骑手状态文案(html格式),部分文案有颜色差异,类型:String
rePlaceOrder:是否是重新发布的订单,类型:Bool
hasEvaluationed:是否已对骑手进行评价,类型:bool
canRePlace:是否可重新发布,类型:bool
feeDisplay:配送费显示,非取消状态,格式为:¥ 4.0;取消状态,格式为:¥ 4.0(已返还)
extraFeeDisplay:配送费显示,非取消状态,格式为:¥ 4.0;取消状态,格式为:¥ 4.0(已返还)
}
}
接口描述
获取骑手定位接
接口消息定义
请求url:/order/get-rider-location.json
请求方法:GET/POST
请求消息体:
{
shopId:商家id,类型:int
cityId:城市id,类型:int
orderId:订单id,类型:int
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
riderLng:配送员经度,类型:String
riderLat:配送员纬度,类型:String
riderText:地图上显示的骑手状态文案(html格式),部分文案有颜色差异,类型:String
currentStatusSort: 订单当前状态排序值,类型:int
}
}
接口描述
1.收货人短信通知启用状态
2.新增同城渠道或商家等级文案(待定)
接口消息定义
请求url:/shop/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
customerMsgOpen:收货人短信通知,类型:Bool
shopPlatformType:商家业务类型 (0.默认餐饮业务,1. 同城业务)类型:int
shopLevel:商家等级枚举,类型:int
1:普通商家 2:青铜商家 3:白银商家 4:黄金商家 5:钻石商家
...
}
msg:
}
接口描述
设置收货人短信通知
接口消息定义
请求url:/shop/set-customer-message.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
open:收货人短信通知,类型:Bool
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
customerMsgOpen:收货人短信通知,类型:Bool
}
msg:
}
接口描述
重新发布订单
接口消息定义
请求url:/order/re-place.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderId:需要重新发布的订单ID,类型:string
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
}
msg:
}
接口描述
增加异常完成单或者取消单变化通知
接口消息定义
请求url:/common/monitor.json
请求方法:GET/POST
请求消息体:
{
...
}
响应消息体:
{
{
status:"1",
data:
{
...
exceptionOrder: 订单主页是否需要显示异常tab,类型:BOOL
...
}
}
接口描述
通知消息列表,目录由shop改为common
接口消息定义
请求url:/common/notifyList.json
请求方法:GET/POST
请求消息体:
{
lastNotifyId:long
}
响应消息体:
{
{
status:"1",
data:
{
...
}
}
接口描述
登录接口
接口消息定义
请求url:/common/login.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:
{
token:String
shopId:int
}
}
接口描述
登录接口
接口消息定义
请求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:
{
原login接口返回结果
}
}
接口描述
登录接口
接口消息定义
请求url:/shop/switch-login-mobile.json
请求方法:GET/POST
接口描述
上传商家信息前主动获取当前区域BD列表
接口消息定义
请求url:/common/get-bd-list.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
lng:商家经度,类型:String
lat:商家纬度,类型:String
}
响应消息体:
{
{
status:"1",
data:
{
list:[
{
name:BD姓名,类型:String
code:bdCode,类型:String
},...]
}
}
接口描述
接口消息定义
请求url:/shop/submit-verify.json
请求方法:GET/POST
请求消息体:
{
...
shopType:商户类型,类型:int
shopTypeCn:商户类型中文,类型:string
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
}
msg:
}
接口描述
增加重量时 重新搜索配送费
接口消息定义
请求url:/order/distribution-charge.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
toLng:商家纬度,类型:int
toLat:商家经度,类型:int
distance:距离(m),类型:int
weight:重量(克),类型:int (非必填值)
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
}
msg:
}
接口描述
查询商家订单
接口消息定义
请求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
arriveShopNum:已到店订单数,类型:Int
orderList:订单列表集合
[
{
...
sendMsgShowed:短信通知收件人按钮展示,类型:bool
hasSendMsg:已发送过短信,类型:bool
msgCharge:发短信费用,如:“收费0.1元”,若免费发送短信,则传空,类型:string
},
{...}
]
}
}
接口描述
短信通知收件人
接口消息定义
请求url:/common/send-msg-to-customer.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderId:订单ID,类型:String
}
相应消息体:
{
{
status:"1",
data:
{
successText:“发送成功”
}
msg:失败提示
}
接口描述
获取商家信息
接口消息定义
请求url:/shop/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
superiorTime:优质商家服务剩余使用期限,类型:String 例:剩余期限:4天
superiorReviewStatus:商家优质商家审核状态,类型:int
0:未申请过优质商家,1:审核中,2:审核被拒,3:审核通过
...
}
msg:
}
接口描述
增加通知
接口消息定义
请求url:/common/monitor.json
请求方法:GET/POST
请求消息体:
{
...
}
响应消息体:
{
{
status:"1",
data:
{
...
orderTimeOutCancel: 订单超时取消语音播报,类型:BOOL
shopPlatformType:商家业务类型 0:默认 1:同城(跑腿)业务,类型:int
serverTime:服务器时间,类型:String
...
}
}
接口描述
登录接口
接口消息定义
请求url:/common/login.json
请求方法:GET/POST
请求消息体:
{
phoneNumber:手机号码,类型:String
cityId:城市ID,类型:String
appVersion:app版本号,类型:String
source:当前操作系统版本号,类型:String
shopId:商家ID,类型:String
captcha:验证码,类型:String
deviceId:设备编号,类型:String
channelId:渠道编号,类型:String
deviceIdentifier:设备绑定标识,类型:string
password:密码,类型:String
}
响应消息体:
{
{
status:"1",
data:
{
token:String
shopId:int
needSetPassword:需要设置登录密码,类型:bool
needAgreeRule:需要同意服务协议,类型:bool
certificate:校验验证码接口返回的凭证,类型:String
},
errorCode:
9200:手机号格式正确但未注册
9201:手机号已注册单未设置登录密码
9202:密码不正确达到10次以上
}
接口描述
设置登录密码
接口消息定义
请求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:
}
接口描述
接受服务协议
接口消息定义
请求url:/common/agree-rule.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
{
status:"1",
data:
{
successText:成功文案
}
msg:
}
接口描述
获取短信验证码
接口消息定义
请求url:/common/send-captcha.json
请求方法:GET/POSTC
请求消息体:
{
mobile:手机号,类型:String
cityId:城市ID,类型:String
shopId:商家ID,类型:String
systemCode:spider
isVoice:是否是语音验证码,类型:bool
type:业务类型,1:修改登录手机号:“changeMobile”,2:登录:“”,3:设置登录密码“setPassword” 4:找回密码“findPassword”
}
响应消息体:
{
{
status:"1",
data:
{
successText:成功文案
}
msg:
}
接口描述
接到通知后,回执给服务端
接口消息定义
请求url:/common/monitor-response.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
...
receiveOrderTimeOutCancelNotify:收到系统取消单回执,类型:int
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
}
}
接口描述
根据手机号获取密码设置和服务协议状态接口
接口消息定义
请求url:/common/account-info.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:int
phoneNumber:手机号码,类型:String
}
响应消息体:
{
{
status:"1",
data:
{
needRegister:需要注册,类型 :bool
needSetPassword:需要设置登录密码,类型:bool
needAgreeRule:需要同意服务协议,类型:bool
certificate:设置登录密码时所需要的凭证,类型:String
}
}
接口描述
获取短信验证码
接口消息定义
请求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:
}
接口描述
1.增加短信通知收件人
接口消息定义
请求url:/order/detail.json
请求方法:GET/POST
请求消息体:
{
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
sendMsgShowed:短信通知收件人按钮展示,类型:bool
hasSendMsg:已发送过短信,类型:bool
msgCharge:发短信费用,如:“收费0.1元”,若免费发送短信,则传空,类型:string
}
}
接口描述
增加获取配送费构成明细
接口消息定义
请求url:/order/distribution-charge.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
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:
}
接口描述
增加下发字段,订单录入的货品重量最大值
接口消息定义
请求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
}
响应消息体:
{
...
maxWeight:重量最大值 类型:int
...
}
接口描述
增加校验时间戳
接口消息定义
请求url:/shop/place.json
请求方法:GET/POST
请求消息体:
{
...
serverTime:服务器时间,类型:string
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
}
msg:
}
接口描述
获取投诉列表
接口消息定义
请求url:/common/complaint-list.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
page:分页索引,类型:int
}
响应消息体:
{
status:"1",
data:
{
currentPage:分页索引,返回该请求上发的page值,类型 : int
pageCount:总页数,类型 : int
list:[
{
wid:投诉工单Id,类型:String
type:投诉类型,类型:string 如:投诉商家
time:投诉时间,类型:String 如:2017-09-20 20:20 或者 今天 10:10
reason:原因,类型:String
result:结果,类型:String
status:进度状态,0:处理中,1:已完成,类型:Int
},...]
}
msg:
}
接口描述
增加下发字段,优惠券总数,我的积分数
接口消息定义
请求url:/shop/balance.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
...
couponCount:充值优惠券总张数,类型:Int
score:我的积分,类型:int
...
接口描述
等级体系,相应特权
接口消息定义
请求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:“”
}
接口描述
增加通知
接口消息定义
请求url:common/monitor.json
请求方法:GET/POST
请求消息体:
{
...
}
响应消息体:
{
{
status:"1",
data:
{
...
levelUpgrade: 等级升级,类型:Bool
shopLevel:当前等级,类型:Int
shopLevelName:当前等级名称,类型:String
couponBag:优惠券大礼包,类型:Bool
bannerNotify:banner变化通知,ture为有变化,类型:Bool
...
}
}
接口描述
接到通知后,回执给服务端
接口消息定义
请求url:/common/monitor-response.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
...
receiveLevelUpgradeNotify:收到等级升级回执,类型:int
receiveCouponBagNotify:收到优惠券大礼包回执,类型:int
receiveBannerNotify:收到新广告回执,类型:int
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
}
}
接口描述
获取商家信息
接口消息定义
请求url:/shop/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
shopLevelName:商家等级名称,类型:String
couponCount:优惠券总张数,类型:Int
score:我的积分,类型:int
...
}
msg:
}
接口描述
APP端优惠券列表获取数据,根据优惠券不同类型,分页请求,每页最多20条数据
接口消息定义
请求url:/shop/couponList.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
type:优惠券类型,类型:int 1.消费券 2.运费券 3.充值券 4:小费券+运费券
page:分页索引,类型:int 第一页索引为1
queryType:排序类型,类型:int, 1.查看排序 2.使用排序
该排序对应PRD需求如下:
CaseA、在券的查看页(从个人中心和账户中心入口进入),先分类,可用在前,不可用在后;然后按照券的发放时间倒序,该排序对应查看排序
CaseB、在券的使用页(从录入页入口、小费窗、充值页入口进入),先分类,可用在前,不可用在后,不显示使用过和过期的优惠券;每个类中按面值倒序,该排序对应使用排序
distance:配送距离,类型:int,type为运费券时,必传
fee:配送费用(单位为分),类型:int,type为运费券时,必传
extraFee:已加小费,单位分,类型:int,type为小费券时,必传
rechargeFee:充值金额,单位为分,类型:int,type为充值券时,必传
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
type:优惠券类型,返回该请求上发的type值
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,单位:元
mismatchReason:不符合优惠券使用条件的原因,如“未达启用金额”,“该时段不可用”,“未达启用距离”,“使用中”
discount:折扣,如0.7,类型:double
discountCoupon:是否是折扣券,类型:bool
status:优惠券使用状态,类型:int
0:可使用,1:已使用,2:已过期,3:不满足使用条件,包括被锁定状态
}
...],
tipList:[ 小费券List集合
{
//数据结构跟List集合里面保持一致
}
...
],
carriageList:[ 运费券List集合
{
//数据结构跟List集合里面保持一致
}
...
]
}
}
接口描述
可用优惠券数量接口
接口消息定义
请求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:可用并满足筛选条件的优惠券总张数
}
}
接口描述
1.增加短信通知收件人
接口消息定义
请求url:/order/detail.json
请求方法:GET/POST
请求消息体:
{
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
extraFeeDisplay:小费显示,非取消状态,格式为:¥ 4.0;取消状态,格式为:¥ 4.0(已返还) 若当小费为0的时候,小费栏去除“已返还”字样
useTipCoupon:该订单是否用过小费券,类型:bool
dispatchTimeDisplay:订单派单时间,类型:string 格式 2017-10-12-11:30
}
}
接口描述
获取投诉或者申请结果详情
接口消息定义
请求地址:/common/get-workorder-detail.json
请求方法: get
请求消息体:
{
cityId: 城市Id,类型:String
riderId:骑士Id,类型:String
workorderId:投诉或者申诉ID,类型:string
}
响应消息
{
status:1,
data:{
status:状态,类型:int
statusText:状态文案,类型:String
list:[
{
name:标题,类型:String
value:内容,类型:String
}
]
},
msg:“”
}
接口描述
可用优惠券数量接口
接口消息定义
请求url:/common/banner.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
locationPage:位置标志(1-首页滚动广告位,2-首页弹窗广告位),类型:int
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
bannerList:[
{
bannerId:标志ID,类型:int
imageUrl:显示图片下载地址,类型:String
url:跳转url(如果是跳转到普通网页,则为空),类型:String
paramType:跳转到原生界面,类型:int,1:充值界面,2:查看优惠券界面,3:等级权益界面
appearType:banner展示机制,类型:int,
0:点击查看后消失
1:点击x号后消息
2:有效期内一直展示
3:有效期内每天只展示一次
4:有效期内每次都展示
},...
]
}
}
接口描述
增加一键发单外部订单号
接口消息定义
请求url:/shop/place.json
请求方法:GET/POST
请求消息体:
{
...
externalOrderId:外部单号,类型:string
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
}
msg:
}
接口描述
我的订单页面更早订单列表页面,下单时间早于今天的,查询最多30天,分页查询,每页最多20条
接口消息定义
请求url:/order/earlier-list.json
请求方法:GET/POST
请求消息体:
{
shopId:商家id,类型:int
cityId:城市id,类型:int
timeType:时间搜索条件,类型:int
0:近30天,1:近一周,2:指定时间段 3:昨天,4:前天
startDate:查询开始时间,类型:String,格式:YYYY-mm-DD,该字段仅当timeType=2有效
endDate:查询结束时间,类型:String,格式:YYYY-mm-DD,该字段仅当timeType=2有效 新增查询一天
page:分页索引,类型:int
}
响应消息体:
{
{
status:"1",
data:
{
yesterdayNum:昨天订单数量总计,类型:int
beforeYestserNum:前天订单数量总计,类型:int
...
}
}
接口描述
城市是否开通
接口消息定义
请求url:/apis/common/shop/get-city.json
请求方法:GET/POST
请求消息体:
{
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
cityOpen:城市是否开通,类型:bool
}
msg:
}
接口描述
查询商家订单
接口消息定义
请求url:/order/query-order.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderStatus:订单状态,0-未完成的所有订单,1-发布中(派单中),2-待取货(已派单,到店前,已到店),3-配送中,4-已到店,5-已离店,6-异常(取消单,异常完成单)
}
相应消息体:
{
{
status:"1",
data:
{
...
orderList:订单列表集合
[
{
...
useTipCoupon:该订单是否用过小费券,类型:bool
},
{...}
]
}
}
接口描述
获取微信支付接口
接口消息定义
请求地址:/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:优惠券已锁定
}
接口描述
可用优惠券数量接口
接口消息定义
请求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:有效期内每次都展示
},...
]
}
}
接口描述
增加下发字段,当前登录手机号
接口消息定义
请求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
}
响应消息体:
{
...
loginMobile:登录账号 类型:String
...
}
接口描述
微信SDK返回客户端支付成功信息后,客户端需要向服务器确认支付结果
接口消息定义
请求url: /common/check-pay-result.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
tradeNo:交易单号,类型:String
}
响应消息体:
{
tradeStatus: 0|未查询到成功记录,1|成功,类型:int
}
接口描述
接口消息定义
请求url:/shop/submit-verify.json
请求方法:GET/POST
请求消息体:
{
...
shopPlatformType:商户类型,0:餐饮,1:同城,2:快递,类型:int,
expressType:快递类型,类型:int
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
}
msg:若商户名包含关键字值集,则提示“请输入真实的商户名”
}
接口描述
获取商家信息
接口消息定义
请求url:/shop/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
shopPlatformType:商户类型,0:餐饮,1:同城,2:快递,类型:int
shopPlatformCn:商家类型中文,类型:string
platformId:渠道Id,类型:int
platformCn:渠道中文,类型:string
...
}
msg:
}
接口描述
获取所有商家类型列表信息
接口消息定义
请求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
},...
]
}
msg:
}
接口描述
获取商家信息
接口消息定义
请求url:/common/get-shop-type.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
shopType:商户类型,类型:int
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
list:[
{
branchType:商户类型下细分的渠道,类型:int
branchTypeCn:商户类型下细分的渠道中文,类型:string
},...
]
}
msg:
}
接口描述
获取商家信息
接口消息定义
请求url:/shop/changeShopInfo.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
shopName:商户名称,类型:String
phone:联系电话,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
}
msg:1、若本月修改次数达到上限,则提示“您本月修改商户名称次数已达到上限3次,如有疑问请联系客服。”
2、若商户名包含关键字值集,则提示“请输入真实的商户名”
errorCode: 9500(待定):本月修改次数达到上限
}
接口描述
增加通知
接口消息定义
请求url:common/monitor.json
请求方法:GET/POST
请求消息体:
{
...
}
响应消息体:
{
{
status:"1",
data:
{
...
reviewPassCouponBag:验证通过新人大礼包,类型:Bool
...
}
}
接口描述
接到通知后,回执给服务端
接口消息定义
请求url:/common/monitor-response.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
...
receiveReviewPassCouponBagNotify:收到验证通过新人大礼包回执,类型:int
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
}
}
接口描述
快递下单
接口消息定义
请求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:
}
接口描述
快递下单
接口消息定义
请求url:/order/express-charge.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
waybillNum:面单数,类型:Int
toLng:客户纬度,类型:int
toLat:客户经度,类型:int
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
fee:发单费用,单位:分,类型:int
chargeDetailList:费用明细,类型:list
[
{
name:费用名称,类型:String
fee:费用,类型:String
},...
]
}
msg:
}
接口描述
订单包增加小费
接口消息定义
请求url:/order/add-tip.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
couponId:小费券Id,类型:int
tip:小费,单位:分,类型:int
couponValue:小费券金额,类型:int,单位:元,没用传0
groupId:订单包ID,类型:String
}
相应消息体:
{
{
status:"1",
data:
{
successText:"增加成功",
}
}
接口描述
查询商家订单
接口消息定义
请求url:/order/query-order.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderStatus:订单状态,0-未完成的所有订单,1-发布中(派单中),2-待取货(已派单,到店前,已到店),3-配送中,4-已到店,5-已离店,6-异常(取消单,异常完成单)
}
相应消息体:
{
{
status:"1",
data:
{
...
orderList:订单列表集合
[
{
...
groupId:快递包Id,类型:String
groupOrderCount:快递包订单量,类型:String
},
{...}
]
}
}
接口描述
1.增加根据订单包Id查询包详情功能
2.单个订单信息增加面单号字段
接口消息定义
请求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,
...
],
groupId:订单包Id,类型:String,
orderType:订单类型, 0:普通订单,1:同城直送,2:手发订单,3:揽件订单,4:派件订单,5:保险订单,类型:int
}
errorCode:3016,订单包有骑手接单
msg:骑手已接单
}
接口描述
重新发布订单
接口消息定义
请求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:
}
接口描述
增加下发字段,商家业务类型
接口消息定义
请求url:/shop/shop-info.json
请求方法:GET/POST
请求消息体:
{
...
}
响应消息体:
{
...
shopPlatformType:商户类型,0:餐饮,1:同城,2:快递,类型:int
maxWaybillCount:快递发单的最大单数,类型:int (默认40)
...
}
接口描述
上传参数增加商户类型,快递类型
接口消息定义
请求url:/common/get-bd-list.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
lng:商家经度,类型:String
lat:商家纬度,类型:String
shopType:商家类型,类型:int
branchType:商家子类型,类型:int
}
响应消息体:
{
{
status:"1",
data:
{
list:[
{
name:BD姓名,类型:String
code:bdCode,类型:int
},...]
}
}
接口描述
商家取消订单,请求体加groupID(订单包ID字段)
接口消息定义
请求url:/order/new-cancel.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderId:订单ID,类型 String
groupId:订单包ID,类型 String
}
接口描述
商家取消订单,请求体加是否确认取消
接口消息定义
请求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
}
}
接口描述
获取共单进度(投诉、申诉、举报)列表
接口消息定义
请求url:/common/complaint-list.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
page:分页索引,类型:int
}
响应消息体:
{
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
},...]
}
msg:
}
接口描述
获取投诉或申诉详情(投诉、申诉、举报)
接口消息定义
请求url:/common/get-workorder-detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
workorderId:工单ID,类型:String
}
响应消息体:
{
status:"1",
data:
{
status:工单状态 类型:int 0-处理中 1-成功 2-失败
workOrderType: 工单类型 类型int 0-投诉,1-申诉 2-举报
statusText:状态文案 类型String
statusTips:状态描述文案 类型String
list:工单详情内容列表
[{
name: 标题 类型:String
value:内容 类型:String
}...]
}
msg:
}
接口描述
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天后过期
}
...],
]
}
}
接口描述
增加通知
接口消息定义
请求url:common/monitor.json
请求方法:GET/POST
请求消息体:
{
...
}
响应消息体:
{
{
status:"1",
data:
{
...
couponOverdueRemind:优惠券过期提醒,包含首页气泡文案和侧边栏气泡文案,用|分割,如:价值400元运费券即将过期|4张优惠券即将过期,类型:String
...
}
}
接口描述
接到通知后,回执给服务端
接口消息定义
请求url:/common/monitor-response.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
...
receiveCouponOverdueRemindNotify:收到优惠券过期提醒回执,类型:int
...
}
接口描述
商家取消订单,请求体加是否确认取消
接口消息定义
请求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 账号密码
}
}
}
接口描述
商家取消订单,请求体加是否确认取消
接口消息定义
请求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": ""
}
接口描述
查询快递商家订单
接口消息定义
请求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:订单列表集合
[
{
groupId:快递包Id,类型:String
groupOrderCount:快递包订单量,类型:String
cancelCount:取消订单量,类型:Int
abnormalCount:异常完成订单量,类型:Int
serialId:订单流水号,类型:int
address:收件地址,类型:String
distance:配送距离,带单位,如"2.5km",类型:String
extraFee:已加小费,单位分,类型:int
orderStatus:订单状态类型数值,类型:int
orderStatusCn:订单状态中文,类型:String
枚举类型{发布中,已派单,已到站点,已离站点,已完成,已取消,异常完成}
},
{...}
]
}
}
接口描述
快递商家搜索今日或今日+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,
...
]
},{...}
]
}
}
接口描述
订单详情
接口消息定义
请求url:/order/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderId:订单Id,类型:String
groupId:订单包Id,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
groupOrderCount:快递包总订单量,类型:Int
cancelCount:取消订单量,类型:Int
abnormalCount:异常完成订单量,类型:Int
statusList:订单状态列表中的mean中文文案均改为,
普通订单枚举类型{发布中,已派单,已到店,已离店,已完成,已取消,异常完成}
快递订单枚举类型{发布中,已派单,已到站点,已离站点,已完成,已取消,异常完成}
feeDisplay:配送费显示,非取消状态,格式为:《html》《body》《font color='#FE751A'》¥ 4.0《/font》《/body》《/html》;取消状态,格式为:《html》《body》《font color='#FE751A'》¥ 4.0《/font》《font color='#929292'》(已返还)《/font》
extraFeeDisplay:配送费显示,非取消状态,格式为:《html》《body》《font color='#FE751A'》¥ 4.0《/font》《/body》《/html》;取消状态,格式为:《html》《body》《font color='#FE751A'》¥ 4.0《/font》《font color='#929292'》(已返还)《/font》
feeExplainList:[
{
item:运费构成说明,类型:string,例如:自费 ¥2,快递包说明例:¥ 3.0 x 40件
},{...}
],
tipsExplainList:[
{
item:小费构成说明,类型:string,例如:平台追加 ¥3,快递包说明例:¥ 3.0 x 40件
},{...}
]
...
}
errorCode:3016,订单包有骑手接单
msg:骑手已接单
}
接口描述
新增根据订单包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
}
}
接口描述
订单包Id搜索面单信息列表
接口消息定义
请求url:/group/query-waybill.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
groupId:订单包Id,类型:int
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
groupId:快递包Id,类型:String
groupOrderCount:快递包订单量,类型:Int
cancelCount:取消订单量,类型:Int
abnormalCount:异常完成订单量,类型:Int
currentStatusSort: 订单当前状态排序值,类型:int
cancelList:已取消货品
[
{
waybillNo:面单号,类型:String,
orderId:订单ID,类型:String
title:取消title,类型:String,
reason:取消原因,类型:String
},
...
],
abnormalList:异常完成货品
[
{
waybillNo:面单号,类型:String,
orderId:订单ID,类型:String
title:异常title,类型:String,
reason:异常原因,类型:String
},
...
],
normalList:发布中货品/待取货品/配送中货品/已完成货品
[
waybillNo:面单号,类型:String,
orderId:订单ID,类型:String
...
]
}
}
接口描述
订单包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》
}...]
}
}
接口描述
增加页面类型
接口消息定义
请求url:/order/today-list.json
请求方法:GET/POST
请求消息体:
{
...
cardType:卡片样式,0:不需要展示已投诉标签,1:需要展示已投诉标签
}
响应消息体:
{
status:"1",
data:
{
...
orderList:[
{
groupId: 订单编号,类型:int,
groupOrderCount:快递包订单量,类型:String
cancelCount:取消订单量,类型:Int
abnormalCount:异常完成订单量,类型:Int
hasComplaint:已发起投诉,类型:Bool
...
},...
]
}
}
接口描述
增加页面类型
接口消息定义
请求url:/order/earlier-list.json
请求方法:GET/POST
请求消息体:
{
...
cardType:卡片样式,0:不需要展示已投诉标签,1:需要展示已投诉标签
}
响应消息体:
{
...
orderList:[
{
groupId: 订单编号,类型:int,
hasComplaint:已发起投诉,类型:Bool
groupOrderCount:快递包订单量,类型:String
cancelCount:取消订单量,类型:Int
abnormalCount:异常完成订单量,类型:Int
...
},...
]
}
接口描述
服务中心可能有疑问的订单列表
接口消息定义
请求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
},
{...}
]
}
接口描述
服务中心常见问题配置
接口消息定义
请求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
},
...
]
},
...
]
}
接口描述
获取城市列表
接口消息定义
请求url:/common/city-list.json
请求方法:GET/POST
请求消息体:
{
shopId:商家id,类型:int
}
响应消息体:
{
status:"1",
data:
{
list:[
{
initial:城市首字母索引,类型:String
cityList:[
{
cityName:城市名称,类型:String
lat:城市纬度,类型:int
lng:城市经度,类型:int
},
...
]
},
...
]
}
接口描述
获取工单进度(投诉、申诉、举报)列表
接口消息定义
请求url:/common/complaint-list.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
workorderType:工单类型,0:投诉-处理中,1:投诉-已完成,2:申诉记录,3:反馈举报
page:分页索引,类型:int
}
响应消息体:
{
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
},...],
}
msg:
}
接口描述
获取商家处罚记录列表
接口消息定义
请求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:
}
接口描述
商家端订单详情页,请求参数不变
接口消息定义
请求url:/order/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderId:订单ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
groupComplainingCount:订单包投诉中的数量,类型:int
groupComplainedCount:订单包已完成投诉的数量,类型:int
.....
}
}
接口描述
获取交易详情
接口消息定义
请求地址:/shop/get-balance-detail.json?
请求方法: get/post
请求消息体:
{
shopId:商家Id,类型:String
balanceId:交易Id,类型:int
}
响应消息体:
{
status: 1,
data:{
groupId:订单包Id,类型:long
...
},
msg:“”
errorCode:错误码,类型:int
}
接口描述
每日交易详细查询
接口消息定义
请求地址:/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:
{
...
list:
[
{
groupId:订单包Id,类型:long
...
},
{...}
],
}
}
接口描述
每月交易详细查询
接口消息定义
请求地址:/shop/trade-month-list.json?
请求方法: get/post
请求消息体:
{
shopId:商家Id,类型:String
cityId:城市Id,类型:String
month:具体月份,格式:或者YYYY-MM,类型String
tradeType:查询某一类交易,类型:int
page:分页索引,类型:int
}
响应消息体:
{
status:"1",
data:
{
list:
[
{
groupId:订单包Id,类型:long
...
},
{...}
],
...
}
}
接口描述
获取所有商家类型列表信息
接口消息定义
请求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:
}
接口描述
获取商家信息
接口消息定义
请求url:/common/get-shop-type.json
请求方法:GET/POST
请求消息体:
{ cityId:城市ID,类型:String shopId:商家ID,类型:String shopType:商户类型,类型:int }
{ status : 请求成功标志,1 成功 0 失败, 类型 : int data: { 常用快递 list:[ { branchType:商户类型下细分的渠道,类型:int branchTypeCn:商户类型下细分的渠道中文,类型:string },... ], 其他快递 otherList:[ { branchType:商户类型下细分的渠道,类型:int branchTypeCn:商户类型下细分的渠道中文,类型:string },... ] } msg: }
接口描述
接口消息定义
请求url:/shop/submit-verify.json
请求方法:GET/POST
请求消息体:
{
...
exSiteCode:快递站点编码,类型:String
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
}
msg:若errorCode==5002,msg为"所填站点编码已注册,不能重复注册,若有疑问请联系BD解决~|180XXXXXXXX",电话号码为BD电话
errorCode==5003,msg为“若请输入真实的商户名”
errorCode:错误码,类型:int
5002:站点编码已注册,5003:商户名包含关键字值集
}
接口描述
获取商家信息
接口消息定义
请求url:/shop/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
exSiteCode:快递站点编码,类型:String
balance:当前可用余额,单位:分
shopNameOnly:商户名称,类型:String
...
}
msg:
}
接口描述
获取订单包投诉时效
接口消息定义
请求url:/group/enable-complaint.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
groupId:订单包Id,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
isCanComplaint:是否可投诉,类型:BOOL
reason:若不可投诉,显示不可投诉原因,如:“已超过投诉有效期”
}
msg:
}
接口描述
订单包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
groupOrderCount:快递包订单量,类型:Int
cancelCount:取消订单量,类型:Int
abnormalCount:异常完成订单量,类型:Int
currentStatusSort: 订单当前状态排序值,类型:int
cancelList:已取消货品
[
{
waybillNo:面单号,类型:String,
orderId:订单ID,类型:String
title:取消title,类型:String,
reason:取消原因,类型:String
complaintId:投诉Id,类型:String
},
...
],
abnormalList:异常完成货品
[
{
waybillNo:面单号,类型:String,
orderId:订单ID,类型:String
title:异常title,类型:String,
reason:异常原因,类型:String
complaintId:投诉Id,类型:String
},
...
],
normalList:发布中货品/待取货品/配送中货品/已完成货品
[
{
waybillNo:面单号,类型:String,
orderId:订单ID,类型:String
complaintId:投诉Id,类型:String
},
...
]
}
}
接口描述
上传参数增加商户类型,快递类型
接口消息定义
请求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
},...]
}
}
接口描述
新增类型,查询投诉时效期内所有订单
接口消息定义
请求url:/order/earlier-list.json
请求方法:GET/POST
请求消息体:
{
shopId:商家id,类型:int
cityId:城市id,类型:int
timeType:时间搜索条件,类型:int
0:近30天,1:近一周,2:指定时间段,3:昨天,4:前天5:投诉时效期内所有订单
startDate:查询开始时间,类型:String,格式:YYYY-mm-DD,该字段仅当timeType=2有效
endDate:查询结束时间,类型:String,格式:YYYY-mm-DD,该字段仅当timeType=2有效
cardType:卡片样式,0:不需要展示已投诉标签,1:需要展示已投诉标签
page:分页索引,类型:int
}
响应消息体:
{
{
status:"1",
data:
{
dateIntervalNum:指定查询时段数量总计,类型:int ,仅在timeType=2、5时返回
orderList:订单列表集合
[
...
]
}
}
接口描述
快递商家搜索7日内包括今日的面单接口(可投诉)
接口消息定义
请求url:/group/search-waybill.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
searchStr:搜索内容为面单号,类型:String
page:页面索引,类型:int
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
currentPage:分页索引,返回该请求上发的page值,类型 : int
pageCount:总页数,类型 : int
waybillList:[
{
waybillNo:面单号,类型String;
orderId:订单号,类型long;
orderCode:订单号,(展示用)类型:string
riderName:配送员姓名,string
timeStr:如: 完成时间:12:34 ; 类型:string
currentStatus: 订单当前状态,类型:int
currentStatusCN:订单状态中文描述,类型:string
hasComplaint:是否已经投诉过;类型:boolean
orderRelate:渠道号, int
},{...}
]
}
}
接口描述
商家端订单详情页,请求参数不变
接口消息定义
请求url:/order/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
orderId:订单ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
code:展示用的订单号,类型:String
.....
}
}
接口描述
每日交易详细查询
接口消息定义
请求地址:/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
code:展示用的订单号,类型:String
queryType:分类,类型:1:支付配送费,2:退款,3:支付小费,4:充值,5:其它
},
{...}
],
currentPage = 1;
pageCount = 1;
}
}
接口描述
获取交易详情
接口消息定义
请求地址:/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
code:展示用的订单号,类型:String
tips:说明(多个原因以|分割),类型:String
urlDesc:页面底部按钮文案,类型:String,如商家管理规则
url:页面底部h5链接,类型:String
},
msg:“”
errorCode:错误码,类型:int
}
接口描述
每月交易详细查询
接口消息定义
请求地址:/shop/trade-month-list.json?
请求方法: get/post
请求消息体:
{
shopId:商家Id,类型:String
cityId:城市Id,类型:String
month:具体月份,格式:或者YYYY-MM,类型String
tradeType:查询某一类交易,类型:int
page:分页索引,类型:int
}
响应消息体:
{
status:"1",
data:
{
list:
[
{
tradeDesc:"支付宝充值",
tradeTime:"19:10"
tradeAmtDesc:"+6.0元"
tradeId:交易Id
orderId:该记录对应的OrderId,类型:String
code:展示用的订单号,类型:String
},
{...}
],
queryTitle:查询某一类交易时的标题,类型:String,例如:共支付配送费
queryAmount:查询某一类交易时的金额,类型:String,例如:-250.0
currentPage = 1;
pageCount = 1;
}
}
接口描述
获取工单进度(投诉、申诉、举报)列表
接口消息定义
请求url:/common/complaint-list.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
workorderType:工单类型,0:投诉-处理中,1:投诉-已完成,2:申诉记录,3:反馈举报
page:分页索引,类型:int
groupId:订单包ID(查询订单包的投诉详情时才传值,其他情况不校验),类型: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:
}
接口描述
一键叫人任务列表
接口消息定义
请求url:/api/shop/capacity/list
请求方法:GET
请求消息体:
{
type: 1, // 1-报名管理 2-任务中 3-已完结 类型:number
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
signUpCount: 报名管理数量, 类型:number
goingCount: 任务中数量, 类型:number
endCount: 已完结数量, 类型:number
list: [
{
id: 任务ID, 类型:number
startTime: 任务开始时间, 类型:string
endTime: 任务结束时间,类型:string
status: 任务状态,类型:number 10-报名中 20-报名结束 30-任务中 40-已取消 100-已结束
statusCn: 任务状态显示名, 类型:string
transporterOrder: {
delivery: 派件中数量,类型:number
finish:已完成数量,类型:number
miss:丢件数量,类型:number
sendBack: 已送回数量,类型:number
},
signupRiderNum: 报名骑手数量,类型:number
requirementAmount: 要求骑手数量,类型:number
lastNotifyTime: 报名截止时间,类型:string
checkInNum: 签到人数,类型:number
checkOutNum: 签退人数,类型:number
commitTime: 提交时间,判断n分钟内,是否可取消,类型:string
orderAmount: 预估单量,类型:number
avgCost: 单均配送费,类型:float
deliveryArea: 配送区域,类型:string
remark: 备注, 类型:string
cencelableMinute: 可取消分钟数,类型:number
},
...
]
}
msg:
errorCode:
}
接口描述
一键叫人任务列表
接口消息定义
请求url:/api/shop/capacity/cancel
请求方法:POST
请求消息体:
{
id: 任务ID, number
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: { successText: '该运力需求已取消' }
msg:
errorCode:
}
接口描述
获取商家信息
接口消息定义
请求url:/common/get-shop-type.json
请求方法:GET/POST
请求消息体:
{ cityId:城市ID,类型:String shopId:商家ID,类型:String shopType:商户类型,类型:int }
{ status : 请求成功标志,1 成功 0 失败, 类型 : int data: { 常用 list:[ { branchType:商户类型下细分的渠道,类型:int tips:描述 branchTypeCn:商户类型下细分的渠道中文,类型:string },... ], 其他 otherList:[ { branchType:商户类型下细分的渠道,类型:int branchTypeCn:商户类型下细分的渠道中文,类型:string },... ] } msg: }
接口描述
接口消息定义
请求url:/shop/submit-verify.json
请求方法:GET/POST
请求消息体:
{
...
branchType:商户细分类型,类型:String
expressType:商户细分类型,类型:String
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
}
msg:若errorCode==5002,msg为"所填站点编码已注册,不能重复注册,若有疑问请联系BD解决~|180XXXXXXXX",电话号码为BD电话
errorCode==5003,msg为“若请输入真实的商户名”
errorCode:错误码,类型:int
5002:站点编码已注册,5003:商户名包含关键字值集
}
接口描述
获取商家信息
接口消息定义
请求url:/shop/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
branchType:商户细分类型,类型:String
branchTypeCn:商户细分类型中文,类型:String
platformId:商户细分类型,类型:String
platformCn:商户细分类型中文,类型:String
...
}
msg:
}
接口描述
获取商家信息
接口消息定义
请求url:/shop/changeShopInfo.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
shopName:商户名称,类型:String
phone:联系电话,类型:String
branchType:商户细分类型,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
}
msg:1、若本月修改次数达到上限,则提示“您本月修改商户名称次数已达到上限3次,如有疑问请联系客服。”
2、若商户名包含关键字值集,则提示“请输入真实的商户名”
errorCode: 9500(待定):本月修改次数达到上限
接口描述
获取工单进度(投诉、申诉、举报)列表
接口消息定义
请求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:
}
接口描述
获取短信验证码
接口消息定义
请求url:/common/send-captcha.json
请求方法:GET/POST
请求消息体:
{
mobile:手机号,类型:String
cityId:城市ID,类型:String
shopId:商家ID,类型:String
systemCode:spider
isVoice:是否是语音验证码,类型:bool
type:业务类型,1:修改登录手机号:“changeMobile”,2:登录:“”,3:设置登录密码“setPassword” 4:找回密码“findPassword”
captcha:图形验证码,类型:String
PS:默认传空,需要图形验证码时填对应的图形验证码内容
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data:
{
successText:成功文案
}
errorCode:错误码
9120,需输入图形验证码
9121:验证码错误
msg:提示文案
extraMsg:当errorCode=9120或9121时,返回图形验证码图片Base64码
}
接口描述
登录时刷新图形验证码
接口消息定义
请求地址: /common/refresh-image-captcha.json
请求方法: post
请求消息体:
{
cityId:城市ID,类型:String
mobile:手机号,类型:String
systemCode: "spider"(商家端)
type:业务类型,1:修改登录手机号:“changeMobile”,2:登录:“”,3:设置登录密码“setPassword” 4:找回密码“findPassword”
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data: {
captchaUrl:图形验证码Base64码,类型:String
}
msg:错误提示信息,如没有,则为空,类型:String
}
接口描述
增加判断一键发单是否修改
接口消息定义
请求url:/shop/place.json
请求方法:GET/POST
请求消息体:
{
...
alterJudged 一键发单是否被修改过, int 1 被修改过, 0 没被修改过
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
}
msg:
}
接口描述
接口消息定义
请求url:/shop/submit-verify.json
请求方法:GET/POST
请求消息体:
{
...
identifyFrontImageUrl:上传OSS成功的证件正面照URL 类型:String
identifyBackImageUrl:上传OSS成功的证件反面照URL 类型:String
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
}
msg:
}
接口描述
获取工单进度(投诉、申诉、举报)列表
接口消息定义
请求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
totalCount:当前结果的总数 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:
}
接口描述
一键叫人任务列表
接口消息定义
请求url:/api/shop/capacity/list
请求方法:GET
请求消息体:
{
type: 1, // 1-报名管理 2-任务中 3-已完结 类型:number
bubbleRequire: 1 // 1-需要气泡提示功能 0-不需要气泡提示功能
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
signUpCount: 报名管理数量, 类型:number
goingCount: 任务中数量, 类型:number
endCount: 已完结数量, 类型:number
bubbleGuide: 是否展示气泡提示,类型:boolean // true-提示 false-不提示
list: [
{
id: 任务ID, 类型:number
startTime: 任务开始时间, 类型:string
endTime: 任务结束时间,类型:string
status: 任务状态,类型:number 10-报名中 20-报名结束 30-任务中 40-已取消 100-已结束
statusCn: 任务状态显示名, 类型:string
transporterOrder: {
delivery: 派件中数量,类型:number
finish:已完成数量,类型:number
miss:丢件数量,类型:number
sendBack: 已送回数量,类型:number
},
signupRiderNum: 报名骑手数量,类型:number
requirementAmount: 要求骑手数量,类型:number
lastNotifyTime: 报名截止时间,类型:string
checkInNum: 签到人数,类型:number
checkOutNum: 签退人数,类型:number
commitTime: 提交时间,判断n分钟内,是否可取消,类型:string
orderAmount: 预估单量,类型:number
avgCost: 单均配送费,类型:float
deliveryArea: 配送区域,类型:string
remark: 备注, 类型:string
cencelableMinute: 可取消分钟数,类型:number
},
...
]
}
msg:
errorCode:
}
接口描述
一键叫人首页点击气泡提示后服务回传
接口消息定义
请求url:/api/shop/capacity/list/bubble/click
请求方法:GET
请求消息体:
无
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {}
msg:
errorCode:
}
接口描述
APP端优惠券列表获取数据,根据优惠券不同类型,分页请求,每页最多20条数据
接口消息定义
请求url:/shop/couponList.json
请求方法:GET/POST
请求消息体:
{
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
type:优惠券类型,返回该请求上发的type值
page:分页索引,返回该请求上发的page值
totalCount:该类型下的优惠券总张数
list:[
{
id:优惠券id,类型:int
value:优惠券面值,类型:double,单位:元,如果是折扣券,该字段为最高抵扣面值
name:优惠券名称,类型:string
validDate:优惠券有效期(结束时间),类型:string,格式:YYYY-MM-DD
startDate:优惠券开始时间,类型:String,格式:YYYY—MM-DD
validTime:优惠券使用时间段,类型:string,例:仅11:30-13:30、16:30-18:30可用
thresholdCn:优惠券启用门槛提示文案,类型:string,例:满25可以用
threshold:优惠券启用门槛金额,类型:double,单位:元
mismatchReason:不符合优惠券使用条件的原因,如“未达启用金额”,“该时段不可用”,“未达启用距离”,“使用中”
discount:折扣,如0.7,类型:double
discountCoupon:是否是折扣券,类型:bool
status:优惠券使用状态,类型:int
0:可使用,1:已使用,2:已过期,3:不满足使用条件,包括被锁定状态
}
...],
tipList:[ 小费券List集合
{
//数据结构跟List集合里面保持一致
}
...
],
carriageList:[ 运费券List集合
{
//数据结构跟List集合里面保持一致
}
...
]
}
}
接口描述
修改下发充值面额的数组
接口消息定义
请求url:/shop/balance.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
...
rechargeDiscountTip:充值满多少赠多少活动文案,无活动传空字符串,类型:string
rechargeList:快捷输入的金额 || 金额相关活动 || 金额相关返充
[
{
price:金额,单位:元,double,
rechargeTip:返额提示,如:返¥100 , String (没有可不传)
specialOffers:充值优惠活动提示,String,如:送10张¥10运费券 (没有可不传)
eventId:Long 活动id
giftAmount:充送金额,元,double
},...
]
}
...
接口描述
根据金额查询充值活动接口
接口消息定义
请求url:/shop/get-recharge-activity.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
rechargeAmount: 充值金额 类型:double 单位:元
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
specialOffers :充值优惠活动提示,String,如:送10张¥10元运费券
giftAmount:充送金额,元,double
eventId:活动id ,long
}
msg:
}
接口描述
获取商家信息
接口消息定义
请求url:/shop/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
oneClickOpen:一键发单开关是否开启,类型:bool
...
}
msg:
}
接口描述
增加通知
接口消息定义
请求url:common/monitor.json
请求方法:GET/POST
请求消息体:
{
...
loginPhone :登录手机号 类型String
source:手机厂商,类型:String
version:app版本号,类型:String
}
响应消息体:
{
{
status:"1",
data:
{
...
weexConfigVersion:weex配置文件版本号,类型:String
weexConfigUrl:weex文件下载地址,类型:String
weexConfigMD5:weex文件Md5,类型:String
loginStatus:登录类型,0:个人用户登录,1:企业用户登录,类型:int
tobReviewStatus: b端审核状态 类型 int
hasNewMessage:是否有新通知, 类型: bool
...
}
}
接口描述
支付链接获取统一接口
接口消息定义
请求url:abcbank/get-pay-url.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
amount: 充值金额 类型:double 单位:元
couponId:充值券 类型 long
eventId:活动id int
giftAmount:充送金额,类型:double
paymentType:支付类型 10-支付宝,20-银联,30-微信 40-银行卡
credit:账号,类型:String
mobile:预留手机号,类型:String
name:银行开户姓名,类型:String
idNo:银行开户身份证号,类型:String
}
响应消息体:
{
{
status:"1",
data:
{
aliPaymentUrl:支付宝 支付url 类型:String
bankPaymentUrl:银行卡 支付url类型:String
tradeNo:银行卡付交易单号,类型:String
-------剩下的都是微信返回的-------
partnerId:商家向财付通申请的商家id,类型:String
prepayId:预支付订单,类型:String
nonceStr:随机串,防重发,类型:String
timeStamp:时间戳,防重发,类型:String
packageValue:商家根据财付通文档填写的数据和签名,类型:String
wxSign:商家根据微信开放平台文档对数据做的签名,类型:String
tradeNo:微信支付交易单号,类型:String
}
}
接口描述
增加上传参数、errorCode
接口消息定义
请求url:/shop/shop-info.json
请求方法:GET/POST
请求消息体:
{
loginStatus:登录类型,0:个人用户登录,1:企业用户登录,类型:int
}
响应消息体:
{
...
}
errorCode:XXXX|登录状态错误
接口描述
个人版企业版账号切换
接口消息定义
请求url:/shop/change-login-status.json
请求方法:GET/POST
请求消息体:
{
shopId:用户ID,类型:int
cityId:城市ID,类型:String
loginStatus:当前app登录类型,类型:int
token:身份令牌,类型:string
upgrade:是否是升级到商家 类型:boolean
phoneNumber:手机号码,类型:String
appVersion:app版本号,类型:String
source:当前操作系统版本号,类型:String
deviceId:设备编号,类型:String
}
响应消息体:
{
shopId:用户ID,类型:int
token:身份令牌,类型:string
loginStatus:登录类型,0:个人用户登录,1:企业用户登录,类型:int
}
errorCode:
5006:在途订单未完结,无法切换
5007:审核失败
5008:签约失败
接口描述
登录接口
接口消息定义
请求url:/common/login.json
请求方法:GET/POST
请求消息体:
{
phoneNumber:手机号码,类型:String
cityId:城市ID,类型:String
appVersion:app版本号,类型:String
source:当前操作系统版本号,类型:String
shopId:商家ID,类型:String
captcha:验证码,类型:String
deviceId:设备编号,类型:String
channelId:渠道编号,类型:String
deviceIdentifier:设备绑定标识,类型:string
password:密码,类型:String
}
响应消息体:
{
{
status:"1",
data:
{
token:String
shopId:int
needSetPassword:需要设置登录密码,类型:bool
needAgreeRule:需要同意服务协议,类型:bool
certificate:校验验证码接口返回的凭证,类型:String
loginStatus:登录类型,0:个人用户登录,1:企业用户登录,类型:int
},
errorCode:
9200:手机号格式正确但未注册
9201:手机号已注册单未设置登录密码
9202:密码不正确达到10次以上
}
接口描述
登录接口
接口消息定义
请求url:/shop/verify.json
请求方法:GET/POST
请求消息体:
{
...
upgrade: 是否升级到企业版 类型:bool
loginPhone: 登录手机号 类型:String
}
errorCode:
5005:重复提交审核
响应消息体:
{
{
status:"1",
data:
{
token:String
tobShopId: B端账户ID,类型:int
loginStatus:登录类型,0:个人用户登录,1:企业用户登录,类型:int
},
}
接口描述
获取商家信息
接口消息定义
请求url:/shop/merchant-detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
loginPhone:登录手机号,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
同shop/detail.json返回结果
}
msg:
}
接口描述
调用芝麻信用审核接口
接口消息定义
请求url:/shop/zhima-verify.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
name:姓名,类型:String
identifyId:身份证号,类型:String
loginPhone:登录手机号 类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:
{
result:芝麻信用分查询结果,-1:未知, 0:信用不满足, 1:满足,类型:int
}
msg:
}
接口描述
接到通知后,回执给服务端
接口消息定义
请求url:/common/monitor-response.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
...
receiveNewMessageNotify:收到新通知提醒回执,类型:int
...
}
接口描述
获取短信验证码
接口消息定义
请求url:/common/send-captcha.json
请求方法:GET/POST
请求消息体:
{
mobile:手机号,类型:String
cityId:城市ID,类型:String
shopId:商家ID,类型:String
systemCode:spider
isVoice:是否是语音验证码,类型:bool
type:业务类型,1:修改登录手机号:“changeMobile”,2:登录:“”,3:设置登录密码“setPassword” 4:找回密码“findPassword”
captcha:图形验证码,类型:String
PS:默认传空,需要图形验证码时填对应的图形验证码内容
}
响应消息
{
status : 请求成功标志,1 成功 0 失败, 类型 : number
data:
{
successText:成功文案
}
errorCode:错误码
9120,需输入图形验证码
9121:验证码错误
9127:验证码发送次数达到上限
msg:提示文案
extraMsg:当errorCode=9120或9121时,返回图形验证码图片Base64码
}
接口描述
可用优惠券数量接口
接口消息定义
请求url:/common/banner.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
locationPage:位置标志(1-首页滚动广告位,2-首页弹窗广告位,3-首页小黄条,4-充值页面小黄条,10-toc账户分享),类型: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:有效期内每次都展示
},...
]
}
}
接口描述
登录接口
接口消息定义
请求url:/common/login.json
请求方法:GET/POST
请求消息体:
{
phoneNumber:手机号码,类型:String
cityId:城市ID,类型:String
appVersion:app版本号,类型:String
source:当前操作系统版本号,类型:String
shopId:商家ID,类型:String
captcha:验证码,类型:String
deviceId:设备编号,类型:String
channelId:渠道编号,类型:String
deviceIdentifier:设备绑定标识,类型:string
password:密码,类型:String
loginLimit:0 (不校验) 1(只允许toc登录)2(只允许tob登录,(4.8.2暂时用不到))
}
响应消息体:
{
{
status:"1",
data:
{
...
},
errorCode:
9128:对应loginLimit状态下用户不允许登录
}
接口描述
增加判断是否是座机号
接口消息定义
请求url:/shop/place.json
请求方法:GET/POST
请求消息体:
{
...
isTel 是否是座机, int 1 是, 0 不是
...
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
...
}
msg:
}
接口描述
支付链接获取统一接口
接口消息定义
请求url:abcbank/get-pay-url.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
amount: 充值金额 类型:double 单位:元
couponId:充值券 类型 long
eventId:活动id int
giftAmount:充送金额,类型:double
paymentType:支付类型 10-支付宝,20-银联,30-微信 40-银行卡
credit:账号,类型:String
mobile:预留手机号,类型:String
name:银行开户姓名,类型:String
idNo:银行开户身份证号,类型:String
tradeNo:进行中充值交易号,类型:String
specialOffers:充值优惠活动提示,如:送10张¥10运费券 ,类型:String, (没有可传空)
}
响应消息体:
{
{
status:"1",
data:
{
aliPaymentUrl:支付宝 支付url 类型:String
bankPaymentUrl:银行卡 支付url类型:String
tradeNo:银行卡付交易单号,类型:String
-------剩下的都是微信返回的-------
partnerId:商家向财付通申请的商家id,类型:String
prepayId:预支付订单,类型:String
nonceStr:随机串,防重发,类型:String
timeStamp:时间戳,防重发,类型:String
packageValue:商家根据财付通文档填写的数据和签名,类型:String
wxSign:商家根据微信开放平台文档对数据做的签名,类型:String
tradeNo:微信支付交易单号,类型:String
rechargingNo:进行中充值交易号,类型:String
}
}
接口描述
查询进行中充值订单
接口消息定义
请求url:/abcbank/recharging-order.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:{
tradeNo:进行中充值交易号,类型:String
eventId:活动id ,long
giftAmount:充送金额,类型:double
createTimeStamp:订单创建时间戳,1417792627,类型:long
amount:金额double,单位为元
couponId:优惠券ID,类型:String
couponValue:充值券金额,类型:double,单位:元,没用传0
specialOffers:充值优惠活动提示,如:送10张¥10运费券 ,类型:String, (没有可传空)
rechargeTip:返额提示,如:返¥100 , String (没有可不传)
}
msg:
}
接口描述
取消进行中充值订单
接口消息定义
请求url:/abcbank/cancel-recharging.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
tradeNo:进行中充值交易号,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data:{
successText:取消成功
}
msg:
}
接口描述
获取商家信息
接口消息定义
请求url:/shop/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
showRealNameStatus:实名认证状态,0 不显示、1 显示去实名认证、2 显示实名认证已经完成,类型:int
showElecContract:是否显示电子合同,0 不显示、1 显示,类型:int
pendingElecContractCount:待签约电子合同数量,类型:int
realNameAuthType:实名认证类型,1 个人认证、2 企业认证,类型:int
...
}
msg:
}
接口描述
可用优惠券数量接口
接口消息定义
请求url:/common/banner.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
locationPage:位置标志(1-首页滚动广告位,2-首页弹窗广告位,3-首页小黄条,4-充值页面小黄条,6-快递商家首页滚动广告位),10-toc账户分享类型: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:有效期内每次都展示
},...
]
}
}
接口描述
每日交易详细查询,新增 支付账单 筛选
接口消息定义
请求地址:/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:其它
6:支付账单
}
响应消息体:
{
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
queryType:分类,类型:1:支付配送费,2:退款,3:支付小费,4:充值,5:其它,6:支付账单
},
{...}
],
currentPage = 1;
pageCount = 1;
}
}
接口描述
获取商家信息,新增驿站开通状态
接口消息定义
请求url:/shop/detail.json
请求方法:GET/POST
请求消息体:
{
cityId:城市ID,类型:String
shopId:商家ID,类型:String
}
响应消息体:
{
status : 请求成功标志,1 成功 0 失败, 类型 : int
data: {
riderStationReviewStatus,int ,骑手驿站开通状态,0:未开通,1:处理中,2:已通过,3:审核失败,4:驿站下线
...
}
msg:
}