[关闭]
@xuduochoua 2015-11-04T03:15:16.000000Z 字数 30369 阅读 1337

生活很忙接口文档(hurrylife-api)

返回码说明

  1. {
  2.     code://返回代号：0成功；其它 失败
  3.     message://提示信息
  4.     data://接口需求的具体数据
  5. }

登录注册相关接口

获取短信验证码

接口地址
GET /auth/smscode

eg. http://120.26.62.247/api/auth/smscode

请求参数

参数 数据类型 必填 参数说明
mobile string 接收短信的手机号码

运行时异常

code 错误原因 返回消息
502 与短信接口通讯异常 短信验证码发送失败

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data": "aba25484-c9db-403c-810d-5da308fe48aa" //短信验证码token值
  5. }

用户注册

接口地址
POST /auth/regist

请求参数:

参数 数据类型 必填 参数说明
mobile String 手机号
password String 密码
smscode String 验证码
token String 验证码唯一票据
pushKey String Jpush设备ID

运行时异常

code 错误原因 返回消息
424 短信验证码错误 验证码错误
409 手机号重复 您的手机号码已注册过，请直接登录哦~

返回参数:

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: CustomerInfo
  5. }

另请参考CustomerInfo 说明

用户登录

客户登录分为密码登录和短信验证码登录两种方式。后者在找不到注册用户的情形下，自动注册为初级会员。

接口地址
POST /auth/login

请求参数

参数 数据类型 必填 参数说明
mobile String 手机号
password String 1 密码，传入该参数表示使用密码方式登录
smscode String 2 验证码，验证码方式登录时必填
token String 2 验证码唯一票据，验证码方式登录时必填
pushKey String Jpush设备ID

运行时异常

code 错误原因 返回消息
404 密码登录时手机号码不存在 用户不存在
424 密码错误或验证码错误 密码错误/验证码错误
403 用户被禁用 帐号被禁用

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: CustomerInfo
  5. }

另请参考CustomerInfo 说明

忘记密码

接口地址
POST /auth/passwd

请求参数

参数 数据类型 必填 参数说明
mobile String 手机号
password String 密码
smscode String 验证码
token String 验证码唯一票据

运行时异常

code 错误原因 返回消息
404 手机号码不存在 用户不存在
424 验证码错误 验证码错误
403 用户被禁用 帐号被禁用

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: CustomerInfo
  5. }

另请参考CustomerInfo 说明

个人中心

提交土豪请客信息

接口地址
POST /profile/lord/buy

请求参数

参数 数据类型 必填 参数说明
principal int 用户id
lordJson lordJson 提交的信息

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  6.    }
  7. }

土豪请客送出列表

接口地址
GET /profile/lord/send

eg.http://120.26.62.247/api/profile/lord/send

请求参数

参数 数据类型 必填 参数说明
principal int 当前登录用户ID

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404 用户不存在 系统繁忙，请稍候再试……

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":[
  5.         {
  6.             id          :   129,            //请客单ID
  7.             commodityId :   1,             //商品ID
  8.             commodityName:   "三杯鸡套餐",   //商品名称 
  9.             price       :   10.5,           //商品单价
  10.             count       :   6,              //请客份数
  11.             fee         :   90.5,           //总花费
  12.             shopId      :   10041,          //商品所在店铺ID
  13.             shopName    :   "聚食惠餐厅",   //商品所在店铺名称
  14.             createTime  :   "2015-01-27 10:50",//请客时间
  15.             share       :   "http://share.hurrylife.com/Xdw9Y8dE",//请客链接
  16.             received    :   3,               //已被领取份数
  17.             customerId  :   3,               //土豪id
  18.             system      :   3,               //1-美食外卖 2-生鲜百货
  19.             circleId    :   3,               //商圈ID
  20.             payed:true//支付状态
  21.         },
  22.         ...
  23.     ]
  24. }

土豪请客送出列表-详情（被领取列表）

接口地址
GET /profile/lord/send/{id}

eg.http://120.26.62.247/api/profile/lord/send/2

路径参数
id int 请客单ID

运行时异常

code 错误原因 返回消息
404 请客单ID不存在 系统繁忙，请稍候再试……

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":[
  5.         "138****1245",
  6.         "138****1245",
  7.         "138****1245",
  8.         "138****1245",
  9.         ...
  10.     ]
  11. }

土豪请客送出列表-删除

接口地址
GET /profile/lord/send/remove

请求参数

参数 数据类型 必填 参数说明
id int 请客单ID

运行时异常

code 错误原因 返回消息
404 请客单ID不存在 系统繁忙，请稍候再试……

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":null
  5. }

土豪请客接收列表

接口地址
GET /profile/lord/receive

请求参数

参数 数据类型 必填 参数说明
principal int 当前登录用户ID

运行时异常
code| 错误原因 |返回消息
401|未传入操作人ID|您需要重新登录才能继续操作哦~
404|用户不存在|系统繁忙，请稍候再试……

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":[
  5.         {
  6.             id          :   129,            //请客接收单ID
  7.             lordId      :   4,            //土豪请客ID
  8.             customerId  :   4,            //被请客用户id
  9.             initiator   :   "139****1111",  //发起者
  10.             commodityId :   4,             //商品ID 
  11.             commodityName:   "三杯鸡套餐",   //商品名称 
  12.             fee         :   90.5,           //总花费
  13.             circleId    :   3,              //商圈ID
  14.             shopId      :   10041,          //商品所在店铺ID
  15.             shopName    :   "聚食惠餐厅",   //商品所在店铺名称
  16.             createTime  :   "2015-01-27 10:50",//请客时间
  17.             used        :   false,           //true - 已使用 | false - 未使用
  18.             system      :   1               //子系统标识 `1`-美食外卖 `2`-生鲜百货 `3`-干洗护理 `4`-同城微商
  19.         },
  20.         ...
  21.     ]
  22. }

土豪请客接收列表-使用(确认订单)

与确认订单类似，返回的配送地址、送达时间信息是系统推荐的值。

接口地址
GET /profile/lord/receive/use

请求参数

参数 数据类型 必填 参数说明
principal int 当前登录用户ID
id int 请客接收单ID

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404 用户不存在 系统繁忙，请稍候再试……
404 请客接收单ID 系统繁忙，请稍候再试……

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":{
  5.             id          :   129,            //请客接收单ID
  6.             lordId      :   4,            //土豪请客ID
  7.             customerId  :   4,            //被请客用户id
  8.             initiator   :   "139****1111",  //发起者
  9.             commodityId :   4,             //商品ID 
  10.             commodityName:   "三杯鸡套餐",   //商品名称 
  11.             fee         :   90.5,           //总花费
  12.             circleId    :   3,              //商圈ID
  13.             shopId      :   10041,          //商品所在店铺ID
  14.             shopName    :   "聚食惠餐厅",   //商品所在店铺名称
  15.             createTime  :   "2015-01-27 10:50",//请客时间
  16.             used        :   false,           //true - 已使用 | false - 未使用
  17.             system      :   1               //子系统标识 `1`-美食外卖 `2`-生鲜百货 `3`-干洗护理 `4`-同城微商
  18.         }
  19. }

