1、KuaiLai 司机接口说明书版本 修改人 日期 说明1.0 汪熙 2017-04-24 创建目 录1 序言 .31.1 概述 .31.2 适用读者 .31.3 参考文档 .32 接口说明 .42.1 司机登录 .42.2 忘记密码 .52.3 验证码验证 .52.4 获取物流分配单 .62.5 获取物流分配单详情.62.6 获取订单详情信息.72.7 执行物流分配单发货.82.8 查询物流分配单.82.9 订单完成操作.92.10 分配单取货.91 序言概述1. 该接口主要用户送货司机 APP 操作2. 接口是平台重要的组成部分。3. 接口 Post 获取。适用读者本文档将给开发、测试人员的
2、相关工作提供参考和标准1. 备注红色为必填项。2. 如果接口有分页功能,无需分页 PageIndex、PageSize 请传递 0参考文档无2 接口说明接口地址: https:/api.kuailai.me:8088/Api/ Driverhttp:/api.kuailai.me/Api/ Driver2.1 司机登录 传递参数说明序号 字段名称 类型 备注1 MethodName String 方法名称(固定值 Login)2 UserName String 用户名3 PassWord String 密码返回参数说明序号 字段名称 类型 备注1 msg String 返回说明(ok:成功)其
3、余为错误信息2 UserInfo Object 司机实体对象(msg 为 ok 时返回)2.2 忘记密码 发送验证码传递参数说明 序号 字段名称 类型 备注1 MethodName String 方法名称(固定值 UpdatePassword)2 UpdateType int 类型(1:修改密码、2:发送验证码 )3 Phone String 手机号码4 UserName String 用户名、账号返回参数说明序号 字段名称 类型 备注1 msg String 返回说明(ok:成功)其余为错误信息2 Code String 验证码 修改密码传递参数说明序号 字段名称 类型 备注1 Method
4、Name String 方法名称(固定值 UpdatePassword)2 UpdateType int 类型(1:修改密码、2:发送验证码 )3 Phone String 手机号码4 UserName String 用户名、账号返回参数说明序号 字段名称 类型 备注1 msg String 返回说明(ok:成功)其余为错误信息2.3 验证码验证传递参数说明序号 字段名称 类型 备注1 MethodName String 方法名称(固定值 CheckCode)2 Code String 验证码3 Phone String 手机号码4 UserName String 用户名、账号返回参数说明序号
5、 字段名称 类型 备注1 msg String 返回说明(ok:成功)其余为错误信息2.4 查询物流分配单传递参数说明序号 字段名称 类型 备注1 MethodName String 方法名称(固定值 Get DistributionList)2 DriverId String 用户 ID3 PageIndex String 第几页4 PageSize String 每页显示条数返回参数说明序号 字段名称 类型 备注1 msg String 返回说明(ok:成功)其余为错误信息2 ItemList List 分配单列表信息AllocationNum String 分配单号SumWeight S
6、tring 总重量Volume String 总体积CreateTime String 分配时间Id Int 分配单 IdStatus String 当前状态2.5 查询物流分配单详情传递参数说明序号 字段名称 类型 备注1 MethodName String 方法名称(固定值 DistributionDetails)2 DistributionId Int 分配单 ID3 DriverId String 司机 ID(历史订单获取时必传)返回参数说明序号 字段名称 类型 备注1 msg String 返回说明(ok:成功)其余为错误信息2 ItemList List 销售单列表信息Id Int
7、 销售单 IDOrderNum String 销售单号Consignee String 收货人Tel String 电话Address String 地址DistributionItemIdInt 分配单详情 IDStatusName String 销售单状态2.6 查询订单详情传递参数说明序号 字段名称 类型 备注1 MethodName String 方法名称(固定值 GetOrderItem)2 DistributionId Int 分配单 ID3 OrderId String 销售单 ID返回参数说明序号 字段名称 类型 备注1 msg String 返回说明(ok:成功)其余为错误信
8、息2 ItemList List 商品列表信息Id Int 商品 IDarticlenumber String 商品编号Name String 商品名称Classification String 商品分类amount Int 数量2.7 执行物流分配单发货(配货中的订单才可以进行发货操作)传递参数说明序号 字段名称 类型 备注1 MethodName String 方法名称(固定值 ObtainDistribution)2 DistributionId Int 分配单 ID3 DriverId String 司机 ID4 OrderItem List 分配单详情(全部发货时该值不传 )Orde
9、rId Int 订单 IDDistributionItemIdInt 分配单详情 ID返回参数说明序号 字段名称 类型 备注1 msg String 返回说明(ok:成功)其余为错误信息2.8 根据取货码查询物流分配单传递参数说明序号 字段名称 类型 备注1 MethodName String 方法名称(固定值 GetDistribution)2 DriverCode String 获取码返回参数说明序号 字段名称 类型 备注1 msg String 返回说明(ok:成功)其余为错误信息2 ItemList List 分配单列表信息AllocationNum String 分配单号SumWei
10、ght String 总重量Volume String 总体积CreateTime String 分配时间Id Int 分配单 IdStatus String 当前状态2.9 订单完成操作(配送中的订单才可以执行完成操作)传递参数说明序号 字段名称 类型 备注1 MethodName String 方法名称(固定值 CompleteOrder)2 DistributionId Int 分配单 ID3 OrderId Int 销售单 ID4 DriverId String 司机 ID5 PicContent String 签收图片返回参数说明序号 字段名称 类型 备注1 msg String 返回说明(ok:成功)其余为错误信息2.10 分配单取货传递参数说明序号 字段名称 类型 备注1 MethodName String 方法名称(固定值 PickUp)2 DistributionId Int 分配单 ID3 DriverId String 司机 ID返回参数说明序号 字段名称 类型 备注1 msg String 返回说明(ok:成功)其余为错误信息