统一接口说明
# 预定功能v1.0统一接口说明
服务器地址:
测试机:10.60.1.150:8081
启按本地 :10.60.1.226
测试账号:另外提供
------
前端实现说明:
1.是否展示【预定订货】模块,更具接口1的返回值来直接判断
2.预定订单列表中是否展示【提货】按键,是根据当前销售单状态为(1,2,5,6)且提货总数小于可提总数
3.提货页中根据接口3中来展示产品列表,最高数不能高于(productCount-pickUpCount)
4.提货订单出库单页 是有接口3和接口5公共组合成
------
表A-统一接口说明
| 编号 | 作用 | 老接口 | 新接口 | 方式 | 传参 | 反参 |
| :--: | :-----------: | :------------------: | :--------------------------: | :--: | :---------------------: | ----- |
| 1 | 【预定订货】是否存在 | 无 | cSalesOrder/cGetMyScheduledSalesOrderStatus | GET | 无 | 看表C |
| 2 | 预定订单列表 | 无| cSalesOrder/cGetMyScheduledSalesOrders?offset=0&pageSize=5 | GET | offset->起始量;pageSize->每页展示量 | 看表C |
| 3 | 获取销售单详情(含销售明细) | 无 | cSalesOrder/cGetInfo/{id} | GET | id是salesOrder的id | 看表C |
| 4 | 提交提货单 | 无 | cStockMove/cAdd | POST | 传的是PickUpOrderReqVO对象 看表B | res.data>0 成功 返回的是出库单的id |
| 5 | 获取某个预订单提货列表 | 无 | cSalesOrder/cGetMyScheduledSalesOrderInfo/{id} | GET |id是salesOrder的id | 看表C |
------
表B-传参说明(无)
| 编号 | 说明 | 举例 |
| :--: | --------------------------------------------------------- | ------------------------------------------------------------ |
| 4 | addressId地址id,salesOrderId销售单id,shops是提交的哥哥商品和商品数对应的shop集合,每个shop含productId 商品id,count商品数, salesOrderLineId对应的销售明细id | {"addressId":1,"salesOrderId":11987,"shops":[{"count":2,"productId":39,"salesOrderLineId":11785},{"count":6,"productId":38,"salesOrderLineId":11786}]}
表C-反参说明
| 编号 | 说明 | 举例 |
| :--: | --------------------------------------------------------- | ------------------------------------------------------------ |
| 1 | 0无1有 res.data中 | {"data":1,"message":"","status":200}-->有 |
| 2 | 返回的时 分页封装类型 res.rows中是销售单的集合(List<SalesOrder>),| 这里给出了每个salesOrder的状态列表如下 订单状态 0:草稿 1:已提交 2:已确认 3: 已退回 4:取消 5:已发货 6:已完成 以及 预定商品总数(totalOrderProductCount) 预定商品已提总数(totalPickUpProductCount) |
| 3 | res.data 是销售单SalesOrder对象, 预定商品总数(totalOrderProductCount) 和 预定商品已提总数(totalPickUpProductCount) ,其中salesOrderLines是这个销售单的明细集合,每个明细都含产品,已提数量(pickUpCount) 和总共可提数量(productCount) | 1
| 5 | 返回的是stockMove的集合,每个stockmove的状态 0草稿 1待发货 2已发货 3已退回 4已取消 | |
------