查询加盟品牌

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/searchBrand

请求参数：

参数名 描述 数据类型 必填 字节长度
page
pageNum 第几页 int 是
pageSize 每页条数 int 是
param
brandUuidList 品牌uuid集合 List<String> 否
statusCode 品牌状态
{
  enable:启用,
  disable:禁用
} 		String 否
keyWord 关键搜索：公司名称、备注 String 否

请求示例

{
  "page": {
    "pageNum": 1,
    "pageSize": 10
  },
  "param": {
    "brandUuidList": [
      "41e595df936b4f4dae1280daf6a0b368"
    ],
    "keyWord": "加盟公司",
    "statusCode": "enable"
  }
}

返回参数：List

参数名 描述 数据类型 必填 字节长度
count 查询总数 int 是
items
brandUuid 品牌uuid String 是 100
brandName 品牌名称 String 是 100
companyName 公司名称 String 是 100
franchiseeSize 加盟商数量 Long 是
storeSize 门店数量 Long 是
openStoreSize 运营门店数量 Long 是
agentSize 经纪人数量 Long 是
statusCode 品牌状态码 String 是 100
statusText 品牌状态[启动/禁用] String 是 100
remark 备注 String 否 500

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": {
    "count": 1,
    "items": [
      {
        "brandUuid": "41e595df936b4f4dae1280daf6a0b368",
        "brandName": "xx品牌",
        "companyName": "xxxxx公司",
        "franchiseeSize": 1,
        "storeSize": 1,
        "openStoreSize": 1,
        "agentSize": 10,
        "statusCode": "enable",
        "statusText": "启用",
        "remark": "备注"
      }
    ]
  }
}

新增加盟品牌

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/addBrand

请求参数：

参数名 描述 数据类型 必填 字节长度
brandName 品牌名称 String 是 100
companyName 公司名称 String 是 100
unifiedSocialCode 统一社会信用代码 String 是 100
companyAddress 公司地址 String 否 200
corporateName 法人姓名 String 否 100
corporateIDNum 法人身份证号 String 否 100
corporatePhone 法人联系方式 String 否 100
remark 备注 String 否 500
moveAccountEmpUuidList 动账联系人的uuid List<String> 否
brandManagerList 品牌管理员 List<String> 否
attachments 附件列表 List<AddFranchiseeAttachmentDTO> 否
contacts 联系人列表 List<AddFranchiseeContactDTO> 是  
附件列表 List<AddFranchiseeAttachmentDTO>
参数名 描述 数据类型 必填 字节长度
attachName 附件名称 String 是 100
attachUrl 附件链接 String 是 200
attachTypeCfgUuid 附件类型物业参数 String 是 100
meta 附件meta String 否 20
联系人列表 List<AddFranchiseeContactDTO>
参数名 描述 数据类型 必填 字节长度
userName 联系人姓名 String 是 100
userPhone 联系人电话 String 是 100
userIdNum 联系人证件号码 String 是 100

请求示例：

{
  "param": {
    "brandName": "巧房",
    "companyAddress": "上海晶耀前滩",
    "companyName": "上海巧房信息科技有限公司",
    "corporateIDNum": "123456789012345678",
    "corporateName": "张三",
    "corporatePhone": "18512341234",
    "remark": "备注",
    "unifiedSocialCode": "9135052155323005XL",
    "moveAccountEmpUuidList": [
      "eeebf6dc-7dc1-4b72-b68e-cc8f1a3abb89"
    ],
    "brandManagerList": [
      "eeebf6dc-7dc1-4b72-b68e-cc8f1a3abb89"
    ],
    "attachments": [
      {
        "attachName": "附件",
        "attachTypeCfgUuid": "be27e7c8f4aa44368b02a1d00ab4d367",
        "attachUrl": "http://image.qfstatic.com/saas2_test2_company3_company7j8h6gh5tf/2021/07/20210722/f11d2415d5e3488da58bd309cde77f52",
        "meta": "image/png"
      }
    ],
    "contacts": [
      {
        "userIdNum": "513436200010139434",
        "userName": "李四",
        "userPhone": "13112341234"
      }
    ]
  }
}

返回参数：

参数名 描述 数据类型 必填 字节长度
data 品牌uuid String 是 100

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": "9925a691-c7b9-4d11-91d0-942801aa29ec"
}

更新加盟品牌

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/updateBrand

请求参数：

