[关闭]
@wangwangheng 2015-07-12T15:35:41.000000Z 字数 10739 阅读 2215

接口文档

未分类

0. 概述

  1. {
  2.     "code":"000",    // 000 状态码表示请求成功
  3.     "message":"请求成功",// 返回结果说明
  4.     "data":{    // 所有返回数据的结构体
  5.         .... 
  6.     }
  7. }

或者

  1. {
  2.     "code":"000",    // 000 状态码表示请求成功
  3.     "message":"请求成功",// 返回结果说明
  4.     "data":[    // 所有返回数据的结构体
  5.         .... 
  6.     ]
  7. }

1. 客户端接口

1.1 概述

1.1.1 EndPoint

http://123.57.221.174:8080/admin/app/c/

1.1.2 Header

Key Value 备注
x-customer-token 用户登录后返回 除了登陆注册之外，所有的接口都需要添加这个Header

1.2 登录

  1. {
  2.     "mobile": "a",      // 手机号
  3.     "password": "a"     // 密码
  4. }
  1. {
  2.     "code": "000",
  3.     "message": "登录成功",
  4.     "data": {
  5.         "customerId": 2,            // 用户id
  6.         "token": "26e37f0e-eea9-47e4-b1d8-bb80a016d752" // Token
  7.     }
  8. }

1.3 注册

  1. {
  2.     "mobile": "a",      // 手机号
  3.     "password": "a"     // 密码
  4. }
  1. {
  2.     "code": "000",
  3.     "message": "注册成功",
  4.     "data":null
  5. }

1.4 退出登录

  1. {
  2.     "code": "000",
  3.     "message": "登出成功",
  4.     "data": null
  5. }

1.5 修改密码

  1. {
  2.     "oldpwd": "123",        // 旧密码
  3.     "newpwd": "123456"      // 新密码
  4. }
  1. {
  2.     "code": "000",
  3.     "message": "更新成功",
  4.     "data": null
  5. }

1.6 获取个人信息

  1. {
  2.     "code": "000",
  3.     "message": "成功",
  4.     "data": {
  5.         "id": 1,                // ID 
  6.         "address": "高家园小区7号楼3单元201",   // 地址
  7.         "birthday": "1980-01-01",       // 生日
  8.         "city": "朝阳区",               // 城市
  9.         "county": "望京",               // 区县
  10.         "customerType": 1,              // ??
  11.         "email": "tom@xexpress.com",    // Email
  12.         "gender": 1,                    // 性别，1 男；其他，女
  13.         "mobile": "18812348766",        // 手机号码
  14.         "nickName": "唐木木",           // 姓名
  15.         "password": "******",           // 密码
  16.         "province": "北京市"            // 省
  17.     }
  18. }

1.7 更新个人信息

  1. {
  2.     "address": "高家园小区7号楼3单元201",
  3.     "birthday": "1980-01-01",
  4.     "city": "朝阳区",
  5.     "county": "望京", 
  6.     "email": "tom@xexpress.com",
  7.     "gender": 1,
  8.     "mobile": "13300008899",
  9.     "nickName": "唐木木",
  10.     "province": "北京市"
  11. }
  1. {
  2.     "code": "000",
  3.     "message": "信息更新成功",
  4.     "data": ""
  5. }

1.8 添加常用地址

  1. {
  2.     "address": "高家园小区7号楼3单元201",
  3.     "birthday": "1980-01-01",
  4.     "city": "朝阳区",
  5.     "county": "望京", 
  6.     "email": "tom@xexpress.com",
  7.     "gender": 1,
  8.     "mobile": "13300008899",
  9.     "nickName": "唐木木",
  10.     "province": "北京市"
  11. }
  1. {
  2.     "code": "000",
  3.     "message": "添加成功",
  4.     "data": ""
  5. }

1.8 得到常用地址列表

  1. {
  2.     "code": "000",
  3.     "message": "添加成功",
  4.     "data": [
  5.         {
  6.             "address": "高家园小区7号楼3单元201",
  7.             "birthday": "1980-01-01",
  8.             "city": "朝阳区",
  9.             "county": "望京", 
  10.             "email": "tom@xexpress.com",
  11.             "gender": 1,
  12.             "mobile": "13300008899",
  13.             "nickName": "唐木木",
  14.             "province": "北京市"
  15.         },
  16.         ...
  17.     ]
  18. }

