API开放平台

TIP

# 销售区域接口

# 新增销售区域信息

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/district/v1/addDistrict/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
	"dis_id": "15062255555",
	"dis_code": "zscsnw2",
	"dis_name": "周三测试nw2",
	"dis_parent_id": "emp001",
	"parent_id": "2",
	"dis_sequence": "1",
	"dis_status": "1",
	"dis_remarks": "测试",
	"dis_level_name": "商圈A",
	"dis_waiqin365_dept_id": "9063838294391319969",
	"dis_dept_id": "DEPT001",
	"dis_dept_name": "江苏事业部"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
dis_id VARCHAR(100) 是 销售区域唯一标识，来源于第三方系统的唯一销售区域标识
dis_code VARCHAR(100) 是 销售区域编码，同一销售区域节点下唯一，有效字符详见附录：有效字符说明 (opens new window)
dis_name VARCHAR(32) 是 销售区域名称，同一销售区域节点下唯一，有效字符详见附录：有效字符说明 (opens new window)
dis_parent_id VARCHAR(32) 否 父节点销售区域唯一标识，来源于第三方系统的销售区域
parent_id int 否 父节点销售区域唯一标识，本系统的销售区域父节点唯一标识。parent_id、dis_parent_id如果同时存在优先取parent_id
dis_sequence int 否 排序号，数值越小，排名越靠前
dis_status CHAR(1) 否 状态标识。0：删除 1：正常
dis_level_name VARCHAR(100) 否 区域类型名称
dis_remarks VARCHAR(200) 否 备注信息
dis_waiqin365_dept_id int 否 销售区域所属部门ID,来源于勤策部门唯一ID
dis_dept_id VARCHAR(32) 否 销售区域所属部门唯一标识，来源于第三方系统的部门唯一标识和部门信息中org_id对应，dis_dept_id、dis_dept_waiqin365_id如果同时存在优先取dis_dept_waiqin365_id
dis_dept_name VARCHAR(32) 否 销售区域所属部门名称

响应示例：