参数名 描述 数据类型 必填 字节长度
brandUuid 品牌uuid String 是 100
brandName 品牌名称 String 是 100
companyName 公司名称 String 是 100
unifiedSocialCode 统一社会信用代码 String 是 100
companyAddress 公司地址 String 否 200
corporateName 法人姓名 String 否 100
corporateIDNum 法人身份证号 String 否 100
corporatePhone 法人联系方式 String 否 100
remark 备注 String 否 500
moveAccountEmpUuidList 动账联系人的uuid List<String> 否
attachments 附件列表 List<AddFranchiseeAttachmentDTO> 否
contacts 联系人列表 List<AddFranchiseeContactDTO> 是  
附件列表 List<AddFranchiseeAttachmentDTO>
参数名 描述 数据类型 必填 字节长度
attachName 附件名称 String 是 100
attachUrl 附件链接 String 是 200
attachTypeCfgUuid 附件类型物业参数 String 是 100
meta 附件meta String 否 100
联系人列表 List<AddFranchiseeContactDTO>
参数名 描述 数据类型 必填 字节长度
userName 联系人姓名 String 是 100
userPhone 联系人电话 String 是 100
userIdNum 联系人证件号码 String 是 100

请求示例：

{
  "param": {
    "brandUuid": "41e595df936b4f4dae1280daf6a0b368",
    "brandName": "巧房",
    "companyAddress": "上海晶耀前滩",
    "companyName": "上海巧房信息科技有限公司",
    "corporateIDNum": "123456789012345678",
    "corporateName": "张三",
    "corporatePhone": "18512341234",
    "remark": "备注",
    "unifiedSocialCode": "9135052155323005XL",
    "moveAccountEmpUuidList": [
      "eeebf6dc-7dc1-4b72-b68e-cc8f1a3abb89"
    ],
    "attachments": [
      {
        "attachName": "附件",
        "attachTypeCfgUuid": "be27e7c8f4aa44368b02a1d00ab4d367",
        "attachUrl": "http://image.qfstatic.com/saas2_test2_company3_company7j8h6gh5tf/2021/07/20210722/f11d2415d5e3488da58bd309cde77f52",
        "meta": "image/png"
      }
    ],
    "contacts": [
      {
        "userIdNum": "513436200010139434",
        "userName": "李四",
        "userPhone": "13112341234"
      }
    ]
  }
}

返回参数：无

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": null
}

禁用加盟品牌

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/disableBrand

请求参数：

参数名 描述 数据类型 必填 字节长度
param 品牌uuid String 是 100

请求示例：

{
  "param": "41e595df936b4f4dae1280daf6a0b368"
}

返回参数：无

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": null
}

查询加盟品牌详情

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/getBrandByUuid

请求参数：

参数名 描述 数据类型 必填 字节长度
param 品牌uuid String 是 100

请求示例：

{
  "param": "f33078b31e3b4e2fb05d10ce11e66f9f"
}

返回参数：

参数名 描述 数据类型 必填 字节长度
brandUuid 品牌uuid String 是 100
brandName 品牌名称 String 是 100
companyName 公司名称 String 是 100
statusCode 品牌状态 String 是 100
unifiedSocialCode 统一社会信用代码 String 是 100
companyAddress 公司地址 String 否 200
corporateName 法人姓名 String 否 100
corporateIDNum 法人身份证号 String 否 100
corporatePhone 法人联系方式 String 否 100
remark 备注 String 否 500
moveAccountEmpUuidList 动账联系人的uuid List<String> 否
attachments 附件列表 List<AddFranchiseeAttachmentDTO> 否
contacts 联系人列表 List<AddFranchiseeContactDTO> 是  
附件列表 List<AddFranchiseeAttachmentDTO>
参数名 描述 数据类型 必填 字节长度
attachName 附件名称 String 是 100
attachUrl 附件链接 String 是 200
attachTypeCfgUuid 附件类型物业参数 String 是 100
meta 附件meta String 否 100
联系人列表 List<AddFranchiseeContactDTO>
参数名 描述 数据类型 必填 字节长度
franContactUuid 联系人uuid String 是 100
userName 联系人姓名 String 是 100
userPhone 联系人电话 String 是 100
userIdNum 联系人证件号码 String 是 100

返回示例：

{
  "brandUuid": "f33078b31e3b4e2fb05d10ce11e66f9f",
  "brandName": "巧房",
  "companyAddress": "上海晶耀前滩",
  "companyName": "上海巧房信息科技有限公司",
  "corporateIDNum": "123456789012345678",
  "corporateName": "张三",
  "corporatePhone": "18512341234",
  "remark": "备注",
  "unifiedSocialCode": "9135052155323005XL",
  "moveAccountEmpUuidList": [
    "eeebf6dc-7dc1-4b72-b68e-cc8f1a3abb89"
  ],
  "brandManagerList": [
    "eeebf6dc-7dc1-4b72-b68e-cc8f1a3abb89"
  ],
  "attachments": [
    {
      "attachName": "附件",
      "attachTypeCfgUuid": "be27e7c8f4aa44368b02a1d00ab4d367",
      "attachUrl": "http://image.qfstatic.com/saas2_test2_company3_company7j8h6gh5tf/2021/07/20210722/f11d2415d5e3488da58bd309cde77f52",
      "meta": "image/png"
    }
  ],
  "contacts": [
    {
      "franContactUuid": "be27e7c8f4aa44368b02a1d00ab4d367",
      "userIdNum": "513436200010139434",
      "userName": "李四",
      "userPhone": "13112341234"
    }
  ],
  "moveAccountEmpUuidList": [
    "eeebf6dc-7dc1-4b72-b68e-cc8f1a3abb89"
  ]
}

