257 lines
7.5 KiB
JSON
257 lines
7.5 KiB
JSON
{
|
||
"generatedAt": "2026-04-16 20:30:46",
|
||
"generatedAtLocal": "2026-04-16 20:30:46",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "订单工作台入口模块",
|
||
"key": "order.index",
|
||
"folder": "order.index",
|
||
"interfaceCount": 3
|
||
},
|
||
"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.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+"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|