开放接口API说明-销售区域接口

参数名称 参数值
应用编码 district
应用版本 v1
接口名称 新增销售区域
接口编码 addDistrict
接口URL https://openapi.waiqin365.com/api/district/v1/addDistrict/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
dis_id VARCHAR(100) 销售区域唯一标识,来源于第三方系统的唯一销售区域标识,有效字符详见附录:编码类型参照表
dis_code VARCHAR(100) 销售区域编码,同一销售区域节点下唯一,有效字符详见附录:编码类型参照表
dis_name VARCHAR(32) 销售区域名称,同一销售区域节点下唯一,有效字符详见附录:编码类型参照表
dis_parent_id VARCHAR(32) 父节点销售区域唯一标识,来源于第三方系统的销售区域。
parent_id int 父节点销售区域唯一标识,本系统的销售区域父节点唯一标识。如果和dis_parent_id同时传入时,以parent_id数据为准。
dis_sequence int 排序号,数值越小,排名越靠前
dis_status CHAR(1) 状态标识。0:删除 1:正常
dis_level_name VARCHAR(1) 区域级别名称。
dis_remarks VARCHAR(200) 备注信息
dis_waiqin365_dept_id int 销售区域所属部门ID,来源于外勤365部门唯一ID
dis_dept_id VARCHAR(32) 销售区域所属部门唯一标识,来源于第三方系统的部门唯一标识和部门信息中org_id对应,如果和外勤365部门IDdis_dept_waiqin365_id同时传入时,以dis_dept_waiqin365_id数据为准
dis_dept_name VARCHAR(32) 销售区域所属部门名称
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
	"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": "江苏事业部"
}

// 响应信息示例:
{
	"msg_id": "X000001",
	"return_code": 0,
	"return_msg": ""
}
                  
参数名称 参数值
应用编码 district
应用版本 v1
接口名称 修改销售区域信息
接口编码 modifyDistrict
接口URL https://openapi.waiqin365.com/api/district/v1/modifyDistrict/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
id Long 销售区域唯一标识
dis_id VARCHAR(200) id、dis_id 至少提供一个
dis_status CHAR(1) 状态标识,默认1,0注销 1正常
dis_parent_id VARCHAR(32) 上级销售区域唯一标识,来源于第三方系统
parent_id int 上级销售区域唯一标识。如果和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) 销售区域所属部门唯一标识,来源于外勤365的销售区域所属部门唯一ID。
dis_dept_id VARCHAR(32) 销售区域所属部门唯一标识,来源于第三方系统的销售区域所属部门唯一ID,如果和外勤365部门IDdept_waiqin365_id同时传入时,以dept_waiqin365_id数据为准
dis_dept_name VARCHAR(100) 销售区域所属部门名称
dis_remarks VARCHAR(200) 备注信息
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
	"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": "测试"
}

// 响应信息示例:
{
	"msg_id": "X000001",
	"return_code": 0,
	"return_msg": ""
}
                  
参数名称 参数值
应用编码 district
应用版本 v1
接口名称 删除销售区域
接口编码 removeDistrict
接口URL https://openapi.waiqin365.com/api/district/v1/removeDistrict/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
id VARCHAR(32) 销售区域唯一标识,多个值以","隔开
dis_id VARCHAR(32) 销售区域唯一标识,来源于第三方系统销售区域唯一标识,多个值以","隔开
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "id": "9016037564062509941,5657701858264035735",
    "dis_id": "15051846677,15051855555"
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 district
应用版本 v1
接口名称 查询销售区域
接口编码 queryDistrict
接口URL https://openapi.waiqin365.com/api/district/v1/queryDistrict/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
dis_id VARCHAR(32) 销售区域唯一标识(source_code)
dis_parent_code VARCHAR(100) 上级销售区域编码
dis_code VARCHAR(100) 销售区域代码
dis_name VARCHAR(100) 销售区域名称,模糊查询
dis_status CHAR(1) 销售区域状态,默认1,0注销 1正常
create_date CHAR(10) 创建日期,格式:“yyyy-MM-dd”
modify_date CHAR(10) 修改日期,格式:“yyyy-MM-dd”
响应信息 参照表响应信息格式
dis_id VARCHAR(32) 销售区域唯一标识(source_code)
dis_name VARCHAR(100) 销售区域名称
dis_parent_id VARCHAR(32) 上级销售区域唯一标识
dis_sequence VARCHAR(32) 排序号,顺序排列
dis_status VARCHAR(32) 销售区域状态,默认1,0注销 1正常
create_date VARCHAR(10) 创建日期,格式:“yyyy-MM-dd”
modify_date VARCHAR(10) 修改日期,格式:“yyyy-MM-dd”
id VARCHAR(32) 外勤365销售区域ID
parent_id VARCHAR(32) 外勤365销售区域上级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_id": "type00001"
}

// 响应信息示例:
{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X000001",
    "response_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"
        }
    ]
}