土豪请客接收列表-删除

接口地址
POST /profile/lord/receive/remove

请求参数

参数 数据类型 必填 参数说明
id int 请客接收单ID

运行时异常

code 错误原因 返回消息
404 请客单ID不存在 系统繁忙，请稍候再试……

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":null
  5. }

我的积分

接口地址
GET /profile/score

eg.http://120.26.62.247/api/profile/score

请求参数

参数 数据类型 必填 参数说明
principal int 当前登录用户ID

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404 用户不存在 系统繁忙，请稍候再试……

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":1003 //用户当前积分
  5. }

积分商城列表

接口地址
GET /profile/scoremall/exchange

eg.http://120.26.62.247/api/profile/scoremall/exchange

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":[{
  5.                 id:1,               //兑换物品ID
  6.                 name:"5元抵用券",    //兑换物品名称
  7.                 valid:1,            //有效期  单位天
  8.                 value:1,            //券值
  9.                 condition:100,        //条件 满xx元可用
  10.                 score:10            //兑换所需积分
  11.             },
  12.             ...
  13.         ]
  15. }

积分商城物品兑换

接口地址
POST /profile/scoremall/exchange/{id}

eg.http://120.26.62.247/api/profile/scoremall/exchange/1?principal=1

路径参数
id int 要兑换的物品ID

请求参数:

参数 数据类型 必填 参数说明
principal int 当前登录用户ID
num int 兑换的数量

运行时异常

code 错误原因 返回消息
412 积分余额不足 对不起，您的积分余额不足！
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404 用户不存在 系统繁忙，请稍候再试……

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":null
  5. }

批量兑换抵用券

接口地址
POST /profile/scoremall/exchange

请求参数:

参数 数据类型 必填 参数说明
principal int 当前登录用户ID
departmentOrder DepartmentOrder 订单信息
cardJson String cardJson 抵用券json

运行时异常

code 错误原因 返回消息
412 积分余额不足 对不起，您的积分余额不足！
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404 用户不存在 系统繁忙，请稍候再试……

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":null
  5. }

积分记录

接口地址
GET /profile/score/record

eg.http://120.26.62.247/api/profile/score/history

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":[
  5.         {
  6.             id:1,
  7.             score:80,
  8.             type:1,//1获得 2消费
  9.             description:"订单完成获得40积分",   //积分记录说明文字
  10.             createTime:"2015-02-28"            //积分变动时间
  11.         },
  12.         ...
  13.     ]
  14. }

积分规则

接口地址
GET /profile/score/rule

eg.http://120.26.62.247/api/profile/score/rule

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":"<html>...</html>"
  5. }

我的抵用券

接口地址
GET /profile/cash

eg.http://120.26.62.247/api/profile/cash

请求参数

参数 数据类型 必填 参数说明
principal int 当前登录用户ID

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404 用户不存在 系统繁忙，请稍候再试……

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":[ //抵用券
  5.         {
  6.             id:2,  //抵用券ID
  7.             value:5,//抵用券面值，￥5
  8.             cardno:"xxxxxxx", //券号
  9.             condition:100,//条件，￥5
  10.             enable:true,    //是否有效， false 表示已过期
  11.             endTime:"2015-08-30"    //有效期
  12.         },
  13.         ...
  14.     ]
  15. }

输入抵用券

接口地址
POST /profile/cash

eg.http://120.26.62.247/api/profile/cash

请求参数

参数 数据类型 必填 参数说明
principal int 当前登录用户ID
cardno string 抵用券号码

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404 用户不存在 系统繁忙，请稍候再试……
504 不存在的抵用券 不存在的抵用券
604 该抵用券已被使用 该抵用券已被使用

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":null
  5. }

我的收藏-商家

接口地址
GET /profile/collect/shop

eg.http://120.26.62.247/api/profile/collect/shop?principal=1

请求参数

参数 数据类型 必填 参数说明
principal int 当前登录用户ID

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404 用户不存在 系统繁忙，请稍候再试……

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:[ //
  5.         {
  6.             id:2,  //商家ID
  7.             name:"聚食惠",//
  8.             categoryName:"中餐",//分类
  9.             icon:"http://www.sd/asd/1"//图标
  10.             notice:"30元起送 5元配送费",//商家信息
  11.             star:5,//星级
  12.             collectId:20//收藏ID
  13.         },
  14.         ...
  15.     ]
  16. }

我的收藏-商品

接口地址
GET /profile/collect/commodity

eg.http://120.26.62.247/api/profile/collect/commodity?principal=1

请求参数

参数 数据类型 必填 参数说明
principal int 当前登录用户ID

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404 用户不存在 系统繁忙，请稍候再试……

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:[ //
  5.         {
  6.             id:2,  //商品ID
  7.             name:"聚食惠",//
  8.             icon:"http://www.sd/asd/1"//图标
  9.             sold:21,//已售量
  10.             price:20,//价格
  11.             restaurantId:21,//餐厅ID
  12.             collectId:21,//收藏ID
  13.         },
  14.         ...
  15.     ]
  16. }

取消收藏

接口地址
POST /profile/collect/delete

请求参数

参数 数据类型 必填 参数说明
collectedId int 收藏ID

运行时异常

code 错误原因 返回消息
401 用户不存在 您需要重新登录才能继续操作哦~

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  5. }

发票管理

接口地址
GET /profile/invoice

eg.http://120.26.62.247/api/profile/invoice?principal=1

请求参数

参数 数据类型 必填 参数说明
principal int 当前登录用户ID

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404 用户不存在 系统繁忙，请稍候再试……

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:[ //
  5.         {
  6.             id:2,  //商品ID
  7.             title:"聚食惠",//
  8.             createTime:"2014-12-12"//时间
  9.         },
  10.         ...
  11.     ]
  12. }

添加发票抬头

接口地址
POST /profile/addInvoice

请求参数

参数 数据类型 必填 参数说明
principal int 当前登录用户ID
title String 发票抬头

运行时异常

code 错误原因 返回消息
401 用户不存在 您需要重新登录才能继续操作哦~

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  5. }

编辑发票抬头

接口地址
POST /profile/editInvoice/{id} //发票抬头id

请求参数

参数 数据类型 必填 参数说明
principal int 当前登录用户ID
title String 发票抬头

运行时异常

code 错误原因 返回消息
401 用户不存在 您需要重新登录才能继续操作哦~

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  5. }

删除发票抬头

接口地址
POST /profile/removeInvoice/{id} //发票抬头id

请求参数

参数 数据类型 必填 参数说明
principal int 当前登录用户ID

运行时异常

code 错误原因 返回消息
401 用户不存在 您需要重新登录才能继续操作哦~

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  5. }