查询加盟商

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/searchFranchisee

请求参数：

参数名 描述 数据类型 必填 字节长度
page
pageNum 第几页 int 是
pageSize 每页条数 int 是
param
brandUuidList 品牌Uuid集合 List<String> 否
statusCode 加盟商状态
{
  enable:启用,
  disable:禁用
} 		String 否 100
gridConnectStatus 并网状态 String 否 100
keyWord 其他筛选项{联系人,手机号公司名称,备注} String 否

请求示例：

{
  "page": {
    "pageNum": 1,
    "pageSize": 20
  },
  "param": {
    "statusCode": "enable"
  }
}

返回参数

参数名 描述 数据类型 字节长度
count 查询总数 int
items
franUuid 加盟商uuid String 100
franName 加盟商名称 String 100
brandName 归属品牌 String 100
companyName 公司名称 String 100
userName 联系人 String 100
userPhone 联系方式 String 100
storeSize 门店数量 Long  
openStoreSize 运营门店数量 Long  
agentSize 经济人数量 Long  
statusCode 状态编码 String 100
statusText 状态[启用/禁用] String 100
remark 备注 String 500
cooperStartDate 合作开始时间 Date  
cooperEndDate 合作结束时间 Date  
contractStatusCode 合作状态 String 100
gridConnectStatus 并网状态 String 100
dueFlag true:即将到期 默认值：false Boolean  

返回示例

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": {
    "items": [
      {
        "franUuid": "b63ef3502ab248b5bedf869e2c99ddfc",
        "franName": "yaohuihui",
        "brandName": "姚会会test",
        "companyName": null,
        "userName": "姚会会加盟",
        "userPhone": "13162085569",
        "storeSize": 0,
        "openStoreSize": 0,
        "agentSize": 0,
        "statusCode": "enable",
        "statusText": "启用",
        "remark": "",
        "cooperStartDate": null,
        "cooperEndDate": null,
        "contractStatusCode": "signed",
        "gridConnectStatus": "gridConnecting",
        "dueFlag": false
      },
      {
        "franUuid": "5b2babcb53154b7ea1d2cdfe85369222",
        "franName": "一个品牌加盟商1",
        "brandName": "一个测试品牌3",
        "companyName": "小明的公司",
        "userName": "小明",
        "userPhone": "13397482983",
        "storeSize": 1,
        "openStoreSize": 0,
        "agentSize": 0,
        "statusCode": "enable",
        "statusText": "启用",
        "remark": "",
        "cooperStartDate": null,
        "cooperEndDate": null,
        "contractStatusCode": "signed",
        "gridConnectStatus": "gridConnecting",
        "dueFlag": false
      }
    ],
    "count": 2
  }
}

新增加盟商

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/addFranchisee

请求参数：

参数名 描述 数据类型 必填 字节长度
franName 加盟商名称 String 是 100
franTypeCode 加盟商类型 String 是 100
companyName 公司名称 String 否 100
unifiedSocialCode 统一社会信用代码 String 否 100
companyAddress 公司地址 String 否 200
corporateName 法人姓名 String 否 100
corporateIDNum 法人身份证号 String 否 100
corporatePhone 法人联系方式 String 否 100
remark 备注 String 否 500
attachments 附件列表 List<AddFranchiseeAttachmentDTO> 否  
contacts 加盟商列表 List<AddFranchiseeContactDTO> 否  
brandUuid 品牌uuid String 是 100
cooperStartDate 合作开始时间 Date 否  
cooperEndDate 合作结束时间 Date 否  
bond 保证金 BigDecimal 否  
moveAccountEmpUuidList 动账联系人的uuid List <String> 否  
franchiseeManagerList 加盟商管理员 List <String> 否  
附件列表 List<AddFranchiseeAttachmentDTO>
参数名 描述 数据类型 必填 字节长度
attachName 附件名称 String 是 100
attachUrl 附件链接 String 是 200
attachTypeCfgUuid 附件类型物业参数 String 是 100
meta 附件meta String 否 100
加盟商列表 List<AddFranchiseeContactDTO>
参数名 描述 数据类型 必填 字节长度
userName 联系人姓名 String 是 100
userPhone 联系人电话 String 是 100
userIdNum 联系人证件号码 String 是 100

