408 lines
12 KiB
JSON
408 lines
12 KiB
JSON
{
|
||
"generatedAt": "2026-04-19 09:32:24",
|
||
"generatedAtLocal": "2026-04-19 09:32:24",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "订单待处理模块",
|
||
"key": "order.pendingOrder",
|
||
"folder": "order.pendingorder",
|
||
"interfaceCount": 6
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "order.pendingOrder.list",
|
||
"title": "待处理订单列表,默认筛选 outbound_status != padding 且 step in [1,2]。",
|
||
"description": "待处理订单列表,默认筛选 outbound_status != 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.pendingOrder.reverseReviewOrder",
|
||
"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",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "订单 ID 列表;兼容 ids / id / order_id,建议传 ids"
|
||
},
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "兼容单个订单 ID"
|
||
},
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "兼容单个订单 ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "首条更新记录 ID"
|
||
},
|
||
{
|
||
"name": "inspection_status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "新的审核状态"
|
||
},
|
||
{
|
||
"name": "step",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新的流程步骤"
|
||
},
|
||
{
|
||
"name": "updated_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "更新时间"
|
||
},
|
||
{
|
||
"name": "updated_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "受影响行数"
|
||
},
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "实际更新的订单 ID 列表"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.markPendingOutboundOrder",
|
||
"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",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单 ID 正整数数组;不支持 id、order_id 或逗号字符串"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "首条更新记录 ID"
|
||
},
|
||
{
|
||
"name": "outbound_status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "新的出库状态"
|
||
},
|
||
{
|
||
"name": "updated_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "更新时间"
|
||
},
|
||
{
|
||
"name": "updated_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "受影响行数"
|
||
},
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "实际更新的订单 ID 列表"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.cancelOrder",
|
||
"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",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单 ID 正整数数组;不支持 id、order_id 或逗号字符串"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "首条更新记录 ID"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "新的订单状态"
|
||
},
|
||
{
|
||
"name": "step",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新的流程步骤"
|
||
},
|
||
{
|
||
"name": "updated_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "更新时间"
|
||
},
|
||
{
|
||
"name": "updated_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "受影响行数"
|
||
},
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "实际更新的订单 ID 列表"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.allocateExpressCode",
|
||
"title": "批量分配待处理订单的快递号,接收订单对象数组,复用 express.createWaybillCodePipeline。",
|
||
"description": "批量分配待处理订单的快递号,接收订单对象数组,复用 express.createWaybillCodePipeline。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "orders",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单对象数组;每个对象应为待处理订单列表或详情中获取的原始订单对象。每个订单对象必须包含 order_id 与 business_key;sys_platform_code 与 logistics_code 为订单对象自带字段,前端无需额外拼装或从外部构造,直接原样回传订单对象即可。其余字段会原样透传给运单创建链路。business_key 说明:business_key 是运单创建的序号键数组(例如:新分配 1 个运单号时传 [1];订单拆单时可能传 [2,3]),该字段会在 createWaybillCodePipeline 的返回 data 中原样返回,便于前端关联订单与运单创建结果。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "flag",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "全局调用结果标识,成功时为 success"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "业务状态码,200 表示成功"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "返回信息"
|
||
},
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "createWaybillCodePipeline 返回的运单创建结果,包含 success/failed 列表与 summary 等字段"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.allocateStorage",
|
||
"title": "按订单批量分配储位(迁移自 order.storageAllocation.allocateStorage)。只接受订单相关入参,不再接受 warehouse_id / warehouseId,仓库上下文来自当前登录用户。",
|
||
"description": "按订单批量分配储位(迁移自 order.storageAllocation.allocateStorage)。只接受订单相关入参,不再接受 warehouse_id / warehouseId,仓库上下文来自当前登录用户。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "allow_storage_location / allowStorageLocation / is_allow_storage / isAllowStorage",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否允许使用存储储位,支持多种字段别名。"
|
||
},
|
||
{
|
||
"name": "order_ids / orderIds / ids / order_id / orderId / id",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单 ID 列表,支持数组、逗号分隔字符串或单个 ID(兼容多种别名)。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "flag",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "全局调用结果标识,成功为 success"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "业务状态码,200 表示成功"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "提示信息,成功或部分成功时给出人类可读的摘要。"
|
||
},
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分配结果汇总对象,包含以下字段"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|