1091 lines
35 KiB
JSON
1091 lines
35 KiB
JSON
{
|
||
"generatedAt": "2026-05-26 09:05:07",
|
||
"generatedAtLocal": "2026-05-26 09:05:07",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "待处理订单模块",
|
||
"key": "order.pendingOrder",
|
||
"folder": "order.pendingorder",
|
||
"interfaceCount": 16
|
||
},
|
||
"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.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.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)。这是一个异步提交接口:调用后接口立即返回受理信息(包含 request_id),后端异步执行实际的储位分配与锁定操作;仓库上下文由当前登录用户提供(ctx.user.store_id)。接口不会在同步响应中返回分配明细(如 requested_order_ids、allocated_order_ids 等),客户端可通过请求 ID 或事件/查询链路获取最终结果。",
|
||
"description": "按订单批量分配储位(迁移自 order.storageAllocation.allocateStorage)。这是一个异步提交接口:调用后接口立即返回受理信息(包含 request_id),后端异步执行实际的储位分配与锁定操作;仓库上下文由当前登录用户提供(ctx.user.store_id)。接口不会在同步响应中返回分配明细(如 requested_order_ids、allocated_order_ids 等),客户端可通过请求 ID 或事件/查询链路获取最终结果。",
|
||
"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": "request_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "请求 ID(后端生成的唯一标识),用于查询任务状态或结果"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "生效的仓库 ID(来自当前用户 store_id)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "受理提示信息,通常为 '请求已受理,后端异步处理中' 或错误说明"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.allocateStorageProgress",
|
||
"title": "按 request_id 查询储位分配异步任务状态/结果(由 allocateStorage 提交)",
|
||
"description": "按 request_id 查询储位分配异步任务状态/结果(由 allocateStorage 提交)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "request_id / requestId",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务请求 ID,兼容字段 requestId"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "request_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "请求 ID(后端生成的唯一标识)"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
|
||
},
|
||
{
|
||
"name": "result",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "成功时返回底层分配结果,结构视实现而定"
|
||
},
|
||
{
|
||
"name": "error",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时返回的错误信息"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "关联仓库 ID(若任务关联仓库时返回)"
|
||
},
|
||
{
|
||
"name": "update_time",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "最近一次状态更新时间,ISO8601 字符串"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "额外提示信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.syncOrderIds",
|
||
"title": "同步待处理订单入口,仅接收 order_ids 并转发到服务层,当前不做业务处理。",
|
||
"description": "同步待处理订单入口,仅接收 order_ids 并转发到服务层,当前不做业务处理。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"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": false,
|
||
"description": "服务层返回值,当前仅透传 order_ids"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.cancelAllocateStorage",
|
||
"title": "待处理模块的取消分配储位入口,直接对接 system service 的 cancelAllocateStorage。仅接受订单ID(order_ids)作为入参,不接受 allow_storage_location 或 warehouse_id/warehouseId;仓库上下文来自当前登录用户的 store_id。",
|
||
"description": "待处理模块的取消分配储位入口,直接对接 system service 的 cancelAllocateStorage。仅接受订单ID(order_ids)作为入参,不接受 allow_storage_location 或 warehouse_id/warehouseId;仓库上下文来自当前登录用户的 store_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_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": false,
|
||
"description": "取消分配汇总结果,包含下列字段"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.updateOrderPlatform",
|
||
"title": "批量修改待处理订单的平台信息。用 code 查找 wms_platform 表,若平台存在则将订单的 sys_platform_code 和 sys_platform_name 更新为该平台的 code/name;若平台不存在则返回错误。只操作当前仓库的当前订单表,不处理其他订单表。",
|
||
"description": "批量修改待处理订单的平台信息。用 code 查找 wms_platform 表,若平台存在则将订单的 sys_platform_code 和 sys_platform_name 更新为该平台的 code/name;若平台不存在则返回错误。只操作当前仓库的当前订单表,不处理其他订单表。",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "订单ID 正整数数组,不能为空"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "平台编码,对应 wms_platform.code"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "updated_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "实际更新行数"
|
||
},
|
||
{
|
||
"name": "sys_platform_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "更新后的平台编码"
|
||
},
|
||
{
|
||
"name": "sys_platform_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "更新后的平台名称"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.updateOrderExpress",
|
||
"title": "批量修改待处理订单的快递信息。用 express_code 从当前仓库快递列表(带缓存)中查找对应项:若为自定义映射(is_system_setting=true),sys_logistics_code/name 写系统快递编码和名称,logistics_code/name 写自定义编码和名称;若为系统快递(is_system_setting=false),四个字段均写系统快递的 code/name;未找到则报错。只操作当前仓库的当前订单表,不处理其他订单表。",
|
||
"description": "批量修改待处理订单的快递信息。用 express_code 从当前仓库快递列表(带缓存)中查找对应项:若为自定义映射(is_system_setting=true),sys_logistics_code/name 写系统快递编码和名称,logistics_code/name 写自定义编码和名称;若为系统快递(is_system_setting=false),四个字段均写系统快递的 code/name;未找到则报错。只操作当前仓库的当前订单表,不处理其他订单表。",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "订单ID 正整数数组,不能为空"
|
||
},
|
||
{
|
||
"name": "express_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "快递编码,可为系统编码或仓库自定义编码"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "updated_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "实际更新行数"
|
||
},
|
||
{
|
||
"name": "sys_logistics_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "写入的系统快递编码"
|
||
},
|
||
{
|
||
"name": "sys_logistics_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "写入的系统快递名称"
|
||
},
|
||
{
|
||
"name": "logistics_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "写入的快递编码(自定义或系统)"
|
||
},
|
||
{
|
||
"name": "logistics_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "写入的快递名称(自定义或系统)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.cloneOrder",
|
||
"title": "克隆待处理订单。完整流程:1. 查找原订单,校验可取消状态(step 0/1/2/3);2. 若原订单已分配储位(storage_status='fin'),先清除已分配库存;3. 取消原订单(step→9, status→cancel),记录克隆日志;4. 以原订单业务数据创建新订单,所有流程状态字段重置为初始落库状态;5. 克隆订单明细(含 stock_id),重置 order_id 为新订单 ID;6. 对新订单记录克隆创建日志。",
|
||
"description": "克隆待处理订单。完整流程:1. 查找原订单,校验可取消状态(step 0/1/2/3);2. 若原订单已分配储位(storage_status='fin'),先清除已分配库存;3. 取消原订单(step→9, status→cancel),记录克隆日志;4. 以原订单业务数据创建新订单,所有流程状态字段重置为初始落库状态;5. 克隆订单明细(含 stock_id),重置 order_id 为新订单 ID;6. 对新订单记录克隆创建日志。",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "原订单ID,正整数"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "source_order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "原订单ID(已取消)"
|
||
},
|
||
{
|
||
"name": "new_order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新订单ID(克隆生成)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.createOrder",
|
||
"title": "手动创建待处理订单。根据货主策略(need_order_approval)决定初始步骤:need_order_approval=1 进待审核(step=0),need_order_approval=0 直接进待处理(step=1)。",
|
||
"description": "手动创建待处理订单。根据货主策略(need_order_approval)决定初始步骤:need_order_approval=1 进待审核(step=0),need_order_approval=0 直接进待处理(step=1)。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "货主ID(正整数)"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "收件人姓名"
|
||
},
|
||
{
|
||
"name": "mobile",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "收件人手机号,mobile 与 tel 至少填一项"
|
||
},
|
||
{
|
||
"name": "tel",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "收件人电话,mobile 与 tel 至少填一项"
|
||
},
|
||
{
|
||
"name": "detail_address",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "详细地址"
|
||
},
|
||
{
|
||
"name": "province",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "省份"
|
||
},
|
||
{
|
||
"name": "city",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "城市"
|
||
},
|
||
{
|
||
"name": "area",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "区/县"
|
||
},
|
||
{
|
||
"name": "town",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "镇/街道"
|
||
},
|
||
{
|
||
"name": "zip_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "邮编"
|
||
},
|
||
{
|
||
"name": "items",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单明细数组,每项含 item_code(商品编码)和 plan_qty(计划数量,正整数);item_name、order_line_no、actual_price 为可选"
|
||
},
|
||
{
|
||
"name": "delivery_order_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "订单号,不填则自动生成(SYS + 时间戳 + 随机4位)"
|
||
},
|
||
{
|
||
"name": "logistics_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "快递编码,不填则读货主默认快递策略(policy_config.default_express_code)"
|
||
},
|
||
{
|
||
"name": "logistics_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "快递名称"
|
||
},
|
||
{
|
||
"name": "sys_platform_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "系统平台编码,不填则读货主默认平台策略(policy_config.default_platform_code)"
|
||
},
|
||
{
|
||
"name": "source_platform_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "来源平台编码"
|
||
},
|
||
{
|
||
"name": "source_order_codes",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "来源订单号"
|
||
},
|
||
{
|
||
"name": "order_type",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "订单类型"
|
||
},
|
||
{
|
||
"name": "is_urgency",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "是否紧急:Y/N,默认 N"
|
||
},
|
||
{
|
||
"name": "invoice_flag",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "是否需要发票:Y/N,默认 N"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新创建的订单 ID"
|
||
},
|
||
{
|
||
"name": "delivery_order_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "订单号(传入值或自动生成值)"
|
||
},
|
||
{
|
||
"name": "step",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "初始步骤:0=待审核,1=待处理"
|
||
},
|
||
{
|
||
"name": "step_label",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "步骤说明:待审核 / 待处理"
|
||
},
|
||
{
|
||
"name": "items_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "商品种类数"
|
||
},
|
||
{
|
||
"name": "items_total",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "商品总件数"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.downloadCreateTemplate",
|
||
"title": "下载创建订单的 Excel 导入模板。返回 base64 编码的 xlsx 文件,前端解码后作为附件下载。表头中标注 * 的列为必填项,多行相同订单号的行组成一个完整订单。",
|
||
"description": "下载创建订单的 Excel 导入模板。返回 base64 编码的 xlsx 文件,前端解码后作为附件下载。表头中标注 * 的列为必填项,多行相同订单号的行组成一个完整订单。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [
|
||
{
|
||
"name": "base64",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "base64 编码的 xlsx 文件内容"
|
||
},
|
||
{
|
||
"name": "filename",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "建议保存的文件名"
|
||
},
|
||
{
|
||
"name": "mime",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "文件 MIME 类型"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.importOrdersFromExcel",
|
||
"title": "通过 Excel 文件批量创建订单。接受 base64 编码的 xlsx 内容,按订单号分组,每组创建一个订单(step 由货主策略决定)。每行代表一条商品明细;同一订单号的多行组成一个完整订单,头信息取每组第一行。",
|
||
"description": "通过 Excel 文件批量创建订单。接受 base64 编码的 xlsx 内容,按订单号分组,每组创建一个订单(step 由货主策略决定)。每行代表一条商品明细;同一订单号的多行组成一个完整订单,头信息取每组第一行。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "file_base64",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "base64 编码的 .xlsx 文件内容"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "total",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "解析到的订单总数"
|
||
},
|
||
{
|
||
"name": "success_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "创建成功的订单数"
|
||
},
|
||
{
|
||
"name": "fail_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "创建失败的订单数"
|
||
},
|
||
{
|
||
"name": "success_orders",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "成功订单列表,每项含 delivery_order_code、order_id、step、step_label"
|
||
},
|
||
{
|
||
"name": "fail_orders",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "失败订单列表,每项含 delivery_order_code、error(失败原因)"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|