731 lines
23 KiB
JSON
731 lines
23 KiB
JSON
{
|
||
"generatedAt": "2026-06-01 09:11:20",
|
||
"generatedAtLocal": "2026-06-01 09:11:20",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "订单工作台入口模块",
|
||
"key": "order.index",
|
||
"folder": "order.index",
|
||
"interfaceCount": 10
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "order.list",
|
||
"title": "订单工作台总列表入口,查询当前登录用户仓库上下文下的订单总列表,支持 pagination / where / sort。",
|
||
"description": "订单工作台总列表入口,查询当前登录用户仓库上下文下的订单总列表,支持 pagination / where / sort。",
|
||
"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,兼容 currentPage / page_size / size"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会自动标准化;禁止传入 warehouse_id / warehouseId。"
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "排序参数,支持 sortField / sortOrder"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.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": "ids / id / order_id / orderId",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
|
||
},
|
||
{
|
||
"name": "tableType / tablePosition / type / moduleName",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "订单头对象(raw 行数据)"
|
||
},
|
||
{
|
||
"name": "detail",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "等同于 order"
|
||
},
|
||
{
|
||
"name": "orderItems / items",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "商品明细数组"
|
||
},
|
||
{
|
||
"name": "expresses",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "运单信息数组"
|
||
},
|
||
{
|
||
"name": "waybill_codes",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "去重后的运单号字符串数组"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.manualOutboundOrder",
|
||
"title": "手动触发出库迁移,将当前仓库内已出库订单同步到配送表。请求体直接透传给 orderDeliveryMigration.syncOutboundOrdersToDelivery。",
|
||
"description": "手动触发出库迁移,将当前仓库内已出库订单同步到配送表。请求体直接透传给 orderDeliveryMigration.syncOutboundOrdersToDelivery。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouseId",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "单仓库ID,兼容 warehouse_id"
|
||
},
|
||
{
|
||
"name": "warehouseIds",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "仓库ID 数组"
|
||
},
|
||
{
|
||
"name": "queryTimeoutMs",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "查询超时时间(毫秒)"
|
||
},
|
||
{
|
||
"name": "executionTimeoutMs",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "执行超时时间(毫秒)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "warehouseIds",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "参与迁移的仓库ID列表"
|
||
},
|
||
{
|
||
"name": "batchSize",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "单批处理上限,当前固定为 1000"
|
||
},
|
||
{
|
||
"name": "outboundStatuses",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "本次迁移匹配的出库状态"
|
||
},
|
||
{
|
||
"name": "totalSelected",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "命中的源订单数量"
|
||
},
|
||
{
|
||
"name": "totalCreated",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "实际创建到配送表的订单数量"
|
||
},
|
||
{
|
||
"name": "totalSkipped",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "本次跳过的源订单数量"
|
||
},
|
||
{
|
||
"name": "totalTimeout",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "被标记为出库超时的订单数量"
|
||
},
|
||
{
|
||
"name": "results",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "按仓库维度返回的批次结果数组,元素包含 selectedCount、createdCount、skippedCount、timeoutCount、retryableFailure 等字段"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.badgeCount",
|
||
"title": "订单工作台各标签页角标计数,基于当前仓库上下文返回。配送、配送异常与归档标签固定返回 99+。",
|
||
"description": "订单工作台各标签页角标计数,基于当前仓库上下文返回。配送、配送异常与归档标签固定返回 99+。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [
|
||
{
|
||
"name": "reviewOrder",
|
||
"type": "number|string",
|
||
"required": true,
|
||
"description": "待审核角标"
|
||
},
|
||
{
|
||
"name": "pendingOrder",
|
||
"type": "number|string",
|
||
"required": true,
|
||
"description": "待处理角标"
|
||
},
|
||
{
|
||
"name": "outboundOrder",
|
||
"type": "number|string",
|
||
"required": true,
|
||
"description": "待出库角标"
|
||
},
|
||
{
|
||
"name": "expectionOrder",
|
||
"type": "number|string",
|
||
"required": true,
|
||
"description": "待处理异常角标"
|
||
},
|
||
{
|
||
"name": "entrustOrder",
|
||
"type": "number|string",
|
||
"required": true,
|
||
"description": "委托外仓角标"
|
||
},
|
||
{
|
||
"name": "deliveryOrder",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "配送角标,固定返回 99+"
|
||
},
|
||
{
|
||
"name": "deliveryExpectionOrder",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "配送异常角标,固定返回 99+"
|
||
},
|
||
{
|
||
"name": "archiveOrder",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "归档角标,固定返回 99+"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.queryOrderLogs",
|
||
"title": "查询当前仓库下订单操作日志,底层复用通用日志查询分页结构,按订单ID筛选。",
|
||
"description": "查询当前仓库下订单操作日志,底层复用通用日志查询分页结构,按订单ID筛选。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "订单ID"
|
||
},
|
||
{
|
||
"name": "page",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "页码"
|
||
},
|
||
{
|
||
"name": "pageSize",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "每页数量"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "日志列表,字段与 stock.warehouse.queryStockLogs 保持一致"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息,包含 page、pageSize、total、totalPages"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.queryOrderLogList",
|
||
"title": "按 order_id 查询订单操作日志,返回全量日志(不分页)。接口按当前登录用户的仓库上下文过滤(method 层从 ctx.user.store_id 获取 warehouse_id),以防跨仓越界。",
|
||
"description": "按 order_id 查询订单操作日志,返回全量日志(不分页)。接口按当前登录用户的仓库上下文过滤(method 层从 ctx.user.store_id 获取 warehouse_id),以防跨仓越界。",
|
||
"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;支持别名 id 与 orderId,接口会兼容解析。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "日志列表(全量返回,无分页)。每项字段与 stock.warehouse.queryStockLogs 保持一致,典型字段包括 id、action、message、actor、created_at、warehouse_id 等。"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.updateExpressWeighingWeight",
|
||
"title": "更新订单运单称重重量。规则:订单仅一个运单时,直接写入该运单重量;多运单时,必须传 waybill_code 并按运单写入。",
|
||
"description": "更新订单运单称重重量。规则:订单仅一个运单时,直接写入该运单重量;多运单时,必须传 waybill_code 并按运单写入。",
|
||
"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|string",
|
||
"required": true,
|
||
"description": "订单ID,必填且必须为正整数。"
|
||
},
|
||
{
|
||
"name": "waybill_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "运单号;订单仅一个运单时可不传且会被忽略,多运单时必填并需匹配订单下运单。"
|
||
},
|
||
{
|
||
"name": "weighing_weight",
|
||
"type": "number|string",
|
||
"required": true,
|
||
"description": "称重重量(kg),必填,必须大于 0,最多支持 3 位小数。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "订单ID(成功时返回于 data 对象中)。"
|
||
},
|
||
{
|
||
"name": "waybill_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "写入重量的运单号(成功时返回于 data 对象中)。"
|
||
},
|
||
{
|
||
"name": "weighing_weight",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "已写入的称重重量(kg,成功时返回于 data 对象中)。"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.bindExpressPackageMaterial",
|
||
"title": "按订单ID+运单号匹配 wms_order_express,按包材编码匹配包材,并将 package_material_id 与 package_material_name_snapshot 绑定到订单运单记录。",
|
||
"description": "按订单ID+运单号匹配 wms_order_express,按包材编码匹配包材,并将 package_material_id 与 package_material_name_snapshot 绑定到订单运单记录。",
|
||
"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|string",
|
||
"required": true,
|
||
"description": "订单ID,必填。"
|
||
},
|
||
{
|
||
"name": "waybill_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "运单号,必填。"
|
||
},
|
||
{
|
||
"name": "package_material_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "包材编码,必填。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "订单ID(成功时返回于 data 对象中)。"
|
||
},
|
||
{
|
||
"name": "waybill_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "运单号(成功时返回于 data 对象中)。"
|
||
},
|
||
{
|
||
"name": "package_material_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "绑定后的包材ID(成功时返回于 data 对象中)。"
|
||
},
|
||
{
|
||
"name": "package_material_name_snapshot",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "绑定时写入的包材名称快照(成功时返回于 data 对象中)。"
|
||
},
|
||
{
|
||
"name": "package_material_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "绑定成功的包材编码(成功时返回于 data 对象中)。"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.export",
|
||
"title": "提交订单导出任务(异步)。入参支持 table_type/tableType 与 module/module_name;where 与 sort 语义与 order.list 一致。提交后立即返回 task_id,后台异步执行,导出进度/下载请通过 order.exportTaskProgress 查询。",
|
||
"description": "提交订单导出任务(异步)。入参支持 table_type/tableType 与 module/module_name;where 与 sort 语义与 order.list 一致。提交后立即返回 task_id,后台异步执行,导出进度/下载请通过 order.exportTaskProgress 查询。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "table_type / tableType",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "导出表类型,枚举:current/history/dispatch/outsourced;兼容订单模块别名(order/reviewOrder/pendingOrder 等);支持 table_type 与 tableType 两种写法"
|
||
},
|
||
{
|
||
"name": "module / module_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "订单模块名,兼容 module(驼峰)与 module_name(下划线)两种写法"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "查询条件,语义与 order.list 的 where 一致(推荐使用 { operator, value, type } 标准结构);禁止传入 warehouse_id/warehouseId"
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "排序参数,语义与 order.list 的 sort 一致"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成)"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态,枚举:submitted/running/success/failed/not_found"
|
||
},
|
||
{
|
||
"name": "progress",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前进度百分比(0-100)"
|
||
},
|
||
{
|
||
"name": "current_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前已处理记录数"
|
||
},
|
||
{
|
||
"name": "total_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "总记录数(若有)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务提示信息"
|
||
},
|
||
{
|
||
"name": "result",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "任务执行结果(可选,可能包含文件 url/fileKey 等)"
|
||
},
|
||
{
|
||
"name": "error",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "失败时的错误信息(可选)"
|
||
},
|
||
{
|
||
"name": "update_time",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务更新时间(Unix ms 或 ISO 字符串)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.exportTaskProgress",
|
||
"title": "按 task_id 查询订单导出任务进度,返回 task_id、status、progress、current_count、total_count、message、error、download_url、update_time;上传完成后 download_url 返回下载链接;未找到时 status=not_found。",
|
||
"description": "按 task_id 查询订单导出任务进度,返回 task_id、status、progress、current_count、total_count、message、error、download_url、update_time;上传完成后 download_url 返回下载链接;未找到时 status=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,兼容 taskId"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态:submitted/running/success/failed/not_found"
|
||
},
|
||
{
|
||
"name": "progress",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "进度百分比(0-100)"
|
||
},
|
||
{
|
||
"name": "current_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前已处理记录数"
|
||
},
|
||
{
|
||
"name": "total_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "总记录数"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "额外提示信息"
|
||
},
|
||
{
|
||
"name": "error",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "失败信息(可选)"
|
||
},
|
||
{
|
||
"name": "download_url",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务完成后下载链接(若有)"
|
||
},
|
||
{
|
||
"name": "update_time",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "最近一次状态更新时间(Unix ms 或 ISO 字符串)"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|