1.9 查找附近的快递员

  1. {
  2.    "longitude": "116.48445573534015",
  3.     "latitude": "39.97702946300868"
  4. }
  1. {
  2.     "code": "000",
  3.     "message": "成功",
  4.     "data": [
  5.         {
  6.             "id": 2,
  7.             "currentLatitude": 39.9827,
  8.             "currentLongitude": 116.491,
  9.             "description": null,
  10.             "gender": 0,
  11.             "lastUpdateTime": 1433992603000,
  12.             "mobile": "a",
  13.             "name": "test",
  14.             "stationName": "酒仙桥站",
  15.             "companyName": "全峰快递"
  16.         }
  17.     ]
  18. }

1.10 申请发快递

  1. {
  2.     "shipperCounty": "酒仙桥",
  3.     "consigneeProvince": "广东省",
  4.     "shipperLatitude": "39.97702946300868",
  5.     "shipperNickName": "唐木",
  6.     "customerDesc": "要快",
  7.     "shipperAddress": "高家园一区7号楼",
  8.     "shipperCity": "朝阳区",
  9.     "shipperMobile": "tom",
  10.     "shipperProvince": "北京市",
  11.     "shipperLongitude": "116.48445573534015",
  12.     "companyNo": "",
  13.     "consigneeCounty": "白云区",
  14.     "consigneeMobile": "17010001001",
  15.     "consigneeNickName": "罗山",
  16.     "consigneeAddress": "珠江明月2号楼7单元0712",
  17.     "consigneeCity": "广州市",
  18.     "collecteMoney"：1      // 是否到付,1是到付，其他不是到付
  19. }
  1. shipperCounty 发件人区县 required
  2. shipperNickName: 发件人昵称 required
  3. customerDesc: 客户备注
  4. shipperAddress: 发件人地址 required
  5. shipperCity: 发件人市地 required
  6. shipperMobile: 发件人手机 required
  7. shipperProvince: 发件人省份 required
  8. shipperLongitude: 发件人经度 optional
  9. shipperLatitude: 发件人纬度 optional
  10. companyNo: 快递公司编码 optional
  11. consigneeProvince: 收件人省份 required
  12. consigneeCounty: 收件人区县 required
  13. consigneeMobile: 收件人手机 required
  14. consigneeNickName: 收件人昵称 required
  15. consigneeAddress: 收件人地址 required
  16. consigneeCity: 收件人市地 required
  17. collecteMoney:是否到付 required
  1. {
  2.     "code": "000",
  3.     "message": "申请成功",
  4.     "data": null
  5. }

1.11 我的快递列表

  1. {
  2.     "code": "000",
  3.     "message": "成功",
  4.     "data": [
  5.         {
  6.             "id": 59,
  7.             "applyTime": 1433992558000,
  8.             "companyNo": null,
  9.             "consigneeAddress": "望京",
  10.             "consigneeCity": "北京市",
  11.             "consigneeCounty": "朝阳区",
  12.             "consigneeMobile": "3333333333",
  13.             "consigneeNickName": "aaaaaaaaa",
  14.             "consigneeProvince": "北京市",
  15.             "courierId": 2,
  16.             "customerDesc": "",
  17.             "expressNo": null,
  18.             "planTime": 1433999801000,
  19.             "printTime": null,
  20.             "receiveTime": null,
  21.             "shipperAddress": "望京",
  22.             "shipperCity": "北京市",
  23.             "shipperCounty": "朝阳区",
  24.             "shipperMobile": "13701011772",
  25.             "shipperNickName": "上官",
  26.             "shipperProvince": "北京市",
  27.             "shipperLatitude": 39.9828,
  28.             "shipperLongitude": 116.491,
  29.             "status": 2,
  30.             "payStatus":1
  31.             "trackNo": null
  32.         },
  33.         ...
  34.     ]
  35. }

