222 lines
6.3 KiB
JSON
222 lines
6.3 KiB
JSON
{
|
||
"generatedAt": "2026-06-04 19:02:14",
|
||
"generatedAtLocal": "2026-06-04 19:02:14",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "订单复核模块",
|
||
"key": "order.recheckOrder",
|
||
"folder": "order.recheckorder",
|
||
"interfaceCount": 2
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "order.recheckOrder.scanOrder",
|
||
"title": "扫码查询订单(支持运单号与车号)并返回订单详情。车号命中时按 pick_mode 返回语义化结构。",
|
||
"description": "扫码查询订单(支持运单号与车号)并返回订单详情。车号命中时按 pick_mode 返回语义化结构。",
|
||
"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 / cart_code / cartCode",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "扫描关键词;优先按运单号匹配,未命中时回退到 wms_wave_pick_task.current_cart_code_snapshot / wms_wave_pick_task_order.cart_code_snapshot 车号匹配,支持别名 waybillCode/waybill_code/cart_code/cartCode"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "match_type",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "命中类型:waybill(运单号命中)/ cart(车号命中)"
|
||
},
|
||
{
|
||
"name": "cart_match_view",
|
||
"type": "object|null",
|
||
"required": true,
|
||
"description": "仅 cart 命中返回对象,waybill 命中返回 null"
|
||
},
|
||
{
|
||
"name": "cart_match_view.mode_code",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "波次类型编码(pick_mode)"
|
||
},
|
||
{
|
||
"name": "cart_match_view.mode_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "波次类型名称"
|
||
},
|
||
{
|
||
"name": "cart_match_view.view_type",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "语义化视图类型:groups/orders/pick_groups/box_groups"
|
||
},
|
||
{
|
||
"name": "cart_match_view.task",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "任务摘要信息"
|
||
},
|
||
{
|
||
"name": "cart_match_view.groups",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "仅 mode_code=1/5 返回,按 wave 分组"
|
||
},
|
||
{
|
||
"name": "cart_match_view.orders",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "仅 mode_code=2 返回,直接返回订单列表"
|
||
},
|
||
{
|
||
"name": "cart_match_view.pick_groups",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "仅 mode_code=3 返回,按 pick_status 分组"
|
||
},
|
||
{
|
||
"name": "cart_match_view.box_groups",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "仅 mode_code=4 返回,按 box_no 分组"
|
||
},
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "准确的订单 ID(供 confirmRecheck 使用)"
|
||
},
|
||
{
|
||
"name": "waybill_no",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "匹配到的运单号"
|
||
},
|
||
{
|
||
"name": "order",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "订单头对象"
|
||
},
|
||
{
|
||
"name": "items",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单商品明细"
|
||
},
|
||
{
|
||
"name": "expresses",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "运单信息数组"
|
||
},
|
||
{
|
||
"name": "logs",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "相关操作日志"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.recheckOrder.confirmRecheck",
|
||
"title": "按订单 ID 确认复核并记录复核任务到 wms_recheck_task(入参兼容 id/orderId)",
|
||
"description": "按订单 ID 确认复核并记录复核任务到 wms_recheck_task(入参兼容 id/orderId)",
|
||
"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": false,
|
||
"description": "订单 ID"
|
||
},
|
||
{
|
||
"name": "waybill_no",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "运单号"
|
||
},
|
||
{
|
||
"name": "recheck_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "复核结果状态"
|
||
},
|
||
{
|
||
"name": "recheck_time",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "复核时间(ISO 字符串)"
|
||
},
|
||
{
|
||
"name": "review_no",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "复核任务编号"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|