请求示例：

{
  "param": {
    "attachments": [
      {
        "attachName": "附件1",
        "attachTypeCfgUuid": "storeAffixType-copyOfbusinessLicense",
        "attachUrl": "http://image.qfstatic.com/saas2_test2_company3_company7j8h6gh5tf/2021/07/20210722/f11d2415d5e3488da58bd309cde77f52",
        "meta": "image/png"
      }
    ],
    "bond": 0,
    "brandUuid": "305aff94c296497899454ecd86fdd799",
    "companyAddress": "湖南长沙",
    "companyName": "QF122",
    "contacts": [
      {
        "userIdNum": "430429198809092287",
        "userName": "小萌",
        "userPhone": "1243635767463"
      }
    ],
    "cooperEndDate": 1635328355000,
    "cooperStartDate": 1632736355000,
    "corporateIDNum": "430429198809092267",
    "corporateName": "小明",
    "corporatePhone": "1354364676543",
    "franName": "加盟商11",
    "franTypeCode": "company",
    "franchiseeManagerList": [
      "66e09739-fafa-4e20-932a-c99d45f19b0c"
    ],
    "moveAccountEmpUuidList": [
      "66e09739-fafa-4e20-932a-c99d45f19b0c"
    ],
    "remark": "string",
    "unifiedSocialCode": "9135052155323005XF"
  }
}

返回参数：

参数名 描述 数据类型 字节长度
data 加盟商uuid String 100

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": "5c49058812d64c46b8ddd04121521ca5"
}

更新加盟商

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/updateFranchisee

请求参数：

参数名 描述 数据类型 必填 字节长度
franUuid 加盟商uuid String 是 100
franName 加盟商名称 String 是 100
companyName 公司名称 String 否 100
unifiedSocialCode 统一社会信用代码 String 否 100
companyAddress 公司地址 String 否 200
corporateName 法人姓名 String 否 100
corporateIDNum 法人身份证号 String 否 100
corporatePhone 法人联系方式 String 否 100
remark 备注 String 否 500
attachments 附件列表 List<AddFranchiseeAttachmentDTO> 否  
contacts 加盟商列表 List<AddFranchiseeContactDTO> 是  
brandUuid 品牌uuid String 是 100
bond 保证金 BigDecimal 否  
moveAccountEmpUuidList 动账联系人的uuid List <String> 否  
franchiseeManagerList 加盟商管理员 List <String> 否  
附件列表 List<AddFranchiseeAttachmentDTO>
参数名 描述 数据类型 必填 字节长度
attachName 附件名称 String 是 100
attachUrl 附件链接 String 是 200
attachTypeCfgUuid 附件类型物业参数 String 是 100
meta 附件meta String 否 100
加盟商列表 List<AddFranchiseeContactDTO>
参数名 描述 数据类型 必填 字节长度
userName 联系人姓名 String 是 100
userPhone 联系人电话 String 是 100
userIdNum 联系人证件号码 String 是 100

请求示例：

{
  "param": {
    "attachments": [
      {
        "attachName": "附件2",
        "attachTypeCfgUuid": "storeAffixType-copyOfbusinessLicense",
        "attachUrl": "http://image.qfstatic.com/saas2_test2_company3_company7j8h6gh5tf/2021/07/20210722/f11d2415d5e3488da58bd309cde77f52",
        "meta": "image/png"
      }
    ],
    "bond": 0,
    "brandUuid": "305aff94c296497899454ecd86fdd799",
    "companyAddress": "湖南长沙",
    "companyName": "qf123",
    "contacts": [
      {
        "userIdNum": "430429198809092287",
        "userName": "小萌",
        "userPhone": "1243635767463"
      }
    ],
    "corporateIDNum": "430429198809092267",
    "corporateName": "小明",
    "corporatePhone": "1354364676543",
    "franName": "加盟商12",
    "franUuid": "d7a56cc53c00467db265eb49a5a3967c",
    "moveAccountEmpUuidList": [
      "string"
    ],
    "remark": "修改",
    "unifiedSocialCode": "9135052155323005XM"
  }
}

返回参数：无

参数名 描述 数据类型 字节长度
null Void  

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": null
}

加盟商解约

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/breakFranchiseeContract

请求参数：

参数名 描述 数据类型 必填 字节长度
param 加盟商uuid String 是 100

请求示例：

{
  "param": "d7a56cc53c00467db265eb49a5a3967c"
}

返回参数：无

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": null
}

加盟商并网

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/updateGridConnectStatusToConnected

请求参数：

