12998 lines
391 KiB
JSON
12998 lines
391 KiB
JSON
{
|
||
"generatedAt": "2026-05-09 09:52:14",
|
||
"generatedAtLocal": "2026-05-09 09:52:14",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"totalInterfaceCount": 245,
|
||
"changes": {
|
||
"summary": {
|
||
"moduleAdded": 1,
|
||
"moduleDeleted": 0,
|
||
"moduleUpdated": 1,
|
||
"interfaceAdded": 3,
|
||
"interfaceDeleted": 1,
|
||
"interfaceParamsUpdated": 2,
|
||
"interfaceResponseUpdated": 2
|
||
},
|
||
"moduleUpdates": {
|
||
"added": [
|
||
{
|
||
"moduleName": "order.wave",
|
||
"moduleKey": "order",
|
||
"folder": "order",
|
||
"methods": [
|
||
"order.wave.batchList"
|
||
],
|
||
"interfaceCount": 1
|
||
}
|
||
],
|
||
"deleted": [],
|
||
"updated": [
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"folder": "order.wave",
|
||
"previousModuleName": "订单波次模块",
|
||
"previousModuleKey": "order.wave",
|
||
"interfaceChanges": {
|
||
"addedMethods": [
|
||
"order.wave.wavePickTaskCancel",
|
||
"order.wave.wavePickTaskList"
|
||
],
|
||
"deletedMethods": [
|
||
"order.wave.batchList"
|
||
],
|
||
"paramsUpdatedMethods": [
|
||
"order.wave.waveStrategyFetchAdmin",
|
||
"order.wave.waveStrategyFetchPda"
|
||
],
|
||
"responseUpdatedMethods": [
|
||
"order.wave.waveStrategyFetchAdmin",
|
||
"order.wave.waveStrategyFetchPda"
|
||
]
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"interfaceUpdates": {
|
||
"added": [
|
||
{
|
||
"moduleName": "order.wave",
|
||
"moduleKey": "order",
|
||
"folder": "order",
|
||
"method": "order.wave.batchList"
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"folder": "order.wave",
|
||
"method": "order.wave.wavePickTaskCancel"
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"folder": "order.wave",
|
||
"method": "order.wave.wavePickTaskList"
|
||
}
|
||
],
|
||
"deleted": [
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"folder": "order.wave",
|
||
"method": "order.wave.batchList"
|
||
}
|
||
],
|
||
"paramsUpdated": [
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"folder": "order.wave",
|
||
"method": "order.wave.waveStrategyFetchAdmin"
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"folder": "order.wave",
|
||
"method": "order.wave.waveStrategyFetchPda"
|
||
}
|
||
],
|
||
"responseUpdated": [
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"folder": "order.wave",
|
||
"method": "order.wave.waveStrategyFetchAdmin"
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"folder": "order.wave",
|
||
"method": "order.wave.waveStrategyFetchPda"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"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": "setting.express",
|
||
"moduleFolder": "setting.express",
|
||
"method": "index.getExpressList",
|
||
"title": "合并后的快递列表",
|
||
"description": "合并后的快递列表",
|
||
"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.getLocationTypeList",
|
||
"title": "查询库位类型基础列表,优先返回当前仓库下启用的库位类型,同时合并系统公共类型;结果带 300 秒缓存",
|
||
"description": "查询库位类型基础列表,优先返回当前仓库下启用的库位类型,同时合并系统公共类型;结果带 300 秒缓存",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "库位类型列表"
|
||
},
|
||
{
|
||
"name": "total",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "返回总数"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "基础模块",
|
||
"moduleKey": "index",
|
||
"moduleFolder": "index",
|
||
"method": "index.getMessageDetail",
|
||
"title": "index.getMessageDetail 接口",
|
||
"description": "index.getMessageDetail 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "平台编码管理模块",
|
||
"moduleKey": "setting.platform",
|
||
"moduleFolder": "setting.platform",
|
||
"method": "index.getPlatformList",
|
||
"title": "合并后的平台列表",
|
||
"description": "合并后的平台列表",
|
||
"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.detail",
|
||
"title": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids / id / order_id / orderId",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
|
||
},
|
||
{
|
||
"name": "tableType / tablePosition / type / moduleName",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "订单头对象(raw 行数据)"
|
||
},
|
||
{
|
||
"name": "detail",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "等同于 order"
|
||
},
|
||
{
|
||
"name": "orderItems / items",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "商品明细数组"
|
||
},
|
||
{
|
||
"name": "expresses",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "运单信息数组"
|
||
},
|
||
{
|
||
"name": "waybill_codes",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "去重后的运单号字符串数组"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单归档模块",
|
||
"moduleKey": "order.archiveOrder",
|
||
"moduleFolder": "order.archiveorder",
|
||
"method": "order.archiveOrder.list",
|
||
"title": "归档订单列表,使用 history 模型。",
|
||
"description": "归档订单列表,使用 history 模型。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "排序参数,支持 sortField / sortOrder"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单列表(raw 行数据)"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"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.detail",
|
||
"title": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids / id / order_id / orderId",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
|
||
},
|
||
{
|
||
"name": "tableType / tablePosition / type / moduleName",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "订单头对象(raw 行数据)"
|
||
},
|
||
{
|
||
"name": "detail",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "等同于 order"
|
||
},
|
||
{
|
||
"name": "orderItems / items",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "商品明细数组"
|
||
},
|
||
{
|
||
"name": "expresses",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "运单信息数组"
|
||
},
|
||
{
|
||
"name": "waybill_codes",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "去重后的运单号字符串数组"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单配送异常模块",
|
||
"moduleKey": "order.deliveryExpectionOrder",
|
||
"moduleFolder": "order.deliveryexpectionorder",
|
||
"method": "order.deliveryExpectionOrder.list",
|
||
"title": "配送异常订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m5。",
|
||
"description": "配送异常订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m5。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "排序参数,支持 sortField / sortOrder"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单配送模块",
|
||
"moduleKey": "order.deliveryOrder",
|
||
"moduleFolder": "order.deliveryorder",
|
||
"method": "order.deliveryOrder.detail",
|
||
"title": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids / id / order_id / orderId",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
|
||
},
|
||
{
|
||
"name": "tableType / tablePosition / type / moduleName",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "订单头对象(raw 行数据)"
|
||
},
|
||
{
|
||
"name": "detail",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "等同于 order"
|
||
},
|
||
{
|
||
"name": "orderItems / items",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "商品明细数组"
|
||
},
|
||
{
|
||
"name": "expresses",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "运单信息数组"
|
||
},
|
||
{
|
||
"name": "waybill_codes",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "去重后的运单号字符串数组"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单配送模块",
|
||
"moduleKey": "order.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.index",
|
||
"moduleFolder": "order.index",
|
||
"method": "order.detail",
|
||
"title": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids / id / order_id / orderId",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
|
||
},
|
||
{
|
||
"name": "tableType / tablePosition / type / moduleName",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "订单头对象(raw 行数据)"
|
||
},
|
||
{
|
||
"name": "detail",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "等同于 order"
|
||
},
|
||
{
|
||
"name": "orderItems / items",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "商品明细数组"
|
||
},
|
||
{
|
||
"name": "expresses",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "运单信息数组"
|
||
},
|
||
{
|
||
"name": "waybill_codes",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "去重后的运单号字符串数组"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单委托外仓模块",
|
||
"moduleKey": "order.entrustOrder",
|
||
"moduleFolder": "order.entrustorder",
|
||
"method": "order.entrustOrder.detail",
|
||
"title": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids / id / order_id / orderId",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
|
||
},
|
||
{
|
||
"name": "tableType / tablePosition / type / moduleName",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "订单头对象(raw 行数据)"
|
||
},
|
||
{
|
||
"name": "detail",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "等同于 order"
|
||
},
|
||
{
|
||
"name": "orderItems / items",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "商品明细数组"
|
||
},
|
||
{
|
||
"name": "expresses",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "运单信息数组"
|
||
},
|
||
{
|
||
"name": "waybill_codes",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "去重后的运单号字符串数组"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单委托外仓模块",
|
||
"moduleKey": "order.entrustOrder",
|
||
"moduleFolder": "order.entrustorder",
|
||
"method": "order.entrustOrder.list",
|
||
"title": "委托外仓订单列表,使用 outsourced 模型。",
|
||
"description": "委托外仓订单列表,使用 outsourced 模型。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "排序参数,支持 sortField / sortOrder"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单异常模块",
|
||
"moduleKey": "order.expectionOrder",
|
||
"moduleFolder": "order.expectionorder",
|
||
"method": "order.expectionOrder.detail",
|
||
"title": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids / id / order_id / orderId",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
|
||
},
|
||
{
|
||
"name": "tableType / tablePosition / type / moduleName",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "订单头对象(raw 行数据)"
|
||
},
|
||
{
|
||
"name": "detail",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "等同于 order"
|
||
},
|
||
{
|
||
"name": "orderItems / items",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "商品明细数组"
|
||
},
|
||
{
|
||
"name": "expresses",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "运单信息数组"
|
||
},
|
||
{
|
||
"name": "waybill_codes",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "去重后的运单号字符串数组"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单异常模块",
|
||
"moduleKey": "order.expectionOrder",
|
||
"moduleFolder": "order.expectionorder",
|
||
"method": "order.expectionOrder.list",
|
||
"title": "待处理异常订单列表,默认仅查询 step=3 的订单。",
|
||
"description": "待处理异常订单列表,默认仅查询 step=3 的订单。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "排序参数,支持 sortField / sortOrder"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单异常模块",
|
||
"moduleKey": "order.expectionOrder",
|
||
"moduleFolder": "order.expectionorder",
|
||
"method": "order.expectionOrder.resolveException",
|
||
"title": "将待处理异常订单转回正常待处理状态(step 3 → 2)。只操作当前仓库的当前订单表,且仅对 step=3 的订单生效。",
|
||
"description": "将待处理异常订单转回正常待处理状态(step 3 → 2)。只操作当前仓库的当前订单表,且仅对 step=3 的订单生效。",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "订单ID 正整数数组,不能为空"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "updated_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "实际更新行数"
|
||
},
|
||
{
|
||
"name": "ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "本次操作的订单ID 列表"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单工作台入口模块",
|
||
"moduleKey": "order.index",
|
||
"moduleFolder": "order.index",
|
||
"method": "order.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.detail",
|
||
"title": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids / id / order_id / orderId",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
|
||
},
|
||
{
|
||
"name": "tableType / tablePosition / type / moduleName",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "订单头对象(raw 行数据)"
|
||
},
|
||
{
|
||
"name": "detail",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "等同于 order"
|
||
},
|
||
{
|
||
"name": "orderItems / items",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "商品明细数组"
|
||
},
|
||
{
|
||
"name": "expresses",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "运单信息数组"
|
||
},
|
||
{
|
||
"name": "waybill_codes",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "去重后的运单号字符串数组"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单待出库模块",
|
||
"moduleKey": "order.outboundOrder",
|
||
"moduleFolder": "order.outboundorder",
|
||
"method": "order.outboundOrder.list",
|
||
"title": "待出库订单列表,默认筛选 outbound_status in [none,padding] 且 step in [1,2]。",
|
||
"description": "待出库订单列表,默认筛选 outbound_status in [none,padding] 且 step in [1,2]。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "排序参数,支持 sortField / sortOrder"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单待出库模块",
|
||
"moduleKey": "order.outboundOrder",
|
||
"moduleFolder": "order.outboundorder",
|
||
"method": "order.outboundOrder.manualOutboundOrder",
|
||
"title": "待出库模块的手动出库入口,行为与 order.manualOutboundOrder 一致。",
|
||
"description": "待出库模块的手动出库入口,行为与 order.manualOutboundOrder 一致。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouseId",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "单仓库ID,兼容 warehouse_id"
|
||
},
|
||
{
|
||
"name": "warehouseIds",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "仓库ID 数组"
|
||
},
|
||
{
|
||
"name": "queryTimeoutMs",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "查询超时时间(毫秒)"
|
||
},
|
||
{
|
||
"name": "executionTimeoutMs",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "执行超时时间(毫秒)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "warehouseIds",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "参与迁移的仓库ID列表"
|
||
},
|
||
{
|
||
"name": "batchSize",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "单批处理上限,当前固定为 1000"
|
||
},
|
||
{
|
||
"name": "outboundStatuses",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "本次迁移匹配的出库状态"
|
||
},
|
||
{
|
||
"name": "totalSelected",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "命中的源订单数量"
|
||
},
|
||
{
|
||
"name": "totalCreated",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "实际创建到配送表的订单数量"
|
||
},
|
||
{
|
||
"name": "totalSkipped",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "本次跳过的源订单数量"
|
||
},
|
||
{
|
||
"name": "totalTimeout",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "被标记为出库超时的订单数量"
|
||
},
|
||
{
|
||
"name": "results",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "按仓库维度返回的批次结果数组,元素包含 selectedCount、createdCount、skippedCount、timeoutCount、retryableFailure 等字段"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "待处理订单模块",
|
||
"moduleKey": "order.pendingOrder",
|
||
"moduleFolder": "order.pendingorder",
|
||
"method": "order.pendingOrder.allocateExpressCode",
|
||
"title": "批量分配待处理订单的快递号,接收订单对象数组,复用 express.createWaybillCodePipeline。",
|
||
"description": "批量分配待处理订单的快递号,接收订单对象数组,复用 express.createWaybillCodePipeline。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "orders",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单对象数组;每个对象应为待处理订单列表或详情中获取的原始订单对象。每个订单对象必须包含 order_id 与 business_key;sys_platform_code 与 logistics_code 为订单对象自带字段,前端无需额外拼装或从外部构造,直接原样回传订单对象即可。其余字段会原样透传给运单创建链路。business_key 说明:business_key 是运单创建的序号键数组(例如:新分配 1 个运单号时传 [1];订单拆单时可能传 [2,3]),该字段会在 createWaybillCodePipeline 的返回 data 中原样返回,便于前端关联订单与运单创建结果。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "flag",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "全局调用结果标识,成功时为 success"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "业务状态码,200 表示成功"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "返回信息"
|
||
},
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "createWaybillCodePipeline 返回的运单创建结果,包含 success/failed 列表与 summary 等字段"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "待处理订单模块",
|
||
"moduleKey": "order.pendingOrder",
|
||
"moduleFolder": "order.pendingorder",
|
||
"method": "order.pendingOrder.allocateStorage",
|
||
"title": "按订单批量分配储位(迁移自 order.storageAllocation.allocateStorage)。这是一个异步提交接口:调用后接口立即返回受理信息(包含 request_id),后端异步执行实际的储位分配与锁定操作;仓库上下文由当前登录用户提供(ctx.user.store_id)。接口不会在同步响应中返回分配明细(如 requested_order_ids、allocated_order_ids 等),客户端可通过请求 ID 或事件/查询链路获取最终结果。",
|
||
"description": "按订单批量分配储位(迁移自 order.storageAllocation.allocateStorage)。这是一个异步提交接口:调用后接口立即返回受理信息(包含 request_id),后端异步执行实际的储位分配与锁定操作;仓库上下文由当前登录用户提供(ctx.user.store_id)。接口不会在同步响应中返回分配明细(如 requested_order_ids、allocated_order_ids 等),客户端可通过请求 ID 或事件/查询链路获取最终结果。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "allow_storage_location / allowStorageLocation / is_allow_storage / isAllowStorage",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否允许使用存储储位,支持多种字段别名。"
|
||
},
|
||
{
|
||
"name": "order_ids / orderIds / ids / order_id / orderId / id",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单 ID 列表,支持数组、逗号分隔字符串或单个 ID(兼容多种别名)。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "request_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "请求 ID(后端生成的唯一标识),用于查询任务状态或结果"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "生效的仓库 ID(来自当前用户 store_id)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "受理提示信息,通常为 '请求已受理,后端异步处理中' 或错误说明"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "待处理订单模块",
|
||
"moduleKey": "order.pendingOrder",
|
||
"moduleFolder": "order.pendingorder",
|
||
"method": "order.pendingOrder.allocateStorageProgress",
|
||
"title": "按 request_id 查询储位分配异步任务状态/结果(由 allocateStorage 提交)",
|
||
"description": "按 request_id 查询储位分配异步任务状态/结果(由 allocateStorage 提交)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "request_id / requestId",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务请求 ID,兼容字段 requestId"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "request_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "请求 ID(后端生成的唯一标识)"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
|
||
},
|
||
{
|
||
"name": "result",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "成功时返回底层分配结果,结构视实现而定"
|
||
},
|
||
{
|
||
"name": "error",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时返回的错误信息"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "关联仓库 ID(若任务关联仓库时返回)"
|
||
},
|
||
{
|
||
"name": "update_time",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "最近一次状态更新时间,ISO8601 字符串"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "额外提示信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "待处理订单模块",
|
||
"moduleKey": "order.pendingOrder",
|
||
"moduleFolder": "order.pendingorder",
|
||
"method": "order.pendingOrder.cancelAllocateStorage",
|
||
"title": "待处理模块的取消分配储位入口,直接对接 system service 的 cancelAllocateStorage。仅接受订单ID(order_ids)作为入参,不接受 allow_storage_location 或 warehouse_id/warehouseId;仓库上下文来自当前登录用户的 store_id。",
|
||
"description": "待处理模块的取消分配储位入口,直接对接 system service 的 cancelAllocateStorage。仅接受订单ID(order_ids)作为入参,不接受 allow_storage_location 或 warehouse_id/warehouseId;仓库上下文来自当前登录用户的 store_id。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_ids / orderIds / ids / order_id / orderId / id",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单 ID 列表;支持数组、逗号字符串或单个 ID(兼容多种别名)。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "flag",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "全局调用结果标识,成功为 success"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "业务状态码,200 表示成功"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "返回信息,成功或部分成功时给出摘要"
|
||
},
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "取消分配汇总结果,包含下列字段"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "待处理订单模块",
|
||
"moduleKey": "order.pendingOrder",
|
||
"moduleFolder": "order.pendingorder",
|
||
"method": "order.pendingOrder.cancelOrder",
|
||
"title": "将待处理订单批量取消,仅允许当前状态可取消的订单。",
|
||
"description": "将待处理订单批量取消,仅允许当前状态可取消的订单。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单 ID 正整数数组;不支持 id、order_id 或逗号字符串"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "首条更新记录 ID"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "新的订单状态"
|
||
},
|
||
{
|
||
"name": "step",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新的流程步骤"
|
||
},
|
||
{
|
||
"name": "updated_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "更新时间"
|
||
},
|
||
{
|
||
"name": "updated_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "受影响行数"
|
||
},
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "实际更新的订单 ID 列表"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "待处理订单模块",
|
||
"moduleKey": "order.pendingOrder",
|
||
"moduleFolder": "order.pendingorder",
|
||
"method": "order.pendingOrder.cloneOrder",
|
||
"title": "克隆待处理订单。完整流程:1. 查找原订单,校验可取消状态(step 0/1/2/3);2. 若原订单已分配储位(storage_status='fin'),先清除已分配库存;3. 取消原订单(step→9, status→cancel),记录克隆日志;4. 以原订单业务数据创建新订单,所有流程状态字段重置为初始落库状态;5. 克隆订单明细(含 stock_id),重置 order_id 为新订单 ID;6. 对新订单记录克隆创建日志。",
|
||
"description": "克隆待处理订单。完整流程:1. 查找原订单,校验可取消状态(step 0/1/2/3);2. 若原订单已分配储位(storage_status='fin'),先清除已分配库存;3. 取消原订单(step→9, status→cancel),记录克隆日志;4. 以原订单业务数据创建新订单,所有流程状态字段重置为初始落库状态;5. 克隆订单明细(含 stock_id),重置 order_id 为新订单 ID;6. 对新订单记录克隆创建日志。",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "原订单ID,正整数"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "source_order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "原订单ID(已取消)"
|
||
},
|
||
{
|
||
"name": "new_order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新订单ID(克隆生成)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "待处理订单模块",
|
||
"moduleKey": "order.pendingOrder",
|
||
"moduleFolder": "order.pendingorder",
|
||
"method": "order.pendingOrder.createOrder",
|
||
"title": "手动创建待处理订单。根据货主策略(need_order_approval)决定初始步骤:need_order_approval=1 进待审核(step=0),need_order_approval=0 直接进待处理(step=1)。",
|
||
"description": "手动创建待处理订单。根据货主策略(need_order_approval)决定初始步骤:need_order_approval=1 进待审核(step=0),need_order_approval=0 直接进待处理(step=1)。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "货主ID(正整数)"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "收件人姓名"
|
||
},
|
||
{
|
||
"name": "mobile",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "收件人手机号,mobile 与 tel 至少填一项"
|
||
},
|
||
{
|
||
"name": "tel",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "收件人电话,mobile 与 tel 至少填一项"
|
||
},
|
||
{
|
||
"name": "detail_address",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "详细地址"
|
||
},
|
||
{
|
||
"name": "province",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "省份"
|
||
},
|
||
{
|
||
"name": "city",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "城市"
|
||
},
|
||
{
|
||
"name": "area",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "区/县"
|
||
},
|
||
{
|
||
"name": "town",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "镇/街道"
|
||
},
|
||
{
|
||
"name": "zip_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "邮编"
|
||
},
|
||
{
|
||
"name": "items",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单明细数组,每项含 item_code(商品编码)和 plan_qty(计划数量,正整数);item_name、order_line_no、actual_price 为可选"
|
||
},
|
||
{
|
||
"name": "delivery_order_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "订单号,不填则自动生成(SYS + 时间戳 + 随机4位)"
|
||
},
|
||
{
|
||
"name": "logistics_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "快递编码,不填则读货主默认快递策略(policy_config.default_express_code)"
|
||
},
|
||
{
|
||
"name": "logistics_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "快递名称"
|
||
},
|
||
{
|
||
"name": "sys_platform_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "系统平台编码,不填则读货主默认平台策略(policy_config.default_platform_code)"
|
||
},
|
||
{
|
||
"name": "source_platform_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "来源平台编码"
|
||
},
|
||
{
|
||
"name": "source_order_codes",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "来源订单号"
|
||
},
|
||
{
|
||
"name": "order_type",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "订单类型"
|
||
},
|
||
{
|
||
"name": "is_urgency",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "是否紧急:Y/N,默认 N"
|
||
},
|
||
{
|
||
"name": "invoice_flag",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "是否需要发票:Y/N,默认 N"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新创建的订单 ID"
|
||
},
|
||
{
|
||
"name": "delivery_order_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "订单号(传入值或自动生成值)"
|
||
},
|
||
{
|
||
"name": "step",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "初始步骤:0=待审核,1=待处理"
|
||
},
|
||
{
|
||
"name": "step_label",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "步骤说明:待审核 / 待处理"
|
||
},
|
||
{
|
||
"name": "items_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "商品种类数"
|
||
},
|
||
{
|
||
"name": "items_total",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "商品总件数"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "待处理订单模块",
|
||
"moduleKey": "order.pendingOrder",
|
||
"moduleFolder": "order.pendingorder",
|
||
"method": "order.pendingOrder.detail",
|
||
"title": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids / id / order_id / orderId",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
|
||
},
|
||
{
|
||
"name": "tableType / tablePosition / type / moduleName",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "订单头对象(raw 行数据)"
|
||
},
|
||
{
|
||
"name": "detail",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "等同于 order"
|
||
},
|
||
{
|
||
"name": "orderItems / items",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "商品明细数组"
|
||
},
|
||
{
|
||
"name": "expresses",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "运单信息数组"
|
||
},
|
||
{
|
||
"name": "waybill_codes",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "去重后的运单号字符串数组"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "待处理订单模块",
|
||
"moduleKey": "order.pendingOrder",
|
||
"moduleFolder": "order.pendingorder",
|
||
"method": "order.pendingOrder.downloadCreateTemplate",
|
||
"title": "下载创建订单的 Excel 导入模板。返回 base64 编码的 xlsx 文件,前端解码后作为附件下载。表头中标注 * 的列为必填项,多行相同订单号的行组成一个完整订单。",
|
||
"description": "下载创建订单的 Excel 导入模板。返回 base64 编码的 xlsx 文件,前端解码后作为附件下载。表头中标注 * 的列为必填项,多行相同订单号的行组成一个完整订单。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [
|
||
{
|
||
"name": "base64",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "base64 编码的 xlsx 文件内容"
|
||
},
|
||
{
|
||
"name": "filename",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "建议保存的文件名"
|
||
},
|
||
{
|
||
"name": "mime",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "文件 MIME 类型"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "待处理订单模块",
|
||
"moduleKey": "order.pendingOrder",
|
||
"moduleFolder": "order.pendingorder",
|
||
"method": "order.pendingOrder.importOrdersFromExcel",
|
||
"title": "通过 Excel 文件批量创建订单。接受 base64 编码的 xlsx 内容,按订单号分组,每组创建一个订单(step 由货主策略决定)。每行代表一条商品明细;同一订单号的多行组成一个完整订单,头信息取每组第一行。",
|
||
"description": "通过 Excel 文件批量创建订单。接受 base64 编码的 xlsx 内容,按订单号分组,每组创建一个订单(step 由货主策略决定)。每行代表一条商品明细;同一订单号的多行组成一个完整订单,头信息取每组第一行。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "file_base64",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "base64 编码的 .xlsx 文件内容"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "total",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "解析到的订单总数"
|
||
},
|
||
{
|
||
"name": "success_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "创建成功的订单数"
|
||
},
|
||
{
|
||
"name": "fail_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "创建失败的订单数"
|
||
},
|
||
{
|
||
"name": "success_orders",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "成功订单列表,每项含 delivery_order_code、order_id、step、step_label"
|
||
},
|
||
{
|
||
"name": "fail_orders",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "失败订单列表,每项含 delivery_order_code、error(失败原因)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "待处理订单模块",
|
||
"moduleKey": "order.pendingOrder",
|
||
"moduleFolder": "order.pendingorder",
|
||
"method": "order.pendingOrder.list",
|
||
"title": "待处理订单列表,默认筛选 outbound_status != padding 且 step in [1,2]。",
|
||
"description": "待处理订单列表,默认筛选 outbound_status != padding 且 step in [1,2]。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "排序参数,支持 sortField / sortOrder"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"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.pendingOrder",
|
||
"moduleFolder": "order.pendingorder",
|
||
"method": "order.pendingOrder.syncOrderIds",
|
||
"title": "同步待处理订单入口,仅接收 order_ids 并转发到服务层,当前不做业务处理。",
|
||
"description": "同步待处理订单入口,仅接收 order_ids 并转发到服务层,当前不做业务处理。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_ids / orderIds / ids / order_id / orderId / id",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单 ID 列表,支持数组、逗号分隔字符串或单个 ID。当前仅透传到服务层,不做额外处理。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "flag",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "全局调用结果标识,成功为 success"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "业务状态码,200 表示成功"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "返回信息,当前仅做受理提示"
|
||
},
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "服务层返回值,当前仅透传 order_ids"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "待处理订单模块",
|
||
"moduleKey": "order.pendingOrder",
|
||
"moduleFolder": "order.pendingorder",
|
||
"method": "order.pendingOrder.updateOrderExpress",
|
||
"title": "批量修改待处理订单的快递信息。用 express_code 从当前仓库快递列表(带缓存)中查找对应项:若为自定义映射(is_system_setting=true),sys_logistics_code/name 写系统快递编码和名称,logistics_code/name 写自定义编码和名称;若为系统快递(is_system_setting=false),四个字段均写系统快递的 code/name;未找到则报错。只操作当前仓库的当前订单表,不处理其他订单表。",
|
||
"description": "批量修改待处理订单的快递信息。用 express_code 从当前仓库快递列表(带缓存)中查找对应项:若为自定义映射(is_system_setting=true),sys_logistics_code/name 写系统快递编码和名称,logistics_code/name 写自定义编码和名称;若为系统快递(is_system_setting=false),四个字段均写系统快递的 code/name;未找到则报错。只操作当前仓库的当前订单表,不处理其他订单表。",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "订单ID 正整数数组,不能为空"
|
||
},
|
||
{
|
||
"name": "express_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "快递编码,可为系统编码或仓库自定义编码"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "updated_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "实际更新行数"
|
||
},
|
||
{
|
||
"name": "sys_logistics_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "写入的系统快递编码"
|
||
},
|
||
{
|
||
"name": "sys_logistics_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "写入的系统快递名称"
|
||
},
|
||
{
|
||
"name": "logistics_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "写入的快递编码(自定义或系统)"
|
||
},
|
||
{
|
||
"name": "logistics_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "写入的快递名称(自定义或系统)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "待处理订单模块",
|
||
"moduleKey": "order.pendingOrder",
|
||
"moduleFolder": "order.pendingorder",
|
||
"method": "order.pendingOrder.updateOrderPlatform",
|
||
"title": "批量修改待处理订单的平台信息。用 code 查找 wms_platform 表,若平台存在则将订单的 sys_platform_code 和 sys_platform_name 更新为该平台的 code/name;若平台不存在则返回错误。只操作当前仓库的当前订单表,不处理其他订单表。",
|
||
"description": "批量修改待处理订单的平台信息。用 code 查找 wms_platform 表,若平台存在则将订单的 sys_platform_code 和 sys_platform_name 更新为该平台的 code/name;若平台不存在则返回错误。只操作当前仓库的当前订单表,不处理其他订单表。",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "订单ID 正整数数组,不能为空"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "平台编码,对应 wms_platform.code"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "updated_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "实际更新行数"
|
||
},
|
||
{
|
||
"name": "sys_platform_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "更新后的平台编码"
|
||
},
|
||
{
|
||
"name": "sys_platform_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "更新后的平台名称"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单打印模块",
|
||
"moduleKey": "order.print",
|
||
"moduleFolder": "order.print",
|
||
"method": "order.print.getWavePrintData",
|
||
"title": "按波次 IDs 获取订单打印数据,自动过滤快递未完全分配的波次,返回通过过滤的波次订单明细,按波次号分组",
|
||
"description": "按波次 IDs 获取订单打印数据,自动过滤快递未完全分配的波次,返回通过过滤的波次订单明细,按波次号分组",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "仓库ID"
|
||
},
|
||
{
|
||
"name": "wave_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "波次ID列表(支持数字或字符串,内部自动去重与归一化)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "summary",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "汇总信息"
|
||
},
|
||
{
|
||
"name": "wave_list",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "波次列表(按 wave_no 排序)"
|
||
},
|
||
{
|
||
"name": "ext",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "扩展字段"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单工作台入口模块",
|
||
"moduleKey": "order.index",
|
||
"moduleFolder": "order.index",
|
||
"method": "order.queryOrderLogList",
|
||
"title": "按 order_id 查询订单操作日志,返回全量日志(不分页)。接口按当前登录用户的仓库上下文过滤(method 层从 ctx.user.store_id 获取 warehouse_id),以防跨仓越界。",
|
||
"description": "按 order_id 查询订单操作日志,返回全量日志(不分页)。接口按当前登录用户的仓库上下文过滤(method 层从 ctx.user.store_id 获取 warehouse_id),以防跨仓越界。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_id / id / orderId",
|
||
"type": "string|number",
|
||
"required": true,
|
||
"description": "订单ID;支持别名 id 与 orderId,接口会兼容解析。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "日志列表(全量返回,无分页)。每项字段与 stock.warehouse.queryStockLogs 保持一致,典型字段包括 id、action、message、actor、created_at、warehouse_id 等。"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单工作台入口模块",
|
||
"moduleKey": "order.index",
|
||
"moduleFolder": "order.index",
|
||
"method": "order.queryOrderLogs",
|
||
"title": "查询当前仓库下订单操作日志,底层复用通用日志查询分页结构,按订单ID筛选。",
|
||
"description": "查询当前仓库下订单操作日志,底层复用通用日志查询分页结构,按订单ID筛选。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "订单ID"
|
||
},
|
||
{
|
||
"name": "page",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "页码"
|
||
},
|
||
{
|
||
"name": "pageSize",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "每页数量"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "日志列表,字段与 stock.warehouse.queryStockLogs 保持一致"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息,包含 page、pageSize、total、totalPages"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单待审核模块",
|
||
"moduleKey": "order.reviewOrder",
|
||
"moduleFolder": "order.revieworder",
|
||
"method": "order.reviewOrder.detail",
|
||
"title": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids / id / order_id / orderId",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
|
||
},
|
||
{
|
||
"name": "tableType / tablePosition / type / moduleName",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "订单头对象(raw 行数据)"
|
||
},
|
||
{
|
||
"name": "detail",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "等同于 order"
|
||
},
|
||
{
|
||
"name": "orderItems / items",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "商品明细数组"
|
||
},
|
||
{
|
||
"name": "expresses",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "运单信息数组"
|
||
},
|
||
{
|
||
"name": "waybill_codes",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "去重后的运单号字符串数组"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单待审核模块",
|
||
"moduleKey": "order.reviewOrder",
|
||
"moduleFolder": "order.revieworder",
|
||
"method": "order.reviewOrder.list",
|
||
"title": "待审核订单列表,默认仅查询 step=0 的订单。",
|
||
"description": "待审核订单列表,默认仅查询 step=0 的订单。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "排序参数,支持 sortField / sortOrder"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单待审核模块",
|
||
"moduleKey": "order.reviewOrder",
|
||
"moduleFolder": "order.revieworder",
|
||
"method": "order.reviewOrder.reviewOrder",
|
||
"title": "批量审核通过订单并进入待处理。",
|
||
"description": "批量审核通过订单并进入待处理。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单 ID 数组;仅允许 ids 字段,建议传数组,也兼容逗号字符串或单值"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "首条更新记录 ID"
|
||
},
|
||
{
|
||
"name": "inspection_status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "新的审核状态"
|
||
},
|
||
{
|
||
"name": "step",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新的流程步骤"
|
||
},
|
||
{
|
||
"name": "updated_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "更新时间"
|
||
},
|
||
{
|
||
"name": "updated_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "受影响行数"
|
||
},
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "实际更新的订单 ID 列表"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.batchAllocateExpress",
|
||
"title": "提交批次分配快递号任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到快递号分配流水线。",
|
||
"description": "提交批次分配快递号任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到快递号分配流水线。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "wave_ids / waveIds / ids",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "波次ID列表;支持数组、逗号分隔字符串或单个ID"
|
||
},
|
||
{
|
||
"name": "task_id / taskId",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选外部任务ID,用于幂等提交"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "提交状态,固定 success"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(用于查询任务进度)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前仓库ID"
|
||
},
|
||
{
|
||
"name": "accepted_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务受理时间(ISO8601)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "受理提示信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.batchAllocateExpressTaskProgress",
|
||
"title": "查询批次分配快递号任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
|
||
"description": "查询批次分配快递号任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "task_id / taskId",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成或提交时传入)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID"
|
||
},
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务关联仓库ID"
|
||
},
|
||
{
|
||
"name": "total_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "波次数量"
|
||
},
|
||
{
|
||
"name": "total_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "参与分配的订单数量"
|
||
},
|
||
{
|
||
"name": "processed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已处理订单数量"
|
||
},
|
||
{
|
||
"name": "success_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "成功提交分配的订单数量"
|
||
},
|
||
{
|
||
"name": "failed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "提交分配失败的订单数量"
|
||
},
|
||
{
|
||
"name": "progress_percent",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "进度百分比(0-100)"
|
||
},
|
||
{
|
||
"name": "duration_ms",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务耗时(毫秒)"
|
||
},
|
||
{
|
||
"name": "error_message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误信息"
|
||
},
|
||
{
|
||
"name": "error_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误码"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.batchAllocateStorage",
|
||
"title": "提交批次分配储位任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到储位分配流水线。",
|
||
"description": "提交批次分配储位任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到储位分配流水线。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "wave_ids / waveIds / ids",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "波次ID列表;支持数组、逗号分隔字符串或单个ID"
|
||
},
|
||
{
|
||
"name": "task_id / taskId",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选外部任务ID,用于幂等提交"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "提交状态,固定 success"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(用于查询任务进度)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前仓库ID"
|
||
},
|
||
{
|
||
"name": "accepted_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务受理时间(ISO8601)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "受理提示信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.batchAllocateStorageTaskProgress",
|
||
"title": "查询批次分配储位任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
|
||
"description": "查询批次分配储位任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "task_id / taskId",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成或提交时传入)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID"
|
||
},
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务关联仓库ID"
|
||
},
|
||
{
|
||
"name": "total_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "波次数量"
|
||
},
|
||
{
|
||
"name": "total_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "参与分配的订单数量"
|
||
},
|
||
{
|
||
"name": "processed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已处理订单数量"
|
||
},
|
||
{
|
||
"name": "success_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "成功提交分配的订单数量"
|
||
},
|
||
{
|
||
"name": "failed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "提交分配失败的订单数量"
|
||
},
|
||
{
|
||
"name": "progress_percent",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "进度百分比(0-100)"
|
||
},
|
||
{
|
||
"name": "duration_ms",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务耗时(毫秒)"
|
||
},
|
||
{
|
||
"name": "error_message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误信息"
|
||
},
|
||
{
|
||
"name": "error_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误码"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.batchAutoGrouping",
|
||
"title": "批量将波次状态修改为 0(自动加团中),仅作用当前登录仓库命中的波次。限制条件: - 跳过已打印及之后状态的波次(wave_status >= 2); - 跳过 total_orders >= 仓库配置 max_wave_quantity 的波次。被跳过的波次不会被修改为自动加团中。",
|
||
"description": "批量将波次状态修改为 0(自动加团中),仅作用当前登录仓库命中的波次。限制条件: - 跳过已打印及之后状态的波次(wave_status >= 2); - 跳过 total_orders >= 仓库配置 max_wave_quantity 的波次。被跳过的波次不会被修改为自动加团中。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "波次ID 列表;支持数组、逗号分隔字符串或单个ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "归一化后的请求ID"
|
||
},
|
||
{
|
||
"name": "affected_wave_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "实际命中的波次ID"
|
||
},
|
||
{
|
||
"name": "updated_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "实际更新数量"
|
||
},
|
||
{
|
||
"name": "skipped_wave_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "被跳过的波次ID数组(不修改状态)"
|
||
},
|
||
{
|
||
"name": "skipped_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "被跳过的波次数量"
|
||
},
|
||
{
|
||
"name": "skipped_details",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "被跳过的波次明细數組,元素包含 wave_id 与 reason,reason 枚举 printed_or_after_printed / reach_max_wave_quantity"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.batchCancel",
|
||
"title": "提交批量解除波次异步任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理波次并执行解除操作;可通过 order.wave.batchCancelTaskProgress 查询进度与结果。",
|
||
"description": "提交批量解除波次异步任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理波次并执行解除操作;可通过 order.wave.batchCancelTaskProgress 查询进度与结果。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "wave_ids / waveIds / ids",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "波次ID列表;支持数组、逗号分隔字符串或单个ID"
|
||
},
|
||
{
|
||
"name": "task_id / taskId",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选外部任务ID,用于幂等提交"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "提交状态,固定 success"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(用于查询任务进度)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前仓库ID"
|
||
},
|
||
{
|
||
"name": "accepted_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务受理时间(ISO8601)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "受理提示信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.batchCancelTaskProgress",
|
||
"title": "查询批量解除波次任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。响应包含 state、progress_percent、processed_wave_count、total_wave_count;当 state 为 success/failed 时返回额外字段说明。",
|
||
"description": "查询批量解除波次任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。响应包含 state、progress_percent、processed_wave_count、total_wave_count;当 state 为 success/failed 时返回额外字段说明。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "task_id / taskId",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成或提交时传入)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID"
|
||
},
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
|
||
},
|
||
{
|
||
"name": "progress_percent",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "进度百分比(0-100)"
|
||
},
|
||
{
|
||
"name": "processed_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已处理的波次数量"
|
||
},
|
||
{
|
||
"name": "total_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "总波次数量"
|
||
},
|
||
{
|
||
"name": "duration_ms",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务耗时(毫秒)"
|
||
},
|
||
{
|
||
"name": "error_message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误信息(仅在 state=failed 时返回)"
|
||
},
|
||
{
|
||
"name": "error_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误码(仅在 state=failed 时返回)"
|
||
},
|
||
{
|
||
"name": "result",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "成功时返回的汇总结果(仅在 state=success 时返回),例如 { \"processed_wave_count\": number, \"canceled_wave_count\": number }"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.batchFinishAutoGrouping",
|
||
"title": "批量结束自动加团,将当前仓库命中且 wave_status=0 的波次改为 1(已就绪)。",
|
||
"description": "批量结束自动加团,将当前仓库命中且 wave_status=0 的波次改为 1(已就绪)。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "波次ID 列表;支持数组、逗号分隔字符串或单个ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "归一化后的请求ID"
|
||
},
|
||
{
|
||
"name": "affected_wave_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "实际命中的波次ID"
|
||
},
|
||
{
|
||
"name": "updated_wave_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "实际更新为已就绪的波次ID"
|
||
},
|
||
{
|
||
"name": "updated_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "实际更新数量"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "order.wave",
|
||
"moduleKey": "order",
|
||
"moduleFolder": "order",
|
||
"method": "order.wave.batchList",
|
||
"title": "波次列表查询。仅使用当前登录操作者的仓库ID作为查询约束(禁止传入 warehouse_id / warehouseId)。支持通过白名单字段进行过滤(通过 where 对象传入),接口对 wave_status 固定叠加查询状态 0/1,无需客户端传入。列表按订单数量从大到小排序,并附带波次基础信息与分配状态汇总。",
|
||
"description": "波次列表查询。仅使用当前登录操作者的仓库ID作为查询约束(禁止传入 warehouse_id / warehouseId)。支持通过白名单字段进行过滤(通过 where 对象传入),接口对 wave_status 固定叠加查询状态 0/1,无需客户端传入。列表按订单数量从大到小排序,并附带波次基础信息与分配状态汇总。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "筛选白名单字段(object,可选)。仅支持下列字段过滤,且禁止传入 warehouse_id / warehouseId: - wave_id(等值) - wave_no(模糊) - wave_type(等值) - wave_status(等值,接口固定叠加状态 0/1) - creator(模糊) - logistics_name(模糊) - item_part_type(等值) - item_part(模糊) - item_snapshot_key(模糊) - item_detail_machine(模糊) - distinguish_express(等值) - total_orders_min / total_orders_max(范围) - processed_orders_min / processed_orders_max(范围) - storage_assignment_status(等值,string,可选,取值:未分配、部分分配、已分配;默认不传不做限制)。过滤语义:已分配=聚合后全部 fin;部分分配=不含 error,且既不是全 none,也不是全 fin;未分配=全 none 或包含 error(异常并入未分配筛选集合)。说明:返回字段 storage_assignment_status 的展示值保持不变,包含 error 时仍可显示“分配异常”;此处 where 的过滤语义会把异常计入“未分配”,以避免把过滤语义与展示值混淆。 - source(可选,number)来源过滤:0=普通波次(正常后台操作),1=管理后台策略任务,2=PDA策略任务;不传则不过滤。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "波次列表,包含波次基础信息与状态汇总(order_count / storage_assignment_status / express_assignment_status / print_assignment_status)。每条记录新增字段 source(number):来源标识,0=普通波次(正常后台操作),1=管理后台策略任务,2=PDA策略任务。"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.batchRemoveExceptionOrders",
|
||
"title": "提交批次移除异常订单任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取异常订单并移出波次。",
|
||
"description": "提交批次移除异常订单任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取异常订单并移出波次。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "wave_ids / waveIds / ids",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "波次ID列表;支持数组、逗号分隔字符串或单个ID"
|
||
},
|
||
{
|
||
"name": "task_id / taskId",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选外部任务ID,用于幂等提交"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "提交状态,固定 success"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(用于查询任务进度)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前仓库ID"
|
||
},
|
||
{
|
||
"name": "accepted_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务受理时间(ISO8601)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "受理提示信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.batchRemoveExceptionOrdersTaskProgress",
|
||
"title": "查询批次移除异常订单任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
|
||
"description": "查询批次移除异常订单任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "task_id / taskId",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成或提交时传入)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID"
|
||
},
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务关联仓库ID"
|
||
},
|
||
{
|
||
"name": "total_wave_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "波次数量"
|
||
},
|
||
{
|
||
"name": "total_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "参与处理的订单数量"
|
||
},
|
||
{
|
||
"name": "processed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已处理订单数量"
|
||
},
|
||
{
|
||
"name": "removed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已成功移出波次的订单数量"
|
||
},
|
||
{
|
||
"name": "failed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "处理失败的订单数量"
|
||
},
|
||
{
|
||
"name": "progress_percent",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "进度百分比(0-100)"
|
||
},
|
||
{
|
||
"name": "duration_ms",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务耗时(毫秒)"
|
||
},
|
||
{
|
||
"name": "error_message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误信息"
|
||
},
|
||
{
|
||
"name": "error_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "失败时的错误码"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.batchRemoveOrders",
|
||
"title": "按订单ID批量移出波次;仅处理当前仓库的待处理订单表中非待审核订单(step in [1,2,3])。操作会清空订单的 wave_id/wave_no,并在同一事务内回写 wms_wave_batch 表:重算 total_orders,若波次被清空则将 wave_status 置为 -1。仓库上下文来自当前登录用户(ctx.user.store_id)。",
|
||
"description": "按订单ID批量移出波次;仅处理当前仓库的待处理订单表中非待审核订单(step in [1,2,3])。操作会清空订单的 wave_id/wave_no,并在同一事务内回写 wms_wave_batch 表:重算 total_orders,若波次被清空则将 wave_status 置为 -1。仓库上下文来自当前登录用户(ctx.user.store_id)。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids / order_ids / orderIds / order_id / orderId / id",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单 ID 列表;支持数组、逗号分隔字符串或单个 ID,以上别名均可用(ids、order_ids、orderIds、order_id、orderId、id)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "归一化后的请求 ID 列表"
|
||
},
|
||
{
|
||
"name": "removed_order_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "实际被移出波次的订单 ID 列表"
|
||
},
|
||
{
|
||
"name": "removed_order_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "被移出波次的订单数量"
|
||
},
|
||
{
|
||
"name": "affected_wave_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "本次操作涉及的波次 ID 列表"
|
||
},
|
||
{
|
||
"name": "updated_wave_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "实际更新了 total_orders 的波次 ID 列表"
|
||
},
|
||
{
|
||
"name": "emptied_wave_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "被清空且已置为 wave_status=-1 的波次 ID 列表"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.fetch",
|
||
"title": "兼容别名(等同 groupFetch)",
|
||
"description": "兼容别名(等同 groupFetch)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "structure_list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识),可选 quantity(未传入时使用仓库默认或全局默认)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "生效的仓库 ID"
|
||
},
|
||
{
|
||
"name": "structure_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "本次入参的结构数量(structure_list 长度)"
|
||
},
|
||
{
|
||
"name": "default_quantity",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "仓库默认抓取数量或全局默认值"
|
||
},
|
||
{
|
||
"name": "auto_fetch_disabled_marker",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "手动抓取标记;值为 'wave_manual_fetch' 表示手动抓取"
|
||
},
|
||
{
|
||
"name": "fetch_mode",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "抓取模式,值为 'group'(团购)或 'single'(散单)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.fetchTaskProgress",
|
||
"title": "查询波次抓取任务进度:按 task_id 查询任务状态与进度;兼容 taskId 参数名。",
|
||
"description": "查询波次抓取任务进度:按 task_id 查询任务状态与进度;兼容 taskId 参数名。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "task_id / taskId",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成的唯一标识),兼容旧参数名 taskId,可从 order.wave.fetch 的返回值中获取"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "生效的仓库 ID(若任务关联仓库时返回)"
|
||
},
|
||
{
|
||
"name": "structure_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "本次任务的结构数量(structure_list 长度)"
|
||
},
|
||
{
|
||
"name": "finished_structure_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已完成抓取的结构数量"
|
||
},
|
||
{
|
||
"name": "progress_percent",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "进度百分比(0-100,可能为小数)"
|
||
},
|
||
{
|
||
"name": "total_fetched_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已抓取的总件数"
|
||
},
|
||
{
|
||
"name": "duration_ms",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务已运行时长,毫秒级"
|
||
},
|
||
{
|
||
"name": "error",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "错误信息,仅当 status=failed 时返回"
|
||
},
|
||
{
|
||
"name": "fetch_mode",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "抓取模式,值为 'group'(团购)或 'single'(散单);single 模式时可能返回下列额外字段"
|
||
},
|
||
{
|
||
"name": "max_fetch_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "当 fetch_mode=single 时返回的最大抓取上限(订单数,正整数)"
|
||
},
|
||
{
|
||
"name": "limit_reached",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "当 fetch_mode=single 时指示是否已达到 max_fetch_quantity 限制"
|
||
},
|
||
{
|
||
"name": "stop_reason",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "任务停止原因(如达到上限、人工停止或其他失败原因)"
|
||
},
|
||
{
|
||
"name": "update_time",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "最近一次状态更新时间,ISO8601 字符串"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "额外提示信息"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.groupFetch",
|
||
"title": "抓取团购接口(异步任务提交)",
|
||
"description": "抓取团购接口(异步任务提交)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "structure_list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识),可选 quantity(未传入时使用仓库默认或全局默认)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "生效的仓库 ID"
|
||
},
|
||
{
|
||
"name": "structure_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "本次入参的结构数量(structure_list 长度)"
|
||
},
|
||
{
|
||
"name": "default_quantity",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "仓库默认抓取数量或全局默认值"
|
||
},
|
||
{
|
||
"name": "auto_fetch_disabled_marker",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "手动抓取标记;值为 'wave_manual_fetch' 表示手动抓取"
|
||
},
|
||
{
|
||
"name": "fetch_mode",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "抓取模式,值为 'group'(团购)或 'single'(散单)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.groupOrderFetchList",
|
||
"title": "按机器结构分组的可抓取列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。",
|
||
"description": "按机器结构分组的可抓取列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize"
|
||
},
|
||
{
|
||
"name": "distinguish_express",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否区分快递(影响分组粒度)"
|
||
},
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "货主ID(仅作为筛选条件)"
|
||
},
|
||
{
|
||
"name": "same_order_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最小同组订单数量阈值(>=)。若显式传入有效数值则按传入值使用;未传入时使用仓库配置 min_group_order_fetch_quantity(默认 13)。"
|
||
},
|
||
{
|
||
"name": "shop_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "店铺名称(模糊匹配)"
|
||
},
|
||
{
|
||
"name": "include_sku",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "仅保留包含该 SKU 的分组(页内过滤)"
|
||
},
|
||
{
|
||
"name": "return_order_ids",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否在结果中返回组内订单ID列表"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "分组列表,items 示例见实现:包含 item_detail_machine/item_snapshot/group_count 等字段"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.singleFetch",
|
||
"title": "抓取散单接口(异步任务提交)",
|
||
"description": "抓取散单接口(异步任务提交)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "structure_list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识)并包含必填字段 max_fetch_quantity(最大抓取上限,订单数,正整数);可选 quantity(未传入时使用仓库默认或全局默认)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "生效的仓库 ID"
|
||
},
|
||
{
|
||
"name": "structure_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "本次入参的结构数量(structure_list 长度)"
|
||
},
|
||
{
|
||
"name": "default_quantity",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "仓库默认抓取数量或全局默认值"
|
||
},
|
||
{
|
||
"name": "auto_fetch_disabled_marker",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "手动抓取标记;值为 'wave_manual_fetch' 表示手动抓取"
|
||
},
|
||
{
|
||
"name": "fetch_mode",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "抓取模式,值为 'group'(团购)或 'single'(散单)"
|
||
},
|
||
{
|
||
"name": "max_fetch_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "提交时生效的最大抓取上限(订单数,正整数)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.singleFetchByIds",
|
||
"title": "按订单 ID 列表抓取到一个散单波次。仅处理当前仓库的待处理订单(step in [1,2,3]),排除已在波次中的订单(wave_id>0),不区分快递;成功抓取后批量写入订单操作日志;当无可抓取订单时返回 wave_id=0。",
|
||
"description": "按订单 ID 列表抓取到一个散单波次。仅处理当前仓库的待处理订单(step in [1,2,3]),排除已在波次中的订单(wave_id>0),不区分快递;成功抓取后批量写入订单操作日志;当无可抓取订单时返回 wave_id=0。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids / order_ids / orderIds",
|
||
"type": "array|string|number",
|
||
"required": true,
|
||
"description": "订单 ID 列表;支持数组、逗号分隔字符串或单个 ID。入参会被去重并转换为正整数。字段解析优先顺序:ids -> order_ids -> orderIds。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "请求归一化后的 ids 列表(去重且为正整数)"
|
||
},
|
||
{
|
||
"name": "wave_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "创建的波次 ID;若无可抓取订单返回 0"
|
||
},
|
||
{
|
||
"name": "wave_no",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "创建的波次号;无可抓取时为空字符串"
|
||
},
|
||
{
|
||
"name": "fetched_order_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "实际被抓取并成功分配到波次的订单 ID 列表(为归一化后的 ids 的子集)"
|
||
},
|
||
{
|
||
"name": "fetched_order_count",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "实际被抓取的订单数量(等于 fetched_order_ids.length)"
|
||
},
|
||
{
|
||
"name": "excluded_existing_wave_order_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "原始入参中已在其它波次中的订单 ID(被排除,不会被抓取)"
|
||
},
|
||
{
|
||
"name": "skipped_order_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "因订单状态不符、正在出库或其他业务原因被跳过的订单 ID(不会被抓取)"
|
||
},
|
||
{
|
||
"name": "not_found_order_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "入参中未在数据库中找到的订单 ID"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.singleOrderFetchList",
|
||
"title": "按机器结构分组的散单候选列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。与 order.wave.groupOrderFetchList 不同:groupOrderFetchList 返回满足同组订单数量 >= same_order_quantity(或仓库配置 min_group_order_fetch_quantity)的团购命中分组;singleOrderFetchList 则排除这些团购命中分组,仅返回同组订单数量小于该阈值的散单候选分组(即 < same_order_quantity)。",
|
||
"description": "按机器结构分组的散单候选列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。与 order.wave.groupOrderFetchList 不同:groupOrderFetchList 返回满足同组订单数量 >= same_order_quantity(或仓库配置 min_group_order_fetch_quantity)的团购命中分组;singleOrderFetchList 则排除这些团购命中分组,仅返回同组订单数量小于该阈值的散单候选分组(即 < same_order_quantity)。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize"
|
||
},
|
||
{
|
||
"name": "distinguish_express",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否区分快递(影响分组粒度)"
|
||
},
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "货主ID(仅作为筛选条件)"
|
||
},
|
||
{
|
||
"name": "same_order_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最小同组订单数量阈值(用于判定团购命中);本接口返回同组订单数量小于该阈值的分组。若显式传入有效数值则按传入值使用;未传入时使用仓库配置 min_group_order_fetch_quantity(默认 13)。"
|
||
},
|
||
{
|
||
"name": "shop_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "店铺名称(模糊匹配)"
|
||
},
|
||
{
|
||
"name": "include_sku",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "仅保留包含该 SKU 的分组(页内过滤)"
|
||
},
|
||
{
|
||
"name": "return_order_ids",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否在结果中返回组内订单ID列表"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "散单候选分组列表,items 示例见实现:包含 item_detail_machine/item_snapshot/group_count 等字段;返回的 group_count 均小于 same_order_quantity(或仓库配置的 min_group_order_fetch_quantity)。"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.wavePickTaskCancel",
|
||
"title": "取消拣货任务(批量),同时释放关联波次(物理删除波次记录,订单回池)、解绑拣货车、写操作日志。入参仅支持 task_ids(数组,必填),不再支持单个 task_id。操作人与仓库从请求上下文获取(例如当前登录用户上下文 ctx.user),若上下文缺失接口将返回错误。",
|
||
"description": "取消拣货任务(批量),同时释放关联波次(物理删除波次记录,订单回池)、解绑拣货车、写操作日志。入参仅支持 task_ids(数组,必填),不再支持单个 task_id。操作人与仓库从请求上下文获取(例如当前登录用户上下文 ctx.user),若上下文缺失接口将返回错误。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "task_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "任务ID数组,例如 [123,124];仅支持批量处理,不再支持单个 task_id。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "cancelled_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "成功取消的任务数量"
|
||
},
|
||
{
|
||
"name": "task_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "处理的任务ID数组(若后端返回)"
|
||
},
|
||
{
|
||
"name": "task_nos",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "处理的任务编号数组(若后端返回)"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "任务ID(历史兼容,若后端仍返回)"
|
||
},
|
||
{
|
||
"name": "task_no",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "任务编号(历史兼容,若后端仍返回)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.wavePickTaskList",
|
||
"title": "按当前仓库分页查询拣货任务列表。支持顶层分页参数 `page_no`/`page_size`(兼容 `pagination` 对象与 `current/size`),支持 `status` 单值或数组;兼容历史 `where` 结构,顶层参数优先。默认按 create_time desc 排序。",
|
||
"description": "按当前仓库分页查询拣货任务列表。支持顶层分页参数 `page_no`/`page_size`(兼容 `pagination` 对象与 `current/size`),支持 `status` 单值或数组;兼容历史 `where` 结构,顶层参数优先。默认按 create_time desc 排序。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "仓库ID(必填)"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize,兼容 current / size(兼容旧客户端)"
|
||
},
|
||
{
|
||
"name": "page_no",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "页码(优先于 pagination.page/current)"
|
||
},
|
||
{
|
||
"name": "page_size",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "每页大小(优先于 pagination.pageSize/size)"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "拣货任务状态过滤;建议传数组,也兼容单值或逗号分隔字符串,兼容 where.status;顶层参数优先"
|
||
},
|
||
{
|
||
"name": "review_status",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "复核状态过滤"
|
||
},
|
||
{
|
||
"name": "pick_mode",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "拣货模式(如批量/逐单等)"
|
||
},
|
||
{
|
||
"name": "source",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "任务来源标识(业务端语义)"
|
||
},
|
||
{
|
||
"name": "pick_user_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "拣货执行人ID(兼容旧字段)"
|
||
},
|
||
{
|
||
"name": "review_user_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "复核人ID"
|
||
},
|
||
{
|
||
"name": "task_no",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "任务编号(支持模糊匹配)"
|
||
},
|
||
{
|
||
"name": "cart_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "拣货车/作业车ID"
|
||
},
|
||
{
|
||
"name": "keyword",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "关键字搜索:支持 task_no / batch_no / current_cart_code_snapshot 等字段的模糊匹配"
|
||
},
|
||
{
|
||
"name": "start_time_start",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "开始时间(ISO 字符串),与 start_time_end 一起用于时间范围过滤"
|
||
},
|
||
{
|
||
"name": "start_time_end",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "结束时间(ISO 字符串),与 start_time_start 一起用于时间范围过滤"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "兼容历史 where 结构(可包含 status 等字段);当存在顶层同名参数时,顶层参数优先"
|
||
},
|
||
{
|
||
"name": "strategy_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "策略ID(当前主表未存,该接口会忽略此过滤,建议勿使用)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "拣货任务列表(数组),每项字段如下"
|
||
},
|
||
{
|
||
"name": "total",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "总记录数"
|
||
},
|
||
{
|
||
"name": "page",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "当前页码"
|
||
},
|
||
{
|
||
"name": "page_size",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "每页大小"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.waveStrategyCreate",
|
||
"title": "新增波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。创建成功后会推进仓库的 wave_strategy_version 并失效相关缓存。",
|
||
"description": "新增波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。创建成功后会推进仓库的 wave_strategy_version 并失效相关缓存。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "strategy_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "策略名称(必填)"
|
||
},
|
||
{
|
||
"name": "strategy_type",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "策略类型(必填,正整数):1-散单 2-团购"
|
||
},
|
||
{
|
||
"name": "batch_mode",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "拣货模式(必填,正整数)"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "状态:1-启用 0-停用(可选)"
|
||
},
|
||
{
|
||
"name": "order_min_sku",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最小 SKU 种类数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "order_max_sku",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最大 SKU 种类数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "order_min_qty",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最小商品总数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "order_max_qty",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最大商品总数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "min_same_structure",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最小相同结构订单数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "max_same_structure",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最大相同结构订单数(可选,正整数或 null)。注意:若传入值 >= 仓库配置的 min_group_order_fetch_quantity,则会被下调为 min_group_order_fetch_quantity - 1,最小为 1。"
|
||
},
|
||
{
|
||
"name": "batch_max_orders",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "批次最大订单数(可选)"
|
||
},
|
||
{
|
||
"name": "batch_max_skus",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "批次最大 SKU 总数(可选)"
|
||
},
|
||
{
|
||
"name": "group_batch_max_orders",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "团购批次最大订单数(可选)"
|
||
},
|
||
{
|
||
"name": "require_same_express",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否要求相同快递(可选,布尔)"
|
||
},
|
||
{
|
||
"name": "allow_cross_owner",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否允许跨货主(可选,布尔)"
|
||
},
|
||
{
|
||
"name": "description",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "策略描述(可选)"
|
||
},
|
||
{
|
||
"name": "allowed_provinces",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的省份列表(可选,支持数组、JSON 字符串或逗号分隔字符串)"
|
||
},
|
||
{
|
||
"name": "allowed_platforms",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的平台列表(可选,支持数组、JSON 字符串或逗号分隔字符串)"
|
||
},
|
||
{
|
||
"name": "allowed_owners",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的货主列表(可选,支持数组/JSON/逗号分隔);系统会校验所传货主是否在仓库可用货主范围内,非法值将导致 400 错误。"
|
||
},
|
||
{
|
||
"name": "allowed_expresses",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的快递编码列表(可选,支持数组/JSON/逗号分隔);系统会校验所传编码是否在可用快递列表内,非法值将导致 400 错误。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "创建的策略对象,字段同 order.wave.waveStrategyList.list[*] 所示"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "HTTP-like 状态码,成功时返回 200"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.waveStrategyFallbackOrderList",
|
||
"title": "基于波次策略的回退候选订单列表。该接口内置固定筛选条件:step != 0、wave_id = 0、wave_scan_result = 2。用于展示策略未命中但需回退处理的订单候选。",
|
||
"description": "基于波次策略的回退候选订单列表。该接口内置固定筛选条件:step != 0、wave_id = 0、wave_scan_result = 2。用于展示策略未命中但需回退处理的订单候选。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "筛选白名单字段(object)。仅支持下列字段,且禁止传入 warehouse_id / warehouseId: - id(等值) - delivery_no / deliveryNo(模糊) - tracking_no / trackingNo(模糊) - items_count_min / items_count_max(范围) - items_total_min / items_total_max(范围) - sys_logistics_name(模糊) - store_name(模糊) - owner_name(等值) - province(模糊) - sys_platform_name(模糊) 说明:若传入未列出的字段或禁止字段(如 warehouse_id)接口会返回 400。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "回退候选订单简要列表。数组内对象字段说明见 children。"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.waveStrategyFetchAdmin",
|
||
"title": "按策略提交并创建抓取主流程任务(后台管理)。当前为最小主流程:执行入参校验并创建任务记录,返回创建结果与计划预览;后续将扩展完整扫描/执行链路。",
|
||
"description": "按策略提交并创建抓取主流程任务(后台管理)。当前为最小主流程:执行入参校验并创建任务记录,返回创建结果与计划预览;后续将扩展完整扫描/执行链路。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "strategy_id / strategyId",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "策略ID(正整数,支持下划线/驼峰)"
|
||
},
|
||
{
|
||
"name": "cart_id / cartId",
|
||
"type": "string|number",
|
||
"required": false,
|
||
"description": "可选,关联拣货车/作业车ID,用于记录作业上下文或幂等识别"
|
||
},
|
||
{
|
||
"name": "source / operation_source",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选,操作来源标识(例如 admin/pda/manual/auto),用于审计与分流策略"
|
||
},
|
||
{
|
||
"name": "strategy_params / strategyParams",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "可选,策略参数透传对象(如 order_min_qty/order_max_qty/allow_cross_owner 等),在创建任务时作为策略覆盖或附加参数使用"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态:created(已创建主流程任务),后续可能为 running/success/failed"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务唯一 ID(用于后续查询或关联)"
|
||
},
|
||
{
|
||
"name": "task_no",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务业务编号(便于展示与关联)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "生效的仓库 ID(来自当前上下文,如可用则返回)"
|
||
},
|
||
{
|
||
"name": "strategy_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "生效的策略 ID(与入参保持一致,兼容回传)"
|
||
},
|
||
{
|
||
"name": "plan",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "任务计划/执行预览对象,描述本次任务预估的执行计划"
|
||
},
|
||
{
|
||
"name": "plan_summary",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "计划摘要字符串,便于前端在受理后快速展示(例如:'创建 3 个波次,涉及 120 单,约 450 件')"
|
||
},
|
||
{
|
||
"name": "validation_errors",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "当入参校验失败时返回的数组,每项为 { field, message } 对象,供前端展示或定位问题"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选提示信息或错误说明(创建失败时返回简短说明)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.waveStrategyFetchPda",
|
||
"title": "按策略提交并创建抓取主流程任务(PDA)。当前为最小主流程:进行入参校验并创建任务记录,返回创建结果与计划预览;后续扫描/执行阶段将扩展为完整执行流。",
|
||
"description": "按策略提交并创建抓取主流程任务(PDA)。当前为最小主流程:进行入参校验并创建任务记录,返回创建结果与计划预览;后续扫描/执行阶段将扩展为完整执行流。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "strategy_id / strategyId",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "策略ID(正整数,支持下划线/驼峰)"
|
||
},
|
||
{
|
||
"name": "cart_id / cartId",
|
||
"type": "string|number",
|
||
"required": false,
|
||
"description": "可选,关联拣货车/作业车ID,支持字符串或数字,用于记录作业上下文"
|
||
},
|
||
{
|
||
"name": "source / operation_source",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选,操作来源标识(例如 pda/admin/manual/auto),用于审计与分流策略"
|
||
},
|
||
{
|
||
"name": "strategy_params / strategyParams",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "可选,策略参数透传对象(如 order_min_qty/order_max_qty/allow_cross_owner 等),在创建任务时作为策略覆盖或附加参数使用"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态:created(已创建主流程任务),后续可能为 running/success/failed"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务唯一 ID(用于后续查询或关联)"
|
||
},
|
||
{
|
||
"name": "task_no",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务业务编号(便于展示与关联)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "生效的仓库 ID(来自当前上下文,如可用则返回)"
|
||
},
|
||
{
|
||
"name": "strategy_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "生效的策略 ID(与入参保持一致,兼容回传)"
|
||
},
|
||
{
|
||
"name": "plan",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "任务计划/执行预览对象,描述本次任务预估的执行计划"
|
||
},
|
||
{
|
||
"name": "plan_summary",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "计划摘要字符串,便于前端在受理后快速展示(例如:'创建 3 个波次,涉及 120 单,约 450 件')"
|
||
},
|
||
{
|
||
"name": "validation_errors",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "当入参校验失败时返回的数组,每项为 { field, message } 对象,供前端展示或定位问题"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选提示信息或错误说明(创建失败时返回简短说明)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.waveStrategyList",
|
||
"title": "查询当前仓库波次策略列表。仅查询当前登录仓库在 wms_wave_strategy 中的数据,返回标准 list/pagination 结构。",
|
||
"description": "查询当前仓库波次策略列表。仅查询当前登录仓库在 wms_wave_strategy 中的数据,返回标准 list/pagination 结构。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "策略列表,每项为波次策略记录"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.waveStrategyQuickScan",
|
||
"title": "提交波次策略快速扫描异步任务。无外部参数,使用当前仓库上下文;同一仓库同一时刻仅允许一个任务运行,若已有运行任务直接返回已有 task_id。",
|
||
"description": "提交波次策略快速扫描异步任务。无外部参数,使用当前仓库上下文;同一仓库同一时刻仅允许一个任务运行,若已有运行任务直接返回已有 task_id。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "提交状态,固定 success"
|
||
},
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(用于后续查询进度)"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "仓库 ID(来自当前上下文)"
|
||
},
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态(一般为 submitted 或 running)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "可选提示信息"
|
||
},
|
||
{
|
||
"name": "accepted_at",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "任务受理时间(ISO 字符串)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.waveStrategyQuickScanTaskProgress",
|
||
"title": "查询波次策略快速扫描任务进度。接受 task_id / taskId,若未找到返回 state='not_found'。",
|
||
"description": "查询波次策略快速扫描任务进度。接受 task_id / taskId,若未找到返回 state='not_found'。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "task_id / taskId",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID(下划线或驼峰兼容,必填)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "task_id",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务 ID"
|
||
},
|
||
{
|
||
"name": "state",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "任务状态:submitted/running/success/failed/not_found"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "仓库 ID"
|
||
},
|
||
{
|
||
"name": "total_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "扫描订单总数"
|
||
},
|
||
{
|
||
"name": "processed_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已处理订单数"
|
||
},
|
||
{
|
||
"name": "matched_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "命中策略的订单数"
|
||
},
|
||
{
|
||
"name": "unmatched_order_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "未命中策略的订单数"
|
||
},
|
||
{
|
||
"name": "progress_percent",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "进度百分比(0-100)"
|
||
},
|
||
{
|
||
"name": "submitted_at",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "提交时间(timestamp 或 ISO)"
|
||
},
|
||
{
|
||
"name": "start_time",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "实际开始时间(ISO)"
|
||
},
|
||
{
|
||
"name": "end_time",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "结束时间(ISO)"
|
||
},
|
||
{
|
||
"name": "error_message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "错误信息(若失败)"
|
||
},
|
||
{
|
||
"name": "error_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "错误码(若失败)"
|
||
},
|
||
{
|
||
"name": "duration_ms",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "耗时,毫秒"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "订单波次模块",
|
||
"moduleKey": "order.wave",
|
||
"moduleFolder": "order.wave",
|
||
"method": "order.wave.waveStrategyUpdate",
|
||
"title": "修改波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。id(或 strategy_id/strategyId)为必填主键,其他字段为可选更新;更新成功后会推进仓库的 wave_strategy_version 并失效相关缓存。",
|
||
"description": "修改波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。id(或 strategy_id/strategyId)为必填主键,其他字段为可选更新;更新成功后会推进仓库的 wave_strategy_version 并失效相关缓存。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id / strategy_id / strategyId",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "策略主键,兼容 id / strategy_id / strategyId(必填)"
|
||
},
|
||
{
|
||
"name": "strategy_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "策略名称(可选)"
|
||
},
|
||
{
|
||
"name": "strategy_type",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "策略类型(可选,正整数)"
|
||
},
|
||
{
|
||
"name": "batch_mode",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "拣货模式(可选,正整数)"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "状态:1-启用 0-停用(可选)"
|
||
},
|
||
{
|
||
"name": "order_min_sku",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最小 SKU 种类数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "order_max_sku",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最大 SKU 种类数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "order_min_qty",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最小商品总数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "order_max_qty",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单最大商品总数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "min_same_structure",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最小相同结构订单数(可选,正整数或 null)"
|
||
},
|
||
{
|
||
"name": "max_same_structure",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最大相同结构订单数(可选,正整数或 null)。会受仓库 min_group_order_fetch_quantity 约束,接口会自动调整。"
|
||
},
|
||
{
|
||
"name": "batch_max_orders",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "批次最大订单数(可选)"
|
||
},
|
||
{
|
||
"name": "batch_max_skus",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "批次最大 SKU 总数(可选)"
|
||
},
|
||
{
|
||
"name": "group_batch_max_orders",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "团购批次最大订单数(可选)"
|
||
},
|
||
{
|
||
"name": "require_same_express",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否要求相同快递(可选,布尔)"
|
||
},
|
||
{
|
||
"name": "allow_cross_owner",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否允许跨货主(可选,布尔)"
|
||
},
|
||
{
|
||
"name": "description",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "策略描述(可选)"
|
||
},
|
||
{
|
||
"name": "allowed_provinces",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的省份列表(可选,支持数组/JSON/逗号分隔)"
|
||
},
|
||
{
|
||
"name": "allowed_platforms",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的平台列表(可选,支持数组/JSON/逗号分隔)"
|
||
},
|
||
{
|
||
"name": "allowed_owners",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的货主列表(可选,支持数组/JSON/逗号分隔);系统会校验所传货主是否在仓库可用货主范围内,非法值将导致 400 错误。"
|
||
},
|
||
{
|
||
"name": "allowed_expresses",
|
||
"type": "array|string",
|
||
"required": false,
|
||
"description": "允许的快递编码列表(可选,支持数组/JSON/逗号分隔);系统会校验所传编码是否在可用快递列表内,非法值将导致 400 错误。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "更新后的策略对象,字段同 order.wave.waveStrategyList.list[*] 所示"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "HTTP-like 状态码,成功时返回 200"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "拣货模块",
|
||
"moduleKey": "pick",
|
||
"moduleFolder": "pick",
|
||
"method": "pick.query",
|
||
"title": "按订单查询波次拣货信息,支持 full/full_display/is_full 控制是否完整显示;接口按当前登录用户仓库上下文过滤,防止跨仓越界。",
|
||
"description": "按订单查询波次拣货信息,支持 full/full_display/is_full 控制是否完整显示;接口按当前登录用户仓库上下文过滤,防止跨仓越界。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "waybill_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "快递号/运单号,必填。"
|
||
},
|
||
{
|
||
"name": "full_display",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否完整显示拣货明细;默认 false。true 返回全部拣货明细,false 仅返回未完成的(inspection_status != 'fin')。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order_id",
|
||
"type": "string|number",
|
||
"required": false,
|
||
"description": "订单 ID"
|
||
},
|
||
{
|
||
"name": "wave_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "波次 ID(若订单未关联波次则为空)"
|
||
},
|
||
{
|
||
"name": "wave_no",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "波次编号(若订单未关联波次则为空)"
|
||
},
|
||
{
|
||
"name": "full_display",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否以完整明细展示(等同于请求中的 full/full_display/is_full)"
|
||
},
|
||
{
|
||
"name": "summary",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "汇总信息"
|
||
},
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "拣货明细列表(根据 full 参数返回全量或仅未复核明细),每项为明细对象,字段视实现而定。"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"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.express",
|
||
"moduleFolder": "setting.express",
|
||
"method": "setting.express.checkCodeUnique",
|
||
"title": "校验快递编码在当前仓库/主体维度唯一性,仅支持 code 与可选 id 排除自身",
|
||
"description": "校验快递编码在当前仓库/主体维度唯一性,仅支持 code 与可选 id 排除自身",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "待校验的快递编码"
|
||
},
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "排除自身 id(更新时使用)"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "快递编码管理模块",
|
||
"moduleKey": "setting.express",
|
||
"moduleFolder": "setting.express",
|
||
"method": "setting.express.create",
|
||
"title": "创建快递映射,仅写入已实现字段(code、name、platform 等)",
|
||
"description": "创建快递映射,仅写入已实现字段(code、name、platform 等)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "快递编码"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "快递名称"
|
||
},
|
||
{
|
||
"name": "platform",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "平台标识(可选)"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "快递编码管理模块",
|
||
"moduleKey": "setting.express",
|
||
"moduleFolder": "setting.express",
|
||
"method": "setting.express.delete",
|
||
"title": "批量软删除快递映射;接受 ids 参数,已删除记录会在结果中标记。",
|
||
"description": "批量软删除快递映射;接受 ids 参数,已删除记录会在结果中标记。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "待删除的映射ID数组;支持数组、逗号字符串或单个ID。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "请求中的所有 id 列表(原样返回)"
|
||
},
|
||
{
|
||
"name": "deleted_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "本次实际被软删除的 ID 列表(即原本未被删除的 ID)"
|
||
},
|
||
{
|
||
"name": "already_deleted_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "请求中已处于已删除状态的 ID 列表"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "固定返回 'deleted'"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "快递编码管理模块",
|
||
"moduleKey": "setting.express",
|
||
"moduleFolder": "setting.express",
|
||
"method": "setting.express.list",
|
||
"title": "查询当前仓库范围的快递映射列表,支持 where + pagination",
|
||
"description": "查询当前仓库范围的快递映射列表,支持 where + pagination",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize,兼容 currentPage / page_size / size"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "快递编码管理模块",
|
||
"moduleKey": "setting.express",
|
||
"moduleFolder": "setting.express",
|
||
"method": "setting.express.listBase",
|
||
"title": "返回系统快递基础列表(系统级别基础快递,不含仓库自定义)",
|
||
"description": "返回系统快递基础列表(系统级别基础快递,不含仓库自定义)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "快递编码管理模块",
|
||
"moduleKey": "setting.express",
|
||
"moduleFolder": "setting.express",
|
||
"method": "setting.express.update",
|
||
"title": "更新快递映射,仅更新已实现字段(例如 name、platform)",
|
||
"description": "更新快递映射,仅更新已实现字段(例如 name、platform)",
|
||
"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": "name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "快递名称"
|
||
},
|
||
{
|
||
"name": "platform",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "平台标识(可选)"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "快递接口管理模块",
|
||
"moduleKey": "setting.expressInterface",
|
||
"moduleFolder": "setting.expressinterface",
|
||
"method": "setting.expressInterface.create",
|
||
"title": "在当前仓库范围内创建快递接口,仅写入已实现字段(见 params),仓库由系统自动填充,禁止传入 warehouse_id/warehouseId。",
|
||
"description": "在当前仓库范围内创建快递接口,仅写入已实现字段(见 params),仓库由系统自动填充,禁止传入 warehouse_id/warehouseId。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "接口名称"
|
||
},
|
||
{
|
||
"name": "express_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "快递编码(不区分大小写,会在服务端转为大写)"
|
||
},
|
||
{
|
||
"name": "platform_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "平台代码(不区分大小写,会在服务端转为大写)"
|
||
},
|
||
{
|
||
"name": "express_platform_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "平台接口 ID"
|
||
},
|
||
{
|
||
"name": "sender_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "发件人姓名"
|
||
},
|
||
{
|
||
"name": "sender_tel",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "发件人电话"
|
||
},
|
||
{
|
||
"name": "weight",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "默认重量(可选)"
|
||
},
|
||
{
|
||
"name": "token",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "接口密钥或 token"
|
||
},
|
||
{
|
||
"name": "viewer",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "查看者标识"
|
||
},
|
||
{
|
||
"name": "client_id",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "客户端 ID"
|
||
},
|
||
{
|
||
"name": "is_share",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "是否共享(0/1)"
|
||
},
|
||
{
|
||
"name": "share_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "共享记录 ID"
|
||
},
|
||
{
|
||
"name": "can_use_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "可用次数/配额"
|
||
},
|
||
{
|
||
"name": "province_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "省"
|
||
},
|
||
{
|
||
"name": "city_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "市"
|
||
},
|
||
{
|
||
"name": "district_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "区/县"
|
||
},
|
||
{
|
||
"name": "site_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "站点编码"
|
||
},
|
||
{
|
||
"name": "product_type",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "快递产品类型"
|
||
},
|
||
{
|
||
"name": "shop_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "店铺名称/分组标识"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新建记录 ID"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "快递接口管理模块",
|
||
"moduleKey": "setting.expressInterface",
|
||
"moduleFolder": "setting.expressinterface",
|
||
"method": "setting.expressInterface.delete",
|
||
"title": "删除快递接口,支持 id 别名 interface_id / interfaceId;返回被删除记录 id 与所属 warehouse_id。",
|
||
"description": "删除快递接口,支持 id 别名 interface_id / interfaceId;返回被删除记录 id 与所属 warehouse_id。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "快递接口ID;兼容 interface_id / interfaceId"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已删除记录 ID"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "记录所属仓库 ID"
|
||
},
|
||
{
|
||
"name": "deleted",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否已删除,成功时为 true"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "快递接口管理模块",
|
||
"moduleKey": "setting.expressInterface",
|
||
"moduleFolder": "setting.expressinterface",
|
||
"method": "setting.expressInterface.list",
|
||
"title": "查询当前仓库范围的快递接口列表,支持 where + pagination;返回 data:{ list, total, page, page_size }。每条记录字段见 children。",
|
||
"description": "查询当前仓库范围的快递接口列表,支持 where + pagination;返回 data:{ list, total, page, page_size }。每条记录字段见 children。",
|
||
"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 条件对象;支持字段:id、name、express_code、platform_code、express_platform_id、sender_name、sender_tel、viewer、client_id、share_id、site_code、product_type、shop_name。支持 quickWhere 快速关键词。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "快递接口记录数组(每项字段如下)"
|
||
},
|
||
{
|
||
"name": "total",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "匹配的总记录数"
|
||
},
|
||
{
|
||
"name": "page",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "当前页"
|
||
},
|
||
{
|
||
"name": "page_size",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "每页数量"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "快递接口管理模块",
|
||
"moduleKey": "setting.expressInterface",
|
||
"moduleFolder": "setting.expressinterface",
|
||
"method": "setting.expressInterface.listByWarehousePlatformCode",
|
||
"title": "按 warehouse_id + platform_code 查询快递接口全字段数组,支持缓存;返回结果按 weight 升序、必要时按 id 升序排序,每条记录显式包含 express_code 以及关联的 express 对象(如 express.id/express.code/express.name/express.platform)。该接口不分页,按 warehouse_id + platform_code 全量返回匹配记录。",
|
||
"description": "按 warehouse_id + platform_code 查询快递接口全字段数组,支持缓存;返回结果按 weight 升序、必要时按 id 升序排序,每条记录显式包含 express_code 以及关联的 express 对象(如 express.id/express.code/express.name/express.platform)。该接口不分页,按 warehouse_id + platform_code 全量返回匹配记录。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouse_id / warehouseId",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "仓库ID;默认使用当前登录主体/仓库上下文(ctx.user.store_id),也支持显式传入以查询指定仓库,文档兼容 warehouse_id 与 warehouseId 两种写法。"
|
||
},
|
||
{
|
||
"name": "platform_code / platformCode",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "平台代码;作为缓存键的一部分,建议使用大写形式(服务端会标准化处理)。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "快递接口记录数组(按 warehouse_id + platform_code 全量返回,不分页),每项包含以下字段:"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "快递接口管理模块",
|
||
"moduleKey": "setting.expressInterface",
|
||
"moduleFolder": "setting.expressinterface",
|
||
"method": "setting.expressInterface.update",
|
||
"title": "更新快递接口,支持局部字段更新;支持 id 别名 interface_id / interfaceId;禁止通过接口修改 warehouse_id。",
|
||
"description": "更新快递接口,支持局部字段更新;支持 id 别名 interface_id / interfaceId;禁止通过接口修改 warehouse_id。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "快递接口ID;兼容 interface_id / interfaceId"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "接口名称"
|
||
},
|
||
{
|
||
"name": "express_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "快递编码(更新时会被转为大写)"
|
||
},
|
||
{
|
||
"name": "platform_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "平台代码(更新时会被转为大写)"
|
||
},
|
||
{
|
||
"name": "express_platform_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "平台接口 ID"
|
||
},
|
||
{
|
||
"name": "sender_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "发件人姓名"
|
||
},
|
||
{
|
||
"name": "sender_tel",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "发件人电话"
|
||
},
|
||
{
|
||
"name": "weight",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "默认重量"
|
||
},
|
||
{
|
||
"name": "token",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "接口密钥或 token"
|
||
},
|
||
{
|
||
"name": "viewer",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "查看者标识"
|
||
},
|
||
{
|
||
"name": "client_id",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "客户端 ID"
|
||
},
|
||
{
|
||
"name": "is_share",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "是否共享(0/1)"
|
||
},
|
||
{
|
||
"name": "share_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "共享记录 ID"
|
||
},
|
||
{
|
||
"name": "can_use_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "可用次数/配额"
|
||
},
|
||
{
|
||
"name": "province_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "省"
|
||
},
|
||
{
|
||
"name": "city_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "市"
|
||
},
|
||
{
|
||
"name": "district_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "区/县"
|
||
},
|
||
{
|
||
"name": "site_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "站点编码"
|
||
},
|
||
{
|
||
"name": "product_type",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "快递产品类型"
|
||
},
|
||
{
|
||
"name": "shop_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "店铺名称/分组标识"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "首条更新记录 ID"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"type": "string",
|
||
"required": false,
|
||
"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.platform",
|
||
"moduleFolder": "setting.platform",
|
||
"method": "setting.platform.create",
|
||
"title": "创建当前仓库范围的平台设置",
|
||
"description": "创建当前仓库范围的平台设置",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "平台编码管理模块",
|
||
"moduleKey": "setting.platform",
|
||
"moduleFolder": "setting.platform",
|
||
"method": "setting.platform.delete",
|
||
"title": "删除当前仓库范围的平台设置",
|
||
"description": "删除当前仓库范围的平台设置",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "平台编码管理模块",
|
||
"moduleKey": "setting.platform",
|
||
"moduleFolder": "setting.platform",
|
||
"method": "setting.platform.list",
|
||
"title": "查询当前仓库范围的平台设置列表",
|
||
"description": "查询当前仓库范围的平台设置列表",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "平台编码管理模块",
|
||
"moduleKey": "setting.platform",
|
||
"moduleFolder": "setting.platform",
|
||
"method": "setting.platform.update",
|
||
"title": "更新当前仓库范围的平台设置",
|
||
"description": "更新当前仓库范围的平台设置",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "打印模板模块",
|
||
"moduleKey": "setting.printTemplate",
|
||
"moduleFolder": "setting.printtemplate",
|
||
"method": "setting.printTemplate.create",
|
||
"title": "创建打印模板(platform 固定为 default,template_type 固定为 CUSTOM,template_url 固定为空字符串)",
|
||
"description": "创建打印模板(platform 固定为 default,template_type 固定为 CUSTOM,template_url 固定为空字符串)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "template_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "模板名称"
|
||
},
|
||
{
|
||
"name": "business_type",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "业务类型"
|
||
},
|
||
{
|
||
"name": "page_width",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "页面宽度(mm)"
|
||
},
|
||
{
|
||
"name": "page_height",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "页面高度(mm)"
|
||
},
|
||
{
|
||
"name": "template_content",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "模板内容,可省略;省略时默认创建空模板内容"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新建模板ID"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "打印模板模块",
|
||
"moduleKey": "setting.printTemplate",
|
||
"moduleFolder": "setting.printtemplate",
|
||
"method": "setting.printTemplate.delete",
|
||
"title": "删除打印模板(软删除)",
|
||
"description": "删除打印模板(软删除)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "模板ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "删除的模板ID"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "打印模板模块",
|
||
"moduleKey": "setting.printTemplate",
|
||
"moduleFolder": "setting.printtemplate",
|
||
"method": "setting.printTemplate.list",
|
||
"title": "获取打印模板树",
|
||
"description": "获取打印模板树",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "打印模板模块",
|
||
"moduleKey": "setting.printTemplate",
|
||
"moduleFolder": "setting.printtemplate",
|
||
"method": "setting.printTemplate.listTemplatesByType",
|
||
"title": "按业务类型查询模板",
|
||
"description": "按业务类型查询模板",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "businessType",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "businessType 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "打印模板模块",
|
||
"moduleKey": "setting.printTemplate",
|
||
"moduleFolder": "setting.printtemplate",
|
||
"method": "setting.printTemplate.save",
|
||
"title": "保存打印模板",
|
||
"description": "保存打印模板",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "角色管理模块",
|
||
"moduleKey": "setting.role",
|
||
"moduleFolder": "setting.role",
|
||
"method": "setting.role.add",
|
||
"title": "新增角色并绑定权限集合",
|
||
"description": "新增角色并绑定权限集合",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "role_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "角色编码"
|
||
},
|
||
{
|
||
"name": "role_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "角色名称"
|
||
},
|
||
{
|
||
"name": "permission_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "权限ID数组,支持 [\"*\"]"
|
||
},
|
||
{
|
||
"name": "pid",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "父角色ID"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "角色管理模块",
|
||
"moduleKey": "setting.role",
|
||
"moduleFolder": "setting.role",
|
||
"method": "setting.role.delete",
|
||
"title": "批量停用角色",
|
||
"description": "批量停用角色",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "待停用的角色ID数组"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "角色管理模块",
|
||
"moduleKey": "setting.role",
|
||
"moduleFolder": "setting.role",
|
||
"method": "setting.role.list",
|
||
"title": "获取当前主体可管理的角色树",
|
||
"description": "获取当前主体可管理的角色树",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "includeDisabled",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否包含已停用角色"
|
||
},
|
||
{
|
||
"name": "includeSystem",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否包含系统角色域"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "角色管理模块",
|
||
"moduleKey": "setting.role",
|
||
"moduleFolder": "setting.role",
|
||
"method": "setting.role.permission",
|
||
"title": "获取角色权限树(兼容旧入口,等同于 setting.permission.list)",
|
||
"description": "获取角色权限树(兼容旧入口,等同于 setting.permission.list)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "role_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "角色ID"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "角色管理模块",
|
||
"moduleKey": "setting.role",
|
||
"moduleFolder": "setting.role",
|
||
"method": "setting.role.update",
|
||
"title": "更新角色信息并重设权限集合",
|
||
"description": "更新角色信息并重设权限集合",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "role_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "角色ID"
|
||
},
|
||
{
|
||
"name": "permission_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "权限ID数组,角色权限需一次性提交"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "仓库设置模块",
|
||
"moduleKey": "setting.warehouse",
|
||
"moduleFolder": "setting.warehouse",
|
||
"method": "setting.warehouse.getFieldMeta",
|
||
"title": "获取仓库设置字段元信息",
|
||
"description": "获取仓库设置字段元信息",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "字段元信息数组"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "仓库设置模块",
|
||
"moduleKey": "setting.warehouse",
|
||
"moduleFolder": "setting.warehouse",
|
||
"method": "setting.warehouse.getSettings",
|
||
"title": "获取当前登录仓库的 subject_config",
|
||
"description": "获取当前登录仓库的 subject_config",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "仓库 ID"
|
||
},
|
||
{
|
||
"name": "subject_config",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "仓库的 subject_config 配置对象"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "仓库设置模块",
|
||
"moduleKey": "setting.warehouse",
|
||
"moduleFolder": "setting.warehouse",
|
||
"method": "setting.warehouse.saveSettings",
|
||
"title": "修改仓库设置并清理指定仓库缓存",
|
||
"description": "修改仓库设置并清理指定仓库缓存",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "subject_config",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "仓库的 subject_config 对象"
|
||
},
|
||
{
|
||
"name": "cache_warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "需清理缓存的仓库 ID(下划线命名兼容)"
|
||
},
|
||
{
|
||
"name": "cacheWarehouseId",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "需清理缓存的仓库 ID(驼峰命名兼容)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "生效的仓库 ID"
|
||
},
|
||
{
|
||
"name": "subject_config",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "保存后的 subject_config"
|
||
},
|
||
{
|
||
"name": "cache_cleared_warehouse_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "被清理缓存的仓库 ID(若未清理则为 null)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.bindItem",
|
||
"title": "绑定货主商品关系",
|
||
"description": "绑定货主商品关系",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.checkItemCodeUnique",
|
||
"title": "检测商品编码唯一性。在同一仓库和货主下,排除商品自身后,判断商品编码是否已存在于未删除商品中。",
|
||
"description": "检测商品编码唯一性。在同一仓库和货主下,排除商品自身后,判断商品编码是否已存在于未删除商品中。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "仓库ID;默认使用当前登录主体/仓库上下文(ctx.user.store_id)"
|
||
},
|
||
{
|
||
"name": "item_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "要检测的商品编码"
|
||
},
|
||
{
|
||
"name": "item_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "当前商品ID(编辑场景用,排除自身);兼容字段名 id"
|
||
},
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "兼容字段 id"
|
||
},
|
||
{
|
||
"name": "owner_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "货主ID(对应表字段 store_id);兼容字段名 store_id"
|
||
},
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "兼容字段 store_id"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "unique",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "true 表示编码唯一,false 表示已存在重复"
|
||
},
|
||
{
|
||
"name": "isUnique",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "同 unique(兼容旧字段名)"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "重复时返回 '商品编码已存在',唯一时不返回该字段"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.createProhibited",
|
||
"title": "新增违禁品类型",
|
||
"description": "新增违禁品类型",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "name 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.createUnit",
|
||
"title": "新增库存单位",
|
||
"description": "新增库存单位",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "name 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.createWarehouseStock",
|
||
"title": "新建仓库商品资料",
|
||
"description": "新建仓库商品资料",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.deleteProhibited",
|
||
"title": "删除违禁品类型",
|
||
"description": "删除违禁品类型",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.deleteUnit",
|
||
"title": "删除库存单位",
|
||
"description": "删除库存单位",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.getBarcodes",
|
||
"title": "查询商品条码列表",
|
||
"description": "查询商品条码列表",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.getInfo",
|
||
"title": "查询仓库商品详情",
|
||
"description": "查询仓库商品详情",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.getProhibitedType",
|
||
"title": "查询违禁品类型列表(系统预设+仓库自定义)",
|
||
"description": "查询违禁品类型列表(系统预设+仓库自定义)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.getStockDetail",
|
||
"title": "按库位/批次维度查询商品库存分布",
|
||
"description": "按库位/批次维度查询商品库存分布",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "stock_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "商品库存ID(stock_warehouse.id)"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,包含 page/pageSize"
|
||
},
|
||
{
|
||
"name": "group_by_batch",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否按批次返回明细;true 返回每条明细,false 按库位合并"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "stockItem",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "商品概要,包含 id、item_code、item_name、sku_property、stock_unit、quantity、locked_quantity 等"
|
||
},
|
||
{
|
||
"name": "storageList",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "库存明细数组;group_by_batch=true 返回 wms_storage 明细(含 batch_no、production_date、expiry_date、inbound_time、inbound_order_no、supplier_batch_no 等),group_by_batch=false 时按库位合并,批次相关字段为 null"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页信息,包含 page、pageSize、total"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.getStockUnits",
|
||
"title": "查询可用库存单位(系统+仓库)",
|
||
"description": "查询可用库存单位(系统+仓库)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.getStoreStocks",
|
||
"title": "查询仓库商品与货主关联列表",
|
||
"description": "查询仓库商品与货主关联列表",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.getUnitList",
|
||
"title": "查询当前仓库自定义单位列表",
|
||
"description": "查询当前仓库自定义单位列表",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "商品模块",
|
||
"moduleKey": "stock",
|
||
"moduleFolder": "stock",
|
||
"method": "stock.warehouse.handleBatchChange",
|
||
"title": "批量修改仓库商品字段",
|
||
"description": "批量修改仓库商品字段",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"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": "box_remainder",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "箱内剩余数量/零散数量(不满箱时的件数)"
|
||
},
|
||
{
|
||
"name": "box_weight",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "实测箱重(单位与系统重量一致,如 kg)"
|
||
},
|
||
{
|
||
"name": "weight",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "毛重/重量"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "data.id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "收货明细 ID"
|
||
},
|
||
{
|
||
"name": "data.receiving_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "收货单 ID"
|
||
},
|
||
{
|
||
"name": "data.actual_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "实际收货数量"
|
||
},
|
||
{
|
||
"name": "data.product_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "商品名称"
|
||
},
|
||
{
|
||
"name": "data.barcode",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "条码"
|
||
},
|
||
{
|
||
"name": "data.system_product_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "系统商品 ID"
|
||
},
|
||
{
|
||
"name": "data.box_remainder",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "箱内剩余数量/零散数量(不满箱时的件数)"
|
||
},
|
||
{
|
||
"name": "data.box_weight",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "实测箱重(单位与系统重量一致,如 kg)"
|
||
},
|
||
{
|
||
"name": "data.updated_at",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "记录更新时间(ISO)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "收货单模块",
|
||
"moduleKey": "storage_receiving",
|
||
"moduleFolder": "storage_receiving",
|
||
"method": "storage.receiving.get",
|
||
"title": "storage.receiving.get 接口",
|
||
"description": "storage.receiving.get 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "收货单ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "业务状态码,200 表示成功"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "返回信息"
|
||
},
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "收货单详情对象,包含 details(明细数组)、images 及主表字段"
|
||
},
|
||
{
|
||
"name": "data.details",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "收货单明细数组(每项为明细对象)"
|
||
},
|
||
{
|
||
"name": "data.details.*.box_remainder",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "箱内剩余数量/零散数量(不满箱时的件数),默认 0"
|
||
},
|
||
{
|
||
"name": "data.details.*.box_weight",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "实测箱重(单位与系统重量一致,如 kg),默认 0"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "收货单模块",
|
||
"moduleKey": "storage_receiving",
|
||
"moduleFolder": "storage_receiving",
|
||
"method": "storage.receiving.getReceivingDetail",
|
||
"title": "storage.receiving.getReceivingDetail 接口",
|
||
"description": "storage.receiving.getReceivingDetail 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "收货单ID"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "明细分页参数,支持 page/pageSize"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "receiving",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "收货单详情(含 details、images、pagination)"
|
||
},
|
||
{
|
||
"name": "receiving.details",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "收货单明细列表,单条记录包含明细字段(见下文)"
|
||
},
|
||
{
|
||
"name": "receiving.details.*.box_remainder",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "箱内剩余数量/零散数量(不满箱时的件数)"
|
||
},
|
||
{
|
||
"name": "receiving.details.*.box_weight",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "实测箱重(单位与系统重量一致,如 kg)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "收货单模块",
|
||
"moduleKey": "storage_receiving",
|
||
"moduleFolder": "storage_receiving",
|
||
"method": "storage.receiving.getReceivingList",
|
||
"title": "storage.receiving.getReceivingList 接口",
|
||
"description": "storage.receiving.getReceivingList 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page/pageSize"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、status、store_id、日期区间等字段。示例:where.status={operator:eq,value:finished}; where.store_id={operator:eq,value:1001}; where.create_time_start={value:2026-03-01}。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "收货单列表"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
|
||
},
|
||
{
|
||
"name": "summary",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "汇总信息(total_quantity、total_locked、total_available、total_items)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "收货单模块",
|
||
"moduleKey": "storage_receiving",
|
||
"moduleFolder": "storage_receiving",
|
||
"method": "storage.receiving.queryReceivingLogs",
|
||
"title": "按收货单ID查询操作日志列表(分页),仅返回当前仓库上下文数据",
|
||
"description": "按收货单ID查询操作日志列表(分页),仅返回当前仓库上下文数据",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number|string",
|
||
"required": false,
|
||
"description": "收货单ID(与 receiving_id 二选一)"
|
||
},
|
||
{
|
||
"name": "receiving_id",
|
||
"type": "number|string",
|
||
"required": false,
|
||
"description": "收货单ID(兼容字段,与 id 二选一)"
|
||
},
|
||
{
|
||
"name": "page",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "页码(兼容顶层分页入参)"
|
||
},
|
||
{
|
||
"name": "pageSize",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "每页数量(兼容顶层分页入参)"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page / pageSize"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "日志列表"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息,包含 page、pageSize、total、totalPages"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "收货单模块",
|
||
"moduleKey": "storage_receiving",
|
||
"moduleFolder": "storage_receiving",
|
||
"method": "storage.receiving.rejectReceiving",
|
||
"title": "驳回收货单:将已完成(completed)的收货单批量恢复为收货中(receiving),记录驳回人信息和驳回理由。若任意一张收货单状态非 completed,则整批拒绝操作。驳回人信息(reviewer_name、reviewer_employee_id)自动取当前登录用户上下文,无需传入.",
|
||
"description": "驳回收货单:将已完成(completed)的收货单批量恢复为收货中(receiving),记录驳回人信息和驳回理由。若任意一张收货单状态非 completed,则整批拒绝操作。驳回人信息(reviewer_name、reviewer_employee_id)自动取当前登录用户上下文,无需传入.",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "收货单ID数组,所有收货单必须属于当前仓库且状态为 completed,否则整批拒绝"
|
||
},
|
||
{
|
||
"name": "remark",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "驳回理由,覆盖收货单原备注字段;不传则保留原备注"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "成功驳回的收货单数量"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "收货单模块",
|
||
"moduleKey": "storage_receiving",
|
||
"moduleFolder": "storage_receiving",
|
||
"method": "storage.receiving.removeItem",
|
||
"title": "storage.receiving.removeItem 接口",
|
||
"description": "storage.receiving.removeItem 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "id 参数"
|
||
},
|
||
{
|
||
"name": "item_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "item_id 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "收货单模块",
|
||
"moduleKey": "storage_receiving",
|
||
"moduleFolder": "storage_receiving",
|
||
"method": "storage.receiving.reviewReceiving",
|
||
"title": "批量审核收货单:校验所有单据满足条件(收货完成、全部匹配、未入库、已绑定货主、未审核)后统一审核,任意一张不符合则整批失败回滚。审核人信息自动取当前登录用户上下文,无需传入.",
|
||
"description": "批量审核收货单:校验所有单据满足条件(收货完成、全部匹配、未入库、已绑定货主、未审核)后统一审核,任意一张不符合则整批失败回滚。审核人信息自动取当前登录用户上下文,无需传入.",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "收货单ID数组,所有单据必须满足:status=completed、detail_status=all_matched、storage_status=none、store_id 已绑定、is_review=0,否则整批拒绝"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "成功审核的收货单数量"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "收货单模块",
|
||
"moduleKey": "storage_receiving",
|
||
"moduleFolder": "storage_receiving",
|
||
"method": "storage.receiving.save",
|
||
"title": "修改收货单基础信息。按收货单ID更新当前仓库下收货单的基础字段。",
|
||
"description": "修改收货单基础信息。按收货单ID更新当前仓库下收货单的基础字段。",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "收货单ID,按该ID修改当前仓库下的收货单"
|
||
},
|
||
{
|
||
"name": "delivery_method",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "到货方式:truck/express/air_freight/sea_freight/other;不传则保持原值"
|
||
},
|
||
{
|
||
"name": "loading_method",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "装卸方式:with_pallet/without_pallet;不传则保持原值"
|
||
},
|
||
{
|
||
"name": "license_plate",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "车牌号;当 delivery_method=truck 时可更新,其他到货方式会被清空或忽略"
|
||
},
|
||
{
|
||
"name": "tracking_number",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "物流单号;当 delivery_method 为 express/air_freight/sea_freight 时可更新,truck/other 场景会被清空或忽略"
|
||
},
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "货主ID;若传入,会校验当前仓库下签约关系并同步更新货主名称;传 0/null 可清空货主"
|
||
},
|
||
{
|
||
"name": "total_boxes",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "总箱数,默认 0"
|
||
},
|
||
{
|
||
"name": "total_pallets",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "总托盘数,默认 0"
|
||
},
|
||
{
|
||
"name": "remark",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "备注信息"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "收货单状态;不传则保持原值"
|
||
},
|
||
{
|
||
"name": "video_device_id",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "录像设备ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "业务状态码;200 表示修改成功"
|
||
},
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "修改的收货单ID"
|
||
},
|
||
{
|
||
"name": "receiving_number",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "收货单号"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "结果描述;成功时通常为收货单修改成功"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "出库单模块",
|
||
"moduleKey": "storage.stockout",
|
||
"moduleFolder": "storage.stockout",
|
||
"method": "storage.stockout.list",
|
||
"title": "非订单出库单能力(对应奇门 stockout.create):用于处理由奇门创建的非订单出库单;主出口为 storage.stockout.*,不再推荐通过 storage.delivery.* 命名使用。storage.delivery.* 仅保留兼容转发。",
|
||
"description": "非订单出库单能力(对应奇门 stockout.create):用于处理由奇门创建的非订单出库单;主出口为 storage.stockout.*,不再推荐通过 storage.delivery.* 命名使用。storage.delivery.* 仅保留兼容转发。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page/pageSize"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;常用字段包括 delivery_order_code、status、outbound_status、buyer_nick、mobile 与日期区间字段。"
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "排序参数,支持 sortField/sortOrder,默认按 updated_at DESC、id DESC"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "出库单列表"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "出库单模块",
|
||
"moduleKey": "storage.stockout",
|
||
"moduleFolder": "storage.stockout",
|
||
"method": "storage.stockout.listItems",
|
||
"title": "按出库单查询商品明细(用于非订单出库单),底层复用 order.listItems。",
|
||
"description": "按出库单查询商品明细(用于非订单出库单),底层复用 order.listItems。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "delivery_order_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "出库单号,可用于定位订单"
|
||
},
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单ID,可与 id 兼容用于定位订单"
|
||
},
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "订单ID,可选;与 delivery_order_code / order_id 至少传一个"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "order",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "订单基础信息(含 id、delivery_order_code)"
|
||
},
|
||
{
|
||
"name": "items",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "出库单商品明细"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "出库单模块",
|
||
"moduleKey": "storage.stockout",
|
||
"moduleFolder": "storage.stockout",
|
||
"method": "storage.stockout.toOrder",
|
||
"title": "占位接口,暂未开放。当前仅保留方法名用于后续扩展,逻辑暂不能使用。参数 id / delivery_order_code 暂未启用。",
|
||
"description": "占位接口,暂未开放。当前仅保留方法名用于后续扩展,逻辑暂不能使用。参数 id / delivery_order_code 暂未启用。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "预留参数,暂未启用;当前仅保留字段名用于后续扩展。"
|
||
},
|
||
{
|
||
"name": "delivery_order_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "预留参数,暂未启用;当前仅保留字段名用于后续扩展。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "_note",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "占位接口,当前无有效业务响应"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "库存操作模块",
|
||
"moduleKey": "storage.inventory",
|
||
"moduleFolder": "storage.inventory",
|
||
"method": "storage.transaction.list",
|
||
"title": "出入库记录列表查询,支持 where 条件、分页、排序、批次分组切换。默认按库位合并数量(合并模式),group_by_batch=true 时返回每条明细(明细模式)",
|
||
"description": "出入库记录列表查询,支持 where 条件、分页、排序、批次分组切换。默认按库位合并数量(合并模式),group_by_batch=true 时返回每条明细(明细模式)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "统一 where 条件对象,可用字段:transaction_type(ENUM INBOUND/OUTBOUND)、stock_id、space_id、store_id、order_type(SCRK/MATCH)、order_no、inventory_type(ZP/CC/JS/XS/ZT/DJ/FP)、operator_name、created_at(支持 between)"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数 { page, pageSize },默认 page=1, pageSize=20"
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "排序参数 { sortField, sortOrder },默认 sortField='created_at', sortOrder='DESC'"
|
||
},
|
||
{
|
||
"name": "group_by_batch",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否按批次查询明细,默认 false。false=合并模式(按库位+商品聚合),true=明细模式(逐条返回)"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "主体模块",
|
||
"moduleKey": "store",
|
||
"moduleFolder": "store",
|
||
"method": "store.auditApply",
|
||
"title": "store.auditApply 接口",
|
||
"description": "store.auditApply 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "audit_status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "审核状态(approved/rejected)"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "申请码(join_token)"
|
||
},
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前审批门店ID"
|
||
},
|
||
{
|
||
"name": "role_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "分配角色ID数组"
|
||
},
|
||
{
|
||
"name": "reject_reason",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "拒绝原因(audit_status=rejected 时可传)"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "主体模块",
|
||
"moduleKey": "store",
|
||
"moduleFolder": "store",
|
||
"method": "store.createStore",
|
||
"title": "store.createStore 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))",
|
||
"description": "store.createStore 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "subject_config",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "货主主体配置,不传时自动写入默认值"
|
||
},
|
||
{
|
||
"name": "subject_config.max_notice_webhook_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "当前主体最多允许绑定 / 触达的消息推送接口数量,默认 5"
|
||
},
|
||
{
|
||
"name": "subject_config.default_express_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "默认快递编码,缺省为 STO"
|
||
},
|
||
{
|
||
"name": "subject_config.default_platform_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "默认平台编码,缺省为 TB"
|
||
},
|
||
{
|
||
"name": "subject_config.group_wave_prefix",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "团购波次前缀,最多 5 个字符,默认 B"
|
||
},
|
||
{
|
||
"name": "subject_config.min_group_order_fetch_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最小团购订单抓取数量,默认 13"
|
||
},
|
||
{
|
||
"name": "subject_config.auto_grouping_enabled",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否自动加团,默认 false(关闭)"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "主体模块",
|
||
"moduleKey": "store",
|
||
"moduleFolder": "store",
|
||
"method": "store.createWarehouse",
|
||
"title": "store.createWarehouse 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))",
|
||
"description": "store.createWarehouse 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "subject_config",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "货主主体配置,不传时自动写入默认值"
|
||
},
|
||
{
|
||
"name": "subject_config.max_notice_webhook_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "当前主体最多允许绑定 / 触达的消息推送接口数量,默认 5"
|
||
},
|
||
{
|
||
"name": "subject_config.default_express_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "默认快递编码,缺省为 STO"
|
||
},
|
||
{
|
||
"name": "subject_config.default_platform_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "默认平台编码,缺省为 TB"
|
||
},
|
||
{
|
||
"name": "subject_config.group_wave_prefix",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "团购波次前缀,最多 5 个字符,默认 B"
|
||
},
|
||
{
|
||
"name": "subject_config.min_group_order_fetch_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最小团购订单抓取数量,默认 13"
|
||
},
|
||
{
|
||
"name": "subject_config.auto_grouping_enabled",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否自动加团,默认 false(关闭)"
|
||
}
|
||
],
|
||
"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、auto_allocate_express(是否自动分配快递)、auto_allocate_storage(是否自动分配储位)、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.batchUpdateSpaceInfo",
|
||
"title": "按导出模板批量修改货架仓位信息,任一行越界或冲突则整批失败。前端提交示例:{ id: 36, items: [ { space_code: 'A01-01-01', custom_name: '拣货位1', custom_barcode: 'PICK-001', pick_sequence: 10, location_type_id: 3 } ] }。其中 id 为货架ID(可选,传入时只允许操作该货架下的仓位),space_code 为必填定位键,location_type_id 为仓位类型主键(可通过 index.getLocationTypeList 获取)。",
|
||
"description": "按导出模板批量修改货架仓位信息,任一行越界或冲突则整批失败。前端提交示例:{ id: 36, items: [ { space_code: 'A01-01-01', custom_name: '拣货位1', custom_barcode: 'PICK-001', pick_sequence: 10, location_type_id: 3 } ] }。其中 id 为货架ID(可选,传入时只允许操作该货架下的仓位),space_code 为必填定位键,location_type_id 为仓位类型主键(可通过 index.getLocationTypeList 获取)。",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "货架ID,传入时校验所有 space_code 必须属于该货架,不传则只校验属于任意货架类型库位"
|
||
},
|
||
{
|
||
"name": "items",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "批量修改数据数组;每项支持字段:space_code、custom_name、custom_barcode、pick_sequence、location_type_name"
|
||
},
|
||
{
|
||
"name": "items[].space_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "仓位编码,作为批量修改的唯一定位键;缺失、重复或不存在都会整批失败"
|
||
},
|
||
{
|
||
"name": "items[].custom_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "自定义名称,空字符串会被清空"
|
||
},
|
||
{
|
||
"name": "items[].custom_barcode",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "自定义条码,批次内或系统内冲突都会整批失败;空字符串会被清空"
|
||
},
|
||
{
|
||
"name": "items[].pick_sequence",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "拣货顺序,必须为非负整数,超出边界则整批失败"
|
||
},
|
||
{
|
||
"name": "items[].location_type_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "仓位类型ID,必须为正整数且在当前仓库或全局类型中存在(is_active=true),否则整批失败;传 null 或不传则不修改仓位类型"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "成功更新的记录数"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "仓库模块",
|
||
"moduleKey": "warehouse",
|
||
"moduleFolder": "warehouse",
|
||
"method": "warehouse.checkBarcodeUnique",
|
||
"title": "warehouse.checkBarcodeUnique 接口",
|
||
"description": "warehouse.checkBarcodeUnique 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "barcode",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "barcode 参数"
|
||
},
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "仓库模块",
|
||
"moduleKey": "warehouse",
|
||
"moduleFolder": "warehouse",
|
||
"method": "warehouse.create",
|
||
"title": "warehouse.create 接口",
|
||
"description": "warehouse.create 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "仓库模块",
|
||
"moduleKey": "warehouse",
|
||
"moduleFolder": "warehouse",
|
||
"method": "warehouse.createRackWithSpaces",
|
||
"title": "warehouse.createRackWithSpaces 接口",
|
||
"description": "warehouse.createRackWithSpaces 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "仓库模块",
|
||
"moduleKey": "warehouse",
|
||
"moduleFolder": "warehouse",
|
||
"method": "warehouse.delete",
|
||
"title": "warehouse.delete 接口",
|
||
"description": "warehouse.delete 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "仓库模块",
|
||
"moduleKey": "warehouse",
|
||
"moduleFolder": "warehouse",
|
||
"method": "warehouse.detail",
|
||
"title": "warehouse.detail 接口",
|
||
"description": "warehouse.detail 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "仓库模块",
|
||
"moduleKey": "warehouse",
|
||
"moduleFolder": "warehouse",
|
||
"method": "warehouse.exportRackSpaces",
|
||
"title": "按货架ID导出仓位模板(含仓库编码、仓位编码、自定义名称、自定义条码、拣货顺序、仓位类型)",
|
||
"description": "按货架ID导出仓位模板(含仓库编码、仓位编码、自定义名称、自定义条码、拣货顺序、仓位类型)",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "货架ID,仅导出该货架下仓位"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "导出记录数"
|
||
},
|
||
{
|
||
"name": "fileName",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "导出文件名"
|
||
},
|
||
{
|
||
"name": "fileUrl",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "导出文件下载地址"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"moduleName": "仓库模块",
|
||
"moduleKey": "warehouse",
|
||
"moduleFolder": "warehouse",
|
||
"method": "warehouse.getAreaRacks",
|
||
"title": "warehouse.getAreaRacks 接口",
|
||
"description": "warehouse.getAreaRacks 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "area_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "area_id 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "仓库模块",
|
||
"moduleKey": "warehouse",
|
||
"moduleFolder": "warehouse",
|
||
"method": "warehouse.getChildren",
|
||
"title": "warehouse.getChildren 接口",
|
||
"description": "warehouse.getChildren 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "zoneId",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "zoneId 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "仓库模块",
|
||
"moduleKey": "warehouse",
|
||
"moduleFolder": "warehouse",
|
||
"method": "warehouse.getPath",
|
||
"title": "warehouse.getPath 接口",
|
||
"description": "warehouse.getPath 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "仓库模块",
|
||
"moduleKey": "warehouse",
|
||
"moduleFolder": "warehouse",
|
||
"method": "warehouse.getPickPath",
|
||
"title": "warehouse.getPickPath 接口",
|
||
"description": "warehouse.getPickPath 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "warehouse_id 参数"
|
||
},
|
||
{
|
||
"name": "include_spaces",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "include_spaces 参数"
|
||
},
|
||
{
|
||
"name": "limit",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "limit 参数"
|
||
},
|
||
{
|
||
"name": "sort_by",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "sort_by 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"moduleName": "仓库模块",
|
||
"moduleKey": "warehouse",
|
||
"moduleFolder": "warehouse",
|
||
"method": "warehouse.getSpaceInfo",
|
||
"title": "warehouse.getSpaceInfo 接口",
|
||
"description": "warehouse.getSpaceInfo 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": 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": []
|
||
}
|
||
]
|
||
}
|