帮助中心

接口地址
GET /system/help

eg.http://120.26.62.247/api/profile/help

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.             content:"..."
  6.         }
  7. }

关于

接口地址
GET /system/aboutus

eg.http://120.26.62.247/api/profile/about

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.             content:"..."
  6.         }
  7. }

意见反馈

接口地址
POST /profile/feedback

请求参数

参数 数据类型 必填 参数说明
principal int 当前登录用户ID
content String 反馈内容
contact String 联系方式

运行时异常

code 错误原因 返回消息
401 用户不存在 您需要重新登录才能继续操作哦~
424 密码错误 密码错误
403 用户被禁用 帐号被禁用

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  5. }

修改密码

接口地址
POST /profile/passwd

请求参数

参数 数据类型 必填 参数说明
principal int 当前登录用户ID
pwdold String 原密码
pwdnew String 新密码

运行时异常

code 错误原因 返回消息
401 用户不存在 您需要重新登录才能继续操作哦~
424 密码错误 密码错误
403 用户被禁用 帐号被禁用

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  5. }

地址管理

地址管理

接口地址
GET /profile/address

eg.http://120.26.62.247/api/profile/address

请求参数:

参数 数据类型 必填 参数说明
principal int 当前登录用户ID
cityId int 当前城市ID

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":[ //送餐地址
  5.         {
  6.             id:23,  //送餐地址ID, 订餐时传入此参数
  7.             location:"潜山路与东流路交叉口蔚蓝商务港B坐1406",
  8.             name:"萨达姆",
  9.             mobile:"18919601457",
  10.             defaulted:true,//是否本商圈默认地址
  11.             cityId:1,
  12.             cityName:北京市,
  13.             deliveryFee:5//配送费
  14.         },
  15.         ...
  16.     ]
  17. }

新增送餐地址

接口地址
POST /profile/address/add

请求参数:

参数 数据类型 必填 参数说明
principal int 当前登录用户ID
name String 收货人姓名
mobile String 手机号
cityId int 城市ID
circleId int 商圈ID
location String 详细地址

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404

返回参数:

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  5. }

编辑送餐地址

接口地址
POST /profile/address/edit

请求参数:

参数 数据类型 必填 参数说明
principal int 当前登录用户ID
addressId int 地址ID
name String 收货人姓名
mobile String 手机号
cityId int 城市ID
circleId int 商圈ID
location String 详细地址

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404

返回参数:

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  5. }

设置默认地址

接口地址
POST /profile/address/default

请求参数:

参数 数据类型 必填 参数说明
principal int 当前用户id
addressIdint 地址ID

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
604 不存在的地址 地址不存在

返回参数:

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  5. }

删除地址

接口地址
POST /profile/address/delete

请求参数:

参数 数据类型 必填 参数说明
id int 地址ID

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404

返回参数:

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  5. }

外卖美食

餐厅分类

接口地址
GET /food/restaurant/category

eg.http://120.26.62.247/api/food/restaurant/category
请求参数:

参数 数据类型 必填 参数说明

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":[
  5.             {
  6.                 id:1,               //分类id
  7.                 categoryName:'中餐'//分类名称
  8.             },
  9.             ...
  10.         ]
  11. }

餐厅列表

接口地址
GET /food/restaurant

eg.http://120.26.62.247/api/food/restaurant
请求参数:

参数 数据类型 必填 参数说明
circleId int 商圈id
categoryId int 餐厅分类id
order int 排序 1-评价 2-销量 0-商家折扣率
promotionId int 优惠标签id
start int 起始
size int 数量

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":[
  5.             {
  6.                 id:1,               //餐厅id
  7.                 name:'Tail餐厅',
  8.                 icon:'....',//餐厅图标
  9.                 circleId:2,//所属商圈
  10.                 categoryName:"西餐", 
  11.                 usedCard:true,//是否可使用抵用券  
  12.                 deliverMoney:500.00,//起送金额  
  13.                 deliverFee:5.00,//同商圈配送金额  
  14.                 commentNum:10            //评价数
  15.                 star:4//评星
  16.                 level:[//等级
  17.                     diamond:1,//钻石数
  18.                     moon:2,//月亮数
  19.                     star:3//星星数
  20.                 ]
  21.             },
  22.             ...
  23.         ]
  24. }

美食搜索—餐厅

接口地址
GET /food/search/restaurant

eg.http://120.26.62.247/api/food/search/restaurant?keywords=鸿云来
请求参数:

参数 数据类型 必填 参数说明
circleId int 商圈id
keywords string 餐厅关键字
order int 排序 1-评价 2-销量 0-商家折扣率
start int 起始
size int 数量

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":[{//同餐厅列表
  5.                 id:1,               //餐厅id
  6.                 name:'Tail餐厅',
  7.                 categoryName:"西餐", 
  8.                 usedCard:true,//是否可使用抵用券  
  9.                 commentNum:10            //评价数
  10.                 star:4//评星
  11.                 icon:'....',//餐厅图标
  12.                 level:[//等级
  13.                     diamond:1,//钻石数
  14.                     moon:2,//月亮数
  15.                     star:3//星星数
  16.                 ]
  17.             },
  18.             ...
  19.         ]
  22. }

美食搜索—商品

接口地址
GET /food/search/commodity

eg.http://120.26.62.247/api/food/search/commodity
请求参数:

参数 数据类型 必填 参数说明
circleId int 商圈id
keywords string 商品关键字
order int 排序 1-价格 2-评价 3-销量
start int 起始
size int 数量

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":{
  5.         {
  6.             id:1,
  7.             name:'猪排饭',
  8.             price:28;
  9.             restaurantId:10,
  10.             restaurantName:'Tail餐厅',
  11.             star:4,
  12.             sold:16.
  13.             icon:'...'//商品图片
  14.             level:[//等级
  15.                     diamond:1,//钻石数
  16.                     moon:2,//月亮数
  17.                     star:3//星星数
  18.                 ]
  19.         },...
  20.     ]
  21. }

商品分类

接口地址
GET /food/commodity/category

eg.http://120.26.62.247/api/food/commodity/category?id=1
请求参数:

参数 数据类型 必填 参数说明
id int 餐厅id

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":[{
  5.             id:1,
  6.             name:'冷菜'
  7.         },
  8.         ...
  9.     ]
  10. }

商品列表

接口地址
GET /food/commodity

eg.http://120.26.62.247/api/food/commodity?restaurantId=1&categoryId=1
请求参数:

参数 数据类型 必填 参数说明
restaurantId int 餐厅id
categoryId int 商品分类id
start int 起始
size int 数量

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":{
  5.         {
  6.             id:1,
  7.             name:'猪排饭',
  8.             price:28;
  9.             sold:16.
  10.             icon:'...',//商品图片
  11.             restaurantId:1
  12.         },...
  13.     ]
  14. }

商家内搜索

接口地址
GET /food/restaurant/search

eg.http://120.26.62.247/api/food/commodity/search
请求参数:

参数 数据类型 必填 参数说明
id int 餐厅id
keywords string 搜索关键字
start int 起始
size int 数量

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":{
  5.         {
  6.             id:1,
  7.             name:'猪排饭',
  8.             price:28;
  9.             sold:16.
  10.             icon:'...',//商品图片
  11.             restaurantId:1
  12.         },...
  13.     ]
  14. }

商品详情

接口地址
GET /food/commodity/{id}

eg.http://120.26.62.247/api/food/commodity/1
请求参数:

参数 数据类型 必填 参数说明
principal int 当前登录用户id

路径参数
id int 商品ID

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":{
  5.         {
  6.             id:1,
  7.             name:'猪排饭',
  8.             price:28;
  9.             description:'这是九九八十一道工序精心调制的猪排饭'.//介绍
  10.             icon:'...'//商品图标
  11.             image;['...',...];//商品图片
  12.             collected:true,//是否收藏
  13.             collectId:2,//收藏ID
  14.             sold:3//
  15.         },...
  16.     ]
  17. }

商家详情

接口地址
GET /food/restaurant/{id}

eg.http://120.26.62.247/api/food/commodity/1
请求参数:

参数 数据类型 必填 参数说明
principal int 当前登录用户id

路径参数
id int 商家ID

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":{
  5.             id:1,
  6.             name:'聚实惠餐厅',
  7.             images['...',...],
  8.             sold:3,//销量
  9.             openTime:'10:00',//营业时间--开始
  10.             closeTime:'22:00',//营业时间--结束
  11.             description:'这是餐厅的简介，促销活动等',
  12.             location:"蔚蓝商务港B座1816"
  13.             longitude:134.232323//经度
  14.             latitude:32.322332//纬度
  15.             star:4，//星评-用以计算餐厅当前等级
  16.             mobile:"13212212222",
  17.             circleId:1,//商圈ID
  18.             categoryName:"中餐"//分类名称
  19.             notice:"公告"//公告
  20.             deliverMoney:120,//起送金额
  21.             supportInvoice:true,//是否支持发票
  22.             discount:0.7,//折扣率
  23.             usedCard:true,//是否可使用抵用券
  24.             collected:true//是否收藏
  25.             collectId:2,//收藏ID
  26.             comments:[//显示三条评论
  27.                 {
  28.                     id:1,
  29.                     mobile:'130****1425',
  30.                     createTime:'2015-10-12',
  31.                     star:3,//1-差评 2-中评 3-好评
  32.                     content:'不错哦',
  33.                     images:['...',...]
  34.                     },
  35.                 ...
  36.             ],
  37.             level:[//等级
  38.                     diamond:1,//钻石数
  39.                     moon:2,//月亮数
  40.                     star:3//星星数
  41.                 ]
  42.         }
  43. }

商家评论列表

接口地址
GET /food/restaurant/comment

eg.http://120.26.62.247/api/food/restaurant/comment?id=1
请求参数:

参数 数据类型 必填 参数说明
id int 商家id
type int 0-全部评论 1 -差评 2-中评 3-好评
start int 起始
size int 数量

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":{
  5.         countNum:10,//总评论数
  6.         fineNum:7，//好评数
  7.         middleNum:2//中评
  8.         badNum:1,//差评
  9.         comments：[
  10.                 {
  11.                     id:1,
  12.                     mobile:'130****1425',
  13.                     createTime:'2015-10-12',
  14.                     star:'好评',
  15.                     content:'不错哦',
  16.                     images:['...',...],
  17.                 },
  18.                 ...
  19.             ]
  20.         }
  21. }

后台推荐附属品

接口地址
GET /food/recommend

eg.http://120.26.62.247/api//food/recommend
请求参数:

参数 数据类型 必填 参数说明

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":[
  5.             {
  6.                 id:1,               //id
  7.                 name:'推荐可乐',//附属品名称
  8.                 price:3
  9.             },
  10.             ...
  11.         ]
  12. }

提交订单(同生鲜百货)

美食外卖配送费

接口地址
GET /food/deliver

请求参数:

参数 数据类型 必填 参数说明
principal int 当前登录用户id
addressId int 配送地址id
restaurantId int 餐厅id

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404 用户不存在 系统繁忙，请稍候再试……
406 不存在的餐厅
407 当前商圈不存在

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":15.0
  5. }

收藏商品

接口地址
POST /food/commodity/collect

请求参数:

参数 数据类型 必填 参数说明
principal int 当前登录用户id
id int 商品id

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404 用户不存在 系统繁忙，请稍候再试……

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":null
  5. }

收藏商家

接口地址
POST /food/restaurant/collect

请求参数:

参数 数据类型 必填 参数说明
principal int 当前登录用户idid
id int 商家id

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404 用户不存在 系统繁忙，请稍候再试……

响应结果:

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":null
  5. }

生鲜百货

分类

接口地址
GET /department/category

eg. http://120.26.62.247/api/department/category

请求参数

参数 数据类型 必填 参数说明
start int 起始
size int 页长

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:[
  5.         {
  6.             id:1,
  7.             name:"w.y.w.k",//分类名
  8.             icon:"http://www.sd/asd/1"//图标
  9.         },
  10.     ...
  11.     ]
  12. }

商品列表

接口地址
GET /department/commodity

eg. http://120.26.62.247/api/department/commodity

请求参数

参数 数据类型 必填 参数说明
categoryId int 分类ID
start int 起始
size int 页长

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.         id:1,
  6.         name:"车厘子",//
  7.         icon:"http://www.sd/asd/1"//图标
  8.         sold:21,//已售量
  9.         price:20,//价格
  10.         unit:"500g",//单位
  11.         special:true,//是否特卖
  12.         specialPrice:18//特价
  14.     }
  15. }

商品搜索列表

接口地址
GET /department/search

eg. http://120.26.62.247/api/department/search

请求参数

参数 数据类型 必填 参数说明
keyword String 搜索关键字
start int 起始
size int 页长

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.         id:1,
  6.         name:"车厘子",//
  7.         icon:"http://www.sd/asd/1"//图标
  8.         sold:21,//已售量
  9.         price:20,//价格
  10.         unit:"500g",//单位
  11.         special:true,//是否特卖
  12.         specialPrice:18//特价
  14.     }
  15. }

商品详情

接口地址
GET /department/commodity/{id}//id--商品id

eg. http://120.26.62.247/api/department/commodity/1

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.         id:1,
  6.         name:"车厘子",//
  7.         images{//轮播图片
  8.             "http//www/wa/as/1",
  9.             ...
  10.         },
  11.         description:"..."//文字介绍
  12.         rate:98%,//好评率
  13.         comments:[{//用户评价--默认3个
  14.             mobile:"132****2112",
  15.             createTime:"2014-08-23",
  16.             content:"不错~",//内容
  17.             targetStat:3,//1-差评 2-中评 3-好评
  18.             images:{
  19.                 "http://wsd.sd/wad/1",
  20.                 ...
  21.             },
  22.         },
  23.         ...
  24.         ]
  26.     }
  27. }