参数名 描述 数据类型 必填 字节长度
param 加盟商uuid String 是 100

请求示例：

{
  "param": "d7a56cc53c00467db265eb49a5a3967c"
}

返回参数：无

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": null
}

查询加盟商详情

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/getFranchiseeByUuid

请求参数：

参数名 描述 数据类型 必填 字节长度
param 加盟商uuid String 是 100

请求示例：

{
  "param": "f33078b31e3b4e2fb05d10ce11e66f9f"
}

返回参数：

参数名 描述 数据类型 字节长度
franUuid 加盟商uuid String 100
franName 加盟商名称 String 100
companyName 加盟商类型：个人/公司 String 100
unifiedSocialCode 加盟类型 品牌/加盟商/加盟门 String 100
companyName 公司名称 String 100
unifiedSocialCode 统一社会信用代码 String 100
companyAddress 公司地址 String 200
corporateName 加盟商姓名 String 100
corporateIDNum 加盟商身份证号 String 100
corporatePhone 加盟商联系方式 String 100
remark 备注 String 500
attachments 附件列表 List<AddFranchiseeAttachmentDTO>  
contacts 加盟商列表 List<AddFranchiseeContactDTO>  
brandUuid 品牌uuid String 100
bond 保证金 BigDecimal  
allianceFlag 是否是迁移过来的门店 true：迁移过来的 Boolean  
deptUuid 关联的部门uuid String 100
moveAccountEmpUuidList 动账联系人的uuid List <String>  
contractStatusCode 合同状态 String 100
createdTime 创建时间 Date  
updatedTime 修改时间 Date  
附件列表 List<AddFranchiseeAttachmentDTO>
参数名 描述 数据类型 必填 字节长度
attachName 附件名称 String 是 100
attachUrl 附件链接 String 是 200
attachTypeCfgUuid 附件类型物业参数 String 是 100
meta 附件meta String 否 100
加盟商列表 List<AddFranchiseeContactDTO>
参数名 描述 数据类型 必填 字节长度
franContactUuid 联系人uuid String 是 100
userName 联系人姓名 String 是 100
userPhone 联系人电话 String 是 100
userIdNum 联系人证件号码 String 是 100

返回示例：

{
  "franUuid": "f33078b31e3b4e2fb05d10ce11e66f9f",
  "franName": "加盟商第四个",
  "franTypeCode": "company",
  "typeCode": "franchisee",
  "companyName": "测试第四个",
  "unifiedSocialCode": "第四个",
  "companyAddress": "v测试地址11111",
  "corporateName": "小明",
  "corporateIDNum": "430429198809092267",
  "corporatePhone": "1354364676543",
  "remark": "string",
  "statusCode": "enable",
  "attachments": [],
  "contacts": [
    {
      "franContactUuid": "60824bf1991448859287f458d944bb02",
      "userName": "王小明",
      "userPhone": "1243635767463",
      "userIdNum": "430429198809092287"
    }
  ],
  "brandUuid": "13449d36fddc42bb83e7424e5aa5ab12",
  "cooperStartDate": 1632736355000,
  "cooperEndDate": 1635328355000,
  "bond": 0,
  "allianceFlag": false,
  "deptUuid": null,
  "moveAccountEmpUuidList": [
    "66e09739-fafa-4e20-932a-c99d45f19b0c"
  ],
  "createdTime": 1634007018257,
  "updatedTime": null,
  "contractStatusCode": "signed",
  "brandName": "一个测试品牌"
}

查询加盟店(根据名称查询)

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/searchStore

请求参数：

参数名 描述 数据类型 必填 字节长度
page
pageNum 第几页 int 是
pageSize 每页条数 int 是
param
brandUuidList 品牌Uuid集合 List<String> 否
statusCodeList 门店状态集合
{
  enable:启用,
  disable:禁用
} 		List<String> 否
contractStatusCodeList 合同状态集合 String 否
keyWord 关键词 String 否
parentDeptUuid 父级部门uuid String 否
gridConnectStatus 并网状态 String 否 100

请求示例:

{
  "page": {
    "desc": "",
    "offset": 0,
    "pageNum": 1,
    "pageSize": 1,
    "sortBy": ""
  },
  "param": {
    "brandUuidList": [],
    "contractStatusCodeList": [],
    "gridConnectStatus": "",
    "keyWord": "张三的店",
    "parentDeptUuid": "",
    "statusCodeList": []
  }
}

返回参数：

