This commit is contained in:
yin 2026-06-21 18:21:10 +08:00
parent 8e0b5211e3
commit dfea0c3164
152 changed files with 2063 additions and 45069 deletions

3
.gitignore vendored
View File

@ -37,3 +37,6 @@ __screenshots__/
# Vite
*.timestamp-*-*.mjs
# Workflows (local tooling, not tracked)
/workflows/

View File

@ -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<string, unknown> & {
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<any> {
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<any> {
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<any> {
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<any> {
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<any> {
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
}

View File

@ -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<any> {
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<any> {
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

View File

@ -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<string, unknown> | null
/** 无波次时单订单详情模式 */
detail?: Record<string, unknown>
items?: unknown[]

View File

@ -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<any> {
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
}

View File

@ -64,6 +64,7 @@ export default {
'packageMaterial':'Package Material',
'packageSupplier':'Package Supplier',
'pickcart':'Pickcart',
'PickingShortage':'Picking Shortage',
},
"login": {
"title": "Login",

View File

@ -65,6 +65,7 @@ export default {
'packageMaterial':'包材管理',
'packageSupplier':'包装供应商',
'pickcart':'拣货车',
'PickingShortage':'缺货补货',
},
"login": {
"title": "登录",

View File

@ -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
}

View File

@ -15,6 +15,7 @@ export const componentMap: Record<string, any> = {
'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'),

View File

@ -13,7 +13,7 @@
:closable="false"
show-icon
style="margin-bottom: 12px"
title="仅需运单号与包材编码,系统自动反查订单运单记录并绑定包材,无需订单 ID。"
title="仅需运单号与包材,系统自动反查订单运单记录并绑定包材,无需订单 ID。"
/>
<el-form ref="formRef" :model="form" :rules="rules" label-width="96px" @submit.prevent>
@ -25,10 +25,10 @@
@keyup.enter="focusMaterialSelect"
/>
</el-form-item>
<el-form-item label="包材编码" prop="package_material_code">
<el-form-item label="包材" prop="package_material_id">
<el-select
ref="materialSelectRef"
v-model="form.package_material_code"
v-model="form.package_material_id"
filterable
remote
clearable
@ -41,9 +41,9 @@
>
<el-option
v-for="item in materialOptions"
:key="item.material_code"
:key="item.id"
:label="`${item.material_code} / ${item.material_name}`"
:value="item.material_code"
:value="item.id"
/>
</el-select>
</el-form-item>
@ -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<FormInstance>()
const materialSelectRef = ref<{ focus?: () => void } | null>(null)
const submitting = ref(false)
const materialLoading = ref(false)
const materialOptions = ref<Array<{ material_code: string; material_name: string }>>([])
const materialOptions = ref<Array<{ id: number; material_code: string; material_name: string }>>([])
const lastResult = ref<BindExpressPackageMaterialByWaybillResponse | null>(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 || '绑定包材失败')

View File

@ -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' },
]

View File

@ -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<string, unknown> {
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<string, unknown> = {}
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<string, unknown>
}) {
const payload: Record<string, unknown> = {
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<string, unknown>) : {}
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)
}

View File

@ -0,0 +1,322 @@
<template>
<el-dialog
v-model="visible"
:title="mode === 'create' ? '新增组合商品' : '编辑组合商品'"
width="920px"
align-center
destroy-on-close
@close="resetForm"
>
<el-form ref="formRef" :model="formData" :rules="rules" label-width="96px">
<el-row :gutter="16">
<el-col :span="12">
<el-form-item label="组合编码" prop="combo_code">
<el-input
v-model="formData.combo_code"
placeholder="全局唯一"
:disabled="mode === 'edit'"
@blur="normalizeComboCode"
/>
</el-form-item>
</el-col>
<el-col :span="12">
<el-form-item label="组合名称" prop="combo_name">
<el-input v-model="formData.combo_name" placeholder="请输入组合名称" />
</el-form-item>
</el-col>
<el-col :span="12">
<el-form-item label="仓库 ID" prop="warehouse_id">
<el-input-number
v-model="formData.warehouse_id"
:min="1"
controls-position="right"
placeholder="可选"
style="width: 100%"
/>
</el-form-item>
</el-col>
<el-col v-if="mode === 'edit'" :span="12">
<el-form-item label="状态" prop="status">
<el-radio-group v-model="formData.status">
<el-radio :label="1">启用</el-radio>
<el-radio :label="0">停用</el-radio>
</el-radio-group>
</el-form-item>
</el-col>
<el-col :span="24">
<el-form-item label="备注" prop="remark">
<el-input v-model="formData.remark" type="textarea" :rows="2" placeholder="可选" />
</el-form-item>
</el-col>
</el-row>
</el-form>
<div class="items-toolbar">
<span class="items-title">子商品明细</span>
<el-button type="primary" size="small" plain @click="pickerVisible = true">添加子商品</el-button>
</div>
<el-table :data="formItems" border size="small" max-height="280" empty-text="请至少添加 1 个子商品">
<el-table-column label="序号" width="64" align="center">
<template #default="{ $index }">{{ $index + 1 }}</template>
</el-table-column>
<el-table-column prop="item_goods_sku_id" label="SKU ID" width="90" />
<el-table-column prop="item_code" label="商品编码" min-width="120" show-overflow-tooltip />
<el-table-column prop="item_name" label="商品名称" min-width="140" show-overflow-tooltip />
<el-table-column label="数量" width="120">
<template #default="{ row }">
<el-input-number
v-model="row.item_quantity"
:min="1"
:step="1"
controls-position="right"
size="small"
style="width: 100%"
/>
</template>
</el-table-column>
<el-table-column label="排序" width="100">
<template #default="{ row, $index }">
<el-input-number
v-model="row.sort_order"
:min="1"
:step="1"
controls-position="right"
size="small"
style="width: 100%"
@change="(val: number | undefined) => onSortOrderChange($index, val)"
/>
</template>
</el-table-column>
<el-table-column label="操作" width="72" align="center" fixed="right">
<template #default="{ $index }">
<el-button link type="danger" size="small" @click="removeItem($index)">移除</el-button>
</template>
</el-table-column>
</el-table>
<ComboStockPickerDialog v-model="pickerVisible" @confirm="handlePickItems" />
<template #footer>
<el-button @click="visible = false">取消</el-button>
<el-button type="primary" :loading="saving" @click="submitForm">保存</el-button>
</template>
</el-dialog>
</template>
<script setup lang="ts">
import { reactive, ref, watch } from 'vue'
import { ElMessage } from 'element-plus'
import type { FormInstance, FormRules } from 'element-plus'
import { comboGoodsCreate, comboGoodsUpdate } from '@/api/combogoods/combogoods'
import ComboStockPickerDialog, {
type ComboStockPickerItem
} from './ComboStockPickerDialog.vue'
import {
isComboGoodsApiSuccess,
mapComboGoodsItemsFromRecord,
type ComboGoodsItemRow,
type ComboGoodsRecord
} from '../combo-stock-config'
const visible = defineModel<boolean>({ default: false })
const props = defineProps<{
mode: 'create' | 'edit'
record?: ComboGoodsRecord | null
}>()
const emit = defineEmits<{ success: [] }>()
const formRef = ref<FormInstance>()
const saving = ref(false)
const pickerVisible = ref(false)
const formItems = ref<ComboGoodsItemRow[]>([])
const formData = reactive({
id: undefined as number | undefined,
combo_code: '',
combo_name: '',
warehouse_id: undefined as number | undefined,
remark: '',
status: 1
})
const rules: FormRules = {
combo_code: [{ required: true, message: '请输入组合编码', trigger: 'blur' }],
combo_name: [{ required: true, message: '请输入组合名称', trigger: 'blur' }]
}
watch(
() => visible.value,
(opened) => {
if (!opened) return
if (props.mode === 'edit' && props.record) {
fillFromRecord(props.record)
return
}
resetForm()
}
)
function normalizeComboCode() {
formData.combo_code = String(formData.combo_code || '').trim()
}
function fillFromRecord(record: ComboGoodsRecord) {
formData.id = record.id
formData.combo_code = record.combo_code || ''
formData.combo_name = record.combo_name || ''
formData.warehouse_id =
record.warehouse_id != null && Number(record.warehouse_id) > 0
? Number(record.warehouse_id)
: undefined
formData.remark = record.remark || ''
formData.status = record.status === 0 ? 0 : 1
formItems.value = mapComboGoodsItemsFromRecord(record.items)
formRef.value?.clearValidate()
}
function resetForm() {
formData.id = undefined
formData.combo_code = ''
formData.combo_name = ''
formData.warehouse_id = undefined
formData.remark = ''
formData.status = 1
formItems.value = []
formRef.value?.clearValidate()
}
function onSortOrderChange(index: number, value: number | undefined) {
const row = formItems.value[index]
if (!row) return
row.sort_order = Number.isFinite(Number(value)) && Number(value) > 0 ? Number(value) : index + 1
}
function removeItem(index: number) {
formItems.value.splice(index, 1)
formItems.value.forEach((item, idx) => {
if (!item.sort_order || item.sort_order <= 0) {
item.sort_order = idx + 1
}
})
}
function handlePickItems(items: ComboStockPickerItem[]) {
if (!items.length) return
const existing = new Set(formItems.value.map((item) => item.item_goods_sku_id))
let nextSort = formItems.value.length
? Math.max(...formItems.value.map((item) => Number(item.sort_order) || 0)) + 1
: 1
for (const picked of items) {
if (existing.has(picked.item_goods_sku_id)) continue
formItems.value.push({
item_goods_sku_id: picked.item_goods_sku_id,
item_quantity: 1,
sort_order: nextSort,
item_code: picked.item_code,
item_name: picked.item_name,
barcode: picked.barcode
})
existing.add(picked.item_goods_sku_id)
nextSort += 1
}
}
function buildItemsPayload() {
return formItems.value.map((item, index) => ({
item_goods_sku_id: item.item_goods_sku_id,
item_quantity: Math.max(1, Math.floor(Number(item.item_quantity) || 1)),
sort_order: Number(item.sort_order) > 0 ? Number(item.sort_order) : index + 1
}))
}
function validateItems() {
if (!formItems.value.length) {
ElMessage.warning('请至少添加 1 个子商品')
return false
}
const invalidQty = formItems.value.some(
(item) => !Number.isFinite(Number(item.item_quantity)) || Number(item.item_quantity) <= 0
)
if (invalidQty) {
ElMessage.warning('子商品数量必须为正整数')
return false
}
return true
}
async function submitForm() {
if (!formRef.value || saving.value) return
const valid = await formRef.value.validate().catch(() => false)
if (!valid || !validateItems()) return
normalizeComboCode()
saving.value = true
try {
if (props.mode === 'create') {
const payload: Record<string, unknown> = {
combo_code: formData.combo_code,
combo_name: formData.combo_name.trim(),
items: buildItemsPayload()
}
const remark = formData.remark.trim()
if (remark) payload.remark = remark
if (formData.warehouse_id != null && formData.warehouse_id > 0) {
payload.warehouse_id = formData.warehouse_id
}
const res = await comboGoodsCreate(payload as any)
if (!isComboGoodsApiSuccess(res)) {
ElMessage.error((res as any)?.message || '新增失败')
return
}
ElMessage.success('新增成功')
} else {
if (!formData.id) return
const payload: Record<string, unknown> = {
id: formData.id,
combo_name: formData.combo_name.trim(),
status: formData.status,
items: buildItemsPayload()
}
const remark = formData.remark.trim()
payload.remark = remark
if (formData.warehouse_id != null && formData.warehouse_id > 0) {
payload.warehouse_id = formData.warehouse_id
} else {
payload.warehouse_id = null
}
const res = await comboGoodsUpdate(payload as any)
if (!isComboGoodsApiSuccess(res)) {
ElMessage.error((res as any)?.message || '更新失败')
return
}
ElMessage.success('更新成功')
}
visible.value = false
emit('success')
} catch {
ElMessage.error('保存失败')
} finally {
saving.value = false
}
}
</script>
<style scoped lang="scss">
.items-toolbar {
display: flex;
align-items: center;
justify-content: space-between;
margin: 8px 0 10px;
}
.items-title {
font-size: 14px;
font-weight: 600;
color: #303133;
}
</style>

View File

@ -0,0 +1,141 @@
<template>
<el-dialog
v-model="visible"
title="组合商品快速搜索"
width="900px"
align-center
destroy-on-close
:close-on-click-modal="!loading"
@closed="emit('closed')"
>
<el-alert
type="info"
:closable="false"
show-icon
class="search-alert"
title="comboGoods.search"
description="模糊匹配 combo_code / combo_name,仅返回启用状态记录,默认 20 条,上限 100 条。"
/>
<el-form :inline="true" size="small" class="search-form" @submit.prevent="handleSearch">
<el-form-item label="关键字">
<el-input
v-model="keyword"
clearable
placeholder="组合编码 / 名称"
style="width: 260px"
@keyup.enter="handleSearch"
/>
</el-form-item>
<el-form-item label="条数">
<el-input-number v-model="limit" :min="1" :max="100" controls-position="right" />
</el-form-item>
<el-form-item>
<el-button type="primary" :loading="loading" @click="handleSearch">搜索</el-button>
<el-button :disabled="loading" @click="handleReset">重置</el-button>
</el-form-item>
</el-form>
<div class="result-meta">共 {{ list.length }} 条</div>
<el-table
:data="list"
border
size="small"
max-height="420"
v-loading="loading"
row-key="id"
empty-text="暂无组合商品"
highlight-current-row
>
<el-table-column prop="id" label="ID" width="72" />
<el-table-column prop="combo_code" label="组合编码" min-width="130" show-overflow-tooltip />
<el-table-column prop="combo_name" label="组合名称" min-width="150" show-overflow-tooltip />
<el-table-column prop="simpleNotation" label="子商品简记" min-width="160" show-overflow-tooltip />
<el-table-column prop="nameNotation" label="名称简记" min-width="180" show-overflow-tooltip />
<el-table-column label="状态" width="88" align="center">
<template #default="{ row }">
<el-tag :type="formatComboGoodsStatus(row.status).type" size="small">
{{ formatComboGoodsStatus(row.status).text }}
</el-tag>
</template>
</el-table-column>
</el-table>
<template #footer>
<el-button @click="visible = false">关闭</el-button>
</template>
</el-dialog>
</template>
<script setup lang="ts">
import { ref, watch } from 'vue'
import { ElMessage } from 'element-plus'
import { comboGoodsSearch } from '@/api/combogoods/combogoods'
import {
formatComboGoodsStatus,
isComboGoodsApiSuccess,
parseComboGoodsSearchResponse,
type ComboGoodsRecord
} from '../combo-stock-config'
const visible = defineModel<boolean>({ default: false })
const emit = defineEmits<{ closed: [] }>()
const loading = ref(false)
const keyword = ref('')
const limit = ref(20)
const list = ref<ComboGoodsRecord[]>([])
watch(visible, (opened) => {
if (!opened) return
keyword.value = ''
limit.value = 20
list.value = []
})
async function handleSearch() {
const text = keyword.value.trim()
if (!text) {
ElMessage.warning('请输入搜索关键字')
return
}
loading.value = true
try {
const res = await comboGoodsSearch({ keyword: text, limit: limit.value })
if (!isComboGoodsApiSuccess(res)) {
list.value = []
ElMessage.error((res as any)?.message || '搜索失败')
return
}
list.value = parseComboGoodsSearchResponse(res)
} catch {
list.value = []
ElMessage.error('搜索失败')
} finally {
loading.value = false
}
}
function handleReset() {
keyword.value = ''
limit.value = 20
list.value = []
}
</script>
<style scoped lang="scss">
.search-alert {
margin-bottom: 12px;
}
.search-form {
margin-bottom: 8px;
}
.result-meta {
margin-bottom: 8px;
font-size: 13px;
color: #606266;
}
</style>

View File

@ -0,0 +1,179 @@
<template>
<el-dialog
v-model="visible"
title="选择子商品"
width="760px"
align-center
append-to-body
destroy-on-close
@closed="handleClosed"
>
<el-alert
type="info"
:closable="false"
show-icon
class="picker-alert"
title="stock.warehouse.search"
description="搜索仓库商品后勾选加入组合明细;子商品须属于同一货主且库存记录有效。"
/>
<div class="picker-toolbar">
<el-input
v-model="keyword"
placeholder="商品编码 / 条码 / 名称"
clearable
size="small"
@keyup.enter="handleSearch"
/>
<el-button type="primary" size="small" :loading="loading" @click="handleSearch">搜索</el-button>
</div>
<el-table
ref="tableRef"
:data="list"
border
size="small"
max-height="320"
v-loading="loading"
row-key="item_goods_sku_id"
empty-text="暂无商品"
@selection-change="handleSelectionChange"
>
<el-table-column type="selection" width="46" :reserve-selection="true" />
<el-table-column prop="item_goods_sku_id" label="SKU ID" width="90" />
<el-table-column prop="item_code" label="商品编码" min-width="120" show-overflow-tooltip />
<el-table-column prop="item_name" label="商品名称" min-width="140" show-overflow-tooltip />
<el-table-column prop="barcode" label="条码" min-width="110" show-overflow-tooltip />
<el-table-column prop="store_id" label="货主 ID" width="88" />
</el-table>
<div class="picker-meta">已选 {{ selectedItems.length }} 个商品</div>
<template #footer>
<el-button @click="visible = false">取消</el-button>
<el-button type="primary" :disabled="!selectedItems.length" @click="handleConfirm">确定</el-button>
</template>
</el-dialog>
</template>
<script setup lang="ts">
import { ref, watch } from 'vue'
import { ElMessage } from 'element-plus'
import { warehouseSearch } from '@/api/stock/stock'
import {
getStockItemCode,
getStockItemName,
getStockBarcode,
getStockStoreId,
isStockApiSuccess,
mapStockPickerItem,
parseStockWarehouseSearch
} from '@/views/order/orderManagement/utils/stock-picker-helpers'
export type ComboStockPickerItem = {
item_goods_sku_id: number
item_code: string
item_name: string
barcode: string
store_id?: number
}
const visible = defineModel<boolean>({ default: false })
const emit = defineEmits<{ confirm: [items: ComboStockPickerItem[]] }>()
const loading = ref(false)
const keyword = ref('')
const list = ref<ComboStockPickerItem[]>([])
const selectedItems = ref<ComboStockPickerItem[]>([])
const tableRef = ref<any>(null)
watch(visible, (opened) => {
if (!opened) return
keyword.value = ''
list.value = []
selectedItems.value = []
})
function resolveSkuId(row: any): number | undefined {
const candidates = [row?.id, row?.item_id, row?.goods_sku_id, row?.stock_id]
for (const candidate of candidates) {
const value = Number(candidate)
if (Number.isInteger(value) && value > 0) return value
}
return undefined
}
function mapPickerRow(row: any): ComboStockPickerItem | null {
const mapped = mapStockPickerItem(row)
const skuId = resolveSkuId(row) ?? mapped.item_id
if (!skuId) return null
return {
item_goods_sku_id: skuId,
item_code: getStockItemCode(row) || mapped.item_code,
item_name: getStockItemName(row) || mapped.item_name,
barcode: getStockBarcode(row) || mapped.barcode,
store_id: getStockStoreId(row)
}
}
async function handleSearch() {
const text = keyword.value.trim()
if (!text) {
ElMessage.warning('请输入搜索关键字')
return
}
loading.value = true
try {
const res: any = await warehouseSearch({ keyword: text })
if (!isStockApiSuccess(res)) {
list.value = []
ElMessage.error(res?.message || '搜索商品失败')
return
}
const { list: rawList } = parseStockWarehouseSearch(res)
list.value = rawList
.map((row) => mapPickerRow(row))
.filter((item): item is ComboStockPickerItem => item != null)
} catch {
list.value = []
ElMessage.error('搜索商品失败')
} finally {
loading.value = false
}
}
function handleSelectionChange(rows: ComboStockPickerItem[]) {
selectedItems.value = rows || []
}
function handleConfirm() {
if (!selectedItems.value.length) return
emit('confirm', selectedItems.value.map((item) => ({ ...item })))
visible.value = false
}
function handleClosed() {
keyword.value = ''
list.value = []
selectedItems.value = []
tableRef.value?.clearSelection?.()
}
</script>
<style scoped lang="scss">
.picker-alert {
margin-bottom: 12px;
}
.picker-toolbar {
display: flex;
gap: 8px;
margin-bottom: 10px;
}
.picker-meta {
margin-top: 10px;
font-size: 13px;
color: #606266;
}
</style>

View File

@ -1,7 +1,314 @@
<template>
<div class="">combo_stock页面</div>
<div class="combo-stock-container" :style="{ height: containerHeight }">
<scan-box
ref="scanBox"
width="250px"
:tree-props="{ children: 'children', label: 'label' }"
:auto-submit="false"
:preset-tree="presetTree"
:available-fields="availableFieldsRef"
@condition-change="handleConditionChange"
@reset="handleConditionReset"
@condition-clear="handleConditionClear"
@submit="handleSubmit"
/>
<div class="main-content">
<div class="toolbar">
<div class="toolbar-left">
<el-button size="small" type="primary" :loading="loading" @click="loadList">刷新</el-button>
<el-tag size="small" type="info">共 {{ pagination.total }} 条</el-tag>
</div>
<div class="toolbar-right">
<el-button size="small" type="primary" plain @click="searchDialogVisible = true">快速搜索</el-button>
<el-button type="success" size="small" @click="openCreate">新增组合商品</el-button>
</div>
</div>
<div class="upper-wrapper">
<upper-table
ref="upperTable"
title="组合商品列表"
table-id="stock-combo-goods"
:data="tableData"
:columns="columns"
:table-size="tableSize"
:pagination="pagination"
:show-index="true"
:show-selection="false"
:show-actions="true"
:loading="loading"
:query-time="queryTime"
row-key="id"
@page-change="handlePageChange"
@page-size-change="handlePageSizeChange"
@refresh="loadList"
>
<template #column-status="{ row }">
<el-tag :type="formatComboGoodsStatus(row.status).type" size="small">
{{ formatComboGoodsStatus(row.status).text }}
</el-tag>
</template>
<template #column-simpleNotation="{ row }">
{{ row.simpleNotation || '--' }}
</template>
<template #column-nameNotation="{ row }">
{{ row.nameNotation || '--' }}
</template>
<template #column-created_at="{ row }">
{{ formatDateTime(row.created_at) }}
</template>
<template #column-updated_at="{ row }">
{{ formatDateTime(row.updated_at) }}
</template>
<template #column-actions="{ row }">
<el-button link type="primary" size="small" @click.stop="openEdit(row)">编辑</el-button>
<el-button link type="danger" size="small" @click.stop="handleDelete(row)">删除</el-button>
</template>
<template #empty>
<div class="empty-tip">暂无组合商品,可调整左侧筛选条件或点击新增</div>
</template>
</upper-table>
</div>
</div>
<ComboGoodsFormDialog
v-model="formDialogVisible"
:mode="formDialogMode"
:record="editingRecord"
@success="loadList"
/>
<ComboGoodsSearchDialog v-model="searchDialogVisible" />
</div>
</template>
<script setup lang="ts"></script>
<script setup lang="ts">
import { computed, onMounted, reactive, ref } from 'vue'
import { ElMessage, ElMessageBox } from 'element-plus'
import ScanBox from '@/components/ScanBox/index.vue'
import UpperTable from '@/components/UpperTable/index.vue'
import { comboGoodsDelete, comboGoodsList } from '@/api/combogoods/combogoods'
import { useSettingsStore } from '@/stores/modules/settings'
import ComboGoodsFormDialog from './component/ComboGoodsFormDialog.vue'
import ComboGoodsSearchDialog from './component/ComboGoodsSearchDialog.vue'
import {
buildComboGoodsListPayload,
comboGoodsColumns,
comboGoodsScanFields,
formatComboGoodsStatus,
isComboGoodsApiSuccess,
normalizeComboGoodsScanConditionToWhere,
parseComboGoodsListResponse,
type ComboGoodsRecord
} from './combo-stock-config'
<style lang="css" scoped></style>
const settingsStore = useSettingsStore()
const scanBox = ref<any>(null)
const presetTree = ref<any[]>([])
const availableFieldsRef = reactive(JSON.parse(JSON.stringify(comboGoodsScanFields)))
const shortcutExpanded = computed(() => settingsStore.shortcutExpanded)
const containerHeight = computed(() =>
shortcutExpanded.value ? 'calc(100vh - 150px)' : 'calc(100vh - 100px)'
)
const columns = comboGoodsColumns
const loading = ref(false)
const tableData = ref<ComboGoodsRecord[]>([])
const queryTime = ref(0)
const tableSize = ref<'small' | 'default' | 'large'>('small')
const currentConditionRaw = ref<any>(null)
const pagination = reactive({ currentPage: 1, pageSize: 20, total: 0 })
const formDialogVisible = ref(false)
const formDialogMode = ref<'create' | 'edit'>('create')
const editingRecord = ref<ComboGoodsRecord | null>(null)
const searchDialogVisible = ref(false)
function formatDateTime(value: unknown) {
if (value == null || value === '') return '--'
const text = String(value).trim()
if (!text) return '--'
const num = Number(text)
if (Number.isFinite(num) && num > 1e11) {
const date = new Date(num)
if (!Number.isNaN(date.getTime())) {
return date.toLocaleString('zh-CN', { hour12: false })
}
}
return text
}
async function loadList() {
if (loading.value) return
loading.value = true
const start = Date.now()
try {
const where = normalizeComboGoodsScanConditionToWhere(currentConditionRaw.value)
const res: any = await comboGoodsList(
buildComboGoodsListPayload({
page: pagination.currentPage,
pageSize: pagination.pageSize,
where
})
)
if (!isComboGoodsApiSuccess(res)) {
ElMessage.error(res?.message || '获取组合商品列表失败')
tableData.value = []
pagination.total = 0
return
}
const data = parseComboGoodsListResponse(res)
tableData.value = data.list
pagination.total = data.total
if (data.page) pagination.currentPage = data.page
if (data.pageSize) pagination.pageSize = data.pageSize
} catch {
tableData.value = []
pagination.total = 0
ElMessage.error('获取组合商品列表失败')
} finally {
queryTime.value = Date.now() - start
loading.value = false
}
}
function handleConditionChange(condition: any) {
currentConditionRaw.value = condition
pagination.currentPage = 1
loadList()
}
function handleSubmit() {
pagination.currentPage = 1
loadList()
}
function handleConditionClear() {
currentConditionRaw.value = null
pagination.currentPage = 1
loadList()
}
function handleConditionReset() {
currentConditionRaw.value = null
pagination.currentPage = 1
if (scanBox.value?.reset) {
scanBox.value.reset()
} else if (scanBox.value?.clear) {
scanBox.value.clear()
}
loadList()
}
function handlePageChange(page: number) {
pagination.currentPage = page
loadList()
}
function handlePageSizeChange(size: number) {
pagination.pageSize = size
pagination.currentPage = 1
loadList()
}
function openCreate() {
formDialogMode.value = 'create'
editingRecord.value = null
formDialogVisible.value = true
}
function openEdit(row: ComboGoodsRecord) {
if (!row.id) return
formDialogMode.value = 'edit'
editingRecord.value = row
formDialogVisible.value = true
}
function handleDelete(row: ComboGoodsRecord) {
if (!row.id) return
const name = row.combo_name || row.combo_code || String(row.id)
ElMessageBox.confirm(`确认删除组合商品「${name}」吗?(软删除,状态置为停用)`, '提示', {
type: 'warning'
})
.then(async () => {
const res: any = await comboGoodsDelete({ id: row.id as number })
if (!isComboGoodsApiSuccess(res)) {
ElMessage.error(res?.message || '删除失败')
return
}
ElMessage.success('删除成功')
if (tableData.value.length === 1 && pagination.currentPage > 1) {
pagination.currentPage -= 1
}
loadList()
})
.catch(() => undefined)
}
onMounted(() => {
loadList()
})
</script>
<style lang="scss" scoped>
.combo-stock-container {
display: flex;
width: 100%;
background-color: #f0f2f5;
.main-content {
flex: 1;
display: flex;
flex-direction: column;
padding: 10px;
overflow: hidden;
min-width: 0;
}
.toolbar {
padding: 5px 8px;
border-bottom: 1px solid #ebeef5;
display: flex;
justify-content: space-between;
align-items: center;
gap: 12px;
flex-wrap: wrap;
background-color: #fff;
flex-shrink: 0;
}
.toolbar-left,
.toolbar-right {
display: flex;
align-items: center;
gap: 8px;
flex-wrap: wrap;
}
.upper-wrapper {
flex: 1 1 auto;
min-height: 0;
overflow: hidden;
}
.upper-wrapper :deep(.upper-table-container) {
height: 100%;
}
.empty-tip {
text-align: center;
font-size: 13px;
color: #909399;
padding: 16px;
}
}
</style>

View File

@ -3,9 +3,9 @@
<!-- 筛选区域 -->
<scan-box
ref="scanBox"
width="250px"
:tree-props="{ children: 'children', label: 'label' }"
:auto-submit="false"
:width="stockScanBoxConfig.width"
:tree-props="stockScanBoxConfig.treeProps"
:auto-submit="stockScanBoxConfig.autoSubmit"
:preset-tree="presetTree"
:available-fields="availableFields"
@condition-change="handleConditionChange"
@ -160,8 +160,8 @@
<el-drawer v-model="drawer" :with-header="false" direction="rtl" size="800px">
<Add
v-if="drawer"
:stores="(availableFields[0] as any).options"
:prohibited_type="(availableFields[3] as any).options"
:stores="storeFieldOptions"
:prohibited_type="prohibitedTypeFieldOptions"
@saved="handleSaved"
@update-prohibited-types="handleUpdateProhibitedTypes"
/>
@ -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
}

View File

@ -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<G extends StockScanFieldGroupKey>(
group: G,
field: Record<string, any>
) {
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: '结束时间'
}),
]
// 批量操作配置

View File

@ -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<G extends EntryScanFieldGroupKey>(
group: G,
field: Record<string, any>
) {
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<string, string> = {
@ -142,4 +217,4 @@ export const addEntryFields = [
{ label: '入库单号', prop: 'entry_order_code' },
{ label: '采购单号', prop: 'purchase_order_code' },
{ label: '备注', prop: 'remark', type: 'textarea' }
]
]

View File

@ -2,9 +2,9 @@
<div class="storage-entry-container">
<scan-box
ref="scanBox"
width="250px"
:tree-props="{ children: 'children', label: 'label' }"
:auto-submit="false"
:width="entryScanBoxConfig.width"
:tree-props="entryScanBoxConfig.treeProps"
:auto-submit="entryScanBoxConfig.autoSubmit"
:initial-conditions="initialConditions"
:preset-tree="presetTree"
:available-fields="availableFieldsRef"
@ -173,7 +173,8 @@ import * as XLSX from 'xlsx'
import {
availableFields,
entryColums,
addEntryFields
addEntryFields,
entryScanBoxConfig
} from './entry-config'
import entrydetail from './component/entrydetail.vue'

View File

@ -2,9 +2,9 @@
<div class="storage-entry-container">
<scan-box
ref="scanBox"
width="250px"
:tree-props="{ children: 'children', label: 'label' }"
:auto-submit="false"
:width="inventoryScanBoxConfig.width"
:tree-props="inventoryScanBoxConfig.treeProps"
:auto-submit="inventoryScanBoxConfig.autoSubmit"
:preset-tree="presetTree"
:available-fields="availableFieldsRef"
@condition-change="handleConditionChange"
@ -200,6 +200,7 @@ import {
formatInventoryTypeLabel,
inventoryExportColumns,
isInventoryFlagEnabled,
inventoryScanBoxConfig,
productstockColums,
} from './inventory-config'
import { exportUpperTableRows } from '@/views/order/orderManagement/utils/export'

View File

@ -1,27 +1,56 @@
/** ScanBox 筛选字段分组(库存模块专用) */
export const INVENTORY_SCAN_FIELD_GROUPS = {
product: '商品信息',
location: '库位信息',
owner: '货主信息',
inventory: '库存属性',
time: '时间范围',
} as const
type InventoryScanFieldGroupKey = keyof typeof INVENTORY_SCAN_FIELD_GROUPS
export function inventoryScanField<G extends InventoryScanFieldGroupKey>(
group: G,
field: Record<string, any>
) {
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<string, any> | null, fallback = ''): string {
if (!space || typeof space !== 'object') return fallback

View File

@ -7,14 +7,14 @@
</div>
</div>
<el-alert
<!-- <el-alert
type="info"
:closable="false"
show-icon
class="api-tip"
title="storage.management.replenishmentDemand"
description="接口自动从用户上下文获取仓库,查询参数仅支持分页(page / pageSize)与排序(sortField / sortOrder)。"
/>
/> -->
<el-card shadow="never" class="query-card">
<el-form

View File

@ -1,6 +1,9 @@
<template>
<div class="storage-receiving-container" :style="{ height: containerHeight }">
<scan-box ref="scanBox" width="250px" :tree-props="{ children: 'children', label: 'label' }" :auto-submit="false"
<scan-box ref="scanBox"
:width="receivingScanBoxConfig.width"
:tree-props="receivingScanBoxConfig.treeProps"
:auto-submit="receivingScanBoxConfig.autoSubmit"
:initial-conditions="initialConditions" :preset-tree="presetTree" :available-fields="availableFieldsRef"
@condition-change="handleConditionChange" @reset="handleConditionReset" @condition-clear="handleConditionClear"
@submit="handleSubmit" />
@ -322,7 +325,8 @@ import {
deliveryMethodConfig,
loadingMethodConfig,
addReceivingFields,
receivingToolbarButtons
receivingToolbarButtons,
receivingScanBoxConfig
} from './receiving-config'
import * as XLSX from 'xlsx'
import { useVerticalSplitPane } from '@/composables/useVerticalSplitPane'

View File

@ -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<G extends ReceivingScanFieldGroupKey>(
group: G,
field: Record<string, any>
) {
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 = [

View File

@ -2,9 +2,9 @@
<div class="storage-report-container" :style="{ height: containerHeight }">
<scan-box
ref="scanBox"
width="250px"
:tree-props="{ children: 'children', label: 'label' }"
:auto-submit="false"
:width="reportScanBoxConfig.width"
:tree-props="reportScanBoxConfig.treeProps"
:auto-submit="reportScanBoxConfig.autoSubmit"
:preset-tree="presetTree"
:available-fields="availableFieldsRef"
@condition-change="handleConditionChange"
@ -136,6 +136,7 @@ import {
normalizeScanConditionToReportWhere,
reportFieldLabels,
reportScanBoxAvailableFields,
reportScanBoxConfig,
sortReportDetailKeys
} from './report-config'
import { useSettingsStore } from '@/stores/modules/settings'

View File

@ -168,16 +168,39 @@ function normalizeReportEndDateParam(value: unknown): string | undefined {
return d.isValid() ? d.endOf('day').format('YYYY-MM-DD HH:mm:ss') : String(value)
}
/** ScanBox 筛选字段分组(库存报表模块专用) */
export const REPORT_SCAN_FIELD_GROUPS = {
time: '统计配置',
owner: '货主信息',
options: '统计选项',
} as const
type ReportScanFieldGroupKey = keyof typeof REPORT_SCAN_FIELD_GROUPS
export function reportScanField<G extends ReportScanFieldGroupKey>(
group: G,
field: Record<string, any>
) {
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;无有效条件时返回 {} */

View File

@ -2,9 +2,9 @@
<div class="storage-stockout-container">
<scan-box
ref="scanBox"
width="250px"
:tree-props="{ children: 'children', label: 'label' }"
:auto-submit="false"
:width="stockoutScanBoxConfig.width"
:tree-props="stockoutScanBoxConfig.treeProps"
:auto-submit="stockoutScanBoxConfig.autoSubmit"
:initial-conditions="initialConditions"
:preset-tree="presetTree"
:available-fields="availableFieldsRef"
@ -124,7 +124,8 @@ import {
entryColums,
statusConfig,
syncStatusConfig,
formatStockoutData
formatStockoutData,
stockoutScanBoxConfig
} from './stockout-config'
import stockoutdetail from './component/stockoutdetail.vue'

View File

@ -1,4 +1,29 @@
// status 实际值(接口存在拼写:pedding)
export const STOCKOUT_SCAN_FIELD_GROUPS = {
order: '单据信息',
status: '单据状态',
owner: '货主信息',
receiver: '收货信息',
logistics: '物流信息',
time: '时间范围',
} as const
type StockoutScanFieldGroupKey = keyof typeof STOCKOUT_SCAN_FIELD_GROUPS
export function stockoutScanField<G extends StockoutScanFieldGroupKey>(
group: G,
field: Record<string, any>
) {
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<string, { text: string; tagType: string }> = {
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: '结束时间'
})
]
// 详情面板表单配置

View File

@ -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
}
}
]
```

View File

@ -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 | |

View File

@ -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/<folder>/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/<folder>/module.json`(只读取本次涉及 folder)
- 按需选读:`src/api/<module>/...`(只读取本次涉及模块的文件)
- 条件读取:`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/<f>/`(且内含至少一个 `.ts` 作为该模块 API 入口层,文件名按项目既有约定即可)。
- 对任意 `src/api` 下一级目录 `d`,必须满足 `d ∈ M`;**禁止**出现文档中不存在的杂项目录(例如历史上合并用的裸 `order/` 若不在 `M` 中则必须迁出并删除空目录)。
5. **接口归属**:`data/module/<folder>/module.json` 中列出的每个接口,其 **`method` 的封装实现必须位于 `src/api/<folder>/` 下的 `.ts` 文件内**(`params` 等与 `module.json` 一致)。**禁止**把某 `folder` 文档模块下的接口长期写在另一个 `folder` 目录下(例如某接口在文档中归在 `setting.express`,则不得仅写在 `index/` 下;应放在 `src/api/setting.express/` 或按项目规范再分子路径,但首段目录名仍为 `setting.express`)。
6. **迁出合并代码**:若发现多个文档 `folder` 的接口被写在同一历史文件(如 `order/order.ts`),必须按 `folder` **拆分目录与文件**,并同步修正业务侧 `import`(至少全局检索旧路径并更新到 `src/api/<folder>/...`)。
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/<folder>/`、将误放接口迁回对应 `<folder>`、删除或改名不在 `M` 中的目录,直至 `D = M`;再处理接口级增删改。
4. 若 `pending-updates.json` 存在变更项(接口增删、`Params/Response` 变化),按“增删优先”原则更新 `src/api`:
- 新增/更新:只读对应 `folder` 的 `module.json` 中本次涉及条目(含 Params),**仅在** `src/api/<folder>/` 下增改 `.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/<folder>/module.json` 中的每个 `method` 要么(a)在 `src/api/<folder>/` 下某 `.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` 执行状态

View File

@ -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. 给出接口维度与页面维度的通过率统计。

View File

@ -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/<folder>/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 <token>`。
数据文件:`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/`,减少根目录散落文件。
- 采用覆盖写入模式,避免重复历史文件导致目录混乱与资源浪费。

View File

@ -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",
"查询成功",
"获取成功"
]
}

View File

@ -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;
}

