# 连锁门店信息接口
# 新增连锁门店信息
请求方式: POST(HTTPS)
请求地址: https://openapi.qince.com/api/chainStore/v1/addChainStore/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
name | VARCHAR(100) | 是 | 连锁门店姓名,有效字符详见附录:有效字符说明 (opens new window) |
code | VARCHAR(32) | 是 | 连锁门店编码,状态为正常的客户编码唯一,有效字符详见附录:有效字符说明 (opens new window) |
type_id | VARCHAR(100) | 否 | 连锁门店类型id。 |
type_code | VARCHAR(100) | 否 | 连锁门店类型编码。type_id 存在优先取 type_id |
type_name | VARCHAR(100) | 否 | 连锁门店类型名称。type_code 存在优先取 type_code |
customer_level | VARCHAR(100) | 否 | 连锁门店级别编码 |
customer_level_name | VARCHAR(100) | 否 | 连锁门店级别名称 |
dept_waiqin365_id | VARCHAR(100) | 否 | 连锁门店所属部门ID,来源于勤策部门唯一ID |
dept_waiqin365_name | VARCHAR(100) | 否 | 连锁门店所属部门名称,来源于勤策部门名称 |
manager_id | VARCHAR(4000) | 否 | 连锁门店客户经理唯一标识,多客户经理唯一标识间以“,”分隔。来源于勤策的员工唯一标识 |
manager_name | VARCHAR(4000) | 否 | 连锁门店客户经理名称。多客户经理唯一标识间以“,”分隔。来源于勤策的员工名称 |
mss_country | VARCHAR(32) | 否 | 连锁门店所属行政区域-国家编码 |
mss_country_name | VARCHAR(32) | 否 | 连锁门店所属行政区域-国家名称。优先取 mss_country |
mss_province | VARCHAR(32) | 否 | 连锁门店所属行政区域-省编码,如是直辖市,省和市请传一样的值 |
mss_province_name | VARCHAR(32) | 否 | 连锁门店所属行政区域-省名称,如是直辖市,省和市请传一样的值。优先取 mss_province |
mss_city | VARCHAR(32) | 否 | 连锁门店所属行政区域-市编码,如是直辖市,省和市请传一样的值 |
mss_city_name | VARCHAR(32) | 否 | 连锁门店所属行政区域-市名称,如是直辖市,省和市请传一样的值。优先取 mss_city |
mss_area | VARCHAR(32) | 否 | 连锁门店所属行政区域-区县编码,如是直筒子市,市和县请传一样的值 |
mss_area_name | VARCHAR(32) | 否 | 连锁门店所属行政区域-区县名称,如是直筒子市,市和县请传一样的值。优先取 mss_area |
mss_street | VARCHAR(100) | 否 | 连锁门店所属行政区域-乡镇街道编码 |
mss_street_name | VARCHAR(100) | 否 | 连锁门店所属行政区域-乡镇街道名称。优先取 mss_street |
addr | VARCHAR(4000) | 否 | 连锁门店详细地址 |
address | VARCHAR(4000) | 否 | 连锁门店定位地址 |
longitude | VARCHAR(100) | 否 | 连锁门店定位地址,经度。如:32.055289 |
latitude | VARCHAR(100) | 否 | 连锁门店定位地址,纬度。如:118.797087 |
cooperate_status | CHAR(1) | 否 | 合作状态。0:终止合作,1:合作中,2:未合作,3:有意向 |
cooperate_status_name | VARCHAR(32) | 否 | 合作状态:终止合作/合作中/未合作/有意向/{自定义的},优先取 cooperate_status |
city_id_code | VARCHAR(32) | 否 | 所在城市编码。所在城市配置手动维护时生效,对应省市区码。 |
city_id_mame | VARCHAR(100) | 否 | 所在城市名称。所在城市配置手动维护时生效,对应省市区名称。优先取 city_id_code |
tel | VARCHAR(32) | 否 | 电话, 如:02544550010或025-44550010或15100112233 |
auth_code | VARCHAR(32) | 否 | 授权号 |
store_area | VARCHAR(32) | 否 | 店面面积 |
site_condition | VARCHAR(32) | 否 | 位置情况,单选字段入参 |
traffic_condition | VARCHAR(32) | 否 | 交通情况,单选字段入参 |
chain_expertise | VARCHAR(32) | 否 | 连锁门店经营经验,单选字段入参 |
surroundings | Map | 否 | 周边环境(左右对面),多照片字段入参 |
decoration_photos | Map | 否 | 装修照片,多照片字段入参 |
closure_mode | VARCHAR(32) | 否 | 闭店类型,单选字段入参 |
close_reason | VARCHAR(100) | 否 | 闭店原因 |
facade_sign_num | VARCHAR(32) | 否 | 店招门头数 |
liscence_name | VARCHAR(100) | 否 | 营业执照名称 |
liscence | Map | 否 | 营业执照,多照片字段入参 |
pictures | Map | 否 | 门头照,多照片字段入参 |
remarks | VARCHAR(1000) | 否 | 备注 |
field_xxx | 否 | 客户信息扩展字段。aPaaS字段类型参数样式说明 (opens new window) |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": "",
"response_data": null
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
response_data | String | 响应数据 |
# 修改连锁门店信息
请求方式: POST(HTTPS)
请求地址: https://openapi.qince.com/api/chainStore/v1/modifyChainStore/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
id | VARCHAR(100) | 是 | 连锁门店id |
name | VARCHAR(100) | 是 | 连锁门店姓名,有效字符详见附录:有效字符说明 (opens new window) |
code | VARCHAR(32) | 是 | 连锁门店编码,状态为正常的客户编码唯一,有效字符详见附录:有效字符说明 (opens new window) |
type_id | VARCHAR(100) | 否 | 连锁门店类型id。 |
type_code | VARCHAR(100) | 否 | 连锁门店类型编码。type_id 存在优先取 type_id |
type_name | VARCHAR(100) | 否 | 连锁门店类型名称。type_code 存在优先取 type_code |
customer_level | VARCHAR(100) | 否 | 连锁门店级别编码 |
customer_level_name | VARCHAR(100) | 否 | 连锁门店级别名称 |
dept_waiqin365_id | VARCHAR(100) | 否 | 连锁门店所属部门ID,来源于勤策部门唯一ID |
dept_waiqin365_name | VARCHAR(100) | 否 | 连锁门店所属部门名称,来源于勤策部门名称 |
manager_id | VARCHAR(4000) | 否 | 连锁门店客户经理唯一标识,多客户经理唯一标识间以“,”分隔。来源于勤策的员工唯一标识 |
manager_name | VARCHAR(4000) | 否 | 连锁门店客户经理名称。多客户经理唯一标识间以“,”分隔。来源于勤策的员工名称 |
mss_country | VARCHAR(32) | 否 | 连锁门店所属行政区域-国家编码 |
mss_country_name | VARCHAR(32) | 否 | 连锁门店所属行政区域-国家名称。优先取 mss_country |
mss_province | VARCHAR(32) | 否 | 连锁门店所属行政区域-省编码,如是直辖市,省和市请传一样的值 |
mss_province_name | VARCHAR(32) | 否 | 连锁门店所属行政区域-省名称,如是直辖市,省和市请传一样的值。优先取 mss_province |
mss_city | VARCHAR(32) | 否 | 连锁门店所属行政区域-市编码,如是直辖市,省和市请传一样的值 |
mss_city_name | VARCHAR(32) | 否 | 连锁门店所属行政区域-市名称,如是直辖市,省和市请传一样的值。优先取 mss_city |
mss_area | VARCHAR(32) | 否 | 连锁门店所属行政区域-区县编码,如是直筒子市,市和县请传一样的值 |
mss_area_name | VARCHAR(32) | 否 | 连锁门店所属行政区域-区县名称,如是直筒子市,市和县请传一样的值。优先取 mss_area |
mss_street | VARCHAR(100) | 否 | 连锁门店所属行政区域-乡镇街道编码 |
mss_street_name | VARCHAR(100) | 否 | 连锁门店所属行政区域-乡镇街道名称。优先取 mss_street |
addr | VARCHAR(4000) | 否 | 连锁门店详细地址 |
address | VARCHAR(4000) | 否 | 连锁门店定位地址 |
longitude | VARCHAR(100) | 否 | 连锁门店定位地址,经度。如:32.055289 |
latitude | VARCHAR(100) | 否 | 连锁门店定位地址,纬度。如:118.797087 |
cooperate_status | CHAR(1) | 否 | 合作状态。0:终止合作,1:合作中,2:未合作,3:有意向 |
cooperate_status_name | VARCHAR(32) | 否 | 合作状态:终止合作/合作中/未合作/有意向/{自定义的},优先取 cooperate_status |
city_id_code | VARCHAR(32) | 否 | 所在城市编码。所在城市配置手动维护时生效,对应省市区码。 |
city_id_mame | VARCHAR(100) | 否 | 所在城市名称。所在城市配置手动维护时生效,对应省市区名称。优先取 city_id_code |
tel | VARCHAR(32) | 否 | 电话, 如:02544550010或025-44550010或15100112233 |
auth_code | VARCHAR(32) | 否 | 授权号 |
store_area | VARCHAR(32) | 否 | 店面面积 |
site_condition | VARCHAR(32) | 否 | 位置情况,单选字段入参 |
traffic_condition | VARCHAR(32) | 否 | 交通情况,单选字段入参 |
chain_expertise | VARCHAR(32) | 否 | 连锁门店经营经验,单选字段入参 |
surroundings | Map | 否 | 周边环境(左右对面),多照片字段入参 |
decoration_photos | Map | 否 | 装修照片,多照片字段入参 |
closure_mode | VARCHAR(32) | 否 | 闭店类型,单选字段入参 |
close_reason | VARCHAR(100) | 否 | 闭店原因 |
facade_sign_num | VARCHAR(32) | 否 | 店招门头数 |
liscence_name | VARCHAR(100) | 否 | 营业执照名称 |
liscence | Map | 否 | 营业执照,多照片字段入参 |
pictures | Map | 否 | 门头照,多照片字段入参 |
remarks | VARCHAR(1000) | 否 | 备注 |
field_xxx | 否 | 客户信息扩展字段。aPaaS字段类型参数样式说明 (opens new window) |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": "",
"response_data": null
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
response_data | String | 响应数据 |
# 删除连锁门店信息
请求方式: POST(HTTPS)
请求地址: https://openapi.qince.com/api/chainStore/v1/deleteChainStore/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
ids | VARCHAR | 是 | 连锁门店 id,多值逗号分隔 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": "",
"response_data": null
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
response_data | String | 响应数据 |
# 查询连锁门店信息
请求方式: POST(HTTPS)
请求地址: https://openapi.qince.com/api/chainStore/v1/queryChainStore/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
page | INT | 是 | 页数,默认值为1。 |
rows | INT | 是 | 条数,默认值为100。 |
sorts | List | 是 | 排序,默认按创建时间倒序排序。 |
sorts.field_key | VARCHAR(30) | 是 | 排序字段。 |
sorts.type | VARCHAR(4) | 是 | 排序类型:asc 正序,desc 倒序。 |
query_group | List | 是 | 查询条件列表 |
query_group.connector | List | 是 | 组内查询条件,条件AND或OR |
query_group.filters | VARCHAR(4) | 是 | 组内查询条件 |
query_group.filters.field_key | VARCHAR(32) | 是 | 字段key |
query_group.filters.operator | VARCHAR(10) | 是 | 操作符,详见附录操作符说明 (opens new window) |
query_group.filters.field_values | List | 是 | 字段值集合 |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"id": "8232593632613849441",
"name": "测试门店001",
"code": "ZMD2025042300000009",
"area": {
"mss_province": {
"code": "320000",
"name": "江苏省"
},
"mss_country": {
"code": "86",
"name": "中国"
},
"mss_street": {
"code": "320102003",
"name": "新街口街道"
},
"addr": "江苏省南京市玄武区珠江路205号",
"mss_area": {
"code": "320102",
"name": "玄武区"
},
"mss_city": {
"code": "320100",
"name": "南京市"
}
},
"type_id": {
"name": "类型001",
"id": "6768752509128034765",
"status": "1"
},
"customer_level": {
"code": "9059239336101111053",
"label": "级别1"
},
"cooperate_status": {
"code": "1",
"label": "合作中"
},
"department": {
"name": "运维测试部",
"id": "5740556610527350237",
"status": "1"
},
"manager_id": [
{
"id": "8250035712611830714",
"name": "许周",
"status": "1"
},
{
"id": "7396228732961698215",
"name": "0220",
"status": "1"
}
],
"city_id": {
"name": "南京市",
"id": "4649070459465534932",
"status": "1"
},
"city_level_id": {
"code": "8901879972064436026",
"label": "E"
},
"tel": "18999887722",
"auth_code": "2131231231",
"store_area": "66.55",
"traffic_condition": {
"code": "T3Je033m",
"label": "十字街"
},
"chain_expertise": [
{
"code": "xAJgpdpF",
"content": "",
"label": "有渠道,有品牌运作经验",
"status": "1"
},
{
"code": "Mu3JByUM",
"content": "",
"label": "有施工队",
"status": "1"
},
{
"code": "MZCPSCJ5",
"content": "",
"label": "有师傅联系渠道",
"status": "1"
}
],
"liscence_name": "测试门店001测试门店001",
"surroundings": [
{
"path": "chainStore/202504/202504231715342_2d9122f4b2d34dccbca63ef2c7ccf522.jpg",
"name": "9fcd4fbd-5ac9-4a8d-bf94-b717262c66f6.jpg",
"url": "https://image-test.waiqin365.com/6928113655533238145/chainStore/202504/202504231715342_2d9122f4b2d34dccbca63ef2c7ccf522.jpg"
},
{
"path": "chainStore/202504/202504231715615_96c8911f51444925834caa78b526b46c.jpg",
"name": "540bb456-5c1e-4c03-9a60-e7238ebff224.jpg",
"url": "https://image-test.waiqin365.com/6928113655533238145/chainStore/202504/202504231715615_96c8911f51444925834caa78b526b46c.jpg"
}
],
"pictures": {
"all_path": [
{
"path": "chainStore/202504/20250423171534_bf4e0eedebe44e7797ef96c7d72c65d0.jpg",
"name": "chainStore/202504/20250423171534_bf4e0eedebe44e7797ef96c7d72c65d0.jpg",
"url": "https://image-test.waiqin365.com/6928113655533238145/chainStore/202504/20250423171534_bf4e0eedebe44e7797ef96c7d72c65d0.jpg"
},
{
"path": "chainStore/202504/202504231715484_88c193d670ae406e94e72f0abd4a5ceb.jpg",
"name": "chainStore/202504/202504231715484_88c193d670ae406e94e72f0abd4a5ceb.jpg",
"url": "https://image-test.waiqin365.com/6928113655533238145/chainStore/202504/202504231715484_88c193d670ae406e94e72f0abd4a5ceb.jpg"
}
]
},
"decoration_photos": [
{
"path": "chainStore/202504/202504231715297_3bb509a407914a68a5b90c405170e78b.jpg",
"name": "01a1779b-e965-4e89-a5b7-8b3edf17074f.jpg",
"url": "https://image-test.waiqin365.com/6928113655533238145/chainStore/202504/202504231715297_3bb509a407914a68a5b90c405170e78b.jpg"
},
{
"path": "chainStore/202504/202504231715576_beef172d76284cd8ac4a58b952fe57ab.jpg",
"name": "2a3bead8-0eac-4e5b-a978-2dcad40b1cb7.jpg",
"url": "https://image-test.waiqin365.com/6928113655533238145/chainStore/202504/202504231715576_beef172d76284cd8ac4a58b952fe57ab.jpg"
}
],
"liscence": [
{
"path": "chainStore/202504/202504231715140_9d468e065e9840bdad5af7720b082c93.jpg",
"name": "540bb456-5c1e-4c03-9a60-e7238ebff224.jpg",
"url": "https://image-test.waiqin365.com/6928113655533238145/chainStore/202504/202504231715140_9d468e065e9840bdad5af7720b082c93.jpg"
}
],
"closure_mode": {
"code": "CqZthTUu",
"label": "无店招无陈列无销售(三无)"
},
"site_condition": {
"code": "6oq7DxmZ",
"label": "街边店门口"
},
"facade_sign_num": "3.00",
"close_reason": "测试门店001测试门店001测试门店001",
"remarks": "测试门店001测试门店001测试门店001",
"field_tbuxj__c": "这个是自定义文本字段",
"field_nLNco__c": "这个是自定义多行文本字段",
"source_type": {
"code": "LROPFXCJ",
"label": "自建"
},
"status": {
"code": "NORMAL",
"label": "正常"
},
"creator_id": {
"name": "开发001",
"id": "8250035712611830714",
"status": "1"
},
"create_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-04-23 17:16:38"
},
"modify_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-04-23 17:17:41"
},
"modifyier_id": {
"name": "许周",
"id": "8250035712611830714",
"status": "1"
},
"lock_status": {
"code": "UNLOCK",
"label": "未锁定"
},
"approval_status": {
"code": "APPROVED",
"label": "已审批"
}
}
]
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
id | VARCHAR(32) | 否 | 勤策的客户唯一ID。其他字段格式详见:aPaaS字段类型样式说明 (opens new window) |
name | VARCHAR(100) | 是 | 连锁门店姓名 |
code | VARCHAR(32) | 是 | 连锁门店编码 |
area | Map | 否 | 连锁门店所在地 |
area.mss_country | Map | 否 | 区域-国家。 |
area.mss_province | Map | 否 | 区域-省 |
area.mss_city | Map | 否 | 区域-市 |
area.mss_area | Map | 否 | 区域-县 |
area.mss_street | Map | 否 | 区域-乡镇/街道 |
area.addr | VARCHAR(4000) | 否 | 连锁门店详细地址 |
type_id | Map | 否 | 连锁门店类型 |
customer_level | Map | 否 | 连锁门店级别 |
cooperate_status | Map | 否 | 合作状态 |
department | Map | 否 | 连锁门店部门 |
manager_id | Map | 否 | 连锁门店客户经理 |
city_id | Map | 否 | 所在城市 |
city_level_id | Map | 否 | 城市等级 |
tel | VARCHAR(32) | 否 | 电话, 如:02544550010或025-44550010或15100112233 |
auth_code | VARCHAR(32) | 否 | 授权号 |
store_area | VARCHAR(32) | 否 | 店面面积 |
traffic_condition | Map | 否 | 交通情况 |
chain_expertise | Map | 否 | 连锁门店经营经验 |
liscence_name | VARCHAR(32) | 否 | 营业执照名称 |
surroundings | Map | 否 | 周边环境(左右对面) |
pictures | Map | 否 | 门头照 |
decoration_photos | Map | 否 | 装修照片 |
liscence | Map | 否 | 营业执照 |
closure_mode | Map | 否 | 闭店类型 |
site_condition | Map | 否 | 位置情况 |
facade_sign_num | VARCHAR(32) | 否 | 店招门头数 |
close_reason | VARCHAR(32) | 否 | 闭店原因 |
remarks | VARCHAR(32) | 否 | 备注 |
source_type | Map | 否 | 数据来源 |
status | Map | 否 | 删除标识 |
creator_id | Map | 否 | 创建人 |
create_time | Map | 是 | 创建时间 |
modifyier_id | Map | 否 | 修改人 |
modify_time | Map | 否 | 修改时间 |
lock_status | Map | 否 | 修改时间 |
approval_status | Map | 否 | 修改时间 |
field_xxx | 否 | 客户信息扩展字段。aPaaS字段类型样式说明 (opens new window) |