参数名 描述 数据类型 是否必填 字节长度
count 查询总数 int 否
items
storeUuid 门店uuid String 否 100
storeName 门店名称 String 否 100
franUuid 加盟商uuid String 否 100
franName 加盟商名称 String 否 100
franContractStatusCode 加盟商合作状态 String 否 100
brandUuid 品牌uuid String 否 100
brandName 品牌名称 String 否 100
deptUuid 组织结构的部门uuid String 否 100
parentDeptUuid 父级部门 String 否 100
empCount 经纪人数 Long 否 |
cooperStartDate 合作开始时间 Date 否 |
cooperEndDate 合作结束时间 Date 否 |
contractStatusCode 合作状态 String 否 100
statusCode 门店状态 String 否 100
remark 备注 String 否 100
dueFlag true:即将到期 Boolean 否 |
gridConnectStatus 并网状态 String 否 100

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": {
    "items": [
      {
        "storeUuid": "b776d297e3664b4fac83d507df0dc937",
        "storeName": "~张三的店子~",
        "franUuid": "qianhouduanliandiaoy_saas2_99dcd576f",
        "franName": "前后端联调用公司1",
        "franContractStatusCode": "signed",
        "brandUuid": "21684cee521e4202a60ccfb4c3e1ef51",
        "brandName": null,
        "deptUuid": "b2b70c02b9b54ad0835d42306c14de7a",
        "parentDeptUuid": null,
        "empCount": 0,
        "cooperStartDate": 1632904300453,
        "cooperEndDate": 1885451500000,
        "contractStatusCode": "signed",
        "statusCode": "open",
        "remark": "string",
        "dueFlag": false,
        "gridConnectStatus": "gridConnecting"
      }
    ],
    "count": 3
  }
}

新增加盟店

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/addStore

请求参数：

参数名 描述 数据类型 必填 字节长度
storeName 门店名称 String storeName&deptUuid至少一个 100
deptUuid 关联的部门uuid String storeName&deptUuid至少一个 100
brandUuid 品牌uuid String 是 100
franUuid 加盟商uuid String 否 100
companyName 公司名称 String 是 100
unifiedSocialCode 统一社会信用代码 String 是 100
companyAddress 公司地址 String 否 200
corporateName 法人姓名 String 是 100
corporateIDNum 法人身份证号 String 是 100
corporatePhone 法人联系方式 String 是 100
cooperStartDate 合作开始时间 Date 否 \
cooperEndDate 合作结束时间 Date 否 \
bond 保证金 BigDecimal 否 (18,9)
remark 备注 String 否 100
statusCode 门店状态 String 否 100
moveAccountEmpUuidList 动账联系人的uuid List<String> 否 \
attachments 附件列表 List<AddFranchiseeAttachmentDTO> 否 \
contacts @NotEmpty 联系人列表 List<AddFranchiseeContactDTO> 是 \
signingUuid 签约uuid String 否 100
signingNo 签约编号 String 否 \
附件列表List<AddFranchiseeAttachmentDTO>
参数名 描述 数据类型 必填 字节长度
attachName 附件名称 String 否 100
attachUrl 附件链接 String 否 200
attachTypeCfgUuid 附件类型物业参数 String 否 100
meta 附件meta String 否 20
联系人列表List<AddFranchiseeContactDTO>
参数名 描述 数据类型 必填 字节长度
userName 用户名称 String 否 100
userPhone 联系人电话 String 否 100
userIdNum 联系人证件号 String 否 100

请求示例:

{
  "param": {
    "attachments": [
      {
        "attachName": "附件",
        "attachTypeCfgUuid": "be27e7c8f4aa44368b02a1d00ab4d367",
        "attachUrl": "http://image.qfstatic.com/saas2_test2_company3_company7j8h6gh5tf/2021/07/20210722/f11d2415d5e3488da58bd309cde77f52",
        "meta": "image/png"
      }
    ],
    "bond": 100.00,
    "brandUuid": "b2b70c02b9b54ad0835d42306c14de7a",
    "companyAddress": "测试",
    "companyName": "张三",
    "contacts": [
      {
        "userIdNum": "028627197612215551",
        "userName": "张三",
        "userPhone": "13746836519"
      }
    ],
    "cooperEndDate": 1885451500000,
    "cooperStartDate": 1632904300452,
    "corporateIDNum": "028627197612215551",
    "corporateName": "张三",
    "corporatePhone": "13746836519",
    "deptUuid": "b2b70c02b9b54ad0835d42306c14de7a",
    "franUuid": "qianhouduanliandiaoy_saas2_99dcd576f",
    "moveAccountEmpUuidList": [
      "string"
    ],
    "remark": "string",
    "statusCode": "open",
    "storeManagerList": [],
    "storeName": "~张三的店子~",
    "unifiedSocialCode": "123456"
  }
}

返回参数：

参数名 描述 数据类型 必填 字节长度
storeUuid 门店uuid String 是 100

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": "b776d297e3664b4fac83d507df0dc937"
}