1.12 快递详情

  1. {
  2.     "orderID": 1
  3. }
  1. {
  2.     "code": "000",
  3.     "message": "成功",
  4.     "data": [
  5.         {
  6.             "id": 59,
  7.             "applyTime": 1433992558000,
  8.             "companyNo": null,
  9.             "consigneeAddress": "望京",
  10.             "consigneeCity": "北京市",
  11.             "consigneeCounty": "朝阳区",
  12.             "consigneeMobile": "3333333333",
  13.             "consigneeNickName": "aaaaaaaaa",
  14.             "consigneeProvince": "北京市",
  15.             "courierId": 2,
  16.             "customerDesc": "",
  17.             "expressNo": null,
  18.             "planTime": 1433999801000,
  19.             "printTime": null,
  20.             "receiveTime": null,
  21.             "shipperAddress": "望京",
  22.             "shipperCity": "北京市",
  23.             "shipperCounty": "朝阳区",
  24.             "shipperMobile": "13701011772",
  25.             "shipperNickName": "上官",
  26.             "shipperProvince": "北京市",
  27.             "shipperLatitude": 39.9828,
  28.             "shipperLongitude": 116.491,
  29.             "status": 2,
  30.             "payStatus":1
  31.             "trackNo": null
  32.         },
  33.         ...
  34.     ]
  35. }

1.12 快递位置

  1. {
  2.     "orderID": 1
  3. }
  1. {
  2.     "code": "000",
  3.     "message": "成功",
  4.     "data": {
  5.         "courierID": 2,
  6.         "orderLatitude": 39.9827,
  7.         "orderLongitude": 116.491,
  8.         "courierName": "王明",
  9.         "courierMobile": "18500235684"
  10.     }
  11. }

2. 配送员端接口

2.1 概述

2.1.1 EndPoint

http://123.57.221.174:8080/admin/app/b/

2.1.2 Header

Key Value 备注
x-courier-token 用户登录后返回 除了登陆注册之外，所有的接口都需要添加这个Header

2.2 登录

  1. {
  2.     "mobile": "a",      // 手机号
  3.     "password": "a"     // 密码
  4. }
  1. {
  2.     "code": "000",
  3.     "message": "登录成功",
  4.     "data": {
  5.         "operatorId": 2,            // 用户id
  6.         "role": "快递员",           // 角色，对客户端来讲没有用
  7.         "token": "26e37f0e-eea9-47e4-b1d8-bb80a016d752" // Token
  8.     }
  9. }

2.3 退出登录

  1. {
  2.     "code": "000",
  3.     "message": "登出成功",
  4.     "data": null
  5. }

2.4 同步当前位置

  1. {
  2.    "longitude": "116.48445573534015",   // 经度
  3.    "latitude": "39.97702946300868"     // 纬度
  4. }
  1. {
  2.     "code": "000",
  3.     "message": "更新成功",
  4.     "data": null
  5. }

2.5 修改密码

  1. {
  2.     "oldpwd": "123",        // 旧密码
  3.     "newpwd": "123456"      // 新密码
  4. }
  1. {
  2.     "code": "000",
  3.     "message": "更新成功",
  4.     "data": null
  5. }

2.6 获取个人信息

  1. {
  2.     "code": "000",
  3.     "message": "成功",
  4.     "data": {
  5.         "id": 1,                // ID 
  6.         "address": "高家园小区7号楼3单元201",   // 地址
  7.         "birthday": "1980-01-01",       // 生日
  8.         "city": "朝阳区",               // 城市
  9.         "county": "望京",               // 区县
  10.         "customerType": 1,              // ??
  11.         "email": "tom@xexpress.com",    // Email
  12.         "gender": 1,                    // 性别，1 男；其他，女
  13.         "mobile": "18812348766",        // 手机号码
  14.         "nickName": "唐木木",           // 姓名
  15.         "password": "******",           // 密码
  16.         "province": "北京市"            // 省
  17.     }
  18. }