{
    "return_code": 0,
    "msg_id": "{ msg_id }"
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 修改销售区域信息

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/district/v1/modifyDistrict/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
	"id": "5657701858264035735",
	"dis_id": "15062255555",
	"dis_status": "1",
	"dis_parent_id": "王伟,张强,吴为",
	"parent_id": "2",
	"dis_name": "周三测试nw2",
	"dis_code": "zscsnw2",
	"dis_level_name": "商圈B",
	"dis_sequence": "1",
	"dis_waiqin365_dept_id": "9063838294391319969",
	"dis_dept_id": "DEPT002",
	"dis_dept_name": "南京事业部",
	"dis_remarks": "测试"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
id Long 是 勤策的销售区域唯一ID，和来源于第三方系统销售区域唯一ID(dis_id)作为更新数据的唯一标识，所以不能同时为空
dis_id VARCHAR(200) 是 来源于第三方系统的销售区域唯一ID，对应新增销售区域 (dis_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空。 后续可调用此接口更新该字段值。调用此接口时该字段值(dist_id)和勤策的销售区域ID(id)作为更新数据的唯一标识，所以不能同时为空， 如果两个值同时存在则优先顺序为id、dis_id
dis_status CHAR(1) 否 状态标识。0：注销，1：正常。默认值为1
dis_parent_id VARCHAR(32) 否 第三方系统上级销售区域唯一ID
parent_id int 否 勤策上级销售区域唯一ID。parent_id、dis_parent_id如果同时存在优先取parent_id
dis_name VARCHAR(32) 否 销售区域名称
dis_code VARCHAR(100) 否 销售区域编码
dis_level_name VARCHAR(100) 否 销售区域类型名称
dis_sequence int 否 排序号，数值越小，排名越靠前
dis_waiqin365_dept_id VARCHAR(32) 否 勤策的销售区域所属部门唯一ID
dis_dept_id VARCHAR(32) 否 第三方系统销售区域所属部门唯一ID，dis_dept_id、dept_waiqin365_id如果同时存在优先取dept_waiqin365_id
dis_dept_name VARCHAR(100) 否 销售区域所属部门名称
dis_remarks VARCHAR(200) 否 备注信息

响应示例：

{
    "return_code": 0,
    "msg_id": "{ msg_id }"
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 删除销售区域信息

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/district/v1/removeDistrict/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "id": "9016037564062509941,5657701858264035735",
    "dis_id": "15051846677,15051855555"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
id VARCHAR(32) 是 销售区域唯一标识，多个值以","隔开
dis_id VARCHAR(32) 是 销售区域唯一标识，来源于第三方系统销售区域唯一标识，多个值以","隔开

响应示例：

{
    "return_code": 0,
    "msg_id": "{ msg_id }"
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 查询销售区域

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/district/v1/queryDistrict/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "dis_id": "type00001"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
id LONG 否 勤策的销售区域唯一ID，id和dis_id如果同时存在优先取id
dis_id VARCHAR(32) 否 销售区域唯一标识(source_code)
dis_parent_code VARCHAR(100) 否 上级销售区域编码
dis_code VARCHAR(100) 否 销售区域代码
dis_name VARCHAR(100) 否 销售区域名称,模糊查询
dis_status CHAR(1) 否 销售区域状态。0：注销，1：正常。默认值为1
create_date CHAR(10) 否 创建日期。格式：yyyy-MM-dd
modify_date CHAR(10) 否 修改日期。格式：yyyy-MM-dd

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
        {
            "dis_id": "dis00001",
            "dis_name": "类型1",
            "dis_parent_id": "",
            "dis_status": 1,
            "dis_sequence": 20,
            "create_date ": "2016-01-01",
            "modify_date ": "2016-01-01",
            "id": "5303911770644379662",
            "parent_id": "",
            "name_full_path": "中国/江苏省/南京市",
            "code_full_path": "A/B/C",
            "waiqin365_dis_level_id": "1",
            "dis_level_code": "1",
            "dis_level_name": "A",
            "dis_waiqin365_dept_id": "9063838294391319969",
           	"dis_dept_id": "DEPT002",
           	"dis_dept_name": "南京事业部",
           	"dis_remarks": "测试"
        }
    ]

参数说明：

参数 类型 必填 说明
dis_id VARCHAR(32) 是 销售区域唯一标识(source_code)
dis_name VARCHAR(100) 是 销售区域名称
dis_parent_id VARCHAR(32) 否 上级销售区域唯一标识
dis_sequence VARCHAR(32) 否 排序号，顺序排列
dis_status VARCHAR(32) 是 销售区域状态。0：注销，1：正常。默认值为1
create_date VARCHAR(10) 否 创建日期。格式：yyyy-MM-dd
modify_date VARCHAR(10) 否 修改日期。格式：yyyy-MM-dd
id VARCHAR(32) 是 勤策销售区域ID
parent_id VARCHAR(32) 是 勤策销售区域上级ID
name_full_path VARCHAR(256) 否 名称的全路径，以/分隔
code_full_path VARCHAR(256) 否 编码的全路径，以/分隔
waiqin365_dis_level_id VARCHAR(256) 否 销售区域类型id
dis_level_code VARCHAR(256) 否 销售区域类型编码
dis_level_name VARCHAR(256) 否 销售区域类型名称
dis_waiqin365_dept_id VARCHAR(32) 否 勤策的销售区域所属部门唯一ID
dis_dept_id VARCHAR(32) 否 第三方系统销售区域所属部门唯一ID，dis_dept_id、dept_waiqin365_id如果同时存在优先取dept_waiqin365_id
dis_dept_name VARCHAR(100) 否 销售区域所属部门名称
dis_remarks VARCHAR(200) 否 备注信息

# 查询销售区域2.0

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/v2/district/query/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "page_number": 1,
    "id": 123456789,
    "dis_parent_code": "PARENT001",
    "dis_code": "DIS001",
    "dis_name": "销售区域名称",
    "dis_status": "1",
    "create_date_start": "2024-01-01",
    "create_date_end": "2024-12-31",
    "modify_date_start": "2024-01-01",
    "modify_date_end": "2024-12-31",
    "sorts": [
        {
            "field_key": "create_date",
            "type": "desc"
        }
    ],
    "query_group": [
        {
            "connector": "OR",
            "filters": [
                {
                    "field_key": "dis_name",
                    "operator": "NQ",
                    "field_values": ["测试"]
                }
            ]
        }
    ]
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
page_number INT 否 分页页码，默认值为1
id LONG 否 勤策的销售区域唯一ID，id和dis_id如果同时存在优先取id
dis_parent_code VARCHAR(100) 否 上级销售区域编码
dis_code VARCHAR(100) 否 销售区域代码
dis_name VARCHAR(100) 否 销售区域名称，模糊查询
dis_status CHAR(1) 否 销售区域状态。0：注销，1：正常。默认值为1
create_date_start CHAR(10) 否 创建日期起。格式：yyyy-MM-dd
create_date_end CHAR(10) 否 创建日期止。格式：yyyy-MM-dd
modify_date_start CHAR(10) 否 修改日期起。格式：yyyy-MM-dd
modify_date_end CHAR(10) 否 修改日期止。格式：yyyy-MM-dd
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) 是 操作符，详见附录操作符说明
query_group.filters.field_values List 是 字段值集合

响应示例：

{
    "return_code": "0",
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "dis_id": "dis00001",
        "dis_name": "销售区域名称",
        "dis_parent_id": "parent_dis_001",
        "dis_sequence": "1",
        "dis_status": "1",
        "create_date": "2024-01-01",
        "modify_date": "2024-01-15",
        "id": "9063838294391319969",
        "parent_id": "9063838294391319968",
        "name_full_path": "中国/江苏省/南京市",
        "code_full_path": "CN/JS/NJ",
        "waiqin365_dis_level_id": "100001",
        "dis_level_code": "LEVEL01",
        "dis_level_name": "一级区域",
        "dis_waiqin365_dept_id": "9063838294391319969",
        "dis_dept_id": "DEPT001",
        "dis_dept_name": "华东事业部",
        "dis_remarks": "备注信息",
        "department_code": "",
        "father_node_code": "QINCE000011",
        "code": "xxxxx",
        "boundary_type": "{\"code\" : \"110000,120000,130000\",\"geographicBoundaries\" : \"北京市,天津市,河北省\"}",
        "exts": [{
          "key": "key_1",
          "value": "value_1"
        }]
    }
]

参数说明：

参数 类型 必填 说明
dis_id VARCHAR(32) 是 销售区域唯一标识(source_code)，按照apaas的格式让企业出参
dis_name VARCHAR(100) 是 销售区域名称，按照apaas的格式让企业出参
dis_parent_id VARCHAR(32) 否 上级销售区域唯一标识，按照apaas的格式让企业出参
dis_sequence VARCHAR(32) 否 排序号，顺序排列，按照apaas的格式让企业出参
dis_status VARCHAR(32) 是 销售区域状态。0：注销，1：正常。默认值为1，按照apaas的格式让企业出参
create_date VARCHAR(10) 否 创建日期。格式：yyyy-MM-dd，按照apaas的格式让企业出参
modify_date VARCHAR(10) 否 修改日期。格式：yyyy-MM-dd，按照apaas的格式让企业出参
id VARCHAR(32) 是 勤策销售区域ID，按照apaas的格式让企业出参
parent_id VARCHAR(32) 是 勤策销售区域上级ID，按照apaas的格式让企业出参
name_full_path VARCHAR(256) 否 名称的全路径，以/分隔，按照apaas的格式让企业出参
code_full_path VARCHAR(256) 否 编码的全路径，以/分隔，按照apaas的格式让企业出参
waiqin365_dis_level_id VARCHAR(256) 否 销售区域类型id，按照apaas的格式让企业出参
dis_level_code VARCHAR(256) 否 销售区域类型编码，按照apaas的格式让企业出参
dis_level_name VARCHAR(256) 否 销售区域类型名称，按照apaas的格式让企业出参
dis_waiqin365_dept_id VARCHAR(32) 否 勤策的销售区域所属部门唯一ID，按照apaas的格式让企业出参
dis_dept_id VARCHAR(32) 否 第三方系统销售区域所属部门唯一ID，dis_dept_id、dept_waiqin365_id如果同时存在优先取dept_waiqin365_id，按照apaas的格式让企业出参
dis_dept_name VARCHAR(100) 否 销售区域所属部门名称，按照apaas的格式让企业出参
dis_remarks VARCHAR(200) 否 备注信息，按照apaas的格式让企业出参
department_code VARCHAR(100) 否 部门编码
father_node_code VARCHAR(100) 否 上级销售区域编码，按照apaas的格式让企业出参
code VARCHAR(100) 否 销售区域编码，按照apaas的格式让企业出参
boundary_type VARCHAR(200) 否 区域地理边界
exts array 否 自定义字段列表
exts.key VARCHAR(100) 否 自定义字段field code
exts.value object 否 自定义字段值, apaas格式

# 查询销售区域分配到人员的关系

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/district/v1/queryDistrictByEmp/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "dis_waiqin365_id": "6222371498170461968", 
    "dis_id": "dis00001",
    "dis_code": "DIS001"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
dis_id VARCHAR(32) 否 销售区域第三方唯一标识(source_code)，和销售区域编码、销售区域勤策的id不能同时为空
dis_code VARCHAR(100) 否 销售区域编码，和销售区域第三方唯一标识、销售区域勤策的id不能同时为空
dis_waiqin365_id VARCHAR(32) 否 销售区域勤策的id，和销售区域第三方唯一标识、销售区域编码不能同时为空

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
        {
            "dis_id": "dis00001",
            "dis_waiqin365_id": "6222371498170461968",
            "dis_code": "DIS001",
            "dis_name": "区域1",
            "dis_status": "1",
            "dis_emp_names": "张三,李四",
            "dis_emp_codes ": "zhangsan,lisi",
            "dis_strategy ": "1",
            "dis_modify_time": "2020-12-10"
        }
    ]

参数说明：

参数 类型 必填 说明
dis_waiqin365_id VARCHAR(32) 是 销售区域勤策id
dis_id VARCHAR(100) 是 销售区域唯一标识(source_code),来源于第三代系统id
dis_status VARCHAR(32) 是 销售区域状态。0：注销，1：正常。默认值为1
dis_code VARCHAR(32) 是 销售区域编码
dis_name VARCHAR(32) 是 销售区域名称
dis_emp_names VARCHAR(100) 否 分配到的人员姓名，多个人用“，”分隔
dis_emp_codes VARCHAR(100) 否 分配到的人员账号，多个人用“，”分隔
dis_strategy VARCHAR(32) 否 客户权限处理策略。0：作为客户经理，1：仅可查看客户但不是客户经理
dis_modify_time VARCHAR(32) 否 最近一次销售区域分配到人的时间。格式：yyyy-MM-dd

← 收货地址接口 →