View File

@ -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
}
}
]
}

View File

@ -1 +0,0 @@
import "./core/clear-pending.mjs";

View File

@ -1 +0,0 @@
export { API_DOC_SYSTEM_CONFIG } from "./core/config.mjs";

File diff suppressed because it is too large Load Diff

View File

@ -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;
});

View File

@ -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"),
},
};

View File

@ -1 +0,0 @@
import "../update.mjs";

View File

@ -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
}

File diff suppressed because it is too large Load Diff

View File

@ -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
}

View File

@ -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": "成功时返回的结果对象"
}
]
}
]
}

View File

@ -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
}

View File

@ -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": "成功时返回的趋势数据对象"
}
]
}
]
}

View File

@ -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
}

View File

@ -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_<rawCode>。当前仅支持已按上述模式配置好的基础授权链接。",
"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_<rawCode>。当前仅支持已按上述模式配置好的基础授权链接。",
"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。"
}
]
}
]
}

View File

@ -1,5 +0,0 @@
{
"folder": "order.archiveorder",
"deletedAt": "2026-04-17 17:28:24",
"reason": "Missing from latest API doc parsing result"
}

View File

@ -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"
}

View File

@ -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": "去重后的运单号字符串数组"
}
]
}
]
}

View File

@ -1,5 +0,0 @@
{
"folder": "order.deliveryexpectionorder",
"deletedAt": "2026-04-17 17:28:24",
"reason": "Missing from latest API doc parsing result"
}

