2026-06-05 18:22:15 +08:00

178 lines
4.8 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

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

{
"generatedAt": "2026-06-05 17:45:07",
"generatedAtLocal": "2026-06-05 17:45:07",
"source": "remote",
"filter": {
"platform": {
"value": "web",
"label": "网页端"
},
"project": {
"value": "all",
"label": "全部"
}
},
"module": {
"name": "仓库设置模块",
"key": "setting.warehouse",
"folder": "setting.warehouse",
"interfaceCount": 3
},
"changes": {
"fromPreviousSnapshot": {
"moduleAdded": false,
"moduleRenamed": false,
"interfaceChanges": {
"addedMethods": [],
"deletedMethods": [],
"paramsUpdatedMethods": [],
"responseUpdatedMethods": []
}
}
},
"interfaces": [
{
"method": "setting.warehouse.getSettings",
"title": "获取当前登录仓库的 subject_config",
"description": "获取当前登录仓库的 subject_config",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": [
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "仓库 ID"
},
{
"name": "subject_config",
"type": "object",
"required": true,
"description": "仓库的 subject_config 配置对象"
},
{
"name": "subject_config.enable_external_express_code",
"type": "boolean",
"required": true,
"description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)"
}
]
},
{
"method": "setting.warehouse.getFieldMeta",
"title": "获取仓库设置字段元信息",
"description": "获取仓库设置字段元信息",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": [
{
"name": "list",
"type": "array",
"required": false,
"description": "字段元信息数组"
}
]
},
{
"method": "setting.warehouse.saveSettings",
"title": "修改仓库设置并清理指定仓库缓存",
"description": "修改仓库设置并清理指定仓库缓存",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "subject_config",
"type": "object",
"required": true,
"description": "仓库的 subject_config 对象"
},
{
"name": "cache_warehouse_id",
"type": "number",
"required": false,
"description": "需清理缓存的仓库 ID(下划线命名兼容)"
},
{
"name": "cacheWarehouseId",
"type": "number",
"required": false,
"description": "需清理缓存的仓库 ID(驼峰命名兼容)"
},
{
"name": "subject_config.enable_external_express_code",
"type": "boolean",
"required": false,
"description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)"
}
],
"response": [
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "生效的仓库 ID"
},
{
"name": "subject_config",
"type": "object",
"required": true,
"description": "保存后的 subject_config"
},
{
"name": "cache_cleared_warehouse_id",
"type": "number",
"required": true,
"description": "被清理缓存的仓库 ID(若未清理则为 null)"
},
{
"name": "subject_config.enable_external_express_code",
"type": "boolean",
"required": true,
"description": "保存后的 subject_config.enable_external_express_code 值"
}
]
}
]
}