2549 lines
87 KiB
JSON
2549 lines
87 KiB
JSON
{
|
||
"generatedAt": "2026-06-18 17:45:21",
|
||
"generatedAtLocal": "2026-06-18 17:45:21",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "订单波次模块",
|
||
"key": "order.wave",
|
||
"folder": "order.wave",
|
||
"interfaceCount": 29
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "order.wave.waveStrategyList",
|
||
"title": "查询当前仓库波次策略列表。仅查询当前登录仓库在 wms_wave_strategy 中的数据,返回标准 list/pagination 结构。",
|
||
"description": "查询当前仓库波次策略列表。仅查询当前登录仓库在 wms_wave_strategy 中的数据,返回标准 list/pagination 结构。",
|
||
"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"
|
||
},
|
||
{
|
||
"name": "strategy_type",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "仅支持 1=散单、2=团购;与 where.strategy_type 同时存在时以顶层 strategy_type 为准。"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "当前仅支持 where.strategy_type(1/2);其余 where 字段暂不支持。"
|
||
},
|
||
{
|
||
"name": "calculate_next_fetch_order_count / calculateNextFetchOrderCount",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "0-不计算(默认),1-计算并返回每条策略的 next_fetch_order_count;支持别名 calculateNextFetchOrderCount"
|
||
},
|
||
{
|
||
"name": "debug",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "0-不启用(默认),1-启用调试输出,返回每条策略的 next_fetch_order_list(含结构/快递/货主ID等指标明细)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "策略列表,每项为波次策略记录"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.waveStrategyCreate",
|
||
"title": "新增波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。创建成功后会推进仓库的 wave_strategy_version 并失效相关缓存。",
|
||
"description": "新增波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。创建成功后会推进仓库的 wave_strategy_version 并失效相关缓存。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "strategy_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "策略名称(必填)"
|
||
},
|
||
{
|
||
"name": "strategy_type",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "策略类型(必填,正整数):1-散单 2-团购"
|
||
},
|
||
{
|
||
"name": "batch_mode",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货模式(必填,正整数)"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "状态:1-启用 0-停用(可选)"
|
||
},
|
||
{
|
||
"name": "order_min_sku",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最小 SKU 种类数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "order_max_sku",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最大 SKU 种类数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "order_min_qty",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最小商品总数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "order_max_qty",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最大商品总数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "min_same_structure",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最小相同结构订单数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "max_same_structure",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最大相同结构订单数(可选,正整数或 null)。注意:若传入值 >= 仓库配置的 min_group_order_fetch_quantity,则会被下调为 min_group_order_fetch_quantity - 1,最小为 1。"
|
||
},
|
||
{
|
||
"name": "batch_max_orders",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "批次最大订单数(可选)"
|
||
},
|
||
{
|
||
"name": "batch_max_skus",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "批次最大 SKU 总数(可选)"
|
||
},
|
||
{
|
||
"name": "group_batch_max_orders",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "团购批次最大订单数(可选)"
|
||
},
|
||
{
|
||
"name": "require_same_express",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否要求相同快递(可选,布尔)"
|
||
},
|
||
{
|
||
"name": "allow_cross_owner",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否允许跨货主(可选,布尔)"
|
||
},
|
||
{
|
||
"name": "description",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "策略描述(可选)"
|
||
},
|
||
{
|
||
"name": "allowed_provinces",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的省份列表(可选,支持数组、JSON 字符串或逗号分隔字符串)"
|
||
},
|
||
{
|
||
"name": "allowed_platforms",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的平台列表(可选,支持数组、JSON 字符串或逗号分隔字符串)"
|
||
},
|
||
{
|
||
"name": "allowed_owners",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的货主列表(可选,支持数组/JSON/逗号分隔);系统会校验所传货主是否在仓库可用货主范围内,非法值将导致 400 错误。"
|
||
},
|
||
{
|
||
"name": "allowed_expresses",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的快递编码列表(可选,支持数组/JSON/逗号分隔);系统会校验所传编码是否在可用快递列表内,非法值将导致 400 错误。"
|
||
},
|
||
{
|
||
"name": "wave_prefix",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "波次编号前缀(可选),最多 5 个字符,如 D、B、A;不传则保持原值"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "创建的策略对象,字段同 order.wave.waveStrategyList.list[*] 所示"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "HTTP-like 状态码,成功时返回 200"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.waveStrategyUpdate",
|
||
"title": "修改波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。id(或 strategy_id/strategyId)为必填主键,其他字段为可选更新;更新成功后会推进仓库的 wave_strategy_version 并失效相关缓存。",
|
||
"description": "修改波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。id(或 strategy_id/strategyId)为必填主键,其他字段为可选更新;更新成功后会推进仓库的 wave_strategy_version 并失效相关缓存。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id / strategy_id / strategyId",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "策略主键,兼容 id / strategy_id / strategyId(必填)"
|
||
},
|
||
{
|
||
"name": "strategy_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "策略名称(可选)"
|
||
},
|
||
{
|
||
"name": "strategy_type",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "策略类型(可选,正整数)"
|
||
},
|
||
{
|
||
"name": "batch_mode",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "拣货模式(可选,正整数)"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "状态:1-启用 0-停用(可选)"
|
||
},
|
||
{
|
||
"name": "order_min_sku",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最小 SKU 种类数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "order_max_sku",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最大 SKU 种类数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "order_min_qty",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最小商品总数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "order_max_qty",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最大商品总数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "min_same_structure",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最小相同结构订单数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "max_same_structure",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最大相同结构订单数(可选,正整数或 null)。会受仓库 min_group_order_fetch_quantity 约束,接口会自动调整。"
|
||
},
|
||
{
|
||
"name": "batch_max_orders",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "批次最大订单数(可选)"
|
||
},
|
||
{
|
||
"name": "batch_max_skus",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "批次最大 SKU 总数(可选)"
|
||
},
|
||
{
|
||
"name": "group_batch_max_orders",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "团购批次最大订单数(可选)"
|
||
},
|
||
{
|
||
"name": "require_same_express",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否要求相同快递(可选,布尔)"
|
||
},
|
||
{
|
||
"name": "allow_cross_owner",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否允许跨货主(可选,布尔)"
|
||
},
|
||
{
|
||
"name": "description",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "策略描述(可选)"
|
||
},
|
||
{
|
||
"name": "allowed_provinces",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的省份列表(可选,支持数组/JSON/逗号分隔)"
|
||
},
|
||
{
|
||
"name": "allowed_platforms",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的平台列表(可选,支持数组/JSON/逗号分隔)"
|
||
},
|
||
{
|
||
"name": "allowed_owners",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的货主列表(可选,支持数组/JSON/逗号分隔);系统会校验所传货主是否在仓库可用货主范围内,非法值将导致 400 错误。"
|
||
},
|
||
{
|
||
"name": "allowed_expresses",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的快递编码列表(可选,支持数组/JSON/逗号分隔);系统会校验所传编码是否在可用快递列表内,非法值将导致 400 错误。"
|
||
},
|
||
{
|
||
"name": "wave_prefix",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "波次编号前缀(可选),最多 5 个字符,如 D、B、A;不传则保持原值"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "更新后的策略对象,字段同 order.wave.waveStrategyList.list[*] 所示"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "HTTP-like 状态码,成功时返回 200"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.waveStrategyQuickScan",
|
||
"title": "提交波次策略快速扫描异步任务。无外部参数,使用当前仓库上下文;同一仓库同一时刻仅允许一个任务运行,若已有运行任务直接返回已有 task_id。",
|
||
"description": "提交波次策略快速扫描异步任务。无外部参数,使用当前仓库上下文;同一仓库同一时刻仅允许一个任务运行,若已有运行任务直接返回已有 task_id。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "提交状态,固定 success"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(用于后续查询进度)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "仓库 ID(来自当前上下文)"
|
||
},
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态(一般为 submitted 或 running)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选提示信息"
|
||
},
|
||
{
|
||
"name": "accepted_at",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "任务受理时间(ISO 字符串)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.waveStrategyFetchPda",
|
||
"title": "按策略提交并创建抓取主流程任务(PDA)。当前为最小主流程:进行入参校验并创建任务记录,返回创建结果与计划预览;后续扫描/执行阶段将扩展为完整执行流。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。",
|
||
"description": "按策略提交并创建抓取主流程任务(PDA)。当前为最小主流程:进行入参校验并创建任务记录,返回创建结果与计划预览;后续扫描/执行阶段将扩展为完整执行流。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "strategy_id / strategyId",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "策略ID(正整数,支持下划线/驼峰)"
|
||
},
|
||
{
|
||
"name": "cart_id / cartId",
|
||
"type": "string|number",
|
||
"required": false,
|
||
"description": "可选,关联拣货车/作业车ID,支持字符串或数字,用于记录作业上下文"
|
||
},
|
||
{
|
||
"name": "source / operation_source",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选,操作来源标识(例如 pda/admin/manual/auto),用于审计与分流策略"
|
||
},
|
||
{
|
||
"name": "strategy_params / strategyParams",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "可选,策略参数透传对象(如 order_min_qty/order_max_qty/allow_cross_owner 等),在创建任务时作为策略覆盖或附加参数使用"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态:created(已创建主流程任务),后续可能为 running/success/failed"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务唯一 ID(用于后续查询或关联)"
|
||
},
|
||
{
|
||
"name": "task_no",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务业务编号(便于展示与关联)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "生效的仓库 ID(来自当前上下文,如可用则返回)"
|
||
},
|
||
{
|
||
"name": "strategy_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "生效的策略 ID(与入参保持一致,兼容回传)"
|
||
},
|
||
{
|
||
"name": "plan",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "任务计划/执行预览对象,描述本次任务预估的执行计划"
|
||
},
|
||
{
|
||
"name": "plan_summary",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "计划摘要字符串,便于前端在受理后快速展示(例如:'创建 3 个波次,涉及 120 单,约 450 件')"
|
||
},
|
||
{
|
||
"name": "validation_errors",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "当入参校验失败时返回的数组,每项为 { field, message } 对象,供前端展示或定位问题"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选提示信息或错误说明(创建失败时返回简短说明)"
|
||
},
|
||
{
|
||
"name": "fetch_state",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "抓取结果三态:1=成功创建任务(返回 task_id/task_no),2=普通失败(task_id=null),3=存在未完成任务(返回 existing task_id/task_no,前端可进入拣货流程)"
|
||
},
|
||
{
|
||
"name": "tip",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "简短提示,用于向前端展示简要原因或下一步建议"
|
||
},
|
||
{
|
||
"name": "can_enter_pick_flow",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "仅当 fetch_state=3 时为 true,表示前端可直接进入拣货流程"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.waveStrategyFetchAdmin",
|
||
"title": "按策略提交并创建抓取主流程任务(后台管理)。当前为最小主流程:执行入参校验并创建任务记录,返回创建结果与计划预览;后续将扩展完整扫描/执行链路。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。",
|
||
"description": "按策略提交并创建抓取主流程任务(后台管理)。当前为最小主流程:执行入参校验并创建任务记录,返回创建结果与计划预览;后续将扩展完整扫描/执行链路。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "strategy_id / strategyId",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "策略ID(正整数,支持下划线/驼峰)"
|
||
},
|
||
{
|
||
"name": "cart_id / cartId",
|
||
"type": "string|number",
|
||
"required": false,
|
||
"description": "可选,关联拣货车/作业车ID,用于记录作业上下文或幂等识别"
|
||
},
|
||
{
|
||
"name": "source / operation_source",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选,操作来源标识(例如 admin/pda/manual/auto),用于审计与分流策略"
|
||
},
|
||
{
|
||
"name": "strategy_params / strategyParams",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "可选,策略参数透传对象(如 order_min_qty/order_max_qty/allow_cross_owner 等),在创建任务时作为策略覆盖或附加参数使用"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态:created(已创建主流程任务),后续可能为 running/success/failed"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务唯一 ID(用于后续查询或关联)"
|
||
},
|
||
{
|
||
"name": "task_no",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务业务编号(便于展示与关联)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "生效的仓库 ID(来自当前上下文,如可用则返回)"
|
||
},
|
||
{
|
||
"name": "strategy_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "生效的策略 ID(与入参保持一致,兼容回传)"
|
||
},
|
||
{
|
||
"name": "plan",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "任务计划/执行预览对象,描述本次任务预估的执行计划"
|
||
},
|
||
{
|
||
"name": "plan_summary",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "计划摘要字符串,便于前端在受理后快速展示(例如:'创建 3 个波次,涉及 120 单,约 450 件')"
|
||
},
|
||
{
|
||
"name": "validation_errors",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "当入参校验失败时返回的数组,每项为 { field, message } 对象,供前端展示或定位问题"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选提示信息或错误说明(创建失败时返回简短说明)"
|
||
},
|
||
{
|
||
"name": "fetch_state",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "抓取结果三态:1=成功创建任务(返回 task_id/task_no),2=普通失败(task_id=null),3=存在未完成任务(返回 existing task_id/task_no,前端可进入拣货流程)"
|
||
},
|
||
{
|
||
"name": "tip",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "简短提示,用于向前端展示简要原因或下一步建议"
|
||
},
|
||
{
|
||
"name": "can_enter_pick_flow",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "仅当 fetch_state=3 时为 true,表示前端可直接进入拣货流程"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.waveStrategyQuickScanTaskProgress",
|
||
"title": "查询波次策略快速扫描任务进度。接受 task_id / taskId,若未找到返回 state='not_found'。",
|
||
"description": "查询波次策略快速扫描任务进度。接受 task_id / taskId,若未找到返回 state='not_found'。",
|
||
"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 / taskId",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(下划线或驼峰兼容,必填)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID"
|
||
},
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态:submitted/running/success/failed/not_found"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "仓库 ID"
|
||
},
|
||
{
|
||
"name": "total_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "扫描订单总数"
|
||
},
|
||
{
|
||
"name": "processed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已处理订单数"
|
||
},
|
||
{
|
||
"name": "matched_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "命中策略的订单数"
|
||
},
|
||
{
|
||
"name": "unmatched_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "未命中策略的订单数"
|
||
},
|
||
{
|
||
"name": "progress_percent",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "进度百分比(0-100)"
|
||
},
|
||
{
|
||
"name": "submitted_at",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "提交时间(timestamp 或 ISO)"
|
||
},
|
||
{
|
||
"name": "start_time",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "实际开始时间(ISO)"
|
||
},
|
||
{
|
||
"name": "end_time",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "结束时间(ISO)"
|
||
},
|
||
{
|
||
"name": "error_message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "错误信息(若失败)"
|
||
},
|
||
{
|
||
"name": "error_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "错误码(若失败)"
|
||
},
|
||
{
|
||
"name": "duration_ms",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "耗时,毫秒"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.groupOrderFetchList",
|
||
"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"
|
||
},
|
||
{
|
||
"name": "distinguish_express",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否区分快递(影响分组粒度)"
|
||
},
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "货主ID(仅作为筛选条件)"
|
||
},
|
||
{
|
||
"name": "same_order_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最小同组订单数量阈值(>=)。若显式传入有效数值则按传入值使用;未传入时使用仓库配置 min_group_order_fetch_quantity(默认 13)。"
|
||
},
|
||
{
|
||
"name": "shop_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "店铺名称(模糊匹配)"
|
||
},
|
||
{
|
||
"name": "include_sku",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "仅保留包含该 SKU 的分组(页内过滤)"
|
||
},
|
||
{
|
||
"name": "return_order_ids",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否在结果中返回组内订单ID列表"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "分组列表,每项包含 item_detail、item_detail_machine、item_detail_machine_snapshot、item_snapshot、group、group_count、items_total、items_weight(总重量kg,取组内首单 items_weight)、store_id、store_ids、logistics_name、distinguish_express、first_order_time、last_order_time、status_summary 等字段;若指定 return_order_ids=true 则额外包含 order_ids"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.singleFetchByIds",
|
||
"title": "按订单 ID 列表抓取到一个散单波次。仅处理当前仓库的待处理订单(step in [1,2,3]),排除已在波次中的订单(wave_id>0),不区分快递;成功抓取后批量写入订单操作日志;当无可抓取订单时返回 wave_id=0。",
|
||
"description": "按订单 ID 列表抓取到一个散单波次。仅处理当前仓库的待处理订单(step in [1,2,3]),排除已在波次中的订单(wave_id>0),不区分快递;成功抓取后批量写入订单操作日志;当无可抓取订单时返回 wave_id=0。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids / order_ids / orderIds",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单 ID 列表;支持数组、逗号分隔字符串或单个 ID。入参会被去重并转换为正整数。字段解析优先顺序:ids -> order_ids -> orderIds。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "请求归一化后的 ids 列表(去重且为正整数)"
|
||
},
|
||
{
|
||
"name": "wave_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "创建的波次 ID;若无可抓取订单返回 0"
|
||
},
|
||
{
|
||
"name": "wave_no",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "创建的波次号;无可抓取时为空字符串"
|
||
},
|
||
{
|
||
"name": "fetched_order_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "实际被抓取并成功分配到波次的订单 ID 列表(为归一化后的 ids 的子集)"
|
||
},
|
||
{
|
||
"name": "fetched_order_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "实际被抓取的订单数量(等于 fetched_order_ids.length)"
|
||
},
|
||
{
|
||
"name": "excluded_existing_wave_order_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "原始入参中已在其它波次中的订单 ID(被排除,不会被抓取)"
|
||
},
|
||
{
|
||
"name": "skipped_order_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "因订单状态不符、正在出库或其他业务原因被跳过的订单 ID(不会被抓取)"
|
||
},
|
||
{
|
||
"name": "not_found_order_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "入参中未在数据库中找到的订单 ID"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.waveStrategyFallbackOrderList",
|
||
"title": "基于波次策略的回退候选订单列表。该接口内置固定筛选条件:step != 0、wave_id = 0、wave_scan_result = 2。用于展示策略未命中但需回退处理的订单候选。",
|
||
"description": "基于波次策略的回退候选订单列表。该接口内置固定筛选条件:step != 0、wave_id = 0、wave_scan_result = 2。用于展示策略未命中但需回退处理的订单候选。",
|
||
"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"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "筛选白名单字段(object)。仅支持下列字段,且禁止传入 warehouse_id / warehouseId: - id(等值) - delivery_no / deliveryNo(模糊) - tracking_no / trackingNo(模糊) - items_count_min / items_count_max(范围) - items_total_min / items_total_max(范围) - sys_logistics_name(模糊) - store_name(模糊) - owner_name(等值) - province(模糊) - sys_platform_name(模糊) 说明:若传入未列出的字段或禁止字段(如 warehouse_id)接口会返回 400。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "回退候选订单简要列表。数组内对象字段说明见 children。"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.singleOrderFetchList",
|
||
"title": "按机器结构分组的散单候选列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。与 order.wave.groupOrderFetchList 不同:groupOrderFetchList 返回满足同组订单数量 >= same_order_quantity(或仓库配置 min_group_order_fetch_quantity)的团购命中分组;singleOrderFetchList 则排除这些团购命中分组,仅返回同组订单数量小于该阈值的散单候选分组(即 < same_order_quantity)。",
|
||
"description": "按机器结构分组的散单候选列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。与 order.wave.groupOrderFetchList 不同:groupOrderFetchList 返回满足同组订单数量 >= same_order_quantity(或仓库配置 min_group_order_fetch_quantity)的团购命中分组;singleOrderFetchList 则排除这些团购命中分组,仅返回同组订单数量小于该阈值的散单候选分组(即 < same_order_quantity)。",
|
||
"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"
|
||
},
|
||
{
|
||
"name": "distinguish_express",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否区分快递(影响分组粒度)"
|
||
},
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "货主ID(仅作为筛选条件)"
|
||
},
|
||
{
|
||
"name": "same_order_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最小同组订单数量阈值(用于判定团购命中);本接口返回同组订单数量小于该阈值的分组。若显式传入有效数值则按传入值使用;未传入时使用仓库配置 min_group_order_fetch_quantity(默认 13)。"
|
||
},
|
||
{
|
||
"name": "shop_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "店铺名称(模糊匹配)"
|
||
},
|
||
{
|
||
"name": "include_sku",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "仅保留包含该 SKU 的分组(页内过滤)"
|
||
},
|
||
{
|
||
"name": "return_order_ids",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否在结果中返回组内订单ID列表"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "散单候选分组列表,每项包含 item_detail、item_detail_machine、item_detail_machine_snapshot、item_snapshot、group、group_count、items_total、items_weight(总重量kg,取组内首单 items_weight)、store_id、store_ids、logistics_name、distinguish_express、first_order_time、last_order_time、status_summary 等字段;返回的 group_count 均小于 same_order_quantity(或仓库配置的 min_group_order_fetch_quantity);若指定 return_order_ids=true 则额外包含 order_ids"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.wavePickTaskList",
|
||
"title": "按当前仓库分页查询拣货任务列表。支持顶层分页参数 `page_no`/`page_size`(兼容 `pagination` 对象与 `current/size`),支持 `status` 单值或数组;兼容历史 `where` 结构,顶层参数优先。默认按 create_time desc 排序。",
|
||
"description": "按当前仓库分页查询拣货任务列表。支持顶层分页参数 `page_no`/`page_size`(兼容 `pagination` 对象与 `current/size`),支持 `status` 单值或数组;兼容历史 `where` 结构,顶层参数优先。默认按 create_time desc 排序。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "仓库ID(必填)"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize,兼容 current / size(兼容旧客户端)"
|
||
},
|
||
{
|
||
"name": "page_no",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "页码(优先于 pagination.page/current)"
|
||
},
|
||
{
|
||
"name": "page_size",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "每页大小(优先于 pagination.pageSize/size)"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "拣货任务状态过滤;建议传数组,也兼容单值或逗号分隔字符串,兼容 where.status;顶层参数优先"
|
||
},
|
||
{
|
||
"name": "review_status",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "复核状态过滤"
|
||
},
|
||
{
|
||
"name": "pick_mode",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "拣货模式(如批量/逐单等)"
|
||
},
|
||
{
|
||
"name": "source",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "任务来源标识(业务端语义)"
|
||
},
|
||
{
|
||
"name": "pick_user_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "拣货执行人ID(兼容旧字段)"
|
||
},
|
||
{
|
||
"name": "review_user_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "复核人ID"
|
||
},
|
||
{
|
||
"name": "task_no",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "任务编号(支持模糊匹配)"
|
||
},
|
||
{
|
||
"name": "cart_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "拣货车/作业车ID"
|
||
},
|
||
{
|
||
"name": "keyword",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "关键字搜索:支持 task_no / batch_no / current_cart_code_snapshot 等字段的模糊匹配"
|
||
},
|
||
{
|
||
"name": "start_time_start",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "开始时间(ISO 字符串),与 start_time_end 一起用于时间范围过滤"
|
||
},
|
||
{
|
||
"name": "start_time_end",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "结束时间(ISO 字符串),与 start_time_start 一起用于时间范围过滤"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "兼容历史 where 结构(可包含 status 等字段);当存在顶层同名参数时,顶层参数优先"
|
||
},
|
||
{
|
||
"name": "strategy_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "策略ID(当前主表未存,该接口会忽略此过滤,建议勿使用)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "拣货任务列表(数组),每项字段如下"
|
||
},
|
||
{
|
||
"name": "total",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "总记录数"
|
||
},
|
||
{
|
||
"name": "page",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前页码"
|
||
},
|
||
{
|
||
"name": "page_size",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "每页大小"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.wavePickTaskCancel",
|
||
"title": "取消拣货任务(批量)。可取消的状态:0=待开始、1=拣货中、2=待复核(拣货完成)、3=已完成,状态9(已取消)或其他状态不允许取消。同时释放关联波次(物理删除波次记录,订单回池)、解绑拣货车、写操作日志。对于status=2或3的任务,取消时会自动回退订单拣货状态:wms_wave_pick_task_order.pick_status(1→0)、order_delivery.pick_status(fin→padding)。入参仅支持 task_ids(数组,必填),不再支持单个 task_id。操作人与仓库从请求上下文获取(例如当前登录用户上下文 ctx.user),若上下文缺失接口将返回错误。",
|
||
"description": "取消拣货任务(批量)。可取消的状态:0=待开始、1=拣货中、2=待复核(拣货完成)、3=已完成,状态9(已取消)或其他状态不允许取消。同时释放关联波次(物理删除波次记录,订单回池)、解绑拣货车、写操作日志。对于status=2或3的任务,取消时会自动回退订单拣货状态:wms_wave_pick_task_order.pick_status(1→0)、order_delivery.pick_status(fin→padding)。入参仅支持 task_ids(数组,必填),不再支持单个 task_id。操作人与仓库从请求上下文获取(例如当前登录用户上下文 ctx.user),若上下文缺失接口将返回错误。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "task_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "任务ID数组,例如 [123,124];仅支持批量处理,不再支持单个 task_id。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "cancelled_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "成功取消的任务数量"
|
||
},
|
||
{
|
||
"name": "task_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "处理的任务ID数组(若后端返回)"
|
||
},
|
||
{
|
||
"name": "task_nos",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "处理的任务编号数组(若后端返回)"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务ID(历史兼容,若后端仍返回)"
|
||
},
|
||
{
|
||
"name": "task_no",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "任务编号(历史兼容,若后端仍返回)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.wavePickTaskCancelSelf",
|
||
"title": "取消单个拣货任务(仅允许取消当前操作人本人创建的任务;仅支持单个 task_id,明确不支持 task_ids)",
|
||
"description": "取消单个拣货任务(仅允许取消当前操作人本人创建的任务;仅支持单个 task_id,明确不支持 task_ids)",
|
||
"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(仅支持单个,不支持 task_ids)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "cancelled_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "成功取消的任务数量(0 或 1)"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "被处理的任务ID"
|
||
},
|
||
{
|
||
"name": "task_no",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "被处理的任务编号(若后端返回)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.batchCancel",
|
||
"title": "提交批量解除波次异步任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理波次并执行解除操作;可通过 order.wave.batchCancelTaskProgress 查询进度与结果。",
|
||
"description": "提交批量解除波次异步任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理波次并执行解除操作;可通过 order.wave.batchCancelTaskProgress 查询进度与结果。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "wave_ids / waveIds / ids",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "波次ID列表;支持数组、逗号分隔字符串或单个ID"
|
||
},
|
||
{
|
||
"name": "task_id / taskId",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选外部任务ID,用于幂等提交"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "提交状态,固定 success"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(用于查询任务进度)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前仓库ID"
|
||
},
|
||
{
|
||
"name": "accepted_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务受理时间(ISO8601)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "受理提示信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.batchCancelTaskProgress",
|
||
"title": "查询批量解除波次任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。响应包含 state、progress_percent、processed_wave_count、total_wave_count;当 state 为 success/failed 时返回额外字段说明。",
|
||
"description": "查询批量解除波次任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。响应包含 state、progress_percent、processed_wave_count、total_wave_count;当 state 为 success/failed 时返回额外字段说明。",
|
||
"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 / taskId",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成或提交时传入)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID"
|
||
},
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
|
||
},
|
||
{
|
||
"name": "progress_percent",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "进度百分比(0-100)"
|
||
},
|
||
{
|
||
"name": "processed_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已处理的波次数量"
|
||
},
|
||
{
|
||
"name": "total_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "总波次数量"
|
||
},
|
||
{
|
||
"name": "duration_ms",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务耗时(毫秒)"
|
||
},
|
||
{
|
||
"name": "error_message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误信息(仅在 state=failed 时返回)"
|
||
},
|
||
{
|
||
"name": "error_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误码(仅在 state=failed 时返回)"
|
||
},
|
||
{
|
||
"name": "result",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "成功时返回的汇总结果(仅在 state=success 时返回),例如 { \"processed_wave_count\": number, \"canceled_wave_count\": number }"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.batchAllocateExpress",
|
||
"title": "提交批次分配快递号任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到快递号分配流水线。",
|
||
"description": "提交批次分配快递号任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到快递号分配流水线。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "wave_ids / waveIds / ids",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "波次ID列表;支持数组、逗号分隔字符串或单个ID"
|
||
},
|
||
{
|
||
"name": "task_id / taskId",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选外部任务ID,用于幂等提交"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "提交状态,固定 success"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(用于查询任务进度)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前仓库ID"
|
||
},
|
||
{
|
||
"name": "accepted_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务受理时间(ISO8601)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "受理提示信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.batchAllocateExpressTaskProgress",
|
||
"title": "查询批次分配快递号任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
|
||
"description": "查询批次分配快递号任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
|
||
"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 / taskId",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成或提交时传入)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID"
|
||
},
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务关联仓库ID"
|
||
},
|
||
{
|
||
"name": "total_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "波次数量"
|
||
},
|
||
{
|
||
"name": "total_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "参与分配的订单数量"
|
||
},
|
||
{
|
||
"name": "processed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已处理订单数量"
|
||
},
|
||
{
|
||
"name": "success_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "成功提交分配的订单数量"
|
||
},
|
||
{
|
||
"name": "failed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "提交分配失败的订单数量"
|
||
},
|
||
{
|
||
"name": "progress_percent",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "进度百分比(0-100)"
|
||
},
|
||
{
|
||
"name": "duration_ms",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务耗时(毫秒)"
|
||
},
|
||
{
|
||
"name": "error_message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误信息"
|
||
},
|
||
{
|
||
"name": "error_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误码"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.batchRemoveExceptionOrders",
|
||
"title": "提交批次移除异常订单任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取异常订单并移出波次。",
|
||
"description": "提交批次移除异常订单任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取异常订单并移出波次。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "wave_ids / waveIds / ids",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "波次ID列表;支持数组、逗号分隔字符串或单个ID"
|
||
},
|
||
{
|
||
"name": "task_id / taskId",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选外部任务ID,用于幂等提交"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "提交状态,固定 success"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(用于查询任务进度)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前仓库ID"
|
||
},
|
||
{
|
||
"name": "accepted_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务受理时间(ISO8601)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "受理提示信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.batchRemoveExceptionOrdersTaskProgress",
|
||
"title": "查询批次移除异常订单任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
|
||
"description": "查询批次移除异常订单任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
|
||
"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 / taskId",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成或提交时传入)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID"
|
||
},
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务关联仓库ID"
|
||
},
|
||
{
|
||
"name": "total_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "波次数量"
|
||
},
|
||
{
|
||
"name": "total_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "参与处理的订单数量"
|
||
},
|
||
{
|
||
"name": "processed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已处理订单数量"
|
||
},
|
||
{
|
||
"name": "removed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已成功移出波次的订单数量"
|
||
},
|
||
{
|
||
"name": "failed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "处理失败的订单数量"
|
||
},
|
||
{
|
||
"name": "progress_percent",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "进度百分比(0-100)"
|
||
},
|
||
{
|
||
"name": "duration_ms",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务耗时(毫秒)"
|
||
},
|
||
{
|
||
"name": "error_message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误信息"
|
||
},
|
||
{
|
||
"name": "error_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误码"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.batchAllocateStorage",
|
||
"title": "提交批次分配储位任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到储位分配流水线。",
|
||
"description": "提交批次分配储位任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到储位分配流水线。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "wave_ids / waveIds / ids",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "波次ID列表;支持数组、逗号分隔字符串或单个ID"
|
||
},
|
||
{
|
||
"name": "task_id / taskId",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选外部任务ID,用于幂等提交"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "提交状态,固定 success"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(用于查询任务进度)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前仓库ID"
|
||
},
|
||
{
|
||
"name": "accepted_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务受理时间(ISO8601)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "受理提示信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.batchAllocateStorageTaskProgress",
|
||
"title": "查询批次分配储位任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
|
||
"description": "查询批次分配储位任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
|
||
"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 / taskId",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成或提交时传入)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID"
|
||
},
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务关联仓库ID"
|
||
},
|
||
{
|
||
"name": "total_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "波次数量"
|
||
},
|
||
{
|
||
"name": "total_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "参与分配的订单数量"
|
||
},
|
||
{
|
||
"name": "processed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已处理订单数量"
|
||
},
|
||
{
|
||
"name": "success_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "成功提交分配的订单数量"
|
||
},
|
||
{
|
||
"name": "failed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "提交分配失败的订单数量"
|
||
},
|
||
{
|
||
"name": "progress_percent",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "进度百分比(0-100)"
|
||
},
|
||
{
|
||
"name": "duration_ms",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务耗时(毫秒)"
|
||
},
|
||
{
|
||
"name": "error_message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误信息"
|
||
},
|
||
{
|
||
"name": "error_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误码"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.groupFetch",
|
||
"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": "structure_list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识),可选 quantity(未传入时使用仓库默认或全局默认)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "生效的仓库 ID"
|
||
},
|
||
{
|
||
"name": "structure_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "本次入参的结构数量(structure_list 长度)"
|
||
},
|
||
{
|
||
"name": "default_quantity",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "仓库默认抓取数量或全局默认值"
|
||
},
|
||
{
|
||
"name": "fetch_mode",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "抓取模式,值为 'group'(团购)或 'single'(散单)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.singleFetch",
|
||
"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": "structure_list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识)并包含必填字段 max_fetch_quantity(最大抓取上限,订单数,正整数);可选 quantity(未传入时使用仓库默认或全局默认)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "生效的仓库 ID"
|
||
},
|
||
{
|
||
"name": "structure_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "本次入参的结构数量(structure_list 长度)"
|
||
},
|
||
{
|
||
"name": "default_quantity",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "仓库默认抓取数量或全局默认值"
|
||
},
|
||
{
|
||
"name": "fetch_mode",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "抓取模式,值为 'group'(团购)或 'single'(散单)"
|
||
},
|
||
{
|
||
"name": "max_fetch_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "提交时生效的最大抓取上限(订单数,正整数)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.fetch",
|
||
"title": "兼容别名(等同 groupFetch)",
|
||
"description": "兼容别名(等同 groupFetch)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "structure_list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识),可选 quantity(未传入时使用仓库默认或全局默认)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "生效的仓库 ID"
|
||
},
|
||
{
|
||
"name": "structure_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "本次入参的结构数量(structure_list 长度)"
|
||
},
|
||
{
|
||
"name": "default_quantity",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "仓库默认抓取数量或全局默认值"
|
||
},
|
||
{
|
||
"name": "fetch_mode",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "抓取模式,值为 'group'(团购)或 'single'(散单)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.fetchTaskProgress",
|
||
"title": "查询波次抓取任务进度:按 task_id 查询任务状态与进度;兼容 taskId 参数名。",
|
||
"description": "查询波次抓取任务进度:按 task_id 查询任务状态与进度;兼容 taskId 参数名。",
|
||
"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 / taskId",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成的唯一标识),兼容旧参数名 taskId,可从 order.wave.fetch 的返回值中获取"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "生效的仓库 ID(若任务关联仓库时返回)"
|
||
},
|
||
{
|
||
"name": "structure_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "本次任务的结构数量(structure_list 长度)"
|
||
},
|
||
{
|
||
"name": "finished_structure_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已完成抓取的结构数量"
|
||
},
|
||
{
|
||
"name": "progress_percent",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "进度百分比(0-100,可能为小数)"
|
||
},
|
||
{
|
||
"name": "total_fetched_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已抓取的总件数"
|
||
},
|
||
{
|
||
"name": "duration_ms",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务已运行时长,毫秒级"
|
||
},
|
||
{
|
||
"name": "error",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "错误信息,仅当 status=failed 时返回"
|
||
},
|
||
{
|
||
"name": "fetch_mode",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "抓取模式,值为 'group'(团购)或 'single'(散单);single 模式时可能返回下列额外字段"
|
||
},
|
||
{
|
||
"name": "max_fetch_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "当 fetch_mode=single 时返回的最大抓取上限(订单数,正整数)"
|
||
},
|
||
{
|
||
"name": "limit_reached",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "当 fetch_mode=single 时指示是否已达到 max_fetch_quantity 限制"
|
||
},
|
||
{
|
||
"name": "stop_reason",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "任务停止原因(如达到上限、人工停止或其他失败原因)"
|
||
},
|
||
{
|
||
"name": "update_time",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "最近一次状态更新时间,ISO8601 字符串"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "额外提示信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.batchAutoGrouping",
|
||
"title": "批量将波次状态修改为 0(自动加团中),仅作用当前登录仓库命中的波次。限制条件: - 跳过已打印及之后状态的波次(wave_status >= 2); - 跳过 total_orders >= 仓库配置 max_wave_quantity 的波次。被跳过的波次不会被修改为自动加团中。",
|
||
"description": "批量将波次状态修改为 0(自动加团中),仅作用当前登录仓库命中的波次。限制条件: - 跳过已打印及之后状态的波次(wave_status >= 2); - 跳过 total_orders >= 仓库配置 max_wave_quantity 的波次。被跳过的波次不会被修改为自动加团中。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "波次ID 列表;支持数组、逗号分隔字符串或单个ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "归一化后的请求ID"
|
||
},
|
||
{
|
||
"name": "affected_wave_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "实际命中的波次ID"
|
||
},
|
||
{
|
||
"name": "updated_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "实际更新数量"
|
||
},
|
||
{
|
||
"name": "skipped_wave_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "被跳过的波次ID数组(不修改状态)"
|
||
},
|
||
{
|
||
"name": "skipped_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "被跳过的波次数量"
|
||
},
|
||
{
|
||
"name": "skipped_details",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "被跳过的波次明细數組,元素包含 wave_id 与 reason,reason 枚举 printed_or_after_printed / reach_max_wave_quantity"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.batchFinishAutoGrouping",
|
||
"title": "批量结束自动加团,将当前仓库命中且 wave_status=0 的波次改为 1(已就绪)。",
|
||
"description": "批量结束自动加团,将当前仓库命中且 wave_status=0 的波次改为 1(已就绪)。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "波次ID 列表;支持数组、逗号分隔字符串或单个ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "归一化后的请求ID"
|
||
},
|
||
{
|
||
"name": "affected_wave_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "实际命中的波次ID"
|
||
},
|
||
{
|
||
"name": "updated_wave_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "实际更新为已就绪的波次ID"
|
||
},
|
||
{
|
||
"name": "updated_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "实际更新数量"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.wave.batchRemoveOrders",
|
||
"title": "按订单ID批量移出波次;仅处理当前仓库的待处理订单表中非待审核订单(step in [1,2,3])。操作会清空订单的 wave_id/wave_no,并在同一事务内回写 wms_wave_batch 表:重算 total_orders,若波次被清空则将 wave_status 置为 -1。仓库上下文来自当前登录用户(ctx.user.store_id)。",
|
||
"description": "按订单ID批量移出波次;仅处理当前仓库的待处理订单表中非待审核订单(step in [1,2,3])。操作会清空订单的 wave_id/wave_no,并在同一事务内回写 wms_wave_batch 表:重算 total_orders,若波次被清空则将 wave_status 置为 -1。仓库上下文来自当前登录用户(ctx.user.store_id)。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids / order_ids / orderIds / order_id / orderId / id",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单 ID 列表;支持数组、逗号分隔字符串或单个 ID,以上别名均可用(ids、order_ids、orderIds、order_id、orderId、id)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "归一化后的请求 ID 列表"
|
||
},
|
||
{
|
||
"name": "removed_order_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "实际被移出波次的订单 ID 列表"
|
||
},
|
||
{
|
||
"name": "removed_order_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "被移出波次的订单数量"
|
||
},
|
||
{
|
||
"name": "affected_wave_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "本次操作涉及的波次 ID 列表"
|
||
},
|
||
{
|
||
"name": "updated_wave_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "实际更新了 total_orders 的波次 ID 列表"
|
||
},
|
||
{
|
||
"name": "emptied_wave_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "被清空且已置为 wave_status=-1 的波次 ID 列表"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|