提交订单(用于生鲜百货和美食外卖)

接口地址
POST /department/order/buy

请求参数

参数 数据类型 必填 参数说明
departmentOrder DepartmentOrder 订单信息
principal int 当前登录用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.         orderno:"2313213",
  6.         price:12.00
  7.    }
  8. }

干洗护理

分类

接口地址
GET /cleaning/category

eg. http://120.26.62.247/api/cleaning/category

请求参数

参数 数据类型 必填 参数说明
start int 起始
size int 页长

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:[
  5.         {
  6.             id:1,
  7.             name:"w.y.w.k",//分类名
  8.             icon:"http://www.sd/asd/1"//图标
  9.         },
  10.     ...
  11.     ]
  12. }

商品列表

接口地址
GET /cleaning/commodity

eg. http://120.26.62.247/api/cleaning/commodity

请求参数

参数 数据类型 必填 参数说明
categoryId int 分类ID
start int 起始
size int 页长

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.         id:1,
  6.         name:"冬装水洗",//
  7.         icon:"http://www.sd/asd/1"//图标
  8.         sold:21,//已洗量
  9.         price:20//价格
  11.     }
  12. }

商品搜索列表

接口地址
GET /cleaning/search

eg. http://120.26.62.247/api/cleaning/search

请求参数

参数 数据类型 必填 参数说明
keyword String 搜索关键字
start int 起始
size int 页长

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.         id:1,
  6.         name:"冬装水洗",//
  7.         icon:"http://www.sd/asd/1"//图标
  8.         sold:21,//已洗量
  9.         price:20//价格
  11.     }
  12. }

商品详情

接口地址
GET /cleaning/commodity/{id}//id--商品id

eg. http://120.26.62.247/api/cleaning/commodity/1

请求参数

参数 数据类型 必填 参数说明
principal int 用户ID

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.         id:1,
  6.         name:"冬装水洗",//
  7.         images{//轮播图片
  8.             "http//www/wa/as/1",
  9.             ...
  10.         },
  11.         description:"..."//文字介绍
  12.         rate:98%,//好评率
  13.         comments:[{//用户评价--默认3个
  14.             mobile:"132****2112",
  15.             createTime:"2014-08-23",
  16.             content:"不错~",//内容
  17.             targetStat:3,//1-差评 2-中评 3-好评
  18.             images:{
  19.                 "http://wsd.sd/wad/1",
  20.                 ...
  21.             },
  22.         },
  23.         ...
  24.         ]
  26.     }
  27. }

提交订单

接口地址
POST /cleaning/order/buy

请求参数

参数 数据类型 必填 参数说明
cleaningOrder CleaningOrder 订单信息

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  6.    }
  7. }

同城微商

分类

接口地址
GET /vshop/category

eg. http://120.26.62.247/api/vshop/category

请求参数

参数 数据类型 必填 参数说明
start int 起始
size int 页长

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:[
  5.         {
  6.             id:1,
  7.             name:"w.y.w.k",//分类名
  8.             icon:"http://www.sd/asd/1"//图标
  9.         },
  10.     ...
  11.     ]
  12. }

店铺列表

接口地址
GET /vshop/shop

eg. http://120.26.62.247/api/vshop/shop

请求参数

参数 数据类型 必填 参数说明
category int 分类 -1--推荐店铺 默认全部
order int 排序 1-评价最好 2-销量最高
cityId int 城市ID
start int 起始
size int 页长

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.         id:1,
  6.         name:"澳洲代购店",//
  7.         category:"推荐店铺",//分类
  8.         icon:"http://www.sd/asd/1"//图标
  9.         notice:"30元起送 5元配送费",//商家信息
  10.         star:5,//星级
  11.         commentnum:20,//评论数
  12.         recommend:true//是否为推荐
  14.     }
  15. }

店铺商品分类

接口地址
GET /vshop/commodity/category

eg. http://120.26.62.247/api/vshop/commodity/category

请求参数

参数 数据类型 必填 参数说明
id int 店铺id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:[
  5.         {
  6.             id:1,
  7.             name:"w.y.w.k",//分类名
  8.         },
  9.     ...
  10.     ]
  11. }

商品列表

接口地址
GET /vshop/commodity

eg. http://120.26.62.247/api/vshop/commodity

请求参数

参数 数据类型 必填 参数说明
category int 分类
shopId int 店铺ID
start int 起始
size int 页长

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.         id:1,
  6.         name:"夫妻肺片",
  7.         icon:"http://www.sd/asd/1"//图标
  8.         sold:21,//已洗量
  9.         price:20//价格
  11.     }
  12. }

商品详情

接口地址
GET /vshop/commodity/{id}//id--商品id

eg. http://120.26.62.247/api/local/commodity/1

请求参数

参数 数据类型 必填 参数说明
principal int 用户ID

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.         id:1,
  6.         name:"冬装水洗",//
  7.         images{//轮播图片
  8.             "http//www/wa/as/1",
  9.             ...
  10.         },
  11.         description:"..."//文字介绍
  12.         rate:98%,//好评率
  13.         comments:[{//用户评价--默认3个
  14.             mobile:"132****2112",
  15.             createTime:"2014-08-23",
  16.             content:"不错~",//内容
  17.             targetStar:3,//1-差评 2-中评 3-好评
  18.             images:{
  19.                 "http://wsd.sd/wad/1",
  20.                 ...
  21.             },
  22.         },
  23.         ...
  24.         ]
  26.     }
  27. }

提交订单

接口地址
POST /vshop/commodity/confirm

请求参数

参数 数据类型 必填 参数说明
vshopOrder VshopOrder 订单信息

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.         orderno:"213213",
  6.         price:34.00
  7.    }
  8. }

商家详情

接口地址
GET /vshop/shop/{id}//id--商家id

eg. http://120.26.62.247/api/vshop/shop/1

请求参数

参数 数据类型 必填 参数说明
principal int 用户ID

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.         id:1,
  6.         name:"澳洲代购店",//
  7.         images{//轮播图片
  8.             "http//www/wa/as/1",
  9.             ...
  10.         },
  11.         description:"..."//店铺简介，促销活动等
  12.         star:4,//星评
  13.         comments:[{//用户评价
  14.             mobile:"132****2112",
  15.             createTime:"2014-08-23",
  16.             content:"不错~",//内容
  17.             targetStar:3,//1-差评 2-中评 3-好评
  18.             images:{
  19.                 "http://wsd.sd/wad/1",
  20.                 ...
  21.             },
  22.         },
  23.         ...
  24.         ]
  26.     }
  27. }

订单

订单状态

接口地址
GET /order/status

eg. http://120.26.62.247/api/order/current

请求参数

