API开放平台

TIP

# 客户类型信息接口

# 新增客户类型信息

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

{
    "type_id":"test",
    "type_code":"test",
    "type_name": "测试用",
    "type_remarks": "测试",
    "type_status": "1",
    "trade_type": "2",
    "type_seq": "1",
    "type_parent_id": "CODE001"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
type_id VARCHAR(32) 是 来源于第三方系统类型唯一标识
type_code VARCHAR(32) 否 类型编码
type_name VARCHAR(32) 是 类型名称，同一客户类型节点下唯一
type_remarks VARCHAR(32) 否 类型备注
type_status VARCHAR(32) 否 类型状态，默认值为1。0：注销，1：正常
trade_type VARCHAR(32) 是 客户行业类型。1：标准版客户，2：经销商，3：终端门店
type_seq VARCHAR(32) 否 排序号，数值型，数值越小，排名越靠前
type_parent_id VARCHAR(32) 是 来源于第三方系统上级类型唯一标识，首次调用传值-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/customerType/v1/modifyCustomerType/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
   "type_id":"test",
    "type_code":"test",
    "type_name": "测试用",
    "type_remarks": "测试",
    "type_status": "1",
    "trade_type": "2",
    "type_seq": "1",
    "type_parent_id": "CODE001",
    "waiqin365_id": "123456789",
    "waiqin365_parent_id": "234567890"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
type_id VARCHAR(32) 否 来源于第三方系统客户类型唯一标识，和勤策的客户类型唯一标识不能同时为空
type_code VARCHAR(32) 否 类型编码
type_name VARCHAR(32) 否 类型名称，同一客户类型节点下唯一
type_remarks VARCHAR(32) 否 类型备注
type_status VARCHAR(32) 否 类型状态，默认值为1。0：注销，1：正常
trade_type VARCHAR(32) 否 客户行业类型，默认值为1。1：标准版客户，2：经销商，3：终端门店
type_seq VARCHAR(32) 否 排序号，数值型，数值越小，排名越靠前
type_parent_id VARCHAR(32) 否 来源于第三方系统上级类型唯一标识，和勤策的上级客户类型唯一标识不能同时为空
waiqin365_id VARCHAR(32) 否 勤策的客户类型唯一标识，和来源于第三方系统客户类型唯一标识不能同时为空。type_id、waiqin365_id如果同时存在优先取waiqin365_id
waiqin365_parent_id VARCHAR(32) 否 勤策的上级客户类型唯一标识，和来源于第三方系统上级类型唯一标识不能同时为空。type_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/customerType/v1/removeCustomerType/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "type_id":"test",
    "waiqin365_id": "CODE001"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
type_id VARCHAR(32) 否 来源于第三方系统类型唯一标识，和勤策的客户类型唯一标识不能同时为空
waiqin365_id VARCHAR(32) 否 勤策的客户类型唯一标识，和来源于第三方系统类型唯一标识不能同时为空。type_id和waiqin365_id如果同时存在优先取waiqin365_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/customerType/v1/queryCustomerType/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

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

参数说明：

参数 类型 必填 说明
type_id VARCHAR(32) 否 来源于第三方系统类型唯一标识
type_code VARCHAR(100) 否 类型编码，模糊查询
type_name VARCHAR(100) 否 类型名称，模糊查询
type_remarks VARCHAR(100) 否 类型备注，模糊查询
type_status CHAR(1) 否 类型状态，默认1。0：注销，1：正常
trade_type CHAR(1) 否 客户行业类型，默认1。1：标准版客户，2：经销商，3：终端门店
create_date CHAR(10) 否 创建日期。格式：yyyy-MM-dd
modify_date CHAR(10) 否 修改日期。格式：yyyy-MM-dd
after_create_date CHAR(19) 否 创建时间之后。格式：yyyy-MM-dd HH:mm:ss
after_modify_date CHAR(19) 否 更新时间之后。格式：yyyy-MM-dd HH:mm:ss

响应示例：

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

数据DATA示例:

[
        {
            "type_id": "type00001",
            "type_code": "leixin1",
            "type_name": "类型1",
            "type_parent_id": "",
            "type_status": 1,
            "type_image": "size-1,color-1",
            "type_remarks ": "这是备注",
            "create_date ": "2016-01-01",
            "modify_date ": "2016-01-01",
            "trade_type ": 1,
            "id": "5303911770644379662",
            "parent_id": ""
        }
]

参数说明：

参数 类型 必填 说明
type_id VARCHAR(32) 来源于第三方系统类型唯一标识
type_code VARCHAR(100) 类型编码
type_name VARCHAR(100) 类型名称
type_parent_id VARCHAR(32) 来源于第三方系统上级类型唯一标识
type_sequence VARCHAR(32) 排序号，顺序排列
type_status CHAR(1) 类型状态，默认值为1。0：注销，1：正常
type_image VARCHAR(200) 类型对应的图片信息
type_remarks VARCHAR(1000) 类型备注
create_date VARCHAR(10) 创建日期。格式：yyyy-MM-dd
modify_date VARCHAR(10) 修改日期。格式：yyyy-MM-dd
trade_type CHAR(1) 客户行业类型，默认1。1：标准版客户，2：经销商，3：终端门店
id VARCHAR(32) 勤策类型ID
parent_id VARCHAR(32) 勤策类型上级ID

← 客户合作状态 →