534 lines
14 KiB
JSON
534 lines
14 KiB
JSON
{
|
||
"generatedAt": "2026-06-04 09:53:13",
|
||
"generatedAtLocal": "2026-06-04 09:53:13",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "拣货车模块",
|
||
"key": "pickCart",
|
||
"folder": "pickcart",
|
||
"interfaceCount": 8
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "pickCart.scan",
|
||
"title": "按拣货车条码/编码查询拣货车信息,供 PDA 扫码后用于拣货任务绑定。",
|
||
"description": "按拣货车条码/编码查询拣货车信息,供 PDA 扫码后用于拣货任务绑定。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "cart_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "拣货车条码/编码"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "cart_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货车ID"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "仓库ID"
|
||
},
|
||
{
|
||
"name": "cart_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "拣货车编码"
|
||
},
|
||
{
|
||
"name": "cart_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "拣货车名称"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货车状态:0-停用 1-启用"
|
||
},
|
||
{
|
||
"name": "current_task_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "当前绑定任务ID,无绑定时为 null"
|
||
},
|
||
{
|
||
"name": "current_task_no",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "当前绑定任务编号,无绑定时为 null"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "pickCart.bindTaskCart",
|
||
"title": "绑定拣货任务与拣货车。支持传 cart_id 或 cart_code;若任务已绑定其他拣货车则自动改绑,若目标拣货车已绑定其他活动任务则返回冲突。",
|
||
"description": "绑定拣货任务与拣货车。支持传 cart_id 或 cart_code;若任务已绑定其他拣货车则自动改绑,若目标拣货车已绑定其他活动任务则返回冲突。",
|
||
"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": "cart_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "拣货车ID,和 cart_code 二选一即可"
|
||
},
|
||
{
|
||
"name": "cart_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "拣货车编码,和 cart_id 二选一即可"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货任务ID"
|
||
},
|
||
{
|
||
"name": "task_no",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "拣货任务编号"
|
||
},
|
||
{
|
||
"name": "cart",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "绑定后的拣货车信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "pickCart.create",
|
||
"title": "创建拣货车。拣货车编码在当前仓库内不可重复。",
|
||
"description": "创建拣货车。拣货车编码在当前仓库内不可重复。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "cart_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "拣货车编码,当前仓库内唯一"
|
||
},
|
||
{
|
||
"name": "cart_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "拣货车名称"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "状态:0-停用 1-启用,默认 1"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "cart_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货车ID"
|
||
},
|
||
{
|
||
"name": "cart_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "拣货车编码"
|
||
},
|
||
{
|
||
"name": "cart_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "拣货车名称"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "状态:0-停用 1-启用"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "pickCart.update",
|
||
"title": "更新拣货车。支持修改编码、名称、状态;若修改后的编码与当前仓库内其他拣货车重复则拦截。",
|
||
"description": "更新拣货车。支持修改编码、名称、状态;若修改后的编码与当前仓库内其他拣货车重复则拦截。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "cart_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货车ID"
|
||
},
|
||
{
|
||
"name": "cart_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "新的拣货车编码"
|
||
},
|
||
{
|
||
"name": "cart_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "新的拣货车名称"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "新的状态:0-停用 1-启用"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "cart_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货车ID"
|
||
},
|
||
{
|
||
"name": "cart_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "拣货车编码"
|
||
},
|
||
{
|
||
"name": "cart_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "拣货车名称"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "状态:0-停用 1-启用"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "pickCart.delete",
|
||
"title": "删除拣货车。若拣货车当前已绑定任务或存在有效绑定记录,则不允许删除。",
|
||
"description": "删除拣货车。若拣货车当前已绑定任务或存在有效绑定记录,则不允许删除。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "cart_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货车ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "cart_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "被删除的拣货车ID"
|
||
},
|
||
{
|
||
"name": "deleted",
|
||
"type": "boolean",
|
||
"required": true,
|
||
"description": "是否删除成功,固定为 true"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "pickCart.detail",
|
||
"title": "查询拣货车详情。",
|
||
"description": "查询拣货车详情。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "cart_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货车ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "cart_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货车ID"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "仓库ID"
|
||
},
|
||
{
|
||
"name": "cart_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "拣货车编码"
|
||
},
|
||
{
|
||
"name": "cart_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "拣货车名称"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "状态:0-停用 1-启用"
|
||
},
|
||
{
|
||
"name": "current_task_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "当前绑定任务ID,无绑定时为 null"
|
||
},
|
||
{
|
||
"name": "current_task_no",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "当前绑定任务编号,无绑定时为 null"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "pickCart.list",
|
||
"title": "分页查询拣货车列表。支持按关键字、状态、当前绑定任务筛选。",
|
||
"description": "分页查询拣货车列表。支持按关键字、状态、当前绑定任务筛选。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page/pageSize,默认 1/20"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "筛选条件,支持 keyword、status、current_task_id"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "拣货车列表,元素结构同 pickCart.detail 返回"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息,包含 page、pageSize、total、totalPages"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "pickCart.codeDuplicateCheck",
|
||
"title": "拣货车编码查重。支持传 exclude_cart_id 排除自身,用于编辑场景判断是否与其他车重复。",
|
||
"description": "拣货车编码查重。支持传 exclude_cart_id 排除自身,用于编辑场景判断是否与其他车重复。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "cart_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "待校验的拣货车编码"
|
||
},
|
||
{
|
||
"name": "exclude_cart_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "需排除的拣货车ID,通常为当前编辑记录自身ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "duplicated",
|
||
"type": "boolean",
|
||
"required": true,
|
||
"description": "是否存在重复编码"
|
||
},
|
||
{
|
||
"name": "cart_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "命中的重复拣货车ID,无重复时为 null"
|
||
},
|
||
{
|
||
"name": "cart_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "命中的重复编码,无重复时为 null"
|
||
},
|
||
{
|
||
"name": "cart_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "命中的重复拣货车名称,无重复时为 null"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "命中的重复拣货车状态,无重复时为 null"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|