2026-04-16 20:59:44 +08:00

7356 lines
203 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"generatedAt": "2026-04-16 20:30:46",
"generatedAtLocal": "2026-04-16 20:30:46",
"source": "remote",
"filter": {
"platform": {
"value": "web",
"label": "网页端"
},
"project": {
"value": "all",
"label": "全部"
}
},
"totalInterfaceCount": 169,
"changes": {
"summary": {
"moduleAdded": 0,
"moduleDeleted": 0,
"moduleUpdated": 0,
"interfaceAdded": 0,
"interfaceDeleted": 0,
"interfaceParamsUpdated": 0,
"interfaceResponseUpdated": 0
},
"moduleUpdates": {
"added": [],
"deleted": [],
"updated": []
},
"interfaceUpdates": {
"added": [],
"deleted": [],
"paramsUpdated": [],
"responseUpdated": []
}
},
"interfaces": [
{
"moduleName": "配置模块",
"moduleKey": "config",
"moduleFolder": "config",
"method": "config.list",
"title": "config.list 接口",
"description": "config.list 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "看板模块",
"moduleKey": "dashboard",
"moduleFolder": "dashboard",
"method": "dashboard.express_ratio",
"title": "dashboard.express_ratio 接口",
"description": "dashboard.express_ratio 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "看板模块",
"moduleKey": "dashboard",
"moduleFolder": "dashboard",
"method": "dashboard.hot_order_rank",
"title": "dashboard.hot_order_rank 接口",
"description": "dashboard.hot_order_rank 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "看板模块",
"moduleKey": "dashboard",
"moduleFolder": "dashboard",
"method": "dashboard.order_trend",
"title": "dashboard.order_trend 接口",
"description": "dashboard.order_trend 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "看板模块",
"moduleKey": "dashboard",
"moduleFolder": "dashboard",
"method": "dashboard.platform_distribution",
"title": "dashboard.platform_distribution 接口",
"description": "dashboard.platform_distribution 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "看板模块",
"moduleKey": "dashboard",
"moduleFolder": "dashboard",
"method": "dashboard.storeStats",
"title": "dashboard.storeStats 接口",
"description": "dashboard.storeStats 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "看板模块",
"moduleKey": "dashboard",
"moduleFolder": "dashboard",
"method": "dashboard.warehouseStats",
"title": "dashboard.warehouseStats 接口",
"description": "dashboard.warehouseStats 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.fastWhereTree",
"title": "index.fastWhereTree 接口",
"description": "index.fastWhereTree 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "type",
"type": "string",
"required": false,
"description": "type 参数"
}
],
"response": []
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.getCOSUploadConfig",
"title": "index.getCOSUploadConfig 接口",
"description": "index.getCOSUploadConfig 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "data",
"type": "object",
"required": false,
"description": "data 参数"
}
],
"response": []
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.getExpressList",
"title": "index.getExpressList 接口",
"description": "index.getExpressList 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [],
"response": []
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.getI18nMessage",
"title": "index.getI18nMessage 接口",
"description": "index.getI18nMessage 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": false,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [
{
"name": "language",
"type": "string",
"required": false,
"description": "language 参数"
}
],
"response": []
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.getImages",
"title": "index.getImages 接口",
"description": "index.getImages 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.getMessageDetail",
"title": "index.getMessageDetail 接口",
"description": "index.getMessageDetail 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.getPlatformList",
"title": "index.getPlatformList 接口",
"description": "index.getPlatformList 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [],
"response": []
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.listInterfaceTypes",
"title": "查询可用的接口类型列表(如奇门仓储、开放接口等)",
"description": "查询可用的接口类型列表(如奇门仓储、开放接口等)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [],
"response": []
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.loadStores",
"title": "index.loadStores 接口",
"description": "index.loadStores 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.putI18nCollect",
"title": "index.putI18nCollect 接口",
"description": "index.putI18nCollect 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": false,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [
{
"name": "keys",
"type": "array",
"required": false,
"description": "keys 参数"
},
{
"name": "locale",
"type": "string",
"required": false,
"description": "locale 参数"
},
{
"name": "project",
"type": "string",
"required": false,
"description": "project 参数"
},
{
"name": "source",
"type": "string",
"required": false,
"description": "source 参数"
}
],
"response": []
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.recognizeLicensePlate",
"title": "识别车牌号码(通过 base64 图片)",
"description": "识别车牌号码(通过 base64 图片)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "base64",
"type": "string",
"required": true,
"description": "base64 图片,支持 data URL 前缀(data:image/...;base64,)或纯 base64 字符串"
},
{
"name": "imageBase64",
"type": "string",
"required": false,
"description": "兼容字段(同 base64)"
},
{
"name": "image_base64",
"type": "string",
"required": false,
"description": "兼容字段(同 base64)"
}
],
"response": [
{
"name": "licensePlate",
"type": "string",
"required": false,
"description": "识别到的车牌号(对外契约,仅返回该字段)"
}
]
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.ReferenceFile",
"title": "index.ReferenceFile 接口",
"description": "index.ReferenceFile 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.searchSpace",
"title": "按当前仓库上下文搜索库位(使用 ctx.user.store_id;仅在 location_space 表中按 space_code/custom_barcode 搜索)",
"description": "按当前仓库上下文搜索库位(使用 ctx.user.store_id;仅在 location_space 表中按 space_code/custom_barcode 搜索)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "keyword",
"type": "string",
"required": false,
"description": "搜索关键字,对 space_code 和 custom_barcode 做模糊匹配(%keyword%);为空时返回当前仓库下前 50 条"
}
],
"response": [
{
"name": "flag",
"type": "string",
"required": false,
"description": "全局调用结果标识,成功时为 success"
},
{
"name": "code",
"type": "number",
"required": false,
"description": "业务状态码,200 表示成功"
},
{
"name": "message",
"type": "string",
"required": false,
"description": "返回信息"
},
{
"name": "data",
"type": "array",
"required": false,
"description": "库位数组(最多 50 条),每项包含以下字段"
},
{
"name": "total",
"type": "number",
"required": false,
"description": "本次返回的记录条数(等于 data.length,≤50)"
}
]
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.tryAutoTranslateNewKeys",
"title": "index.tryAutoTranslateNewKeys 接口",
"description": "index.tryAutoTranslateNewKeys 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "基础模块",
"moduleKey": "index",
"moduleFolder": "index",
"method": "index.uploadSuccessNotify",
"title": "index.uploadSuccessNotify 接口",
"description": "index.uploadSuccessNotify 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "订单归档模块",
"moduleKey": "order.archiveOrder",
"moduleFolder": "order.archiveorder",
"method": "order.archiveOrder.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": "分页信息"
}
]
},
{
"moduleName": "订单工作台入口模块",
"moduleKey": "order.index",
"moduleFolder": "order.index",
"method": "order.badgeCount",
"title": "订单工作台各标签页角标计数,基于当前仓库上下文返回。配送、配送异常与归档标签固定返回 99+。",
"description": "订单工作台各标签页角标计数,基于当前仓库上下文返回。配送、配送异常与归档标签固定返回 99+。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": [
{
"name": "reviewOrder",
"type": "number|string",
"required": true,
"description": "待审核角标"
},
{
"name": "pendingOrder",
"type": "number|string",
"required": true,
"description": "待处理角标"
},
{
"name": "outboundOrder",
"type": "number|string",
"required": true,
"description": "待出库角标"
},
{
"name": "expectionOrder",
"type": "number|string",
"required": true,
"description": "待处理异常角标"
},
{
"name": "entrustOrder",
"type": "number|string",
"required": true,
"description": "委托外仓角标"
},
{
"name": "deliveryOrder",
"type": "string",
"required": true,
"description": "配送角标,固定返回 99+"
},
{
"name": "deliveryExpectionOrder",
"type": "string",
"required": true,
"description": "配送异常角标,固定返回 99+"
},
{
"name": "archiveOrder",
"type": "string",
"required": true,
"description": "归档角标,固定返回 99+"
}
]
},
{
"moduleName": "订单配送异常模块",
"moduleKey": "order.deliveryExpectionOrder",
"moduleFolder": "order.deliveryexpectionorder",
"method": "order.deliveryExpectionOrder.list",
"title": "配送异常订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m5。",
"description": "配送异常订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m5。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页参数,支持 page / pageSize"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息"
}
]
},
{
"moduleName": "订单配送模块",
"moduleKey": "order.deliveryOrder",
"moduleFolder": "order.deliveryorder",
"method": "order.deliveryOrder.list",
"title": "配送订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m4。",
"description": "配送订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m4。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页参数,支持 page / pageSize"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息"
}
]
},
{
"moduleName": "订单委托外仓模块",
"moduleKey": "order.entrustOrder",
"moduleFolder": "order.entrustorder",
"method": "order.entrustOrder.list",
"title": "委托外仓订单列表,使用 outsourced 模型。",
"description": "委托外仓订单列表,使用 outsourced 模型。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页参数,支持 page / pageSize"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息"
}
]
},
{
"moduleName": "订单异常模块",
"moduleKey": "order.expectionOrder",
"moduleFolder": "order.expectionorder",
"method": "order.expectionOrder.list",
"title": "待处理异常订单列表,默认仅查询 step=3 的订单。",
"description": "待处理异常订单列表,默认仅查询 step=3 的订单。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页参数,支持 page / pageSize"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息"
}
]
},
{
"moduleName": "订单工作台入口模块",
"moduleKey": "order.index",
"moduleFolder": "order.index",
"method": "order.list",
"title": "订单工作台总列表入口,查询当前登录用户仓库上下文下的订单总列表,支持 pagination / where / sort。",
"description": "订单工作台总列表入口,查询当前登录用户仓库上下文下的订单总列表,支持 pagination / where / sort。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页参数,支持 page / pageSize,兼容 currentPage / page_size / size"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会自动标准化;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
}
]
},
{
"moduleName": "订单工作台入口模块",
"moduleKey": "order.index",
"moduleFolder": "order.index",
"method": "order.manualOutboundOrder",
"title": "手动触发出库迁移,将当前仓库内已出库订单同步到配送表。请求体直接透传给 orderDeliveryMigration.syncOutboundOrdersToDelivery。",
"description": "手动触发出库迁移,将当前仓库内已出库订单同步到配送表。请求体直接透传给 orderDeliveryMigration.syncOutboundOrdersToDelivery。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouseId",
"type": "number",
"required": false,
"description": "单仓库ID,兼容 warehouse_id"
},
{
"name": "warehouseIds",
"type": "array",
"required": false,
"description": "仓库ID 数组"
},
{
"name": "queryTimeoutMs",
"type": "number",
"required": false,
"description": "查询超时时间(毫秒)"
},
{
"name": "executionTimeoutMs",
"type": "number",
"required": false,
"description": "执行超时时间(毫秒)"
}
],
"response": [
{
"name": "warehouseIds",
"type": "array",
"required": true,
"description": "参与迁移的仓库ID列表"
},
{
"name": "batchSize",
"type": "number",
"required": true,
"description": "单批处理上限,当前固定为 1000"
},
{
"name": "outboundStatuses",
"type": "array",
"required": true,
"description": "本次迁移匹配的出库状态"
},
{
"name": "totalSelected",
"type": "number",
"required": true,
"description": "命中的源订单数量"
},
{
"name": "totalCreated",
"type": "number",
"required": true,
"description": "实际创建到配送表的订单数量"
},
{
"name": "totalSkipped",
"type": "number",
"required": true,
"description": "本次跳过的源订单数量"
},
{
"name": "totalTimeout",
"type": "number",
"required": true,
"description": "被标记为出库超时的订单数量"
},
{
"name": "results",
"type": "array",
"required": true,
"description": "按仓库维度返回的批次结果数组,元素包含 selectedCount、createdCount、skippedCount、timeoutCount、retryableFailure 等字段"
}
]
},
{
"moduleName": "订单待出库模块",
"moduleKey": "order.outboundOrder",
"moduleFolder": "order.outboundorder",
"method": "order.outboundOrder.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": "分页信息"
}
]
},
{
"moduleName": "订单待出库模块",
"moduleKey": "order.outboundOrder",
"moduleFolder": "order.outboundorder",
"method": "order.outboundOrder.manualOutboundOrder",
"title": "待出库模块的手动出库入口,行为与 order.manualOutboundOrder 一致。",
"description": "待出库模块的手动出库入口,行为与 order.manualOutboundOrder 一致。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouseId",
"type": "number",
"required": false,
"description": "单仓库ID,兼容 warehouse_id"
},
{
"name": "warehouseIds",
"type": "array",
"required": false,
"description": "仓库ID 数组"
},
{
"name": "queryTimeoutMs",
"type": "number",
"required": false,
"description": "查询超时时间(毫秒)"
},
{
"name": "executionTimeoutMs",
"type": "number",
"required": false,
"description": "执行超时时间(毫秒)"
}
],
"response": [
{
"name": "warehouseIds",
"type": "array",
"required": true,
"description": "参与迁移的仓库ID列表"
},
{
"name": "batchSize",
"type": "number",
"required": true,
"description": "单批处理上限,当前固定为 1000"
},
{
"name": "outboundStatuses",
"type": "array",
"required": true,
"description": "本次迁移匹配的出库状态"
},
{
"name": "totalSelected",
"type": "number",
"required": true,
"description": "命中的源订单数量"
},
{
"name": "totalCreated",
"type": "number",
"required": true,
"description": "实际创建到配送表的订单数量"
},
{
"name": "totalSkipped",
"type": "number",
"required": true,
"description": "本次跳过的源订单数量"
},
{
"name": "totalTimeout",
"type": "number",
"required": true,
"description": "被标记为出库超时的订单数量"
},
{
"name": "results",
"type": "array",
"required": true,
"description": "按仓库维度返回的批次结果数组,元素包含 selectedCount、createdCount、skippedCount、timeoutCount、retryableFailure 等字段"
}
]
},
{
"moduleName": "订单待处理模块",
"moduleKey": "order.pendingOrder",
"moduleFolder": "order.pendingorder",
"method": "order.pendingOrder.cancelOrder",
"title": "将待处理订单批量取消,仅允许当前状态可取消的订单。",
"description": "将待处理订单批量取消,仅允许当前状态可取消的订单。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": true,
"description": "订单 ID 正整数数组;不支持 id、order_id 或逗号字符串"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "首条更新记录 ID"
},
{
"name": "status",
"type": "string",
"required": true,
"description": "新的订单状态"
},
{
"name": "step",
"type": "number",
"required": true,
"description": "新的流程步骤"
},
{
"name": "updated_at",
"type": "string",
"required": true,
"description": "更新时间"
},
{
"name": "updated_count",
"type": "number",
"required": true,
"description": "受影响行数"
},
{
"name": "ids",
"type": "array",
"required": true,
"description": "实际更新的订单 ID 列表"
}
]
},
{
"moduleName": "订单待处理模块",
"moduleKey": "order.pendingOrder",
"moduleFolder": "order.pendingorder",
"method": "order.pendingOrder.list",
"title": "待处理订单列表,默认筛选 outbound_status != padding 且 step in [1,2]。",
"description": "待处理订单列表,默认筛选 outbound_status != padding 且 step in [1,2]。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页参数,支持 page / pageSize"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息"
}
]
},
{
"moduleName": "订单待处理模块",
"moduleKey": "order.pendingOrder",
"moduleFolder": "order.pendingorder",
"method": "order.pendingOrder.markPendingOutboundOrder",
"title": "将待处理订单批量标记为待出库。",
"description": "将待处理订单批量标记为待出库。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": true,
"description": "订单 ID 正整数数组;不支持 id、order_id 或逗号字符串"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "首条更新记录 ID"
},
{
"name": "outbound_status",
"type": "string",
"required": true,
"description": "新的出库状态"
},
{
"name": "updated_at",
"type": "string",
"required": true,
"description": "更新时间"
},
{
"name": "updated_count",
"type": "number",
"required": true,
"description": "受影响行数"
},
{
"name": "ids",
"type": "array",
"required": true,
"description": "实际更新的订单 ID 列表"
}
]
},
{
"moduleName": "订单待处理模块",
"moduleKey": "order.pendingOrder",
"moduleFolder": "order.pendingorder",
"method": "order.pendingOrder.reverseReviewOrder",
"title": "将待处理订单反审回待审核状态。",
"description": "将待处理订单反审回待审核状态。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": false,
"description": "订单 ID 列表;兼容 ids / id / order_id,建议传 ids"
},
{
"name": "id",
"type": "number",
"required": false,
"description": "兼容单个订单 ID"
},
{
"name": "order_id",
"type": "number",
"required": false,
"description": "兼容单个订单 ID"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "首条更新记录 ID"
},
{
"name": "inspection_status",
"type": "string",
"required": true,
"description": "新的审核状态"
},
{
"name": "step",
"type": "number",
"required": true,
"description": "新的流程步骤"
},
{
"name": "updated_at",
"type": "string",
"required": true,
"description": "更新时间"
},
{
"name": "updated_count",
"type": "number",
"required": true,
"description": "受影响行数"
},
{
"name": "ids",
"type": "array",
"required": true,
"description": "实际更新的订单 ID 列表"
}
]
},
{
"moduleName": "订单待审核模块",
"moduleKey": "order.reviewOrder",
"moduleFolder": "order.revieworder",
"method": "order.reviewOrder.list",
"title": "待审核订单列表,默认仅查询 step=0 的订单。",
"description": "待审核订单列表,默认仅查询 step=0 的订单。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页参数,支持 page / pageSize"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息"
}
]
},
{
"moduleName": "订单待审核模块",
"moduleKey": "order.reviewOrder",
"moduleFolder": "order.revieworder",
"method": "order.reviewOrder.reviewOrder",
"title": "批量审核通过订单并进入待处理。",
"description": "批量审核通过订单并进入待处理。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": true,
"description": "订单 ID 数组;仅允许 ids 字段,建议传数组,也兼容逗号字符串或单值"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "首条更新记录 ID"
},
{
"name": "inspection_status",
"type": "string",
"required": true,
"description": "新的审核状态"
},
{
"name": "step",
"type": "number",
"required": true,
"description": "新的流程步骤"
},
{
"name": "updated_at",
"type": "string",
"required": true,
"description": "更新时间"
},
{
"name": "updated_count",
"type": "number",
"required": true,
"description": "受影响行数"
},
{
"name": "ids",
"type": "array",
"required": true,
"description": "实际更新的订单 ID 列表"
}
]
},
{
"moduleName": "打印模块",
"moduleKey": "print",
"moduleFolder": "print",
"method": "print.add",
"title": "print.add 接口",
"description": "print.add 接口",
"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": "computer_id 参数"
},
{
"name": "name",
"type": "string",
"required": true,
"description": "name 参数"
},
{
"name": "custom_barcode",
"type": "string",
"required": false,
"description": "custom_barcode 参数"
},
{
"name": "default_printer_name",
"type": "string",
"required": false,
"description": "default_printer_name 参数"
}
],
"response": []
},
{
"moduleName": "打印模块",
"moduleKey": "print",
"moduleFolder": "print",
"method": "print.del",
"title": "print.del 接口",
"description": "print.del 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": false,
"description": "ids 参数"
}
],
"response": []
},
{
"moduleName": "打印模块",
"moduleKey": "print",
"moduleFolder": "print",
"method": "print.getComputer",
"title": "print.getComputer 接口",
"description": "print.getComputer 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "打印模块",
"moduleKey": "print",
"moduleFolder": "print",
"method": "print.getComputerPrinter",
"title": "print.getComputerPrinter 接口",
"description": "print.getComputerPrinter 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"moduleName": "打印模块",
"moduleKey": "print",
"moduleFolder": "print",
"method": "print.getItem",
"title": "print.getItem 接口",
"description": "print.getItem 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"moduleName": "打印模块",
"moduleKey": "print",
"moduleFolder": "print",
"method": "print.getList",
"title": "print.getList 接口",
"description": "print.getList 接口",
"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": "page 参数"
},
{
"name": "pageSize",
"type": "number",
"required": false,
"description": "pageSize 参数"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;当前支持 id、name、computer_id、custom_barcode。示例:where.name={operator:like,value:热敏}; where.computer_id={operator:eq,value:PC-01}。"
}
],
"response": []
},
{
"moduleName": "打印模块",
"moduleKey": "print",
"moduleFolder": "print",
"method": "print.getPrintRecordItem",
"title": "print.getPrintRecordItem 接口",
"description": "print.getPrintRecordItem 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"moduleName": "打印模块",
"moduleKey": "print",
"moduleFolder": "print",
"method": "print.getPrintResult",
"title": "print.getPrintResult 接口",
"description": "print.getPrintResult 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "printId",
"type": "string",
"required": true,
"description": "printId 参数"
}
],
"response": []
},
{
"moduleName": "打印模块",
"moduleKey": "print",
"moduleFolder": "print",
"method": "print.hasName",
"title": "print.hasName 接口",
"description": "print.hasName 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "name",
"type": "string",
"required": true,
"description": "name 参数"
},
{
"name": "id",
"type": "number",
"required": false,
"description": "id 参数"
}
],
"response": []
},
{
"moduleName": "打印模块",
"moduleKey": "print",
"moduleFolder": "print",
"method": "print.savePrinters",
"title": "print.savePrinters 接口",
"description": "print.savePrinters 接口",
"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": "defaultPrinter 参数"
},
{
"name": "express",
"type": "array",
"required": false,
"description": "express 参数"
},
{
"name": "print_station_id",
"type": "number",
"required": false,
"description": "print_station_id 参数"
}
],
"response": []
},
{
"moduleName": "打印模块",
"moduleKey": "print",
"moduleFolder": "print",
"method": "print.send",
"title": "print.send 接口",
"description": "print.send 接口",
"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": "computerId 参数"
},
{
"name": "count",
"type": "number",
"required": false,
"description": "count 参数"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "data 参数"
},
{
"name": "printer",
"type": "string",
"required": false,
"description": "printer 参数"
},
{
"name": "template",
"type": "object",
"required": false,
"description": "template 参数"
},
{
"name": "timestamp",
"type": "string",
"required": false,
"description": "timestamp 参数"
},
{
"name": "type",
"type": "string",
"required": false,
"description": "type 参数"
}
],
"response": []
},
{
"moduleName": "打印模块",
"moduleKey": "print",
"moduleFolder": "print",
"method": "print.updateItem",
"title": "print.updateItem 接口",
"description": "print.updateItem 接口",
"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": "computer_id 参数"
},
{
"name": "custom_barcode",
"type": "string",
"required": false,
"description": "custom_barcode 参数"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "name 参数"
}
],
"response": []
},
{
"moduleName": "打印机站点模块",
"moduleKey": "printer.station",
"moduleFolder": "printer.station",
"method": "printer.station.list",
"title": "获取打印站点列表",
"description": "获取打印站点列表",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "账号管理模块",
"moduleKey": "setting.account",
"moduleFolder": "setting.account",
"method": "setting.account.add",
"title": "新增工号,按手机号复用或创建账号后绑定到当前主体",
"description": "新增工号,按手机号复用或创建账号后绑定到当前主体",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "phone",
"type": "string",
"required": true,
"description": "手机号,作为账号复用/创建依据"
},
{
"name": "real_name",
"type": "string",
"required": true,
"description": "工号姓名,新增时禁止直接使用保留名称"
},
{
"name": "username",
"type": "string",
"required": false,
"description": "新账号用户名,不传时系统自动生成"
},
{
"name": "password",
"type": "string",
"required": false,
"description": "新账号密码,不传默认 111111"
},
{
"name": "role_id",
"type": "number",
"required": false,
"description": "工号角色,不传时继承当前操作人工号角色"
},
{
"name": "email",
"type": "string",
"required": false,
"description": "新账号邮箱,不传时按 username 自动生成"
}
],
"response": [
{
"name": "employee_id",
"type": "number",
"required": true,
"description": "新增或复用后的工号ID"
},
{
"name": "account_id",
"type": "number",
"required": true,
"description": "绑定账号ID"
},
{
"name": "role_id",
"type": "number",
"required": true,
"description": "绑定后的角色ID"
},
{
"name": "is_new_account",
"type": "boolean",
"required": true,
"description": "是否为本次新建账号"
},
{
"name": "phone",
"type": "string",
"required": true,
"description": "绑定账号手机号"
},
{
"name": "username",
"type": "string",
"required": true,
"description": "绑定账号用户名"
}
]
},
{
"moduleName": "账号管理模块",
"moduleKey": "setting.account",
"moduleFolder": "setting.account",
"method": "setting.account.delete",
"title": "删除工号绑定关系,仅停用工号,不删除账号",
"description": "删除工号绑定关系,仅停用工号,不删除账号",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "employee_id",
"type": "number",
"required": true,
"description": "要删除的工号ID"
}
],
"response": [
{
"name": "employee_id",
"type": "number",
"required": true,
"description": "被停用的工号ID"
},
{
"name": "account_id",
"type": "number",
"required": true,
"description": "关联账号ID"
},
{
"name": "status",
"type": "string",
"required": true,
"description": "固定返回 deleted"
},
{
"name": "already_deleted",
"type": "boolean",
"required": false,
"description": "可选,true 表示该工号原本已停用"
}
]
},
{
"moduleName": "账号管理模块",
"moduleKey": "setting.account",
"moduleFolder": "setting.account",
"method": "setting.account.getBindWechatCode",
"title": "为指定工号账号获取微信绑定码",
"description": "为指定工号账号获取微信绑定码",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "account_id",
"type": "number",
"required": true,
"description": "目标账号ID,兼容 user_id / id"
},
{
"name": "longPoll",
"type": "boolean",
"required": false,
"description": "是否开启长轮询等待状态变化,最长60秒"
},
{
"name": "waitTimeoutMs",
"type": "number",
"required": false,
"description": "等待超时毫秒数,后端自动封顶60000"
}
],
"response": []
},
{
"moduleName": "账号管理模块",
"moduleKey": "setting.account",
"moduleFolder": "setting.account",
"method": "setting.account.list",
"title": "查询当前主体下的工号基础信息列表",
"description": "查询当前主体下的工号基础信息列表",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "status",
"type": "number",
"required": false,
"description": "状态筛选,默认 1,仅查有效工号"
},
{
"name": "includeDisabled",
"type": "boolean",
"required": false,
"description": "是否包含已删除工号"
}
],
"response": [
{
"name": "data[]",
"type": "object",
"required": true,
"description": "工号列表项"
},
{
"name": "data[].employee_id",
"type": "number",
"required": true,
"description": "工号ID"
},
{
"name": "data[].account_id",
"type": "number",
"required": true,
"description": "账号ID"
},
{
"name": "data[].store_id",
"type": "number",
"required": true,
"description": "主体ID"
},
{
"name": "data[].real_name",
"type": "string",
"required": true,
"description": "工号姓名"
},
{
"name": "data[].status",
"type": "number",
"required": true,
"description": "工号状态:1=启用,0=停用"
},
{
"name": "data[].username",
"type": "string",
"required": true,
"description": "账号用户名"
},
{
"name": "data[].phone",
"type": "string",
"required": true,
"description": "账号手机号"
},
{
"name": "data[].email",
"type": "string",
"required": true,
"description": "账号邮箱"
},
{
"name": "data[].avatar_file_id",
"type": "number",
"required": false,
"description": "头像文件ID,为空表示未设置"
},
{
"name": "data[].avatar_url",
"type": "string",
"required": true,
"description": "头像访问地址"
}
]
},
{
"moduleName": "账号管理模块",
"moduleKey": "setting.account",
"moduleFolder": "setting.account",
"method": "setting.account.unbindWechat",
"title": "为指定工号账号解绑微信",
"description": "为指定工号账号解绑微信",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "account_id",
"type": "number",
"required": true,
"description": "目标账号ID,兼容 user_id / id"
}
],
"response": []
},
{
"moduleName": "账号管理模块",
"moduleKey": "setting.account",
"moduleFolder": "setting.account",
"method": "setting.account.update",
"title": "更新工号姓名和头像引用",
"description": "更新工号姓名和头像引用",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "employee_id",
"type": "number",
"required": true,
"description": "要更新的工号ID"
},
{
"name": "real_name",
"type": "string",
"required": false,
"description": "更新后的工号姓名"
},
{
"name": "file_id",
"type": "number",
"required": false,
"description": "已有文件ID,作为头像引用"
}
],
"response": [
{
"name": "employee_id",
"type": "number",
"required": true,
"description": "更新后的工号ID"
},
{
"name": "real_name",
"type": "string",
"required": true,
"description": "更新后的工号姓名"
},
{
"name": "avatar_file_id",
"type": "number",
"required": false,
"description": "更新后的头像文件ID"
},
{
"name": "avatar_url",
"type": "string",
"required": true,
"description": "更新后的头像地址"
}
]
},
{
"moduleName": "权限管理模块",
"moduleKey": "setting.permission",
"moduleFolder": "setting.permission",
"method": "setting.permission.add",
"title": "新增权限节点",
"description": "新增权限节点",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "path",
"type": "string",
"required": true,
"description": "权限路径"
},
{
"name": "type",
"type": "string",
"required": true,
"description": "权限类型"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "权限名称"
},
{
"name": "parent_id",
"type": "number",
"required": false,
"description": "父级权限ID"
}
],
"response": []
},
{
"moduleName": "权限管理模块",
"moduleKey": "setting.permission",
"moduleFolder": "setting.permission",
"method": "setting.permission.delete",
"title": "批量停用权限节点",
"description": "批量停用权限节点",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": true,
"description": "待停用的权限ID数组"
}
],
"response": []
},
{
"moduleName": "权限管理模块",
"moduleKey": "setting.permission",
"moduleFolder": "setting.permission",
"method": "setting.permission.list",
"title": "查询权限树/权限列表,可附带指定角色的选中状态",
"description": "查询权限树/权限列表,可附带指定角色的选中状态",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "role_id",
"type": "number",
"required": false,
"description": "角色ID;传入后返回 selected 标记"
},
{
"name": "type",
"type": "string",
"required": false,
"description": "权限类型筛选:web_pages/pda_pages/btns/api/miniprogram_pages/block"
},
{
"name": "keyword",
"type": "string",
"required": false,
"description": "关键字模糊搜索 path/name/meta_title"
},
{
"name": "includeDisabled",
"type": "boolean",
"required": false,
"description": "是否包含已停用权限"
}
],
"response": []
},
{
"moduleName": "权限管理模块",
"moduleKey": "setting.permission",
"moduleFolder": "setting.permission",
"method": "setting.permission.update",
"title": "更新权限节点信息",
"description": "更新权限节点信息",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "permission_id",
"type": "number",
"required": true,
"description": "权限ID"
}
],
"response": []
},
{
"moduleName": "打印模板模块",
"moduleKey": "setting.printTemplate",
"moduleFolder": "setting.printtemplate",
"method": "setting.printTemplate.create",
"title": "创建打印模板(platform 固定为 default,template_type 固定为 CUSTOM,template_url 固定为空字符串)",
"description": "创建打印模板(platform 固定为 default,template_type 固定为 CUSTOM,template_url 固定为空字符串)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "template_name",
"type": "string",
"required": true,
"description": "模板名称"
},
{
"name": "business_type",
"type": "string",
"required": true,
"description": "业务类型"
},
{
"name": "page_width",
"type": "number",
"required": true,
"description": "页面宽度(mm)"
},
{
"name": "page_height",
"type": "number",
"required": true,
"description": "页面高度(mm)"
},
{
"name": "template_content",
"type": "array",
"required": false,
"description": "模板内容,可省略;省略时默认创建空模板内容"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "新建模板ID"
}
]
},
{
"moduleName": "打印模板模块",
"moduleKey": "setting.printTemplate",
"moduleFolder": "setting.printtemplate",
"method": "setting.printTemplate.delete",
"title": "删除打印模板(软删除)",
"description": "删除打印模板(软删除)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "模板ID"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "删除的模板ID"
}
]
},
{
"moduleName": "打印模板模块",
"moduleKey": "setting.printTemplate",
"moduleFolder": "setting.printtemplate",
"method": "setting.printTemplate.list",
"title": "获取打印模板树",
"description": "获取打印模板树",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "打印模板模块",
"moduleKey": "setting.printTemplate",
"moduleFolder": "setting.printtemplate",
"method": "setting.printTemplate.listTemplatesByType",
"title": "按业务类型查询模板",
"description": "按业务类型查询模板",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "businessType",
"type": "string",
"required": true,
"description": "businessType 参数"
}
],
"response": []
},
{
"moduleName": "打印模板模块",
"moduleKey": "setting.printTemplate",
"moduleFolder": "setting.printtemplate",
"method": "setting.printTemplate.save",
"title": "保存打印模板",
"description": "保存打印模板",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "角色管理模块",
"moduleKey": "setting.role",
"moduleFolder": "setting.role",
"method": "setting.role.add",
"title": "新增角色并绑定权限集合",
"description": "新增角色并绑定权限集合",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "role_code",
"type": "string",
"required": true,
"description": "角色编码"
},
{
"name": "role_name",
"type": "string",
"required": true,
"description": "角色名称"
},
{
"name": "permission_ids",
"type": "array",
"required": true,
"description": "权限ID数组,支持 [\"*\"]"
},
{
"name": "pid",
"type": "number",
"required": false,
"description": "父角色ID"
}
],
"response": []
},
{
"moduleName": "角色管理模块",
"moduleKey": "setting.role",
"moduleFolder": "setting.role",
"method": "setting.role.delete",
"title": "批量停用角色",
"description": "批量停用角色",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": true,
"description": "待停用的角色ID数组"
}
],
"response": []
},
{
"moduleName": "角色管理模块",
"moduleKey": "setting.role",
"moduleFolder": "setting.role",
"method": "setting.role.list",
"title": "获取当前主体可管理的角色树",
"description": "获取当前主体可管理的角色树",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "includeDisabled",
"type": "boolean",
"required": false,
"description": "是否包含已停用角色"
},
{
"name": "includeSystem",
"type": "boolean",
"required": false,
"description": "是否包含系统角色域"
}
],
"response": []
},
{
"moduleName": "角色管理模块",
"moduleKey": "setting.role",
"moduleFolder": "setting.role",
"method": "setting.role.permission",
"title": "获取角色权限树(兼容旧入口,等同于 setting.permission.list)",
"description": "获取角色权限树(兼容旧入口,等同于 setting.permission.list)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "role_id",
"type": "number",
"required": false,
"description": "角色ID"
}
],
"response": []
},
{
"moduleName": "角色管理模块",
"moduleKey": "setting.role",
"moduleFolder": "setting.role",
"method": "setting.role.update",
"title": "更新角色信息并重设权限集合",
"description": "更新角色信息并重设权限集合",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "role_id",
"type": "number",
"required": true,
"description": "角色ID"
},
{
"name": "permission_ids",
"type": "array",
"required": true,
"description": "权限ID数组,角色权限需一次性提交"
}
],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.stockWarehouse",
"title": "仓库商品列表查询兼容入口(等同于 stock.warehouse.list)",
"description": "仓库商品列表查询兼容入口(等同于 stock.warehouse.list)",
"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": "分页参数"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "筛选条件,写法与 stock.warehouse.list 一致"
}
],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.bindItem",
"title": "绑定货主商品关系",
"description": "绑定货主商品关系",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.checkItemCodeUnique",
"title": "校验商品编码在货主维度唯一性",
"description": "校验商品编码在货主维度唯一性",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "item_code",
"type": "string",
"required": true,
"description": "item_code 参数"
},
{
"name": "store_id",
"type": "number",
"required": true,
"description": "store_id 参数"
},
{
"name": "id",
"type": "number",
"required": false,
"description": "id 参数"
}
],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.createProhibited",
"title": "新增违禁品类型",
"description": "新增违禁品类型",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "name",
"type": "string",
"required": true,
"description": "name 参数"
}
],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.createUnit",
"title": "新增库存单位",
"description": "新增库存单位",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "name",
"type": "string",
"required": true,
"description": "name 参数"
}
],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.createWarehouseStock",
"title": "新建仓库商品资料",
"description": "新建仓库商品资料",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.deleteProhibited",
"title": "删除违禁品类型",
"description": "删除违禁品类型",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.deleteUnit",
"title": "删除库存单位",
"description": "删除库存单位",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.getBarcodes",
"title": "查询商品条码列表",
"description": "查询商品条码列表",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.getInfo",
"title": "查询仓库商品详情",
"description": "查询仓库商品详情",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.getProhibitedType",
"title": "查询违禁品类型列表(系统预设+仓库自定义)",
"description": "查询违禁品类型列表(系统预设+仓库自定义)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.getStockDetail",
"title": "查询商品的库存明细,返回 wms_storage 表的数据(按库位/批次维度展示库存分布)",
"description": "查询商品的库存明细,返回 wms_storage 表的数据(按库位/批次维度展示库存分布)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "stock_id",
"type": "number",
"required": true,
"description": "商品库存ID(stock_warehouse.id)"
},
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页参数,含 page(页码,默认1)和 pageSize(每页条数,默认20)"
},
{
"name": "group_by_batch",
"type": "boolean",
"required": false,
"description": "是否区分批次。false(默认)时按库位合并数量,批次相关字段(batch_no, production_date, expiry_date, inbound_time, inbound_order_no, supplier_batch_no)置 null;true 时按原逻辑返回每条明细"
}
],
"response": [
{
"name": "stockItem",
"type": "object",
"required": false,
"description": "商品概要信息,含 id, item_code, item_name, sku_property, stock_unit, quantity, locked_quantity"
},
{
"name": "storageList",
"type": "array",
"required": false,
"description": "库存明细数组,每条含 id, space_id, batch_no, inventory_type, quantity, locked_quantity, available_quantity, production_date, expiry_date, inbound_time, inbound_order_no, supplier_batch_no, created_at,关联 space 对象(id, space_code, custom_name)。当 group_by_batch=false 时,批次相关字段为 null"
},
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页信息,含 page, pageSize, total"
}
]
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.getStockUnits",
"title": "查询可用库存单位(系统+仓库)",
"description": "查询可用库存单位(系统+仓库)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.getStoreStocks",
"title": "查询仓库商品与货主关联列表",
"description": "查询仓库商品与货主关联列表",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.getUnitList",
"title": "查询当前仓库自定义单位列表",
"description": "查询当前仓库自定义单位列表",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.handleBatchChange",
"title": "批量修改仓库商品字段",
"description": "批量修改仓库商品字段",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.handleBatchDelete",
"title": "批量删除仓库商品资料",
"description": "批量删除仓库商品资料",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.list",
"title": "仓库商品列表查询(支持 where 条件与分页)",
"description": "仓库商品列表查询(支持 where 条件与分页)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "pagination",
"type": "object",
"required": false,
"description": "pagination 参数"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、barcode、prohibited_type 等商品筛选字段。示例:where.barcode={operator:like,value:69}; where.prohibited_type={operator:eq,value:liquid}。"
}
],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.queryStockLogs",
"title": "查询库存操作日志",
"description": "查询库存操作日志",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouseId",
"type": "string",
"required": false,
"description": "warehouseId 参数"
}
],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.saveWarehouseStock",
"title": "更新仓库商品资料",
"description": "更新仓库商品资料",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.saveWarehouseStockBarcode",
"title": "保存商品条码信息",
"description": "保存商品条码信息",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.search",
"title": "仓库商品关键字搜索,按 item_code / item_name / goods_code / 条形码模糊匹配,最多返回 50 条",
"description": "仓库商品关键字搜索,按 item_code / item_name / goods_code / 条形码模糊匹配,最多返回 50 条",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "keyword",
"type": "string",
"required": false,
"description": "搜索关键字,模糊匹配 item_code、item_name、goods_code 以及关联的 barcode;为空时返回全部(仍受 limit 50 限制)"
},
{
"name": "store_id",
"type": "number",
"required": false,
"description": "货主ID,传入时仅返回指定货主的商品"
},
{
"name": "with_stock",
"type": "boolean",
"required": false,
"description": "是否返回关联库存数据(wms_storage),为 true 时每条商品新增 storage[] 字段"
},
{
"name": "is_batch",
"type": "boolean",
"required": false,
"description": "是否按批次明细返回库存,仅 with_stock=true 时生效。false(默认)按库位分组汇总;true 逐条返回批次明细"
}
],
"response": [
{
"name": "code",
"type": "number",
"required": false,
"description": "业务状态码,200 表示成功"
},
{
"name": "data",
"type": "array",
"required": false,
"description": "商品列表,每项包含以下字段"
},
{
"name": "total",
"type": "number",
"required": false,
"description": "本次返回的记录条数(≤50)"
}
]
},
{
"moduleName": "商品模块",
"moduleKey": "stock",
"moduleFolder": "stock",
"method": "stock.warehouse.unbindItem",
"title": "解绑货主商品关系",
"description": "解绑货主商品关系",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "入库单模块",
"moduleKey": "storage.entry",
"moduleFolder": "storage.entry",
"method": "storage.entry.cancel",
"title": "作废入库单(支持单条或批量作废)",
"description": "作废入库单(支持单条或批量作废)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": false,
"description": "入库单ID,兼容旧调用;与 `ids` 二选一。若同时传入 `ids`,以 `ids` 为准。"
},
{
"name": "ids",
"type": "array",
"required": false,
"description": "入库单ID数组(number[]),用于批量作废;必须为非空数组,建议批量操作使用 `ids`,优先于 `id`。"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": false,
"description": "单条作废时返回的入库单ID"
},
{
"name": "ids",
"type": "array",
"required": false,
"description": "批量作废时返回的已成功作废入库单ID数组(number[])"
}
]
},
{
"moduleName": "入库单模块",
"moduleKey": "storage.entry",
"moduleFolder": "storage.entry",
"method": "storage.entry.completeEntry",
"title": "完成入库单",
"description": "完成入库单",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "入库单ID"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "完成成功的入库单ID"
}
]
},
{
"moduleName": "入库单模块",
"moduleKey": "storage.entry",
"moduleFolder": "storage.entry",
"method": "storage.entry.get",
"title": "查询入库单详情",
"description": "查询入库单详情",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": false,
"description": "入库单ID,与 entry_order_code 二选一"
},
{
"name": "entry_order_code",
"type": "string",
"required": false,
"description": "入库单号,与 id 二选一"
}
],
"response": [
{
"name": "entryOrder",
"type": "object",
"required": true,
"description": "入库单详情(含 items 明细)"
}
]
},
{
"moduleName": "入库单模块",
"moduleKey": "storage.entry",
"moduleFolder": "storage.entry",
"method": "storage.entry.list",
"title": "入库单列表查询",
"description": "入库单列表查询",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页参数,支持 page/pageSize"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、order_status、store_id、order_type、日期区间等字段。示例:where.order_status={operator:eq,value:waiting}; where.order_type={operator:eq,value:purchase}; where.create_time_start={value:2026-03-01}。"
},
{
"name": "sort",
"type": "object",
"required": false,
"description": "排序参数,支持 sortField/sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "入库单列表"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
},
{
"name": "summary",
"type": "object",
"required": true,
"description": "状态汇总(total、pending、creating、created、completed、cancelled)"
}
]
},
{
"moduleName": "库存操作模块",
"moduleKey": "storage.inventory",
"moduleFolder": "storage.inventory",
"method": "storage.expiry.list",
"title": "库存有效期列表查询(效期预警),按 wms_storage 查询并计算剩余天数与过期状态,支持 where 条件与分页。注意:无需传 warehouse_id/store_id,服务端会从当前登录用户取仓库上下文。",
"description": "库存有效期列表查询(效期预警),按 wms_storage 查询并计算剩余天数与过期状态,支持 where 条件与分页。注意:无需传 warehouse_id/store_id,服务端会从当前登录用户取仓库上下文。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象;支持字段:item_code、goods_code、item_name、sku_property、stock_unit、is_shelf_life_mgmt、remaining_threshold_days。示例:where.item_code={operator:like,value:ABC}; where.remaining_threshold_days={operator:lte,value:7}。注意:无需传入 store_id 或 warehouse_id,服务端会从当前登录用户获取仓库上下文。"
},
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页参数 { page, pageSize },默认 page=1, pageSize=20"
}
],
"response": [
{
"name": "data.list",
"type": "array",
"required": true,
"description": "匹配到的库存效期项数组"
},
{
"name": "data.list[]",
"type": "object",
"required": false,
"description": "列表项,包含至少以下字段"
},
{
"name": "data.pagination",
"type": "object",
"required": true,
"description": "分页信息,含 page、pageSize、total、totalPages"
}
]
},
{
"moduleName": "库存操作模块",
"moduleKey": "storage.inventory",
"moduleFolder": "storage.inventory",
"method": "storage.inventory.list",
"title": "库存列表查询(查 wms_storage),支持 where 条件、分页、排序、批次分组。默认按库位+商品合并数量(合并模式),group_by_batch=true 时返回每条库存明细(明细模式)",
"description": "库存列表查询(查 wms_storage),支持 where 条件、分页、排序、批次分组。默认按库位+商品合并数量(合并模式),group_by_batch=true 时返回每条库存明细(明细模式)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象,可用字段:stock_id(商品ID)、space_id(库位ID)、store_id(货主ID)、inventory_type(ZP/CC/JS/XS/ZT/DJ/FP)、batch_no(批次号)、inbound_order_no(入库单号)、available_quantity(可用数量,支持 gt/lt)、inbound_time(入库时间,支持 between)、created_at(创建时间,支持 between)"
},
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页参数 { page, pageSize },默认 page=1, pageSize=20"
},
{
"name": "sort",
"type": "object",
"required": false,
"description": "排序参数 { sortField, sortOrder },默认 sortField='created_at', sortOrder='DESC'"
},
{
"name": "group_by_batch",
"type": "boolean",
"required": false,
"description": "是否按批次查询,默认 false。false=合并模式(按库位+商品聚合quantity/locked_quantity/available_quantity),true=明细模式(逐条返回含 batch_no/production_date/expiry_date 等)"
}
],
"response": []
},
{
"moduleName": "库存操作模块",
"moduleKey": "storage.inventory",
"moduleFolder": "storage.inventory",
"method": "storage.inventory.matchPutaway",
"title": "收货单与入库单匹配入库。接收多个收货单和入库单,按商品(stock_warehouse_id)进行数量匹配入库,完成后根据入库单来源(QM/API)自动触发回传",
"description": "收货单与入库单匹配入库。接收多个收货单和入库单,按商品(stock_warehouse_id)进行数量匹配入库,完成后根据入库单来源(QM/API)自动触发回传",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [
{
"name": "receiving_ids",
"type": "array",
"required": true,
"description": "收货单ID列表"
},
{
"name": "entry_order_ids",
"type": "array",
"required": true,
"description": "入库单ID列表"
}
],
"response": []
},
{
"moduleName": "库存操作模块",
"moduleKey": "storage.inventory",
"moduleFolder": "storage.inventory",
"method": "storage.inventory.quickPutaway",
"title": "收货单快捷入库上架。从收货单直接生成入库单并写入库存表,要求收货单已完成且所有明细已匹配系统商品",
"description": "收货单快捷入库上架。从收货单直接生成入库单并写入库存表,要求收货单已完成且所有明细已匹配系统商品",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [
{
"name": "receiving_id",
"type": "number",
"required": true,
"description": "收货单ID,兼容 id"
}
],
"response": []
},
{
"moduleName": "库存操作模块",
"moduleKey": "storage.inventory",
"moduleFolder": "storage.inventory",
"method": "storage.inventory.transferByProduct",
"title": "按库位+商品维度移库,自动查找原库位下该商品的所有库存记录并合并移动。不适用于开启批次管理的商品",
"description": "按库位+商品维度移库,自动查找原库位下该商品的所有库存记录并合并移动。不适用于开启批次管理的商品",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [
{
"name": "space_id",
"type": "number",
"required": true,
"description": "原库位ID"
},
{
"name": "stock_id",
"type": "number",
"required": true,
"description": "商品SKU ID(wms_stock_warehouse.id)"
},
{
"name": "target_space_id",
"type": "number",
"required": true,
"description": "目标库位ID"
},
{
"name": "quantity",
"type": "number",
"required": true,
"description": "移库数量"
}
],
"response": []
},
{
"moduleName": "库存操作模块",
"moduleKey": "storage.inventory",
"moduleFolder": "storage.inventory",
"method": "storage.inventory.transferLocation",
"title": "单商品单库位移库,将库存从一个库位移动到另一个库位,支持部分数量移库和全量移库",
"description": "单商品单库位移库,将库存从一个库位移动到另一个库位,支持部分数量移库和全量移库",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [
{
"name": "storage_id",
"type": "number",
"required": true,
"description": "库存记录ID"
},
{
"name": "target_space_id",
"type": "number",
"required": true,
"description": "目标库位ID"
},
{
"name": "quantity",
"type": "number",
"required": false,
"description": "移库数量,不传则全部移动"
}
],
"response": []
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.addDetail",
"title": "storage.receiving.addDetail 接口",
"description": "storage.receiving.addDetail 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.addItem",
"title": "storage.receiving.addItem 接口",
"description": "storage.receiving.addItem 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": false,
"description": "id 参数"
},
{
"name": "item",
"type": "object",
"required": false,
"description": "item 参数"
}
],
"response": []
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.batchCancelReceiving",
"title": "storage.receiving.batchCancelReceiving 接口",
"description": "storage.receiving.batchCancelReceiving 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": true,
"description": "待作废收货单ID数组"
}
],
"response": [
{
"name": "message",
"type": "string",
"required": true,
"description": "批量作废处理结果"
}
]
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.bindDetailProduct",
"title": "收货单明细绑定或改绑系统商品",
"description": "收货单明细绑定或改绑系统商品",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "detail_id",
"type": "number",
"required": true,
"description": "收货单明细ID(兼容字段 `id`)"
},
{
"name": "system_product_id",
"type": "number",
"required": true,
"description": "系统商品ID(`StockWarehouse.id`,且必须属于当前仓库)"
}
],
"response": [
{
"name": "data.detail_id",
"type": "number",
"required": true,
"description": "收货单明细ID"
},
{
"name": "data.receiving_id",
"type": "number",
"required": true,
"description": "收货单ID"
},
{
"name": "data.system_product_id",
"type": "number",
"required": true,
"description": "已绑定的系统商品ID"
},
{
"name": "data.product_name",
"type": "string",
"required": true,
"description": "自动回填的商品名称"
}
]
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.bindStore",
"title": "收货单绑定货主",
"description": "收货单绑定货主",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "收货单ID"
},
{
"name": "store_id",
"type": "number",
"required": true,
"description": "货主ID(必须与当前仓库存在有效签约关系)"
}
],
"response": [
{
"name": "data.id",
"type": "number",
"required": true,
"description": "收货单ID"
},
{
"name": "data.store_id",
"type": "number",
"required": true,
"description": "已绑定的货主ID"
},
{
"name": "data.store_name",
"type": "string",
"required": false,
"description": "货主名称/签约备注名"
},
{
"name": "data.status",
"type": "string",
"required": true,
"description": "当前收货单状态"
}
]
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.cancel",
"title": "storage.receiving.cancel 接口",
"description": "storage.receiving.cancel 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.completeReceiving",
"title": "storage.receiving.completeReceiving 接口",
"description": "storage.receiving.completeReceiving 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.create",
"title": "storage.receiving.create 接口",
"description": "storage.receiving.create 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "delivery_method",
"type": "string",
"required": true,
"description": "到货方式:truck/express/air_freight/sea_freight/other"
},
{
"name": "loading_method",
"type": "string",
"required": true,
"description": "装卸方式:with_pallet/without_pallet"
},
{
"name": "license_plate",
"type": "string",
"required": false,
"description": "车牌号(delivery_method=truck 时建议传)"
},
{
"name": "tracking_number",
"type": "string",
"required": false,
"description": "物流单号(非 truck/other 场景建议传)"
},
{
"name": "store_id",
"type": "number",
"required": false,
"description": "货主ID"
},
{
"name": "total_boxes",
"type": "number",
"required": false,
"description": "总箱数"
},
{
"name": "total_pallets",
"type": "number",
"required": false,
"description": "总托盘数"
},
{
"name": "remark",
"type": "string",
"required": false,
"description": "备注"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "新建收货单ID"
},
{
"name": "receiving_number",
"type": "string",
"required": true,
"description": "收货单号"
}
]
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.deleteDetail",
"title": "storage.receiving.deleteDetail 接口",
"description": "storage.receiving.deleteDetail 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.detailChange",
"title": "修改收货单明细(数量/箱规/批次/商品信息回写等)",
"description": "修改收货单明细(数量/箱规/批次/商品信息回写等)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "收货明细ID"
},
{
"name": "receiving_id",
"type": "number",
"required": true,
"description": "收货单ID"
},
{
"name": "actual_quantity",
"type": "number",
"required": false,
"description": "实际收货数量"
},
{
"name": "batch_number",
"type": "string",
"required": false,
"description": "批次号"
},
{
"name": "production_date",
"type": "string",
"required": false,
"description": "生产日期(可解析的日期字符串)"
},
{
"name": "expiry_date",
"type": "string",
"required": false,
"description": "到期日期(可解析的日期字符串)。若早于当前日期,接口会返回 400 并拒绝录入。"
},
{
"name": "box_quantity",
"type": "number",
"required": false,
"description": "箱数"
},
{
"name": "boxes_per_pallet",
"type": "number",
"required": false,
"description": "每托盘箱数"
},
{
"name": "pallet_quantity",
"type": "number",
"required": false,
"description": "托盘数"
},
{
"name": "space_id",
"type": "number",
"required": false,
"description": "库位 ID(可回写)"
},
{
"name": "remark",
"type": "string",
"required": false,
"description": "备注"
},
{
"name": "system_product_id",
"type": "number",
"required": false,
"description": "系统商品 ID(StockWarehouse.id)。若提供,服务端会尝试回填 barcode/weight/箱规/product_name/product_snapshot 等。"
},
{
"name": "barcode",
"type": "string",
"required": false,
"description": "条码(未传 system_product_id 时可单独更新)"
},
{
"name": "product_name",
"type": "string",
"required": false,
"description": "商品名称(未传 system_product_id 时可单独更新)"
},
{
"name": "box_width",
"type": "number",
"required": false,
"description": "箱宽"
},
{
"name": "box_height",
"type": "number",
"required": false,
"description": "箱高"
},
{
"name": "box_length",
"type": "number",
"required": false,
"description": "箱长"
},
{
"name": "weight",
"type": "number",
"required": false,
"description": "毛重/重量"
}
],
"response": [
{
"name": "data.id",
"type": "number",
"required": true,
"description": "收货明细 ID"
},
{
"name": "data.receiving_id",
"type": "number",
"required": true,
"description": "收货单 ID"
},
{
"name": "data.actual_quantity",
"type": "number",
"required": false,
"description": "实际收货数量"
},
{
"name": "data.product_name",
"type": "string",
"required": false,
"description": "商品名称"
},
{
"name": "data.barcode",
"type": "string",
"required": false,
"description": "条码"
},
{
"name": "data.system_product_id",
"type": "number",
"required": false,
"description": "系统商品 ID"
},
{
"name": "data.updated_at",
"type": "string",
"required": false,
"description": "记录更新时间(ISO)"
}
]
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.get",
"title": "storage.receiving.get 接口",
"description": "storage.receiving.get 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.getReceivingDetail",
"title": "storage.receiving.getReceivingDetail 接口",
"description": "storage.receiving.getReceivingDetail 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "收货单ID"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "明细分页参数,支持 page/pageSize"
}
],
"response": [
{
"name": "receiving",
"type": "object",
"required": true,
"description": "收货单详情(含 details、images、pagination)"
}
]
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.getReceivingList",
"title": "storage.receiving.getReceivingList 接口",
"description": "storage.receiving.getReceivingList 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页参数,支持 page/pageSize"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、status、store_id、日期区间等字段。示例:where.status={operator:eq,value:finished}; where.store_id={operator:eq,value:1001}; where.create_time_start={value:2026-03-01}。"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "收货单列表"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
},
{
"name": "summary",
"type": "object",
"required": true,
"description": "汇总信息(total_quantity、total_locked、total_available、total_items)"
}
]
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.removeItem",
"title": "storage.receiving.removeItem 接口",
"description": "storage.receiving.removeItem 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": false,
"description": "id 参数"
},
{
"name": "item_id",
"type": "number",
"required": false,
"description": "item_id 参数"
}
],
"response": []
},
{
"moduleName": "收货单模块",
"moduleKey": "storage_receiving",
"moduleFolder": "storage_receiving",
"method": "storage.receiving.saveReceiving",
"title": "storage.receiving.saveReceiving 接口",
"description": "storage.receiving.saveReceiving 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "出库单模块",
"moduleKey": "storage.stockout",
"moduleFolder": "storage.stockout",
"method": "storage.stockout.list",
"title": "非订单出库单能力(对应奇门 stockout.create):用于处理由奇门创建的非订单出库单;主出口为 storage.stockout.*,不再推荐通过 storage.delivery.* 命名使用。storage.delivery.* 仅保留兼容转发。",
"description": "非订单出库单能力(对应奇门 stockout.create):用于处理由奇门创建的非订单出库单;主出口为 storage.stockout.*,不再推荐通过 storage.delivery.* 命名使用。storage.delivery.* 仅保留兼容转发。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页参数,支持 page/pageSize"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;常用字段包括 delivery_order_code、status、outbound_status、buyer_nick、mobile 与日期区间字段。"
},
{
"name": "sort",
"type": "object",
"required": false,
"description": "排序参数,支持 sortField/sortOrder,默认按 updated_at DESC、id DESC"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "出库单列表"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
}
]
},
{
"moduleName": "出库单模块",
"moduleKey": "storage.stockout",
"moduleFolder": "storage.stockout",
"method": "storage.stockout.listItems",
"title": "按出库单查询商品明细(用于非订单出库单),底层复用 order.listItems。",
"description": "按出库单查询商品明细(用于非订单出库单),底层复用 order.listItems。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "delivery_order_code",
"type": "string",
"required": false,
"description": "出库单号,可用于定位订单"
},
{
"name": "order_id",
"type": "number",
"required": false,
"description": "订单ID,可与 id 兼容用于定位订单"
},
{
"name": "id",
"type": "number",
"required": false,
"description": "订单ID,可选;与 delivery_order_code / order_id 至少传一个"
}
],
"response": [
{
"name": "order",
"type": "object",
"required": true,
"description": "订单基础信息(含 id、delivery_order_code)"
},
{
"name": "items",
"type": "array",
"required": true,
"description": "出库单商品明细"
}
]
},
{
"moduleName": "出库单模块",
"moduleKey": "storage.stockout",
"moduleFolder": "storage.stockout",
"method": "storage.stockout.toOrder",
"title": "占位接口,暂未开放。当前仅保留方法名用于后续扩展,逻辑暂不能使用。参数 id / delivery_order_code 暂未启用。",
"description": "占位接口,暂未开放。当前仅保留方法名用于后续扩展,逻辑暂不能使用。参数 id / delivery_order_code 暂未启用。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": false,
"description": "预留参数,暂未启用;当前仅保留字段名用于后续扩展。"
},
{
"name": "delivery_order_code",
"type": "string",
"required": false,
"description": "预留参数,暂未启用;当前仅保留字段名用于后续扩展。"
}
],
"response": [
{
"name": "_note",
"type": "string",
"required": false,
"description": "占位接口,当前无有效业务响应"
}
]
},
{
"moduleName": "库存操作模块",
"moduleKey": "storage.inventory",
"moduleFolder": "storage.inventory",
"method": "storage.transaction.list",
"title": "出入库记录列表查询,支持 where 条件、分页、排序、批次分组切换。默认按库位合并数量(合并模式),group_by_batch=true 时返回每条明细(明细模式)",
"description": "出入库记录列表查询,支持 where 条件、分页、排序、批次分组切换。默认按库位合并数量(合并模式),group_by_batch=true 时返回每条明细(明细模式)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象,可用字段:transaction_type(ENUM INBOUND/OUTBOUND)、stock_id、space_id、store_id、order_type(SCRK/MATCH)、order_no、inventory_type(ZP/CC/JS/XS/ZT/DJ/FP)、operator_name、created_at(支持 between)"
},
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页参数 { page, pageSize },默认 page=1, pageSize=20"
},
{
"name": "sort",
"type": "object",
"required": false,
"description": "排序参数 { sortField, sortOrder },默认 sortField='created_at', sortOrder='DESC'"
},
{
"name": "group_by_batch",
"type": "boolean",
"required": false,
"description": "是否按批次查询明细,默认 false。false=合并模式(按库位+商品聚合),true=明细模式(逐条返回)"
}
],
"response": []
},
{
"moduleName": "主体模块",
"moduleKey": "store",
"moduleFolder": "store",
"method": "store.auditApply",
"title": "store.auditApply 接口",
"description": "store.auditApply 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "audit_status",
"type": "string",
"required": true,
"description": "审核状态(approved/rejected)"
},
{
"name": "code",
"type": "string",
"required": true,
"description": "申请码(join_token)"
},
{
"name": "store_id",
"type": "number",
"required": true,
"description": "当前审批门店ID"
},
{
"name": "role_ids",
"type": "array",
"required": true,
"description": "分配角色ID数组"
},
{
"name": "reject_reason",
"type": "string",
"required": false,
"description": "拒绝原因(audit_status=rejected 时可传)"
}
],
"response": []
},
{
"moduleName": "主体模块",
"moduleKey": "store",
"moduleFolder": "store",
"method": "store.createStore",
"title": "store.createStore 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB",
"description": "store.createStore 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "subject_config",
"type": "object",
"required": false,
"description": "货主主体配置,不传时自动写入默认值"
},
{
"name": "subject_config.max_notice_webhook_count",
"type": "number",
"required": false,
"description": "当前主体最多允许绑定 / 触达的消息推送接口数量,默认 5"
},
{
"name": "subject_config.default_express_code",
"type": "string",
"required": false,
"description": "默认快递编码,缺省为 STO"
},
{
"name": "subject_config.default_platform_code",
"type": "string",
"required": false,
"description": "默认平台编码,缺省为 TB"
}
],
"response": []
},
{
"moduleName": "主体模块",
"moduleKey": "store",
"moduleFolder": "store",
"method": "store.createWarehouse",
"title": "store.createWarehouse 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB",
"description": "store.createWarehouse 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "subject_config",
"type": "object",
"required": false,
"description": "货主主体配置,不传时自动写入默认值"
},
{
"name": "subject_config.max_notice_webhook_count",
"type": "number",
"required": false,
"description": "当前主体最多允许绑定 / 触达的消息推送接口数量,默认 5"
},
{
"name": "subject_config.default_express_code",
"type": "string",
"required": false,
"description": "默认快递编码,缺省为 STO"
},
{
"name": "subject_config.default_platform_code",
"type": "string",
"required": false,
"description": "默认平台编码,缺省为 TB"
}
],
"response": []
},
{
"moduleName": "主体模块",
"moduleKey": "store",
"moduleFolder": "store",
"method": "store.getStoreRoles",
"title": "store.getStoreRoles 接口",
"description": "store.getStoreRoles 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "code",
"type": "string",
"required": true,
"description": "申请码(join_token)"
}
],
"response": []
},
{
"moduleName": "主体模块",
"moduleKey": "store",
"moduleFolder": "store",
"method": "store.joinStore",
"title": "store.joinStore 接口",
"description": "store.joinStore 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "主体模块",
"moduleKey": "store",
"moduleFolder": "store",
"method": "store.joinWarehouse",
"title": "store.joinWarehouse 接口",
"description": "store.joinWarehouse 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "货主-仓库签约模块",
"moduleKey": "storeWarehouse.store",
"moduleFolder": "storewarehouse.store",
"method": "storeWarehouse.store.adjustPrintQuantity",
"title": "人工调整签约关系下的面单余额并记录变更日志",
"description": "人工调整签约关系下的面单余额并记录变更日志",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "签约关系ID,兼容 contract_id"
},
{
"name": "print_quantity",
"type": "number",
"required": false,
"description": "目标面单余额(覆盖值);优先使用该字段"
},
{
"name": "target_quantity",
"type": "number",
"required": false,
"description": "目标面单余额(覆盖值);兼容别名"
},
{
"name": "change_quantity",
"type": "number",
"required": true,
"description": "兼容旧字段;当前按目标面单余额(覆盖值)解释,差值将自动写入变更日志"
},
{
"name": "adjust_quantity",
"type": "number",
"required": false,
"description": "兼容旧字段;当前按目标面单余额(覆盖值)解释"
},
{
"name": "reason",
"type": "string",
"required": true,
"description": "人工调整缘由,必填"
},
{
"name": "business_type",
"type": "string",
"required": false,
"description": "业务来源类型,预留给后续 order_express 等自动扣减场景"
},
{
"name": "business_id",
"type": "number",
"required": false,
"description": "业务关联ID,预留给后续关联 wms_order_express.id"
}
],
"response": []
},
{
"moduleName": "货主-仓库签约模块",
"moduleKey": "storeWarehouse.store",
"moduleFolder": "storewarehouse.store",
"method": "storeWarehouse.store.deleteQimenConfig",
"title": "删除签约关系下的奇门接口配置",
"description": "删除签约关系下的奇门接口配置",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "签约关系ID,兼容 contract_id"
},
{
"name": "interface_type_id",
"type": "number",
"required": false,
"description": "接口类型ID"
}
],
"response": []
},
{
"moduleName": "货主-仓库签约模块",
"moduleKey": "storeWarehouse.store",
"moduleFolder": "storewarehouse.store",
"method": "storeWarehouse.store.getPolicyConfig",
"title": "读取签约策略配置",
"description": "读取签约策略配置",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "签约关系ID,兼容 contract_id"
}
],
"response": []
},
{
"moduleName": "货主-仓库签约模块",
"moduleKey": "storeWarehouse.store",
"moduleFolder": "storewarehouse.store",
"method": "storeWarehouse.store.getPolicyConfigFields",
"title": "获取签约策略可配置字段元信息列表",
"description": "获取签约策略可配置字段元信息列表",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "货主-仓库签约模块",
"moduleKey": "storeWarehouse.store",
"moduleFolder": "storewarehouse.store",
"method": "storeWarehouse.store.list",
"title": "查询当前主体可见的仓库-货主签约列表",
"description": "查询当前主体可见的仓库-货主签约列表",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "page",
"type": "number",
"required": false,
"description": "页码,默认 1"
},
{
"name": "page_size",
"type": "number",
"required": false,
"description": "分页大小,默认 20"
},
{
"name": "keyword",
"type": "string",
"required": false,
"description": "签约备注或主体名称关键字"
}
],
"response": [
{
"name": "data.list",
"type": "array",
"required": false,
"description": "签约关系列表"
},
{
"name": "data.list[].id",
"type": "number",
"required": false,
"description": "签约关系主键 ID"
},
{
"name": "data.list[].store_id",
"type": "number",
"required": false,
"description": "货主 ID"
},
{
"name": "data.list[].store_name",
"type": "string",
"required": false,
"description": "货主名称(优先取备注名,无则取 company_name)"
},
{
"name": "data.list[].warehouse_id",
"type": "number",
"required": false,
"description": "仓库 ID"
},
{
"name": "data.list[].warehouse_name",
"type": "string",
"required": false,
"description": "仓库名称(优先取备注名,无则取 company_name)"
},
{
"name": "data.list[].counterparty_id",
"type": "number",
"required": false,
"description": "对方主体 ID(当前为仓库则返回货主 ID,反之亦然)"
},
{
"name": "data.list[].counterparty_name",
"type": "string",
"required": false,
"description": "对方主体名称"
},
{
"name": "data.list[].current_subject_role",
"type": "string",
"required": false,
"description": "当前主体角色:warehouse 或 store"
},
{
"name": "data.list[].auth_status",
"type": "number",
"required": false,
"description": "签约状态:1=申请中 2=已通过 3=已拒绝 4=已解除 5=已过期"
},
{
"name": "data.list[].auth_status_label",
"type": "string",
"required": false,
"description": "签约状态中文标签"
},
{
"name": "data.list[].apply_reason",
"type": "string",
"required": false,
"description": "申请原因"
},
{
"name": "data.list[].review_comment",
"type": "string",
"required": false,
"description": "审核评语"
},
{
"name": "data.list[].apply_time",
"type": "string|null",
"required": false,
"description": "申请时间"
},
{
"name": "data.list[].review_time",
"type": "string|null",
"required": false,
"description": "审核时间"
},
{
"name": "data.list[].auth_start",
"type": "string|null",
"required": false,
"description": "授权开始时间"
},
{
"name": "data.list[].auth_end",
"type": "string|null",
"required": false,
"description": "授权结束时间"
},
{
"name": "data.list[].actual_end",
"type": "string|null",
"required": false,
"description": "实际结束时间"
},
{
"name": "data.list[].print_quantity",
"type": "number",
"required": false,
"description": "面单余额数量"
},
{
"name": "data.list[].applied_by",
"type": "number|null",
"required": false,
"description": "申请人账号 ID"
},
{
"name": "data.list[].reviewed_by",
"type": "number|null",
"required": false,
"description": "审核人账号 ID"
},
{
"name": "data.list[].ended_by",
"type": "number|null",
"required": false,
"description": "解除人账号 ID"
},
{
"name": "data.list[].remask",
"type": "string",
"required": false,
"description": "备注名(当前为仓库则返回货主备注名,反之亦然)"
},
{
"name": "data.list[].use_status",
"type": "number",
"required": false,
"description": "启用状态:0=禁用 1=启用"
},
{
"name": "data.list[].policy_config",
"type": "object|null",
"required": false,
"description": "签约策略配置对象,无则为 null"
},
{
"name": "data.list[].is_auth_valid",
"type": "boolean",
"required": false,
"description": "签约是否在有效期内"
},
{
"name": "data.list[].remaining_days",
"type": "number",
"required": false,
"description": "剩余有效天数(未在有效期内时为 0)"
},
{
"name": "data.list[].has_qimen_config",
"type": "boolean",
"required": false,
"description": "该货主是否已配置奇门(true=已配置,false=未配置)"
},
{
"name": "data.total",
"type": "number",
"required": false,
"description": "总记录数"
},
{
"name": "data.page",
"type": "number",
"required": false,
"description": "当前页码"
},
{
"name": "data.page_size",
"type": "number",
"required": false,
"description": "每页条数"
},
{
"name": "data.current_subject.store_id",
"type": "number",
"required": false,
"description": "当前主体 ID"
},
{
"name": "data.current_subject.company_name",
"type": "string",
"required": false,
"description": "当前主体公司名称"
},
{
"name": "data.current_subject.role",
"type": "string",
"required": false,
"description": "当前主体角色:warehouse 或 store"
}
]
},
{
"moduleName": "货主-仓库签约模块",
"moduleKey": "storeWarehouse.store",
"moduleFolder": "storewarehouse.store",
"method": "storeWarehouse.store.listApiConfig",
"title": "查询签约关系下的接口配置列表",
"description": "查询签约关系下的接口配置列表",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "签约关系ID,兼容 contract_id"
},
{
"name": "interface_type_id",
"type": "number",
"required": false,
"description": "接口类型ID,默认查询全部可用类型"
}
],
"response": [
{
"name": "data.list[].callback_url",
"type": "string",
"required": false,
"description": "API回调通知URL,来自 serializeQimenConfig 序列化"
}
]
},
{
"moduleName": "货主-仓库签约模块",
"moduleKey": "storeWarehouse.store",
"moduleFolder": "storewarehouse.store",
"method": "storeWarehouse.store.rename",
"title": "修改当前主体视角下的签约备注名",
"description": "修改当前主体视角下的签约备注名",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "签约关系ID,兼容 contract_id"
}
],
"response": []
},
{
"moduleName": "货主-仓库签约模块",
"moduleKey": "storeWarehouse.store",
"moduleFolder": "storewarehouse.store",
"method": "storeWarehouse.store.saveApiConfig",
"title": "新增或更新签约关系下的接口配置。QM_WMS 类型须填写奇门字段;OPEN_API 类型由系统自动生成 self_app_key 和 self_app_secret",
"description": "新增或更新签约关系下的接口配置。QM_WMS 类型须填写奇门字段;OPEN_API 类型由系统自动生成 self_app_key 和 self_app_secret",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "签约关系ID,兼容 contract_id"
},
{
"name": "interface_type_id",
"type": "number",
"required": true,
"description": "接口类型ID,必须是 wms_interface_type 已存在的类型"
},
{
"name": "qimen_app_key",
"type": "string",
"required": false,
"description": "奇门 AppKey(QM_WMS 类型必填,OPEN_API 类型不需要)"
},
{
"name": "qimen_customer_id",
"type": "string",
"required": false,
"description": "奇门客户ID(QM_WMS 类型必填,OPEN_API 类型不需要)"
},
{
"name": "qimen_warehouse_code",
"type": "string",
"required": false,
"description": "奇门仓库编码(QM_WMS 类型必填,OPEN_API 类型不需要)"
},
{
"name": "app_name",
"type": "string",
"required": true,
"description": "应用名称"
},
{
"name": "callback_url",
"type": "string",
"required": false,
"description": "API 类型入库单回调地址(VARCHAR(500),仅 OPEN_API 类型使用)"
}
],
"response": []
},
{
"moduleName": "货主-仓库签约模块",
"moduleKey": "storeWarehouse.store",
"moduleFolder": "storewarehouse.store",
"method": "storeWarehouse.store.savePolicyConfig",
"title": "保存签约策略配置",
"description": "保存签约策略配置",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "签约关系ID,兼容 contract_id"
},
{
"name": "policy_config",
"type": "object",
"required": true,
"description": "策略配置对象;仅支持 receive_mode、auto_allocate_bin、allow_mix_batch、allow_temp_storage、storage_separation、print_recharge_price(面单充值元/单,支持 2 位小数)、max_daily_inbound、remark"
}
],
"response": []
},
{
"moduleName": "货主-仓库签约模块",
"moduleKey": "storeWarehouse.store",
"moduleFolder": "storewarehouse.store",
"method": "storeWarehouse.store.sign",
"title": "发起或确认仓库-货主签约",
"description": "发起或确认仓库-货主签约",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "store_id",
"type": "number",
"required": false,
"description": "货主ID;由仓库侧发起时必传"
},
{
"name": "warehouse_id",
"type": "number",
"required": false,
"description": "仓库ID;由货主侧发起时必传"
},
{
"name": "temp_code",
"type": "string",
"required": false,
"description": "临时签约码;传入后进入确认或预览流程"
}
],
"response": []
},
{
"moduleName": "货主-仓库签约模块",
"moduleKey": "storeWarehouse.store",
"moduleFolder": "storewarehouse.store",
"method": "storeWarehouse.store.unbind",
"title": "解除或停用签约关系",
"description": "解除或停用签约关系",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "签约关系ID,兼容 contract_id"
},
{
"name": "use_status",
"type": "number",
"required": false,
"description": "使用状态,0=停用,1=恢复"
}
],
"response": []
},
{
"moduleName": "用户模块",
"moduleKey": "user",
"moduleFolder": "user",
"method": "user.changeRole",
"title": "user.changeRole 接口",
"description": "user.changeRole 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "用户模块",
"moduleKey": "user",
"moduleFolder": "user",
"method": "user.getBindWechatCode",
"title": "获取微信绑定码(默认立即返回;显式开启长轮询后,最长等待60秒,状态变化立即返回)",
"description": "获取微信绑定码(默认立即返回;显式开启长轮询后,最长等待60秒,状态变化立即返回)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "forceRefresh",
"type": "boolean",
"required": false,
"description": "是否强制刷新状态,true 时跳过缓存等待窗口"
},
{
"name": "waitForChange",
"type": "boolean",
"required": false,
"description": "是否显式开启长轮询等待(推荐字段);true 时进入最长60秒等待"
},
{
"name": "longPoll",
"type": "boolean",
"required": false,
"description": "长轮询开关(兼容字段);true 时进入最长60秒等待"
},
{
"name": "waitTimeoutMs",
"type": "number",
"required": false,
"description": "等待超时毫秒数;后端自动封顶60000"
},
{
"name": "init",
"type": "boolean",
"required": false,
"description": "初始化请求标记;true 时强制立即返回,不进入长等待"
}
],
"response": []
},
{
"moduleName": "用户模块",
"moduleKey": "user",
"moduleFolder": "user",
"method": "user.getLoginWechatCode",
"title": "获取微信扫码登录码(无 clientCode 时分配新客户端编码;有 clientCode 时可长轮询刷新)",
"description": "获取微信扫码登录码(无 clientCode 时分配新客户端编码;有 clientCode 时可长轮询刷新)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": false,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [
{
"name": "clientCode",
"type": "string",
"required": false,
"description": "客户端编码;首次可不传,后续轮询建议透传已有值"
}
],
"response": []
},
{
"moduleName": "用户模块",
"moduleKey": "user",
"moduleFolder": "user",
"method": "user.info",
"title": "获取当前用户信息",
"description": "获取当前用户信息",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "用户模块",
"moduleKey": "user",
"moduleFolder": "user",
"method": "user.login",
"title": "用户登录(仅返回 token)",
"description": "用户登录(仅返回 token)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": false,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [
{
"name": "password",
"type": "string",
"required": false,
"description": "password 参数"
},
{
"name": "username",
"type": "string",
"required": false,
"description": "username 参数"
}
],
"response": []
},
{
"moduleName": "用户模块",
"moduleKey": "user",
"moduleFolder": "user",
"method": "user.loginByCode",
"title": "登录码登录(使用 ye4s_user.tmp_code)",
"description": "登录码登录(使用 ye4s_user.tmp_code)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": false,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [
{
"name": "code",
"type": "string",
"required": true,
"description": "登录码,对应 ye4s_user.tmp_code"
}
],
"response": []
},
{
"moduleName": "用户模块",
"moduleKey": "user",
"moduleFolder": "user",
"method": "user.logout",
"title": "用户登出",
"description": "用户登出",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "用户模块",
"moduleKey": "user",
"moduleFolder": "user",
"method": "user.register",
"title": "user.register 接口",
"description": "user.register 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": false,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [],
"response": []
},
{
"moduleName": "用户模块",
"moduleKey": "user",
"moduleFolder": "user",
"method": "user.unbindWechat",
"title": "解绑微信账号(清理 ye4s 关联账号数据)",
"description": "解绑微信账号(清理 ye4s 关联账号数据)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.checkBarcodeUnique",
"title": "warehouse.checkBarcodeUnique 接口",
"description": "warehouse.checkBarcodeUnique 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "barcode",
"type": "string",
"required": true,
"description": "barcode 参数"
},
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.create",
"title": "warehouse.create 接口",
"description": "warehouse.create 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.createRack",
"title": "warehouse.createRack 接口",
"description": "warehouse.createRack 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "height",
"type": "number",
"required": true,
"description": "height 参数"
},
{
"name": "length",
"type": "number",
"required": true,
"description": "length 参数"
},
{
"name": "rack_columns",
"type": "number",
"required": true,
"description": "rack_columns 参数"
},
{
"name": "rack_levels",
"type": "number",
"required": true,
"description": "rack_levels 参数"
},
{
"name": "rack_rows",
"type": "number",
"required": true,
"description": "rack_rows 参数"
},
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "warehouse_id 参数"
},
{
"name": "width",
"type": "number",
"required": true,
"description": "width 参数"
},
{
"name": "x",
"type": "number",
"required": true,
"description": "x 参数"
},
{
"name": "y",
"type": "number",
"required": true,
"description": "y 参数"
},
{
"name": "zone_code",
"type": "string",
"required": true,
"description": "zone_code 参数"
},
{
"name": "zone_name",
"type": "string",
"required": true,
"description": "zone_name 参数"
},
{
"name": "color",
"type": "string",
"required": false,
"description": "color 参数"
},
{
"name": "direction",
"type": "string",
"required": false,
"description": "direction 参数"
},
{
"name": "parent_id",
"type": "number",
"required": false,
"description": "parent_id 参数"
},
{
"name": "z",
"type": "number",
"required": false,
"description": "z 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.createRackWithSpaces",
"title": "warehouse.createRackWithSpaces 接口",
"description": "warehouse.createRackWithSpaces 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.delete",
"title": "warehouse.delete 接口",
"description": "warehouse.delete 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.detail",
"title": "warehouse.detail 接口",
"description": "warehouse.detail 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.getAreaRacks",
"title": "warehouse.getAreaRacks 接口",
"description": "warehouse.getAreaRacks 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "area_id",
"type": "number",
"required": true,
"description": "area_id 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.getChildren",
"title": "warehouse.getChildren 接口",
"description": "warehouse.getChildren 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "zoneId",
"type": "number",
"required": true,
"description": "zoneId 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.getPath",
"title": "warehouse.getPath 接口",
"description": "warehouse.getPath 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.getPickPath",
"title": "warehouse.getPickPath 接口",
"description": "warehouse.getPickPath 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "warehouse_id 参数"
},
{
"name": "include_spaces",
"type": "string",
"required": false,
"description": "include_spaces 参数"
},
{
"name": "limit",
"type": "number",
"required": false,
"description": "limit 参数"
},
{
"name": "sort_by",
"type": "string",
"required": false,
"description": "sort_by 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.getSpaceInfo",
"title": "warehouse.getSpaceInfo 接口",
"description": "warehouse.getSpaceInfo 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": false,
"description": "id 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.getSpacesByRack",
"title": "warehouse.getSpacesByRack 接口",
"description": "warehouse.getSpacesByRack 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.getWarehouseTree",
"title": "warehouse.getWarehouseTree 接口",
"description": "warehouse.getWarehouseTree 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouseId",
"type": "number",
"required": true,
"description": "warehouseId 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.getWarehouseZones",
"title": "warehouse.getWarehouseZones 接口",
"description": "warehouse.getWarehouseZones 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.recalculatePickPath",
"title": "warehouse.recalculatePickPath 接口",
"description": "warehouse.recalculatePickPath 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "warehouse_id 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.toggleActive",
"title": "warehouse.toggleActive 接口",
"description": "warehouse.toggleActive 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
},
{
"name": "isActive",
"type": "string",
"required": false,
"description": "isActive 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.update",
"title": "warehouse.update 接口",
"description": "warehouse.update 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
},
{
"name": "aisles",
"type": "string",
"required": false,
"description": "aisles 参数"
},
{
"name": "cell_height",
"type": "string",
"required": false,
"description": "cell_height 参数"
},
{
"name": "cell_length",
"type": "string",
"required": false,
"description": "cell_length 参数"
},
{
"name": "cell_width",
"type": "string",
"required": false,
"description": "cell_width 参数"
},
{
"name": "direction",
"type": "string",
"required": false,
"description": "direction 参数"
},
{
"name": "height",
"type": "number",
"required": false,
"description": "height 参数"
},
{
"name": "is_active",
"type": "boolean",
"required": false,
"description": "是否启用,支持 true/false 或 1/0"
},
{
"name": "length",
"type": "number",
"required": false,
"description": "length 参数"
},
{
"name": "rack_columns",
"type": "string",
"required": false,
"description": "rack_columns 参数"
},
{
"name": "rack_levels",
"type": "string",
"required": false,
"description": "rack_levels 参数"
},
{
"name": "rack_rows",
"type": "string",
"required": false,
"description": "rack_rows 参数"
},
{
"name": "width",
"type": "number",
"required": false,
"description": "width 参数"
},
{
"name": "x",
"type": "number",
"required": false,
"description": "x 参数"
},
{
"name": "y",
"type": "number",
"required": false,
"description": "y 参数"
},
{
"name": "z",
"type": "number",
"required": false,
"description": "z 参数"
},
{
"name": "zone_code",
"type": "string",
"required": false,
"description": "zone_code 参数"
},
{
"name": "zone_name",
"type": "string",
"required": false,
"description": "zone_name 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.updateNeighbors",
"title": "warehouse.updateNeighbors 接口",
"description": "warehouse.updateNeighbors 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "warehouse_id 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.updateRackPosition",
"title": "warehouse.updateRackPosition 接口",
"description": "warehouse.updateRackPosition 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "x",
"type": "number",
"required": true,
"description": "x 参数"
},
{
"name": "y",
"type": "number",
"required": true,
"description": "y 参数"
},
{
"name": "rack_id",
"type": "number",
"required": false,
"description": "rack_id 参数"
},
{
"name": "z",
"type": "number",
"required": false,
"description": "z 参数"
}
],
"response": []
},
{
"moduleName": "仓库模块",
"moduleKey": "warehouse",
"moduleFolder": "warehouse",
"method": "warehouse.updateSpaceInfo",
"title": "warehouse.updateSpaceInfo 接口",
"description": "warehouse.updateSpaceInfo 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
},
{
"name": "custom_barcode",
"type": "string",
"required": false,
"description": "custom_barcode 参数"
},
{
"name": "custom_name",
"type": "string",
"required": false,
"description": "custom_name 参数"
},
{
"name": "location_type_id",
"type": "number",
"required": false,
"description": "location_type_id 参数"
},
{
"name": "pick_sequence",
"type": "string",
"required": false,
"description": "pick_sequence 参数"
},
{
"name": "space_status",
"type": "string",
"required": false,
"description": "space_status 参数"
}
],
"response": []
}
]
}