开放接口API说明-客户层级关系信息接口

参数名称 参数值
应用编码 basCmCustomerRel
应用版本 v1
接口名称 新增客户层级关系
接口编码 addCustomerRel
接口URL https://openapi.waiqin365.com/api/basCmCustomerRel/v1/addCustomerRel/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
store_code VARCHAR(32) 子节点客户编码,唯一,有效字符详见附录:编码类型参照表
parent_code VARCHAR(32) 父节点客户编码,根节点传“-1”
store_id VARCHAR(32) 子节点客户唯一标识,来源于第三方系统的唯一客户标识,有效字符详见附录:编码类型参照表
parent_id VARCHAR(32) 父节点客户唯一标识,根节点传“-1”,来源于第三方系统的唯一客户标识,有效字符详见附录:编码类型参照表
waiqin365_store_id VARCHAR(32) 子节点客户唯一标识。store_idwaiqin365_store_id必传其一,
如果同时传入,
则以waiqin365_store_id为准
waiqin365_parent_id VARCHAR(32) 父节点客户唯一标识,根节点传“-1”。parent_idwaiqin365_parent_id必传其一,
如果同时传入,
则以waiqin365_parent_id为准
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "store_code":"",
    "parent_code":"",
    "store_id": "TEST002",
    "parent_id": "TEST001",
    "waiqin365_store_id": "8490176521611231861",
    "waiqin365_parent_id": "5742455073132501980"
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 basCmCustomerRel
应用版本 v1
接口名称 修改客户层级关系信息
接口编码 modifyCustomerRel
接口URL https://openapi.waiqin365.com/api/basCmCustomerRel/v1/modifyCustomerRel/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
store_code VARCHAR(32) 客户编码,唯一,有效字符详见附录:编码类型参照表
store_new_code VARCHAR(32) 修改后客户编码,唯一,有效字符详见附录:编码类型参照表
store_id VARCHAR(32) 客户唯一标识,来源于第三方系统的唯一客户标识,有效字符详见附录:编码类型参照表
store_new_id VARCHAR(32) 修改后客户唯一标识,来源于第三方系统的唯一客户标识,有效字符详见附录:编码类型参照表
waiqin365_store_id VARCHAR(100) 客户唯一标识。store_idwaiqin365_store_id必传其一,
如果同时传入,
则以waiqin365_store_id为准
waiqin365_new_store_id VARCHAR(32) 修改后客户唯一标识。store_new_idwaiqin365_new_store_id必传其一,
如果同时传入,
则以waiqin365_new_store_id为准
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "store_code": "CUS002",
    "store_new_code": "CUS001",
    "store_id": "TEST002",
    "store_new_id": "TEST001",
    "waiqin365_store_id": "8490176521611231861",
	"waiqin365_new_store_id": "5742455073132501980"
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 basCmCustomerRel
应用版本 v1
接口名称 删除客户层级关系信息
接口编码 removeCustomerRel
接口URL https://openapi.waiqin365.com/api/basCmCustomerRel/v1/removeCustomerRel/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
store_code VARCHAR(32) 客户编码,唯一,有效字符详见附录:编码类型参照表
store_id VARCHAR(32) 客户唯一标识,来源于第三方系统的唯一客户标识,有效字符详见附录:编码类型参照表
waiqin365_store_id VARCHAR(32) 客户唯一标识,store_idwaiqin365_store_id必传其一,
如果同时传入,
则以waiqin365_store_id为准
remove_flag CHAR(1) 删除标识,不传值默认包含子节点的节点是不能直接删除,传值“1”表示可以直接删除,删除时,该节点下所有节点都会被删除
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "store_code": "CUS001",
    "store_id": "TEST002",
	"waiqin365_store_id": "8490176521611231861",
    "remove_flag":"1"
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 basCmCustomerRel
应用版本 v1
接口名称 查询客户层级关系
接口编码 queryCustomerRel
接口URL https://openapi.waiqin365.com/api/basCmCustomerRel/v1/queryCustomerRel/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
page_number INT 页码默认1,每页最大1000条
store_code VARCHAR(32) 子节点客户编码,唯一,有效字符详见附录:编码类型参照表
parent_code VARCHAR(32) 父节点客户编码,唯一,有效字符详见附录:编码类型参照表
store_name VARCHAR(1) 子节点客户名称
parent_name VARCHAR(1) 父节点客户名称
store_id VARCHAR(32) 子节点客户唯一标识,来源于第三方系统的唯一客户标识,有效字符详见附录:编码类型参照表
parent_id VARCHAR(32) 父节点客户唯一标识,来源于第三方系统的唯一客户标识,有效字符详见附录:编码类型参照表
waiqin365_store_id VARCHAR(32) 子节点客户唯一标识。store_idwaiqin365_store_id必传其一,
如果同时传入,
则以waiqin365_store_id为准
waiqin365_parent_id VARCHAR(32) 父节点客户唯一标识。parent_idwaiqin365_parent_id必传其一,
如果同时传入,
则以waiqin365_parent_id为准
响应信息 参照表响应信息格式
waiqin365_store_id VARCHAR(32) 子节点客户唯一标识
waiqin365_parent_id VARCHAR(32) 父节点客户唯一标识
store_code VARCHAR(32) 子节点客户唯一标识,唯一,有效字符详见附录:编码类型参照表
parent_code VARCHAR(1) 父节点客户唯一标识,唯一,有效字符详见附录:编码类型参照表
store_id VARCHAR(1) 父节点客户唯一标识,来源于第三方系统的唯一客户标识,有效字符详见附录:编码类型参照表
parent_id VARCHAR(1) 父节点客户唯一标识,来源于第三方系统的唯一客户标识,有效字符详见附录:编码类型参照表
store_name VARCHAR(1) 子节点客户名称
parent_name VARCHAR(1) 父节点客户名称

// 请求消息体示例:
{
    "store_name": "苏果夫子庙分店",
    "parent_name": "苏果夫子庙总店",
    "store_code": "CM008",
    "parent_code": "CM001",
    "store_id": "DD000201710091",
    "parent_id": "DD000201709949",
    "waiqin365_store_id": "5742455073132501980",
    "waiqin365_parent_id": "6240516572552388530",
    "page_number": "1000"
}

// 响应信息示例:
{
    "return_code": "0",
    "return_msg": "",
    "msg_id": "X000001",
    "response_data": "[
        {
            "store_name": "苏果夫子庙分店",
			"parent_name": "苏果夫子庙总店",
			"store_code": "CM008",
			"parent_code": "CM001",
			"store_id": "DD000201710091",
			"parent_id": "DD000201709949",
			"waiqin365_store_id": "5742455073132501980",
			"waiqin365_parent_id": "6240516572552388530"
        }
    ]"
}