开放接口API说明-客户类型信息接口

参数名称 参数值
应用编码 customerType
应用版本 v1
接口名称 新增客户类型
接口编码 addCustomerType
接口URL https://openapi.waiqin365.com/api/customerType/v1/addCustomerType/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
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) 来源于第三方系统上级类型唯一标识
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "type_id":"test",
    "type_code":"test",
    "type_name": "测试用",
    "type_remarks": "测试",
    "type_status": "1",
    "trade_type": "2",
    "type_seq": "1",
    "type_parent_id": "CODE001"
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 customerType
应用版本 v1
接口名称 修改客户类型
接口编码 modifyCustomerType
接口URL https://openapi.waiqin365.com/api/customerType/v1/modifyCustomerType/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
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_idwaiqin365_id必传其一,
如果同时传入,
则以waiqin365_id为准
waiqin365_parent_id VARCHAR(32) 上级客户类型唯一标识,type_parent_idwaiqin365_parent_id必传其一,
如果同时传入,
则以waiqin365_parent_id为准
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

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

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 customerType
应用版本 v1
接口名称 删除客户类型
接口编码 removeCustomerType
接口URL https://openapi.waiqin365.com/api/customerType/v1/removeCustomerType/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
type_id VARCHAR(32) 来源于第三方系统类型唯一标识
waiqin365_id VARCHAR(32) 类型编码,type_idwaiqin365_id必传其一,
如果同时传入,
则以waiqin365_id为准
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "type_id":"test",
    "waiqin365_id": "CODE001"
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 customerType
应用版本 v1
接口名称 查询客户类型
接口编码 queryCustomerType
接口URL https://openapi.waiqin365.com/api/customerType/v1/queryCustomerType/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
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”
响应信息 参照表响应信息格式
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) 外勤365类型ID
parent_id VARCHAR(32) 外勤365类型上级ID

// 请求消息体示例:
{
    "type_id": "type00001"
}

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