View File

@ -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"
}

View File

@ -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": "去重后的运单号字符串数组"
}
]
}
]
}

View File

@ -1,5 +0,0 @@
{
"folder": "order.deliveryorder",
"deletedAt": "2026-04-17 17:28:24",
"reason": "Missing from latest API doc parsing result"
}

View File

@ -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"
}

View File

@ -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": "去重后的运单号字符串数组"
}
]
}
]
}

View File

@ -1,5 +0,0 @@
{
"folder": "order.entrustorder",
"deletedAt": "2026-04-17 17:28:24",
"reason": "Missing from latest API doc parsing result"
}

View File

@ -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"
}

View File

@ -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": "去重后的运单号字符串数组"
}
]
}
]
}

View File

@ -1,5 +0,0 @@
{
"folder": "order.expectionorder",
"deletedAt": "2026-04-17 17:28:24",
"reason": "Missing from latest API doc parsing result"
}

View File

@ -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"
}

View File

@ -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 列表"
}
]
}
]
}

View File

@ -1,5 +0,0 @@
{
"folder": "order.index",
"deletedAt": "2026-04-17 17:28:24",
"reason": "Missing from latest API doc parsing result"
}

View File

@ -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"
}

View File

@ -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 字符串)"
}
]
}
]
}

View File