2.7 派单列表(附近的订单列表)

  1. {
  2.    "longitude": "116.48445573534015",           // 经度
  3.     "latitude": "39.97702946300868"             // 纬度
  4. }
  1. {
  2.     "code": "000",
  3.     "message": "成功",
  4.     "data": [
  5.         {
  6.             "id": 59,                       // 订单id
  7.             "applyTime": 1433992558000,     // 发单时间
  8.             "companyNo": null,              // ???，应该没用了吧？！
  9.             "consigneeAddress": "望京湖光中街1号",     // 收件人详细地址 
  10.             "consigneeCity": "北京市",      // 收件人所在的城市
  11.             "consigneeCounty": "朝阳区",    // 收件人所在的区县
  12.             "consigneeMobile": "3333333333",    // 收件人电话
  13.             "consigneeNickName": "aaaaaaaaa",  // 收件人姓名
  14.             "consigneeProvince": "北京市",      // 收件人省份或者直辖市名称
  15.             "courierId": 2,     // 快递员id?!
  16.             "customerDesc": "",     // 发件人备注信息
  17.             "expressNo": null,      // ???
  18.             "planTime": 1433999801000,  // 预计接单时间
  19.             "printTime": null,          // ？？？
  20.             "receiveTime": null,        // ???
  21.             "shipperAddress": "望京",   // 发件人详细信息
  22.             "shipperCity": "北京市",    // 发件人城市
  23.             "shipperCounty": "朝阳区",  // 发件人区县
  24.             "shipperMobile": "13701011772", // 发件人电话
  25.             "shipperNickName": "上官",  // 发件人姓名
  26.             "shipperProvince": "北京市",    // 发件人所在的省份或者直辖市名称
  27.             "shipperLatitude": 39.9828,     // 发件人的经度
  28.             "shipperLongitude": 116.491,    // 发件人的纬度
  29.             "status": 2,            // 订单状态，
  30.                                     // 1表示尚未被抢单;
  31.                                     // 2表示已经被抢单，但是尚未接单
  32.                                     // 3表示已经接单完成,正在配送中
  33.                                     // 4表示已经配送完成
  34.             "payStatus":1,          // 支付状态
  35.                                     // 1表示尚未支付
  36.                                     // 2表示已支付
  37.                                     // 3表示到付-未支付
  38.                                     // 4表示到付-已支付
  39.             "trackNo": null         // 快递单号
  40.         },
  41.         ...
  42.     ]
  43. }

2.8 抢单

  1. {
  2.     "id": "123",        // 订单号
  3.     "minute":30         // 预计多少分钟后可以到达发件人所在位置
  4. }
  1. {
  2.     "code": "000",
  3.     "message": "接单成功",
  4.     "data": null
  5. }

2.9 获得已接单列表(未取件)

  1. {
  2.     "code": "000",
  3.     "message": "成功",
  4.     "data": [
  5.         {
  6.             "id": 59,                       // 订单id
  7.             "applyTime": 1433992558000,     // 发单时间
  8.             "companyNo": null,              // ???，应该没用了吧？！
  9.             "consigneeAddress": "望京湖光中街1号",     // 收件人详细地址 
  10.             "consigneeCity": "北京市",      // 收件人所在的城市
  11.             "consigneeCounty": "朝阳区",    // 收件人所在的区县
  12.             "consigneeMobile": "3333333333",    // 收件人电话
  13.             "consigneeNickName": "aaaaaaaaa",  // 收件人姓名
  14.             "consigneeProvince": "北京市",      // 收件人省份或者直辖市名称
  15.             "courierId": 2,     // 快递员id?!
  16.             "customerDesc": "",     // 发件人备注信息
  17.             "expressNo": null,      // ???
  18.             "planTime": 1433999801000,  // 预计接单时间
  19.             "printTime": null,          // ？？？
  20.             "receiveTime": null,        // ???
  21.             "shipperAddress": "望京",   // 发件人详细信息
  22.             "shipperCity": "北京市",    // 发件人城市
  23.             "shipperCounty": "朝阳区",  // 发件人区县
  24.             "shipperMobile": "13701011772", // 发件人电话
  25.             "shipperNickName": "上官",  // 发件人姓名
  26.             "shipperProvince": "北京市",    // 发件人所在的省份或者直辖市名称
  27.             "shipperLatitude": 39.9828,     // 发件人的经度
  28.             "shipperLongitude": 116.491,    // 发件人的纬度
  29.             "status": 2,            // 订单状态
  30.             "trackNo": null         // 快递单号
  31.         },
  32.         ...
  33.     ]
  34. }

