{ "generatedAt": "2026-06-18 17:45:21", "generatedAtLocal": "2026-06-18 17:45:21", "source": "remote", "filter": { "platform": { "value": "web", "label": "网页端" }, "project": { "value": "all", "label": "全部" } }, "module": { "name": "店铺模块", "key": "shops", "folder": "shops", "interfaceCount": 5 }, "changes": { "fromPreviousSnapshot": { "moduleAdded": false, "moduleRenamed": false, "interfaceChanges": { "addedMethods": [], "deletedMethods": [], "paramsUpdatedMethods": [], "responseUpdatedMethods": [] } } }, "interfaces": [ { "method": "shops.list", "title": "分页查询店铺,支持 where 条件(支持字段:id, platform_code, custom_name, shop_name, status, quickWhere),兼容 snake_case 与 camelCase 入参;返回分页信息与标准化店铺列表。", "description": "分页查询店铺,支持 where 条件(支持字段:id, platform_code, custom_name, shop_name, status, quickWhere),兼容 snake_case 与 camelCase 入参;返回分页信息与标准化店铺列表。", "endpoint": "/system", "authRequired": true, "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": "页码,兼容 pagination.page/currentPage" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页大小,兼容 page_size/pagination.page_size,最大 200" }, { "name": "where", "type": "object", "required": false, "description": "查询条件,支持标准 where 结构或 quickWhere 简写,字段兼容 id/platform_code/custom_name/shop_name/status/quickWhere" } ], "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.list", "type": "array", "required": true, "description": "店铺数组,元素结构见 children" }, { "name": "data.pagination", "type": "object", "required": true, "description": "分页信息" } ] }, { "method": "shops.add", "title": "新增店铺,校验 platform_code 必须匹配已配置且处于 ACTIVE 且未删除的打印平台;custom_name 必填且长度<=100。shop_name 由服务端生成待授权占位名(PENDING_*),授权后再同步真实店铺名。支持 snake_case 与 camelCase 入参兼容。", "description": "新增店铺,校验 platform_code 必须匹配已配置且处于 ACTIVE 且未删除的打印平台;custom_name 必填且长度<=100。shop_name 由服务端生成待授权占位名(PENDING_*),授权后再同步真实店铺名。支持 snake_case 与 camelCase 入参兼容。", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "platform_code", "type": "string", "required": true, "description": "平台编码,兼容 platformCode,服务端会标准化为大写并验证" }, { "name": "custom_name", "type": "string", "required": true, "description": "店铺自定义名称,最大长度 100" } ], "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.id", "type": "number", "required": true, "description": "新建店铺 ID" } ] }, { "method": "shops.del", "title": "软删除店铺:将 shop_name 修改为 DELETED_SHOP__ 并清空敏感字段;若存在 ExpressInterface 引用则返回 409;返回 deleted=true 与 id。", "description": "软删除店铺:将 shop_name 修改为 DELETED_SHOP__ 并清空敏感字段;若存在 ExpressInterface 引用则返回 409;返回 deleted=true 与 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,兼容 shop_id/shopId" } ], "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.deleted", "type": "boolean", "required": true, "description": "是否已删除" }, { "name": "data.id", "type": "number", "required": true, "description": "删除的店铺 ID" } ] }, { "method": "shops.edit", "title": "编辑店铺,仅允许修改 platform_code 或 custom_name;至少传入其中一个。platform_code 会校验平台存在且为 ACTIVE;custom_name 必填且长度<=100;服务端兼容 snake_case/camelCase。", "description": "编辑店铺,仅允许修改 platform_code 或 custom_name;至少传入其中一个。platform_code 会校验平台存在且为 ACTIVE;custom_name 必填且长度<=100;服务端兼容 snake_case/camelCase。", "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,兼容 shop_id/shopId" }, { "name": "platform_code", "type": "string", "required": false, "description": "平台编码,兼容 platformCode,服务端会转为大写并校验" }, { "name": "custom_name", "type": "string", "required": false, "description": "自定义名称,兼容 customName,若传入需非空且 <=100 字符" } ], "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.updated", "type": "boolean", "required": true, "description": "是否已更新" }, { "name": "data.id", "type": "number", "required": true, "description": "被更新的店铺 ID" } ] }, { "method": "shops.GetAuthorizeSessionKey", "title": "按店铺所属平台生成授权会话。入参兼容 id/shop_id/shopId 与 callbackurl/callback_url,callbackurl 必填。对已实现的平台(PDD/CAINIAO)返回 session_key/authorize_url/state,其他平台返回 501 未实现。", "description": "按店铺所属平台生成授权会话。入参兼容 id/shop_id/shopId 与 callbackurl/callback_url,callbackurl 必填。对已实现的平台(PDD/CAINIAO)返回 session_key/authorize_url/state,其他平台返回 501 未实现。", "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,兼容 shop_id/shopId" }, { "name": "callbackurl", "type": "string", "required": true, "description": "回调地址,兼容 callback_url" } ], "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.shop_id", "type": "number", "required": true, "description": "店铺 ID" }, { "name": "data.platform_code", "type": "string", "required": true, "description": "平台编码(大写)" }, { "name": "data.callbackurl", "type": "string", "required": true, "description": "回调地址" }, { "name": "data.session_key", "type": "string", "required": true, "description": "授权预占码(session)" }, { "name": "data.authorize_url", "type": "string", "required": true, "description": "平台授权跳转地址(含 state)" }, { "name": "data.state", "type": "string", "required": true, "description": "内部 state 值(platform + '_' + authRandomCode),用于回调解析" } ] } ] }