@ -1,5 +0,0 @@
{
"folder": "order.outboundorder",
"deletedAt": "2026-04-17 17:28:24",
"reason": "Missing from latest API doc parsing result"
}

View File

@ -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"
}

View File

@ -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 等字段"
}
]
}
]
}

View File

@ -1,5 +0,0 @@
{
"folder": "order.pendingorder",
"deletedAt": "2026-04-17 17:28:24",
"reason": "Missing from latest API doc parsing result"
}

View File

@ -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"
}

View File

@ -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
}

View File

@ -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": "扩展字段"
}
]
}
]
}

View File

@ -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
}

View File

@ -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<number>|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"
}
]
}
]
}

View File

@ -1,5 +0,0 @@
{
"folder": "order.revieworder",
"deletedAt": "2026-04-17 17:28:24",
"reason": "Missing from latest API doc parsing result"
}

View File

@ -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"
}

View File

@ -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 列表"
}
]
}
]
}

View File

@ -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
}

File diff suppressed because it is too large Load Diff

View File

@ -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
}

View File

@ -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": "创建时间"
}
]
}
]
}

View File

@ -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
}

View File

@ -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": "任务订单拣货进度统计"
}
]
}
]
}

View File

@ -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
}

View File

@ -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"
}
]
}
]
}

View File

@ -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
}

View File

@ -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": []
}
]
}

View File

@ -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
}

View File

@ -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": []
}
]
}

View File

@ -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
}

View File

@ -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": []
}
]
}

View File

@ -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
}

View File

@ -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'"
}
]
}
]
}

View File

@ -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
}

Some files were not shown because too many files have changed in this diff Show More