参数 数据类型 必填 参数说明
principal int 用户ID
orderno String 订单号

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:[{
  5.         id:1,
  6.         orderno:"xxxxx",//
  7.         status:0//状态
  8.         description:"..."//描述
  9.         createTime:"2014-12-12"//创建时间
  10.     },
  11.     ...]
  12. }

当前订单

接口地址
GET /order/current

eg. http://120.26.62.247/api/order/current

请求参数

参数 数据类型 必填 参数说明
principal int 用户ID

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:[{
  5.         id:1,
  6.         orderno:"xxxxx",//
  7.         system:1,
  8.         sellerName:"..."//商家名
  9.         commodityNames:"sdasd,asdas",//商品名（多个）
  10.         createTime:"2014-12-12"//创建时间
  11.         totalFee:4,//总金额
  12.         status:0//状态
  13.     },
  14.     ...]
  15. }

历史订单

接口地址
GET /order/history

eg. http://120.26.62.247/api/order/current

请求参数

参数 数据类型 必填 参数说明
principal int 用户ID

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:[{
  5.         id:1,
  6.         orderno:"xxxxx",//
  7.         system:1,
  8.         sellerName:"..."//商家名
  9.         commodityNames:"sdasd,asdas",//商品名（多个）
  10.         createTime:"2014-12-12"//创建时间
  11.         totalFee:4,//总金额
  12.         status:0//状态
  13.     },
  14.     ...]
  15. }

订单详情

接口地址
GET /order/detail

eg. http://120.26.62.247/api/order/status

请求参数

参数 数据类型 必填 参数说明
principal int 用户ID
orderno String 订单号

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{
  5.         id;
  6.         orderno;//订单号
  7.         createTime;//下单时间
  8.         status;//状态:0-待支付 1-接单中 2-待发送 3-待确认 4 已收货 5-调度中 6-确认调度 7-已接单 8-取件中 9-护理中 10-配送中 12-退款中 18-已完成 19已取消
  9.         system;//1-美食外卖 2-生鲜百货 3-干洗护理 4-同城微商
  10.         deliverId;//配送员id
  11.         totalFee;//总价格
  12.         remark;//订单备注
  13.         payType;//支付方式 1-支付宝 2-微信支付 3-货到付款 4-招人请客
  14.         addressId;//收货地址
  15.         deliverFee;//配送费
  16.         sellerId;//餐厅id或者vshop的id
  17.         sellerName;//卖家名称 美食的店名，生鲜百货，干洗护理，徽商的店铺名
  18.         commented;//是否评价
  19.         hopeCarry;//期望送达时间
  20.         hopeTake;//期望取件时间
  21.         readyMoney;//应备零钱(当支付方式为货到付款的时候)
  22.         invoice;//发票信息
  23.         cardId;//抵用券id
  24.         cardValue;//抵用券面值
  25.         backCard;//满多少送多少抵价券,形如100,15
  26.         changeRemark;//变更描述(配送员输入的内容)
  27.         loadId;//土豪请客id
  28.         customerId;//用户id
  29.         commodities:[
  30.             {
  31.                 id:1//商品ID 
  32.                 name:"三杯鸡",
  33.                 count,4//数量
  34.                 price:23.00
  35.                 recommend:false//是否为推荐商品 除美食外卖外都为false
  36.             },
  37.             ...
  38.         ],
  39.         address:{
  40.             id:23,  //送餐地址ID, 订餐时传入此参数
  41.             location:"潜山路与东流路交叉口蔚蓝商务港B坐1406",
  42.             name:"萨达姆",
  43.             mobile:"18919601457",
  44.             defaulted:true,//是否本商圈默认地址
  45.             cityId:1,
  46.             cityName:北京市,
  47.             deliveryFee:5//配送费
  48.         }
  49.     }
  50. }

取消订单

接口地址
GET /order/cancle

eg. http://120.26.62.247/api/order/cancle?principal=1&orderno=xxxxxx

请求参数

参数 数据类型 必填 参数说明
principal int 用户ID
orderno String 订单号

运行时异常

code 错误原因 返回消息
401 未传入操作人ID 您需要重新登录才能继续操作哦~
404 用户不存在 系统繁忙，请稍候再试……
604 订单不存在 不存在的订单
605 不可取消 订单当前状态不可取消

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:null
  5. }

美食外卖评价

接口地址
POST /order/comment/food

请求参数

参数 数据类型 必填 参数说明
principal int 用户ID
orderno string 订单号
forfood int 餐厅美食评价 1-差评 2-中评 3-好评
fordeliver int 配送专员评价
pics String 图片-最多三四张
content string 评论内容

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":100//获得的积分
  6. }

生鲜百货评价

接口地址
POST /order/comment/department

请求参数

参数 数据类型 必填 参数说明
commentJson CommentJson 评论JSON

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":100//获得的积分
  6. }

干洗护理评价

接口地址
POST /order/comment/cleaning

请求参数

参数 数据类型 必填 参数说明
commentJson CommentJson 评论JSON

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":100//获得的积分
  6. }

同城微商评价

接口地址
POST /order/comment/vshop

请求参数

参数 数据类型 必填 参数说明
commentJson CommentJson 评论JSON

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":100//获得的积分
  6. }

配送员位置

接口地址
GET /order/deliver/location

请求参数

参数 数据类型 必填 参数说明
orderno string 订单号
longitude double 经度
latitude double 纬度

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":{
  5.                 status:2,//配送员状态
  6.                 distance:500//距离
  7.     }   
  8. }

系统级相关接口

启动整合接口

客户端（买家）在打开APP就应马上调用的接口
该接口集成了定位当前商圈、版本更新、获取系统配置、首页广告等信息

接口地址
GET /system

eg. http://120.26.62.247/api/system

请求参数

参数 数据类型 必填 参数说明
city String 城市名
longitude double 经度，不填无法得到商圈
latitude double 纬度，不填无法得到商圈

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":{
  5.         cityId:232,//城市ID
  6.         cityName:"合肥",
  7.         circleId:2,//商圈ID
  8.         circleName:"万达广场",//商圈名称
  9.         cleaningMoney:100//干洗护理起始金额
  10.         cleaningFee:10//干洗护理配送费
  11.         deliverMoney:500//生鲜百货起始金额
  12.         deliverFee:10//生鲜百货配送费
  13.         carouses:[
  14.             {
  15.                 id:1,
  16.                 image:"http://static.taddy.com/upfile/2014/9/10/lasjfoegaljoeg/icon-xs.png",
  17.                 title:"好消息"//标题
  18.             },...
  19.         ]
  20.     }
  21. }

轮播详情

接口地址
GET /system/carousel

eg. http://120.26.62.247/api/system/carousel

请求参数

参数 数据类型 必填 参数说明
id int 轮播id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{  "<div>...</div>"}
  5. }

版本更新

接口地址
GET /system/upgrade

eg. http://120.26.62.247/api/system/upgrade

请求参数

