282 lines
9.6 KiB
JSON
282 lines
9.6 KiB
JSON
{
|
||
"generatedAt": "2026-06-17 10:25:45",
|
||
"generatedAtLocal": "2026-06-17 10:25:45",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "拣货模块",
|
||
"key": "pick",
|
||
"folder": "pick",
|
||
"interfaceCount": 4
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "pick.query",
|
||
"title": "按 keyword(运单号或波次号)获取或创建当前用户的拣货任务:命中同用户活动任务返回 existing;无活动任务则创建并返回 created;若活动任务归属他人则返回冲突提示。",
|
||
"description": "按 keyword(运单号或波次号)获取或创建当前用户的拣货任务:命中同用户活动任务返回 existing;无活动任务则创建并返回 created;若活动任务归属他人则返回冲突提示。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "keyword",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "关键字,支持运单号或波次号。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货任务ID。"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态:existing(命中当前用户已有活动任务)或 created(新建成功)。"
|
||
},
|
||
{
|
||
"name": "tip",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "提示文案。"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "pick.wavePickTaskDetail",
|
||
"title": "按任务ID获取拣货任务详情。查询前会校验任务内订单是否全部完成快递号与储位分配:若存在未分配快递号或未分配储位订单,将返回 400 并在 data 中返回 action 与 order_ids 供前端触发一键分配;详情响应新增中间态进度语义(task.is_completed、task.progress 与顶层 is_completed),用于前端判断是否已完成与展示阶段进度;仅允许任务的 pick_user_id 与当前登录用户一致时返回详情。当 pick_mode=1(团购小波次)时,picking_details 字段不返回以减少带宽。",
|
||
"description": "按任务ID获取拣货任务详情。查询前会校验任务内订单是否全部完成快递号与储位分配:若存在未分配快递号或未分配储位订单,将返回 400 并在 data 中返回 action 与 order_ids 供前端触发一键分配;详情响应新增中间态进度语义(task.is_completed、task.progress 与顶层 is_completed),用于前端判断是否已完成与展示阶段进度;仅允许任务的 pick_user_id 与当前登录用户一致时返回详情。当 pick_mode=1(团购小波次)时,picking_details 字段不返回以减少带宽。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "wms_wave_pick_task 主键 ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "拣货任务主表(精简字段)"
|
||
},
|
||
{
|
||
"name": "is_completed",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "任务是否已完成(与 task.is_completed 含义一致,便于前端直接判断)"
|
||
},
|
||
{
|
||
"name": "boxes",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "箱列表;包含用于前端展示与拣货进度的统计字段"
|
||
},
|
||
{
|
||
"name": "picking_details",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "拣货明细列表(按库位/商品/数量拆分),用于从明细视角展示拣货要求。注意:当 pick_mode=1(团购小波次)时该字段不返回,减少带宽浪费;其他 pick_mode(2/3/4/5)正常返回。"
|
||
},
|
||
{
|
||
"name": "picking_summary",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "对 picking_details 的汇总信息,用于统计与前端显示"
|
||
},
|
||
{
|
||
"name": "picking_view",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "按 pick_mode 区分的 picking_view 形态输出(五种形态);用于前端按任务类型展示聚合视图。"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "pick.wavePickTaskSubmit",
|
||
"title": "提交拣货任务中间态。用于保存阶段性数据到任务 ext_json.pick_intermediate,并在任务初始状态时自动推进到进行中。",
|
||
"description": "提交拣货任务中间态。用于保存阶段性数据到任务 ext_json.pick_intermediate,并在任务初始状态时自动推进到进行中。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货任务ID"
|
||
},
|
||
{
|
||
"name": "payload",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "中间态业务数据对象,将原样保存到 ext_json.pick_intermediate.payload"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货任务ID"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "提交结果状态,固定为 submitted"
|
||
},
|
||
{
|
||
"name": "is_completed",
|
||
"type": "boolean",
|
||
"required": true,
|
||
"description": "当前任务是否已完成"
|
||
},
|
||
{
|
||
"name": "progress",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "任务订单拣货进度统计"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "pick.wavePickTaskComplete",
|
||
"title": "完全提交拣货任务。支持 mode=1 全部确认,mode=2 部分确认(需传 order_ids)。提交后根据是否全部完成自动推进任务状态。后台抓取创建的任务(source=2)必须先绑定拣货车才能提交,否则返回 400。",
|
||
"description": "完全提交拣货任务。支持 mode=1 全部确认,mode=2 部分确认(需传 order_ids)。提交后根据是否全部完成自动推进任务状态。后台抓取创建的任务(source=2)必须先绑定拣货车才能提交,否则返回 400。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货任务ID"
|
||
},
|
||
{
|
||
"name": "mode",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "提交模式:1=全部确认(默认),2=部分确认"
|
||
},
|
||
{
|
||
"name": "order_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "部分确认模式(mode=2)时必填;仅会确认命中当前任务的订单ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货任务ID"
|
||
},
|
||
{
|
||
"name": "mode",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "实际生效的提交模式(1=全部确认,2=部分确认)"
|
||
},
|
||
{
|
||
"name": "confirmed_order_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "本次成功确认的订单ID列表"
|
||
},
|
||
{
|
||
"name": "is_completed",
|
||
"type": "boolean",
|
||
"required": true,
|
||
"description": "提交后任务是否已完成"
|
||
},
|
||
{
|
||
"name": "progress",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "任务订单拣货进度统计"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|