更新加盟店

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/updateStore

请求参数：

参数名 描述 数据类型 必填 字节长度
storeUuid 门店uuid String 是 100
companyName 公司名称 String 否 100
unifiedSocialCode 统一社会信用代码 String 否 100
companyAddress 公司地址 String 否 200
corporateName 法人姓名 String 否 100
corporateIDNum 法人身份证号 String 否 100
corporatePhone 法人联系方式 String 否 100
bond 保证金 BigDecimal 否 (18,9)
remark 备注 String 否 500
attachments 附件列表 List<AddFranchiseeAttachmentDTO> 否 \
contacts @NotEmpty 联系人列表 List<AddFranchiseeContactDTO> 是 \
附件列表List<AddFranchiseeAttachmentDTO>
参数名 描述 数据类型 必填 字节长度
attachName 附件名称 String 否 100
attachUrl 附件链接 String 否 200
attachTypeCfgUuid 附件类型物业参数 String 否 100
meta 附件meta String 否 20
联系人列表List<AddFranchiseeContactDTO>
参数名 描述 数据类型 必填 字节长度
userName 用户名称 String 否 100
userPhone 联系人电话 String 否 100
userIdNum 联系人证件号 String 否 100

请求示例:

{
  "param": {
    "attachments": [
      {
        "attachName": "附件",
        "attachTypeCfgUuid": "be27e7c8f4aa44368b02a1d00ab4d367",
        "attachUrl": "http://image.qfstatic.com/saas2_test2_company3_company7j8h6gh5tf/2021/07/20210722/f11d2415d5e3488da58bd309cde77f52",
        "meta": "image/png"
      }
    ],
    "bond": 100,
    "companyAddress": "测试",
    "companyName": "张三",
    "contacts": [
      {
        "userIdNum": "028627197612215551",
        "userName": "张三",
        "userPhone": "13746836519"
      }
    ],
    "corporateIDNum": "546100196305201123",
    "corporateName": "张三",
    "corporatePhone": "13746836519",
    "moveAccountEmpUuidList": [
      "string"
    ],
    "remark": "青青草原",
    "storeManagerList": [],
    "storeUuid": "b776d297e3664b4fac83d507df0dc937",
    "unifiedSocialCode": "123456"
  }
}

返回参数：无

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": null
}

加盟店解约

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/breakContract

请求参数：

参数名 描述 数据类型 必填 字节长度
param 门店Uuid String 是 100

请求示例:

{
  "param": "b776d297e3664b4fac83d507df0dc937"
}

返回参数：无

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": null
}

加盟店并网

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/updateStoreConnectStatusToConnected

请求参数：

参数名 描述 数据类型 必填 字节长度
param 门店Uuid String 是 100

请求示例:

{
  "param": "b776d297e3664b4fac83d507df0dc937"
}

返回参数：无

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": null
}

查询加盟店详情

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/getStoreDetailByUuid

请求参数：

参数名 描述 数据类型 必填 字节长度
param 门店Uuid String 是 100

请求示例:

{
  "param": "e295201656db4df9850f0bf7c20c6d32"
}

返回参数：

参数名 描述 数据类型 字节长度
storeUuid 门店uuid String 100
storeName 门店名称 String 100
brandUuid 品牌uuid String 100
franUuid 加盟商uuid String 100
deptUuid 关联的部门uuid String 100
statusCode 门店状态 String 100
contractStatusCode 门店合同状态 String 100
companyName 公司名称 String 100
unifiedSocialCode 统一社会信用代码 String 100
companyAddress 公司地址 String 100
corporateName 法人姓名 String 100
corporateIDNum 法人身份证号 String 100
corporatePhone 法人联系方式 String 100
cooperStartDate 合作开始时间 Date \
cooperEndDate 合作结束时间 Date \
bond 保证金 BigDecimal (18,9)
remark 备注 String 100
allianceFlag 是否是迁移过来的门店 true：迁移过来的 Boolean 100
moveAccountEmpUuidList 动账联系人的uuid List<String> \
attachments 附件列表 List<FranchiseeAttachmentDTO> \
contacts 联系人列表 List<FranchiseeContactDTO> \
附件列表List<FranchiseeAttachmentDTO>
参数名 描述 数据类型 必填 字节长度
attachUuid 附件Uuid String 否 100
attachName 附件名称 String 否 100
attachUrl 附件链接 String 否 200
attachTypeCfgUuid 附件类型 String 否 100
meta 附件meta String 否 100
联系人列表List<FranchiseeContactDTO>
参数名 描述 数据类型 必填 字节长度
franContactUuid 联系人Uuid String 否 100
userName 用户名称 String 否 100
userPhone 联系人电话 String 否 100
userIdNum 联系人证件号 String 否 100

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": {
    "storeUuid": "e295201656db4df9850f0bf7c20c6d32",
    "storeName": "万年万年1",
    "brandUuid": "b2b70c02b9b54ad0835d42306c14de7a",
    "franUuid": null,
    "deptUuid": null,
    "statusCode": "toBeOpen",
    "contractStatusCode": "signed",
    "companyName": "张三",
    "unifiedSocialCode": "10086",
    "companyAddress": null,
    "corporateName": "李四",
    "corporateIDNum": "028627197612215552",
    "corporatePhone": "13746836510",
    "cooperStartDate": null,
    "cooperEndDate": null,
    "bond": null,
    "remark": null,
    "allianceFlag": false,
    "attachments": [
      {
        "attachName": "附件",
        "attachTypeCfgUuid": "be27e7c8f4aa44368b02a1d00ab4d367",
        "attachUrl": "http://image.qfstatic.com/saas2_test2_company3_company7j8h6gh5tf/2021/07/20210722/f11d2415d5e3488da58bd309cde77f52",
        "meta": "image/png"
      }
    ],
    "contacts": [
      {
        "franContactUuid": "2b40f659b0524446b5f94d345864b7dd",
        "userName": "www",
        "userPhone": null,
        "userIdNum": null
      }
    ],
    "moveAccountEmpUuidList": []
  }
}