参数 数据类型 必填 参数说明
code int 版本号，不填无版本更新
type int 0-买家端 1-配送员
category int 1-安卓 2-苹果

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{  //无版本更新时为null
  5.         version:"10.0.0.3",     //版本号
  6.         log:"更新日志：....（略）", //更新日志
  7.         url:"http://....apk"    //下载地址
  8.     }
  9. }

备注热词

接口地址
GET /system/hotword

eg. http://120.26.62.247/api/system/hotword

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{  //
  5.         "不要辣",
  6.         ...
  7.     }
  8. }

关于我们

接口地址
GET /system/aboutus

eg. http://120.26.62.247/api/system/aboutus

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{  "<div>...</div>"}
  5. }

城市商圈

城市列表

接口地址
GET /system/citys

eg. http://120.26.62.247/api/system/citys

请求参数

参数 数据类型 必填 参数说明
city string 定位的当前城市名
longitude double 经度，不填无法得到商圈
latitude double 纬度，不填无法得到商圈

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":[
  5.             {
  6.                 id:1,
  7.                 name:"北京"
  8.             }
  9.         ]
  10. }

商圈列表

接口地址
GET /system/circles

eg. http://120.26.62.247/api/system/circles

请求参数

参数 数据类型 必填 参数说明
cityId int 当前城市id
longitude double 经度，不填无法得到商圈
latitude double 纬度，不填无法得到商圈

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":{
  5.         nearest：{//最近的商圈
  6.                 id:2,
  7.                 name:'yy商圈',
  8.                 createTime:"2012-12-12",
  9.                 deliverFee:5.00,
  10.                 cityId:232,
  11.                 CirclePoint [
  12.                 {
  13.                     id:1,
  14.                     x:137233223,
  15.                     longitude:"137,233223",
  16.                     y:37233223,
  17.                     latitude:"37,233223",
  18.                 },
  19.                 ...
  20.                 ]
  21.             }
  22.         allCitys:[//该城市下的所有商圈
  23.             {
  24.                 id:2,
  25.                 name:'yy商圈',
  26.                 createTime:"2012-12-12",
  27.                 deliverFee:5.00,
  28.                 cityId:232,
  29.                 CirclePoint [
  30.                 {
  31.                     id:1,
  32.                     x:137233223,
  33.                     longitude:"137,233223",
  34.                     y:37233223,
  35.                     latitude:"37,233223",
  36.                 },
  37.                 ...
  38.                 ]
  39.             },
  40.             ......
  41.     }
  42. }

商圈地图列表

接口地址
GET /system/citys/map

eg. http://120.26.62.247/api/system/citys/map

请求参数

参数 数据类型 必填 参数说明
cityId int 当前城市id
longitude double 经度，不填无法得到商圈
latitude double 纬度，不填无法得到商圈

响应结果

  1. {
  2.     "code": 0, //0 - 接口调用成功，其他值表示失败
  3.     "message": null,
  4.     "data":{
  5.         nearest：{//最近的商圈
  6.                 id:2,
  7.                 name:'yy商圈' 
  8.                 longitude:117.12,
  9.                 latitude:32.12
  10.             }
  11.         allCitys:[//该城市下的所有商圈
  12.             {
  13.                 id:1,
  14.                 name:"XX商圈",
  15.                 longitude:117.11
  16.                 latitude:32.11
  17.             },
  18.             ......
  19.     }
  20. }

配送员APP相关接口

用户登录

接口地址
POST /deliver/login

请求参数

参数 数据类型 必填 参数说明
mobile String 手机号
password String 1 密码

|pushKey|String||Jpush设备ID|

运行时异常

code 错误原因 返回消息
404 密码登录时手机号码不存在 用户不存在
403 用户被禁用 帐号被禁用

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: {
  5.         id:1,
  6.         username:'Tom',
  7.         mobile:'15056920174',
  8.         workNum:'PS001'
  9.         ....
  10.     }
  11. }

待接单数目

接口地址
GET /deliver/waitreceive/num

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id

运行时异常

code 错误原因 返回消息
404 用户不存在

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: 32
  6. }

待接单列表

接口地址
GET /deliver/waitreceive

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id
start int
size int

运行时异常

code 错误原因 返回消息
404 用户不存在

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: [
  5.             {
  6.                 orderno:'123456',
  7.                 type：2,//订单类型
  8.                 createTime:'2014-11-12 11:20',//下单时间
  9.                 sellerAdd:{//商家地址
  10.                   name:'天鹅湖万达酒店',
  11.                   longitude:117.147852,
  12.                   latitude:31.12
  13.                   mobile:'13855251478'
  14.                 },
  15.                 buyerAdd:{//买家地址
  16.                   name:'天鹅湖万达酒店',
  17.                   longitude:117.147852,
  18.                   latitude:31.12
  19.                   mobile:'13855251478'
  20.             },
  21.         ...
  22.     ]
  24. }

拒单

接口地址
POST /deliver/order/refuse

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id
orderno string 订单号
cause string 拒单原因

运行时异常

code 错误原因 返回消息
404 用户不存在
504 订单不存在

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  6. }

接单

接口地址
POST /deliver/order/receive

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id
orderno string 订单号

运行时异常

code 错误原因 返回消息
404 用户不存在
504 订单不存在

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  6. }

待配送数目

接口地址
GET /deliver/waitdeliver/num

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id

运行时异常

code 错误原因 返回消息
404 用户不存在

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: 32
  6. }

待配送列表

接口地址
GET /deliver/waitdeliver

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id
start int
size int

运行时异常

code 错误原因 返回消息
404 用户不存在

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: [//同待接单列表
  6. }

开始配送

接口地址
GET /deliver/order/deliver/

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id
orderno string 订单号

运行时异常

code 错误原因 返回消息
404 用户不存在
504 订单不存在

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  6. }

配送中数目

接口地址
GET /deliver/deliver/num

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id

运行时异常

code 错误原因 返回消息
404 用户不存在

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: 32
  6. }

配送中列表

接口地址
GET /deliver/deliver

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id
start int
size int

运行时异常

code 错误原因 返回消息
404 用户不存在

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: [//同待接单列表
  6. }

确认送到

接口地址
GET /deliver/service /

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id
orderno string 订单号

运行时异常

code 错误原因 返回消息
404 用户不存在
504 订单不存在

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  6. }

无法送到

接口地址
GET /deliver/cannot/service /

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id
orderno string 订单号
cause string 原因

运行时异常

code 错误原因 返回消息
404 用户不存在
504 订单不存在

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: null
  6. }

已完成数目

接口地址
GET /deliver/finished/num

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id

运行时异常

code 错误原因 返回消息
404 用户不存在

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: 32
  6. }

已完成列表

接口地址
GET /deliver/finished

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id
start int
size int

运行时异常

code 错误原因 返回消息
404 用户不存在

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: [
  5.         {
  6.             id:1,
  7.             oderno:'123456',
  8.             createTime:'2015-11-12 11:30'
  9.         }，
  10.         ...
  11.     ]           
  12. }

