304 lines
9.7 KiB
JSON
304 lines
9.7 KiB
JSON
{
|
||
"generatedAt": "2026-06-12 15:55:40",
|
||
"generatedAtLocal": "2026-06-12 15:55:40",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "主体模块",
|
||
"key": "store",
|
||
"folder": "store",
|
||
"interfaceCount": 6
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "store.createStore",
|
||
"title": "store.createStore 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))",
|
||
"description": "store.createStore 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "subject_config",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "货主主体配置,不传时自动写入默认值"
|
||
},
|
||
{
|
||
"name": "subject_config.max_notice_webhook_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "当前主体最多允许绑定 / 触达的消息推送接口数量,默认 5"
|
||
},
|
||
{
|
||
"name": "subject_config.default_express_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "默认快递编码,缺省为 STO"
|
||
},
|
||
{
|
||
"name": "subject_config.default_platform_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "默认平台编码,缺省为 TB"
|
||
},
|
||
{
|
||
"name": "subject_config.group_wave_prefix",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "团购波次前缀,最多 5 个字符,默认 B"
|
||
},
|
||
{
|
||
"name": "subject_config.min_group_order_fetch_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最小团购订单抓取数量,默认 13"
|
||
},
|
||
{
|
||
"name": "subject_config.auto_grouping_enabled",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否自动加团,默认 false(关闭)"
|
||
},
|
||
{
|
||
"name": "subject_config.enable_external_express_code",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "store.createWarehouse",
|
||
"title": "store.createWarehouse 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))",
|
||
"description": "store.createWarehouse 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "subject_config",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "货主主体配置,不传时自动写入默认值"
|
||
},
|
||
{
|
||
"name": "subject_config.max_notice_webhook_count",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "当前主体最多允许绑定 / 触达的消息推送接口数量,默认 5"
|
||
},
|
||
{
|
||
"name": "subject_config.default_express_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "默认快递编码,缺省为 STO"
|
||
},
|
||
{
|
||
"name": "subject_config.default_platform_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "默认平台编码,缺省为 TB"
|
||
},
|
||
{
|
||
"name": "subject_config.group_wave_prefix",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "团购波次前缀,最多 5 个字符,默认 B"
|
||
},
|
||
{
|
||
"name": "subject_config.min_group_order_fetch_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "最小团购订单抓取数量,默认 13"
|
||
},
|
||
{
|
||
"name": "subject_config.auto_grouping_enabled",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否自动加团,默认 false(关闭)"
|
||
},
|
||
{
|
||
"name": "subject_config.enable_external_express_code",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "store.joinStore",
|
||
"title": "store.joinStore 接口",
|
||
"description": "store.joinStore 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "store.joinWarehouse",
|
||
"title": "store.joinWarehouse 接口",
|
||
"description": "store.joinWarehouse 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "store.getStoreRoles",
|
||
"title": "store.getStoreRoles 接口",
|
||
"description": "store.getStoreRoles 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "申请码(join_token)"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "store.auditApply",
|
||
"title": "store.auditApply 接口",
|
||
"description": "store.auditApply 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "audit_status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "审核状态(approved/rejected)"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "申请码(join_token)"
|
||
},
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前审批门店ID"
|
||
},
|
||
{
|
||
"name": "role_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "分配角色ID数组"
|
||
},
|
||
{
|
||
"name": "reject_reason",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "拒绝原因(audit_status=rejected 时可传)"
|
||
}
|
||
],
|
||
"response": []
|
||
}
|
||
]
|
||
}
|