2.10 获得已接单列表(已取件，自己取件，不是从中转车上取的件)

  1. {
  2.     "code": "000",
  3.     "message": "成功",
  4.     "data": [
  5.         {
  6.             "id": 59,                       // 订单id
  7.             "applyTime": 1433992558000,     // 发单时间
  8.             "companyNo": null,              // ???，应该没用了吧？！
  9.             "consigneeAddress": "望京湖光中街1号",     // 收件人详细地址 
  10.             "consigneeCity": "北京市",      // 收件人所在的城市
  11.             "consigneeCounty": "朝阳区",    // 收件人所在的区县
  12.             "consigneeMobile": "3333333333",    // 收件人电话
  13.             "consigneeNickName": "aaaaaaaaa",  // 收件人姓名
  14.             "consigneeProvince": "北京市",      // 收件人省份或者直辖市名称
  15.             "courierId": 2,     // 快递员id?!
  16.             "customerDesc": "",     // 发件人备注信息
  17.             "expressNo": null,      // ???
  18.             "planTime": 1433999801000,  // 预计接单时间
  19.             "printTime": null,          // ？？？
  20.             "receiveTime": null,        // ???
  21.             "shipperAddress": "望京",   // 发件人详细信息
  22.             "shipperCity": "北京市",    // 发件人城市
  23.             "shipperCounty": "朝阳区",  // 发件人区县
  24.             "shipperMobile": "13701011772", // 发件人电话
  25.             "shipperNickName": "上官",  // 发件人姓名
  26.             "shipperProvince": "北京市",    // 发件人所在的省份或者直辖市名称
  27.             "shipperLatitude": 39.9828,     // 发件人的经度
  28.             "shipperLongitude": 116.491,    // 发件人的纬度
  29.             "status": 2,            // 订单状态
  30.             "trackNo": null         // 快递单号
  31.         },
  32.         ...
  33.     ]
  34. }

2.11 获得已接单列表(通过扫码从中转车上取的件)

  1. {
  2.     "code": "000",
  3.     "message": "成功",
  4.     "data": [
  5.         {
  6.             "id": 59,                       // 订单id
  7.             "applyTime": 1433992558000,     // 发单时间
  8.             "companyNo": null,              // ???，应该没用了吧？！
  9.             "consigneeAddress": "望京湖光中街1号",     // 收件人详细地址 
  10.             "consigneeCity": "北京市",      // 收件人所在的城市
  11.             "consigneeCounty": "朝阳区",    // 收件人所在的区县
  12.             "consigneeMobile": "3333333333",    // 收件人电话
  13.             "consigneeNickName": "aaaaaaaaa",  // 收件人姓名
  14.             "consigneeProvince": "北京市",      // 收件人省份或者直辖市名称
  15.             "courierId": 2,     // 快递员id?!
  16.             "customerDesc": "",     // 发件人备注信息
  17.             "expressNo": null,      // ???
  18.             "planTime": 1433999801000,  // 预计接单时间
  19.             "printTime": null,          // ？？？
  20.             "receiveTime": null,        // ???
  21.             "shipperAddress": "望京",   // 发件人详细信息
  22.             "shipperCity": "北京市",    // 发件人城市
  23.             "shipperCounty": "朝阳区",  // 发件人区县
  24.             "shipperMobile": "13701011772", // 发件人电话
  25.             "shipperNickName": "上官",  // 发件人姓名
  26.             "shipperProvince": "北京市",    // 发件人所在的省份或者直辖市名称
  27.             "shipperLatitude": 39.9828,     // 发件人的经度
  28.             "shipperLongitude": 116.491,    // 发件人的纬度
  29.             "status": 2,            // 订单状态
  30.             "trackNo": null         // 快递单号
  31.         },
  32.         ...
  33.     ]
  34. }

2.12 通过条形码接单(从中转车上扫件)

  1. {
  2.     "trackNo":"1243565778"         // 快递单号
  3. }
  1. {
  2.     "code": "000",
  3.     "message": "接单成功",
  4.     "data": null
  5. }

2.13 取件

  1. {
  2.     "id": "123",            // 订单id
  3.     "orderNo": "123456"     // 订单号
  4. }
  1. {
  2.     "code": "000",
  3.     "message": "取件成功",
  4.     "data": null
  5. }

2.14 计算订单价格

  1. {
  2.     "orderId":          // 订单id，如果有这个参数(不为0)则把价格应用到订单上
  3.     "typeID": 1,        // 类型id 
  4.     "volume": 2.1,      // 距离,这个距离能否服务端计算？
  5.     "weight":3.5        // 重量
  6. }
  1. {
  2.     "code": "000",
  3.     "message": "成功",
  4.     "data": {
  5.         "price":25.6
  6.     }
  7. }

2.15 得到商品类型

  1. {
  2.     "code": "000",
  3.     "message": "成功",
  4.     "data": [
  5.         {
  6.             "id": 1,
  7.             "name": "生鲜"
  8.         },
  9.         {
  10.             "id": 2,
  11.             "name": "鲜花"
  12.         }
  13.     ]
  14. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注