变更品牌加盟商

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/changeStoreType

请求参数：

参数名 描述 数据类型 必填 字节长度
storeUuid 门店uuid String 是 100
brandUuid 品牌uuid String 是 100
franUuid 加盟商uuid String 否 100

请求示例:

{
  "param": {
    "storeUuid": "b776d297e3664b4fac83d507df0dc937",
    "brandUuid": "123456",
    "franUuid": "123456"
  }
}

返回参数：无

返回示例：

{
  "responseCode": "1",
  "responseMessage": "success",
  "responseType": null,
  "data": null
}

加盟签约(虚拟签约)

请求方式：POST

请求地址：/api/jediopenplatformopenapi/organization/franchisee/addVirtualSigning

  • 虚拟签约接口(仅支持V20)

请求参数：

参数名 描述 数据类型 必填 字节长度
brandUuid 加盟品牌UUID String 是 100
signingUserUuid 签约人UUID String 是 100
cooperationStartTime 合作开始时间 Date 是 \
cooperationEndTime 合作结束时间 Date 是 \
companyName 公司名称 String 否 \
companyAddress 公司地址 String 否 \
unifiedSocialCreditCode 统一社会信用代码 String 否 \
legalRepresentativeName 法人代表姓名 String 否 \
legalRepresentativePhone 法人代表手机号 String 否 \
franchiseeName 加盟商名称 String 否 \
franchiseeUuid 加盟商UUID String 否 100

请求示例:

{
  "param": {
    "brandUuid": "2657fac4d9c142e499637f61c6fd9732",
    "companyAddress": "companyAddress",
    "companyName": "companyName",
    "cooperationEndTime": 1689405147017,
    "cooperationStartTime": 1689405080012,
    "franchiseeName": "franchiseeName",
    "franchiseeUuid": "franchiseeUuid",
    "legalRepresentativeName": "legalRepresentativeName",
    "legalRepresentativePhone": "legalRepresentativePhone",
    "signingUserUuid": "446bc5ce-d701-4d4a-bf06-4248b87fd94c",
    "unifiedSocialCreditCode": "unifiedSocialCreditCode"
  }
}

返回参数：

参数名 描述 数据类型 必填 字节长度
signingUuid 签约uuid String \ 100
signingNo 签约编号 String \ \

返回示例：

{
  "data": {
    "signingUuid": "fa87678b1665466ea84d8fcceb8036cf",
    "lifeCycleUuid": "73e86d15049c4af2a58181360dbc1f19",
    "storeUuid": null,
    "opportunityUuid": null,
    "signingStatus": "signed",
    "signingNo": "JQ1688020861284370",
    "lifeCycleType": "newSigning",
    "franchiseeName": "franchiseeName",
    "brandUuid": "2657fac4d9c142e499637f61c6fd9732",
    "signingContractType": 4,
    "opportunityNo": null,
    "certificateCfgUuid": null,
    "certificateNo": null,
    "signingUserUuid": "446bc5ce-d701-4d4a-bf06-4248b87fd94c",
    "newSignCompleteDate": "Thu Jun 29 14:41:01 CST 2023",
    "lastContractSignDate": "Thu Jun 29 14:41:01 CST 2023",
    "rescindDate": null,
    "updatedTime": null
  },
  "responseCode": "1",
  "responseMessage": "string",
  "responseType": "string"
}

results matching ""

    No results matching ""