From dfea0c31642d3d30416e63a3407229159b4f7ffd Mon Sep 17 00:00:00 2001 From: yin <3313488199@qq.com> Date: Sun, 21 Jun 2026 18:21:10 +0800 Subject: [PATCH] 621 --- .gitignore | 3 + src/api/combogoods/combogoods.ts | 170 + src/api/order.index/orderindex.ts | 33 - src/api/order.recheckorder/recheckOrder.ts | 4 + src/api/order/order.ts | 35 +- src/lang/en-US.ts | 1 + src/lang/zh-CN.ts | 1 + src/router/index.ts | 62 +- src/router/map.ts | 1 + .../BindPackageMaterialByWaybillDialog.vue | 31 +- .../config/order-common-config.ts | 10 +- .../stock/combo_stock/combo-stock-config.ts | 208 + .../component/ComboGoodsFormDialog.vue | 322 + .../component/ComboGoodsSearchDialog.vue | 141 + .../component/ComboStockPickerDialog.vue | 179 + src/views/stock/combo_stock/index.vue | 313 +- src/views/stock/stock/index.vue | 31 +- src/views/stock/stock/stock-config.ts | 357 +- src/views/storage/entry/entry-config.ts | 177 +- src/views/storage/entry/index.vue | 9 +- src/views/storage/inventory/index.vue | 7 +- .../storage/inventory/inventory-config.ts | 63 +- .../management/replenishmentDemand/index.vue | 4 +- src/views/storage/receiving/index.vue | 8 +- .../storage/receiving/receiving-config.ts | 157 +- src/views/storage/report/index.vue | 7 +- src/views/storage/report/report-config.ts | 35 +- src/views/storage/stockout/index.vue | 9 +- src/views/storage/stockout/stockout-config.ts | 101 +- workflows/api-doc-agent/config/响应.md | 112 - workflows/api-doc-agent/config/接口.md | 424 - workflows/api-doc-agent/docs/修改接口.md | 83 - workflows/api-doc-agent/docs/测试.md | 168 - workflows/api-doc-system/README.md | 151 - workflows/api-doc-system/apidata/config.json | 41 - workflows/api-doc-system/apidata/crawler.mjs | 63 - workflows/api-doc-system/apidata/data.json | 132 - workflows/api-doc-system/clear-pending.mjs | 1 - workflows/api-doc-system/config.mjs | 1 - workflows/api-doc-system/core/apidata.mjs | 1209 - .../api-doc-system/core/clear-pending.mjs | 15 - workflows/api-doc-system/core/config.mjs | 28 - workflows/api-doc-system/core/update.mjs | 1 - .../20260416/storage.receiving.bindstore.json | 16 - .../interface-details/interface-details.json | 19080 ---------------- .../data/module-list/module-list.json | 1396 -- .../data/module/config/_module.lifecycle.json | 12 - .../data/module/config/module.json | 101 - .../module/dashboard/_module.lifecycle.json | 12 - .../data/module/dashboard/module.json | 186 - .../data/module/index/_module.lifecycle.json | 12 - .../data/module/index/module.json | 866 - .../order.archiveorder/_deleted.20260417.json | 5 - .../order.archiveorder/_module.lifecycle.json | 12 - .../module/order.archiveorder/module.json | 161 - .../_deleted.20260417.json | 5 - .../_module.lifecycle.json | 12 - .../order.deliveryexpectionorder/module.json | 161 - .../_deleted.20260417.json | 5 - .../_module.lifecycle.json | 12 - .../module/order.deliveryorder/module.json | 161 - .../order.entrustorder/_deleted.20260417.json | 5 - .../order.entrustorder/_module.lifecycle.json | 12 - .../module/order.entrustorder/module.json | 161 - .../_deleted.20260417.json | 5 - .../_module.lifecycle.json | 12 - .../module/order.expectionorder/module.json | 203 - .../module/order.index/_deleted.20260417.json | 5 - .../module/order.index/_module.lifecycle.json | 12 - .../data/module/order.index/module.json | 850 - .../_deleted.20260417.json | 5 - .../_module.lifecycle.json | 12 - .../module/order.outboundorder/module.json | 257 - .../order.pendingorder/_deleted.20260417.json | 5 - .../order.pendingorder/_module.lifecycle.json | 12 - .../module/order.pendingorder/module.json | 1990 -- .../module/order.print/_module.lifecycle.json | 12 - .../data/module/order.print/module.json | 299 - .../order.recheckorder/_module.lifecycle.json | 12 - .../module/order.recheckorder/module.json | 551 - .../order.revieworder/_deleted.20260417.json | 5 - .../order.revieworder/_module.lifecycle.json | 12 - .../data/module/order.revieworder/module.json | 227 - .../module/order.wave/_module.lifecycle.json | 12 - .../data/module/order.wave/module.json | 2548 --- .../data/module/order/_module.lifecycle.json | 12 - .../data/module/order/module.json | 208 - .../data/module/pick/_module.lifecycle.json | 12 - .../data/module/pick/module.json | 281 - .../module/pickcart/_module.lifecycle.json | 12 - .../data/module/pickcart/module.json | 533 - .../data/module/print/_module.lifecycle.json | 12 - .../data/module/print/module.json | 773 - .../printer.station/_module.lifecycle.json | 12 - .../data/module/printer.station/module.json | 57 - .../setting.account/_module.lifecycle.json | 12 - .../data/module/setting.account/module.json | 423 - .../setting.express/_module.lifecycle.json | 12 - .../data/module/setting.express/module.json | 322 - .../_module.lifecycle.json | 12 - .../setting.expressinterface/module.json | 333 - .../_module.lifecycle.json | 12 - .../setting.packagematerial/module.json | 315 - .../_module.lifecycle.json | 12 - .../setting.packagesupplier/module.json | 249 - .../setting.permission/_module.lifecycle.json | 12 - .../module/setting.permission/module.json | 187 - .../setting.platform/_module.lifecycle.json | 12 - .../data/module/setting.platform/module.json | 176 - .../_module.lifecycle.json | 12 - .../module/setting.printtemplate/module.json | 204 - .../setting.role/_module.lifecycle.json | 12 - .../data/module/setting.role/module.json | 210 - .../setting.warehouse/_module.lifecycle.json | 12 - .../data/module/setting.warehouse/module.json | 273 - .../data/module/shops/_module.lifecycle.json | 12 - .../data/module/shops/module.json | 389 - .../data/module/stock/_module.lifecycle.json | 12 - .../data/module/stock/module.json | 987 - .../storage.entry/_module.lifecycle.json | 12 - .../data/module/storage.entry/module.json | 315 - .../storage.inventory/_module.lifecycle.json | 12 - .../data/module/storage.inventory/module.json | 286 - .../storage.management/_module.lifecycle.json | 12 - .../module/storage.management/module.json | 89 - .../storage.report/_module.lifecycle.json | 12 - .../data/module/storage.report/module.json | 341 - .../storage.stockout/_module.lifecycle.json | 12 - .../data/module/storage.stockout/module.json | 185 - .../storage_receiving/_deleted.20260417.json | 5 - .../storage_receiving/_module.lifecycle.json | 12 - .../data/module/storage_receiving/module.json | 1256 - .../data/module/store/_module.lifecycle.json | 12 - .../data/module/store/module.json | 303 - .../_module.lifecycle.json | 12 - .../module/storewarehouse.store/module.json | 945 - .../data/module/user/_module.lifecycle.json | 12 - .../data/module/user/module.json | 263 - .../module/warehouse/_module.lifecycle.json | 12 - .../data/module/warehouse/module.json | 872 - .../api-doc-system/data/pending-updates.json | 50 - .../scripts/agent/api-list-update/config.mjs | 10 - .../scripts/agent/api-list-update/run.mjs | 474 - .../scripts/agent/config/scripts.mjs | 20 - .../agent/interface-availability/config.mjs | 11 - .../agent/interface-availability/run.mjs | 180 - .../api-doc-system/scripts/agent/run.mjs | 57 - workflows/api-doc-system/scripts/apidata.mjs | 6 - .../api-doc-system/scripts/clear-pending.mjs | 1 - workflows/api-doc-system/scripts/update.mjs | 1 - .../api-doc-system/system/workflow-mode.json | 4 - workflows/api-doc-system/update.mjs | 867 - 152 files changed, 2063 insertions(+), 45069 deletions(-) create mode 100644 src/api/combogoods/combogoods.ts create mode 100644 src/views/stock/combo_stock/combo-stock-config.ts create mode 100644 src/views/stock/combo_stock/component/ComboGoodsFormDialog.vue create mode 100644 src/views/stock/combo_stock/component/ComboGoodsSearchDialog.vue create mode 100644 src/views/stock/combo_stock/component/ComboStockPickerDialog.vue delete mode 100644 workflows/api-doc-agent/config/响应.md delete mode 100644 workflows/api-doc-agent/config/接口.md delete mode 100644 workflows/api-doc-agent/docs/修改接口.md delete mode 100644 workflows/api-doc-agent/docs/测试.md delete mode 100644 workflows/api-doc-system/README.md delete mode 100644 workflows/api-doc-system/apidata/config.json delete mode 100644 workflows/api-doc-system/apidata/crawler.mjs delete mode 100644 workflows/api-doc-system/apidata/data.json delete mode 100644 workflows/api-doc-system/clear-pending.mjs delete mode 100644 workflows/api-doc-system/config.mjs delete mode 100644 workflows/api-doc-system/core/apidata.mjs delete mode 100644 workflows/api-doc-system/core/clear-pending.mjs delete mode 100644 workflows/api-doc-system/core/config.mjs delete mode 100644 workflows/api-doc-system/core/update.mjs delete mode 100644 workflows/api-doc-system/data/agent-results/interface-availability/20260416/storage.receiving.bindstore.json delete mode 100644 workflows/api-doc-system/data/interface-details/interface-details.json delete mode 100644 workflows/api-doc-system/data/module-list/module-list.json delete mode 100644 workflows/api-doc-system/data/module/config/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/config/module.json delete mode 100644 workflows/api-doc-system/data/module/dashboard/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/dashboard/module.json delete mode 100644 workflows/api-doc-system/data/module/index/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/index/module.json delete mode 100644 workflows/api-doc-system/data/module/order.archiveorder/_deleted.20260417.json delete mode 100644 workflows/api-doc-system/data/module/order.archiveorder/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/order.archiveorder/module.json delete mode 100644 workflows/api-doc-system/data/module/order.deliveryexpectionorder/_deleted.20260417.json delete mode 100644 workflows/api-doc-system/data/module/order.deliveryexpectionorder/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/order.deliveryexpectionorder/module.json delete mode 100644 workflows/api-doc-system/data/module/order.deliveryorder/_deleted.20260417.json delete mode 100644 workflows/api-doc-system/data/module/order.deliveryorder/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/order.deliveryorder/module.json delete mode 100644 workflows/api-doc-system/data/module/order.entrustorder/_deleted.20260417.json delete mode 100644 workflows/api-doc-system/data/module/order.entrustorder/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/order.entrustorder/module.json delete mode 100644 workflows/api-doc-system/data/module/order.expectionorder/_deleted.20260417.json delete mode 100644 workflows/api-doc-system/data/module/order.expectionorder/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/order.expectionorder/module.json delete mode 100644 workflows/api-doc-system/data/module/order.index/_deleted.20260417.json delete mode 100644 workflows/api-doc-system/data/module/order.index/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/order.index/module.json delete mode 100644 workflows/api-doc-system/data/module/order.outboundorder/_deleted.20260417.json delete mode 100644 workflows/api-doc-system/data/module/order.outboundorder/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/order.outboundorder/module.json delete mode 100644 workflows/api-doc-system/data/module/order.pendingorder/_deleted.20260417.json delete mode 100644 workflows/api-doc-system/data/module/order.pendingorder/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/order.pendingorder/module.json delete mode 100644 workflows/api-doc-system/data/module/order.print/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/order.print/module.json delete mode 100644 workflows/api-doc-system/data/module/order.recheckorder/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/order.recheckorder/module.json delete mode 100644 workflows/api-doc-system/data/module/order.revieworder/_deleted.20260417.json delete mode 100644 workflows/api-doc-system/data/module/order.revieworder/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/order.revieworder/module.json delete mode 100644 workflows/api-doc-system/data/module/order.wave/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/order.wave/module.json delete mode 100644 workflows/api-doc-system/data/module/order/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/order/module.json delete mode 100644 workflows/api-doc-system/data/module/pick/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/pick/module.json delete mode 100644 workflows/api-doc-system/data/module/pickcart/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/pickcart/module.json delete mode 100644 workflows/api-doc-system/data/module/print/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/print/module.json delete mode 100644 workflows/api-doc-system/data/module/printer.station/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/printer.station/module.json delete mode 100644 workflows/api-doc-system/data/module/setting.account/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/setting.account/module.json delete mode 100644 workflows/api-doc-system/data/module/setting.express/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/setting.express/module.json delete mode 100644 workflows/api-doc-system/data/module/setting.expressinterface/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/setting.expressinterface/module.json delete mode 100644 workflows/api-doc-system/data/module/setting.packagematerial/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/setting.packagematerial/module.json delete mode 100644 workflows/api-doc-system/data/module/setting.packagesupplier/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/setting.packagesupplier/module.json delete mode 100644 workflows/api-doc-system/data/module/setting.permission/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/setting.permission/module.json delete mode 100644 workflows/api-doc-system/data/module/setting.platform/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/setting.platform/module.json delete mode 100644 workflows/api-doc-system/data/module/setting.printtemplate/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/setting.printtemplate/module.json delete mode 100644 workflows/api-doc-system/data/module/setting.role/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/setting.role/module.json delete mode 100644 workflows/api-doc-system/data/module/setting.warehouse/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/setting.warehouse/module.json delete mode 100644 workflows/api-doc-system/data/module/shops/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/shops/module.json delete mode 100644 workflows/api-doc-system/data/module/stock/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/stock/module.json delete mode 100644 workflows/api-doc-system/data/module/storage.entry/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/storage.entry/module.json delete mode 100644 workflows/api-doc-system/data/module/storage.inventory/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/storage.inventory/module.json delete mode 100644 workflows/api-doc-system/data/module/storage.management/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/storage.management/module.json delete mode 100644 workflows/api-doc-system/data/module/storage.report/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/storage.report/module.json delete mode 100644 workflows/api-doc-system/data/module/storage.stockout/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/storage.stockout/module.json delete mode 100644 workflows/api-doc-system/data/module/storage_receiving/_deleted.20260417.json delete mode 100644 workflows/api-doc-system/data/module/storage_receiving/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/storage_receiving/module.json delete mode 100644 workflows/api-doc-system/data/module/store/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/store/module.json delete mode 100644 workflows/api-doc-system/data/module/storewarehouse.store/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/storewarehouse.store/module.json delete mode 100644 workflows/api-doc-system/data/module/user/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/user/module.json delete mode 100644 workflows/api-doc-system/data/module/warehouse/_module.lifecycle.json delete mode 100644 workflows/api-doc-system/data/module/warehouse/module.json delete mode 100644 workflows/api-doc-system/data/pending-updates.json delete mode 100644 workflows/api-doc-system/scripts/agent/api-list-update/config.mjs delete mode 100644 workflows/api-doc-system/scripts/agent/api-list-update/run.mjs delete mode 100644 workflows/api-doc-system/scripts/agent/config/scripts.mjs delete mode 100644 workflows/api-doc-system/scripts/agent/interface-availability/config.mjs delete mode 100644 workflows/api-doc-system/scripts/agent/interface-availability/run.mjs delete mode 100644 workflows/api-doc-system/scripts/agent/run.mjs delete mode 100644 workflows/api-doc-system/scripts/apidata.mjs delete mode 100644 workflows/api-doc-system/scripts/clear-pending.mjs delete mode 100644 workflows/api-doc-system/scripts/update.mjs delete mode 100644 workflows/api-doc-system/system/workflow-mode.json delete mode 100644 workflows/api-doc-system/update.mjs diff --git a/.gitignore b/.gitignore index cd68f140..175de5b0 100644 --- a/.gitignore +++ b/.gitignore @@ -37,3 +37,6 @@ __screenshots__/ # Vite *.timestamp-*-*.mjs + +# Workflows (local tooling, not tracked) +/workflows/ diff --git a/src/api/combogoods/combogoods.ts b/src/api/combogoods/combogoods.ts new file mode 100644 index 00000000..400c66fb --- /dev/null +++ b/src/api/combogoods/combogoods.ts @@ -0,0 +1,170 @@ +import request from '@/utils/request' + +const v = '1.0' + +export type ComboGoodsListParams = { + pagination?: { + page?: number + pageSize?: number + } + where?: { + combo_code?: string + combo_name?: string + status?: number + warehouse_id?: number + } +} + +export type ComboGoodsListItem = Record & { + id?: number + combo_code?: string + combo_name?: string + combo_sku_id?: number + status?: number + warehouse_id?: number + remark?: string + items?: unknown[] + simpleNotation?: string + nameNotation?: string +} + +export type ComboGoodsListResponse = { + list: ComboGoodsListItem[] + total: number + page: number + pageSize: number +} + +export type ComboGoodsCreateItem = { + item_goods_sku_id: number + item_quantity: number + sort_order?: number +} + +export type ComboGoodsCreateParams = { + combo_code: string + combo_name: string + warehouse_id?: number + remark?: string + items: ComboGoodsCreateItem[] +} + +export type ComboGoodsCreateResponse = { + id: number + combo_code: string + combo_name: string +} + +export type ComboGoodsUpdateParams = { + id: number + combo_name?: string + warehouse_id?: number + remark?: string + status?: number + items?: ComboGoodsCreateItem[] +} + +export type ComboGoodsUpdateResponse = { + id: number +} + +export type ComboGoodsDeleteParams = { + id: number +} + +export type ComboGoodsDeleteResponse = { + id: number +} + +export type ComboGoodsSearchParams = { + keyword: string + limit?: number +} + +export type ComboGoodsSearchResponse = { + list: ComboGoodsListItem[] + total: number +} + +/** comboGoods.list:组合商品列表查询(分页) */ +export function comboGoodsList(data: ComboGoodsListParams = {}): Promise { + return request({ + url: '/system', + method: 'post', + params: { + method: 'comboGoods.list', + v, + timestamp: Date.now() + }, + data, + isSystemApi: true + } as any) +} + +/** comboGoods.create:创建组合商品(含明细一次性提交) */ +export function comboGoodsCreate(data: ComboGoodsCreateParams): Promise { + return request({ + url: '/system', + method: 'post', + params: { + method: 'comboGoods.create', + v, + timestamp: Date.now() + }, + data, + isSystemApi: true + } as any) +} + +/** comboGoods.update:编辑组合商品(含明细替换) */ +export function comboGoodsUpdate(data: ComboGoodsUpdateParams): Promise { + return request({ + url: '/system', + method: 'post', + params: { + method: 'comboGoods.update', + v, + timestamp: Date.now() + }, + data, + isSystemApi: true + } as any) +} + +/** comboGoods.delete:删除组合商品(软删除) */ +export function comboGoodsDelete(data: ComboGoodsDeleteParams): Promise { + return request({ + url: '/system', + method: 'post', + params: { + method: 'comboGoods.delete', + v, + timestamp: Date.now() + }, + data, + isSystemApi: true + } as any) +} + +/** comboGoods.search:关键字搜索组合商品(供手工建单选择) */ +export function comboGoodsSearch(data: ComboGoodsSearchParams): Promise { + return request({ + url: '/system', + method: 'post', + params: { + method: 'comboGoods.search', + v, + timestamp: Date.now() + }, + data, + isSystemApi: true + } as any) +} + +export const comboGoods = { + list: comboGoodsList, + create: comboGoodsCreate, + update: comboGoodsUpdate, + delete: comboGoodsDelete, + search: comboGoodsSearch +} diff --git a/src/api/order.index/orderindex.ts b/src/api/order.index/orderindex.ts index 1316ac63..ddf243a7 100644 --- a/src/api/order.index/orderindex.ts +++ b/src/api/order.index/orderindex.ts @@ -143,21 +143,6 @@ export type BindExpressPackageMaterialParams = { package_material_code: string } -/** order.bindExpressPackageMaterialByWaybill 请求参数 */ -export type BindExpressPackageMaterialByWaybillParams = { - waybill_code: string - package_material_code: string -} - -/** order.bindExpressPackageMaterialByWaybill 响应 data */ -export type BindExpressPackageMaterialByWaybillResponse = { - order_id: number - waybill_code: string - package_material_id: number - package_material_name_snapshot: string - package_material_code: string -} - export type OrderExportParams = { table_type?: string tableType?: string @@ -285,23 +270,6 @@ export function orderBindExpressPackageMaterial(data: BindExpressPackageMaterial } as any) } -/** order.bindExpressPackageMaterialByWaybill:按运单号绑定包材,无需传入订单 ID */ -export function orderBindExpressPackageMaterialByWaybill( - data: BindExpressPackageMaterialByWaybillParams -): Promise { - return request({ - url: '/system', - method: 'post', - params: { - method: 'order.bindExpressPackageMaterialByWaybill', - v, - timestamp: new Date().getTime() - }, - data, - isSystemApi: true - } as any) -} - export function orderExport(data: OrderExportParams = {}): Promise { return request({ url: '/system', @@ -353,7 +321,6 @@ export const order = { queryOrderLogList: orderQueryOrderLogList, updateExpressWeighingWeight: orderUpdateExpressWeighingWeight, bindExpressPackageMaterial: orderBindExpressPackageMaterial, - bindExpressPackageMaterialByWaybill: orderBindExpressPackageMaterialByWaybill, export: orderExport, exportTaskProgress: orderExportTaskProgress, detail: orderDetail diff --git a/src/api/order.recheckorder/recheckOrder.ts b/src/api/order.recheckorder/recheckOrder.ts index c4717606..a0887caf 100644 --- a/src/api/order.recheckorder/recheckOrder.ts +++ b/src/api/order.recheckorder/recheckOrder.ts @@ -63,6 +63,10 @@ export type ScanOrderSingleListItem = { store_remark?: string intercept_status?: string stock?: unknown[] + /** 订单商品总重量(kg) */ + items_weight?: number | string + /** 推荐包材信息,无推荐时为 null */ + suggested_package_material?: Record | null /** 无波次时单订单详情模式 */ detail?: Record items?: unknown[] diff --git a/src/api/order/order.ts b/src/api/order/order.ts index 707902d3..38de35e7 100644 --- a/src/api/order/order.ts +++ b/src/api/order/order.ts @@ -218,8 +218,41 @@ export function orderModulePendingOrderManualWaybill( } as any) } +/** order.bindExpressPackageMaterialByWaybill 请求参数 */ +export type BindExpressPackageMaterialByWaybillParams = { + waybill_code: string + package_material_id: number | string +} + +/** order.bindExpressPackageMaterialByWaybill 响应 data */ +export type BindExpressPackageMaterialByWaybillResponse = { + order_id: number + waybill_code: string + package_material_id: number + package_material_name_snapshot: string + package_material_code: string +} + +/** order.bindExpressPackageMaterialByWaybill:按运单号绑定包材,无需传入订单 ID */ +export function orderBindExpressPackageMaterialByWaybill( + data: BindExpressPackageMaterialByWaybillParams +): Promise { + return request({ + url: '/system', + method: 'post', + params: { + method: 'order.bindExpressPackageMaterialByWaybill', + v, + timestamp: Date.now() + }, + data, + isSystemApi: true + } as any) +} + export const orderModule = { waveBatchList: orderModuleWaveBatchList, pendingOrderDownloadCreateTemplate: orderModulePendingOrderDownloadCreateTemplate, - pendingOrderManualWaybill: orderModulePendingOrderManualWaybill + pendingOrderManualWaybill: orderModulePendingOrderManualWaybill, + bindExpressPackageMaterialByWaybill: orderBindExpressPackageMaterialByWaybill } diff --git a/src/lang/en-US.ts b/src/lang/en-US.ts index 77c3b965..aa684691 100644 --- a/src/lang/en-US.ts +++ b/src/lang/en-US.ts @@ -64,6 +64,7 @@ export default { 'packageMaterial':'Package Material', 'packageSupplier':'Package Supplier', 'pickcart':'Pickcart', + 'PickingShortage':'Picking Shortage', }, "login": { "title": "Login", diff --git a/src/lang/zh-CN.ts b/src/lang/zh-CN.ts index 1b13d6eb..553e635f 100644 --- a/src/lang/zh-CN.ts +++ b/src/lang/zh-CN.ts @@ -65,6 +65,7 @@ export default { 'packageMaterial':'包材管理', 'packageSupplier':'包装供应商', 'pickcart':'拣货车', + 'PickingShortage':'缺货补货', }, "login": { "title": "登录", diff --git a/src/router/index.ts b/src/router/index.ts index 68256c07..e1d15bdf 100644 --- a/src/router/index.ts +++ b/src/router/index.ts @@ -18,9 +18,45 @@ function resolveViewFromGlob(componentPath: string) { if (rel.startsWith('/')) rel = rel.slice(1) if (rel.toLowerCase().endsWith('.vue')) rel = rel.slice(0, -4) - const target = `/views/${rel}.vue` - const key = Object.keys(viewModules).find((k) => k.replace(/\\/g, '/').endsWith(target)) - return key ? viewModules[key] : undefined + const candidates = [`/views/${rel}.vue`, `/views/${rel}/index.vue`] + for (const target of candidates) { + const key = Object.keys(viewModules).find((k) => k.replace(/\\/g, '/').endsWith(target)) + if (key) return viewModules[key] + } + return undefined +} + +function buildInferredComponentPaths(menu: any, parentName?: string) { + const parentKey = parentName ? String(parentName).replace(/_Child$/, '').toLowerCase() : '' + const menuPath = String(menu.path || '').replace(/^\//, '') + const candidates: string[] = [] + + if (parentKey && menuPath) { + candidates.push(`${parentKey}/${menuPath}/index`, `${parentKey}/${menuPath}`) + } + if (menuPath) { + candidates.push(`${menuPath}/index`, menuPath) + } + + return candidates +} + +function findComponentLoader(componentPath: string) { + if (componentMap[componentPath]) { + return componentMap[componentPath] + } + + const fromGlob = resolveViewFromGlob(componentPath) + if (fromGlob) { + return fromGlob + } + + // 处理常见的目录结构,例如 'warehouse' -> 'warehouse/index.vue'(变量仅一段,Vite 可分析) + if (!componentPath.includes('/')) { + return () => import(`@/views/${componentPath}/index.vue`).catch(() => import(`@/views/${componentPath}.vue`)) + } + + return undefined } /** @@ -148,24 +184,15 @@ export const notFoundPage: RouteRecordRaw = { * 解析组件路径 */ function resolveComponent(componentPath: string) { - if (componentMap[componentPath]) { - return componentMap[componentPath] - } - - const fromGlob = resolveViewFromGlob(componentPath) - if (fromGlob) { - return fromGlob + const loader = findComponentLoader(componentPath) + if (loader) { + return loader } console.warn( `Component ${componentPath} not found in componentMap or views glob; check DB component 字段与 map 是否一致` ) - // 处理常见的目录结构,例如 'warehouse' -> 'warehouse/index.vue'(变量仅一段,Vite 可分析) - if (!componentPath.includes('/')) { - return () => import(`@/views/${componentPath}/index.vue`).catch(() => import(`@/views/${componentPath}.vue`)) - } - // 多段路径禁止再用模板字符串动态 import,否则生产环境报错 unknown variable dynamic import return () => import('@/views/404.vue') } @@ -236,7 +263,10 @@ export const transformMenusToRoutes = (menus: any[]) => { } } else { if (!menu.children || menu.children.length === 0) { - route.component = ParentView + const inferredLoader = buildInferredComponentPaths(menu, parentName) + .map((path) => findComponentLoader(path)) + .find(Boolean) + route.component = inferredLoader ?? ParentView } else { route.component = Layout } diff --git a/src/router/map.ts b/src/router/map.ts index bac8bd8d..e5481689 100644 --- a/src/router/map.ts +++ b/src/router/map.ts @@ -15,6 +15,7 @@ export const componentMap: Record = { 'warehouse/index': () => import('@/views/warehouse/index.vue'), 'stock/index': () => import('@/views/stock/stock/index.vue'), 'stock/storestock/index': () => import('@/views/stock/storestock/index.vue'), + 'stock/combo_stock': () => import('@/views/stock/combo_stock/index.vue'), 'stock/combo_stock/index': () => import('@/views/stock/combo_stock/index.vue'), 'stock/pickingShortage/index': () => import('@/views/storage/management/replenishmentDemand/index.vue'), 'storage/management/replenishmentDemand/index': () => import('@/views/storage/management/replenishmentDemand/index.vue'), diff --git a/src/views/order/orderManagement/component/BindPackageMaterialByWaybillDialog.vue b/src/views/order/orderManagement/component/BindPackageMaterialByWaybillDialog.vue index d6c8322b..49d8684b 100644 --- a/src/views/order/orderManagement/component/BindPackageMaterialByWaybillDialog.vue +++ b/src/views/order/orderManagement/component/BindPackageMaterialByWaybillDialog.vue @@ -13,7 +13,7 @@ :closable="false" show-icon style="margin-bottom: 12px" - title="仅需运单号与包材编码,系统自动反查订单运单记录并绑定包材,无需订单 ID。" + title="仅需运单号与包材,系统自动反查订单运单记录并绑定包材,无需订单 ID。" /> @@ -25,10 +25,10 @@ @keyup.enter="focusMaterialSelect" /> - + @@ -74,7 +74,7 @@ import type { FormInstance, FormRules } from 'element-plus' import { orderBindExpressPackageMaterialByWaybill, type BindExpressPackageMaterialByWaybillResponse -} from '@/api/order.index/orderindex' +} from '@/api/order/order' import { packageMaterialSearch } from '@/api/setting.packagematerial/packagematerial' import { isPackageMaterialApiSuccess, @@ -97,17 +97,17 @@ const formRef = ref() const materialSelectRef = ref<{ focus?: () => void } | null>(null) const submitting = ref(false) const materialLoading = ref(false) -const materialOptions = ref>([]) +const materialOptions = ref>([]) const lastResult = ref(null) const form = reactive({ waybill_code: '', - package_material_code: '' + package_material_id: undefined as number | undefined }) const rules: FormRules = { waybill_code: [{ required: true, message: '请输入运单号', trigger: 'blur' }], - package_material_code: [{ required: true, message: '请选择包材编码', trigger: 'change' }] + package_material_id: [{ required: true, message: '请选择包材', trigger: 'change' }] } watch( @@ -116,7 +116,7 @@ watch( if (!visible) return lastResult.value = null form.waybill_code = String(props.initialWaybillCode || '').trim() - form.package_material_code = '' + form.package_material_id = undefined materialOptions.value = [] void searchPackageMaterials('') } @@ -128,7 +128,7 @@ function handleClose() { function resetForm() { form.waybill_code = '' - form.package_material_code = '' + form.package_material_id = undefined materialOptions.value = [] lastResult.value = null formRef.value?.clearValidate() @@ -149,10 +149,11 @@ async function searchPackageMaterials(query: string) { } materialOptions.value = parsePackageMaterialSearchResponse(res) .map((item) => ({ + id: Number(item.id), material_code: String(item.material_code || '').trim(), material_name: String(item.material_name || '').trim() })) - .filter((item) => item.material_code) + .filter((item) => Number.isFinite(item.id) && item.id > 0 && item.material_code) } catch { materialOptions.value = [] } finally { @@ -174,14 +175,14 @@ async function handleSubmit() { if (!valid) return const waybill_code = form.waybill_code.trim() - const package_material_code = String(form.package_material_code || '').trim().toUpperCase() - if (!waybill_code || !package_material_code) return + const package_material_id = form.package_material_id + if (!waybill_code || package_material_id == null) return submitting.value = true try { const res: any = await orderBindExpressPackageMaterialByWaybill({ waybill_code, - package_material_code + package_material_id }) if (!isOrderIndexApiSuccess(res)) { throw new Error(res?.message || '绑定包材失败') diff --git a/src/views/order/orderManagement/config/order-common-config.ts b/src/views/order/orderManagement/config/order-common-config.ts index 9f6f634d..def77e7b 100644 --- a/src/views/order/orderManagement/config/order-common-config.ts +++ b/src/views/order/orderManagement/config/order-common-config.ts @@ -959,7 +959,7 @@ export const syncStatusFilterOptionsBasic = [ export const syncStatusFilterOptionsExtended = [ { label: '待同步', value: 'padding' }, - { label: '同步中', value: 'pending' }, + // { label: '同步中', value: 'pending' }, { label: '已同步', value: 'fin' }, { label: '错误', value: 'error' }, { label: '未同步', value: 'none' }, @@ -967,14 +967,14 @@ export const syncStatusFilterOptionsExtended = [ export const storageStatusFilterOptions = [ { label: '未分配', value: 'none' }, - { label: '分配中', value: 'padding' }, + // { label: '分配中', value: 'padding' }, { label: '已完成', value: 'fin' }, { label: '错误', value: 'error' }, ] export const postStatusFilterOptions = [ { label: '未分配', value: 'none' }, - { label: '分配中', value: 'padding' }, + // { label: '分配中', value: 'padding' }, { label: '已分配', value: 'fin' }, { label: '错误', value: 'error' }, ] @@ -986,13 +986,13 @@ export const postStatusFilterOptionsExtended = [ export const pickStatusFilterOptions = [ { label: '未拣货', value: 'none' }, - { label: '拣货中', value: 'padding' }, + // { label: '拣货中', value: 'padding' }, { label: '已完成', value: 'fin' }, ] export const packStatusFilterOptions = [ { label: '未打包', value: 'none' }, - { label: '打包中', value: 'padding' }, + // { label: '打包中', value: 'padding' }, { label: '已完成', value: 'fin' }, ] diff --git a/src/views/stock/combo_stock/combo-stock-config.ts b/src/views/stock/combo_stock/combo-stock-config.ts new file mode 100644 index 00000000..cac31c12 --- /dev/null +++ b/src/views/stock/combo_stock/combo-stock-config.ts @@ -0,0 +1,208 @@ +import type { ComboGoodsListItem } from '@/api/combogoods/combogoods' + +export type ComboGoodsRecord = ComboGoodsListItem & { + created_at?: string + updated_at?: string + creator_id?: number + editor_id?: number +} + +export type ComboGoodsItemRow = { + item_goods_sku_id: number + item_quantity: number + sort_order?: number + item_code?: string + item_name?: string + barcode?: string +} + +export const comboGoodsColumns = [ + { prop: 'id', label: 'ID', width: '72', sortable: true }, + { prop: 'combo_code', label: '组合编码', minWidth: '130', showOverflowTooltip: true }, + { prop: 'combo_name', label: '组合名称', minWidth: '150', showOverflowTooltip: true }, + { prop: 'status', label: '状态', width: '88', align: 'center' }, + { prop: 'simpleNotation', label: '子商品简记', minWidth: '160', showOverflowTooltip: true }, + { prop: 'nameNotation', label: '名称简记', minWidth: '180', showOverflowTooltip: true }, + { prop: 'remark', label: '备注', minWidth: '120', showOverflowTooltip: true }, + { prop: 'created_at', label: '创建时间', width: '160', showOverflowTooltip: true }, + { prop: 'updated_at', label: '更新时间', width: '160', showOverflowTooltip: true }, + { prop: 'actions', label: '操作', width: '150', align: 'center', fixed: 'right' } +] + +export const comboGoodsScanFields = [ + { + value: 'keyword', + label: '关键词', + type: 'text', + placeholder: '组合编码 / 名称', + operators: ['contains'], + defaultOperator: 'contains' + }, + { + value: 'combo_code', + label: '组合编码', + type: 'text', + placeholder: '精确匹配', + operators: ['eq'], + defaultOperator: 'eq' + }, + { + value: 'combo_name', + label: '组合名称', + type: 'text', + placeholder: '模糊匹配', + operators: ['contains', 'like'], + defaultOperator: 'contains' + }, + { + value: 'status', + label: '状态', + type: 'select', + clearable: true, + options: [ + { label: '启用', value: '1' }, + { label: '停用', value: '0' } + ] + } +] + +function readConditionValue(raw: unknown): unknown { + if (raw && typeof raw === 'object' && !Array.isArray(raw) && 'value' in (raw as object)) { + return (raw as { value?: unknown }).value + } + return raw +} + +/** comboGoods.list 的 where 为扁平字段,非 operator 结构 */ +export function normalizeComboGoodsScanConditionToWhere(condition: any): Record { + if (!condition) return {} + + const conds = + condition?.conditions && typeof condition.conditions === 'object' + ? condition.conditions + : condition && typeof condition === 'object' + ? condition + : null + + if (!conds) return {} + + const where: Record = {} + + const keyword = String(readConditionValue(conds.keyword) ?? '').trim() + if (keyword) { + where.combo_name = keyword + } + + const comboCode = String(readConditionValue(conds.combo_code) ?? '').trim() + if (comboCode) { + where.combo_code = comboCode + } + + const comboName = String(readConditionValue(conds.combo_name) ?? '').trim() + if (comboName) { + where.combo_name = comboName + } + + const statusRaw = readConditionValue(conds.status) + if (statusRaw !== null && statusRaw !== undefined && statusRaw !== '') { + where.status = Number(statusRaw) + } + + return where +} + +export function formatComboGoodsStatus(status: string | number | undefined) { + const raw = String(status ?? '').trim() + if (!raw) return { text: '--', type: 'info' as const } + if (['1', 'ACTIVE', 'ENABLED', 'ENABLE'].includes(raw)) { + return { text: '启用', type: 'success' as const } + } + if (['0', 'INACTIVE', 'DISABLED', 'DISABLE'].includes(raw)) { + return { text: '停用', type: 'danger' as const } + } + return { text: String(status), type: 'info' as const } +} + +export function buildComboGoodsListPayload(options: { + page: number + pageSize: number + where?: Record +}) { + const payload: Record = { + pagination: { + page: options.page, + pageSize: options.pageSize + } + } + if (options.where && Object.keys(options.where).length) { + payload.where = options.where + } + return payload +} + +export function parseComboGoodsListResponse(res: any): { + list: ComboGoodsRecord[] + total: number + page?: number + pageSize?: number +} { + const pick = (obj: any) => { + if (Array.isArray(obj)) { + return { list: obj as ComboGoodsRecord[], total: obj.length, page: undefined, pageSize: undefined } + } + if (!obj || typeof obj !== 'object') { + return { list: [] as ComboGoodsRecord[], total: 0, page: undefined, pageSize: undefined } + } + const list = Array.isArray(obj.list) ? obj.list : [] + const total = Number(obj.total ?? obj.pagination?.total ?? list.length) + const page = Number(obj.page ?? obj.pagination?.page) + const pageSize = Number(obj.pageSize ?? obj.page_size ?? obj.pagination?.pageSize) + return { + list, + total: Number.isFinite(total) ? total : list.length, + page: Number.isFinite(page) && page > 0 ? page : undefined, + pageSize: Number.isFinite(pageSize) && pageSize > 0 ? pageSize : undefined + } + } + + const nested = res?.data + if (Array.isArray(nested)) return pick(nested) + if (nested && typeof nested === 'object' && (Array.isArray(nested.list) || nested.total !== undefined)) { + return pick(nested) + } + return pick(res) +} + +export function parseComboGoodsSearchResponse(res: unknown): ComboGoodsRecord[] { + const root = (res as any)?.data ?? res + if (Array.isArray(root)) return root as ComboGoodsRecord[] + if (Array.isArray(root?.list)) return root.list as ComboGoodsRecord[] + return [] +} + +export function isComboGoodsApiSuccess(res: unknown) { + const r = res as { code?: number; flag?: string } | null | undefined + return Boolean(r && (r.code === 1 || r.code === 200 || r.flag === 'success')) +} + +export function mapComboGoodsItemsFromRecord(items: unknown): ComboGoodsItemRow[] { + if (!Array.isArray(items)) return [] + return items + .map((raw, index) => { + const row = raw && typeof raw === 'object' ? (raw as Record) : {} + const skuId = Number(row.item_goods_sku_id ?? row.goods_sku_id ?? row.stock_id ?? row.id) + const quantity = Number(row.item_quantity ?? row.quantity ?? 0) + if (!Number.isFinite(skuId) || skuId <= 0 || !Number.isFinite(quantity) || quantity <= 0) { + return null + } + return { + item_goods_sku_id: skuId, + item_quantity: Math.floor(quantity), + sort_order: Number(row.sort_order ?? index + 1), + item_code: String(row.item_code ?? row.goods_code ?? '').trim() || undefined, + item_name: String(row.item_name ?? row.goods_name ?? row.name ?? '').trim() || undefined, + barcode: String(row.barcode ?? '').trim() || undefined + } satisfies ComboGoodsItemRow + }) + .filter((item): item is ComboGoodsItemRow => item != null) +} diff --git a/src/views/stock/combo_stock/component/ComboGoodsFormDialog.vue b/src/views/stock/combo_stock/component/ComboGoodsFormDialog.vue new file mode 100644 index 00000000..db0afb72 --- /dev/null +++ b/src/views/stock/combo_stock/component/ComboGoodsFormDialog.vue @@ -0,0 +1,322 @@ + + + + + diff --git a/src/views/stock/combo_stock/component/ComboGoodsSearchDialog.vue b/src/views/stock/combo_stock/component/ComboGoodsSearchDialog.vue new file mode 100644 index 00000000..c63e6314 --- /dev/null +++ b/src/views/stock/combo_stock/component/ComboGoodsSearchDialog.vue @@ -0,0 +1,141 @@ + + + + + diff --git a/src/views/stock/combo_stock/component/ComboStockPickerDialog.vue b/src/views/stock/combo_stock/component/ComboStockPickerDialog.vue new file mode 100644 index 00000000..71b7bd1d --- /dev/null +++ b/src/views/stock/combo_stock/component/ComboStockPickerDialog.vue @@ -0,0 +1,179 @@ + + + + + diff --git a/src/views/stock/combo_stock/index.vue b/src/views/stock/combo_stock/index.vue index 89d4dd5e..056416d3 100644 --- a/src/views/stock/combo_stock/index.vue +++ b/src/views/stock/combo_stock/index.vue @@ -1,7 +1,314 @@ - + + + diff --git a/src/views/stock/stock/index.vue b/src/views/stock/stock/index.vue index 45fe2a00..0536de23 100644 --- a/src/views/stock/stock/index.vue +++ b/src/views/stock/stock/index.vue @@ -3,9 +3,9 @@ @@ -249,7 +249,7 @@ import Log from './component/log.vue' import Add from './component/add.vue' import Recycle from './component/recycle.vue' import ImportDialog from './component/ImportDialog.vue' -import { stockColumns, availableFields as stockAvailableFields, stockBatchConfig, stockToolbarButtons } from './stock-config' +import { stockColumns, availableFields as stockAvailableFields, stockBatchConfig, stockToolbarButtons, stockScanBoxConfig } from './stock-config' // API import * as stockApi from '@/api/stock/stock' @@ -303,9 +303,14 @@ function normalizeProhibitedOptions(data: unknown): ProhibitedOption[] { .filter((x): x is ProhibitedOption => x != null) } +function findScanField(value: string) { + return (availableFields as any[]).find((field) => field.value === value) +} + function applyProhibitedOptions(options: ProhibitedOption[]) { - if (availableFields[3]) { - ;(availableFields[3] as any).options = options + const prohibitedField = findScanField('prohibited_type') + if (prohibitedField) { + prohibitedField.options = options } if (batchConfig.prohibited_id) { batchConfig.prohibited_id.options = options @@ -378,6 +383,9 @@ const accountColumns = stockColumns // Available Fields for ScanBox const availableFields = reactive(JSON.parse(JSON.stringify(stockAvailableFields))) +const storeFieldOptions = computed(() => findScanField('store_id')?.options || []) +const prohibitedTypeFieldOptions = computed(() => findScanField('prohibited_type')?.options || []) + const hasSelection = computed(() => selectionIds.value.length > 0) const toolbarButtons = computed(() => @@ -721,7 +729,10 @@ onMounted(async () => { try { const res = await indexApi.loadStores({ type: 'stock' }) if (res && (res as any).stores) { - (availableFields[0] as any).options = (res as any).stores + const storeField = findScanField('store_id') + if (storeField) { + storeField.options = (res as any).stores + } } const proRes = await stockApi.getProhibitedType() if (proRes?.data) { @@ -760,7 +771,7 @@ const loadStockUnits = async () => { } // Update available fields - const field = (availableFields as any[]).find(f => f.value === 'stock_unit') + const field = findScanField('stock_unit') if (field) { field.options = units } diff --git a/src/views/stock/stock/stock-config.ts b/src/views/stock/stock/stock-config.ts index b0dfe1ab..ae146afe 100644 --- a/src/views/stock/stock/stock-config.ts +++ b/src/views/stock/stock/stock-config.ts @@ -1,5 +1,34 @@ import type { ToolbarButtonConfig } from '@/views/order/orderManagement/config/order-common-config' +/** ScanBox 筛选字段分组(商品模块专用) */ +export const STOCK_SCAN_FIELD_GROUPS = { + owner: '货主信息', + product: '商品标识', + info: '商品信息', + attribute: '商品属性', + inventory: '库存信息', + management: '管理标识', + price: '价格规格', + time: '时间范围', +} as const + +type StockScanFieldGroupKey = keyof typeof STOCK_SCAN_FIELD_GROUPS + +/** 为商品 ScanBox 字段附加分组标签 */ +export function stockScanField( + group: G, + field: Record +) { + return { ...field, group: STOCK_SCAN_FIELD_GROUPS[group] } +} + +/** ScanBox 默认 props(与波次模块 scan-box 侧栏一致) */ +export const stockScanBoxConfig = { + width: '250px', + treeProps: { children: 'children', label: 'label' } as const, + autoSubmit: false +} + // 格式化数字 const formatNumber = (num: any, digits = 0) => { if (num === null || num === undefined || num === '') return 0 @@ -208,176 +237,17 @@ export const stockColumns = [ }, ] -// ScanBox 可用筛选字段 +// ScanBox 可用筛选字段(含分组标签,与波次管理 scan-box 样式一致) export const availableFields = [ - { + stockScanField('owner', { value: 'store_id', label: '货主', type: 'select', placeholder: '请选择货主', filterable: true, options: [], - }, - { - value: 'barcode', - label: '条码', - type: 'text', - placeholder: '请输入商品条码', - operators: ['contains'], - defaultOperator: 'contains' - }, - { - value: 'id', - label: 'SKU', - type: 'text', - placeholder: '请输入SKU', - operators: ['contains'], - defaultOperator: 'contains' - }, - { - value: 'prohibited_type', - label: '违禁品类型', - type: 'select', - placeholder: '请选择违禁品类型', - filterable: true, - options: [], - }, - { - value: 'is_images', - label: '是否有图片', - type: 'boolean', - }, - { - value: 'has_bound_item', - label: '外部商品绑定', - type: 'boolean', - placeholder: '请选择是否已绑定外部商品' - }, - { - value: 'item_code', - label: '商品编码', - type: 'text', - placeholder: '请输入商品编码', - operators: ['eq', 'ne', 'contains', 'startswith', 'endswith'], - defaultOperator: 'contains' - }, - { - value: 'brand_name', - label: '品牌', - type: 'text', - placeholder: '请输入品牌', - operators: ['eq', 'ne', 'contains', 'startswith', 'endswith'], - defaultOperator: 'contains' - }, - { - value: 'goods_code', - label: '货物编码', - type: 'text', - placeholder: '请输入货物编码', - operators: ['eq', 'ne', 'contains'], - defaultOperator: 'contains' - }, - { - value: 'item_name', - label: '商品名称', - type: 'text', - placeholder: '请输入商品名称', - operators: ['eq', 'ne', 'contains'], - defaultOperator: 'contains', - required: false - }, - { - value: 'sku_property', - label: 'SKU规格', - type: 'text', - placeholder: '请输入SKU规格', - operators: ['eq', 'ne', 'contains'], - defaultOperator: 'contains' - }, - { - value: 'level', - label: 'ABC分类', - type: 'select', - placeholder: '请选择分类', - options: [ - { value: 'A', label: 'A类' }, - { value: 'B', label: 'B类' }, - { value: 'C', label: 'C类' } - ], - }, - { - value: 'quantity', - label: '库存数量', - type: 'number', - placeholder: '请输入库存数量', - operators: ['eq', 'ne', 'gt', 'lt', 'ge', 'le', 'between'], - defaultOperator: 'ge' - }, - { - value: 'locked_quantity', - label: '锁定量', - type: 'number', - placeholder: '请输入锁定量', - operators: ['eq', 'ne', 'gt', 'lt', 'ge', 'le'], - defaultOperator: 'eq' - }, - { - value: 'is_sn_mgmt', - label: '序列号管理', - type: 'boolean', - placeholder: '请选择是否序列号管理' - }, - { - value: 'is_shelf_life_mgmt', - label: '保质期管理', - type: 'boolean', - placeholder: '请选择是否保质期管理' - }, - { - value: 'is_batch_mgmt', - label: '批次管理', - type: 'boolean', - placeholder: '请选择是否批次管理' - }, - { - value: 'tag_price', - label: '标价', - type: 'number', - placeholder: '请输入标价', - operators: ['eq', 'ne', 'gt', 'lt', 'ge', 'le', 'between'], - defaultOperator: 'between' - }, - { - value: 'retail_price', - label: '零售价', - type: 'number', - placeholder: '请输入零售价', - operators: ['eq', 'ne', 'gt', 'lt', 'ge', 'le', 'between'], - defaultOperator: 'between' - }, - { - value: 'length', - label: '长度', - type: 'number', - placeholder: '请输入长度', - operators: ['eq', 'ne', 'gt', 'lt', 'ge', 'le'], - defaultOperator: 'gt' - }, - { - value: 'create_at', - label: '创建时间', - type: 'daterange', - startPlaceholder: '开始时间', - endPlaceholder: '结束时间' - }, - { - value: 'update_at', - label: '更新时间', - type: 'daterange', - startPlaceholder: '开始时间', - endPlaceholder: '结束时间' - }, - { + }), + stockScanField('owner', { value: 'stock_unit', label: '库存单位', type: 'select', @@ -387,7 +257,166 @@ export const availableFields = [ { value: '箱', label: '箱' }, ], required: false - } + }), + stockScanField('product', { + value: 'barcode', + label: '条码', + type: 'text', + placeholder: '请输入商品条码', + operators: ['contains'], + defaultOperator: 'contains' + }), + stockScanField('product', { + value: 'id', + label: 'SKU', + type: 'text', + placeholder: '请输入SKU', + operators: ['contains'], + defaultOperator: 'contains' + }), + stockScanField('product', { + value: 'item_code', + label: '商品编码', + type: 'text', + placeholder: '请输入商品编码', + operators: ['eq', 'ne', 'contains', 'startswith', 'endswith'], + defaultOperator: 'contains' + }), + stockScanField('product', { + value: 'goods_code', + label: '货物编码', + type: 'text', + placeholder: '请输入货物编码', + operators: ['eq', 'ne', 'contains'], + defaultOperator: 'contains' + }), + stockScanField('info', { + value: 'item_name', + label: '商品名称', + type: 'text', + placeholder: '请输入商品名称', + operators: ['eq', 'ne', 'contains'], + defaultOperator: 'contains', + required: false + }), + stockScanField('info', { + value: 'brand_name', + label: '品牌', + type: 'text', + placeholder: '请输入品牌', + operators: ['eq', 'ne', 'contains', 'startswith', 'endswith'], + defaultOperator: 'contains' + }), + stockScanField('info', { + value: 'sku_property', + label: 'SKU规格', + type: 'text', + placeholder: '请输入SKU规格', + operators: ['eq', 'ne', 'contains'], + defaultOperator: 'contains' + }), + stockScanField('attribute', { + value: 'prohibited_type', + label: '违禁品类型', + type: 'select', + placeholder: '请选择违禁品类型', + filterable: true, + options: [], + }), + stockScanField('attribute', { + value: 'is_images', + label: '是否有图片', + type: 'boolean', + }), + stockScanField('attribute', { + value: 'has_bound_item', + label: '外部商品绑定', + type: 'boolean', + placeholder: '请选择是否已绑定外部商品' + }), + stockScanField('attribute', { + value: 'level', + label: 'ABC分类', + type: 'select', + placeholder: '请选择分类', + options: [ + { value: 'A', label: 'A类' }, + { value: 'B', label: 'B类' }, + { value: 'C', label: 'C类' } + ], + }), + stockScanField('inventory', { + value: 'quantity', + label: '库存数量', + type: 'number', + placeholder: '请输入库存数量', + operators: ['eq', 'ne', 'gt', 'lt', 'ge', 'le', 'between'], + defaultOperator: 'ge' + }), + stockScanField('inventory', { + value: 'locked_quantity', + label: '锁定量', + type: 'number', + placeholder: '请输入锁定量', + operators: ['eq', 'ne', 'gt', 'lt', 'ge', 'le'], + defaultOperator: 'eq' + }), + stockScanField('management', { + value: 'is_sn_mgmt', + label: '序列号管理', + type: 'boolean', + placeholder: '请选择是否序列号管理' + }), + stockScanField('management', { + value: 'is_shelf_life_mgmt', + label: '保质期管理', + type: 'boolean', + placeholder: '请选择是否保质期管理' + }), + stockScanField('management', { + value: 'is_batch_mgmt', + label: '批次管理', + type: 'boolean', + placeholder: '请选择是否批次管理' + }), + stockScanField('price', { + value: 'tag_price', + label: '标价', + type: 'number', + placeholder: '请输入标价', + operators: ['eq', 'ne', 'gt', 'lt', 'ge', 'le', 'between'], + defaultOperator: 'between' + }), + stockScanField('price', { + value: 'retail_price', + label: '零售价', + type: 'number', + placeholder: '请输入零售价', + operators: ['eq', 'ne', 'gt', 'lt', 'ge', 'le', 'between'], + defaultOperator: 'between' + }), + stockScanField('price', { + value: 'length', + label: '长度', + type: 'number', + placeholder: '请输入长度', + operators: ['eq', 'ne', 'gt', 'lt', 'ge', 'le'], + defaultOperator: 'gt' + }), + stockScanField('time', { + value: 'create_at', + label: '创建时间', + type: 'daterange', + startPlaceholder: '开始时间', + endPlaceholder: '结束时间' + }), + stockScanField('time', { + value: 'update_at', + label: '更新时间', + type: 'daterange', + startPlaceholder: '开始时间', + endPlaceholder: '结束时间' + }), ] // 批量操作配置 diff --git a/src/views/storage/entry/entry-config.ts b/src/views/storage/entry/entry-config.ts index 87e3c148..fcc5ba1f 100644 --- a/src/views/storage/entry/entry-config.ts +++ b/src/views/storage/entry/entry-config.ts @@ -1,48 +1,123 @@ +/** ScanBox 筛选字段分组(入库模块专用) */ +export const ENTRY_SCAN_FIELD_GROUPS = { + owner: '货主信息', + status: '单据状态', + source: '来源配置', + detail: '单据详情', + time: '时间范围', +} as const + +type EntryScanFieldGroupKey = keyof typeof ENTRY_SCAN_FIELD_GROUPS + +export function entryScanField( + group: G, + field: Record +) { + return { ...field, group: ENTRY_SCAN_FIELD_GROUPS[group] } +} + +/** ScanBox 默认 props(与波次模块 scan-box 侧栏一致) */ +export const entryScanBoxConfig = { + width: '250px', + treeProps: { children: 'children', label: 'label' } as const, + autoSubmit: false +} + export const availableFields = [ - { label:'', value: '', type: 'input' }, - { label: '货主', value: 'store_id', type: 'select', multiple: true, options: [] }, - { label: '状态', value: 'order_status', type: 'select', options: [ - { label: '待入库', value: 'PENDING' }, - { label: '入库中', value: 'PARTIAL' }, - { label: '部分收货', value: 'PARTIAL_RECEIVED' }, - ]}, - { label: '入库单类型', value: 'order_type', type: 'select', options: [ - { label: '采购入库', value: 'CGRK' }, - { label: '退货入库', value: 'THRK' }, - { label: '其他入库', value: 'QTRK' }, - { label: '盘点入库', value: 'PDRK' }, - { label: '生产入库', value: 'SCRK' }, - { label: '领用入库', value: 'LYRK' }, - { label: '拆解入库', value: 'CCRK' }, - { label: '调拨入库', value: 'DBRK' }, - { label: 'B2B入库', value: 'B2BRK' }, - { label: '虚拟入库', value: 'XNRK' }, - ]}, - { label: '入库状态', value: 'sync_status', type: 'select', options: [ - { label: '待推送', value: 'PENDING' }, - { label: '推送中', value: 'SYNCING' }, - { label: '成功', value: 'SUCCESS' }, - { label: '失败', value: 'FAIL' }, - ]}, - { label: '数据来源', value: 'source_type', type: 'select', options: [ - { label: '奇门', value: 'QM' }, - { label: '接口', value: 'API' }, - { label: '系统', value: 'WMS' }, - ]}, - { label: '费用是否记录',value: 'expense_record', type: 'select', options: [ - { label: '是', value: true }, - { label: '否', value: false }, - ]}, - { label: '批次',value: 'batch',type: 'text' }, - { label: '编号',value: 'number',type: 'text' }, - { label: '备注',value: 'remark',type: 'text' }, - { label: 'ERP备注',value: 'erp_remark',type: 'text' }, - { label: '操作员ID',value: 'operator_id',type: 'text' }, - { label: '创建时间',value: 'order_create_time',type: 'datetimerange' }, - { label: '',value: ''}, - { label: '',value: ''}, - { label: '',value: ''}, - { label: '',value: ''}, + entryScanField('owner', { + label: '货主', + value: 'store_id', + type: 'select', + multiple: true, + options: [] + }), + entryScanField('status', { + label: '状态', + value: 'order_status', + type: 'select', + options: [ + { label: '待入库', value: 'PENDING' }, + { label: '入库中', value: 'PARTIAL' }, + { label: '部分收货', value: 'PARTIAL_RECEIVED' }, + ] + }), + entryScanField('status', { + label: '入库单类型', + value: 'order_type', + type: 'select', + options: [ + { label: '采购入库', value: 'CGRK' }, + { label: '退货入库', value: 'THRK' }, + { label: '其他入库', value: 'QTRK' }, + { label: '盘点入库', value: 'PDRK' }, + { label: '生产入库', value: 'SCRK' }, + { label: '领用入库', value: 'LYRK' }, + { label: '拆解入库', value: 'CCRK' }, + { label: '调拨入库', value: 'DBRK' }, + { label: 'B2B入库', value: 'B2BRK' }, + { label: '虚拟入库', value: 'XNRK' }, + ] + }), + entryScanField('status', { + label: '入库状态', + value: 'sync_status', + type: 'select', + options: [ + { label: '待推送', value: 'PENDING' }, + { label: '推送中', value: 'SYNCING' }, + { label: '成功', value: 'SUCCESS' }, + { label: '失败', value: 'FAIL' }, + ] + }), + entryScanField('source', { + label: '数据来源', + value: 'source_type', + type: 'select', + options: [ + { label: '奇门', value: 'QM' }, + { label: '接口', value: 'API' }, + { label: '系统', value: 'WMS' }, + ] + }), + entryScanField('source', { + label: '费用是否记录', + value: 'expense_record', + type: 'select', + options: [ + { label: '是', value: true }, + { label: '否', value: false }, + ] + }), + entryScanField('detail', { + label: '批次', + value: 'batch', + type: 'text' + }), + entryScanField('detail', { + label: '编号', + value: 'number', + type: 'text' + }), + entryScanField('detail', { + label: '备注', + value: 'remark', + type: 'text' + }), + entryScanField('detail', { + label: 'ERP备注', + value: 'erp_remark', + type: 'text' + }), + entryScanField('detail', { + label: '操作员ID', + value: 'operator_id', + type: 'text' + }), + entryScanField('time', { + label: '创建时间', + value: 'order_create_time', + type: 'datetimerange' + }), ] export const entryColums = [ @@ -57,20 +132,20 @@ export const entryColums = [ { prop: 'sync_status',label:'入库状态',width:'160' }, { prop: 'supplier_code',label:'供应商编码',width:'160' }, { prop: 'supplier_name',label:'供应商名称',width:'160' }, - { prop: '',label:'',width:'160' }, + // { prop: '',label:'',width:'160' }, { prop: 'express_code',label:'运单号',width:'160' }, { prop: 'logistics_code',label:'物流公司编码',width:'160' }, { prop: 'logistics_name',label:'物流公司名称',width:'160' }, - { prop: '',label:'',width:'160',fixed: 'left' }, - { prop: '',label:'',width:'160',fixed: 'left' }, + // { prop: '',label:'',width:'160',fixed: 'left' }, + // { prop: '',label:'',width:'160',fixed: 'left' }, { prop: 'order_create_time',label:'单据创建时间',width:'160' }, { prop: 'expect_start_time',label:'预计开始时间',width:'160' }, { prop: 'expect_end_time',label:'预计结束时间',width:'160' }, - { prop: '',label:'',width:'160',fixed: 'left' }, + // { prop: '',label:'',width:'160',fixed: 'left' }, { prop: 'source_type',label:'数据来源',width:'160' }, { prop: 'remark',label:'备注',width:'160' }, - { prop: '',label:'',width:'160',fixed: 'left' }, - { prop: '',label:'',width:'160',fixed: 'left' }, + // { prop: '',label:'',width:'160',fixed: 'left' }, + // { prop: '',label:'',width:'160',fixed: 'left' }, ] const entryInventoryTypeLabelMap: Record = { @@ -142,4 +217,4 @@ export const addEntryFields = [ { label: '入库单号', prop: 'entry_order_code' }, { label: '采购单号', prop: 'purchase_order_code' }, { label: '备注', prop: 'remark', type: 'textarea' } -] \ No newline at end of file +] diff --git a/src/views/storage/entry/index.vue b/src/views/storage/entry/index.vue index a6562082..397ea28e 100644 --- a/src/views/storage/entry/index.vue +++ b/src/views/storage/entry/index.vue @@ -2,9 +2,9 @@
( + group: G, + field: Record +) { + return { ...field, group: INVENTORY_SCAN_FIELD_GROUPS[group] } +} + +/** ScanBox 默认 props(与波次模块 scan-box 侧栏一致) */ +export const inventoryScanBoxConfig = { + width: '250px', + treeProps: { children: 'children', label: 'label' } as const, + autoSubmit: false +} + export const availableFields = [ - { + inventoryScanField('product', { label: '商品ID', value: 'stock_id', type: 'text', placeholder: '请输入商品ID', extraAction: { label: '编码筛选' } - }, - { label: '库位', value: 'space_id', type: 'text' }, - { label: '货主', value: 'store_id', type: 'select', multiple: true, options: [] }, - { label: '库存类型', value: 'inventory_type', type: 'select', options: [ - { label: '正品', value: 'ZP' }, - { label: '次品', value: 'CC' }, - { label: '机损', value: 'JS' }, - { label: '箱损', value: 'XS' }, - { label: '在途', value: 'ZT' }, - { label: '冻结', value: 'DJ' }, - { label: '分配', value: 'FP' } - ]}, - { label: '批次号', value: 'batch_no', type: 'text' }, - { label: '入库单号', value: 'inbound_order_no', type: 'text' }, - { label: '创建日期', value: 'created_at', type: 'daterange' } + }), + inventoryScanField('location', { label: '库位', value: 'space_id', type: 'text' }), + inventoryScanField('owner', { label: '货主', value: 'store_id', type: 'select', multiple: true, options: [] }), + inventoryScanField('inventory', { + label: '库存类型', + value: 'inventory_type', + type: 'select', + options: [ + { label: '正品', value: 'ZP' }, + { label: '次品', value: 'CC' }, + { label: '机损', value: 'JS' }, + { label: '箱损', value: 'XS' }, + { label: '在途', value: 'ZT' }, + { label: '冻结', value: 'DJ' }, + { label: '分配', value: 'FP' } + ] + }), + inventoryScanField('inventory', { label: '批次号', value: 'batch_no', type: 'text' }), + inventoryScanField('inventory', { label: '入库单号', value: 'inbound_order_no', type: 'text' }), + inventoryScanField('time', { label: '创建日期', value: 'created_at', type: 'daterange' }) ] - /** 库位展示名:优先 custom_name,其次 space_code */ export function formatInventorySpaceLabel(space?: Record | null, fallback = ''): string { if (!space || typeof space !== 'object') return fallback diff --git a/src/views/storage/management/replenishmentDemand/index.vue b/src/views/storage/management/replenishmentDemand/index.vue index d9cde91e..baebea9c 100644 --- a/src/views/storage/management/replenishmentDemand/index.vue +++ b/src/views/storage/management/replenishmentDemand/index.vue @@ -7,14 +7,14 @@
- + /> -->
- @@ -322,7 +325,8 @@ import { deliveryMethodConfig, loadingMethodConfig, addReceivingFields, - receivingToolbarButtons + receivingToolbarButtons, + receivingScanBoxConfig } from './receiving-config' import * as XLSX from 'xlsx' import { useVerticalSplitPane } from '@/composables/useVerticalSplitPane' diff --git a/src/views/storage/receiving/receiving-config.ts b/src/views/storage/receiving/receiving-config.ts index 247d828b..ee1f487a 100644 --- a/src/views/storage/receiving/receiving-config.ts +++ b/src/views/storage/receiving/receiving-config.ts @@ -1,5 +1,33 @@ import type { ToolbarButtonConfig } from '@/views/order/orderManagement/config/order-common-config' +/** ScanBox 筛选字段分组(收货模块专用) */ +export const RECEIVING_SCAN_FIELD_GROUPS = { + order: '单据信息', + status: '状态筛选', + owner: '货主信息', + logistics: '物流信息', + stats: '数量统计', + time: '时间范围', + person: '人员信息', + other: '其他', +} as const + +type ReceivingScanFieldGroupKey = keyof typeof RECEIVING_SCAN_FIELD_GROUPS + +export function receivingScanField( + group: G, + field: Record +) { + return { ...field, group: RECEIVING_SCAN_FIELD_GROUPS[group] } +} + +/** ScanBox 默认 props(与波次模块 scan-box 侧栏一致) */ +export const receivingScanBoxConfig = { + width: '250px', + treeProps: { children: 'children', label: 'label' } as const, + autoSubmit: false +} + export const statusConfig = { receiving: { text: '收货中', tagType: 'warning' }, completed: { text: '已完成', tagType: 'success' }, @@ -127,23 +155,37 @@ export const receivingColumns = [ // receiving配置 export const availableFields = [ - { + receivingScanField('order', { value: 'receiving_number', label: '收货单号', type: 'text', placeholder: '请输入收货单号', - // 可用操作符(后端 operator 名称):等于、不等于、包含、开头为、模糊匹配 operators: ['eq', 'ne', 'contains', 'starts_with', 'like'], defaultOperator: 'contains' - }, - { value: 'status', label: '收货状态', type: 'select', options: Object.entries(statusConfig).map(([v, c]) => ({ value: v, label: c.text })) }, - { value: 'detail_status', label: '匹配状态', type: 'select', options: Object.entries(detailStatusConfig).map(([v, c]) => ({ value: v, label: c.text })) }, - { value: 'storage_status', label: '入库状态', type: 'select', options: [ - { value: 'none', label: '待入库' }, - { value: 'partial', label: '部分入库' }, - { value: 'all', label: '已入库' } - ] }, - { + }), + receivingScanField('status', { + value: 'status', + label: '收货状态', + type: 'select', + options: Object.entries(statusConfig).map(([v, c]) => ({ value: v, label: c.text })) + }), + receivingScanField('status', { + value: 'detail_status', + label: '匹配状态', + type: 'select', + options: Object.entries(detailStatusConfig).map(([v, c]) => ({ value: v, label: c.text })) + }), + receivingScanField('status', { + value: 'storage_status', + label: '入库状态', + type: 'select', + options: [ + { value: 'none', label: '待入库' }, + { value: 'partial', label: '部分入库' }, + { value: 'all', label: '已入库' } + ] + }), + receivingScanField('status', { value: 'is_review', label: '审核状态', type: 'select', @@ -152,122 +194,131 @@ export const availableFields = [ { value: 0, label: '未审核' }, { value: 1, label: '已审核' } ] - }, - { value: 'store_id', label: '货主', type: 'select', multiple: true, filterable: true, options: [] }, - { value: 'delivery_method', label: '来货方式', type: 'select', options: Object.entries(deliveryMethodConfig).map(([v, c]: [string, any]) => ({ value: v, label: c.text })) }, - { value: 'loading_method', - label: '装卸方式', - type: 'select', - placeholder: '请选择装卸方式', - options: Object.entries(loadingMethodConfig).map(([value, config]: [string, any]) => ({ - value, - label: (config as any).text - }))}, - { + }), + receivingScanField('owner', { + value: 'store_id', + label: '货主', + type: 'select', + multiple: true, + filterable: true, + options: [] + }), + receivingScanField('logistics', { + value: 'delivery_method', + label: '来货方式', + type: 'select', + options: Object.entries(deliveryMethodConfig).map(([v, c]: [string, any]) => ({ value: v, label: c.text })) + }), + receivingScanField('logistics', { + value: 'loading_method', + label: '装卸方式', + type: 'select', + placeholder: '请选择装卸方式', + options: Object.entries(loadingMethodConfig).map(([value, config]: [string, any]) => ({ + value, + label: (config as any).text + })) + }), + receivingScanField('logistics', { value: 'license_plate', label: '车牌号', type: 'text', placeholder: '请输入车牌号', operators: ['contains'], defaultOperator: 'contains' - }, - { + }), + receivingScanField('logistics', { value: 'tracking_number', label: '物流单号', type: 'text', placeholder: '请输入物流单号', operators: ['contains'], defaultOperator: 'contains' - }, - // 数量范围筛选 - { + }), + receivingScanField('stats', { value: 'total_items', label: '商品种类', type: 'number', placeholder: '请输入商品种类数', operators: numberConfig.operators, defaultOperator: numberConfig.defaultOperator - }, - { + }), + receivingScanField('stats', { value: 'total_quantity', label: '总数量', type: 'number', placeholder: '请输入总数量', operators: numberConfig.operators, defaultOperator: numberConfig.defaultOperator - }, - { + }), + receivingScanField('stats', { value: 'total_boxes', label: '总箱数', type: 'number', placeholder: '请输入总箱数', operators: numberConfig.operators, defaultOperator: numberConfig.defaultOperator - }, - { + }), + receivingScanField('stats', { value: 'total_pallets', label: '总托盘数', type: 'number', placeholder: '请输入总托盘数', operators: numberConfig.operators, defaultOperator: numberConfig.defaultOperator - }, - // 时间筛选 - { + }), + receivingScanField('time', { value: 'created_at', label: '创建时间', type: 'daterange', startPlaceholder: '开始时间', endPlaceholder: '结束时间' - }, - { + }), + receivingScanField('time', { value: 'updated_at', label: '更新时间', type: 'daterange', startPlaceholder: '开始时间', endPlaceholder: '结束时间' - }, - { + }), + receivingScanField('time', { value: 'receiving_start_time', label: '收货开始时间', type: 'daterange', startPlaceholder: '开始时间', endPlaceholder: '结束时间' - }, - { + }), + receivingScanField('time', { value: 'receiving_end_time', label: '收货结束时间', type: 'daterange', startPlaceholder: '开始时间', endPlaceholder: '结束时间' - }, - // 创建人筛选 - { + }), + receivingScanField('person', { value: 'creator_id', label: '创建人', type: 'select', placeholder: '请选择创建人', filterable: true, options: [] - }, - // 备注筛选 - { + }), + receivingScanField('other', { value: 'remark', label: '备注', type: 'text', placeholder: '请输入备注关键词', operators: ['contains'], defaultOperator: 'contains' - }, - // 录像设备 - { + }), + receivingScanField('other', { value: 'video_device_id', label: '录像设备ID', type: 'text', placeholder: '请输入录像设备ID', operators: ['eq', 'contains'], defaultOperator: 'contains' - } + }) ] export const addReceving = [ diff --git a/src/views/storage/report/index.vue b/src/views/storage/report/index.vue index 729ea8ae..1014104a 100644 --- a/src/views/storage/report/index.vue +++ b/src/views/storage/report/index.vue @@ -2,9 +2,9 @@
( + group: G, + field: Record +) { + return { ...field, group: REPORT_SCAN_FIELD_GROUPS[group] } +} + +/** ScanBox 默认 props(与波次模块 scan-box 侧栏一致) */ +export const reportScanBoxConfig = { + width: '250px', + treeProps: { children: 'children', label: 'label' } as const, + autoSubmit: false +} + /** ScanBox 侧栏可用字段(与 storage.report.search 的 where 对应) */ export const reportScanBoxAvailableFields = [ - { + reportScanField('time', { value: 'report_period', label: '统计时间', type: 'daterange', startPlaceholder: '开始日期', endPlaceholder: '结束日期' - }, - { + }), + reportScanField('owner', { value: 'store_id', label: '货主', type: 'select', @@ -185,13 +208,13 @@ export const reportScanBoxAvailableFields = [ filterable: true, placeholder: '请选择货主', options: [] as { label: string; value: number }[] - }, - { + }), + reportScanField('options', { value: 'by_space', label: '按库位统计', type: 'boolean', placeholder: '开启后按商品+库位+货主返回;关闭则按商品+货主聚合' - } + }) ] /** 将 ScanBox 条件转为接口扁平 where;无有效条件时返回 {} */ diff --git a/src/views/storage/stockout/index.vue b/src/views/storage/stockout/index.vue index 53d9d7a6..b539cfe4 100644 --- a/src/views/storage/stockout/index.vue +++ b/src/views/storage/stockout/index.vue @@ -2,9 +2,9 @@
( + group: G, + field: Record +) { + return { ...field, group: STOCKOUT_SCAN_FIELD_GROUPS[group] } +} + +/** ScanBox 默认 props(与波次模块 scan-box 侧栏一致) */ +export const stockoutScanBoxConfig = { + width: '250px', + treeProps: { children: 'children', label: 'label' } as const, + autoSubmit: false +} + export const statusConfig: Record = { pedding: { text: '待出库', tagType: 'warning' }, pending: { text: '待出库', tagType: 'warning' }, @@ -51,30 +76,58 @@ export const entryColums = [ ] export const availableFields = [ - { value: 'delivery_order_code', label: '出库单号', type: 'text' }, - { value: 'status', label: '出库状态', type: 'select', options: [ - { value: 'pedding', label: '待出库' }, - { value: 'processing', label: '出库中' }, - { value: 'completed', label: '已完成' }, - { value: 'cancelled', label: '已作废' } - ]}, - { value: 'sync_status', label: '同步状态', type: 'select', options: [ - { value: 'padding', label: '待同步' }, - { value: 'success', label: '同步成功' }, - { value: 'failed', label: '同步失败' } - ]}, - { value: 'store_id', label: '货主', type: 'select', multiple: true, filterable: true, options: [] }, - { value: 'order_type', label: '单据类型', type: 'select', options: [ - { label: '交易出库', value: 'JYCK' }, - { label: '调拨出库', value: 'TRANSFER' }, - { label: '退货出库', value: 'RETURN' }, - { label: '其他出库', value: 'OTHER' } - ]}, - { value: 'buyer_nick', label: '买家', type: 'text' }, - { value: 'mobile', label: '联系电话', type: 'text' }, - { value: 'logistics_code', label: '物流公司', type: 'text' }, - { value: 'express_code', label: '运单号', type: 'text' }, - { value: 'place_order_time', label: '下单时间', type: 'daterange', startPlaceholder: '开始时间', endPlaceholder: '结束时间' } + stockoutScanField('order', { value: 'delivery_order_code', label: '出库单号', type: 'text' }), + stockoutScanField('order', { + value: 'order_type', + label: '单据类型', + type: 'select', + options: [ + { label: '交易出库', value: 'JYCK' }, + { label: '调拨出库', value: 'TRANSFER' }, + { label: '退货出库', value: 'RETURN' }, + { label: '其他出库', value: 'OTHER' } + ] + }), + stockoutScanField('status', { + value: 'status', + label: '出库状态', + type: 'select', + options: [ + { value: 'pedding', label: '待出库' }, + { value: 'processing', label: '出库中' }, + { value: 'completed', label: '已完成' }, + { value: 'cancelled', label: '已作废' } + ] + }), + stockoutScanField('status', { + value: 'sync_status', + label: '同步状态', + type: 'select', + options: [ + { value: 'padding', label: '待同步' }, + { value: 'success', label: '同步成功' }, + { value: 'failed', label: '同步失败' } + ] + }), + stockoutScanField('owner', { + value: 'store_id', + label: '货主', + type: 'select', + multiple: true, + filterable: true, + options: [] + }), + stockoutScanField('receiver', { value: 'buyer_nick', label: '买家', type: 'text' }), + stockoutScanField('receiver', { value: 'mobile', label: '联系电话', type: 'text' }), + stockoutScanField('logistics', { value: 'logistics_code', label: '物流公司', type: 'text' }), + stockoutScanField('logistics', { value: 'express_code', label: '运单号', type: 'text' }), + stockoutScanField('time', { + value: 'place_order_time', + label: '下单时间', + type: 'daterange', + startPlaceholder: '开始时间', + endPlaceholder: '结束时间' + }) ] // 详情面板表单配置 diff --git a/workflows/api-doc-agent/config/响应.md b/workflows/api-doc-agent/config/响应.md deleted file mode 100644 index 256505a4..00000000 --- a/workflows/api-doc-agent/config/响应.md +++ /dev/null @@ -1,112 +0,0 @@ -```json -[ - { - "接口": "user.login", - "data": { - "flag": "success", - "code": 200, - "message": "登录成功", - "success": true, - "data": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MywidXNlcm5hbWUiOiJ5am0iLCJyZWFsX25hbWUiOiJ5aW4iLCJwbGF0Zm9ybV9jb2RlIjoid2ViIiwiY3VycmVudF9yb2xlX2lkIjozMSwiY3VycmVudF9zdG9yZV9pZCI6MTAwMDAwLCJpYXQiOjE3ODE3NzY0NjksImV4cCI6MTc4MTc5MDg2OX0.CbuNMERnphyn_sdPNSOast3BfOnW030MzEEkml_Y-ZE" - }, - "timestamp": 1781776469 - } - }, - { - "接口": "storage.entry.get", - "data": { - "flag": "success", - "code": 200, - "message": "查询成功", - "data": { - "entryOrder": { - "id": 234, - "entry_order_code": "TEST-EO-1781661791664EM3F02", - "order_type": "SCRK", - "purchase_order_code": "", - "total_order_lines": 1, - "order_create_time": "2026-06-17T02:03:11.000Z", - "expect_start_time": "2026-06-20T02:00:00.000Z", - "expect_end_time": "2026-06-17T02:03:11.000Z", - "logistics_code": "", - "logistics_name": "", - "express_code": "", - "supplier_code": "SUP001", - "supplier_name": "测试供应商", - "source_type": "API", - "order_status": "PENDING", - "sync_status": "PENDING", - "sync_message": "", - "is_enabled": 1, - "created_at": "2026-06-17T02:03:11.000Z", - "updated_at": "2026-06-17T02:03:11.000Z", - "warehouse_id": 100000, - "store_id": 1000000, - "remark": "自动化测试入库单", - "expense_record": 0, - "store_name": "测试货主", - "warehouse_name": "测试云仓", - "deleted_at": null, - "qimen_owner_code": "", - "qimen_warehouse_code": "100000", - "warehouse": { - "id": 100000, - "company_name": "测试仓" - }, - "store": { - "id": 1000000, - "company_name": "测试货主1111" - }, - "items": [ - { - "id": 440, - "order_id": 234, - "out_biz_code": "", - "order_line_no": 1, - "owner_code": "4", - "count": 10, - "inventory_type": "ZP", - "stock_id": 101397, - "received_quantity": 0, - "confirm_quantity": 0, - "pending_total": 3, - "total_planned": 10, - "bindings": [ - { - "id": 1, - "entry_item_id": 440, - "receiving_detail_id": 2628, - "allocated_quantity": 3, - "status": "pending", - "creator_id": 31, - "created_at": "2026-06-18T09:26:10.000Z", - "updated_at": "2026-06-18T09:26:10.000Z", - "deleted_at": null, - "receivingDetail": { - "id": 2628, - "receiving_id": 1433, - "product_name": "CrazyKitty唇刷", - "actual_quantity": 5, - "stored_quantity": 0, - "batch_number": "02025416", - "production_date": "2026-06-16", - "expiry_date": "2026-06-27", - "storage_status": "none" - } - } - ], - "external_item_code": "6920251105000", - "external_item_id": 1000213, - "warehouse_item_code": "6920251105000", - "warehouse_item_name": "CrazyKitty唇刷", - "warehouse_item_spec": "" - } - ] - } - }, - "timestamp": 1781776469 - } - } -] -``` diff --git a/workflows/api-doc-agent/config/接口.md b/workflows/api-doc-agent/config/接口.md deleted file mode 100644 index 15ca7e83..00000000 --- a/workflows/api-doc-agent/config/接口.md +++ /dev/null @@ -1,424 +0,0 @@ -# 接口 - -- 更新时间: 2026-06-18 17:47:31 -- 扫描目录: `src\api` -- 模块数: 42 -- API 文件数: 42 -- 接口数: 363 -- 已启用: 326 -- 占位接口: 2 - -## 模块统计 - -| 模块 | 文件数 | 接口数 | 已启用 | 占位 | -| --- | ---: | ---: | ---: | ---: | -| config | 1 | 1 | 0 | 0 | -| dashboard | 1 | 6 | 6 | 0 | -| index | 1 | 25 | 22 | 1 | -| order | 1 | 3 | 3 | 0 | -| order.archiveorder | 1 | 2 | 2 | 0 | -| order.deliveryexpectionorder | 1 | 2 | 2 | 0 | -| order.deliveryorder | 1 | 2 | 2 | 0 | -| order.entrustorder | 1 | 2 | 2 | 0 | -| order.expectionorder | 1 | 3 | 3 | 0 | -| order.index | 1 | 11 | 10 | 0 | -| order.outboundorder | 1 | 3 | 3 | 0 | -| order.pendingorder | 1 | 27 | 25 | 0 | -| order.print | 1 | 4 | 4 | 0 | -| order.recheckorder | 1 | 8 | 6 | 0 | -| order.revieworder | 1 | 3 | 3 | 0 | -| order.wave | 1 | 30 | 28 | 0 | -| pick | 1 | 4 | 4 | 0 | -| pickcart | 1 | 8 | 8 | 0 | -| print | 1 | 16 | 15 | 1 | -| printer.station | 1 | 11 | 1 | 0 | -| setting.account | 1 | 7 | 7 | 0 | -| setting.express | 1 | 7 | 7 | 0 | -| setting.expressinterface | 1 | 6 | 6 | 0 | -| setting.packagematerial | 1 | 6 | 6 | 0 | -| setting.packagesupplier | 1 | 5 | 5 | 0 | -| setting.permission | 1 | 4 | 4 | 0 | -| setting.platform | 1 | 5 | 5 | 0 | -| setting.printtemplate | 1 | 13 | 13 | 0 | -| setting.role | 1 | 5 | 5 | 0 | -| setting.warehouse | 1 | 3 | 3 | 0 | -| shops | 1 | 6 | 5 | 0 | -| stock | 1 | 29 | 28 | 0 | -| storage_receiving | 1 | 24 | 14 | 0 | -| storage.entry | 1 | 6 | 6 | 0 | -| storage.inventory | 1 | 8 | 7 | 0 | -| storage.management | 1 | 1 | 1 | 0 | -| storage.report | 1 | 3 | 3 | 0 | -| storage.stockout | 1 | 3 | 3 | 0 | -| store | 1 | 6 | 6 | 0 | -| storewarehouse.store | 1 | 13 | 13 | 0 | -| user | 1 | 9 | 9 | 0 | -| warehouse | 1 | 23 | 21 | 0 | - -## 接口明细 - -| 模块 | 接口名 | method | HTTP Method | 启用 | 占位 | 文件 | 备注 | -| --- | --- | --- | --- | --- | --- | --- | --- | -| config | listConfig | config.list | POST | 否 | 否 | config/config.ts | | -| dashboard | getExpressRatio | dashboard.express_ratio | POST | 是 | 否 | dashboard/dashboard.ts | | -| dashboard | getHotOrderRank | dashboard.hot_order_rank | POST | 是 | 否 | dashboard/dashboard.ts | | -| dashboard | getOrderTrend | dashboard.order_trend | POST | 是 | 否 | dashboard/dashboard.ts | | -| dashboard | getPlatformDist | dashboard.platform_distribution | POST | 是 | 否 | dashboard/dashboard.ts | | -| dashboard | getStoreStats | dashboard.storeStats | POST | 是 | 否 | dashboard/dashboard.ts | | -| dashboard | getWarehouseStats | dashboard.warehouseStats | POST | 是 | 否 | dashboard/dashboard.ts | | -| index | fastWhereTree | index.fastWhereTree | POST | 否 | 是 | index/index.ts | | -| index | getCainiaoStfTemplates | index.getCainiaoStfTemplates | POST | 是 | 否 | index/index.ts | | -| index | getCOSUploadConfig | index.getCOSUploadConfig | POST | 是 | 否 | index/index.ts | | -| index | getExpressList | index.getExpressList | POST | 是 | 否 | index/index.ts | | -| index | getExpressProductTypeList | index.getExpressProductTypeList | POST | 是 | 否 | index/index.ts | | -| index | getI18nMessage | index.getI18nMessage | POST | 是 | 否 | index/index.ts | | -| index | getImages | index.getImages | POST | 是 | 否 | index/index.ts | | -| index | getLocationTypeList | index.getLocationTypeList | POST | 是 | 否 | index/index.ts | | -| index | getMessageDetail | index.getMessageDetail | POST | 是 | 否 | index/index.ts | | -| index | getPlatformList | index.getPlatformList | POST | 是 | 否 | index/index.ts | 平台编码表单用 | -| index | getPlatformOauthLink | index.getPlatformOauthLink | POST | 是 | 否 | index/index.ts | | -| index | getPrintPlatformTemplateList | index.getPrintPlatformTemplateList | POST | 是 | 否 | index/index.ts | | -| index | getQimenAppList | index.getQimenAppList | POST | 是 | 否 | index/index.ts | | -| index | getShopExpressList | index.getShopExpressList | POST | 是 | 否 | index/index.ts | | -| index | getShopList | index.getShopList | POST | 是 | 否 | index/index.ts | | -| index | listInterfaceTypes | index.listInterfaceTypes | POST | 是 | 否 | index/index.ts | | -| index | loadStores | index.loadStores | POST | 是 | 否 | index/index.ts | | -| index | loginToIm | index.loginToIm | POST | 否 | 否 | index/index.ts | | -| index | polyapiAuthorizeUrl | index.polyapiAuthorizeUrl | POST | 是 | 否 | index/index.ts | | -| index | putI18nCollect | index.putI18nCollect | POST | 是 | 否 | index/index.ts | | -| index | recognizeLicensePlate | index.recognizeLicensePlate | POST | 否 | 否 | index/index.ts | | -| index | ReferenceFile | index.ReferenceFile | POST | 是 | 否 | index/index.ts | | -| index | searchSpace | index.searchSpace | POST | 是 | 否 | index/index.ts | | -| index | tryAutoTranslateNewKeys | index.tryAutoTranslateNewKeys | POST | 是 | 否 | index/index.ts | | -| index | uploadSuccessNotify | index.uploadSuccessNotify | POST | 是 | 否 | index/index.ts | | -| order | orderModulePendingOrderDownloadCreateTemplate | order.pendingOrder.downloadCreateTemplate | POST | 是 | 否 | order/order.ts | | -| order | orderModulePendingOrderManualWaybill | order.pendingOrder.manualWaybill | POST | 是 | 否 | order/order.ts | | -| order | orderModuleWaveBatchList | order.wave.batchList | POST | 是 | 否 | order/order.ts | | -| order.archiveorder | orderArchiveOrderDetail | order.archiveOrder.detail | POST | 是 | 否 | order.archiveorder/orderarchiveorder.ts | | -| order.archiveorder | orderArchiveOrderList | order.archiveOrder.list | POST | 是 | 否 | order.archiveorder/orderarchiveorder.ts | | -| order.deliveryexpectionorder | orderDeliveryExpectionOrderDetail | order.deliveryExpectionOrder.detail | POST | 是 | 否 | order.deliveryexpectionorder/orderdeliveryexpectionorder.ts | | -| order.deliveryexpectionorder | orderDeliveryExpectionOrderList | order.deliveryExpectionOrder.list | POST | 是 | 否 | order.deliveryexpectionorder/orderdeliveryexpectionorder.ts | | -| order.deliveryorder | orderDeliveryOrderDetail | order.deliveryOrder.detail | POST | 是 | 否 | order.deliveryorder/orderdeliveryOrder.ts | | -| order.deliveryorder | orderDeliveryOrderList | order.deliveryOrder.list | POST | 是 | 否 | order.deliveryorder/orderdeliveryOrder.ts | | -| order.entrustorder | orderEntrustOrderDetail | order.entrustOrder.detail | POST | 是 | 否 | order.entrustorder/orderentrustorder.ts | | -| order.entrustorder | orderEntrustOrderList | order.entrustOrder.list | POST | 是 | 否 | order.entrustorder/orderentrustorder.ts | | -| order.expectionorder | orderExpectionOrderDetail | order.expectionOrder.detail | POST | 是 | 否 | order.expectionorder/orderexpectionorder.ts | | -| order.expectionorder | orderExpectionOrderList | order.expectionOrder.list | POST | 是 | 否 | order.expectionorder/orderexpectionorder.ts | | -| order.expectionorder | orderExpectionOrderResolveException | order.expectionOrder.resolveException | POST | 是 | 否 | order.expectionorder/orderexpectionorder.ts | | -| order.index | orderBadgeCount | order.badgeCount | POST | 是 | 否 | order.index/orderindex.ts | | -| order.index | orderBindExpressPackageMaterial | order.bindExpressPackageMaterial | POST | 是 | 否 | order.index/orderindex.ts | | -| order.index | orderBindExpressPackageMaterialByWaybill | order.bindExpressPackageMaterialByWaybill | POST | 是 | 否 | order.index/orderindex.ts | | -| order.index | orderDetail | order.detail | POST | 否 | 否 | order.index/orderindex.ts | | -| order.index | orderExport | order.export | POST | 是 | 否 | order.index/orderindex.ts | | -| order.index | orderExportTaskProgress | order.exportTaskProgress | POST | 是 | 否 | order.index/orderindex.ts | | -| order.index | orderList | order.list | POST | 是 | 否 | order.index/orderindex.ts | | -| order.index | orderManualOutboundOrder | order.manualOutboundOrder | POST | 是 | 否 | order.index/orderindex.ts | | -| order.index | orderQueryOrderLogList | order.queryOrderLogList | POST | 是 | 否 | order.index/orderindex.ts | | -| order.index | orderQueryOrderLogs | order.queryOrderLogs | POST | 是 | 否 | order.index/orderindex.ts | | -| order.index | orderUpdateExpressWeighingWeight | order.updateExpressWeighingWeight | POST | 是 | 否 | order.index/orderindex.ts | | -| order.outboundorder | orderOutboundOrderDetail | order.outboundOrder.detail | POST | 是 | 否 | order.outboundorder/orderoutboundOrder.ts | | -| order.outboundorder | orderOutboundOrderList | order.outboundOrder.list | POST | 是 | 否 | order.outboundorder/orderoutboundOrder.ts | | -| order.outboundorder | orderOutboundOrderManualOutboundOrder | order.outboundOrder.manualOutboundOrder | POST | 是 | 否 | order.outboundorder/orderoutboundOrder.ts | | -| order.pendingorder | orderPendingOrderAllocateExpressCode | order.pendingOrder.allocateExpressCode | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderAllocateStorage | order.pendingOrder.allocateStorage | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderAllocateStorageProgress | order.pendingOrder.allocateStorageProgress | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderBatchIntercept | order.pendingOrder.batchIntercept | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderBatchInterceptTaskProgress | order.pendingOrder.batchInterceptTaskProgress | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderBatchLock | order.pendingOrder.batchLock | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderBatchLockTaskProgress | order.pendingOrder.batchLockTaskProgress | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderBatchUnintercept | order.pendingOrder.batchUnintercept | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderBatchUninterceptTaskProgress | order.pendingOrder.batchUninterceptTaskProgress | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderBatchUnlock | order.pendingOrder.batchUnlock | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderBatchUnlockTaskProgress | order.pendingOrder.batchUnlockTaskProgress | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderCancelAllocateStorage | order.pendingOrder.cancelAllocateStorage | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderCancelOrder | order.pendingOrder.cancelOrder | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderCloneOrder | order.pendingOrder.cloneOrder | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderCreateOrder | order.pendingOrder.createOrder | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderDetail | order.pendingOrder.detail | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderDownloadCreateTemplate | order.pendingOrder.downloadCreateTemplate | POST | 否 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderImportOrdersFromExcel | order.pendingOrder.importOrdersFromExcel | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderList | order.pendingOrder.list | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderManualWaybill | order.pendingOrder.manualWaybill | POST | 否 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderMarkPendingOutboundOrder | order.pendingOrder.markPendingOutboundOrder | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderParseAddress | order.pendingOrder.parseAddress | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderReverseReviewOrder | order.pendingOrder.reverseReviewOrder | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderSyncOrderIds | order.pendingOrder.syncOrderIds | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderUpdateAddress | order.pendingOrder.updateAddress | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderUpdateOrderExpress | order.pendingOrder.updateOrderExpress | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.pendingorder | orderPendingOrderUpdateOrderPlatform | order.pendingOrder.updateOrderPlatform | POST | 是 | 否 | order.pendingorder/orderpendingOrder.ts | | -| order.print | getOrderPrintData | order.print.getOrderPrintData | POST | 是 | 否 | order.print/orderprint.ts | | -| order.print | getWavePlatformPrintData | order.print.getWavePlatformPrintData | POST | 是 | 否 | order.print/orderprint.ts | | -| order.print | getWavePrintData | order.print.getWavePrintData | POST | 是 | 否 | order.print/orderprint.ts | | -| order.print | unlockWavePlatformPrintDataByGroup | order.print.unlockWavePlatformPrintDataByGroup | POST | 是 | 否 | order.print/orderprint.ts | | -| order.recheckorder | batchQuickRecheck | order.recheckOrder.batchQuickRecheck | POST | 是 | 否 | order.recheckorder/recheckOrder.ts | | -| order.recheckorder | confirmIntercept | order.recheckOrder.confirmIntercept | POST | 是 | 否 | order.recheckorder/recheckOrder.ts | | -| order.recheckorder | confirmRecheck | order.recheckOrder.confirmRecheck | POST | 是 | 否 | order.recheckorder/recheckOrder.ts | | -| order.recheckorder | queryRecheckOrderSingleList | order.recheckOrder.queryRecheckOrderSingleList | POST | 是 | 否 | order.recheckorder/recheckOrder.ts | | -| order.recheckorder | scanOrder | order.recheckOrder.scanOrder | POST | 是 | 否 | order.recheckorder/recheckOrder.ts | | -| order.recheckorder | scanTask | order.recheckOrder.scanTask | POST | 是 | 否 | order.recheckorder/recheckOrder.ts | | -| order.recheckorder | scanWaybill | order.recheckOrder.scanWaybill | POST | 否 | 否 | order.recheckorder/recheckOrder.ts | | -| order.recheckorder | updateExpressWeighingWeight | order.updateExpressWeighingWeight | POST | 否 | 否 | order.recheckorder/recheckOrder.ts | | -| order.revieworder | orderReviewOrderDetail | order.reviewOrder.detail | POST | 是 | 否 | order.revieworder/orderreviewOrder.ts | | -| order.revieworder | orderReviewOrderList | order.reviewOrder.list | POST | 是 | 否 | order.revieworder/orderreviewOrder.ts | | -| order.revieworder | orderReviewOrderReviewOrder | order.reviewOrder.reviewOrder | POST | 是 | 否 | order.revieworder/orderreviewOrder.ts | | -| order.wave | orderWaveBatchAllocateExpress | order.wave.batchAllocateExpress | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveBatchAllocateExpressTaskProgress | order.wave.batchAllocateExpressTaskProgress | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveBatchAllocateStorage | order.wave.batchAllocateStorage | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveBatchAllocateStorageTaskProgress | order.wave.batchAllocateStorageTaskProgress | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveBatchAutoGrouping | order.wave.batchAutoGrouping | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveBatchCancel | order.wave.batchCancel | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveBatchCancelTaskProgress | order.wave.batchCancelTaskProgress | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveBatchFinishAutoGrouping | order.wave.batchFinishAutoGrouping | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveBatchList | order.wave.batchList | POST | 否 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveBatchRemoveExceptionOrders | order.wave.batchRemoveExceptionOrders | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveBatchRemoveExceptionOrdersTaskProgress | order.wave.batchRemoveExceptionOrdersTaskProgress | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveBatchRemoveOrders | order.wave.batchRemoveOrders | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveFetch | order.wave.fetch | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveFetchTaskProgress | order.wave.fetchTaskProgress | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveGroupFetch | order.wave.groupFetch | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveGroupOrderFetchList | order.wave.groupOrderFetchList | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveSingleFetch | order.wave.singleFetch | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveSingleFetchByIds | order.wave.singleFetchByIds | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveSingleOrderFetchList | order.wave.singleOrderFetchList | POST | 否 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveWavePickTaskCancel | order.wave.wavePickTaskCancel | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveWavePickTaskCancelSelf | order.wave.wavePickTaskCancelSelf | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveWavePickTaskList | order.wave.wavePickTaskList | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveWaveStrategyCreate | order.wave.waveStrategyCreate | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveWaveStrategyFallbackOrderList | order.wave.waveStrategyFallbackOrderList | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveWaveStrategyFetchAdmin | order.wave.waveStrategyFetchAdmin | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveWaveStrategyFetchPda | order.wave.waveStrategyFetchPda | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveWaveStrategyList | order.wave.waveStrategyList | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveWaveStrategyQuickScan | order.wave.waveStrategyQuickScan | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveWaveStrategyQuickScanTaskProgress | order.wave.waveStrategyQuickScanTaskProgress | POST | 是 | 否 | order.wave/orderwave.ts | | -| order.wave | orderWaveWaveStrategyUpdate | order.wave.waveStrategyUpdate | POST | 是 | 否 | order.wave/orderwave.ts | | -| pick | pickQuery | pick.query | POST | 是 | 否 | pick/pick.ts | | -| pick | pickWavePickTaskComplete | pick.wavePickTaskComplete | POST | 是 | 否 | pick/pick.ts | | -| pick | pickWavePickTaskDetail | pick.wavePickTaskDetail | POST | 是 | 否 | pick/pick.ts | | -| pick | pickWavePickTaskSubmit | pick.wavePickTaskSubmit | POST | 是 | 否 | pick/pick.ts | | -| pickcart | pickCartBindTaskCart | pickCart.bindTaskCart | POST | 是 | 否 | pickcart/pickcart.ts | | -| pickcart | pickCartCodeDuplicateCheck | pickCart.codeDuplicateCheck | POST | 是 | 否 | pickcart/pickcart.ts | | -| pickcart | pickCartCreate | pickCart.create | POST | 是 | 否 | pickcart/pickcart.ts | | -| pickcart | pickCartDelete | pickCart.delete | POST | 是 | 否 | pickcart/pickcart.ts | | -| pickcart | pickCartDetail | pickCart.detail | POST | 是 | 否 | pickcart/pickcart.ts | | -| pickcart | pickCartList | pickCart.list | POST | 是 | 否 | pickcart/pickcart.ts | | -| pickcart | pickCartScan | pickCart.scan | POST | 是 | 否 | pickcart/pickcart.ts | | -| pickcart | pickCartUpdate | pickCart.update | POST | 是 | 否 | pickcart/pickcart.ts | | -| print | getExpressList | index.getExpressList | POST | 否 | 否 | print/print.ts | | -| print | add | print.add | POST | 是 | 否 | print/print.ts | | -| print | delItems | print.del | POST | 是 | 否 | print/print.ts | | -| print | getComputer | print.getComputer | POST | 是 | 否 | print/print.ts | | -| print | getComputerPrinter | print.getComputerPrinter | POST | 是 | 否 | print/print.ts | | -| print | getItem | print.getItem | POST | 是 | 否 | print/print.ts | | -| print | getList | print.getList | POST | 是 | 是 | print/print.ts | | -| print | getPrintRecordItem | print.getPrintRecordItem | POST | 是 | 否 | print/print.ts | | -| print | getPrintResult | print.getPrintResult | POST | 是 | 否 | print/print.ts | | -| print | hasName | print.hasName | POST | 是 | 否 | print/print.ts | | -| print | notify_lock | print.notify_lock | POST | 是 | 否 | print/print.ts | | -| print | notifyLock | print.notifyLock | POST | 是 | 否 | print/print.ts | | -| print | retryFailed | print.retryFailed | POST | 是 | 否 | print/print.ts | | -| print | savePrinters | print.savePrinters | POST | 是 | 否 | print/print.ts | | -| print | sendPrint | print.send | POST | 是 | 否 | print/print.ts | | -| print | updateItem | print.updateItem | POST | 是 | 否 | print/print.ts | | -| printer.station | createPrintComputer | printer.computer.create | POST | 否 | 否 | printer.station/printerstation.ts | | -| printer.station | deletePrintComputer | printer.computer.delete | POST | 否 | 否 | printer.station/printerstation.ts | | -| printer.station | listPrintComputers | printer.computer.list | POST | 否 | 否 | printer.station/printerstation.ts | | -| printer.station | updatePrintComputer | printer.computer.update | POST | 否 | 否 | printer.station/printerstation.ts | | -| printer.station | listPrinters | printer.device.list | POST | 否 | 否 | printer.station/printerstation.ts | | -| printer.station | bindPrinterToStation | printer.station.bind | POST | 否 | 否 | printer.station/printerstation.ts | | -| printer.station | createPrintStation | printer.station.create | POST | 否 | 否 | printer.station/printerstation.ts | | -| printer.station | deletePrintStation | printer.station.delete | POST | 否 | 否 | printer.station/printerstation.ts | | -| printer.station | printerStationList | printer.station.list | POST | 是 | 否 | printer.station/printerstation.ts | | -| printer.station | unbindPrinterFromStation | printer.station.unbind | POST | 否 | 否 | printer.station/printerstation.ts | | -| printer.station | updatePrintStation | printer.station.update | POST | 否 | 否 | printer.station/printerstation.ts | | -| setting.account | accountAdd | setting.account.add | POST | 是 | 否 | setting.account/account.ts | | -| setting.account | accountdelete | setting.account.delete | POST | 是 | 否 | setting.account/account.ts | | -| setting.account | getBindWechatCode | setting.account.getBindWechatCode | POST | 是 | 否 | setting.account/account.ts | | -| setting.account | accountList | setting.account.list | POST | 是 | 否 | setting.account/account.ts | | -| setting.account | accountResetPassword | setting.account.resetPassword | POST | 是 | 否 | setting.account/account.ts | | -| setting.account | unbindWechat | setting.account.unbindWechat | POST | 是 | 否 | setting.account/account.ts | | -| setting.account | accountUpdate | setting.account.update | POST | 是 | 否 | setting.account/account.ts | | -| setting.express | expressIndexGetExpressList | index.getExpressList | POST | 是 | 否 | setting.express/express.ts | | -| setting.express | expressCheckCodeUnique | setting.express.checkCodeUnique | POST | 是 | 否 | setting.express/express.ts | | -| setting.express | expressCreate | setting.express.create | POST | 是 | 否 | setting.express/express.ts | | -| setting.express | expressDelete | setting.express.delete | POST | 是 | 否 | setting.express/express.ts | | -| setting.express | expressList | setting.express.list | POST | 是 | 否 | setting.express/express.ts | | -| setting.express | expressListBase | setting.express.listBase | POST | 是 | 否 | setting.express/express.ts | | -| setting.express | expressUpdate | setting.express.update | POST | 是 | 否 | setting.express/express.ts | | -| setting.expressinterface | getPrintPlatformList | index.getPrintPlatformList | POST | 是 | 否 | setting.expressinterface/expressInterface.ts | | -| setting.expressinterface | expressInterfaceCreate | setting.expressInterface.create | POST | 是 | 否 | setting.expressinterface/expressInterface.ts | | -| setting.expressinterface | expressInterfaceDelete | setting.expressInterface.delete | POST | 是 | 否 | setting.expressinterface/expressInterface.ts | | -| setting.expressinterface | expressInterfaceList | setting.expressInterface.list | POST | 是 | 否 | setting.expressinterface/expressInterface.ts | | -| setting.expressinterface | expressInterfaceListByWarehousePlatformCode | setting.expressInterface.listByWarehousePlatformCode | POST | 是 | 否 | setting.expressinterface/expressInterface.ts | | -| setting.expressinterface | expressInterfaceUpdate | setting.expressInterface.update | POST | 是 | 否 | setting.expressinterface/expressInterface.ts | | -| setting.packagematerial | packageMaterialCreate | setting.packageMaterial.create | POST | 是 | 否 | setting.packagematerial/packagematerial.ts | | -| setting.packagematerial | packageMaterialDelete | setting.packageMaterial.delete | POST | 是 | 否 | setting.packagematerial/packagematerial.ts | | -| setting.packagematerial | packageMaterialGet | setting.packageMaterial.get | POST | 是 | 否 | setting.packagematerial/packagematerial.ts | | -| setting.packagematerial | packageMaterialList | setting.packageMaterial.list | POST | 是 | 否 | setting.packagematerial/packagematerial.ts | | -| setting.packagematerial | packageMaterialSearch | setting.packageMaterial.search | POST | 是 | 否 | setting.packagematerial/packagematerial.ts | | -| setting.packagematerial | packageMaterialUpdate | setting.packageMaterial.update | POST | 是 | 否 | setting.packagematerial/packagematerial.ts | | -| setting.packagesupplier | packageSupplierCreate | setting.packageSupplier.create | POST | 是 | 否 | setting.packagesupplier/packagesupplier.ts | | -| setting.packagesupplier | packageSupplierDelete | setting.packageSupplier.delete | POST | 是 | 否 | setting.packagesupplier/packagesupplier.ts | | -| setting.packagesupplier | packageSupplierGet | setting.packageSupplier.get | POST | 是 | 否 | setting.packagesupplier/packagesupplier.ts | | -| setting.packagesupplier | packageSupplierList | setting.packageSupplier.list | POST | 是 | 否 | setting.packagesupplier/packagesupplier.ts | | -| setting.packagesupplier | packageSupplierUpdate | setting.packageSupplier.update | POST | 是 | 否 | setting.packagesupplier/packagesupplier.ts | | -| setting.permission | permissionAdd | setting.permission.add | POST | 是 | 否 | setting.permission/permission.ts | | -| setting.permission | permissionDelete | setting.permission.delete | POST | 是 | 否 | setting.permission/permission.ts | | -| setting.permission | permissionList | setting.permission.list | POST | 是 | 否 | setting.permission/permission.ts | | -| setting.permission | permissionUpdate | setting.permission.update | POST | 是 | 否 | setting.permission/permission.ts | | -| setting.platform | settingPlatformIndexGetPlatformList | index.getPlatformList | POST | 是 | 否 | setting.platform/platform.ts | | -| setting.platform | settingPlatformCreate | setting.platform.create | POST | 是 | 否 | setting.platform/platform.ts | | -| setting.platform | settingPlatformDelete | setting.platform.delete | POST | 是 | 否 | setting.platform/platform.ts | | -| setting.platform | settingPlatformList | setting.platform.list | POST | 是 | 否 | setting.platform/platform.ts | 平台编码管理用 | -| setting.platform | settingPlatformUpdate | setting.platform.update | POST | 是 | 否 | setting.platform/platform.ts | | -| setting.printtemplate | addElement | setting.printTemplate.addElement | POST | 是 | 否 | setting.printtemplate/printTemplate.ts | | -| setting.printtemplate | createTemplate | setting.printTemplate.create | POST | 是 | 否 | setting.printtemplate/printTemplate.ts | | -| setting.printtemplate | deleteTemplate | setting.printTemplate.delete | POST | 是 | 否 | setting.printtemplate/printTemplate.ts | | -| setting.printtemplate | deleteElement | setting.printTemplate.deleteElement | POST | 是 | 否 | setting.printtemplate/printTemplate.ts | | -| setting.printtemplate | duplicateElement | setting.printTemplate.duplicateElement | POST | 是 | 否 | setting.printtemplate/printTemplate.ts | | -| setting.printtemplate | exportTemplateXml | setting.printTemplate.exportXml | POST | 是 | 否 | setting.printtemplate/printTemplate.ts | | -| setting.printtemplate | getTemplateDetail | setting.printTemplate.get | POST | 是 | 否 | setting.printtemplate/printTemplate.ts | | -| setting.printtemplate | importTemplateXml | setting.printTemplate.importXml | POST | 是 | 否 | setting.printtemplate/printTemplate.ts | | -| setting.printtemplate | listTemplates | setting.printTemplate.list | POST | 是 | 否 | setting.printtemplate/printTemplate.ts | | -| setting.printtemplate | listTemplatesByType | setting.printTemplate.listTemplatesByType | POST | 是 | 否 | setting.printtemplate/printTemplate.ts | | -| setting.printtemplate | saveTemplate | setting.printTemplate.save | POST | 是 | 否 | setting.printtemplate/printTemplate.ts | | -| setting.printtemplate | updateTemplate | setting.printTemplate.update | POST | 是 | 否 | setting.printtemplate/printTemplate.ts | | -| setting.printtemplate | updateElement | setting.printTemplate.updateElement | POST | 是 | 否 | setting.printtemplate/printTemplate.ts | | -| setting.role | roleAdd | setting.role.add | POST | 是 | 否 | setting.role/role.ts | | -| setting.role | roleDelete | setting.role.delete | POST | 是 | 否 | setting.role/role.ts | | -| setting.role | roleList | setting.role.list | POST | 是 | 否 | setting.role/role.ts | | -| setting.role | permissionroleList | setting.role.permission | POST | 是 | 否 | setting.role/role.ts | | -| setting.role | roleUpdate | setting.role.update | POST | 是 | 否 | setting.role/role.ts | | -| setting.warehouse | settingWarehouseGetFieldMeta | setting.warehouse.getFieldMeta | POST | 是 | 否 | setting.warehouse/settingwarehouse.ts | | -| setting.warehouse | settingWarehouseGetSettings | setting.warehouse.getSettings | POST | 是 | 否 | setting.warehouse/settingwarehouse.ts | | -| setting.warehouse | settingWarehouseSaveSettings | setting.warehouse.saveSettings | POST | 是 | 否 | setting.warehouse/settingwarehouse.ts | | -| shops | shopGetAuthorizeSessionKey | shop.GetAuthorizeSessionKey | POST | 否 | 否 | shops/shops.ts | | -| shops | shopsAdd | shops.add | POST | 是 | 否 | shops/shops.ts | | -| shops | shopsDel | shops.del | POST | 是 | 否 | shops/shops.ts | | -| shops | shopsEdit | shops.edit | POST | 是 | 否 | shops/shops.ts | | -| shops | shopGetAuthorizeSessionKey | shops.GetAuthorizeSessionKey | POST | 是 | 否 | shops/shops.ts | | -| shops | shopsList | shops.list | POST | 是 | 否 | shops/shops.ts | | -| stock | stockStockWarehouse | stock.stockWarehouse | POST | 是 | 否 | stock/stock.ts | | -| stock | backData | stock.warehouse.backData | POST | 是 | 否 | stock/stock.ts | | -| stock | bindItem | stock.warehouse.bindItem | POST | 是 | 否 | stock/stock.ts | | -| stock | checkItemCodeUnique | stock.warehouse.checkItemCodeUnique | POST | 是 | 否 | stock/stock.ts | | -| stock | createProhibited | stock.warehouse.createProhibited | POST | 是 | 否 | stock/stock.ts | | -| stock | createUnit | stock.warehouse.createUnit | POST | 是 | 否 | stock/stock.ts | | -| stock | createWarehouseStock | stock.warehouse.createWarehouseStock | POST | 是 | 否 | stock/stock.ts | | -| stock | deleteProhibited | stock.warehouse.deleteProhibited | POST | 是 | 否 | stock/stock.ts | | -| stock | deleteUnit | stock.warehouse.deleteUnit | POST | 是 | 否 | stock/stock.ts | | -| stock | exportStockWarehouse | stock.warehouse.export | POST | 是 | 否 | stock/stock.ts | | -| stock | getExportTaskProgress | stock.warehouse.exportTaskProgress | POST | 是 | 否 | stock/stock.ts | | -| stock | getBarcodes | stock.warehouse.getBarcodes | POST | 是 | 否 | stock/stock.ts | | -| stock | getBoxUnits | stock.warehouse.getBoxUnits | POST | 否 | 否 | stock/stock.ts | | -| stock | getInfo | stock.warehouse.getInfo | POST | 是 | 否 | stock/stock.ts | | -| stock | getProhibitedList | stock.warehouse.getProhibitedList | POST | 是 | 否 | stock/stock.ts | | -| stock | getProhibitedType | stock.warehouse.getProhibitedType | POST | 是 | 否 | stock/stock.ts | | -| stock | getStockDetail | stock.warehouse.getStockDetail | POST | 是 | 否 | stock/stock.ts | | -| stock | getStockUnits | stock.warehouse.getStockUnits | POST | 是 | 否 | stock/stock.ts | | -| stock | getStoreStocks | stock.warehouse.getStoreStocks | POST | 是 | 否 | stock/stock.ts | | -| stock | getUnitList | stock.warehouse.getUnitList | POST | 是 | 否 | stock/stock.ts | | -| stock | handleBatchChange | stock.warehouse.handleBatchChange | POST | 是 | 否 | stock/stock.ts | | -| stock | handleBatchDelete | stock.warehouse.handleBatchDelete | POST | 是 | 否 | stock/stock.ts | | -| stock | importStockWarehouse | stock.warehouse.import | POST | 是 | 否 | stock/stock.ts | | -| stock | stockWarehouse | stock.warehouse.list | POST | 是 | 否 | stock/stock.ts | | -| stock | queryStockLogs | stock.warehouse.queryStockLogs | POST | 是 | 否 | stock/stock.ts | | -| stock | saveWarehouseStock | stock.warehouse.saveWarehouseStock | POST | 是 | 否 | stock/stock.ts | | -| stock | saveWarehouseStockBarcode | stock.warehouse.saveWarehouseStockBarcode | POST | 是 | 否 | stock/stock.ts | | -| stock | warehouseSearch | stock.warehouse.search | POST | 是 | 否 | stock/stock.ts | | -| stock | unbindItem | stock.warehouse.unbindItem | POST | 是 | 否 | stock/stock.ts | | -| storage_receiving | quickPutaway | storage.inventory.quickPutaway | POST | 是 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | addDetail | storage.receiving.addDetail | POST | 否 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | addItem | storage.receiving.addItem | POST | 否 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | batchCancelReceiving | storage.receiving.batchCancelReceiving | POST | 是 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | bindDetailProduct | storage.receiving.bindDetailProduct | POST | 是 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | bindReceivingStore | storage.receiving.bindStore | POST | 是 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | cancelReceivingDetail | storage.receiving.cancel | POST | 否 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | completeReceiving | storage.receiving.completeReceiving | POST | 是 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | createReceiving | storage.receiving.create | POST | 是 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | deleteDetail | storage.receiving.deleteDetail | POST | 否 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | detailChange | storage.receiving.detailChange | POST | 否 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | exportReceiving | storage.receiving.exportReceiving | POST | 否 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | getReceiving | storage.receiving.get | POST | 否 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | getAvailableInboundQuantity | storage.receiving.getAvailableInboundQuantity | POST | 是 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | getReceivingDetail | storage.receiving.getReceivingDetail | POST | 是 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | getReceivingList | storage.receiving.getReceivingList | POST | 是 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | getReceivingProduct | storage.receiving.getReceivingProduct | POST | 否 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | manualMatchEntryOrder | storage.receiving.manualMatchEntryOrder | POST | 是 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | queryReceivingLogs | storage.receiving.queryReceivingLogs | POST | 是 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | rejectReceiving | storage.receiving.rejectReceiving | POST | 是 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | removeItem | storage.receiving.removeItem | POST | 否 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | reviewReceiving | storage.receiving.reviewReceiving | POST | 是 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | save | storage.receiving.save | POST | 是 | 否 | storage_receiving/receiving.ts | | -| storage_receiving | saveReceiving | storage.receiving.saveReceiving | POST | 否 | 否 | storage_receiving/receiving.ts | | -| storage.entry | bindReceivingDetails | storage.entry.bindReceivingDetails | POST | 是 | 否 | storage.entry/entry.ts | | -| storage.entry | cancelEntry | storage.entry.cancel | POST | 是 | 否 | storage.entry/entry.ts | | -| storage.entry | completeEntry | storage.entry.completeEntry | POST | 是 | 否 | storage.entry/entry.ts | | -| storage.entry | getEntryDetail | storage.entry.get | POST | 是 | 否 | storage.entry/entry.ts | | -| storage.entry | getEntryList | storage.entry.list | POST | 是 | 否 | storage.entry/entry.ts | | -| storage.entry | unbindReceivingDetails | storage.entry.unbindReceivingDetails | POST | 是 | 否 | storage.entry/entry.ts | | -| storage.inventory | getExpiryList | storage.expiry.list | POST | 是 | 否 | storage.inventory/inventory.ts | | -| storage.inventory | getInventoryList | storage.inventory.list | POST | 是 | 否 | storage.inventory/inventory.ts | | -| storage.inventory | matchPutaway | storage.inventory.matchPutaway | POST | 是 | 否 | storage.inventory/inventory.ts | | -| storage.inventory | quickPutaway | storage.inventory.quickPutaway | POST | 是 | 否 | storage.inventory/inventory.ts | | -| storage.inventory | transaction | storage.inventory.transaction | POST | 否 | 否 | storage.inventory/inventory.ts | | -| storage.inventory | transferByProduct | storage.inventory.transferByProduct | POST | 是 | 否 | storage.inventory/inventory.ts | | -| storage.inventory | transferLocation | storage.inventory.transferLocation | POST | 是 | 否 | storage.inventory/inventory.ts | | -| storage.inventory | getTransactionList | storage.transaction.list | POST | 是 | 否 | storage.inventory/inventory.ts | | -| storage.management | getReplenishmentDemand | storage.management.replenishmentDemand | POST | 是 | 否 | storage.management/management.ts | | -| storage.report | exportInventoryReport | storage.report.export | POST | 是 | 否 | storage.report/report.ts | | -| storage.report | getExportTaskProgress | storage.report.exportTaskProgress | POST | 是 | 否 | storage.report/report.ts | | -| storage.report | searchInventoryReport | storage.report.search | POST | 是 | 否 | storage.report/report.ts | | -| storage.stockout | stockoutList | storage.stockout.list | POST | 是 | 否 | storage.stockout/stockout.ts | | -| storage.stockout | stockoutListItems | storage.stockout.listItems | POST | 是 | 否 | storage.stockout/stockout.ts | | -| storage.stockout | stockoutToOrder | storage.stockout.toOrder | POST | 是 | 否 | storage.stockout/stockout.ts | | -| store | auditApply | store.auditApply | POST | 是 | 否 | store/store.ts | | -| store | createStore | store.createStore | POST | 是 | 否 | store/store.ts | | -| store | createWarehouse | store.createWarehouse | POST | 是 | 否 | store/store.ts | | -| store | getStoreRoles | store.getStoreRoles | POST | 是 | 否 | store/store.ts | | -| store | joinStore | store.joinStore | POST | 是 | 否 | store/store.ts | | -| store | joinWarehouse | store.joinWarehouse | POST | 是 | 否 | store/store.ts | | -| storewarehouse.store | storeWarehouseAdjustPrintQuantity | storeWarehouse.store.adjustPrintQuantity | POST | 是 | 否 | storewarehouse.store/storeWarehouse.ts | | -| storewarehouse.store | storeWarehouseDeleteQimenConfig | storeWarehouse.store.deleteQimenConfig | POST | 是 | 否 | storewarehouse.store/storeWarehouse.ts | | -| storewarehouse.store | storeWarehouseGetPolicyConfig | storeWarehouse.store.getPolicyConfig | POST | 是 | 否 | storewarehouse.store/storeWarehouse.ts | | -| storewarehouse.store | storeWarehouseGetPolicyConfigFields | storeWarehouse.store.getPolicyConfigFields | POST | 是 | 否 | storewarehouse.store/storeWarehouse.ts | | -| storewarehouse.store | storeWarehouseList | storeWarehouse.store.list | POST | 是 | 否 | storewarehouse.store/storeWarehouse.ts | | -| storewarehouse.store | listApiConfig | storeWarehouse.store.listApiConfig | POST | 是 | 否 | storewarehouse.store/storeWarehouse.ts | | -| storewarehouse.store | storeWarehouseOpenAccount | storeWarehouse.store.openAccount | POST | 是 | 否 | storewarehouse.store/storeWarehouse.ts | | -| storewarehouse.store | storeWarehouseQueryPrintQuantityLogs | storeWarehouse.store.queryPrintQuantityLogs | POST | 是 | 否 | storewarehouse.store/storeWarehouse.ts | | -| storewarehouse.store | storeWarehouseRename | storeWarehouse.store.rename | POST | 是 | 否 | storewarehouse.store/storeWarehouse.ts | | -| storewarehouse.store | saveApiConfig | storeWarehouse.store.saveApiConfig | POST | 是 | 否 | storewarehouse.store/storeWarehouse.ts | | -| storewarehouse.store | storeWarehouseSavePolicyConfig | storeWarehouse.store.savePolicyConfig | POST | 是 | 否 | storewarehouse.store/storeWarehouse.ts | | -| storewarehouse.store | storeWarehouseSign | storeWarehouse.store.sign | POST | 是 | 否 | storewarehouse.store/storeWarehouse.ts | | -| storewarehouse.store | storeWarehouseUnbind | storeWarehouse.store.unbind | POST | 是 | 否 | storewarehouse.store/storeWarehouse.ts | | -| user | changeRole | user.changeRole | POST | 是 | 否 | user/user.ts | | -| user | getBindWechatCode | user.getBindWechatCode | POST | 是 | 否 | user/user.ts | | -| user | getLoginWechatCode | user.getLoginWechatCode | POST | 是 | 否 | user/user.ts | | -| user | getInfo | user.info | POST | 是 | 否 | user/user.ts | | -| user | login | user.login | POST | 是 | 否 | user/user.ts | | -| user | loginByCode | user.loginByCode | POST | 是 | 否 | user/user.ts | | -| user | logout | user.logout | POST | 是 | 否 | user/user.ts | | -| user | register | user.register | POST | 是 | 否 | user/user.ts | | -| user | unbindWechat | user.unbindWechat | POST | 是 | 否 | user/user.ts | | -| warehouse | batchUpdateSpaceInfo | warehouse.batchUpdateSpaceInfo | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | checkBarcodeUnique | warehouse.checkBarcodeUnique | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | checkConnectivity | warehouse.checkConnectivity | POST | 否 | 否 | warehouse/warehouse.ts | | -| warehouse | create | warehouse.create | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | createRack | warehouse.createRack | POST | 否 | 否 | warehouse/warehouse.ts | | -| warehouse | createRackWithSpaces | warehouse.createRackWithSpaces | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | deleteZone | warehouse.delete | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | detail | warehouse.detail | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | exportRackSpaces | warehouse.exportRackSpaces | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | getAreaRacks | warehouse.getAreaRacks | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | getChildren | warehouse.getChildren | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | getPath | warehouse.getPath | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | getPickPath | warehouse.getPickPath | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | getSpaceInfo | warehouse.getSpaceInfo | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | getSpacesByRack | warehouse.getSpacesByRack | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | getWarehouseTree | warehouse.getWarehouseTree | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | getWarehouseZones | warehouse.getWarehouseZones | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | recalculatePickPath | warehouse.recalculatePickPath | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | toggleActive | warehouse.toggleActive | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | update | warehouse.update | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | updateNeighbors | warehouse.updateNeighbors | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | updateRackPosition | warehouse.updateRackPosition | POST | 是 | 否 | warehouse/warehouse.ts | | -| warehouse | updateSpaceInfo | warehouse.updateSpaceInfo | POST | 是 | 否 | warehouse/warehouse.ts | | diff --git a/workflows/api-doc-agent/docs/修改接口.md b/workflows/api-doc-agent/docs/修改接口.md deleted file mode 100644 index 746a16ad..00000000 --- a/workflows/api-doc-agent/docs/修改接口.md +++ /dev/null @@ -1,83 +0,0 @@ -# 修改接口(Agent 自动执行工作流) - -当用户输入 `更新接口`,Agent 必须全自动执行本流程,完成后端接口变更到前端 `src/api` 的对齐更新,无需用户干预。 - -## 0. 模式开关(先检查) - -1. 读取 `workflows/api-doc-system/system/workflow-mode.json`。 -2. 若 `mode=test`,只输出:`测试更新接口`,然后立即结束。 -3. 只有 `mode=work` 才执行后续所有动作。 - -## 1. 核心数据源 - -- 前端 API 目录:`src/api` -- 待更新清单:`workflows/api-doc-system/data/pending-updates.json` -- 模块总览:`workflows/api-doc-system/data/module-list/module-list.json` -- 模块明细:`workflows/api-doc-system/data/module//module.json` -- 接口维护表:`workflows/api-doc-agent/config/接口.md` - -## 1.1 最小读取范围(必须遵守) - -1. 禁止全量读取 `src/api`、`data/module`、`data/interface-details`、`workflows` 下所有文件。 -2. 仅允许按“变更驱动”读取: - - 固定必读:`workflow-mode.json`、`pending-updates.json`、`module-list.json` - - 按需选读:`workflows/api-doc-system/data/module//module.json`(只读取本次涉及 folder) - - 按需选读:`src/api//...`(只读取本次涉及模块的文件) - - 条件读取:`workflows/api-doc-agent/config/接口.md`(仅在存在删除项或软删除处理时读取) -3. 若 `pending-updates.json` 已给出 `interfaceUpdates`,禁止再遍历读取无关模块文件。 -4. 任何“扫描全部文件/目录”行为均视为违规(包括为了“确认一下”而做的全量读取)。 -5. **例外(仅用于 §4 校验)**:允许(1)列出 `src/api` **一级子目录名**;(2)对工作区内 `src/api` 做按字面量 `method:` 的搜索。不得借机通读无关 `.ts` 全文。 - -## 1.2 模块目录强制对齐(与 `module-list` / `module` 一致) - -**目标**:`src/api` 的「模块」= `src/api` 下一级子目录;其**个数与命名**必须与远端清洗结果一致,且**双向一一对应** `module-list.json` 中的文档模块。 - -1. **权威集合 `M`**:从 `module-list.json` 的 `modules` 数组提取全部 **`folder` 字段**,去重得到集合 `M`。正常情况下 `moduleCount === |M|`,且 `src/api` 应对齐到该 `|M|`。若元数据中 `moduleCount` 与去重后的 `|M|` 不一致,以 `workflows/api-doc-system/data/module/` 下**实际存在的子目录名**为准构造 `M`,并在 §5 结果中注明 `module-list` 元数据异常。 -2. **强制数量**:`src/api` 下**一级子目录的个数**必须等于 `moduleCount`(即等于 `|M|`),**禁止**多一个、少一个。 -3. **强制命名**:每个一级目录名必须与 `M` 中对应项 **字符串完全一致**(含大小写、点号)。**禁止**使用与 `folder` 不同的大小写变体(如文档为 `setting.printtemplate` 则目录名必须为 `setting.printtemplate`,不得长期保留 `setting.printTemplate` 等别名;在 Windows 上重命名需必要时经临时名两阶段改名,避免仅大小写变更失败)。 -4. **双向对应**: - - 对任意 `f ∈ M`,必须存在目录 `src/api//`(且内含至少一个 `.ts` 作为该模块 API 入口层,文件名按项目既有约定即可)。 - - 对任意 `src/api` 下一级目录 `d`,必须满足 `d ∈ M`;**禁止**出现文档中不存在的杂项目录(例如历史上合并用的裸 `order/` 若不在 `M` 中则必须迁出并删除空目录)。 -5. **接口归属**:`data/module//module.json` 中列出的每个接口,其 **`method` 的封装实现必须位于 `src/api//` 下的 `.ts` 文件内**(`params` 等与 `module.json` 一致)。**禁止**把某 `folder` 文档模块下的接口长期写在另一个 `folder` 目录下(例如某接口在文档中归在 `setting.express`,则不得仅写在 `index/` 下;应放在 `src/api/setting.express/` 或按项目规范再分子路径,但首段目录名仍为 `setting.express`)。 -6. **迁出合并代码**:若发现多个文档 `folder` 的接口被写在同一历史文件(如 `order/order.ts`),必须按 `folder` **拆分目录与文件**,并同步修正业务侧 `import`(至少全局检索旧路径并更新到 `src/api//...`)。 -7. **`接口.md` 的「模块数」**:在遵守本条后,扫描脚本按路径首段聚合的「模块数」**应与 `moduleCount` 一致**;若仍不一致,视为目录命名或残留非法目录未清干净,**不算完成**。 - -## 2. 自动执行步骤(严格顺序) - -1. 读取 `pending-updates.json`。 -2. 若 `pending-updates.json` 为 `{}`,先执行 `npm run apiconfig`。 -3. 读取 `module-list.json`,构造集合 `M`(见 §1.2),并列出 `src/api` 当前一级子目录集合 `D`(允许使用 §1.1 第 5 条的目录列举)。若 `D ≠ M`(元素或数量不一致),**必须先**完成目录级对齐:新建缺失的 `src/api//`、将误放接口迁回对应 ``、删除或改名不在 `M` 中的目录,直至 `D = M`;再处理接口级增删改。 -4. 若 `pending-updates.json` 存在变更项(接口增删、`Params/Response` 变化),按“增删优先”原则更新 `src/api`: - - 新增/更新:只读对应 `folder` 的 `module.json` 中本次涉及条目(含 Params),**仅在** `src/api//` 下增改 `.ts`。 - - 删除:不硬删除代码;仅在 `config/接口.md` 标记 `启用=否`(仅处理命中 method)。 -5. 若 `pending-updates.json` 为 `{}` 且 `npm run apiconfig` 后仍为 `{}`,仍须执行 §4 的**目录集合 + method 归属**校验(§1.1 第 5 条)。 -6. 完成接口改动后,执行 `npm run apiagent -- --script api-list-update`。 -7. 在 §5 结果输出中给出:`M` 与对齐前 `D` 的差异摘要;若有 **method 未出现在其 `folder` 目录下** 的项,逐条列出(视为未完成直至修复)。 - -## 3. `config/接口.md` 维护规则(必须遵守) - -- `启用`、`占位`、`备注` 三列属于人工维护字段,更新脚本不得覆盖。 -- 新增接口默认值: - - `启用=是` - - `占位=否` -- 删除的接口/模块不做硬清理,统一通过 `config/接口.md` 中 `启用=否` 标记软删除,便于后续恢复。 - -## 4. 完成判定 - -以下条件**同时**满足才算完成(**强制目录与 module 一致**,见 §1.2): - -1. **目录集合一致**:`src/api` 一级子目录名构成的集合与 `module-list` 导出的集合 `M` **完全相等**;`src/api` 子目录个数 **=** `moduleCount`。 -2. **接口归属一致**:对每个 `folder ∈ M`,`data/module//module.json` 中的每个 `method` 要么(a)在 `src/api//` 下某 `.ts` 中出现对应封装,要么(b)已按 §3 在 `接口.md` 中对同一 `method` 标记为禁用;Params 等与文档一致(无文档 Params 时可为空对象或合理宽类型)。 -3. **无跨目录挂靠**:任一启用接口的 `method` 字符串,其所在文件路径的首段目录名必须等于该接口所属文档的 `folder`(与 §1.2 第 5 条一致)。 -4. `npm run apiagent -- --script api-list-update` 执行成功,且输出中的「模块数」**等于** `moduleCount`(否则继续清理非法目录或错误命名直至一致)。 -5. `pending-updates.json` 已被清空为 `{}`(在确认第 1~4 条已满足后执行 `npm run apiconfig:clear-pending`)。 - -## 5. 结果输出 - -返回以下信息: - -- 更新统计:`pending` / `module-list.changes` 中的模块变更数量、接口变更数量 -- **目录对齐**:对齐前 `D` 与目标集合 `M` 的差集(多目录、少目录、命名不一致项);对齐后确认 `D = M` -- 实际改动文件:`src/api/...` 及因迁目录而改动的 `import` 路径(若有) -- 异常列表:`method` 未出现在其 `folder` 目录下、Params 明显不一致、或 `接口.md`「模块数」≠ `moduleCount` 的项(若有) -- 收尾结果:`api-list-update` 与 `clear-pending` 执行状态 diff --git a/workflows/api-doc-agent/docs/测试.md b/workflows/api-doc-agent/docs/测试.md deleted file mode 100644 index 0045495a..00000000 --- a/workflows/api-doc-agent/docs/测试.md +++ /dev/null @@ -1,168 +0,0 @@ -# WMS 自动化测试工作流(Agent 自动执行工作流) - -当用户输入 `测试[目标页面]`,Agent 必须全自动执行本流程,完成目标页面各功能的测试并输出测试报告,无需用户干预。 - -专项触发词:当用户输入 `测试波次管理`,Agent 必须自动执行“波次管理专项测试”(见下文第六节),覆盖 `团购波次`、`散单波次`、`拣货中任务` 三个页面。 - -## 一、 测试上下文基准 (Context Baseline) - -项目类型: 基于 Vue3 + Vite + TypeScript 的 WMS 前端系统。 -路由模式: 动态路由。 -说明:此工作流仅对项目进行测试并根据测试结果输出测试报告,不涉及任何针对项目代码的修改。禁止任何对项目代码的修改操作。 -目的:测试接口后端是否可用、前端对接口的使用是否有问题、通过测试排查出请求/响应有更新但前端未更新的接口功能等。 - - -依赖参考 -- 前端 API 目录:`src/api` -- 前端 公共组件目录:`src/components` -- 前端 路由目录:`src/router` -- 前端 页面框架目录:`src/layout` -- 前端 页面目录:`src/views` -- 前端 状态管理目录:`src/stores` -- 前端 组合式逻辑目录:`src/composables` -- 前端 工具方法目录:`src/utils` -- 前端 语言包目录:`src/lang` -- 后端 接口文档:`workflows/api-doc-system/data/module` - -波次管理关键文件(测试优先参考): -- 波次 API:`src/api/order.wave/orderwave.ts` -- 团购波次:`src/views/order/waveOrder/GroupWaveBatchListPanel.vue` -- 散单波次:`src/views/order/waveOrder/SandanWaveBatchListPanel.vue` -- 拣货中任务:`src/views/order/waveOrder/WavePickTaskListPanel.vue` -- 波次配置:`src/views/order/waveOrder/config/wave-config.ts` - -页面/标签页基础结构: -- 主入口一般为 `index.vue` 或标签页组件(如 `GroupWaveBatchListPanel.vue`、`SandanWaveBatchListPanel.vue`、`WavePickTaskListPanel.vue`)。 -- `config` 配置文件管理 `scan-box` 筛选条件、`upper-table` 列配置及工具栏按钮。 - - -## 二、 环境引导 (Environment Setup) - -前置条件: -确认本地开发服务器已运行 (npm run dev)。 - -访问规则: -基准路径:http://localhost:5174 -登录账号: -"username": "yjm", -"password": "111111" - - -## 三、 测试任务定义 (Task Definition) - -路径导航: 按照路由表进入目标页面。 -UI 完整性检查: 验证核心按钮(如“入库确认”、“打印标签”)是否按权限加载。 - -基础数据显示:检查目标页面upper-table是否有正常获取数据并显示,表格哪些状态字段数据显示为英文而不是翻译字段(如"订单状态"显示'pedding'而不是'待审核')。 - -筛选条件测试:测试各筛选条件能否正常使用获取符合筛选条件的数据,将不可用或筛选结果包含非筛选条件数据的问题筛选进行记录。 - -- 功能测试: 根据页面按钮和接口信息分别测试页面各功能。 -1、请求测试:发起请求后,根据接口文档检查该功能请求的传参是否符合接口文档的要求。 -2、后端功能测试:根据响应结果判断后端该接口服务是否可用,区分后端接口不可用与前端请求传参错误导致的失败。 -3、根据接口设计,刷新页面或刷新相关数据表单,查看功能是否被应用/添加。 -4、检查项目是否符合接口响应设计,统计项目响应设计与接口响应数据、设计有不符的接口。 - - -异常捕获: 记录 Console Error 或 4xx/5xx 错误。 - - -## 四、 断言与逻辑校验 (Assertions) - -视觉断言: 提交后是否出现 ElMessage.success 或预期的跳转。 -业务断言: 操作后页面状态(如单据状态位)是否发生预期更新。 - - -## 五、 报告生成标准 (Reporting Specification) - -规定测试结果的输出格式。 -报告标题: [TEST_REPORT] - {模块名} - {时间} - -核心板块: -Test Summary: 成功/失败总览。 -API Compliance: 实际请求与接口文档的匹配程度(字段缺失、类型错误等)。 -Issue Logs: 发现的 Bug 描述及复现建议。 - -最小必填字段: -- 通过测试的接口:按页面分组列出 `method`、请求摘要、通过结论。 -- 问题接口:按严重级别列出 `method`、失败类型(前端参数/后端异常/文档不一致/响应兼容问题)、证据摘要。 -- 页面功能通过率:页面维度统计(通过项 / 总项)。 -- 复现步骤:问题接口对应的最短复现路径。 -- 修复建议:对前端或后端的最小改动建议。 - ---- - -## 六、 波次管理专项测试(触发词:`测试波次管理`) - -### 6.1 执行目标(必须全量覆盖) - -当输入 `测试波次管理` 时,默认目标页面固定为: -1. 团购波次(`GroupWaveBatchListPanel`) -2. 散单波次(`SandanWaveBatchListPanel`) -3. 拣货中任务(`WavePickTaskListPanel`) - -### 6.2 自动执行步骤(严格顺序) - -1. 启动前检查: - - 确认本地服务可访问(`http://localhost:5174`)。 - - 使用文档中的账号完成登录。 -2. 逐页面执行测试(按“团购波次 -> 散单波次 -> 拣货中任务”顺序): - - 页面加载:检查首屏渲染、表格数据加载、分页是否可用。 - - 筛选能力:至少验证 3 类筛选(文本、枚举、数值区间)并校验结果一致性。 - - 核心功能按钮:逐个触发并记录调用接口、请求参数、响应状态与页面回显。 - - 异常链路:对可预期异常场景(空选择、非法条件、任务未完成)进行校验。 -3. 接口核对: - - 以 `src/api/order.wave/orderwave.ts` 的接口封装为基准,映射本次实际触发接口。 - - 对照接口文档检查参数与响应结构兼容性。 -4. 归因分类: - - 前端问题:参数拼装错误、字段名不匹配、状态映射错误、UI 未按响应更新。 - - 后端问题:5xx、业务报错、返回结构缺失或类型不符合约定。 - - 文档问题:接口文档与实际行为不一致。 -5. 输出报告: - - 必须输出“通过测试的接口”和“问题接口”两大清单(见 6.3)。 - -### 6.3 波次管理报告模板(必须使用) - -报告标题: -`[TEST_REPORT] - 波次管理 - {YYYY-MM-DD HH:mm:ss}` - -1) Test Summary -- 页面覆盖:团购波次 / 散单波次 / 拣货中任务(3/3) -- 功能点通过率:{passed}/{total} -- 接口通过率:{api_passed}/{api_total} - -2) Passed APIs(通过测试的接口) -- 页面:{页面名} -- method:`xxx.xxx.xxx` -- 请求校验:通过/不通过(说明) -- 响应校验:通过/不通过(说明) -- 最终结论:通过 - -3) Problem APIs(问题接口) -- 严重级别:P0/P1/P2 -- 页面:{页面名} -- method:`xxx.xxx.xxx` -- 问题类型:前端问题 / 后端问题 / 文档不一致 -- 现象:{错误码、报错信息、页面表现} -- 复现步骤:{最短步骤} -- 期望结果:{按文档或业务预期} -- 实际结果:{当前表现} -- 建议处理:{前端/后端/文档修正建议} - -4) API Compliance -- 参数不一致接口:{数量与列表} -- 响应不一致接口:{数量与列表} -- 向后兼容风险:{有/无,说明} - -5) Issue Logs -- Console Error 摘要 -- 4xx/5xx 请求清单 -- 关联页面与操作路径 - -### 6.4 完成判定 - -满足以下条件才算完成: -1. 三个页面均已执行测试并有结果记录。 -2. 报告中包含“通过测试的接口”与“问题接口”两个清单。 -3. 每个问题接口均包含可复现步骤与归因分类。 -4. 给出接口维度与页面维度的通过率统计。 \ No newline at end of file diff --git a/workflows/api-doc-system/README.md b/workflows/api-doc-system/README.md deleted file mode 100644 index b71cd9fe..00000000 --- a/workflows/api-doc-system/README.md +++ /dev/null @@ -1,151 +0,0 @@ -# API Doc System Workflow - -该工作流用于抓取 `system` API 文档页面,按 `platform=网页端(web)`、`project=全部(all)` 条件进行校验后,清洗输出模块与接口数据。 - -## 目录结构 - -- `core/`: 核心实现目录(`config.mjs`、`update.mjs`、`clear-pending.mjs`)。 -- `scripts/`: 脚本入口目录(`update.mjs`、`clear-pending.mjs`、`apidata.mjs`)。 -- `system/`: 系统模式配置目录(如 `workflow-mode.json`)。 -- `config.mjs`: 兼容转发入口(实际定义位于 `core/config.mjs`)。 -- `scripts/agent/`: 从 `api-doc-agent` 迁移的 Agent 脚本(`run.mjs`、`api-list-update`、`interface-availability`)。 -- `data/`: 数据目录,按功能分类存放产物。 - - `data/module//module.json`: 模块接口明细(覆盖更新)。 - - `data/module-list/module-list.json`: 模块总览(覆盖更新)。 - - `data/interface-details/interface-details.json`: 全量接口明细(覆盖更新)。 - - `data/pending-updates.json`: 待更新文件(模块变化 + 接口变化)。 - -## 运行 - -```bash -npm run apiconfig -``` - -如需清空待更新接口文件,可执行: - -```bash -npm run apiconfig:clear-pending -``` - -执行前会先检查 `pending-updates.json`: - -- 若文件内容不是 `{}`(存在未处理项),脚本会输出: - - `请先处理待更新接口再更新接口信息!` -- 并终止本次执行,不更新其他产物。 - -## Apidata 抓取脚本 - -新增 `apidata` 请求脚本,用于按配置发起接口请求并写入响应结果(支持提取登录 token)。 - -运行命令: - -```bash -npm run apiconfig:apidata -``` - -配置文件:`workflows/api-doc-system/apidata/config.json` - -- `config.json` 仅存放待请求接口配置(不存放爬虫地址、版本等信息)。 -- `requests`: 请求列表 - - `method`: 接口 method(会拼接到 `?method=xxx`) - - `body`: 请求 JSON(可省略,默认 `{}`) - - `needAuth`: 是否携带登录 token(可省略;除 `user.login` 外默认 `true`) -- 脚本内部固定请求地址:`http://192.168.11.56:6060/system?v=1.0`。 -- 脚本默认携带请求头:`platform: web`、`project: all`。 - -示例配置(登录获取 token): - -```json -{ - "requests": [ - { - "method": "user.login", - "body": { - "username": "yjm", - "password": "111111" - } - }, - { - "method": "order.list", - "body": {} - }, - { - "method": "order.manualOutboundOrder", - "body": {} - }, - { - "method": "order.badgeCount", - "body": {} - } - ] -} -``` - -说明: - -- 脚本会按 `requests` 顺序串行执行。 -- 当某次响应中包含 `data.token`(如 `user.login`)时,后续 `needAuth=true` 的接口会自动携带 `Authorization: Bearer `。 - -数据文件:`workflows/api-doc-system/apidata/data.json` - -- 每次执行会先清空该文件,再写入本次抓取结果。 -- 输出结构为数组项:`{ 接口, message, data }`。 -- 同步更新:`workflows/api-doc-agent/config/响应.md`(写入本次结果)。 - -如需改抓取地址,可临时指定: - -```bash -API_DOC_URL=http://192.168.11.56:6060/api/docs/system npm run apiconfig -``` - -Agent 脚本入口: - -```bash -npm run apiagent -- --script list -``` - -## 输出说明(去历史回档) - -- 模块文件包含当前模块全部接口信息(接口名、描述、Headers、Params、Response 等)。 -- `module` 是最新接口信息的主数据源,每次执行 `npm run apiconfig` 都会覆盖更新 `module.json`。 -- 每个模块快照新增 `changes.fromPreviousSnapshot` 字段,记录本模块相对上一快照的: - - 模块是否新增/重命名 - - 接口新增/删除 - - 接口 `params` 更新 - - 接口 `response` 更新 -- 模块总览文件仅保留每个模块的精简接口清单: - - `method` -- `module-list/module-list.json` 每次执行覆盖更新,避免每日堆积快照文件。 -- `module-list` 与 `interface-details` 均新增 `changes` 字段,统一汇总模块与接口变化统计: - - `moduleUpdates.added / deleted / updated` - - `interfaceUpdates.added / deleted / paramsUpdated / responseUpdated` -- 接口明细文件包含当前项目所有接口信息,并带状态字段: - - `status.isUsed`: 是否使用(默认 `false`) - - `status.isPlaceholder`: 是否占位(默认 `false`) -- 状态会优先继承 `module` 目录最近快照中的状态,避免每次执行覆盖人工维护状态。 -- 脚本输出增加本地可读时间字段(如 `generatedAtLocal`),终端日志统一显示 `YYYY-MM-DD HH:mm:ss`。 -- 页面中的 `platform/project` 是全局请求头配置项,脚本会校验 `web/all` 选项存在,并将其写入每份产物的 `filter` 字段。 -- `pending-updates.json` 中: - - 无任何变化时文件会被重置为 `{}`。 - - 有变化时写入模块/接口变更清单,复杂迁移统一折叠为“新增 + 删除”。 - - `summary`:包含 `moduleAdded`、`moduleDeleted`、`interfaceAdded`、`interfaceDeleted`、`interfaceParamsUpdated`、`interfaceResponseUpdated`、`totalChangedItems` - - `interfaceUpdates`:包含 `added`、`deleted`、`paramsUpdated`、`responseUpdated` - -## 待更新接口判定规则 - -- 与上一轮有效快照对比后,以下变化会写入 `pending-updates.json`: - - 模块更新:新增模块、删除模块(拆分/合并/替换统一按增删处理) - - 接口更新:新增接口、删除接口、`params` 变化、`response` 变化 - -## 模块文件夹生命周期 - -- 新模块首次出现时自动创建模块文件夹并生成 `_module.lifecycle.json`。 -- 运行 `npm run apiconfig` 时会先完成与上一轮数据的差异对比并写入 `pending-updates.json`。 -- 对比完成后,当前文档中不存在的旧模块文件夹会被直接物理删除(不再保留 `_deleted.YYYYMMDD.json` 软删除标记)。 -- 目录内仅保留本轮解析到的最新模块数据,避免历史目录残留影响结构一致性。 - -## 结构优化说明 - -- 入口脚本统一放在 `scripts/`。 -- 数据统一放在 `data/`,减少根目录散落文件。 -- 采用覆盖写入模式,避免重复历史文件导致目录混乱与资源浪费。 diff --git a/workflows/api-doc-system/apidata/config.json b/workflows/api-doc-system/apidata/config.json deleted file mode 100644 index 6768b8fc..00000000 --- a/workflows/api-doc-system/apidata/config.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "requests": [ - { - "method": "user.login", - "body": { - "username": "yjm", - "password": "111111" - } - }, - { - "method": "storage.entry.get", - "body": { - "id": 234 - } - }, - { - "method": "", - "body": {} - }, - { - "method": "", - "body": {} - }, - { - "method": "", - "body": {} - }, - { - "method": "", - "body": {} - } - ], - "successMessages": [ - "ok", - "成功", - "登录成功", - "success", - "查询成功", - "获取成功" - ] -} diff --git a/workflows/api-doc-system/apidata/crawler.mjs b/workflows/api-doc-system/apidata/crawler.mjs deleted file mode 100644 index 3728bbff..00000000 --- a/workflows/api-doc-system/apidata/crawler.mjs +++ /dev/null @@ -1,63 +0,0 @@ -function buildRequestUrl({ baseUrl, method, version }) { - const url = new URL(baseUrl); - const timestamp = String(Math.floor(Date.now() / 1000)); - url.searchParams.set("method", method); - url.searchParams.set("v", version); - url.searchParams.set("timestamp", timestamp); - return url; -} - -function withTimeoutSignal(timeoutMs) { - return AbortSignal.timeout(timeoutMs); -} - -export async function crawlApi({ - baseUrl, - version, - method, - body = {}, - timeoutMs = 20000, - token = null, -}) { - const url = buildRequestUrl({ baseUrl, method, version }); - const headers = { - "content-type": "application/json", - platform: "web", - project: "all", - }; - if (token) { - headers.Authorization = `Bearer ${token}`; - } - const response = await fetch(url, { - method: "POST", - headers, - body: JSON.stringify(body ?? {}), - signal: withTimeoutSignal(timeoutMs), - }); - - const rawText = await response.text(); - let parsed; - try { - parsed = rawText ? JSON.parse(rawText) : null; - } catch { - parsed = { - rawText, - }; - } - - return { - request: { - url: url.toString(), - method, - body: body ?? {}, - headers, - }, - status: response.status, - ok: response.ok, - response: parsed, - }; -} - -export function extractToken(responseData) { - return responseData?.data?.token ?? null; -} diff --git a/workflows/api-doc-system/apidata/data.json b/workflows/api-doc-system/apidata/data.json deleted file mode 100644 index fdcfb909..00000000 --- a/workflows/api-doc-system/apidata/data.json +++ /dev/null @@ -1,132 +0,0 @@ -{ - "数据一览": { - "当前请求数": 2, - "成功数": 2, - "全部请求数": 2, - "成功数与全部请求数": "2/2", - "成功判定名单": [ - "ok", - "成功", - "登录成功", - "success", - "查询成功", - "获取成功" - ], - "失败接口": [], - "空数据接口": [] - }, - "详情": [ - { - "接口": "user.login", - "message": "登录成功", - "code": 200, - "data": { - "flag": "success", - "code": 200, - "message": "登录成功", - "success": true, - "data": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MywidXNlcm5hbWUiOiJ5am0iLCJyZWFsX25hbWUiOiJ5aW4iLCJwbGF0Zm9ybV9jb2RlIjoid2ViIiwiY3VycmVudF9yb2xlX2lkIjozMSwiY3VycmVudF9zdG9yZV9pZCI6MTAwMDAwLCJpYXQiOjE3ODE3NzY0NjksImV4cCI6MTc4MTc5MDg2OX0.CbuNMERnphyn_sdPNSOast3BfOnW030MzEEkml_Y-ZE" - }, - "timestamp": 1781776469 - } - }, - { - "接口": "storage.entry.get", - "message": "查询成功", - "code": 200, - "data": { - "flag": "success", - "code": 200, - "message": "查询成功", - "data": { - "entryOrder": { - "id": 234, - "entry_order_code": "TEST-EO-1781661791664EM3F02", - "order_type": "SCRK", - "purchase_order_code": "", - "total_order_lines": 1, - "order_create_time": "2026-06-17T02:03:11.000Z", - "expect_start_time": "2026-06-20T02:00:00.000Z", - "expect_end_time": "2026-06-17T02:03:11.000Z", - "logistics_code": "", - "logistics_name": "", - "express_code": "", - "supplier_code": "SUP001", - "supplier_name": "测试供应商", - "source_type": "API", - "order_status": "PENDING", - "sync_status": "PENDING", - "sync_message": "", - "is_enabled": 1, - "created_at": "2026-06-17T02:03:11.000Z", - "updated_at": "2026-06-17T02:03:11.000Z", - "warehouse_id": 100000, - "store_id": 1000000, - "remark": "自动化测试入库单", - "expense_record": 0, - "store_name": "测试货主", - "warehouse_name": "测试云仓", - "deleted_at": null, - "qimen_owner_code": "", - "qimen_warehouse_code": "100000", - "warehouse": { - "id": 100000, - "company_name": "测试仓" - }, - "store": { - "id": 1000000, - "company_name": "测试货主1111" - }, - "items": [ - { - "id": 440, - "order_id": 234, - "out_biz_code": "", - "order_line_no": 1, - "owner_code": "4", - "count": 10, - "inventory_type": "ZP", - "stock_id": 101397, - "received_quantity": 0, - "confirm_quantity": 0, - "pending_total": 3, - "total_planned": 10, - "bindings": [ - { - "id": 1, - "entry_item_id": 440, - "receiving_detail_id": 2628, - "allocated_quantity": 3, - "status": "pending", - "creator_id": 31, - "created_at": "2026-06-18T09:26:10.000Z", - "updated_at": "2026-06-18T09:26:10.000Z", - "deleted_at": null, - "receivingDetail": { - "id": 2628, - "receiving_id": 1433, - "product_name": "CrazyKitty唇刷", - "actual_quantity": 5, - "stored_quantity": 0, - "batch_number": "02025416", - "production_date": "2026-06-16", - "expiry_date": "2026-06-27", - "storage_status": "none" - } - } - ], - "external_item_code": "6920251105000", - "external_item_id": 1000213, - "warehouse_item_code": "6920251105000", - "warehouse_item_name": "CrazyKitty唇刷", - "warehouse_item_spec": "" - } - ] - } - }, - "timestamp": 1781776469 - } - } - ] -} diff --git a/workflows/api-doc-system/clear-pending.mjs b/workflows/api-doc-system/clear-pending.mjs deleted file mode 100644 index 374b7d5c..00000000 --- a/workflows/api-doc-system/clear-pending.mjs +++ /dev/null @@ -1 +0,0 @@ -import "./core/clear-pending.mjs"; diff --git a/workflows/api-doc-system/config.mjs b/workflows/api-doc-system/config.mjs deleted file mode 100644 index 88380aca..00000000 --- a/workflows/api-doc-system/config.mjs +++ /dev/null @@ -1 +0,0 @@ -export { API_DOC_SYSTEM_CONFIG } from "./core/config.mjs"; diff --git a/workflows/api-doc-system/core/apidata.mjs b/workflows/api-doc-system/core/apidata.mjs deleted file mode 100644 index 42ff198b..00000000 --- a/workflows/api-doc-system/core/apidata.mjs +++ /dev/null @@ -1,1209 +0,0 @@ -import { mkdir, readdir, readFile, writeFile, stat } from "node:fs/promises"; -import path from "node:path"; -import { crawlApi } from "../apidata/crawler.mjs"; - -const APIDATA_DIR = path.join("workflows", "api-doc-system", "apidata"); -const APIDATA_CONFIG_FILE = path.join(APIDATA_DIR, "config.json"); -const APIDATA_DATA_FILE = path.join(APIDATA_DIR, "data.json"); -const RESPONSE_MARKDOWN_FILE = path.join("workflows", "api-doc-agent", "config", "响应.md"); -const MODULE_DATA_ROOT = path.join("workflows", "api-doc-system", "data", "module"); -const MODULE_LIST_FILE = path.join("workflows", "api-doc-system", "data", "module-list", "module-list.json"); - -const CRAWLER_CONFIG = { - baseUrl: "http://192.168.11.56:6060/system", - version: "1.0", - /** 普通抓取:单接口 fetch 上限 */ - timeoutMs: 20000, - /** --quick 全量顺序请求时服务端易排队,单接口默认放宽(可被 config.requestTimeoutMs 覆盖) */ - quickModeTimeoutMs: 60000, - /** 单请求失败(fetch failed / timeout / 5xx)自动重试次数(不含首次) */ - defaultMaxRetries: 2, - quickMaxRetries: 3, - /** 连续请求之间的间隔(ms),防止服务端雪崩 */ - defaultDelayMs: 0, - quickDelayMs: 120, - /** 重试退避起始时间(ms),指数退避上限 */ - retryBackoffMsBase: 500, - retryBackoffMsMax: 5000, -}; - -/** @param {number} ms */ -function clampRequestTimeoutMs(ms) { - const n = Math.floor(ms); - if (!Number.isFinite(n) || n < 1000) { - return CRAWLER_CONFIG.timeoutMs; - } - return Math.min(n, 900000); -} - -/** - * apidata/config.json 根级可选 requestTimeoutMs(毫秒)覆盖默认;否则 quick 用 quickModeTimeoutMs。 - * CLI 的 --timeout= 优先级最高。 - * @param {{ rawConfig: object, quickCheck: boolean, cliTimeoutMs?: number | null }} args - */ -function resolveCrawlTimeoutMs({ rawConfig, quickCheck, cliTimeoutMs = null }) { - if (Number.isFinite(cliTimeoutMs) && cliTimeoutMs > 0) { - return clampRequestTimeoutMs(cliTimeoutMs); - } - const fromFile = Number(rawConfig?.requestTimeoutMs); - if (Number.isFinite(fromFile) && fromFile > 0) { - return clampRequestTimeoutMs(fromFile); - } - return quickCheck ? CRAWLER_CONFIG.quickModeTimeoutMs : CRAWLER_CONFIG.timeoutMs; -} - -/** @param {number} n */ -function clampNonNegativeInt(n) { - const v = Math.floor(Number(n)); - if (!Number.isFinite(v) || v < 0) { - return 0; - } - return v; -} - -/** - * @param {{ rawConfig: object, quickCheck: boolean, cliDelayMs?: number | null }} args - */ -function resolveRequestDelayMs({ rawConfig, quickCheck, cliDelayMs = null }) { - if (Number.isFinite(cliDelayMs) && cliDelayMs >= 0) { - return clampNonNegativeInt(cliDelayMs); - } - const v = Number(rawConfig?.requestDelayMs); - if (Number.isFinite(v) && v >= 0) { - return clampNonNegativeInt(v); - } - return quickCheck ? CRAWLER_CONFIG.quickDelayMs : CRAWLER_CONFIG.defaultDelayMs; -} - -/** - * @param {{ rawConfig: object, quickCheck: boolean, cliMaxRetries?: number | null }} args - */ -function resolveMaxRetries({ rawConfig, quickCheck, cliMaxRetries = null }) { - if (Number.isFinite(cliMaxRetries) && cliMaxRetries >= 0) { - return clampNonNegativeInt(cliMaxRetries); - } - const v = Number(rawConfig?.maxRetries); - if (Number.isFinite(v) && v >= 0) { - return clampNonNegativeInt(v); - } - return quickCheck ? CRAWLER_CONFIG.quickMaxRetries : CRAWLER_CONFIG.defaultMaxRetries; -} - -/** - * 连续超时熔断阈值,默认 5(表示连续 5 个接口超时即中止抓取)。 - * 可通过 apidata/config.json 根级 maxConsecutiveTimeouts 或 CLI --timeout-streak 覆盖。 - * @param {{ rawConfig: object, cliTimeoutStreak?: number | null }} args - */ -function resolveMaxConsecutiveTimeouts({ rawConfig, cliTimeoutStreak = null }) { - const clampMinOne = (n) => Math.max(1, clampNonNegativeInt(n)); - if (Number.isFinite(cliTimeoutStreak) && cliTimeoutStreak > 0) { - return clampMinOne(cliTimeoutStreak); - } - const v = Number(rawConfig?.maxConsecutiveTimeouts); - if (Number.isFinite(v) && v > 0) { - return clampMinOne(v); - } - return 5; -} - -function sleepMs(ms) { - if (!Number.isFinite(ms) || ms <= 0) { - return Promise.resolve(); - } - return new Promise((r) => setTimeout(r, ms)); -} - -/** 瞬时网络错误/超时/5xx 视为可重试 */ -function isRetryableCrawlError(err) { - const name = String(err?.name ?? ""); - const msg = String(err?.message ?? err ?? ""); - if (name === "TimeoutError" || /timeout/i.test(msg)) { - return true; - } - if (/fetch failed|ECONNRESET|ECONNREFUSED|ETIMEDOUT|EAI_AGAIN|ENOTFOUND|EPIPE|socket hang up/i.test(msg)) { - return true; - } - return false; -} - -function isRetryableStatus(status) { - return status === 0 || status === 408 || status === 425 || status === 429 || (status >= 500 && status <= 599); -} - -/** - * 仅把“请求超时”归入连续超时计数,普通网络错误不计入。 - * @param {{ status: number, error?: string }} result - */ -function isTimeoutFailureResult(result) { - const errMsg = String(result?.error ?? ""); - if (/timeout|timed out|请求超时/i.test(errMsg)) { - return true; - } - return Number(result?.status) === 408; -} - -function backoffDelayMs(attempt) { - const base = CRAWLER_CONFIG.retryBackoffMsBase; - const max = CRAWLER_CONFIG.retryBackoffMsMax; - const exp = Math.min(max, base * 2 ** attempt); - const jitter = Math.floor(Math.random() * Math.min(300, exp)); - return exp + jitter; -} - -/** - * 带重试的 crawlApi 封装:捕获网络异常与可重试状态码 - * @returns {Promise<{ ok: boolean, status: number, response: unknown, error?: string, attempts: number, elapsedMs: number }>} - */ -async function crawlApiWithRetry({ method, body, token, timeoutMs, maxRetries }) { - const started = Date.now(); - let lastError = null; - for (let attempt = 0; attempt <= maxRetries; attempt += 1) { - try { - const r = await crawlApi({ - baseUrl: CRAWLER_CONFIG.baseUrl, - version: CRAWLER_CONFIG.version, - method, - body, - timeoutMs, - token, - }); - if (!r.ok && isRetryableStatus(r.status) && attempt < maxRetries) { - await sleepMs(backoffDelayMs(attempt)); - continue; - } - return { - ok: r.ok, - status: r.status, - response: r.response, - attempts: attempt + 1, - elapsedMs: Date.now() - started, - }; - } catch (err) { - lastError = err; - if (attempt < maxRetries && isRetryableCrawlError(err)) { - await sleepMs(backoffDelayMs(attempt)); - continue; - } - return { - ok: false, - status: 0, - response: null, - error: String(err?.message ?? err), - attempts: attempt + 1, - elapsedMs: Date.now() - started, - }; - } - } - return { - ok: false, - status: 0, - response: null, - error: String(lastError?.message ?? lastError ?? "unknown"), - attempts: maxRetries + 1, - elapsedMs: Date.now() - started, - }; -} - -const LOGIN_METHOD = "user.login"; - -/** apidata/config.json 未配置 successMessages 时使用;可在 config 中写 successMessages 数组覆盖 */ -const DEFAULT_SUCCESS_MESSAGES = ["ok", "成功", "登录成功",]; - -function normalizeSuccessMessageKey(value) { - return String(value ?? "") - .trim() - .toLowerCase(); -} - -function resolveSuccessMessages(rawConfig) { - const arr = rawConfig?.successMessages; - if (Array.isArray(arr) && arr.length > 0) { - const cleaned = arr.map((x) => String(x).trim()).filter(Boolean); - if (cleaned.length > 0) { - return cleaned; - } - } - return [...DEFAULT_SUCCESS_MESSAGES]; -} - -/** message 与成功名单某项在 trim + 小写比较下一致则视为成功(英文 ok 与 OK 等价) */ -function isResponseMessageOk(message, successMessages) { - const key = normalizeSuccessMessageKey(message); - if (!key) { - return false; - } - const allow = new Set(successMessages.map((x) => normalizeSuccessMessageKey(x)).filter(Boolean)); - return allow.has(key); -} - -/** - * 成功响应中「列表业务数据」为空时视为「空数据」。 - * - 标准包裹:根对象含 `data` 且 `data` 为对象且含 `list` - * - 扁平结构:根对象直接含 `list` - * 无上述 list 字段的接口(如登录、单对象配置)不归入此类。 - * @param {unknown} storedResponse apidata 详情条目中保存的完整响应 JSON - */ -function isDataWithEmptyList(storedResponse) { - if (!storedResponse || typeof storedResponse !== "object" || Array.isArray(storedResponse)) { - return false; - } - const root = /** @type {Record} */ (storedResponse); - /** @param {Record} obj */ - const emptyListOn = (obj) => { - if (!Object.prototype.hasOwnProperty.call(obj, "list")) { - return false; - } - const list = obj.list; - if (list == null) { - return true; - } - return Array.isArray(list) && list.length === 0; - }; - const inner = root.data; - if (inner && typeof inner === "object" && !Array.isArray(inner)) { - if (emptyListOn(/** @type {Record} */ (inner))) { - return true; - } - } - return emptyListOn(root); -} - -/** - * @param {Array<{ 接口: string, message: string, code?: unknown, data: unknown }>} rows - * @param {string[]} successMessages - */ -function buildDataOverview(rows, successMessages) { - const total = rows.length; - let success = 0; - /** @type {{ 接口: string, message: string, code: unknown }[]} */ - const 失败接口 = []; - /** @type {{ 接口: string, message: string, code: unknown }[]} */ - const 空数据接口 = []; - for (const row of rows) { - if (isResponseMessageOk(row.message, successMessages)) { - success += 1; - if (isDataWithEmptyList(row.data)) { - 空数据接口.push({ - 接口: row.接口, - message: String(row.message ?? ""), - code: row.code ?? null, - }); - } - } else { - 失败接口.push({ - 接口: row.接口, - message: String(row.message ?? ""), - code: row.code ?? null, - }); - } - } - return { - 当前请求数: total, - 成功数: success, - 全部请求数: total, - 成功数与全部请求数: `${success}/${total}`, - 成功判定名单: [...successMessages], - 失败接口, - 空数据接口, - }; -} - -function ensurePlainObject(value, fallbackValue = {}) { - if (!value || typeof value !== "object" || Array.isArray(value)) { - return fallbackValue; - } - return value; -} - -async function readJson(filePath) { - const content = await readFile(filePath, "utf8"); - return JSON.parse(content); -} - -async function writeJson(filePath, data) { - await mkdir(path.dirname(filePath), { recursive: true }); - await writeFile(filePath, `${JSON.stringify(data, null, 2)}\n`, "utf8"); -} - -function normalizeConfigRequest(item) { - const method = String(item?.method ?? "").trim(); - if (!method) { - return null; - } - return { - method, - body: ensurePlainObject(item?.body, {}), - needAuth: item?.needAuth ?? method !== LOGIN_METHOD, - }; -} - -function normalizeConfig(rawConfig) { - const rawRequests = Array.isArray(rawConfig) ? rawConfig : rawConfig?.requests; - const requests = Array.isArray(rawRequests) ? rawRequests.map(normalizeConfigRequest).filter(Boolean) : []; - - if (requests.length === 0) { - throw new Error("apidata/config.json 缺少有效接口配置,请至少提供一个 method"); - } - - return { - requests, - }; -} - -function printHelp() { - console.log(` -apidata — 按 config.json 请求远端并写入 apidata/data.json;默认同时写入 api-doc-agent/config/响应.md(仅含各接口 method 与完整响应 JSON)。 -快速检查(--quick)不写入 响应.md,且 data.json 仅含「数据一览」、不含「详情」。 - -成功判定: 响应 message 与「成功判定名单」某项在 trim 且英文忽略大小写后一致即成功(默认含 ok、成功、登录成功)。 -可在 apidata/config.json 根级设置 successMessages 数组覆盖默认名单。 -可在同文件根级设置 requestTimeoutMs(数字,毫秒)覆盖单次 fetch 超时;未设置时 --quick 默认单接口 ${CRAWLER_CONFIG.quickModeTimeoutMs}ms,普通模式 ${CRAWLER_CONFIG.timeoutMs}ms。 -可在同文件根级设置 maxConsecutiveTimeouts(数字,默认 5)控制连续超时熔断阈值。 - -失败接口: 默认在每条失败记录上附加「模块目录」(来自 data/module-list/module-list.json)、 -「api封装」(在 src/api 中匹配到的 export)及「引用页面」(扫描 src/views、src/components、src/layout 下 .vue/.ts/.tsx 的引用路径,相对仓库根)。 - -空数据接口: message 判定成功且完整响应体中 \`data.list\`(包裹结构)或根级 \`list\` 为 [] 或 null 的接口,写入「数据一览.空数据接口」,默认附加信息与失败接口相同。 - -快速检查(--quick)下:失败/空数据条目仅含 接口、message、文件(api 封装所在文件路径,去重)、引用页面;不含 模块目录、code、api 封装明细等。 - -用法: - npm run apiconfig:apidata - npm run apiconfig:apidata -- [选项] [模块名 ...] - -选项: - -c, -r, --clear 清空除 ${LOGIN_METHOD} 外的请求项(无模块名时仅保留登录) - -n, --no-clear 指定模块时仍保留 config 中其它模块的请求(默认:指定模块时会先清空) - -q, --quick 快速检查:自动包含 data/module 下全部模块的接口(等同清空后写入全量), - data.json 仅含「数据一览」、不含「详情」;失败/空数据条目仅含 接口、message、文件、引用页面;不写入 响应.md - --timeout= 覆盖单次 fetch 超时;优先级高于 config.requestTimeoutMs - --delay= 请求间隔;优先级高于 config.requestDelayMs(--quick 默认 ${CRAWLER_CONFIG.quickDelayMs}ms) - --retries= 单请求失败重试次数(不含首次);优先级高于 config.maxRetries(--quick 默认 ${CRAWLER_CONFIG.quickMaxRetries}) - --timeout-streak= 连续超时熔断阈值(默认 5);达到阈值后终止后续请求 - -h, --help 显示本说明 - -模块名: - 与 data/module/ 一致,例如 order.index、order.revieworder(大小写不敏感) - 指定一个或多个模块时,默认会先「清空除登录外的条目」,再写入这些模块在 module.json 中的全部 method。 - -示例: - npm run apiconfig:apidata - npm run apiconfig:apidata -- order.index order.revieworder - npm run apiconfig:apidata -- -c - npm run apiconfig:apidata -- --no-clear order.index - npm run apiconfig:apidata -- --quick - npm run apiconfig:apidata:quick -`); -} - -/** - * @param {string[]} argv process.argv.slice(2) - */ -export function parseApidataCli(argv) { - const flags = { clear: false, noClear: false, help: false, quickCheck: false }; - /** @type {{ delayMs: number | null, maxRetries: number | null, timeoutMs: number | null, timeoutStreak: number | null }} */ - const tune = { delayMs: null, maxRetries: null, timeoutMs: null, timeoutStreak: null }; - const positionals = []; - - /** @param {string} raw */ - const parseIntOpt = (raw) => { - const v = Number(raw); - if (!Number.isFinite(v) || v < 0) { - throw new Error(`无效数值: ${raw}`); - } - return Math.floor(v); - }; - - for (const arg of argv) { - if (arg === "--") { - continue; - } - if (arg === "-h" || arg === "--help") { - flags.help = true; - continue; - } - if (arg === "-c" || arg === "-r" || arg === "--clear") { - flags.clear = true; - continue; - } - if (arg === "-n" || arg === "--no-clear") { - flags.noClear = true; - continue; - } - if (arg === "-q" || arg === "--quick") { - flags.quickCheck = true; - continue; - } - if (arg.startsWith("--delay=")) { - tune.delayMs = parseIntOpt(arg.slice("--delay=".length)); - continue; - } - if (arg.startsWith("--retries=")) { - tune.maxRetries = parseIntOpt(arg.slice("--retries=".length)); - continue; - } - if (arg.startsWith("--timeout=")) { - tune.timeoutMs = parseIntOpt(arg.slice("--timeout=".length)); - continue; - } - if (arg.startsWith("--timeout-streak=")) { - tune.timeoutStreak = parseIntOpt(arg.slice("--timeout-streak=".length)); - continue; - } - if (arg.startsWith("-")) { - throw new Error(`未知参数: ${arg}(使用 --help 查看说明)`); - } - positionals.push(arg.trim()); - } - - const modules = positionals.filter(Boolean); - let clearOld = false; - if (flags.help) { - return { flags, modules, clearOld, help: true, quickCheck: false, tune }; - } - if (flags.quickCheck && flags.noClear) { - throw new Error("快速检查模式(--quick)不能与 --no-clear 同时使用"); - } - if (flags.quickCheck && modules.length > 0) { - throw new Error("快速检查模式会自动包含 data/module 下全部模块,请勿再指定模块名"); - } - if (flags.noClear && flags.clear) { - throw new Error("不能同时使用 --clear 与 --no-clear"); - } - if (modules.length > 0) { - clearOld = !flags.noClear; - } else { - clearOld = flags.clear; - } - - return { flags, modules, clearOld, help: false, quickCheck: flags.quickCheck, tune }; -} - -async function listModuleFolders() { - const entries = await readdir(MODULE_DATA_ROOT, { withFileTypes: true }); - return entries.filter((e) => e.isDirectory()).map((e) => e.name); -} - -async function resolveModuleFolder(userInput) { - const name = String(userInput ?? "").trim(); - if (!name) { - return null; - } - const folders = await listModuleFolders(); - const exact = folders.find((f) => f === name); - if (exact) { - return exact; - } - const lower = name.toLowerCase(); - const ci = folders.find((f) => f.toLowerCase() === lower); - if (ci) { - return ci; - } - return null; -} - -async function loadMethodsFromModuleFolder(folder) { - const filePath = path.join(MODULE_DATA_ROOT, folder, "module.json"); - const raw = await readJson(filePath); - const list = Array.isArray(raw?.interfaces) ? raw.interfaces : []; - const methods = []; - for (const item of list) { - const m = String(item?.method ?? "").trim(); - if (m) { - methods.push(m); - } - } - return methods; -} - -function requestEntry(method, body = {}) { - return { - method, - body: ensurePlainObject(body, {}), - }; -} - -/** - * @param {{ existingRaw: object, modules: string[], clearOld: boolean }} opts - */ -async function buildAndWriteConfig(opts) { - const { existingRaw, modules, clearOld } = opts; - const existing = normalizeConfig(existingRaw); - const loginReq = existing.requests.find((r) => r.method === LOGIN_METHOD); - - const methodToRequest = new Map(); - for (const r of existing.requests) { - methodToRequest.set(r.method, { method: r.method, body: { ...r.body }, needAuth: r.needAuth }); - } - - const unknownModules = []; - const moduleMethodsOrdered = []; - - for (const mod of modules) { - const folder = await resolveModuleFolder(mod); - if (!folder) { - unknownModules.push(mod); - continue; - } - const methods = await loadMethodsFromModuleFolder(folder); - for (const m of methods) { - moduleMethodsOrdered.push(m); - } - } - - const seenMethod = new Set(); - const uniqueModuleMethods = []; - for (const m of moduleMethodsOrdered) { - if (seenMethod.has(m)) { - continue; - } - seenMethod.add(m); - uniqueModuleMethods.push(m); - } - - if (unknownModules.length) { - const available = (await listModuleFolders()).sort().join(", "); - throw new Error( - `未找到模块: ${unknownModules.join(", ")}\n` + `data/module 下可用 folder: ${available}`, - ); - } - - const moduleMethodSet = new Set(uniqueModuleMethods); - - let nextRequests = []; - - if (clearOld) { - if (loginReq) { - nextRequests.push(requestEntry(LOGIN_METHOD, loginReq.body)); - } else { - throw new Error(`清空模式下需要在 config.json 中保留 ${LOGIN_METHOD} 及 body,以便后续接口鉴权`); - } - for (const m of uniqueModuleMethods) { - if (m === LOGIN_METHOD) { - continue; - } - nextRequests.push(requestEntry(m, {})); - } - } else if (modules.length > 0) { - const merged = []; - for (const r of existing.requests) { - if (r.method === LOGIN_METHOD) { - merged.push({ method: r.method, body: { ...r.body } }); - continue; - } - if (moduleMethodSet.has(r.method)) { - continue; - } - merged.push({ method: r.method, body: { ...r.body } }); - } - for (const m of uniqueModuleMethods) { - if (m === LOGIN_METHOD) { - continue; - } - const prev = methodToRequest.get(m); - merged.push(requestEntry(m, prev?.body ?? {})); - } - nextRequests = merged; - const hasLogin = nextRequests.some((r) => r.method === LOGIN_METHOD); - if (!hasLogin) { - throw new Error(`config 中须包含 ${LOGIN_METHOD},或先使用清空模式生成配置`); - } - } else { - nextRequests = existing.requests.map((r) => ({ method: r.method, body: { ...r.body } })); - } - - nextRequests.sort((a, b) => { - if (a.method === LOGIN_METHOD) { - return -1; - } - if (b.method === LOGIN_METHOD) { - return 1; - } - return 0; - }); - - const out = { - requests: nextRequests.map((r) => ({ - method: r.method, - body: r.body ?? {}, - })), - }; - - const prevSm = existingRaw?.successMessages; - if (Array.isArray(prevSm) && prevSm.length > 0) { - const cleaned = prevSm.map((x) => String(x).trim()).filter(Boolean); - if (cleaned.length > 0) { - out.successMessages = cleaned; - } - } - - const prevRt = Number(existingRaw?.requestTimeoutMs); - if (Number.isFinite(prevRt) && prevRt > 0) { - out.requestTimeoutMs = clampRequestTimeoutMs(prevRt); - } - const prevTimeoutStreak = Number(existingRaw?.maxConsecutiveTimeouts); - if (Number.isFinite(prevTimeoutStreak) && prevTimeoutStreak > 0) { - out.maxConsecutiveTimeouts = Math.max(1, clampNonNegativeInt(prevTimeoutStreak)); - } - - await writeJson(APIDATA_CONFIG_FILE, out); - console.log(`已更新 ${APIDATA_CONFIG_FILE}(共 ${out.requests.length} 条请求)`); - return out; -} - -/** - * 响应.md 仅含「接口 method + 完整响应体」,不含数据一览、message 等。 - * @param {Array<{ 接口: string, message?: string, code?: unknown, data: unknown }>} rows - */ -function buildMethodDataOnlyForMarkdown(rows) { - return rows.map((row) => ({ - 接口: row.接口, - data: row.data ?? null, - })); -} - -function createResponseMarkdown(rows) { - const slim = buildMethodDataOnlyForMarkdown(rows); - return ["```json", JSON.stringify(slim, null, 2), "```", ""].join("\n"); -} - -function escapeRegex(s) { - return String(s).replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); -} - -function toPosix(p) { - return p.split(path.sep).join("/"); -} - -/** @returns {Promise} */ -async function walkFilesRecursive(rootDir, { extensions } = {}) { - const out = []; - let st; - try { - st = await stat(rootDir); - } catch { - return out; - } - if (!st.isDirectory()) { - return out; - } - const entries = await readdir(rootDir, { withFileTypes: true }); - for (const e of entries) { - const full = path.join(rootDir, e.name); - if (e.isDirectory()) { - out.push(...(await walkFilesRecursive(full, { extensions }))); - } else if (e.isFile()) { - if (extensions && extensions.length > 0) { - const ext = path.extname(e.name).toLowerCase(); - if (!extensions.includes(ext)) { - continue; - } - } - out.push(full); - } - } - return out; -} - -/** - * 从 module-list.json 构建 method -> folder(module.json 所在目录名,对应 src/api/) - * @returns {Promise>} - */ -async function loadMethodToFolderFromModuleList() { - const map = new Map(); - try { - const raw = await readJson(MODULE_LIST_FILE); - const modules = Array.isArray(raw?.modules) ? raw.modules : []; - for (const mod of modules) { - const folder = String(mod?.folder ?? "").trim(); - const interfaces = Array.isArray(mod?.interfaces) ? mod.interfaces : []; - for (const it of interfaces) { - const m = String(it?.method ?? "").trim(); - if (m && folder && !map.has(m)) { - map.set(m, folder); - } - } - } - } catch { - // 无 module-list 时仅全量扫描 src/api - } - return map; -} - -/** - * @param {string} apiFileAbs - * @param {string} repoRoot - */ -function apiFileToImportPath(apiFileAbs, repoRoot) { - const rel = toPosix(path.relative(repoRoot, apiFileAbs)); - const withoutExt = rel.replace(/\.ts$/i, ""); - if (withoutExt.startsWith("src/")) { - return "@" + withoutExt.slice("src".length); - } - return "@" + withoutExt; -} - -/** - * 解析单文件:method 字符串对应的封装(export function / export const fn = ( / 聚合对象上的属性) - * @returns {{ kind: 'function', exportName: string } | { kind: 'objectProperty', objectName: string, propName: string }}[] - */ -function extractWrappersFromApiSource(content, methodStr) { - const needleSingle = `method: '${methodStr}'`; - const needleDouble = `method: "${methodStr}"`; - if (!content.includes(needleSingle) && !content.includes(needleDouble)) { - return []; - } - - const lines = content.split(/\r?\n/); - let currentExport = null; - /** @type {Map>} method -> function export names */ - const methodToFnExports = new Map(); - - const exportFnRe = /export\s+function\s+(\w+)\s*\(/; - const exportConstFnRe = /export\s+const\s+(\w+)\s*=\s*(?:async\s*)?\(/; - const methodLineRe = /method:\s*['"]([^'"]+)['"]/; - - function addFnExport(meth, name) { - if (!meth || !name) { - return; - } - if (!methodToFnExports.has(meth)) { - methodToFnExports.set(meth, new Set()); - } - methodToFnExports.get(meth).add(name); - } - - for (const line of lines) { - let m = line.match(exportFnRe); - if (m) { - currentExport = m[1]; - } else { - m = line.match(exportConstFnRe); - if (m) { - currentExport = m[1]; - } - } - const mm = line.match(methodLineRe); - if (mm && currentExport) { - addFnExport(mm[1], currentExport); - } - } - - const fnNames = methodToFnExports.get(methodStr); - if (!fnNames || fnNames.size === 0) { - return []; - } - - /** @type {any[]} */ - const wrappers = []; - for (const fnName of fnNames) { - const aliases = findObjectPropertyAliases(content, fnName); - // 若已发现聚合对象对外导出,优先展示该调用形态,避免同一接口重复显示“函数 + 对象属性”两条封装。 - if (aliases.length > 0) { - for (const { objectName, propName } of aliases) { - wrappers.push({ kind: "objectProperty", objectName, propName }); - } - continue; - } - wrappers.push({ kind: "function", exportName: fnName }); - } - return wrappers; -} - -/** - * @param {string} content - * @param {string} fnName - * @returns {{ objectName: string, propName: string }[]} - */ -function findObjectPropertyAliases(content, fnName) { - const re = new RegExp(`\\b(\\w+)\\s*:\\s*${escapeRegex(fnName)}\\b`, "g"); - const results = []; - let m; - while ((m = re.exec(content)) !== null) { - const propName = m[1]; - const before = content.slice(0, m.index); - const objs = [...before.matchAll(/export\s+const\s+(\w+)\s*=\s*\{/g)]; - if (objs.length === 0) { - continue; - } - const objectName = objs[objs.length - 1][1]; - results.push({ objectName, propName }); - } - return results; -} - -/** - * @param {string} importPath - */ -function importsFromPath(content, importPath) { - return new RegExp(`from\\s*['"]${escapeRegex(importPath)}['"]`, "i").test(content); -} - -/** - * import { a, b } from 'path'(支持多行) - */ -function namedImportDeclaresSymbol(content, importPath, symbol) { - if (!importsFromPath(content, importPath)) { - return false; - } - const ep = escapeRegex(importPath); - const blocks = [...content.matchAll(new RegExp(`import\\s*\\{([\\s\\S]*?)\\}\\s*from\\s*['"]${ep}['"]`, "gi"))]; - for (const b of blocks) { - if (new RegExp(`\\b${escapeRegex(symbol)}\\b`).test(b[1])) { - return true; - } - } - return false; -} - -function namespaceAlias(content, importPath) { - const ep = escapeRegex(importPath); - const m = content.match(new RegExp(`import\\s*\\*\\s*as\\s+(\\w+)\\s+from\\s*['"]${ep}['"]`, "i")); - return m ? m[1] : null; -} - -function viewUsesFunctionExport(content, importPath, exportName) { - const alias = namespaceAlias(content, importPath); - if (alias && new RegExp(`\\b${escapeRegex(alias)}\\.${escapeRegex(exportName)}\\s*\\(`).test(content)) { - return true; - } - if (namedImportDeclaresSymbol(content, importPath, exportName)) { - if (new RegExp(`(?:^|[^.\\w])${escapeRegex(exportName)}\\s*\\(`).test(content)) { - return true; - } - } - return false; -} - -function viewUsesObjectProperty(content, importPath, objectName, propName) { - if (!namedImportDeclaresSymbol(content, importPath, objectName)) { - return false; - } - return new RegExp( - `\\b${escapeRegex(objectName)}\\.${escapeRegex(propName)}\\s*\\(`, - ).test(content); -} - -/** - * 扫描整个 src/api(module-list 的 folder 仅写入失败项的「模块目录」,不排除其它目录下的同名 method 封装) - * @param {string} repoRoot - * @param {string} methodStr - */ -async function collectWrappersForMethod(repoRoot, methodStr) { - const srcApi = path.join(repoRoot, "src", "api"); - const tsFiles = await walkFilesRecursive(srcApi, { extensions: [".ts"] }); - - const seen = new Set(); - /** @type {{ relFile: string, importPath: string, kind: string, exportName?: string, objectName?: string, propName?: string }[]} */ - const out = []; - - for (const abs of tsFiles) { - let text; - try { - text = await readFile(abs, "utf8"); - } catch { - continue; - } - const wrappers = extractWrappersFromApiSource(text, methodStr); - if (wrappers.length === 0) { - continue; - } - const relFile = toPosix(path.relative(repoRoot, abs)); - const importPath = apiFileToImportPath(abs, repoRoot); - for (const w of wrappers) { - const key = - w.kind === "function" - ? `${relFile}|fn|${w.exportName}` - : `${relFile}|obj|${w.objectName}.${w.propName}`; - if (seen.has(key)) { - continue; - } - seen.add(key); - if (w.kind === "function") { - out.push({ relFile, importPath, kind: "function", exportName: w.exportName }); - } else { - out.push({ - relFile, - importPath, - kind: "objectProperty", - objectName: w.objectName, - propName: w.propName, - }); - } - } - } - - return out; -} - -/** 失败接口「引用页面」扫描目录(相对 src/) */ -const APIDATA_USAGE_SCAN_SEGMENTS = ["views", "components", "layout"]; - -/** - * @param {string} repoRoot - * @param {Awaited>} wrappers - */ -async function findViewsUsingWrappers(repoRoot, wrappers) { - if (wrappers.length === 0) { - return []; - } - const candidates = []; - for (const seg of APIDATA_USAGE_SCAN_SEGMENTS) { - const root = path.join(repoRoot, "src", seg); - const files = await walkFilesRecursive(root, { extensions: [".vue", ".ts", ".tsx"] }); - candidates.push(...files); - } - const hits = new Set(); - for (const abs of candidates) { - let content; - try { - content = await readFile(abs, "utf8"); - } catch { - continue; - } - for (const w of wrappers) { - let ok = false; - if (w.kind === "function") { - ok = viewUsesFunctionExport(content, w.importPath, w.exportName); - } else if (w.kind === "objectProperty") { - ok = viewUsesObjectProperty(content, w.importPath, w.objectName, w.propName); - } - if (ok) { - hits.add(toPosix(path.relative(repoRoot, abs))); - break; - } - } - } - return [...hits].sort(); -} - -/** - * 为「失败接口」补充 api 封装与引用页面路径(views / components / layout) - * @param {Array<{ 接口: string, message: string, code: unknown }>} failedList - */ -async function enrichFailedInterfacesWithUsage(failedList) { - const repoRoot = process.cwd(); - const methodToFolder = await loadMethodToFolderFromModuleList(); - const enriched = []; - for (const item of failedList) { - const methodStr = String(item.接口 ?? "").trim(); - const folder = methodToFolder.get(methodStr) ?? null; - const wrappers = await collectWrappersForMethod(repoRoot, methodStr); - const 引用页面 = await findViewsUsingWrappers(repoRoot, wrappers); - const api封装 = wrappers.map((w) => { - if (w.kind === "function") { - return { 文件: w.relFile, 方法名: w.exportName }; - } - return { - 文件: w.relFile, - 方法名: `${w.objectName}.${w.propName}`, - 说明: "聚合对象方法", - }; - }); - enriched.push({ - ...item, - 模块目录: folder, - api封装, - 引用页面, - }); - } - return enriched; -} - -/** - * 快速检查:失败/空数据条目仅保留 接口、message、文件(api 封装去重后的相对路径)、引用页面 - * @param {Awaited>[number]} enriched - */ -function slimUsageRowForQuickCheck(enriched) { - const 文件 = []; - const seen = new Set(); - for (const w of enriched.api封装 ?? []) { - const f = w?.文件; - if (typeof f === "string" && f && !seen.has(f)) { - seen.add(f); - 文件.push(f); - } - } - 文件.sort(); - return { - 接口: enriched.接口, - message: enriched.message, - 文件, - 引用页面: Array.isArray(enriched.引用页面) ? [...enriched.引用页面] : [], - }; -} - -/** - * @param {{ quickCheck?: boolean, tune?: { delayMs?: number | null, maxRetries?: number | null, timeoutMs?: number | null } }} [opts] - */ -async function runCrawlFromConfigFile(opts = {}) { - const { quickCheck = false, tune = {} } = opts; - const rawConfig = await readJson(APIDATA_CONFIG_FILE); - const successMessages = resolveSuccessMessages(rawConfig); - const config = normalizeConfig(rawConfig); - const crawlTimeoutMs = resolveCrawlTimeoutMs({ - rawConfig, - quickCheck, - cliTimeoutMs: tune.timeoutMs ?? null, - }); - const requestDelayMs = resolveRequestDelayMs({ - rawConfig, - quickCheck, - cliDelayMs: tune.delayMs ?? null, - }); - const maxRetries = resolveMaxRetries({ - rawConfig, - quickCheck, - cliMaxRetries: tune.maxRetries ?? null, - }); - const maxConsecutiveTimeouts = resolveMaxConsecutiveTimeouts({ - rawConfig, - cliTimeoutStreak: tune.timeoutStreak ?? null, - }); - console.log( - `apidata 抓取参数: 超时=${crawlTimeoutMs}ms 间隔=${requestDelayMs}ms 重试=${maxRetries} 连续超时熔断=${maxConsecutiveTimeouts}${quickCheck ? "(快速检查)" : ""}`, - ); - - const rows = []; - let authToken = null; - const total = config.requests.length; - let idx = 0; - const networkErrors = []; - let consecutiveTimeoutCount = 0; - - for (const req of config.requests) { - idx += 1; - const isLogin = req.method === LOGIN_METHOD; - const result = await crawlApiWithRetry({ - method: req.method, - body: req.body, - timeoutMs: crawlTimeoutMs, - token: req.needAuth ? authToken : null, - maxRetries: isLogin ? Math.max(maxRetries, 1) : maxRetries, - }); - - const res = result.response; - const isObj = res && typeof res === "object" && !Array.isArray(res); - if (isObj && /** @type {{ data?: { token?: unknown } }} */ (res).data?.token) { - authToken = /** @type {{ data: { token: string } }} */ (res).data.token; - } - - if (result.error) { - rows.push({ - 接口: req.method, - message: `NETWORK: ${result.error}`, - code: null, - data: null, - }); - networkErrors.push({ method: req.method, error: result.error, attempts: result.attempts }); - console.log( - ` [${idx}/${total}] ${req.method} — 网络失败(重试${result.attempts - 1}次): ${result.error}`, - ); - if (isLogin) { - throw new Error(`登录接口 ${LOGIN_METHOD} 多次失败,无法继续鉴权抓取:${result.error}`); - } - } else { - rows.push({ - 接口: req.method, - message: isObj ? String(/** @type {{ message?: unknown }} */ (res).message ?? "") : "", - code: isObj && "code" in res ? /** @type {{ code?: unknown }} */ (res).code : null, - // 保存服务端返回的完整 JSON,避免仅取 `data` 导致扁平结构接口(如 setting.warehouse.getSettings)丢失主体字段 - data: isObj ? /** @type {Record} */ (res) : res, - }); - if (quickCheck || result.attempts > 1) { - console.log( - ` [${idx}/${total}] ${req.method} — ${result.elapsedMs}ms${result.attempts > 1 ? `(重试${result.attempts - 1}次)` : ""}`, - ); - } - } - - if (isTimeoutFailureResult(result)) { - consecutiveTimeoutCount += 1; - if (consecutiveTimeoutCount >= maxConsecutiveTimeouts) { - throw new Error( - `检测到连续 ${consecutiveTimeoutCount} 个接口请求超时(阈值=${maxConsecutiveTimeouts}),疑似后端异常,已终止后续请求`, - ); - } - } else { - consecutiveTimeoutCount = 0; - } - - if (requestDelayMs > 0 && idx < total) { - await sleepMs(requestDelayMs); - } - } - - const 数据一览 = buildDataOverview(rows, successMessages); - const failedEnriched = await enrichFailedInterfacesWithUsage(数据一览.失败接口); - const emptyEnriched = await enrichFailedInterfacesWithUsage(数据一览.空数据接口); - if (quickCheck) { - 数据一览.失败接口 = failedEnriched.map(slimUsageRowForQuickCheck); - 数据一览.空数据接口 = emptyEnriched.map(slimUsageRowForQuickCheck); - } else { - 数据一览.失败接口 = failedEnriched; - 数据一览.空数据接口 = emptyEnriched; - } - - const payload = quickCheck ? { 数据一览 } : { 数据一览, 详情: rows }; - - await writeJson(APIDATA_DATA_FILE, payload); - console.log(`已写入接口响应数据: ${APIDATA_DATA_FILE}`); - if (quickCheck) { - console.log("快速检查模式:已跳过写入 响应.md"); - } else { - await mkdir(path.dirname(RESPONSE_MARKDOWN_FILE), { recursive: true }); - await writeFile(RESPONSE_MARKDOWN_FILE, createResponseMarkdown(rows), "utf8"); - console.log(`已更新响应文档: ${RESPONSE_MARKDOWN_FILE}`); - } - console.log( - `数据一览: 当前请求数=${数据一览.当前请求数} 成功数/全部请求数=${数据一览.成功数与全部请求数} 失败数=${数据一览.失败接口.length} 空数据数=${数据一览.空数据接口.length} 网络错误=${networkErrors.length}`, - ); - if (数据一览.空数据接口.length) { - for (const item of 数据一览.空数据接口) { - const codePart = - !quickCheck && "code" in item ? ` — code=${JSON.stringify(/** @type {{ code?: unknown }} */ (item).code)}` : ""; - console.log(` 空数据: ${item.接口}${codePart} — ${item.message}`); - } - } - if (数据一览.失败接口.length) { - for (const item of 数据一览.失败接口) { - const codePart = - !quickCheck && "code" in item ? ` — code=${JSON.stringify(/** @type {{ code?: unknown }} */ (item).code)}` : ""; - console.log(` 失败: ${item.接口}${codePart} — ${item.message}`); - } - } -} - -export async function runApidata() { - const cli = parseApidataCli(process.argv.slice(2)); - if (cli.help) { - printHelp(); - return; - } - - const existingRaw = await readJson(APIDATA_CONFIG_FILE); - - if (cli.quickCheck) { - const all = (await listModuleFolders()).sort(); - if (all.length === 0) { - throw new Error("快速检查:data/module 下无模块目录"); - } - console.log(`apidata 快速检查:将清空并请求全部模块接口(${all.length} 个模块目录)`); - await buildAndWriteConfig({ - existingRaw, - modules: all, - clearOld: true, - }); - } else if (cli.modules.length > 0 || cli.clearOld) { - console.log( - `apidata: clearOld=${cli.clearOld}, modules=[${cli.modules.join(", ")}]`, - ); - await buildAndWriteConfig({ - existingRaw, - modules: cli.modules, - clearOld: cli.clearOld, - }); - } - - await runCrawlFromConfigFile({ quickCheck: cli.quickCheck, tune: cli.tune }); -} diff --git a/workflows/api-doc-system/core/clear-pending.mjs b/workflows/api-doc-system/core/clear-pending.mjs deleted file mode 100644 index 6bfec7a7..00000000 --- a/workflows/api-doc-system/core/clear-pending.mjs +++ /dev/null @@ -1,15 +0,0 @@ -import { mkdir, writeFile } from "node:fs/promises"; -import path from "node:path"; -import { API_DOC_SYSTEM_CONFIG } from "./config.mjs"; - -async function clearPendingUpdates() { - const pendingFilePath = API_DOC_SYSTEM_CONFIG.file.pendingUpdates; - await mkdir(path.dirname(pendingFilePath), { recursive: true }); - await writeFile(pendingFilePath, "{}\n", "utf8"); - console.log(`已清空待更新接口文件: ${pendingFilePath}`); -} - -clearPendingUpdates().catch((error) => { - console.error("清空待更新接口失败:", error.message); - process.exitCode = 1; -}); diff --git a/workflows/api-doc-system/core/config.mjs b/workflows/api-doc-system/core/config.mjs deleted file mode 100644 index c114d74d..00000000 --- a/workflows/api-doc-system/core/config.mjs +++ /dev/null @@ -1,28 +0,0 @@ -import path from "node:path"; - -const WORKFLOW_ROOT = path.join("workflows", "api-doc-system"); -const DATA_ROOT = path.join(WORKFLOW_ROOT, "data"); - -export const API_DOC_SYSTEM_CONFIG = { - docUrl: process.env.API_DOC_URL || "http://192.168.11.56:6060/api/docs/system", - requestTimeoutMs: 20000, - retentionDays: 5, - filter: { - platform: { - value: "web", - label: "网页端", - }, - project: { - value: "all", - label: "全部", - }, - }, - file: { - localHtmlSnapshot: path.join("src", "apiweb.html"), - moduleDir: path.join(DATA_ROOT, "module"), - moduleSnapshotName: "module.json", - moduleListFile: path.join(DATA_ROOT, "module-list", "module-list.json"), - interfaceDetailFile: path.join(DATA_ROOT, "interface-details", "interface-details.json"), - pendingUpdates: path.join(DATA_ROOT, "pending-updates.json"), - }, -}; diff --git a/workflows/api-doc-system/core/update.mjs b/workflows/api-doc-system/core/update.mjs deleted file mode 100644 index 91939af0..00000000 --- a/workflows/api-doc-system/core/update.mjs +++ /dev/null @@ -1 +0,0 @@ -import "../update.mjs"; diff --git a/workflows/api-doc-system/data/agent-results/interface-availability/20260416/storage.receiving.bindstore.json b/workflows/api-doc-system/data/agent-results/interface-availability/20260416/storage.receiving.bindstore.json deleted file mode 100644 index 29aae8f1..00000000 --- a/workflows/api-doc-system/data/agent-results/interface-availability/20260416/storage.receiving.bindstore.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "script": "interface", - "resolvedAt": "2026-04-16T09:15:33.059Z", - "resolvedAtLocal": "2026-04-16 17:15:33", - "method": "storage.receiving.bindStore", - "available": false, - "reason": "Method does not satisfy availability rule: isUsed=true and isPlaceholder=false.", - "check": { - "isUsed": false, - "isPlaceholder": false - }, - "source": { - "moduleFile": "workflows\\api-doc-system\\data\\module\\storage_receiving\\module.json" - }, - "interfaceSpec": null -} diff --git a/workflows/api-doc-system/data/interface-details/interface-details.json b/workflows/api-doc-system/data/interface-details/interface-details.json deleted file mode 100644 index 37ee2314..00000000 --- a/workflows/api-doc-system/data/interface-details/interface-details.json +++ /dev/null @@ -1,19080 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "totalInterfaceCount": 322, - "changes": { - "summary": { - "moduleAdded": 0, - "moduleDeleted": 0, - "moduleUpdated": 2, - "interfaceAdded": 1, - "interfaceDeleted": 0, - "interfaceParamsUpdated": 0, - "interfaceResponseUpdated": 2 - }, - "moduleUpdates": { - "added": [], - "deleted": [], - "updated": [ - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "folder": "storage_receiving", - "previousModuleName": "收货单模块", - "previousModuleKey": "storage_receiving", - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [ - "storage.receiving.getAvailableInboundQuantity" - ] - } - }, - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "folder": "storage.entry", - "previousModuleName": "入库单模块", - "previousModuleKey": "storage.entry", - "interfaceChanges": { - "addedMethods": [ - "storage.entry.unbindReceivingDetails" - ], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [ - "storage.entry.get" - ] - } - } - ] - }, - "interfaceUpdates": { - "added": [ - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "folder": "storage.entry", - "method": "storage.entry.unbindReceivingDetails" - } - ], - "deleted": [], - "paramsUpdated": [], - "responseUpdated": [ - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "folder": "storage_receiving", - "method": "storage.receiving.getAvailableInboundQuantity" - }, - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "folder": "storage.entry", - "method": "storage.entry.get" - } - ] - } - }, - "interfaces": [ - { - "moduleName": "配置模块", - "moduleKey": "config", - "moduleFolder": "config", - "method": "config.list", - "title": "config.list 接口", - "description": "config.list 接口", - "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 数组(stock_warehouse.id)" - }, - { - "name": "method", - "type": "string", - "required": true, - "description": "要修改的字段名,可选值:brand_name、prohibited_id、gross_weight、packing_requirements、managementFlags、stock_unit" - }, - { - "name": "value", - "type": "string|number|object", - "required": true, - "description": "修改值,类型依 method 而定:brand_name/packing_requirements/stock_unit 为 string(<=255 字符);prohibited_id 为 number(整数);gross_weight 为 number(正数,可含小数);managementFlags 为 object,必须包含 is_sn_mgmt/is_shelf_life_mgmt/is_batch_mgmt,值为 'Y' 或 'N'" - }, - { - "name": "values", - "type": "any", - "required": false, - "description": "兼容字段:当前实现以 `value` 为准,不使用 `values`。若客户端历史使用 `values`,请切换为 `value`。" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": false, - "description": "业务状态码,200 表示成功;405 表示参数/权限校验不通过;500 表示服务器错误" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "业务提示信息" - }, - { - "name": "data", - "type": "object", - "required": false, - "description": "成功时返回的结果对象" - } - ] - }, - { - "moduleName": "看板模块", - "moduleKey": "dashboard", - "moduleFolder": "dashboard", - "method": "dashboard.express_ratio", - "title": "dashboard.express_ratio 接口", - "description": "dashboard.express_ratio 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "看板模块", - "moduleKey": "dashboard", - "moduleFolder": "dashboard", - "method": "dashboard.hot_order_rank", - "title": "dashboard.hot_order_rank 接口", - "description": "dashboard.hot_order_rank 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "看板模块", - "moduleKey": "dashboard", - "moduleFolder": "dashboard", - "method": "dashboard.order_trend", - "title": "订单趋势统计:按小时统计当日订单数与发货数,包含汇总信息(订单总数、发货总数、发货率、峰值时段)。数据来源于真实数据库查询,已废弃旧版 mock 数据。", - "description": "订单趋势统计:按小时统计当日订单数与发货数,包含汇总信息(订单总数、发货总数、发货率、峰值时段)。数据来源于真实数据库查询,已废弃旧版 mock 数据。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token,从中解析 warehouseId(仓库上下文)" - } - ], - "params": [], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,200 表示成功" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "业务提示信息" - }, - { - "name": "data", - "type": "object", - "required": true, - "description": "成功时返回的趋势数据对象" - } - ] - }, - { - "moduleName": "看板模块", - "moduleKey": "dashboard", - "moduleFolder": "dashboard", - "method": "dashboard.platform_distribution", - "title": "dashboard.platform_distribution 接口", - "description": "dashboard.platform_distribution 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "看板模块", - "moduleKey": "dashboard", - "moduleFolder": "dashboard", - "method": "dashboard.storeStats", - "title": "dashboard.storeStats 接口", - "description": "dashboard.storeStats 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "看板模块", - "moduleKey": "dashboard", - "moduleFolder": "dashboard", - "method": "dashboard.warehouseStats", - "title": "dashboard.warehouseStats 接口", - "description": "dashboard.warehouseStats 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.fastWhereTree", - "title": "index.fastWhereTree 接口", - "description": "index.fastWhereTree 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "type", - "type": "string", - "required": false, - "description": "type 参数" - } - ], - "response": [] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.getCainiaoStfTemplates", - "title": "公共无参查询淘宝菜鸟标准模板列表;服务端调用淘宝开放平台 cainiao.cloudprint.stdtemplates.get,请求地址为 https://eco.taobao.com/router/rest,使用 TOP 公共签名参数。不需要用户授权,不下发 session,不依赖登录态、当前仓库或店铺授权。成功返回 data.platform_code='TB' 与标准模板数组,模板项统一字段为 template_id/template_name/template_url/cp_code/wp_code。", - "description": "公共无参查询淘宝菜鸟标准模板列表;服务端调用淘宝开放平台 cainiao.cloudprint.stdtemplates.get,请求地址为 https://eco.taobao.com/router/rest,使用 TOP 公共签名参数。不需要用户授权,不下发 session,不依赖登录态、当前仓库或店铺授权。成功返回 data.platform_code='TB' 与标准模板数组,模板项统一字段为 template_id/template_name/template_url/cp_code/wp_code。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200。" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "业务提示信息,成功时返回 ok。" - }, - { - "name": "data.platform_code", - "type": "string", - "required": true, - "description": "平台编码,固定返回 TB。" - }, - { - "name": "data.list", - "type": "array", - "required": true, - "description": "菜鸟标准模板列表;来源于 cainiao_cloudprint_stdtemplates_get_response.result.datas[*].standard_templates[*] 的宽松兼容解析结果,按统一字段 template_id/template_name/template_url/cp_code/wp_code 返回。" - } - ] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.getCOSUploadConfig", - "title": "index.getCOSUploadConfig 接口", - "description": "index.getCOSUploadConfig 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "data", - "type": "object", - "required": false, - "description": "data 参数" - } - ], - "response": [] - }, - { - "moduleName": "快递编码管理模块", - "moduleKey": "setting.express", - "moduleFolder": "setting.express", - "method": "index.getExpressList", - "title": "获取快递列表。默认返回系统基础快递与当前登录仓库自定义快递编码的合并结果:系统快递在前,仓库自定义编码在后,同一 `code` 仅保留首条(系统同码优先保留系统记录)。当 `systemOnly` 为真值(支持 `true`、`1`、`'1'`、`'true'`)时,仅返回系统基础快递列表。仅接受 `express_code` 入参,服务端会先 trim 再转为大写:`systemOnly=true` 时按系统快递编码过滤系统基础快递列表;`systemOnly=false` 时按自定义编码映射记录中的系统快递编码字段 `express_code` 过滤,仅返回当前登录仓库下匹配该系统快递编码的自定义编码列表,不再回传系统基础项。仓库范围来自当前登录用户 `ctx.user.store_id`;未识别到仓库时,自定义编码列表为空。接口优先读取缓存,未命中时回源 `wms_express` 与 `wms_express_setting`。", - "description": "获取快递列表。默认返回系统基础快递与当前登录仓库自定义快递编码的合并结果:系统快递在前,仓库自定义编码在后,同一 `code` 仅保留首条(系统同码优先保留系统记录)。当 `systemOnly` 为真值(支持 `true`、`1`、`'1'`、`'true'`)时,仅返回系统基础快递列表。仅接受 `express_code` 入参,服务端会先 trim 再转为大写:`systemOnly=true` 时按系统快递编码过滤系统基础快递列表;`systemOnly=false` 时按自定义编码映射记录中的系统快递编码字段 `express_code` 过滤,仅返回当前登录仓库下匹配该系统快递编码的自定义编码列表,不再回传系统基础项。仓库范围来自当前登录用户 `ctx.user.store_id`;未识别到仓库时,自定义编码列表为空。接口优先读取缓存,未命中时回源 `wms_express` 与 `wms_express_setting`。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "systemOnly", - "type": "boolean|number|string", - "required": false, - "description": "是否仅返回系统基础快递列表;仅 `true`、`1`、`'1'`、`'true'` 会被识别为 true,其余值按 false 处理" - }, - { - "name": "express_code", - "type": "string", - "required": false, - "description": "系统快递编码;服务端会去首尾空格并转为大写。`systemOnly=true` 时按该系统快递编码过滤系统基础快递列表;`systemOnly=false` 时按自定义映射记录中的系统快递编码字段 `express_code` 过滤当前仓库的自定义编码列表,而不是按自定义 `code` 过滤" - } - ], - "response": [ - { - "name": "flag", - "type": "string", - "required": true, - "description": "全局调用结果标识,成功时为 `success`" - }, - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "返回消息,成功时通常为 `ok`" - }, - { - "name": "data", - "type": "array", - "required": true, - "description": "快递列表数组。默认模式下先返回系统基础快递,再追加当前仓库自定义编码;当传入 `express_code` 且 `systemOnly=false` 时,仅返回当前仓库下系统快递编码等于该 `express_code` 的自定义映射记录,不返回系统基础项。每项字段如下:" - } - ] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.getI18nMessage", - "title": "index.getI18nMessage 接口", - "description": "index.getI18nMessage 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "language", - "type": "string", - "required": false, - "description": "language 参数" - } - ], - "response": [] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.getImages", - "title": "index.getImages 接口", - "description": "index.getImages 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.getLocationTypeList", - "title": "查询库位类型基础列表,优先返回当前仓库下启用的库位类型,同时合并系统公共类型;结果带 300 秒缓存", - "description": "查询库位类型基础列表,优先返回当前仓库下启用的库位类型,同时合并系统公共类型;结果带 300 秒缓存", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [ - { - "name": "list", - "type": "array", - "required": false, - "description": "库位类型列表" - }, - { - "name": "total", - "type": "number", - "required": false, - "description": "返回总数" - } - ] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.getMessageDetail", - "title": "index.getMessageDetail 接口", - "description": "index.getMessageDetail 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "平台编码管理模块", - "moduleKey": "setting.platform", - "moduleFolder": "setting.platform", - "method": "index.getPlatformList", - "title": "获取平台列表。默认返回系统基础平台与当前登录仓库自定义平台设置的合并结果:系统平台在前,仓库自定义编码在后,同一 `code` 仅保留首条(系统同码优先保留系统记录)。当 `systemOnly` 为真值(支持 `true`、`1`、`'1'`、`'true'`)时,仅返回系统基础平台列表。`full` 为真值时返回全量字段(包含 wms_platform 全部表字段、route_platform_code、platid 等)。仓库范围来自当前登录用户 `ctx.user.store_id`;未识别到仓库时,自定义设置列表为空。接口优先读取缓存,未命中时回源 `wms_platform` 与 `wms_platfrom_setting`。", - "description": "获取平台列表。默认返回系统基础平台与当前登录仓库自定义平台设置的合并结果:系统平台在前,仓库自定义编码在后,同一 `code` 仅保留首条(系统同码优先保留系统记录)。当 `systemOnly` 为真值(支持 `true`、`1`、`'1'`、`'true'`)时,仅返回系统基础平台列表。`full` 为真值时返回全量字段(包含 wms_platform 全部表字段、route_platform_code、platid 等)。仓库范围来自当前登录用户 `ctx.user.store_id`;未识别到仓库时,自定义设置列表为空。接口优先读取缓存,未命中时回源 `wms_platform` 与 `wms_platfrom_setting`。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "systemOnly", - "type": "boolean|number|string", - "required": false, - "description": "是否仅返回系统基础平台列表;仅 `true`、`1`、`'1'`、`'true'` 会被识别为 true,其余值按 false 处理。也支持 `is_system` 别名(若请求体中同时存在 `is_system` 和 `systemOnly`,优先使用 `is_system`)" - }, - { - "name": "full", - "type": "boolean|number|string", - "required": false, - "description": "是否返回全量字段;仅 `true`、`1`、`'1'`、`'true'` 会被识别为 true,其余值按 false 处理。为 true 时返回 wms_platform 全部表字段、route_platform_code、platid 等扩展信息" - } - ], - "response": [ - { - "name": "flag", - "type": "string", - "required": true, - "description": "全局调用结果标识,成功时为 `success`" - }, - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "返回消息,成功时通常为 `ok`" - }, - { - "name": "data", - "type": "array", - "required": true, - "description": "平台列表数组。默认模式下先返回系统基础平台,再追加当前仓库自定义设置;`systemOnly=true` 时仅返回系统基础平台。每项字段如下:" - } - ] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.getPlatformOauthLink", - "title": "获取平台授权链接。入参支持 code / platform_code / platformCode,服务端按首个非空值标准化为大写平台编码;会从当前登录上下文读取仓库 ID(ctx.user.store_id),再从 wms_platform.auth_base_url 读取授权基础地址。接口会优先复用当前仓库与平台下 status=0 的未授权记录;若历史 auth_random_code 带有当前配置前缀,则会先去前缀后以裸码回写,当前数据库最终保存的 auth_random_code 为裸码。若无可复用记录则生成新的裸码并写入 wms_shops。返回的 oauth_link 会从配置 platformOauthReservationCodePrefix 读取前缀(本地示例为 xxxxx_),按“前缀 + 平台编码 + '_' + 裸码”生成 state,并将 URL 编码后的 state 直接拼接到平台基础授权链接后,例如 xxxxx_PDD_。当前仅支持已按上述模式配置好的基础授权链接。", - "description": "获取平台授权链接。入参支持 code / platform_code / platformCode,服务端按首个非空值标准化为大写平台编码;会从当前登录上下文读取仓库 ID(ctx.user.store_id),再从 wms_platform.auth_base_url 读取授权基础地址。接口会优先复用当前仓库与平台下 status=0 的未授权记录;若历史 auth_random_code 带有当前配置前缀,则会先去前缀后以裸码回写,当前数据库最终保存的 auth_random_code 为裸码。若无可复用记录则生成新的裸码并写入 wms_shops。返回的 oauth_link 会从配置 platformOauthReservationCodePrefix 读取前缀(本地示例为 xxxxx_),按“前缀 + 平台编码 + '_' + 裸码”生成 state,并将 URL 编码后的 state 直接拼接到平台基础授权链接后,例如 xxxxx_PDD_。当前仅支持已按上述模式配置好的基础授权链接。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "code", - "type": "string", - "required": false, - "description": "平台编码主字段;与 platform_code / platformCode 三选一即可,服务端按 code -> platform_code -> platformCode 顺序取首个非空值并转为大写" - }, - { - "name": "platform_code", - "type": "string", - "required": false, - "description": "平台编码下划线别名" - }, - { - "name": "platformCode", - "type": "string", - "required": false, - "description": "平台编码驼峰别名" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200" - }, - { - "name": "data.platform_code", - "type": "string", - "required": true, - "description": "标准化后的平台编码" - }, - { - "name": "data.oauth_link", - "type": "string", - "required": true, - "description": "基于 wms_platform.auth_base_url 构造的授权链接;实际拼接值为 encodeURIComponent(prefix + platform_code + '_' + rawCode),其中 prefix 来自 platformOauthReservationCodePrefix,rawCode 为数据库 auth_random_code 中保存的裸码。基础授权链接需预先配置为可直接追加 state 值的模式。" - } - ] - }, - { - "moduleName": "快递接口管理模块", - "moduleKey": "setting.expressInterface", - "moduleFolder": "setting.expressinterface", - "method": "index.getPrintPlatformList", - "title": "获取打印平台全量列表。供前端新增、修改快递接口时下拉选择使用;仅返回未删除且状态为 `ACTIVE` 的打印平台,不分页,按 `platform_name` 升序、`id` 升序返回。接口不校验额外鉴权或权限点,但需要登录态。", - "description": "获取打印平台全量列表。供前端新增、修改快递接口时下拉选择使用;仅返回未删除且状态为 `ACTIVE` 的打印平台,不分页,按 `platform_name` 升序、`id` 升序返回。接口不校验额外鉴权或权限点,但需要登录态。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [], - "response": [ - { - "name": "flag", - "type": "string", - "required": true, - "description": "全局调用结果标识,成功时为 `success`" - }, - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "返回消息,成功时通常为 `ok`" - }, - { - "name": "data", - "type": "array", - "required": true, - "description": "打印平台列表数组,不分页,仅包含未删除且状态为 `ACTIVE` 的平台;按 `platform_name` 升序、`id` 升序返回。每项字段如下:" - } - ] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.getPrintPlatformTemplateList", - "title": "按打印平台与快递编码查询模板列表。express_code 为必填;接口会先按 platform_code(默认 CAINIAO)定位 wms_express 对应打印平台字段,再以 express_code 过滤可用模板后返回。", - "description": "按打印平台与快递编码查询模板列表。express_code 为必填;接口会先按 platform_code(默认 CAINIAO)定位 wms_express 对应打印平台字段,再以 express_code 过滤可用模板后返回。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "platform_code", - "type": "string", - "required": false, - "description": "打印平台编码(如 CAINIAO);不传默认 CAINIAO,服务端会转为大写。" - }, - { - "name": "express_code", - "type": "string", - "required": true, - "description": "快递编码(必填);服务端会转为大写,并用于按 wms_express 中对应打印平台字段筛选模板。" - } - ], - "response": [ - { - "name": "flag", - "type": "string", - "required": true, - "description": "全局结果标识;成功为 success,失败为 failure。" - }, - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码;成功时为 200。" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "提示信息;成功时为 ok。" - }, - { - "name": "data", - "type": "object", - "required": true, - "description": "返回数据对象。" - } - ] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.getShopExpressList", - "title": "获取指定店铺的快递签约/电子面单可用列表。接口依赖当前登录仓库上下文 ctx.user.store_id 校验店铺归属;服务端会按店铺所属平台拉取并收敛可用快递列表,统一返回前端消费结构;未接入的平台当前返回空列表。", - "description": "获取指定店铺的快递签约/电子面单可用列表。接口依赖当前登录仓库上下文 ctx.user.store_id 校验店铺归属;服务端会按店铺所属平台拉取并收敛可用快递列表,统一返回前端消费结构;未接入的平台当前返回空列表。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "shop_id", - "type": "string|number", - "required": false, - "description": "店铺 ID;与 shopId 兼容,二选一至少传一个。服务端按 shop_id、shopId 的顺序读取首个非空值。" - }, - { - "name": "shopId", - "type": "string|number", - "required": false, - "description": "店铺 ID 的驼峰兼容字段;当 shop_id 为空时读取该值。" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200。" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "业务提示信息,成功时返回 ok。" - }, - { - "name": "data.shop_id", - "type": "number", - "required": true, - "description": "当前店铺 ID。" - }, - { - "name": "data.platform_code", - "type": "string", - "required": true, - "description": "店铺所属平台编码,返回值按服务端实现转为大写。" - }, - { - "name": "data.list", - "type": "array", - "required": true, - "description": "服务端按店铺所属平台拉取并统一收敛后的快递签约/电子面单可用列表;未接入的平台返回空数组。" - } - ] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.getShopList", - "title": "获取当前登录仓库下的已授权店铺列表,支持按平台编码可选过滤。仓库上下文来自 ctx.user.store_id;服务端兼容读取 body.platform_code 与 body.platformCode,按该顺序取首个 trim 后非空值作为平台过滤条件。未传平台参数时返回当前登录仓库下全部已授权店铺;传入非空平台编码时仅返回该平台的已授权店铺。结果按 status DESC、updated_at DESC、id DESC 排序,并对敏感字段完成脱敏后返回 data.list。", - "description": "获取当前登录仓库下的已授权店铺列表,支持按平台编码可选过滤。仓库上下文来自 ctx.user.store_id;服务端兼容读取 body.platform_code 与 body.platformCode,按该顺序取首个 trim 后非空值作为平台过滤条件。未传平台参数时返回当前登录仓库下全部已授权店铺;传入非空平台编码时仅返回该平台的已授权店铺。结果按 status DESC、updated_at DESC、id DESC 排序,并对敏感字段完成脱敏后返回 data.list。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "platform_code", - "type": "string", - "required": false, - "description": "平台编码过滤条件;兼容 platformCode。服务端按 platform_code、platformCode 的顺序读取首个值,trim 后非空时仅返回该平台的已授权店铺;未传或为空时返回当前登录仓库下全部已授权店铺。" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "业务提示信息,成功时返回 ok" - }, - { - "name": "data.list", - "type": "array", - "required": true, - "description": "当前登录仓库下按条件过滤后的已授权店铺列表数组;未传平台参数时返回当前仓库全部已授权店铺,传入非空 platform_code/platformCode 时仅返回对应平台店铺。结果按 status DESC、updated_at DESC、id DESC 排序,且 owner_id、access_token、refresh_token、auth_random_code 已按实现规则脱敏。" - } - ] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.listInterfaceTypes", - "title": "查询可用的接口类型列表(如奇门仓储、开放接口等)", - "description": "查询可用的接口类型列表(如奇门仓储、开放接口等)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [], - "response": [] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.loadStores", - "title": "index.loadStores 接口", - "description": "index.loadStores 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.polyapiAuthorizeUrl", - "title": "生成菠萝派授权链接。该接口不接收请求参数,服务端会固定调用 Differ.JH.BuildeAuthorizeUrl,并以内置配置 this.app.config.poloApi.appKey / this.app.config.poloApi.secret 以及当前代码中写死的 callbackUrl=http://39.100.57.68/、state=123456、itemcode=test001 作为上游请求参数,最终将菠萝派接口原始响应包裹后返回。", - "description": "生成菠萝派授权链接。该接口不接收请求参数,服务端会固定调用 Differ.JH.BuildeAuthorizeUrl,并以内置配置 this.app.config.poloApi.appKey / this.app.config.poloApi.secret 以及当前代码中写死的 callbackUrl=http://39.100.57.68/、state=123456、itemcode=test001 作为上游请求参数,最终将菠萝派接口原始响应包裹后返回。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200。" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "业务提示信息,成功时返回 ok。" - }, - { - "name": "data.respone", - "type": "object", - "required": true, - "description": "菠萝派接口 Differ.JH.BuildeAuthorizeUrl 的原始响应对象。字段名按当前实现保持为 respone。" - } - ] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.putI18nCollect", - "title": "index.putI18nCollect 接口", - "description": "index.putI18nCollect 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "keys", - "type": "array", - "required": false, - "description": "keys 参数" - }, - { - "name": "locale", - "type": "string", - "required": false, - "description": "locale 参数" - }, - { - "name": "project", - "type": "string", - "required": false, - "description": "project 参数" - }, - { - "name": "source", - "type": "string", - "required": false, - "description": "source 参数" - } - ], - "response": [] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.recognizeLicensePlate", - "title": "识别车牌号码(通过 base64 图片)", - "description": "识别车牌号码(通过 base64 图片)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "base64", - "type": "string", - "required": true, - "description": "base64 图片,支持 data URL 前缀(data:image/...;base64,)或纯 base64 字符串" - }, - { - "name": "imageBase64", - "type": "string", - "required": false, - "description": "兼容字段(同 base64)" - }, - { - "name": "image_base64", - "type": "string", - "required": false, - "description": "兼容字段(同 base64)" - } - ], - "response": [ - { - "name": "licensePlate", - "type": "string", - "required": false, - "description": "识别到的车牌号(对外契约,仅返回该字段)" - } - ] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.ReferenceFile", - "title": "index.ReferenceFile 接口", - "description": "index.ReferenceFile 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.searchSpace", - "title": "按当前仓库上下文搜索库位(使用 ctx.user.store_id;仅在 location_space 表中按 space_code/custom_barcode 搜索)", - "description": "按当前仓库上下文搜索库位(使用 ctx.user.store_id;仅在 location_space 表中按 space_code/custom_barcode 搜索)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "keyword", - "type": "string", - "required": false, - "description": "搜索关键字,对 space_code 和 custom_barcode 做模糊匹配(%keyword%);为空时返回当前仓库下前 50 条" - } - ], - "response": [ - { - "name": "flag", - "type": "string", - "required": false, - "description": "全局调用结果标识,成功时为 success" - }, - { - "name": "code", - "type": "number", - "required": false, - "description": "业务状态码,200 表示成功" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "返回信息" - }, - { - "name": "data", - "type": "array", - "required": false, - "description": "库位数组(最多 50 条),每项包含以下字段" - }, - { - "name": "total", - "type": "number", - "required": false, - "description": "本次返回的记录条数(等于 data.length,≤50)" - } - ] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.test", - "title": "后台专用的拼多多开放平台测试接口,用于传入请求参数并发起真实请求,返回签名后的请求体和接口响应", - "description": "后台专用的拼多多开放平台测试接口,用于传入请求参数并发起真实请求,返回签名后的请求体和接口响应", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "type", - "type": "string", - "required": true, - "description": "拼多多接口名,例如 pdd.order.number.list.get" - }, - { - "name": "bizParams", - "type": "object", - "required": false, - "description": "业务参数对象,会参与签名和请求" - }, - { - "name": "request", - "type": "object", - "required": false, - "description": "bizParams 兼容字段" - }, - { - "name": "accessToken", - "type": "string", - "required": false, - "description": "用户授权令牌" - }, - { - "name": "access_token", - "type": "string", - "required": false, - "description": "accessToken 的下划线命名兼容字段" - }, - { - "name": "dataType", - "type": "string", - "required": false, - "description": "返回格式,默认 JSON" - }, - { - "name": "version", - "type": "string", - "required": false, - "description": "API 版本" - }, - { - "name": "timestamp", - "type": "string|number", - "required": false, - "description": "时间戳,不传则使用当前秒级时间戳" - }, - { - "name": "clientId", - "type": "string", - "required": false, - "description": "覆盖配置中的 client_id" - }, - { - "name": "clientSecret", - "type": "string", - "required": false, - "description": "覆盖配置中的 client_secret" - }, - { - "name": "baseUrl", - "type": "string", - "required": false, - "description": "请求地址,默认拼多多开放平台网关" - }, - { - "name": "headers", - "type": "object", - "required": false, - "description": "额外请求头" - }, - { - "name": "timeout", - "type": "number", - "required": false, - "description": "请求超时时间(毫秒)" - } - ], - "response": [ - { - "name": "requestBody", - "type": "object", - "required": false, - "description": "实际发送到 PDD 网关的请求体,已包含 sign" - }, - { - "name": "response", - "type": "any", - "required": false, - "description": "拼多多接口返回内容" - }, - { - "name": "baseUrl", - "type": "string", - "required": false, - "description": "实际请求地址" - } - ] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.tryAutoTranslateNewKeys", - "title": "index.tryAutoTranslateNewKeys 接口", - "description": "index.tryAutoTranslateNewKeys 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "moduleFolder": "index", - "method": "index.uploadSuccessNotify", - "title": "index.uploadSuccessNotify 接口", - "description": "index.uploadSuccessNotify 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "订单归档模块", - "moduleKey": "order.archiveOrder", - "moduleFolder": "order.archiveorder", - "method": "order.archiveOrder.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": "去重后的运单号字符串数组" - } - ] - }, - { - "moduleName": "订单归档模块", - "moduleKey": "order.archiveOrder", - "moduleFolder": "order.archiveorder", - "method": "order.archiveOrder.list", - "title": "归档订单列表,使用 history 模型。", - "description": "归档订单列表,使用 history 模型。", - "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 行数据)" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "moduleName": "订单工作台入口模块", - "moduleKey": "order.index", - "moduleFolder": "order.index", - "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+" - } - ] - }, - { - "moduleName": "订单工作台入口模块", - "moduleKey": "order.index", - "moduleFolder": "order.index", - "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 对象中)。" - } - ] - }, - { - "moduleName": "订单工作台入口模块", - "moduleKey": "order.index", - "moduleFolder": "order.index", - "method": "order.bindExpressPackageMaterialByWaybill", - "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": "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 对象中)。" - } - ] - }, - { - "moduleName": "订单配送异常模块", - "moduleKey": "order.deliveryExpectionOrder", - "moduleFolder": "order.deliveryexpectionorder", - "method": "order.deliveryExpectionOrder.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": "去重后的运单号字符串数组" - } - ] - }, - { - "moduleName": "订单配送异常模块", - "moduleKey": "order.deliveryExpectionOrder", - "moduleFolder": "order.deliveryexpectionorder", - "method": "order.deliveryExpectionOrder.list", - "title": "配送异常订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m5。", - "description": "配送异常订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m5。", - "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": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "moduleName": "订单配送模块", - "moduleKey": "order.deliveryOrder", - "moduleFolder": "order.deliveryorder", - "method": "order.deliveryOrder.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": true, - "description": "订单头对象(raw 行数据)" - }, - { - "name": "detail", - "type": "object", - "required": true, - "description": "等同于 order" - }, - { - "name": "orderItems / items", - "type": "array", - "required": true, - "description": "商品明细数组" - }, - { - "name": "expresses", - "type": "array", - "required": true, - "description": "运单信息数组,每个元素包含以下字段:waybill_code(运单号,string)、weighing_weight(称重重量,number|null)、sys_logistics_code(系统物流公司编码,string)、sys_logistics_name(系统物流公司名称,string)、logistics_code(实际物流公司编码,string)、logistics_name(实际物流公司名称,string)、logistics_interface_id(物流接口ID,number|null)、business_key(业务标识,string)、created_at(创建时间戳毫秒,number|null)、package_material_id(包材ID,number|null)、package_material_name_snapshot(包材名称快照,string|null)" - }, - { - "name": "waybill_codes", - "type": "array", - "required": true, - "description": "去重后的运单号字符串数组" - } - ] - }, - { - "moduleName": "订单配送模块", - "moduleKey": "order.deliveryOrder", - "moduleFolder": "order.deliveryorder", - "method": "order.deliveryOrder.list", - "title": "配送订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m4。", - "description": "配送订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m4。", - "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": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "moduleName": "订单工作台入口模块", - "moduleKey": "order.index", - "moduleFolder": "order.index", - "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": true, - "description": "订单头对象(raw 行数据)" - }, - { - "name": "detail", - "type": "object", - "required": true, - "description": "等同于 order" - }, - { - "name": "orderItems / items", - "type": "array", - "required": true, - "description": "商品明细数组" - }, - { - "name": "expresses", - "type": "array", - "required": true, - "description": "运单信息数组,每个元素包含以下字段:waybill_code(运单号,string)、weighing_weight(称重重量,number|null)、sys_logistics_code(系统物流公司编码,string)、sys_logistics_name(系统物流公司名称,string)、logistics_code(实际物流公司编码,string)、logistics_name(实际物流公司名称,string)、logistics_interface_id(物流接口ID,number|null)、business_key(业务标识,string)、created_at(创建时间戳毫秒,number|null)、package_material_id(包材ID,number|null)、package_material_name_snapshot(包材名称快照,string|null)" - }, - { - "name": "waybill_codes", - "type": "array", - "required": true, - "description": "去重后的运单号字符串数组" - } - ] - }, - { - "moduleName": "订单委托外仓模块", - "moduleKey": "order.entrustOrder", - "moduleFolder": "order.entrustorder", - "method": "order.entrustOrder.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": "去重后的运单号字符串数组" - } - ] - }, - { - "moduleName": "订单委托外仓模块", - "moduleKey": "order.entrustOrder", - "moduleFolder": "order.entrustorder", - "method": "order.entrustOrder.list", - "title": "委托外仓订单列表,使用 outsourced 模型。", - "description": "委托外仓订单列表,使用 outsourced 模型。", - "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": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "moduleName": "订单异常模块", - "moduleKey": "order.expectionOrder", - "moduleFolder": "order.expectionorder", - "method": "order.expectionOrder.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": "去重后的运单号字符串数组" - } - ] - }, - { - "moduleName": "订单异常模块", - "moduleKey": "order.expectionOrder", - "moduleFolder": "order.expectionorder", - "method": "order.expectionOrder.list", - "title": "待处理异常订单列表,默认仅查询 step=3 的订单。", - "description": "待处理异常订单列表,默认仅查询 step=3 的订单。", - "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": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "moduleName": "订单异常模块", - "moduleKey": "order.expectionOrder", - "moduleFolder": "order.expectionorder", - "method": "order.expectionOrder.resolveException", - "title": "将待处理异常订单转回正常待处理状态(step 3 → 2)。只操作当前仓库的当前订单表,且仅对 step=3 的订单生效。", - "description": "将待处理异常订单转回正常待处理状态(step 3 → 2)。只操作当前仓库的当前订单表,且仅对 step=3 的订单生效。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "ids", - "type": "number[]", - "required": true, - "description": "订单ID 正整数数组,不能为空" - } - ], - "response": [ - { - "name": "updated_count", - "type": "number", - "required": true, - "description": "实际更新行数" - }, - { - "name": "ids", - "type": "number[]", - "required": true, - "description": "本次操作的订单ID 列表" - } - ] - }, - { - "moduleName": "订单工作台入口模块", - "moduleKey": "order.index", - "moduleFolder": "order.index", - "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 字符串)" - } - ] - }, - { - "moduleName": "订单工作台入口模块", - "moduleKey": "order.index", - "moduleFolder": "order.index", - "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 字符串)" - } - ] - }, - { - "moduleName": "订单工作台入口模块", - "moduleKey": "order.index", - "moduleFolder": "order.index", - "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)" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "moduleName": "订单工作台入口模块", - "moduleKey": "order.index", - "moduleFolder": "order.index", - "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 等字段" - } - ] - }, - { - "moduleName": "订单待出库模块", - "moduleKey": "order.outboundOrder", - "moduleFolder": "order.outboundorder", - "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": "去重后的运单号字符串数组" - } - ] - }, - { - "moduleName": "订单待出库模块", - "moduleKey": "order.outboundOrder", - "moduleFolder": "order.outboundorder", - "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": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "moduleName": "订单待出库模块", - "moduleKey": "order.outboundOrder", - "moduleFolder": "order.outboundorder", - "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 等字段" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "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 等字段" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "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": "受理提示信息,通常为 '请求已受理,后端异步处理中' 或错误说明" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "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": "额外提示信息" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "method": "order.pendingOrder.batchIntercept", - "title": "批量提交订单拦截请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 intercept_status 更新为 'requested' 并写入操作日志(ORDER_INTERCEPT_REQUEST)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", - "description": "批量提交订单拦截请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 intercept_status 更新为 'requested' 并写入操作日志(ORDER_INTERCEPT_REQUEST)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.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", - "type": "number[]", - "required": true, - "description": "订单ID数组;优先级 order_ids > orderIds > ids" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "外部指定任务ID(用于幂等提交,不传则自动生成)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID,格式 recheck_intercept_{warehouseId}_{timestamp}_{rand}(幂等提交时返回已有任务的 task_id)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID(取自当前上下文)" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "任务提交状态说明:'批量拦截任务已提交。' 或 '批量拦截任务已存在,请勿重复提交。'" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO 字符串)" - }, - { - "name": "status", - "type": "string", - "required": false, - "description": "提交状态(固定为 'success')" - }, - { - "name": "state", - "type": "string", - "required": false, - "description": "幂等提交时返回已有任务的状态:submitted / running / success / failed" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "method": "order.pendingOrder.batchInterceptTaskProgress", - "title": "查询批量拦截任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已拦截订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", - "description": "查询批量拦截任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已拦截订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、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" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态:submitted / running / success / failed / not_found" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "仓库ID(not_found 时不返回)" - }, - { - "name": "submitted_at", - "type": "number|null", - "required": false, - "description": "任务提交时间戳(毫秒)" - }, - { - "name": "start_time", - "type": "number|null", - "required": false, - "description": "任务开始执行时间戳(毫秒,running/success/failed 时返回)" - }, - { - "name": "end_time", - "type": "number|null", - "required": false, - "description": "任务结束时间戳(毫秒,success/failed 时返回)" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比 0-100(submitted/running/success/failed 时返回)" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "总订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数(仅 submitted/running 时返回)" - }, - { - "name": "intercepted_order_count", - "type": "number", - "required": false, - "description": "已拦截订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "intercepted_order_ids", - "type": "number[]", - "required": false, - "description": "已拦截订单ID列表(仅 success 时返回)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒,success/failed 时返回)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "错误信息(仅 failed 时返回)" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "错误码(仅 failed 时返回,默认 'BATCH_INTERCEPT_FAILED')" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "method": "order.pendingOrder.batchLock", - "title": "批量提交订单锁定请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 lock_status 更新为 'warehouse' 并写入操作日志(ORDER_LOCK)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", - "description": "批量提交订单锁定请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 lock_status 更新为 'warehouse' 并写入操作日志(ORDER_LOCK)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.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", - "type": "number[]", - "required": true, - "description": "订单ID数组;优先级 order_ids > orderIds > ids" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "外部指定任务ID(用于幂等提交,不传则自动生成)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID,格式 order_lock_{warehouseId}_{timestamp}_{rand}(幂等提交时返回已有任务的 task_id)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID(取自当前上下文)" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "任务提交状态说明:'批量锁定任务已提交。' 或 '批量锁定任务已存在,请勿重复提交。'" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO 字符串)" - }, - { - "name": "status", - "type": "string", - "required": false, - "description": "提交状态(固定为 'success')" - }, - { - "name": "state", - "type": "string", - "required": false, - "description": "幂等提交时返回已有任务的状态:submitted / running / success / failed" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "method": "order.pendingOrder.batchLockTaskProgress", - "title": "查询批量锁定任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已锁定订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", - "description": "查询批量锁定任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已锁定订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、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" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态:submitted / running / success / failed / not_found" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "仓库ID(not_found 时不返回)" - }, - { - "name": "submitted_at", - "type": "number|null", - "required": false, - "description": "任务提交时间戳(毫秒)" - }, - { - "name": "start_time", - "type": "number|null", - "required": false, - "description": "任务开始执行时间戳(毫秒,running/success/failed 时返回)" - }, - { - "name": "end_time", - "type": "number|null", - "required": false, - "description": "任务结束时间戳(毫秒,success/failed 时返回)" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比 0-100(submitted/running/success/failed 时返回)" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "总订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数(仅 submitted/running 时返回)" - }, - { - "name": "locked_order_count", - "type": "number", - "required": false, - "description": "已锁定订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "locked_order_ids", - "type": "number[]", - "required": false, - "description": "已锁定订单ID列表(仅 success 时返回)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒,success/failed 时返回)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "错误信息(仅 failed 时返回)" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "错误码(仅 failed 时返回,默认 'BATCH_LOCK_FAILED')" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "method": "order.pendingOrder.batchUnintercept", - "title": "批量提交解除拦截请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 intercept_status 更新为 'none' 并写入操作日志(ORDER_INTERCEPT_CANCEL)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", - "description": "批量提交解除拦截请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 intercept_status 更新为 'none' 并写入操作日志(ORDER_INTERCEPT_CANCEL)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.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", - "type": "number[]", - "required": true, - "description": "订单ID数组;优先级 order_ids > orderIds > ids" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "外部指定任务ID(用于幂等提交,不传则自动生成)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID,格式 order_unintercept_{warehouseId}_{timestamp}_{rand}(幂等提交时返回已有任务的 task_id)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID(取自当前上下文)" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "任务提交状态说明:'批量解除拦截任务已提交。' 或 '批量解除拦截任务已存在,请勿重复提交。'" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO 字符串)" - }, - { - "name": "status", - "type": "string", - "required": false, - "description": "提交状态(固定为 'success')" - }, - { - "name": "state", - "type": "string", - "required": false, - "description": "幂等提交时返回已有任务的状态:submitted / running / success / failed" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "method": "order.pendingOrder.batchUninterceptTaskProgress", - "title": "查询批量解除拦截任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已解除拦截订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", - "description": "查询批量解除拦截任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已解除拦截订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、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" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态:submitted / running / success / failed / not_found" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "仓库ID(not_found 时不返回)" - }, - { - "name": "submitted_at", - "type": "number|null", - "required": false, - "description": "任务提交时间戳(毫秒)" - }, - { - "name": "start_time", - "type": "number|null", - "required": false, - "description": "任务开始执行时间戳(毫秒,running/success/failed 时返回)" - }, - { - "name": "end_time", - "type": "number|null", - "required": false, - "description": "任务结束时间戳(毫秒,success/failed 时返回)" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比 0-100(submitted/running/success/failed 时返回)" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "总订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数(仅 submitted/running 时返回)" - }, - { - "name": "unintercepted_order_count", - "type": "number", - "required": false, - "description": "已解除拦截订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "unintercepted_order_ids", - "type": "number[]", - "required": false, - "description": "已解除拦截订单ID列表(仅 success 时返回)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒,success/failed 时返回)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "错误信息(仅 failed 时返回)" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "错误码(仅 failed 时返回,默认 'BATCH_UNINTERCEPT_FAILED')" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "method": "order.pendingOrder.batchUnlock", - "title": "批量提交订单解锁请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 lock_status 更新为 'none' 并写入操作日志(ORDER_UNLOCK)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", - "description": "批量提交订单解锁请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 lock_status 更新为 'none' 并写入操作日志(ORDER_UNLOCK)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.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", - "type": "number[]", - "required": true, - "description": "订单ID数组;优先级 order_ids > orderIds > ids" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "外部指定任务ID(用于幂等提交,不传则自动生成)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID,格式 order_unlock_{warehouseId}_{timestamp}_{rand}(幂等提交时返回已有任务的 task_id)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID(取自当前上下文)" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "任务提交状态说明:'批量解锁任务已提交。' 或 '批量解锁任务已存在,请勿重复提交。'" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO 字符串)" - }, - { - "name": "status", - "type": "string", - "required": false, - "description": "提交状态(固定为 'success')" - }, - { - "name": "state", - "type": "string", - "required": false, - "description": "幂等提交时返回已有任务的状态:submitted / running / success / failed" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "method": "order.pendingOrder.batchUnlockTaskProgress", - "title": "查询批量解锁任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已解锁订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", - "description": "查询批量解锁任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已解锁订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、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" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态:submitted / running / success / failed / not_found" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "仓库ID(not_found 时不返回)" - }, - { - "name": "submitted_at", - "type": "number|null", - "required": false, - "description": "任务提交时间戳(毫秒)" - }, - { - "name": "start_time", - "type": "number|null", - "required": false, - "description": "任务开始执行时间戳(毫秒,running/success/failed 时返回)" - }, - { - "name": "end_time", - "type": "number|null", - "required": false, - "description": "任务结束时间戳(毫秒,success/failed 时返回)" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比 0-100(submitted/running/success/failed 时返回)" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "总订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数(仅 submitted/running 时返回)" - }, - { - "name": "unlocked_order_count", - "type": "number", - "required": false, - "description": "已解锁订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "unlocked_order_ids", - "type": "number[]", - "required": false, - "description": "已解锁订单ID列表(仅 success 时返回)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒,success/failed 时返回)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "错误信息(仅 failed 时返回)" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "错误码(仅 failed 时返回,默认 'BATCH_UNLOCK_FAILED')" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "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": "取消分配汇总结果,包含下列字段" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "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 列表" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "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(克隆生成)" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "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": true, - "description": "省份(必填,空值返回 400)" - }, - { - "name": "city", - "type": "string", - "required": true, - "description": "城市(必填,空值返回 400)" - }, - { - "name": "area", - "type": "string", - "required": true, - "description": "区/县(必填,空值返回 400)" - }, - { - "name": "town", - "type": "string", - "required": false, - "description": "镇/街道" - }, - { - "name": "zip_code", - "type": "string", - "required": false, - "description": "邮编" - }, - { - "name": "items", - "type": "array", - "required": true, - "description": "订单明细数组,每项含 item_id(商品主键,必填,正整数)和 plan_qty(计划数量,正整数);item_name(优先外部传入,其次从 StockStore 缓存获取,最后兜底'商品')、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": "shop_nick", - "type": "string", - "required": false, - "description": "店铺名称(自定义),最大长度 200" - }, - { - "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": "商品总件数" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "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": "去重后的运单号字符串数组" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order", - "moduleFolder": "order", - "method": "order.pendingOrder.downloadCreateTemplate", - "title": "下载创建订单的 Excel 导入模板。返回 base64 编码的 xlsx 文件,前端解码后作为 .xlsx 附件下载。表头中标注 * 的列为必填项(橙色背景),可选列为灰色背景,包含示例数据行和填写说明工作表。多行相同订单号的行组成一个完整订单,每行代表一条商品明细。模板共 25 列(A-Y):店铺名称(shop_nick)位于第2列B列,紧接*订单号(delivery_order_code)之后;其余必填列为*收件人姓名(name)、*手机号(mobile)、*详细地址(detail_address)、*商品编码(item_code)、*计划数量(plan_qty);非必填列依次为货主ID(store_id)、电话(tel)、省份(province)、城市(city)、区/县(area)、镇/街道(town)、邮编(zip_code)、快递编码(logistics_code)、快递名称(logistics_name)、系统平台编码(sys_platform_code)、来源平台编码(source_platform_code)、来源订单号(source_order_codes)、订单类型(order_type)、是否紧急(is_urgency)、是否需要发票(invoice_flag)、商品名称(item_name)、行号(order_line_no)、实际价格(actual_price)。", - "description": "下载创建订单的 Excel 导入模板。返回 base64 编码的 xlsx 文件,前端解码后作为 .xlsx 附件下载。表头中标注 * 的列为必填项(橙色背景),可选列为灰色背景,包含示例数据行和填写说明工作表。多行相同订单号的行组成一个完整订单,每行代表一条商品明细。模板共 25 列(A-Y):店铺名称(shop_nick)位于第2列B列,紧接*订单号(delivery_order_code)之后;其余必填列为*收件人姓名(name)、*手机号(mobile)、*详细地址(detail_address)、*商品编码(item_code)、*计划数量(plan_qty);非必填列依次为货主ID(store_id)、电话(tel)、省份(province)、城市(city)、区/县(area)、镇/街道(town)、邮编(zip_code)、快递编码(logistics_code)、快递名称(logistics_name)、系统平台编码(sys_platform_code)、来源平台编码(source_platform_code)、来源订单号(source_order_codes)、订单类型(order_type)、是否紧急(is_urgency)、是否需要发票(invoice_flag)、商品名称(item_name)、行号(order_line_no)、实际价格(actual_price)。", - "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": "建议保存的文件名,固定为 创建订单导入模板.xlsx" - }, - { - "name": "mime", - "type": "string", - "required": true, - "description": "文件 MIME 类型,固定为 application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "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(失败原因)" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "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": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order", - "moduleFolder": "order", - "method": "order.pendingOrder.manualWaybill", - "title": "手工录入运单号。为指定待处理订单创建一条运单记录(wms_order_express 表),仅允许 step 在 [1,2,3] 且 outbound_status 不为 'padding' 的订单操作。完成后自动更新订单表的 print_status 与 post_status 为 'fin',表示外部已打印。", - "description": "手工录入运单号。为指定待处理订单创建一条运单记录(wms_order_express 表),仅允许 step 在 [1,2,3] 且 outbound_status 不为 'padding' 的订单操作。完成后自动更新订单表的 print_status 与 post_status 为 'fin',表示外部已打印。", - "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", - "required": true, - "description": "订单 ID,必须为正整数" - }, - { - "name": "waybill_code", - "type": "string", - "required": true, - "description": "运单号,非空字符串" - }, - { - "name": "logistics_interface_name", - "type": "string", - "required": false, - "description": "物流接口名称(选填),手工填入的值,trim 后为空则传 null" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "创建的运单记录 ID" - }, - { - "name": "order_id", - "type": "number", - "required": true, - "description": "订单 ID" - }, - { - "name": "waybill_code", - "type": "string", - "required": true, - "description": "运单号" - }, - { - "name": "business_key", - "type": "number", - "required": true, - "description": "递增的业务键,同一订单下从 1 开始递增" - }, - { - "name": "logistics_interface_name", - "type": "string", - "required": false, - "description": "写入的物流接口名称,未传时为 null" - }, - { - "name": "create_at", - "type": "string", - "required": true, - "description": "创建时间" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "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 列表" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "method": "order.pendingOrder.parseAddress", - "title": "智能地址解析:使用 AI 将非结构化地址字符串解析为省/市/区/详细地址/收件人/手机号", - "description": "智能地址解析:使用 AI 将非结构化地址字符串解析为省/市/区/详细地址/收件人/手机号", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "address", - "type": "string", - "required": true, - "description": "原始地址字符串(必填),如\"张三 13800138000 广东省广州市天河区体育西路100号\"" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "1=成功,0=失败" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "提示消息" - }, - { - "name": "data", - "type": "object", - "required": false, - "description": "解析成功时返回 province/city/area/detailAddress/name/mobile" - }, - { - "name": "data.province", - "type": "string", - "required": false, - "description": "省份,如 广东省" - }, - { - "name": "data.city", - "type": "string", - "required": false, - "description": "城市,如 广州市" - }, - { - "name": "data.area", - "type": "string", - "required": false, - "description": "区/县,如 天河区" - }, - { - "name": "data.town", - "type": "string", - "required": false, - "description": "乡镇/街道,如 员村街道" - }, - { - "name": "data.detailAddress", - "type": "string", - "required": false, - "description": "详细地址,如 体育西路100号" - }, - { - "name": "data.name", - "type": "string", - "required": false, - "description": "收件人姓名,如 张三" - }, - { - "name": "data.mobile", - "type": "string", - "required": false, - "description": "收件人手机号,如 13800138000" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "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 列表" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "method": "order.pendingOrder.syncOrderIds", - "title": "同步待处理订单入口,支持批量传入 order_ids。服务端会按 create_channel 分组派发同步任务;若命中 SN 管理订单(is_sn_mgmt=Y),该订单会被拦截并标记失败,不允许走批量回传,需改用单订单回传。", - "description": "同步待处理订单入口,支持批量传入 order_ids。服务端会按 create_channel 分组派发同步任务;若命中 SN 管理订单(is_sn_mgmt=Y),该订单会被拦截并标记失败,不允许走批量回传,需改用单订单回传。", - "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。服务端会校验订单状态并执行批量同步拦截规则(含 SN 订单限制)。" - } - ], - "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" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "method": "order.pendingOrder.updateAddress", - "title": "批量修改待处理订单的收件地址信息和备注。地址字段修改仅允许 post_status='none'(未分配快递)的订单;remark 字段修改不受 post_status 限制可对所有订单生效。至少需要提供一个地址字段(name/mobile/tel/zip_code/province/city/area/town/detail_address)或 remark,空值和纯空白会被忽略。更新成功后写入操作日志。", - "description": "批量修改待处理订单的收件地址信息和备注。地址字段修改仅允许 post_status='none'(未分配快递)的订单;remark 字段修改不受 post_status 限制可对所有订单生效。至少需要提供一个地址字段(name/mobile/tel/zip_code/province/city/area/town/detail_address)或 remark,空值和纯空白会被忽略。更新成功后写入操作日志。", - "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": "number[]", - "required": true, - "description": "订单ID 正整数数组,不能为空" - }, - { - "name": "name", - "type": "string", - "required": false, - "description": "收件人姓名" - }, - { - "name": "mobile", - "type": "string", - "required": false, - "description": "收件人手机号" - }, - { - "name": "tel", - "type": "string", - "required": false, - "description": "收件人电话" - }, - { - "name": "zip_code", - "type": "string", - "required": false, - "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": "detail_address", - "type": "string", - "required": false, - "description": "详细地址" - }, - { - "name": "remark", - "type": "string", - "required": false, - "description": "订单留言/备注,最大500字符。非空时批量覆盖所选订单的 remark 字段,不受 post_status 限制。" - } - ], - "response": [ - { - "name": "updated_count", - "type": "number", - "required": true, - "description": "实际更新的订单行数(取地址更新行数与备注更新行数的最大值)。remark 字段的更新计数独立于地址字段。" - }, - { - "name": "ids", - "type": "number[]", - "required": true, - "description": "请求的订单ID数组(原样返回)" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "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": "写入的快递名称(自定义或系统)" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "moduleFolder": "order.pendingorder", - "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": "更新后的平台名称" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "order.print", - "moduleFolder": "order.print", - "method": "order.print.getOrderPrintData", - "title": "按订单ID拉取平台打印中间态数据,与 getWavePlatformPrintData 返回结构一致。不限制打印锁定状态,所有订单(包括已锁定)统一返回。仓库ID统一从当前上下文获取,无需调用方传入。自动过滤快递未完全分配的订单(post_status !== 'fin'),返回 waveGroups(波次 -> 平台 -> 订单)结构。", - "description": "按订单ID拉取平台打印中间态数据,与 getWavePlatformPrintData 返回结构一致。不限制打印锁定状态,所有订单(包括已锁定)统一返回。仓库ID统一从当前上下文获取,无需调用方传入。自动过滤快递未完全分配的订单(post_status !== 'fin'),返回 waveGroups(波次 -> 平台 -> 订单)结构。", - "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", - "type": "array", - "required": true, - "description": "订单ID列表(支持数字或字符串,内部自动去重与归一化,必须为非空数组)" - } - ], - "response": [ - { - "name": "summary", - "type": "object", - "required": true, - "description": "汇总信息" - }, - { - "name": "wave_ids", - "type": "array", - "required": true, - "description": "通过过滤的波次ID数组" - }, - { - "name": "waveGroups", - "type": "array", - "required": true, - "description": "主返回结构:按波次分组(波次 -> 平台 -> 订单)" - }, - { - "name": "ext", - "type": "object", - "required": true, - "description": "扩展字段" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "order.print", - "moduleFolder": "order.print", - "method": "order.print.getWavePlatformPrintData", - "title": "按波次 IDs 获取平台打印中间态数据,自动过滤快递未完全分配的波次,返回 waveGroups(波次 -> 平台 -> 订单)结构", - "description": "按波次 IDs 获取平台打印中间态数据,自动过滤快递未完全分配的波次,返回 waveGroups(波次 -> 平台 -> 订单)结构", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID(必须与当前用户上下文 store_id 一致)" - }, - { - "name": "wave_ids", - "type": "array", - "required": true, - "description": "波次ID列表(支持数字或字符串,内部自动去重与归一化)" - } - ], - "response": [ - { - "name": "summary", - "type": "object", - "required": false, - "description": "汇总信息" - }, - { - "name": "wave_ids", - "type": "array", - "required": false, - "description": "通过过滤的波次ID数组" - }, - { - "name": "waveGroups", - "type": "array", - "required": false, - "description": "主返回结构:按波次分组(波次 -> 平台 -> 订单)" - }, - { - "name": "platform_groups", - "type": "array", - "required": false, - "description": "兼容字段:按平台分组结果(保留以兼容旧客户端)" - }, - { - "name": "order_list", - "type": "array", - "required": false, - "description": "兼容字段:逐单平台打印中间态明细(保留以兼容旧客户端)" - }, - { - "name": "ext", - "type": "object", - "required": false, - "description": "扩展字段" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "order.print", - "moduleFolder": "order.print", - "method": "order.print.getWavePrintData", - "title": "按波次 IDs 获取订单打印数据,自动过滤快递未完全分配的波次,返回通过过滤的波次订单明细,按波次号分组", - "description": "按波次 IDs 获取订单打印数据,自动过滤快递未完全分配的波次,返回通过过滤的波次订单明细,按波次号分组", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID" - }, - { - "name": "wave_ids", - "type": "array", - "required": true, - "description": "波次ID列表(支持数字或字符串,内部自动去重与归一化)" - } - ], - "response": [ - { - "name": "summary", - "type": "object", - "required": false, - "description": "汇总信息" - }, - { - "name": "wave_list", - "type": "array", - "required": false, - "description": "波次列表(按 wave_no 排序)" - }, - { - "name": "ext", - "type": "object", - "required": false, - "description": "扩展字段" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "order.print", - "moduleFolder": "order.print", - "method": "order.print.unlockWavePlatformPrintDataByGroup", - "title": "按分组解锁波次平台打印锁:按传入的 groups 条件匹配已锁定订单并将其 print_lock_status 置为 none,返回解锁统计与解锁订单列表。", - "description": "按分组解锁波次平台打印锁:按传入的 groups 条件匹配已锁定订单并将其 print_lock_status 置为 none,返回解锁统计与解锁订单列表。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID(必须与当前用户上下文 store_id 一致)" - }, - { - "name": "wave_ids", - "type": "array", - "required": true, - "description": "波次ID列表(支持数字或字符串,内部自动去重与归一化)" - }, - { - "name": "group_type", - "type": "string", - "required": false, - "description": "分组类型,支持 platform、platform_express、order;默认 platform_express" - }, - { - "name": "unlock_scope", - "type": "string", - "required": false, - "description": "解锁范围,支持 group、wave;默认 group" - }, - { - "name": "groups", - "type": "array", - "required": true, - "description": "分组条件列表。元素为对象,可包含字段:wave_id(必填)、platform(平台编码)、sys_logistics_code(系统快递编码)、order_ids(订单ID数组)" - } - ], - "response": [ - { - "name": "summary", - "type": "object", - "required": true, - "description": "解锁操作的汇总统计" - }, - { - "name": "wave_ids", - "type": "array", - "required": true, - "description": "通过过滤的波次ID数组" - }, - { - "name": "unlocked_order_ids", - "type": "array", - "required": true, - "description": "被解锁的订单ID数组" - }, - { - "name": "unlocked_orders", - "type": "array", - "required": true, - "description": "被解锁订单简要信息列表" - }, - { - "name": "ext", - "type": "object", - "required": false, - "description": "扩展字段" - } - ] - }, - { - "moduleName": "订单工作台入口模块", - "moduleKey": "order.index", - "moduleFolder": "order.index", - "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 等。" - } - ] - }, - { - "moduleName": "订单工作台入口模块", - "moduleKey": "order.index", - "moduleFolder": "order.index", - "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" - } - ] - }, - { - "moduleName": "订单复核模块", - "moduleKey": "order.recheckOrder", - "moduleFolder": "order.recheckorder", - "method": "order.recheckOrder.batchQuickRecheck", - "title": "批量快捷复核:传入订单 IDs 列表,对每个有效订单执行前置检查(已分配储位、已分配快递、已同步且未被拦截),必要时自动完成拣货(含库存锁定校验与扣减、库存流水写入、拣货任务状态同步)后标记复核(含复核任务记录、任务复核状态更新、车任务解绑、操作日志)。每个订单在独立事务中执行,支持部分失败,不满足条件的订单跳过并返回原因。", - "description": "批量快捷复核:传入订单 IDs 列表,对每个有效订单执行前置检查(已分配储位、已分配快递、已同步且未被拦截),必要时自动完成拣货(含库存锁定校验与扣减、库存流水写入、拣货任务状态同步)后标记复核(含复核任务记录、任务复核状态更新、车任务解绑、操作日志)。每个订单在独立事务中执行,支持部分失败,不满足条件的订单跳过并返回原因。", - "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|string", - "required": true, - "description": "订单 ID 列表,支持数组或以逗号分隔的字符串" - } - ], - "response": [ - { - "name": "success", - "type": "array", - "required": true, - "description": "复核成功的订单列表" - }, - { - "name": "failed", - "type": "array", - "required": true, - "description": "复核失败的订单列表" - }, - { - "name": "success_count", - "type": "number", - "required": true, - "description": "成功数量" - }, - { - "name": "failed_count", - "type": "number", - "required": true, - "description": "失败数量" - } - ] - }, - { - "moduleName": "订单复核模块", - "moduleKey": "order.recheckOrder", - "moduleFolder": "order.recheckorder", - "method": "order.recheckOrder.confirmIntercept", - "title": "确认拦截:通过订单ID直接匹配订单,将其拦截状态更新为 intercepted_at_warehouse(仓库已拦截)。仅拦截当前指定订单,不波及波次内其他订单。操作成功后写入操作日志(ORDER_INTERCEPT_CONFIRM),日志写入失败不影响主流程。", - "description": "确认拦截:通过订单ID直接匹配订单,将其拦截状态更新为 intercepted_at_warehouse(仓库已拦截)。仅拦截当前指定订单,不波及波次内其他订单。操作成功后写入操作日志(ORDER_INTERCEPT_CONFIRM),日志写入失败不影响主流程。", - "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", - "required": true, - "description": "订单 ID" - } - ], - "response": [ - { - "name": "order_id", - "type": "number", - "required": true, - "description": "订单 ID" - }, - { - "name": "order_no", - "type": "string", - "required": true, - "description": "订单号(优先 delivery_order_code,其次 pre_delivery_order_code)" - }, - { - "name": "intercept_status", - "type": "string", - "required": true, - "description": "拦截状态(固定为 'intercepted_at_warehouse')" - }, - { - "name": "updated_at", - "type": "string", - "required": true, - "description": "更新时间(ISO 字符串)" - } - ] - }, - { - "moduleName": "订单复核模块", - "moduleKey": "order.recheckOrder", - "moduleFolder": "order.recheckorder", - "method": "order.recheckOrder.confirmRecheck", - "title": "按订单 ID 确认复核并记录复核任务到 wms_recheck_task(入参兼容 id/orderId)。确认复核后,若该订单所属波次拣货任务下所有订单均已复核完成,则自动解绑车任务:清空 wms_wave_pick_task 的车绑定信息(current_cart_id、current_cart_code_snapshot)、停用 wms_pick_task_cart_binding 绑定记录(is_active=0 并记录解绑人和时间)并释放 wms_pick_cart(清空 current_task_id、bind_user_id)。解绑失败仅记录 warn 日志,不影响复核主流程。", - "description": "按订单 ID 确认复核并记录复核任务到 wms_recheck_task(入参兼容 id/orderId)。确认复核后,若该订单所属波次拣货任务下所有订单均已复核完成,则自动解绑车任务:清空 wms_wave_pick_task 的车绑定信息(current_cart_id、current_cart_code_snapshot)、停用 wms_pick_task_cart_binding 绑定记录(is_active=0 并记录解绑人和时间)并释放 wms_pick_cart(清空 current_task_id、bind_user_id)。解绑失败仅记录 warn 日志,不影响复核主流程。", - "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;优先使用 order_id,兼容别名 id 与 orderId" - } - ], - "response": [ - { - "name": "order_id", - "type": "number", - "required": true, - "description": "订单 ID" - }, - { - "name": "waybill_no", - "type": "string", - "required": true, - "description": "运单号" - }, - { - "name": "recheck_status", - "type": "string", - "required": true, - "description": "复核结果状态(固定为 'fin')" - }, - { - "name": "recheck_time", - "type": "string", - "required": true, - "description": "复核时间(ISO 字符串)" - }, - { - "name": "review_no", - "type": "string", - "required": true, - "description": "复核任务编号" - } - ] - }, - { - "moduleName": "订单复核模块", - "moduleKey": "order.recheckOrder", - "moduleFolder": "order.recheckorder", - "method": "order.recheckOrder.queryRecheckOrderSingleList", - "title": "散单模式复核列表查询,按订单维度返回待复核订单(排除 pick_status='none' 和 recheck_status='fin'),支持分页与关键词/波次号/复核状态筛选。与 recheckOrderList 不同:本方法仅处理散单模式,不包含团购分支。", - "description": "散单模式复核列表查询,按订单维度返回待复核订单(排除 pick_status='none' 和 recheck_status='fin'),支持分页与关键词/波次号/复核状态筛选。与 recheckOrderList 不同:本方法仅处理散单模式,不包含团购分支。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "where", - "type": "object", - "required": false, - "description": "筛选条件。支持 keyword(运单号/订单号模糊搜索)、wave_no(精确匹配)、recheck_status、pick_status" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数,支持 page / pageSize(默认 page=1, pageSize=20)" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "散单复核订单列表,每项含 order_id、delivery_order_code、order_type、wave_id、wave_no、pick_status、recheck_status、shop_nick、logistics_name、items_count、items_total、items_weight、weight_type、status、create_at、pick_time、recheck_time" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息,含 page、pageSize、total、totalPages、hasPrevious、hasNext" - } - ] - }, - { - "moduleName": "订单复核模块", - "moduleKey": "order.recheckOrder", - "moduleFolder": "order.recheckorder", - "method": "order.recheckOrder.recheckOrderList", - "title": "复核订单列表查询,通过入参 list_type 区分散单模式与团购模式。散单模式(single,默认)返回待复核订单列表(每项为一个订单,排除 pick_status='none' 和 recheck_status='fin'),团购模式(group)返回波次维度的复核汇总列表(每项为一个波次及其订单复核统计,含 review_assignment_status 计算字段)。统一使用 list 字段名输出,均支持分页与筛选。", - "description": "复核订单列表查询,通过入参 list_type 区分散单模式与团购模式。散单模式(single,默认)返回待复核订单列表(每项为一个订单,排除 pick_status='none' 和 recheck_status='fin'),团购模式(group)返回波次维度的复核汇总列表(每项为一个波次及其订单复核统计,含 review_assignment_status 计算字段)。统一使用 list 字段名输出,均支持分页与筛选。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "list_type", - "type": "string", - "required": false, - "description": "列表模式:single(散单模式,默认)/ group(团购模式)" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "筛选条件。散单模式支持 keyword(运单号/订单号模糊搜索)、wave_no(精确匹配)、recheck_status、pick_status;团购模式支持 wave_no(模糊搜索)、wave_type、wave_status" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数,支持 page / pageSize(默认 page=1, pageSize=20)" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "散单模式(list_type=single):订单数组,每项含 order_id、delivery_order_code、order_type、wave_id、wave_no、pick_status、recheck_status、shop_nick、logistics_name、items_count、items_total、status、create_at、pick_time、recheck_time。团购模式(list_type=group):波次汇总数组,每项含 wave_id、wave_no、wave_type、wave_status、total_orders、processed_orders、creator、create_time、update_time、order_count、reviewed_count、unreviewed_count、review_assignment_status(unreviewed/partially_reviewed/reviewed)" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息,含 page、pageSize、total、totalPages、hasPrevious、hasNext" - } - ] - }, - { - "moduleName": "订单复核模块", - "moduleKey": "order.recheckOrder", - "moduleFolder": "order.recheckorder", - "method": "order.recheckOrder.scanOrder", - "title": "扫描关键词并返回以波次为单位的复核视图。支持运单号、波次号、车号三种匹配模式。运单号/波次号命中(散单)返回扁平化订单列表 list_type='single',车号命中(团单)返回嵌套波次结构 list_type='group'。运单号命中但订单无波次信息时,退回单订单详情模式(list 每项含 detail/items/expresses/logs)。", - "description": "扫描关键词并返回以波次为单位的复核视图。支持运单号、波次号、车号三种匹配模式。运单号/波次号命中(散单)返回扁平化订单列表 list_type='single',车号命中(团单)返回嵌套波次结构 list_type='group'。运单号命中但订单无波次信息时,退回单订单详情模式(list 每项含 detail/items/expresses/logs)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "keyword / value / waybill_no / waybillCode / waybill_code / wave_no / waveNo / cart_code / cartCode", - "type": "string", - "required": true, - "description": "扫描关键词;匹配优先级:运单号 → 波次号 → 车号。支持别名 waybillCode/waybill_code(运单号)、waveNo(波次号)、cartCode(车号)" - } - ], - "response": [ - { - "name": "match_type", - "type": "string", - "required": true, - "description": "命中类型:waybill(运单号命中)/ wave(波次号命中)/ cart(车号命中)" - }, - { - "name": "list_type", - "type": "string", - "required": true, - "description": "列表模式:single(散单扁平列表)/ group(团购嵌套波次列表)" - }, - { - "name": "waybill_no", - "type": "string", - "required": false, - "description": "仅 waybill 命中时返回,匹配到的运单号" - }, - { - "name": "task_id", - "type": "number|null", - "required": false, - "description": "散单有波次信息时返回(来自拣货任务表 wms_wave_pick_task.id),团单车号命中时返回 cartMatchContext 中的任务 ID" - }, - { - "name": "picker_id", - "type": "number|null", - "required": false, - "description": "仅散单模式(有波次信息时)返回,拣货人ID(来自 wms_wave_pick_task.pick_user_id)" - }, - { - "name": "picker_name", - "type": "string", - "required": false, - "description": "仅散单模式(有波次信息时)返回,拣货人名称(来自 wms_wave_pick_task.pick_user_name)" - }, - { - "name": "wave_id", - "type": "number", - "required": false, - "description": "仅散单模式(有波次信息时)返回,波次ID" - }, - { - "name": "wave_no", - "type": "string", - "required": false, - "description": "仅散单模式(有波次信息时)返回,波次号" - }, - { - "name": "wave_type", - "type": "number", - "required": false, - "description": "仅散单模式(有波次信息时)返回,波次类型编码(来自 wms_wave_batch.wave_type)" - }, - { - "name": "pick_mode", - "type": "number", - "required": false, - "description": "拣货模式:1-团购小波次 2-散单单品单件 3-散单先拣后分 4-边拣边分 5-团购大波次。散单模式在顶层返回,团购模式在每个波次视图项内返回" - }, - { - "name": "strategy_id", - "type": "number|null", - "required": false, - "description": "仅散单模式返回,波次策略ID" - }, - { - "name": "strategy_name", - "type": "string", - "required": false, - "description": "仅散单模式返回,波次策略名称" - }, - { - "name": "total_orders", - "type": "number", - "required": false, - "description": "仅散单模式返回,波次内订单总数" - }, - { - "name": "reviewed_count", - "type": "number", - "required": false, - "description": "仅散单模式返回,已复核订单数" - }, - { - "name": "unreviewed_count", - "type": "number", - "required": false, - "description": "仅散单模式返回,未复核订单数" - }, - { - "name": "list", - "type": "array", - "required": true, - "description": "统一列表输出。散单模式(list_type=single)有波次信息时:扁平订单数组;无波次信息时退回单订单详情模式(每项含 detail、items、expresses、logs)。团购模式(list_type=group):波次视图数组(每项含 wave_id、wave_no、wave_type、wave_status、total_orders、processed_orders、creator、create_time、update_time、order_count、pick_mode、box_no、order_ids、orders_detail、stocks[])" - } - ] - }, - { - "moduleName": "订单复核模块", - "moduleKey": "order.recheckOrder", - "moduleFolder": "order.recheckorder", - "method": "order.recheckOrder.scanTask", - "title": "按拣货任务 ID 拉取复核扫描视图。根据任务的 pick_mode 区分散单/团单模式,返回与 scanOrder 一致的数据结构,用于前端刷新数据。散单模式(pick_mode 2/3/4)扁平化任务下所有波次的订单列表(按 order_id 去重,未复核优先、wave_index 升序),顶层携带拣货人/任务等汇总信息(包括 picker_id、picker_name、pick_mode、total_orders、reviewed_count、unreviewed_count);团购模式(pick_mode 1/5)返回任务下所有团购波次及订单的分组列表(list_type='group')。", - "description": "按拣货任务 ID 拉取复核扫描视图。根据任务的 pick_mode 区分散单/团单模式,返回与 scanOrder 一致的数据结构,用于前端刷新数据。散单模式(pick_mode 2/3/4)扁平化任务下所有波次的订单列表(按 order_id 去重,未复核优先、wave_index 升序),顶层携带拣货人/任务等汇总信息(包括 picker_id、picker_name、pick_mode、total_orders、reviewed_count、unreviewed_count);团购模式(pick_mode 1/5)返回任务下所有团购波次及订单的分组列表(list_type='group')。", - "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", - "type": "number", - "required": true, - "description": "拣货任务 ID(对应 wms_wave_pick_task.id)" - } - ], - "response": [ - { - "name": "match_type", - "type": "string", - "required": true, - "description": "固定为 'task',表示通过任务 ID 匹配" - }, - { - "name": "list_type", - "type": "string", - "required": true, - "description": "列表模式:single(散单扁平列表)/ group(团购嵌套波次列表),由拣货任务的 pick_mode 决定" - }, - { - "name": "task_id", - "type": "number", - "required": true, - "description": "拣货任务 ID" - }, - { - "name": "picker_id", - "type": "number|null", - "required": false, - "description": "拣货人 ID(来自 wms_wave_pick_task.pick_user_id),散单模式返回" - }, - { - "name": "picker_name", - "type": "string", - "required": false, - "description": "拣货人名称(来自 wms_wave_pick_task.pick_user_name),散单模式返回" - }, - { - "name": "pick_mode", - "type": "number", - "required": false, - "description": "拣货模式:1-团购小波次 2-散单单品单件 3-散单先拣后分 4-边拣边分 5-团购大波次" - }, - { - "name": "wave_id", - "type": "number", - "required": false, - "description": "散单模式固定为 0,团购模式不返回" - }, - { - "name": "wave_no", - "type": "string", - "required": false, - "description": "散单模式固定为空字符串,团购模式不返回" - }, - { - "name": "wave_type", - "type": "number", - "required": false, - "description": "波次类型编码(取任务下第一个有效波次的 wave_type),散单模式返回" - }, - { - "name": "strategy_id", - "type": "number|null", - "required": false, - "description": "散单模式固定为 null(任务级别不绑定单一策略)" - }, - { - "name": "strategy_name", - "type": "string", - "required": false, - "description": "散单模式固定为空字符串(任务级别不绑定单一策略)" - }, - { - "name": "total_orders", - "type": "number", - "required": false, - "description": "任务下订单总数(去重后),散单模式返回" - }, - { - "name": "reviewed_count", - "type": "number", - "required": false, - "description": "已复核订单数,散单模式返回" - }, - { - "name": "unreviewed_count", - "type": "number", - "required": false, - "description": "未复核订单数,散单模式返回" - }, - { - "name": "list", - "type": "array", - "required": true, - "description": "统一列表输出。散单模式(list_type=single):扁平订单数组(每项结构与 scanOrder 散单有波次模式一致,含 order_id/delivery_order_code/waybill_no/pick_status/is_printed/is_reviewed/shop_nick/items_count/wave_index/recheck_status/order_type/status/logistics_name/store_remark/intercept_status/stock[])。团购模式(list_type=group):波次视图数组(结构与 scanOrder 团购模式一致,每项含 wave_id/wave_no/wave_type/wave_status/total_orders/processed_orders/creator/create_time/update_time/order_count/pick_mode/box_no/orders[])" - } - ] - }, - { - "moduleName": "订单待审核模块", - "moduleKey": "order.reviewOrder", - "moduleFolder": "order.revieworder", - "method": "order.reviewOrder.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": "去重后的运单号字符串数组" - } - ] - }, - { - "moduleName": "订单待审核模块", - "moduleKey": "order.reviewOrder", - "moduleFolder": "order.revieworder", - "method": "order.reviewOrder.list", - "title": "待审核订单列表,默认仅查询 step=0 的订单。", - "description": "待审核订单列表,默认仅查询 step=0 的订单。", - "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": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "moduleName": "订单待审核模块", - "moduleKey": "order.reviewOrder", - "moduleFolder": "order.revieworder", - "method": "order.reviewOrder.reviewOrder", - "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 数组;仅允许 ids 字段,建议传数组,也兼容逗号字符串或单值" - } - ], - "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 列表" - } - ] - }, - { - "moduleName": "订单工作台入口模块", - "moduleKey": "order.index", - "moduleFolder": "order.index", - "method": "order.updateExpressWeighingWeight", - "title": "更新订单运单称重重量。支持两种模式:1) 订单模式(order_id>0):规则:订单仅一个运单时,直接写入该运单重量;多运单时,必须传 waybill_code 并按运单写入;团购波次批量设置同一重量到波次下所有订单运单,并返回拆单汇总信息(total_weight/split_count/splits/store_name/sys_logistics_name)。2) 运单号模式(order_id=0):从运单号反查订单与波次,散单/非团购波次仅更新单个运单重量,团购波次按 wave_no+business_key 批量设置并返回拆单汇总信息。", - "description": "更新订单运单称重重量。支持两种模式:1) 订单模式(order_id>0):规则:订单仅一个运单时,直接写入该运单重量;多运单时,必须传 waybill_code 并按运单写入;团购波次批量设置同一重量到波次下所有订单运单,并返回拆单汇总信息(total_weight/split_count/splits/store_name/sys_logistics_name)。2) 运单号模式(order_id=0):从运单号反查订单与波次,散单/非团购波次仅更新单个运单重量,团购波次按 wave_no+business_key 批量设置并返回拆单汇总信息。", - "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,必填且必须为数字。订单模式下为正整数,设为0时切换为运单号模式(需配合 waybill_code 使用)。" - }, - { - "name": "waybill_code", - "type": "string", - "required": false, - "description": "运单号。订单模式下:订单仅一个运单时可不传且会被忽略,多运单时必填并需匹配订单下运单。运单号模式(order_id=0)下必填。" - }, - { - "name": "weighing_weight", - "type": "number|string", - "required": true, - "description": "称重重量(kg),必填,必须大于 0,最多支持 3 位小数。" - } - ], - "response": [ - { - "name": "order_id", - "type": "number", - "required": false, - "description": "订单ID。订单模式及运单号散单模式返回。" - }, - { - "name": "waybill_code", - "type": "string", - "required": false, - "description": "写入重量的运单号。订单模式及运单号散单模式返回。" - }, - { - "name": "weighing_weight", - "type": "number", - "required": true, - "description": "已写入的称重重量(kg)。" - }, - { - "name": "wave_no", - "type": "string", - "required": false, - "description": "波次号。团购批量模式返回。" - }, - { - "name": "business_key", - "type": "string", - "required": false, - "description": "业务键。运单号团购批量模式返回。" - }, - { - "name": "wave_id", - "type": "number", - "required": false, - "description": "波次ID。团购批量模式返回。" - }, - { - "name": "total_weight", - "type": "number", - "required": false, - "description": "所有拆单重量累加(kg)。团购批量模式返回。" - }, - { - "name": "split_count", - "type": "number", - "required": false, - "description": "waybill_code 非空的 business_key 数量。团购批量模式返回。" - }, - { - "name": "splits", - "type": "array", - "required": false, - "description": "按 business_key 分组的拆单明细。每项含 business_key(业务键)、weighing_weight(该拆单累加重量)、waybill_code(代表运单号)。团购批量模式返回。" - }, - { - "name": "store_name", - "type": "string", - "required": false, - "description": "货主名称(订单 shop_nick)。团购批量模式返回。" - }, - { - "name": "sys_logistics_name", - "type": "string", - "required": false, - "description": "系统快递名称。团购批量模式返回。" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.batchAllocateExpress", - "title": "提交批次分配快递号任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到快递号分配流水线。", - "description": "提交批次分配快递号任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到快递号分配流水线。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "wave_ids / waveIds / ids", - "type": "array|string|number", - "required": true, - "description": "波次ID列表;支持数组、逗号分隔字符串或单个ID" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "可选外部任务ID,用于幂等提交" - } - ], - "response": [ - { - "name": "status", - "type": "string", - "required": true, - "description": "提交状态,固定 success" - }, - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(用于查询任务进度)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "当前仓库ID" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO8601)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "受理提示信息" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.batchAllocateExpressTaskProgress", - "title": "查询批次分配快递号任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", - "description": "查询批次分配快递号任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", - "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(后端生成或提交时传入)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "任务关联仓库ID" - }, - { - "name": "total_wave_count", - "type": "number", - "required": false, - "description": "波次数量" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "参与分配的订单数量" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数量" - }, - { - "name": "success_order_count", - "type": "number", - "required": false, - "description": "成功提交分配的订单数量" - }, - { - "name": "failed_order_count", - "type": "number", - "required": false, - "description": "提交分配失败的订单数量" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比(0-100)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "失败时的错误信息" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "失败时的错误码" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.batchAllocateStorage", - "title": "提交批次分配储位任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到储位分配流水线。", - "description": "提交批次分配储位任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到储位分配流水线。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "wave_ids / waveIds / ids", - "type": "array|string|number", - "required": true, - "description": "波次ID列表;支持数组、逗号分隔字符串或单个ID" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "可选外部任务ID,用于幂等提交" - } - ], - "response": [ - { - "name": "status", - "type": "string", - "required": true, - "description": "提交状态,固定 success" - }, - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(用于查询任务进度)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "当前仓库ID" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO8601)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "受理提示信息" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.batchAllocateStorageTaskProgress", - "title": "查询批次分配储位任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", - "description": "查询批次分配储位任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", - "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(后端生成或提交时传入)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "任务关联仓库ID" - }, - { - "name": "total_wave_count", - "type": "number", - "required": false, - "description": "波次数量" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "参与分配的订单数量" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数量" - }, - { - "name": "success_order_count", - "type": "number", - "required": false, - "description": "成功提交分配的订单数量" - }, - { - "name": "failed_order_count", - "type": "number", - "required": false, - "description": "提交分配失败的订单数量" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比(0-100)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "失败时的错误信息" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "失败时的错误码" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.batchAutoGrouping", - "title": "批量将波次状态修改为 0(自动加团中),仅作用当前登录仓库命中的波次。限制条件: - 跳过已打印及之后状态的波次(wave_status >= 2); - 跳过 total_orders >= 仓库配置 max_wave_quantity 的波次。被跳过的波次不会被修改为自动加团中。", - "description": "批量将波次状态修改为 0(自动加团中),仅作用当前登录仓库命中的波次。限制条件: - 跳过已打印及之后状态的波次(wave_status >= 2); - 跳过 total_orders >= 仓库配置 max_wave_quantity 的波次。被跳过的波次不会被修改为自动加团中。", - "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|string|number", - "required": true, - "description": "波次ID 列表;支持数组、逗号分隔字符串或单个ID" - } - ], - "response": [ - { - "name": "ids", - "type": "array", - "required": false, - "description": "归一化后的请求ID" - }, - { - "name": "affected_wave_ids", - "type": "array", - "required": false, - "description": "实际命中的波次ID" - }, - { - "name": "updated_wave_count", - "type": "number", - "required": false, - "description": "实际更新数量" - }, - { - "name": "skipped_wave_ids", - "type": "array", - "required": false, - "description": "被跳过的波次ID数组(不修改状态)" - }, - { - "name": "skipped_wave_count", - "type": "number", - "required": false, - "description": "被跳过的波次数量" - }, - { - "name": "skipped_details", - "type": "array", - "required": false, - "description": "被跳过的波次明细數組,元素包含 wave_id 与 reason,reason 枚举 printed_or_after_printed / reach_max_wave_quantity" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.batchCancel", - "title": "提交批量解除波次异步任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理波次并执行解除操作;可通过 order.wave.batchCancelTaskProgress 查询进度与结果。", - "description": "提交批量解除波次异步任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理波次并执行解除操作;可通过 order.wave.batchCancelTaskProgress 查询进度与结果。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "wave_ids / waveIds / ids", - "type": "array|string|number", - "required": true, - "description": "波次ID列表;支持数组、逗号分隔字符串或单个ID" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "可选外部任务ID,用于幂等提交" - } - ], - "response": [ - { - "name": "status", - "type": "string", - "required": true, - "description": "提交状态,固定 success" - }, - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(用于查询任务进度)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "当前仓库ID" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO8601)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "受理提示信息" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.batchCancelTaskProgress", - "title": "查询批量解除波次任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。响应包含 state、progress_percent、processed_wave_count、total_wave_count;当 state 为 success/failed 时返回额外字段说明。", - "description": "查询批量解除波次任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。响应包含 state、progress_percent、processed_wave_count、total_wave_count;当 state 为 success/failed 时返回额外字段说明。", - "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(后端生成或提交时传入)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比(0-100)" - }, - { - "name": "processed_wave_count", - "type": "number", - "required": false, - "description": "已处理的波次数量" - }, - { - "name": "total_wave_count", - "type": "number", - "required": false, - "description": "总波次数量" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "失败时的错误信息(仅在 state=failed 时返回)" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "失败时的错误码(仅在 state=failed 时返回)" - }, - { - "name": "result", - "type": "object", - "required": false, - "description": "成功时返回的汇总结果(仅在 state=success 时返回),例如 { \"processed_wave_count\": number, \"canceled_wave_count\": number }" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.batchFinishAutoGrouping", - "title": "批量结束自动加团,将当前仓库命中且 wave_status=0 的波次改为 1(已就绪)。", - "description": "批量结束自动加团,将当前仓库命中且 wave_status=0 的波次改为 1(已就绪)。", - "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|string|number", - "required": true, - "description": "波次ID 列表;支持数组、逗号分隔字符串或单个ID" - } - ], - "response": [ - { - "name": "ids", - "type": "array", - "required": false, - "description": "归一化后的请求ID" - }, - { - "name": "affected_wave_ids", - "type": "array", - "required": false, - "description": "实际命中的波次ID" - }, - { - "name": "updated_wave_ids", - "type": "array", - "required": false, - "description": "实际更新为已就绪的波次ID" - }, - { - "name": "updated_wave_count", - "type": "number", - "required": false, - "description": "实际更新数量" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order", - "moduleFolder": "order", - "method": "order.wave.batchList", - "title": "波次列表查询。仅使用当前登录操作者仓库上下文(禁止传入 warehouse_id/warehouseId)。支持 where 白名单过滤,固定查询 wave_status=0/1;返回波次基础信息及分配状态汇总。支持 only_todo=1 仅返回仍有未复核订单的波次,并返回复核状态汇总(review_assignment_status)与未复核数量(unreviewed_order_count)。", - "description": "波次列表查询。仅使用当前登录操作者仓库上下文(禁止传入 warehouse_id/warehouseId)。支持 where 白名单过滤,固定查询 wave_status=0/1;返回波次基础信息及分配状态汇总。支持 only_todo=1 仅返回仍有未复核订单的波次,并返回复核状态汇总(review_assignment_status)与未复核数量(unreviewed_order_count)。", - "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": "only_todo", - "type": "number|boolean|string", - "required": false, - "description": "是否仅返回待处理(仍有未复核订单)的波次,默认 0;传 1/true 时仅返回 unreviewed_order_count > 0 的波次。" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "筛选白名单字段(object,可选)。仅支持下列字段过滤,且禁止传入 warehouse_id / warehouseId: - wave_id(等值) - wave_no(模糊) - wave_type(等值) - wave_status(等值,接口固定叠加状态 0/1) - creator(模糊) - logistics_name(模糊) - item_part_type(等值) - item_part(模糊) - item_snapshot_key(模糊) - item_detail_machine(模糊) - distinguish_express(等值) - total_orders_min / total_orders_max(范围) - processed_orders_min / processed_orders_max(范围) - express_assignment_status(等值,string,可选,英文枚举,取值:unassigned、partially_assigned、assigned;语义:按快递分配聚合判断,assigned 表示聚合后全部 fin,partially_assigned 表示部分已分配且不含 error,unassigned 表示全 none 或包含 error(异常并入未分配集合))。 - print_assignment_status(等值,string,可选,英文枚举,取值:unprinted、partially_printed、printed;语义:按打印分配聚合判断,printed 表示聚合后全部已打印)。 - storage_assignment_status(等值,string,可选,取值:未分配、部分分配、已分配;默认不传不做限制)。过滤语义:已分配=聚合后全部 fin;部分分配=不含 error,且既不是全 none,也不是全 fin;未分配=全 none 或包含 error(异常并入未分配筛选集合)。说明:返回字段 storage_assignment_status 的展示值保持不变,包含 error 时仍可显示“分配异常”;此处 where 的过滤语义会把异常计入“未分配”,以避免把过滤语义与展示值混淆。 - source(可选,number)来源过滤:0=普通波次(正常后台操作),1=管理后台策略任务,2=PDA策略任务;不传则不过滤。 说明:express_assignment_status 与 print_assignment_status 要求使用英文枚举值;storage_assignment_status 仍向后兼容中文展示值。若传入的枚举值不在允许集合内,接口会返回 400(参数校验失败),并在 message 中说明错误字段与允许取值。 - review_assignment_status(等值,string,可选,英文枚举:unreviewed、partially_reviewed、reviewed;分别表示未复核、部分复核、已复核)。" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "波次列表,包含波次基础信息与状态汇总(order_count / storage_assignment_status / express_assignment_status / print_assignment_status / review_assignment_status / unreviewed_order_count)。每条记录新增字段 source(number):来源标识,0=普通波次(正常后台操作),1=管理后台策略任务,2=PDA策略任务。" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.batchRemoveExceptionOrders", - "title": "提交批次移除异常订单任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取异常订单并移出波次。", - "description": "提交批次移除异常订单任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取异常订单并移出波次。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "wave_ids / waveIds / ids", - "type": "array|string|number", - "required": true, - "description": "波次ID列表;支持数组、逗号分隔字符串或单个ID" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "可选外部任务ID,用于幂等提交" - } - ], - "response": [ - { - "name": "status", - "type": "string", - "required": true, - "description": "提交状态,固定 success" - }, - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(用于查询任务进度)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "当前仓库ID" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO8601)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "受理提示信息" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.batchRemoveExceptionOrdersTaskProgress", - "title": "查询批次移除异常订单任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", - "description": "查询批次移除异常订单任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", - "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(后端生成或提交时传入)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "任务关联仓库ID" - }, - { - "name": "total_wave_count", - "type": "number", - "required": false, - "description": "波次数量" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "参与处理的订单数量" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数量" - }, - { - "name": "removed_order_count", - "type": "number", - "required": false, - "description": "已成功移出波次的订单数量" - }, - { - "name": "failed_order_count", - "type": "number", - "required": false, - "description": "处理失败的订单数量" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比(0-100)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "失败时的错误信息" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "失败时的错误码" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.batchRemoveOrders", - "title": "按订单ID批量移出波次;仅处理当前仓库的待处理订单表中非待审核订单(step in [1,2,3])。操作会清空订单的 wave_id/wave_no,并在同一事务内回写 wms_wave_batch 表:重算 total_orders,若波次被清空则将 wave_status 置为 -1。仓库上下文来自当前登录用户(ctx.user.store_id)。", - "description": "按订单ID批量移出波次;仅处理当前仓库的待处理订单表中非待审核订单(step in [1,2,3])。操作会清空订单的 wave_id/wave_no,并在同一事务内回写 wms_wave_batch 表:重算 total_orders,若波次被清空则将 wave_status 置为 -1。仓库上下文来自当前登录用户(ctx.user.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": "ids / order_ids / orderIds / order_id / orderId / id", - "type": "array|string|number", - "required": true, - "description": "订单 ID 列表;支持数组、逗号分隔字符串或单个 ID,以上别名均可用(ids、order_ids、orderIds、order_id、orderId、id)" - } - ], - "response": [ - { - "name": "ids", - "type": "array", - "required": true, - "description": "归一化后的请求 ID 列表" - }, - { - "name": "removed_order_ids", - "type": "array", - "required": true, - "description": "实际被移出波次的订单 ID 列表" - }, - { - "name": "removed_order_count", - "type": "number", - "required": true, - "description": "被移出波次的订单数量" - }, - { - "name": "affected_wave_ids", - "type": "array", - "required": true, - "description": "本次操作涉及的波次 ID 列表" - }, - { - "name": "updated_wave_ids", - "type": "array", - "required": true, - "description": "实际更新了 total_orders 的波次 ID 列表" - }, - { - "name": "emptied_wave_ids", - "type": "array", - "required": true, - "description": "被清空且已置为 wave_status=-1 的波次 ID 列表" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.fetch", - "title": "兼容别名(等同 groupFetch)", - "description": "兼容别名(等同 groupFetch)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "structure_list", - "type": "array", - "required": true, - "description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识),可选 quantity(未传入时使用仓库默认或全局默认)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "生效的仓库 ID" - }, - { - "name": "structure_count", - "type": "number", - "required": true, - "description": "本次入参的结构数量(structure_list 长度)" - }, - { - "name": "default_quantity", - "type": "number", - "required": true, - "description": "仓库默认抓取数量或全局默认值" - }, - { - "name": "fetch_mode", - "type": "string", - "required": false, - "description": "抓取模式,值为 'group'(团购)或 'single'(散单)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.fetchTaskProgress", - "title": "查询波次抓取任务进度:按 task_id 查询任务状态与进度;兼容 taskId 参数名。", - "description": "查询波次抓取任务进度:按 task_id 查询任务状态与进度;兼容 taskId 参数名。", - "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,可从 order.wave.fetch 的返回值中获取" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID" - }, - { - "name": "status", - "type": "string", - "required": true, - "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "生效的仓库 ID(若任务关联仓库时返回)" - }, - { - "name": "structure_count", - "type": "number", - "required": false, - "description": "本次任务的结构数量(structure_list 长度)" - }, - { - "name": "finished_structure_count", - "type": "number", - "required": false, - "description": "已完成抓取的结构数量" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比(0-100,可能为小数)" - }, - { - "name": "total_fetched_quantity", - "type": "number", - "required": false, - "description": "已抓取的总件数" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务已运行时长,毫秒级" - }, - { - "name": "error", - "type": "string", - "required": false, - "description": "错误信息,仅当 status=failed 时返回" - }, - { - "name": "fetch_mode", - "type": "string", - "required": false, - "description": "抓取模式,值为 'group'(团购)或 'single'(散单);single 模式时可能返回下列额外字段" - }, - { - "name": "max_fetch_quantity", - "type": "number", - "required": false, - "description": "当 fetch_mode=single 时返回的最大抓取上限(订单数,正整数)" - }, - { - "name": "limit_reached", - "type": "boolean", - "required": false, - "description": "当 fetch_mode=single 时指示是否已达到 max_fetch_quantity 限制" - }, - { - "name": "stop_reason", - "type": "string", - "required": false, - "description": "任务停止原因(如达到上限、人工停止或其他失败原因)" - }, - { - "name": "update_time", - "type": "string", - "required": false, - "description": "最近一次状态更新时间,ISO8601 字符串" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "额外提示信息" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.groupFetch", - "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": "structure_list", - "type": "array", - "required": true, - "description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识),可选 quantity(未传入时使用仓库默认或全局默认)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "生效的仓库 ID" - }, - { - "name": "structure_count", - "type": "number", - "required": true, - "description": "本次入参的结构数量(structure_list 长度)" - }, - { - "name": "default_quantity", - "type": "number", - "required": true, - "description": "仓库默认抓取数量或全局默认值" - }, - { - "name": "fetch_mode", - "type": "string", - "required": false, - "description": "抓取模式,值为 'group'(团购)或 'single'(散单)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.groupOrderFetchList", - "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": "pagination", - "type": "object", - "required": false, - "description": "分页参数,支持 page / pageSize" - }, - { - "name": "distinguish_express", - "type": "boolean", - "required": false, - "description": "是否区分快递(影响分组粒度)" - }, - { - "name": "store_id", - "type": "number", - "required": false, - "description": "货主ID(仅作为筛选条件)" - }, - { - "name": "same_order_quantity", - "type": "number", - "required": false, - "description": "最小同组订单数量阈值(>=)。若显式传入有效数值则按传入值使用;未传入时使用仓库配置 min_group_order_fetch_quantity(默认 13)。" - }, - { - "name": "shop_name", - "type": "string", - "required": false, - "description": "店铺名称(模糊匹配)" - }, - { - "name": "include_sku", - "type": "string", - "required": false, - "description": "仅保留包含该 SKU 的分组(页内过滤)" - }, - { - "name": "return_order_ids", - "type": "boolean", - "required": false, - "description": "是否在结果中返回组内订单ID列表" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "分组列表,每项包含 item_detail、item_detail_machine、item_detail_machine_snapshot、item_snapshot、group、group_count、items_total、items_weight(总重量kg,取组内首单 items_weight)、store_id、store_ids、logistics_name、distinguish_express、first_order_time、last_order_time、status_summary 等字段;若指定 return_order_ids=true 则额外包含 order_ids" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.singleFetch", - "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": "structure_list", - "type": "array", - "required": true, - "description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识)并包含必填字段 max_fetch_quantity(最大抓取上限,订单数,正整数);可选 quantity(未传入时使用仓库默认或全局默认)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "生效的仓库 ID" - }, - { - "name": "structure_count", - "type": "number", - "required": true, - "description": "本次入参的结构数量(structure_list 长度)" - }, - { - "name": "default_quantity", - "type": "number", - "required": true, - "description": "仓库默认抓取数量或全局默认值" - }, - { - "name": "fetch_mode", - "type": "string", - "required": false, - "description": "抓取模式,值为 'group'(团购)或 'single'(散单)" - }, - { - "name": "max_fetch_quantity", - "type": "number", - "required": false, - "description": "提交时生效的最大抓取上限(订单数,正整数)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.singleFetchByIds", - "title": "按订单 ID 列表抓取到一个散单波次。仅处理当前仓库的待处理订单(step in [1,2,3]),排除已在波次中的订单(wave_id>0),不区分快递;成功抓取后批量写入订单操作日志;当无可抓取订单时返回 wave_id=0。", - "description": "按订单 ID 列表抓取到一个散单波次。仅处理当前仓库的待处理订单(step in [1,2,3]),排除已在波次中的订单(wave_id>0),不区分快递;成功抓取后批量写入订单操作日志;当无可抓取订单时返回 wave_id=0。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "ids / order_ids / orderIds", - "type": "array|string|number", - "required": true, - "description": "订单 ID 列表;支持数组、逗号分隔字符串或单个 ID。入参会被去重并转换为正整数。字段解析优先顺序:ids -> order_ids -> orderIds。" - } - ], - "response": [ - { - "name": "ids", - "type": "array", - "required": true, - "description": "请求归一化后的 ids 列表(去重且为正整数)" - }, - { - "name": "wave_id", - "type": "number", - "required": true, - "description": "创建的波次 ID;若无可抓取订单返回 0" - }, - { - "name": "wave_no", - "type": "string", - "required": true, - "description": "创建的波次号;无可抓取时为空字符串" - }, - { - "name": "fetched_order_ids", - "type": "array", - "required": true, - "description": "实际被抓取并成功分配到波次的订单 ID 列表(为归一化后的 ids 的子集)" - }, - { - "name": "fetched_order_count", - "type": "number", - "required": true, - "description": "实际被抓取的订单数量(等于 fetched_order_ids.length)" - }, - { - "name": "excluded_existing_wave_order_ids", - "type": "array", - "required": false, - "description": "原始入参中已在其它波次中的订单 ID(被排除,不会被抓取)" - }, - { - "name": "skipped_order_ids", - "type": "array", - "required": false, - "description": "因订单状态不符、正在出库或其他业务原因被跳过的订单 ID(不会被抓取)" - }, - { - "name": "not_found_order_ids", - "type": "array", - "required": false, - "description": "入参中未在数据库中找到的订单 ID" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.singleOrderFetchList", - "title": "按机器结构分组的散单候选列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。与 order.wave.groupOrderFetchList 不同:groupOrderFetchList 返回满足同组订单数量 >= same_order_quantity(或仓库配置 min_group_order_fetch_quantity)的团购命中分组;singleOrderFetchList 则排除这些团购命中分组,仅返回同组订单数量小于该阈值的散单候选分组(即 < same_order_quantity)。", - "description": "按机器结构分组的散单候选列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。与 order.wave.groupOrderFetchList 不同:groupOrderFetchList 返回满足同组订单数量 >= same_order_quantity(或仓库配置 min_group_order_fetch_quantity)的团购命中分组;singleOrderFetchList 则排除这些团购命中分组,仅返回同组订单数量小于该阈值的散单候选分组(即 < same_order_quantity)。", - "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": "distinguish_express", - "type": "boolean", - "required": false, - "description": "是否区分快递(影响分组粒度)" - }, - { - "name": "store_id", - "type": "number", - "required": false, - "description": "货主ID(仅作为筛选条件)" - }, - { - "name": "same_order_quantity", - "type": "number", - "required": false, - "description": "最小同组订单数量阈值(用于判定团购命中);本接口返回同组订单数量小于该阈值的分组。若显式传入有效数值则按传入值使用;未传入时使用仓库配置 min_group_order_fetch_quantity(默认 13)。" - }, - { - "name": "shop_name", - "type": "string", - "required": false, - "description": "店铺名称(模糊匹配)" - }, - { - "name": "include_sku", - "type": "string", - "required": false, - "description": "仅保留包含该 SKU 的分组(页内过滤)" - }, - { - "name": "return_order_ids", - "type": "boolean", - "required": false, - "description": "是否在结果中返回组内订单ID列表" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "散单候选分组列表,每项包含 item_detail、item_detail_machine、item_detail_machine_snapshot、item_snapshot、group、group_count、items_total、items_weight(总重量kg,取组内首单 items_weight)、store_id、store_ids、logistics_name、distinguish_express、first_order_time、last_order_time、status_summary 等字段;返回的 group_count 均小于 same_order_quantity(或仓库配置的 min_group_order_fetch_quantity);若指定 return_order_ids=true 则额外包含 order_ids" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.wavePickTaskCancel", - "title": "取消拣货任务(批量)。可取消的状态:0=待开始、1=拣货中、2=待复核(拣货完成)、3=已完成,状态9(已取消)或其他状态不允许取消。同时释放关联波次(物理删除波次记录,订单回池)、解绑拣货车、写操作日志。对于status=2或3的任务,取消时会自动回退订单拣货状态:wms_wave_pick_task_order.pick_status(1→0)、order_delivery.pick_status(fin→padding)。入参仅支持 task_ids(数组,必填),不再支持单个 task_id。操作人与仓库从请求上下文获取(例如当前登录用户上下文 ctx.user),若上下文缺失接口将返回错误。", - "description": "取消拣货任务(批量)。可取消的状态:0=待开始、1=拣货中、2=待复核(拣货完成)、3=已完成,状态9(已取消)或其他状态不允许取消。同时释放关联波次(物理删除波次记录,订单回池)、解绑拣货车、写操作日志。对于status=2或3的任务,取消时会自动回退订单拣货状态:wms_wave_pick_task_order.pick_status(1→0)、order_delivery.pick_status(fin→padding)。入参仅支持 task_ids(数组,必填),不再支持单个 task_id。操作人与仓库从请求上下文获取(例如当前登录用户上下文 ctx.user),若上下文缺失接口将返回错误。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "task_ids", - "type": "array", - "required": true, - "description": "任务ID数组,例如 [123,124];仅支持批量处理,不再支持单个 task_id。" - } - ], - "response": [ - { - "name": "cancelled_count", - "type": "number", - "required": false, - "description": "成功取消的任务数量" - }, - { - "name": "task_ids", - "type": "array", - "required": false, - "description": "处理的任务ID数组(若后端返回)" - }, - { - "name": "task_nos", - "type": "array", - "required": false, - "description": "处理的任务编号数组(若后端返回)" - }, - { - "name": "task_id", - "type": "number", - "required": false, - "description": "任务ID(历史兼容,若后端仍返回)" - }, - { - "name": "task_no", - "type": "string", - "required": false, - "description": "任务编号(历史兼容,若后端仍返回)" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.wavePickTaskCancelSelf", - "title": "取消单个拣货任务(仅允许取消当前操作人本人创建的任务;仅支持单个 task_id,明确不支持 task_ids)", - "description": "取消单个拣货任务(仅允许取消当前操作人本人创建的任务;仅支持单个 task_id,明确不支持 task_ids)", - "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", - "type": "number", - "required": true, - "description": "要取消的单个任务 ID(仅支持单个,不支持 task_ids)" - } - ], - "response": [ - { - "name": "cancelled_count", - "type": "number", - "required": false, - "description": "成功取消的任务数量(0 或 1)" - }, - { - "name": "task_id", - "type": "number", - "required": false, - "description": "被处理的任务ID" - }, - { - "name": "task_no", - "type": "string", - "required": false, - "description": "被处理的任务编号(若后端返回)" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.wavePickTaskList", - "title": "按当前仓库分页查询拣货任务列表。支持顶层分页参数 `page_no`/`page_size`(兼容 `pagination` 对象与 `current/size`),支持 `status` 单值或数组;兼容历史 `where` 结构,顶层参数优先。默认按 create_time desc 排序。", - "description": "按当前仓库分页查询拣货任务列表。支持顶层分页参数 `page_no`/`page_size`(兼容 `pagination` 对象与 `current/size`),支持 `status` 单值或数组;兼容历史 `where` 结构,顶层参数优先。默认按 create_time desc 排序。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID(必填)" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数,支持 page / pageSize,兼容 current / size(兼容旧客户端)" - }, - { - "name": "page_no", - "type": "number", - "required": false, - "description": "页码(优先于 pagination.page/current)" - }, - { - "name": "page_size", - "type": "number", - "required": false, - "description": "每页大小(优先于 pagination.pageSize/size)" - }, - { - "name": "status", - "type": "array", - "required": false, - "description": "拣货任务状态过滤;建议传数组,也兼容单值或逗号分隔字符串,兼容 where.status;顶层参数优先" - }, - { - "name": "review_status", - "type": "number", - "required": false, - "description": "复核状态过滤" - }, - { - "name": "pick_mode", - "type": "number", - "required": false, - "description": "拣货模式(如批量/逐单等)" - }, - { - "name": "source", - "type": "string", - "required": false, - "description": "任务来源标识(业务端语义)" - }, - { - "name": "pick_user_id", - "type": "number", - "required": false, - "description": "拣货执行人ID(兼容旧字段)" - }, - { - "name": "review_user_id", - "type": "number", - "required": false, - "description": "复核人ID" - }, - { - "name": "task_no", - "type": "string", - "required": false, - "description": "任务编号(支持模糊匹配)" - }, - { - "name": "cart_id", - "type": "number", - "required": false, - "description": "拣货车/作业车ID" - }, - { - "name": "keyword", - "type": "string", - "required": false, - "description": "关键字搜索:支持 task_no / batch_no / current_cart_code_snapshot 等字段的模糊匹配" - }, - { - "name": "start_time_start", - "type": "string", - "required": false, - "description": "开始时间(ISO 字符串),与 start_time_end 一起用于时间范围过滤" - }, - { - "name": "start_time_end", - "type": "string", - "required": false, - "description": "结束时间(ISO 字符串),与 start_time_start 一起用于时间范围过滤" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "兼容历史 where 结构(可包含 status 等字段);当存在顶层同名参数时,顶层参数优先" - }, - { - "name": "strategy_id", - "type": "number", - "required": false, - "description": "策略ID(当前主表未存,该接口会忽略此过滤,建议勿使用)" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "拣货任务列表(数组),每项字段如下" - }, - { - "name": "total", - "type": "number", - "required": true, - "description": "总记录数" - }, - { - "name": "page", - "type": "number", - "required": true, - "description": "当前页码" - }, - { - "name": "page_size", - "type": "number", - "required": true, - "description": "每页大小" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.waveStrategyCreate", - "title": "新增波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。创建成功后会推进仓库的 wave_strategy_version 并失效相关缓存。", - "description": "新增波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。创建成功后会推进仓库的 wave_strategy_version 并失效相关缓存。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "strategy_name", - "type": "string", - "required": true, - "description": "策略名称(必填)" - }, - { - "name": "strategy_type", - "type": "number", - "required": true, - "description": "策略类型(必填,正整数):1-散单 2-团购" - }, - { - "name": "batch_mode", - "type": "number", - "required": true, - "description": "拣货模式(必填,正整数)" - }, - { - "name": "status", - "type": "number", - "required": false, - "description": "状态:1-启用 0-停用(可选)" - }, - { - "name": "order_min_sku", - "type": "number", - "required": false, - "description": "订单最小 SKU 种类数(可选,正整数或 null)" - }, - { - "name": "order_max_sku", - "type": "number", - "required": false, - "description": "订单最大 SKU 种类数(可选,正整数或 null)" - }, - { - "name": "order_min_qty", - "type": "number", - "required": false, - "description": "订单最小商品总数(可选,正整数或 null)" - }, - { - "name": "order_max_qty", - "type": "number", - "required": false, - "description": "订单最大商品总数(可选,正整数或 null)" - }, - { - "name": "min_same_structure", - "type": "number", - "required": false, - "description": "最小相同结构订单数(可选,正整数或 null)" - }, - { - "name": "max_same_structure", - "type": "number", - "required": false, - "description": "最大相同结构订单数(可选,正整数或 null)。注意:若传入值 >= 仓库配置的 min_group_order_fetch_quantity,则会被下调为 min_group_order_fetch_quantity - 1,最小为 1。" - }, - { - "name": "batch_max_orders", - "type": "number", - "required": false, - "description": "批次最大订单数(可选)" - }, - { - "name": "batch_max_skus", - "type": "number", - "required": false, - "description": "批次最大 SKU 总数(可选)" - }, - { - "name": "group_batch_max_orders", - "type": "number", - "required": false, - "description": "团购批次最大订单数(可选)" - }, - { - "name": "require_same_express", - "type": "boolean", - "required": false, - "description": "是否要求相同快递(可选,布尔)" - }, - { - "name": "allow_cross_owner", - "type": "boolean", - "required": false, - "description": "是否允许跨货主(可选,布尔)" - }, - { - "name": "description", - "type": "string", - "required": false, - "description": "策略描述(可选)" - }, - { - "name": "allowed_provinces", - "type": "array|string", - "required": false, - "description": "允许的省份列表(可选,支持数组、JSON 字符串或逗号分隔字符串)" - }, - { - "name": "allowed_platforms", - "type": "array|string", - "required": false, - "description": "允许的平台列表(可选,支持数组、JSON 字符串或逗号分隔字符串)" - }, - { - "name": "allowed_owners", - "type": "array|string", - "required": false, - "description": "允许的货主列表(可选,支持数组/JSON/逗号分隔);系统会校验所传货主是否在仓库可用货主范围内,非法值将导致 400 错误。" - }, - { - "name": "allowed_expresses", - "type": "array|string", - "required": false, - "description": "允许的快递编码列表(可选,支持数组/JSON/逗号分隔);系统会校验所传编码是否在可用快递列表内,非法值将导致 400 错误。" - }, - { - "name": "wave_prefix", - "type": "string", - "required": false, - "description": "波次编号前缀(可选),最多 5 个字符,如 D、B、A;不传则保持原值" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": true, - "description": "创建的策略对象,字段同 order.wave.waveStrategyList.list[*] 所示" - }, - { - "name": "code", - "type": "number", - "required": true, - "description": "HTTP-like 状态码,成功时返回 200" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.waveStrategyFallbackOrderList", - "title": "基于波次策略的回退候选订单列表。该接口内置固定筛选条件:step != 0、wave_id = 0、wave_scan_result = 2。用于展示策略未命中但需回退处理的订单候选。", - "description": "基于波次策略的回退候选订单列表。该接口内置固定筛选条件:step != 0、wave_id = 0、wave_scan_result = 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": "筛选白名单字段(object)。仅支持下列字段,且禁止传入 warehouse_id / warehouseId: - id(等值) - delivery_no / deliveryNo(模糊) - tracking_no / trackingNo(模糊) - items_count_min / items_count_max(范围) - items_total_min / items_total_max(范围) - sys_logistics_name(模糊) - store_name(模糊) - owner_name(等值) - province(模糊) - sys_platform_name(模糊) 说明:若传入未列出的字段或禁止字段(如 warehouse_id)接口会返回 400。" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "回退候选订单简要列表。数组内对象字段说明见 children。" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.waveStrategyFetchAdmin", - "title": "按策略提交并创建抓取主流程任务(后台管理)。当前为最小主流程:执行入参校验并创建任务记录,返回创建结果与计划预览;后续将扩展完整扫描/执行链路。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。", - "description": "按策略提交并创建抓取主流程任务(后台管理)。当前为最小主流程:执行入参校验并创建任务记录,返回创建结果与计划预览;后续将扩展完整扫描/执行链路。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "strategy_id / strategyId", - "type": "number", - "required": true, - "description": "策略ID(正整数,支持下划线/驼峰)" - }, - { - "name": "cart_id / cartId", - "type": "string|number", - "required": false, - "description": "可选,关联拣货车/作业车ID,用于记录作业上下文或幂等识别" - }, - { - "name": "source / operation_source", - "type": "string", - "required": false, - "description": "可选,操作来源标识(例如 admin/pda/manual/auto),用于审计与分流策略" - }, - { - "name": "strategy_params / strategyParams", - "type": "object", - "required": false, - "description": "可选,策略参数透传对象(如 order_min_qty/order_max_qty/allow_cross_owner 等),在创建任务时作为策略覆盖或附加参数使用" - } - ], - "response": [ - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态:created(已创建主流程任务),后续可能为 running/success/failed" - }, - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务唯一 ID(用于后续查询或关联)" - }, - { - "name": "task_no", - "type": "string", - "required": true, - "description": "任务业务编号(便于展示与关联)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "生效的仓库 ID(来自当前上下文,如可用则返回)" - }, - { - "name": "strategy_id", - "type": "number", - "required": false, - "description": "生效的策略 ID(与入参保持一致,兼容回传)" - }, - { - "name": "plan", - "type": "object", - "required": true, - "description": "任务计划/执行预览对象,描述本次任务预估的执行计划" - }, - { - "name": "plan_summary", - "type": "string", - "required": true, - "description": "计划摘要字符串,便于前端在受理后快速展示(例如:'创建 3 个波次,涉及 120 单,约 450 件')" - }, - { - "name": "validation_errors", - "type": "array", - "required": false, - "description": "当入参校验失败时返回的数组,每项为 { field, message } 对象,供前端展示或定位问题" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "可选提示信息或错误说明(创建失败时返回简短说明)" - }, - { - "name": "fetch_state", - "type": "number", - "required": true, - "description": "抓取结果三态:1=成功创建任务(返回 task_id/task_no),2=普通失败(task_id=null),3=存在未完成任务(返回 existing task_id/task_no,前端可进入拣货流程)" - }, - { - "name": "tip", - "type": "string", - "required": false, - "description": "简短提示,用于向前端展示简要原因或下一步建议" - }, - { - "name": "can_enter_pick_flow", - "type": "boolean", - "required": false, - "description": "仅当 fetch_state=3 时为 true,表示前端可直接进入拣货流程" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.waveStrategyFetchPda", - "title": "按策略提交并创建抓取主流程任务(PDA)。当前为最小主流程:进行入参校验并创建任务记录,返回创建结果与计划预览;后续扫描/执行阶段将扩展为完整执行流。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。", - "description": "按策略提交并创建抓取主流程任务(PDA)。当前为最小主流程:进行入参校验并创建任务记录,返回创建结果与计划预览;后续扫描/执行阶段将扩展为完整执行流。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "strategy_id / strategyId", - "type": "number", - "required": true, - "description": "策略ID(正整数,支持下划线/驼峰)" - }, - { - "name": "cart_id / cartId", - "type": "string|number", - "required": false, - "description": "可选,关联拣货车/作业车ID,支持字符串或数字,用于记录作业上下文" - }, - { - "name": "source / operation_source", - "type": "string", - "required": false, - "description": "可选,操作来源标识(例如 pda/admin/manual/auto),用于审计与分流策略" - }, - { - "name": "strategy_params / strategyParams", - "type": "object", - "required": false, - "description": "可选,策略参数透传对象(如 order_min_qty/order_max_qty/allow_cross_owner 等),在创建任务时作为策略覆盖或附加参数使用" - } - ], - "response": [ - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态:created(已创建主流程任务),后续可能为 running/success/failed" - }, - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务唯一 ID(用于后续查询或关联)" - }, - { - "name": "task_no", - "type": "string", - "required": true, - "description": "任务业务编号(便于展示与关联)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "生效的仓库 ID(来自当前上下文,如可用则返回)" - }, - { - "name": "strategy_id", - "type": "number", - "required": false, - "description": "生效的策略 ID(与入参保持一致,兼容回传)" - }, - { - "name": "plan", - "type": "object", - "required": true, - "description": "任务计划/执行预览对象,描述本次任务预估的执行计划" - }, - { - "name": "plan_summary", - "type": "string", - "required": true, - "description": "计划摘要字符串,便于前端在受理后快速展示(例如:'创建 3 个波次,涉及 120 单,约 450 件')" - }, - { - "name": "validation_errors", - "type": "array", - "required": false, - "description": "当入参校验失败时返回的数组,每项为 { field, message } 对象,供前端展示或定位问题" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "可选提示信息或错误说明(创建失败时返回简短说明)" - }, - { - "name": "fetch_state", - "type": "number", - "required": true, - "description": "抓取结果三态:1=成功创建任务(返回 task_id/task_no),2=普通失败(task_id=null),3=存在未完成任务(返回 existing task_id/task_no,前端可进入拣货流程)" - }, - { - "name": "tip", - "type": "string", - "required": false, - "description": "简短提示,用于向前端展示简要原因或下一步建议" - }, - { - "name": "can_enter_pick_flow", - "type": "boolean", - "required": false, - "description": "仅当 fetch_state=3 时为 true,表示前端可直接进入拣货流程" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.waveStrategyList", - "title": "查询当前仓库波次策略列表。仅查询当前登录仓库在 wms_wave_strategy 中的数据,返回标准 list/pagination 结构。", - "description": "查询当前仓库波次策略列表。仅查询当前登录仓库在 wms_wave_strategy 中的数据,返回标准 list/pagination 结构。", - "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": "strategy_type", - "type": "number", - "required": false, - "description": "仅支持 1=散单、2=团购;与 where.strategy_type 同时存在时以顶层 strategy_type 为准。" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "当前仅支持 where.strategy_type(1/2);其余 where 字段暂不支持。" - }, - { - "name": "calculate_next_fetch_order_count / calculateNextFetchOrderCount", - "type": "number", - "required": false, - "description": "0-不计算(默认),1-计算并返回每条策略的 next_fetch_order_count;支持别名 calculateNextFetchOrderCount" - }, - { - "name": "debug", - "type": "number", - "required": false, - "description": "0-不启用(默认),1-启用调试输出,返回每条策略的 next_fetch_order_list(含结构/快递/货主ID等指标明细)" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "策略列表,每项为波次策略记录" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.waveStrategyQuickScan", - "title": "提交波次策略快速扫描异步任务。无外部参数,使用当前仓库上下文;同一仓库同一时刻仅允许一个任务运行,若已有运行任务直接返回已有 task_id。", - "description": "提交波次策略快速扫描异步任务。无外部参数,使用当前仓库上下文;同一仓库同一时刻仅允许一个任务运行,若已有运行任务直接返回已有 task_id。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [ - { - "name": "status", - "type": "string", - "required": true, - "description": "提交状态,固定 success" - }, - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(用于后续查询进度)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库 ID(来自当前上下文)" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态(一般为 submitted 或 running)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "可选提示信息" - }, - { - "name": "accepted_at", - "type": "string", - "required": false, - "description": "任务受理时间(ISO 字符串)" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.waveStrategyQuickScanTaskProgress", - "title": "查询波次策略快速扫描任务进度。接受 task_id / taskId,若未找到返回 state='not_found'。", - "description": "查询波次策略快速扫描任务进度。接受 task_id / taskId,若未找到返回 state='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(下划线或驼峰兼容,必填)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态:submitted/running/success/failed/not_found" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "仓库 ID" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "扫描订单总数" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数" - }, - { - "name": "matched_order_count", - "type": "number", - "required": false, - "description": "命中策略的订单数" - }, - { - "name": "unmatched_order_count", - "type": "number", - "required": false, - "description": "未命中策略的订单数" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比(0-100)" - }, - { - "name": "submitted_at", - "type": "string", - "required": false, - "description": "提交时间(timestamp 或 ISO)" - }, - { - "name": "start_time", - "type": "string", - "required": false, - "description": "实际开始时间(ISO)" - }, - { - "name": "end_time", - "type": "string", - "required": false, - "description": "结束时间(ISO)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "错误信息(若失败)" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "错误码(若失败)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "耗时,毫秒" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "moduleFolder": "order.wave", - "method": "order.wave.waveStrategyUpdate", - "title": "修改波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。id(或 strategy_id/strategyId)为必填主键,其他字段为可选更新;更新成功后会推进仓库的 wave_strategy_version 并失效相关缓存。", - "description": "修改波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。id(或 strategy_id/strategyId)为必填主键,其他字段为可选更新;更新成功后会推进仓库的 wave_strategy_version 并失效相关缓存。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id / strategy_id / strategyId", - "type": "number", - "required": true, - "description": "策略主键,兼容 id / strategy_id / strategyId(必填)" - }, - { - "name": "strategy_name", - "type": "string", - "required": false, - "description": "策略名称(可选)" - }, - { - "name": "strategy_type", - "type": "number", - "required": false, - "description": "策略类型(可选,正整数)" - }, - { - "name": "batch_mode", - "type": "number", - "required": false, - "description": "拣货模式(可选,正整数)" - }, - { - "name": "status", - "type": "number", - "required": false, - "description": "状态:1-启用 0-停用(可选)" - }, - { - "name": "order_min_sku", - "type": "number", - "required": false, - "description": "订单最小 SKU 种类数(可选,正整数或 null)" - }, - { - "name": "order_max_sku", - "type": "number", - "required": false, - "description": "订单最大 SKU 种类数(可选,正整数或 null)" - }, - { - "name": "order_min_qty", - "type": "number", - "required": false, - "description": "订单最小商品总数(可选,正整数或 null)" - }, - { - "name": "order_max_qty", - "type": "number", - "required": false, - "description": "订单最大商品总数(可选,正整数或 null)" - }, - { - "name": "min_same_structure", - "type": "number", - "required": false, - "description": "最小相同结构订单数(可选,正整数或 null)" - }, - { - "name": "max_same_structure", - "type": "number", - "required": false, - "description": "最大相同结构订单数(可选,正整数或 null)。会受仓库 min_group_order_fetch_quantity 约束,接口会自动调整。" - }, - { - "name": "batch_max_orders", - "type": "number", - "required": false, - "description": "批次最大订单数(可选)" - }, - { - "name": "batch_max_skus", - "type": "number", - "required": false, - "description": "批次最大 SKU 总数(可选)" - }, - { - "name": "group_batch_max_orders", - "type": "number", - "required": false, - "description": "团购批次最大订单数(可选)" - }, - { - "name": "require_same_express", - "type": "boolean", - "required": false, - "description": "是否要求相同快递(可选,布尔)" - }, - { - "name": "allow_cross_owner", - "type": "boolean", - "required": false, - "description": "是否允许跨货主(可选,布尔)" - }, - { - "name": "description", - "type": "string", - "required": false, - "description": "策略描述(可选)" - }, - { - "name": "allowed_provinces", - "type": "array|string", - "required": false, - "description": "允许的省份列表(可选,支持数组/JSON/逗号分隔)" - }, - { - "name": "allowed_platforms", - "type": "array|string", - "required": false, - "description": "允许的平台列表(可选,支持数组/JSON/逗号分隔)" - }, - { - "name": "allowed_owners", - "type": "array|string", - "required": false, - "description": "允许的货主列表(可选,支持数组/JSON/逗号分隔);系统会校验所传货主是否在仓库可用货主范围内,非法值将导致 400 错误。" - }, - { - "name": "allowed_expresses", - "type": "array|string", - "required": false, - "description": "允许的快递编码列表(可选,支持数组/JSON/逗号分隔);系统会校验所传编码是否在可用快递列表内,非法值将导致 400 错误。" - }, - { - "name": "wave_prefix", - "type": "string", - "required": false, - "description": "波次编号前缀(可选),最多 5 个字符,如 D、B、A;不传则保持原值" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": true, - "description": "更新后的策略对象,字段同 order.wave.waveStrategyList.list[*] 所示" - }, - { - "name": "code", - "type": "number", - "required": true, - "description": "HTTP-like 状态码,成功时返回 200" - } - ] - }, - { - "moduleName": "拣货模块", - "moduleKey": "pick", - "moduleFolder": "pick", - "method": "pick.query", - "title": "按 keyword(运单号或波次号)获取或创建当前用户的拣货任务:命中同用户活动任务返回 existing;无活动任务则创建并返回 created;若活动任务归属他人则返回冲突提示。", - "description": "按 keyword(运单号或波次号)获取或创建当前用户的拣货任务:命中同用户活动任务返回 existing;无活动任务则创建并返回 created;若活动任务归属他人则返回冲突提示。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "keyword", - "type": "string", - "required": true, - "description": "关键字,支持运单号或波次号。" - } - ], - "response": [ - { - "name": "task_id", - "type": "number", - "required": true, - "description": "拣货任务ID。" - }, - { - "name": "status", - "type": "string", - "required": true, - "description": "任务状态:existing(命中当前用户已有活动任务)或 created(新建成功)。" - }, - { - "name": "tip", - "type": "string", - "required": true, - "description": "提示文案。" - } - ] - }, - { - "moduleName": "拣货模块", - "moduleKey": "pick", - "moduleFolder": "pick", - "method": "pick.wavePickTaskComplete", - "title": "完全提交拣货任务。支持 mode=1 全部确认,mode=2 部分确认(需传 order_ids)。提交后根据是否全部完成自动推进任务状态。后台抓取创建的任务(source=2)必须先绑定拣货车才能提交,否则返回 400。", - "description": "完全提交拣货任务。支持 mode=1 全部确认,mode=2 部分确认(需传 order_ids)。提交后根据是否全部完成自动推进任务状态。后台抓取创建的任务(source=2)必须先绑定拣货车才能提交,否则返回 400。", - "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", - "type": "number", - "required": true, - "description": "拣货任务ID" - }, - { - "name": "mode", - "type": "number", - "required": false, - "description": "提交模式:1=全部确认(默认),2=部分确认" - }, - { - "name": "order_ids", - "type": "array", - "required": false, - "description": "部分确认模式(mode=2)时必填;仅会确认命中当前任务的订单ID" - } - ], - "response": [ - { - "name": "task_id", - "type": "number", - "required": true, - "description": "拣货任务ID" - }, - { - "name": "mode", - "type": "number", - "required": true, - "description": "实际生效的提交模式(1=全部确认,2=部分确认)" - }, - { - "name": "confirmed_order_ids", - "type": "array", - "required": true, - "description": "本次成功确认的订单ID列表" - }, - { - "name": "is_completed", - "type": "boolean", - "required": true, - "description": "提交后任务是否已完成" - }, - { - "name": "progress", - "type": "object", - "required": true, - "description": "任务订单拣货进度统计" - } - ] - }, - { - "moduleName": "拣货模块", - "moduleKey": "pick", - "moduleFolder": "pick", - "method": "pick.wavePickTaskDetail", - "title": "按任务ID获取拣货任务详情。查询前会校验任务内订单是否全部完成快递号与储位分配:若存在未分配快递号或未分配储位订单,将返回 400 并在 data 中返回 action 与 order_ids 供前端触发一键分配;详情响应新增中间态进度语义(task.is_completed、task.progress 与顶层 is_completed),用于前端判断是否已完成与展示阶段进度;仅允许任务的 pick_user_id 与当前登录用户一致时返回详情。当 pick_mode=1(团购小波次)时,picking_details 字段不返回以减少带宽。", - "description": "按任务ID获取拣货任务详情。查询前会校验任务内订单是否全部完成快递号与储位分配:若存在未分配快递号或未分配储位订单,将返回 400 并在 data 中返回 action 与 order_ids 供前端触发一键分配;详情响应新增中间态进度语义(task.is_completed、task.progress 与顶层 is_completed),用于前端判断是否已完成与展示阶段进度;仅允许任务的 pick_user_id 与当前登录用户一致时返回详情。当 pick_mode=1(团购小波次)时,picking_details 字段不返回以减少带宽。", - "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", - "type": "number", - "required": true, - "description": "wms_wave_pick_task 主键 ID" - } - ], - "response": [ - { - "name": "task", - "type": "object", - "required": false, - "description": "拣货任务主表(精简字段)" - }, - { - "name": "is_completed", - "type": "boolean", - "required": false, - "description": "任务是否已完成(与 task.is_completed 含义一致,便于前端直接判断)" - }, - { - "name": "boxes", - "type": "array", - "required": false, - "description": "箱列表;包含用于前端展示与拣货进度的统计字段" - }, - { - "name": "picking_details", - "type": "array", - "required": false, - "description": "拣货明细列表(按库位/商品/数量拆分),用于从明细视角展示拣货要求。注意:当 pick_mode=1(团购小波次)时该字段不返回,减少带宽浪费;其他 pick_mode(2/3/4/5)正常返回。" - }, - { - "name": "picking_summary", - "type": "object", - "required": false, - "description": "对 picking_details 的汇总信息,用于统计与前端显示" - }, - { - "name": "picking_view", - "type": "object", - "required": false, - "description": "按 pick_mode 区分的 picking_view 形态输出(五种形态);用于前端按任务类型展示聚合视图。" - } - ] - }, - { - "moduleName": "拣货模块", - "moduleKey": "pick", - "moduleFolder": "pick", - "method": "pick.wavePickTaskSubmit", - "title": "提交拣货任务中间态。用于保存阶段性数据到任务 ext_json.pick_intermediate,并在任务初始状态时自动推进到进行中。", - "description": "提交拣货任务中间态。用于保存阶段性数据到任务 ext_json.pick_intermediate,并在任务初始状态时自动推进到进行中。", - "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", - "type": "number", - "required": true, - "description": "拣货任务ID" - }, - { - "name": "payload", - "type": "object", - "required": false, - "description": "中间态业务数据对象,将原样保存到 ext_json.pick_intermediate.payload" - } - ], - "response": [ - { - "name": "task_id", - "type": "number", - "required": true, - "description": "拣货任务ID" - }, - { - "name": "status", - "type": "string", - "required": true, - "description": "提交结果状态,固定为 submitted" - }, - { - "name": "is_completed", - "type": "boolean", - "required": true, - "description": "当前任务是否已完成" - }, - { - "name": "progress", - "type": "object", - "required": true, - "description": "任务订单拣货进度统计" - } - ] - }, - { - "moduleName": "拣货车模块", - "moduleKey": "pickCart", - "moduleFolder": "pickcart", - "method": "pickCart.bindTaskCart", - "title": "绑定拣货任务与拣货车。支持传 cart_id 或 cart_code;若任务已绑定其他拣货车则自动改绑,若目标拣货车已绑定其他活动任务则返回冲突。", - "description": "绑定拣货任务与拣货车。支持传 cart_id 或 cart_code;若任务已绑定其他拣货车则自动改绑,若目标拣货车已绑定其他活动任务则返回冲突。", - "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", - "type": "number", - "required": true, - "description": "拣货任务ID" - }, - { - "name": "cart_id", - "type": "number", - "required": false, - "description": "拣货车ID,和 cart_code 二选一即可" - }, - { - "name": "cart_code", - "type": "string", - "required": false, - "description": "拣货车编码,和 cart_id 二选一即可" - } - ], - "response": [ - { - "name": "task_id", - "type": "number", - "required": true, - "description": "拣货任务ID" - }, - { - "name": "task_no", - "type": "string", - "required": true, - "description": "拣货任务编号" - }, - { - "name": "cart", - "type": "object", - "required": true, - "description": "绑定后的拣货车信息" - } - ] - }, - { - "moduleName": "拣货车模块", - "moduleKey": "pickCart", - "moduleFolder": "pickcart", - "method": "pickCart.codeDuplicateCheck", - "title": "拣货车编码查重。支持传 exclude_cart_id 排除自身,用于编辑场景判断是否与其他车重复。", - "description": "拣货车编码查重。支持传 exclude_cart_id 排除自身,用于编辑场景判断是否与其他车重复。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "cart_code", - "type": "string", - "required": true, - "description": "待校验的拣货车编码" - }, - { - "name": "exclude_cart_id", - "type": "number", - "required": false, - "description": "需排除的拣货车ID,通常为当前编辑记录自身ID" - } - ], - "response": [ - { - "name": "duplicated", - "type": "boolean", - "required": true, - "description": "是否存在重复编码" - }, - { - "name": "cart_id", - "type": "number", - "required": false, - "description": "命中的重复拣货车ID,无重复时为 null" - }, - { - "name": "cart_code", - "type": "string", - "required": false, - "description": "命中的重复编码,无重复时为 null" - }, - { - "name": "cart_name", - "type": "string", - "required": false, - "description": "命中的重复拣货车名称,无重复时为 null" - }, - { - "name": "status", - "type": "number", - "required": false, - "description": "命中的重复拣货车状态,无重复时为 null" - } - ] - }, - { - "moduleName": "拣货车模块", - "moduleKey": "pickCart", - "moduleFolder": "pickcart", - "method": "pickCart.create", - "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": "cart_code", - "type": "string", - "required": true, - "description": "拣货车编码,当前仓库内唯一" - }, - { - "name": "cart_name", - "type": "string", - "required": false, - "description": "拣货车名称" - }, - { - "name": "status", - "type": "number", - "required": false, - "description": "状态:0-停用 1-启用,默认 1" - } - ], - "response": [ - { - "name": "cart_id", - "type": "number", - "required": true, - "description": "拣货车ID" - }, - { - "name": "cart_code", - "type": "string", - "required": true, - "description": "拣货车编码" - }, - { - "name": "cart_name", - "type": "string", - "required": false, - "description": "拣货车名称" - }, - { - "name": "status", - "type": "number", - "required": true, - "description": "状态:0-停用 1-启用" - } - ] - }, - { - "moduleName": "拣货车模块", - "moduleKey": "pickCart", - "moduleFolder": "pickcart", - "method": "pickCart.delete", - "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": "cart_id", - "type": "number", - "required": true, - "description": "拣货车ID" - } - ], - "response": [ - { - "name": "cart_id", - "type": "number", - "required": true, - "description": "被删除的拣货车ID" - }, - { - "name": "deleted", - "type": "boolean", - "required": true, - "description": "是否删除成功,固定为 true" - } - ] - }, - { - "moduleName": "拣货车模块", - "moduleKey": "pickCart", - "moduleFolder": "pickcart", - "method": "pickCart.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": "cart_id", - "type": "number", - "required": true, - "description": "拣货车ID" - } - ], - "response": [ - { - "name": "cart_id", - "type": "number", - "required": true, - "description": "拣货车ID" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID" - }, - { - "name": "cart_code", - "type": "string", - "required": true, - "description": "拣货车编码" - }, - { - "name": "cart_name", - "type": "string", - "required": false, - "description": "拣货车名称" - }, - { - "name": "status", - "type": "number", - "required": true, - "description": "状态:0-停用 1-启用" - }, - { - "name": "current_task_id", - "type": "number", - "required": false, - "description": "当前绑定任务ID,无绑定时为 null" - }, - { - "name": "current_task_no", - "type": "string", - "required": false, - "description": "当前绑定任务编号,无绑定时为 null" - } - ] - }, - { - "moduleName": "拣货车模块", - "moduleKey": "pickCart", - "moduleFolder": "pickcart", - "method": "pickCart.list", - "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": "pagination", - "type": "object", - "required": false, - "description": "分页参数,支持 page/pageSize,默认 1/20" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "筛选条件,支持 keyword、status、current_task_id" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "拣货车列表,元素结构同 pickCart.detail 返回" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息,包含 page、pageSize、total、totalPages" - } - ] - }, - { - "moduleName": "拣货车模块", - "moduleKey": "pickCart", - "moduleFolder": "pickcart", - "method": "pickCart.scan", - "title": "按拣货车条码/编码查询拣货车信息,供 PDA 扫码后用于拣货任务绑定。", - "description": "按拣货车条码/编码查询拣货车信息,供 PDA 扫码后用于拣货任务绑定。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "cart_code", - "type": "string", - "required": true, - "description": "拣货车条码/编码" - } - ], - "response": [ - { - "name": "cart_id", - "type": "number", - "required": true, - "description": "拣货车ID" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID" - }, - { - "name": "cart_code", - "type": "string", - "required": true, - "description": "拣货车编码" - }, - { - "name": "cart_name", - "type": "string", - "required": false, - "description": "拣货车名称" - }, - { - "name": "status", - "type": "number", - "required": true, - "description": "拣货车状态:0-停用 1-启用" - }, - { - "name": "current_task_id", - "type": "number", - "required": false, - "description": "当前绑定任务ID,无绑定时为 null" - }, - { - "name": "current_task_no", - "type": "string", - "required": false, - "description": "当前绑定任务编号,无绑定时为 null" - } - ] - }, - { - "moduleName": "拣货车模块", - "moduleKey": "pickCart", - "moduleFolder": "pickcart", - "method": "pickCart.update", - "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": "cart_id", - "type": "number", - "required": true, - "description": "拣货车ID" - }, - { - "name": "cart_code", - "type": "string", - "required": false, - "description": "新的拣货车编码" - }, - { - "name": "cart_name", - "type": "string", - "required": false, - "description": "新的拣货车名称" - }, - { - "name": "status", - "type": "number", - "required": false, - "description": "新的状态:0-停用 1-启用" - } - ], - "response": [ - { - "name": "cart_id", - "type": "number", - "required": true, - "description": "拣货车ID" - }, - { - "name": "cart_code", - "type": "string", - "required": true, - "description": "拣货车编码" - }, - { - "name": "cart_name", - "type": "string", - "required": false, - "description": "拣货车名称" - }, - { - "name": "status", - "type": "number", - "required": true, - "description": "状态:0-停用 1-启用" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.add", - "title": "新增打印台:关联打印电脑并可保存 subject_config(会由模型 normalizeSubjectConfig 校验)。", - "description": "新增打印台:关联打印电脑并可保存 subject_config(会由模型 normalizeSubjectConfig 校验)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "computer_id", - "type": "number", - "required": true, - "description": "关联的打印电脑 ID(必填)" - }, - { - "name": "name", - "type": "string", - "required": true, - "description": "打印台名称(必填)" - }, - { - "name": "custom_barcode", - "type": "string", - "required": false, - "description": "自定义条码" - }, - { - "name": "default_printer_name", - "type": "string", - "required": false, - "description": "默认打印机名称" - }, - { - "name": "subject_config", - "type": "object", - "required": false, - "description": "打印台的主题/业务配置(可选,若存在将调用模型 normalizeSubjectConfig 进行校验)" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": true, - "description": "新建的打印台对象(raw)" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.del", - "title": "批量删除(软删除)打印台:将指定 ids 的记录标记为 deleted=1。", - "description": "批量删除(软删除)打印台:将指定 ids 的记录标记为 deleted=1。", - "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 数组,必须为非空数组(示例: [1,2,3])" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": false, - "description": "返回空数据结构,表示操作成功" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.getComputer", - "title": "查询当前仓库下状态为 1 的打印电脑列表(raw 列表)。", - "description": "查询当前仓库下状态为 1 的打印电脑列表(raw 列表)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [ - { - "name": "data", - "type": "array", - "required": true, - "description": "打印电脑数组,每项为打印电脑的原始记录" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.getComputerPrinter", - "title": "获取指定打印电脑的打印机列表(从 redis: printer:{id}:printerList 读取并返回 data 数组,通常为打印机名称数组或对象数组)。", - "description": "获取指定打印电脑的打印机列表(从 redis: printer:{id}:printerList 读取并返回 data 数组,通常为打印机名称数组或对象数组)。", - "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": "number", - "required": true, - "description": "打印电脑 ID,必填" - } - ], - "response": [ - { - "name": "data", - "type": "array", - "required": true, - "description": "打印机数组,通常为字符串名称数组或打印机对象数组(取决于 redis 存储格式)" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.getItem", - "title": "查询单个打印台详情,返回打印台对象(raw 行记录,含 subject_config)", - "description": "查询单个打印台详情,返回打印台对象(raw 行记录,含 subject_config)", - "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": "number", - "required": true, - "description": "打印台 ID,必填" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": true, - "description": "打印台原始记录(PrintStation raw),字段示例" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.getList", - "title": "查询当前仓库下的打印台列表,支持分页与 where 条件筛选(支持字段:id、name、computer_id、custom_barcode)。", - "description": "查询当前仓库下的打印台列表,支持分页与 where 条件筛选(支持字段:id、name、computer_id、custom_barcode)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "page", - "type": "number", - "required": false, - "description": "页码,默认 1" - }, - { - "name": "pageSize", - "type": "number", - "required": false, - "description": "每页数量,默认 20" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "筛选条件对象;支持字段:id(等值)、name、computer_id、custom_barcode;推荐使用 { operator, value, type } 标准结构" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": true, - "description": "返回数据对象,包含 list 与 pagination" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.getPrintRecordItem", - "title": "print.getPrintRecordItem 接口", - "description": "print.getPrintRecordItem 接口", - "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": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.getPrintResult", - "title": "print.getPrintResult 接口", - "description": "print.getPrintResult 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "printId", - "type": "string", - "required": true, - "description": "printId 参数" - } - ], - "response": [] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.hasName", - "title": "print.hasName 接口", - "description": "print.hasName 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "name", - "type": "string", - "required": true, - "description": "name 参数" - }, - { - "name": "id", - "type": "number", - "required": false, - "description": "id 参数" - } - ], - "response": [] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.notify_lock", - "title": "兼容别名(等价转调到 print.notifyLock);建议使用 print.notifyLock。", - "description": "兼容别名(等价转调到 print.notifyLock);建议使用 print.notifyLock。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.notifyLock", - "title": "仅执行订单锁定流程,不发送打印任务;记录打印任务日志并写入订单操作日志。兼容别名:print.notify_lock(等价转调)。", - "description": "仅执行订单锁定流程,不发送打印任务;记录打印任务日志并写入订单操作日志。兼容别名:print.notify_lock(等价转调)。", - "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", - "type": "array", - "required": false, - "description": "订单 ID 数组(与 orderIds 互为别名)。至少需提供 order_ids/orderIds/waveGroups/data.waveGroups 中的一类以提取订单 ID。" - }, - { - "name": "orderIds", - "type": "array", - "required": false, - "description": "订单 ID 数组(驼峰兼容,等同于 order_ids)。" - }, - { - "name": "waveGroups", - "type": "array", - "required": false, - "description": "波次分组结构(可从中提取订单 ID,参考 order.print.getWavePlatformPrintData 返回的 waveGroups)。" - }, - { - "name": "data", - "type": "object", - "required": false, - "description": "兼容包装对象;若传入 data.waveGroups,可从中提取订单 ID。" - } - ], - "response": [ - { - "name": "locked_count", - "type": "number", - "required": false, - "description": "成功锁定的订单数量" - }, - { - "name": "order_ids_count", - "type": "number", - "required": false, - "description": "请求中识别出的订单 ID 数量" - }, - { - "name": "order_ids", - "type": "array", - "required": false, - "description": "本次尝试锁定的订单 ID 列表" - }, - { - "name": "source", - "type": "string", - "required": false, - "description": "操作来源标识(可选,若后端返回则提供具体来源)" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.retryFailed", - "title": "失败项补打:重试指定打印记录的发送。被定时任务 print-retry-compensation 调用以批量触发失败项补打。", - "description": "失败项补打:重试指定打印记录的发送。被定时任务 print-retry-compensation 调用以批量触发失败项补打。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "print_ids", - "type": "array", - "required": true, - "description": "要补打的打印记录 ID 数组" - }, - { - "name": "force", - "type": "boolean", - "required": false, - "description": "是否强制补打(当前实现仍不放宽状态判定)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "显式指定仓库 ID(调度任务推荐提供),若缺失将使用当前用户的 store_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": "success_count", - "type": "number", - "required": false, - "description": "成功补打数量" - }, - { - "name": "failed_count", - "type": "number", - "required": false, - "description": "补打失败数量" - }, - { - "name": "skipped_count", - "type": "number", - "required": false, - "description": "被跳过的记录数量" - }, - { - "name": "retried", - "type": "array", - "required": false, - "description": "补打尝试结果数组" - }, - { - "name": "skipped", - "type": "array", - "required": false, - "description": "跳过项明细" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.savePrinters", - "title": "保存 default_printer_name 与 subject_config.express_bind_printer。", - "description": "保存 default_printer_name 与 subject_config.express_bind_printer。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "defaultPrinter", - "type": "string", - "required": true, - "description": "默认打印机名称(必填),会写入打印台的 `default_printer_name` 字段" - }, - { - "name": "express", - "type": "array", - "required": true, - "description": "快递与打印机绑定数组(必填)。每项应包含首选字段 `express_code`(string)和 `printer_name`(string)。为兼容历史字段,也接受 `express_id`(可映射为 `express_code`)和 `name`(可映射为 `printer_name`)。接口实现会将结果序列化后写入打印台的 `subject_config.express_bind_printer`。" - }, - { - "name": "print_station_id", - "type": "number", - "required": true, - "description": "目标打印台 ID(必填)。接口会根据此 ID 更新对应打印台记录的 default_printer_name 与 subject_config.express_bind_printer" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": false, - "description": "成功不返回业务数据,语义为成功(实现中返回 { data: null, code: 0 })" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.send", - "title": "发送打印任务到打印电脑,并记录打印单。说明:当 type=express 时,接口按 data.waveGroups(来源于 order.print.getWavePlatformPrintData 返回的 data.waveGroups)进行处理,按 waveGroups -> platforms 串行处理,每个平台+快递 组分别发送;返回沿用现有简要风格,不返回明细。接口在记录打印单的同时,也会写入订单操作日志(记录打印相关操作)。", - "description": "发送打印任务到打印电脑,并记录打印单。说明:当 type=express 时,接口按 data.waveGroups(来源于 order.print.getWavePlatformPrintData 返回的 data.waveGroups)进行处理,按 waveGroups -> platforms 串行处理,每个平台+快递 组分别发送;返回沿用现有简要风格,不返回明细。接口在记录打印单的同时,也会写入订单操作日志(记录打印相关操作)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "computerId", - "type": "string", - "required": false, - "description": "打印电脑 ID;历史/customize 分支可能使用。注意:type=express 场景下不适用(该字段不再作为 express 路径的必填或传输约束)。" - }, - { - "name": "count", - "type": "number", - "required": false, - "description": "打印份数;对 type=customize 有效。type=express 场景下不保留,相应字段会被忽略。" - }, - { - "name": "data", - "type": "object", - "required": true, - "description": "打印业务数据对象。对于 type=express:必须提供 data.waveGroups(来源于 order.print.getWavePlatformPrintData 的返回值 data.waveGroups),接口按 waveGroups->platforms 串行处理,每个 平台+快递 组分别发送;对于 type=customize,data 的具体字段由模板决定。" - }, - { - "name": "printer", - "type": "string", - "required": false, - "description": "打印机名称;type=customize 使用。type=express 下忽略(由快递平台/站点决定打印目标)。" - }, - { - "name": "template", - "type": "object", - "required": false, - "description": "打印模板对象;仅 type=customize 时必填且应包含 page_width、page_height、template_content。type=express 场景下忽略 template 字段。" - }, - { - "name": "timestamp", - "type": "string", - "required": false, - "description": "业务时间戳;历史字段。type=express 场景下不适用。" - }, - { - "name": "type", - "type": "string", - "required": true, - "description": "打印类型;支持 customize、express。对于 express 场景,必须遵守下列额外约束:提供 printStationId、requestCode,并在 data.waveGroups 中传入来自 order.print.getWavePlatformPrintData 的 waveGroups 数据。" - }, - { - "name": "printStationId", - "type": "string", - "required": true, - "description": "打印站点/工作站标识(必填,type=express 时必须提供),用于指示目标打印站或分发单元。" - }, - { - "name": "requestCode", - "type": "string", - "required": true, - "description": "请求去重/防重放 ID(必填,type=express 时必须提供)。接口约束:requestCode 在约定周期内不得变更(例如一次批次/会话期间),系统在同一次请求处理范围内保证对重复 requestCode 进行防重放处理;此保护仅保证同一次请求内的去重/防重放,不等同于跨请求的强幂等保证。" - } - ], - "response": [ - { - "name": "flag", - "type": "string", - "required": false, - "description": "全局调用结果标识,成功时为 success,失败时为 failure" - }, - { - "name": "code", - "type": "number", - "required": false, - "description": "业务状态码;成功时为 200,失败时通常为 1001 或 504" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "返回信息" - }, - { - "name": "printId", - "type": "number", - "required": false, - "description": "打印记录 ID;任务入库成功后返回,失败时若已生成记录也会返回。接口在 express 场景下不返回明细结果,只给出调用结果摘要。" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "moduleFolder": "print", - "method": "print.updateItem", - "title": "更新打印台信息:支持更新 name、computer_id、custom_barcode、default_printer_name 以及 subject_config(会走 normalizeSubjectConfig)。", - "description": "更新打印台信息:支持更新 name、computer_id、custom_barcode、default_printer_name 以及 subject_config(会走 normalizeSubjectConfig)。", - "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": "number", - "required": true, - "description": "打印台 ID(必填)" - }, - { - "name": "computer_id", - "type": "number", - "required": false, - "description": "要更新的打印电脑 ID" - }, - { - "name": "custom_barcode", - "type": "string", - "required": false, - "description": "自定义条码" - }, - { - "name": "name", - "type": "string", - "required": false, - "description": "打印台名称" - }, - { - "name": "default_printer_name", - "type": "string", - "required": false, - "description": "默认打印机名称" - }, - { - "name": "subject_config", - "type": "object", - "required": false, - "description": "subject_config(可选),传入将替换/规范化配置" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": false, - "description": "更新结果,通常返回 null" - } - ] - }, - { - "moduleName": "打印机站点模块", - "moduleKey": "printer.station", - "moduleFolder": "printer.station", - "method": "printer.station.list", - "title": "获取打印站点列表", - "description": "获取打印站点列表", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "账号管理模块", - "moduleKey": "setting.account", - "moduleFolder": "setting.account", - "method": "setting.account.add", - "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": "phone", - "type": "string", - "required": true, - "description": "手机号,作为账号复用/创建依据" - }, - { - "name": "real_name", - "type": "string", - "required": true, - "description": "工号姓名,新增时禁止直接使用保留名称" - }, - { - "name": "username", - "type": "string", - "required": false, - "description": "新账号用户名,不传时系统自动生成" - }, - { - "name": "password", - "type": "string", - "required": false, - "description": "新账号密码,不传默认 111111" - }, - { - "name": "role_id", - "type": "number", - "required": false, - "description": "工号角色,不传时继承当前操作人工号角色" - }, - { - "name": "email", - "type": "string", - "required": false, - "description": "新账号邮箱,不传时按 username 自动生成" - } - ], - "response": [ - { - "name": "employee_id", - "type": "number", - "required": true, - "description": "新增或复用后的工号ID" - }, - { - "name": "account_id", - "type": "number", - "required": true, - "description": "绑定账号ID" - }, - { - "name": "role_id", - "type": "number", - "required": true, - "description": "绑定后的角色ID" - }, - { - "name": "is_new_account", - "type": "boolean", - "required": true, - "description": "是否为本次新建账号" - }, - { - "name": "phone", - "type": "string", - "required": true, - "description": "绑定账号手机号" - }, - { - "name": "username", - "type": "string", - "required": true, - "description": "绑定账号用户名" - } - ] - }, - { - "moduleName": "账号管理模块", - "moduleKey": "setting.account", - "moduleFolder": "setting.account", - "method": "setting.account.delete", - "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": "employee_id", - "type": "number", - "required": true, - "description": "要删除的工号ID" - } - ], - "response": [ - { - "name": "employee_id", - "type": "number", - "required": true, - "description": "被停用的工号ID" - }, - { - "name": "account_id", - "type": "number", - "required": true, - "description": "关联账号ID" - }, - { - "name": "status", - "type": "string", - "required": true, - "description": "固定返回 deleted" - }, - { - "name": "already_deleted", - "type": "boolean", - "required": false, - "description": "可选,true 表示该工号原本已停用" - } - ] - }, - { - "moduleName": "账号管理模块", - "moduleKey": "setting.account", - "moduleFolder": "setting.account", - "method": "setting.account.getBindWechatCode", - "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": "account_id", - "type": "number", - "required": true, - "description": "目标账号ID,兼容 user_id / id" - }, - { - "name": "longPoll", - "type": "boolean", - "required": false, - "description": "是否开启长轮询等待状态变化,最长60秒" - }, - { - "name": "waitTimeoutMs", - "type": "number", - "required": false, - "description": "等待超时毫秒数,后端自动封顶60000" - } - ], - "response": [] - }, - { - "moduleName": "账号管理模块", - "moduleKey": "setting.account", - "moduleFolder": "setting.account", - "method": "setting.account.list", - "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": "status", - "type": "number", - "required": false, - "description": "状态筛选,默认 1,仅查有效工号" - }, - { - "name": "includeDisabled", - "type": "boolean", - "required": false, - "description": "是否包含已删除工号" - } - ], - "response": [ - { - "name": "data[]", - "type": "object", - "required": true, - "description": "工号列表项" - }, - { - "name": "data[].employee_id", - "type": "number", - "required": true, - "description": "工号ID" - }, - { - "name": "data[].account_id", - "type": "number", - "required": true, - "description": "账号ID" - }, - { - "name": "data[].store_id", - "type": "number", - "required": true, - "description": "主体ID" - }, - { - "name": "data[].real_name", - "type": "string", - "required": true, - "description": "工号姓名" - }, - { - "name": "data[].status", - "type": "number", - "required": true, - "description": "工号状态:1=启用,0=停用" - }, - { - "name": "data[].username", - "type": "string", - "required": true, - "description": "账号用户名" - }, - { - "name": "data[].phone", - "type": "string", - "required": true, - "description": "账号手机号" - }, - { - "name": "data[].email", - "type": "string", - "required": true, - "description": "账号邮箱" - }, - { - "name": "data[].avatar_file_id", - "type": "number", - "required": false, - "description": "头像文件ID,为空表示未设置" - }, - { - "name": "data[].avatar_url", - "type": "string", - "required": true, - "description": "头像访问地址" - } - ] - }, - { - "moduleName": "账号管理模块", - "moduleKey": "setting.account", - "moduleFolder": "setting.account", - "method": "setting.account.unbindWechat", - "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": "account_id", - "type": "number", - "required": true, - "description": "目标账号ID,兼容 user_id / id" - } - ], - "response": [] - }, - { - "moduleName": "账号管理模块", - "moduleKey": "setting.account", - "moduleFolder": "setting.account", - "method": "setting.account.update", - "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": "employee_id", - "type": "number", - "required": true, - "description": "要更新的工号ID" - }, - { - "name": "real_name", - "type": "string", - "required": false, - "description": "更新后的工号姓名" - }, - { - "name": "file_id", - "type": "number", - "required": false, - "description": "已有文件ID,作为头像引用" - } - ], - "response": [ - { - "name": "employee_id", - "type": "number", - "required": true, - "description": "更新后的工号ID" - }, - { - "name": "real_name", - "type": "string", - "required": true, - "description": "更新后的工号姓名" - }, - { - "name": "avatar_file_id", - "type": "number", - "required": false, - "description": "更新后的头像文件ID" - }, - { - "name": "avatar_url", - "type": "string", - "required": true, - "description": "更新后的头像地址" - } - ] - }, - { - "moduleName": "快递编码管理模块", - "moduleKey": "setting.express", - "moduleFolder": "setting.express", - "method": "setting.express.checkCodeUnique", - "title": "校验快递编码在当前仓库/主体维度唯一性,仅支持 code 与可选 id 排除自身", - "description": "校验快递编码在当前仓库/主体维度唯一性,仅支持 code 与可选 id 排除自身", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "code", - "type": "string", - "required": true, - "description": "待校验的快递编码" - }, - { - "name": "id", - "type": "number", - "required": false, - "description": "排除自身 id(更新时使用)" - } - ], - "response": [] - }, - { - "moduleName": "快递编码管理模块", - "moduleKey": "setting.express", - "moduleFolder": "setting.express", - "method": "setting.express.create", - "title": "创建快递映射,仅写入已实现字段(code、name、express_code 等)", - "description": "创建快递映射,仅写入已实现字段(code、name、express_code 等)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "code", - "type": "string", - "required": true, - "description": "快递映射编码;接口会转为大写" - }, - { - "name": "name", - "type": "string", - "required": true, - "description": "快递名称(最大 50 字符)" - }, - { - "name": "express_code", - "type": "string", - "required": true, - "description": "系统快递编码;同时支持驼峰写法 expressCode" - } - ], - "response": [] - }, - { - "moduleName": "快递编码管理模块", - "moduleKey": "setting.express", - "moduleFolder": "setting.express", - "method": "setting.express.delete", - "title": "批量软删除快递映射;接受 ids 参数,已删除记录会在结果中标记。", - "description": "批量软删除快递映射;接受 ids 参数,已删除记录会在结果中标记。", - "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。" - } - ], - "response": [ - { - "name": "ids", - "type": "array", - "required": true, - "description": "请求中的所有 id 列表(原样返回)" - }, - { - "name": "deleted_ids", - "type": "array", - "required": true, - "description": "本次实际被软删除的 ID 列表(即原本未被删除的 ID)" - }, - { - "name": "already_deleted_ids", - "type": "array", - "required": true, - "description": "请求中已处于已删除状态的 ID 列表" - }, - { - "name": "status", - "type": "string", - "required": true, - "description": "固定返回 'deleted'" - } - ] - }, - { - "moduleName": "快递编码管理模块", - "moduleKey": "setting.express", - "moduleFolder": "setting.express", - "method": "setting.express.list", - "title": "查询当前仓库范围的快递映射列表,支持 where + pagination", - "description": "查询当前仓库范围的快递映射列表,支持 where + pagination", - "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 } 标准结构" - } - ], - "response": [] - }, - { - "moduleName": "快递编码管理模块", - "moduleKey": "setting.express", - "moduleFolder": "setting.express", - "method": "setting.express.listBase", - "title": "返回系统快递基础列表(系统级别基础快递,不含仓库自定义)", - "description": "返回系统快递基础列表(系统级别基础快递,不含仓库自定义)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [], - "response": [] - }, - { - "moduleName": "快递编码管理模块", - "moduleKey": "setting.express", - "moduleFolder": "setting.express", - "method": "setting.express.update", - "title": "更新快递映射。必须提供 `id`(必填),且至少提供 `code`、`name` 或 `express_code` 中的一个用于更新;同时支持 `expressCode` 驼峰写法。", - "description": "更新快递映射。必须提供 `id`(必填),且至少提供 `code`、`name` 或 `express_code` 中的一个用于更新;同时支持 `expressCode` 驼峰写法。", - "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": "number", - "required": true, - "description": "快递记录ID;也兼容别名 `setting_id` / `settingId`" - }, - { - "name": "code", - "type": "string", - "required": false, - "description": "快递映射编码(最大 50 字符,接口会大写化并校验在当前仓库的唯一性)" - }, - { - "name": "name", - "type": "string", - "required": false, - "description": "快递名称(最大 50 字符)" - }, - { - "name": "express_code", - "type": "string", - "required": false, - "description": "系统快递编码(必须为系统已存在的编码);支持 `expressCode` 驼峰写法" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": true, - "description": "更新后的快递映射对象(规范化字段)" - } - ] - }, - { - "moduleName": "快递接口管理模块", - "moduleKey": "setting.expressInterface", - "moduleFolder": "setting.expressinterface", - "method": "setting.expressInterface.create", - "title": "在当前仓库范围内创建快递接口,支持 shop_id/shopId 入参。", - "description": "在当前仓库范围内创建快递接口,支持 shop_id/shopId 入参。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "name", - "type": "string", - "required": true, - "description": "name" - }, - { - "name": "express_code", - "type": "string", - "required": true, - "description": "express_code" - }, - { - "name": "platform_code", - "type": "string", - "required": true, - "description": "platform_code" - }, - { - "name": "shop_id", - "type": "number", - "required": false, - "description": "店铺 ID(支持 shopId),正整数,可空;未传或空值按 null 处理" - }, - { - "name": "address", - "type": "string", - "required": false, - "description": "发件人详细地址(可选),使用 index.getShopExpressList 返回的 detail 字段值,非 full_address" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "新建记录 ID" - } - ] - }, - { - "moduleName": "快递接口管理模块", - "moduleKey": "setting.expressInterface", - "moduleFolder": "setting.expressinterface", - "method": "setting.expressInterface.delete", - "title": "删除快递接口,支持 id 别名 interface_id / interfaceId;返回被删除记录 id 与所属 warehouse_id。", - "description": "删除快递接口,支持 id 别名 interface_id / interfaceId;返回被删除记录 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": "id", - "type": "number", - "required": true, - "description": "快递接口ID;兼容 interface_id / interfaceId" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": false, - "description": "已删除记录 ID" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "记录所属仓库 ID" - }, - { - "name": "deleted", - "type": "boolean", - "required": false, - "description": "是否已删除,成功时为 true" - } - ] - }, - { - "moduleName": "快递接口管理模块", - "moduleKey": "setting.expressInterface", - "moduleFolder": "setting.expressinterface", - "method": "setting.expressInterface.list", - "title": "查询当前仓库范围的快递接口列表,支持 where + pagination;返回 data:{ list, total, page, page_size }。按 weight 升序、id 降序排序,优先按权重排序。", - "description": "查询当前仓库范围的快递接口列表,支持 where + pagination;返回 data:{ list, total, page, page_size }。按 weight 升序、id 降序排序,优先按权重排序。", - "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": "pagination" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "支持按 shop_id 过滤" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "list,按 weight 升序、id 降序排序;优先按权重排序,权重相同再按 id 倒序" - }, - { - "name": "total", - "type": "number", - "required": true, - "description": "total" - }, - { - "name": "page", - "type": "number", - "required": true, - "description": "page" - }, - { - "name": "page_size", - "type": "number", - "required": true, - "description": "page_size" - } - ] - }, - { - "moduleName": "快递接口管理模块", - "moduleKey": "setting.expressInterface", - "moduleFolder": "setting.expressinterface", - "method": "setting.expressInterface.listByWarehousePlatformCode", - "title": "按 warehouse_id + platform_code 查询快递接口全字段数组,支持缓存;返回结果按 weight 升序、必要时按 id 升序排序,每条记录显式包含 express_code 以及关联的 express 对象(如 express.id/express.code/express.name/express.platform)。该接口不分页,按 warehouse_id + platform_code 全量返回匹配记录。", - "description": "按 warehouse_id + platform_code 查询快递接口全字段数组,支持缓存;返回结果按 weight 升序、必要时按 id 升序排序,每条记录显式包含 express_code 以及关联的 express 对象(如 express.id/express.code/express.name/express.platform)。该接口不分页,按 warehouse_id + platform_code 全量返回匹配记录。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id / warehouseId", - "type": "number", - "required": false, - "description": "仓库ID;默认使用当前登录主体/仓库上下文(ctx.user.store_id),也支持显式传入以查询指定仓库,文档兼容 warehouse_id 与 warehouseId 两种写法。" - }, - { - "name": "platform_code / platformCode", - "type": "string", - "required": true, - "description": "平台代码;作为缓存键的一部分,建议使用大写形式(服务端会标准化处理)。" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "快递接口记录数组(按 warehouse_id + platform_code 全量返回,不分页),每项包含以下字段:" - } - ] - }, - { - "moduleName": "快递接口管理模块", - "moduleKey": "setting.expressInterface", - "moduleFolder": "setting.expressinterface", - "method": "setting.expressInterface.update", - "title": "更新快递接口,支持 shop_id/shopId 入参(可空)。", - "description": "更新快递接口,支持 shop_id/shopId 入参(可空)。", - "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": "number", - "required": true, - "description": "id" - }, - { - "name": "shop_id", - "type": "number", - "required": false, - "description": "shop_id" - }, - { - "name": "address", - "type": "string", - "required": false, - "description": "发件人详细地址(可选),使用 index.getShopExpressList 返回的 detail 字段值,非 full_address" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "id" - } - ] - }, - { - "moduleName": "包材管理模块", - "moduleKey": "setting.packageMaterial", - "moduleFolder": "setting.packagematerial", - "method": "setting.packageMaterial.create", - "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": "material_code", - "type": "string", - "required": true, - "description": "包材编码(大写且在当前仓库唯一)" - }, - { - "name": "material_name", - "type": "string", - "required": true, - "description": "包材名称" - }, - { - "name": "material_type", - "type": "string", - "required": false, - "description": "包材类型" - }, - { - "name": "spec", - "type": "string", - "required": false, - "description": "规格" - }, - { - "name": "length", - "type": "number", - "required": false, - "description": "长度" - }, - { - "name": "width", - "type": "number", - "required": false, - "description": "宽度" - }, - { - "name": "height", - "type": "number", - "required": false, - "description": "高度" - }, - { - "name": "weight", - "type": "number", - "required": false, - "description": "重量" - }, - { - "name": "cost_price", - "type": "number", - "required": false, - "description": "成本价" - }, - { - "name": "status", - "type": "number", - "required": false, - "description": "状态 0/1,默认 1" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "包材 ID" - } - ] - }, - { - "moduleName": "包材管理模块", - "moduleKey": "setting.packageMaterial", - "moduleFolder": "setting.packagematerial", - "method": "setting.packageMaterial.delete", - "title": "删除包材(支持 ids 数组或逗号分隔字符串,兼容 id/material_id/materialId)", - "description": "删除包材(支持 ids 数组或逗号分隔字符串,兼容 id/material_id/materialId)", - "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|number|string", - "required": true, - "description": "要删除的 ID 列表" - } - ], - "response": [ - { - "name": "deleted", - "type": "boolean", - "required": true, - "description": "是否删除成功" - } - ] - }, - { - "moduleName": "包材管理模块", - "moduleKey": "setting.packageMaterial", - "moduleFolder": "setting.packagematerial", - "method": "setting.packageMaterial.get", - "title": "查询包材列表,支持 where + pagination(兼容旧别名 list,建议使用 get)", - "description": "查询包材列表,支持 where + pagination(兼容旧别名 list,建议使用 get)", - "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": "筛选条件,支持 material_code/material_name/material_type/status/quickWhere" - } - ], - "response": [ - { - "name": "page", - "type": "number", - "required": true, - "description": "当前页" - }, - { - "name": "page_size", - "type": "number", - "required": true, - "description": "每页大小" - }, - { - "name": "total", - "type": "number", - "required": true, - "description": "总数" - }, - { - "name": "list", - "type": "array", - "required": true, - "description": "包材项数组" - } - ] - }, - { - "moduleName": "包材管理模块", - "moduleKey": "setting.packageMaterial", - "moduleFolder": "setting.packagematerial", - "method": "setting.packageMaterial.list", - "title": "兼容旧称 list,内部转发至 get;建议改用 setting.packageMaterial.get", - "description": "兼容旧称 list,内部转发至 get;建议改用 setting.packageMaterial.get", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "包材管理模块", - "moduleKey": "setting.packageMaterial", - "moduleFolder": "setting.packagematerial", - "method": "setting.packageMaterial.search", - "title": "包材关键字搜索,按 material_code / material_name 模糊匹配,最多返回 50 条(仅返回启用中的包材)", - "description": "包材关键字搜索,按 material_code / material_name 模糊匹配,最多返回 50 条(仅返回启用中的包材)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "keyword", - "type": "string", - "required": false, - "description": "搜索关键字,模糊匹配 material_code、material_name;为空时返回前 50 条启用中的包材" - } - ], - "response": [ - { - "name": "data[]", - "type": "array", - "required": true, - "description": "包材列表,每项包含 id(包材ID)、material_code(包材编码)、material_name(包材名称)、material_type(包材类型)、spec(规格)、status(状态)" - } - ] - }, - { - "moduleName": "包材管理模块", - "moduleKey": "setting.packageMaterial", - "moduleFolder": "setting.packagematerial", - "method": "setting.packageMaterial.update", - "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": "number", - "required": true, - "description": "包材 ID(也兼容 material_id/materialId)" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "包材 ID" - } - ] - }, - { - "moduleName": "package-supplier-module", - "moduleKey": "setting.packageSupplier", - "moduleFolder": "setting.packagesupplier", - "method": "setting.packageSupplier.create", - "title": "Create package supplier (current warehouse scope)", - "description": "Create package supplier (current warehouse scope)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "supplier_code", - "type": "string", - "required": true, - "description": "Supplier code (uppercased, unique in warehouse)" - }, - { - "name": "supplier_name", - "type": "string", - "required": true, - "description": "Supplier name" - }, - { - "name": "contact_name", - "type": "string", - "required": false, - "description": "Contact name" - }, - { - "name": "contact_phone", - "type": "string", - "required": false, - "description": "Contact phone" - }, - { - "name": "status", - "type": "number", - "required": false, - "description": "Status 0/1, default 1" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "Created supplier id" - } - ] - }, - { - "moduleName": "package-supplier-module", - "moduleKey": "setting.packageSupplier", - "moduleFolder": "setting.packagesupplier", - "method": "setting.packageSupplier.delete", - "title": "Delete package suppliers (supports ids array or comma-separated string)", - "description": "Delete package suppliers (supports ids array or comma-separated string)", - "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|number|string", - "required": true, - "description": "IDs to delete" - } - ], - "response": [ - { - "name": "deleted", - "type": "boolean", - "required": true, - "description": "Deleted flag" - } - ] - }, - { - "moduleName": "package-supplier-module", - "moduleKey": "setting.packageSupplier", - "moduleFolder": "setting.packagesupplier", - "method": "setting.packageSupplier.get", - "title": "Get package supplier list (supports where + pagination). list is an alias to get; prefer get.", - "description": "Get package supplier list (supports where + pagination). list is an alias to get; prefer get.", - "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": "Pagination parameters" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "Filter conditions" - } - ], - "response": [ - { - "name": "page", - "type": "number", - "required": true, - "description": "Current page" - }, - { - "name": "page_size", - "type": "number", - "required": true, - "description": "Page size" - }, - { - "name": "total", - "type": "number", - "required": true, - "description": "Total" - }, - { - "name": "list", - "type": "array", - "required": true, - "description": "Supplier array" - } - ] - }, - { - "moduleName": "package-supplier-module", - "moduleKey": "setting.packageSupplier", - "moduleFolder": "setting.packagesupplier", - "method": "setting.packageSupplier.list", - "title": "Compatibility alias for get; internally forwards to get. Prefer setting.packageSupplier.get.", - "description": "Compatibility alias for get; internally forwards to get. Prefer setting.packageSupplier.get.", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "package-supplier-module", - "moduleKey": "setting.packageSupplier", - "moduleFolder": "setting.packagesupplier", - "method": "setting.packageSupplier.update", - "title": "Update package supplier by id (partial update supported)", - "description": "Update package supplier by id (partial update supported)", - "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": "number", - "required": true, - "description": "Supplier id (also supports supplier_id / supplierId)" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "Supplier id" - } - ] - }, - { - "moduleName": "权限管理模块", - "moduleKey": "setting.permission", - "moduleFolder": "setting.permission", - "method": "setting.permission.add", - "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": "path", - "type": "string", - "required": true, - "description": "权限路径" - }, - { - "name": "type", - "type": "string", - "required": true, - "description": "权限类型" - }, - { - "name": "name", - "type": "string", - "required": false, - "description": "权限名称" - }, - { - "name": "parent_id", - "type": "number", - "required": false, - "description": "父级权限ID" - } - ], - "response": [] - }, - { - "moduleName": "权限管理模块", - "moduleKey": "setting.permission", - "moduleFolder": "setting.permission", - "method": "setting.permission.delete", - "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数组" - } - ], - "response": [] - }, - { - "moduleName": "权限管理模块", - "moduleKey": "setting.permission", - "moduleFolder": "setting.permission", - "method": "setting.permission.list", - "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": "role_id", - "type": "number", - "required": false, - "description": "角色ID;传入后返回 selected 标记" - }, - { - "name": "type", - "type": "string", - "required": false, - "description": "权限类型筛选:web_pages/pda_pages/btns/api/miniprogram_pages/block" - }, - { - "name": "keyword", - "type": "string", - "required": false, - "description": "关键字模糊搜索 path/name/meta_title" - }, - { - "name": "includeDisabled", - "type": "boolean", - "required": false, - "description": "是否包含已停用权限" - } - ], - "response": [] - }, - { - "moduleName": "权限管理模块", - "moduleKey": "setting.permission", - "moduleFolder": "setting.permission", - "method": "setting.permission.update", - "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": "permission_id", - "type": "number", - "required": true, - "description": "权限ID" - } - ], - "response": [] - }, - { - "moduleName": "平台编码管理模块", - "moduleKey": "setting.platform", - "moduleFolder": "setting.platform", - "method": "setting.platform.create", - "title": "创建当前仓库范围的平台设置", - "description": "创建当前仓库范围的平台设置", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "平台编码管理模块", - "moduleKey": "setting.platform", - "moduleFolder": "setting.platform", - "method": "setting.platform.delete", - "title": "删除当前仓库范围的平台设置", - "description": "删除当前仓库范围的平台设置", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "平台编码管理模块", - "moduleKey": "setting.platform", - "moduleFolder": "setting.platform", - "method": "setting.platform.list", - "title": "查询当前仓库范围的平台设置列表", - "description": "查询当前仓库范围的平台设置列表", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "平台编码管理模块", - "moduleKey": "setting.platform", - "moduleFolder": "setting.platform", - "method": "setting.platform.update", - "title": "更新当前仓库范围的平台设置", - "description": "更新当前仓库范围的平台设置", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "打印模板模块", - "moduleKey": "setting.printTemplate", - "moduleFolder": "setting.printtemplate", - "method": "setting.printTemplate.create", - "title": "创建打印模板(platform 固定为 default,template_type 固定为 CUSTOM,template_url 固定为空字符串)", - "description": "创建打印模板(platform 固定为 default,template_type 固定为 CUSTOM,template_url 固定为空字符串)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "template_name", - "type": "string", - "required": true, - "description": "模板名称" - }, - { - "name": "business_type", - "type": "string", - "required": true, - "description": "业务类型" - }, - { - "name": "page_width", - "type": "number", - "required": true, - "description": "页面宽度(mm)" - }, - { - "name": "page_height", - "type": "number", - "required": true, - "description": "页面高度(mm)" - }, - { - "name": "template_content", - "type": "array", - "required": false, - "description": "模板内容,可省略;省略时默认创建空模板内容" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "新建模板ID" - } - ] - }, - { - "moduleName": "打印模板模块", - "moduleKey": "setting.printTemplate", - "moduleFolder": "setting.printtemplate", - "method": "setting.printTemplate.delete", - "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": "id", - "type": "number", - "required": true, - "description": "模板ID" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "删除的模板ID" - } - ] - }, - { - "moduleName": "打印模板模块", - "moduleKey": "setting.printTemplate", - "moduleFolder": "setting.printtemplate", - "method": "setting.printTemplate.list", - "title": "获取打印模板树", - "description": "获取打印模板树", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "打印模板模块", - "moduleKey": "setting.printTemplate", - "moduleFolder": "setting.printtemplate", - "method": "setting.printTemplate.listTemplatesByType", - "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": "businessType", - "type": "string", - "required": true, - "description": "businessType 参数" - } - ], - "response": [] - }, - { - "moduleName": "打印模板模块", - "moduleKey": "setting.printTemplate", - "moduleFolder": "setting.printtemplate", - "method": "setting.printTemplate.save", - "title": "保存打印模板", - "description": "保存打印模板", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "角色管理模块", - "moduleKey": "setting.role", - "moduleFolder": "setting.role", - "method": "setting.role.add", - "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": "role_code", - "type": "string", - "required": true, - "description": "角色编码" - }, - { - "name": "role_name", - "type": "string", - "required": true, - "description": "角色名称" - }, - { - "name": "permission_ids", - "type": "array", - "required": true, - "description": "权限ID数组,支持 [\"*\"]" - }, - { - "name": "pid", - "type": "number", - "required": false, - "description": "父角色ID" - } - ], - "response": [] - }, - { - "moduleName": "角色管理模块", - "moduleKey": "setting.role", - "moduleFolder": "setting.role", - "method": "setting.role.delete", - "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数组" - } - ], - "response": [] - }, - { - "moduleName": "角色管理模块", - "moduleKey": "setting.role", - "moduleFolder": "setting.role", - "method": "setting.role.list", - "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": "includeDisabled", - "type": "boolean", - "required": false, - "description": "是否包含已停用角色" - }, - { - "name": "includeSystem", - "type": "boolean", - "required": false, - "description": "是否包含系统角色域" - } - ], - "response": [] - }, - { - "moduleName": "角色管理模块", - "moduleKey": "setting.role", - "moduleFolder": "setting.role", - "method": "setting.role.permission", - "title": "获取角色权限树(兼容旧入口,等同于 setting.permission.list)", - "description": "获取角色权限树(兼容旧入口,等同于 setting.permission.list)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "role_id", - "type": "number", - "required": false, - "description": "角色ID" - } - ], - "response": [] - }, - { - "moduleName": "角色管理模块", - "moduleKey": "setting.role", - "moduleFolder": "setting.role", - "method": "setting.role.update", - "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": "role_id", - "type": "number", - "required": true, - "description": "角色ID" - }, - { - "name": "permission_ids", - "type": "array", - "required": true, - "description": "权限ID数组,角色权限需一次性提交" - } - ], - "response": [] - }, - { - "moduleName": "仓库设置模块", - "moduleKey": "setting.warehouse", - "moduleFolder": "setting.warehouse", - "method": "setting.warehouse.getFieldMeta", - "title": "获取仓库设置字段元信息", - "description": "获取仓库设置字段元信息", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [ - { - "name": "list", - "type": "array", - "required": false, - "description": "字段元信息数组" - } - ] - }, - { - "moduleName": "仓库设置模块", - "moduleKey": "setting.warehouse", - "moduleFolder": "setting.warehouse", - "method": "setting.warehouse.getSettings", - "title": "获取当前登录仓库的 subject_config", - "description": "获取当前登录仓库的 subject_config", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库 ID" - }, - { - "name": "subject_config", - "type": "object", - "required": true, - "description": "仓库的 subject_config 配置对象" - }, - { - "name": "subject_config.enable_external_express_code", - "type": "boolean", - "required": true, - "description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)" - }, - { - "name": "subject_config.auto_outbound_rules", - "type": "object", - "required": true, - "description": "自动出库规则配置。全部条件满足时自动标记待出库" - }, - { - "name": "subject_config.auto_outbound_rules.enabled", - "type": "boolean", - "required": true, - "description": "是否启用自动出库,默认 false" - }, - { - "name": "subject_config.auto_outbound_rules.require_recheck", - "type": "boolean", - "required": true, - "description": "是否要求已复核(recheck_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_pack", - "type": "boolean", - "required": true, - "description": "是否要求已打包(pack_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_weigh", - "type": "boolean", - "required": true, - "description": "是否要求已称重(weighing_weight>0),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_sync", - "type": "boolean", - "required": true, - "description": "是否要求已同步(sync_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_print", - "type": "boolean", - "required": true, - "description": "是否要求已打印(print_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_pick", - "type": "boolean", - "required": true, - "description": "是否要求已拣货(pick_status=fin),默认 true" - } - ] - }, - { - "moduleName": "仓库设置模块", - "moduleKey": "setting.warehouse", - "moduleFolder": "setting.warehouse", - "method": "setting.warehouse.saveSettings", - "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": "subject_config", - "type": "object", - "required": true, - "description": "仓库的 subject_config 对象" - }, - { - "name": "cache_warehouse_id", - "type": "number", - "required": false, - "description": "需清理缓存的仓库 ID(下划线命名兼容)" - }, - { - "name": "cacheWarehouseId", - "type": "number", - "required": false, - "description": "需清理缓存的仓库 ID(驼峰命名兼容)" - }, - { - "name": "subject_config.enable_external_express_code", - "type": "boolean", - "required": false, - "description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)" - }, - { - "name": "subject_config.auto_outbound_rules", - "type": "object", - "required": false, - "description": "自动出库规则配置。全部条件满足时自动标记待出库" - }, - { - "name": "subject_config.auto_outbound_rules.enabled", - "type": "boolean", - "required": false, - "description": "是否启用自动出库,默认 false" - }, - { - "name": "subject_config.auto_outbound_rules.require_recheck", - "type": "boolean", - "required": false, - "description": "是否要求已复核(recheck_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_pack", - "type": "boolean", - "required": false, - "description": "是否要求已打包(pack_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_weigh", - "type": "boolean", - "required": false, - "description": "是否要求已称重(weighing_weight>0),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_sync", - "type": "boolean", - "required": false, - "description": "是否要求已同步(sync_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_print", - "type": "boolean", - "required": false, - "description": "是否要求已打印(print_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_pick", - "type": "boolean", - "required": false, - "description": "是否要求已拣货(pick_status=fin),默认 true" - } - ], - "response": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "生效的仓库 ID" - }, - { - "name": "subject_config", - "type": "object", - "required": true, - "description": "保存后的 subject_config" - }, - { - "name": "cache_cleared_warehouse_id", - "type": "number", - "required": true, - "description": "被清理缓存的仓库 ID(若未清理则为 null)" - }, - { - "name": "subject_config.enable_external_express_code", - "type": "boolean", - "required": true, - "description": "保存后的 subject_config.enable_external_express_code 值" - } - ] - }, - { - "moduleName": "店铺模块", - "moduleKey": "shops", - "moduleFolder": "shops", - "method": "shops.add", - "title": "新增店铺,校验 platform_code 必须匹配已配置且处于 ACTIVE 且未删除的打印平台;custom_name 必填且长度<=100。shop_name 由服务端生成待授权占位名(PENDING_*),授权后再同步真实店铺名。支持 snake_case 与 camelCase 入参兼容。", - "description": "新增店铺,校验 platform_code 必须匹配已配置且处于 ACTIVE 且未删除的打印平台;custom_name 必填且长度<=100。shop_name 由服务端生成待授权占位名(PENDING_*),授权后再同步真实店铺名。支持 snake_case 与 camelCase 入参兼容。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "platform_code", - "type": "string", - "required": true, - "description": "平台编码,兼容 platformCode,服务端会标准化为大写并验证" - }, - { - "name": "custom_name", - "type": "string", - "required": true, - "description": "店铺自定义名称,最大长度 100" - } - ], - "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.id", - "type": "number", - "required": true, - "description": "新建店铺 ID" - } - ] - }, - { - "moduleName": "店铺模块", - "moduleKey": "shops", - "moduleFolder": "shops", - "method": "shops.del", - "title": "软删除店铺:将 shop_name 修改为 DELETED_SHOP__ 并清空敏感字段;若存在 ExpressInterface 引用则返回 409;返回 deleted=true 与 id。", - "description": "软删除店铺:将 shop_name 修改为 DELETED_SHOP__ 并清空敏感字段;若存在 ExpressInterface 引用则返回 409;返回 deleted=true 与 id。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "店铺 ID,兼容 shop_id/shopId" - } - ], - "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.deleted", - "type": "boolean", - "required": true, - "description": "是否已删除" - }, - { - "name": "data.id", - "type": "number", - "required": true, - "description": "删除的店铺 ID" - } - ] - }, - { - "moduleName": "店铺模块", - "moduleKey": "shops", - "moduleFolder": "shops", - "method": "shops.edit", - "title": "编辑店铺,仅允许修改 platform_code 或 custom_name;至少传入其中一个。platform_code 会校验平台存在且为 ACTIVE;custom_name 必填且长度<=100;服务端兼容 snake_case/camelCase。", - "description": "编辑店铺,仅允许修改 platform_code 或 custom_name;至少传入其中一个。platform_code 会校验平台存在且为 ACTIVE;custom_name 必填且长度<=100;服务端兼容 snake_case/camelCase。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "店铺 ID,兼容 shop_id/shopId" - }, - { - "name": "platform_code", - "type": "string", - "required": false, - "description": "平台编码,兼容 platformCode,服务端会转为大写并校验" - }, - { - "name": "custom_name", - "type": "string", - "required": false, - "description": "自定义名称,兼容 customName,若传入需非空且 <=100 字符" - } - ], - "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.updated", - "type": "boolean", - "required": true, - "description": "是否已更新" - }, - { - "name": "data.id", - "type": "number", - "required": true, - "description": "被更新的店铺 ID" - } - ] - }, - { - "moduleName": "店铺模块", - "moduleKey": "shops", - "moduleFolder": "shops", - "method": "shops.GetAuthorizeSessionKey", - "title": "按店铺所属平台生成授权会话。入参兼容 id/shop_id/shopId 与 callbackurl/callback_url,callbackurl 必填。对已实现的平台(PDD/CAINIAO)返回 session_key/authorize_url/state,其他平台返回 501 未实现。", - "description": "按店铺所属平台生成授权会话。入参兼容 id/shop_id/shopId 与 callbackurl/callback_url,callbackurl 必填。对已实现的平台(PDD/CAINIAO)返回 session_key/authorize_url/state,其他平台返回 501 未实现。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "店铺 ID,兼容 shop_id/shopId" - }, - { - "name": "callbackurl", - "type": "string", - "required": true, - "description": "回调地址,兼容 callback_url" - } - ], - "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.shop_id", - "type": "number", - "required": true, - "description": "店铺 ID" - }, - { - "name": "data.platform_code", - "type": "string", - "required": true, - "description": "平台编码(大写)" - }, - { - "name": "data.callbackurl", - "type": "string", - "required": true, - "description": "回调地址" - }, - { - "name": "data.session_key", - "type": "string", - "required": true, - "description": "授权预占码(session)" - }, - { - "name": "data.authorize_url", - "type": "string", - "required": true, - "description": "平台授权跳转地址(含 state)" - }, - { - "name": "data.state", - "type": "string", - "required": true, - "description": "内部 state 值(platform + '_' + authRandomCode),用于回调解析" - } - ] - }, - { - "moduleName": "店铺模块", - "moduleKey": "shops", - "moduleFolder": "shops", - "method": "shops.list", - "title": "分页查询店铺,支持 where 条件(支持字段:id, platform_code, custom_name, shop_name, status, quickWhere),兼容 snake_case 与 camelCase 入参;返回分页信息与标准化店铺列表。", - "description": "分页查询店铺,支持 where 条件(支持字段:id, platform_code, custom_name, shop_name, status, quickWhere),兼容 snake_case 与 camelCase 入参;返回分页信息与标准化店铺列表。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "page", - "type": "number", - "required": false, - "description": "页码,兼容 pagination.page/currentPage" - }, - { - "name": "pageSize", - "type": "number", - "required": false, - "description": "每页大小,兼容 page_size/pagination.page_size,最大 200" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "查询条件,支持标准 where 结构或 quickWhere 简写,字段兼容 id/platform_code/custom_name/shop_name/status/quickWhere" - } - ], - "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.list", - "type": "array", - "required": true, - "description": "店铺数组,元素结构见 children" - }, - { - "name": "data.pagination", - "type": "object", - "required": true, - "description": "分页信息" - } - ] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.bindItem", - "title": "绑定货主商品关系", - "description": "绑定货主商品关系", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.checkItemCodeUnique", - "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": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID;默认使用当前登录主体/仓库上下文(ctx.user.store_id)" - }, - { - "name": "item_code", - "type": "string", - "required": true, - "description": "要检测的商品编码" - }, - { - "name": "item_id", - "type": "number", - "required": false, - "description": "当前商品ID(编辑场景用,排除自身);兼容字段名 id" - }, - { - "name": "id", - "type": "number", - "required": false, - "description": "兼容字段 id" - }, - { - "name": "owner_id", - "type": "number", - "required": true, - "description": "货主ID(对应表字段 store_id);兼容字段名 store_id" - }, - { - "name": "store_id", - "type": "number", - "required": true, - "description": "兼容字段 store_id" - } - ], - "response": [ - { - "name": "unique", - "type": "boolean", - "required": false, - "description": "true 表示编码唯一,false 表示已存在重复" - }, - { - "name": "isUnique", - "type": "boolean", - "required": false, - "description": "同 unique(兼容旧字段名)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "重复时返回 '商品编码已存在',唯一时不返回该字段" - } - ] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.createProhibited", - "title": "新增违禁品类型", - "description": "新增违禁品类型", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "name", - "type": "string", - "required": true, - "description": "name 参数" - } - ], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.createUnit", - "title": "新增库存单位", - "description": "新增库存单位", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "name", - "type": "string", - "required": true, - "description": "name 参数" - } - ], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.createWarehouseStock", - "title": "新建仓库商品资料", - "description": "新建仓库商品资料", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.deleteProhibited", - "title": "删除违禁品类型", - "description": "删除违禁品类型", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.deleteUnit", - "title": "删除库存单位", - "description": "删除库存单位", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.export", - "title": "提交导出任务,返回 task_id/status/progress/message/result/error/update_time", - "description": "提交导出任务,返回 task_id/status/progress/message/result/error/update_time", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "where", - "type": "object", - "required": false, - "description": "查询条件对象,与 stock.warehouse.list 的 where 语义一致;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化。" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数对象,支持 sortField/sortOrder 与 sort_field/sort_order 下划线别名兼容。" - }, - { - "name": "sort.sortField", - "type": "string", - "required": false, - "description": "排序字段(兼容 sort.sortField)。" - }, - { - "name": "sort.sort_field", - "type": "string", - "required": false, - "description": "排序字段下划线别名(兼容 sort.sort_field)。" - }, - { - "name": "sort.sortOrder", - "type": "string", - "required": false, - "description": "排序方向(ASC/DESC,大小写不敏感)。" - }, - { - "name": "sort.sort_order", - "type": "string", - "required": false, - "description": "排序方向下划线别名(兼容 sort.sort_order)。" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": false, - "description": "任务 ID(后端生成的唯一标识)" - }, - { - "name": "status", - "type": "string", - "required": false, - "description": "任务状态,枚举:submitted/running/success/failed/not_found" - }, - { - "name": "progress", - "type": "number", - "required": false, - "description": "进度百分比(0-100)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "额外提示信息或受理消息" - }, - { - "name": "result", - "type": "object", - "required": false, - "description": "任务成功时返回的结果对象(可选)" - }, - { - "name": "error", - "type": "string", - "required": false, - "description": "失败时的错误信息(可选)" - }, - { - "name": "update_time", - "type": "string", - "required": false, - "description": "最近一次状态更新时间,ISO8601 字符串(可选)" - } - ] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.exportTaskProgress", - "title": "按 task_id 查询导出任务进度,未找到时 status=not_found", - "description": "按 task_id 查询导出任务进度,未找到时 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": false, - "description": "任务 ID" - }, - { - "name": "status", - "type": "string", - "required": false, - "description": "任务状态:submitted/running/success/failed/not_found" - }, - { - "name": "progress", - "type": "number", - "required": false, - "description": "进度百分比(0-100)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "额外提示信息" - }, - { - "name": "result", - "type": "object", - "required": false, - "description": "任务成功时返回的结果对象(可选)" - }, - { - "name": "error", - "type": "string", - "required": false, - "description": "失败时的错误信息(可选)" - }, - { - "name": "download_url", - "type": "string", - "required": false, - "description": "任务完成后可直接下载的文件地址(若有)" - }, - { - "name": "update_time", - "type": "string", - "required": false, - "description": "最近一次状态更新时间,ISO8601 字符串(可选)" - } - ] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.getBarcodes", - "title": "查询商品条码列表", - "description": "查询商品条码列表", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.getInfo", - "title": "查询仓库商品详情", - "description": "查询仓库商品详情", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.getProhibitedType", - "title": "查询违禁品类型列表(系统预设+仓库自定义)", - "description": "查询违禁品类型列表(系统预设+仓库自定义)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.getStockDetail", - "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": "stock_id", - "type": "number", - "required": true, - "description": "商品库存ID(stock_warehouse.id)" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数,包含 page/pageSize" - }, - { - "name": "group_by_batch", - "type": "boolean", - "required": false, - "description": "是否按批次返回明细;true 返回每条明细,false 按库位合并" - } - ], - "response": [ - { - "name": "stockItem", - "type": "object", - "required": false, - "description": "商品概要,包含 id、item_code、item_name、sku_property、stock_unit、quantity、locked_quantity 等" - }, - { - "name": "storageList", - "type": "array", - "required": false, - "description": "库存明细数组;group_by_batch=true 返回 wms_storage 明细(含 batch_no、production_date、expiry_date、inbound_time、inbound_order_no、supplier_batch_no 等),group_by_batch=false 时按库位合并,批次相关字段为 null" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页信息,包含 page、pageSize、total" - } - ] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.getStockUnits", - "title": "查询可用库存单位(系统+仓库)", - "description": "查询可用库存单位(系统+仓库)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.getStoreStocks", - "title": "查询仓库商品与货主关联列表", - "description": "查询仓库商品与货主关联列表", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.getUnitList", - "title": "查询当前仓库自定义单位列表", - "description": "查询当前仓库自定义单位列表", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.handleBatchChange", - "title": "批量修改仓库商品字段", - "description": "批量修改仓库商品字段", - "endpoint": "/system", - "authRequired": true, - "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 数组(stock_warehouse.id)" - }, - { - "name": "method", - "type": "string", - "required": true, - "description": "要修改的字段名,可选值:brand_name、prohibited_id、gross_weight、packing_requirements、managementFlags、stock_unit" - }, - { - "name": "value", - "type": "string|number|object", - "required": true, - "description": "修改值,类型依 method 而定:brand_name/packing_requirements/stock_unit 为 string(<=255 字符);prohibited_id 为 number(整数);gross_weight 为 number(正数,可含小数);managementFlags 为 object,必须包含 is_sn_mgmt/is_shelf_life_mgmt/is_batch_mgmt,值为 'Y' 或 'N'" - }, - { - "name": "values", - "type": "any", - "required": false, - "description": "兼容字段:当前实现以 `value` 为准,不使用 `values`。若客户端历史使用 `values`,请切换为 `value`。" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": false, - "description": "业务状态码,200 表示成功;405 表示参数/权限校验不通过;500 表示服务器错误" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "业务提示信息" - }, - { - "name": "data", - "type": "object", - "required": false, - "description": "成功时返回的结果对象" - } - ] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.handleBatchDelete", - "title": "批量删除仓库商品资料", - "description": "批量删除仓库商品资料", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.import", - "title": "批量导入或更新仓库商品。请求体优先直接传入商品数据数组 JSON(主方式为数组);也兼容以 rows/items/list/data 包装。每项仅需包含商品相关字段;当 SKU 为空时创建新商品,SKU 非空时为更新操作;更新会写操作日志以便审计。未传 store_id 时默认使用当前上下文仓库/主体(ctx.user.store_id)。支持导入条码(barcode),新建和更新均生效,条码写入 wms_stock_barcodes 表。", - "description": "批量导入或更新仓库商品。请求体优先直接传入商品数据数组 JSON(主方式为数组);也兼容以 rows/items/list/data 包装。每项仅需包含商品相关字段;当 SKU 为空时创建新商品,SKU 非空时为更新操作;更新会写操作日志以便审计。未传 store_id 时默认使用当前上下文仓库/主体(ctx.user.store_id)。支持导入条码(barcode),新建和更新均生效,条码写入 wms_stock_barcodes 表。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "items / rows / list / data", - "type": "array", - "required": true, - "description": "商品数组(主方式为直接传数组 []),也兼容对象包装:{ rows: [...] } / { items: [...] } / { list: [...] } / { data: [...] }。每项可使用下列字段别名:" - } - ], - "response": [ - { - "name": "total_count", - "type": "number", - "required": true, - "description": "解析到的总条目数" - }, - { - "name": "created_count", - "type": "number", - "required": true, - "description": "成功创建的新商品数" - }, - { - "name": "updated_count", - "type": "number", - "required": true, - "description": "成功更新的商品数" - }, - { - "name": "fail_count", - "type": "number", - "required": true, - "description": "导入失败数" - }, - { - "name": "created_ids", - "type": "array", - "required": true, - "description": "创建成功的商品 ID 列表" - }, - { - "name": "updated_ids", - "type": "array", - "required": true, - "description": "更新成功的商品 ID 列表" - }, - { - "name": "fail_items", - "type": "array", - "required": true, - "description": "失败项明细数组,每项包含原始输入与错误信息" - } - ] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.list", - "title": "仓库商品列表查询(支持 where 条件与分页)", - "description": "仓库商品列表查询(支持 where 条件与分页)", - "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": "pagination 参数" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、barcode、prohibited_type、has_bound_item 等商品筛选字段。示例:where.barcode={operator:like,value:69}; where.prohibited_type={operator:eq,value:liquid}; where.has_bound_item={operator:eq,value:true}(已绑定外部商品)/ where.has_bound_item={operator:eq,value:false}(未绑定外部商品)。" - } - ], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.queryStockLogs", - "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": "warehouseId", - "type": "string", - "required": false, - "description": "warehouseId 参数" - } - ], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.saveWarehouseStock", - "title": "更新仓库商品资料", - "description": "更新仓库商品资料", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.saveWarehouseStockBarcode", - "title": "保存商品条码信息", - "description": "保存商品条码信息", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.search", - "title": "仓库商品关键字搜索,按 item_code / item_name / goods_code / 条形码模糊匹配,最多返回 50 条", - "description": "仓库商品关键字搜索,按 item_code / item_name / goods_code / 条形码模糊匹配,最多返回 50 条", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "keyword", - "type": "string", - "required": false, - "description": "搜索关键字,模糊匹配 item_code、item_name、goods_code 以及关联的 barcode;为空时返回全部(仍受 limit 50 限制)" - }, - { - "name": "store_id", - "type": "number", - "required": false, - "description": "货主ID,传入时仅返回指定货主的商品" - }, - { - "name": "with_stock", - "type": "boolean", - "required": false, - "description": "是否返回关联库存数据(wms_storage),为 true 时每条商品新增 storage[] 字段" - }, - { - "name": "is_batch", - "type": "boolean", - "required": false, - "description": "是否按批次明细返回库存,仅 with_stock=true 时生效。false(默认)按库位分组汇总;true 逐条返回批次明细" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": false, - "description": "业务状态码,200 表示成功" - }, - { - "name": "data", - "type": "array", - "required": false, - "description": "商品列表,每项包含以下字段" - }, - { - "name": "total", - "type": "number", - "required": false, - "description": "本次返回的记录条数(≤50)" - } - ] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "moduleFolder": "stock", - "method": "stock.warehouse.unbindItem", - "title": "解绑货主商品关系", - "description": "解绑货主商品关系", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "moduleFolder": "storage.entry", - "method": "storage.entry.bindReceivingDetails", - "title": "入库单明细绑定收货明细。将指定的收货单明细与入库单明细建立绑定关系,并立即更新入库明细的 received_quantity(绑定即实收)。重复调用会先回退旧绑定量再创建新绑定。提交入库时完成收货单侧的入库数量扣减和库存上架。", - "description": "入库单明细绑定收货明细。将指定的收货单明细与入库单明细建立绑定关系,并立即更新入库明细的 received_quantity(绑定即实收)。重复调用会先回退旧绑定量再创建新绑定。提交入库时完成收货单侧的入库数量扣减和库存上架。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "entry_item_id", - "type": "number", - "required": true, - "description": "入库单明细ID(wms_entry_items.id)" - }, - { - "name": "bindings", - "type": "array", - "required": true, - "description": "收货明细绑定数组,每项包含 receiving_detail_id(收货明细ID, number, 必填)和 allocated_quantity(分配数量, number, 必填, 正整数)" - } - ], - "response": [ - { - "name": "entry_item_id", - "type": "number", - "required": true, - "description": "入库明细ID" - }, - { - "name": "binding_count", - "type": "number", - "required": true, - "description": "创建的绑定数量" - } - ] - }, - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "moduleFolder": "storage.entry", - "method": "storage.entry.cancel", - "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": "id", - "type": "number", - "required": false, - "description": "入库单ID,兼容旧调用;与 `ids` 二选一。若同时传入 `ids`,以 `ids` 为准。" - }, - { - "name": "ids", - "type": "array", - "required": false, - "description": "入库单ID数组(number[]),用于批量作废;必须为非空数组,建议批量操作使用 `ids`,优先于 `id`。" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": false, - "description": "单条作废时返回的入库单ID" - }, - { - "name": "ids", - "type": "array", - "required": false, - "description": "批量作废时返回的已成功作废入库单ID数组(number[])" - } - ] - }, - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "moduleFolder": "storage.entry", - "method": "storage.entry.completeEntry", - "title": "完成入库单。入库单状态变更为 COMPLETED 后,异步触发收货单匹配与回传:系统会从入库单 remark 中匹配近 3 天收货单号,明细一致则按来源回传(奇门→奇门确认接口,API→OpenAPI 回调);若收货单覆盖入库单,还会标记收货单为部分入库。异步匹配失败不阻塞主流程,仅记录日志。", - "description": "完成入库单。入库单状态变更为 COMPLETED 后,异步触发收货单匹配与回传:系统会从入库单 remark 中匹配近 3 天收货单号,明细一致则按来源回传(奇门→奇门确认接口,API→OpenAPI 回调);若收货单覆盖入库单,还会标记收货单为部分入库。异步匹配失败不阻塞主流程,仅记录日志。", - "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": "number", - "required": true, - "description": "入库单ID" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "完成成功的入库单ID" - } - ] - }, - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "moduleFolder": "storage.entry", - "method": "storage.entry.get", - "title": "查询入库单详情。返回的 entryOrder.items 每项包含 pending_total(当前 pending 绑定的总预分配数量)、total_planned(计划入库数量=count)、bindings(pending 绑定列表,每项含 id/entry_item_id/receiving_detail_id/allocated_quantity/status/receivingDetail)", - "description": "查询入库单详情。返回的 entryOrder.items 每项包含 pending_total(当前 pending 绑定的总预分配数量)、total_planned(计划入库数量=count)、bindings(pending 绑定列表,每项含 id/entry_item_id/receiving_detail_id/allocated_quantity/status/receivingDetail)", - "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": "number", - "required": false, - "description": "入库单ID,与 entry_order_code 二选一" - }, - { - "name": "entry_order_code", - "type": "string", - "required": false, - "description": "入库单号,与 id 二选一" - } - ], - "response": [ - { - "name": "entryOrder", - "type": "object", - "required": true, - "description": "入库单详情,含 items 明细数组" - } - ] - }, - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "moduleFolder": "storage.entry", - "method": "storage.entry.list", - "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": "pagination", - "type": "object", - "required": false, - "description": "分页参数,支持 page/pageSize" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、order_status、store_id、order_type、日期区间等字段。新增 expense_record(费用是否记录)筛选,支持 eq/in;值会归一化为 0/1,兼容 true/false、1/0、y/n、yes/no(大小写不敏感,含布尔/字符串/数字写法)。示例:where.expense_record={operator:eq,value:true} 等价 where.expense_record={operator:eq,value:1};where.expense_record={operator:in,value:[true,\"0\",\"yes\",\"n\"]} 会归一化为 [1,0]。若部署环境尚未完成 expense_record 字段迁移,传入该筛选可能返回 400,错误提示为“当前环境未提供 expense_record 字段,暂不支持该筛选条件,请先完成表结构升级”。" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数,支持 sortField/sortOrder" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "入库单列表" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - }, - { - "name": "summary", - "type": "object", - "required": true, - "description": "状态汇总(total、pending、creating、created、completed、cancelled)" - } - ] - }, - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "moduleFolder": "storage.entry", - "method": "storage.entry.unbindReceivingDetails", - "title": "解绑入库明细的收货明细绑定。删除指定入库明细的所有 pending 绑定,并回退 received_quantity(恢复到绑定前的值),收货单明细的可用数量自动恢复(因为绑定记录被删除)。", - "description": "解绑入库明细的收货明细绑定。删除指定入库明细的所有 pending 绑定,并回退 received_quantity(恢复到绑定前的值),收货单明细的可用数量自动恢复(因为绑定记录被删除)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "entry_item_id", - "type": "number", - "required": true, - "description": "入库单明细ID" - } - ], - "response": [ - { - "name": "entry_item_id", - "type": "number", - "required": true, - "description": "入库明细ID" - }, - { - "name": "released_quantity", - "type": "number", - "required": true, - "description": "释放的绑定总量" - } - ] - }, - { - "moduleName": "库存操作模块", - "moduleKey": "storage.inventory", - "moduleFolder": "storage.inventory", - "method": "storage.expiry.list", - "title": "库存有效期列表查询(效期预警),按 wms_storage 查询并计算剩余天数与过期状态,支持 where 条件与分页。注意:无需传 warehouse_id/store_id,服务端会从当前登录用户取仓库上下文。", - "description": "库存有效期列表查询(效期预警),按 wms_storage 查询并计算剩余天数与过期状态,支持 where 条件与分页。注意:无需传 warehouse_id/store_id,服务端会从当前登录用户取仓库上下文。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "where", - "type": "object", - "required": false, - "description": "统一 where 条件对象;支持字段:item_code、goods_code、item_name、sku_property、stock_unit、is_shelf_life_mgmt、remaining_threshold_days。示例:where.item_code={operator:like,value:ABC}; where.remaining_threshold_days={operator:lte,value:7}。注意:无需传入 store_id 或 warehouse_id,服务端会从当前登录用户获取仓库上下文。" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数 { page, pageSize },默认 page=1, pageSize=20" - } - ], - "response": [ - { - "name": "data.list", - "type": "array", - "required": true, - "description": "匹配到的库存效期项数组" - }, - { - "name": "data.list[]", - "type": "object", - "required": false, - "description": "列表项,包含至少以下字段" - }, - { - "name": "data.pagination", - "type": "object", - "required": true, - "description": "分页信息,含 page、pageSize、total、totalPages" - } - ] - }, - { - "moduleName": "库存操作模块", - "moduleKey": "storage.inventory", - "moduleFolder": "storage.inventory", - "method": "storage.inventory.list", - "title": "库存列表查询(查 wms_storage),支持 where 条件、分页、排序、批次分组。默认按库位+商品合并数量(合并模式),group_by_batch=true 时返回每条库存明细(明细模式)", - "description": "库存列表查询(查 wms_storage),支持 where 条件、分页、排序、批次分组。默认按库位+商品合并数量(合并模式),group_by_batch=true 时返回每条库存明细(明细模式)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "where", - "type": "object", - "required": false, - "description": "统一 where 条件对象,可用字段:stock_id(商品ID)、space_id(库位ID)、store_id(货主ID)、inventory_type(ZP/CC/JS/XS/ZT/DJ/FP)、batch_no(批次号)、inbound_order_no(入库单号)、available_quantity(可用数量,支持 gt/lt)、inbound_time(入库时间,支持 between)、created_at(创建时间,支持 between)" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数 { page, pageSize },默认 page=1, pageSize=20" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数 { sortField, sortOrder },默认 sortField='created_at', sortOrder='DESC'" - }, - { - "name": "group_by_batch", - "type": "boolean", - "required": false, - "description": "是否按批次查询,默认 false。false=合并模式(按库位+商品聚合quantity/locked_quantity/available_quantity),true=明细模式(逐条返回含 batch_no/production_date/expiry_date 等)" - } - ], - "response": [] - }, - { - "moduleName": "库存操作模块", - "moduleKey": "storage.inventory", - "moduleFolder": "storage.inventory", - "method": "storage.inventory.matchPutaway", - "title": "收货单与入库单匹配入库。接收多个收货单和入库单,按商品(stock_warehouse_id)进行数量匹配入库,要求收货单已完成且已审核,完成后根据入库单来源(QM/API)自动触发回传", - "description": "收货单与入库单匹配入库。接收多个收货单和入库单,按商品(stock_warehouse_id)进行数量匹配入库,要求收货单已完成且已审核,完成后根据入库单来源(QM/API)自动触发回传", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "receiving_ids", - "type": "array", - "required": true, - "description": "收货单ID列表" - }, - { - "name": "entry_order_ids", - "type": "array", - "required": true, - "description": "入库单ID列表" - } - ], - "response": [] - }, - { - "moduleName": "库存操作模块", - "moduleKey": "storage.inventory", - "moduleFolder": "storage.inventory", - "method": "storage.inventory.quickPutaway", - "title": "收货单快捷入库上架。从收货单直接生成入库单并写入库存表,要求收货单已完成、已审核、货主已开启快捷入库策略且所有明细已匹配系统商品", - "description": "收货单快捷入库上架。从收货单直接生成入库单并写入库存表,要求收货单已完成、已审核、货主已开启快捷入库策略且所有明细已匹配系统商品", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "receiving_id", - "type": "number", - "required": true, - "description": "收货单ID,兼容 id" - } - ], - "response": [] - }, - { - "moduleName": "库存操作模块", - "moduleKey": "storage.inventory", - "moduleFolder": "storage.inventory", - "method": "storage.inventory.transferByProduct", - "title": "按库位+商品维度移库,自动查找原库位下该商品的所有库存记录并合并移动。不适用于开启批次管理的商品", - "description": "按库位+商品维度移库,自动查找原库位下该商品的所有库存记录并合并移动。不适用于开启批次管理的商品", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "space_id", - "type": "number", - "required": true, - "description": "原库位ID" - }, - { - "name": "stock_id", - "type": "number", - "required": true, - "description": "商品SKU ID(wms_stock_warehouse.id)" - }, - { - "name": "target_space_id", - "type": "number", - "required": true, - "description": "目标库位ID" - }, - { - "name": "quantity", - "type": "number", - "required": true, - "description": "移库数量" - } - ], - "response": [] - }, - { - "moduleName": "库存操作模块", - "moduleKey": "storage.inventory", - "moduleFolder": "storage.inventory", - "method": "storage.inventory.transferLocation", - "title": "单商品单库位移库,将库存从一个库位移动到另一个库位,支持部分数量移库和全量移库", - "description": "单商品单库位移库,将库存从一个库位移动到另一个库位,支持部分数量移库和全量移库", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "storage_id", - "type": "number", - "required": true, - "description": "库存记录ID" - }, - { - "name": "target_space_id", - "type": "number", - "required": true, - "description": "目标库位ID" - }, - { - "name": "quantity", - "type": "number", - "required": false, - "description": "移库数量,不传则全部移动" - } - ], - "response": [] - }, - { - "moduleName": "库存管理模块", - "moduleKey": "storage.management", - "moduleFolder": "storage.management", - "method": "storage.management.replenishmentDemand", - "title": "分拣缺货补货需求计算(仓库级别)。自动从用户上下文获取仓库,查询所有未完成储位分配的订单,计算每个SKU在分拣区与存货区的库存量、订单需求量、分拣区缺口、建议补货量及可补货库位。支持分页与排序。", - "description": "分拣缺货补货需求计算(仓库级别)。自动从用户上下文获取仓库,查询所有未完成储位分配的订单,计算每个SKU在分拣区与存货区的库存量、订单需求量、分拣区缺口、建议补货量及可补货库位。支持分页与排序。", - "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,默认 page=1 pageSize=20" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数,支持 sortField / sortOrder。sortField 可选值:stock_id / pick_zone_quantity / storage_zone_quantity / total_demand / shortage / replenishment_needed,默认 shortage;sortOrder 可选 ASC / DESC,默认 DESC" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "补货需求明细列表" - }, - { - "name": "summary", - "type": "object", - "required": true, - "description": "汇总信息" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.addDetail", - "title": "支持新增可选入参 item;item 有值时按传入字段创建明细(服务端会覆盖 receiving_id 与 creator_id);item 无值时沿原链路创建空白明细。返回的 selectId 与 data.details 语义不变(仍返回新创建明细的 selectId 与更新后的明细列表)。", - "description": "支持新增可选入参 item;item 有值时按传入字段创建明细(服务端会覆盖 receiving_id 与 creator_id);item 无值时沿原链路创建空白明细。返回的 selectId 与 data.details 语义不变(仍返回新创建明细的 selectId 与更新后的明细列表)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "receiving_id", - "type": "number", - "required": true, - "description": "收货单ID" - }, - { - "name": "item", - "type": "object", - "required": false, - "description": "可选:按传入字段创建明细;不传则创建空白明细。item.children 需覆盖以下字段(有则写、无则补齐):actual_quantity, box_quantity, boxes_per_pallet, space_id, system_product_id, box_width, box_height, box_length, box_remainder, box_weight, weight, barcode, product_name, pallet_quantity, receiving_time, production_date, expiry_date, remark, batch_number, product_snapshot。若传入 item,服务端仍会覆盖 receiving_id 与 creator_id。" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,200 表示添加成功" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "结果描述,成功时为 '添加成功'" - }, - { - "name": "data.details", - "type": "array", - "required": true, - "description": "收货单明细数组(每项为明细对象)" - }, - { - "name": "data.selectId", - "type": "number", - "required": true, - "description": "新创建的明细ID,用于前端选中" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.batchCancelReceiving", - "title": "storage.receiving.batchCancelReceiving 接口", - "description": "storage.receiving.batchCancelReceiving 接口", - "endpoint": "/system", - "authRequired": true, - "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数组" - } - ], - "response": [ - { - "name": "message", - "type": "string", - "required": true, - "description": "批量作废处理结果" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.bindDetailProduct", - "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": "detail_id", - "type": "number", - "required": true, - "description": "收货单明细ID(兼容字段 `id`)" - }, - { - "name": "system_product_id", - "type": "number", - "required": true, - "description": "系统商品ID(`StockWarehouse.id`,且必须属于当前仓库)" - } - ], - "response": [ - { - "name": "data.detail_id", - "type": "number", - "required": true, - "description": "收货单明细ID" - }, - { - "name": "data.receiving_id", - "type": "number", - "required": true, - "description": "收货单ID" - }, - { - "name": "data.system_product_id", - "type": "number", - "required": true, - "description": "已绑定的系统商品ID" - }, - { - "name": "data.product_name", - "type": "string", - "required": true, - "description": "自动回填的商品名称" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.bindStore", - "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": "id", - "type": "number", - "required": true, - "description": "收货单ID" - }, - { - "name": "store_id", - "type": "number", - "required": true, - "description": "货主ID(必须与当前仓库存在有效签约关系)" - } - ], - "response": [ - { - "name": "data.id", - "type": "number", - "required": true, - "description": "收货单ID" - }, - { - "name": "data.store_id", - "type": "number", - "required": true, - "description": "已绑定的货主ID" - }, - { - "name": "data.store_name", - "type": "string", - "required": false, - "description": "货主名称/签约备注名" - }, - { - "name": "data.status", - "type": "string", - "required": true, - "description": "当前收货单状态" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.cancel", - "title": "storage.receiving.cancel 接口", - "description": "storage.receiving.cancel 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.completeReceiving", - "title": "storage.receiving.completeReceiving 接口", - "description": "storage.receiving.completeReceiving 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.create", - "title": "storage.receiving.create 接口", - "description": "storage.receiving.create 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "delivery_method", - "type": "string", - "required": true, - "description": "到货方式:truck/express/air_freight/sea_freight/other" - }, - { - "name": "loading_method", - "type": "string", - "required": true, - "description": "装卸方式:with_pallet/without_pallet" - }, - { - "name": "license_plate", - "type": "string", - "required": false, - "description": "车牌号(delivery_method=truck 时建议传)" - }, - { - "name": "tracking_number", - "type": "string", - "required": false, - "description": "物流单号(非 truck/other 场景建议传)" - }, - { - "name": "store_id", - "type": "number", - "required": false, - "description": "货主ID" - }, - { - "name": "total_boxes", - "type": "number", - "required": false, - "description": "总箱数" - }, - { - "name": "total_pallets", - "type": "number", - "required": false, - "description": "总托盘数" - }, - { - "name": "remark", - "type": "string", - "required": false, - "description": "备注" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "新建收货单ID" - }, - { - "name": "receiving_number", - "type": "string", - "required": true, - "description": "收货单号" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.deleteDetail", - "title": "删除收货单明细并回算统计。仅允许明细创建者在收货中状态删除未入库的明细;服务端从登录用户上下文获取 creator_id(ctx.user.employees_id)与 warehouse_id(ctx.user.store_id)。若关联收货单状态为 completed(已完成)或 cancelled(已取消),接口会返回删除失败(400),不允许删除明细。", - "description": "删除收货单明细并回算统计。仅允许明细创建者在收货中状态删除未入库的明细;服务端从登录用户上下文获取 creator_id(ctx.user.employees_id)与 warehouse_id(ctx.user.store_id)。若关联收货单状态为 completed(已完成)或 cancelled(已取消),接口会返回删除失败(400),不允许删除明细。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "detail_id", - "type": "number", - "required": true, - "description": "收货单明细 ID(必填)" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": false, - "description": "业务状态码,200 表示成功,400/404/500 表示失败" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "简短的错误或成功信息" - }, - { - "name": "data", - "type": "object", - "required": false, - "description": "成功时返回的结果对象" - }, - { - "name": "data.details", - "type": "array", - "required": false, - "description": "删除后收货单剩余的明细数组。每项字段与 storage.receiving.getReceivingDetail 返回的明细项一致;product_snapshot 为解析后的对象或 null" - }, - { - "name": "data.selectId", - "type": "number|null", - "required": false, - "description": "删除后建议前端选中的明细 ID;无剩余明细时为 null" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.detailChange", - "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": "id", - "type": "number", - "required": true, - "description": "收货明细ID" - }, - { - "name": "receiving_id", - "type": "number", - "required": true, - "description": "收货单ID" - }, - { - "name": "actual_quantity", - "type": "number", - "required": false, - "description": "实际收货数量" - }, - { - "name": "batch_number", - "type": "string", - "required": false, - "description": "批次号" - }, - { - "name": "production_date", - "type": "string", - "required": false, - "description": "生产日期(可解析的日期字符串)" - }, - { - "name": "expiry_date", - "type": "string", - "required": false, - "description": "到期日期(可解析的日期字符串)。若早于当前日期,接口会返回 400 并拒绝录入。" - }, - { - "name": "box_quantity", - "type": "number", - "required": false, - "description": "箱数" - }, - { - "name": "boxes_per_pallet", - "type": "number", - "required": false, - "description": "每托盘箱数" - }, - { - "name": "pallet_quantity", - "type": "number", - "required": false, - "description": "托盘数" - }, - { - "name": "space_id", - "type": "number", - "required": false, - "description": "库位 ID(可回写)" - }, - { - "name": "remark", - "type": "string", - "required": false, - "description": "备注" - }, - { - "name": "system_product_id", - "type": "number", - "required": false, - "description": "系统商品 ID(StockWarehouse.id)。若提供,服务端会尝试回填 barcode/weight/箱规/product_name/product_snapshot 等。" - }, - { - "name": "barcode", - "type": "string", - "required": false, - "description": "条码(未传 system_product_id 时可单独更新)" - }, - { - "name": "product_name", - "type": "string", - "required": false, - "description": "商品名称(未传 system_product_id 时可单独更新)" - }, - { - "name": "box_width", - "type": "number", - "required": false, - "description": "箱宽" - }, - { - "name": "box_height", - "type": "number", - "required": false, - "description": "箱高" - }, - { - "name": "box_length", - "type": "number", - "required": false, - "description": "箱长" - }, - { - "name": "box_remainder", - "type": "number", - "required": false, - "description": "箱内剩余数量/零散数量(不满箱时的件数)" - }, - { - "name": "box_weight", - "type": "number", - "required": false, - "description": "实测箱重(单位与系统重量一致,如 kg)" - }, - { - "name": "weight", - "type": "number", - "required": false, - "description": "毛重/重量" - } - ], - "response": [ - { - "name": "data.id", - "type": "number", - "required": true, - "description": "收货明细 ID" - }, - { - "name": "data.receiving_id", - "type": "number", - "required": true, - "description": "收货单 ID" - }, - { - "name": "data.actual_quantity", - "type": "number", - "required": false, - "description": "实际收货数量" - }, - { - "name": "data.product_name", - "type": "string", - "required": false, - "description": "商品名称" - }, - { - "name": "data.barcode", - "type": "string", - "required": false, - "description": "条码" - }, - { - "name": "data.system_product_id", - "type": "number", - "required": false, - "description": "系统商品 ID" - }, - { - "name": "data.box_remainder", - "type": "number", - "required": false, - "description": "箱内剩余数量/零散数量(不满箱时的件数)" - }, - { - "name": "data.box_weight", - "type": "number", - "required": false, - "description": "实测箱重(单位与系统重量一致,如 kg)" - }, - { - "name": "data.updated_at", - "type": "string", - "required": false, - "description": "记录更新时间(ISO)" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.get", - "title": "storage.receiving.get 接口", - "description": "storage.receiving.get 接口", - "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": "number", - "required": true, - "description": "收货单ID" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": false, - "description": "业务状态码,200 表示成功" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "返回信息" - }, - { - "name": "data", - "type": "object", - "required": false, - "description": "收货单详情对象,包含 details(明细数组)、images 及主表字段" - }, - { - "name": "data.details", - "type": "array", - "required": false, - "description": "收货单明细数组(每项为明细对象)" - }, - { - "name": "data.details.*.box_remainder", - "type": "number", - "required": false, - "description": "箱内剩余数量/零散数量(不满箱时的件数),默认 0" - }, - { - "name": "data.details.*.box_weight", - "type": "number", - "required": false, - "description": "实测箱重(单位与系统重量一致,如 kg),默认 0" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.getAvailableInboundQuantity", - "title": "按 stock_id 查询可入库数量。返回指定商品在已审核收货单中各明细的可入库数量(actual_quantity - stored_quantity - pending_allocated_quantity),仅包含尚有可入库余量的明细,排除未审核和已取消的收货单。", - "description": "按 stock_id 查询可入库数量。返回指定商品在已审核收货单中各明细的可入库数量(actual_quantity - stored_quantity - pending_allocated_quantity),仅包含尚有可入库余量的明细,排除未审核和已取消的收货单。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "stock_id", - "type": "number", - "required": true, - "description": "商品库存ID(stock_warehouse.id)" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "可入库明细列表,每项包含 detail_id、receiving_id、receiving_number、product_name、actual_quantity、stored_quantity、pending_allocated_quantity、available_quantity、storage_status、batch_number、production_date、expiry_date、space_id、receiving_status" - }, - { - "name": "total", - "type": "number", - "required": true, - "description": "返回条数" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.getReceivingDetail", - "title": "storage.receiving.getReceivingDetail 接口", - "description": "storage.receiving.getReceivingDetail 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "收货单ID" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "明细分页参数,支持 page/pageSize" - } - ], - "response": [ - { - "name": "receiving", - "type": "object", - "required": true, - "description": "收货单详情(含 details、images、pagination)" - }, - { - "name": "receiving.details", - "type": "array", - "required": false, - "description": "收货单明细列表,单条记录包含明细字段(见下文)" - }, - { - "name": "receiving.details.*.space_id", - "type": "string", - "required": false, - "description": "库位展示名称(string|null)。优先取 custom_space_name,其次取 space_name。兼容说明:该字段历史上为数值库位ID,现已调整为展示名称;原始ID请使用 receiving.details.*.space_id_raw。" - }, - { - "name": "receiving.details.*.space_id_raw", - "type": "number", - "required": false, - "description": "原始库位ID(number|null),用于兼容依赖旧语义(space_id=数字ID)的调用方。" - }, - { - "name": "receiving.details.*.space_name", - "type": "string", - "required": false, - "description": "库位名称/编码(string|null),作为展示名称的回退来源。" - }, - { - "name": "receiving.details.*.custom_space_name", - "type": "string", - "required": false, - "description": "库位自定义名称(string|null,可空)。" - }, - { - "name": "receiving.details.*.box_remainder", - "type": "number", - "required": false, - "description": "箱内剩余数量/零散数量(不满箱时的件数)" - }, - { - "name": "receiving.details.*.box_weight", - "type": "number", - "required": false, - "description": "实测箱重(单位与系统重量一致,如 kg)" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.getReceivingList", - "title": "storage.receiving.getReceivingList 接口", - "description": "storage.receiving.getReceivingList 接口", - "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 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、status、store_id、日期区间等字段。示例:where.status={operator:eq,value:finished}; where.store_id={operator:eq,value:1001}; where.create_time_start={value:2026-03-01}。" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "收货单列表" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - }, - { - "name": "summary", - "type": "object", - "required": true, - "description": "汇总信息(total_quantity、total_locked、total_available、total_items)" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.manualMatchEntryOrder", - "title": "手动匹配入库单与收货单。传入收货单ID和入库单ID,复用异步匹配服务的明细对比和回传逻辑,同步返回匹配结果(含 matchType、comparisonResult、callbackSent、partialStorageMarked 等)。", - "description": "手动匹配入库单与收货单。传入收货单ID和入库单ID,复用异步匹配服务的明细对比和回传逻辑,同步返回匹配结果(含 matchType、comparisonResult、callbackSent、partialStorageMarked 等)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "receivingId", - "type": "number", - "required": true, - "description": "收货单 ID" - }, - { - "name": "entryOrderId", - "type": "number", - "required": true, - "description": "入库单 ID" - } - ], - "response": [ - { - "name": "matchType", - "type": "string", - "required": true, - "description": "匹配类型枚举:full_match(SKU+数量完全一致)/ receiving_covers_entry(收货单覆盖入库单,触发回传+标记部分入库)/ entry_exceeds_receiving(入库单超出收货单,不触发回传)/ no_match(SKU无交集,不触发回传)" - }, - { - "name": "comparisonResult", - "type": "object", - "required": true, - "description": "明细对比结果对象" - }, - { - "name": "callbackSent", - "type": "boolean", - "required": true, - "description": "是否已发送回传(full_match / receiving_covers_entry 时为 true)" - }, - { - "name": "callbackResult", - "type": "object|null", - "required": true, - "description": "回传结果对象(未发送时为 null);成功时含 success、sourceType(QM/API)、detail 字段" - }, - { - "name": "partialStorageMarked", - "type": "boolean", - "required": true, - "description": "是否已标记部分入库(仅 receiving_covers_entry 时为 true)" - }, - { - "name": "entryOrder", - "type": "object", - "required": true, - "description": "入库单摘要信息" - }, - { - "name": "receivingOrder", - "type": "object", - "required": true, - "description": "收货单摘要信息" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.queryReceivingLogs", - "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": "number|string", - "required": false, - "description": "收货单ID(与 receiving_id 二选一)" - }, - { - "name": "receiving_id", - "type": "number|string", - "required": false, - "description": "收货单ID(兼容字段,与 id 二选一)" - }, - { - "name": "page", - "type": "number", - "required": false, - "description": "页码(兼容顶层分页入参)" - }, - { - "name": "pageSize", - "type": "number", - "required": false, - "description": "每页数量(兼容顶层分页入参)" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数,支持 page / pageSize" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "日志列表" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息,包含 page、pageSize、total、totalPages" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.rejectReceiving", - "title": "驳回收货单:将已完成(completed)的收货单批量恢复为收货中(receiving),记录驳回人信息和驳回理由。若任意一张收货单状态非 completed,则整批拒绝操作。驳回人信息(reviewer_name、reviewer_employee_id)自动取当前登录用户上下文,无需传入.", - "description": "驳回收货单:将已完成(completed)的收货单批量恢复为收货中(receiving),记录驳回人信息和驳回理由。若任意一张收货单状态非 completed,则整批拒绝操作。驳回人信息(reviewer_name、reviewer_employee_id)自动取当前登录用户上下文,无需传入.", - "endpoint": "/system", - "authRequired": true, - "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数组,所有收货单必须属于当前仓库且状态为 completed,否则整批拒绝" - }, - { - "name": "remark", - "type": "string", - "required": false, - "description": "驳回理由,覆盖收货单原备注字段;不传则保留原备注" - } - ], - "response": [ - { - "name": "count", - "type": "number", - "required": false, - "description": "成功驳回的收货单数量" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.removeItem", - "title": "storage.receiving.removeItem 接口", - "description": "storage.receiving.removeItem 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": false, - "description": "id 参数" - }, - { - "name": "item_id", - "type": "number", - "required": false, - "description": "item_id 参数" - } - ], - "response": [] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.reviewReceiving", - "title": "批量审核收货单:校验所有单据满足条件(收货完成、全部匹配、未入库、已绑定货主、未审核)后统一审核,任意一张不符合则整批失败回滚。审核人信息自动取当前登录用户上下文,无需传入.", - "description": "批量审核收货单:校验所有单据满足条件(收货完成、全部匹配、未入库、已绑定货主、未审核)后统一审核,任意一张不符合则整批失败回滚。审核人信息自动取当前登录用户上下文,无需传入.", - "endpoint": "/system", - "authRequired": true, - "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数组,所有单据必须满足:status=completed、detail_status=all_matched、storage_status=none、store_id 已绑定、is_review=0,否则整批拒绝" - } - ], - "response": [ - { - "name": "count", - "type": "number", - "required": false, - "description": "成功审核的收货单数量" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "moduleFolder": "storage_receiving", - "method": "storage.receiving.save", - "title": "修改收货单基础信息。按收货单ID更新当前仓库下收货单的基础字段。", - "description": "修改收货单基础信息。按收货单ID更新当前仓库下收货单的基础字段。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "收货单ID,按该ID修改当前仓库下的收货单" - }, - { - "name": "delivery_method", - "type": "string", - "required": false, - "description": "到货方式:truck/express/air_freight/sea_freight/other;不传则保持原值" - }, - { - "name": "loading_method", - "type": "string", - "required": false, - "description": "装卸方式:with_pallet/without_pallet;不传则保持原值" - }, - { - "name": "license_plate", - "type": "string", - "required": false, - "description": "车牌号;当 delivery_method=truck 时可更新,其他到货方式会被清空或忽略" - }, - { - "name": "tracking_number", - "type": "string", - "required": false, - "description": "物流单号;当 delivery_method 为 express/air_freight/sea_freight 时可更新,truck/other 场景会被清空或忽略" - }, - { - "name": "store_id", - "type": "number", - "required": false, - "description": "货主ID;若传入,会校验当前仓库下签约关系并同步更新货主名称;传 0/null 可清空货主" - }, - { - "name": "total_boxes", - "type": "number", - "required": false, - "description": "总箱数,默认 0" - }, - { - "name": "total_pallets", - "type": "number", - "required": false, - "description": "总托盘数,默认 0" - }, - { - "name": "remark", - "type": "string", - "required": false, - "description": "备注信息" - }, - { - "name": "status", - "type": "string", - "required": false, - "description": "收货单状态;不传则保持原值" - }, - { - "name": "video_device_id", - "type": "string", - "required": false, - "description": "录像设备ID" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码;200 表示修改成功" - }, - { - "name": "id", - "type": "number", - "required": true, - "description": "修改的收货单ID" - }, - { - "name": "receiving_number", - "type": "string", - "required": true, - "description": "收货单号" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "结果描述;成功时通常为收货单修改成功" - } - ] - }, - { - "moduleName": "库存报表模块", - "moduleKey": "storage.report", - "moduleFolder": "storage.report", - "method": "storage.report.export", - "title": "提交库存报表导出异步任务(与 storage.report.search 使用相同查询条件),立即返回任务受理信息,不直接返回文件。", - "description": "提交库存报表导出异步任务(与 storage.report.search 使用相同查询条件),立即返回任务受理信息,不直接返回文件。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "where", - "type": "object", - "required": false, - "description": "查询条件对象。支持字段:start_time(闭区间下限)、end_time(闭区间上限)、by_space(是否按库位返回,默认 false)、store_ids(货主ID数组)。仅返回在时间区间内存在流水的数据(无流水键不返回)。" - }, - { - "name": "where.start_time", - "type": "string", - "required": false, - "description": "开始时间,支持字符串/Date;用于闭区间过滤:created_at >= start_time" - }, - { - "name": "where.end_time", - "type": "string", - "required": false, - "description": "结束时间,支持字符串/Date;用于闭区间过滤:created_at <= end_time" - }, - { - "name": "where.by_space", - "type": "boolean", - "required": false, - "description": "是否按库位返回,默认 false。false=按商品+货主聚合(多库位汇总),true=按商品+库位+货主返回;当 where.by_space=true 时,导出汇总 sheet 会额外包含 space_id、space_name。" - }, - { - "name": "where.store_ids", - "type": "array", - "required": false, - "description": "货主ID数组,用于过滤特定货主(空或未传表示不过滤)" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数对象(请求体 data.sort)。支持 data.sort.sortField / data.sort.sort_field 与 data.sort.sortOrder / data.sort.sort_order;sortField 白名单:begin_total、inbound_total、outbound_total、end_total;sortOrder 支持 ASC / DESC(大小写不敏感);非法字段或顺序将回退默认排序。" - }, - { - "name": "sort.sortField", - "type": "string", - "required": false, - "description": "排序字段(兼容 data.sort.sortField)。白名单:begin_total、inbound_total、outbound_total、end_total;非法值回退默认排序。" - }, - { - "name": "sort.sort_field", - "type": "string", - "required": false, - "description": "排序字段下划线别名(兼容 data.sort.sort_field),规则同 sort.sortField。" - }, - { - "name": "sort.sortOrder", - "type": "string", - "required": false, - "description": "排序方向(兼容 data.sort.sortOrder),支持 ASC / DESC(大小写不敏感);非法值回退默认排序。" - }, - { - "name": "sort.sort_order", - "type": "string", - "required": false, - "description": "排序方向下划线别名(兼容 data.sort.sort_order),规则同 sort.sortOrder。" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "导出任务ID,用于后续查询进度。" - }, - { - "name": "status", - "type": "string", - "required": true, - "description": "任务状态,提交受理后初始为 submitted。" - }, - { - "name": "progress", - "type": "number", - "required": true, - "description": "任务进度百分比(0-100)。" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "任务受理提示信息。" - }, - { - "name": "error", - "type": "string", - "required": true, - "description": "错误信息;受理成功时通常为空字符串。" - }, - { - "name": "result", - "type": "object|null", - "required": true, - "description": "任务结果对象;受理阶段为 null。" - }, - { - "name": "update_time", - "type": "number", - "required": true, - "description": "任务状态更新时间(时间戳)。" - } - ] - }, - { - "moduleName": "库存报表模块", - "moduleKey": "storage.report", - "moduleFolder": "storage.report", - "method": "storage.report.exportTaskProgress", - "title": "根据 task_id 查询库存报表导出任务进度与结果;status 可能值:submitted/running/success/failed/not_found。", - "description": "根据 task_id 查询库存报表导出任务进度与结果;status 可能值:submitted/running/success/failed/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", - "type": "string", - "required": false, - "description": "导出任务ID(下划线写法)。" - }, - { - "name": "taskId", - "type": "string", - "required": false, - "description": "导出任务ID(驼峰写法,兼容别名)。" - } - ], - "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": "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": "number", - "required": true, - "description": "任务状态更新时间(时间戳)。" - }, - { - "name": "result", - "type": "object|null", - "required": true, - "description": "任务结果对象(包含导出文件信息);未完成或失败时可能为 null。" - } - ] - }, - { - "moduleName": "库存报表模块", - "moduleKey": "storage.report", - "moduleFolder": "storage.report", - "method": "storage.report.search", - "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": "where", - "type": "object", - "required": false, - "description": "查询条件对象。支持字段:start_time(闭区间下限)、end_time(闭区间上限)、by_space(是否按库位返回,默认 false)、store_ids(货主ID数组)。仅返回在时间区间内存在流水的数据(无流水键不返回)。" - }, - { - "name": "where.start_time", - "type": "string", - "required": false, - "description": "开始时间,支持字符串/Date;用于闭区间过滤:created_at >= start_time" - }, - { - "name": "where.end_time", - "type": "string", - "required": false, - "description": "结束时间,支持字符串/Date;用于闭区间过滤:created_at <= end_time" - }, - { - "name": "where.by_space", - "type": "boolean", - "required": false, - "description": "是否按库位返回,默认 false。false=按商品+货主聚合(多库位汇总),true=按商品+库位+货主返回;当 where.by_space=true 时,额外返回 space_id、space_name(custom_name 优先,否则使用 space_code)。" - }, - { - "name": "where.store_ids", - "type": "array", - "required": false, - "description": "货主ID数组,用于过滤特定货主(空或未传表示不过滤)" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数对象(请求体 data.sort)。支持 data.sort.sortField / data.sort.sort_field 与 data.sort.sortOrder / data.sort.sort_order;sortField 白名单:begin_total、inbound_total、outbound_total、end_total;sortOrder 支持 ASC / DESC(大小写不敏感);非法字段或顺序将回退默认排序。" - }, - { - "name": "sort.sortField", - "type": "string", - "required": false, - "description": "排序字段(兼容 data.sort.sortField)。白名单:begin_total、inbound_total、outbound_total、end_total;非法值回退默认排序。" - }, - { - "name": "sort.sort_field", - "type": "string", - "required": false, - "description": "排序字段下划线别名(兼容 data.sort.sort_field),规则同 sort.sortField。" - }, - { - "name": "sort.sortOrder", - "type": "string", - "required": false, - "description": "排序方向(兼容 data.sort.sortOrder),支持 ASC / DESC(大小写不敏感);非法值回退默认排序。" - }, - { - "name": "sort.sort_order", - "type": "string", - "required": false, - "description": "排序方向下划线别名(兼容 data.sort.sort_order),规则同 sort.sortOrder。" - } - ], - "response": [ - { - "name": "data.list", - "type": "array", - "required": true, - "description": "匹配到的报表行列表 已按 sort 规则排序返回。" - }, - { - "name": "data.list[]", - "type": "object", - "required": true, - "description": "单条报表记录字段" - } - ] - }, - { - "moduleName": "出库单模块", - "moduleKey": "storage.stockout", - "moduleFolder": "storage.stockout", - "method": "storage.stockout.list", - "title": "非订单出库单能力(对应奇门 stockout.create):用于处理由奇门创建的非订单出库单;主出口为 storage.stockout.*,不再推荐通过 storage.delivery.* 命名使用。storage.delivery.* 仅保留兼容转发。", - "description": "非订单出库单能力(对应奇门 stockout.create):用于处理由奇门创建的非订单出库单;主出口为 storage.stockout.*,不再推荐通过 storage.delivery.* 命名使用。storage.delivery.* 仅保留兼容转发。", - "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 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;常用字段包括 delivery_order_code、status、outbound_status、buyer_nick、mobile 与日期区间字段。" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数,支持 sortField/sortOrder,默认按 updated_at DESC、id DESC" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "出库单列表" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - } - ] - }, - { - "moduleName": "出库单模块", - "moduleKey": "storage.stockout", - "moduleFolder": "storage.stockout", - "method": "storage.stockout.listItems", - "title": "按出库单查询商品明细(用于非订单出库单),底层复用 order.listItems。", - "description": "按出库单查询商品明细(用于非订单出库单),底层复用 order.listItems。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "delivery_order_code", - "type": "string", - "required": false, - "description": "出库单号,可用于定位订单" - }, - { - "name": "order_id", - "type": "number", - "required": false, - "description": "订单ID,可与 id 兼容用于定位订单" - }, - { - "name": "id", - "type": "number", - "required": false, - "description": "订单ID,可选;与 delivery_order_code / order_id 至少传一个" - } - ], - "response": [ - { - "name": "order", - "type": "object", - "required": true, - "description": "订单基础信息(含 id、delivery_order_code)" - }, - { - "name": "items", - "type": "array", - "required": true, - "description": "出库单商品明细" - } - ] - }, - { - "moduleName": "出库单模块", - "moduleKey": "storage.stockout", - "moduleFolder": "storage.stockout", - "method": "storage.stockout.toOrder", - "title": "占位接口,暂未开放。当前仅保留方法名用于后续扩展,逻辑暂不能使用。参数 id / delivery_order_code 暂未启用。", - "description": "占位接口,暂未开放。当前仅保留方法名用于后续扩展,逻辑暂不能使用。参数 id / delivery_order_code 暂未启用。", - "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": "number", - "required": false, - "description": "预留参数,暂未启用;当前仅保留字段名用于后续扩展。" - }, - { - "name": "delivery_order_code", - "type": "string", - "required": false, - "description": "预留参数,暂未启用;当前仅保留字段名用于后续扩展。" - } - ], - "response": [ - { - "name": "_note", - "type": "string", - "required": false, - "description": "占位接口,当前无有效业务响应" - } - ] - }, - { - "moduleName": "库存操作模块", - "moduleKey": "storage.inventory", - "moduleFolder": "storage.inventory", - "method": "storage.transaction.list", - "title": "出入库记录列表查询,支持 where 条件、分页、排序、批次分组切换。默认按库位合并数量(合并模式),group_by_batch=true 时返回每条明细(明细模式)", - "description": "出入库记录列表查询,支持 where 条件、分页、排序、批次分组切换。默认按库位合并数量(合并模式),group_by_batch=true 时返回每条明细(明细模式)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "where", - "type": "object", - "required": false, - "description": "统一 where 条件对象,可用字段:transaction_type(ENUM INBOUND/OUTBOUND)、stock_id、space_id、store_id、order_type(SCRK/MATCH)、order_no、inventory_type(ZP/CC/JS/XS/ZT/DJ/FP)、operator_name、created_at(支持 between)" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数 { page, pageSize },默认 page=1, pageSize=20" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数 { sortField, sortOrder },默认 sortField='created_at', sortOrder='DESC'" - }, - { - "name": "group_by_batch", - "type": "boolean", - "required": false, - "description": "是否按批次查询明细,默认 false。false=合并模式(按库位+商品聚合),true=明细模式(逐条返回)" - } - ], - "response": [] - }, - { - "moduleName": "主体模块", - "moduleKey": "store", - "moduleFolder": "store", - "method": "store.auditApply", - "title": "store.auditApply 接口", - "description": "store.auditApply 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "audit_status", - "type": "string", - "required": true, - "description": "审核状态(approved/rejected)" - }, - { - "name": "code", - "type": "string", - "required": true, - "description": "申请码(join_token)" - }, - { - "name": "store_id", - "type": "number", - "required": true, - "description": "当前审批门店ID" - }, - { - "name": "role_ids", - "type": "array", - "required": true, - "description": "分配角色ID数组" - }, - { - "name": "reject_reason", - "type": "string", - "required": false, - "description": "拒绝原因(audit_status=rejected 时可传)" - } - ], - "response": [] - }, - { - "moduleName": "主体模块", - "moduleKey": "store", - "moduleFolder": "store", - "method": "store.createStore", - "title": "store.createStore 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))", - "description": "store.createStore 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "subject_config", - "type": "object", - "required": false, - "description": "货主主体配置,不传时自动写入默认值" - }, - { - "name": "subject_config.max_notice_webhook_count", - "type": "number", - "required": false, - "description": "当前主体最多允许绑定 / 触达的消息推送接口数量,默认 5" - }, - { - "name": "subject_config.default_express_code", - "type": "string", - "required": false, - "description": "默认快递编码,缺省为 STO" - }, - { - "name": "subject_config.default_platform_code", - "type": "string", - "required": false, - "description": "默认平台编码,缺省为 TB" - }, - { - "name": "subject_config.group_wave_prefix", - "type": "string", - "required": false, - "description": "团购波次前缀,最多 5 个字符,默认 B" - }, - { - "name": "subject_config.min_group_order_fetch_quantity", - "type": "number", - "required": false, - "description": "最小团购订单抓取数量,默认 13" - }, - { - "name": "subject_config.auto_grouping_enabled", - "type": "boolean", - "required": false, - "description": "是否自动加团,默认 false(关闭)" - }, - { - "name": "subject_config.enable_external_express_code", - "type": "boolean", - "required": false, - "description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)" - } - ], - "response": [] - }, - { - "moduleName": "主体模块", - "moduleKey": "store", - "moduleFolder": "store", - "method": "store.createWarehouse", - "title": "store.createWarehouse 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))", - "description": "store.createWarehouse 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "subject_config", - "type": "object", - "required": false, - "description": "货主主体配置,不传时自动写入默认值" - }, - { - "name": "subject_config.max_notice_webhook_count", - "type": "number", - "required": false, - "description": "当前主体最多允许绑定 / 触达的消息推送接口数量,默认 5" - }, - { - "name": "subject_config.default_express_code", - "type": "string", - "required": false, - "description": "默认快递编码,缺省为 STO" - }, - { - "name": "subject_config.default_platform_code", - "type": "string", - "required": false, - "description": "默认平台编码,缺省为 TB" - }, - { - "name": "subject_config.group_wave_prefix", - "type": "string", - "required": false, - "description": "团购波次前缀,最多 5 个字符,默认 B" - }, - { - "name": "subject_config.min_group_order_fetch_quantity", - "type": "number", - "required": false, - "description": "最小团购订单抓取数量,默认 13" - }, - { - "name": "subject_config.auto_grouping_enabled", - "type": "boolean", - "required": false, - "description": "是否自动加团,默认 false(关闭)" - }, - { - "name": "subject_config.enable_external_express_code", - "type": "boolean", - "required": false, - "description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)" - } - ], - "response": [] - }, - { - "moduleName": "主体模块", - "moduleKey": "store", - "moduleFolder": "store", - "method": "store.getStoreRoles", - "title": "store.getStoreRoles 接口", - "description": "store.getStoreRoles 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "code", - "type": "string", - "required": true, - "description": "申请码(join_token)" - } - ], - "response": [] - }, - { - "moduleName": "主体模块", - "moduleKey": "store", - "moduleFolder": "store", - "method": "store.joinStore", - "title": "store.joinStore 接口", - "description": "store.joinStore 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "主体模块", - "moduleKey": "store", - "moduleFolder": "store", - "method": "store.joinWarehouse", - "title": "store.joinWarehouse 接口", - "description": "store.joinWarehouse 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "货主-仓库签约模块", - "moduleKey": "storeWarehouse.store", - "moduleFolder": "storewarehouse.store", - "method": "storeWarehouse.store.adjustPrintQuantity", - "title": "人工调整签约关系下的面单余额并记录变更日志", - "description": "人工调整签约关系下的面单余额并记录变更日志", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - }, - { - "name": "print_quantity", - "type": "number", - "required": false, - "description": "目标面单余额(覆盖值);优先使用该字段" - }, - { - "name": "target_quantity", - "type": "number", - "required": false, - "description": "目标面单余额(覆盖值);兼容别名" - }, - { - "name": "change_quantity", - "type": "number", - "required": true, - "description": "兼容旧字段;当前按目标面单余额(覆盖值)解释,差值将自动写入变更日志" - }, - { - "name": "adjust_quantity", - "type": "number", - "required": false, - "description": "兼容旧字段;当前按目标面单余额(覆盖值)解释" - }, - { - "name": "reason", - "type": "string", - "required": true, - "description": "人工调整缘由,必填" - }, - { - "name": "business_type", - "type": "string", - "required": false, - "description": "业务来源类型,预留给后续 order_express 等自动扣减场景" - }, - { - "name": "business_id", - "type": "number", - "required": false, - "description": "业务关联ID,预留给后续关联 wms_order_express.id" - } - ], - "response": [] - }, - { - "moduleName": "货主-仓库签约模块", - "moduleKey": "storeWarehouse.store", - "moduleFolder": "storewarehouse.store", - "method": "storeWarehouse.store.deleteQimenConfig", - "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": "id", - "type": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - }, - { - "name": "interface_type_id", - "type": "number", - "required": false, - "description": "接口类型ID" - } - ], - "response": [] - }, - { - "moduleName": "货主-仓库签约模块", - "moduleKey": "storeWarehouse.store", - "moduleFolder": "storewarehouse.store", - "method": "storeWarehouse.store.getPolicyConfig", - "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": "id", - "type": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - } - ], - "response": [ - { - "name": "data.contract_id", - "type": "number", - "required": true, - "description": "签约关系ID" - }, - { - "name": "data.policy_config", - "type": "object", - "required": true, - "description": "策略配置对象(包含默认值补齐后的字段)" - }, - { - "name": "data.policy_config.enable_external_express_code", - "type": "number", - "required": true, - "description": "是否启用外部快递编码(flag:0=关闭,1=开启;默认 0)" - } - ] - }, - { - "moduleName": "货主-仓库签约模块", - "moduleKey": "storeWarehouse.store", - "moduleFolder": "storewarehouse.store", - "method": "storeWarehouse.store.getPolicyConfigFields", - "title": "获取签约策略可配置字段元信息列表", - "description": "获取签约策略可配置字段元信息列表", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "货主-仓库签约模块", - "moduleKey": "storeWarehouse.store", - "moduleFolder": "storewarehouse.store", - "method": "storeWarehouse.store.list", - "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": "page", - "type": "number", - "required": false, - "description": "页码,默认 1" - }, - { - "name": "page_size", - "type": "number", - "required": false, - "description": "分页大小,默认 20" - }, - { - "name": "keyword", - "type": "string", - "required": false, - "description": "签约备注或主体名称关键字" - } - ], - "response": [ - { - "name": "data.list", - "type": "array", - "required": false, - "description": "签约关系列表" - }, - { - "name": "data.list[].id", - "type": "number", - "required": false, - "description": "签约关系主键 ID" - }, - { - "name": "data.list[].store_id", - "type": "number", - "required": false, - "description": "货主 ID" - }, - { - "name": "data.list[].store_name", - "type": "string", - "required": false, - "description": "货主名称(优先取备注名,无则取 company_name)" - }, - { - "name": "data.list[].warehouse_id", - "type": "number", - "required": false, - "description": "仓库 ID" - }, - { - "name": "data.list[].warehouse_name", - "type": "string", - "required": false, - "description": "仓库名称(优先取备注名,无则取 company_name)" - }, - { - "name": "data.list[].counterparty_id", - "type": "number", - "required": false, - "description": "对方主体 ID(当前为仓库则返回货主 ID,反之亦然)" - }, - { - "name": "data.list[].counterparty_name", - "type": "string", - "required": false, - "description": "对方主体名称" - }, - { - "name": "data.list[].current_subject_role", - "type": "string", - "required": false, - "description": "当前主体角色:warehouse 或 store" - }, - { - "name": "data.list[].auth_status", - "type": "number", - "required": false, - "description": "签约状态:1=申请中 2=已通过 3=已拒绝 4=已解除 5=已过期" - }, - { - "name": "data.list[].auth_status_label", - "type": "string", - "required": false, - "description": "签约状态中文标签" - }, - { - "name": "data.list[].apply_reason", - "type": "string", - "required": false, - "description": "申请原因" - }, - { - "name": "data.list[].review_comment", - "type": "string", - "required": false, - "description": "审核评语" - }, - { - "name": "data.list[].apply_time", - "type": "string|null", - "required": false, - "description": "申请时间" - }, - { - "name": "data.list[].review_time", - "type": "string|null", - "required": false, - "description": "审核时间" - }, - { - "name": "data.list[].auth_start", - "type": "string|null", - "required": false, - "description": "授权开始时间" - }, - { - "name": "data.list[].auth_end", - "type": "string|null", - "required": false, - "description": "授权结束时间" - }, - { - "name": "data.list[].actual_end", - "type": "string|null", - "required": false, - "description": "实际结束时间" - }, - { - "name": "data.list[].print_quantity", - "type": "number", - "required": false, - "description": "面单余额数量" - }, - { - "name": "data.list[].applied_by", - "type": "number|null", - "required": false, - "description": "申请人账号 ID" - }, - { - "name": "data.list[].reviewed_by", - "type": "number|null", - "required": false, - "description": "审核人账号 ID" - }, - { - "name": "data.list[].ended_by", - "type": "number|null", - "required": false, - "description": "解除人账号 ID" - }, - { - "name": "data.list[].remask", - "type": "string", - "required": false, - "description": "备注名(当前为仓库则返回货主备注名,反之亦然)" - }, - { - "name": "data.list[].use_status", - "type": "number", - "required": false, - "description": "启用状态:0=禁用 1=启用" - }, - { - "name": "data.list[].policy_config", - "type": "object|null", - "required": false, - "description": "签约策略配置对象,无则为 null" - }, - { - "name": "data.list[].is_auth_valid", - "type": "boolean", - "required": false, - "description": "签约是否在有效期内" - }, - { - "name": "data.list[].remaining_days", - "type": "number", - "required": false, - "description": "剩余有效天数(未在有效期内时为 0)" - }, - { - "name": "data.list[].has_qimen_config", - "type": "boolean", - "required": false, - "description": "该货主是否已配置奇门(true=已配置,false=未配置)" - }, - { - "name": "data.total", - "type": "number", - "required": false, - "description": "总记录数" - }, - { - "name": "data.page", - "type": "number", - "required": false, - "description": "当前页码" - }, - { - "name": "data.page_size", - "type": "number", - "required": false, - "description": "每页条数" - }, - { - "name": "data.current_subject.store_id", - "type": "number", - "required": false, - "description": "当前主体 ID" - }, - { - "name": "data.current_subject.company_name", - "type": "string", - "required": false, - "description": "当前主体公司名称" - }, - { - "name": "data.current_subject.role", - "type": "string", - "required": false, - "description": "当前主体角色:warehouse 或 store" - } - ] - }, - { - "moduleName": "货主-仓库签约模块", - "moduleKey": "storeWarehouse.store", - "moduleFolder": "storewarehouse.store", - "method": "storeWarehouse.store.listApiConfig", - "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": "id", - "type": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - }, - { - "name": "interface_type_id", - "type": "number", - "required": false, - "description": "接口类型ID,默认查询全部可用类型" - } - ], - "response": [ - { - "name": "data.list[].callback_url", - "type": "string", - "required": false, - "description": "API回调通知URL,来自 serializeQimenConfig 序列化" - } - ] - }, - { - "moduleName": "货主-仓库签约模块", - "moduleKey": "storeWarehouse.store", - "moduleFolder": "storewarehouse.store", - "method": "storeWarehouse.store.openAccount", - "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": "username", - "type": "string", - "required": true, - "description": "登录账号(用户名),全局唯一" - }, - { - "name": "password", - "type": "string", - "required": false, - "description": "初始密码,不传则自动随机生成 12 位密码" - }, - { - "name": "real_name", - "type": "string", - "required": false, - "description": "真实姓名" - }, - { - "name": "company_name", - "type": "string", - "required": true, - "description": "公司全称,全局唯一,1-200 字符" - }, - { - "name": "business_license", - "type": "string", - "required": false, - "description": "营业执照号" - }, - { - "name": "contact_person", - "type": "string", - "required": true, - "description": "联系人姓名,1-50 字符" - }, - { - "name": "contact_phone", - "type": "string", - "required": false, - "description": "联系电话" - }, - { - "name": "legal_person", - "type": "string", - "required": false, - "description": "法人代表" - }, - { - "name": "contact_email", - "type": "string", - "required": false, - "description": "联系邮箱" - }, - { - "name": "address", - "type": "string", - "required": false, - "description": "公司地址" - }, - { - "name": "industry", - "type": "string", - "required": false, - "description": "所属行业" - }, - { - "name": "logo_url", - "type": "string", - "required": false, - "description": "Logo 链接" - }, - { - "name": "domain", - "type": "string", - "required": false, - "description": "绑定域名" - }, - { - "name": "auth_start", - "type": "string", - "required": false, - "description": "授权开始日期,默认当天(ISO 8601 格式)" - }, - { - "name": "auth_end", - "type": "string", - "required": false, - "description": "授权结束日期(ISO 8601 格式)" - }, - { - "name": "print_quantity", - "type": "number", - "required": false, - "description": "初始面单余额,默认 0" - }, - { - "name": "apply_reason", - "type": "string", - "required": false, - "description": "申请原因,默认\"仓库代开户\",最长 2000 字符" - }, - { - "name": "store_remask", - "type": "string", - "required": false, - "description": "货主备注名,最长 50 字符" - }, - { - "name": "warehouse_remask", - "type": "string", - "required": false, - "description": "仓库备注名,最长 50 字符" - } - ], - "response": [ - { - "name": "store_id", - "type": "number", - "required": true, - "description": "新建的货主 ID" - }, - { - "name": "account_id", - "type": "number", - "required": true, - "description": "新建的账号 ID" - }, - { - "name": "contract_id", - "type": "number", - "required": true, - "description": "新建的签约关系 ID" - }, - { - "name": "company_name", - "type": "string", - "required": true, - "description": "货主公司名称" - }, - { - "name": "username", - "type": "string", - "required": true, - "description": "新建的登录账号名" - }, - { - "name": "role_id", - "type": "number", - "required": true, - "description": "分配的货主管理员角色 ID" - } - ] - }, - { - "moduleName": "货主-仓库签约模块", - "moduleKey": "storeWarehouse.store", - "moduleFolder": "storewarehouse.store", - "method": "storeWarehouse.store.queryPrintQuantityLogs", - "title": "按 store_id 分页查询面单余额变更日志", - "description": "按 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": "store_id", - "type": "number|string", - "required": true, - "description": "货主ID(必填)" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页对象,包含 page 与 page_size;默认 { page: 1, page_size: 20 }" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": true, - "description": "返回结果对象,包含 list 和 pagination" - } - ] - }, - { - "moduleName": "货主-仓库签约模块", - "moduleKey": "storeWarehouse.store", - "moduleFolder": "storewarehouse.store", - "method": "storeWarehouse.store.rename", - "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": "id", - "type": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - } - ], - "response": [] - }, - { - "moduleName": "货主-仓库签约模块", - "moduleKey": "storeWarehouse.store", - "moduleFolder": "storewarehouse.store", - "method": "storeWarehouse.store.saveApiConfig", - "title": "新增或更新签约关系下的接口配置。QM_WMS 类型须填写奇门字段;OPEN_API 类型由系统自动生成 self_app_key 和 self_app_secret", - "description": "新增或更新签约关系下的接口配置。QM_WMS 类型须填写奇门字段;OPEN_API 类型由系统自动生成 self_app_key 和 self_app_secret", - "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": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - }, - { - "name": "interface_type_id", - "type": "number", - "required": true, - "description": "接口类型ID,必须是 wms_interface_type 已存在的类型" - }, - { - "name": "qimen_app_key", - "type": "string", - "required": false, - "description": "奇门 AppKey(QM_WMS 类型必填,OPEN_API 类型不需要)" - }, - { - "name": "qimen_customer_id", - "type": "string", - "required": false, - "description": "奇门客户ID(QM_WMS 类型必填,OPEN_API 类型不需要)" - }, - { - "name": "qimen_warehouse_code", - "type": "string", - "required": false, - "description": "奇门仓库编码(QM_WMS 类型必填,OPEN_API 类型不需要)" - }, - { - "name": "app_name", - "type": "string", - "required": true, - "description": "应用名称" - }, - { - "name": "callback_url", - "type": "string", - "required": false, - "description": "API 回调通知 URL(可选),最大 500 字符;配置后订单状态变更时将回调通知推送到此地址;兼容别名 callbackUrl" - } - ], - "response": [] - }, - { - "moduleName": "货主-仓库签约模块", - "moduleKey": "storeWarehouse.store", - "moduleFolder": "storewarehouse.store", - "method": "storeWarehouse.store.savePolicyConfig", - "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": "id", - "type": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - }, - { - "name": "policy_config", - "type": "object", - "required": true, - "description": "策略配置对象;支持 receive_mode、auto_allocate_bin、auto_allocate_express(是否自动分配快递)、auto_allocate_storage(是否自动分配储位)、allow_mix_batch、allow_temp_storage、storage_separation、print_recharge_price(面单充值元/单,支持 2 位小数)、max_daily_inbound、remark、waybill_custom_display_type(面单自定义显示类型:1=隐藏,2=商品名称和数量,3=拣货库位和条码和数量,4=拣货库位和条码后5位和数量,5=拣货库位商品名称条码和数量)、enable_external_express_code(是否启用外部快递编码,flag:0=关闭,1=开启;默认 0)" - }, - { - "name": "policy_config.enable_external_express_code", - "type": "number", - "required": false, - "description": "是否启用外部快递编码(flag:0=关闭,1=开启;默认 0)" - } - ], - "response": [ - { - "name": "data.contract_id", - "type": "number", - "required": true, - "description": "签约关系ID" - }, - { - "name": "data.policy_config", - "type": "object", - "required": true, - "description": "保存后并补齐默认值的策略配置对象" - }, - { - "name": "data.policy_config.enable_external_express_code", - "type": "number", - "required": true, - "description": "是否启用外部快递编码(flag:0=关闭,1=开启;默认 0)" - } - ] - }, - { - "moduleName": "货主-仓库签约模块", - "moduleKey": "storeWarehouse.store", - "moduleFolder": "storewarehouse.store", - "method": "storeWarehouse.store.sign", - "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": "store_id", - "type": "number", - "required": false, - "description": "货主ID;由仓库侧发起时必传" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "仓库ID;由货主侧发起时必传" - }, - { - "name": "temp_code", - "type": "string", - "required": false, - "description": "临时签约码;传入后进入确认或预览流程" - } - ], - "response": [] - }, - { - "moduleName": "货主-仓库签约模块", - "moduleKey": "storeWarehouse.store", - "moduleFolder": "storewarehouse.store", - "method": "storeWarehouse.store.unbind", - "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": "id", - "type": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - }, - { - "name": "use_status", - "type": "number", - "required": false, - "description": "使用状态,0=停用,1=恢复" - } - ], - "response": [] - }, - { - "moduleName": "用户模块", - "moduleKey": "user", - "moduleFolder": "user", - "method": "user.changeRole", - "title": "user.changeRole 接口", - "description": "user.changeRole 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "用户模块", - "moduleKey": "user", - "moduleFolder": "user", - "method": "user.getBindWechatCode", - "title": "获取微信绑定码(默认立即返回;显式开启长轮询后,最长等待60秒,状态变化立即返回)", - "description": "获取微信绑定码(默认立即返回;显式开启长轮询后,最长等待60秒,状态变化立即返回)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "forceRefresh", - "type": "boolean", - "required": false, - "description": "是否强制刷新状态,true 时跳过缓存等待窗口" - }, - { - "name": "waitForChange", - "type": "boolean", - "required": false, - "description": "是否显式开启长轮询等待(推荐字段);true 时进入最长60秒等待" - }, - { - "name": "longPoll", - "type": "boolean", - "required": false, - "description": "长轮询开关(兼容字段);true 时进入最长60秒等待" - }, - { - "name": "waitTimeoutMs", - "type": "number", - "required": false, - "description": "等待超时毫秒数;后端自动封顶60000" - }, - { - "name": "init", - "type": "boolean", - "required": false, - "description": "初始化请求标记;true 时强制立即返回,不进入长等待" - } - ], - "response": [] - }, - { - "moduleName": "用户模块", - "moduleKey": "user", - "moduleFolder": "user", - "method": "user.getLoginWechatCode", - "title": "获取微信扫码登录码(无 clientCode 时分配新客户端编码;有 clientCode 时可长轮询刷新)", - "description": "获取微信扫码登录码(无 clientCode 时分配新客户端编码;有 clientCode 时可长轮询刷新)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "clientCode", - "type": "string", - "required": false, - "description": "客户端编码;首次可不传,后续轮询建议透传已有值" - } - ], - "response": [] - }, - { - "moduleName": "用户模块", - "moduleKey": "user", - "moduleFolder": "user", - "method": "user.info", - "title": "获取当前用户信息", - "description": "获取当前用户信息", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "用户模块", - "moduleKey": "user", - "moduleFolder": "user", - "method": "user.login", - "title": "用户登录(仅返回 token)", - "description": "用户登录(仅返回 token)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "password", - "type": "string", - "required": false, - "description": "password 参数" - }, - { - "name": "username", - "type": "string", - "required": false, - "description": "username 参数" - } - ], - "response": [] - }, - { - "moduleName": "用户模块", - "moduleKey": "user", - "moduleFolder": "user", - "method": "user.loginByCode", - "title": "登录码登录(使用 ye4s_user.tmp_code)", - "description": "登录码登录(使用 ye4s_user.tmp_code)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "code", - "type": "string", - "required": true, - "description": "登录码,对应 ye4s_user.tmp_code" - } - ], - "response": [] - }, - { - "moduleName": "用户模块", - "moduleKey": "user", - "moduleFolder": "user", - "method": "user.logout", - "title": "用户登出", - "description": "用户登出", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "用户模块", - "moduleKey": "user", - "moduleFolder": "user", - "method": "user.register", - "title": "user.register 接口", - "description": "user.register 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [], - "response": [] - }, - { - "moduleName": "用户模块", - "moduleKey": "user", - "moduleFolder": "user", - "method": "user.unbindWechat", - "title": "解绑微信账号(清理 ye4s 关联账号数据)", - "description": "解绑微信账号(清理 ye4s 关联账号数据)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.batchUpdateSpaceInfo", - "title": "按导出模板批量修改货架仓位信息,任一行越界或冲突则整批失败。前端提交示例:{ id: 36, items: [ { space_code: 'A01-01-01', custom_name: '拣货位1', custom_barcode: 'PICK-001', pick_sequence: 10, location_type_id: 3 } ] }。其中 id 为货架ID(可选,传入时只允许操作该货架下的仓位),space_code 为必填定位键,location_type_id 为仓位类型主键(可通过 index.getLocationTypeList 获取)。", - "description": "按导出模板批量修改货架仓位信息,任一行越界或冲突则整批失败。前端提交示例:{ id: 36, items: [ { space_code: 'A01-01-01', custom_name: '拣货位1', custom_barcode: 'PICK-001', pick_sequence: 10, location_type_id: 3 } ] }。其中 id 为货架ID(可选,传入时只允许操作该货架下的仓位),space_code 为必填定位键,location_type_id 为仓位类型主键(可通过 index.getLocationTypeList 获取)。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": false, - "description": "货架ID,传入时校验所有 space_code 必须属于该货架,不传则只校验属于任意货架类型库位" - }, - { - "name": "items", - "type": "array", - "required": true, - "description": "批量修改数据数组;每项支持字段:space_code、custom_name、custom_barcode、pick_sequence、location_type_name" - }, - { - "name": "items[].space_code", - "type": "string", - "required": true, - "description": "仓位编码,作为批量修改的唯一定位键;缺失、重复或不存在都会整批失败" - }, - { - "name": "items[].custom_name", - "type": "string", - "required": false, - "description": "自定义名称,空字符串会被清空" - }, - { - "name": "items[].custom_barcode", - "type": "string", - "required": false, - "description": "自定义条码,批次内或系统内冲突都会整批失败;空字符串会被清空" - }, - { - "name": "items[].pick_sequence", - "type": "number", - "required": false, - "description": "拣货顺序,必须为非负整数,超出边界则整批失败" - }, - { - "name": "items[].location_type_id", - "type": "number", - "required": false, - "description": "仓位类型ID,必须为正整数且在当前仓库或全局类型中存在(is_active=true),否则整批失败;传 null 或不传则不修改仓位类型" - } - ], - "response": [ - { - "name": "count", - "type": "number", - "required": false, - "description": "成功更新的记录数" - } - ] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.checkBarcodeUnique", - "title": "warehouse.checkBarcodeUnique 接口", - "description": "warehouse.checkBarcodeUnique 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "barcode", - "type": "string", - "required": true, - "description": "barcode 参数" - }, - { - "name": "id", - "type": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.create", - "title": "warehouse.create 接口", - "description": "warehouse.create 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.createRackWithSpaces", - "title": "warehouse.createRackWithSpaces 接口", - "description": "warehouse.createRackWithSpaces 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.delete", - "title": "warehouse.delete 接口", - "description": "warehouse.delete 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.detail", - "title": "warehouse.detail 接口", - "description": "warehouse.detail 接口", - "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": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.exportRackSpaces", - "title": "按货架ID导出仓位模板(含仓库编码、仓位编码、自定义名称、自定义条码、拣货顺序、仓位类型)", - "description": "按货架ID导出仓位模板(含仓库编码、仓位编码、自定义名称、自定义条码、拣货顺序、仓位类型)", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "货架ID,仅导出该货架下仓位" - } - ], - "response": [ - { - "name": "count", - "type": "number", - "required": false, - "description": "导出记录数" - }, - { - "name": "fileName", - "type": "string", - "required": false, - "description": "导出文件名" - }, - { - "name": "fileUrl", - "type": "string", - "required": false, - "description": "导出文件下载地址" - } - ] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.getAreaRacks", - "title": "warehouse.getAreaRacks 接口", - "description": "warehouse.getAreaRacks 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "area_id", - "type": "number", - "required": true, - "description": "area_id 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.getChildren", - "title": "warehouse.getChildren 接口", - "description": "warehouse.getChildren 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "zoneId", - "type": "number", - "required": true, - "description": "zoneId 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.getPath", - "title": "warehouse.getPath 接口", - "description": "warehouse.getPath 接口", - "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": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.getPickPath", - "title": "warehouse.getPickPath 接口", - "description": "warehouse.getPickPath 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "warehouse_id 参数" - }, - { - "name": "include_spaces", - "type": "string", - "required": false, - "description": "include_spaces 参数" - }, - { - "name": "limit", - "type": "number", - "required": false, - "description": "limit 参数" - }, - { - "name": "sort_by", - "type": "string", - "required": false, - "description": "sort_by 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.getSpaceInfo", - "title": "warehouse.getSpaceInfo 接口", - "description": "warehouse.getSpaceInfo 接口", - "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": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.getSpacesByRack", - "title": "warehouse.getSpacesByRack 接口", - "description": "warehouse.getSpacesByRack 接口", - "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": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.getWarehouseTree", - "title": "warehouse.getWarehouseTree 接口", - "description": "warehouse.getWarehouseTree 接口", - "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": true, - "description": "warehouseId 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.getWarehouseZones", - "title": "warehouse.getWarehouseZones 接口", - "description": "warehouse.getWarehouseZones 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.recalculatePickPath", - "title": "warehouse.recalculatePickPath 接口", - "description": "warehouse.recalculatePickPath 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "warehouse_id 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.toggleActive", - "title": "warehouse.toggleActive 接口", - "description": "warehouse.toggleActive 接口", - "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": "number", - "required": true, - "description": "id 参数" - }, - { - "name": "isActive", - "type": "string", - "required": false, - "description": "isActive 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.update", - "title": "warehouse.update 接口", - "description": "warehouse.update 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "id 参数" - }, - { - "name": "aisles", - "type": "string", - "required": false, - "description": "aisles 参数" - }, - { - "name": "cell_height", - "type": "string", - "required": false, - "description": "cell_height 参数" - }, - { - "name": "cell_length", - "type": "string", - "required": false, - "description": "cell_length 参数" - }, - { - "name": "cell_width", - "type": "string", - "required": false, - "description": "cell_width 参数" - }, - { - "name": "direction", - "type": "string", - "required": false, - "description": "direction 参数" - }, - { - "name": "height", - "type": "number", - "required": false, - "description": "height 参数" - }, - { - "name": "is_active", - "type": "boolean", - "required": false, - "description": "是否启用,支持 true/false 或 1/0" - }, - { - "name": "length", - "type": "number", - "required": false, - "description": "length 参数" - }, - { - "name": "rack_columns", - "type": "string", - "required": false, - "description": "rack_columns 参数" - }, - { - "name": "rack_levels", - "type": "string", - "required": false, - "description": "rack_levels 参数" - }, - { - "name": "rack_rows", - "type": "string", - "required": false, - "description": "rack_rows 参数" - }, - { - "name": "width", - "type": "number", - "required": false, - "description": "width 参数" - }, - { - "name": "x", - "type": "number", - "required": false, - "description": "x 参数" - }, - { - "name": "y", - "type": "number", - "required": false, - "description": "y 参数" - }, - { - "name": "z", - "type": "number", - "required": false, - "description": "z 参数" - }, - { - "name": "zone_code", - "type": "string", - "required": false, - "description": "zone_code 参数" - }, - { - "name": "zone_name", - "type": "string", - "required": false, - "description": "zone_name 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.updateNeighbors", - "title": "warehouse.updateNeighbors 接口", - "description": "warehouse.updateNeighbors 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "warehouse_id 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.updateRackPosition", - "title": "warehouse.updateRackPosition 接口", - "description": "warehouse.updateRackPosition 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "x", - "type": "number", - "required": true, - "description": "x 参数" - }, - { - "name": "y", - "type": "number", - "required": true, - "description": "y 参数" - }, - { - "name": "rack_id", - "type": "number", - "required": false, - "description": "rack_id 参数" - }, - { - "name": "z", - "type": "number", - "required": false, - "description": "z 参数" - } - ], - "response": [] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "moduleFolder": "warehouse", - "method": "warehouse.updateSpaceInfo", - "title": "warehouse.updateSpaceInfo 接口", - "description": "warehouse.updateSpaceInfo 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "id 参数" - }, - { - "name": "custom_barcode", - "type": "string", - "required": false, - "description": "custom_barcode 参数" - }, - { - "name": "custom_name", - "type": "string", - "required": false, - "description": "custom_name 参数" - }, - { - "name": "location_type_id", - "type": "number", - "required": false, - "description": "location_type_id 参数" - }, - { - "name": "pick_sequence", - "type": "string", - "required": false, - "description": "pick_sequence 参数" - }, - { - "name": "space_status", - "type": "string", - "required": false, - "description": "space_status 参数" - } - ], - "response": [] - } - ] -} diff --git a/workflows/api-doc-system/data/module-list/module-list.json b/workflows/api-doc-system/data/module-list/module-list.json deleted file mode 100644 index eb19886b..00000000 --- a/workflows/api-doc-system/data/module-list/module-list.json +++ /dev/null @@ -1,1396 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "moduleCount": 42, - "totalInterfaceCount": 322, - "changes": { - "summary": { - "moduleAdded": 0, - "moduleDeleted": 0, - "moduleUpdated": 2, - "interfaceAdded": 1, - "interfaceDeleted": 0, - "interfaceParamsUpdated": 0, - "interfaceResponseUpdated": 2 - }, - "moduleUpdates": { - "added": [], - "deleted": [], - "updated": [ - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "folder": "storage_receiving", - "previousModuleName": "收货单模块", - "previousModuleKey": "storage_receiving", - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [ - "storage.receiving.getAvailableInboundQuantity" - ] - } - }, - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "folder": "storage.entry", - "previousModuleName": "入库单模块", - "previousModuleKey": "storage.entry", - "interfaceChanges": { - "addedMethods": [ - "storage.entry.unbindReceivingDetails" - ], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [ - "storage.entry.get" - ] - } - } - ] - }, - "interfaceUpdates": { - "added": [ - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "folder": "storage.entry", - "method": "storage.entry.unbindReceivingDetails" - } - ], - "deleted": [], - "paramsUpdated": [], - "responseUpdated": [ - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "folder": "storage_receiving", - "method": "storage.receiving.getAvailableInboundQuantity" - }, - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "folder": "storage.entry", - "method": "storage.entry.get" - } - ] - } - }, - "modules": [ - { - "moduleName": "包材管理模块", - "moduleKey": "setting.packageMaterial", - "folder": "setting.packagematerial", - "interfaceCount": 6, - "interfaces": [ - { - "method": "setting.packageMaterial.create" - }, - { - "method": "setting.packageMaterial.update" - }, - { - "method": "setting.packageMaterial.delete" - }, - { - "method": "setting.packageMaterial.get" - }, - { - "method": "setting.packageMaterial.list" - }, - { - "method": "setting.packageMaterial.search" - } - ] - }, - { - "moduleName": "仓库模块", - "moduleKey": "warehouse", - "folder": "warehouse", - "interfaceCount": 21, - "interfaces": [ - { - "method": "warehouse.getWarehouseZones" - }, - { - "method": "warehouse.getWarehouseTree" - }, - { - "method": "warehouse.getChildren" - }, - { - "method": "warehouse.create" - }, - { - "method": "warehouse.update" - }, - { - "method": "warehouse.delete" - }, - { - "method": "warehouse.detail" - }, - { - "method": "warehouse.checkBarcodeUnique" - }, - { - "method": "warehouse.toggleActive" - }, - { - "method": "warehouse.getPath" - }, - { - "method": "warehouse.getPickPath" - }, - { - "method": "warehouse.updateRackPosition" - }, - { - "method": "warehouse.recalculatePickPath" - }, - { - "method": "warehouse.updateNeighbors" - }, - { - "method": "warehouse.getAreaRacks" - }, - { - "method": "warehouse.getSpacesByRack" - }, - { - "method": "warehouse.createRackWithSpaces" - }, - { - "method": "warehouse.exportRackSpaces" - }, - { - "method": "warehouse.batchUpdateSpaceInfo" - }, - { - "method": "warehouse.getSpaceInfo" - }, - { - "method": "warehouse.updateSpaceInfo" - } - ] - }, - { - "moduleName": "仓库设置模块", - "moduleKey": "setting.warehouse", - "folder": "setting.warehouse", - "interfaceCount": 3, - "interfaces": [ - { - "method": "setting.warehouse.getSettings" - }, - { - "method": "setting.warehouse.getFieldMeta" - }, - { - "method": "setting.warehouse.saveSettings" - } - ] - }, - { - "moduleName": "出库单模块", - "moduleKey": "storage.stockout", - "folder": "storage.stockout", - "interfaceCount": 3, - "interfaces": [ - { - "method": "storage.stockout.list" - }, - { - "method": "storage.stockout.toOrder" - }, - { - "method": "storage.stockout.listItems" - } - ] - }, - { - "moduleName": "打印机站点模块", - "moduleKey": "printer.station", - "folder": "printer.station", - "interfaceCount": 1, - "interfaces": [ - { - "method": "printer.station.list" - } - ] - }, - { - "moduleName": "打印模板模块", - "moduleKey": "setting.printTemplate", - "folder": "setting.printtemplate", - "interfaceCount": 5, - "interfaces": [ - { - "method": "setting.printTemplate.list" - }, - { - "method": "setting.printTemplate.save" - }, - { - "method": "setting.printTemplate.create" - }, - { - "method": "setting.printTemplate.delete" - }, - { - "method": "setting.printTemplate.listTemplatesByType" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "order.print", - "folder": "order.print", - "interfaceCount": 4, - "interfaces": [ - { - "method": "order.print.getWavePrintData" - }, - { - "method": "order.print.getWavePlatformPrintData" - }, - { - "method": "order.print.unlockWavePlatformPrintDataByGroup" - }, - { - "method": "order.print.getOrderPrintData" - } - ] - }, - { - "moduleName": "打印模块", - "moduleKey": "print", - "folder": "print", - "interfaceCount": 15, - "interfaces": [ - { - "method": "print.send" - }, - { - "method": "print.getPrintResult" - }, - { - "method": "print.getPrintRecordItem" - }, - { - "method": "print.getList" - }, - { - "method": "print.getItem" - }, - { - "method": "print.add" - }, - { - "method": "print.hasName" - }, - { - "method": "print.updateItem" - }, - { - "method": "print.del" - }, - { - "method": "print.getComputer" - }, - { - "method": "print.getComputerPrinter" - }, - { - "method": "print.savePrinters" - }, - { - "method": "print.retryFailed" - }, - { - "method": "print.notifyLock" - }, - { - "method": "print.notify_lock" - } - ] - }, - { - "moduleName": "店铺模块", - "moduleKey": "shops", - "folder": "shops", - "interfaceCount": 5, - "interfaces": [ - { - "method": "shops.list" - }, - { - "method": "shops.add" - }, - { - "method": "shops.del" - }, - { - "method": "shops.edit" - }, - { - "method": "shops.GetAuthorizeSessionKey" - } - ] - }, - { - "moduleName": "订单波次模块", - "moduleKey": "order.wave", - "folder": "order.wave", - "interfaceCount": 29, - "interfaces": [ - { - "method": "order.wave.waveStrategyList" - }, - { - "method": "order.wave.waveStrategyCreate" - }, - { - "method": "order.wave.waveStrategyUpdate" - }, - { - "method": "order.wave.waveStrategyQuickScan" - }, - { - "method": "order.wave.waveStrategyFetchPda" - }, - { - "method": "order.wave.waveStrategyFetchAdmin" - }, - { - "method": "order.wave.waveStrategyQuickScanTaskProgress" - }, - { - "method": "order.wave.groupOrderFetchList" - }, - { - "method": "order.wave.singleFetchByIds" - }, - { - "method": "order.wave.waveStrategyFallbackOrderList" - }, - { - "method": "order.wave.singleOrderFetchList" - }, - { - "method": "order.wave.wavePickTaskList" - }, - { - "method": "order.wave.wavePickTaskCancel" - }, - { - "method": "order.wave.wavePickTaskCancelSelf" - }, - { - "method": "order.wave.batchCancel" - }, - { - "method": "order.wave.batchCancelTaskProgress" - }, - { - "method": "order.wave.batchAllocateExpress" - }, - { - "method": "order.wave.batchAllocateExpressTaskProgress" - }, - { - "method": "order.wave.batchRemoveExceptionOrders" - }, - { - "method": "order.wave.batchRemoveExceptionOrdersTaskProgress" - }, - { - "method": "order.wave.batchAllocateStorage" - }, - { - "method": "order.wave.batchAllocateStorageTaskProgress" - }, - { - "method": "order.wave.groupFetch" - }, - { - "method": "order.wave.singleFetch" - }, - { - "method": "order.wave.fetch" - }, - { - "method": "order.wave.fetchTaskProgress" - }, - { - "method": "order.wave.batchAutoGrouping" - }, - { - "method": "order.wave.batchFinishAutoGrouping" - }, - { - "method": "order.wave.batchRemoveOrders" - } - ] - }, - { - "moduleName": "订单待出库模块", - "moduleKey": "order.outboundOrder", - "folder": "order.outboundorder", - "interfaceCount": 3, - "interfaces": [ - { - "method": "order.outboundOrder.list" - }, - { - "method": "order.outboundOrder.detail" - }, - { - "method": "order.outboundOrder.manualOutboundOrder" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order.pendingOrder", - "folder": "order.pendingorder", - "interfaceCount": 25, - "interfaces": [ - { - "method": "order.pendingOrder.list" - }, - { - "method": "order.pendingOrder.detail" - }, - { - "method": "order.pendingOrder.reverseReviewOrder" - }, - { - "method": "order.pendingOrder.markPendingOutboundOrder" - }, - { - "method": "order.pendingOrder.cancelOrder" - }, - { - "method": "order.pendingOrder.allocateExpressCode" - }, - { - "method": "order.pendingOrder.allocateStorage" - }, - { - "method": "order.pendingOrder.allocateStorageProgress" - }, - { - "method": "order.pendingOrder.syncOrderIds" - }, - { - "method": "order.pendingOrder.cancelAllocateStorage" - }, - { - "method": "order.pendingOrder.updateOrderPlatform" - }, - { - "method": "order.pendingOrder.updateOrderExpress" - }, - { - "method": "order.pendingOrder.cloneOrder" - }, - { - "method": "order.pendingOrder.createOrder" - }, - { - "method": "order.pendingOrder.importOrdersFromExcel" - }, - { - "method": "order.pendingOrder.parseAddress" - }, - { - "method": "order.pendingOrder.updateAddress" - }, - { - "method": "order.pendingOrder.batchIntercept" - }, - { - "method": "order.pendingOrder.batchInterceptTaskProgress" - }, - { - "method": "order.pendingOrder.batchLock" - }, - { - "method": "order.pendingOrder.batchLockTaskProgress" - }, - { - "method": "order.pendingOrder.batchUnlock" - }, - { - "method": "order.pendingOrder.batchUnlockTaskProgress" - }, - { - "method": "order.pendingOrder.batchUnintercept" - }, - { - "method": "order.pendingOrder.batchUninterceptTaskProgress" - } - ] - }, - { - "moduleName": "订单待处理模块", - "moduleKey": "order", - "folder": "order", - "interfaceCount": 3, - "interfaces": [ - { - "method": "order.wave.batchList" - }, - { - "method": "order.pendingOrder.downloadCreateTemplate" - }, - { - "method": "order.pendingOrder.manualWaybill" - } - ] - }, - { - "moduleName": "订单待审核模块", - "moduleKey": "order.reviewOrder", - "folder": "order.revieworder", - "interfaceCount": 3, - "interfaces": [ - { - "method": "order.reviewOrder.list" - }, - { - "method": "order.reviewOrder.detail" - }, - { - "method": "order.reviewOrder.reviewOrder" - } - ] - }, - { - "moduleName": "订单复核模块", - "moduleKey": "order.recheckOrder", - "folder": "order.recheckorder", - "interfaceCount": 7, - "interfaces": [ - { - "method": "order.recheckOrder.scanOrder" - }, - { - "method": "order.recheckOrder.confirmRecheck" - }, - { - "method": "order.recheckOrder.confirmIntercept" - }, - { - "method": "order.recheckOrder.recheckOrderList" - }, - { - "method": "order.recheckOrder.scanTask" - }, - { - "method": "order.recheckOrder.batchQuickRecheck" - }, - { - "method": "order.recheckOrder.queryRecheckOrderSingleList" - } - ] - }, - { - "moduleName": "订单工作台入口模块", - "moduleKey": "order.index", - "folder": "order.index", - "interfaceCount": 11, - "interfaces": [ - { - "method": "order.list" - }, - { - "method": "order.detail" - }, - { - "method": "order.manualOutboundOrder" - }, - { - "method": "order.badgeCount" - }, - { - "method": "order.queryOrderLogs" - }, - { - "method": "order.queryOrderLogList" - }, - { - "method": "order.updateExpressWeighingWeight" - }, - { - "method": "order.bindExpressPackageMaterial" - }, - { - "method": "order.bindExpressPackageMaterialByWaybill" - }, - { - "method": "order.export" - }, - { - "method": "order.exportTaskProgress" - } - ] - }, - { - "moduleName": "订单归档模块", - "moduleKey": "order.archiveOrder", - "folder": "order.archiveorder", - "interfaceCount": 2, - "interfaces": [ - { - "method": "order.archiveOrder.list" - }, - { - "method": "order.archiveOrder.detail" - } - ] - }, - { - "moduleName": "订单配送模块", - "moduleKey": "order.deliveryOrder", - "folder": "order.deliveryorder", - "interfaceCount": 2, - "interfaces": [ - { - "method": "order.deliveryOrder.list" - }, - { - "method": "order.deliveryOrder.detail" - } - ] - }, - { - "moduleName": "订单配送异常模块", - "moduleKey": "order.deliveryExpectionOrder", - "folder": "order.deliveryexpectionorder", - "interfaceCount": 2, - "interfaces": [ - { - "method": "order.deliveryExpectionOrder.list" - }, - { - "method": "order.deliveryExpectionOrder.detail" - } - ] - }, - { - "moduleName": "订单委托外仓模块", - "moduleKey": "order.entrustOrder", - "folder": "order.entrustorder", - "interfaceCount": 2, - "interfaces": [ - { - "method": "order.entrustOrder.list" - }, - { - "method": "order.entrustOrder.detail" - } - ] - }, - { - "moduleName": "订单异常模块", - "moduleKey": "order.expectionOrder", - "folder": "order.expectionorder", - "interfaceCount": 3, - "interfaces": [ - { - "method": "order.expectionOrder.list" - }, - { - "method": "order.expectionOrder.detail" - }, - { - "method": "order.expectionOrder.resolveException" - } - ] - }, - { - "moduleName": "货主-仓库签约模块", - "moduleKey": "storeWarehouse.store", - "folder": "storewarehouse.store", - "interfaceCount": 13, - "interfaces": [ - { - "method": "storeWarehouse.store.list" - }, - { - "method": "storeWarehouse.store.sign" - }, - { - "method": "storeWarehouse.store.rename" - }, - { - "method": "storeWarehouse.store.unbind" - }, - { - "method": "storeWarehouse.store.adjustPrintQuantity" - }, - { - "method": "storeWarehouse.store.queryPrintQuantityLogs" - }, - { - "method": "storeWarehouse.store.getPolicyConfig" - }, - { - "method": "storeWarehouse.store.getPolicyConfigFields" - }, - { - "method": "storeWarehouse.store.savePolicyConfig" - }, - { - "method": "storeWarehouse.store.listApiConfig" - }, - { - "method": "storeWarehouse.store.saveApiConfig" - }, - { - "method": "storeWarehouse.store.deleteQimenConfig" - }, - { - "method": "storeWarehouse.store.openAccount" - } - ] - }, - { - "moduleName": "基础模块", - "moduleKey": "index", - "folder": "index", - "interfaceCount": 21, - "interfaces": [ - { - "method": "index.fastWhereTree" - }, - { - "method": "index.loadStores" - }, - { - "method": "index.getCOSUploadConfig" - }, - { - "method": "index.getImages" - }, - { - "method": "index.uploadSuccessNotify" - }, - { - "method": "index.ReferenceFile" - }, - { - "method": "index.getMessageDetail" - }, - { - "method": "index.test" - }, - { - "method": "index.recognizeLicensePlate" - }, - { - "method": "index.getI18nMessage" - }, - { - "method": "index.putI18nCollect" - }, - { - "method": "index.tryAutoTranslateNewKeys" - }, - { - "method": "index.searchSpace" - }, - { - "method": "index.listInterfaceTypes" - }, - { - "method": "index.getLocationTypeList" - }, - { - "method": "index.getPlatformOauthLink" - }, - { - "method": "index.getShopList" - }, - { - "method": "index.getShopExpressList" - }, - { - "method": "index.getCainiaoStfTemplates" - }, - { - "method": "index.getPrintPlatformTemplateList" - }, - { - "method": "index.polyapiAuthorizeUrl" - } - ] - }, - { - "moduleName": "拣货车模块", - "moduleKey": "pickCart", - "folder": "pickcart", - "interfaceCount": 8, - "interfaces": [ - { - "method": "pickCart.scan" - }, - { - "method": "pickCart.bindTaskCart" - }, - { - "method": "pickCart.create" - }, - { - "method": "pickCart.update" - }, - { - "method": "pickCart.delete" - }, - { - "method": "pickCart.detail" - }, - { - "method": "pickCart.list" - }, - { - "method": "pickCart.codeDuplicateCheck" - } - ] - }, - { - "moduleName": "拣货模块", - "moduleKey": "pick", - "folder": "pick", - "interfaceCount": 4, - "interfaces": [ - { - "method": "pick.query" - }, - { - "method": "pick.wavePickTaskDetail" - }, - { - "method": "pick.wavePickTaskSubmit" - }, - { - "method": "pick.wavePickTaskComplete" - } - ] - }, - { - "moduleName": "角色管理模块", - "moduleKey": "setting.role", - "folder": "setting.role", - "interfaceCount": 5, - "interfaces": [ - { - "method": "setting.role.list" - }, - { - "method": "setting.role.permission" - }, - { - "method": "setting.role.add" - }, - { - "method": "setting.role.update" - }, - { - "method": "setting.role.delete" - } - ] - }, - { - "moduleName": "看板模块", - "moduleKey": "dashboard", - "folder": "dashboard", - "interfaceCount": 6, - "interfaces": [ - { - "method": "dashboard.storeStats" - }, - { - "method": "dashboard.warehouseStats" - }, - { - "method": "dashboard.hot_order_rank" - }, - { - "method": "dashboard.express_ratio" - }, - { - "method": "dashboard.platform_distribution" - }, - { - "method": "dashboard.order_trend" - } - ] - }, - { - "moduleName": "库存报表模块", - "moduleKey": "storage.report", - "folder": "storage.report", - "interfaceCount": 3, - "interfaces": [ - { - "method": "storage.report.search" - }, - { - "method": "storage.report.export" - }, - { - "method": "storage.report.exportTaskProgress" - } - ] - }, - { - "moduleName": "库存操作模块", - "moduleKey": "storage.inventory", - "folder": "storage.inventory", - "interfaceCount": 7, - "interfaces": [ - { - "method": "storage.inventory.quickPutaway" - }, - { - "method": "storage.inventory.matchPutaway" - }, - { - "method": "storage.inventory.transferLocation" - }, - { - "method": "storage.inventory.transferByProduct" - }, - { - "method": "storage.inventory.list" - }, - { - "method": "storage.expiry.list" - }, - { - "method": "storage.transaction.list" - } - ] - }, - { - "moduleName": "库存管理模块", - "moduleKey": "storage.management", - "folder": "storage.management", - "interfaceCount": 1, - "interfaces": [ - { - "method": "storage.management.replenishmentDemand" - } - ] - }, - { - "moduleName": "快递编码管理模块", - "moduleKey": "setting.express", - "folder": "setting.express", - "interfaceCount": 7, - "interfaces": [ - { - "method": "index.getExpressList" - }, - { - "method": "setting.express.list" - }, - { - "method": "setting.express.listBase" - }, - { - "method": "setting.express.create" - }, - { - "method": "setting.express.checkCodeUnique" - }, - { - "method": "setting.express.update" - }, - { - "method": "setting.express.delete" - } - ] - }, - { - "moduleName": "快递接口管理模块", - "moduleKey": "setting.expressInterface", - "folder": "setting.expressinterface", - "interfaceCount": 6, - "interfaces": [ - { - "method": "setting.expressInterface.list" - }, - { - "method": "setting.expressInterface.listByWarehousePlatformCode" - }, - { - "method": "setting.expressInterface.create" - }, - { - "method": "setting.expressInterface.update" - }, - { - "method": "setting.expressInterface.delete" - }, - { - "method": "index.getPrintPlatformList" - } - ] - }, - { - "moduleName": "配置模块", - "moduleKey": "config", - "folder": "config", - "interfaceCount": 1, - "interfaces": [ - { - "method": "config.list" - } - ] - }, - { - "moduleName": "平台编码管理模块", - "moduleKey": "setting.platform", - "folder": "setting.platform", - "interfaceCount": 5, - "interfaces": [ - { - "method": "index.getPlatformList" - }, - { - "method": "setting.platform.list" - }, - { - "method": "setting.platform.create" - }, - { - "method": "setting.platform.update" - }, - { - "method": "setting.platform.delete" - } - ] - }, - { - "moduleName": "权限管理模块", - "moduleKey": "setting.permission", - "folder": "setting.permission", - "interfaceCount": 4, - "interfaces": [ - { - "method": "setting.permission.list" - }, - { - "method": "setting.permission.add" - }, - { - "method": "setting.permission.update" - }, - { - "method": "setting.permission.delete" - } - ] - }, - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "folder": "storage.entry", - "interfaceCount": 6, - "interfaces": [ - { - "method": "storage.entry.list" - }, - { - "method": "storage.entry.get" - }, - { - "method": "storage.entry.cancel" - }, - { - "method": "storage.entry.completeEntry" - }, - { - "method": "storage.entry.bindReceivingDetails" - }, - { - "method": "storage.entry.unbindReceivingDetails" - } - ] - }, - { - "moduleName": "商品模块", - "moduleKey": "stock", - "folder": "stock", - "interfaceCount": 25, - "interfaces": [ - { - "method": "stock.warehouse.list" - }, - { - "method": "stock.warehouse.export" - }, - { - "method": "stock.warehouse.exportTaskProgress" - }, - { - "method": "stock.warehouse.getProhibitedType" - }, - { - "method": "stock.warehouse.getInfo" - }, - { - "method": "stock.warehouse.getStockDetail" - }, - { - "method": "stock.warehouse.saveWarehouseStock" - }, - { - "method": "stock.warehouse.createWarehouseStock" - }, - { - "method": "stock.warehouse.import" - }, - { - "method": "stock.warehouse.getBarcodes" - }, - { - "method": "stock.warehouse.saveWarehouseStockBarcode" - }, - { - "method": "stock.warehouse.getStoreStocks" - }, - { - "method": "stock.warehouse.bindItem" - }, - { - "method": "stock.warehouse.unbindItem" - }, - { - "method": "stock.warehouse.checkItemCodeUnique" - }, - { - "method": "stock.warehouse.queryStockLogs" - }, - { - "method": "stock.warehouse.handleBatchDelete" - }, - { - "method": "stock.warehouse.deleteUnit" - }, - { - "method": "stock.warehouse.deleteProhibited" - }, - { - "method": "stock.warehouse.handleBatchChange" - }, - { - "method": "stock.warehouse.getStockUnits" - }, - { - "method": "stock.warehouse.getUnitList" - }, - { - "method": "stock.warehouse.createProhibited" - }, - { - "method": "stock.warehouse.createUnit" - }, - { - "method": "stock.warehouse.search" - } - ] - }, - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "folder": "storage_receiving", - "interfaceCount": 19, - "interfaces": [ - { - "method": "storage.receiving.getReceivingList" - }, - { - "method": "storage.receiving.getReceivingDetail" - }, - { - "method": "storage.receiving.batchCancelReceiving" - }, - { - "method": "storage.receiving.rejectReceiving" - }, - { - "method": "storage.receiving.reviewReceiving" - }, - { - "method": "storage.receiving.create" - }, - { - "method": "storage.receiving.bindStore" - }, - { - "method": "storage.receiving.bindDetailProduct" - }, - { - "method": "storage.receiving.queryReceivingLogs" - }, - { - "method": "storage.receiving.removeItem" - }, - { - "method": "storage.receiving.save" - }, - { - "method": "storage.receiving.get" - }, - { - "method": "storage.receiving.addDetail" - }, - { - "method": "storage.receiving.deleteDetail" - }, - { - "method": "storage.receiving.detailChange" - }, - { - "method": "storage.receiving.cancel" - }, - { - "method": "storage.receiving.completeReceiving" - }, - { - "method": "storage.receiving.manualMatchEntryOrder" - }, - { - "method": "storage.receiving.getAvailableInboundQuantity" - } - ] - }, - { - "moduleName": "用户模块", - "moduleKey": "user", - "folder": "user", - "interfaceCount": 9, - "interfaces": [ - { - "method": "user.login" - }, - { - "method": "user.loginByCode" - }, - { - "method": "user.getLoginWechatCode" - }, - { - "method": "user.getBindWechatCode" - }, - { - "method": "user.unbindWechat" - }, - { - "method": "user.logout" - }, - { - "method": "user.info" - }, - { - "method": "user.changeRole" - }, - { - "method": "user.register" - } - ] - }, - { - "moduleName": "账号管理模块", - "moduleKey": "setting.account", - "folder": "setting.account", - "interfaceCount": 6, - "interfaces": [ - { - "method": "setting.account.list" - }, - { - "method": "setting.account.add" - }, - { - "method": "setting.account.delete" - }, - { - "method": "setting.account.update" - }, - { - "method": "setting.account.getBindWechatCode" - }, - { - "method": "setting.account.unbindWechat" - } - ] - }, - { - "moduleName": "主体模块", - "moduleKey": "store", - "folder": "store", - "interfaceCount": 6, - "interfaces": [ - { - "method": "store.createStore" - }, - { - "method": "store.createWarehouse" - }, - { - "method": "store.joinStore" - }, - { - "method": "store.joinWarehouse" - }, - { - "method": "store.getStoreRoles" - }, - { - "method": "store.auditApply" - } - ] - }, - { - "moduleName": "package-supplier-module", - "moduleKey": "setting.packageSupplier", - "folder": "setting.packagesupplier", - "interfaceCount": 5, - "interfaces": [ - { - "method": "setting.packageSupplier.create" - }, - { - "method": "setting.packageSupplier.update" - }, - { - "method": "setting.packageSupplier.delete" - }, - { - "method": "setting.packageSupplier.get" - }, - { - "method": "setting.packageSupplier.list" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/config/_module.lifecycle.json b/workflows/api-doc-system/data/module/config/_module.lifecycle.json deleted file mode 100644 index c66580b8..00000000 --- a/workflows/api-doc-system/data/module/config/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "配置模块", - "key": "config", - "folder": "config" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/config/module.json b/workflows/api-doc-system/data/module/config/module.json deleted file mode 100644 index 44cd9ae5..00000000 --- a/workflows/api-doc-system/data/module/config/module.json +++ /dev/null @@ -1,101 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "配置模块", - "key": "config", - "folder": "config", - "interfaceCount": 1 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "config.list", - "title": "config.list 接口", - "description": "config.list 接口", - "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 数组(stock_warehouse.id)" - }, - { - "name": "method", - "type": "string", - "required": true, - "description": "要修改的字段名,可选值:brand_name、prohibited_id、gross_weight、packing_requirements、managementFlags、stock_unit" - }, - { - "name": "value", - "type": "string|number|object", - "required": true, - "description": "修改值,类型依 method 而定:brand_name/packing_requirements/stock_unit 为 string(<=255 字符);prohibited_id 为 number(整数);gross_weight 为 number(正数,可含小数);managementFlags 为 object,必须包含 is_sn_mgmt/is_shelf_life_mgmt/is_batch_mgmt,值为 'Y' 或 'N'" - }, - { - "name": "values", - "type": "any", - "required": false, - "description": "兼容字段:当前实现以 `value` 为准,不使用 `values`。若客户端历史使用 `values`,请切换为 `value`。" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": false, - "description": "业务状态码,200 表示成功;405 表示参数/权限校验不通过;500 表示服务器错误" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "业务提示信息" - }, - { - "name": "data", - "type": "object", - "required": false, - "description": "成功时返回的结果对象" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/dashboard/_module.lifecycle.json b/workflows/api-doc-system/data/module/dashboard/_module.lifecycle.json deleted file mode 100644 index 89d20594..00000000 --- a/workflows/api-doc-system/data/module/dashboard/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "看板模块", - "key": "dashboard", - "folder": "dashboard" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/dashboard/module.json b/workflows/api-doc-system/data/module/dashboard/module.json deleted file mode 100644 index 8ee3e04d..00000000 --- a/workflows/api-doc-system/data/module/dashboard/module.json +++ /dev/null @@ -1,186 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "看板模块", - "key": "dashboard", - "folder": "dashboard", - "interfaceCount": 6 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "dashboard.storeStats", - "title": "dashboard.storeStats 接口", - "description": "dashboard.storeStats 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "dashboard.warehouseStats", - "title": "dashboard.warehouseStats 接口", - "description": "dashboard.warehouseStats 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "dashboard.hot_order_rank", - "title": "dashboard.hot_order_rank 接口", - "description": "dashboard.hot_order_rank 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "dashboard.express_ratio", - "title": "dashboard.express_ratio 接口", - "description": "dashboard.express_ratio 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "dashboard.platform_distribution", - "title": "dashboard.platform_distribution 接口", - "description": "dashboard.platform_distribution 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "dashboard.order_trend", - "title": "订单趋势统计:按小时统计当日订单数与发货数,包含汇总信息(订单总数、发货总数、发货率、峰值时段)。数据来源于真实数据库查询,已废弃旧版 mock 数据。", - "description": "订单趋势统计:按小时统计当日订单数与发货数,包含汇总信息(订单总数、发货总数、发货率、峰值时段)。数据来源于真实数据库查询,已废弃旧版 mock 数据。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token,从中解析 warehouseId(仓库上下文)" - } - ], - "params": [], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,200 表示成功" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "业务提示信息" - }, - { - "name": "data", - "type": "object", - "required": true, - "description": "成功时返回的趋势数据对象" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/index/_module.lifecycle.json b/workflows/api-doc-system/data/module/index/_module.lifecycle.json deleted file mode 100644 index 1820cc71..00000000 --- a/workflows/api-doc-system/data/module/index/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "基础模块", - "key": "index", - "folder": "index" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/index/module.json b/workflows/api-doc-system/data/module/index/module.json deleted file mode 100644 index b3132f3d..00000000 --- a/workflows/api-doc-system/data/module/index/module.json +++ /dev/null @@ -1,866 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "基础模块", - "key": "index", - "folder": "index", - "interfaceCount": 21 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "index.fastWhereTree", - "title": "index.fastWhereTree 接口", - "description": "index.fastWhereTree 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "type", - "type": "string", - "required": false, - "description": "type 参数" - } - ], - "response": [] - }, - { - "method": "index.loadStores", - "title": "index.loadStores 接口", - "description": "index.loadStores 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "index.getCOSUploadConfig", - "title": "index.getCOSUploadConfig 接口", - "description": "index.getCOSUploadConfig 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "data", - "type": "object", - "required": false, - "description": "data 参数" - } - ], - "response": [] - }, - { - "method": "index.getImages", - "title": "index.getImages 接口", - "description": "index.getImages 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "index.uploadSuccessNotify", - "title": "index.uploadSuccessNotify 接口", - "description": "index.uploadSuccessNotify 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "index.ReferenceFile", - "title": "index.ReferenceFile 接口", - "description": "index.ReferenceFile 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "index.getMessageDetail", - "title": "index.getMessageDetail 接口", - "description": "index.getMessageDetail 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "index.test", - "title": "后台专用的拼多多开放平台测试接口,用于传入请求参数并发起真实请求,返回签名后的请求体和接口响应", - "description": "后台专用的拼多多开放平台测试接口,用于传入请求参数并发起真实请求,返回签名后的请求体和接口响应", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "type", - "type": "string", - "required": true, - "description": "拼多多接口名,例如 pdd.order.number.list.get" - }, - { - "name": "bizParams", - "type": "object", - "required": false, - "description": "业务参数对象,会参与签名和请求" - }, - { - "name": "request", - "type": "object", - "required": false, - "description": "bizParams 兼容字段" - }, - { - "name": "accessToken", - "type": "string", - "required": false, - "description": "用户授权令牌" - }, - { - "name": "access_token", - "type": "string", - "required": false, - "description": "accessToken 的下划线命名兼容字段" - }, - { - "name": "dataType", - "type": "string", - "required": false, - "description": "返回格式,默认 JSON" - }, - { - "name": "version", - "type": "string", - "required": false, - "description": "API 版本" - }, - { - "name": "timestamp", - "type": "string|number", - "required": false, - "description": "时间戳,不传则使用当前秒级时间戳" - }, - { - "name": "clientId", - "type": "string", - "required": false, - "description": "覆盖配置中的 client_id" - }, - { - "name": "clientSecret", - "type": "string", - "required": false, - "description": "覆盖配置中的 client_secret" - }, - { - "name": "baseUrl", - "type": "string", - "required": false, - "description": "请求地址,默认拼多多开放平台网关" - }, - { - "name": "headers", - "type": "object", - "required": false, - "description": "额外请求头" - }, - { - "name": "timeout", - "type": "number", - "required": false, - "description": "请求超时时间(毫秒)" - } - ], - "response": [ - { - "name": "requestBody", - "type": "object", - "required": false, - "description": "实际发送到 PDD 网关的请求体,已包含 sign" - }, - { - "name": "response", - "type": "any", - "required": false, - "description": "拼多多接口返回内容" - }, - { - "name": "baseUrl", - "type": "string", - "required": false, - "description": "实际请求地址" - } - ] - }, - { - "method": "index.recognizeLicensePlate", - "title": "识别车牌号码(通过 base64 图片)", - "description": "识别车牌号码(通过 base64 图片)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "base64", - "type": "string", - "required": true, - "description": "base64 图片,支持 data URL 前缀(data:image/...;base64,)或纯 base64 字符串" - }, - { - "name": "imageBase64", - "type": "string", - "required": false, - "description": "兼容字段(同 base64)" - }, - { - "name": "image_base64", - "type": "string", - "required": false, - "description": "兼容字段(同 base64)" - } - ], - "response": [ - { - "name": "licensePlate", - "type": "string", - "required": false, - "description": "识别到的车牌号(对外契约,仅返回该字段)" - } - ] - }, - { - "method": "index.getI18nMessage", - "title": "index.getI18nMessage 接口", - "description": "index.getI18nMessage 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "language", - "type": "string", - "required": false, - "description": "language 参数" - } - ], - "response": [] - }, - { - "method": "index.putI18nCollect", - "title": "index.putI18nCollect 接口", - "description": "index.putI18nCollect 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "keys", - "type": "array", - "required": false, - "description": "keys 参数" - }, - { - "name": "locale", - "type": "string", - "required": false, - "description": "locale 参数" - }, - { - "name": "project", - "type": "string", - "required": false, - "description": "project 参数" - }, - { - "name": "source", - "type": "string", - "required": false, - "description": "source 参数" - } - ], - "response": [] - }, - { - "method": "index.tryAutoTranslateNewKeys", - "title": "index.tryAutoTranslateNewKeys 接口", - "description": "index.tryAutoTranslateNewKeys 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "index.searchSpace", - "title": "按当前仓库上下文搜索库位(使用 ctx.user.store_id;仅在 location_space 表中按 space_code/custom_barcode 搜索)", - "description": "按当前仓库上下文搜索库位(使用 ctx.user.store_id;仅在 location_space 表中按 space_code/custom_barcode 搜索)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "keyword", - "type": "string", - "required": false, - "description": "搜索关键字,对 space_code 和 custom_barcode 做模糊匹配(%keyword%);为空时返回当前仓库下前 50 条" - } - ], - "response": [ - { - "name": "flag", - "type": "string", - "required": false, - "description": "全局调用结果标识,成功时为 success" - }, - { - "name": "code", - "type": "number", - "required": false, - "description": "业务状态码,200 表示成功" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "返回信息" - }, - { - "name": "data", - "type": "array", - "required": false, - "description": "库位数组(最多 50 条),每项包含以下字段" - }, - { - "name": "total", - "type": "number", - "required": false, - "description": "本次返回的记录条数(等于 data.length,≤50)" - } - ] - }, - { - "method": "index.listInterfaceTypes", - "title": "查询可用的接口类型列表(如奇门仓储、开放接口等)", - "description": "查询可用的接口类型列表(如奇门仓储、开放接口等)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [], - "response": [] - }, - { - "method": "index.getLocationTypeList", - "title": "查询库位类型基础列表,优先返回当前仓库下启用的库位类型,同时合并系统公共类型;结果带 300 秒缓存", - "description": "查询库位类型基础列表,优先返回当前仓库下启用的库位类型,同时合并系统公共类型;结果带 300 秒缓存", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [ - { - "name": "list", - "type": "array", - "required": false, - "description": "库位类型列表" - }, - { - "name": "total", - "type": "number", - "required": false, - "description": "返回总数" - } - ] - }, - { - "method": "index.getPlatformOauthLink", - "title": "获取平台授权链接。入参支持 code / platform_code / platformCode,服务端按首个非空值标准化为大写平台编码;会从当前登录上下文读取仓库 ID(ctx.user.store_id),再从 wms_platform.auth_base_url 读取授权基础地址。接口会优先复用当前仓库与平台下 status=0 的未授权记录;若历史 auth_random_code 带有当前配置前缀,则会先去前缀后以裸码回写,当前数据库最终保存的 auth_random_code 为裸码。若无可复用记录则生成新的裸码并写入 wms_shops。返回的 oauth_link 会从配置 platformOauthReservationCodePrefix 读取前缀(本地示例为 xxxxx_),按“前缀 + 平台编码 + '_' + 裸码”生成 state,并将 URL 编码后的 state 直接拼接到平台基础授权链接后,例如 xxxxx_PDD_。当前仅支持已按上述模式配置好的基础授权链接。", - "description": "获取平台授权链接。入参支持 code / platform_code / platformCode,服务端按首个非空值标准化为大写平台编码;会从当前登录上下文读取仓库 ID(ctx.user.store_id),再从 wms_platform.auth_base_url 读取授权基础地址。接口会优先复用当前仓库与平台下 status=0 的未授权记录;若历史 auth_random_code 带有当前配置前缀,则会先去前缀后以裸码回写,当前数据库最终保存的 auth_random_code 为裸码。若无可复用记录则生成新的裸码并写入 wms_shops。返回的 oauth_link 会从配置 platformOauthReservationCodePrefix 读取前缀(本地示例为 xxxxx_),按“前缀 + 平台编码 + '_' + 裸码”生成 state,并将 URL 编码后的 state 直接拼接到平台基础授权链接后,例如 xxxxx_PDD_。当前仅支持已按上述模式配置好的基础授权链接。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "code", - "type": "string", - "required": false, - "description": "平台编码主字段;与 platform_code / platformCode 三选一即可,服务端按 code -> platform_code -> platformCode 顺序取首个非空值并转为大写" - }, - { - "name": "platform_code", - "type": "string", - "required": false, - "description": "平台编码下划线别名" - }, - { - "name": "platformCode", - "type": "string", - "required": false, - "description": "平台编码驼峰别名" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200" - }, - { - "name": "data.platform_code", - "type": "string", - "required": true, - "description": "标准化后的平台编码" - }, - { - "name": "data.oauth_link", - "type": "string", - "required": true, - "description": "基于 wms_platform.auth_base_url 构造的授权链接;实际拼接值为 encodeURIComponent(prefix + platform_code + '_' + rawCode),其中 prefix 来自 platformOauthReservationCodePrefix,rawCode 为数据库 auth_random_code 中保存的裸码。基础授权链接需预先配置为可直接追加 state 值的模式。" - } - ] - }, - { - "method": "index.getShopList", - "title": "获取当前登录仓库下的已授权店铺列表,支持按平台编码可选过滤。仓库上下文来自 ctx.user.store_id;服务端兼容读取 body.platform_code 与 body.platformCode,按该顺序取首个 trim 后非空值作为平台过滤条件。未传平台参数时返回当前登录仓库下全部已授权店铺;传入非空平台编码时仅返回该平台的已授权店铺。结果按 status DESC、updated_at DESC、id DESC 排序,并对敏感字段完成脱敏后返回 data.list。", - "description": "获取当前登录仓库下的已授权店铺列表,支持按平台编码可选过滤。仓库上下文来自 ctx.user.store_id;服务端兼容读取 body.platform_code 与 body.platformCode,按该顺序取首个 trim 后非空值作为平台过滤条件。未传平台参数时返回当前登录仓库下全部已授权店铺;传入非空平台编码时仅返回该平台的已授权店铺。结果按 status DESC、updated_at DESC、id DESC 排序,并对敏感字段完成脱敏后返回 data.list。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "platform_code", - "type": "string", - "required": false, - "description": "平台编码过滤条件;兼容 platformCode。服务端按 platform_code、platformCode 的顺序读取首个值,trim 后非空时仅返回该平台的已授权店铺;未传或为空时返回当前登录仓库下全部已授权店铺。" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "业务提示信息,成功时返回 ok" - }, - { - "name": "data.list", - "type": "array", - "required": true, - "description": "当前登录仓库下按条件过滤后的已授权店铺列表数组;未传平台参数时返回当前仓库全部已授权店铺,传入非空 platform_code/platformCode 时仅返回对应平台店铺。结果按 status DESC、updated_at DESC、id DESC 排序,且 owner_id、access_token、refresh_token、auth_random_code 已按实现规则脱敏。" - } - ] - }, - { - "method": "index.getShopExpressList", - "title": "获取指定店铺的快递签约/电子面单可用列表。接口依赖当前登录仓库上下文 ctx.user.store_id 校验店铺归属;服务端会按店铺所属平台拉取并收敛可用快递列表,统一返回前端消费结构;未接入的平台当前返回空列表。", - "description": "获取指定店铺的快递签约/电子面单可用列表。接口依赖当前登录仓库上下文 ctx.user.store_id 校验店铺归属;服务端会按店铺所属平台拉取并收敛可用快递列表,统一返回前端消费结构;未接入的平台当前返回空列表。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "shop_id", - "type": "string|number", - "required": false, - "description": "店铺 ID;与 shopId 兼容,二选一至少传一个。服务端按 shop_id、shopId 的顺序读取首个非空值。" - }, - { - "name": "shopId", - "type": "string|number", - "required": false, - "description": "店铺 ID 的驼峰兼容字段;当 shop_id 为空时读取该值。" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200。" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "业务提示信息,成功时返回 ok。" - }, - { - "name": "data.shop_id", - "type": "number", - "required": true, - "description": "当前店铺 ID。" - }, - { - "name": "data.platform_code", - "type": "string", - "required": true, - "description": "店铺所属平台编码,返回值按服务端实现转为大写。" - }, - { - "name": "data.list", - "type": "array", - "required": true, - "description": "服务端按店铺所属平台拉取并统一收敛后的快递签约/电子面单可用列表;未接入的平台返回空数组。" - } - ] - }, - { - "method": "index.getCainiaoStfTemplates", - "title": "公共无参查询淘宝菜鸟标准模板列表;服务端调用淘宝开放平台 cainiao.cloudprint.stdtemplates.get,请求地址为 https://eco.taobao.com/router/rest,使用 TOP 公共签名参数。不需要用户授权,不下发 session,不依赖登录态、当前仓库或店铺授权。成功返回 data.platform_code='TB' 与标准模板数组,模板项统一字段为 template_id/template_name/template_url/cp_code/wp_code。", - "description": "公共无参查询淘宝菜鸟标准模板列表;服务端调用淘宝开放平台 cainiao.cloudprint.stdtemplates.get,请求地址为 https://eco.taobao.com/router/rest,使用 TOP 公共签名参数。不需要用户授权,不下发 session,不依赖登录态、当前仓库或店铺授权。成功返回 data.platform_code='TB' 与标准模板数组,模板项统一字段为 template_id/template_name/template_url/cp_code/wp_code。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200。" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "业务提示信息,成功时返回 ok。" - }, - { - "name": "data.platform_code", - "type": "string", - "required": true, - "description": "平台编码,固定返回 TB。" - }, - { - "name": "data.list", - "type": "array", - "required": true, - "description": "菜鸟标准模板列表;来源于 cainiao_cloudprint_stdtemplates_get_response.result.datas[*].standard_templates[*] 的宽松兼容解析结果,按统一字段 template_id/template_name/template_url/cp_code/wp_code 返回。" - } - ] - }, - { - "method": "index.getPrintPlatformTemplateList", - "title": "按打印平台与快递编码查询模板列表。express_code 为必填;接口会先按 platform_code(默认 CAINIAO)定位 wms_express 对应打印平台字段,再以 express_code 过滤可用模板后返回。", - "description": "按打印平台与快递编码查询模板列表。express_code 为必填;接口会先按 platform_code(默认 CAINIAO)定位 wms_express 对应打印平台字段,再以 express_code 过滤可用模板后返回。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "platform_code", - "type": "string", - "required": false, - "description": "打印平台编码(如 CAINIAO);不传默认 CAINIAO,服务端会转为大写。" - }, - { - "name": "express_code", - "type": "string", - "required": true, - "description": "快递编码(必填);服务端会转为大写,并用于按 wms_express 中对应打印平台字段筛选模板。" - } - ], - "response": [ - { - "name": "flag", - "type": "string", - "required": true, - "description": "全局结果标识;成功为 success,失败为 failure。" - }, - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码;成功时为 200。" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "提示信息;成功时为 ok。" - }, - { - "name": "data", - "type": "object", - "required": true, - "description": "返回数据对象。" - } - ] - }, - { - "method": "index.polyapiAuthorizeUrl", - "title": "生成菠萝派授权链接。该接口不接收请求参数,服务端会固定调用 Differ.JH.BuildeAuthorizeUrl,并以内置配置 this.app.config.poloApi.appKey / this.app.config.poloApi.secret 以及当前代码中写死的 callbackUrl=http://39.100.57.68/、state=123456、itemcode=test001 作为上游请求参数,最终将菠萝派接口原始响应包裹后返回。", - "description": "生成菠萝派授权链接。该接口不接收请求参数,服务端会固定调用 Differ.JH.BuildeAuthorizeUrl,并以内置配置 this.app.config.poloApi.appKey / this.app.config.poloApi.secret 以及当前代码中写死的 callbackUrl=http://39.100.57.68/、state=123456、itemcode=test001 作为上游请求参数,最终将菠萝派接口原始响应包裹后返回。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200。" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "业务提示信息,成功时返回 ok。" - }, - { - "name": "data.respone", - "type": "object", - "required": true, - "description": "菠萝派接口 Differ.JH.BuildeAuthorizeUrl 的原始响应对象。字段名按当前实现保持为 respone。" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/order.archiveorder/_deleted.20260417.json b/workflows/api-doc-system/data/module/order.archiveorder/_deleted.20260417.json deleted file mode 100644 index e4e99d2c..00000000 --- a/workflows/api-doc-system/data/module/order.archiveorder/_deleted.20260417.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "folder": "order.archiveorder", - "deletedAt": "2026-04-17 17:28:24", - "reason": "Missing from latest API doc parsing result" -} diff --git a/workflows/api-doc-system/data/module/order.archiveorder/_module.lifecycle.json b/workflows/api-doc-system/data/module/order.archiveorder/_module.lifecycle.json deleted file mode 100644 index 78474d33..00000000 --- a/workflows/api-doc-system/data/module/order.archiveorder/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "订单归档模块", - "key": "order.archiveOrder", - "folder": "order.archiveorder" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": "2026-04-17 19:16:50" -} diff --git a/workflows/api-doc-system/data/module/order.archiveorder/module.json b/workflows/api-doc-system/data/module/order.archiveorder/module.json deleted file mode 100644 index a9d458c7..00000000 --- a/workflows/api-doc-system/data/module/order.archiveorder/module.json +++ /dev/null @@ -1,161 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "订单归档模块", - "key": "order.archiveOrder", - "folder": "order.archiveorder", - "interfaceCount": 2 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "order.archiveOrder.list", - "title": "归档订单列表,使用 history 模型。", - "description": "归档订单列表,使用 history 模型。", - "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 行数据)" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "method": "order.archiveOrder.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": "去重后的运单号字符串数组" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/order.deliveryexpectionorder/_deleted.20260417.json b/workflows/api-doc-system/data/module/order.deliveryexpectionorder/_deleted.20260417.json deleted file mode 100644 index 3d485d69..00000000 --- a/workflows/api-doc-system/data/module/order.deliveryexpectionorder/_deleted.20260417.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "folder": "order.deliveryexpectionorder", - "deletedAt": "2026-04-17 17:28:24", - "reason": "Missing from latest API doc parsing result" -} diff --git a/workflows/api-doc-system/data/module/order.deliveryexpectionorder/_module.lifecycle.json b/workflows/api-doc-system/data/module/order.deliveryexpectionorder/_module.lifecycle.json deleted file mode 100644 index 7ed2ad55..00000000 --- a/workflows/api-doc-system/data/module/order.deliveryexpectionorder/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "订单配送异常模块", - "key": "order.deliveryExpectionOrder", - "folder": "order.deliveryexpectionorder" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": "2026-04-17 19:16:50" -} diff --git a/workflows/api-doc-system/data/module/order.deliveryexpectionorder/module.json b/workflows/api-doc-system/data/module/order.deliveryexpectionorder/module.json deleted file mode 100644 index b2c4a7c1..00000000 --- a/workflows/api-doc-system/data/module/order.deliveryexpectionorder/module.json +++ /dev/null @@ -1,161 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "订单配送异常模块", - "key": "order.deliveryExpectionOrder", - "folder": "order.deliveryexpectionorder", - "interfaceCount": 2 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "order.deliveryExpectionOrder.list", - "title": "配送异常订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m5。", - "description": "配送异常订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m5。", - "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": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "method": "order.deliveryExpectionOrder.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": "去重后的运单号字符串数组" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/order.deliveryorder/_deleted.20260417.json b/workflows/api-doc-system/data/module/order.deliveryorder/_deleted.20260417.json deleted file mode 100644 index 448a75d8..00000000 --- a/workflows/api-doc-system/data/module/order.deliveryorder/_deleted.20260417.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "folder": "order.deliveryorder", - "deletedAt": "2026-04-17 17:28:24", - "reason": "Missing from latest API doc parsing result" -} diff --git a/workflows/api-doc-system/data/module/order.deliveryorder/_module.lifecycle.json b/workflows/api-doc-system/data/module/order.deliveryorder/_module.lifecycle.json deleted file mode 100644 index 598076b9..00000000 --- a/workflows/api-doc-system/data/module/order.deliveryorder/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "订单配送模块", - "key": "order.deliveryOrder", - "folder": "order.deliveryorder" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": "2026-04-17 19:16:50" -} diff --git a/workflows/api-doc-system/data/module/order.deliveryorder/module.json b/workflows/api-doc-system/data/module/order.deliveryorder/module.json deleted file mode 100644 index 39bf54a2..00000000 --- a/workflows/api-doc-system/data/module/order.deliveryorder/module.json +++ /dev/null @@ -1,161 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "订单配送模块", - "key": "order.deliveryOrder", - "folder": "order.deliveryorder", - "interfaceCount": 2 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "order.deliveryOrder.list", - "title": "配送订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m4。", - "description": "配送订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m4。", - "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": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "method": "order.deliveryOrder.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": true, - "description": "订单头对象(raw 行数据)" - }, - { - "name": "detail", - "type": "object", - "required": true, - "description": "等同于 order" - }, - { - "name": "orderItems / items", - "type": "array", - "required": true, - "description": "商品明细数组" - }, - { - "name": "expresses", - "type": "array", - "required": true, - "description": "运单信息数组,每个元素包含以下字段:waybill_code(运单号,string)、weighing_weight(称重重量,number|null)、sys_logistics_code(系统物流公司编码,string)、sys_logistics_name(系统物流公司名称,string)、logistics_code(实际物流公司编码,string)、logistics_name(实际物流公司名称,string)、logistics_interface_id(物流接口ID,number|null)、business_key(业务标识,string)、created_at(创建时间戳毫秒,number|null)、package_material_id(包材ID,number|null)、package_material_name_snapshot(包材名称快照,string|null)" - }, - { - "name": "waybill_codes", - "type": "array", - "required": true, - "description": "去重后的运单号字符串数组" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/order.entrustorder/_deleted.20260417.json b/workflows/api-doc-system/data/module/order.entrustorder/_deleted.20260417.json deleted file mode 100644 index d39ddc12..00000000 --- a/workflows/api-doc-system/data/module/order.entrustorder/_deleted.20260417.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "folder": "order.entrustorder", - "deletedAt": "2026-04-17 17:28:24", - "reason": "Missing from latest API doc parsing result" -} diff --git a/workflows/api-doc-system/data/module/order.entrustorder/_module.lifecycle.json b/workflows/api-doc-system/data/module/order.entrustorder/_module.lifecycle.json deleted file mode 100644 index 803be76a..00000000 --- a/workflows/api-doc-system/data/module/order.entrustorder/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "订单委托外仓模块", - "key": "order.entrustOrder", - "folder": "order.entrustorder" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": "2026-04-17 19:16:50" -} diff --git a/workflows/api-doc-system/data/module/order.entrustorder/module.json b/workflows/api-doc-system/data/module/order.entrustorder/module.json deleted file mode 100644 index fede45a6..00000000 --- a/workflows/api-doc-system/data/module/order.entrustorder/module.json +++ /dev/null @@ -1,161 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "订单委托外仓模块", - "key": "order.entrustOrder", - "folder": "order.entrustorder", - "interfaceCount": 2 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "order.entrustOrder.list", - "title": "委托外仓订单列表,使用 outsourced 模型。", - "description": "委托外仓订单列表,使用 outsourced 模型。", - "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": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "method": "order.entrustOrder.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": "去重后的运单号字符串数组" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/order.expectionorder/_deleted.20260417.json b/workflows/api-doc-system/data/module/order.expectionorder/_deleted.20260417.json deleted file mode 100644 index 3bf9d3fa..00000000 --- a/workflows/api-doc-system/data/module/order.expectionorder/_deleted.20260417.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "folder": "order.expectionorder", - "deletedAt": "2026-04-17 17:28:24", - "reason": "Missing from latest API doc parsing result" -} diff --git a/workflows/api-doc-system/data/module/order.expectionorder/_module.lifecycle.json b/workflows/api-doc-system/data/module/order.expectionorder/_module.lifecycle.json deleted file mode 100644 index 4cf28b6c..00000000 --- a/workflows/api-doc-system/data/module/order.expectionorder/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "订单异常模块", - "key": "order.expectionOrder", - "folder": "order.expectionorder" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": "2026-04-17 19:16:50" -} diff --git a/workflows/api-doc-system/data/module/order.expectionorder/module.json b/workflows/api-doc-system/data/module/order.expectionorder/module.json deleted file mode 100644 index 5439e309..00000000 --- a/workflows/api-doc-system/data/module/order.expectionorder/module.json +++ /dev/null @@ -1,203 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "订单异常模块", - "key": "order.expectionOrder", - "folder": "order.expectionorder", - "interfaceCount": 3 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "order.expectionOrder.list", - "title": "待处理异常订单列表,默认仅查询 step=3 的订单。", - "description": "待处理异常订单列表,默认仅查询 step=3 的订单。", - "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": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "method": "order.expectionOrder.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.expectionOrder.resolveException", - "title": "将待处理异常订单转回正常待处理状态(step 3 → 2)。只操作当前仓库的当前订单表,且仅对 step=3 的订单生效。", - "description": "将待处理异常订单转回正常待处理状态(step 3 → 2)。只操作当前仓库的当前订单表,且仅对 step=3 的订单生效。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "ids", - "type": "number[]", - "required": true, - "description": "订单ID 正整数数组,不能为空" - } - ], - "response": [ - { - "name": "updated_count", - "type": "number", - "required": true, - "description": "实际更新行数" - }, - { - "name": "ids", - "type": "number[]", - "required": true, - "description": "本次操作的订单ID 列表" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/order.index/_deleted.20260417.json b/workflows/api-doc-system/data/module/order.index/_deleted.20260417.json deleted file mode 100644 index 22827bdf..00000000 --- a/workflows/api-doc-system/data/module/order.index/_deleted.20260417.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "folder": "order.index", - "deletedAt": "2026-04-17 17:28:24", - "reason": "Missing from latest API doc parsing result" -} diff --git a/workflows/api-doc-system/data/module/order.index/_module.lifecycle.json b/workflows/api-doc-system/data/module/order.index/_module.lifecycle.json deleted file mode 100644 index c119e085..00000000 --- a/workflows/api-doc-system/data/module/order.index/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "订单工作台入口模块", - "key": "order.index", - "folder": "order.index" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": "2026-04-17 19:16:50" -} diff --git a/workflows/api-doc-system/data/module/order.index/module.json b/workflows/api-doc-system/data/module/order.index/module.json deleted file mode 100644 index 4e23d509..00000000 --- a/workflows/api-doc-system/data/module/order.index/module.json +++ /dev/null @@ -1,850 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "订单工作台入口模块", - "key": "order.index", - "folder": "order.index", - "interfaceCount": 11 - }, - "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)" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "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": true, - "description": "订单头对象(raw 行数据)" - }, - { - "name": "detail", - "type": "object", - "required": true, - "description": "等同于 order" - }, - { - "name": "orderItems / items", - "type": "array", - "required": true, - "description": "商品明细数组" - }, - { - "name": "expresses", - "type": "array", - "required": true, - "description": "运单信息数组,每个元素包含以下字段:waybill_code(运单号,string)、weighing_weight(称重重量,number|null)、sys_logistics_code(系统物流公司编码,string)、sys_logistics_name(系统物流公司名称,string)、logistics_code(实际物流公司编码,string)、logistics_name(实际物流公司名称,string)、logistics_interface_id(物流接口ID,number|null)、business_key(业务标识,string)、created_at(创建时间戳毫秒,number|null)、package_material_id(包材ID,number|null)、package_material_name_snapshot(包材名称快照,string|null)" - }, - { - "name": "waybill_codes", - "type": "array", - "required": true, - "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": "更新订单运单称重重量。支持两种模式:1) 订单模式(order_id>0):规则:订单仅一个运单时,直接写入该运单重量;多运单时,必须传 waybill_code 并按运单写入;团购波次批量设置同一重量到波次下所有订单运单,并返回拆单汇总信息(total_weight/split_count/splits/store_name/sys_logistics_name)。2) 运单号模式(order_id=0):从运单号反查订单与波次,散单/非团购波次仅更新单个运单重量,团购波次按 wave_no+business_key 批量设置并返回拆单汇总信息。", - "description": "更新订单运单称重重量。支持两种模式:1) 订单模式(order_id>0):规则:订单仅一个运单时,直接写入该运单重量;多运单时,必须传 waybill_code 并按运单写入;团购波次批量设置同一重量到波次下所有订单运单,并返回拆单汇总信息(total_weight/split_count/splits/store_name/sys_logistics_name)。2) 运单号模式(order_id=0):从运单号反查订单与波次,散单/非团购波次仅更新单个运单重量,团购波次按 wave_no+business_key 批量设置并返回拆单汇总信息。", - "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,必填且必须为数字。订单模式下为正整数,设为0时切换为运单号模式(需配合 waybill_code 使用)。" - }, - { - "name": "waybill_code", - "type": "string", - "required": false, - "description": "运单号。订单模式下:订单仅一个运单时可不传且会被忽略,多运单时必填并需匹配订单下运单。运单号模式(order_id=0)下必填。" - }, - { - "name": "weighing_weight", - "type": "number|string", - "required": true, - "description": "称重重量(kg),必填,必须大于 0,最多支持 3 位小数。" - } - ], - "response": [ - { - "name": "order_id", - "type": "number", - "required": false, - "description": "订单ID。订单模式及运单号散单模式返回。" - }, - { - "name": "waybill_code", - "type": "string", - "required": false, - "description": "写入重量的运单号。订单模式及运单号散单模式返回。" - }, - { - "name": "weighing_weight", - "type": "number", - "required": true, - "description": "已写入的称重重量(kg)。" - }, - { - "name": "wave_no", - "type": "string", - "required": false, - "description": "波次号。团购批量模式返回。" - }, - { - "name": "business_key", - "type": "string", - "required": false, - "description": "业务键。运单号团购批量模式返回。" - }, - { - "name": "wave_id", - "type": "number", - "required": false, - "description": "波次ID。团购批量模式返回。" - }, - { - "name": "total_weight", - "type": "number", - "required": false, - "description": "所有拆单重量累加(kg)。团购批量模式返回。" - }, - { - "name": "split_count", - "type": "number", - "required": false, - "description": "waybill_code 非空的 business_key 数量。团购批量模式返回。" - }, - { - "name": "splits", - "type": "array", - "required": false, - "description": "按 business_key 分组的拆单明细。每项含 business_key(业务键)、weighing_weight(该拆单累加重量)、waybill_code(代表运单号)。团购批量模式返回。" - }, - { - "name": "store_name", - "type": "string", - "required": false, - "description": "货主名称(订单 shop_nick)。团购批量模式返回。" - }, - { - "name": "sys_logistics_name", - "type": "string", - "required": false, - "description": "系统快递名称。团购批量模式返回。" - } - ] - }, - { - "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.bindExpressPackageMaterialByWaybill", - "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": "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 字符串)" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/order.outboundorder/_deleted.20260417.json b/workflows/api-doc-system/data/module/order.outboundorder/_deleted.20260417.json deleted file mode 100644 index 6e9b26e4..00000000 --- a/workflows/api-doc-system/data/module/order.outboundorder/_deleted.20260417.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "folder": "order.outboundorder", - "deletedAt": "2026-04-17 17:28:24", - "reason": "Missing from latest API doc parsing result" -} diff --git a/workflows/api-doc-system/data/module/order.outboundorder/_module.lifecycle.json b/workflows/api-doc-system/data/module/order.outboundorder/_module.lifecycle.json deleted file mode 100644 index 2194399e..00000000 --- a/workflows/api-doc-system/data/module/order.outboundorder/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "订单待出库模块", - "key": "order.outboundOrder", - "folder": "order.outboundorder" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": "2026-04-17 19:16:50" -} diff --git a/workflows/api-doc-system/data/module/order.outboundorder/module.json b/workflows/api-doc-system/data/module/order.outboundorder/module.json deleted file mode 100644 index 534c0e93..00000000 --- a/workflows/api-doc-system/data/module/order.outboundorder/module.json +++ /dev/null @@ -1,257 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "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": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "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 等字段" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/order.pendingorder/_deleted.20260417.json b/workflows/api-doc-system/data/module/order.pendingorder/_deleted.20260417.json deleted file mode 100644 index a2b6ef0a..00000000 --- a/workflows/api-doc-system/data/module/order.pendingorder/_deleted.20260417.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "folder": "order.pendingorder", - "deletedAt": "2026-04-17 17:28:24", - "reason": "Missing from latest API doc parsing result" -} diff --git a/workflows/api-doc-system/data/module/order.pendingorder/_module.lifecycle.json b/workflows/api-doc-system/data/module/order.pendingorder/_module.lifecycle.json deleted file mode 100644 index ddbdd349..00000000 --- a/workflows/api-doc-system/data/module/order.pendingorder/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "订单待处理模块", - "key": "order.pendingOrder", - "folder": "order.pendingorder" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": "2026-04-17 19:16:50" -} diff --git a/workflows/api-doc-system/data/module/order.pendingorder/module.json b/workflows/api-doc-system/data/module/order.pendingorder/module.json deleted file mode 100644 index c6afbb63..00000000 --- a/workflows/api-doc-system/data/module/order.pendingorder/module.json +++ /dev/null @@ -1,1990 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "订单待处理模块", - "key": "order.pendingOrder", - "folder": "order.pendingorder", - "interfaceCount": 25 - }, - "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": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "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。服务端会按 create_channel 分组派发同步任务;若命中 SN 管理订单(is_sn_mgmt=Y),该订单会被拦截并标记失败,不允许走批量回传,需改用单订单回传。", - "description": "同步待处理订单入口,支持批量传入 order_ids。服务端会按 create_channel 分组派发同步任务;若命中 SN 管理订单(is_sn_mgmt=Y),该订单会被拦截并标记失败,不允许走批量回传,需改用单订单回传。", - "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。服务端会校验订单状态并执行批量同步拦截规则(含 SN 订单限制)。" - } - ], - "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": true, - "description": "省份(必填,空值返回 400)" - }, - { - "name": "city", - "type": "string", - "required": true, - "description": "城市(必填,空值返回 400)" - }, - { - "name": "area", - "type": "string", - "required": true, - "description": "区/县(必填,空值返回 400)" - }, - { - "name": "town", - "type": "string", - "required": false, - "description": "镇/街道" - }, - { - "name": "zip_code", - "type": "string", - "required": false, - "description": "邮编" - }, - { - "name": "items", - "type": "array", - "required": true, - "description": "订单明细数组,每项含 item_id(商品主键,必填,正整数)和 plan_qty(计划数量,正整数);item_name(优先外部传入,其次从 StockStore 缓存获取,最后兜底'商品')、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": "shop_nick", - "type": "string", - "required": false, - "description": "店铺名称(自定义),最大长度 200" - }, - { - "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.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(失败原因)" - } - ] - }, - { - "method": "order.pendingOrder.parseAddress", - "title": "智能地址解析:使用 AI 将非结构化地址字符串解析为省/市/区/详细地址/收件人/手机号", - "description": "智能地址解析:使用 AI 将非结构化地址字符串解析为省/市/区/详细地址/收件人/手机号", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "address", - "type": "string", - "required": true, - "description": "原始地址字符串(必填),如\"张三 13800138000 广东省广州市天河区体育西路100号\"" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "1=成功,0=失败" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "提示消息" - }, - { - "name": "data", - "type": "object", - "required": false, - "description": "解析成功时返回 province/city/area/detailAddress/name/mobile" - }, - { - "name": "data.province", - "type": "string", - "required": false, - "description": "省份,如 广东省" - }, - { - "name": "data.city", - "type": "string", - "required": false, - "description": "城市,如 广州市" - }, - { - "name": "data.area", - "type": "string", - "required": false, - "description": "区/县,如 天河区" - }, - { - "name": "data.town", - "type": "string", - "required": false, - "description": "乡镇/街道,如 员村街道" - }, - { - "name": "data.detailAddress", - "type": "string", - "required": false, - "description": "详细地址,如 体育西路100号" - }, - { - "name": "data.name", - "type": "string", - "required": false, - "description": "收件人姓名,如 张三" - }, - { - "name": "data.mobile", - "type": "string", - "required": false, - "description": "收件人手机号,如 13800138000" - } - ] - }, - { - "method": "order.pendingOrder.updateAddress", - "title": "批量修改待处理订单的收件地址信息和备注。地址字段修改仅允许 post_status='none'(未分配快递)的订单;remark 字段修改不受 post_status 限制可对所有订单生效。至少需要提供一个地址字段(name/mobile/tel/zip_code/province/city/area/town/detail_address)或 remark,空值和纯空白会被忽略。更新成功后写入操作日志。", - "description": "批量修改待处理订单的收件地址信息和备注。地址字段修改仅允许 post_status='none'(未分配快递)的订单;remark 字段修改不受 post_status 限制可对所有订单生效。至少需要提供一个地址字段(name/mobile/tel/zip_code/province/city/area/town/detail_address)或 remark,空值和纯空白会被忽略。更新成功后写入操作日志。", - "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": "number[]", - "required": true, - "description": "订单ID 正整数数组,不能为空" - }, - { - "name": "name", - "type": "string", - "required": false, - "description": "收件人姓名" - }, - { - "name": "mobile", - "type": "string", - "required": false, - "description": "收件人手机号" - }, - { - "name": "tel", - "type": "string", - "required": false, - "description": "收件人电话" - }, - { - "name": "zip_code", - "type": "string", - "required": false, - "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": "detail_address", - "type": "string", - "required": false, - "description": "详细地址" - }, - { - "name": "remark", - "type": "string", - "required": false, - "description": "订单留言/备注,最大500字符。非空时批量覆盖所选订单的 remark 字段,不受 post_status 限制。" - } - ], - "response": [ - { - "name": "updated_count", - "type": "number", - "required": true, - "description": "实际更新的订单行数(取地址更新行数与备注更新行数的最大值)。remark 字段的更新计数独立于地址字段。" - }, - { - "name": "ids", - "type": "number[]", - "required": true, - "description": "请求的订单ID数组(原样返回)" - } - ] - }, - { - "method": "order.pendingOrder.batchIntercept", - "title": "批量提交订单拦截请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 intercept_status 更新为 'requested' 并写入操作日志(ORDER_INTERCEPT_REQUEST)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", - "description": "批量提交订单拦截请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 intercept_status 更新为 'requested' 并写入操作日志(ORDER_INTERCEPT_REQUEST)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.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", - "type": "number[]", - "required": true, - "description": "订单ID数组;优先级 order_ids > orderIds > ids" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "外部指定任务ID(用于幂等提交,不传则自动生成)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID,格式 recheck_intercept_{warehouseId}_{timestamp}_{rand}(幂等提交时返回已有任务的 task_id)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID(取自当前上下文)" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "任务提交状态说明:'批量拦截任务已提交。' 或 '批量拦截任务已存在,请勿重复提交。'" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO 字符串)" - }, - { - "name": "status", - "type": "string", - "required": false, - "description": "提交状态(固定为 'success')" - }, - { - "name": "state", - "type": "string", - "required": false, - "description": "幂等提交时返回已有任务的状态:submitted / running / success / failed" - } - ] - }, - { - "method": "order.pendingOrder.batchInterceptTaskProgress", - "title": "查询批量拦截任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已拦截订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", - "description": "查询批量拦截任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已拦截订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、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" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态:submitted / running / success / failed / not_found" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "仓库ID(not_found 时不返回)" - }, - { - "name": "submitted_at", - "type": "number|null", - "required": false, - "description": "任务提交时间戳(毫秒)" - }, - { - "name": "start_time", - "type": "number|null", - "required": false, - "description": "任务开始执行时间戳(毫秒,running/success/failed 时返回)" - }, - { - "name": "end_time", - "type": "number|null", - "required": false, - "description": "任务结束时间戳(毫秒,success/failed 时返回)" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比 0-100(submitted/running/success/failed 时返回)" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "总订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数(仅 submitted/running 时返回)" - }, - { - "name": "intercepted_order_count", - "type": "number", - "required": false, - "description": "已拦截订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "intercepted_order_ids", - "type": "number[]", - "required": false, - "description": "已拦截订单ID列表(仅 success 时返回)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒,success/failed 时返回)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "错误信息(仅 failed 时返回)" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "错误码(仅 failed 时返回,默认 'BATCH_INTERCEPT_FAILED')" - } - ] - }, - { - "method": "order.pendingOrder.batchLock", - "title": "批量提交订单锁定请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 lock_status 更新为 'warehouse' 并写入操作日志(ORDER_LOCK)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", - "description": "批量提交订单锁定请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 lock_status 更新为 'warehouse' 并写入操作日志(ORDER_LOCK)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.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", - "type": "number[]", - "required": true, - "description": "订单ID数组;优先级 order_ids > orderIds > ids" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "外部指定任务ID(用于幂等提交,不传则自动生成)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID,格式 order_lock_{warehouseId}_{timestamp}_{rand}(幂等提交时返回已有任务的 task_id)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID(取自当前上下文)" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "任务提交状态说明:'批量锁定任务已提交。' 或 '批量锁定任务已存在,请勿重复提交。'" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO 字符串)" - }, - { - "name": "status", - "type": "string", - "required": false, - "description": "提交状态(固定为 'success')" - }, - { - "name": "state", - "type": "string", - "required": false, - "description": "幂等提交时返回已有任务的状态:submitted / running / success / failed" - } - ] - }, - { - "method": "order.pendingOrder.batchLockTaskProgress", - "title": "查询批量锁定任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已锁定订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", - "description": "查询批量锁定任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已锁定订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、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" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态:submitted / running / success / failed / not_found" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "仓库ID(not_found 时不返回)" - }, - { - "name": "submitted_at", - "type": "number|null", - "required": false, - "description": "任务提交时间戳(毫秒)" - }, - { - "name": "start_time", - "type": "number|null", - "required": false, - "description": "任务开始执行时间戳(毫秒,running/success/failed 时返回)" - }, - { - "name": "end_time", - "type": "number|null", - "required": false, - "description": "任务结束时间戳(毫秒,success/failed 时返回)" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比 0-100(submitted/running/success/failed 时返回)" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "总订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数(仅 submitted/running 时返回)" - }, - { - "name": "locked_order_count", - "type": "number", - "required": false, - "description": "已锁定订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "locked_order_ids", - "type": "number[]", - "required": false, - "description": "已锁定订单ID列表(仅 success 时返回)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒,success/failed 时返回)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "错误信息(仅 failed 时返回)" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "错误码(仅 failed 时返回,默认 'BATCH_LOCK_FAILED')" - } - ] - }, - { - "method": "order.pendingOrder.batchUnlock", - "title": "批量提交订单解锁请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 lock_status 更新为 'none' 并写入操作日志(ORDER_UNLOCK)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", - "description": "批量提交订单解锁请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 lock_status 更新为 'none' 并写入操作日志(ORDER_UNLOCK)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.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", - "type": "number[]", - "required": true, - "description": "订单ID数组;优先级 order_ids > orderIds > ids" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "外部指定任务ID(用于幂等提交,不传则自动生成)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID,格式 order_unlock_{warehouseId}_{timestamp}_{rand}(幂等提交时返回已有任务的 task_id)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID(取自当前上下文)" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "任务提交状态说明:'批量解锁任务已提交。' 或 '批量解锁任务已存在,请勿重复提交。'" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO 字符串)" - }, - { - "name": "status", - "type": "string", - "required": false, - "description": "提交状态(固定为 'success')" - }, - { - "name": "state", - "type": "string", - "required": false, - "description": "幂等提交时返回已有任务的状态:submitted / running / success / failed" - } - ] - }, - { - "method": "order.pendingOrder.batchUnlockTaskProgress", - "title": "查询批量解锁任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已解锁订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", - "description": "查询批量解锁任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已解锁订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、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" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态:submitted / running / success / failed / not_found" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "仓库ID(not_found 时不返回)" - }, - { - "name": "submitted_at", - "type": "number|null", - "required": false, - "description": "任务提交时间戳(毫秒)" - }, - { - "name": "start_time", - "type": "number|null", - "required": false, - "description": "任务开始执行时间戳(毫秒,running/success/failed 时返回)" - }, - { - "name": "end_time", - "type": "number|null", - "required": false, - "description": "任务结束时间戳(毫秒,success/failed 时返回)" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比 0-100(submitted/running/success/failed 时返回)" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "总订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数(仅 submitted/running 时返回)" - }, - { - "name": "unlocked_order_count", - "type": "number", - "required": false, - "description": "已解锁订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "unlocked_order_ids", - "type": "number[]", - "required": false, - "description": "已解锁订单ID列表(仅 success 时返回)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒,success/failed 时返回)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "错误信息(仅 failed 时返回)" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "错误码(仅 failed 时返回,默认 'BATCH_UNLOCK_FAILED')" - } - ] - }, - { - "method": "order.pendingOrder.batchUnintercept", - "title": "批量提交解除拦截请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 intercept_status 更新为 'none' 并写入操作日志(ORDER_INTERCEPT_CANCEL)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", - "description": "批量提交解除拦截请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 intercept_status 更新为 'none' 并写入操作日志(ORDER_INTERCEPT_CANCEL)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.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", - "type": "number[]", - "required": true, - "description": "订单ID数组;优先级 order_ids > orderIds > ids" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "外部指定任务ID(用于幂等提交,不传则自动生成)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID,格式 order_unintercept_{warehouseId}_{timestamp}_{rand}(幂等提交时返回已有任务的 task_id)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID(取自当前上下文)" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "任务提交状态说明:'批量解除拦截任务已提交。' 或 '批量解除拦截任务已存在,请勿重复提交。'" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO 字符串)" - }, - { - "name": "status", - "type": "string", - "required": false, - "description": "提交状态(固定为 'success')" - }, - { - "name": "state", - "type": "string", - "required": false, - "description": "幂等提交时返回已有任务的状态:submitted / running / success / failed" - } - ] - }, - { - "method": "order.pendingOrder.batchUninterceptTaskProgress", - "title": "查询批量解除拦截任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已解除拦截订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", - "description": "查询批量解除拦截任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已解除拦截订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、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" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态:submitted / running / success / failed / not_found" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "仓库ID(not_found 时不返回)" - }, - { - "name": "submitted_at", - "type": "number|null", - "required": false, - "description": "任务提交时间戳(毫秒)" - }, - { - "name": "start_time", - "type": "number|null", - "required": false, - "description": "任务开始执行时间戳(毫秒,running/success/failed 时返回)" - }, - { - "name": "end_time", - "type": "number|null", - "required": false, - "description": "任务结束时间戳(毫秒,success/failed 时返回)" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比 0-100(submitted/running/success/failed 时返回)" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "总订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数(仅 submitted/running 时返回)" - }, - { - "name": "unintercepted_order_count", - "type": "number", - "required": false, - "description": "已解除拦截订单数(submitted/running/success/failed 时返回)" - }, - { - "name": "unintercepted_order_ids", - "type": "number[]", - "required": false, - "description": "已解除拦截订单ID列表(仅 success 时返回)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒,success/failed 时返回)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "错误信息(仅 failed 时返回)" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "错误码(仅 failed 时返回,默认 'BATCH_UNINTERCEPT_FAILED')" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/order.print/_module.lifecycle.json b/workflows/api-doc-system/data/module/order.print/_module.lifecycle.json deleted file mode 100644 index 32bed1e6..00000000 --- a/workflows/api-doc-system/data/module/order.print/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "打印模块", - "key": "order.print", - "folder": "order.print" - }, - "status": "active", - "createdAt": "2026-05-05 09:15:19", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/order.print/module.json b/workflows/api-doc-system/data/module/order.print/module.json deleted file mode 100644 index bc2351f5..00000000 --- a/workflows/api-doc-system/data/module/order.print/module.json +++ /dev/null @@ -1,299 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "打印模块", - "key": "order.print", - "folder": "order.print", - "interfaceCount": 4 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "order.print.getWavePrintData", - "title": "按波次 IDs 获取订单打印数据,自动过滤快递未完全分配的波次,返回通过过滤的波次订单明细,按波次号分组", - "description": "按波次 IDs 获取订单打印数据,自动过滤快递未完全分配的波次,返回通过过滤的波次订单明细,按波次号分组", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID" - }, - { - "name": "wave_ids", - "type": "array", - "required": true, - "description": "波次ID列表(支持数字或字符串,内部自动去重与归一化)" - } - ], - "response": [ - { - "name": "summary", - "type": "object", - "required": false, - "description": "汇总信息" - }, - { - "name": "wave_list", - "type": "array", - "required": false, - "description": "波次列表(按 wave_no 排序)" - }, - { - "name": "ext", - "type": "object", - "required": false, - "description": "扩展字段" - } - ] - }, - { - "method": "order.print.getWavePlatformPrintData", - "title": "按波次 IDs 获取平台打印中间态数据,自动过滤快递未完全分配的波次,返回 waveGroups(波次 -> 平台 -> 订单)结构", - "description": "按波次 IDs 获取平台打印中间态数据,自动过滤快递未完全分配的波次,返回 waveGroups(波次 -> 平台 -> 订单)结构", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID(必须与当前用户上下文 store_id 一致)" - }, - { - "name": "wave_ids", - "type": "array", - "required": true, - "description": "波次ID列表(支持数字或字符串,内部自动去重与归一化)" - } - ], - "response": [ - { - "name": "summary", - "type": "object", - "required": false, - "description": "汇总信息" - }, - { - "name": "wave_ids", - "type": "array", - "required": false, - "description": "通过过滤的波次ID数组" - }, - { - "name": "waveGroups", - "type": "array", - "required": false, - "description": "主返回结构:按波次分组(波次 -> 平台 -> 订单)" - }, - { - "name": "platform_groups", - "type": "array", - "required": false, - "description": "兼容字段:按平台分组结果(保留以兼容旧客户端)" - }, - { - "name": "order_list", - "type": "array", - "required": false, - "description": "兼容字段:逐单平台打印中间态明细(保留以兼容旧客户端)" - }, - { - "name": "ext", - "type": "object", - "required": false, - "description": "扩展字段" - } - ] - }, - { - "method": "order.print.unlockWavePlatformPrintDataByGroup", - "title": "按分组解锁波次平台打印锁:按传入的 groups 条件匹配已锁定订单并将其 print_lock_status 置为 none,返回解锁统计与解锁订单列表。", - "description": "按分组解锁波次平台打印锁:按传入的 groups 条件匹配已锁定订单并将其 print_lock_status 置为 none,返回解锁统计与解锁订单列表。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID(必须与当前用户上下文 store_id 一致)" - }, - { - "name": "wave_ids", - "type": "array", - "required": true, - "description": "波次ID列表(支持数字或字符串,内部自动去重与归一化)" - }, - { - "name": "group_type", - "type": "string", - "required": false, - "description": "分组类型,支持 platform、platform_express、order;默认 platform_express" - }, - { - "name": "unlock_scope", - "type": "string", - "required": false, - "description": "解锁范围,支持 group、wave;默认 group" - }, - { - "name": "groups", - "type": "array", - "required": true, - "description": "分组条件列表。元素为对象,可包含字段:wave_id(必填)、platform(平台编码)、sys_logistics_code(系统快递编码)、order_ids(订单ID数组)" - } - ], - "response": [ - { - "name": "summary", - "type": "object", - "required": true, - "description": "解锁操作的汇总统计" - }, - { - "name": "wave_ids", - "type": "array", - "required": true, - "description": "通过过滤的波次ID数组" - }, - { - "name": "unlocked_order_ids", - "type": "array", - "required": true, - "description": "被解锁的订单ID数组" - }, - { - "name": "unlocked_orders", - "type": "array", - "required": true, - "description": "被解锁订单简要信息列表" - }, - { - "name": "ext", - "type": "object", - "required": false, - "description": "扩展字段" - } - ] - }, - { - "method": "order.print.getOrderPrintData", - "title": "按订单ID拉取平台打印中间态数据,与 getWavePlatformPrintData 返回结构一致。不限制打印锁定状态,所有订单(包括已锁定)统一返回。仓库ID统一从当前上下文获取,无需调用方传入。自动过滤快递未完全分配的订单(post_status !== 'fin'),返回 waveGroups(波次 -> 平台 -> 订单)结构。", - "description": "按订单ID拉取平台打印中间态数据,与 getWavePlatformPrintData 返回结构一致。不限制打印锁定状态,所有订单(包括已锁定)统一返回。仓库ID统一从当前上下文获取,无需调用方传入。自动过滤快递未完全分配的订单(post_status !== 'fin'),返回 waveGroups(波次 -> 平台 -> 订单)结构。", - "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", - "type": "array", - "required": true, - "description": "订单ID列表(支持数字或字符串,内部自动去重与归一化,必须为非空数组)" - } - ], - "response": [ - { - "name": "summary", - "type": "object", - "required": true, - "description": "汇总信息" - }, - { - "name": "wave_ids", - "type": "array", - "required": true, - "description": "通过过滤的波次ID数组" - }, - { - "name": "waveGroups", - "type": "array", - "required": true, - "description": "主返回结构:按波次分组(波次 -> 平台 -> 订单)" - }, - { - "name": "ext", - "type": "object", - "required": true, - "description": "扩展字段" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/order.recheckorder/_module.lifecycle.json b/workflows/api-doc-system/data/module/order.recheckorder/_module.lifecycle.json deleted file mode 100644 index 510b20ab..00000000 --- a/workflows/api-doc-system/data/module/order.recheckorder/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "订单复核模块", - "key": "order.recheckOrder", - "folder": "order.recheckorder" - }, - "status": "active", - "createdAt": "2026-05-20 08:59:09", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/order.recheckorder/module.json b/workflows/api-doc-system/data/module/order.recheckorder/module.json deleted file mode 100644 index 163d95ee..00000000 --- a/workflows/api-doc-system/data/module/order.recheckorder/module.json +++ /dev/null @@ -1,551 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "订单复核模块", - "key": "order.recheckOrder", - "folder": "order.recheckorder", - "interfaceCount": 7 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "order.recheckOrder.scanOrder", - "title": "扫描关键词并返回以波次为单位的复核视图。支持运单号、波次号、车号三种匹配模式。运单号/波次号命中(散单)返回扁平化订单列表 list_type='single',车号命中(团单)返回嵌套波次结构 list_type='group'。运单号命中但订单无波次信息时,退回单订单详情模式(list 每项含 detail/items/expresses/logs)。", - "description": "扫描关键词并返回以波次为单位的复核视图。支持运单号、波次号、车号三种匹配模式。运单号/波次号命中(散单)返回扁平化订单列表 list_type='single',车号命中(团单)返回嵌套波次结构 list_type='group'。运单号命中但订单无波次信息时,退回单订单详情模式(list 每项含 detail/items/expresses/logs)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "keyword / value / waybill_no / waybillCode / waybill_code / wave_no / waveNo / cart_code / cartCode", - "type": "string", - "required": true, - "description": "扫描关键词;匹配优先级:运单号 → 波次号 → 车号。支持别名 waybillCode/waybill_code(运单号)、waveNo(波次号)、cartCode(车号)" - } - ], - "response": [ - { - "name": "match_type", - "type": "string", - "required": true, - "description": "命中类型:waybill(运单号命中)/ wave(波次号命中)/ cart(车号命中)" - }, - { - "name": "list_type", - "type": "string", - "required": true, - "description": "列表模式:single(散单扁平列表)/ group(团购嵌套波次列表)" - }, - { - "name": "waybill_no", - "type": "string", - "required": false, - "description": "仅 waybill 命中时返回,匹配到的运单号" - }, - { - "name": "task_id", - "type": "number|null", - "required": false, - "description": "散单有波次信息时返回(来自拣货任务表 wms_wave_pick_task.id),团单车号命中时返回 cartMatchContext 中的任务 ID" - }, - { - "name": "picker_id", - "type": "number|null", - "required": false, - "description": "仅散单模式(有波次信息时)返回,拣货人ID(来自 wms_wave_pick_task.pick_user_id)" - }, - { - "name": "picker_name", - "type": "string", - "required": false, - "description": "仅散单模式(有波次信息时)返回,拣货人名称(来自 wms_wave_pick_task.pick_user_name)" - }, - { - "name": "wave_id", - "type": "number", - "required": false, - "description": "仅散单模式(有波次信息时)返回,波次ID" - }, - { - "name": "wave_no", - "type": "string", - "required": false, - "description": "仅散单模式(有波次信息时)返回,波次号" - }, - { - "name": "wave_type", - "type": "number", - "required": false, - "description": "仅散单模式(有波次信息时)返回,波次类型编码(来自 wms_wave_batch.wave_type)" - }, - { - "name": "pick_mode", - "type": "number", - "required": false, - "description": "拣货模式:1-团购小波次 2-散单单品单件 3-散单先拣后分 4-边拣边分 5-团购大波次。散单模式在顶层返回,团购模式在每个波次视图项内返回" - }, - { - "name": "strategy_id", - "type": "number|null", - "required": false, - "description": "仅散单模式返回,波次策略ID" - }, - { - "name": "strategy_name", - "type": "string", - "required": false, - "description": "仅散单模式返回,波次策略名称" - }, - { - "name": "total_orders", - "type": "number", - "required": false, - "description": "仅散单模式返回,波次内订单总数" - }, - { - "name": "reviewed_count", - "type": "number", - "required": false, - "description": "仅散单模式返回,已复核订单数" - }, - { - "name": "unreviewed_count", - "type": "number", - "required": false, - "description": "仅散单模式返回,未复核订单数" - }, - { - "name": "list", - "type": "array", - "required": true, - "description": "统一列表输出。散单模式(list_type=single)有波次信息时:扁平订单数组;无波次信息时退回单订单详情模式(每项含 detail、items、expresses、logs)。团购模式(list_type=group):波次视图数组(每项含 wave_id、wave_no、wave_type、wave_status、total_orders、processed_orders、creator、create_time、update_time、order_count、pick_mode、box_no、order_ids、orders_detail、stocks[])" - } - ] - }, - { - "method": "order.recheckOrder.confirmRecheck", - "title": "按订单 ID 确认复核并记录复核任务到 wms_recheck_task(入参兼容 id/orderId)。确认复核后,若该订单所属波次拣货任务下所有订单均已复核完成,则自动解绑车任务:清空 wms_wave_pick_task 的车绑定信息(current_cart_id、current_cart_code_snapshot)、停用 wms_pick_task_cart_binding 绑定记录(is_active=0 并记录解绑人和时间)并释放 wms_pick_cart(清空 current_task_id、bind_user_id)。解绑失败仅记录 warn 日志,不影响复核主流程。", - "description": "按订单 ID 确认复核并记录复核任务到 wms_recheck_task(入参兼容 id/orderId)。确认复核后,若该订单所属波次拣货任务下所有订单均已复核完成,则自动解绑车任务:清空 wms_wave_pick_task 的车绑定信息(current_cart_id、current_cart_code_snapshot)、停用 wms_pick_task_cart_binding 绑定记录(is_active=0 并记录解绑人和时间)并释放 wms_pick_cart(清空 current_task_id、bind_user_id)。解绑失败仅记录 warn 日志,不影响复核主流程。", - "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;优先使用 order_id,兼容别名 id 与 orderId" - } - ], - "response": [ - { - "name": "order_id", - "type": "number", - "required": true, - "description": "订单 ID" - }, - { - "name": "waybill_no", - "type": "string", - "required": true, - "description": "运单号" - }, - { - "name": "recheck_status", - "type": "string", - "required": true, - "description": "复核结果状态(固定为 'fin')" - }, - { - "name": "recheck_time", - "type": "string", - "required": true, - "description": "复核时间(ISO 字符串)" - }, - { - "name": "review_no", - "type": "string", - "required": true, - "description": "复核任务编号" - } - ] - }, - { - "method": "order.recheckOrder.confirmIntercept", - "title": "确认拦截:通过订单ID直接匹配订单,将其拦截状态更新为 intercepted_at_warehouse(仓库已拦截)。仅拦截当前指定订单,不波及波次内其他订单。操作成功后写入操作日志(ORDER_INTERCEPT_CONFIRM),日志写入失败不影响主流程。", - "description": "确认拦截:通过订单ID直接匹配订单,将其拦截状态更新为 intercepted_at_warehouse(仓库已拦截)。仅拦截当前指定订单,不波及波次内其他订单。操作成功后写入操作日志(ORDER_INTERCEPT_CONFIRM),日志写入失败不影响主流程。", - "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", - "required": true, - "description": "订单 ID" - } - ], - "response": [ - { - "name": "order_id", - "type": "number", - "required": true, - "description": "订单 ID" - }, - { - "name": "order_no", - "type": "string", - "required": true, - "description": "订单号(优先 delivery_order_code,其次 pre_delivery_order_code)" - }, - { - "name": "intercept_status", - "type": "string", - "required": true, - "description": "拦截状态(固定为 'intercepted_at_warehouse')" - }, - { - "name": "updated_at", - "type": "string", - "required": true, - "description": "更新时间(ISO 字符串)" - } - ] - }, - { - "method": "order.recheckOrder.recheckOrderList", - "title": "复核订单列表查询,通过入参 list_type 区分散单模式与团购模式。散单模式(single,默认)返回待复核订单列表(每项为一个订单,排除 pick_status='none' 和 recheck_status='fin'),团购模式(group)返回波次维度的复核汇总列表(每项为一个波次及其订单复核统计,含 review_assignment_status 计算字段)。统一使用 list 字段名输出,均支持分页与筛选。", - "description": "复核订单列表查询,通过入参 list_type 区分散单模式与团购模式。散单模式(single,默认)返回待复核订单列表(每项为一个订单,排除 pick_status='none' 和 recheck_status='fin'),团购模式(group)返回波次维度的复核汇总列表(每项为一个波次及其订单复核统计,含 review_assignment_status 计算字段)。统一使用 list 字段名输出,均支持分页与筛选。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "list_type", - "type": "string", - "required": false, - "description": "列表模式:single(散单模式,默认)/ group(团购模式)" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "筛选条件。散单模式支持 keyword(运单号/订单号模糊搜索)、wave_no(精确匹配)、recheck_status、pick_status;团购模式支持 wave_no(模糊搜索)、wave_type、wave_status" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数,支持 page / pageSize(默认 page=1, pageSize=20)" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "散单模式(list_type=single):订单数组,每项含 order_id、delivery_order_code、order_type、wave_id、wave_no、pick_status、recheck_status、shop_nick、logistics_name、items_count、items_total、status、create_at、pick_time、recheck_time。团购模式(list_type=group):波次汇总数组,每项含 wave_id、wave_no、wave_type、wave_status、total_orders、processed_orders、creator、create_time、update_time、order_count、reviewed_count、unreviewed_count、review_assignment_status(unreviewed/partially_reviewed/reviewed)" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息,含 page、pageSize、total、totalPages、hasPrevious、hasNext" - } - ] - }, - { - "method": "order.recheckOrder.scanTask", - "title": "按拣货任务 ID 拉取复核扫描视图。根据任务的 pick_mode 区分散单/团单模式,返回与 scanOrder 一致的数据结构,用于前端刷新数据。散单模式(pick_mode 2/3/4)扁平化任务下所有波次的订单列表(按 order_id 去重,未复核优先、wave_index 升序),顶层携带拣货人/任务等汇总信息(包括 picker_id、picker_name、pick_mode、total_orders、reviewed_count、unreviewed_count);团购模式(pick_mode 1/5)返回任务下所有团购波次及订单的分组列表(list_type='group')。", - "description": "按拣货任务 ID 拉取复核扫描视图。根据任务的 pick_mode 区分散单/团单模式,返回与 scanOrder 一致的数据结构,用于前端刷新数据。散单模式(pick_mode 2/3/4)扁平化任务下所有波次的订单列表(按 order_id 去重,未复核优先、wave_index 升序),顶层携带拣货人/任务等汇总信息(包括 picker_id、picker_name、pick_mode、total_orders、reviewed_count、unreviewed_count);团购模式(pick_mode 1/5)返回任务下所有团购波次及订单的分组列表(list_type='group')。", - "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", - "type": "number", - "required": true, - "description": "拣货任务 ID(对应 wms_wave_pick_task.id)" - } - ], - "response": [ - { - "name": "match_type", - "type": "string", - "required": true, - "description": "固定为 'task',表示通过任务 ID 匹配" - }, - { - "name": "list_type", - "type": "string", - "required": true, - "description": "列表模式:single(散单扁平列表)/ group(团购嵌套波次列表),由拣货任务的 pick_mode 决定" - }, - { - "name": "task_id", - "type": "number", - "required": true, - "description": "拣货任务 ID" - }, - { - "name": "picker_id", - "type": "number|null", - "required": false, - "description": "拣货人 ID(来自 wms_wave_pick_task.pick_user_id),散单模式返回" - }, - { - "name": "picker_name", - "type": "string", - "required": false, - "description": "拣货人名称(来自 wms_wave_pick_task.pick_user_name),散单模式返回" - }, - { - "name": "pick_mode", - "type": "number", - "required": false, - "description": "拣货模式:1-团购小波次 2-散单单品单件 3-散单先拣后分 4-边拣边分 5-团购大波次" - }, - { - "name": "wave_id", - "type": "number", - "required": false, - "description": "散单模式固定为 0,团购模式不返回" - }, - { - "name": "wave_no", - "type": "string", - "required": false, - "description": "散单模式固定为空字符串,团购模式不返回" - }, - { - "name": "wave_type", - "type": "number", - "required": false, - "description": "波次类型编码(取任务下第一个有效波次的 wave_type),散单模式返回" - }, - { - "name": "strategy_id", - "type": "number|null", - "required": false, - "description": "散单模式固定为 null(任务级别不绑定单一策略)" - }, - { - "name": "strategy_name", - "type": "string", - "required": false, - "description": "散单模式固定为空字符串(任务级别不绑定单一策略)" - }, - { - "name": "total_orders", - "type": "number", - "required": false, - "description": "任务下订单总数(去重后),散单模式返回" - }, - { - "name": "reviewed_count", - "type": "number", - "required": false, - "description": "已复核订单数,散单模式返回" - }, - { - "name": "unreviewed_count", - "type": "number", - "required": false, - "description": "未复核订单数,散单模式返回" - }, - { - "name": "list", - "type": "array", - "required": true, - "description": "统一列表输出。散单模式(list_type=single):扁平订单数组(每项结构与 scanOrder 散单有波次模式一致,含 order_id/delivery_order_code/waybill_no/pick_status/is_printed/is_reviewed/shop_nick/items_count/wave_index/recheck_status/order_type/status/logistics_name/store_remark/intercept_status/stock[])。团购模式(list_type=group):波次视图数组(结构与 scanOrder 团购模式一致,每项含 wave_id/wave_no/wave_type/wave_status/total_orders/processed_orders/creator/create_time/update_time/order_count/pick_mode/box_no/orders[])" - } - ] - }, - { - "method": "order.recheckOrder.batchQuickRecheck", - "title": "批量快捷复核:传入订单 IDs 列表,对每个有效订单执行前置检查(已分配储位、已分配快递、已同步且未被拦截),必要时自动完成拣货(含库存锁定校验与扣减、库存流水写入、拣货任务状态同步)后标记复核(含复核任务记录、任务复核状态更新、车任务解绑、操作日志)。每个订单在独立事务中执行,支持部分失败,不满足条件的订单跳过并返回原因。", - "description": "批量快捷复核:传入订单 IDs 列表,对每个有效订单执行前置检查(已分配储位、已分配快递、已同步且未被拦截),必要时自动完成拣货(含库存锁定校验与扣减、库存流水写入、拣货任务状态同步)后标记复核(含复核任务记录、任务复核状态更新、车任务解绑、操作日志)。每个订单在独立事务中执行,支持部分失败,不满足条件的订单跳过并返回原因。", - "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|string", - "required": true, - "description": "订单 ID 列表,支持数组或以逗号分隔的字符串" - } - ], - "response": [ - { - "name": "success", - "type": "array", - "required": true, - "description": "复核成功的订单列表" - }, - { - "name": "failed", - "type": "array", - "required": true, - "description": "复核失败的订单列表" - }, - { - "name": "success_count", - "type": "number", - "required": true, - "description": "成功数量" - }, - { - "name": "failed_count", - "type": "number", - "required": true, - "description": "失败数量" - } - ] - }, - { - "method": "order.recheckOrder.queryRecheckOrderSingleList", - "title": "散单模式复核列表查询,按订单维度返回待复核订单(排除 pick_status='none' 和 recheck_status='fin'),支持分页与关键词/波次号/复核状态筛选。与 recheckOrderList 不同:本方法仅处理散单模式,不包含团购分支。", - "description": "散单模式复核列表查询,按订单维度返回待复核订单(排除 pick_status='none' 和 recheck_status='fin'),支持分页与关键词/波次号/复核状态筛选。与 recheckOrderList 不同:本方法仅处理散单模式,不包含团购分支。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "where", - "type": "object", - "required": false, - "description": "筛选条件。支持 keyword(运单号/订单号模糊搜索)、wave_no(精确匹配)、recheck_status、pick_status" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数,支持 page / pageSize(默认 page=1, pageSize=20)" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "散单复核订单列表,每项含 order_id、delivery_order_code、order_type、wave_id、wave_no、pick_status、recheck_status、shop_nick、logistics_name、items_count、items_total、items_weight、weight_type、status、create_at、pick_time、recheck_time" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息,含 page、pageSize、total、totalPages、hasPrevious、hasNext" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/order.revieworder/_deleted.20260417.json b/workflows/api-doc-system/data/module/order.revieworder/_deleted.20260417.json deleted file mode 100644 index 85c41568..00000000 --- a/workflows/api-doc-system/data/module/order.revieworder/_deleted.20260417.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "folder": "order.revieworder", - "deletedAt": "2026-04-17 17:28:24", - "reason": "Missing from latest API doc parsing result" -} diff --git a/workflows/api-doc-system/data/module/order.revieworder/_module.lifecycle.json b/workflows/api-doc-system/data/module/order.revieworder/_module.lifecycle.json deleted file mode 100644 index 766fc76b..00000000 --- a/workflows/api-doc-system/data/module/order.revieworder/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "订单待审核模块", - "key": "order.reviewOrder", - "folder": "order.revieworder" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": "2026-04-17 19:16:50" -} diff --git a/workflows/api-doc-system/data/module/order.revieworder/module.json b/workflows/api-doc-system/data/module/order.revieworder/module.json deleted file mode 100644 index e041c432..00000000 --- a/workflows/api-doc-system/data/module/order.revieworder/module.json +++ /dev/null @@ -1,227 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "订单待审核模块", - "key": "order.reviewOrder", - "folder": "order.revieworder", - "interfaceCount": 3 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "order.reviewOrder.list", - "title": "待审核订单列表,默认仅查询 step=0 的订单。", - "description": "待审核订单列表,默认仅查询 step=0 的订单。", - "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": "分页信息" - }, - { - "name": "recheck_status", - "type": "string", - "required": false, - "description": "复核状态:none=未复核,fin=已复核" - } - ] - }, - { - "method": "order.reviewOrder.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.reviewOrder.reviewOrder", - "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 数组;仅允许 ids 字段,建议传数组,也兼容逗号字符串或单值" - } - ], - "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 列表" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/order.wave/_module.lifecycle.json b/workflows/api-doc-system/data/module/order.wave/_module.lifecycle.json deleted file mode 100644 index a53b1051..00000000 --- a/workflows/api-doc-system/data/module/order.wave/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "订单波次模块", - "key": "order.wave", - "folder": "order.wave" - }, - "status": "active", - "createdAt": "2026-05-04 09:11:04", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/order.wave/module.json b/workflows/api-doc-system/data/module/order.wave/module.json deleted file mode 100644 index c5c2b5d2..00000000 --- a/workflows/api-doc-system/data/module/order.wave/module.json +++ /dev/null @@ -1,2548 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "订单波次模块", - "key": "order.wave", - "folder": "order.wave", - "interfaceCount": 29 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "order.wave.waveStrategyList", - "title": "查询当前仓库波次策略列表。仅查询当前登录仓库在 wms_wave_strategy 中的数据,返回标准 list/pagination 结构。", - "description": "查询当前仓库波次策略列表。仅查询当前登录仓库在 wms_wave_strategy 中的数据,返回标准 list/pagination 结构。", - "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": "strategy_type", - "type": "number", - "required": false, - "description": "仅支持 1=散单、2=团购;与 where.strategy_type 同时存在时以顶层 strategy_type 为准。" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "当前仅支持 where.strategy_type(1/2);其余 where 字段暂不支持。" - }, - { - "name": "calculate_next_fetch_order_count / calculateNextFetchOrderCount", - "type": "number", - "required": false, - "description": "0-不计算(默认),1-计算并返回每条策略的 next_fetch_order_count;支持别名 calculateNextFetchOrderCount" - }, - { - "name": "debug", - "type": "number", - "required": false, - "description": "0-不启用(默认),1-启用调试输出,返回每条策略的 next_fetch_order_list(含结构/快递/货主ID等指标明细)" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "策略列表,每项为波次策略记录" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - } - ] - }, - { - "method": "order.wave.waveStrategyCreate", - "title": "新增波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。创建成功后会推进仓库的 wave_strategy_version 并失效相关缓存。", - "description": "新增波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。创建成功后会推进仓库的 wave_strategy_version 并失效相关缓存。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "strategy_name", - "type": "string", - "required": true, - "description": "策略名称(必填)" - }, - { - "name": "strategy_type", - "type": "number", - "required": true, - "description": "策略类型(必填,正整数):1-散单 2-团购" - }, - { - "name": "batch_mode", - "type": "number", - "required": true, - "description": "拣货模式(必填,正整数)" - }, - { - "name": "status", - "type": "number", - "required": false, - "description": "状态:1-启用 0-停用(可选)" - }, - { - "name": "order_min_sku", - "type": "number", - "required": false, - "description": "订单最小 SKU 种类数(可选,正整数或 null)" - }, - { - "name": "order_max_sku", - "type": "number", - "required": false, - "description": "订单最大 SKU 种类数(可选,正整数或 null)" - }, - { - "name": "order_min_qty", - "type": "number", - "required": false, - "description": "订单最小商品总数(可选,正整数或 null)" - }, - { - "name": "order_max_qty", - "type": "number", - "required": false, - "description": "订单最大商品总数(可选,正整数或 null)" - }, - { - "name": "min_same_structure", - "type": "number", - "required": false, - "description": "最小相同结构订单数(可选,正整数或 null)" - }, - { - "name": "max_same_structure", - "type": "number", - "required": false, - "description": "最大相同结构订单数(可选,正整数或 null)。注意:若传入值 >= 仓库配置的 min_group_order_fetch_quantity,则会被下调为 min_group_order_fetch_quantity - 1,最小为 1。" - }, - { - "name": "batch_max_orders", - "type": "number", - "required": false, - "description": "批次最大订单数(可选)" - }, - { - "name": "batch_max_skus", - "type": "number", - "required": false, - "description": "批次最大 SKU 总数(可选)" - }, - { - "name": "group_batch_max_orders", - "type": "number", - "required": false, - "description": "团购批次最大订单数(可选)" - }, - { - "name": "require_same_express", - "type": "boolean", - "required": false, - "description": "是否要求相同快递(可选,布尔)" - }, - { - "name": "allow_cross_owner", - "type": "boolean", - "required": false, - "description": "是否允许跨货主(可选,布尔)" - }, - { - "name": "description", - "type": "string", - "required": false, - "description": "策略描述(可选)" - }, - { - "name": "allowed_provinces", - "type": "array|string", - "required": false, - "description": "允许的省份列表(可选,支持数组、JSON 字符串或逗号分隔字符串)" - }, - { - "name": "allowed_platforms", - "type": "array|string", - "required": false, - "description": "允许的平台列表(可选,支持数组、JSON 字符串或逗号分隔字符串)" - }, - { - "name": "allowed_owners", - "type": "array|string", - "required": false, - "description": "允许的货主列表(可选,支持数组/JSON/逗号分隔);系统会校验所传货主是否在仓库可用货主范围内,非法值将导致 400 错误。" - }, - { - "name": "allowed_expresses", - "type": "array|string", - "required": false, - "description": "允许的快递编码列表(可选,支持数组/JSON/逗号分隔);系统会校验所传编码是否在可用快递列表内,非法值将导致 400 错误。" - }, - { - "name": "wave_prefix", - "type": "string", - "required": false, - "description": "波次编号前缀(可选),最多 5 个字符,如 D、B、A;不传则保持原值" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": true, - "description": "创建的策略对象,字段同 order.wave.waveStrategyList.list[*] 所示" - }, - { - "name": "code", - "type": "number", - "required": true, - "description": "HTTP-like 状态码,成功时返回 200" - } - ] - }, - { - "method": "order.wave.waveStrategyUpdate", - "title": "修改波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。id(或 strategy_id/strategyId)为必填主键,其他字段为可选更新;更新成功后会推进仓库的 wave_strategy_version 并失效相关缓存。", - "description": "修改波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。id(或 strategy_id/strategyId)为必填主键,其他字段为可选更新;更新成功后会推进仓库的 wave_strategy_version 并失效相关缓存。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id / strategy_id / strategyId", - "type": "number", - "required": true, - "description": "策略主键,兼容 id / strategy_id / strategyId(必填)" - }, - { - "name": "strategy_name", - "type": "string", - "required": false, - "description": "策略名称(可选)" - }, - { - "name": "strategy_type", - "type": "number", - "required": false, - "description": "策略类型(可选,正整数)" - }, - { - "name": "batch_mode", - "type": "number", - "required": false, - "description": "拣货模式(可选,正整数)" - }, - { - "name": "status", - "type": "number", - "required": false, - "description": "状态:1-启用 0-停用(可选)" - }, - { - "name": "order_min_sku", - "type": "number", - "required": false, - "description": "订单最小 SKU 种类数(可选,正整数或 null)" - }, - { - "name": "order_max_sku", - "type": "number", - "required": false, - "description": "订单最大 SKU 种类数(可选,正整数或 null)" - }, - { - "name": "order_min_qty", - "type": "number", - "required": false, - "description": "订单最小商品总数(可选,正整数或 null)" - }, - { - "name": "order_max_qty", - "type": "number", - "required": false, - "description": "订单最大商品总数(可选,正整数或 null)" - }, - { - "name": "min_same_structure", - "type": "number", - "required": false, - "description": "最小相同结构订单数(可选,正整数或 null)" - }, - { - "name": "max_same_structure", - "type": "number", - "required": false, - "description": "最大相同结构订单数(可选,正整数或 null)。会受仓库 min_group_order_fetch_quantity 约束,接口会自动调整。" - }, - { - "name": "batch_max_orders", - "type": "number", - "required": false, - "description": "批次最大订单数(可选)" - }, - { - "name": "batch_max_skus", - "type": "number", - "required": false, - "description": "批次最大 SKU 总数(可选)" - }, - { - "name": "group_batch_max_orders", - "type": "number", - "required": false, - "description": "团购批次最大订单数(可选)" - }, - { - "name": "require_same_express", - "type": "boolean", - "required": false, - "description": "是否要求相同快递(可选,布尔)" - }, - { - "name": "allow_cross_owner", - "type": "boolean", - "required": false, - "description": "是否允许跨货主(可选,布尔)" - }, - { - "name": "description", - "type": "string", - "required": false, - "description": "策略描述(可选)" - }, - { - "name": "allowed_provinces", - "type": "array|string", - "required": false, - "description": "允许的省份列表(可选,支持数组/JSON/逗号分隔)" - }, - { - "name": "allowed_platforms", - "type": "array|string", - "required": false, - "description": "允许的平台列表(可选,支持数组/JSON/逗号分隔)" - }, - { - "name": "allowed_owners", - "type": "array|string", - "required": false, - "description": "允许的货主列表(可选,支持数组/JSON/逗号分隔);系统会校验所传货主是否在仓库可用货主范围内,非法值将导致 400 错误。" - }, - { - "name": "allowed_expresses", - "type": "array|string", - "required": false, - "description": "允许的快递编码列表(可选,支持数组/JSON/逗号分隔);系统会校验所传编码是否在可用快递列表内,非法值将导致 400 错误。" - }, - { - "name": "wave_prefix", - "type": "string", - "required": false, - "description": "波次编号前缀(可选),最多 5 个字符,如 D、B、A;不传则保持原值" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": true, - "description": "更新后的策略对象,字段同 order.wave.waveStrategyList.list[*] 所示" - }, - { - "name": "code", - "type": "number", - "required": true, - "description": "HTTP-like 状态码,成功时返回 200" - } - ] - }, - { - "method": "order.wave.waveStrategyQuickScan", - "title": "提交波次策略快速扫描异步任务。无外部参数,使用当前仓库上下文;同一仓库同一时刻仅允许一个任务运行,若已有运行任务直接返回已有 task_id。", - "description": "提交波次策略快速扫描异步任务。无外部参数,使用当前仓库上下文;同一仓库同一时刻仅允许一个任务运行,若已有运行任务直接返回已有 task_id。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [ - { - "name": "status", - "type": "string", - "required": true, - "description": "提交状态,固定 success" - }, - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(用于后续查询进度)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库 ID(来自当前上下文)" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态(一般为 submitted 或 running)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "可选提示信息" - }, - { - "name": "accepted_at", - "type": "string", - "required": false, - "description": "任务受理时间(ISO 字符串)" - } - ] - }, - { - "method": "order.wave.waveStrategyFetchPda", - "title": "按策略提交并创建抓取主流程任务(PDA)。当前为最小主流程:进行入参校验并创建任务记录,返回创建结果与计划预览;后续扫描/执行阶段将扩展为完整执行流。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。", - "description": "按策略提交并创建抓取主流程任务(PDA)。当前为最小主流程:进行入参校验并创建任务记录,返回创建结果与计划预览;后续扫描/执行阶段将扩展为完整执行流。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "strategy_id / strategyId", - "type": "number", - "required": true, - "description": "策略ID(正整数,支持下划线/驼峰)" - }, - { - "name": "cart_id / cartId", - "type": "string|number", - "required": false, - "description": "可选,关联拣货车/作业车ID,支持字符串或数字,用于记录作业上下文" - }, - { - "name": "source / operation_source", - "type": "string", - "required": false, - "description": "可选,操作来源标识(例如 pda/admin/manual/auto),用于审计与分流策略" - }, - { - "name": "strategy_params / strategyParams", - "type": "object", - "required": false, - "description": "可选,策略参数透传对象(如 order_min_qty/order_max_qty/allow_cross_owner 等),在创建任务时作为策略覆盖或附加参数使用" - } - ], - "response": [ - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态:created(已创建主流程任务),后续可能为 running/success/failed" - }, - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务唯一 ID(用于后续查询或关联)" - }, - { - "name": "task_no", - "type": "string", - "required": true, - "description": "任务业务编号(便于展示与关联)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "生效的仓库 ID(来自当前上下文,如可用则返回)" - }, - { - "name": "strategy_id", - "type": "number", - "required": false, - "description": "生效的策略 ID(与入参保持一致,兼容回传)" - }, - { - "name": "plan", - "type": "object", - "required": true, - "description": "任务计划/执行预览对象,描述本次任务预估的执行计划" - }, - { - "name": "plan_summary", - "type": "string", - "required": true, - "description": "计划摘要字符串,便于前端在受理后快速展示(例如:'创建 3 个波次,涉及 120 单,约 450 件')" - }, - { - "name": "validation_errors", - "type": "array", - "required": false, - "description": "当入参校验失败时返回的数组,每项为 { field, message } 对象,供前端展示或定位问题" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "可选提示信息或错误说明(创建失败时返回简短说明)" - }, - { - "name": "fetch_state", - "type": "number", - "required": true, - "description": "抓取结果三态:1=成功创建任务(返回 task_id/task_no),2=普通失败(task_id=null),3=存在未完成任务(返回 existing task_id/task_no,前端可进入拣货流程)" - }, - { - "name": "tip", - "type": "string", - "required": false, - "description": "简短提示,用于向前端展示简要原因或下一步建议" - }, - { - "name": "can_enter_pick_flow", - "type": "boolean", - "required": false, - "description": "仅当 fetch_state=3 时为 true,表示前端可直接进入拣货流程" - } - ] - }, - { - "method": "order.wave.waveStrategyFetchAdmin", - "title": "按策略提交并创建抓取主流程任务(后台管理)。当前为最小主流程:执行入参校验并创建任务记录,返回创建结果与计划预览;后续将扩展完整扫描/执行链路。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。", - "description": "按策略提交并创建抓取主流程任务(后台管理)。当前为最小主流程:执行入参校验并创建任务记录,返回创建结果与计划预览;后续将扩展完整扫描/执行链路。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "strategy_id / strategyId", - "type": "number", - "required": true, - "description": "策略ID(正整数,支持下划线/驼峰)" - }, - { - "name": "cart_id / cartId", - "type": "string|number", - "required": false, - "description": "可选,关联拣货车/作业车ID,用于记录作业上下文或幂等识别" - }, - { - "name": "source / operation_source", - "type": "string", - "required": false, - "description": "可选,操作来源标识(例如 admin/pda/manual/auto),用于审计与分流策略" - }, - { - "name": "strategy_params / strategyParams", - "type": "object", - "required": false, - "description": "可选,策略参数透传对象(如 order_min_qty/order_max_qty/allow_cross_owner 等),在创建任务时作为策略覆盖或附加参数使用" - } - ], - "response": [ - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态:created(已创建主流程任务),后续可能为 running/success/failed" - }, - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务唯一 ID(用于后续查询或关联)" - }, - { - "name": "task_no", - "type": "string", - "required": true, - "description": "任务业务编号(便于展示与关联)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "生效的仓库 ID(来自当前上下文,如可用则返回)" - }, - { - "name": "strategy_id", - "type": "number", - "required": false, - "description": "生效的策略 ID(与入参保持一致,兼容回传)" - }, - { - "name": "plan", - "type": "object", - "required": true, - "description": "任务计划/执行预览对象,描述本次任务预估的执行计划" - }, - { - "name": "plan_summary", - "type": "string", - "required": true, - "description": "计划摘要字符串,便于前端在受理后快速展示(例如:'创建 3 个波次,涉及 120 单,约 450 件')" - }, - { - "name": "validation_errors", - "type": "array", - "required": false, - "description": "当入参校验失败时返回的数组,每项为 { field, message } 对象,供前端展示或定位问题" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "可选提示信息或错误说明(创建失败时返回简短说明)" - }, - { - "name": "fetch_state", - "type": "number", - "required": true, - "description": "抓取结果三态:1=成功创建任务(返回 task_id/task_no),2=普通失败(task_id=null),3=存在未完成任务(返回 existing task_id/task_no,前端可进入拣货流程)" - }, - { - "name": "tip", - "type": "string", - "required": false, - "description": "简短提示,用于向前端展示简要原因或下一步建议" - }, - { - "name": "can_enter_pick_flow", - "type": "boolean", - "required": false, - "description": "仅当 fetch_state=3 时为 true,表示前端可直接进入拣货流程" - } - ] - }, - { - "method": "order.wave.waveStrategyQuickScanTaskProgress", - "title": "查询波次策略快速扫描任务进度。接受 task_id / taskId,若未找到返回 state='not_found'。", - "description": "查询波次策略快速扫描任务进度。接受 task_id / taskId,若未找到返回 state='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(下划线或驼峰兼容,必填)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态:submitted/running/success/failed/not_found" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "仓库 ID" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "扫描订单总数" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数" - }, - { - "name": "matched_order_count", - "type": "number", - "required": false, - "description": "命中策略的订单数" - }, - { - "name": "unmatched_order_count", - "type": "number", - "required": false, - "description": "未命中策略的订单数" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比(0-100)" - }, - { - "name": "submitted_at", - "type": "string", - "required": false, - "description": "提交时间(timestamp 或 ISO)" - }, - { - "name": "start_time", - "type": "string", - "required": false, - "description": "实际开始时间(ISO)" - }, - { - "name": "end_time", - "type": "string", - "required": false, - "description": "结束时间(ISO)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "错误信息(若失败)" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "错误码(若失败)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "耗时,毫秒" - } - ] - }, - { - "method": "order.wave.groupOrderFetchList", - "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": "pagination", - "type": "object", - "required": false, - "description": "分页参数,支持 page / pageSize" - }, - { - "name": "distinguish_express", - "type": "boolean", - "required": false, - "description": "是否区分快递(影响分组粒度)" - }, - { - "name": "store_id", - "type": "number", - "required": false, - "description": "货主ID(仅作为筛选条件)" - }, - { - "name": "same_order_quantity", - "type": "number", - "required": false, - "description": "最小同组订单数量阈值(>=)。若显式传入有效数值则按传入值使用;未传入时使用仓库配置 min_group_order_fetch_quantity(默认 13)。" - }, - { - "name": "shop_name", - "type": "string", - "required": false, - "description": "店铺名称(模糊匹配)" - }, - { - "name": "include_sku", - "type": "string", - "required": false, - "description": "仅保留包含该 SKU 的分组(页内过滤)" - }, - { - "name": "return_order_ids", - "type": "boolean", - "required": false, - "description": "是否在结果中返回组内订单ID列表" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "分组列表,每项包含 item_detail、item_detail_machine、item_detail_machine_snapshot、item_snapshot、group、group_count、items_total、items_weight(总重量kg,取组内首单 items_weight)、store_id、store_ids、logistics_name、distinguish_express、first_order_time、last_order_time、status_summary 等字段;若指定 return_order_ids=true 则额外包含 order_ids" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - } - ] - }, - { - "method": "order.wave.singleFetchByIds", - "title": "按订单 ID 列表抓取到一个散单波次。仅处理当前仓库的待处理订单(step in [1,2,3]),排除已在波次中的订单(wave_id>0),不区分快递;成功抓取后批量写入订单操作日志;当无可抓取订单时返回 wave_id=0。", - "description": "按订单 ID 列表抓取到一个散单波次。仅处理当前仓库的待处理订单(step in [1,2,3]),排除已在波次中的订单(wave_id>0),不区分快递;成功抓取后批量写入订单操作日志;当无可抓取订单时返回 wave_id=0。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "ids / order_ids / orderIds", - "type": "array|string|number", - "required": true, - "description": "订单 ID 列表;支持数组、逗号分隔字符串或单个 ID。入参会被去重并转换为正整数。字段解析优先顺序:ids -> order_ids -> orderIds。" - } - ], - "response": [ - { - "name": "ids", - "type": "array", - "required": true, - "description": "请求归一化后的 ids 列表(去重且为正整数)" - }, - { - "name": "wave_id", - "type": "number", - "required": true, - "description": "创建的波次 ID;若无可抓取订单返回 0" - }, - { - "name": "wave_no", - "type": "string", - "required": true, - "description": "创建的波次号;无可抓取时为空字符串" - }, - { - "name": "fetched_order_ids", - "type": "array", - "required": true, - "description": "实际被抓取并成功分配到波次的订单 ID 列表(为归一化后的 ids 的子集)" - }, - { - "name": "fetched_order_count", - "type": "number", - "required": true, - "description": "实际被抓取的订单数量(等于 fetched_order_ids.length)" - }, - { - "name": "excluded_existing_wave_order_ids", - "type": "array", - "required": false, - "description": "原始入参中已在其它波次中的订单 ID(被排除,不会被抓取)" - }, - { - "name": "skipped_order_ids", - "type": "array", - "required": false, - "description": "因订单状态不符、正在出库或其他业务原因被跳过的订单 ID(不会被抓取)" - }, - { - "name": "not_found_order_ids", - "type": "array", - "required": false, - "description": "入参中未在数据库中找到的订单 ID" - } - ] - }, - { - "method": "order.wave.waveStrategyFallbackOrderList", - "title": "基于波次策略的回退候选订单列表。该接口内置固定筛选条件:step != 0、wave_id = 0、wave_scan_result = 2。用于展示策略未命中但需回退处理的订单候选。", - "description": "基于波次策略的回退候选订单列表。该接口内置固定筛选条件:step != 0、wave_id = 0、wave_scan_result = 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": "筛选白名单字段(object)。仅支持下列字段,且禁止传入 warehouse_id / warehouseId: - id(等值) - delivery_no / deliveryNo(模糊) - tracking_no / trackingNo(模糊) - items_count_min / items_count_max(范围) - items_total_min / items_total_max(范围) - sys_logistics_name(模糊) - store_name(模糊) - owner_name(等值) - province(模糊) - sys_platform_name(模糊) 说明:若传入未列出的字段或禁止字段(如 warehouse_id)接口会返回 400。" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "回退候选订单简要列表。数组内对象字段说明见 children。" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - } - ] - }, - { - "method": "order.wave.singleOrderFetchList", - "title": "按机器结构分组的散单候选列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。与 order.wave.groupOrderFetchList 不同:groupOrderFetchList 返回满足同组订单数量 >= same_order_quantity(或仓库配置 min_group_order_fetch_quantity)的团购命中分组;singleOrderFetchList 则排除这些团购命中分组,仅返回同组订单数量小于该阈值的散单候选分组(即 < same_order_quantity)。", - "description": "按机器结构分组的散单候选列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。与 order.wave.groupOrderFetchList 不同:groupOrderFetchList 返回满足同组订单数量 >= same_order_quantity(或仓库配置 min_group_order_fetch_quantity)的团购命中分组;singleOrderFetchList 则排除这些团购命中分组,仅返回同组订单数量小于该阈值的散单候选分组(即 < same_order_quantity)。", - "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": "distinguish_express", - "type": "boolean", - "required": false, - "description": "是否区分快递(影响分组粒度)" - }, - { - "name": "store_id", - "type": "number", - "required": false, - "description": "货主ID(仅作为筛选条件)" - }, - { - "name": "same_order_quantity", - "type": "number", - "required": false, - "description": "最小同组订单数量阈值(用于判定团购命中);本接口返回同组订单数量小于该阈值的分组。若显式传入有效数值则按传入值使用;未传入时使用仓库配置 min_group_order_fetch_quantity(默认 13)。" - }, - { - "name": "shop_name", - "type": "string", - "required": false, - "description": "店铺名称(模糊匹配)" - }, - { - "name": "include_sku", - "type": "string", - "required": false, - "description": "仅保留包含该 SKU 的分组(页内过滤)" - }, - { - "name": "return_order_ids", - "type": "boolean", - "required": false, - "description": "是否在结果中返回组内订单ID列表" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "散单候选分组列表,每项包含 item_detail、item_detail_machine、item_detail_machine_snapshot、item_snapshot、group、group_count、items_total、items_weight(总重量kg,取组内首单 items_weight)、store_id、store_ids、logistics_name、distinguish_express、first_order_time、last_order_time、status_summary 等字段;返回的 group_count 均小于 same_order_quantity(或仓库配置的 min_group_order_fetch_quantity);若指定 return_order_ids=true 则额外包含 order_ids" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - } - ] - }, - { - "method": "order.wave.wavePickTaskList", - "title": "按当前仓库分页查询拣货任务列表。支持顶层分页参数 `page_no`/`page_size`(兼容 `pagination` 对象与 `current/size`),支持 `status` 单值或数组;兼容历史 `where` 结构,顶层参数优先。默认按 create_time desc 排序。", - "description": "按当前仓库分页查询拣货任务列表。支持顶层分页参数 `page_no`/`page_size`(兼容 `pagination` 对象与 `current/size`),支持 `status` 单值或数组;兼容历史 `where` 结构,顶层参数优先。默认按 create_time desc 排序。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID(必填)" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数,支持 page / pageSize,兼容 current / size(兼容旧客户端)" - }, - { - "name": "page_no", - "type": "number", - "required": false, - "description": "页码(优先于 pagination.page/current)" - }, - { - "name": "page_size", - "type": "number", - "required": false, - "description": "每页大小(优先于 pagination.pageSize/size)" - }, - { - "name": "status", - "type": "array", - "required": false, - "description": "拣货任务状态过滤;建议传数组,也兼容单值或逗号分隔字符串,兼容 where.status;顶层参数优先" - }, - { - "name": "review_status", - "type": "number", - "required": false, - "description": "复核状态过滤" - }, - { - "name": "pick_mode", - "type": "number", - "required": false, - "description": "拣货模式(如批量/逐单等)" - }, - { - "name": "source", - "type": "string", - "required": false, - "description": "任务来源标识(业务端语义)" - }, - { - "name": "pick_user_id", - "type": "number", - "required": false, - "description": "拣货执行人ID(兼容旧字段)" - }, - { - "name": "review_user_id", - "type": "number", - "required": false, - "description": "复核人ID" - }, - { - "name": "task_no", - "type": "string", - "required": false, - "description": "任务编号(支持模糊匹配)" - }, - { - "name": "cart_id", - "type": "number", - "required": false, - "description": "拣货车/作业车ID" - }, - { - "name": "keyword", - "type": "string", - "required": false, - "description": "关键字搜索:支持 task_no / batch_no / current_cart_code_snapshot 等字段的模糊匹配" - }, - { - "name": "start_time_start", - "type": "string", - "required": false, - "description": "开始时间(ISO 字符串),与 start_time_end 一起用于时间范围过滤" - }, - { - "name": "start_time_end", - "type": "string", - "required": false, - "description": "结束时间(ISO 字符串),与 start_time_start 一起用于时间范围过滤" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "兼容历史 where 结构(可包含 status 等字段);当存在顶层同名参数时,顶层参数优先" - }, - { - "name": "strategy_id", - "type": "number", - "required": false, - "description": "策略ID(当前主表未存,该接口会忽略此过滤,建议勿使用)" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "拣货任务列表(数组),每项字段如下" - }, - { - "name": "total", - "type": "number", - "required": true, - "description": "总记录数" - }, - { - "name": "page", - "type": "number", - "required": true, - "description": "当前页码" - }, - { - "name": "page_size", - "type": "number", - "required": true, - "description": "每页大小" - } - ] - }, - { - "method": "order.wave.wavePickTaskCancel", - "title": "取消拣货任务(批量)。可取消的状态:0=待开始、1=拣货中、2=待复核(拣货完成)、3=已完成,状态9(已取消)或其他状态不允许取消。同时释放关联波次(物理删除波次记录,订单回池)、解绑拣货车、写操作日志。对于status=2或3的任务,取消时会自动回退订单拣货状态:wms_wave_pick_task_order.pick_status(1→0)、order_delivery.pick_status(fin→padding)。入参仅支持 task_ids(数组,必填),不再支持单个 task_id。操作人与仓库从请求上下文获取(例如当前登录用户上下文 ctx.user),若上下文缺失接口将返回错误。", - "description": "取消拣货任务(批量)。可取消的状态:0=待开始、1=拣货中、2=待复核(拣货完成)、3=已完成,状态9(已取消)或其他状态不允许取消。同时释放关联波次(物理删除波次记录,订单回池)、解绑拣货车、写操作日志。对于status=2或3的任务,取消时会自动回退订单拣货状态:wms_wave_pick_task_order.pick_status(1→0)、order_delivery.pick_status(fin→padding)。入参仅支持 task_ids(数组,必填),不再支持单个 task_id。操作人与仓库从请求上下文获取(例如当前登录用户上下文 ctx.user),若上下文缺失接口将返回错误。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "task_ids", - "type": "array", - "required": true, - "description": "任务ID数组,例如 [123,124];仅支持批量处理,不再支持单个 task_id。" - } - ], - "response": [ - { - "name": "cancelled_count", - "type": "number", - "required": false, - "description": "成功取消的任务数量" - }, - { - "name": "task_ids", - "type": "array", - "required": false, - "description": "处理的任务ID数组(若后端返回)" - }, - { - "name": "task_nos", - "type": "array", - "required": false, - "description": "处理的任务编号数组(若后端返回)" - }, - { - "name": "task_id", - "type": "number", - "required": false, - "description": "任务ID(历史兼容,若后端仍返回)" - }, - { - "name": "task_no", - "type": "string", - "required": false, - "description": "任务编号(历史兼容,若后端仍返回)" - } - ] - }, - { - "method": "order.wave.wavePickTaskCancelSelf", - "title": "取消单个拣货任务(仅允许取消当前操作人本人创建的任务;仅支持单个 task_id,明确不支持 task_ids)", - "description": "取消单个拣货任务(仅允许取消当前操作人本人创建的任务;仅支持单个 task_id,明确不支持 task_ids)", - "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", - "type": "number", - "required": true, - "description": "要取消的单个任务 ID(仅支持单个,不支持 task_ids)" - } - ], - "response": [ - { - "name": "cancelled_count", - "type": "number", - "required": false, - "description": "成功取消的任务数量(0 或 1)" - }, - { - "name": "task_id", - "type": "number", - "required": false, - "description": "被处理的任务ID" - }, - { - "name": "task_no", - "type": "string", - "required": false, - "description": "被处理的任务编号(若后端返回)" - } - ] - }, - { - "method": "order.wave.batchCancel", - "title": "提交批量解除波次异步任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理波次并执行解除操作;可通过 order.wave.batchCancelTaskProgress 查询进度与结果。", - "description": "提交批量解除波次异步任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理波次并执行解除操作;可通过 order.wave.batchCancelTaskProgress 查询进度与结果。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "wave_ids / waveIds / ids", - "type": "array|string|number", - "required": true, - "description": "波次ID列表;支持数组、逗号分隔字符串或单个ID" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "可选外部任务ID,用于幂等提交" - } - ], - "response": [ - { - "name": "status", - "type": "string", - "required": true, - "description": "提交状态,固定 success" - }, - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(用于查询任务进度)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "当前仓库ID" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO8601)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "受理提示信息" - } - ] - }, - { - "method": "order.wave.batchCancelTaskProgress", - "title": "查询批量解除波次任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。响应包含 state、progress_percent、processed_wave_count、total_wave_count;当 state 为 success/failed 时返回额外字段说明。", - "description": "查询批量解除波次任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。响应包含 state、progress_percent、processed_wave_count、total_wave_count;当 state 为 success/failed 时返回额外字段说明。", - "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(后端生成或提交时传入)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比(0-100)" - }, - { - "name": "processed_wave_count", - "type": "number", - "required": false, - "description": "已处理的波次数量" - }, - { - "name": "total_wave_count", - "type": "number", - "required": false, - "description": "总波次数量" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "失败时的错误信息(仅在 state=failed 时返回)" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "失败时的错误码(仅在 state=failed 时返回)" - }, - { - "name": "result", - "type": "object", - "required": false, - "description": "成功时返回的汇总结果(仅在 state=success 时返回),例如 { \"processed_wave_count\": number, \"canceled_wave_count\": number }" - } - ] - }, - { - "method": "order.wave.batchAllocateExpress", - "title": "提交批次分配快递号任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到快递号分配流水线。", - "description": "提交批次分配快递号任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到快递号分配流水线。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "wave_ids / waveIds / ids", - "type": "array|string|number", - "required": true, - "description": "波次ID列表;支持数组、逗号分隔字符串或单个ID" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "可选外部任务ID,用于幂等提交" - } - ], - "response": [ - { - "name": "status", - "type": "string", - "required": true, - "description": "提交状态,固定 success" - }, - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(用于查询任务进度)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "当前仓库ID" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO8601)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "受理提示信息" - } - ] - }, - { - "method": "order.wave.batchAllocateExpressTaskProgress", - "title": "查询批次分配快递号任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", - "description": "查询批次分配快递号任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", - "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(后端生成或提交时传入)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "任务关联仓库ID" - }, - { - "name": "total_wave_count", - "type": "number", - "required": false, - "description": "波次数量" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "参与分配的订单数量" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数量" - }, - { - "name": "success_order_count", - "type": "number", - "required": false, - "description": "成功提交分配的订单数量" - }, - { - "name": "failed_order_count", - "type": "number", - "required": false, - "description": "提交分配失败的订单数量" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比(0-100)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "失败时的错误信息" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "失败时的错误码" - } - ] - }, - { - "method": "order.wave.batchRemoveExceptionOrders", - "title": "提交批次移除异常订单任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取异常订单并移出波次。", - "description": "提交批次移除异常订单任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取异常订单并移出波次。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "wave_ids / waveIds / ids", - "type": "array|string|number", - "required": true, - "description": "波次ID列表;支持数组、逗号分隔字符串或单个ID" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "可选外部任务ID,用于幂等提交" - } - ], - "response": [ - { - "name": "status", - "type": "string", - "required": true, - "description": "提交状态,固定 success" - }, - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(用于查询任务进度)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "当前仓库ID" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO8601)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "受理提示信息" - } - ] - }, - { - "method": "order.wave.batchRemoveExceptionOrdersTaskProgress", - "title": "查询批次移除异常订单任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", - "description": "查询批次移除异常订单任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", - "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(后端生成或提交时传入)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "任务关联仓库ID" - }, - { - "name": "total_wave_count", - "type": "number", - "required": false, - "description": "波次数量" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "参与处理的订单数量" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数量" - }, - { - "name": "removed_order_count", - "type": "number", - "required": false, - "description": "已成功移出波次的订单数量" - }, - { - "name": "failed_order_count", - "type": "number", - "required": false, - "description": "处理失败的订单数量" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比(0-100)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "失败时的错误信息" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "失败时的错误码" - } - ] - }, - { - "method": "order.wave.batchAllocateStorage", - "title": "提交批次分配储位任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到储位分配流水线。", - "description": "提交批次分配储位任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到储位分配流水线。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "wave_ids / waveIds / ids", - "type": "array|string|number", - "required": true, - "description": "波次ID列表;支持数组、逗号分隔字符串或单个ID" - }, - { - "name": "task_id / taskId", - "type": "string", - "required": false, - "description": "可选外部任务ID,用于幂等提交" - } - ], - "response": [ - { - "name": "status", - "type": "string", - "required": true, - "description": "提交状态,固定 success" - }, - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(用于查询任务进度)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "当前仓库ID" - }, - { - "name": "accepted_at", - "type": "string", - "required": true, - "description": "任务受理时间(ISO8601)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "受理提示信息" - } - ] - }, - { - "method": "order.wave.batchAllocateStorageTaskProgress", - "title": "查询批次分配储位任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", - "description": "查询批次分配储位任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", - "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(后端生成或提交时传入)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID" - }, - { - "name": "state", - "type": "string", - "required": true, - "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "任务关联仓库ID" - }, - { - "name": "total_wave_count", - "type": "number", - "required": false, - "description": "波次数量" - }, - { - "name": "total_order_count", - "type": "number", - "required": false, - "description": "参与分配的订单数量" - }, - { - "name": "processed_order_count", - "type": "number", - "required": false, - "description": "已处理订单数量" - }, - { - "name": "success_order_count", - "type": "number", - "required": false, - "description": "成功提交分配的订单数量" - }, - { - "name": "failed_order_count", - "type": "number", - "required": false, - "description": "提交分配失败的订单数量" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比(0-100)" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务耗时(毫秒)" - }, - { - "name": "error_message", - "type": "string", - "required": false, - "description": "失败时的错误信息" - }, - { - "name": "error_code", - "type": "string", - "required": false, - "description": "失败时的错误码" - } - ] - }, - { - "method": "order.wave.groupFetch", - "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": "structure_list", - "type": "array", - "required": true, - "description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识),可选 quantity(未传入时使用仓库默认或全局默认)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "生效的仓库 ID" - }, - { - "name": "structure_count", - "type": "number", - "required": true, - "description": "本次入参的结构数量(structure_list 长度)" - }, - { - "name": "default_quantity", - "type": "number", - "required": true, - "description": "仓库默认抓取数量或全局默认值" - }, - { - "name": "fetch_mode", - "type": "string", - "required": false, - "description": "抓取模式,值为 'group'(团购)或 'single'(散单)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明" - } - ] - }, - { - "method": "order.wave.singleFetch", - "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": "structure_list", - "type": "array", - "required": true, - "description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识)并包含必填字段 max_fetch_quantity(最大抓取上限,订单数,正整数);可选 quantity(未传入时使用仓库默认或全局默认)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "生效的仓库 ID" - }, - { - "name": "structure_count", - "type": "number", - "required": true, - "description": "本次入参的结构数量(structure_list 长度)" - }, - { - "name": "default_quantity", - "type": "number", - "required": true, - "description": "仓库默认抓取数量或全局默认值" - }, - { - "name": "fetch_mode", - "type": "string", - "required": false, - "description": "抓取模式,值为 'group'(团购)或 'single'(散单)" - }, - { - "name": "max_fetch_quantity", - "type": "number", - "required": false, - "description": "提交时生效的最大抓取上限(订单数,正整数)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明" - } - ] - }, - { - "method": "order.wave.fetch", - "title": "兼容别名(等同 groupFetch)", - "description": "兼容别名(等同 groupFetch)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "structure_list", - "type": "array", - "required": true, - "description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识),可选 quantity(未传入时使用仓库默认或全局默认)" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "生效的仓库 ID" - }, - { - "name": "structure_count", - "type": "number", - "required": true, - "description": "本次入参的结构数量(structure_list 长度)" - }, - { - "name": "default_quantity", - "type": "number", - "required": true, - "description": "仓库默认抓取数量或全局默认值" - }, - { - "name": "fetch_mode", - "type": "string", - "required": false, - "description": "抓取模式,值为 'group'(团购)或 'single'(散单)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明" - } - ] - }, - { - "method": "order.wave.fetchTaskProgress", - "title": "查询波次抓取任务进度:按 task_id 查询任务状态与进度;兼容 taskId 参数名。", - "description": "查询波次抓取任务进度:按 task_id 查询任务状态与进度;兼容 taskId 参数名。", - "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,可从 order.wave.fetch 的返回值中获取" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "任务 ID" - }, - { - "name": "status", - "type": "string", - "required": true, - "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "生效的仓库 ID(若任务关联仓库时返回)" - }, - { - "name": "structure_count", - "type": "number", - "required": false, - "description": "本次任务的结构数量(structure_list 长度)" - }, - { - "name": "finished_structure_count", - "type": "number", - "required": false, - "description": "已完成抓取的结构数量" - }, - { - "name": "progress_percent", - "type": "number", - "required": false, - "description": "进度百分比(0-100,可能为小数)" - }, - { - "name": "total_fetched_quantity", - "type": "number", - "required": false, - "description": "已抓取的总件数" - }, - { - "name": "duration_ms", - "type": "number", - "required": false, - "description": "任务已运行时长,毫秒级" - }, - { - "name": "error", - "type": "string", - "required": false, - "description": "错误信息,仅当 status=failed 时返回" - }, - { - "name": "fetch_mode", - "type": "string", - "required": false, - "description": "抓取模式,值为 'group'(团购)或 'single'(散单);single 模式时可能返回下列额外字段" - }, - { - "name": "max_fetch_quantity", - "type": "number", - "required": false, - "description": "当 fetch_mode=single 时返回的最大抓取上限(订单数,正整数)" - }, - { - "name": "limit_reached", - "type": "boolean", - "required": false, - "description": "当 fetch_mode=single 时指示是否已达到 max_fetch_quantity 限制" - }, - { - "name": "stop_reason", - "type": "string", - "required": false, - "description": "任务停止原因(如达到上限、人工停止或其他失败原因)" - }, - { - "name": "update_time", - "type": "string", - "required": false, - "description": "最近一次状态更新时间,ISO8601 字符串" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "额外提示信息" - } - ] - }, - { - "method": "order.wave.batchAutoGrouping", - "title": "批量将波次状态修改为 0(自动加团中),仅作用当前登录仓库命中的波次。限制条件: - 跳过已打印及之后状态的波次(wave_status >= 2); - 跳过 total_orders >= 仓库配置 max_wave_quantity 的波次。被跳过的波次不会被修改为自动加团中。", - "description": "批量将波次状态修改为 0(自动加团中),仅作用当前登录仓库命中的波次。限制条件: - 跳过已打印及之后状态的波次(wave_status >= 2); - 跳过 total_orders >= 仓库配置 max_wave_quantity 的波次。被跳过的波次不会被修改为自动加团中。", - "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|string|number", - "required": true, - "description": "波次ID 列表;支持数组、逗号分隔字符串或单个ID" - } - ], - "response": [ - { - "name": "ids", - "type": "array", - "required": false, - "description": "归一化后的请求ID" - }, - { - "name": "affected_wave_ids", - "type": "array", - "required": false, - "description": "实际命中的波次ID" - }, - { - "name": "updated_wave_count", - "type": "number", - "required": false, - "description": "实际更新数量" - }, - { - "name": "skipped_wave_ids", - "type": "array", - "required": false, - "description": "被跳过的波次ID数组(不修改状态)" - }, - { - "name": "skipped_wave_count", - "type": "number", - "required": false, - "description": "被跳过的波次数量" - }, - { - "name": "skipped_details", - "type": "array", - "required": false, - "description": "被跳过的波次明细數組,元素包含 wave_id 与 reason,reason 枚举 printed_or_after_printed / reach_max_wave_quantity" - } - ] - }, - { - "method": "order.wave.batchFinishAutoGrouping", - "title": "批量结束自动加团,将当前仓库命中且 wave_status=0 的波次改为 1(已就绪)。", - "description": "批量结束自动加团,将当前仓库命中且 wave_status=0 的波次改为 1(已就绪)。", - "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|string|number", - "required": true, - "description": "波次ID 列表;支持数组、逗号分隔字符串或单个ID" - } - ], - "response": [ - { - "name": "ids", - "type": "array", - "required": false, - "description": "归一化后的请求ID" - }, - { - "name": "affected_wave_ids", - "type": "array", - "required": false, - "description": "实际命中的波次ID" - }, - { - "name": "updated_wave_ids", - "type": "array", - "required": false, - "description": "实际更新为已就绪的波次ID" - }, - { - "name": "updated_wave_count", - "type": "number", - "required": false, - "description": "实际更新数量" - } - ] - }, - { - "method": "order.wave.batchRemoveOrders", - "title": "按订单ID批量移出波次;仅处理当前仓库的待处理订单表中非待审核订单(step in [1,2,3])。操作会清空订单的 wave_id/wave_no,并在同一事务内回写 wms_wave_batch 表:重算 total_orders,若波次被清空则将 wave_status 置为 -1。仓库上下文来自当前登录用户(ctx.user.store_id)。", - "description": "按订单ID批量移出波次;仅处理当前仓库的待处理订单表中非待审核订单(step in [1,2,3])。操作会清空订单的 wave_id/wave_no,并在同一事务内回写 wms_wave_batch 表:重算 total_orders,若波次被清空则将 wave_status 置为 -1。仓库上下文来自当前登录用户(ctx.user.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": "ids / order_ids / orderIds / order_id / orderId / id", - "type": "array|string|number", - "required": true, - "description": "订单 ID 列表;支持数组、逗号分隔字符串或单个 ID,以上别名均可用(ids、order_ids、orderIds、order_id、orderId、id)" - } - ], - "response": [ - { - "name": "ids", - "type": "array", - "required": true, - "description": "归一化后的请求 ID 列表" - }, - { - "name": "removed_order_ids", - "type": "array", - "required": true, - "description": "实际被移出波次的订单 ID 列表" - }, - { - "name": "removed_order_count", - "type": "number", - "required": true, - "description": "被移出波次的订单数量" - }, - { - "name": "affected_wave_ids", - "type": "array", - "required": true, - "description": "本次操作涉及的波次 ID 列表" - }, - { - "name": "updated_wave_ids", - "type": "array", - "required": true, - "description": "实际更新了 total_orders 的波次 ID 列表" - }, - { - "name": "emptied_wave_ids", - "type": "array", - "required": true, - "description": "被清空且已置为 wave_status=-1 的波次 ID 列表" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/order/_module.lifecycle.json b/workflows/api-doc-system/data/module/order/_module.lifecycle.json deleted file mode 100644 index 5828643d..00000000 --- a/workflows/api-doc-system/data/module/order/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "订单待处理模块", - "key": "order", - "folder": "order" - }, - "status": "active", - "createdAt": "2026-05-09 09:52:14", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/order/module.json b/workflows/api-doc-system/data/module/order/module.json deleted file mode 100644 index 49b11f78..00000000 --- a/workflows/api-doc-system/data/module/order/module.json +++ /dev/null @@ -1,208 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "订单待处理模块", - "key": "order", - "folder": "order", - "interfaceCount": 3 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "order.wave.batchList", - "title": "波次列表查询。仅使用当前登录操作者仓库上下文(禁止传入 warehouse_id/warehouseId)。支持 where 白名单过滤,固定查询 wave_status=0/1;返回波次基础信息及分配状态汇总。支持 only_todo=1 仅返回仍有未复核订单的波次,并返回复核状态汇总(review_assignment_status)与未复核数量(unreviewed_order_count)。", - "description": "波次列表查询。仅使用当前登录操作者仓库上下文(禁止传入 warehouse_id/warehouseId)。支持 where 白名单过滤,固定查询 wave_status=0/1;返回波次基础信息及分配状态汇总。支持 only_todo=1 仅返回仍有未复核订单的波次,并返回复核状态汇总(review_assignment_status)与未复核数量(unreviewed_order_count)。", - "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": "only_todo", - "type": "number|boolean|string", - "required": false, - "description": "是否仅返回待处理(仍有未复核订单)的波次,默认 0;传 1/true 时仅返回 unreviewed_order_count > 0 的波次。" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "筛选白名单字段(object,可选)。仅支持下列字段过滤,且禁止传入 warehouse_id / warehouseId: - wave_id(等值) - wave_no(模糊) - wave_type(等值) - wave_status(等值,接口固定叠加状态 0/1) - creator(模糊) - logistics_name(模糊) - item_part_type(等值) - item_part(模糊) - item_snapshot_key(模糊) - item_detail_machine(模糊) - distinguish_express(等值) - total_orders_min / total_orders_max(范围) - processed_orders_min / processed_orders_max(范围) - express_assignment_status(等值,string,可选,英文枚举,取值:unassigned、partially_assigned、assigned;语义:按快递分配聚合判断,assigned 表示聚合后全部 fin,partially_assigned 表示部分已分配且不含 error,unassigned 表示全 none 或包含 error(异常并入未分配集合))。 - print_assignment_status(等值,string,可选,英文枚举,取值:unprinted、partially_printed、printed;语义:按打印分配聚合判断,printed 表示聚合后全部已打印)。 - storage_assignment_status(等值,string,可选,取值:未分配、部分分配、已分配;默认不传不做限制)。过滤语义:已分配=聚合后全部 fin;部分分配=不含 error,且既不是全 none,也不是全 fin;未分配=全 none 或包含 error(异常并入未分配筛选集合)。说明:返回字段 storage_assignment_status 的展示值保持不变,包含 error 时仍可显示“分配异常”;此处 where 的过滤语义会把异常计入“未分配”,以避免把过滤语义与展示值混淆。 - source(可选,number)来源过滤:0=普通波次(正常后台操作),1=管理后台策略任务,2=PDA策略任务;不传则不过滤。 说明:express_assignment_status 与 print_assignment_status 要求使用英文枚举值;storage_assignment_status 仍向后兼容中文展示值。若传入的枚举值不在允许集合内,接口会返回 400(参数校验失败),并在 message 中说明错误字段与允许取值。 - review_assignment_status(等值,string,可选,英文枚举:unreviewed、partially_reviewed、reviewed;分别表示未复核、部分复核、已复核)。" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "波次列表,包含波次基础信息与状态汇总(order_count / storage_assignment_status / express_assignment_status / print_assignment_status / review_assignment_status / unreviewed_order_count)。每条记录新增字段 source(number):来源标识,0=普通波次(正常后台操作),1=管理后台策略任务,2=PDA策略任务。" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - } - ] - }, - { - "method": "order.pendingOrder.downloadCreateTemplate", - "title": "下载创建订单的 Excel 导入模板。返回 base64 编码的 xlsx 文件,前端解码后作为 .xlsx 附件下载。表头中标注 * 的列为必填项(橙色背景),可选列为灰色背景,包含示例数据行和填写说明工作表。多行相同订单号的行组成一个完整订单,每行代表一条商品明细。模板共 25 列(A-Y):店铺名称(shop_nick)位于第2列B列,紧接*订单号(delivery_order_code)之后;其余必填列为*收件人姓名(name)、*手机号(mobile)、*详细地址(detail_address)、*商品编码(item_code)、*计划数量(plan_qty);非必填列依次为货主ID(store_id)、电话(tel)、省份(province)、城市(city)、区/县(area)、镇/街道(town)、邮编(zip_code)、快递编码(logistics_code)、快递名称(logistics_name)、系统平台编码(sys_platform_code)、来源平台编码(source_platform_code)、来源订单号(source_order_codes)、订单类型(order_type)、是否紧急(is_urgency)、是否需要发票(invoice_flag)、商品名称(item_name)、行号(order_line_no)、实际价格(actual_price)。", - "description": "下载创建订单的 Excel 导入模板。返回 base64 编码的 xlsx 文件,前端解码后作为 .xlsx 附件下载。表头中标注 * 的列为必填项(橙色背景),可选列为灰色背景,包含示例数据行和填写说明工作表。多行相同订单号的行组成一个完整订单,每行代表一条商品明细。模板共 25 列(A-Y):店铺名称(shop_nick)位于第2列B列,紧接*订单号(delivery_order_code)之后;其余必填列为*收件人姓名(name)、*手机号(mobile)、*详细地址(detail_address)、*商品编码(item_code)、*计划数量(plan_qty);非必填列依次为货主ID(store_id)、电话(tel)、省份(province)、城市(city)、区/县(area)、镇/街道(town)、邮编(zip_code)、快递编码(logistics_code)、快递名称(logistics_name)、系统平台编码(sys_platform_code)、来源平台编码(source_platform_code)、来源订单号(source_order_codes)、订单类型(order_type)、是否紧急(is_urgency)、是否需要发票(invoice_flag)、商品名称(item_name)、行号(order_line_no)、实际价格(actual_price)。", - "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": "建议保存的文件名,固定为 创建订单导入模板.xlsx" - }, - { - "name": "mime", - "type": "string", - "required": true, - "description": "文件 MIME 类型,固定为 application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - } - ] - }, - { - "method": "order.pendingOrder.manualWaybill", - "title": "手工录入运单号。为指定待处理订单创建一条运单记录(wms_order_express 表),仅允许 step 在 [1,2,3] 且 outbound_status 不为 'padding' 的订单操作。完成后自动更新订单表的 print_status 与 post_status 为 'fin',表示外部已打印。", - "description": "手工录入运单号。为指定待处理订单创建一条运单记录(wms_order_express 表),仅允许 step 在 [1,2,3] 且 outbound_status 不为 'padding' 的订单操作。完成后自动更新订单表的 print_status 与 post_status 为 'fin',表示外部已打印。", - "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", - "required": true, - "description": "订单 ID,必须为正整数" - }, - { - "name": "waybill_code", - "type": "string", - "required": true, - "description": "运单号,非空字符串" - }, - { - "name": "logistics_interface_name", - "type": "string", - "required": false, - "description": "物流接口名称(选填),手工填入的值,trim 后为空则传 null" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "创建的运单记录 ID" - }, - { - "name": "order_id", - "type": "number", - "required": true, - "description": "订单 ID" - }, - { - "name": "waybill_code", - "type": "string", - "required": true, - "description": "运单号" - }, - { - "name": "business_key", - "type": "number", - "required": true, - "description": "递增的业务键,同一订单下从 1 开始递增" - }, - { - "name": "logistics_interface_name", - "type": "string", - "required": false, - "description": "写入的物流接口名称,未传时为 null" - }, - { - "name": "create_at", - "type": "string", - "required": true, - "description": "创建时间" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/pick/_module.lifecycle.json b/workflows/api-doc-system/data/module/pick/_module.lifecycle.json deleted file mode 100644 index aed5c47f..00000000 --- a/workflows/api-doc-system/data/module/pick/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "拣货模块", - "key": "pick", - "folder": "pick" - }, - "status": "active", - "createdAt": "2026-05-04 17:23:48", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/pick/module.json b/workflows/api-doc-system/data/module/pick/module.json deleted file mode 100644 index 0bccf1d5..00000000 --- a/workflows/api-doc-system/data/module/pick/module.json +++ /dev/null @@ -1,281 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "拣货模块", - "key": "pick", - "folder": "pick", - "interfaceCount": 4 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "pick.query", - "title": "按 keyword(运单号或波次号)获取或创建当前用户的拣货任务:命中同用户活动任务返回 existing;无活动任务则创建并返回 created;若活动任务归属他人则返回冲突提示。", - "description": "按 keyword(运单号或波次号)获取或创建当前用户的拣货任务:命中同用户活动任务返回 existing;无活动任务则创建并返回 created;若活动任务归属他人则返回冲突提示。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "keyword", - "type": "string", - "required": true, - "description": "关键字,支持运单号或波次号。" - } - ], - "response": [ - { - "name": "task_id", - "type": "number", - "required": true, - "description": "拣货任务ID。" - }, - { - "name": "status", - "type": "string", - "required": true, - "description": "任务状态:existing(命中当前用户已有活动任务)或 created(新建成功)。" - }, - { - "name": "tip", - "type": "string", - "required": true, - "description": "提示文案。" - } - ] - }, - { - "method": "pick.wavePickTaskDetail", - "title": "按任务ID获取拣货任务详情。查询前会校验任务内订单是否全部完成快递号与储位分配:若存在未分配快递号或未分配储位订单,将返回 400 并在 data 中返回 action 与 order_ids 供前端触发一键分配;详情响应新增中间态进度语义(task.is_completed、task.progress 与顶层 is_completed),用于前端判断是否已完成与展示阶段进度;仅允许任务的 pick_user_id 与当前登录用户一致时返回详情。当 pick_mode=1(团购小波次)时,picking_details 字段不返回以减少带宽。", - "description": "按任务ID获取拣货任务详情。查询前会校验任务内订单是否全部完成快递号与储位分配:若存在未分配快递号或未分配储位订单,将返回 400 并在 data 中返回 action 与 order_ids 供前端触发一键分配;详情响应新增中间态进度语义(task.is_completed、task.progress 与顶层 is_completed),用于前端判断是否已完成与展示阶段进度;仅允许任务的 pick_user_id 与当前登录用户一致时返回详情。当 pick_mode=1(团购小波次)时,picking_details 字段不返回以减少带宽。", - "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", - "type": "number", - "required": true, - "description": "wms_wave_pick_task 主键 ID" - } - ], - "response": [ - { - "name": "task", - "type": "object", - "required": false, - "description": "拣货任务主表(精简字段)" - }, - { - "name": "is_completed", - "type": "boolean", - "required": false, - "description": "任务是否已完成(与 task.is_completed 含义一致,便于前端直接判断)" - }, - { - "name": "boxes", - "type": "array", - "required": false, - "description": "箱列表;包含用于前端展示与拣货进度的统计字段" - }, - { - "name": "picking_details", - "type": "array", - "required": false, - "description": "拣货明细列表(按库位/商品/数量拆分),用于从明细视角展示拣货要求。注意:当 pick_mode=1(团购小波次)时该字段不返回,减少带宽浪费;其他 pick_mode(2/3/4/5)正常返回。" - }, - { - "name": "picking_summary", - "type": "object", - "required": false, - "description": "对 picking_details 的汇总信息,用于统计与前端显示" - }, - { - "name": "picking_view", - "type": "object", - "required": false, - "description": "按 pick_mode 区分的 picking_view 形态输出(五种形态);用于前端按任务类型展示聚合视图。" - } - ] - }, - { - "method": "pick.wavePickTaskSubmit", - "title": "提交拣货任务中间态。用于保存阶段性数据到任务 ext_json.pick_intermediate,并在任务初始状态时自动推进到进行中。", - "description": "提交拣货任务中间态。用于保存阶段性数据到任务 ext_json.pick_intermediate,并在任务初始状态时自动推进到进行中。", - "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", - "type": "number", - "required": true, - "description": "拣货任务ID" - }, - { - "name": "payload", - "type": "object", - "required": false, - "description": "中间态业务数据对象,将原样保存到 ext_json.pick_intermediate.payload" - } - ], - "response": [ - { - "name": "task_id", - "type": "number", - "required": true, - "description": "拣货任务ID" - }, - { - "name": "status", - "type": "string", - "required": true, - "description": "提交结果状态,固定为 submitted" - }, - { - "name": "is_completed", - "type": "boolean", - "required": true, - "description": "当前任务是否已完成" - }, - { - "name": "progress", - "type": "object", - "required": true, - "description": "任务订单拣货进度统计" - } - ] - }, - { - "method": "pick.wavePickTaskComplete", - "title": "完全提交拣货任务。支持 mode=1 全部确认,mode=2 部分确认(需传 order_ids)。提交后根据是否全部完成自动推进任务状态。后台抓取创建的任务(source=2)必须先绑定拣货车才能提交,否则返回 400。", - "description": "完全提交拣货任务。支持 mode=1 全部确认,mode=2 部分确认(需传 order_ids)。提交后根据是否全部完成自动推进任务状态。后台抓取创建的任务(source=2)必须先绑定拣货车才能提交,否则返回 400。", - "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", - "type": "number", - "required": true, - "description": "拣货任务ID" - }, - { - "name": "mode", - "type": "number", - "required": false, - "description": "提交模式:1=全部确认(默认),2=部分确认" - }, - { - "name": "order_ids", - "type": "array", - "required": false, - "description": "部分确认模式(mode=2)时必填;仅会确认命中当前任务的订单ID" - } - ], - "response": [ - { - "name": "task_id", - "type": "number", - "required": true, - "description": "拣货任务ID" - }, - { - "name": "mode", - "type": "number", - "required": true, - "description": "实际生效的提交模式(1=全部确认,2=部分确认)" - }, - { - "name": "confirmed_order_ids", - "type": "array", - "required": true, - "description": "本次成功确认的订单ID列表" - }, - { - "name": "is_completed", - "type": "boolean", - "required": true, - "description": "提交后任务是否已完成" - }, - { - "name": "progress", - "type": "object", - "required": true, - "description": "任务订单拣货进度统计" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/pickcart/_module.lifecycle.json b/workflows/api-doc-system/data/module/pickcart/_module.lifecycle.json deleted file mode 100644 index 53a228f4..00000000 --- a/workflows/api-doc-system/data/module/pickcart/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "拣货车模块", - "key": "pickCart", - "folder": "pickcart" - }, - "status": "active", - "createdAt": "2026-06-03 16:55:40", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/pickcart/module.json b/workflows/api-doc-system/data/module/pickcart/module.json deleted file mode 100644 index e821f4ca..00000000 --- a/workflows/api-doc-system/data/module/pickcart/module.json +++ /dev/null @@ -1,533 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "拣货车模块", - "key": "pickCart", - "folder": "pickcart", - "interfaceCount": 8 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "pickCart.scan", - "title": "按拣货车条码/编码查询拣货车信息,供 PDA 扫码后用于拣货任务绑定。", - "description": "按拣货车条码/编码查询拣货车信息,供 PDA 扫码后用于拣货任务绑定。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "cart_code", - "type": "string", - "required": true, - "description": "拣货车条码/编码" - } - ], - "response": [ - { - "name": "cart_id", - "type": "number", - "required": true, - "description": "拣货车ID" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID" - }, - { - "name": "cart_code", - "type": "string", - "required": true, - "description": "拣货车编码" - }, - { - "name": "cart_name", - "type": "string", - "required": false, - "description": "拣货车名称" - }, - { - "name": "status", - "type": "number", - "required": true, - "description": "拣货车状态:0-停用 1-启用" - }, - { - "name": "current_task_id", - "type": "number", - "required": false, - "description": "当前绑定任务ID,无绑定时为 null" - }, - { - "name": "current_task_no", - "type": "string", - "required": false, - "description": "当前绑定任务编号,无绑定时为 null" - } - ] - }, - { - "method": "pickCart.bindTaskCart", - "title": "绑定拣货任务与拣货车。支持传 cart_id 或 cart_code;若任务已绑定其他拣货车则自动改绑,若目标拣货车已绑定其他活动任务则返回冲突。", - "description": "绑定拣货任务与拣货车。支持传 cart_id 或 cart_code;若任务已绑定其他拣货车则自动改绑,若目标拣货车已绑定其他活动任务则返回冲突。", - "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", - "type": "number", - "required": true, - "description": "拣货任务ID" - }, - { - "name": "cart_id", - "type": "number", - "required": false, - "description": "拣货车ID,和 cart_code 二选一即可" - }, - { - "name": "cart_code", - "type": "string", - "required": false, - "description": "拣货车编码,和 cart_id 二选一即可" - } - ], - "response": [ - { - "name": "task_id", - "type": "number", - "required": true, - "description": "拣货任务ID" - }, - { - "name": "task_no", - "type": "string", - "required": true, - "description": "拣货任务编号" - }, - { - "name": "cart", - "type": "object", - "required": true, - "description": "绑定后的拣货车信息" - } - ] - }, - { - "method": "pickCart.create", - "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": "cart_code", - "type": "string", - "required": true, - "description": "拣货车编码,当前仓库内唯一" - }, - { - "name": "cart_name", - "type": "string", - "required": false, - "description": "拣货车名称" - }, - { - "name": "status", - "type": "number", - "required": false, - "description": "状态:0-停用 1-启用,默认 1" - } - ], - "response": [ - { - "name": "cart_id", - "type": "number", - "required": true, - "description": "拣货车ID" - }, - { - "name": "cart_code", - "type": "string", - "required": true, - "description": "拣货车编码" - }, - { - "name": "cart_name", - "type": "string", - "required": false, - "description": "拣货车名称" - }, - { - "name": "status", - "type": "number", - "required": true, - "description": "状态:0-停用 1-启用" - } - ] - }, - { - "method": "pickCart.update", - "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": "cart_id", - "type": "number", - "required": true, - "description": "拣货车ID" - }, - { - "name": "cart_code", - "type": "string", - "required": false, - "description": "新的拣货车编码" - }, - { - "name": "cart_name", - "type": "string", - "required": false, - "description": "新的拣货车名称" - }, - { - "name": "status", - "type": "number", - "required": false, - "description": "新的状态:0-停用 1-启用" - } - ], - "response": [ - { - "name": "cart_id", - "type": "number", - "required": true, - "description": "拣货车ID" - }, - { - "name": "cart_code", - "type": "string", - "required": true, - "description": "拣货车编码" - }, - { - "name": "cart_name", - "type": "string", - "required": false, - "description": "拣货车名称" - }, - { - "name": "status", - "type": "number", - "required": true, - "description": "状态:0-停用 1-启用" - } - ] - }, - { - "method": "pickCart.delete", - "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": "cart_id", - "type": "number", - "required": true, - "description": "拣货车ID" - } - ], - "response": [ - { - "name": "cart_id", - "type": "number", - "required": true, - "description": "被删除的拣货车ID" - }, - { - "name": "deleted", - "type": "boolean", - "required": true, - "description": "是否删除成功,固定为 true" - } - ] - }, - { - "method": "pickCart.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": "cart_id", - "type": "number", - "required": true, - "description": "拣货车ID" - } - ], - "response": [ - { - "name": "cart_id", - "type": "number", - "required": true, - "description": "拣货车ID" - }, - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID" - }, - { - "name": "cart_code", - "type": "string", - "required": true, - "description": "拣货车编码" - }, - { - "name": "cart_name", - "type": "string", - "required": false, - "description": "拣货车名称" - }, - { - "name": "status", - "type": "number", - "required": true, - "description": "状态:0-停用 1-启用" - }, - { - "name": "current_task_id", - "type": "number", - "required": false, - "description": "当前绑定任务ID,无绑定时为 null" - }, - { - "name": "current_task_no", - "type": "string", - "required": false, - "description": "当前绑定任务编号,无绑定时为 null" - } - ] - }, - { - "method": "pickCart.list", - "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": "pagination", - "type": "object", - "required": false, - "description": "分页参数,支持 page/pageSize,默认 1/20" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "筛选条件,支持 keyword、status、current_task_id" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "拣货车列表,元素结构同 pickCart.detail 返回" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息,包含 page、pageSize、total、totalPages" - } - ] - }, - { - "method": "pickCart.codeDuplicateCheck", - "title": "拣货车编码查重。支持传 exclude_cart_id 排除自身,用于编辑场景判断是否与其他车重复。", - "description": "拣货车编码查重。支持传 exclude_cart_id 排除自身,用于编辑场景判断是否与其他车重复。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "cart_code", - "type": "string", - "required": true, - "description": "待校验的拣货车编码" - }, - { - "name": "exclude_cart_id", - "type": "number", - "required": false, - "description": "需排除的拣货车ID,通常为当前编辑记录自身ID" - } - ], - "response": [ - { - "name": "duplicated", - "type": "boolean", - "required": true, - "description": "是否存在重复编码" - }, - { - "name": "cart_id", - "type": "number", - "required": false, - "description": "命中的重复拣货车ID,无重复时为 null" - }, - { - "name": "cart_code", - "type": "string", - "required": false, - "description": "命中的重复编码,无重复时为 null" - }, - { - "name": "cart_name", - "type": "string", - "required": false, - "description": "命中的重复拣货车名称,无重复时为 null" - }, - { - "name": "status", - "type": "number", - "required": false, - "description": "命中的重复拣货车状态,无重复时为 null" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/print/_module.lifecycle.json b/workflows/api-doc-system/data/module/print/_module.lifecycle.json deleted file mode 100644 index cd961a56..00000000 --- a/workflows/api-doc-system/data/module/print/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "打印模块", - "key": "print", - "folder": "print" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/print/module.json b/workflows/api-doc-system/data/module/print/module.json deleted file mode 100644 index 63d0dc2d..00000000 --- a/workflows/api-doc-system/data/module/print/module.json +++ /dev/null @@ -1,773 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "打印模块", - "key": "print", - "folder": "print", - "interfaceCount": 15 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "print.send", - "title": "发送打印任务到打印电脑,并记录打印单。说明:当 type=express 时,接口按 data.waveGroups(来源于 order.print.getWavePlatformPrintData 返回的 data.waveGroups)进行处理,按 waveGroups -> platforms 串行处理,每个平台+快递 组分别发送;返回沿用现有简要风格,不返回明细。接口在记录打印单的同时,也会写入订单操作日志(记录打印相关操作)。", - "description": "发送打印任务到打印电脑,并记录打印单。说明:当 type=express 时,接口按 data.waveGroups(来源于 order.print.getWavePlatformPrintData 返回的 data.waveGroups)进行处理,按 waveGroups -> platforms 串行处理,每个平台+快递 组分别发送;返回沿用现有简要风格,不返回明细。接口在记录打印单的同时,也会写入订单操作日志(记录打印相关操作)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "computerId", - "type": "string", - "required": false, - "description": "打印电脑 ID;历史/customize 分支可能使用。注意:type=express 场景下不适用(该字段不再作为 express 路径的必填或传输约束)。" - }, - { - "name": "count", - "type": "number", - "required": false, - "description": "打印份数;对 type=customize 有效。type=express 场景下不保留,相应字段会被忽略。" - }, - { - "name": "data", - "type": "object", - "required": true, - "description": "打印业务数据对象。对于 type=express:必须提供 data.waveGroups(来源于 order.print.getWavePlatformPrintData 的返回值 data.waveGroups),接口按 waveGroups->platforms 串行处理,每个 平台+快递 组分别发送;对于 type=customize,data 的具体字段由模板决定。" - }, - { - "name": "printer", - "type": "string", - "required": false, - "description": "打印机名称;type=customize 使用。type=express 下忽略(由快递平台/站点决定打印目标)。" - }, - { - "name": "template", - "type": "object", - "required": false, - "description": "打印模板对象;仅 type=customize 时必填且应包含 page_width、page_height、template_content。type=express 场景下忽略 template 字段。" - }, - { - "name": "timestamp", - "type": "string", - "required": false, - "description": "业务时间戳;历史字段。type=express 场景下不适用。" - }, - { - "name": "type", - "type": "string", - "required": true, - "description": "打印类型;支持 customize、express。对于 express 场景,必须遵守下列额外约束:提供 printStationId、requestCode,并在 data.waveGroups 中传入来自 order.print.getWavePlatformPrintData 的 waveGroups 数据。" - }, - { - "name": "printStationId", - "type": "string", - "required": true, - "description": "打印站点/工作站标识(必填,type=express 时必须提供),用于指示目标打印站或分发单元。" - }, - { - "name": "requestCode", - "type": "string", - "required": true, - "description": "请求去重/防重放 ID(必填,type=express 时必须提供)。接口约束:requestCode 在约定周期内不得变更(例如一次批次/会话期间),系统在同一次请求处理范围内保证对重复 requestCode 进行防重放处理;此保护仅保证同一次请求内的去重/防重放,不等同于跨请求的强幂等保证。" - } - ], - "response": [ - { - "name": "flag", - "type": "string", - "required": false, - "description": "全局调用结果标识,成功时为 success,失败时为 failure" - }, - { - "name": "code", - "type": "number", - "required": false, - "description": "业务状态码;成功时为 200,失败时通常为 1001 或 504" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "返回信息" - }, - { - "name": "printId", - "type": "number", - "required": false, - "description": "打印记录 ID;任务入库成功后返回,失败时若已生成记录也会返回。接口在 express 场景下不返回明细结果,只给出调用结果摘要。" - } - ] - }, - { - "method": "print.getPrintResult", - "title": "print.getPrintResult 接口", - "description": "print.getPrintResult 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "printId", - "type": "string", - "required": true, - "description": "printId 参数" - } - ], - "response": [] - }, - { - "method": "print.getPrintRecordItem", - "title": "print.getPrintRecordItem 接口", - "description": "print.getPrintRecordItem 接口", - "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": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "method": "print.getList", - "title": "查询当前仓库下的打印台列表,支持分页与 where 条件筛选(支持字段:id、name、computer_id、custom_barcode)。", - "description": "查询当前仓库下的打印台列表,支持分页与 where 条件筛选(支持字段:id、name、computer_id、custom_barcode)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "page", - "type": "number", - "required": false, - "description": "页码,默认 1" - }, - { - "name": "pageSize", - "type": "number", - "required": false, - "description": "每页数量,默认 20" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "筛选条件对象;支持字段:id(等值)、name、computer_id、custom_barcode;推荐使用 { operator, value, type } 标准结构" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": true, - "description": "返回数据对象,包含 list 与 pagination" - } - ] - }, - { - "method": "print.getItem", - "title": "查询单个打印台详情,返回打印台对象(raw 行记录,含 subject_config)", - "description": "查询单个打印台详情,返回打印台对象(raw 行记录,含 subject_config)", - "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": "number", - "required": true, - "description": "打印台 ID,必填" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": true, - "description": "打印台原始记录(PrintStation raw),字段示例" - } - ] - }, - { - "method": "print.add", - "title": "新增打印台:关联打印电脑并可保存 subject_config(会由模型 normalizeSubjectConfig 校验)。", - "description": "新增打印台:关联打印电脑并可保存 subject_config(会由模型 normalizeSubjectConfig 校验)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "computer_id", - "type": "number", - "required": true, - "description": "关联的打印电脑 ID(必填)" - }, - { - "name": "name", - "type": "string", - "required": true, - "description": "打印台名称(必填)" - }, - { - "name": "custom_barcode", - "type": "string", - "required": false, - "description": "自定义条码" - }, - { - "name": "default_printer_name", - "type": "string", - "required": false, - "description": "默认打印机名称" - }, - { - "name": "subject_config", - "type": "object", - "required": false, - "description": "打印台的主题/业务配置(可选,若存在将调用模型 normalizeSubjectConfig 进行校验)" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": true, - "description": "新建的打印台对象(raw)" - } - ] - }, - { - "method": "print.hasName", - "title": "print.hasName 接口", - "description": "print.hasName 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "name", - "type": "string", - "required": true, - "description": "name 参数" - }, - { - "name": "id", - "type": "number", - "required": false, - "description": "id 参数" - } - ], - "response": [] - }, - { - "method": "print.updateItem", - "title": "更新打印台信息:支持更新 name、computer_id、custom_barcode、default_printer_name 以及 subject_config(会走 normalizeSubjectConfig)。", - "description": "更新打印台信息:支持更新 name、computer_id、custom_barcode、default_printer_name 以及 subject_config(会走 normalizeSubjectConfig)。", - "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": "number", - "required": true, - "description": "打印台 ID(必填)" - }, - { - "name": "computer_id", - "type": "number", - "required": false, - "description": "要更新的打印电脑 ID" - }, - { - "name": "custom_barcode", - "type": "string", - "required": false, - "description": "自定义条码" - }, - { - "name": "name", - "type": "string", - "required": false, - "description": "打印台名称" - }, - { - "name": "default_printer_name", - "type": "string", - "required": false, - "description": "默认打印机名称" - }, - { - "name": "subject_config", - "type": "object", - "required": false, - "description": "subject_config(可选),传入将替换/规范化配置" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": false, - "description": "更新结果,通常返回 null" - } - ] - }, - { - "method": "print.del", - "title": "批量删除(软删除)打印台:将指定 ids 的记录标记为 deleted=1。", - "description": "批量删除(软删除)打印台:将指定 ids 的记录标记为 deleted=1。", - "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 数组,必须为非空数组(示例: [1,2,3])" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": false, - "description": "返回空数据结构,表示操作成功" - } - ] - }, - { - "method": "print.getComputer", - "title": "查询当前仓库下状态为 1 的打印电脑列表(raw 列表)。", - "description": "查询当前仓库下状态为 1 的打印电脑列表(raw 列表)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [ - { - "name": "data", - "type": "array", - "required": true, - "description": "打印电脑数组,每项为打印电脑的原始记录" - } - ] - }, - { - "method": "print.getComputerPrinter", - "title": "获取指定打印电脑的打印机列表(从 redis: printer:{id}:printerList 读取并返回 data 数组,通常为打印机名称数组或对象数组)。", - "description": "获取指定打印电脑的打印机列表(从 redis: printer:{id}:printerList 读取并返回 data 数组,通常为打印机名称数组或对象数组)。", - "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": "number", - "required": true, - "description": "打印电脑 ID,必填" - } - ], - "response": [ - { - "name": "data", - "type": "array", - "required": true, - "description": "打印机数组,通常为字符串名称数组或打印机对象数组(取决于 redis 存储格式)" - } - ] - }, - { - "method": "print.savePrinters", - "title": "保存 default_printer_name 与 subject_config.express_bind_printer。", - "description": "保存 default_printer_name 与 subject_config.express_bind_printer。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "defaultPrinter", - "type": "string", - "required": true, - "description": "默认打印机名称(必填),会写入打印台的 `default_printer_name` 字段" - }, - { - "name": "express", - "type": "array", - "required": true, - "description": "快递与打印机绑定数组(必填)。每项应包含首选字段 `express_code`(string)和 `printer_name`(string)。为兼容历史字段,也接受 `express_id`(可映射为 `express_code`)和 `name`(可映射为 `printer_name`)。接口实现会将结果序列化后写入打印台的 `subject_config.express_bind_printer`。" - }, - { - "name": "print_station_id", - "type": "number", - "required": true, - "description": "目标打印台 ID(必填)。接口会根据此 ID 更新对应打印台记录的 default_printer_name 与 subject_config.express_bind_printer" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": false, - "description": "成功不返回业务数据,语义为成功(实现中返回 { data: null, code: 0 })" - } - ] - }, - { - "method": "print.retryFailed", - "title": "失败项补打:重试指定打印记录的发送。被定时任务 print-retry-compensation 调用以批量触发失败项补打。", - "description": "失败项补打:重试指定打印记录的发送。被定时任务 print-retry-compensation 调用以批量触发失败项补打。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "print_ids", - "type": "array", - "required": true, - "description": "要补打的打印记录 ID 数组" - }, - { - "name": "force", - "type": "boolean", - "required": false, - "description": "是否强制补打(当前实现仍不放宽状态判定)" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "显式指定仓库 ID(调度任务推荐提供),若缺失将使用当前用户的 store_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": "success_count", - "type": "number", - "required": false, - "description": "成功补打数量" - }, - { - "name": "failed_count", - "type": "number", - "required": false, - "description": "补打失败数量" - }, - { - "name": "skipped_count", - "type": "number", - "required": false, - "description": "被跳过的记录数量" - }, - { - "name": "retried", - "type": "array", - "required": false, - "description": "补打尝试结果数组" - }, - { - "name": "skipped", - "type": "array", - "required": false, - "description": "跳过项明细" - } - ] - }, - { - "method": "print.notifyLock", - "title": "仅执行订单锁定流程,不发送打印任务;记录打印任务日志并写入订单操作日志。兼容别名:print.notify_lock(等价转调)。", - "description": "仅执行订单锁定流程,不发送打印任务;记录打印任务日志并写入订单操作日志。兼容别名:print.notify_lock(等价转调)。", - "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", - "type": "array", - "required": false, - "description": "订单 ID 数组(与 orderIds 互为别名)。至少需提供 order_ids/orderIds/waveGroups/data.waveGroups 中的一类以提取订单 ID。" - }, - { - "name": "orderIds", - "type": "array", - "required": false, - "description": "订单 ID 数组(驼峰兼容,等同于 order_ids)。" - }, - { - "name": "waveGroups", - "type": "array", - "required": false, - "description": "波次分组结构(可从中提取订单 ID,参考 order.print.getWavePlatformPrintData 返回的 waveGroups)。" - }, - { - "name": "data", - "type": "object", - "required": false, - "description": "兼容包装对象;若传入 data.waveGroups,可从中提取订单 ID。" - } - ], - "response": [ - { - "name": "locked_count", - "type": "number", - "required": false, - "description": "成功锁定的订单数量" - }, - { - "name": "order_ids_count", - "type": "number", - "required": false, - "description": "请求中识别出的订单 ID 数量" - }, - { - "name": "order_ids", - "type": "array", - "required": false, - "description": "本次尝试锁定的订单 ID 列表" - }, - { - "name": "source", - "type": "string", - "required": false, - "description": "操作来源标识(可选,若后端返回则提供具体来源)" - } - ] - }, - { - "method": "print.notify_lock", - "title": "兼容别名(等价转调到 print.notifyLock);建议使用 print.notifyLock。", - "description": "兼容别名(等价转调到 print.notifyLock);建议使用 print.notifyLock。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - } - ] -} diff --git a/workflows/api-doc-system/data/module/printer.station/_module.lifecycle.json b/workflows/api-doc-system/data/module/printer.station/_module.lifecycle.json deleted file mode 100644 index 7ff438c2..00000000 --- a/workflows/api-doc-system/data/module/printer.station/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "打印机站点模块", - "key": "printer.station", - "folder": "printer.station" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/printer.station/module.json b/workflows/api-doc-system/data/module/printer.station/module.json deleted file mode 100644 index 267eaf43..00000000 --- a/workflows/api-doc-system/data/module/printer.station/module.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "打印机站点模块", - "key": "printer.station", - "folder": "printer.station", - "interfaceCount": 1 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "printer.station.list", - "title": "获取打印站点列表", - "description": "获取打印站点列表", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - } - ] -} diff --git a/workflows/api-doc-system/data/module/setting.account/_module.lifecycle.json b/workflows/api-doc-system/data/module/setting.account/_module.lifecycle.json deleted file mode 100644 index 1d80cbeb..00000000 --- a/workflows/api-doc-system/data/module/setting.account/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "账号管理模块", - "key": "setting.account", - "folder": "setting.account" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/setting.account/module.json b/workflows/api-doc-system/data/module/setting.account/module.json deleted file mode 100644 index a5f4d012..00000000 --- a/workflows/api-doc-system/data/module/setting.account/module.json +++ /dev/null @@ -1,423 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "账号管理模块", - "key": "setting.account", - "folder": "setting.account", - "interfaceCount": 6 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "setting.account.list", - "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": "status", - "type": "number", - "required": false, - "description": "状态筛选,默认 1,仅查有效工号" - }, - { - "name": "includeDisabled", - "type": "boolean", - "required": false, - "description": "是否包含已删除工号" - } - ], - "response": [ - { - "name": "data[]", - "type": "object", - "required": true, - "description": "工号列表项" - }, - { - "name": "data[].employee_id", - "type": "number", - "required": true, - "description": "工号ID" - }, - { - "name": "data[].account_id", - "type": "number", - "required": true, - "description": "账号ID" - }, - { - "name": "data[].store_id", - "type": "number", - "required": true, - "description": "主体ID" - }, - { - "name": "data[].real_name", - "type": "string", - "required": true, - "description": "工号姓名" - }, - { - "name": "data[].status", - "type": "number", - "required": true, - "description": "工号状态:1=启用,0=停用" - }, - { - "name": "data[].username", - "type": "string", - "required": true, - "description": "账号用户名" - }, - { - "name": "data[].phone", - "type": "string", - "required": true, - "description": "账号手机号" - }, - { - "name": "data[].email", - "type": "string", - "required": true, - "description": "账号邮箱" - }, - { - "name": "data[].avatar_file_id", - "type": "number", - "required": false, - "description": "头像文件ID,为空表示未设置" - }, - { - "name": "data[].avatar_url", - "type": "string", - "required": true, - "description": "头像访问地址" - } - ] - }, - { - "method": "setting.account.add", - "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": "phone", - "type": "string", - "required": true, - "description": "手机号,作为账号复用/创建依据" - }, - { - "name": "real_name", - "type": "string", - "required": true, - "description": "工号姓名,新增时禁止直接使用保留名称" - }, - { - "name": "username", - "type": "string", - "required": false, - "description": "新账号用户名,不传时系统自动生成" - }, - { - "name": "password", - "type": "string", - "required": false, - "description": "新账号密码,不传默认 111111" - }, - { - "name": "role_id", - "type": "number", - "required": false, - "description": "工号角色,不传时继承当前操作人工号角色" - }, - { - "name": "email", - "type": "string", - "required": false, - "description": "新账号邮箱,不传时按 username 自动生成" - } - ], - "response": [ - { - "name": "employee_id", - "type": "number", - "required": true, - "description": "新增或复用后的工号ID" - }, - { - "name": "account_id", - "type": "number", - "required": true, - "description": "绑定账号ID" - }, - { - "name": "role_id", - "type": "number", - "required": true, - "description": "绑定后的角色ID" - }, - { - "name": "is_new_account", - "type": "boolean", - "required": true, - "description": "是否为本次新建账号" - }, - { - "name": "phone", - "type": "string", - "required": true, - "description": "绑定账号手机号" - }, - { - "name": "username", - "type": "string", - "required": true, - "description": "绑定账号用户名" - } - ] - }, - { - "method": "setting.account.delete", - "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": "employee_id", - "type": "number", - "required": true, - "description": "要删除的工号ID" - } - ], - "response": [ - { - "name": "employee_id", - "type": "number", - "required": true, - "description": "被停用的工号ID" - }, - { - "name": "account_id", - "type": "number", - "required": true, - "description": "关联账号ID" - }, - { - "name": "status", - "type": "string", - "required": true, - "description": "固定返回 deleted" - }, - { - "name": "already_deleted", - "type": "boolean", - "required": false, - "description": "可选,true 表示该工号原本已停用" - } - ] - }, - { - "method": "setting.account.update", - "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": "employee_id", - "type": "number", - "required": true, - "description": "要更新的工号ID" - }, - { - "name": "real_name", - "type": "string", - "required": false, - "description": "更新后的工号姓名" - }, - { - "name": "file_id", - "type": "number", - "required": false, - "description": "已有文件ID,作为头像引用" - } - ], - "response": [ - { - "name": "employee_id", - "type": "number", - "required": true, - "description": "更新后的工号ID" - }, - { - "name": "real_name", - "type": "string", - "required": true, - "description": "更新后的工号姓名" - }, - { - "name": "avatar_file_id", - "type": "number", - "required": false, - "description": "更新后的头像文件ID" - }, - { - "name": "avatar_url", - "type": "string", - "required": true, - "description": "更新后的头像地址" - } - ] - }, - { - "method": "setting.account.getBindWechatCode", - "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": "account_id", - "type": "number", - "required": true, - "description": "目标账号ID,兼容 user_id / id" - }, - { - "name": "longPoll", - "type": "boolean", - "required": false, - "description": "是否开启长轮询等待状态变化,最长60秒" - }, - { - "name": "waitTimeoutMs", - "type": "number", - "required": false, - "description": "等待超时毫秒数,后端自动封顶60000" - } - ], - "response": [] - }, - { - "method": "setting.account.unbindWechat", - "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": "account_id", - "type": "number", - "required": true, - "description": "目标账号ID,兼容 user_id / id" - } - ], - "response": [] - } - ] -} diff --git a/workflows/api-doc-system/data/module/setting.express/_module.lifecycle.json b/workflows/api-doc-system/data/module/setting.express/_module.lifecycle.json deleted file mode 100644 index 43659304..00000000 --- a/workflows/api-doc-system/data/module/setting.express/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "快递编码管理模块", - "key": "setting.express", - "folder": "setting.express" - }, - "status": "active", - "createdAt": "2026-04-17 19:37:49", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/setting.express/module.json b/workflows/api-doc-system/data/module/setting.express/module.json deleted file mode 100644 index f688a4e2..00000000 --- a/workflows/api-doc-system/data/module/setting.express/module.json +++ /dev/null @@ -1,322 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "快递编码管理模块", - "key": "setting.express", - "folder": "setting.express", - "interfaceCount": 7 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "index.getExpressList", - "title": "获取快递列表。默认返回系统基础快递与当前登录仓库自定义快递编码的合并结果:系统快递在前,仓库自定义编码在后,同一 `code` 仅保留首条(系统同码优先保留系统记录)。当 `systemOnly` 为真值(支持 `true`、`1`、`'1'`、`'true'`)时,仅返回系统基础快递列表。仅接受 `express_code` 入参,服务端会先 trim 再转为大写:`systemOnly=true` 时按系统快递编码过滤系统基础快递列表;`systemOnly=false` 时按自定义编码映射记录中的系统快递编码字段 `express_code` 过滤,仅返回当前登录仓库下匹配该系统快递编码的自定义编码列表,不再回传系统基础项。仓库范围来自当前登录用户 `ctx.user.store_id`;未识别到仓库时,自定义编码列表为空。接口优先读取缓存,未命中时回源 `wms_express` 与 `wms_express_setting`。", - "description": "获取快递列表。默认返回系统基础快递与当前登录仓库自定义快递编码的合并结果:系统快递在前,仓库自定义编码在后,同一 `code` 仅保留首条(系统同码优先保留系统记录)。当 `systemOnly` 为真值(支持 `true`、`1`、`'1'`、`'true'`)时,仅返回系统基础快递列表。仅接受 `express_code` 入参,服务端会先 trim 再转为大写:`systemOnly=true` 时按系统快递编码过滤系统基础快递列表;`systemOnly=false` 时按自定义编码映射记录中的系统快递编码字段 `express_code` 过滤,仅返回当前登录仓库下匹配该系统快递编码的自定义编码列表,不再回传系统基础项。仓库范围来自当前登录用户 `ctx.user.store_id`;未识别到仓库时,自定义编码列表为空。接口优先读取缓存,未命中时回源 `wms_express` 与 `wms_express_setting`。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "systemOnly", - "type": "boolean|number|string", - "required": false, - "description": "是否仅返回系统基础快递列表;仅 `true`、`1`、`'1'`、`'true'` 会被识别为 true,其余值按 false 处理" - }, - { - "name": "express_code", - "type": "string", - "required": false, - "description": "系统快递编码;服务端会去首尾空格并转为大写。`systemOnly=true` 时按该系统快递编码过滤系统基础快递列表;`systemOnly=false` 时按自定义映射记录中的系统快递编码字段 `express_code` 过滤当前仓库的自定义编码列表,而不是按自定义 `code` 过滤" - } - ], - "response": [ - { - "name": "flag", - "type": "string", - "required": true, - "description": "全局调用结果标识,成功时为 `success`" - }, - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "返回消息,成功时通常为 `ok`" - }, - { - "name": "data", - "type": "array", - "required": true, - "description": "快递列表数组。默认模式下先返回系统基础快递,再追加当前仓库自定义编码;当传入 `express_code` 且 `systemOnly=false` 时,仅返回当前仓库下系统快递编码等于该 `express_code` 的自定义映射记录,不返回系统基础项。每项字段如下:" - } - ] - }, - { - "method": "setting.express.list", - "title": "查询当前仓库范围的快递映射列表,支持 where + pagination", - "description": "查询当前仓库范围的快递映射列表,支持 where + pagination", - "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 } 标准结构" - } - ], - "response": [] - }, - { - "method": "setting.express.listBase", - "title": "返回系统快递基础列表(系统级别基础快递,不含仓库自定义)", - "description": "返回系统快递基础列表(系统级别基础快递,不含仓库自定义)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [], - "response": [] - }, - { - "method": "setting.express.create", - "title": "创建快递映射,仅写入已实现字段(code、name、express_code 等)", - "description": "创建快递映射,仅写入已实现字段(code、name、express_code 等)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "code", - "type": "string", - "required": true, - "description": "快递映射编码;接口会转为大写" - }, - { - "name": "name", - "type": "string", - "required": true, - "description": "快递名称(最大 50 字符)" - }, - { - "name": "express_code", - "type": "string", - "required": true, - "description": "系统快递编码;同时支持驼峰写法 expressCode" - } - ], - "response": [] - }, - { - "method": "setting.express.checkCodeUnique", - "title": "校验快递编码在当前仓库/主体维度唯一性,仅支持 code 与可选 id 排除自身", - "description": "校验快递编码在当前仓库/主体维度唯一性,仅支持 code 与可选 id 排除自身", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "code", - "type": "string", - "required": true, - "description": "待校验的快递编码" - }, - { - "name": "id", - "type": "number", - "required": false, - "description": "排除自身 id(更新时使用)" - } - ], - "response": [] - }, - { - "method": "setting.express.update", - "title": "更新快递映射。必须提供 `id`(必填),且至少提供 `code`、`name` 或 `express_code` 中的一个用于更新;同时支持 `expressCode` 驼峰写法。", - "description": "更新快递映射。必须提供 `id`(必填),且至少提供 `code`、`name` 或 `express_code` 中的一个用于更新;同时支持 `expressCode` 驼峰写法。", - "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": "number", - "required": true, - "description": "快递记录ID;也兼容别名 `setting_id` / `settingId`" - }, - { - "name": "code", - "type": "string", - "required": false, - "description": "快递映射编码(最大 50 字符,接口会大写化并校验在当前仓库的唯一性)" - }, - { - "name": "name", - "type": "string", - "required": false, - "description": "快递名称(最大 50 字符)" - }, - { - "name": "express_code", - "type": "string", - "required": false, - "description": "系统快递编码(必须为系统已存在的编码);支持 `expressCode` 驼峰写法" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": true, - "description": "更新后的快递映射对象(规范化字段)" - } - ] - }, - { - "method": "setting.express.delete", - "title": "批量软删除快递映射;接受 ids 参数,已删除记录会在结果中标记。", - "description": "批量软删除快递映射;接受 ids 参数,已删除记录会在结果中标记。", - "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。" - } - ], - "response": [ - { - "name": "ids", - "type": "array", - "required": true, - "description": "请求中的所有 id 列表(原样返回)" - }, - { - "name": "deleted_ids", - "type": "array", - "required": true, - "description": "本次实际被软删除的 ID 列表(即原本未被删除的 ID)" - }, - { - "name": "already_deleted_ids", - "type": "array", - "required": true, - "description": "请求中已处于已删除状态的 ID 列表" - }, - { - "name": "status", - "type": "string", - "required": true, - "description": "固定返回 'deleted'" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/setting.expressinterface/_module.lifecycle.json b/workflows/api-doc-system/data/module/setting.expressinterface/_module.lifecycle.json deleted file mode 100644 index 11878fe6..00000000 --- a/workflows/api-doc-system/data/module/setting.expressinterface/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "快递接口管理模块", - "key": "setting.expressInterface", - "folder": "setting.expressinterface" - }, - "status": "active", - "createdAt": "2026-04-17 20:21:27", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/setting.expressinterface/module.json b/workflows/api-doc-system/data/module/setting.expressinterface/module.json deleted file mode 100644 index 410021c8..00000000 --- a/workflows/api-doc-system/data/module/setting.expressinterface/module.json +++ /dev/null @@ -1,333 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "快递接口管理模块", - "key": "setting.expressInterface", - "folder": "setting.expressinterface", - "interfaceCount": 6 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "setting.expressInterface.list", - "title": "查询当前仓库范围的快递接口列表,支持 where + pagination;返回 data:{ list, total, page, page_size }。按 weight 升序、id 降序排序,优先按权重排序。", - "description": "查询当前仓库范围的快递接口列表,支持 where + pagination;返回 data:{ list, total, page, page_size }。按 weight 升序、id 降序排序,优先按权重排序。", - "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": "pagination" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "支持按 shop_id 过滤" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "list,按 weight 升序、id 降序排序;优先按权重排序,权重相同再按 id 倒序" - }, - { - "name": "total", - "type": "number", - "required": true, - "description": "total" - }, - { - "name": "page", - "type": "number", - "required": true, - "description": "page" - }, - { - "name": "page_size", - "type": "number", - "required": true, - "description": "page_size" - } - ] - }, - { - "method": "setting.expressInterface.listByWarehousePlatformCode", - "title": "按 warehouse_id + platform_code 查询快递接口全字段数组,支持缓存;返回结果按 weight 升序、必要时按 id 升序排序,每条记录显式包含 express_code 以及关联的 express 对象(如 express.id/express.code/express.name/express.platform)。该接口不分页,按 warehouse_id + platform_code 全量返回匹配记录。", - "description": "按 warehouse_id + platform_code 查询快递接口全字段数组,支持缓存;返回结果按 weight 升序、必要时按 id 升序排序,每条记录显式包含 express_code 以及关联的 express 对象(如 express.id/express.code/express.name/express.platform)。该接口不分页,按 warehouse_id + platform_code 全量返回匹配记录。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id / warehouseId", - "type": "number", - "required": false, - "description": "仓库ID;默认使用当前登录主体/仓库上下文(ctx.user.store_id),也支持显式传入以查询指定仓库,文档兼容 warehouse_id 与 warehouseId 两种写法。" - }, - { - "name": "platform_code / platformCode", - "type": "string", - "required": true, - "description": "平台代码;作为缓存键的一部分,建议使用大写形式(服务端会标准化处理)。" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "快递接口记录数组(按 warehouse_id + platform_code 全量返回,不分页),每项包含以下字段:" - } - ] - }, - { - "method": "setting.expressInterface.create", - "title": "在当前仓库范围内创建快递接口,支持 shop_id/shopId 入参。", - "description": "在当前仓库范围内创建快递接口,支持 shop_id/shopId 入参。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "name", - "type": "string", - "required": true, - "description": "name" - }, - { - "name": "express_code", - "type": "string", - "required": true, - "description": "express_code" - }, - { - "name": "platform_code", - "type": "string", - "required": true, - "description": "platform_code" - }, - { - "name": "shop_id", - "type": "number", - "required": false, - "description": "店铺 ID(支持 shopId),正整数,可空;未传或空值按 null 处理" - }, - { - "name": "address", - "type": "string", - "required": false, - "description": "发件人详细地址(可选),使用 index.getShopExpressList 返回的 detail 字段值,非 full_address" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "新建记录 ID" - } - ] - }, - { - "method": "setting.expressInterface.update", - "title": "更新快递接口,支持 shop_id/shopId 入参(可空)。", - "description": "更新快递接口,支持 shop_id/shopId 入参(可空)。", - "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": "number", - "required": true, - "description": "id" - }, - { - "name": "shop_id", - "type": "number", - "required": false, - "description": "shop_id" - }, - { - "name": "address", - "type": "string", - "required": false, - "description": "发件人详细地址(可选),使用 index.getShopExpressList 返回的 detail 字段值,非 full_address" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "id" - } - ] - }, - { - "method": "setting.expressInterface.delete", - "title": "删除快递接口,支持 id 别名 interface_id / interfaceId;返回被删除记录 id 与所属 warehouse_id。", - "description": "删除快递接口,支持 id 别名 interface_id / interfaceId;返回被删除记录 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": "id", - "type": "number", - "required": true, - "description": "快递接口ID;兼容 interface_id / interfaceId" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": false, - "description": "已删除记录 ID" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "记录所属仓库 ID" - }, - { - "name": "deleted", - "type": "boolean", - "required": false, - "description": "是否已删除,成功时为 true" - } - ] - }, - { - "method": "index.getPrintPlatformList", - "title": "获取打印平台全量列表。供前端新增、修改快递接口时下拉选择使用;仅返回未删除且状态为 `ACTIVE` 的打印平台,不分页,按 `platform_name` 升序、`id` 升序返回。接口不校验额外鉴权或权限点,但需要登录态。", - "description": "获取打印平台全量列表。供前端新增、修改快递接口时下拉选择使用;仅返回未删除且状态为 `ACTIVE` 的打印平台,不分页,按 `platform_name` 升序、`id` 升序返回。接口不校验额外鉴权或权限点,但需要登录态。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [], - "response": [ - { - "name": "flag", - "type": "string", - "required": true, - "description": "全局调用结果标识,成功时为 `success`" - }, - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "返回消息,成功时通常为 `ok`" - }, - { - "name": "data", - "type": "array", - "required": true, - "description": "打印平台列表数组,不分页,仅包含未删除且状态为 `ACTIVE` 的平台;按 `platform_name` 升序、`id` 升序返回。每项字段如下:" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/setting.packagematerial/_module.lifecycle.json b/workflows/api-doc-system/data/module/setting.packagematerial/_module.lifecycle.json deleted file mode 100644 index dba00258..00000000 --- a/workflows/api-doc-system/data/module/setting.packagematerial/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "包材管理模块", - "key": "setting.packageMaterial", - "folder": "setting.packagematerial" - }, - "status": "active", - "createdAt": "2026-05-29 09:07:53", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/setting.packagematerial/module.json b/workflows/api-doc-system/data/module/setting.packagematerial/module.json deleted file mode 100644 index 08adef87..00000000 --- a/workflows/api-doc-system/data/module/setting.packagematerial/module.json +++ /dev/null @@ -1,315 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "包材管理模块", - "key": "setting.packageMaterial", - "folder": "setting.packagematerial", - "interfaceCount": 6 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "setting.packageMaterial.create", - "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": "material_code", - "type": "string", - "required": true, - "description": "包材编码(大写且在当前仓库唯一)" - }, - { - "name": "material_name", - "type": "string", - "required": true, - "description": "包材名称" - }, - { - "name": "material_type", - "type": "string", - "required": false, - "description": "包材类型" - }, - { - "name": "spec", - "type": "string", - "required": false, - "description": "规格" - }, - { - "name": "length", - "type": "number", - "required": false, - "description": "长度" - }, - { - "name": "width", - "type": "number", - "required": false, - "description": "宽度" - }, - { - "name": "height", - "type": "number", - "required": false, - "description": "高度" - }, - { - "name": "weight", - "type": "number", - "required": false, - "description": "重量" - }, - { - "name": "cost_price", - "type": "number", - "required": false, - "description": "成本价" - }, - { - "name": "status", - "type": "number", - "required": false, - "description": "状态 0/1,默认 1" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "包材 ID" - } - ] - }, - { - "method": "setting.packageMaterial.update", - "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": "number", - "required": true, - "description": "包材 ID(也兼容 material_id/materialId)" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "包材 ID" - } - ] - }, - { - "method": "setting.packageMaterial.delete", - "title": "删除包材(支持 ids 数组或逗号分隔字符串,兼容 id/material_id/materialId)", - "description": "删除包材(支持 ids 数组或逗号分隔字符串,兼容 id/material_id/materialId)", - "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|number|string", - "required": true, - "description": "要删除的 ID 列表" - } - ], - "response": [ - { - "name": "deleted", - "type": "boolean", - "required": true, - "description": "是否删除成功" - } - ] - }, - { - "method": "setting.packageMaterial.get", - "title": "查询包材列表,支持 where + pagination(兼容旧别名 list,建议使用 get)", - "description": "查询包材列表,支持 where + pagination(兼容旧别名 list,建议使用 get)", - "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": "筛选条件,支持 material_code/material_name/material_type/status/quickWhere" - } - ], - "response": [ - { - "name": "page", - "type": "number", - "required": true, - "description": "当前页" - }, - { - "name": "page_size", - "type": "number", - "required": true, - "description": "每页大小" - }, - { - "name": "total", - "type": "number", - "required": true, - "description": "总数" - }, - { - "name": "list", - "type": "array", - "required": true, - "description": "包材项数组" - } - ] - }, - { - "method": "setting.packageMaterial.list", - "title": "兼容旧称 list,内部转发至 get;建议改用 setting.packageMaterial.get", - "description": "兼容旧称 list,内部转发至 get;建议改用 setting.packageMaterial.get", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "setting.packageMaterial.search", - "title": "包材关键字搜索,按 material_code / material_name 模糊匹配,最多返回 50 条(仅返回启用中的包材)", - "description": "包材关键字搜索,按 material_code / material_name 模糊匹配,最多返回 50 条(仅返回启用中的包材)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "keyword", - "type": "string", - "required": false, - "description": "搜索关键字,模糊匹配 material_code、material_name;为空时返回前 50 条启用中的包材" - } - ], - "response": [ - { - "name": "data[]", - "type": "array", - "required": true, - "description": "包材列表,每项包含 id(包材ID)、material_code(包材编码)、material_name(包材名称)、material_type(包材类型)、spec(规格)、status(状态)" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/setting.packagesupplier/_module.lifecycle.json b/workflows/api-doc-system/data/module/setting.packagesupplier/_module.lifecycle.json deleted file mode 100644 index 5920c9bd..00000000 --- a/workflows/api-doc-system/data/module/setting.packagesupplier/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "package-supplier-module", - "key": "setting.packageSupplier", - "folder": "setting.packagesupplier" - }, - "status": "active", - "createdAt": "2026-05-29 09:07:53", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/setting.packagesupplier/module.json b/workflows/api-doc-system/data/module/setting.packagesupplier/module.json deleted file mode 100644 index ac53ace2..00000000 --- a/workflows/api-doc-system/data/module/setting.packagesupplier/module.json +++ /dev/null @@ -1,249 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "package-supplier-module", - "key": "setting.packageSupplier", - "folder": "setting.packagesupplier", - "interfaceCount": 5 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "setting.packageSupplier.create", - "title": "Create package supplier (current warehouse scope)", - "description": "Create package supplier (current warehouse scope)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "supplier_code", - "type": "string", - "required": true, - "description": "Supplier code (uppercased, unique in warehouse)" - }, - { - "name": "supplier_name", - "type": "string", - "required": true, - "description": "Supplier name" - }, - { - "name": "contact_name", - "type": "string", - "required": false, - "description": "Contact name" - }, - { - "name": "contact_phone", - "type": "string", - "required": false, - "description": "Contact phone" - }, - { - "name": "status", - "type": "number", - "required": false, - "description": "Status 0/1, default 1" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "Created supplier id" - } - ] - }, - { - "method": "setting.packageSupplier.update", - "title": "Update package supplier by id (partial update supported)", - "description": "Update package supplier by id (partial update supported)", - "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": "number", - "required": true, - "description": "Supplier id (also supports supplier_id / supplierId)" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "Supplier id" - } - ] - }, - { - "method": "setting.packageSupplier.delete", - "title": "Delete package suppliers (supports ids array or comma-separated string)", - "description": "Delete package suppliers (supports ids array or comma-separated string)", - "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|number|string", - "required": true, - "description": "IDs to delete" - } - ], - "response": [ - { - "name": "deleted", - "type": "boolean", - "required": true, - "description": "Deleted flag" - } - ] - }, - { - "method": "setting.packageSupplier.get", - "title": "Get package supplier list (supports where + pagination). list is an alias to get; prefer get.", - "description": "Get package supplier list (supports where + pagination). list is an alias to get; prefer get.", - "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": "Pagination parameters" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "Filter conditions" - } - ], - "response": [ - { - "name": "page", - "type": "number", - "required": true, - "description": "Current page" - }, - { - "name": "page_size", - "type": "number", - "required": true, - "description": "Page size" - }, - { - "name": "total", - "type": "number", - "required": true, - "description": "Total" - }, - { - "name": "list", - "type": "array", - "required": true, - "description": "Supplier array" - } - ] - }, - { - "method": "setting.packageSupplier.list", - "title": "Compatibility alias for get; internally forwards to get. Prefer setting.packageSupplier.get.", - "description": "Compatibility alias for get; internally forwards to get. Prefer setting.packageSupplier.get.", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - } - ] -} diff --git a/workflows/api-doc-system/data/module/setting.permission/_module.lifecycle.json b/workflows/api-doc-system/data/module/setting.permission/_module.lifecycle.json deleted file mode 100644 index 605bf618..00000000 --- a/workflows/api-doc-system/data/module/setting.permission/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "权限管理模块", - "key": "setting.permission", - "folder": "setting.permission" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/setting.permission/module.json b/workflows/api-doc-system/data/module/setting.permission/module.json deleted file mode 100644 index b86d65b5..00000000 --- a/workflows/api-doc-system/data/module/setting.permission/module.json +++ /dev/null @@ -1,187 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "权限管理模块", - "key": "setting.permission", - "folder": "setting.permission", - "interfaceCount": 4 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "setting.permission.list", - "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": "role_id", - "type": "number", - "required": false, - "description": "角色ID;传入后返回 selected 标记" - }, - { - "name": "type", - "type": "string", - "required": false, - "description": "权限类型筛选:web_pages/pda_pages/btns/api/miniprogram_pages/block" - }, - { - "name": "keyword", - "type": "string", - "required": false, - "description": "关键字模糊搜索 path/name/meta_title" - }, - { - "name": "includeDisabled", - "type": "boolean", - "required": false, - "description": "是否包含已停用权限" - } - ], - "response": [] - }, - { - "method": "setting.permission.add", - "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": "path", - "type": "string", - "required": true, - "description": "权限路径" - }, - { - "name": "type", - "type": "string", - "required": true, - "description": "权限类型" - }, - { - "name": "name", - "type": "string", - "required": false, - "description": "权限名称" - }, - { - "name": "parent_id", - "type": "number", - "required": false, - "description": "父级权限ID" - } - ], - "response": [] - }, - { - "method": "setting.permission.update", - "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": "permission_id", - "type": "number", - "required": true, - "description": "权限ID" - } - ], - "response": [] - }, - { - "method": "setting.permission.delete", - "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数组" - } - ], - "response": [] - } - ] -} diff --git a/workflows/api-doc-system/data/module/setting.platform/_module.lifecycle.json b/workflows/api-doc-system/data/module/setting.platform/_module.lifecycle.json deleted file mode 100644 index dad2aa65..00000000 --- a/workflows/api-doc-system/data/module/setting.platform/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "平台编码管理模块", - "key": "setting.platform", - "folder": "setting.platform" - }, - "status": "active", - "createdAt": "2026-04-17 19:16:50", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/setting.platform/module.json b/workflows/api-doc-system/data/module/setting.platform/module.json deleted file mode 100644 index d08e9501..00000000 --- a/workflows/api-doc-system/data/module/setting.platform/module.json +++ /dev/null @@ -1,176 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "平台编码管理模块", - "key": "setting.platform", - "folder": "setting.platform", - "interfaceCount": 5 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "index.getPlatformList", - "title": "获取平台列表。默认返回系统基础平台与当前登录仓库自定义平台设置的合并结果:系统平台在前,仓库自定义编码在后,同一 `code` 仅保留首条(系统同码优先保留系统记录)。当 `systemOnly` 为真值(支持 `true`、`1`、`'1'`、`'true'`)时,仅返回系统基础平台列表。`full` 为真值时返回全量字段(包含 wms_platform 全部表字段、route_platform_code、platid 等)。仓库范围来自当前登录用户 `ctx.user.store_id`;未识别到仓库时,自定义设置列表为空。接口优先读取缓存,未命中时回源 `wms_platform` 与 `wms_platfrom_setting`。", - "description": "获取平台列表。默认返回系统基础平台与当前登录仓库自定义平台设置的合并结果:系统平台在前,仓库自定义编码在后,同一 `code` 仅保留首条(系统同码优先保留系统记录)。当 `systemOnly` 为真值(支持 `true`、`1`、`'1'`、`'true'`)时,仅返回系统基础平台列表。`full` 为真值时返回全量字段(包含 wms_platform 全部表字段、route_platform_code、platid 等)。仓库范围来自当前登录用户 `ctx.user.store_id`;未识别到仓库时,自定义设置列表为空。接口优先读取缓存,未命中时回源 `wms_platform` 与 `wms_platfrom_setting`。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "systemOnly", - "type": "boolean|number|string", - "required": false, - "description": "是否仅返回系统基础平台列表;仅 `true`、`1`、`'1'`、`'true'` 会被识别为 true,其余值按 false 处理。也支持 `is_system` 别名(若请求体中同时存在 `is_system` 和 `systemOnly`,优先使用 `is_system`)" - }, - { - "name": "full", - "type": "boolean|number|string", - "required": false, - "description": "是否返回全量字段;仅 `true`、`1`、`'1'`、`'true'` 会被识别为 true,其余值按 false 处理。为 true 时返回 wms_platform 全部表字段、route_platform_code、platid 等扩展信息" - } - ], - "response": [ - { - "name": "flag", - "type": "string", - "required": true, - "description": "全局调用结果标识,成功时为 `success`" - }, - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,成功时返回 200" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "返回消息,成功时通常为 `ok`" - }, - { - "name": "data", - "type": "array", - "required": true, - "description": "平台列表数组。默认模式下先返回系统基础平台,再追加当前仓库自定义设置;`systemOnly=true` 时仅返回系统基础平台。每项字段如下:" - } - ] - }, - { - "method": "setting.platform.list", - "title": "查询当前仓库范围的平台设置列表", - "description": "查询当前仓库范围的平台设置列表", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "setting.platform.create", - "title": "创建当前仓库范围的平台设置", - "description": "创建当前仓库范围的平台设置", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "setting.platform.update", - "title": "更新当前仓库范围的平台设置", - "description": "更新当前仓库范围的平台设置", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "setting.platform.delete", - "title": "删除当前仓库范围的平台设置", - "description": "删除当前仓库范围的平台设置", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - } - ] -} diff --git a/workflows/api-doc-system/data/module/setting.printtemplate/_module.lifecycle.json b/workflows/api-doc-system/data/module/setting.printtemplate/_module.lifecycle.json deleted file mode 100644 index 440c79dc..00000000 --- a/workflows/api-doc-system/data/module/setting.printtemplate/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "打印模板模块", - "key": "setting.printTemplate", - "folder": "setting.printtemplate" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/setting.printtemplate/module.json b/workflows/api-doc-system/data/module/setting.printtemplate/module.json deleted file mode 100644 index 41956260..00000000 --- a/workflows/api-doc-system/data/module/setting.printtemplate/module.json +++ /dev/null @@ -1,204 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "打印模板模块", - "key": "setting.printTemplate", - "folder": "setting.printtemplate", - "interfaceCount": 5 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "setting.printTemplate.list", - "title": "获取打印模板树", - "description": "获取打印模板树", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "setting.printTemplate.save", - "title": "保存打印模板", - "description": "保存打印模板", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "setting.printTemplate.create", - "title": "创建打印模板(platform 固定为 default,template_type 固定为 CUSTOM,template_url 固定为空字符串)", - "description": "创建打印模板(platform 固定为 default,template_type 固定为 CUSTOM,template_url 固定为空字符串)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "template_name", - "type": "string", - "required": true, - "description": "模板名称" - }, - { - "name": "business_type", - "type": "string", - "required": true, - "description": "业务类型" - }, - { - "name": "page_width", - "type": "number", - "required": true, - "description": "页面宽度(mm)" - }, - { - "name": "page_height", - "type": "number", - "required": true, - "description": "页面高度(mm)" - }, - { - "name": "template_content", - "type": "array", - "required": false, - "description": "模板内容,可省略;省略时默认创建空模板内容" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "新建模板ID" - } - ] - }, - { - "method": "setting.printTemplate.delete", - "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": "id", - "type": "number", - "required": true, - "description": "模板ID" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "删除的模板ID" - } - ] - }, - { - "method": "setting.printTemplate.listTemplatesByType", - "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": "businessType", - "type": "string", - "required": true, - "description": "businessType 参数" - } - ], - "response": [] - } - ] -} diff --git a/workflows/api-doc-system/data/module/setting.role/_module.lifecycle.json b/workflows/api-doc-system/data/module/setting.role/_module.lifecycle.json deleted file mode 100644 index 4a337f8a..00000000 --- a/workflows/api-doc-system/data/module/setting.role/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "角色管理模块", - "key": "setting.role", - "folder": "setting.role" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/setting.role/module.json b/workflows/api-doc-system/data/module/setting.role/module.json deleted file mode 100644 index 6bfb2eae..00000000 --- a/workflows/api-doc-system/data/module/setting.role/module.json +++ /dev/null @@ -1,210 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "角色管理模块", - "key": "setting.role", - "folder": "setting.role", - "interfaceCount": 5 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "setting.role.list", - "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": "includeDisabled", - "type": "boolean", - "required": false, - "description": "是否包含已停用角色" - }, - { - "name": "includeSystem", - "type": "boolean", - "required": false, - "description": "是否包含系统角色域" - } - ], - "response": [] - }, - { - "method": "setting.role.permission", - "title": "获取角色权限树(兼容旧入口,等同于 setting.permission.list)", - "description": "获取角色权限树(兼容旧入口,等同于 setting.permission.list)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "role_id", - "type": "number", - "required": false, - "description": "角色ID" - } - ], - "response": [] - }, - { - "method": "setting.role.add", - "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": "role_code", - "type": "string", - "required": true, - "description": "角色编码" - }, - { - "name": "role_name", - "type": "string", - "required": true, - "description": "角色名称" - }, - { - "name": "permission_ids", - "type": "array", - "required": true, - "description": "权限ID数组,支持 [\"*\"]" - }, - { - "name": "pid", - "type": "number", - "required": false, - "description": "父角色ID" - } - ], - "response": [] - }, - { - "method": "setting.role.update", - "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": "role_id", - "type": "number", - "required": true, - "description": "角色ID" - }, - { - "name": "permission_ids", - "type": "array", - "required": true, - "description": "权限ID数组,角色权限需一次性提交" - } - ], - "response": [] - }, - { - "method": "setting.role.delete", - "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数组" - } - ], - "response": [] - } - ] -} diff --git a/workflows/api-doc-system/data/module/setting.warehouse/_module.lifecycle.json b/workflows/api-doc-system/data/module/setting.warehouse/_module.lifecycle.json deleted file mode 100644 index 76dce2ed..00000000 --- a/workflows/api-doc-system/data/module/setting.warehouse/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "仓库设置模块", - "key": "setting.warehouse", - "folder": "setting.warehouse" - }, - "status": "active", - "createdAt": "2026-05-04 09:11:04", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/setting.warehouse/module.json b/workflows/api-doc-system/data/module/setting.warehouse/module.json deleted file mode 100644 index e8360bd4..00000000 --- a/workflows/api-doc-system/data/module/setting.warehouse/module.json +++ /dev/null @@ -1,273 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "仓库设置模块", - "key": "setting.warehouse", - "folder": "setting.warehouse", - "interfaceCount": 3 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "setting.warehouse.getSettings", - "title": "获取当前登录仓库的 subject_config", - "description": "获取当前登录仓库的 subject_config", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库 ID" - }, - { - "name": "subject_config", - "type": "object", - "required": true, - "description": "仓库的 subject_config 配置对象" - }, - { - "name": "subject_config.enable_external_express_code", - "type": "boolean", - "required": true, - "description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)" - }, - { - "name": "subject_config.auto_outbound_rules", - "type": "object", - "required": true, - "description": "自动出库规则配置。全部条件满足时自动标记待出库" - }, - { - "name": "subject_config.auto_outbound_rules.enabled", - "type": "boolean", - "required": true, - "description": "是否启用自动出库,默认 false" - }, - { - "name": "subject_config.auto_outbound_rules.require_recheck", - "type": "boolean", - "required": true, - "description": "是否要求已复核(recheck_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_pack", - "type": "boolean", - "required": true, - "description": "是否要求已打包(pack_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_weigh", - "type": "boolean", - "required": true, - "description": "是否要求已称重(weighing_weight>0),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_sync", - "type": "boolean", - "required": true, - "description": "是否要求已同步(sync_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_print", - "type": "boolean", - "required": true, - "description": "是否要求已打印(print_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_pick", - "type": "boolean", - "required": true, - "description": "是否要求已拣货(pick_status=fin),默认 true" - } - ] - }, - { - "method": "setting.warehouse.getFieldMeta", - "title": "获取仓库设置字段元信息", - "description": "获取仓库设置字段元信息", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [ - { - "name": "list", - "type": "array", - "required": false, - "description": "字段元信息数组" - } - ] - }, - { - "method": "setting.warehouse.saveSettings", - "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": "subject_config", - "type": "object", - "required": true, - "description": "仓库的 subject_config 对象" - }, - { - "name": "cache_warehouse_id", - "type": "number", - "required": false, - "description": "需清理缓存的仓库 ID(下划线命名兼容)" - }, - { - "name": "cacheWarehouseId", - "type": "number", - "required": false, - "description": "需清理缓存的仓库 ID(驼峰命名兼容)" - }, - { - "name": "subject_config.enable_external_express_code", - "type": "boolean", - "required": false, - "description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)" - }, - { - "name": "subject_config.auto_outbound_rules", - "type": "object", - "required": false, - "description": "自动出库规则配置。全部条件满足时自动标记待出库" - }, - { - "name": "subject_config.auto_outbound_rules.enabled", - "type": "boolean", - "required": false, - "description": "是否启用自动出库,默认 false" - }, - { - "name": "subject_config.auto_outbound_rules.require_recheck", - "type": "boolean", - "required": false, - "description": "是否要求已复核(recheck_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_pack", - "type": "boolean", - "required": false, - "description": "是否要求已打包(pack_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_weigh", - "type": "boolean", - "required": false, - "description": "是否要求已称重(weighing_weight>0),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_sync", - "type": "boolean", - "required": false, - "description": "是否要求已同步(sync_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_print", - "type": "boolean", - "required": false, - "description": "是否要求已打印(print_status=fin),默认 true" - }, - { - "name": "subject_config.auto_outbound_rules.require_pick", - "type": "boolean", - "required": false, - "description": "是否要求已拣货(pick_status=fin),默认 true" - } - ], - "response": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "生效的仓库 ID" - }, - { - "name": "subject_config", - "type": "object", - "required": true, - "description": "保存后的 subject_config" - }, - { - "name": "cache_cleared_warehouse_id", - "type": "number", - "required": true, - "description": "被清理缓存的仓库 ID(若未清理则为 null)" - }, - { - "name": "subject_config.enable_external_express_code", - "type": "boolean", - "required": true, - "description": "保存后的 subject_config.enable_external_express_code 值" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/shops/_module.lifecycle.json b/workflows/api-doc-system/data/module/shops/_module.lifecycle.json deleted file mode 100644 index 0aeb93b6..00000000 --- a/workflows/api-doc-system/data/module/shops/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "店铺模块", - "key": "shops", - "folder": "shops" - }, - "status": "active", - "createdAt": "2026-05-25 17:05:16", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/shops/module.json b/workflows/api-doc-system/data/module/shops/module.json deleted file mode 100644 index 0cb86862..00000000 --- a/workflows/api-doc-system/data/module/shops/module.json +++ /dev/null @@ -1,389 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "店铺模块", - "key": "shops", - "folder": "shops", - "interfaceCount": 5 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "shops.list", - "title": "分页查询店铺,支持 where 条件(支持字段:id, platform_code, custom_name, shop_name, status, quickWhere),兼容 snake_case 与 camelCase 入参;返回分页信息与标准化店铺列表。", - "description": "分页查询店铺,支持 where 条件(支持字段:id, platform_code, custom_name, shop_name, status, quickWhere),兼容 snake_case 与 camelCase 入参;返回分页信息与标准化店铺列表。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "page", - "type": "number", - "required": false, - "description": "页码,兼容 pagination.page/currentPage" - }, - { - "name": "pageSize", - "type": "number", - "required": false, - "description": "每页大小,兼容 page_size/pagination.page_size,最大 200" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "查询条件,支持标准 where 结构或 quickWhere 简写,字段兼容 id/platform_code/custom_name/shop_name/status/quickWhere" - } - ], - "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.list", - "type": "array", - "required": true, - "description": "店铺数组,元素结构见 children" - }, - { - "name": "data.pagination", - "type": "object", - "required": true, - "description": "分页信息" - } - ] - }, - { - "method": "shops.add", - "title": "新增店铺,校验 platform_code 必须匹配已配置且处于 ACTIVE 且未删除的打印平台;custom_name 必填且长度<=100。shop_name 由服务端生成待授权占位名(PENDING_*),授权后再同步真实店铺名。支持 snake_case 与 camelCase 入参兼容。", - "description": "新增店铺,校验 platform_code 必须匹配已配置且处于 ACTIVE 且未删除的打印平台;custom_name 必填且长度<=100。shop_name 由服务端生成待授权占位名(PENDING_*),授权后再同步真实店铺名。支持 snake_case 与 camelCase 入参兼容。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "platform_code", - "type": "string", - "required": true, - "description": "平台编码,兼容 platformCode,服务端会标准化为大写并验证" - }, - { - "name": "custom_name", - "type": "string", - "required": true, - "description": "店铺自定义名称,最大长度 100" - } - ], - "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.id", - "type": "number", - "required": true, - "description": "新建店铺 ID" - } - ] - }, - { - "method": "shops.del", - "title": "软删除店铺:将 shop_name 修改为 DELETED_SHOP__ 并清空敏感字段;若存在 ExpressInterface 引用则返回 409;返回 deleted=true 与 id。", - "description": "软删除店铺:将 shop_name 修改为 DELETED_SHOP__ 并清空敏感字段;若存在 ExpressInterface 引用则返回 409;返回 deleted=true 与 id。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "店铺 ID,兼容 shop_id/shopId" - } - ], - "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.deleted", - "type": "boolean", - "required": true, - "description": "是否已删除" - }, - { - "name": "data.id", - "type": "number", - "required": true, - "description": "删除的店铺 ID" - } - ] - }, - { - "method": "shops.edit", - "title": "编辑店铺,仅允许修改 platform_code 或 custom_name;至少传入其中一个。platform_code 会校验平台存在且为 ACTIVE;custom_name 必填且长度<=100;服务端兼容 snake_case/camelCase。", - "description": "编辑店铺,仅允许修改 platform_code 或 custom_name;至少传入其中一个。platform_code 会校验平台存在且为 ACTIVE;custom_name 必填且长度<=100;服务端兼容 snake_case/camelCase。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "店铺 ID,兼容 shop_id/shopId" - }, - { - "name": "platform_code", - "type": "string", - "required": false, - "description": "平台编码,兼容 platformCode,服务端会转为大写并校验" - }, - { - "name": "custom_name", - "type": "string", - "required": false, - "description": "自定义名称,兼容 customName,若传入需非空且 <=100 字符" - } - ], - "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.updated", - "type": "boolean", - "required": true, - "description": "是否已更新" - }, - { - "name": "data.id", - "type": "number", - "required": true, - "description": "被更新的店铺 ID" - } - ] - }, - { - "method": "shops.GetAuthorizeSessionKey", - "title": "按店铺所属平台生成授权会话。入参兼容 id/shop_id/shopId 与 callbackurl/callback_url,callbackurl 必填。对已实现的平台(PDD/CAINIAO)返回 session_key/authorize_url/state,其他平台返回 501 未实现。", - "description": "按店铺所属平台生成授权会话。入参兼容 id/shop_id/shopId 与 callbackurl/callback_url,callbackurl 必填。对已实现的平台(PDD/CAINIAO)返回 session_key/authorize_url/state,其他平台返回 501 未实现。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "店铺 ID,兼容 shop_id/shopId" - }, - { - "name": "callbackurl", - "type": "string", - "required": true, - "description": "回调地址,兼容 callback_url" - } - ], - "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.shop_id", - "type": "number", - "required": true, - "description": "店铺 ID" - }, - { - "name": "data.platform_code", - "type": "string", - "required": true, - "description": "平台编码(大写)" - }, - { - "name": "data.callbackurl", - "type": "string", - "required": true, - "description": "回调地址" - }, - { - "name": "data.session_key", - "type": "string", - "required": true, - "description": "授权预占码(session)" - }, - { - "name": "data.authorize_url", - "type": "string", - "required": true, - "description": "平台授权跳转地址(含 state)" - }, - { - "name": "data.state", - "type": "string", - "required": true, - "description": "内部 state 值(platform + '_' + authRandomCode),用于回调解析" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/stock/_module.lifecycle.json b/workflows/api-doc-system/data/module/stock/_module.lifecycle.json deleted file mode 100644 index 88dd5f1c..00000000 --- a/workflows/api-doc-system/data/module/stock/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "商品模块", - "key": "stock", - "folder": "stock" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/stock/module.json b/workflows/api-doc-system/data/module/stock/module.json deleted file mode 100644 index f650b113..00000000 --- a/workflows/api-doc-system/data/module/stock/module.json +++ /dev/null @@ -1,987 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "商品模块", - "key": "stock", - "folder": "stock", - "interfaceCount": 25 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "stock.warehouse.list", - "title": "仓库商品列表查询(支持 where 条件与分页)", - "description": "仓库商品列表查询(支持 where 条件与分页)", - "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": "pagination 参数" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、barcode、prohibited_type、has_bound_item 等商品筛选字段。示例:where.barcode={operator:like,value:69}; where.prohibited_type={operator:eq,value:liquid}; where.has_bound_item={operator:eq,value:true}(已绑定外部商品)/ where.has_bound_item={operator:eq,value:false}(未绑定外部商品)。" - } - ], - "response": [] - }, - { - "method": "stock.warehouse.export", - "title": "提交导出任务,返回 task_id/status/progress/message/result/error/update_time", - "description": "提交导出任务,返回 task_id/status/progress/message/result/error/update_time", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "where", - "type": "object", - "required": false, - "description": "查询条件对象,与 stock.warehouse.list 的 where 语义一致;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化。" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数对象,支持 sortField/sortOrder 与 sort_field/sort_order 下划线别名兼容。" - }, - { - "name": "sort.sortField", - "type": "string", - "required": false, - "description": "排序字段(兼容 sort.sortField)。" - }, - { - "name": "sort.sort_field", - "type": "string", - "required": false, - "description": "排序字段下划线别名(兼容 sort.sort_field)。" - }, - { - "name": "sort.sortOrder", - "type": "string", - "required": false, - "description": "排序方向(ASC/DESC,大小写不敏感)。" - }, - { - "name": "sort.sort_order", - "type": "string", - "required": false, - "description": "排序方向下划线别名(兼容 sort.sort_order)。" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": false, - "description": "任务 ID(后端生成的唯一标识)" - }, - { - "name": "status", - "type": "string", - "required": false, - "description": "任务状态,枚举:submitted/running/success/failed/not_found" - }, - { - "name": "progress", - "type": "number", - "required": false, - "description": "进度百分比(0-100)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "额外提示信息或受理消息" - }, - { - "name": "result", - "type": "object", - "required": false, - "description": "任务成功时返回的结果对象(可选)" - }, - { - "name": "error", - "type": "string", - "required": false, - "description": "失败时的错误信息(可选)" - }, - { - "name": "update_time", - "type": "string", - "required": false, - "description": "最近一次状态更新时间,ISO8601 字符串(可选)" - } - ] - }, - { - "method": "stock.warehouse.exportTaskProgress", - "title": "按 task_id 查询导出任务进度,未找到时 status=not_found", - "description": "按 task_id 查询导出任务进度,未找到时 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": false, - "description": "任务 ID" - }, - { - "name": "status", - "type": "string", - "required": false, - "description": "任务状态:submitted/running/success/failed/not_found" - }, - { - "name": "progress", - "type": "number", - "required": false, - "description": "进度百分比(0-100)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "额外提示信息" - }, - { - "name": "result", - "type": "object", - "required": false, - "description": "任务成功时返回的结果对象(可选)" - }, - { - "name": "error", - "type": "string", - "required": false, - "description": "失败时的错误信息(可选)" - }, - { - "name": "download_url", - "type": "string", - "required": false, - "description": "任务完成后可直接下载的文件地址(若有)" - }, - { - "name": "update_time", - "type": "string", - "required": false, - "description": "最近一次状态更新时间,ISO8601 字符串(可选)" - } - ] - }, - { - "method": "stock.warehouse.getProhibitedType", - "title": "查询违禁品类型列表(系统预设+仓库自定义)", - "description": "查询违禁品类型列表(系统预设+仓库自定义)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "stock.warehouse.getInfo", - "title": "查询仓库商品详情", - "description": "查询仓库商品详情", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "stock.warehouse.getStockDetail", - "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": "stock_id", - "type": "number", - "required": true, - "description": "商品库存ID(stock_warehouse.id)" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数,包含 page/pageSize" - }, - { - "name": "group_by_batch", - "type": "boolean", - "required": false, - "description": "是否按批次返回明细;true 返回每条明细,false 按库位合并" - } - ], - "response": [ - { - "name": "stockItem", - "type": "object", - "required": false, - "description": "商品概要,包含 id、item_code、item_name、sku_property、stock_unit、quantity、locked_quantity 等" - }, - { - "name": "storageList", - "type": "array", - "required": false, - "description": "库存明细数组;group_by_batch=true 返回 wms_storage 明细(含 batch_no、production_date、expiry_date、inbound_time、inbound_order_no、supplier_batch_no 等),group_by_batch=false 时按库位合并,批次相关字段为 null" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页信息,包含 page、pageSize、total" - } - ] - }, - { - "method": "stock.warehouse.saveWarehouseStock", - "title": "更新仓库商品资料", - "description": "更新仓库商品资料", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "stock.warehouse.createWarehouseStock", - "title": "新建仓库商品资料", - "description": "新建仓库商品资料", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "stock.warehouse.import", - "title": "批量导入或更新仓库商品。请求体优先直接传入商品数据数组 JSON(主方式为数组);也兼容以 rows/items/list/data 包装。每项仅需包含商品相关字段;当 SKU 为空时创建新商品,SKU 非空时为更新操作;更新会写操作日志以便审计。未传 store_id 时默认使用当前上下文仓库/主体(ctx.user.store_id)。支持导入条码(barcode),新建和更新均生效,条码写入 wms_stock_barcodes 表。", - "description": "批量导入或更新仓库商品。请求体优先直接传入商品数据数组 JSON(主方式为数组);也兼容以 rows/items/list/data 包装。每项仅需包含商品相关字段;当 SKU 为空时创建新商品,SKU 非空时为更新操作;更新会写操作日志以便审计。未传 store_id 时默认使用当前上下文仓库/主体(ctx.user.store_id)。支持导入条码(barcode),新建和更新均生效,条码写入 wms_stock_barcodes 表。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "items / rows / list / data", - "type": "array", - "required": true, - "description": "商品数组(主方式为直接传数组 []),也兼容对象包装:{ rows: [...] } / { items: [...] } / { list: [...] } / { data: [...] }。每项可使用下列字段别名:" - } - ], - "response": [ - { - "name": "total_count", - "type": "number", - "required": true, - "description": "解析到的总条目数" - }, - { - "name": "created_count", - "type": "number", - "required": true, - "description": "成功创建的新商品数" - }, - { - "name": "updated_count", - "type": "number", - "required": true, - "description": "成功更新的商品数" - }, - { - "name": "fail_count", - "type": "number", - "required": true, - "description": "导入失败数" - }, - { - "name": "created_ids", - "type": "array", - "required": true, - "description": "创建成功的商品 ID 列表" - }, - { - "name": "updated_ids", - "type": "array", - "required": true, - "description": "更新成功的商品 ID 列表" - }, - { - "name": "fail_items", - "type": "array", - "required": true, - "description": "失败项明细数组,每项包含原始输入与错误信息" - } - ] - }, - { - "method": "stock.warehouse.getBarcodes", - "title": "查询商品条码列表", - "description": "查询商品条码列表", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "stock.warehouse.saveWarehouseStockBarcode", - "title": "保存商品条码信息", - "description": "保存商品条码信息", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "stock.warehouse.getStoreStocks", - "title": "查询仓库商品与货主关联列表", - "description": "查询仓库商品与货主关联列表", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "stock.warehouse.bindItem", - "title": "绑定货主商品关系", - "description": "绑定货主商品关系", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "stock.warehouse.unbindItem", - "title": "解绑货主商品关系", - "description": "解绑货主商品关系", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "stock.warehouse.checkItemCodeUnique", - "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": "warehouse_id", - "type": "number", - "required": true, - "description": "仓库ID;默认使用当前登录主体/仓库上下文(ctx.user.store_id)" - }, - { - "name": "item_code", - "type": "string", - "required": true, - "description": "要检测的商品编码" - }, - { - "name": "item_id", - "type": "number", - "required": false, - "description": "当前商品ID(编辑场景用,排除自身);兼容字段名 id" - }, - { - "name": "id", - "type": "number", - "required": false, - "description": "兼容字段 id" - }, - { - "name": "owner_id", - "type": "number", - "required": true, - "description": "货主ID(对应表字段 store_id);兼容字段名 store_id" - }, - { - "name": "store_id", - "type": "number", - "required": true, - "description": "兼容字段 store_id" - } - ], - "response": [ - { - "name": "unique", - "type": "boolean", - "required": false, - "description": "true 表示编码唯一,false 表示已存在重复" - }, - { - "name": "isUnique", - "type": "boolean", - "required": false, - "description": "同 unique(兼容旧字段名)" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "重复时返回 '商品编码已存在',唯一时不返回该字段" - } - ] - }, - { - "method": "stock.warehouse.queryStockLogs", - "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": "warehouseId", - "type": "string", - "required": false, - "description": "warehouseId 参数" - } - ], - "response": [] - }, - { - "method": "stock.warehouse.handleBatchDelete", - "title": "批量删除仓库商品资料", - "description": "批量删除仓库商品资料", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "stock.warehouse.deleteUnit", - "title": "删除库存单位", - "description": "删除库存单位", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "stock.warehouse.deleteProhibited", - "title": "删除违禁品类型", - "description": "删除违禁品类型", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "stock.warehouse.handleBatchChange", - "title": "批量修改仓库商品字段", - "description": "批量修改仓库商品字段", - "endpoint": "/system", - "authRequired": true, - "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 数组(stock_warehouse.id)" - }, - { - "name": "method", - "type": "string", - "required": true, - "description": "要修改的字段名,可选值:brand_name、prohibited_id、gross_weight、packing_requirements、managementFlags、stock_unit" - }, - { - "name": "value", - "type": "string|number|object", - "required": true, - "description": "修改值,类型依 method 而定:brand_name/packing_requirements/stock_unit 为 string(<=255 字符);prohibited_id 为 number(整数);gross_weight 为 number(正数,可含小数);managementFlags 为 object,必须包含 is_sn_mgmt/is_shelf_life_mgmt/is_batch_mgmt,值为 'Y' 或 'N'" - }, - { - "name": "values", - "type": "any", - "required": false, - "description": "兼容字段:当前实现以 `value` 为准,不使用 `values`。若客户端历史使用 `values`,请切换为 `value`。" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": false, - "description": "业务状态码,200 表示成功;405 表示参数/权限校验不通过;500 表示服务器错误" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "业务提示信息" - }, - { - "name": "data", - "type": "object", - "required": false, - "description": "成功时返回的结果对象" - } - ] - }, - { - "method": "stock.warehouse.getStockUnits", - "title": "查询可用库存单位(系统+仓库)", - "description": "查询可用库存单位(系统+仓库)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "stock.warehouse.getUnitList", - "title": "查询当前仓库自定义单位列表", - "description": "查询当前仓库自定义单位列表", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "stock.warehouse.createProhibited", - "title": "新增违禁品类型", - "description": "新增违禁品类型", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "name", - "type": "string", - "required": true, - "description": "name 参数" - } - ], - "response": [] - }, - { - "method": "stock.warehouse.createUnit", - "title": "新增库存单位", - "description": "新增库存单位", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "name", - "type": "string", - "required": true, - "description": "name 参数" - } - ], - "response": [] - }, - { - "method": "stock.warehouse.search", - "title": "仓库商品关键字搜索,按 item_code / item_name / goods_code / 条形码模糊匹配,最多返回 50 条", - "description": "仓库商品关键字搜索,按 item_code / item_name / goods_code / 条形码模糊匹配,最多返回 50 条", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "keyword", - "type": "string", - "required": false, - "description": "搜索关键字,模糊匹配 item_code、item_name、goods_code 以及关联的 barcode;为空时返回全部(仍受 limit 50 限制)" - }, - { - "name": "store_id", - "type": "number", - "required": false, - "description": "货主ID,传入时仅返回指定货主的商品" - }, - { - "name": "with_stock", - "type": "boolean", - "required": false, - "description": "是否返回关联库存数据(wms_storage),为 true 时每条商品新增 storage[] 字段" - }, - { - "name": "is_batch", - "type": "boolean", - "required": false, - "description": "是否按批次明细返回库存,仅 with_stock=true 时生效。false(默认)按库位分组汇总;true 逐条返回批次明细" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": false, - "description": "业务状态码,200 表示成功" - }, - { - "name": "data", - "type": "array", - "required": false, - "description": "商品列表,每项包含以下字段" - }, - { - "name": "total", - "type": "number", - "required": false, - "description": "本次返回的记录条数(≤50)" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/storage.entry/_module.lifecycle.json b/workflows/api-doc-system/data/module/storage.entry/_module.lifecycle.json deleted file mode 100644 index 6d760f16..00000000 --- a/workflows/api-doc-system/data/module/storage.entry/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "入库单模块", - "key": "storage.entry", - "folder": "storage.entry" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/storage.entry/module.json b/workflows/api-doc-system/data/module/storage.entry/module.json deleted file mode 100644 index 1a7ca3dc..00000000 --- a/workflows/api-doc-system/data/module/storage.entry/module.json +++ /dev/null @@ -1,315 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "入库单模块", - "key": "storage.entry", - "folder": "storage.entry", - "interfaceCount": 6 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [ - "storage.entry.unbindReceivingDetails" - ], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [ - "storage.entry.get" - ] - } - } - }, - "interfaces": [ - { - "method": "storage.entry.list", - "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": "pagination", - "type": "object", - "required": false, - "description": "分页参数,支持 page/pageSize" - }, - { - "name": "where", - "type": "object", - "required": false, - "description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、order_status、store_id、order_type、日期区间等字段。新增 expense_record(费用是否记录)筛选,支持 eq/in;值会归一化为 0/1,兼容 true/false、1/0、y/n、yes/no(大小写不敏感,含布尔/字符串/数字写法)。示例:where.expense_record={operator:eq,value:true} 等价 where.expense_record={operator:eq,value:1};where.expense_record={operator:in,value:[true,\"0\",\"yes\",\"n\"]} 会归一化为 [1,0]。若部署环境尚未完成 expense_record 字段迁移,传入该筛选可能返回 400,错误提示为“当前环境未提供 expense_record 字段,暂不支持该筛选条件,请先完成表结构升级”。" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数,支持 sortField/sortOrder" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "入库单列表" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - }, - { - "name": "summary", - "type": "object", - "required": true, - "description": "状态汇总(total、pending、creating、created、completed、cancelled)" - } - ] - }, - { - "method": "storage.entry.get", - "title": "查询入库单详情。返回的 entryOrder.items 每项包含 pending_total(当前 pending 绑定的总预分配数量)、total_planned(计划入库数量=count)、bindings(pending 绑定列表,每项含 id/entry_item_id/receiving_detail_id/allocated_quantity/status/receivingDetail)", - "description": "查询入库单详情。返回的 entryOrder.items 每项包含 pending_total(当前 pending 绑定的总预分配数量)、total_planned(计划入库数量=count)、bindings(pending 绑定列表,每项含 id/entry_item_id/receiving_detail_id/allocated_quantity/status/receivingDetail)", - "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": "number", - "required": false, - "description": "入库单ID,与 entry_order_code 二选一" - }, - { - "name": "entry_order_code", - "type": "string", - "required": false, - "description": "入库单号,与 id 二选一" - } - ], - "response": [ - { - "name": "entryOrder", - "type": "object", - "required": true, - "description": "入库单详情,含 items 明细数组" - } - ] - }, - { - "method": "storage.entry.cancel", - "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": "id", - "type": "number", - "required": false, - "description": "入库单ID,兼容旧调用;与 `ids` 二选一。若同时传入 `ids`,以 `ids` 为准。" - }, - { - "name": "ids", - "type": "array", - "required": false, - "description": "入库单ID数组(number[]),用于批量作废;必须为非空数组,建议批量操作使用 `ids`,优先于 `id`。" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": false, - "description": "单条作废时返回的入库单ID" - }, - { - "name": "ids", - "type": "array", - "required": false, - "description": "批量作废时返回的已成功作废入库单ID数组(number[])" - } - ] - }, - { - "method": "storage.entry.completeEntry", - "title": "完成入库单。入库单状态变更为 COMPLETED 后,异步触发收货单匹配与回传:系统会从入库单 remark 中匹配近 3 天收货单号,明细一致则按来源回传(奇门→奇门确认接口,API→OpenAPI 回调);若收货单覆盖入库单,还会标记收货单为部分入库。异步匹配失败不阻塞主流程,仅记录日志。", - "description": "完成入库单。入库单状态变更为 COMPLETED 后,异步触发收货单匹配与回传:系统会从入库单 remark 中匹配近 3 天收货单号,明细一致则按来源回传(奇门→奇门确认接口,API→OpenAPI 回调);若收货单覆盖入库单,还会标记收货单为部分入库。异步匹配失败不阻塞主流程,仅记录日志。", - "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": "number", - "required": true, - "description": "入库单ID" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "完成成功的入库单ID" - } - ] - }, - { - "method": "storage.entry.bindReceivingDetails", - "title": "入库单明细绑定收货明细。将指定的收货单明细与入库单明细建立绑定关系,并立即更新入库明细的 received_quantity(绑定即实收)。重复调用会先回退旧绑定量再创建新绑定。提交入库时完成收货单侧的入库数量扣减和库存上架。", - "description": "入库单明细绑定收货明细。将指定的收货单明细与入库单明细建立绑定关系,并立即更新入库明细的 received_quantity(绑定即实收)。重复调用会先回退旧绑定量再创建新绑定。提交入库时完成收货单侧的入库数量扣减和库存上架。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "entry_item_id", - "type": "number", - "required": true, - "description": "入库单明细ID(wms_entry_items.id)" - }, - { - "name": "bindings", - "type": "array", - "required": true, - "description": "收货明细绑定数组,每项包含 receiving_detail_id(收货明细ID, number, 必填)和 allocated_quantity(分配数量, number, 必填, 正整数)" - } - ], - "response": [ - { - "name": "entry_item_id", - "type": "number", - "required": true, - "description": "入库明细ID" - }, - { - "name": "binding_count", - "type": "number", - "required": true, - "description": "创建的绑定数量" - } - ] - }, - { - "method": "storage.entry.unbindReceivingDetails", - "title": "解绑入库明细的收货明细绑定。删除指定入库明细的所有 pending 绑定,并回退 received_quantity(恢复到绑定前的值),收货单明细的可用数量自动恢复(因为绑定记录被删除)。", - "description": "解绑入库明细的收货明细绑定。删除指定入库明细的所有 pending 绑定,并回退 received_quantity(恢复到绑定前的值),收货单明细的可用数量自动恢复(因为绑定记录被删除)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "entry_item_id", - "type": "number", - "required": true, - "description": "入库单明细ID" - } - ], - "response": [ - { - "name": "entry_item_id", - "type": "number", - "required": true, - "description": "入库明细ID" - }, - { - "name": "released_quantity", - "type": "number", - "required": true, - "description": "释放的绑定总量" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/storage.inventory/_module.lifecycle.json b/workflows/api-doc-system/data/module/storage.inventory/_module.lifecycle.json deleted file mode 100644 index 8e7e3b36..00000000 --- a/workflows/api-doc-system/data/module/storage.inventory/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "库存操作模块", - "key": "storage.inventory", - "folder": "storage.inventory" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/storage.inventory/module.json b/workflows/api-doc-system/data/module/storage.inventory/module.json deleted file mode 100644 index 55940a2e..00000000 --- a/workflows/api-doc-system/data/module/storage.inventory/module.json +++ /dev/null @@ -1,286 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "库存操作模块", - "key": "storage.inventory", - "folder": "storage.inventory", - "interfaceCount": 7 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "storage.inventory.quickPutaway", - "title": "收货单快捷入库上架。从收货单直接生成入库单并写入库存表,要求收货单已完成、已审核、货主已开启快捷入库策略且所有明细已匹配系统商品", - "description": "收货单快捷入库上架。从收货单直接生成入库单并写入库存表,要求收货单已完成、已审核、货主已开启快捷入库策略且所有明细已匹配系统商品", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "receiving_id", - "type": "number", - "required": true, - "description": "收货单ID,兼容 id" - } - ], - "response": [] - }, - { - "method": "storage.inventory.matchPutaway", - "title": "收货单与入库单匹配入库。接收多个收货单和入库单,按商品(stock_warehouse_id)进行数量匹配入库,要求收货单已完成且已审核,完成后根据入库单来源(QM/API)自动触发回传", - "description": "收货单与入库单匹配入库。接收多个收货单和入库单,按商品(stock_warehouse_id)进行数量匹配入库,要求收货单已完成且已审核,完成后根据入库单来源(QM/API)自动触发回传", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "receiving_ids", - "type": "array", - "required": true, - "description": "收货单ID列表" - }, - { - "name": "entry_order_ids", - "type": "array", - "required": true, - "description": "入库单ID列表" - } - ], - "response": [] - }, - { - "method": "storage.inventory.transferLocation", - "title": "单商品单库位移库,将库存从一个库位移动到另一个库位,支持部分数量移库和全量移库", - "description": "单商品单库位移库,将库存从一个库位移动到另一个库位,支持部分数量移库和全量移库", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "storage_id", - "type": "number", - "required": true, - "description": "库存记录ID" - }, - { - "name": "target_space_id", - "type": "number", - "required": true, - "description": "目标库位ID" - }, - { - "name": "quantity", - "type": "number", - "required": false, - "description": "移库数量,不传则全部移动" - } - ], - "response": [] - }, - { - "method": "storage.inventory.transferByProduct", - "title": "按库位+商品维度移库,自动查找原库位下该商品的所有库存记录并合并移动。不适用于开启批次管理的商品", - "description": "按库位+商品维度移库,自动查找原库位下该商品的所有库存记录并合并移动。不适用于开启批次管理的商品", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "space_id", - "type": "number", - "required": true, - "description": "原库位ID" - }, - { - "name": "stock_id", - "type": "number", - "required": true, - "description": "商品SKU ID(wms_stock_warehouse.id)" - }, - { - "name": "target_space_id", - "type": "number", - "required": true, - "description": "目标库位ID" - }, - { - "name": "quantity", - "type": "number", - "required": true, - "description": "移库数量" - } - ], - "response": [] - }, - { - "method": "storage.inventory.list", - "title": "库存列表查询(查 wms_storage),支持 where 条件、分页、排序、批次分组。默认按库位+商品合并数量(合并模式),group_by_batch=true 时返回每条库存明细(明细模式)", - "description": "库存列表查询(查 wms_storage),支持 where 条件、分页、排序、批次分组。默认按库位+商品合并数量(合并模式),group_by_batch=true 时返回每条库存明细(明细模式)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "where", - "type": "object", - "required": false, - "description": "统一 where 条件对象,可用字段:stock_id(商品ID)、space_id(库位ID)、store_id(货主ID)、inventory_type(ZP/CC/JS/XS/ZT/DJ/FP)、batch_no(批次号)、inbound_order_no(入库单号)、available_quantity(可用数量,支持 gt/lt)、inbound_time(入库时间,支持 between)、created_at(创建时间,支持 between)" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数 { page, pageSize },默认 page=1, pageSize=20" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数 { sortField, sortOrder },默认 sortField='created_at', sortOrder='DESC'" - }, - { - "name": "group_by_batch", - "type": "boolean", - "required": false, - "description": "是否按批次查询,默认 false。false=合并模式(按库位+商品聚合quantity/locked_quantity/available_quantity),true=明细模式(逐条返回含 batch_no/production_date/expiry_date 等)" - } - ], - "response": [] - }, - { - "method": "storage.expiry.list", - "title": "库存有效期列表查询(效期预警),按 wms_storage 查询并计算剩余天数与过期状态,支持 where 条件与分页。注意:无需传 warehouse_id/store_id,服务端会从当前登录用户取仓库上下文。", - "description": "库存有效期列表查询(效期预警),按 wms_storage 查询并计算剩余天数与过期状态,支持 where 条件与分页。注意:无需传 warehouse_id/store_id,服务端会从当前登录用户取仓库上下文。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "where", - "type": "object", - "required": false, - "description": "统一 where 条件对象;支持字段:item_code、goods_code、item_name、sku_property、stock_unit、is_shelf_life_mgmt、remaining_threshold_days。示例:where.item_code={operator:like,value:ABC}; where.remaining_threshold_days={operator:lte,value:7}。注意:无需传入 store_id 或 warehouse_id,服务端会从当前登录用户获取仓库上下文。" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数 { page, pageSize },默认 page=1, pageSize=20" - } - ], - "response": [ - { - "name": "data.list", - "type": "array", - "required": true, - "description": "匹配到的库存效期项数组" - }, - { - "name": "data.list[]", - "type": "object", - "required": false, - "description": "列表项,包含至少以下字段" - }, - { - "name": "data.pagination", - "type": "object", - "required": true, - "description": "分页信息,含 page、pageSize、total、totalPages" - } - ] - }, - { - "method": "storage.transaction.list", - "title": "出入库记录列表查询,支持 where 条件、分页、排序、批次分组切换。默认按库位合并数量(合并模式),group_by_batch=true 时返回每条明细(明细模式)", - "description": "出入库记录列表查询,支持 where 条件、分页、排序、批次分组切换。默认按库位合并数量(合并模式),group_by_batch=true 时返回每条明细(明细模式)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "where", - "type": "object", - "required": false, - "description": "统一 where 条件对象,可用字段:transaction_type(ENUM INBOUND/OUTBOUND)、stock_id、space_id、store_id、order_type(SCRK/MATCH)、order_no、inventory_type(ZP/CC/JS/XS/ZT/DJ/FP)、operator_name、created_at(支持 between)" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数 { page, pageSize },默认 page=1, pageSize=20" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数 { sortField, sortOrder },默认 sortField='created_at', sortOrder='DESC'" - }, - { - "name": "group_by_batch", - "type": "boolean", - "required": false, - "description": "是否按批次查询明细,默认 false。false=合并模式(按库位+商品聚合),true=明细模式(逐条返回)" - } - ], - "response": [] - } - ] -} diff --git a/workflows/api-doc-system/data/module/storage.management/_module.lifecycle.json b/workflows/api-doc-system/data/module/storage.management/_module.lifecycle.json deleted file mode 100644 index 53964e04..00000000 --- a/workflows/api-doc-system/data/module/storage.management/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "库存管理模块", - "key": "storage.management", - "folder": "storage.management" - }, - "status": "active", - "createdAt": "2026-06-18 09:43:47", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/storage.management/module.json b/workflows/api-doc-system/data/module/storage.management/module.json deleted file mode 100644 index 18cbe924..00000000 --- a/workflows/api-doc-system/data/module/storage.management/module.json +++ /dev/null @@ -1,89 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "库存管理模块", - "key": "storage.management", - "folder": "storage.management", - "interfaceCount": 1 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "storage.management.replenishmentDemand", - "title": "分拣缺货补货需求计算(仓库级别)。自动从用户上下文获取仓库,查询所有未完成储位分配的订单,计算每个SKU在分拣区与存货区的库存量、订单需求量、分拣区缺口、建议补货量及可补货库位。支持分页与排序。", - "description": "分拣缺货补货需求计算(仓库级别)。自动从用户上下文获取仓库,查询所有未完成储位分配的订单,计算每个SKU在分拣区与存货区的库存量、订单需求量、分拣区缺口、建议补货量及可补货库位。支持分页与排序。", - "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,默认 page=1 pageSize=20" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数,支持 sortField / sortOrder。sortField 可选值:stock_id / pick_zone_quantity / storage_zone_quantity / total_demand / shortage / replenishment_needed,默认 shortage;sortOrder 可选 ASC / DESC,默认 DESC" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "补货需求明细列表" - }, - { - "name": "summary", - "type": "object", - "required": true, - "description": "汇总信息" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/storage.report/_module.lifecycle.json b/workflows/api-doc-system/data/module/storage.report/_module.lifecycle.json deleted file mode 100644 index bb0926df..00000000 --- a/workflows/api-doc-system/data/module/storage.report/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "库存报表模块", - "key": "storage.report", - "folder": "storage.report" - }, - "status": "active", - "createdAt": "2026-05-15 17:32:36", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/storage.report/module.json b/workflows/api-doc-system/data/module/storage.report/module.json deleted file mode 100644 index 7390d52f..00000000 --- a/workflows/api-doc-system/data/module/storage.report/module.json +++ /dev/null @@ -1,341 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "库存报表模块", - "key": "storage.report", - "folder": "storage.report", - "interfaceCount": 3 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "storage.report.search", - "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": "where", - "type": "object", - "required": false, - "description": "查询条件对象。支持字段:start_time(闭区间下限)、end_time(闭区间上限)、by_space(是否按库位返回,默认 false)、store_ids(货主ID数组)。仅返回在时间区间内存在流水的数据(无流水键不返回)。" - }, - { - "name": "where.start_time", - "type": "string", - "required": false, - "description": "开始时间,支持字符串/Date;用于闭区间过滤:created_at >= start_time" - }, - { - "name": "where.end_time", - "type": "string", - "required": false, - "description": "结束时间,支持字符串/Date;用于闭区间过滤:created_at <= end_time" - }, - { - "name": "where.by_space", - "type": "boolean", - "required": false, - "description": "是否按库位返回,默认 false。false=按商品+货主聚合(多库位汇总),true=按商品+库位+货主返回;当 where.by_space=true 时,额外返回 space_id、space_name(custom_name 优先,否则使用 space_code)。" - }, - { - "name": "where.store_ids", - "type": "array", - "required": false, - "description": "货主ID数组,用于过滤特定货主(空或未传表示不过滤)" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数对象(请求体 data.sort)。支持 data.sort.sortField / data.sort.sort_field 与 data.sort.sortOrder / data.sort.sort_order;sortField 白名单:begin_total、inbound_total、outbound_total、end_total;sortOrder 支持 ASC / DESC(大小写不敏感);非法字段或顺序将回退默认排序。" - }, - { - "name": "sort.sortField", - "type": "string", - "required": false, - "description": "排序字段(兼容 data.sort.sortField)。白名单:begin_total、inbound_total、outbound_total、end_total;非法值回退默认排序。" - }, - { - "name": "sort.sort_field", - "type": "string", - "required": false, - "description": "排序字段下划线别名(兼容 data.sort.sort_field),规则同 sort.sortField。" - }, - { - "name": "sort.sortOrder", - "type": "string", - "required": false, - "description": "排序方向(兼容 data.sort.sortOrder),支持 ASC / DESC(大小写不敏感);非法值回退默认排序。" - }, - { - "name": "sort.sort_order", - "type": "string", - "required": false, - "description": "排序方向下划线别名(兼容 data.sort.sort_order),规则同 sort.sortOrder。" - } - ], - "response": [ - { - "name": "data.list", - "type": "array", - "required": true, - "description": "匹配到的报表行列表 已按 sort 规则排序返回。" - }, - { - "name": "data.list[]", - "type": "object", - "required": true, - "description": "单条报表记录字段" - } - ] - }, - { - "method": "storage.report.export", - "title": "提交库存报表导出异步任务(与 storage.report.search 使用相同查询条件),立即返回任务受理信息,不直接返回文件。", - "description": "提交库存报表导出异步任务(与 storage.report.search 使用相同查询条件),立即返回任务受理信息,不直接返回文件。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "where", - "type": "object", - "required": false, - "description": "查询条件对象。支持字段:start_time(闭区间下限)、end_time(闭区间上限)、by_space(是否按库位返回,默认 false)、store_ids(货主ID数组)。仅返回在时间区间内存在流水的数据(无流水键不返回)。" - }, - { - "name": "where.start_time", - "type": "string", - "required": false, - "description": "开始时间,支持字符串/Date;用于闭区间过滤:created_at >= start_time" - }, - { - "name": "where.end_time", - "type": "string", - "required": false, - "description": "结束时间,支持字符串/Date;用于闭区间过滤:created_at <= end_time" - }, - { - "name": "where.by_space", - "type": "boolean", - "required": false, - "description": "是否按库位返回,默认 false。false=按商品+货主聚合(多库位汇总),true=按商品+库位+货主返回;当 where.by_space=true 时,导出汇总 sheet 会额外包含 space_id、space_name。" - }, - { - "name": "where.store_ids", - "type": "array", - "required": false, - "description": "货主ID数组,用于过滤特定货主(空或未传表示不过滤)" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数对象(请求体 data.sort)。支持 data.sort.sortField / data.sort.sort_field 与 data.sort.sortOrder / data.sort.sort_order;sortField 白名单:begin_total、inbound_total、outbound_total、end_total;sortOrder 支持 ASC / DESC(大小写不敏感);非法字段或顺序将回退默认排序。" - }, - { - "name": "sort.sortField", - "type": "string", - "required": false, - "description": "排序字段(兼容 data.sort.sortField)。白名单:begin_total、inbound_total、outbound_total、end_total;非法值回退默认排序。" - }, - { - "name": "sort.sort_field", - "type": "string", - "required": false, - "description": "排序字段下划线别名(兼容 data.sort.sort_field),规则同 sort.sortField。" - }, - { - "name": "sort.sortOrder", - "type": "string", - "required": false, - "description": "排序方向(兼容 data.sort.sortOrder),支持 ASC / DESC(大小写不敏感);非法值回退默认排序。" - }, - { - "name": "sort.sort_order", - "type": "string", - "required": false, - "description": "排序方向下划线别名(兼容 data.sort.sort_order),规则同 sort.sortOrder。" - } - ], - "response": [ - { - "name": "task_id", - "type": "string", - "required": true, - "description": "导出任务ID,用于后续查询进度。" - }, - { - "name": "status", - "type": "string", - "required": true, - "description": "任务状态,提交受理后初始为 submitted。" - }, - { - "name": "progress", - "type": "number", - "required": true, - "description": "任务进度百分比(0-100)。" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "任务受理提示信息。" - }, - { - "name": "error", - "type": "string", - "required": true, - "description": "错误信息;受理成功时通常为空字符串。" - }, - { - "name": "result", - "type": "object|null", - "required": true, - "description": "任务结果对象;受理阶段为 null。" - }, - { - "name": "update_time", - "type": "number", - "required": true, - "description": "任务状态更新时间(时间戳)。" - } - ] - }, - { - "method": "storage.report.exportTaskProgress", - "title": "根据 task_id 查询库存报表导出任务进度与结果;status 可能值:submitted/running/success/failed/not_found。", - "description": "根据 task_id 查询库存报表导出任务进度与结果;status 可能值:submitted/running/success/failed/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", - "type": "string", - "required": false, - "description": "导出任务ID(下划线写法)。" - }, - { - "name": "taskId", - "type": "string", - "required": false, - "description": "导出任务ID(驼峰写法,兼容别名)。" - } - ], - "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": "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": "number", - "required": true, - "description": "任务状态更新时间(时间戳)。" - }, - { - "name": "result", - "type": "object|null", - "required": true, - "description": "任务结果对象(包含导出文件信息);未完成或失败时可能为 null。" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/storage.stockout/_module.lifecycle.json b/workflows/api-doc-system/data/module/storage.stockout/_module.lifecycle.json deleted file mode 100644 index 621a9fdb..00000000 --- a/workflows/api-doc-system/data/module/storage.stockout/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "出库单模块", - "key": "storage.stockout", - "folder": "storage.stockout" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/storage.stockout/module.json b/workflows/api-doc-system/data/module/storage.stockout/module.json deleted file mode 100644 index 958cd929..00000000 --- a/workflows/api-doc-system/data/module/storage.stockout/module.json +++ /dev/null @@ -1,185 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "出库单模块", - "key": "storage.stockout", - "folder": "storage.stockout", - "interfaceCount": 3 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "storage.stockout.list", - "title": "非订单出库单能力(对应奇门 stockout.create):用于处理由奇门创建的非订单出库单;主出口为 storage.stockout.*,不再推荐通过 storage.delivery.* 命名使用。storage.delivery.* 仅保留兼容转发。", - "description": "非订单出库单能力(对应奇门 stockout.create):用于处理由奇门创建的非订单出库单;主出口为 storage.stockout.*,不再推荐通过 storage.delivery.* 命名使用。storage.delivery.* 仅保留兼容转发。", - "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 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;常用字段包括 delivery_order_code、status、outbound_status、buyer_nick、mobile 与日期区间字段。" - }, - { - "name": "sort", - "type": "object", - "required": false, - "description": "排序参数,支持 sortField/sortOrder,默认按 updated_at DESC、id DESC" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "出库单列表" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - } - ] - }, - { - "method": "storage.stockout.toOrder", - "title": "占位接口,暂未开放。当前仅保留方法名用于后续扩展,逻辑暂不能使用。参数 id / delivery_order_code 暂未启用。", - "description": "占位接口,暂未开放。当前仅保留方法名用于后续扩展,逻辑暂不能使用。参数 id / delivery_order_code 暂未启用。", - "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": "number", - "required": false, - "description": "预留参数,暂未启用;当前仅保留字段名用于后续扩展。" - }, - { - "name": "delivery_order_code", - "type": "string", - "required": false, - "description": "预留参数,暂未启用;当前仅保留字段名用于后续扩展。" - } - ], - "response": [ - { - "name": "_note", - "type": "string", - "required": false, - "description": "占位接口,当前无有效业务响应" - } - ] - }, - { - "method": "storage.stockout.listItems", - "title": "按出库单查询商品明细(用于非订单出库单),底层复用 order.listItems。", - "description": "按出库单查询商品明细(用于非订单出库单),底层复用 order.listItems。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "delivery_order_code", - "type": "string", - "required": false, - "description": "出库单号,可用于定位订单" - }, - { - "name": "order_id", - "type": "number", - "required": false, - "description": "订单ID,可与 id 兼容用于定位订单" - }, - { - "name": "id", - "type": "number", - "required": false, - "description": "订单ID,可选;与 delivery_order_code / order_id 至少传一个" - } - ], - "response": [ - { - "name": "order", - "type": "object", - "required": true, - "description": "订单基础信息(含 id、delivery_order_code)" - }, - { - "name": "items", - "type": "array", - "required": true, - "description": "出库单商品明细" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/storage_receiving/_deleted.20260417.json b/workflows/api-doc-system/data/module/storage_receiving/_deleted.20260417.json deleted file mode 100644 index 2c0e5e3b..00000000 --- a/workflows/api-doc-system/data/module/storage_receiving/_deleted.20260417.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "folder": "storage_receiving", - "deletedAt": "2026-04-17 17:28:24", - "reason": "Missing from latest API doc parsing result" -} diff --git a/workflows/api-doc-system/data/module/storage_receiving/_module.lifecycle.json b/workflows/api-doc-system/data/module/storage_receiving/_module.lifecycle.json deleted file mode 100644 index 93fbec27..00000000 --- a/workflows/api-doc-system/data/module/storage_receiving/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "收货单模块", - "key": "storage_receiving", - "folder": "storage_receiving" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": "2026-04-17 19:16:50" -} diff --git a/workflows/api-doc-system/data/module/storage_receiving/module.json b/workflows/api-doc-system/data/module/storage_receiving/module.json deleted file mode 100644 index 9167d639..00000000 --- a/workflows/api-doc-system/data/module/storage_receiving/module.json +++ /dev/null @@ -1,1256 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "收货单模块", - "key": "storage_receiving", - "folder": "storage_receiving", - "interfaceCount": 19 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [ - "storage.receiving.getAvailableInboundQuantity" - ] - } - } - }, - "interfaces": [ - { - "method": "storage.receiving.getReceivingList", - "title": "storage.receiving.getReceivingList 接口", - "description": "storage.receiving.getReceivingList 接口", - "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 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、status、store_id、日期区间等字段。示例:where.status={operator:eq,value:finished}; where.store_id={operator:eq,value:1001}; where.create_time_start={value:2026-03-01}。" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "收货单列表" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" - }, - { - "name": "summary", - "type": "object", - "required": true, - "description": "汇总信息(total_quantity、total_locked、total_available、total_items)" - } - ] - }, - { - "method": "storage.receiving.getReceivingDetail", - "title": "storage.receiving.getReceivingDetail 接口", - "description": "storage.receiving.getReceivingDetail 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "收货单ID" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "明细分页参数,支持 page/pageSize" - } - ], - "response": [ - { - "name": "receiving", - "type": "object", - "required": true, - "description": "收货单详情(含 details、images、pagination)" - }, - { - "name": "receiving.details", - "type": "array", - "required": false, - "description": "收货单明细列表,单条记录包含明细字段(见下文)" - }, - { - "name": "receiving.details.*.space_id", - "type": "string", - "required": false, - "description": "库位展示名称(string|null)。优先取 custom_space_name,其次取 space_name。兼容说明:该字段历史上为数值库位ID,现已调整为展示名称;原始ID请使用 receiving.details.*.space_id_raw。" - }, - { - "name": "receiving.details.*.space_id_raw", - "type": "number", - "required": false, - "description": "原始库位ID(number|null),用于兼容依赖旧语义(space_id=数字ID)的调用方。" - }, - { - "name": "receiving.details.*.space_name", - "type": "string", - "required": false, - "description": "库位名称/编码(string|null),作为展示名称的回退来源。" - }, - { - "name": "receiving.details.*.custom_space_name", - "type": "string", - "required": false, - "description": "库位自定义名称(string|null,可空)。" - }, - { - "name": "receiving.details.*.box_remainder", - "type": "number", - "required": false, - "description": "箱内剩余数量/零散数量(不满箱时的件数)" - }, - { - "name": "receiving.details.*.box_weight", - "type": "number", - "required": false, - "description": "实测箱重(单位与系统重量一致,如 kg)" - } - ] - }, - { - "method": "storage.receiving.batchCancelReceiving", - "title": "storage.receiving.batchCancelReceiving 接口", - "description": "storage.receiving.batchCancelReceiving 接口", - "endpoint": "/system", - "authRequired": true, - "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数组" - } - ], - "response": [ - { - "name": "message", - "type": "string", - "required": true, - "description": "批量作废处理结果" - } - ] - }, - { - "method": "storage.receiving.rejectReceiving", - "title": "驳回收货单:将已完成(completed)的收货单批量恢复为收货中(receiving),记录驳回人信息和驳回理由。若任意一张收货单状态非 completed,则整批拒绝操作。驳回人信息(reviewer_name、reviewer_employee_id)自动取当前登录用户上下文,无需传入.", - "description": "驳回收货单:将已完成(completed)的收货单批量恢复为收货中(receiving),记录驳回人信息和驳回理由。若任意一张收货单状态非 completed,则整批拒绝操作。驳回人信息(reviewer_name、reviewer_employee_id)自动取当前登录用户上下文,无需传入.", - "endpoint": "/system", - "authRequired": true, - "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数组,所有收货单必须属于当前仓库且状态为 completed,否则整批拒绝" - }, - { - "name": "remark", - "type": "string", - "required": false, - "description": "驳回理由,覆盖收货单原备注字段;不传则保留原备注" - } - ], - "response": [ - { - "name": "count", - "type": "number", - "required": false, - "description": "成功驳回的收货单数量" - } - ] - }, - { - "method": "storage.receiving.reviewReceiving", - "title": "批量审核收货单:校验所有单据满足条件(收货完成、全部匹配、未入库、已绑定货主、未审核)后统一审核,任意一张不符合则整批失败回滚。审核人信息自动取当前登录用户上下文,无需传入.", - "description": "批量审核收货单:校验所有单据满足条件(收货完成、全部匹配、未入库、已绑定货主、未审核)后统一审核,任意一张不符合则整批失败回滚。审核人信息自动取当前登录用户上下文,无需传入.", - "endpoint": "/system", - "authRequired": true, - "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数组,所有单据必须满足:status=completed、detail_status=all_matched、storage_status=none、store_id 已绑定、is_review=0,否则整批拒绝" - } - ], - "response": [ - { - "name": "count", - "type": "number", - "required": false, - "description": "成功审核的收货单数量" - } - ] - }, - { - "method": "storage.receiving.create", - "title": "storage.receiving.create 接口", - "description": "storage.receiving.create 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "delivery_method", - "type": "string", - "required": true, - "description": "到货方式:truck/express/air_freight/sea_freight/other" - }, - { - "name": "loading_method", - "type": "string", - "required": true, - "description": "装卸方式:with_pallet/without_pallet" - }, - { - "name": "license_plate", - "type": "string", - "required": false, - "description": "车牌号(delivery_method=truck 时建议传)" - }, - { - "name": "tracking_number", - "type": "string", - "required": false, - "description": "物流单号(非 truck/other 场景建议传)" - }, - { - "name": "store_id", - "type": "number", - "required": false, - "description": "货主ID" - }, - { - "name": "total_boxes", - "type": "number", - "required": false, - "description": "总箱数" - }, - { - "name": "total_pallets", - "type": "number", - "required": false, - "description": "总托盘数" - }, - { - "name": "remark", - "type": "string", - "required": false, - "description": "备注" - } - ], - "response": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "新建收货单ID" - }, - { - "name": "receiving_number", - "type": "string", - "required": true, - "description": "收货单号" - } - ] - }, - { - "method": "storage.receiving.bindStore", - "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": "id", - "type": "number", - "required": true, - "description": "收货单ID" - }, - { - "name": "store_id", - "type": "number", - "required": true, - "description": "货主ID(必须与当前仓库存在有效签约关系)" - } - ], - "response": [ - { - "name": "data.id", - "type": "number", - "required": true, - "description": "收货单ID" - }, - { - "name": "data.store_id", - "type": "number", - "required": true, - "description": "已绑定的货主ID" - }, - { - "name": "data.store_name", - "type": "string", - "required": false, - "description": "货主名称/签约备注名" - }, - { - "name": "data.status", - "type": "string", - "required": true, - "description": "当前收货单状态" - } - ] - }, - { - "method": "storage.receiving.bindDetailProduct", - "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": "detail_id", - "type": "number", - "required": true, - "description": "收货单明细ID(兼容字段 `id`)" - }, - { - "name": "system_product_id", - "type": "number", - "required": true, - "description": "系统商品ID(`StockWarehouse.id`,且必须属于当前仓库)" - } - ], - "response": [ - { - "name": "data.detail_id", - "type": "number", - "required": true, - "description": "收货单明细ID" - }, - { - "name": "data.receiving_id", - "type": "number", - "required": true, - "description": "收货单ID" - }, - { - "name": "data.system_product_id", - "type": "number", - "required": true, - "description": "已绑定的系统商品ID" - }, - { - "name": "data.product_name", - "type": "string", - "required": true, - "description": "自动回填的商品名称" - } - ] - }, - { - "method": "storage.receiving.queryReceivingLogs", - "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": "number|string", - "required": false, - "description": "收货单ID(与 receiving_id 二选一)" - }, - { - "name": "receiving_id", - "type": "number|string", - "required": false, - "description": "收货单ID(兼容字段,与 id 二选一)" - }, - { - "name": "page", - "type": "number", - "required": false, - "description": "页码(兼容顶层分页入参)" - }, - { - "name": "pageSize", - "type": "number", - "required": false, - "description": "每页数量(兼容顶层分页入参)" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页参数,支持 page / pageSize" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "日志列表" - }, - { - "name": "pagination", - "type": "object", - "required": true, - "description": "分页信息,包含 page、pageSize、total、totalPages" - } - ] - }, - { - "method": "storage.receiving.removeItem", - "title": "storage.receiving.removeItem 接口", - "description": "storage.receiving.removeItem 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": false, - "description": "id 参数" - }, - { - "name": "item_id", - "type": "number", - "required": false, - "description": "item_id 参数" - } - ], - "response": [] - }, - { - "method": "storage.receiving.save", - "title": "修改收货单基础信息。按收货单ID更新当前仓库下收货单的基础字段。", - "description": "修改收货单基础信息。按收货单ID更新当前仓库下收货单的基础字段。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "收货单ID,按该ID修改当前仓库下的收货单" - }, - { - "name": "delivery_method", - "type": "string", - "required": false, - "description": "到货方式:truck/express/air_freight/sea_freight/other;不传则保持原值" - }, - { - "name": "loading_method", - "type": "string", - "required": false, - "description": "装卸方式:with_pallet/without_pallet;不传则保持原值" - }, - { - "name": "license_plate", - "type": "string", - "required": false, - "description": "车牌号;当 delivery_method=truck 时可更新,其他到货方式会被清空或忽略" - }, - { - "name": "tracking_number", - "type": "string", - "required": false, - "description": "物流单号;当 delivery_method 为 express/air_freight/sea_freight 时可更新,truck/other 场景会被清空或忽略" - }, - { - "name": "store_id", - "type": "number", - "required": false, - "description": "货主ID;若传入,会校验当前仓库下签约关系并同步更新货主名称;传 0/null 可清空货主" - }, - { - "name": "total_boxes", - "type": "number", - "required": false, - "description": "总箱数,默认 0" - }, - { - "name": "total_pallets", - "type": "number", - "required": false, - "description": "总托盘数,默认 0" - }, - { - "name": "remark", - "type": "string", - "required": false, - "description": "备注信息" - }, - { - "name": "status", - "type": "string", - "required": false, - "description": "收货单状态;不传则保持原值" - }, - { - "name": "video_device_id", - "type": "string", - "required": false, - "description": "录像设备ID" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码;200 表示修改成功" - }, - { - "name": "id", - "type": "number", - "required": true, - "description": "修改的收货单ID" - }, - { - "name": "receiving_number", - "type": "string", - "required": true, - "description": "收货单号" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "结果描述;成功时通常为收货单修改成功" - } - ] - }, - { - "method": "storage.receiving.get", - "title": "storage.receiving.get 接口", - "description": "storage.receiving.get 接口", - "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": "number", - "required": true, - "description": "收货单ID" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": false, - "description": "业务状态码,200 表示成功" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "返回信息" - }, - { - "name": "data", - "type": "object", - "required": false, - "description": "收货单详情对象,包含 details(明细数组)、images 及主表字段" - }, - { - "name": "data.details", - "type": "array", - "required": false, - "description": "收货单明细数组(每项为明细对象)" - }, - { - "name": "data.details.*.box_remainder", - "type": "number", - "required": false, - "description": "箱内剩余数量/零散数量(不满箱时的件数),默认 0" - }, - { - "name": "data.details.*.box_weight", - "type": "number", - "required": false, - "description": "实测箱重(单位与系统重量一致,如 kg),默认 0" - } - ] - }, - { - "method": "storage.receiving.addDetail", - "title": "支持新增可选入参 item;item 有值时按传入字段创建明细(服务端会覆盖 receiving_id 与 creator_id);item 无值时沿原链路创建空白明细。返回的 selectId 与 data.details 语义不变(仍返回新创建明细的 selectId 与更新后的明细列表)。", - "description": "支持新增可选入参 item;item 有值时按传入字段创建明细(服务端会覆盖 receiving_id 与 creator_id);item 无值时沿原链路创建空白明细。返回的 selectId 与 data.details 语义不变(仍返回新创建明细的 selectId 与更新后的明细列表)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "receiving_id", - "type": "number", - "required": true, - "description": "收货单ID" - }, - { - "name": "item", - "type": "object", - "required": false, - "description": "可选:按传入字段创建明细;不传则创建空白明细。item.children 需覆盖以下字段(有则写、无则补齐):actual_quantity, box_quantity, boxes_per_pallet, space_id, system_product_id, box_width, box_height, box_length, box_remainder, box_weight, weight, barcode, product_name, pallet_quantity, receiving_time, production_date, expiry_date, remark, batch_number, product_snapshot。若传入 item,服务端仍会覆盖 receiving_id 与 creator_id。" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": true, - "description": "业务状态码,200 表示添加成功" - }, - { - "name": "message", - "type": "string", - "required": true, - "description": "结果描述,成功时为 '添加成功'" - }, - { - "name": "data.details", - "type": "array", - "required": true, - "description": "收货单明细数组(每项为明细对象)" - }, - { - "name": "data.selectId", - "type": "number", - "required": true, - "description": "新创建的明细ID,用于前端选中" - } - ] - }, - { - "method": "storage.receiving.deleteDetail", - "title": "删除收货单明细并回算统计。仅允许明细创建者在收货中状态删除未入库的明细;服务端从登录用户上下文获取 creator_id(ctx.user.employees_id)与 warehouse_id(ctx.user.store_id)。若关联收货单状态为 completed(已完成)或 cancelled(已取消),接口会返回删除失败(400),不允许删除明细。", - "description": "删除收货单明细并回算统计。仅允许明细创建者在收货中状态删除未入库的明细;服务端从登录用户上下文获取 creator_id(ctx.user.employees_id)与 warehouse_id(ctx.user.store_id)。若关联收货单状态为 completed(已完成)或 cancelled(已取消),接口会返回删除失败(400),不允许删除明细。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "detail_id", - "type": "number", - "required": true, - "description": "收货单明细 ID(必填)" - } - ], - "response": [ - { - "name": "code", - "type": "number", - "required": false, - "description": "业务状态码,200 表示成功,400/404/500 表示失败" - }, - { - "name": "message", - "type": "string", - "required": false, - "description": "简短的错误或成功信息" - }, - { - "name": "data", - "type": "object", - "required": false, - "description": "成功时返回的结果对象" - }, - { - "name": "data.details", - "type": "array", - "required": false, - "description": "删除后收货单剩余的明细数组。每项字段与 storage.receiving.getReceivingDetail 返回的明细项一致;product_snapshot 为解析后的对象或 null" - }, - { - "name": "data.selectId", - "type": "number|null", - "required": false, - "description": "删除后建议前端选中的明细 ID;无剩余明细时为 null" - } - ] - }, - { - "method": "storage.receiving.detailChange", - "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": "id", - "type": "number", - "required": true, - "description": "收货明细ID" - }, - { - "name": "receiving_id", - "type": "number", - "required": true, - "description": "收货单ID" - }, - { - "name": "actual_quantity", - "type": "number", - "required": false, - "description": "实际收货数量" - }, - { - "name": "batch_number", - "type": "string", - "required": false, - "description": "批次号" - }, - { - "name": "production_date", - "type": "string", - "required": false, - "description": "生产日期(可解析的日期字符串)" - }, - { - "name": "expiry_date", - "type": "string", - "required": false, - "description": "到期日期(可解析的日期字符串)。若早于当前日期,接口会返回 400 并拒绝录入。" - }, - { - "name": "box_quantity", - "type": "number", - "required": false, - "description": "箱数" - }, - { - "name": "boxes_per_pallet", - "type": "number", - "required": false, - "description": "每托盘箱数" - }, - { - "name": "pallet_quantity", - "type": "number", - "required": false, - "description": "托盘数" - }, - { - "name": "space_id", - "type": "number", - "required": false, - "description": "库位 ID(可回写)" - }, - { - "name": "remark", - "type": "string", - "required": false, - "description": "备注" - }, - { - "name": "system_product_id", - "type": "number", - "required": false, - "description": "系统商品 ID(StockWarehouse.id)。若提供,服务端会尝试回填 barcode/weight/箱规/product_name/product_snapshot 等。" - }, - { - "name": "barcode", - "type": "string", - "required": false, - "description": "条码(未传 system_product_id 时可单独更新)" - }, - { - "name": "product_name", - "type": "string", - "required": false, - "description": "商品名称(未传 system_product_id 时可单独更新)" - }, - { - "name": "box_width", - "type": "number", - "required": false, - "description": "箱宽" - }, - { - "name": "box_height", - "type": "number", - "required": false, - "description": "箱高" - }, - { - "name": "box_length", - "type": "number", - "required": false, - "description": "箱长" - }, - { - "name": "box_remainder", - "type": "number", - "required": false, - "description": "箱内剩余数量/零散数量(不满箱时的件数)" - }, - { - "name": "box_weight", - "type": "number", - "required": false, - "description": "实测箱重(单位与系统重量一致,如 kg)" - }, - { - "name": "weight", - "type": "number", - "required": false, - "description": "毛重/重量" - } - ], - "response": [ - { - "name": "data.id", - "type": "number", - "required": true, - "description": "收货明细 ID" - }, - { - "name": "data.receiving_id", - "type": "number", - "required": true, - "description": "收货单 ID" - }, - { - "name": "data.actual_quantity", - "type": "number", - "required": false, - "description": "实际收货数量" - }, - { - "name": "data.product_name", - "type": "string", - "required": false, - "description": "商品名称" - }, - { - "name": "data.barcode", - "type": "string", - "required": false, - "description": "条码" - }, - { - "name": "data.system_product_id", - "type": "number", - "required": false, - "description": "系统商品 ID" - }, - { - "name": "data.box_remainder", - "type": "number", - "required": false, - "description": "箱内剩余数量/零散数量(不满箱时的件数)" - }, - { - "name": "data.box_weight", - "type": "number", - "required": false, - "description": "实测箱重(单位与系统重量一致,如 kg)" - }, - { - "name": "data.updated_at", - "type": "string", - "required": false, - "description": "记录更新时间(ISO)" - } - ] - }, - { - "method": "storage.receiving.cancel", - "title": "storage.receiving.cancel 接口", - "description": "storage.receiving.cancel 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "storage.receiving.completeReceiving", - "title": "storage.receiving.completeReceiving 接口", - "description": "storage.receiving.completeReceiving 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "storage.receiving.manualMatchEntryOrder", - "title": "手动匹配入库单与收货单。传入收货单ID和入库单ID,复用异步匹配服务的明细对比和回传逻辑,同步返回匹配结果(含 matchType、comparisonResult、callbackSent、partialStorageMarked 等)。", - "description": "手动匹配入库单与收货单。传入收货单ID和入库单ID,复用异步匹配服务的明细对比和回传逻辑,同步返回匹配结果(含 matchType、comparisonResult、callbackSent、partialStorageMarked 等)。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "receivingId", - "type": "number", - "required": true, - "description": "收货单 ID" - }, - { - "name": "entryOrderId", - "type": "number", - "required": true, - "description": "入库单 ID" - } - ], - "response": [ - { - "name": "matchType", - "type": "string", - "required": true, - "description": "匹配类型枚举:full_match(SKU+数量完全一致)/ receiving_covers_entry(收货单覆盖入库单,触发回传+标记部分入库)/ entry_exceeds_receiving(入库单超出收货单,不触发回传)/ no_match(SKU无交集,不触发回传)" - }, - { - "name": "comparisonResult", - "type": "object", - "required": true, - "description": "明细对比结果对象" - }, - { - "name": "callbackSent", - "type": "boolean", - "required": true, - "description": "是否已发送回传(full_match / receiving_covers_entry 时为 true)" - }, - { - "name": "callbackResult", - "type": "object|null", - "required": true, - "description": "回传结果对象(未发送时为 null);成功时含 success、sourceType(QM/API)、detail 字段" - }, - { - "name": "partialStorageMarked", - "type": "boolean", - "required": true, - "description": "是否已标记部分入库(仅 receiving_covers_entry 时为 true)" - }, - { - "name": "entryOrder", - "type": "object", - "required": true, - "description": "入库单摘要信息" - }, - { - "name": "receivingOrder", - "type": "object", - "required": true, - "description": "收货单摘要信息" - } - ] - }, - { - "method": "storage.receiving.getAvailableInboundQuantity", - "title": "按 stock_id 查询可入库数量。返回指定商品在已审核收货单中各明细的可入库数量(actual_quantity - stored_quantity - pending_allocated_quantity),仅包含尚有可入库余量的明细,排除未审核和已取消的收货单。", - "description": "按 stock_id 查询可入库数量。返回指定商品在已审核收货单中各明细的可入库数量(actual_quantity - stored_quantity - pending_allocated_quantity),仅包含尚有可入库余量的明细,排除未审核和已取消的收货单。", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "stock_id", - "type": "number", - "required": true, - "description": "商品库存ID(stock_warehouse.id)" - } - ], - "response": [ - { - "name": "list", - "type": "array", - "required": true, - "description": "可入库明细列表,每项包含 detail_id、receiving_id、receiving_number、product_name、actual_quantity、stored_quantity、pending_allocated_quantity、available_quantity、storage_status、batch_number、production_date、expiry_date、space_id、receiving_status" - }, - { - "name": "total", - "type": "number", - "required": true, - "description": "返回条数" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/store/_module.lifecycle.json b/workflows/api-doc-system/data/module/store/_module.lifecycle.json deleted file mode 100644 index f7587ec3..00000000 --- a/workflows/api-doc-system/data/module/store/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "主体模块", - "key": "store", - "folder": "store" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/store/module.json b/workflows/api-doc-system/data/module/store/module.json deleted file mode 100644 index ab0fa6ab..00000000 --- a/workflows/api-doc-system/data/module/store/module.json +++ /dev/null @@ -1,303 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "主体模块", - "key": "store", - "folder": "store", - "interfaceCount": 6 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "store.createStore", - "title": "store.createStore 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))", - "description": "store.createStore 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "subject_config", - "type": "object", - "required": false, - "description": "货主主体配置,不传时自动写入默认值" - }, - { - "name": "subject_config.max_notice_webhook_count", - "type": "number", - "required": false, - "description": "当前主体最多允许绑定 / 触达的消息推送接口数量,默认 5" - }, - { - "name": "subject_config.default_express_code", - "type": "string", - "required": false, - "description": "默认快递编码,缺省为 STO" - }, - { - "name": "subject_config.default_platform_code", - "type": "string", - "required": false, - "description": "默认平台编码,缺省为 TB" - }, - { - "name": "subject_config.group_wave_prefix", - "type": "string", - "required": false, - "description": "团购波次前缀,最多 5 个字符,默认 B" - }, - { - "name": "subject_config.min_group_order_fetch_quantity", - "type": "number", - "required": false, - "description": "最小团购订单抓取数量,默认 13" - }, - { - "name": "subject_config.auto_grouping_enabled", - "type": "boolean", - "required": false, - "description": "是否自动加团,默认 false(关闭)" - }, - { - "name": "subject_config.enable_external_express_code", - "type": "boolean", - "required": false, - "description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)" - } - ], - "response": [] - }, - { - "method": "store.createWarehouse", - "title": "store.createWarehouse 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))", - "description": "store.createWarehouse 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "subject_config", - "type": "object", - "required": false, - "description": "货主主体配置,不传时自动写入默认值" - }, - { - "name": "subject_config.max_notice_webhook_count", - "type": "number", - "required": false, - "description": "当前主体最多允许绑定 / 触达的消息推送接口数量,默认 5" - }, - { - "name": "subject_config.default_express_code", - "type": "string", - "required": false, - "description": "默认快递编码,缺省为 STO" - }, - { - "name": "subject_config.default_platform_code", - "type": "string", - "required": false, - "description": "默认平台编码,缺省为 TB" - }, - { - "name": "subject_config.group_wave_prefix", - "type": "string", - "required": false, - "description": "团购波次前缀,最多 5 个字符,默认 B" - }, - { - "name": "subject_config.min_group_order_fetch_quantity", - "type": "number", - "required": false, - "description": "最小团购订单抓取数量,默认 13" - }, - { - "name": "subject_config.auto_grouping_enabled", - "type": "boolean", - "required": false, - "description": "是否自动加团,默认 false(关闭)" - }, - { - "name": "subject_config.enable_external_express_code", - "type": "boolean", - "required": false, - "description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)" - } - ], - "response": [] - }, - { - "method": "store.joinStore", - "title": "store.joinStore 接口", - "description": "store.joinStore 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "store.joinWarehouse", - "title": "store.joinWarehouse 接口", - "description": "store.joinWarehouse 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "store.getStoreRoles", - "title": "store.getStoreRoles 接口", - "description": "store.getStoreRoles 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "code", - "type": "string", - "required": true, - "description": "申请码(join_token)" - } - ], - "response": [] - }, - { - "method": "store.auditApply", - "title": "store.auditApply 接口", - "description": "store.auditApply 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "audit_status", - "type": "string", - "required": true, - "description": "审核状态(approved/rejected)" - }, - { - "name": "code", - "type": "string", - "required": true, - "description": "申请码(join_token)" - }, - { - "name": "store_id", - "type": "number", - "required": true, - "description": "当前审批门店ID" - }, - { - "name": "role_ids", - "type": "array", - "required": true, - "description": "分配角色ID数组" - }, - { - "name": "reject_reason", - "type": "string", - "required": false, - "description": "拒绝原因(audit_status=rejected 时可传)" - } - ], - "response": [] - } - ] -} diff --git a/workflows/api-doc-system/data/module/storewarehouse.store/_module.lifecycle.json b/workflows/api-doc-system/data/module/storewarehouse.store/_module.lifecycle.json deleted file mode 100644 index a9edefa4..00000000 --- a/workflows/api-doc-system/data/module/storewarehouse.store/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "货主-仓库签约模块", - "key": "storeWarehouse.store", - "folder": "storewarehouse.store" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/storewarehouse.store/module.json b/workflows/api-doc-system/data/module/storewarehouse.store/module.json deleted file mode 100644 index d13c7145..00000000 --- a/workflows/api-doc-system/data/module/storewarehouse.store/module.json +++ /dev/null @@ -1,945 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "货主-仓库签约模块", - "key": "storeWarehouse.store", - "folder": "storewarehouse.store", - "interfaceCount": 13 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "storeWarehouse.store.list", - "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": "page", - "type": "number", - "required": false, - "description": "页码,默认 1" - }, - { - "name": "page_size", - "type": "number", - "required": false, - "description": "分页大小,默认 20" - }, - { - "name": "keyword", - "type": "string", - "required": false, - "description": "签约备注或主体名称关键字" - } - ], - "response": [ - { - "name": "data.list", - "type": "array", - "required": false, - "description": "签约关系列表" - }, - { - "name": "data.list[].id", - "type": "number", - "required": false, - "description": "签约关系主键 ID" - }, - { - "name": "data.list[].store_id", - "type": "number", - "required": false, - "description": "货主 ID" - }, - { - "name": "data.list[].store_name", - "type": "string", - "required": false, - "description": "货主名称(优先取备注名,无则取 company_name)" - }, - { - "name": "data.list[].warehouse_id", - "type": "number", - "required": false, - "description": "仓库 ID" - }, - { - "name": "data.list[].warehouse_name", - "type": "string", - "required": false, - "description": "仓库名称(优先取备注名,无则取 company_name)" - }, - { - "name": "data.list[].counterparty_id", - "type": "number", - "required": false, - "description": "对方主体 ID(当前为仓库则返回货主 ID,反之亦然)" - }, - { - "name": "data.list[].counterparty_name", - "type": "string", - "required": false, - "description": "对方主体名称" - }, - { - "name": "data.list[].current_subject_role", - "type": "string", - "required": false, - "description": "当前主体角色:warehouse 或 store" - }, - { - "name": "data.list[].auth_status", - "type": "number", - "required": false, - "description": "签约状态:1=申请中 2=已通过 3=已拒绝 4=已解除 5=已过期" - }, - { - "name": "data.list[].auth_status_label", - "type": "string", - "required": false, - "description": "签约状态中文标签" - }, - { - "name": "data.list[].apply_reason", - "type": "string", - "required": false, - "description": "申请原因" - }, - { - "name": "data.list[].review_comment", - "type": "string", - "required": false, - "description": "审核评语" - }, - { - "name": "data.list[].apply_time", - "type": "string|null", - "required": false, - "description": "申请时间" - }, - { - "name": "data.list[].review_time", - "type": "string|null", - "required": false, - "description": "审核时间" - }, - { - "name": "data.list[].auth_start", - "type": "string|null", - "required": false, - "description": "授权开始时间" - }, - { - "name": "data.list[].auth_end", - "type": "string|null", - "required": false, - "description": "授权结束时间" - }, - { - "name": "data.list[].actual_end", - "type": "string|null", - "required": false, - "description": "实际结束时间" - }, - { - "name": "data.list[].print_quantity", - "type": "number", - "required": false, - "description": "面单余额数量" - }, - { - "name": "data.list[].applied_by", - "type": "number|null", - "required": false, - "description": "申请人账号 ID" - }, - { - "name": "data.list[].reviewed_by", - "type": "number|null", - "required": false, - "description": "审核人账号 ID" - }, - { - "name": "data.list[].ended_by", - "type": "number|null", - "required": false, - "description": "解除人账号 ID" - }, - { - "name": "data.list[].remask", - "type": "string", - "required": false, - "description": "备注名(当前为仓库则返回货主备注名,反之亦然)" - }, - { - "name": "data.list[].use_status", - "type": "number", - "required": false, - "description": "启用状态:0=禁用 1=启用" - }, - { - "name": "data.list[].policy_config", - "type": "object|null", - "required": false, - "description": "签约策略配置对象,无则为 null" - }, - { - "name": "data.list[].is_auth_valid", - "type": "boolean", - "required": false, - "description": "签约是否在有效期内" - }, - { - "name": "data.list[].remaining_days", - "type": "number", - "required": false, - "description": "剩余有效天数(未在有效期内时为 0)" - }, - { - "name": "data.list[].has_qimen_config", - "type": "boolean", - "required": false, - "description": "该货主是否已配置奇门(true=已配置,false=未配置)" - }, - { - "name": "data.total", - "type": "number", - "required": false, - "description": "总记录数" - }, - { - "name": "data.page", - "type": "number", - "required": false, - "description": "当前页码" - }, - { - "name": "data.page_size", - "type": "number", - "required": false, - "description": "每页条数" - }, - { - "name": "data.current_subject.store_id", - "type": "number", - "required": false, - "description": "当前主体 ID" - }, - { - "name": "data.current_subject.company_name", - "type": "string", - "required": false, - "description": "当前主体公司名称" - }, - { - "name": "data.current_subject.role", - "type": "string", - "required": false, - "description": "当前主体角色:warehouse 或 store" - } - ] - }, - { - "method": "storeWarehouse.store.sign", - "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": "store_id", - "type": "number", - "required": false, - "description": "货主ID;由仓库侧发起时必传" - }, - { - "name": "warehouse_id", - "type": "number", - "required": false, - "description": "仓库ID;由货主侧发起时必传" - }, - { - "name": "temp_code", - "type": "string", - "required": false, - "description": "临时签约码;传入后进入确认或预览流程" - } - ], - "response": [] - }, - { - "method": "storeWarehouse.store.rename", - "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": "id", - "type": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - } - ], - "response": [] - }, - { - "method": "storeWarehouse.store.unbind", - "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": "id", - "type": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - }, - { - "name": "use_status", - "type": "number", - "required": false, - "description": "使用状态,0=停用,1=恢复" - } - ], - "response": [] - }, - { - "method": "storeWarehouse.store.adjustPrintQuantity", - "title": "人工调整签约关系下的面单余额并记录变更日志", - "description": "人工调整签约关系下的面单余额并记录变更日志", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - }, - { - "name": "print_quantity", - "type": "number", - "required": false, - "description": "目标面单余额(覆盖值);优先使用该字段" - }, - { - "name": "target_quantity", - "type": "number", - "required": false, - "description": "目标面单余额(覆盖值);兼容别名" - }, - { - "name": "change_quantity", - "type": "number", - "required": true, - "description": "兼容旧字段;当前按目标面单余额(覆盖值)解释,差值将自动写入变更日志" - }, - { - "name": "adjust_quantity", - "type": "number", - "required": false, - "description": "兼容旧字段;当前按目标面单余额(覆盖值)解释" - }, - { - "name": "reason", - "type": "string", - "required": true, - "description": "人工调整缘由,必填" - }, - { - "name": "business_type", - "type": "string", - "required": false, - "description": "业务来源类型,预留给后续 order_express 等自动扣减场景" - }, - { - "name": "business_id", - "type": "number", - "required": false, - "description": "业务关联ID,预留给后续关联 wms_order_express.id" - } - ], - "response": [] - }, - { - "method": "storeWarehouse.store.queryPrintQuantityLogs", - "title": "按 store_id 分页查询面单余额变更日志", - "description": "按 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": "store_id", - "type": "number|string", - "required": true, - "description": "货主ID(必填)" - }, - { - "name": "pagination", - "type": "object", - "required": false, - "description": "分页对象,包含 page 与 page_size;默认 { page: 1, page_size: 20 }" - } - ], - "response": [ - { - "name": "data", - "type": "object", - "required": true, - "description": "返回结果对象,包含 list 和 pagination" - } - ] - }, - { - "method": "storeWarehouse.store.getPolicyConfig", - "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": "id", - "type": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - } - ], - "response": [ - { - "name": "data.contract_id", - "type": "number", - "required": true, - "description": "签约关系ID" - }, - { - "name": "data.policy_config", - "type": "object", - "required": true, - "description": "策略配置对象(包含默认值补齐后的字段)" - }, - { - "name": "data.policy_config.enable_external_express_code", - "type": "number", - "required": true, - "description": "是否启用外部快递编码(flag:0=关闭,1=开启;默认 0)" - } - ] - }, - { - "method": "storeWarehouse.store.getPolicyConfigFields", - "title": "获取签约策略可配置字段元信息列表", - "description": "获取签约策略可配置字段元信息列表", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "storeWarehouse.store.savePolicyConfig", - "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": "id", - "type": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - }, - { - "name": "policy_config", - "type": "object", - "required": true, - "description": "策略配置对象;支持 receive_mode、auto_allocate_bin、auto_allocate_express(是否自动分配快递)、auto_allocate_storage(是否自动分配储位)、allow_mix_batch、allow_temp_storage、storage_separation、print_recharge_price(面单充值元/单,支持 2 位小数)、max_daily_inbound、remark、waybill_custom_display_type(面单自定义显示类型:1=隐藏,2=商品名称和数量,3=拣货库位和条码和数量,4=拣货库位和条码后5位和数量,5=拣货库位商品名称条码和数量)、enable_external_express_code(是否启用外部快递编码,flag:0=关闭,1=开启;默认 0)" - }, - { - "name": "policy_config.enable_external_express_code", - "type": "number", - "required": false, - "description": "是否启用外部快递编码(flag:0=关闭,1=开启;默认 0)" - } - ], - "response": [ - { - "name": "data.contract_id", - "type": "number", - "required": true, - "description": "签约关系ID" - }, - { - "name": "data.policy_config", - "type": "object", - "required": true, - "description": "保存后并补齐默认值的策略配置对象" - }, - { - "name": "data.policy_config.enable_external_express_code", - "type": "number", - "required": true, - "description": "是否启用外部快递编码(flag:0=关闭,1=开启;默认 0)" - } - ] - }, - { - "method": "storeWarehouse.store.listApiConfig", - "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": "id", - "type": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - }, - { - "name": "interface_type_id", - "type": "number", - "required": false, - "description": "接口类型ID,默认查询全部可用类型" - } - ], - "response": [ - { - "name": "data.list[].callback_url", - "type": "string", - "required": false, - "description": "API回调通知URL,来自 serializeQimenConfig 序列化" - } - ] - }, - { - "method": "storeWarehouse.store.saveApiConfig", - "title": "新增或更新签约关系下的接口配置。QM_WMS 类型须填写奇门字段;OPEN_API 类型由系统自动生成 self_app_key 和 self_app_secret", - "description": "新增或更新签约关系下的接口配置。QM_WMS 类型须填写奇门字段;OPEN_API 类型由系统自动生成 self_app_key 和 self_app_secret", - "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": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - }, - { - "name": "interface_type_id", - "type": "number", - "required": true, - "description": "接口类型ID,必须是 wms_interface_type 已存在的类型" - }, - { - "name": "qimen_app_key", - "type": "string", - "required": false, - "description": "奇门 AppKey(QM_WMS 类型必填,OPEN_API 类型不需要)" - }, - { - "name": "qimen_customer_id", - "type": "string", - "required": false, - "description": "奇门客户ID(QM_WMS 类型必填,OPEN_API 类型不需要)" - }, - { - "name": "qimen_warehouse_code", - "type": "string", - "required": false, - "description": "奇门仓库编码(QM_WMS 类型必填,OPEN_API 类型不需要)" - }, - { - "name": "app_name", - "type": "string", - "required": true, - "description": "应用名称" - }, - { - "name": "callback_url", - "type": "string", - "required": false, - "description": "API 回调通知 URL(可选),最大 500 字符;配置后订单状态变更时将回调通知推送到此地址;兼容别名 callbackUrl" - } - ], - "response": [] - }, - { - "method": "storeWarehouse.store.deleteQimenConfig", - "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": "id", - "type": "number", - "required": true, - "description": "签约关系ID,兼容 contract_id" - }, - { - "name": "interface_type_id", - "type": "number", - "required": false, - "description": "接口类型ID" - } - ], - "response": [] - }, - { - "method": "storeWarehouse.store.openAccount", - "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": "username", - "type": "string", - "required": true, - "description": "登录账号(用户名),全局唯一" - }, - { - "name": "password", - "type": "string", - "required": false, - "description": "初始密码,不传则自动随机生成 12 位密码" - }, - { - "name": "real_name", - "type": "string", - "required": false, - "description": "真实姓名" - }, - { - "name": "company_name", - "type": "string", - "required": true, - "description": "公司全称,全局唯一,1-200 字符" - }, - { - "name": "business_license", - "type": "string", - "required": false, - "description": "营业执照号" - }, - { - "name": "contact_person", - "type": "string", - "required": true, - "description": "联系人姓名,1-50 字符" - }, - { - "name": "contact_phone", - "type": "string", - "required": false, - "description": "联系电话" - }, - { - "name": "legal_person", - "type": "string", - "required": false, - "description": "法人代表" - }, - { - "name": "contact_email", - "type": "string", - "required": false, - "description": "联系邮箱" - }, - { - "name": "address", - "type": "string", - "required": false, - "description": "公司地址" - }, - { - "name": "industry", - "type": "string", - "required": false, - "description": "所属行业" - }, - { - "name": "logo_url", - "type": "string", - "required": false, - "description": "Logo 链接" - }, - { - "name": "domain", - "type": "string", - "required": false, - "description": "绑定域名" - }, - { - "name": "auth_start", - "type": "string", - "required": false, - "description": "授权开始日期,默认当天(ISO 8601 格式)" - }, - { - "name": "auth_end", - "type": "string", - "required": false, - "description": "授权结束日期(ISO 8601 格式)" - }, - { - "name": "print_quantity", - "type": "number", - "required": false, - "description": "初始面单余额,默认 0" - }, - { - "name": "apply_reason", - "type": "string", - "required": false, - "description": "申请原因,默认\"仓库代开户\",最长 2000 字符" - }, - { - "name": "store_remask", - "type": "string", - "required": false, - "description": "货主备注名,最长 50 字符" - }, - { - "name": "warehouse_remask", - "type": "string", - "required": false, - "description": "仓库备注名,最长 50 字符" - } - ], - "response": [ - { - "name": "store_id", - "type": "number", - "required": true, - "description": "新建的货主 ID" - }, - { - "name": "account_id", - "type": "number", - "required": true, - "description": "新建的账号 ID" - }, - { - "name": "contract_id", - "type": "number", - "required": true, - "description": "新建的签约关系 ID" - }, - { - "name": "company_name", - "type": "string", - "required": true, - "description": "货主公司名称" - }, - { - "name": "username", - "type": "string", - "required": true, - "description": "新建的登录账号名" - }, - { - "name": "role_id", - "type": "number", - "required": true, - "description": "分配的货主管理员角色 ID" - } - ] - } - ] -} diff --git a/workflows/api-doc-system/data/module/user/_module.lifecycle.json b/workflows/api-doc-system/data/module/user/_module.lifecycle.json deleted file mode 100644 index f482a879..00000000 --- a/workflows/api-doc-system/data/module/user/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "用户模块", - "key": "user", - "folder": "user" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/user/module.json b/workflows/api-doc-system/data/module/user/module.json deleted file mode 100644 index 59bd0fbb..00000000 --- a/workflows/api-doc-system/data/module/user/module.json +++ /dev/null @@ -1,263 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "用户模块", - "key": "user", - "folder": "user", - "interfaceCount": 9 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "user.login", - "title": "用户登录(仅返回 token)", - "description": "用户登录(仅返回 token)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "password", - "type": "string", - "required": false, - "description": "password 参数" - }, - { - "name": "username", - "type": "string", - "required": false, - "description": "username 参数" - } - ], - "response": [] - }, - { - "method": "user.loginByCode", - "title": "登录码登录(使用 ye4s_user.tmp_code)", - "description": "登录码登录(使用 ye4s_user.tmp_code)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "code", - "type": "string", - "required": true, - "description": "登录码,对应 ye4s_user.tmp_code" - } - ], - "response": [] - }, - { - "method": "user.getLoginWechatCode", - "title": "获取微信扫码登录码(无 clientCode 时分配新客户端编码;有 clientCode 时可长轮询刷新)", - "description": "获取微信扫码登录码(无 clientCode 时分配新客户端编码;有 clientCode 时可长轮询刷新)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [ - { - "name": "clientCode", - "type": "string", - "required": false, - "description": "客户端编码;首次可不传,后续轮询建议透传已有值" - } - ], - "response": [] - }, - { - "method": "user.getBindWechatCode", - "title": "获取微信绑定码(默认立即返回;显式开启长轮询后,最长等待60秒,状态变化立即返回)", - "description": "获取微信绑定码(默认立即返回;显式开启长轮询后,最长等待60秒,状态变化立即返回)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "forceRefresh", - "type": "boolean", - "required": false, - "description": "是否强制刷新状态,true 时跳过缓存等待窗口" - }, - { - "name": "waitForChange", - "type": "boolean", - "required": false, - "description": "是否显式开启长轮询等待(推荐字段);true 时进入最长60秒等待" - }, - { - "name": "longPoll", - "type": "boolean", - "required": false, - "description": "长轮询开关(兼容字段);true 时进入最长60秒等待" - }, - { - "name": "waitTimeoutMs", - "type": "number", - "required": false, - "description": "等待超时毫秒数;后端自动封顶60000" - }, - { - "name": "init", - "type": "boolean", - "required": false, - "description": "初始化请求标记;true 时强制立即返回,不进入长等待" - } - ], - "response": [] - }, - { - "method": "user.unbindWechat", - "title": "解绑微信账号(清理 ye4s 关联账号数据)", - "description": "解绑微信账号(清理 ye4s 关联账号数据)", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "user.logout", - "title": "用户登出", - "description": "用户登出", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "user.info", - "title": "获取当前用户信息", - "description": "获取当前用户信息", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "user.changeRole", - "title": "user.changeRole 接口", - "description": "user.changeRole 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "user.register", - "title": "user.register 接口", - "description": "user.register 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": false, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [], - "params": [], - "response": [] - } - ] -} diff --git a/workflows/api-doc-system/data/module/warehouse/_module.lifecycle.json b/workflows/api-doc-system/data/module/warehouse/_module.lifecycle.json deleted file mode 100644 index 9cb7d652..00000000 --- a/workflows/api-doc-system/data/module/warehouse/_module.lifecycle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "module": { - "name": "仓库模块", - "key": "warehouse", - "folder": "warehouse" - }, - "status": "active", - "createdAt": "2026-04-16 11:15:05", - "updatedAt": "2026-06-18 17:45:21", - "deletedAt": null, - "restoredAt": null -} diff --git a/workflows/api-doc-system/data/module/warehouse/module.json b/workflows/api-doc-system/data/module/warehouse/module.json deleted file mode 100644 index 8f7d6eea..00000000 --- a/workflows/api-doc-system/data/module/warehouse/module.json +++ /dev/null @@ -1,872 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "module": { - "name": "仓库模块", - "key": "warehouse", - "folder": "warehouse", - "interfaceCount": 21 - }, - "changes": { - "fromPreviousSnapshot": { - "moduleAdded": false, - "moduleRenamed": false, - "interfaceChanges": { - "addedMethods": [], - "deletedMethods": [], - "paramsUpdatedMethods": [], - "responseUpdatedMethods": [] - } - } - }, - "interfaces": [ - { - "method": "warehouse.getWarehouseZones", - "title": "warehouse.getWarehouseZones 接口", - "description": "warehouse.getWarehouseZones 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "warehouse.getWarehouseTree", - "title": "warehouse.getWarehouseTree 接口", - "description": "warehouse.getWarehouseTree 接口", - "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": true, - "description": "warehouseId 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.getChildren", - "title": "warehouse.getChildren 接口", - "description": "warehouse.getChildren 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "zoneId", - "type": "number", - "required": true, - "description": "zoneId 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.create", - "title": "warehouse.create 接口", - "description": "warehouse.create 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [], - "response": [] - }, - { - "method": "warehouse.update", - "title": "warehouse.update 接口", - "description": "warehouse.update 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "id 参数" - }, - { - "name": "aisles", - "type": "string", - "required": false, - "description": "aisles 参数" - }, - { - "name": "cell_height", - "type": "string", - "required": false, - "description": "cell_height 参数" - }, - { - "name": "cell_length", - "type": "string", - "required": false, - "description": "cell_length 参数" - }, - { - "name": "cell_width", - "type": "string", - "required": false, - "description": "cell_width 参数" - }, - { - "name": "direction", - "type": "string", - "required": false, - "description": "direction 参数" - }, - { - "name": "height", - "type": "number", - "required": false, - "description": "height 参数" - }, - { - "name": "is_active", - "type": "boolean", - "required": false, - "description": "是否启用,支持 true/false 或 1/0" - }, - { - "name": "length", - "type": "number", - "required": false, - "description": "length 参数" - }, - { - "name": "rack_columns", - "type": "string", - "required": false, - "description": "rack_columns 参数" - }, - { - "name": "rack_levels", - "type": "string", - "required": false, - "description": "rack_levels 参数" - }, - { - "name": "rack_rows", - "type": "string", - "required": false, - "description": "rack_rows 参数" - }, - { - "name": "width", - "type": "number", - "required": false, - "description": "width 参数" - }, - { - "name": "x", - "type": "number", - "required": false, - "description": "x 参数" - }, - { - "name": "y", - "type": "number", - "required": false, - "description": "y 参数" - }, - { - "name": "z", - "type": "number", - "required": false, - "description": "z 参数" - }, - { - "name": "zone_code", - "type": "string", - "required": false, - "description": "zone_code 参数" - }, - { - "name": "zone_name", - "type": "string", - "required": false, - "description": "zone_name 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.delete", - "title": "warehouse.delete 接口", - "description": "warehouse.delete 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.detail", - "title": "warehouse.detail 接口", - "description": "warehouse.detail 接口", - "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": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.checkBarcodeUnique", - "title": "warehouse.checkBarcodeUnique 接口", - "description": "warehouse.checkBarcodeUnique 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "barcode", - "type": "string", - "required": true, - "description": "barcode 参数" - }, - { - "name": "id", - "type": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.toggleActive", - "title": "warehouse.toggleActive 接口", - "description": "warehouse.toggleActive 接口", - "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": "number", - "required": true, - "description": "id 参数" - }, - { - "name": "isActive", - "type": "string", - "required": false, - "description": "isActive 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.getPath", - "title": "warehouse.getPath 接口", - "description": "warehouse.getPath 接口", - "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": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.getPickPath", - "title": "warehouse.getPickPath 接口", - "description": "warehouse.getPickPath 接口", - "endpoint": "/system", - "authRequired": false, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "warehouse_id 参数" - }, - { - "name": "include_spaces", - "type": "string", - "required": false, - "description": "include_spaces 参数" - }, - { - "name": "limit", - "type": "number", - "required": false, - "description": "limit 参数" - }, - { - "name": "sort_by", - "type": "string", - "required": false, - "description": "sort_by 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.updateRackPosition", - "title": "warehouse.updateRackPosition 接口", - "description": "warehouse.updateRackPosition 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "x", - "type": "number", - "required": true, - "description": "x 参数" - }, - { - "name": "y", - "type": "number", - "required": true, - "description": "y 参数" - }, - { - "name": "rack_id", - "type": "number", - "required": false, - "description": "rack_id 参数" - }, - { - "name": "z", - "type": "number", - "required": false, - "description": "z 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.recalculatePickPath", - "title": "warehouse.recalculatePickPath 接口", - "description": "warehouse.recalculatePickPath 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "warehouse_id 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.updateNeighbors", - "title": "warehouse.updateNeighbors 接口", - "description": "warehouse.updateNeighbors 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "warehouse_id", - "type": "number", - "required": true, - "description": "warehouse_id 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.getAreaRacks", - "title": "warehouse.getAreaRacks 接口", - "description": "warehouse.getAreaRacks 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "area_id", - "type": "number", - "required": true, - "description": "area_id 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.getSpacesByRack", - "title": "warehouse.getSpacesByRack 接口", - "description": "warehouse.getSpacesByRack 接口", - "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": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.createRackWithSpaces", - "title": "warehouse.createRackWithSpaces 接口", - "description": "warehouse.createRackWithSpaces 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.exportRackSpaces", - "title": "按货架ID导出仓位模板(含仓库编码、仓位编码、自定义名称、自定义条码、拣货顺序、仓位类型)", - "description": "按货架ID导出仓位模板(含仓库编码、仓位编码、自定义名称、自定义条码、拣货顺序、仓位类型)", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "货架ID,仅导出该货架下仓位" - } - ], - "response": [ - { - "name": "count", - "type": "number", - "required": false, - "description": "导出记录数" - }, - { - "name": "fileName", - "type": "string", - "required": false, - "description": "导出文件名" - }, - { - "name": "fileUrl", - "type": "string", - "required": false, - "description": "导出文件下载地址" - } - ] - }, - { - "method": "warehouse.batchUpdateSpaceInfo", - "title": "按导出模板批量修改货架仓位信息,任一行越界或冲突则整批失败。前端提交示例:{ id: 36, items: [ { space_code: 'A01-01-01', custom_name: '拣货位1', custom_barcode: 'PICK-001', pick_sequence: 10, location_type_id: 3 } ] }。其中 id 为货架ID(可选,传入时只允许操作该货架下的仓位),space_code 为必填定位键,location_type_id 为仓位类型主键(可通过 index.getLocationTypeList 获取)。", - "description": "按导出模板批量修改货架仓位信息,任一行越界或冲突则整批失败。前端提交示例:{ id: 36, items: [ { space_code: 'A01-01-01', custom_name: '拣货位1', custom_barcode: 'PICK-001', pick_sequence: 10, location_type_id: 3 } ] }。其中 id 为货架ID(可选,传入时只允许操作该货架下的仓位),space_code 为必填定位键,location_type_id 为仓位类型主键(可通过 index.getLocationTypeList 获取)。", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": false, - "description": "货架ID,传入时校验所有 space_code 必须属于该货架,不传则只校验属于任意货架类型库位" - }, - { - "name": "items", - "type": "array", - "required": true, - "description": "批量修改数据数组;每项支持字段:space_code、custom_name、custom_barcode、pick_sequence、location_type_name" - }, - { - "name": "items[].space_code", - "type": "string", - "required": true, - "description": "仓位编码,作为批量修改的唯一定位键;缺失、重复或不存在都会整批失败" - }, - { - "name": "items[].custom_name", - "type": "string", - "required": false, - "description": "自定义名称,空字符串会被清空" - }, - { - "name": "items[].custom_barcode", - "type": "string", - "required": false, - "description": "自定义条码,批次内或系统内冲突都会整批失败;空字符串会被清空" - }, - { - "name": "items[].pick_sequence", - "type": "number", - "required": false, - "description": "拣货顺序,必须为非负整数,超出边界则整批失败" - }, - { - "name": "items[].location_type_id", - "type": "number", - "required": false, - "description": "仓位类型ID,必须为正整数且在当前仓库或全局类型中存在(is_active=true),否则整批失败;传 null 或不传则不修改仓位类型" - } - ], - "response": [ - { - "name": "count", - "type": "number", - "required": false, - "description": "成功更新的记录数" - } - ] - }, - { - "method": "warehouse.getSpaceInfo", - "title": "warehouse.getSpaceInfo 接口", - "description": "warehouse.getSpaceInfo 接口", - "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": "number", - "required": true, - "description": "id 参数" - } - ], - "response": [] - }, - { - "method": "warehouse.updateSpaceInfo", - "title": "warehouse.updateSpaceInfo 接口", - "description": "warehouse.updateSpaceInfo 接口", - "endpoint": "/system", - "authRequired": true, - "loginRequired": true, - "status": { - "isUsed": false, - "isPlaceholder": false - }, - "headers": [ - { - "name": "Authorization", - "type": "string", - "required": true, - "description": "Bearer token" - } - ], - "params": [ - { - "name": "id", - "type": "number", - "required": true, - "description": "id 参数" - }, - { - "name": "custom_barcode", - "type": "string", - "required": false, - "description": "custom_barcode 参数" - }, - { - "name": "custom_name", - "type": "string", - "required": false, - "description": "custom_name 参数" - }, - { - "name": "location_type_id", - "type": "number", - "required": false, - "description": "location_type_id 参数" - }, - { - "name": "pick_sequence", - "type": "string", - "required": false, - "description": "pick_sequence 参数" - }, - { - "name": "space_status", - "type": "string", - "required": false, - "description": "space_status 参数" - } - ], - "response": [] - } - ] -} diff --git a/workflows/api-doc-system/data/pending-updates.json b/workflows/api-doc-system/data/pending-updates.json deleted file mode 100644 index 380246a2..00000000 --- a/workflows/api-doc-system/data/pending-updates.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "generatedAt": "2026-06-18 17:45:21", - "generatedAtLocal": "2026-06-18 17:45:21", - "source": "remote", - "filter": { - "platform": { - "value": "web", - "label": "网页端" - }, - "project": { - "value": "all", - "label": "全部" - } - }, - "summary": { - "moduleAdded": 0, - "moduleDeleted": 0, - "interfaceAdded": 1, - "interfaceDeleted": 0, - "interfaceParamsUpdated": 0, - "interfaceResponseUpdated": 2, - "totalChangedItems": 3 - }, - "interfaceUpdates": { - "added": [ - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "folder": "storage.entry", - "method": "storage.entry.unbindReceivingDetails" - } - ], - "deleted": [], - "paramsUpdated": [], - "responseUpdated": [ - { - "moduleName": "收货单模块", - "moduleKey": "storage_receiving", - "folder": "storage_receiving", - "method": "storage.receiving.getAvailableInboundQuantity" - }, - { - "moduleName": "入库单模块", - "moduleKey": "storage.entry", - "folder": "storage.entry", - "method": "storage.entry.get" - } - ] - } -} diff --git a/workflows/api-doc-system/scripts/agent/api-list-update/config.mjs b/workflows/api-doc-system/scripts/agent/api-list-update/config.mjs deleted file mode 100644 index 24cc06b3..00000000 --- a/workflows/api-doc-system/scripts/agent/api-list-update/config.mjs +++ /dev/null @@ -1,10 +0,0 @@ -import path from "node:path"; - -const AGENT_WORKFLOW_ROOT = path.join("workflows", "api-doc-agent"); - -export const API_DOC_AGENT_API_LIST_UPDATE_CONFIG = { - file: { - srcApiDir: path.join("src", "api"), - outputConfig: path.join(AGENT_WORKFLOW_ROOT, "config", "接口.md"), - }, -}; diff --git a/workflows/api-doc-system/scripts/agent/api-list-update/run.mjs b/workflows/api-doc-system/scripts/agent/api-list-update/run.mjs deleted file mode 100644 index 8e955b47..00000000 --- a/workflows/api-doc-system/scripts/agent/api-list-update/run.mjs +++ /dev/null @@ -1,474 +0,0 @@ -import { mkdir, readFile, readdir, writeFile } from "node:fs/promises"; -import path from "node:path"; -import { API_DOC_AGENT_API_LIST_UPDATE_CONFIG } from "./config.mjs"; - -function formatLocalDateTime(input = new Date()) { - const date = input instanceof Date ? input : new Date(input); - const year = String(date.getFullYear()); - const month = String(date.getMonth() + 1).padStart(2, "0"); - const day = String(date.getDate()).padStart(2, "0"); - const hours = String(date.getHours()).padStart(2, "0"); - const minutes = String(date.getMinutes()).padStart(2, "0"); - const seconds = String(date.getSeconds()).padStart(2, "0"); - return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}`; -} - -async function writeText(filePath, text) { - await mkdir(path.dirname(filePath), { recursive: true }); - await writeFile(filePath, `${text.trimEnd()}\n`, "utf8"); -} - -async function readTextIfExists(filePath, fallbackValue = "") { - try { - return await readFile(filePath, "utf8"); - } catch (error) { - if (error?.code === "ENOENT") { - return fallbackValue; - } - throw error; - } -} - -async function listTsFiles(rootDir) { - const stack = [rootDir]; - const files = []; - while (stack.length > 0) { - const current = stack.pop(); - const entries = await readdir(current, { withFileTypes: true }); - for (const entry of entries) { - const fullPath = path.join(current, entry.name); - if (entry.isDirectory()) { - stack.push(fullPath); - continue; - } - if (entry.isFile() && entry.name.endsWith(".ts")) { - files.push(fullPath); - } - } - } - return files.sort((a, b) => a.localeCompare(b, "zh-CN")); -} - -function createCommentMask(content) { - const mask = new Array(content.length).fill(false); - let i = 0; - let inSingle = false; - let inDouble = false; - let inTemplate = false; - let inLineComment = false; - let inBlockComment = false; - - while (i < content.length) { - const ch = content[i]; - const next = content[i + 1] ?? ""; - const prev = content[i - 1] ?? ""; - - if (inLineComment) { - mask[i] = true; - if (ch === "\n") { - inLineComment = false; - } - i += 1; - continue; - } - - if (inBlockComment) { - mask[i] = true; - if (ch === "*" && next === "/") { - mask[i + 1] = true; - inBlockComment = false; - i += 2; - continue; - } - i += 1; - continue; - } - - if (!inDouble && !inTemplate && ch === "'" && prev !== "\\") { - inSingle = !inSingle; - i += 1; - continue; - } - if (!inSingle && !inTemplate && ch === '"' && prev !== "\\") { - inDouble = !inDouble; - i += 1; - continue; - } - if (!inSingle && !inDouble && ch === "`" && prev !== "\\") { - inTemplate = !inTemplate; - i += 1; - continue; - } - - if (!inSingle && !inDouble && !inTemplate) { - if (ch === "/" && next === "/") { - mask[i] = true; - mask[i + 1] = true; - inLineComment = true; - i += 2; - continue; - } - if (ch === "/" && next === "*") { - mask[i] = true; - mask[i + 1] = true; - inBlockComment = true; - i += 2; - continue; - } - } - - i += 1; - } - - return mask; -} - -function buildExportAnchors(content) { - const anchors = []; - const reg = /export\s+(?:async\s+)?function\s+([A-Za-z_$][\w$]*)|export\s+const\s+([A-Za-z_$][\w$]*)/g; - for (const match of content.matchAll(reg)) { - anchors.push({ - index: match.index ?? 0, - name: match[1] || match[2] || "", - }); - } - return anchors; -} - -function getNearestExportName(anchors, index) { - let name = ""; - for (const item of anchors) { - if (item.index > index) { - break; - } - name = item.name; - } - return name || null; -} - -function detectPlaceholder(content, index) { - const start = Math.max(0, index - 160); - const end = Math.min(content.length, index + 160); - const context = content.slice(start, end); - return /(占位|placeholder|todo)/i.test(context); -} - -function parseInterfacesFromFile(content, filePath, srcApiDir) { - const commentMask = createCommentMask(content); - const exportAnchors = buildExportAnchors(content); - const relPath = path.relative(srcApiDir, filePath).replaceAll("\\", "/"); - const segments = relPath.split("/"); - const moduleName = segments[0] || "unknown"; - const matches = []; - - const collectMatch = (method, index, httpMethodFallback = "post") => { - const normalizedMethod = (method || "").trim(); - if (!normalizedMethod) { - return; - } - const isCommented = Boolean(commentMask[index]); - const functionName = getNearestExportName(exportAnchors, index); - const requestStart = content.lastIndexOf("request(", index); - const requestWindow = - requestStart >= 0 ? content.slice(requestStart, Math.min(content.length, index + 280)) : content.slice(index, index + 280); - const httpMethod = - requestWindow.match(/\bmethod\s*:\s*['"`](get|post|put|delete|patch|options|head)['"`]/i)?.[1] ?? httpMethodFallback; - - matches.push({ - moduleName, - filePath: relPath, - interfaceName: functionName || normalizedMethod, - method: normalizedMethod, - httpMethod: httpMethod.toLowerCase(), - isEnabled: !isCommented, - isPlaceholder: detectPlaceholder(content, index), - }); - }; - - // Pattern 1: request params carries literal method name. - const methodInParamsRegex = /params\s*:\s*\{[\s\S]*?\bmethod\s*:\s*['"`]([^'"`]+)['"`]/g; - for (const match of content.matchAll(methodInParamsRegex)) { - const index = match.index ?? 0; - collectMatch(match[1], index, "post"); - } - - // Pattern 2: wrapper call passes literal method name, e.g. getDashboardData('dashboard.xxx', data). - const wrappedMethodCallRegex = /return\s+[A-Za-z_$][\w$]*\(\s*['"`]([a-zA-Z0-9_.-]+)['"`]\s*(?:,|\))/g; - for (const match of content.matchAll(wrappedMethodCallRegex)) { - const index = match.index ?? 0; - collectMatch(match[1], index, "post"); - } - - return matches; -} - -function uniqueInterfaces(items) { - const map = new Map(); - for (const item of items) { - const key = `${item.filePath}::${item.method}`; - if (!map.has(key)) { - map.set(key, item); - } - } - return [...map.values()]; -} - -function parseZhBool(value, fallback = false) { - if (value === "是") { - return true; - } - if (value === "否") { - return false; - } - return fallback; -} - -function parseMarkdownCells(line) { - return line - .trim() - .split("|") - .slice(1, -1) - .map((item) => item.trim()); -} - -function parseExistingInterfaceRows(markdown) { - const sectionAnchor = "## 接口明细"; - const sectionIndex = markdown.indexOf(sectionAnchor); - if (sectionIndex < 0) { - return []; - } - - const sectionText = markdown.slice(sectionIndex); - const lines = sectionText - .split(/\r?\n/g) - .map((line) => line.trim()) - .filter((line) => line.length > 0); - const tableLines = lines.filter((line) => line.startsWith("|")); - if (tableLines.length < 3) { - return []; - } - - const headers = parseMarkdownCells(tableLines[0]); - const getCol = (name) => headers.indexOf(name); - const col = { - moduleName: getCol("模块"), - interfaceName: getCol("接口名"), - method: getCol("method"), - httpMethod: getCol("HTTP Method"), - isEnabled: getCol("启用"), - isPlaceholder: getCol("占位"), - filePath: getCol("文件"), - remark: getCol("备注"), - }; - if (col.method < 0 || col.filePath < 0 || col.moduleName < 0) { - return []; - } - - const rows = []; - for (const rowLine of tableLines.slice(2)) { - const cells = parseMarkdownCells(rowLine); - if (cells.length < headers.length) { - continue; - } - const method = cells[col.method] ?? ""; - const filePath = cells[col.filePath] ?? ""; - if (!method || !filePath) { - continue; - } - rows.push({ - moduleName: cells[col.moduleName] ?? "", - interfaceName: col.interfaceName >= 0 ? (cells[col.interfaceName] ?? "") : method, - method, - httpMethod: (cells[col.httpMethod] ?? "POST").toLowerCase(), - isEnabled: parseZhBool(cells[col.isEnabled], true), - isPlaceholder: parseZhBool(cells[col.isPlaceholder], false), - filePath, - remark: col.remark >= 0 ? (cells[col.remark] ?? "") : "", - }); - } - - return rows; -} - -function buildRowKey(item) { - return `${item.moduleName}::${item.method}::${item.filePath}`; -} - -function mergeInterfaceRows(scannedInterfaces, existingRows) { - const byExactKey = new Map(existingRows.map((item) => [buildRowKey(item), item])); - const byMethod = new Map(); - for (const item of existingRows) { - if (!byMethod.has(item.method)) { - byMethod.set(item.method, item); - } - } - - const merged = []; - const consumedExisting = new Set(); - - for (const item of scannedInterfaces) { - const key = buildRowKey(item); - const baseline = byExactKey.get(key) ?? byMethod.get(item.method) ?? null; - if (byExactKey.has(key)) { - consumedExisting.add(key); - } - merged.push({ - moduleName: item.moduleName, - interfaceName: item.interfaceName, - method: item.method, - httpMethod: item.httpMethod, - filePath: item.filePath, - isEnabled: baseline ? baseline.isEnabled : item.isEnabled, - isPlaceholder: baseline ? baseline.isPlaceholder : item.isPlaceholder, - remark: baseline?.remark ?? "", - }); - } - - for (const item of existingRows) { - const key = buildRowKey(item); - if (consumedExisting.has(key)) { - continue; - } - const existsInScan = scannedInterfaces.some( - (scanned) => scanned.method === item.method && scanned.filePath === item.filePath, - ); - if (existsInScan) { - continue; - } - merged.push({ - ...item, - isEnabled: false, - }); - } - - return merged.sort((a, b) => { - if (a.moduleName !== b.moduleName) { - return a.moduleName.localeCompare(b.moduleName, "zh-CN"); - } - if (a.filePath !== b.filePath) { - return a.filePath.localeCompare(b.filePath, "zh-CN"); - } - return a.method.localeCompare(b.method, "zh-CN"); - }); -} - -function buildMarkdown(payload) { - const lines = [ - "# 接口", - "", - `- 更新时间: ${payload.generatedAtLocal}`, - `- 扫描目录: \`${payload.source.srcApiDir}\``, - `- 模块数: ${payload.summary.moduleCount}`, - `- API 文件数: ${payload.summary.fileCount}`, - `- 接口数: ${payload.summary.interfaceCount}`, - `- 已启用: ${payload.summary.enabledCount}`, - `- 占位接口: ${payload.summary.placeholderCount}`, - "", - "## 模块统计", - "", - "| 模块 | 文件数 | 接口数 | 已启用 | 占位 |", - "| --- | ---: | ---: | ---: | ---: |", - ]; - - for (const module of payload.modules) { - lines.push( - `| ${module.moduleName} | ${module.fileCount} | ${module.interfaceCount} | ${module.enabledCount} | ${module.placeholderCount} |`, - ); - } - - lines.push( - "", - "## 接口明细", - "", - "| 模块 | 接口名 | method | HTTP Method | 启用 | 占位 | 文件 | 备注 |", - "| --- | --- | --- | --- | --- | --- | --- | --- |", - ); - for (const item of payload.interfaces) { - lines.push( - `| ${item.moduleName} | ${item.interfaceName} | ${item.method} | ${item.httpMethod.toUpperCase()} | ${item.isEnabled ? "是" : "否"} | ${item.isPlaceholder ? "是" : "否"} | ${item.filePath} | ${item.remark || ""} |`, - ); - } - return lines.join("\n"); -} - -export async function runScript() { - const now = new Date(); - const srcApiDir = API_DOC_AGENT_API_LIST_UPDATE_CONFIG.file.srcApiDir; - const files = await listTsFiles(srcApiDir); - - const allInterfaces = []; - for (const filePath of files) { - const content = await readFile(filePath, "utf8"); - const parsed = parseInterfacesFromFile(content, filePath, srcApiDir); - allInterfaces.push(...parsed); - } - - const scannedInterfaces = uniqueInterfaces(allInterfaces).sort((a, b) => { - if (a.moduleName !== b.moduleName) { - return a.moduleName.localeCompare(b.moduleName, "zh-CN"); - } - if (a.filePath !== b.filePath) { - return a.filePath.localeCompare(b.filePath, "zh-CN"); - } - return a.method.localeCompare(b.method, "zh-CN"); - }); - - const existingMarkdown = await readTextIfExists(API_DOC_AGENT_API_LIST_UPDATE_CONFIG.file.outputConfig, ""); - const existingRows = parseExistingInterfaceRows(existingMarkdown); - const interfaces = mergeInterfaceRows(scannedInterfaces, existingRows); - - const moduleMap = new Map(); - for (const item of interfaces) { - const current = moduleMap.get(item.moduleName) ?? { - moduleName: item.moduleName, - fileSet: new Set(), - interfaceCount: 0, - enabledCount: 0, - placeholderCount: 0, - }; - current.fileSet.add(item.filePath); - current.interfaceCount += 1; - if (item.isEnabled) { - current.enabledCount += 1; - } - if (item.isPlaceholder) { - current.placeholderCount += 1; - } - moduleMap.set(item.moduleName, current); - } - - const modules = [...moduleMap.values()] - .map((item) => ({ - moduleName: item.moduleName, - fileCount: item.fileSet.size, - interfaceCount: item.interfaceCount, - enabledCount: item.enabledCount, - placeholderCount: item.placeholderCount, - })) - .sort((a, b) => a.moduleName.localeCompare(b.moduleName, "zh-CN")); - - const payload = { - script: "api-list-update", - generatedAt: now.toISOString(), - generatedAtLocal: formatLocalDateTime(now), - source: { - srcApiDir, - }, - summary: { - moduleCount: modules.length, - fileCount: new Set(interfaces.map((item) => item.filePath)).size, - interfaceCount: interfaces.length, - enabledCount: interfaces.filter((item) => item.isEnabled).length, - placeholderCount: interfaces.filter((item) => item.isPlaceholder).length, - }, - modules, - interfaces, - }; - - const markdown = buildMarkdown(payload); - await writeText(API_DOC_AGENT_API_LIST_UPDATE_CONFIG.file.outputConfig, markdown); - - console.log(`执行时间: ${payload.generatedAtLocal}`); - console.log(`已同步配置文档: ${API_DOC_AGENT_API_LIST_UPDATE_CONFIG.file.outputConfig}`); - console.log(JSON.stringify(payload.summary, null, 2)); -} diff --git a/workflows/api-doc-system/scripts/agent/config/scripts.mjs b/workflows/api-doc-system/scripts/agent/config/scripts.mjs deleted file mode 100644 index 34fd774f..00000000 --- a/workflows/api-doc-system/scripts/agent/config/scripts.mjs +++ /dev/null @@ -1,20 +0,0 @@ -const INTERFACE_AVAILABILITY_ENTRY = new URL( - "../interface-availability/run.mjs", - import.meta.url, -).href; -const API_LIST_UPDATE_ENTRY = new URL("../api-list-update/run.mjs", import.meta.url).href; - -export const DEFAULT_API_DOC_AGENT_SCRIPT = "interface"; - -export const API_DOC_AGENT_SCRIPTS = { - interface: { - name: "interface", - description: "接口可用性检查脚本", - entry: INTERFACE_AVAILABILITY_ENTRY, - }, - "api-list-update": { - name: "api-list-update", - description: "扫描 src/api 并更新接口配置", - entry: API_LIST_UPDATE_ENTRY, - }, -}; diff --git a/workflows/api-doc-system/scripts/agent/interface-availability/config.mjs b/workflows/api-doc-system/scripts/agent/interface-availability/config.mjs deleted file mode 100644 index a62fd828..00000000 --- a/workflows/api-doc-system/scripts/agent/interface-availability/config.mjs +++ /dev/null @@ -1,11 +0,0 @@ -import path from "node:path"; - -const SYSTEM_WORKFLOW_ROOT = path.join("workflows", "api-doc-system"); - -export const API_DOC_INTERFACE_SCRIPT_CONFIG = { - file: { - moduleDir: path.join(SYSTEM_WORKFLOW_ROOT, "data", "module"), - moduleSnapshotName: "module.json", - resultDir: path.join(SYSTEM_WORKFLOW_ROOT, "data", "agent-results", "interface-availability"), - }, -}; diff --git a/workflows/api-doc-system/scripts/agent/interface-availability/run.mjs b/workflows/api-doc-system/scripts/agent/interface-availability/run.mjs deleted file mode 100644 index 0f86fb46..00000000 --- a/workflows/api-doc-system/scripts/agent/interface-availability/run.mjs +++ /dev/null @@ -1,180 +0,0 @@ -import { mkdir, readFile, readdir, writeFile } from "node:fs/promises"; -import path from "node:path"; -import { API_DOC_INTERFACE_SCRIPT_CONFIG } from "./config.mjs"; - -function sanitizeFileName(name) { - const normalized = name.toLowerCase().replace(/[^a-z0-9._-]+/g, "_"); - return normalized.replace(/^_+|_+$/g, "") || "interface"; -} - -async function readJson(filePath) { - const content = await readFile(filePath, "utf8"); - return JSON.parse(content); -} - -async function readJsonIfExists(filePath, fallbackValue = null) { - try { - return await readJson(filePath); - } catch (error) { - if (error?.code === "ENOENT") { - return fallbackValue; - } - throw error; - } -} - -async function getModuleSnapshotFilePath(targetDir) { - const targetPath = path.join(targetDir, API_DOC_INTERFACE_SCRIPT_CONFIG.file.moduleSnapshotName); - const parsed = await readJsonIfExists(targetPath, null); - return parsed ? targetPath : null; -} - -async function listModuleFolders(moduleRootDir) { - const entries = await readdir(moduleRootDir, { withFileTypes: true }); - return entries - .filter((entry) => entry.isDirectory()) - .map((entry) => entry.name) - .sort((a, b) => a.localeCompare(b, "zh-CN")); -} - -async function writeJson(filePath, data) { - await mkdir(path.dirname(filePath), { recursive: true }); - await writeFile(filePath, `${JSON.stringify(data, null, 2)}\n`, "utf8"); -} - -function getTodayStamp() { - const now = new Date(); - const year = String(now.getFullYear()); - const month = String(now.getMonth() + 1).padStart(2, "0"); - const day = String(now.getDate()).padStart(2, "0"); - return `${year}${month}${day}`; -} - -function formatLocalDateTime(input = new Date()) { - const date = input instanceof Date ? input : new Date(input); - const year = String(date.getFullYear()); - const month = String(date.getMonth() + 1).padStart(2, "0"); - const day = String(date.getDate()).padStart(2, "0"); - const hours = String(date.getHours()).padStart(2, "0"); - const minutes = String(date.getMinutes()).padStart(2, "0"); - const seconds = String(date.getSeconds()).padStart(2, "0"); - return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}`; -} - -async function resolveInterface(method) { - const moduleFolders = await listModuleFolders(API_DOC_INTERFACE_SCRIPT_CONFIG.file.moduleDir); - const moduleInterfaceMap = new Map(); - const moduleSourceFiles = []; - - for (const folderName of moduleFolders) { - const folderPath = path.join(API_DOC_INTERFACE_SCRIPT_CONFIG.file.moduleDir, folderName); - const lifecycle = await readJsonIfExists(path.join(folderPath, "_module.lifecycle.json"), null); - if (lifecycle?.status === "deleted") { - continue; - } - - const moduleFile = await getModuleSnapshotFilePath(folderPath); - if (!moduleFile) { - continue; - } - - moduleSourceFiles.push(moduleFile); - const moduleDoc = await readJson(moduleFile); - const moduleMeta = moduleDoc?.module ?? {}; - const moduleInterfaces = Array.isArray(moduleDoc?.interfaces) ? moduleDoc.interfaces : []; - for (const item of moduleInterfaces) { - if (!item?.method || moduleInterfaceMap.has(item.method)) { - continue; - } - moduleInterfaceMap.set(item.method, { - method: item.method, - title: item.title, - description: item.description, - endpoint: item.endpoint, - authRequired: item.authRequired, - loginRequired: item.loginRequired, - status: { - isUsed: Boolean(item?.status?.isUsed), - isPlaceholder: Boolean(item?.status?.isPlaceholder), - }, - params: item.params ?? [], - response: item.response ?? [], - moduleName: moduleMeta?.name ?? folderName, - moduleKey: moduleMeta?.key ?? folderName, - moduleFolder: moduleMeta?.folder ?? folderName, - moduleFile, - }); - } - } - - const target = moduleInterfaceMap.get(method); - if (!target) { - return { - method, - available: false, - reason: "Method not found in latest active module snapshots.", - check: { isUsed: false, isPlaceholder: false }, - source: { moduleFiles: moduleSourceFiles }, - interfaceSpec: null, - }; - } - - const isUsed = Boolean(target?.status?.isUsed); - const isPlaceholder = Boolean(target?.status?.isPlaceholder); - const available = isUsed && !isPlaceholder; - - return { - method, - available, - reason: available - ? "Method is usable for coding." - : "Method does not satisfy availability rule: isUsed=true and isPlaceholder=false.", - check: { isUsed, isPlaceholder }, - source: { - moduleFile: target.moduleFile, - }, - interfaceSpec: available - ? { - moduleName: target.moduleName, - moduleKey: target.moduleKey, - moduleFolder: target.moduleFolder, - method: target.method, - title: target.title, - description: target.description, - endpoint: target.endpoint, - authRequired: target.authRequired, - loginRequired: target.loginRequired, - params: target.params, - response: target.response, - } - : null, - }; -} - -export async function runScript(args = []) { - const method = args[0]; - if (!method) { - throw new Error("请提供目标接口名,例如: npm run apiagent -- storage.receiving.bindStore"); - } - - const now = new Date(); - const resolvedAt = now.toISOString(); - const result = await resolveInterface(method.trim()); - const payload = { - script: "interface", - resolvedAt, - resolvedAtLocal: formatLocalDateTime(now), - ...result, - }; - - const outputFilePath = path.join( - API_DOC_INTERFACE_SCRIPT_CONFIG.file.resultDir, - getTodayStamp(), - `${sanitizeFileName(method)}.json`, - ); - await writeJson(outputFilePath, payload); - - console.log(`执行时间: ${payload.resolvedAtLocal}`); - console.log(JSON.stringify(payload, null, 2)); - console.log(`Agent 查询结果已写入: ${outputFilePath}`); -} diff --git a/workflows/api-doc-system/scripts/agent/run.mjs b/workflows/api-doc-system/scripts/agent/run.mjs deleted file mode 100644 index 26f703b4..00000000 --- a/workflows/api-doc-system/scripts/agent/run.mjs +++ /dev/null @@ -1,57 +0,0 @@ -import { API_DOC_AGENT_SCRIPTS, DEFAULT_API_DOC_AGENT_SCRIPT } from "./config/scripts.mjs"; - -function parseArgs(rawArgs) { - const args = [...rawArgs]; - const scriptFlagIndex = args.findIndex((item) => item === "--script" || item === "-s"); - let scriptName = DEFAULT_API_DOC_AGENT_SCRIPT; - - if (scriptFlagIndex >= 0) { - const nextValue = args[scriptFlagIndex + 1]; - if (!nextValue) { - throw new Error("`--script` 需要指定脚本名。"); - } - scriptName = nextValue.trim(); - args.splice(scriptFlagIndex, 2); - } - - return { - scriptName, - scriptArgs: args, - }; -} - -function printAvailableScripts() { - const entries = Object.values(API_DOC_AGENT_SCRIPTS) - .sort((a, b) => a.name.localeCompare(b.name, "zh-CN")) - .map((item) => `- ${item.name}: ${item.description}`); - console.log("可用 API Agent 脚本:"); - for (const line of entries) { - console.log(line); - } -} - -async function run() { - const { scriptName, scriptArgs } = parseArgs(process.argv.slice(2)); - if (scriptName === "list") { - printAvailableScripts(); - return; - } - - const scriptConfig = API_DOC_AGENT_SCRIPTS[scriptName]; - if (!scriptConfig) { - printAvailableScripts(); - throw new Error(`未找到脚本: ${scriptName}`); - } - - const scriptModule = await import(scriptConfig.entry); - if (typeof scriptModule.runScript !== "function") { - throw new Error(`脚本 ${scriptName} 缺少 runScript 导出函数。`); - } - - await scriptModule.runScript(scriptArgs); -} - -run().catch((error) => { - console.error("执行 API Doc Agent 失败:", error.message); - process.exitCode = 1; -}); diff --git a/workflows/api-doc-system/scripts/apidata.mjs b/workflows/api-doc-system/scripts/apidata.mjs deleted file mode 100644 index f37ccbc1..00000000 --- a/workflows/api-doc-system/scripts/apidata.mjs +++ /dev/null @@ -1,6 +0,0 @@ -import { runApidata } from "../core/apidata.mjs"; - -runApidata().catch((error) => { - console.error("执行 apidata 抓取失败:", error.message || error); - process.exitCode = 1; -}); diff --git a/workflows/api-doc-system/scripts/clear-pending.mjs b/workflows/api-doc-system/scripts/clear-pending.mjs deleted file mode 100644 index 966c276e..00000000 --- a/workflows/api-doc-system/scripts/clear-pending.mjs +++ /dev/null @@ -1 +0,0 @@ -import "../core/clear-pending.mjs"; diff --git a/workflows/api-doc-system/scripts/update.mjs b/workflows/api-doc-system/scripts/update.mjs deleted file mode 100644 index 83a59e55..00000000 --- a/workflows/api-doc-system/scripts/update.mjs +++ /dev/null @@ -1 +0,0 @@ -import "../core/update.mjs"; diff --git a/workflows/api-doc-system/system/workflow-mode.json b/workflows/api-doc-system/system/workflow-mode.json deleted file mode 100644 index a787be48..00000000 --- a/workflows/api-doc-system/system/workflow-mode.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "work", - "description": "test 模式下仅验证流程,不执行接口更新。改为 work 才会执行真实更新。" -} diff --git a/workflows/api-doc-system/update.mjs b/workflows/api-doc-system/update.mjs deleted file mode 100644 index faba609f..00000000 --- a/workflows/api-doc-system/update.mjs +++ /dev/null @@ -1,867 +0,0 @@ -import { mkdir, readFile, readdir, rm, writeFile } from "node:fs/promises"; -import path from "node:path"; -import { API_DOC_SYSTEM_CONFIG } from "./config.mjs"; - -const MODULE_LIFECYCLE_FILE = "_module.lifecycle.json"; - -const ENTITY_MAP = { - "&": "&", - "<": "<", - ">": ">", - """: '"', - "'": "'", - " ": " ", -}; - -function decodeHtmlEntities(value) { - const withNamed = Object.entries(ENTITY_MAP).reduce( - (acc, [entity, replacement]) => acc.split(entity).join(replacement), - value, - ); - return withNamed.replace(/&#(\d+);/g, (_, num) => String.fromCharCode(Number(num))); -} - -function normalizeText(value) { - return decodeHtmlEntities(value.replace(/<[^>]*>/g, " ")).replace(/\s+/g, " ").trim(); -} - -function parseAttributes(tag) { - const attrs = {}; - const attrRegex = /([:@a-zA-Z0-9_-]+)\s*=\s*"([^"]*)"/g; - for (const match of tag.matchAll(attrRegex)) { - attrs[match[1]] = decodeHtmlEntities(match[2]); - } - return attrs; -} - -function extractSelectOptions(html, headerName) { - const regex = new RegExp( - `]*data-header-name="${headerName}"[^>]*>([\\s\\S]*?)<\\/select>`, - "i", - ); - const selectMatch = html.match(regex); - if (!selectMatch) { - return []; - } - - const options = []; - const optionRegex = /([\s\S]*?)<\/option>/g; - for (const optionMatch of selectMatch[1].matchAll(optionRegex)) { - options.push({ - value: decodeHtmlEntities(optionMatch[1]).trim(), - label: normalizeText(optionMatch[2]), - }); - } - return options; -} - -function findRequiredFilterValue(html, headerName, expectedValue) { - const options = extractSelectOptions(html, headerName); - return options.find((option) => option.value === expectedValue) ?? null; -} - -function extractSectionTableRows(cardHtml, sectionName) { - const escapedName = sectionName.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); - const sectionRegex = new RegExp( - `
\\s*\\s*${escapedName}\\s*\\((\\d+)\\)<\\/summary>[\\s\\S]*?([\\s\\S]*?)<\\/tbody>[\\s\\S]*?<\\/details>`, - "i", - ); - const match = cardHtml.match(sectionRegex); - if (!match) { - return []; - } - - const tbodyHtml = match[2]; - if (/暂无数据/.test(tbodyHtml)) { - return []; - } - - const rows = []; - const rowRegex = /([\s\S]*?)<\/tr>/g; - for (const rowMatch of tbodyHtml.matchAll(rowRegex)) { - const cellValues = [...rowMatch[1].matchAll(/]*>([\s\S]*?)<\/td>/g)].map((cellMatch) => - normalizeText(cellMatch[1]), - ); - if (cellValues.length < 4) { - continue; - } - rows.push({ - name: cellValues[0], - type: cellValues[1], - required: cellValues[2] === "是", - description: cellValues[3], - }); - } - - return rows; -} - -function extractBadgeValue(cardHtml, badgeName) { - const badgeRegex = new RegExp(`${badgeName}:\\s*([^<]+)<\\/span>`, "i"); - const match = cardHtml.match(badgeRegex); - return match ? normalizeText(match[1]) : ""; -} - -function parseMethodCard(cardHtml) { - const openTagMatch = cardHtml.match(/^
]*>/i); - if (!openTagMatch) { - return null; - } - - const attrs = parseAttributes(openTagMatch[0]); - const methodName = normalizeText(cardHtml.match(/

([\s\S]*?)<\/h3>/i)?.[1] ?? ""); - if (!methodName) { - return null; - } - - const description = normalizeText(cardHtml.match(/

([\s\S]*?)<\/p>/i)?.[1] ?? ""); - const endpoint = attrs["data-endpoint"] ?? extractBadgeValue(cardHtml, "入口"); - const authRequired = extractBadgeValue(cardHtml, "鉴权") === "是"; - const loginRequired = - attrs["data-login-required"] === "true" || extractBadgeValue(cardHtml, "登录") === "是"; - - return { - method: methodName, - title: description || `${methodName} 接口`, - description, - endpoint, - authRequired, - loginRequired, - headers: extractSectionTableRows(cardHtml, "Headers"), - params: extractSectionTableRows(cardHtml, "Params"), - response: extractSectionTableRows(cardHtml, "Response"), - }; -} - -function parseMethodCards(blockHtml) { - const starts = [...blockHtml.matchAll(/

]*>/g)]; - const cards = []; - - for (let i = 0; i < starts.length; i += 1) { - const start = starts[i].index; - const end = - i + 1 < starts.length ? starts[i + 1].index : blockHtml.lastIndexOf("
") + "

".length; - const cardHtml = blockHtml.slice(start, end); - const parsed = parseMethodCard(cardHtml); - if (parsed) { - cards.push(parsed); - } - } - - return cards; -} - -function sanitizeFolderName(name) { - const normalized = name.toLowerCase().replace(/[^a-z0-9._-]+/g, "-"); - return normalized.replace(/^-+|-+$/g, "") || "module"; -} - -function parseGroupBlock(blockHtml) { - const openTagMatch = blockHtml.match(/^
]*>/i); - if (!openTagMatch) { - return null; - } - - const attrs = parseAttributes(openTagMatch[0]); - const headingMatch = blockHtml.match(/

([\s\S]*?)([\s\S]*?)<\/small><\/h2>/i); - const moduleName = headingMatch ? normalizeText(headingMatch[1]) : ""; - const moduleKey = headingMatch ? normalizeText(headingMatch[2]) : attrs["data-group-key"] ?? ""; - const methods = parseMethodCards(blockHtml); - - if (!moduleName || methods.length === 0) { - return null; - } - - return { - moduleName, - moduleKey, - baseFolderName: sanitizeFolderName(moduleKey || moduleName), - methods, - }; -} - -function parseGroupsFromHtml(html) { - const starts = [...html.matchAll(/
]*>/g)]; - const parsedGroups = []; - const usedFolders = new Map(); - - for (let i = 0; i < starts.length; i += 1) { - const start = starts[i].index; - const end = i + 1 < starts.length ? starts[i + 1].index : html.lastIndexOf("
") + "

".length; - const blockHtml = html.slice(start, end); - const parsed = parseGroupBlock(blockHtml); - if (!parsed) { - continue; - } - - const currentCount = usedFolders.get(parsed.baseFolderName) ?? 0; - usedFolders.set(parsed.baseFolderName, currentCount + 1); - const folderName = - currentCount === 0 ? parsed.baseFolderName : `${parsed.baseFolderName}-${String(currentCount + 1)}`; - - parsedGroups.push({ - moduleName: parsed.moduleName, - moduleKey: parsed.moduleKey, - folderName, - methods: parsed.methods, - }); - } - - return parsedGroups; -} - -async function writeJson(filePath, data) { - await mkdir(path.dirname(filePath), { recursive: true }); - await writeFile(filePath, `${JSON.stringify(data, null, 2)}\n`, "utf8"); -} - -async function readJsonIfExists(filePath, fallbackValue = null) { - try { - const content = await readFile(filePath, "utf8"); - return JSON.parse(content); - } catch (error) { - if (error?.code === "ENOENT") { - return fallbackValue; - } - throw error; - } -} - -function isSameJson(a, b) { - return JSON.stringify(a ?? null) === JSON.stringify(b ?? null); -} - -function formatLocalDateTime(input) { - const date = input instanceof Date ? input : new Date(input); - if (Number.isNaN(date.getTime())) { - return null; - } - const year = String(date.getFullYear()); - const month = String(date.getMonth() + 1).padStart(2, "0"); - const day = String(date.getDate()).padStart(2, "0"); - const hours = String(date.getHours()).padStart(2, "0"); - const minutes = String(date.getMinutes()).padStart(2, "0"); - const seconds = String(date.getSeconds()).padStart(2, "0"); - return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}`; -} - -function normalizeDisplayTime(value, fallbackValue = null) { - if (!value) { - return fallbackValue; - } - const parsed = formatLocalDateTime(value); - return parsed ?? fallbackValue; -} - -function isNonEmptyPlainObject(value) { - return Boolean(value) && typeof value === "object" && !Array.isArray(value) && Object.keys(value).length > 0; -} - -async function listModuleFolders(moduleRootDir) { - await mkdir(moduleRootDir, { recursive: true }); - const entries = await readdir(moduleRootDir, { withFileTypes: true }); - return entries - .filter((entry) => entry.isDirectory()) - .map((entry) => entry.name) - .sort((a, b) => a.localeCompare(b, "zh-CN")); -} - -async function upsertModuleLifecycle({ folderPath, moduleMeta, nowDisplay }) { - const lifecycleFilePath = path.join(folderPath, MODULE_LIFECYCLE_FILE); - const current = await readJsonIfExists(lifecycleFilePath, null); - - if (!current) { - await writeJson(lifecycleFilePath, { - module: moduleMeta, - status: "active", - createdAt: nowDisplay, - updatedAt: nowDisplay, - deletedAt: null, - restoredAt: null, - }); - return; - } - - const next = { - ...current, - module: moduleMeta, - createdAt: normalizeDisplayTime(current.createdAt, nowDisplay), - updatedAt: nowDisplay, - deletedAt: normalizeDisplayTime(current.deletedAt, null), - restoredAt: normalizeDisplayTime(current.restoredAt, null), - }; - - if (current.status === "deleted") { - next.status = "active"; - next.deletedAt = null; - next.restoredAt = nowDisplay; - } - - await writeJson(lifecycleFilePath, next); -} - -async function removeModuleFolder(folderPath) { - await rm(folderPath, { recursive: true, force: true }); -} - -async function getModuleSnapshotFilePath(targetDir) { - const targetPath = path.join(targetDir, API_DOC_SYSTEM_CONFIG.file.moduleSnapshotName); - const parsed = await readJsonIfExists(targetPath, null); - return parsed ? targetPath : null; -} - -async function readLatestModuleSnapshots(moduleDir) { - const snapshots = new Map(); - const folders = await listModuleFolders(moduleDir); - for (const folderName of folders) { - const folderPath = path.join(moduleDir, folderName); - const lifecycle = await readJsonIfExists(path.join(folderPath, MODULE_LIFECYCLE_FILE), null); - const latestFilePath = await getModuleSnapshotFilePath(folderPath); - if (!latestFilePath) { - continue; - } - const parsed = await readJsonIfExists(latestFilePath, null); - if (!parsed) { - continue; - } - snapshots.set(folderName, { - filePath: latestFilePath, - data: parsed, - lifecycleStatus: lifecycle?.status ?? "active", - }); - } - return snapshots; -} - -async function readPreviousStatusesFromModules(moduleDir) { - const statusMap = new Map(); - const folders = await listModuleFolders(moduleDir); - - for (const folderName of folders) { - const folderPath = path.join(moduleDir, folderName); - const latestFilePath = await getModuleSnapshotFilePath(folderPath); - if (!latestFilePath) { - continue; - } - - const parsed = await readJsonIfExists(latestFilePath, null); - const interfaces = Array.isArray(parsed?.interfaces) ? parsed.interfaces : []; - for (const item of interfaces) { - if (!item?.method) { - continue; - } - statusMap.set(item.method, { - isUsed: Boolean(item?.status?.isUsed), - isPlaceholder: Boolean(item?.status?.isPlaceholder), - }); - } - } - - return statusMap; -} - -async function fetchDocHtml() { - try { - const response = await fetch(API_DOC_SYSTEM_CONFIG.docUrl, { - method: "GET", - signal: AbortSignal.timeout(API_DOC_SYSTEM_CONFIG.requestTimeoutMs), - }); - if (!response.ok) { - throw new Error(`HTTP ${response.status}`); - } - - return { - source: "remote", - html: await response.text(), - }; - } catch (error) { - const fallbackContent = await readFile(API_DOC_SYSTEM_CONFIG.file.localHtmlSnapshot, "utf8"); - console.warn(`抓取远端文档失败,已使用本地快照继续执行:${error.message}`); - return { - source: "local-fallback", - html: fallbackContent, - }; - } -} - -function assertFilterOptionsAvailable(html) { - const platform = findRequiredFilterValue(html, "platform", API_DOC_SYSTEM_CONFIG.filter.platform.value); - const project = findRequiredFilterValue(html, "project", API_DOC_SYSTEM_CONFIG.filter.project.value); - - if (!platform) { - throw new Error(`文档中未找到 platform=${API_DOC_SYSTEM_CONFIG.filter.platform.value} 的选项。`); - } - if (!project) { - throw new Error(`文档中未找到 project=${API_DOC_SYSTEM_CONFIG.filter.project.value} 的选项。`); - } - - return { - platform, - project, - }; -} - -function toModuleComparable(moduleLike) { - const interfaces = Array.isArray(moduleLike.interfaces) ? moduleLike.interfaces : []; - const methodMap = new Map(); - for (const item of interfaces) { - if (!item?.method) { - continue; - } - methodMap.set(item.method, { - method: item.method, - params: item.params ?? [], - response: item.response ?? [], - }); - } - - return { - moduleName: moduleLike.moduleName ?? moduleLike?.module?.name ?? "", - moduleKey: moduleLike.moduleKey ?? moduleLike?.module?.key ?? "", - folder: moduleLike.folder ?? moduleLike?.module?.folder ?? "", - methodMap, - methodSet: new Set(methodMap.keys()), - }; -} - -function getSetDiff(sourceSet, targetSet) { - return [...sourceSet].filter((item) => !targetSet.has(item)); -} - -function getSetIntersection(sourceSet, targetSet) { - return [...sourceSet].filter((item) => targetSet.has(item)); -} - -function getModuleBasics(moduleInfo) { - return { - moduleName: moduleInfo.moduleName, - moduleKey: moduleInfo.moduleKey, - folder: moduleInfo.folder, - }; -} - -function detectModuleAndInterfaceChanges(previousModuleMap, currentModuleMap) { - const previousFolders = new Set(previousModuleMap.keys()); - const currentFolders = new Set(currentModuleMap.keys()); - const addedFolders = getSetDiff(currentFolders, previousFolders); - const deletedFolders = getSetDiff(previousFolders, currentFolders); - const commonFolders = getSetIntersection(currentFolders, previousFolders); - - const moduleChanges = { - added: [], - deleted: [], - updated: [], - }; - - const interfaceChanges = { - added: [], - deleted: [], - paramsUpdated: [], - responseUpdated: [], - }; - - const perModuleDiff = new Map(); - - for (const folder of addedFolders) { - const moduleInfo = currentModuleMap.get(folder); - const methods = [...moduleInfo.methodSet].sort((a, b) => a.localeCompare(b, "zh-CN")); - moduleChanges.added.push({ - ...getModuleBasics(moduleInfo), - methods, - interfaceCount: methods.length, - }); - perModuleDiff.set(folder, { - type: "added", - interfaceChanges: { - addedMethods: methods, - deletedMethods: [], - paramsUpdatedMethods: [], - responseUpdatedMethods: [], - }, - }); - for (const method of methods) { - interfaceChanges.added.push({ - ...getModuleBasics(moduleInfo), - method, - }); - } - } - - for (const folder of deletedFolders) { - const moduleInfo = previousModuleMap.get(folder); - const methods = [...moduleInfo.methodSet].sort((a, b) => a.localeCompare(b, "zh-CN")); - moduleChanges.deleted.push({ - ...getModuleBasics(moduleInfo), - methods, - interfaceCount: methods.length, - }); - for (const method of methods) { - interfaceChanges.deleted.push({ - ...getModuleBasics(moduleInfo), - method, - }); - } - } - - for (const folder of commonFolders) { - const previousModule = previousModuleMap.get(folder); - const currentModule = currentModuleMap.get(folder); - - const addedMethods = getSetDiff(currentModule.methodSet, previousModule.methodSet).sort((a, b) => - a.localeCompare(b, "zh-CN"), - ); - const deletedMethods = getSetDiff(previousModule.methodSet, currentModule.methodSet).sort((a, b) => - a.localeCompare(b, "zh-CN"), - ); - const sameMethods = getSetIntersection(currentModule.methodSet, previousModule.methodSet); - const paramsUpdatedMethods = []; - const responseUpdatedMethods = []; - - for (const method of sameMethods) { - const oldMethod = previousModule.methodMap.get(method); - const newMethod = currentModule.methodMap.get(method); - if (!isSameJson(oldMethod?.params, newMethod?.params)) { - paramsUpdatedMethods.push(method); - } - if (!isSameJson(oldMethod?.response, newMethod?.response)) { - responseUpdatedMethods.push(method); - } - } - - paramsUpdatedMethods.sort((a, b) => a.localeCompare(b, "zh-CN")); - responseUpdatedMethods.sort((a, b) => a.localeCompare(b, "zh-CN")); - - if ( - addedMethods.length > 0 || - deletedMethods.length > 0 || - paramsUpdatedMethods.length > 0 || - responseUpdatedMethods.length > 0 || - previousModule.moduleName !== currentModule.moduleName || - previousModule.moduleKey !== currentModule.moduleKey - ) { - moduleChanges.updated.push({ - ...getModuleBasics(currentModule), - previousModuleName: previousModule.moduleName, - previousModuleKey: previousModule.moduleKey, - interfaceChanges: { - addedMethods, - deletedMethods, - paramsUpdatedMethods, - responseUpdatedMethods, - }, - }); - } - - perModuleDiff.set(folder, { - type: "updated", - interfaceChanges: { - addedMethods, - deletedMethods, - paramsUpdatedMethods, - responseUpdatedMethods, - }, - }); - - for (const method of addedMethods) { - interfaceChanges.added.push({ - ...getModuleBasics(currentModule), - method, - }); - } - for (const method of deletedMethods) { - interfaceChanges.deleted.push({ - ...getModuleBasics(currentModule), - method, - }); - } - for (const method of paramsUpdatedMethods) { - interfaceChanges.paramsUpdated.push({ - ...getModuleBasics(currentModule), - method, - }); - } - for (const method of responseUpdatedMethods) { - interfaceChanges.responseUpdated.push({ - ...getModuleBasics(currentModule), - method, - }); - } - } - - return { - moduleChanges, - interfaceChanges, - perModuleDiff, - summary: { - moduleAdded: moduleChanges.added.length, - moduleDeleted: moduleChanges.deleted.length, - moduleUpdated: moduleChanges.updated.length, - interfaceAdded: interfaceChanges.added.length, - interfaceDeleted: interfaceChanges.deleted.length, - interfaceParamsUpdated: interfaceChanges.paramsUpdated.length, - interfaceResponseUpdated: interfaceChanges.responseUpdated.length, - }, - }; -} - -async function run() { - const pendingUpdates = await readJsonIfExists(API_DOC_SYSTEM_CONFIG.file.pendingUpdates, null); - const hasLegacyPending = Array.isArray(pendingUpdates) && pendingUpdates.length > 0; - const hasObjectPending = isNonEmptyPlainObject(pendingUpdates); - if (hasLegacyPending || hasObjectPending) { - console.log("请先处理待更新接口再更新接口信息!"); - process.exitCode = 1; - return; - } - - const { source, html } = await fetchDocHtml(); - const filterSnapshot = assertFilterOptionsAvailable(html); - const groups = parseGroupsFromHtml(html); - if (groups.length === 0) { - throw new Error("未解析出任何模块,请检查文档结构是否变更。"); - } - - const now = new Date(); - const nowLocal = formatLocalDateTime(now); - const previousModuleSnapshots = await readLatestModuleSnapshots(API_DOC_SYSTEM_CONFIG.file.moduleDir); - const previousStatuses = await readPreviousStatusesFromModules(API_DOC_SYSTEM_CONFIG.file.moduleDir); - const moduleListItems = []; - const allInterfaces = []; - const activeFolderNames = new Set(); - const currentModuleComparableMap = new Map(); - const previousActiveComparableMap = new Map(); - - for (const [folderName, snapshot] of previousModuleSnapshots.entries()) { - if (snapshot.lifecycleStatus === "deleted") { - continue; - } - const moduleComparable = toModuleComparable({ - moduleName: snapshot?.data?.module?.name, - moduleKey: snapshot?.data?.module?.key, - folder: snapshot?.data?.module?.folder ?? folderName, - interfaces: snapshot?.data?.interfaces ?? [], - }); - previousActiveComparableMap.set(folderName, moduleComparable); - } - - await mkdir(API_DOC_SYSTEM_CONFIG.file.moduleDir, { recursive: true }); - - for (const group of groups) { - const moduleFolderPath = path.join(API_DOC_SYSTEM_CONFIG.file.moduleDir, group.folderName); - activeFolderNames.add(group.folderName); - await upsertModuleLifecycle({ - folderPath: moduleFolderPath, - moduleMeta: { - name: group.moduleName, - key: group.moduleKey, - folder: group.folderName, - }, - nowDisplay: nowLocal, - }); - - const previousModule = previousModuleSnapshots.get(group.folderName)?.data; - const previousInterfaces = Array.isArray(previousModule?.interfaces) ? previousModule.interfaces : []; - const previousInterfaceMap = new Map(previousInterfaces.map((item) => [item.method, item])); - const moduleInterfaces = group.methods.map((methodInfo) => { - const status = previousStatuses.get(methodInfo.method) ?? { - isUsed: false, - isPlaceholder: false, - }; - return { - method: methodInfo.method, - title: methodInfo.title, - description: methodInfo.description, - endpoint: methodInfo.endpoint, - authRequired: methodInfo.authRequired, - loginRequired: methodInfo.loginRequired, - status, - headers: methodInfo.headers, - params: methodInfo.params, - response: methodInfo.response, - }; - }); - - const moduleComparable = toModuleComparable({ - moduleName: group.moduleName, - moduleKey: group.moduleKey, - folder: group.folderName, - interfaces: moduleInterfaces, - }); - currentModuleComparableMap.set(group.folderName, moduleComparable); - - const currentMethodSet = new Set(moduleInterfaces.map((item) => item.method)); - const previousMethodSet = new Set(previousInterfaces.map((item) => item.method)); - const addedMethods = getSetDiff(currentMethodSet, previousMethodSet).sort((a, b) => a.localeCompare(b, "zh-CN")); - const deletedMethods = getSetDiff(previousMethodSet, currentMethodSet).sort((a, b) => a.localeCompare(b, "zh-CN")); - const sharedMethods = getSetIntersection(currentMethodSet, previousMethodSet); - const paramsUpdatedMethods = []; - const responseUpdatedMethods = []; - for (const method of sharedMethods) { - const oldItem = previousInterfaceMap.get(method); - const newItem = moduleInterfaces.find((entry) => entry.method === method); - if (!isSameJson(oldItem?.params, newItem?.params)) { - paramsUpdatedMethods.push(method); - } - if (!isSameJson(oldItem?.response, newItem?.response)) { - responseUpdatedMethods.push(method); - } - } - paramsUpdatedMethods.sort((a, b) => a.localeCompare(b, "zh-CN")); - responseUpdatedMethods.sort((a, b) => a.localeCompare(b, "zh-CN")); - - const moduleFilePath = path.join( - API_DOC_SYSTEM_CONFIG.file.moduleDir, - group.folderName, - API_DOC_SYSTEM_CONFIG.file.moduleSnapshotName, - ); - const modulePayload = { - generatedAt: nowLocal, - generatedAtLocal: nowLocal, - source, - filter: filterSnapshot, - module: { - name: group.moduleName, - key: group.moduleKey, - folder: group.folderName, - interfaceCount: group.methods.length, - }, - changes: { - fromPreviousSnapshot: { - moduleAdded: !previousModule, - moduleRenamed: previousModule - ? previousModule?.module?.name !== group.moduleName || previousModule?.module?.key !== group.moduleKey - : false, - interfaceChanges: { - addedMethods, - deletedMethods, - paramsUpdatedMethods, - responseUpdatedMethods, - }, - }, - }, - interfaces: moduleInterfaces, - }; - await writeJson(moduleFilePath, modulePayload); - - moduleListItems.push({ - moduleName: group.moduleName, - moduleKey: group.moduleKey, - folder: group.folderName, - interfaceCount: moduleInterfaces.length, - interfaces: moduleInterfaces.map((item) => ({ - method: item.method, - })), - }); - - for (const methodInfo of moduleInterfaces) { - allInterfaces.push({ - moduleName: group.moduleName, - moduleKey: group.moduleKey, - moduleFolder: group.folderName, - method: methodInfo.method, - title: methodInfo.title, - description: methodInfo.description, - endpoint: methodInfo.endpoint, - authRequired: methodInfo.authRequired, - loginRequired: methodInfo.loginRequired, - status: methodInfo.status, - headers: methodInfo.headers, - params: methodInfo.params, - response: methodInfo.response, - }); - } - } - - const existingFolders = await listModuleFolders(API_DOC_SYSTEM_CONFIG.file.moduleDir); - const staleFolders = existingFolders.filter((folderName) => !activeFolderNames.has(folderName)); - - const changeBundle = detectModuleAndInterfaceChanges(previousActiveComparableMap, currentModuleComparableMap); - const pendingInterfaceChangesCount = - changeBundle.summary.interfaceAdded + - changeBundle.summary.interfaceDeleted + - changeBundle.summary.interfaceParamsUpdated + - changeBundle.summary.interfaceResponseUpdated; - const pendingModuleChangesCount = changeBundle.summary.moduleAdded + changeBundle.summary.moduleDeleted; - - const moduleListFilePath = API_DOC_SYSTEM_CONFIG.file.moduleListFile; - await writeJson(moduleListFilePath, { - generatedAt: nowLocal, - generatedAtLocal: nowLocal, - source, - filter: filterSnapshot, - moduleCount: moduleListItems.length, - totalInterfaceCount: allInterfaces.length, - changes: { - summary: changeBundle.summary, - moduleUpdates: changeBundle.moduleChanges, - interfaceUpdates: changeBundle.interfaceChanges, - }, - modules: moduleListItems.sort((a, b) => a.moduleName.localeCompare(b.moduleName, "zh-CN")), - }); - const detailFilePath = API_DOC_SYSTEM_CONFIG.file.interfaceDetailFile; - await writeJson(detailFilePath, { - generatedAt: nowLocal, - generatedAtLocal: nowLocal, - source, - filter: filterSnapshot, - totalInterfaceCount: allInterfaces.length, - changes: { - summary: changeBundle.summary, - moduleUpdates: changeBundle.moduleChanges, - interfaceUpdates: changeBundle.interfaceChanges, - }, - interfaces: allInterfaces.sort((a, b) => a.method.localeCompare(b.method, "zh-CN")), - }); - const hasChanges = pendingInterfaceChangesCount > 0; - if (hasChanges) { - const pendingPayload = { - generatedAt: nowLocal, - generatedAtLocal: nowLocal, - source, - filter: filterSnapshot, - summary: { - moduleAdded: changeBundle.summary.moduleAdded, - moduleDeleted: changeBundle.summary.moduleDeleted, - interfaceAdded: changeBundle.summary.interfaceAdded, - interfaceDeleted: changeBundle.summary.interfaceDeleted, - interfaceParamsUpdated: changeBundle.summary.interfaceParamsUpdated, - interfaceResponseUpdated: changeBundle.summary.interfaceResponseUpdated, - totalChangedItems: pendingModuleChangesCount + pendingInterfaceChangesCount, - }, - interfaceUpdates: { - added: changeBundle.interfaceChanges.added, - deleted: changeBundle.interfaceChanges.deleted, - paramsUpdated: changeBundle.interfaceChanges.paramsUpdated, - responseUpdated: changeBundle.interfaceChanges.responseUpdated, - }, - }; - await writeJson(API_DOC_SYSTEM_CONFIG.file.pendingUpdates, pendingPayload); - } else { - await writeJson(API_DOC_SYSTEM_CONFIG.file.pendingUpdates, {}); - } - - let removedModuleCount = 0; - for (const folderName of staleFolders) { - const folderPath = path.join(API_DOC_SYSTEM_CONFIG.file.moduleDir, folderName); - await removeModuleFolder(folderPath); - removedModuleCount += 1; - } - - console.log(`执行时间: ${nowLocal}`); - console.log(`API 文档已清洗完成,模块数: ${moduleListItems.length},接口数: ${allInterfaces.length}`); - console.log(`本次移除旧模块文件夹: ${removedModuleCount}`); - console.log( - `模块变化统计 -> 新增:${changeBundle.summary.moduleAdded} 删除:${changeBundle.summary.moduleDeleted} 更新:${changeBundle.summary.moduleUpdated}`, - ); - console.log( - `接口变化统计 -> 新增:${changeBundle.summary.interfaceAdded} 删除:${changeBundle.summary.interfaceDeleted} Params更新:${changeBundle.summary.interfaceParamsUpdated} Response更新:${changeBundle.summary.interfaceResponseUpdated}`, - ); - console.log(`模块列表文件: ${moduleListFilePath}`); - console.log(`接口明细文件: ${detailFilePath}`); - console.log(`待更新接口文件: ${API_DOC_SYSTEM_CONFIG.file.pendingUpdates}`); -} - -run().catch((error) => { - console.error("执行 API 文档抓取与清洗失败:", error); - process.exitCode = 1; -});