420 lines
12 KiB
Plaintext
420 lines
12 KiB
Plaintext
版本号
|
||
|
||
发布日期
|
||
|
||
发布人
|
||
|
||
版本说明
|
||
|
||
V1.0.0
|
||
|
||
初稿
|
||
|
||
V1.0.1
|
||
|
||
销售出库业务类型枚举统一
|
||
|
||
V1.0.2
|
||
|
||
vendor错误码更新
|
||
|
||
V1.0.3
|
||
|
||
3.3.1 需求池模式新增demand_mode字段
|
||
|
||
V1.0.4
|
||
|
||
3.4.1 接口增加属性key说明
|
||
4.1接口字段urgent_flag变更到attr_list中
|
||
4.3状态码更新
|
||
4.7 接口字段urgent_flag future_order_qty future_sku_qty oos_order_qty 四个字段变更到attr_list中
|
||
|
||
V1.0.5
|
||
|
||
新增3.2.11对账接口
|
||
|
||
|
||
V1.0.6
|
||
|
||
2.1 接口返回putaway_qty字段说明
|
||
2.5 接口返回task_list说明
|
||
2.7 接口请求total_qty、putaway_qty、submit_qty字段说明
|
||
2.8 接口请求sku_list说明
|
||
|
||
V1.0.7
|
||
|
||
出库模块新增固定属性枚举说明(紫色标记)
|
||
3.1.3 更新urgent flag批量接口新增批量返回参数
|
||
|
||
v1.0.8
|
||
|
||
4.1AttrList新增oos_order_qty字段
|
||
4.1和4.7AttrItem新增urgent_flag字段说明(红色标记)
|
||
出库模块 新增拣货明细id说明(橙色标记)
|
||
|
||
v1.0.9
|
||
|
||
出库属性列表新增attr_value_type
|
||
3pl 属性key重命名为channel_id
|
||
|
||
v1.1.0
|
||
|
||
入库2.7接口新增错误码-10001016
|
||
|
||
v1.1.1
|
||
|
||
基础资料5.4 请求体新增reconciliation_date字段
|
||
|
||
v1.1.2
|
||
|
||
入库2.1 请求报文、2.5响应报文 批次信息 BatchInfo新增purchase_type
|
||
|
||
v1.1.3
|
||
|
||
库内4.5api路径改动 tovendor改为toshopee (已标记红色)
|
||
|
||
v1.1.4
|
||
|
||
入库2.4接口增加了关于反拣的search_key说明。
|
||
|
||
v1.1.5
|
||
|
||
库内4.3接口 remark增加传参说明
|
||
|
||
v1.1.6
|
||
|
||
出库(黄底标记)
|
||
3.1.7增加校验说明、参数返回说明
|
||
3.3.9 入参、出参与销售出库统一
|
||
3.4.7 出参与销售出库统一
|
||
3.1.11 增加参数说明
|
||
|
||
v1.1.7
|
||
|
||
3.1.1, 3.2.1, 3.3.1 3.4.1 新增下发参数ticket_type
|
||
3.2.2 删除不可能返回的错误码
|
||
|
||
v1.1.8
|
||
|
||
2.6接口新增uid录入说明
|
||
|
||
v1.1.9
|
||
|
||
4.1接口新增ticket_type
|
||
ticket_type枚举统一
|
||
|
||
v1.2.0
|
||
|
||
5.2，5.3，5.4接口block_type字段统一
|
||
|
||
v1.2.1
|
||
|
||
出库错误码补充
|
||
|
||
v1.2.2
|
||
|
||
废弃入库2.1、2.3、2.4、2.5、2.7、2.8接口sheet_id字段
|
||
|
||
v1.2.3
|
||
|
||
出库接口调用说明补充
|
||
|
||
v1.2.4
|
||
|
||
入库2.1、2.4接口BatchInfo新增sku_id
|
||
|
||
v1.2.5
|
||
|
||
基础资料 新增接口5.8；
|
||
基础资料 接口5.3 去除响应体BatchInventory 中的uid_list字段；
|
||
|
||
v1.2.6
|
||
|
||
4.1接口新增sku_quality参数 (好坏品 0代表好品 1代表坏品)
|
||
|
||
v1.2.7
|
||
|
||
需求池返回值增加非必填说明（3.3.6、3.3.8、3.3.10、3.3.11）
|
||
3.3.3 res_list增加最大长度说明
|
||
3.1.7 过账相关接口的拣货id增加长度说明
|
||
batch_no、pickup_id类型为int64
|
||
3.3.1 补充ctime字段
|
||
|
||
v1.2.8
|
||
|
||
附录A.1 新增-10000005错误码
|
||
|
||
v1.2.9
|
||
|
||
新增接口失败重试策略说明
|
||
|
||
v1.3.0
|
||
|
||
4.2的device_id字段 4.3的new_device_id字段增加备注(不可二次使用)
|
||
|
||
v1.3.1
|
||
|
||
更新operator说明
|
||
|
||
v1.3.2
|
||
|
||
5.3修复sku business type枚举值说明
|
||
|
||
v1.3.3
|
||
|
||
5.7查询robot状态接口可选参数agv_id_list统一改为robot_id_list
|
||
|
||
v1.3.4
|
||
|
||
4.7增加更新失败的单据id列表
|
||
4.5 接口增加一个需要重试的状态码
|
||
|
||
v1.3.5
|
||
|
||
新增DB字符集说明
|
||
|
||
v1.3.6
|
||
|
||
3.3.1 single_attr_list字段新增rts_type(20-Real 30-Virtual)
|
||
3.3.1 新增supplier_id字段以及业务逻辑
|
||
|
||
v1.3.7
|
||
|
||
库内4.6新增参数wave_flag start_time end_time exclude_source_id_list
|
||
|
||
v1.3.8
|
||
|
||
ConsumableSpecialTypeNoneSuggested = -1
|
||
新需求引入枚举
|
||
|
||
v1.3.9
|
||
|
||
新增3.1.12订单更新接口
|
||
|
||
v1.4.0
|
||
|
||
新增5.7 AgvStatus下的robot_model字段
|
||
|
||
包含wms和vendor都取消的订单
|
||
|
||
vendor侧，全部订单cancel，task终态也要通知wms
|
||
|
||
包含vendor，wms cancel的订单
|
||
|
||
vendor侧，全部订单cancel，task终态也要通知wms
|
||
|
||
包含vendor，wms cancel的订单
|
||
|
||
vendor侧，全部订单cancel，task终态也要通知wms
|
||
|
||
包含vendor，wms cancel的订单
|
||
|
||
是否保持一致
|
||
|
||
不需要传sku+qty的拣货明细。vendor保证一个订单不会在多个拣货任务中，wms用传的这些订单去预占auto zone的库存
|
||
|
||
去掉。complete接口给我们qty，零拣和缺拣，释放库存，都在complete处理即可
|
||
|
||
任务大小
|
||
|
||
暂定异步
|
||
|
||
与下发任务的cancel，用同一个接口
|
||
|
||
vendor侧的，xingyi之前说传过来我们记录下。
|
||
|
||
xingyi说，vendor侧的pick to order仅仅只移库支持换箱，其他都不支持
|
||
|
||
vendor侧的，xingyi之前说传过来我们记录下。
|
||
|
||
xingyi说，vendor侧的pick to order仅仅只移库支持换箱，其他都不支持
|
||
|
||
vendor侧的，xingyi之前说传过来我们记录下。
|
||
|
||
xingyi说，vendor侧的pick to order仅仅只移库支持换箱，其他都不支持
|
||
|
||
vendor侧的，xingyi之前说传过来我们记录下。
|
||
|
||
xingyi说，vendor侧的pick to order仅仅只移库支持换箱，其他都不支持
|
||
|
||
vendor侧的，xingyi之前说传过来我们记录下。
|
||
|
||
xingyi说，vendor侧的pick to order仅仅只移库支持换箱，其他都不支持
|
||
|
||
不需要传sku+qty的拣货明细。vendor保证一个订单不会在多个拣货任务中，wms用传的这些订单去预占auto zone的库存
|
||
。追加的场景都是单品单件的订单
|
||
|
||
0115：倾向于开始任务不做提前绑了，空绑/解绑/cancel后回到空绑的状态，这些流程就没了。
|
||
关联device和task的本接口是同步
|
||
|
||
考虑不可换箱字段
|
||
|
||
vendor->wms的取消接口，wms擦除预命中结果
|
||
|
||
1、qty为0的，不用给wms；
|
||
2、0拣的订单列表，不用传这个pickedorderinfo，只用传order list
|
||
|
||
包含wms取消，vendor没取消成功的订单
|
||
|
||
vendor释放device后依然占用着，WMS需要兼容释放为using空占
|
||
|
||
vendor要支持，上一个任务终态后，重复下单能成功
|
||
|
||
去掉了
|
||
|
||
接下来，调bind picking task的接口，绑定task和device开始任务
|
||
|
||
2月4号添加 Vendor创建的需要传 我们需要记录拣货的时候这个批次是冻结还是非冻结
|
||
|
||
改下名字？这个应该叫撤单
|
||
|
||
加个字段 传要更新的移库单号
|
||
|
||
这里有点奇怪，下面入参new_order_number_list为新追加的订单，那应该只追加订单3，传order3才对吧，为啥这里要写追加时追加order1,2,3，难道wms要支持已经在任务中的order再次传入？
|
||
|
||
list是拣货id维度
|
||
|
||
相同拣货id不同order，这里会有多条。wms调同步拣货明细时，要按拣货id汇聚一下。
|
||
|
||
sub_pickup_id维度，外层校验重复
|
||
|
||
哪些情况下可以变更为禁止上架
|
||
|
||
宋体:
|
||
新細明體:
|
||
|
||
|
||
ＭＳ 明朝:
|
||
宋体:
|
||
新細明體:
|
||
橙果依依:
|
||
橙果依依:
|
||
橙果依依:
|
||
橙果依依:
|
||
凡:
|
||
凡:
|
||
凡:
|
||
凡:
|
||
橙果依依:
|
||
橙果依依:
|
||
橙果依依:
|
||
橙果依依:
|
||
橙果依依:
|
||
橙果依依:
|
||
无可救药:
|
||
无可救药:
|
||
Shopee Automation Vendor 接入协议手册
|
||
文档版本信息
|
||
目录
|
||
概述
|
||
适用范围
|
||
术语定义
|
||
请求方式
|
||
1.1 Vendor请求Automation（北向请求）
|
||
请求协议
|
||
Authorization JWT Token加密规范
|
||
请求体格式
|
||
响应体格式
|
||
请求和响应示例(以5.1接口为例)
|
||
1.2 Automation请求Vendor（南向请求）
|
||
请求协议
|
||
Authorization JWT Token校验
|
||
请求体格式
|
||
响应体格式
|
||
请求和响应示例(以5.3接口为例)
|
||
接口失败重试策略
|
||
Vendor请求Automation失败场景
|
||
重试方法
|
||
入库模块接口协议
|
||
2.1 入库单据下发到Vendor
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
2.2 WMS给Vendor下发单据变更接口
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
2.3 WMS向Vendor下发单据查询接口
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
2.4 Vendor向WMS请求入库任务接口
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
2.5 Vendor向WMS反查入库任务接口
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
2.6 Vendor向WMS校验uid接口
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
2.7 Vendor向WMS提交库存过账接口
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
2.8 Vendor向WMS下发单据状态变更接口
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
出库模块接口协议
|
||
3.1 销售出库自动化SubPickingTask
|
||
3.1.1 WMS给Vendor下发拣货任务
|
||
请求字段
|
||
响应字段（和vendor对一下能提供什么字段给WMS）
|
||
返回码
|
||
3.1.2 WMS取消拣货任务
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.1.3 WMS向Vendor更新订单/task的urgent flag
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.1.4 Vendor绑定/解绑device(空占)【复用basic接口】
|
||
3.1.5 Vendor开始拣货任务
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.1.6 Vendor实绑拣货任务
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.1.7 Vendor增量拣货明细
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.1.8 Vendor发起换箱（不产生新任务）
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.1.9 Vendor完成拣货任务
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.1.10 Vendor请求流程指引
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.1.11 查询Vendor拣货任务列表【出库所有订单类型通用对账查询vendor接口】
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.2 销售出库自动化Order
|
||
3.2.1 WMS给Vendor下单
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.2.2 WMS向Vendor捞单
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.2.3 Vendor向WMS撤单
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.2.4 Wms向Vendor下发锁单/解锁请求
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.2.5 vendor向wms获取号段缓存
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.2.6 Vendor绑定解绑设备【复用basic接口】
|
||
3.2.7 Vendor向WMS创建picking task
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.2.8 Vendor向WMS追加明细
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.2.9 flow pick换箱
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.2.10 Vendor完成task
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.2.11 Wms向Vendor查询冻结状态订单列表(对账)
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.2.12 复用接口列表
|
||
3.3 RTS & MTO 需求池
|
||
3.3.1 WMS给Vendor下发需求
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.3.2 WMS向Vendor取消需求
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.3.3 Vendor 向 WMS 同步占用信息
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.3.4 Vendor绑定/解绑device【废弃】
|
||
3.3.5 Vendor向wms获取号段缓存【复用】
|
||
3.3.6 Vendor向WMS创建picking task
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.3.7 Vendor实绑拣货任务
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.3.8 Vendor向WMS追加明细
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.3.9 Vendor增量同步拣货明细
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.3.10 Vendor完成task
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.3.11 Vendor换箱接口
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.3.12 查询Vendor拣货任务列表【复用】
|
||
3.3.13 更新需求的urgent_flag【复用】
|
||
3.4 非需求池MTO
|
||
3.4.1 WMS给Vendor下发拣货任务
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.4.2 WMS取消拣货任务
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.4.3 WMS向Vendor更新task的urgent flag【复用3.1.3】
|
||
3.4.4 Vendor绑定/解绑device【复用basic接口】
|
||
3.4.5 Vendor开始拣货任务
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.4.6 Vendor真实绑定拣货任务
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.4.7 Vendor增量拣货明细
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.4.8 Vendor完成拣货任务
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
3.4.9 查询Vendor拣货任务列表【复用】
|
||
库内模块接口协议
|
||
4.1 库内移库同步占用库存给Vendor接口
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
4.2 库内移库Vendor占用PickingDevice接口
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
4.3 库内Vendor发起Picking明细整箱同步到WMS(WMS/Vendor创建)
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
4.4 库内Vendor发起Picking明细定时回传到WMS(只针对WMS创建)
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
4.5 库内Vendor发起盘点差异调减同步给WMS
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
4.6 库内发起Vendor查询拣货接口(用于对账)
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
4.7 库内更新(移库)单据(WMS创建的)
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
基础资料模块接口协议
|
||
5.1 vendor向WMS查询用户是否存在
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
5.2 WMS向Vendor同步批次状态
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
5.3 WMS向Vendor查询库存信息
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
5.4 WMS向Vendor同步对账结果
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
5.5 vendor向WMS查询sku信息
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
5.6 WMS向Vendor同步sku信息
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
5.7 WMS向Vendor查询AGV设备信息
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
5.8 WMS向Vendor查询Unit 信息
|
||
请求字段
|
||
响应字段
|
||
返回码
|
||
附录
|
||
A.1 返回码
|
||
A.2 测试环境 |