API开放平台

TIP

# 客户信息接口

# 新增客户信息

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

{
    "cm_id": "CM0001",
    "cm_name": "苏果夫子庙店",
    "cm_code": "suguo_fzmd",
    "cm_manager": "王伟,张强,吴为",
    "cm_manager_id": "emp001,emp002,emp03",
    "cm_emp_code": "yuangong1",
    "cm_org_code": "1202001",
    "cm_type": "大型超市",
    "cm_district": "华中大区,南京分区,秦淮社区",
    "cm_district_code": "code01",
    "cm_sales_org" : "",
    "cm_mss_province": "江苏省",
    "cm_mss_city": "南京市",
    "cm_mss_area": "秦淮区",
    "cm_mss_street": "红花街道", 
    "cm_addr": "南京市秦淮区大全福巷1号",
    "cm_cooperate_status": "1",
    "cm_uper_customer": "苏果新街口店",
    "cm_source": "老客户介绍",
    "cm_trade": "服务业",
    "cm_scale": "200人以上",
    "cm_tel": "02552416854",
    "cm_fax": "02552416854",
    "cm_post": "210010",
    "cm_remarks": "",
    "cm_residents_id": "emp001,emp002",
    "cm_residents": "王伟,张强",
    "cm_label": "标签1,标签2",
    "cm_assistant_id": "7053012386494123505,6954172928161735690",
    "cm_assistant_name": "王伟,张强",
    "cm_road_msg": "道路信息",
    "cm_pictures": "https://image.waiqin365.com/7203760635523959962/cm/photo/cd3c282b1302498781c77d26fbdde351.png",
    "cm_house_number": "门牌号信息",
    "cm_liscence": "https://image.waiqin365.com/7203760635523959962/cm/photo/cd3c282b1302498781c77d26fbdde351.png",
    "cm_liscence_name": "营业执照信息",
    "cm_registration_no": "工商注册号信息",
    "cm_registration_date": "2019-10-21",
    "cm_operator": "经营者信息",
    "cm_location":"13.6541,86.6656",
    "cm_sale_direct": "是",
    "cm_city_id_code": "110000",
    "cm_city_id_name": "北京市",
    "deliverys": [
        {
            "cm_delivery_main": "1",
            "cm_delivery_name": "张三",
            "cm_delivery_tel": "52365895",
            "cm_delivery_phone": "13052125555",
            "cm_delivery_addr": "南京路XXXX号",
            "cm_delivery_ex1":"",
            "cm_delivery_ex2":"",
            "cm_delivery_ex3":"",
            "cm_delivery_id":"nw001"
        }
    ],
    "linkmans": [
        {
            "cm_linkman_name": "张三",
            "cm_linkman_job": "店主",
            "cm_linkman_mobile": "13052125555",
            "cm_linkman_office_tel": "52365895",
            "cm_linkman_fax": "25758545",
            "cm_linkman_sex": "M",
            "cm_linkman_birthday": "1980-02-06",
            "cm_linkman_email": "abc@163.com",
            "cm_linkman_remarks": "",
            "cm_linkman_main": "1",
            "cm_linkman_qq": "qq",
            "cm_linkman_weixin": "微信",
            "cm_linkman_dept": "部门",
            "cm_linkman_intimacy": "亲密度",
            "cm_linkman_importance": "重要程度",
            "cm_linkman_decision_relationship": "决策关系",
             "cm_linkman_id":"nw001"
        },
        {
            "cm_linkman_name": "李四",
            "cm_linkman_job": "店员",
            "cm_linkman_mobile": "13022215212",
            "cm_linkman_office_tel": "58755254",
            "cm_linkman_fax": "",
            "cm_linkman_sex": "F",
            "cm_linkman_birthday": "1981-02-14",
            "cm_linkman_email": "",
            "cm_linkman_remarks": "",
            "cm_linkman_main": "0",
            "cm_linkman_qq": "qq",
            "cm_linkman_weixin": "微信",
            "cm_linkman_dept": "部门",
            "cm_linkman_intimacy": "亲密度",
            "cm_linkman_importance": "重要程度",
            "cm_linkman_decision_relationship": "决策关系",
            "cm_linkman_id":"nw002"
        }
    ],
    "exts": [
        {
            "cm_ext_key": "级别",
            "cm_ext_value": "四星"
        },
        {
            "cm_ext_key": "主营商品",
            "cm_ext_value": "食品,电器,日化用品"
        }
    ],
    "cm_receive_info":[
          {
              "cm_id": "zt001",
              "cm_waiqin_365_id": "98000123465333545",
              "cm_code": "zt001"
          }
    ]      
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 是 来源于第三方系统的客户唯一ID
cm_name VARCHAR(100) 是 客户名称，有效字符详见附录：有效字符说明 (opens new window)
cm_code VARCHAR(32) 是 客户编码，状态为正常的客户编码唯一，有效字符详见附录：有效字符说明 (opens new window)
cm_manager_id VARCHAR(4000) 否 客户经理唯一标识，多客户经理唯一标识间以“,”分隔。来源于第三方系统的员工唯一标识,和员工信息中emp_id对应。 如：EMP0001, EMP0002, EMP0003
cm_emp_code VARCHAR(32) 否 客户经理code（即为员工登录账号），多客户经理唯一标识间以“,”分隔。
cm_org_code VARCHAR(32) 否 门店所属部门code
cm_manager_waiqin365_id VARCHAR(4000) 否 客户经理唯一标识，多客户经理唯一标识间以“,”分隔。勤策唯一主键，cm_manager_waiqin365_id、cm_manager_id、cm_manager如果同时存在，优先级依次降低
cm_manager VARCHAR(4000) 否 客户经理名称，多客户经理名称间以“,”分隔，如：张三,李四,王五 。cm_manager_id、cm_manager如果同时存在优先取cm_manager_id
cm_type_code VARCHAR(100) 否 客户类型编码
cm_type VARCHAR(100) 否 客户类型名称，cm_type、cm_type_code如果同时存在优先取cm_type_code
cm_third_district_id VARCHAR(32) 否 第三方销售区域ID,来源于第三方系统的唯一销售区域标识
cm_district_waiqin365_id VARCHAR(32) 否 客户所属销售区域ID，来源于勤策的销售区域唯一ID
cm_district_code VARCHAR(32) 否 客户所属销售区域编码，来源于勤策的销售区域编码。如果cm_district_waiqin365_id、cm_third_district_id、cm_district_code同时存在，依展示顺序优先取作为对应销售区域
cm_sales_org VARCHAR(32) 否 销售组织(id或名称)
cm_district VARCHAR(1000) 否 客户所属销售区域名称，此字段需要销售区域的完整层级结构名称，多层级间以“,”分隔，如：华中大区,南京分区,秦淮社区。cm_district,cm_district_waiqin365_id如果同时存在优先取cm_district_waiqin365_id。
此字段从2022年01月01日起废弃，使用cm_district_waiqin365_id、cm_third_district_id替代，新增或修改销售区域时直接使用销售区域管理接口
cm_dept_waiqin365_id VARCHAR(32) 否 客户所属部门ID，来源于勤策部门唯一ID
cm_dept_id VARCHAR(32) 否 客户所属部门唯一标识，来源于第三方系统的部门唯一标识和部门信息中org_id对应，cm_dept_id、cm_dept_waiqin365_id如果同时存在优先取cm_dept_waiqin365_id
cm_mss_province VARCHAR(32) 否 客户所属行政区域-省名称，如是直辖市，省和市请传一样的值
cm_mss_city VARCHAR(32) 否 客户所属行政区域-市名称，如是直辖市，省和市请传一样的值
cm_mss_area VARCHAR(32) 否 客户所属行政区域-区县名称，如是直筒子市，市和县请传一样的值
cm_mss_street VARCHAR(100) 否 客户所属行政区域-乡镇街道名称
cm_addr VARCHAR(4000) 否 客户地址
cm_cooperate_status_name VARCHAR(32) 否 合作状态:终止合作/合作中/未合作/有意向/{自定义的}，cm_cooperate_status,cm_cooperate_status_name如果同时存在优先取cm_cooperate_status
cm_cooperate_status CHAR(1) 否 合作状态。0：终止合作，1：合作中，2：未合作，3：有意向
cm_uper_customer VARCHAR(100) 否 上级客户
cm_level VARCHAR(100) 否 客户级别
cm_source VARCHAR(100) 否 客户来源
cm_trade VARCHAR(100) 否 客户行业
cm_scale VARCHAR(100) 否 客户人员规模
cm_tel VARCHAR(32) 否 客户电话, 如：02544550010或025-44550010
cm_fax VARCHAR(32) 否 客户传真, 如：02544550010或025-44550010
cm_post VARCHAR(32) 否 客户邮编
cm_remarks VARCHAR(4000) 否 客户备注
cm_residents_id VARCHAR(4000) 否 客户驻店人员唯一标识。 多驻店人员唯一标识以“,”分隔
cm_residents VARCHAR(4000) 否 客户驻店人员名称。多驻店人员以“,”分隔
cm_label VARCHAR(4000) 否 客户标签名称。多标签以“,”分隔
cm_assistant_id VARCHAR(4000) 否 客户协助员唯一标识。 多协助员唯一标识以“,”分隔，来源于第三方系统的员工唯一标识。cm_assistant_id、cm_assistant_name如果同时存在优先取cm_assistant_id。
cm_assistant_name VARCHAR(4000) 否 客户协助员名称。多协助员以“,”分隔
cm_road_msg VARCHAR(4000) 否 客户道路信息
cm_pictures VARCHAR(4000) 否 客户门头照，图片下载url
cm_house_number VARCHAR(4000) 否 客户门牌号信息
cm_liscence VARCHAR(4000) 否 客户营业执照，传图片下载url；传多个url时，以“,”分隔拼接
cm_liscence_name VARCHAR(4000) 否 客户营业执照信息
cm_registration_no VARCHAR(4000) 否 客户工商注册号信息
cm_registration_date varchar(32) 否 客户注册日期。格式：yyyy-MM-dd
cm_operator VARCHAR(4000) 否 客户经营者信息
cm_location VARCHAR(100) 否 客户纬经度。坐标格式为"纬度,经度"，如：28.153774,112.986099
cm_sale_direct VARCHAR(1) 否 是否直接交易客户。只能填写“是”、“否”
cm_city_id_code VARCHAR(32) 否 所在城市编码。所在城市配置手动维护时生效，对应省市区码。
cm_city_id_mame VARCHAR(100) 否 所在城市名称。所在城市配置手动维护时生效，对应省市区名称(cm_city_id_code存在则以该字段为准)
cm_linkman_full_sync VARCHAR(1) 否 客户联系人全量同步标识，需要使用，传1，将以接口中数据覆盖系统中数据；如无需使用，不传任何值
cm_delivery_full_sync VARCHAR(1) 否 客户收货地址全量同步标识，需要使用，传1，将以接口中数据覆盖系统中数据；如无需使用，不传任何值
linkmans List 否 客户联系人列表
linkmans
.cm_linkman_name		 VARCHAR(100) 否 客户联系人名称
linkmans
.cm_linkman_job		 VARCHAR(32) 否 客户联系人职务
linkmans
.cm_linkman_mobile		 VARCHAR(32) 否 客户联系人手机
linkmans
.cm_linkman_office_tel		 VARCHAR(32) 否 客户联系人固定电话, 如：02544550010或025-44550010
linkmans
.cm_linkman_fax		 VARCHAR(32) 否 客户联系人传真, 如：02544550010或025-44550010
linkmans
.cm_linkman_sex		 VARCHAR(1) 否 客户联系人性别。F：女性，M：男性。默认值为M
linkmans
.cm_linkman_birthday		 timestamp 否 客户联系人生日
linkmans
.cm_linkman_email		 VARCHAR(100) 否 客户联系人电子邮件
linkmans
.cm_linkman_remarks		 VARCHAR(4000) 否 客户联系人备注
linkmans
.cm_linkman_main		 VARCHAR(1) 否 是否为主联系人。0：否，1：是。默认值为0
linkmans
.cm_linkman_qq		 VARCHAR(100) 否 客户联系人qq
linkmans
.cm_linkman_weixin		 VARCHAR(100) 否 客户联系人微信
linkmans
.cm_linkman_dept		 VARCHAR(200) 否 客户联系人部门
linkmans
.cm_linkman_intimacy		 VARCHAR(200) 否 客户联系人亲密度
linkmans
.cm_linkman_importance		 VARCHAR(200) 否 客户联系人重要程度
linkmans
.cm_linkman
_decision_relationship		 VARCHAR(200) 否 客户联系人决策关系
linkmans
.cm_linkman_id		 VARCHAR(100) 否 客户联系人第三方id，来源于第三方唯一标识，校验唯一性
deliverys List 否 客户收货地址列表
deliverys
.cm_delivery_main		 VARCHAR(1) 否 是否为默认收获地址。0：否，1：是。默认值为0
deliverys
.cm_delivery_name		 VARCHAR(32) 否 收货人名称
deliverys
.cm_delivery_tel		 VARCHAR(32) 否 收货电话
deliverys
.cm_delivery_phone		 VARCHAR(32) 否 收货手机号
deliverys
.cm_delivery_addr		 VARCHAR(32) 否 收货地址
deliverys
.cm_delivery_ex1		 VARCHAR(200) 否 收货地址扩展字段1
deliverys
.cm_delivery_ex2		 VARCHAR(200) 否 收货地址扩展字段2
deliverys
.cm_delivery_ex3		 VARCHAR(200) 否 收货地址扩展字段3
deliverys
.cm_delivery_id		 VARCHAR(100) 否 收货地址第三方id,来源于第三方唯一标识，校验唯一性
exts List 否 客户信息扩展字段列表。json数据格式为[{"cm_ext_key": "级别","cm_ext_value": "四星"}]
exts.cm_ext_key VARCHAR(100) 否 客户信息扩展字段key值，客户信息扩展字段需先在勤策系统客户管理中创建自定义字段
exts.cm_ext_value VARCHAR(4000) 否 客户信息扩展字段value值对多个选项值，以“,”分隔拼接；若字段类型为拍照控件，传图片下载url；暂不支持附件同步
cm_receive_info List 否 客户收货方列表
cm_receive_info
.cm_id		 VARCHAR(32) 否 客户收货方唯一标识，来源于第三方系统的唯一客户标识。cm_waiqin_365_id、cm_id,cm_code如果同时存在，优先级依次降低
cm_receive_info
.cm_waiqin_365_id		 VARCHAR(32) 否 客户收货方对应的勤策的id。cm_waiqin_365_id、cm_id、cm_code如果同时存在，优先级依次降低
cm_receive_info
.cm_code		 VARCHAR(32) 否 客户收货方编码。cm_waiqin_365_id、cm_id、cm_code如果同时存在，优先级依次降低

响应示例：

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

参数说明：

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

# 修改客户信息

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

{
    "cm_id": "CM0001",
    "cm_name": "苏果夫子庙店",
    "cm_code": "suguo_fzmd",
    "cm_manager": "王伟,张强,吴为",
    "cm_manager_id": "emp01,emp02",
    "cm_emp_code": "yuangong1",
    "cm_org_code": "1202001",
    "cm_type": "大型超市",
    "cm_district": "华中大区,南京分区,秦淮社区",
    "cm_district_code": "code01",
    "cm_sales_org" : "",
    "cm_mss_province": "江苏省",
    "cm_mss_city": "南京市",
    "cm_mss_area": "秦淮区",
    "cm_mss_street": "红花街道",
    "cm_addr": "南京市秦淮区大全福巷1号",
    "cm_cooperate_status": "1",
    "cm_uper_customer": "苏果新街口店",
    "cm_source": "老客户介绍",
    "cm_trade": "服务业",
    "cm_scale": "200人以上",
    "cm_tel": "02552416854",
    "cm_fax": "02552416854",
    "cm_post": "210010",
    "cm_remarks": "",
    "status": "1",
    "cm_residents_id": "emp001,emp002",
    "cm_residents": "王伟,张强",
    "cm_label": "标签1,标签2",
    "cm_assistant_id": "7053012386494123505,6954172928161735690",
    "cm_assistant_name": "王伟,张强",
    "cm_road_msg": "道路信息",
    "cm_pictures": "https://image.waiqin365.com/7203760635523959962/cm/photo/cd3c282b1302498781c77d26fbdde351.png",
    "cm_house_number": "门牌号信息",
    "cm_liscence": "https://image.waiqin365.com/7203760635523959962/cm/photo/cd3c282b1302498781c77d26fbdde351.png",
    "cm_liscence_name": "营业执照信息",
    "cm_registration_no": "工商注册号信息",
    "cm_registration_date": "2019-10-21",
    "cm_operator": "经营者信息",
    "cm_location": "28.153774,112.986099",
    "cm_sale_direct": "是",
    "cm_city_id_code": "110000",
    "cm_city_id_name": "北京市",
    "linkmans": [
        {
            "cm_linkman_name": "张三",
            "cm_linkman_job": "店主",
            "cm_linkman_mobile": "13052125555",
            "cm_linkman_office_tel": "52365895",
            "cm_linkman_fax": "25758545",
            "cm_linkman_sex": "M",
            "cm_linkman_birthday": "1980-02-06",
            "cm_linkman_email": "abc@163.com",
            "cm_linkman_remarks": "",
            "cm_linkman_main": "1",
            "cm_linkman_qq": "qq",
            "cm_linkman_weixin": "微信",
            "cm_linkman_dept": "部门",
            "cm_linkman_intimacy": "亲密度",
            "cm_linkman_importance": "重要程度",
            "cm_linkman_decision_relationship": "决策关系",
            "cm_linkman_id":"nw001"
        },
        {
            "cm_linkman_name": "李四",
            "cm_linkman_job": "店员",
            "cm_linkman_mobile": "13022215212",
            "cm_linkman_office_tel": "58755254",
            "cm_linkman_fax": "",
            "cm_linkman_sex": "F",
            "cm_linkman_birthday": "1981-02-14",
            "cm_linkman_email": "",
            "cm_linkman_remarks": "",
            "cm_linkman_main": "0",
            "cm_linkman_qq": "qq",
            "cm_linkman_weixin": "微信",
            "cm_linkman_dept": "部门",
            "cm_linkman_intimacy": "亲密度",
            "cm_linkman_importance": "重要程度",
            "cm_linkman_decision_relationship": "决策关系",
             "cm_linkman_id":"nw002"
        }
    ],
    "deliverys":[{
        "cm_ delivery_main":"1",
        "cm_delivery_name":"张三",
        "cm_delivery_tel":"52365895",
        "cm_delivery_phone":"13052125555",
        "cm_delivery_addr":"南京路XXXX号",
        "cm_delivery_ex1":"",
        "cm_delivery_ex2":"",
        "cm_delivery_ex3":"",
        "cm_delivery_id":"nw001"
    }],
    "exts": [
        {
            "cm_ext_key": "级别",
            "cm_ext_value": "四星"
        },
        {
            "cm_ext_key": "主营商品",
            "cm_ext_value": "食品,电器,日化用品"
        }
    ],
    "cm_receive_info":[
          {
              "cm_id": "zt001",
              "cm_waiqin_365_id": "98000123465333545",
              "cm_code": "zt001"
          }
    ] 
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 否 来源于第三方系统的客户唯一ID，对应新增客户 (cm_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空。 调用此接口时该字段值(cm_id)和勤策的客户唯一ID(cm_waiqin365_id)作为更新数据的唯一标识，所以不能同时为空， 如果两个值同时存在则优先顺序为cm_waiqin365_id、cm_id
cm_waiqin365_id VARCHAR(32) 否 勤策的客户唯一ID，和来源于第三方系统客户唯一ID(cm_id)作为更新数据的唯一标识，所以不能同时为空
cm_name VARCHAR(100) 是 客户名称，唯一，有效字符详见附录：有效字符说明 (opens new window)
cm_code VARCHAR(32) 否 客户编码，有效字符详见附录：有效字符说明 (opens new window)
cm_manager VARCHAR(4000) 否 客户经理，多客户经理名称间以“,”分隔，如：张三,李四,王五。 cm_manager_waiqin365_id、cm_manager_id、cm_manager如果同时存在，优先级依次降低
cm_manager_id VARCHAR(4000) 否 客户经理唯一标识，多客户经理唯一标识间以“,”分隔。来源于第三方系统的员工唯一标识，和员工信息中emp_id对应， 如：EMP0001, EMP0002, EMP0003。 cm_manager_waiqin365_id、cm_manager_id、cm_manager如果同时存在，优先级依次降低
cm_emp_code VARCHAR(32) 否 客户经理code（即为员工登录账号），多客户经理唯一标识间以“,”分隔。
cm_org_code VARCHAR(32) 否 门店所属部门code
cm_manager_waiqin365_id VARCHAR(4000) 否 客户经理唯一标识，多客户经理唯一标识间以“,”分隔。 cm_manager_waiqin365_id、cm_manager_id、cm_manager如果同时存在，优先级依次降低
cm_type VARCHAR(100) 否 客户类型名称，cm_type、cm_type_code如果同时存在优先取cm_type_code
cm_type_code VARCHAR(100) 否 客户类型编码
cm_third_district_id VARCHAR(32) 否 第三方销售区域ID,来源于第三方系统的唯一销售区域标识
cm_district_waiqin365_id VARCHAR(32) 否 客户所属销售区域唯一标识，来源于勤策的客户销售区域唯一ID
cm_district_code VARCHAR(32) 否 客户所属销售区域编码，来源于勤策的销售区域编码。如果cm_district_waiqin365_id、cm_third_district_id、cm_district_code同时存在，依展示顺序优先取作为对应销售区域
cm_sales_org VARCHAR(32) 否 销售组织(id或名称)
cm_district VARCHAR(1000) 否 客户所属销售区域名称，此字段需要销售区域的完整层级结构名称，多层级间以“,”分隔，如：华中大区,南京分区,秦淮社区。cm_district、cm_district_waiqin365_id如果同时存在优先取cm_district_waiqin365_id
此字段从2022年01月01日起废弃，使用cm_district_waiqin365_id、cm_third_district_id替代，新增或修改销售区域时直接使用销售区域管理接口
cm_dept_id VARCHAR(32) 否 部门唯一标识，来源于第三方系统的部门唯一标识,和部门信息中org_id对应，cm_dept_id、cm_dept_waiqin365_id如果同时存在优先取cm_dept_waiqin365_id
cm_dept_waiqin365_id VARCHAR(32) 否 客户部门ID，开源于勤策部门唯一ID
cm_mss_province VARCHAR(32) 否 客户所属行政区域-省名称，如是直辖市，省和市请传一样的值
cm_mss_city VARCHAR(32) 否 客户所属行政区域-市名称，如是直辖市，省和市请传一样的值
cm_mss_area VARCHAR(32) 否 客户所属行政区域-县名称，如是直筒子市，市和县请传一样的值
cm_mss_street VARCHAR(32) 否 客户所属行政区域-乡镇街道名称
cm_addr VARCHAR(4000) 否 客户地址
cm_cooperate_status CHAR(1) 否 合作状态。0：终止合作，1：合作中，2：未合作，3：有意向
cm_cooperate_status_name VARCHAR(32) 否 合作状态：终止合作/合作中/未合作/有意向/{自定义的}，cm_cooperate_status_name、cm_cooperate_status如果同时存在优先取cm_cooperate_status
cm_uper_customer VARCHAR(100) 否 上级客户
cm_level VARCHAR(100) 否 客户级别
cm_source VARCHAR(100) 否 客户来源
cm_trade VARCHAR(100) 否 客户行业
cm_scale VARCHAR(100) 否 客户人员规模
cm_tel VARCHAR(32) 否 客户电话，如：02544550010或025-44550010
cm_fax VARCHAR(32) 否 客户传真，如：02544550010或025-44550010
cm_post VARCHAR(32) 否 客户邮编
cm_remarks VARCHAR(4000) 否 客户备注
cm_residents_id VARCHAR(4000) 否 客户驻店人员唯一标识。 多驻店人员唯一标识以“,”分隔
cm_residents VARCHAR(4000) 否 客户驻店人员名称。多驻店人员以“,”分隔
cm_label VARCHAR(4000) 否 客户标签名称。多标签以“,”分隔
status VARCHAR(1) 否 客户状态。1：正常，0：删除
cm_assistant_id VARCHAR(4000) 否 客户协助员唯一标识。 多协助员唯一标识以“,”分隔，来源于第三方系统的员工唯一标识。cm_assistant_id、cm_assistant_name如果同时存在优先取cm_assistant_id。
cm_assistant_name VARCHAR(4000) 否 客户协助员名称。多协助员以“,”分隔
cm_road_msg VARCHAR(4000) 否 客户道路信息
cm_pictures VARCHAR(4000) 否 客户门头照，图片下载url
cm_house_number VARCHAR(4000) 否 客户门牌号信息
cm_liscence VARCHAR(4000) 否 客户营业执照，传图片下载url；传多个url时，以“,”分隔拼接
cm_liscence_name VARCHAR(4000) 否 客户营业执照信息
cm_registration_no VARCHAR(4000) 否 客户工商注册号信息
cm_registration_date varchar(32) 否 客户注册日期。格式：yyyy-MM-dd
cm_operator VARCHAR(4000) 否 客户经营者信息
cm_linkman_full_sync VARCHAR(1) 否 客户联系人全量同步标识，需要使用，传1，将以接口中数据覆盖系统中数据；如无需使用，不传任何值
cm_delivery_full_sync VARCHAR(1) 否 客户收货地址全量同步标识，需要使用，传1，将以接口中数据覆盖系统中数据；如无需使用，不传任何值
cm_location VARCHAR(100) 否 客户纬经度。坐标格式为"纬度,经度"，如：28.153774,112.986099
cm_sale_direct VARCHAR(1) 否 是否直接交易客户。只能填写“是”、“否”
cm_city_id_code VARCHAR(32) 否 所在城市编码。所在城市配置手动维护时生效，对应省市区码。
cm_city_id_mame VARCHAR(100) 否 所在城市名称。所在城市配置手动维护时生效，对应省市区名称(cm_city_id_code存在则以该字段为准)
linkmans List 否 客户联系人列表
linkmans
.cm_linkman_name		 VARCHAR(100) 否 客户联系人名称
linkmans
.cm_linkman_job		 VARCHAR(32) 否 客户联系人职务
linkmans
.cm_linkman_mobile		 VARCHAR(32) 否 客户联系人手机
linkmans
.cm_linkman_office_tel		 VARCHAR(32) 否 客户联系人固定电话, 如：02544550010或025-44550010
linkmans
.cm_linkman_fax		 VARCHAR(32) 否 客户联系人传真, 如：02544550010或025-44550010
linkmans
.cm_linkman_sex		 VARCHAR(1) 否 客户联系人性别。F：女性，M：男性。默认值为M
linkmans
.cm_linkman_birthday		 timestamp 否 客户联系人生日
linkmans
.cm_linkman_email		 VARCHAR(100) 否 客户联系人电子邮件
linkmans
.cm_linkman_remarks		 VARCHAR(4000) 否 客户联系人备注
linkmans
.cm_linkman_main		 VARCHAR(1) 否 是否为主联系人。0：否，1：是。默认值为0
linkmans
.cm_linkman_qq		 VARCHAR(100) 否 客户联系人qq
linkmans
.cm_linkman_weixin		 VARCHAR(100) 否 客户联系人微信
linkmans
.cm_linkman_dept		 VARCHAR(200) 否 客户联系人部门
linkmans
.cm_linkman_intimacy		 VARCHAR(200) 否 客户联系人亲密度
linkmans
.cm_linkman_importance		 VARCHAR(200) 否 客户联系人重要程度
linkmans
.cm_linkman
_decision_relationship		 VARCHAR(200) 否 客户联系人决策关系
linkmans
.cm_linkman_id		 VARCHAR(100) 否 客户联系人第三方id，来源于第三方唯一标识，校验唯一性
exts List 否 客户信息扩展字段列表。json数据格式为[{"cm_ext_key": "级别","cm_ext_value": "四星"}]
exts.cm_ext_key VARCHAR(100) 否 客户信息扩展字段key值，客户信息扩展字段需先在勤策系统客户管理中创建自定义字段
exts.cm_ext_value VARCHAR(4000) 否 客户信息扩展字段value值对多个选项值，以“,”分隔拼接；若字段类型为拍照控件，传图片下载url；暂不支持附件同步
deliverys List 否 客户收货地址列表
deliverys
.cm_delivery_main		 VARCHAR(1) 否 是否为默认收获地址。0：否，1：是。默认值为0
deliverys
.cm_delivery_name		 VARCHAR(32) 否 收货人名称
deliverys
.cm_delivery_tel		 VARCHAR(32) 否 收货电话
deliverys
.cm_delivery_phone		 VARCHAR(32) 否 收货手机号
deliverys
.cm_delivery_addr		 VARCHAR(32) 否 收货地址
deliverys
.cm_delivery_ex1		 VARCHAR(200) 否 收货地址扩展字段1
deliverys
.cm_delivery_ex2		 VARCHAR(200) 否 收货地址扩展字段2
deliverys
.cm_delivery_ex3		 VARCHAR(200) 否 收货地址扩展字段3
deliverys
.cm_delivery_id		 VARCHAR(200) 否 收货地址第三方系统id, 来源于第三方唯一标识，校验唯一性
cm_receive_info List 否 客户收货方列表
cm_receive_info
.cm_id		 VARCHAR(32) 否 客户唯一标识，来源于第三方系统的唯一客户标识,cm_waiqin_365_id、cm_id、cm_code如果同时存在，优先级依次降低
cm_receive_info
.cm_waiqin_365_id		 VARCHAR(32) 否 客户对应的勤策的id，cm_waiqin_365_id、cm_id、cm_code如果同时存在，优先级依次降低
cm_receive_info
.cm_code		 VARCHAR(32) 否 客户编码，cm_waiqin_365_id、cm_id、cm_code如果同时存在，优先级依次降低

响应示例：

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

参数说明：

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

# 删除客户信息

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

{
    "cm_id": "CM0001",
    "cm_waiqin_id": "CM0001"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 是 来源于第三方系统的客户唯一ID，对应新增客户 (cm_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空
cm_waiqin_id VARCHAR(32) 是 客户勤策ID，与第三方系统客户id（cm_id）两者必传其一

响应示例：

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

参数说明：

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

# 恢复已作废客户

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

{
    "cm_id": "CM0001",
    "cm_waiqin365_id": "8397938754676734"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 否 来源于第三方的客户唯一标识，和勤策的客户唯一标识不能同时为空
cm_waiqin365_id LONG 否 勤策的客户唯一标识，和第三方的客户唯一标识不能同时为空

响应示例：

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

参数说明：

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

# 查询客户信息

接口说明： 如果return_code返回0，查询该接口返回数据为空，请核实一下贵企业订购的是否是门店/经销商版本。 门店/经销商版本分别通过调用门店信息接口、经销商信息接口来获取信息

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

{
    "page_number": "1",
    "cm_id": "CM0001",
    "cm_name": "苏果夫子庙店",
    "cm_code": "suguo_fzmd",
    "cm_manager": "王伟,张强,吴为",
    "cm_type_code": "001",
    "cm_type": "大型超市",
    "cm_district": "华中大区,南京分区,秦淮社区",
    "create_date": "2015-05-12",
    "modify_date": "2015-05-12",
    "after_create_date": "2015-05-10 16:18:33",
    "after_modify_date": "2015-05-10 16:18:33",
    "before_create_date": "2015-05-14 22:18:22",
    "before_modify_date": "2015-05-14 22:18:22",
    "cm_manager_id": "5973487364548349847",
    "cm_dept_code": "dept_001",
    "cm_level": "金牌客户",
    "cm_district_code": "district_001"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
page_number INT 否 分页页码，默认值为1
status CHAR(1) 否 记录状态。0：已删除，1：正常
id VARCHAR(32) 否 勤策的客户唯一ID
cm_id VARCHAR(32) 否 来源于第三方系统的客户唯一ID，对应新增客户 (cm_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空
cm_name VARCHAR(100) 否 客户名称，唯一，有效字符详见附录：有效字符说明 (opens new window)
cm_code VARCHAR(32) 否 客户编码，有效字符详见附录：有效字符说明 (opens new window)
cm_manager_id VARCHAR(4000) 否 客户经理id
cm_manager VARCHAR(4000) 否 客户经理，多客户经理名称间以“,”分隔，如：张三,李四,王五。 cm_manager_id和cm_manager如果同时存在优先取cm_manager_id
cm_type_code VARCHAR(100) 否 客户类型编码，cm_type_code和cm_type如果同时存在优先取cm_type_code
cm_type VARCHAR(100) 否 客户类型，根据客户类型名称精确查询
after_create_date CHAR(19) 否 创建时间之后。格式：yyyy-MM-dd HH:mm:ss
after_modify_date CHAR(19) 否 更新时间之后。格式：yyyy-MM-dd HH:mm:ss
before_create_date CHAR(19) 否 创建时间之前。格式：yyyy-MM-dd HH:mm:ss
before_modify_date CHAR(19) 否 更新时间之前。格式：yyyy-MM-dd HH:mm:ss
create_date CHAR(10) 否 创建日期。格式：yyyy-MM-dd
modify_date CHAR(10) 否 修改日期。格式：yyyy-MM-dd
cm_district VARCHAR(1000) 否 客户所属销售区域名称，此字段需要销售区域的完整层级结构名称，多层级间以“,”分隔，如：华中大区,南京分区,秦淮社区
cm_dept_code VARCHAR(1000) 否 客户所属部门code,多个数值间用英文“,”隔开
cm_level VARCHAR(1000) 否 客户级别，多个数值间用英文“,”隔开
cm_district_code VARCHAR(1000) 否 销售区域编码，非全路径编码，多个数值间用英文“,”隔开

响应示例：

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

数据DATA示例:

[
        {
            "id": "7863150652620035205",
            "cm_id": "CM0001",
            "creator_waiqin_id": "8830671133213284556",
            "creator_name": "丁金金",
            "creator_id": "5956995671401092891",
            "return_pool_reason": "打回测试",
            "cm_name": "苏果夫子庙店",
            "cm_code": "suguo_fzmd",
            "cm_source_type": "自建",
            "cm_district": "秦淮社区",
            "cm_district_full_path": "全部,江苏,南京,秦淮社区",
            "cm_type": "大型超市",
            "cm_mss_province": "江苏省",
            "cm_mss_province_code": "320000",
            "cm_mss_city": "南京市",
            "cm_mss_city_code": "320100",
            "cm_mss_area": "秦淮区",
            "cm_mss_area_code": "320104",
            "cm_addr": "南京市秦淮区大全福巷1号",
            "cm_cooperate_status": "1",
            "cm_uper_customer": "苏果新街口店",
            "cm_source": "老客户介绍",
            "cm_trade": "服务业",
            "cm_scale": "200人以上",
            "cm_tel": "02552416854",
            "cm_fax": "02552416854",
            "cm_post": "210010",
            "cm_remarks": "",
            "cm_cooperate_status_id": "2",
            "cm_level_id": "7287736961434231483",
            "cm_approval_status":"1",
            "tradingarea_big ":"核心区域",
            "tradingarea":"新街口",
            "create_time":"2017-09-09 13:14:11",
            "cm_district_id":"6081235751236711020",
            "cm_district_waiqin365_id":"6081235751236765420",
            "cm_third_district_id":"6081235751236711123",
            "cm_district_code":"code01",
            "cm_district_create_time":"2017-09-09 13:14:11",
            "cm_district_modify_time":"2017-10-09 23:14:11",
            "cm_district_creator_name":"张三",
            "cm_district_modifyier_name":"李四",
            "cm_district_status":"1",
            "cm_type_id":"4803341355190322405",
            "cm_type_code": "001",
            "cm_manager_waiqin365_id":"8776918981000102550,6831633994841635708",
            "cm_rel_level_id":"5669281775545680668",
            "cm_mss_street":"华侨路街道",
            "cm_mss_street_code":"320106002",
            "cm_label":"标签1，标签2",
            "cm_label_id":"8776918981022102551，2581673994841635984",
            "cm_assistant_id":"8776918981022102551，2581673994841635984",
            "cm_assistant_name":"张三，李四",
            "cm_road_msg": "道路信息",
            "cm_house_number": "门牌号信息",
            "cm_liscence_name": "营业执照信息",
            "cm_registration_no": "工商注册号信息",
            "cm_registration_date": "2019-10-21",
            "cm_operator": "经营者信息",
            "cm_sale_direct": "是",
            "cm_creator_code": "EMP001",
            "cm_modifier_code": "EMP002",
            "cm_modify_time": "2024-03-18 17:33:50",
            "cm_manager_code": "EMP003",
            "sales_org_id" : "",
            "sales_org_name" : "销售组织名称",
            "linkmans": [
                {
                    "cm_linkman_name": "张三",
                    "cm_linkman_job": "店主",
                    "cm_linkman_mobile": "13052125555",
                    "cm_linkman_office_tel": "52365895",
                    "cm_linkman_fax": "25758545",
                    "cm_linkman_sex": "M",
                    "cm_linkman_birthday": "1980-02-06",
                    "cm_linkman_email": "abc@163.com",
                    "cm_linkman_remarks": "",
                    "cm_linkman_main": "1",
                    "cm_linkman_qq": "qq",
                    "cm_linkman_weixin": "微信",
                    "cm_linkman_dept": "部门",
                    "cm_linkman_id":"L001",
                    "cm_linkman_intimacy":"一星",
                    "cm_linkman_importance":"重要",
                    "cm_linkman_decision_relationship":"决策人",
                    "cm_linkman_approval_status":"3"
                },
                {
                    "cm_linkman_name": "李四",
                    "cm_linkman_job": "店员",
                    "cm_linkman_mobile": "13022215212",
                    "cm_linkman_office_tel": "58755254",
                    "cm_linkman_fax": "",
                    "cm_linkman_sex": "F",
                    "cm_linkman_birthday": "1981-02-14",
                    "cm_linkman_email": "",
                    "cm_linkman_remarks": "",
                    "cm_linkman_main": "0",
                    "cm_linkman_id":"L002",
                    "cm_linkman_intimacy":"一星",
                    "cm_linkman_importance":"重要",
                    "cm_linkman_decision_relationship":"决策人",
                    "cm_linkman_approval_status":"3"
                }
            ],
            "deliverys": [
            {
                "cm_delivery_main": "1",
                "cm_delivery_name": "张三",
                "cm_delivery_tel": "52365895",
                "cm_delivery_phone": "13052125555",
                "cm_delivery_addr": "南京路XXXX号",
                "cm_delivery_province": "江苏省",
                "cm_delivery_province_code": "320000",
                "cm_delivery_city": "南京市",
                "cm_delivery_city_code": "320100",
                "cm_delivery_area": "鼓楼区",
                "cm_delivery_area_code": "320101",
                "cm_delivery_street": "鼓楼街道",
                "cm_delivery_street_code": "",
                "cm_delivery_ex1":"",
                "cm_delivery_ex2":"",
                "cm_delivery_ex3":"",
                "cm_delivery_id":"D001"
            }
           ],
            "exts": [
                {
                    "cm_ext_column": "exdf_192833",
                    "cm_ext_key": "级别",
                    "cm_ext_value": "四星"
                },
                {
                    "cm_ext_column": "exdf_985623",
                    "cm_ext_key": "主营商品",
                    "cm_ext_value": "食品,电器,日化用品"
                }
            ],
            "cm_receive_info":[
                  {
                      "cm_id": "zt001",
                      "cm_waiqin_365_id": "98000123465333545",
                      "cm_code": "zt001"
                  }
            ] 
        }
]

参数说明：

参数 类型 必填 说明
id VARCHAR(32) 否 勤策的客户唯一ID
cm_id VARCHAR(32) 否 来源于第三方系统的客户唯一ID，对应新增客户 (cm_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空
creator_waiqin_id VARCHAR(32) 否 创建人id，来源勤策员工唯一ID
creator_name VARCHAR(100) 否 创建人名称
creator_id VARCHAR(100) 否 创建人id，来源第三方系统的唯一ID
return_pool_reason VARCHAR(4000) 否 退回原因
cm_name VARCHAR(100) 是 客户名称，唯一，有效字符详见附录：有效字符说明 (opens new window)
cm_code VARCHAR(32) 是 客户编码，有效字符详见附录：有效字符说明 (opens new window)
cm_source_type VARCHAR(32) 否 客户创建方式。
cm_manager VARCHAR(4000) 否 客户经理。多客户经理名称间以“,”分隔。如：张三,李四,王五，
cm_manager_id VARCHAR(4000) 否 勤策客户经理id，多个客户经理id间以“,”分隔
cm_manager_waiqin365_id VARCHAR(4000) 否 勤策客户经理id，多个客户经理id间以“,”分隔，勤策主键，cm_manager_waiqin365_id、cm_manager_id、cm_manager如果同时存在，优先级依次降低
cm_manager_source_code VARCHAR(4000) 否 客户经理的source_code。多个以“,”分隔
cm_assistant_name VARCHAR(4000) 否 客户协助员名称。多个以“,”分隔
cm_assistant_source_code VARCHAR(4000) 否 客户协助员的source_code。多个以“,”分隔
cm_type_id VARCHAR(100) 否 客户类型唯一主键
cm_type_code VARCHAR(100) 否 客户类型编码
cm_type VARCHAR(100) 否 客户类型名称
cm_dept_id VARCHAR(100) 否 客户部门唯一主键
cm_dept_name VARCHAR(100) 否 客户部门名称
cm_dept_waiqin365_id VARCHAR(100) 否 客户部门ID，来源于勤策部门唯一ID
cm_district VARCHAR(1000) 否 客户所属销售区域，此字段为 销售区域的最末级结构
cm_district_full_path VARCHAR(1000) 否 客户销售区域全路径，此字段需要销售区域的完整层级结构，多层级间以“,”分隔。
cm_district_waiqin365_id VARCHAR(1000) 否 客户所属销售区域唯一标识，来源于勤策的客户销售区域唯一ID
cm_third_district_id VARCHAR(1000) 否 第三方销售区域id
cm_mss_province VARCHAR(32) 否 客户所属行政区域-省名称
cm_mss_province_code VARCHAR(32) 否 客户所属行政区域-省编码
cm_mss_city VARCHAR(32) 否 客户所属行政区域-市名称
cm_mss_city_code VARCHAR(32) 否 客户所属行政区域-市编码
cm_mss_area VARCHAR(32) 否 客户所属行政区域-县名称
cm_mss_area_code VARCHAR(32) 否 客户所属行政区域-县编码
cm_mss_street VARCHAR(32) 否 客户所属行政区域-乡镇/街道名称
cm_mss_street_code VARCHAR(32) 否 客户所属行政区域-乡镇/街道编码
cm_addr VARCHAR(4000) 否 客户地址
cm_cooperate_status CHAR(1) 否 合作状态。0：终止合作，1：合作中，2：未合作，3：有意向
cm_uper_customer VARCHAR(100) 否 上级客户
cm_source VARCHAR(100) 否 客户来源
cm_trade VARCHAR(100) 否 客户行业
cm_scale VARCHAR(100) 否 客户人员规模
cm_tel VARCHAR(32) 否 客户电话，如：02544550010或025-44550010
cm_fax VARCHAR(32) 否 客户传真，如：02544550010或025-44550010
cm_post VARCHAR(32) 否 客户邮编
cm_remarks VARCHAR(4000) 否 客户备注
tradingarea_big VARCHAR(100) 否 商圈等级
tradingarea VARCHAR(100) 否 商圈标签
cm_district_id VARCHAR(32) 否 勤策销售区域id。此字段从2021年8月01日起，对新创建第三方应用不再返回真实cm_district_id，使用cm_district_waiqin365_id代替cm_district_id
cm_district_code VARCHAR(32) 否 客户所属销售区域编码，来源于勤策的销售区域编码
cm_district_create_time CHAR(19) 否 销售区域创建时间。格式：yyyy-MM-dd HH:mm:ss
cm_district_modify_time CHAR(19) 否 销售区域修改时间。格式：yyyy-MM-dd HH:mm:ss
cm_district_creator_name VARCHAR(100) 否 销售区域创建人
cm_district_modifyier_name VARCHAR(100) 否 销售区域修改人
cm_district_status CHAR(1) 否 销售区域状态。1：正常，0：删除。默认值为1
cm_rel_level_id VARCHAR(100) 否 勤策客户层级id。“-1”表示是根节点
cm_label VARCHAR(4000) 否 客户分层标签名称。多分层标签名称以“,”分隔
cm_label_id VARCHAR(4000) 否 客户分层标签id。多分层标签id以“,”分隔
cm_assistant_id VARCHAR(4000) 否 客户协助员唯一标识。 多协助员唯一标识以“,”分隔，来源于勤策员工唯一标识
cm_road_msg VARCHAR(4000) 否 客户道路信息
cm_house_number VARCHAR(4000) 否 客户门牌号信息
cm_liscence_name VARCHAR(4000) 否 客户营业执照信息
cm_registration_no VARCHAR(4000) 否 客户工商注册号信息
cm_registration_date varchar(32) 否 客户注册日期。格式：yyyy-MM-dd
cm_operator VARCHAR(4000) 否 客户经营者信息
cm_sale_direct VARCHAR(1) 否 是否直接交易客户。0：是，1：否
cm_manager_code VARCHAR(4000) 否 客户经理编码，即为员工登录账号，多客户经理唯一标识间以英文“,”隔开
cm_creator_code VARCHAR(100) 否 创建人编码
cm_modifier_code VARCHAR(100) 否 修改人编码，取最新修改记录操作人
cm_modify_time VARCHAR(100) 否 修改时间。格式：yyyy-MM-dd hh:mm:ss
sales_org_id VARCHAR(100) 否 销售组织id
sales_org_name VARCHAR(100) 否 销售组织名称
linkmans List 否 客户联系人信息列表
linkmans
.cm_linkman_waiqin365_id		 VARCHAR(32) 是 客户联系人勤策Id
linkmans
.cm_linkman_name		 VARCHAR(100) 是 客户联系人名称
linkmans
.cm_linkman_job		 VARCHAR(32) 否 客户联系人职务
linkmans
.cm_linkman_mobile		 VARCHAR(32) 否 客户联系人手机
linkmans
.cm_linkman_office_tel		 VARCHAR(32) 否 客户联系人固定电话，如：02544550010或025-44550010
linkmans
.cm_linkman_fax		 VARCHAR(32) 否 客户联系人传真。如：02544550010或025-44550010
linkmans
.cm_linkman_sex		 VARCHAR(1) 否 客户联系人性别。F：女性，M：男性
linkmans
.cm_linkman_birthday		 timestamp 否 客户联系人生日
linkmans
.cm_linkman_email		 VARCHAR(100) 否 客户联系人电子邮件
linkmans
.cm_linkman_remarks		 VARCHAR(4000) 否 客户联系人备注
linkmans
.cm_linkman_main		 VARCHAR(1) 是 是否为主联系人。0：否，1：是
linkmans
.cm_linkman_qq		 VARCHAR(100) 否 客户联系人QQ
linkmans
.cm_linkman_weixin		 VARCHAR(100) 否 客户联系人微信
linkmans
.cm_linkman_dept		 VARCHAR(200) 否 客户联系人部门
linkmans
.cm_linkman_id		 VARCHAR(50) 否 客户联系人第三方id
linkmans
.cm_linkman_intimacy		 VARCHAR(50) 否 客户联系人亲密度
linkmans
.cm_linkman_importance		 VARCHAR(50) 否 客户联系人重要关系
linkmans
.cm_linkman
_decision_relationship		 VARCHAR(50) 否 客户联系人决策关系
linkmans
.cm_linkman_modify_time		 timestamp 否 客户联系人修改时间。格式：yyyy-MM-dd HH:mm:ss
linkmans
.cm_linkman_approval_status		 CHAR(1) 是 客户联系人审批状态。1：待审批，2：审批打回，3：审批通过
deliverys List 否 客户收货地址列表
deliverys
.cm_delivery_waiqin365_id		 VARCHAR(32) 否 客户收货人勤策Id
deliverys
.cm_delivery_main		 VARCHAR(1) 是 是否为默认收获地址。0：否，1：是。默认值为0
deliverys
.cm_delivery_name		 VARCHAR(32) 否 收货人名称
deliverys
.cm_delivery_tel		 VARCHAR(32) 否 收货电话
deliverys
.cm_delivery_phone		 VARCHAR(32) 否 收货手机号
deliverys
.cm_delivery_addr		 VARCHAR(32) 否 收货地址
deliverys
.cm_delivery_ex1		 VARCHAR(200) 否 收货地址扩展字段1
deliverys
.cm_delivery_ex2		 VARCHAR(200) 否 收货地址扩展字段2
deliverys
.cm_delivery_ex3		 VARCHAR(200) 否 收货地址扩展字段3
deliverys
.cm_delivery_province		 VARCHAR(32) 否 收货地址所属行政区域-省名称
deliverys
.cm_delivery_province_code		 VARCHAR(32) 否 收货地址所属行政区域-省编码
deliverys
.cm_delivery_city		 VARCHAR(32) 否 收货地址所属行政区域-市名称
deliverys
.cm_delivery_city_code		 VARCHAR(32) 否 收货地址所属行政区域-市编码
deliverys
.cm_delivery_area		 VARCHAR(32) 否 收货地址所属行政区域-区名称
deliverys
.cm_delivery_area_code		 VARCHAR(32) 否 收货地址所属行政区域-区编码
deliverys
.cm_delivery_street		 VARCHAR(32) 否 收货地址所属行政区域-街道名称
deliverys
.cm_delivery_street_code		 VARCHAR(32) 否 收货地址所属行政区域-街道编码
deliverys
.cm_delivery_id		 VARCHAR(50) 否 收货地址第三方id
exts List 否 客户自定义字段列表
exts.cm_ext_key VARCHAR(100) 是 客户信息扩展字段key值，客户信息扩展字段需先在勤策系统客户管理中创建自定义字段
exts.cm_ext_value VARCHAR(4000) 否 客户信息扩展字段value值对多个选项值，以“,”分隔拼接
cm_cooperate_status_id VARCHAR(32) 否 合作状态id
cm_level_id VARCHAR(32) 否 勤策客户等级ID
cm_approval_status char(1) 是 客户审批状态。1：待审批，2：审批打回，3：审批通过
cm_status CHAR(1) 是 客户删除状态。0：删除，1：正常
create_time CHAR(19) 是 创建日期。格式：yyyy-MM-dd HH:mm:ss
cm_receive_info List 否 客户收货方列表
cm_receive_info
.cm_id		 VARCHAR(32) 否 客户收货方唯一标识，来源于第三方系统的唯一客户标识
cm_receive_info
.cm_waiqin_365_id		 VARCHAR(32) 是 客户收货方对应的勤策的id
cm_receive_info
.cm_code		 VARCHAR(32) 是 客户收货方编码

# 客户合作状态变更

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

{
    "cm_id": "CM0001",
    "cm_cooperate_status": "0"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 否 来源于第三方系统的客户唯一ID，对应新增客户 (cm_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空
cm_waiqin365_id VARCHAR(32) 否 勤策的客户唯一ID，和来源于第三方系统客户唯一ID(cm_id)作为更新数据的唯一标识，所以不能同时为空， 如果两个值同时存在则优先顺序为cm_waiqin365_id、cm_id
cm_cooperate_status CHAR(1) 否 合作状态。0：终止合作，1：合作中，2：未合作，3：有意向
cm_cooperate_status_name VARCHAR(32) 否 合作状态：终止合作/合作中/未合作/有意向/{自定义的}， cm_cooperate_status_name、cm_cooperate_status如果同时存在优先取cm_cooperate_status

响应示例：

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

参数说明：

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

# 客户分配到员工

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

{
    "cm_id": "CM0001",
    "emp_id": " EMP0001, EMP0002, EMP0003"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 否 来源于第三方的客户唯一标识，和勤策客户唯一标识不能同时为空
cm_waiqin365_id VARCHAR(32) 否 勤策客户唯一标识，和来源于第三方的客户唯一标识不能同时为空。cm_waiqin365_id、cm_id如果同时存在优先取cm_waiqin365_id
emp_id VARCHAR(4000) 否 员工第三方唯一标识，多员工间以“,”分隔。 如：EMP0001, EMP000。emp_waiqin365_id、emp_id、emp_waiqin365_code如果同时存在，优先级依次降低
emp_waiqin365_id VARCHAR(4000) 否 员工勤策唯一标识，多员工间以“,”分隔。emp_waiqin365_id、emp_id、emp_waiqin365_code如果同时存在，优先级依次降低
emp_waiqin365_code VARCHAR(4000) 否 员工编码，多员工间以“,”分隔。emp_waiqin365_id、emp_id、emp_waiqin365_code如果同时存在，优先级依次降低

响应示例：

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

参数说明：

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

# 客户分配到部门

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

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 是 来源于第三方系统的客户唯一ID，对应新增客户 (cm_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空
org_id VARCHAR(4000) 否 部门唯一标识，多个部门间以“,”分隔。 如：ORG0001, ORG0002, ORG0003

响应示例：

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": "", 
    "response_data":null
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

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

# 变更主联系人

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

{
    "cm_id": "CM0001",
    "cm_waiqin365_id": "",
    "linkman_mobile": "12322222222",
    "is_main": "1"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 否 来源于第三方系统的客户唯一ID，对应新增客户 (cm_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空。 调用此接口时该字段值(cm_id)和勤策的客户唯一ID(cm_waiqin365_id)作为更新数据的唯一标识，所以不能同时为空， 如果两个值同时存在则优先顺序为cm_waiqin365_id、cm_id
cm_waiqin365_id VARCHAR(32) 否 勤策的客户唯一ID，和来源于第三方系统客户唯一ID(cm_id)作为更新数据的唯一标识，所以不能同时为空
linkman_mobile VARCHAR(32) 是 联系人手机号
is_main VARCHAR(32) 是 是否是主联系人。0：不是，1：是

响应示例：

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

参数说明：

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

# 修改客户关联的第三方系统客户唯一标识

通过此接口可以将第三方系统和勤策客户、门店或经销商建立映射关系。

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

{
    "cm_id": "CM0001",
    "cm_waiqin365_id": "5709132709833292684"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 否 来源于第三方系统的客户唯一ID，对应新增客户 (cm_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空。 调用此接口时该字段值(cm_id)和勤策的客户唯一ID(cm_waiqin365_id)作为更新数据的唯一标识，所以不能同时为空， 如果两个值同时存在则优先顺序为cm_waiqin365_id、cm_id
cm_waiqin365_id VARCHAR(32) 否 勤策的客户唯一ID，和来源于第三方系统客户唯一ID(cm_id)作为更新数据的唯一标识，所以不能同时为空

响应示例：

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

参数说明：

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

# 修改客户编码

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

{
    "cm_id": "CM0001",
    "cm_code": "updateCode"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 否 来源于第三方系统的客户唯一ID，对应新增客户 (cm_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空
cm_code VARCHAR(32) 是 客户编码，有效字符详见附录：有效字符说明 (opens new window)

响应示例：

{
    "return_code":"0",
    "return_msg":null,
    "msg_id":"ORG00001",
    "response_data":null
}

参数说明：

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

# 修改客户名称

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

{
   "cm_id": "5709132709833292684",
   "cm_name": "新名称"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 是 勤策的客户唯一ID
cm_name VARCHAR(32) 是 客户名称

响应示例：

{
    "return_code":"0",
    "return_msg":null,
    "msg_id":"ORG00001",
    "response_data":null
}

参数说明：

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

# 查询客户信息简化版

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

{
    "id": "7863150652620035205",
    "cm_id": "CM0001",
    "code": "suguo_fzmd"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 否 来源于第三方系统的客户唯一ID，对应新增客户 (cm_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空
id VARCHAR(32) 否 勤策的客户唯一ID，和(cm_id)、(code)不能同时为空
code VARCHAR(32) 否 客户编码，有效字符详见附录：有效字符说明 (opens new window)

响应示例：

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

数据DATA示例:

[
        {
            "id": "7863150652620035205",
            "name": "苏果夫子庙店",
            "code": "suguo_fzmd",
            "trade_type": "3",
            "source_code": "CM0001",
            "status": "1",
            "approval_status": "3"
        }
]

参数说明：

参数 类型 必填 说明
id VARCHAR(32) 是 勤策的客户唯一ID
name VARCHAR(100) 是 客户名称，唯一，有效字符详见附录：有效字符说明 (opens new window)
code VARCHAR(32) 是 客户编码，有效字符详见附录：有效字符说明 (opens new window)
trade_type VARCHAR(1) 是 客户模式。1：标准客户，2：经销商，3：终端门店
source_code VARCHAR(100) 是 来源于第三方系统的客户唯一ID，对应新增客户 (cm_id)字段，只有当数据来源于新增接口时才有值，如果数据从勤策系统中直接创建则该字段值为空
status VARCHAR(1) 是 状态。1：正常，0：已作废
approval_status VARCHAR(1) 否 审批状态。1：待审批，2：已打回，3：已通过

← 门店信息接口 →