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

946 lines
27 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": "storeWarehouse.store",
"folder": "storewarehouse.store",
"interfaceCount": 13
},
"changes": {
"fromPreviousSnapshot": {
"moduleAdded": false,
"moduleRenamed": false,
"interfaceChanges": {
"addedMethods": [],
"deletedMethods": [],
"paramsUpdatedMethods": [],
"responseUpdatedMethods": []
}
}
},
"interfaces": [
{
"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"
}
]
},
{
"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": []
},
{
"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": []
},
{
"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": []
},
{
"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": []
},
{
"method": "storeWarehouse.store.queryPrintQuantityLogs",
"title": "按 store_id 分页查询面单余额变更日志",
"description": "按 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": "store_id",
"type": "number|string",
"required": true,
"description": "货主ID(必填)"
},
{
"name": "pagination",
"type": "object",
"required": false,
"description": "分页对象,包含 page 与 page_size;默认 { page: 1, page_size: 20 }"
}
],
"response": [
{
"name": "data",
"type": "object",
"required": true,
"description": "返回结果对象,包含 list 和 pagination"
}
]
},
{
"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": [
{
"name": "data.contract_id",
"type": "number",
"required": true,
"description": "签约关系ID"
},
{
"name": "data.policy_config",
"type": "object",
"required": true,
"description": "策略配置对象(包含默认值补齐后的字段)"
},
{
"name": "data.policy_config.enable_external_express_code",
"type": "number",
"required": true,
"description": "是否启用外部快递编码(flag:0=关闭,1=开启;默认 0)"
}
]
},
{
"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": []
},
{
"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、waybill_custom_display_type(面单自定义显示类型:1=隐藏,2=商品名称和数量,3=拣货库位和条码和数量,4=拣货库位和条码后5位和数量,5=拣货库位商品名称条码和数量)、enable_external_express_code(是否启用外部快递编码,flag:0=关闭,1=开启;默认 0)"
},
{
"name": "policy_config.enable_external_express_code",
"type": "number",
"required": false,
"description": "是否启用外部快递编码(flag:0=关闭,1=开启;默认 0)"
}
],
"response": [
{
"name": "data.contract_id",
"type": "number",
"required": true,
"description": "签约关系ID"
},
{
"name": "data.policy_config",
"type": "object",
"required": true,
"description": "保存后并补齐默认值的策略配置对象"
},
{
"name": "data.policy_config.enable_external_express_code",
"type": "number",
"required": true,
"description": "是否启用外部快递编码(flag:0=关闭,1=开启;默认 0)"
}
]
},
{
"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 序列化"
}
]
},
{
"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 回调通知 URL(可选),最大 500 字符;配置后订单状态变更时将回调通知推送到此地址;兼容别名 callbackUrl"
}
],
"response": []
},
{
"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": []
},
{
"method": "storeWarehouse.store.openAccount",
"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": "username",
"type": "string",
"required": true,
"description": "登录账号(用户名),全局唯一"
},
{
"name": "password",
"type": "string",
"required": false,
"description": "初始密码,不传则自动随机生成 12 位密码"
},
{
"name": "real_name",
"type": "string",
"required": false,
"description": "真实姓名"
},
{
"name": "company_name",
"type": "string",
"required": true,
"description": "公司全称,全局唯一,1-200 字符"
},
{
"name": "business_license",
"type": "string",
"required": false,
"description": "营业执照号"
},
{
"name": "contact_person",
"type": "string",
"required": true,
"description": "联系人姓名,1-50 字符"
},
{
"name": "contact_phone",
"type": "string",
"required": false,
"description": "联系电话"
},
{
"name": "legal_person",
"type": "string",
"required": false,
"description": "法人代表"
},
{
"name": "contact_email",
"type": "string",
"required": false,
"description": "联系邮箱"
},
{
"name": "address",
"type": "string",
"required": false,
"description": "公司地址"
},
{
"name": "industry",
"type": "string",
"required": false,
"description": "所属行业"
},
{
"name": "logo_url",
"type": "string",
"required": false,
"description": "Logo 链接"
},
{
"name": "domain",
"type": "string",
"required": false,
"description": "绑定域名"
},
{
"name": "auth_start",
"type": "string",
"required": false,
"description": "授权开始日期,默认当天(ISO 8601 格式)"
},
{
"name": "auth_end",
"type": "string",
"required": false,
"description": "授权结束日期(ISO 8601 格式)"
},
{
"name": "print_quantity",
"type": "number",
"required": false,
"description": "初始面单余额,默认 0"
},
{
"name": "apply_reason",
"type": "string",
"required": false,
"description": "申请原因,默认\"仓库代开户\",最长 2000 字符"
},
{
"name": "store_remask",
"type": "string",
"required": false,
"description": "货主备注名,最长 50 字符"
},
{
"name": "warehouse_remask",
"type": "string",
"required": false,
"description": "仓库备注名,最长 50 字符"
}
],
"response": [
{
"name": "store_id",
"type": "number",
"required": true,
"description": "新建的货主 ID"
},
{
"name": "account_id",
"type": "number",
"required": true,
"description": "新建的账号 ID"
},
{
"name": "contract_id",
"type": "number",
"required": true,
"description": "新建的签约关系 ID"
},
{
"name": "company_name",
"type": "string",
"required": true,
"description": "货主公司名称"
},
{
"name": "username",
"type": "string",
"required": true,
"description": "新建的登录账号名"
},
{
"name": "role_id",
"type": "number",
"required": true,
"description": "分配的货主管理员角色 ID"
}
]
}
]
}