2026-05-23 18:15:21 +08:00

168 lines
5.2 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"generatedAt": "2026-05-23 09:07:16",
"generatedAtLocal": "2026-05-23 09:07:16",
"source": "remote",
"filter": {
"platform": {
"value": "web",
"label": "网页端"
},
"project": {
"value": "all",
"label": "全部"
}
},
"module": {
"name": "拣货模块",
"key": "pick",
"folder": "pick",
"interfaceCount": 2
},
"changes": {
"fromPreviousSnapshot": {
"moduleAdded": false,
"moduleRenamed": false,
"interfaceChanges": {
"addedMethods": [],
"deletedMethods": [],
"paramsUpdatedMethods": [],
"responseUpdatedMethods": []
}
}
},
"interfaces": [
{
"method": "pick.query",
"title": "按订单查询波次拣货信息,支持 full/full_display/is_full 控制是否完整显示;接口按当前登录用户仓库上下文过滤,防止跨仓越界。",
"description": "按订单查询波次拣货信息,支持 full/full_display/is_full 控制是否完整显示;接口按当前登录用户仓库上下文过滤,防止跨仓越界。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "waybill_code",
"type": "string",
"required": true,
"description": "快递号/运单号,必填。"
},
{
"name": "full_display",
"type": "boolean",
"required": false,
"description": "是否完整显示拣货明细;默认 false。true 返回全部拣货明细,false 仅返回未完成的(inspection_status != 'fin')。"
}
],
"response": [
{
"name": "order_id",
"type": "string|number",
"required": false,
"description": "订单 ID"
},
{
"name": "wave_id",
"type": "number",
"required": false,
"description": "波次 ID(若订单未关联波次则为空)"
},
{
"name": "wave_no",
"type": "string",
"required": false,
"description": "波次编号(若订单未关联波次则为空)"
},
{
"name": "full_display",
"type": "boolean",
"required": false,
"description": "是否以完整明细展示(等同于请求中的 full/full_display/is_full)"
},
{
"name": "summary",
"type": "object",
"required": false,
"description": "汇总信息"
},
{
"name": "list",
"type": "array",
"required": false,
"description": "拣货明细列表(根据 full 参数返回全量或仅未复核明细),每项为明细对象,字段视实现而定。"
}
]
},
{
"method": "pick.wavePickTaskDetail",
"title": "按任务ID获取拣货任务详情,返回精简的 task、boxes、picking_details 与 picking_summary;仅允许任务的 pick_user_id 与当前登录用户(operator_id/employees_id)一致时返回数据,否则返回 403。",
"description": "按任务ID获取拣货任务详情,返回精简的 task、boxes、picking_details 与 picking_summary;仅允许任务的 pick_user_id 与当前登录用户(operator_id/employees_id)一致时返回数据,否则返回 403。",
"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": "boxes",
"type": "array",
"required": false,
"description": "箱列表;包含用于前端展示与拣货进度的统计字段"
},
{
"name": "picking_details",
"type": "array",
"required": false,
"description": "拣货明细列表(按库位/商品/数量拆分),用于从明细视角展示拣货要求"
},
{
"name": "picking_summary",
"type": "object",
"required": false,
"description": "对 picking_details 的汇总信息,用于统计与前端显示"
},
{
"name": "picking_view",
"type": "object",
"required": false,
"description": "按 pick_mode 区分的 picking_view 形态输出(五种形态);用于前端按任务类型展示聚合视图。"
}
]
}
]
}