API开放平台

TIP

# 客户层级关系信息接口

# 新增客户层级关系信息

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

{
    "store_code":"",
    "parent_code":"",
    "store_id": "TEST002",
    "parent_id": "TEST001",
    "waiqin365_store_id": "8490176521611231861",
    "waiqin365_parent_id": "5742455073132501980"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
store_code VARCHAR(32) 否 子节点客户编码,唯一,有效字符详见附录：有效字符说明 (opens new window)
parent_code VARCHAR(32) 否 父节点客户编码,根节点传“-1”
store_id VARCHAR(32) 否 来源于第三方系统的子节点客户唯一标识，和勤策的子节点客户唯一标识不能同时为空。有效字符详见附录：有效字符说明 (opens new window)
parent_id VARCHAR(32) 否 来源于第三方系统的父节点客户唯一标识，根节点传“-1”，和勤策的父节点客户唯一标识不能同时为空。有效字符详见附录：有效字符说明 (opens new window)
waiqin365_store_id VARCHAR(32) 否 勤策的子节点客户唯一标识，和来源于第三方系统的子节点客户唯一标识不能同时为空。store_id、waiqin365_store_id如果同时存在优先取waiqin365_store_id
waiqin365_parent_id VARCHAR(32) 否 勤策的父节点客户唯一标识，根节点传“-1”。和来源于第三方系统的父节点客户唯一标识不能同时为空。parent_id、waiqin365_parent_id如果同时存在优先取waiqin365_parent_id

响应示例：

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

参数说明：

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

# 修改客户层级关系信息接口

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

{
    "store_code": "CUS002",
    "store_new_code": "CUS001",
    "store_id": "TEST002",
    "store_new_id": "TEST001",
    "waiqin365_store_id": "8490176521611231861",
	"waiqin365_new_store_id": "5742455073132501980"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
store_code VARCHAR(32) 否 客户编码,唯一,有效字符详见附录：有效字符说明 (opens new window)
store_new_code VARCHAR(32) 否 修改后客户编码,唯一,有效字符详见附录：有效字符说明 (opens new window)
store_id VARCHAR(32) 否 来源于第三方系统的唯一客户标识，和勤策的客户唯一标识不能同时为空。有效字符详见附录：有效字符说明 (opens new window)
store_new_id VARCHAR(32) 否 来源于第三方系统的修改后客户唯一标识，和勤策的修改后客户唯一标识不能同时为空。有效字符详见附录：有效字符说明 (opens new window)
waiqin365_store_id VARCHAR(100) 否 勤策的客户唯一标识，和来源于第三方系统的唯一客户标识不能同时为空。store_id、waiqin365_store_id如果同时存在优先取waiqin365_store_id
waiqin365_new_store_id VARCHAR(32) 否 勤策的修改后客户唯一标识，和来源于第三方系统的修改后客户唯一标识不能同时为空。store_new_id、waiqin365_new_store_id如果同时存在优先取waiqin365_new_store_id

响应示例：

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

参数说明：

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

​

# 删除客户层级关系信息

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

{
    "store_code": "CUS001",
    "store_id": "TEST002",
	"waiqin365_store_id": "8490176521611231861",
    "remove_flag":"1"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
store_code VARCHAR(32) 否 客户编码,唯一,有效字符详见附录：有效字符说明 (opens new window)
store_id VARCHAR(32) 否 来源于第三方系统的唯一客户标识，有效字符详见附录：有效字符说明 (opens new window)
waiqin365_store_id VARCHAR(32) 否 勤策的客户唯一标识，store_id、waiqin365_store_id如果同时存在优先取waiqin365_store_id
remove_flag CHAR(1) 否 删除标识，不传值默认包含子节点的节点是不能直接删除，传值“1”表示可以直接删除，删除时，该节点下所有节点都会被删除

响应示例：

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

参数说明：

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

# 查询客户层级关系信息

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

{
    "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"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
page_number INT 否 页码默认1，每页最大1000条
store_code VARCHAR(32) 否 子节点客户编码,唯一,有效字符详见附录：有效字符说明 (opens new window)
parent_code VARCHAR(32) 否 父节点客户编码,唯一,有效字符详见附录：有效字符说明 (opens new window)
store_name VARCHAR(1) 否 子节点客户名称
parent_name VARCHAR(1) 否 父节点客户名称
store_id VARCHAR(32) 否 子节点客户唯一标识，来源于第三方系统的唯一客户标识，有效字符详见附录：有效字符说明 (opens new window)
parent_id VARCHAR(32) 否 父节点客户唯一标识，来源于第三方系统的唯一客户标识，有效字符详见附录：有效字符说明 (opens new window)
waiqin365_store_id VARCHAR(32) 否 子节点客户唯一标识。store_id、waiqin365_store_id如果同时存在优先取waiqin365_store_id
waiqin365_parent_id VARCHAR(32) 否 父节点客户唯一标识。parent_id、waiqin365_parent_id如果同时存在优先取waiqin365_parent_id

响应示例：

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

数据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"
        }
]

参数说明：

参数 类型 必填 说明
waiqin365_store_id VARCHAR(32) 子节点客户唯一标识
waiqin365_parent_id VARCHAR(32) 父节点客户唯一标识
store_code VARCHAR(32) 子节点客户唯一标识，唯一,有效字符详见附录：有效字符说明 (opens new window)
parent_code VARCHAR(1) 父节点客户唯一标识，唯一,有效字符详见附录：有效字符说明 (opens new window)
store_id VARCHAR(1) 子节点客户唯一标识，来源于第三方系统的唯一客户标识，有效字符详见附录：有效字符说明 (opens new window)
parent_id VARCHAR(1) 父节点客户唯一标识，来源于第三方系统的唯一客户标识，有效字符详见附录：有效字符说明 (opens new window)
store_name VARCHAR(1) 子节点客户名称
parent_name VARCHAR(1) 父节点客户名称

← 客户信息推送 →