--订单详情

接口地址
GET /deliver/order/detail

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id
orderno string 订单号

运行时异常

code 错误原因 返回消息
404 用户不存在
504 订单不存在

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data:{。。。}
  5. }

修改密码

接口地址
POST /deliver/auth/passwd

请求参数

参数 数据类型 必填 参数说明
principal int 配送员id
oldpassword String 旧密码
newpassword String 新密码

运行时异常

code 错误原因 返回消息
404 用户不存在
405 密码错误
403 用户被禁用 帐号被禁用

返回参数 

  1. {
  2.     code:0, //0-表示成功 其它表示失败
  3.     message: null,
  4.     data: {
  5.             id:1,
  6.             username:'Tom',
  7.             mobile:'15056920174',
  8.             workNum:'PS001'
  9.             ....
  10.         }
  11.     }

版本更新

接口地址
GET /deliver/upgrade

eg. http://120.26.62.247/api/deliver/upgrade

请求参数

参数 数据类型 必填 参数说明
code int 版本号，不填无版本更新

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: null,
  4.     data:{  //无版本更新时为null
  5.         version:"10.0.0.3",     //版本号
  6.         log:"更新日志：....（略）", //更新日志
  7.         url:"http://....apk"    //下载地址
  8.     }
  9. }

附录

优惠标签

CustomerInfo

客户实体对象说明

  1. {
  2.     id:1,//用户ID
  3.     mobile:"189****1457"//用户手机号
  4. }

cardJson

订单详情 对象说明

  1. [{
  2.     id:1,
  3.     num:5,
  4.     score:50//所要积分
  6. },{...},...]

lordJson

土豪请客 对象说明

  1. {
  2.     commodityId:2,
  3.     commodityName:'三杯鸡',
  4.     fee:120.0//总费用
  5.     price:12.0
  6.     count:10,//数量
  7.     shopId:'1'，//商店id(生鲜外卖时候为0)
  8.     shopName:'吉时惠'//商店(生鲜外卖时候为"生鲜外卖")
  9.     customerId:1//
  10.     system:1,//1-美食外卖 2-生鲜百货
  11.     circleId:1//商圈id
  13. }

DepartmentOrder

订单详情 对象说明

  1. {
  2.     system  :   2,//子系统标识 `1`-美食外卖 `2`-生鲜百货 `3`-干洗护理 `4`-同城微商
  3.     addressId : 1//配送地址ID
  4.     deliveryFee:10.00,//配送费
  5.     commodities:[
  6.         {
  7.             id:21,  //商品ID
  8.             name:"苹果", //商品名称
  9.             count:10    //商品数量
  10.             price:10.00//单价
  11.         },
  12.         ...
  13.     ],
  14.     payType:1//1-支付宝支付 2-微信支付 3-货到付款 4-找人请客
  15.     remark:"多加饭,没零钱,不要辣",
  16.     totalFee:5.00//总费用,
  17.     invoice:"鸿云来"，//发票信息
  18.     loadId:1,//土豪请客ID
  19.     cardId:1,//抵用券id
  20.     cardValue:5,//抵用券值
  21.     sellerId:2,//卖家id
  22.     sellerName,//卖家name
  23.     firstOrder:false //是否是首次下单
  24. }

CleaningOrder

订单详情 对象说明

  1. {
  2.     system  :   3,//子系统标识 `1`-美食外卖 `2`-生鲜百货 `3`-干洗护理 `4`-同城微商
  3.     addressId : 1//配送地址ID
  4.     deliveryFee:10.00,//配送费
  5.     hopeTake:"16:30",//期望取件时间
  6.     hopeCarry:"17:30",//期望送达时间
  7.     commodities:[
  8.         {
  9.             id:21,  //商品ID
  10.             name:"冬装干洗", //商品名称
  11.             count:10    //商品数量
  12.             price:10.00//单价
  13.             recommend:false//当前商品是否为推荐的商品
  14.         },
  15.         ...
  16.     ],
  17.     payType:1//1-支付宝支付 2-微信支付 3-货到付款 4-找人请客
  18.     remark:"多加饭,没零钱,不要辣",
  19.     totalFee:5.00//总费用,
  20.     invoice:"鸿云来"//发票信息
  21.     firstOrder:false //是否是首次下单
  22. }

VshopOrder

订单详情 对象说明

  1. {
  2.     system  :   4,//子系统标识 `1`-美食外卖 `2`-生鲜百货 `3`-干洗护理 `4`-同城微商
  3.     addressId : 1//配送地址ID
  4.     deliveryFee:10.00,//配送费
  5.     commodities:[
  6.         {
  7.             id:21,  //商品ID
  8.             name:"冬装干洗", //商品名称
  9.             count:10    //商品数量
  10.             price:10.00//单价
  11.             recommend:false//当前商品是否为推荐的商品
  12.         },
  13.         ...
  14.     ],
  15.     payType:1,//1-支付宝支付 2-微信支付 3-货到付款 4-找人请客
  16.     remark:"多加饭,没零钱,不要辣",
  17.     totalFee:5.00,//总费用,
  18.     invoice:"鸿云来"//发票信息
  19.     sellerId:5,//卖家id
  20.     sellerName//卖家name
  21. }

CommentJson

订单详情 对象说明

  1. {
  2.     customerId:   4,//用户ID
  3.     orderno:"ww22212"//订单号
  4.     deliverStar:3,////配送员评分  在同城微商时候 为对店铺的评价 star
  5.     detail:[
  6.         {
  7.             commodityId:21,  //商品ID
  8.             content:2, //商品数量
  9.             star:3,//3 好评 2中评  1差评
  10.             images:"1,2"//图片id用,连接
  11.         },
  12.         ...
  13.     ],
  14.     payType:1,//1-支付宝支付 2-微信支付 3-货到付款 4-找人请客
  15.     remark:"多加饭,没零钱,不要辣",
  16.     totalFee:5.00,//总费用,
  17.     invoice:"鸿云来"//发票信息
  18. }

二维码扫描说明

二维码的功能包括两个方面：
1. 跳转到后台临时创建的活动页
2. 任何一款其它APP打开后能跳转到应用下载页面

针对以上需求，这里规定下客户端需实现的功能。

客户端在扫描二维码后会得到一个url，例如：
http://teddy.hylapp.com/acitivity/14092003?key1=dafe&key2=dsfae&needLogin=true
客户端根据此URL拼接一个新的URL，并用内嵌浏览器打开新的URL。拼接步骤如下：
1. 在url中查找字符串needLogin=true,若能查找到此字符串,则表示该项活动需用户登录，客户端先引导用户登录，然后在url后追加登录用户ID参数。例：&principal=1。
2. 始终在URL后面增加特殊参数：&spt=hylapp

将得到的URL在内嵌浏览器中打开即可。

推送消息说明

推送消息给客户端时候附带的数据，客户端可根据数据进行相信处理

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