450 lines
19 KiB
JSON
450 lines
19 KiB
JSON
{
|
||
"generatedAt": "2026-06-08 16:54:48",
|
||
"generatedAtLocal": "2026-06-08 16:54:48",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "订单复核模块",
|
||
"key": "order.recheckOrder",
|
||
"folder": "order.recheckorder",
|
||
"interfaceCount": 5
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "order.recheckOrder.scanOrder",
|
||
"title": "扫描关键词并返回以波次为单位的复核视图。支持运单号、波次号、车号三种匹配模式。运单号/波次号命中(散单)返回扁平化订单列表 list_type='single',车号命中(团单)返回嵌套波次结构 list_type='group'。运单号命中但订单无波次信息时,退回单订单详情模式(list 每项含 detail/items/expresses/logs)。",
|
||
"description": "扫描关键词并返回以波次为单位的复核视图。支持运单号、波次号、车号三种匹配模式。运单号/波次号命中(散单)返回扁平化订单列表 list_type='single',车号命中(团单)返回嵌套波次结构 list_type='group'。运单号命中但订单无波次信息时,退回单订单详情模式(list 每项含 detail/items/expresses/logs)。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "keyword / value / waybill_no / waybillCode / waybill_code / wave_no / waveNo / cart_code / cartCode",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "扫描关键词;匹配优先级:运单号 → 波次号 → 车号。支持别名 waybillCode/waybill_code(运单号)、waveNo(波次号)、cartCode(车号)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "match_type",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "命中类型:waybill(运单号命中)/ wave(波次号命中)/ cart(车号命中)"
|
||
},
|
||
{
|
||
"name": "list_type",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "列表模式:single(散单扁平列表)/ group(团购嵌套波次列表)"
|
||
},
|
||
{
|
||
"name": "waybill_no",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "仅 waybill 命中时返回,匹配到的运单号"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "number|null",
|
||
"required": false,
|
||
"description": "散单有波次信息时返回(来自拣货任务表 wms_wave_pick_task.id),团单车号命中时返回 cartMatchContext 中的任务 ID"
|
||
},
|
||
{
|
||
"name": "picker_id",
|
||
"type": "number|null",
|
||
"required": false,
|
||
"description": "仅散单模式(有波次信息时)返回,拣货人ID(来自 wms_wave_pick_task.pick_user_id)"
|
||
},
|
||
{
|
||
"name": "picker_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "仅散单模式(有波次信息时)返回,拣货人名称(来自 wms_wave_pick_task.pick_user_name)"
|
||
},
|
||
{
|
||
"name": "wave_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "仅散单模式(有波次信息时)返回,波次ID"
|
||
},
|
||
{
|
||
"name": "wave_no",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "仅散单模式(有波次信息时)返回,波次号"
|
||
},
|
||
{
|
||
"name": "wave_type",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "仅散单模式(有波次信息时)返回,波次类型编码(来自 wms_wave_batch.wave_type)"
|
||
},
|
||
{
|
||
"name": "pick_mode",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "拣货模式:1-团购小波次 2-散单单品单件 3-散单先拣后分 4-边拣边分 5-团购大波次。散单模式在顶层返回,团购模式在每个波次视图项内返回"
|
||
},
|
||
{
|
||
"name": "strategy_id",
|
||
"type": "number|null",
|
||
"required": false,
|
||
"description": "仅散单模式返回,波次策略ID"
|
||
},
|
||
{
|
||
"name": "strategy_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "仅散单模式返回,波次策略名称"
|
||
},
|
||
{
|
||
"name": "total_orders",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "仅散单模式返回,波次内订单总数"
|
||
},
|
||
{
|
||
"name": "reviewed_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "仅散单模式返回,已复核订单数"
|
||
},
|
||
{
|
||
"name": "unreviewed_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "仅散单模式返回,未复核订单数"
|
||
},
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "统一列表输出。散单模式(list_type=single)有波次信息时:扁平订单数组;无波次信息时退回单订单详情模式(每项含 detail、items、expresses、logs)。团购模式(list_type=group):波次视图数组(每项含 wave_id、wave_no、wave_type、wave_status、total_orders、processed_orders、creator、create_time、update_time、order_count、pick_mode、box_no、orders[])"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.recheckOrder.confirmRecheck",
|
||
"title": "按订单 ID 确认复核并记录复核任务到 wms_recheck_task(入参兼容 id/orderId)。确认复核后,若该订单所属波次拣货任务下所有订单均已复核完成,则自动解绑车任务:清空 wms_wave_pick_task 的车绑定信息(current_cart_id、current_cart_code_snapshot)、停用 wms_pick_task_cart_binding 绑定记录(is_active=0 并记录解绑人和时间)并释放 wms_pick_cart(清空 current_task_id、bind_user_id)。解绑失败仅记录 warn 日志,不影响复核主流程。",
|
||
"description": "按订单 ID 确认复核并记录复核任务到 wms_recheck_task(入参兼容 id/orderId)。确认复核后,若该订单所属波次拣货任务下所有订单均已复核完成,则自动解绑车任务:清空 wms_wave_pick_task 的车绑定信息(current_cart_id、current_cart_code_snapshot)、停用 wms_pick_task_cart_binding 绑定记录(is_active=0 并记录解绑人和时间)并释放 wms_pick_cart(清空 current_task_id、bind_user_id)。解绑失败仅记录 warn 日志,不影响复核主流程。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_id / id / orderId",
|
||
"type": "string|number",
|
||
"required": true,
|
||
"description": "订单 ID;优先使用 order_id,兼容别名 id 与 orderId"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "订单 ID"
|
||
},
|
||
{
|
||
"name": "waybill_no",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "运单号"
|
||
},
|
||
{
|
||
"name": "recheck_status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "复核结果状态(固定为 'fin')"
|
||
},
|
||
{
|
||
"name": "recheck_time",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "复核时间(ISO 字符串)"
|
||
},
|
||
{
|
||
"name": "review_no",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "复核任务编号"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.recheckOrder.confirmIntercept",
|
||
"title": "确认拦截:通过订单ID直接匹配订单,将其拦截状态更新为 intercepted_at_warehouse(仓库已拦截)。仅拦截当前指定订单,不波及波次内其他订单。操作成功后写入操作日志(ORDER_INTERCEPT_CONFIRM),日志写入失败不影响主流程。",
|
||
"description": "确认拦截:通过订单ID直接匹配订单,将其拦截状态更新为 intercepted_at_warehouse(仓库已拦截)。仅拦截当前指定订单,不波及波次内其他订单。操作成功后写入操作日志(ORDER_INTERCEPT_CONFIRM),日志写入失败不影响主流程。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "订单 ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "订单 ID"
|
||
},
|
||
{
|
||
"name": "order_no",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "订单号(优先 delivery_order_code,其次 pre_delivery_order_code)"
|
||
},
|
||
{
|
||
"name": "intercept_status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "拦截状态(固定为 'intercepted_at_warehouse')"
|
||
},
|
||
{
|
||
"name": "updated_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "更新时间(ISO 字符串)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.recheckOrder.recheckOrderList",
|
||
"title": "复核订单列表查询,通过入参 list_type 区分散单模式与团购模式。散单模式(single,默认)返回待复核订单列表(每项为一个订单,排除 pick_status='none' 和 recheck_status='fin'),团购模式(group)返回波次维度的复核汇总列表(每项为一个波次及其订单复核统计,含 review_assignment_status 计算字段)。统一使用 list 字段名输出,均支持分页与筛选。",
|
||
"description": "复核订单列表查询,通过入参 list_type 区分散单模式与团购模式。散单模式(single,默认)返回待复核订单列表(每项为一个订单,排除 pick_status='none' 和 recheck_status='fin'),团购模式(group)返回波次维度的复核汇总列表(每项为一个波次及其订单复核统计,含 review_assignment_status 计算字段)。统一使用 list 字段名输出,均支持分页与筛选。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "list_type",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "列表模式:single(散单模式,默认)/ group(团购模式)"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "筛选条件。散单模式支持 keyword(运单号/订单号模糊搜索)、wave_no(精确匹配)、recheck_status、pick_status;团购模式支持 wave_no(模糊搜索)、wave_type、wave_status"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize(默认 page=1, pageSize=20)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "散单模式(list_type=single):订单数组,每项含 order_id、delivery_order_code、order_type、wave_id、wave_no、pick_status、recheck_status、shop_nick、logistics_name、items_count、items_total、status、create_at、pick_time、recheck_time。团购模式(list_type=group):波次汇总数组,每项含 wave_id、wave_no、wave_type、wave_status、total_orders、processed_orders、creator、create_time、update_time、order_count、reviewed_count、unreviewed_count、review_assignment_status(unreviewed/partially_reviewed/reviewed)"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息,含 page、pageSize、total、totalPages、hasPrevious、hasNext"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.recheckOrder.scanTask",
|
||
"title": "按拣货任务 ID 拉取复核扫描视图。根据任务的 pick_mode 区分散单/团单模式,返回与 scanOrder 一致的数据结构,用于前端刷新数据。散单模式(pick_mode 2/3/4)扁平化任务下所有波次的订单列表(按 order_id 去重,未复核优先、wave_index 升序),顶层携带拣货人/任务等汇总信息(包括 picker_id、picker_name、pick_mode、total_orders、reviewed_count、unreviewed_count);团购模式(pick_mode 1/5)返回任务下所有团购波次及订单的分组列表(list_type='group')。",
|
||
"description": "按拣货任务 ID 拉取复核扫描视图。根据任务的 pick_mode 区分散单/团单模式,返回与 scanOrder 一致的数据结构,用于前端刷新数据。散单模式(pick_mode 2/3/4)扁平化任务下所有波次的订单列表(按 order_id 去重,未复核优先、wave_index 升序),顶层携带拣货人/任务等汇总信息(包括 picker_id、picker_name、pick_mode、total_orders、reviewed_count、unreviewed_count);团购模式(pick_mode 1/5)返回任务下所有团购波次及订单的分组列表(list_type='group')。",
|
||
"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(对应 wms_wave_pick_task.id)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "match_type",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "固定为 'task',表示通过任务 ID 匹配"
|
||
},
|
||
{
|
||
"name": "list_type",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "列表模式:single(散单扁平列表)/ group(团购嵌套波次列表),由拣货任务的 pick_mode 决定"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货任务 ID"
|
||
},
|
||
{
|
||
"name": "picker_id",
|
||
"type": "number|null",
|
||
"required": false,
|
||
"description": "拣货人 ID(来自 wms_wave_pick_task.pick_user_id),散单模式返回"
|
||
},
|
||
{
|
||
"name": "picker_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "拣货人名称(来自 wms_wave_pick_task.pick_user_name),散单模式返回"
|
||
},
|
||
{
|
||
"name": "pick_mode",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "拣货模式:1-团购小波次 2-散单单品单件 3-散单先拣后分 4-边拣边分 5-团购大波次"
|
||
},
|
||
{
|
||
"name": "wave_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "散单模式固定为 0,团购模式不返回"
|
||
},
|
||
{
|
||
"name": "wave_no",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "散单模式固定为空字符串,团购模式不返回"
|
||
},
|
||
{
|
||
"name": "wave_type",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "波次类型编码(取任务下第一个有效波次的 wave_type),散单模式返回"
|
||
},
|
||
{
|
||
"name": "strategy_id",
|
||
"type": "number|null",
|
||
"required": false,
|
||
"description": "散单模式固定为 null(任务级别不绑定单一策略)"
|
||
},
|
||
{
|
||
"name": "strategy_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "散单模式固定为空字符串(任务级别不绑定单一策略)"
|
||
},
|
||
{
|
||
"name": "total_orders",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务下订单总数(去重后),散单模式返回"
|
||
},
|
||
{
|
||
"name": "reviewed_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已复核订单数,散单模式返回"
|
||
},
|
||
{
|
||
"name": "unreviewed_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "未复核订单数,散单模式返回"
|
||
},
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "统一列表输出。散单模式(list_type=single):扁平订单数组(每项结构与 scanOrder 散单有波次模式一致,含 order_id/delivery_order_code/waybill_no/pick_status/is_printed/is_reviewed/shop_nick/items_count/wave_index/recheck_status/order_type/status/logistics_name/store_remark/intercept_status/stock[])。团购模式(list_type=group):波次视图数组(结构与 scanOrder 团购模式一致,每项含 wave_id/wave_no/wave_type/wave_status/total_orders/processed_orders/creator/create_time/update_time/order_count/pick_mode/box_no/orders[])"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|