252 lines
7.1 KiB
JSON
252 lines
7.1 KiB
JSON
{
|
||
"generatedAt": "2026-04-23 10:06:38",
|
||
"generatedAtLocal": "2026-04-23 10:06:38",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "订单待出库模块",
|
||
"key": "order.outboundOrder",
|
||
"folder": "order.outboundorder",
|
||
"interfaceCount": 3
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "order.outboundOrder.list",
|
||
"title": "待出库订单列表,默认筛选 outbound_status in [none,padding] 且 step in [1,2]。",
|
||
"description": "待出库订单列表,默认筛选 outbound_status in [none,padding] 且 step in [1,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": "统一 where 条件对象;禁止传入 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": "分页信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.outboundOrder.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.outboundOrder.manualOutboundOrder",
|
||
"title": "待出库模块的手动出库入口,行为与 order.manualOutboundOrder 一致。",
|
||
"description": "待出库模块的手动出库入口,行为与 order.manualOutboundOrder 一致。",
|
||
"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 等字段"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|