# 门店接口
# 新增门店
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/store/v1/addStore/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
store_id | VARCHAR(32) | 是 | 来源于第三方系统的门店唯一ID |
store_name | VARCHAR(100) | 是 | 门店名称,唯一,有效字符详见附录:有效字符说明 (opens new window) |
store_code | VARCHAR(32) | 是 | 门店编码,唯一,有效字符详见附录:有效字符说明 (opens new window) |
store_manager_id | VARCHAR(4000) | 否 | 门店客户经理唯一标识,多客户经理唯一标识间以“,”分隔。来源于第三方系统的员工唯一标识和员工信息中emp_id对应。 如:EMP0001, EMP0002, EMP0003 |
store_emp_code | VARCHAR(32) | 否 | 客户经理code(即为员工登录账号),多客户经理唯一标识间以“,”分隔。 |
store_org_code | VARCHAR(32) | 否 | 门店所属部门code |
store_manager_waiqin365_id | VARCHAR(4000) | 否 | 门店客户经理唯一标识,多客户经理唯一标识间以“,”分隔。 勤策唯一主键。store_manager_waiqin365_id、store_manager_id、store_manager如果同时存在优先取store_manager_waiqin365_id |
store_manager | VARCHAR(4000) | 否 | 门店客户经理名称。多客户经理名称间以“,”分隔,如:张三,李四,王五。store_manager、store_manager_id如果同时存在优先取store_manager_id |
dealer_name | VARCHAR(4000) | 否 | 所属的经销商名称,多个经销商以英文逗号分隔“,”,如:经销商1,经销商2。dealer_name、dealer_id如果同时存在优先取dealer_id |
dealer_id | VARCHAR(4000) | 否 | 所属经销商唯一标识,来源于第三方系统的经销商唯一标识。多个经销商以英文逗号“,”分隔。如:JSX0001,JSX0002 |
autarky_name | VARCHAR(4000) | 否 | 自营经销商名称,多个自营经销商以英文逗号分隔“,”,如:自营经销商1,自营经销商2。autarky_name、autarky_id如果同时存在优先取autarky_id |
autarky_id | VARCHAR(4000) | 否 | 自营经销商唯一标识,来源于第三方系统的自营经销商唯一标识。多个自营经销商以英文逗号“,”分隔。如:ZYJSX0001,ZYJSX0002 |
store_type_code | VARCHAR(100) | 否 | 门店类型编码 |
store_type | VARCHAR(100) | 否 | 门店类型名称,store_type,store_type_code如果同时存在优先取store_type_code |
store_district_waiqin365_id | VARCHAR(32) | 否 | 门店所属销售区域ID,来源于勤策的销售区域唯一ID |
store_third_district_id | VARCHAR(32) | 否 | 第三方销售区域ID,来源于第三方系统的唯一销售区域标识 |
store_district_code | VARCHAR(32) | 否 | 门店所属销售区域编码,来源于勤策的销售区域编码。如果store_district_waiqin365_id 、store_third_district_id 、store_district_code 同时存在,依展示顺序优先取作为对应销售区域 |
store_sales_org | VARCHAR(32) | 否 | 销售组织(id或名称) |
store_district | VARCHAR(1000) | 否 | 门店所属销售区域,此字段需要销售区域的完整层级结构, 多层级间以“,”分隔,如:华中大区,南京分区,秦淮社区。store_district、store_district_waiqin365_id如果同时存在优先取store_district_waiqin365_id。 此字段从2022年01月01日起废弃,使用 store_district_waiqin365_id 、store_third_district_id 替代,新增或修改销售区域时直接使用销售区域管理接口 |
store_dept_waiqin365_id | VARCHAR(32) | 否 | 门店所属部门ID,来源于勤策部门唯一ID |
store_dept_id | VARCHAR(32) | 否 | 门店所属部门唯一标识,来源于第三方系统的部门唯一标识和部门信息中org_id对应,store_dept_id、store_dept_waiqin365_id如果同时存在优先取store_dept_waiqin365_id |
store_mss_province | VARCHAR(32) | 否 | 门店所属行政区域-省名称,如是直辖市,省和市请传一样的值 |
store_mss_city | VARCHAR(32) | 否 | 门店所属行政区域-市名称,如是直辖市,省和市请传一样的值 |
store_mss_area | VARCHAR(32) | 否 | 门店所属行政区域-县名称,如是直筒子市,市和县请传一样的值 |
store_mss_street | VARCHAR(100) | 否 | 门店所属行政区域-乡镇街道名称 |
store_addr | VARCHAR(4000) | 否 | 门店地址 |
store_cooperate_status | CHAR(1) | 否 | 合作状态编码。0:终止合作,1:合作中,2:未合作,3:有意向 |
store_cooperate_status_name | VARCHAR(32) | 否 | 合作状态: 终止合作/合作中/未合作/有意向/{自定义的},store_cooperate_status_name、store_cooperate_status如果同时存在优先取store_cooperate_status |
store_ka_sys | VARCHAR(100) | 否 | 连锁品牌 |
store_level | VARCHAR(100) | 否 | 门店级别 |
store_tel | VARCHAR(32) | 否 | 门店电话, 如:02544550010或025-44550010 |
store_fax | VARCHAR(32) | 否 | 门店传真, 如:02544550010或025-44550010 |
store_post | VARCHAR(32) | 否 | 门店邮编 |
store_remarks | VARCHAR(4000) | 否 | 门店备注 |
store_residents_id | VARCHAR(4000) | 否 | 门店驻店人员唯一标识。多驻店人员唯一标识以“,”分隔 |
store_residents | VARCHAR(4000) | 否 | 门店驻店人员名称。多驻店人员以“,”分隔 |
store_label | VARCHAR(4000) | 否 | 门店标签名称。多标签以“,”分隔 |
store_assistant_id | VARCHAR(4000) | 否 | 门店协助员唯一标识。多协助员唯一标识以“,”分隔,来源于第三方系统的员工唯一标识。store_assistant_id、store_assistant_name如果同时存在优先取store_assistant_id |
store_assistant_name | VARCHAR(4000) | 否 | 门店协助员名称。多协助员名称以“,”分隔 |
store_road_msg | VARCHAR(4000) | 否 | 门店道路信息 |
store_pictures | VARCHAR(4000) | 否 | 门店门头照,图片下载url |
store_house_number | VARCHAR(4000) | 否 | 门店门牌号信息 |
store_liscence | VARCHAR(4000) | 否 | 门店营业执照,传图片下载url;传多个url时,以“,”分隔拼接 |
store_liscence_name | VARCHAR(4000) | 否 | 门店营业执照信息 |
store_registration_no | VARCHAR(4000) | 否 | 门店工商注册号信息 |
store_registration_date | VARCHAR(32) | 否 | 门店注册日期。格式:yyyy-MM-dd |
store_operator | VARCHAR(4000) | 否 | 门店经营者信息 |
store_sale_direct | VARCHAR(1) | 否 | 是否直接交易客户。只能填写“是”、“否” |
store_city_id_code | VARCHAR(32) | 否 | 所在城市编码。所在城市配置手动维护时生效,对应省市区码。 |
store_city_id_mame | VARCHAR(100) | 否 | 所在城市名称。所在城市配置手动维护时生效,对应省市区名称(store_city_id_code存在则以该字段为准) |
store_location | VARCHAR(100) | 否 | 门店纬经度。坐标格式为"纬度,经度",如:28.153774,112.986099 |
store_linkman_full_sync | VARCHAR(1) | 否 | 门店联系人全量同步标识,需要使用,传1,将以接口中数据覆盖系统中数据;如无需使用,不传任何值 |
store_delivery_full_sync | VARCHAR(1) | 否 | 门店收货地址全量同步标识,需要使用,传1,将以接口中数据覆盖系统中数据;如无需使用,不传任何值 |
store_selling_area | VARCHAR(10) | 否 | 门店营业面积 |
store_cashiers_num | VARCHAR(10) | 否 | 门店收银台个数 |
store_shelf_num | VARCHAR(10) | 否 | 门店货架组数 |
store_total_num | VARCHAR(10) | 否 | 门店总排面数 |
store_self_product_num | VARCHAR(10) | 否 | 门店本品排面数 |
store_open_time | timestamp | 否 | 门店营业开始时间 |
store_close_time | timestamp | 否 | 门店营业结束时间 |
linkmans | List | 否 | 门店联系人列表 |
linkmans .store_linkman_name | VARCHAR(100) | 否 | 门店联系人名称 |
linkmans .store_linkman_job | VARCHAR(32) | 否 | 门店联系人职务 |
linkmans .store_linkman_mobile | VARCHAR(32) | 否 | 门店联系人手机 |
linkmans .store_linkman_office_tel | VARCHAR(32) | 否 | 门店联系人固定电话,如:02544550010或025-44550010 |
linkmans .store_linkman_fax | VARCHAR(32) | 否 | 门店联系人传真, 如:02544550010或025-44550010 |
linkmans .store_linkman_sex | VARCHAR(1) | 否 | 门店联系人性别。F:女性,M:男性。默认值为M |
linkmans .store_linkman_birthday | timestamp | 否 | 门店联系人生日 |
linkmans .store_linkman_email | VARCHAR(100) | 否 | 门店联系人电子邮件 |
linkmans .store_linkman_remarks | VARCHAR(4000) | 否 | 门店联系人备注 |
linkmans .store_linkman_main | VARCHAR(1) | 否 | 是否为主联系人。0:否,1:是。默认值为0 |
linkmans .store_linkman_qq | VARCHAR(100) | 否 | 门店联系人qq |
linkmans .store_linkman_weixin | VARCHAR(100) | 否 | 门店联系人微信 |
linkmans .store_linkman_dept | VARCHAR(200) | 否 | 门店联系人部门 |
linkmans .store_linkman_intimacy | VARCHAR(50) | 否 | 门店联系人亲密度 |
linkmans .store_linkman_importance | VARCHAR(50) | 否 | 门店联系人重要关系 |
linkmans .store_linkman _decision_relationship | VARCHAR(50) | 否 | 门店联系人决策关系 |
linkmans .store_linkman_id | VARCHAR(100) | 否 | 门店联系人第三方id,来源于第三方唯一标识,校验唯一性 |
exts | List | 否 | 门店信息扩展字段列表 |
exts.store_ext_key | VARCHAR(100) | 否 | 门店扩展字段key值, 门店扩展字段需先在我方系统门店管理中创建 |
exts.store_ext_value | VARCHAR(4000) | 否 | 门店扩展字段value值对多个选项值,以“,”分隔拼接 |
deliverys | List | 否 | 门店收货地址列表 |
deliverys .store_delivery_main | VARCHAR(1) | 否 | 门店收获地址是否为默认收获地址可选值。0:否,1:是。当存在门店收货人信息时,此字段默认为“0” |
deliverys .store_delivery_name | VARCHAR(32) | 否 | 收货人名称 |
deliverys .store_delivery_tel | VARCHAR(32) | 否 | 收货电话 |
deliverys .store_delivery_phone | VARCHAR(32) | 否 | 收货手机号 |
deliverys .store_delivery_addr | VARCHAR(4000) | 否 | 收货地址 |
deliverys .store_delivery_ex1 | VARCHAR(200) | 否 | 收货地址扩展字段1 |
deliverys .store_delivery_ex2 | VARCHAR(200) | 否 | 收货地址扩展字段2 |
deliverys .store_delivery_ex3 | VARCHAR(200) | 否 | 收货地址扩展字段3 |
deliverys .store_delivery_id | VARCHAR(100) | 否 | 收货地址第三方唯一标识,校验唯一性 |
cm_receive_info | List | 否 | 门店收货方列表 |
store_receive_info .store_id | VARCHAR(32) | 否 | 门店收货方唯一标识,来源于第三方系统的唯一客户标识,store_waiqin_365_id、store_id、store_code如果同时存在,优先级依次降低 |
store_receive_info .store_waiqin_365_id | VARCHAR(32) | 否 | 门店收货方对应的勤策的id,store_waiqin_365_id、store_id、store_code如果同时存在,优先级依次降低 |
store_receive_info .store_code | VARCHAR(32) | 否 | 门店收货方编码,store_waiqin_365_id、store_id、store_code如果同时存在,优先级依次降低 |
响应示例:
{
"return_code": 0,
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"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/store/v1/modifyStore/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
store_waiqin_id | VARCHAR(32) | 否 | 勤策的门店唯一ID,和来源于第三方系统门店唯一ID(store_id )作为更新数据的唯一标识,所以不能同时为空 |
store_id | VARCHAR(32) | 否 | 来源于第三方系统的门店唯一ID,对应新增门店 (store_id )字段,只有当数据来源于新增接口时才有值,如果数据从勤策系统中直接创建则该字段值为空。后续可调用此接口去更新该字段值。 调用此接口时该字段值(store_id )和勤策的门店唯一ID(store_waiqin_id )作为更新数据的唯一标识,所以不能同时为空, 如果两个值同时存在则优先顺序为store_waiqin_id 、store_id |
store_name | VARCHAR(100) | 是 | 门店名称,唯一,有效字符详见附录:有效字符说明 (opens new window) |
store_code | VARCHAR(32) | 否 | 门店编码,有效字符详见附录:有效字符说明 (opens new window) |
store_manager_id | VARCHAR(4000) | 否 | 门店客户经理唯一标识,多客户经理唯一标识间以“,”分隔。来源于第三方系统的员工唯一标识和员工信息中emp_id对应。 如:EMP0001, EMP0002, EMP0003 |
store_emp_code | VARCHAR(32) | 否 | 客户经理code(即为员工登录账号),多客户经理唯一标识间以“,”分隔。 |
store_org_code | VARCHAR(32) | 否 | 门店所属部门code |
store_manager_waiqin365_id | VARCHAR(4000) | 否 | 门店客户经理唯一标识,多客户经理唯一标识间以“,”分隔。 勤策唯一主键,store_manager_waiqin365_id、store_manager_id、store_manager如果同时存在,优先级依次降低 |
store_manager | VARCHAR(4000) | 否 | 门店客户经理名称。多客户经理名称间以“,”分隔,如:张三,李四,王五。store_manager_waiqin365_id、store_manager_id、store_manager如果同时存在,优先级依次降低 |
dealer_name | VARCHAR(4000) | 否 | 所属的经销商名称,多个经销商以英文逗号分隔“,”,如:经销商1,经销商2。dealer_name、dealer_id如果同时存在,优先级依次降低 |
dealer_id | VARCHAR(4000) | 否 | 所属经销商唯一标识,来源于第三方系统的经销商唯一标识。多个经销商以英文逗号“,”分隔。如:JSX0001,JSX0002 |
autarky_name | VARCHAR(4000) | 否 | 自营经销商名称,多个自营经销商以英文逗号分隔“,”,如:自营经销商1,自营经销商2。autarky_name、autarky_id如果同时存在优先取autarky_id |
autarky_id | VARCHAR(4000) | 否 | 自营经销商唯一标识,来源于第三方系统的自营经销商唯一标识。多个自营经销商以英文逗号“,”分隔。如:ZYJSX0001,ZYJSX0002 |
store_type_code | VARCHAR(100) | 否 | 门店类型编码 |
store_type | VARCHAR(100) | 否 | 门店类型名称,store_type、store_type_code如果同时存在优先取store_type_code |
store_district_waiqin365_id | VARCHAR(32) | 否 | 门店所属销售区域ID,来源于勤策的销售区域唯一ID |
store_third_district_id | VARCHAR(32) | 否 | 第三方销售区域ID,来源于第三方系统的唯一销售区域标识 |
store_district_code | VARCHAR(32) | 否 | 门店所属销售区域编码,来源于勤策的销售区域编码。如果store_district_waiqin365_id 、store_third_district_id 、store_district_code 同时存在,依展示顺序优先取作为对应销售区域 |
store_sales_org | VARCHAR(32) | 否 | 销售组织(id或名称) |
store_district | VARCHAR(1000) | 否 | 门店所属销售区域,此字段需要销售区域的完整层级结构, 多层级间以“,”分隔,如:华中大区,南京分区,秦淮社区。store_district、store_district_waiqin365_id如果同时存在优先取store_district_waiqin365_id 此字段从2022年01月01日起废弃,使用 store_district_waiqin365_id 、store_third_district_id 替代,新增或修改销售区域时直接使用销售区域管理接口。 |
store_dept_waiqin365_id | VARCHAR(32) | 否 | 门店所属部门ID,来源于勤策部门唯一ID |
store_dept_id | VARCHAR(32) | 否 | 门店所属部门唯一标识,来源于第三方系统的部门唯一标识和部门信息中org_id对应,store_dept_id、store_dept_waiqin365_id如果同时存在优先取store_dept_waiqin365_id |
store_mss_province | VARCHAR(32) | 否 | 门店所属行政区域-省名称,如是直辖市,省和市请传一样的值 |
store_mss_city | VARCHAR(32) | 否 | 门店所属行政区域-市名称,如是直辖市,省和市请传一样的值 |
store_mss_area | VARCHAR(32) | 否 | 门店所属行政区域-县名称,如是直筒子市,市和县请传一样的值 |
store_mss_street | VARCHAR(32) | 否 | 门店所属行政区域-乡镇街道名称 |
store_addr | VARCHAR(4000) | 否 | 门店地址 |
store_cooperate_status | CHAR(1) | 否 | 合作状态编码。0:终止合作,1:合作中,2:未合作,3:有意向 |
store_cooperate_status_name | VARCHAR(32) | 否 | 合作状态:终止合作/合作中/未合作/有意向/{自定义的},store_cooperate_status_name、store_cooperate_status如果同时存在优先取store_cooperate_status |
store_ka_sys | VARCHAR(100) | 否 | 连锁品牌 |
store_level | VARCHAR(100) | 否 | 门店级别 |
store_tel | VARCHAR(32) | 否 | 门店电话, 如:02544550010或025-44550010 |
store_fax | VARCHAR(32) | 否 | 门店传真, 如:02544550010或025-44550010 |
store_post | VARCHAR(32) | 否 | 门店邮编 |
store_remarks | VARCHAR(4000) | 否 | 门店备注 |
store_residents_id | VARCHAR(4000) | 否 | 门店驻店人员唯一标识。多驻店人员唯一标识以“,”分隔 |
store_residents | VARCHAR(4000) | 否 | 门店驻店人员名称。多驻店人员以“,”分隔 |
store_label | VARCHAR(4000) | 否 | 门店标签名称。多标签以“,”分隔 |
store_assistant_id | VARCHAR(4000) | 否 | 门店协助员唯一标识。多协助员唯一标识以“,”分隔,来源于第三方系统的员工唯一标识。store_assistant_id、store_assistant_name如果同时存在优先取store_assistant_id |
store_assistant_name | VARCHAR(4000) | 否 | 门店协助员名称。多协助员名称以“,”分隔 |
store_road_msg | VARCHAR(4000) | 否 | 门店道路信息 |
store_pictures | VARCHAR(4000) | 否 | 门店门头照,图片下载url |
store_house_number | VARCHAR(4000) | 否 | 门店门牌号信息 |
store_liscence | VARCHAR(4000) | 否 | 门店营业执照,传图片下载url;传多个url时,以“,”分隔拼接 |
store_liscence_name | VARCHAR(4000) | 否 | 门店营业执照信息 |
store_registration_no | VARCHAR(4000) | 否 | 门店工商注册号信息 |
store_registration_date | timestamp | 否 | 门店注册日期。格式:yyyy-MM-dd |
store_operator | VARCHAR(4000) | 否 | 门店经营者信息 |
store_sale_direct | VARCHAR(1) | 否 | 是否直接交易客户。只能填写“是”、“否” |
store_city_id_code | VARCHAR(32) | 否 | 所在城市编码。所在城市配置手动维护时生效,对应省市区码。 |
store_city_id_mame | VARCHAR(100) | 否 | 所在城市名称。所在城市配置手动维护时生效,对应省市区名称(store_city_id_code存在则以该字段为准) |
store_linkman_full_sync | VARCHAR(1) | 否 | 门店联系人全量同步标识,需要使用,传1,将以接口中数据覆盖系统中数据;如无需使用,不传任何值 |
store_delivery_full_sync | VARCHAR(1) | 否 | 门店收货地址全量同步标识,需要使用,传1,将以接口中数据覆盖系统中数据;如无需使用,不传任何值 |
store_selling_area | VARCHAR(10) | 否 | 门店营业面积 |
store_cashiers_num | VARCHAR(10) | 否 | 门店收银台个数 |
store_shelf_num | VARCHAR(10) | 否 | 门店货架组数 |
store_total_num | VARCHAR(10) | 否 | 门店总排面数 |
store_self_product_num | VARCHAR(10) | 否 | 门店本品排面数 |
store_open_time | timestamp | 否 | 门店营业开始时间。格式:yyyy-MM-dd HH:mm:ss |
store_close_time | timestamp | 否 | 门店营业结束时间。格式:yyyy-MM-dd HH:mm:ss |
store_location | VARCHAR(100) | 否 | 门店纬经度。坐标格式为"纬度,经度",如:28.153774,112.986099 |
store_delivery_addr | VARCHAR(200) | 否 | 收货地址 |
linkmans | List | 否 | 门店联系人列表 |
linkmans .store_linkman_name | VARCHAR(100) | 否 | 门店联系人名称 |
linkmans .store_linkman_job | VARCHAR(32) | 否 | 门店联系人职务 |
linkmans .store_linkman_mobile | VARCHAR(32) | 否 | 门店联系人手机 |
linkmans .store_linkman_office_tel | VARCHAR(32) | 否 | 门店联系人固定电话,如:02544550010或025-44550010 |
linkmans .store_linkman_fax | VARCHAR(32) | 否 | 门店联系人传真,如:02544550010或025-44550010 |
linkmans .store_linkman_sex | VARCHAR(1) | 否 | 门店联系人性别。F:女性,M:男性,默认值为M |
linkmans .store_linkman_birthday | timestamp | 否 | 门店联系人生日 |
linkmans .store_linkman_email | VARCHAR(100) | 否 | 门店联系人电子邮件 |
linkmans .store_linkman_remarks | VARCHAR(4000) | 否 | 门店联系人备注 |
linkmans .store_linkman_main | VARCHAR(1) | 否 | 是否为主联系人。0:否,1:是。默认值为0 |
linkmans .store_linkman_qq | VARCHAR(100) | 否 | 门店联系人qq |
linkmans .store_linkman_weixin | VARCHAR(100) | 否 | 门店联系人微信 |
linkmans .store_linkman_dept | VARCHAR(200) | 否 | 门店联系人部门 |
linkmans .store_linkman_intimacy | VARCHAR(50) | 否 | 门店联系人亲密度 |
linkmans .store_linkman_importance | VARCHAR(50) | 否 | 门店联系人重要关系 |
linkmans .store_linkman _decision_relationship | VARCHAR(50) | 否 | 门店联系人决策关系 |
linkmans .store_linkman_id | VARCHAR(100) | 否 | 门店联系人第三方id,来源于第三方唯一标识,校验唯一性 |
exts | List | 否 | 门店信息扩展字段列表 |
exts.store_ext_key | VARCHAR(100) | 否 | 门店扩展字段key值, 门店扩展字段需先在我方系统门店管理中创建 |
exts.store_ext_value | VARCHAR(4000) | 否 | 门店扩展字段value值对多个选项值,以“,”分隔拼接 |
deliverys | List | 否 | 门店收货地址列表 |
deliverys .store_delivery_main | VARCHAR(1) | 否 | 是否为默认收获地址。0:否,1:是。默认值为0 |
deliverys .store_delivery_name | VARCHAR(32) | 否 | 收货人名称 |
deliverys .store_delivery_tel | VARCHAR(32) | 否 | 收货电话 |
deliverys .store_delivery_phone | VARCHAR(32) | 否 | 收货手机号 |
deliverys .store_delivery_addr | VARCHAR(200) | 否 | 收货地址 |
deliverys .store_delivery_ex1 | VARCHAR(200) | 否 | 收货地址扩展字段1 |
deliverys .store_delivery_ex2 | VARCHAR(200) | 否 | 收货地址扩展字段2 |
deliverys .store_delivery_ex3 | VARCHAR(200) | 否 | 收货地址扩展字段3 |
deliverys .store_delivery_id | VARCHAR(100) | 否 | 收货地址第三方唯一标识,校验唯一性 |
cm_receive_info | List | 否 | 门店收货方列表 |
store_receive_info .store_id | VARCHAR(32) | 否 | 门店收货方唯一标识,来源于第三方系统的唯一客户标识,store_waiqin_365_id、store_id、store_code如果同时存在,优先级依次降低 |
store_receive_info .store_waiqin_365_id | VARCHAR(32) | 否 | 门店收货方对应的勤策的id,store_waiqin_365_id、store_id、store_code如果同时存在,优先级依次降低 |
store_receive_info .store_code | VARCHAR(32) | 否 | 门店收货方编码,store_waiqin_365_id、store_id、store_code`如果同时存在,优先级依次降低 |
响应示例:
{
"return_code": 0,
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"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/store/v1/removeStore/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
store_id | VARCHAR(32) | 是 | 来源于第三方系统的门店唯一ID,对应新增门店 (store_id )字段,只有当数据来源于新增接口时才有值,如果数据从勤策系统中直接创建则该字段值为空 |
store_waiqin_id | VARCHAR(32) | 是 | 否 |
响应示例:
{
"return_code": 0,
"msg_id": "{ msg_id }"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
# 恢复已作废门店
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/store/v1/recoverStore/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
store_id | VARCHAR(32) | 否 | 来源于第三方的客户唯一标识,和勤策的客户唯一标识不能同时为空 |
store_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 | 响应数据 |
# 查询门店
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/store/v1/queryStore/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
page_number | INT | 否 | 分页页码,默认1 |
status | CHAR(1) | 否 | 记录状态。0:已删除,1:正常 |
id | VARCHAR(32) | 否 | 勤策的门店唯一ID |
store_id | VARCHAR(32) | 否 | 来源于第三方系统的门店唯一ID,对应新增门店 (store_id )字段,只有当数据来源于新增接口时才有值,如果数据从勤策系统中直接创建则该字段值为空。 如果两个值同时存在则优先顺序为store_waiqin_id 、store_id |
store_name | VARCHAR(100) | 否 | 门店名称,唯一,有效字符详见附录:有效字符说明 (opens new window) |
store_code | VARCHAR(32) | 否 | 门店编码,有效字符详见附录:有效字符说明 (opens new window) |
store_manager_id | VARCHAR(4000) | 否 | 根据门店客户经理标识查询 |
store_type_code | VARCHAR(100) | 否 | 门店类型编码,store_type、store_type_code如果同时存在优先取store_type_code |
store_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 |
store_district | VARCHAR(1000) | 否 | 门店所属销售区域,此字段需要销售区域的完整层级结构, 多层级间以“,”分隔,如:华中大区,南京分区,秦淮社区 |
store_dept_code | VARCHAR(1000) | 否 | 门店所属部门code,多个数值间用英文“,”隔开 |
store_level | VARCHAR(1000) | 否 | 门店级别,多个数值间用英文“,”隔开 |
store_district_code | VARCHAR(1000) | 否 | 销售区域编码,非全路径编码,多个数值间用英文“,”隔开 |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"id": 6572271053202767748,
"store_id": "CM0001",
"creator_waiqin_id": "8830671133213284556",
"creator_name": "丁金金",
"creator_id": "5956995671401092891",
"return_pool_reason": "打回测试",
"store_code": "TEST00001",
"store_name": "测试客户",
"store_type": "终端门店",
"store_type_code": "001",
"store_manager": "张三,李四",
"store_manager_waiqin365_id": "6907820106019252086,5597071445856845986",
"store_dept_name": "销售部",
"store_dept_waiqin365_id": "9121587515174713166",
"store_dept_id": "",
"store_photo": "cm/photo/c2a39abc769a49ca9f49221336d30f7e.jpg",
"store_district": "测试区域",
"store_district_full_path": "全部,江苏,南京,测试区域",
"store_level": "金牌客户",
"store_level_id": "5632595796469497568",
"store_tel": "025-88999988",
"store_fax": "025-88999987",
"store_ka_sys": "苏果超市",
"store_addr": "南京市建邺区嘉陵江东街50号",
"store_delivery_addr": "",
"store_mss_area": "鼓楼区",
"store_mss_area_code": "320106",
"store_mss_city": "南京市",
"store_mss_city_code": "320100",
"store_mss_province": "江苏省",
"store_mss_province_code": "320000",
"tradingarea": "新街口",
"tradingarea_big": "核心城区",
"store_status": "1",
"create_time": "2018-05-18 14:39:12",
"store_approval_status": "3",
"store_cooperate_status": "1",
"store_cooperate_status_id": "2",
"store_remarks": "",
"store_post": "",
"store_district_id":"6081235751236711020",
"store_district_waiqin365_id":"6081235751236765420",
"store_third_district_id":"6081235751236711123",
"store_district_code":"code01",
"store_district_create_time":"2017-09-09 13:14:11",
"store_district_modify_time":"2017-10-09 23:14:11",
"store_district_creator_name":"张三",
"store_district_modifyier_name":"李四",
"store_district_status":"1",
"store_type_id":"4803341355190322405",
"store_rel_level_id":"5669281775545680668",
"store_mss_street":"华侨路街道",
"store_mss_street_code":"320106002",
"store_label":"标签1,标签2",
"store_label_id":"7669281775545680666,2369281775545680667",
"store_assistant_id":"8776918981000102550,6831633994841635708",
"store_assistant_name":"张三,李四",
"store_road_msg": "道路信息",
"store_house_number": "门牌号信息",
"store_liscence_name": "营业执照信息",
"store_registration_no": "工商注册号信息",
"store_registration_date": "2019-10-21",
"store_operator": "经营者信息",
"store_sale_direct": "是",
"store_modify_time": "2019-10-21 17:20:36",
"store_modifyier_name": "张三",
"store_create_approval_time": "2019-10-21 17:20:36",
"store_modify_approval_time": "2019-10-21 20:20:36",
"store_source_type": "自建",
"store_creator_code": "EMP001",
"store_modifier_code": "EMP002",
"store_manager_code": "EMP003",
"sales_org_id" : "",
"sales_org_name" : "销售组织名称",
"dealers": [
{
"dealer_name": "经销商1",
"waiqin365_dealer_order": "1" ,
"waiqin365_dealer_id": "6054085002157264655" ,
"dealer_id": ""
},
{
"dealer_name": "经销商2",
"waiqin365_dealer_order": "2" ,
"waiqin365_dealer_id": "6054085002157264656" ,
"dealer_id": ""
}
],
"autarky": [
{
"autarky_dealer_name": "自营经销商1",
"autarky_waiqin365_dealer_id": "6544085442157264677" ,
"autarky_dealer_id": ""
},
{
"autarky_dealer_name": "自营经销商2",
"autarky_waiqin365_dealer_id": "606258930615121973" ,
"autarky_dealer_id": ""
}
],
"linkmans": [
{
"store_linkman_name": "张三风",
"store_linkman_job": "店主",
"store_linkman_mobile": "13052125555",
"store_linkman_office_tel": "52365895",
"store_linkman_fax": "25758545",
"store_linkman_sex": "M",
"store_linkman_birthday": "1980-02-06",
"store_linkman_email": "abc@163.com",
"store_linkman_remarks": "",
"store_linkman_main": "1",
"store_linkman_qq": "qq",
"store_linkman_weixin": "weixin",
"store_linkman_dept": "部门",
"store_linkman_id": "L001",
"store_linkman_intimacy":"一星",
"store_linkman_importance":"重要",
"store_linkman_decision_relationship":"决策人",
"store_linkman_approval_status": "3"
},
{
"store_linkman_name": "李四光",
"store_linkman_job": "店员",
"store_linkman_mobile": "13022215212",
"store_linkman_office_tel": "58755254",
"store_linkman_fax": "",
"store_linkman_sex": "F",
"store_linkman_birthday": "1981-02-14",
"store_linkman_email": "",
"store_linkman_remarks": "",
"store_linkman_main": "0",
"store_linkman_qq": "qq",
"store_linkman_weixin": "weixin",
"store_linkman_dept": "部门",
"store_linkman_id": "L002",
"store_linkman_intimacy":"一星",
"store_linkman_importance":"重要",
"store_linkman_decision_relationship":"决策人",
"store_linkman_approval_status": "3"
}
],
"deliverys": [
{
"store_delivery_main": "0",
"store_delivery_name": "张三",
"store_delivery_tel": "52365895",
"store_delivery_phone": "13052125555",
"store_delivery_addr": "南京路XXXX号",
"store_delivery_province": "江苏省",
"store_delivery_province_code": "320000",
"store_delivery_city": "南京市",
"store_delivery_city_code": "320100",
"store_delivery_area": "鼓楼区",
"store_delivery_area_code": "320101",
"store_delivery_street": "鼓楼街道",
"store_delivery_street_code": "",
"store_delivery_ex1": "",
"store_delivery_ex2": "",
"store_delivery_ex3": "",
"store_delivery_id": "D001"
}
],
"exts": [
{
"store_ext_column": "exdf_988765",
"store_ext_key": "级别",
"store_ext_value": "四星"
},
{
"store_ext_column": "exdf_832623",
"store_ext_key": "主营商品",
"store_ext_value": "食品,电器,日化用品"
}
],
"store_receive_info":[
{
"store_id": "zt001",
"store_waiqin_365_id": "98000123465333545",
"store_code": "zt001"
}
]
}
]
参数说明:
参数名称 | 参数类型 | 是否必填 | 参数说明 |
---|---|---|---|
id | VARCHAR(32) | 否 | 勤策的门店唯一ID |
store_id | VARCHAR(32) | 否 | 来源于第三方系统的门店唯一ID,对应新增门店 (store_id )字段,只有当数据来源于新增接口时才有值,如果数据从勤策系统中直接创建则该字段值为空 |
creator_waiqin_id | VARCHAR(32) | 否 | 创建人id,来源勤策员工唯一ID |
creator_name | VARCHAR(100) | 否 | 创建人名称 |
creator_id | VARCHAR(100) | 否 | 创建人id,来源第三方系统的唯一ID |
return_pool_reason | VARCHAR(4000) | 否 | 退回原因 |
store_name | VARCHAR(100) | 是 | 门店名称 |
store_code | VARCHAR(32) | 是 | 门店编码 |
store_manager | VARCHAR(4000) | 否 | 门店经理。多门店经理名称间以“,”分隔。如:张三,李四,王五 |
store_manager_id | VARCHAR(4000) | 否 | 勤策门店经理id。第三方唯一标识,多门店经理id间以“,”分隔 |
store_manager_waiqin365_id | VARCHAR(4000) | 否 | 勤策门店经理id。勤策唯一标识,多门店经理id间以“,”分隔。store_manager_waiqin365_id、store_manager_id、store_manager如果同时存在,优先级依次降低 |
store_type | VARCHAR(100) | 否 | 门店类型名称 |
store_type_code | VARCHAR(100) | 否 | 门店类型编码 |
store_type_id | VARCHAR(100) | 否 | 门店类型id |
store_level_id | VARCHAR(32) | 否 | 勤策门店等级ID |
store_level | VARCHAR(32) | 否 | 门店等级名称 |
store_dept_waiqin365_id | VARCHAR(100) | 否 | 勤策门店所属部门ID |
store_dept_id | VARCHAR(100) | 否 | 门店所属部门,来源第三方系统的唯一标识和部门信息中org_id 对应 |
store_dept_name | VARCHAR(100) | 否 | 门店部门名称 |
store_district | VARCHAR(1000) | 否 | 门店所属销售区域,此字段为 销售区域的最末级结构 |
store_district_full_path | VARCHAR(1000) | 否 | 门店所属销售区域,此字段为销售区域的完整层级结构,多层级间以“,”分隔。 如:华中大区,南京分区,秦淮社区 |
store_district_waiqin365_id | VARCHAR(1000) | 否 | 门店所属销售区域ID,来源于勤策的销售区域唯一ID |
store_third_district_id | VARCHAR(1000) | 否 | 第三方销售区域id |
store_mss_province | VARCHAR(32) | 否 | 门店所属行政区域-省份名称,如:北京市、江苏省 |
store_mss_province_code | VARCHAR(32) | 否 | 门店所属行政区域-省份编码,如:110000、320000 |
store_mss_city | VARCHAR(32) | 否 | 门店所属行政区域-城市名称,如:南京市 |
store_mss_city_code | VARCHAR(32) | 否 | 门店所属行政区域-城市编码,如:320100 |
store_mss_area | VARCHAR(32) | 否 | 门店所属行政区域-区县名称,如:鼓楼区 |
store_mss_area_code | VARCHAR(32) | 否 | 门店所属行政区域-区县编码,如:320106 |
store_mss_street | VARCHAR(32) | 否 | 门店所属行政区域-乡镇街道名称,如:宁海路街道 |
store_mss_street_code | VARCHAR(32) | 否 | 门店所属行政区域-乡镇街道编码,如:320106001 |
store_addr | VARCHAR(4000) | 否 | 门店所在地址 |
store_cooperate_status_id | VARCHAR(32) | 否 | 勤策合作状态ID |
store_cooperate_status | CHAR(1) | 否 | 合作状态编码。0:终止合作,1:合作中,2:未合作,3:有意向 |
store_ka_sys | VARCHAR(100) | 否 | 门店所属连锁品牌 |
store_tel | VARCHAR(32) | 否 | 门店电话,如:02544550010或025-44550010 |
store_fax | VARCHAR(32) | 否 | 门店传真,如:02544550010或025-44550010 |
store_post | VARCHAR(32) | 否 | 门店邮编 |
store_remarks | VARCHAR(4000) | 否 | 门店备注 |
tradingarea_big | VARCHAR(100) | 否 | 商圈等级 |
tradingarea | VARCHAR(100) | 否 | 商圈标签 |
tradingarea_level_code | VARCHAR(100) | 否 | 商圈等级编码 |
tradingarea_level_name | VARCHAR(100) | 否 | 商圈等级名称 |
store_district_id | VARCHAR(32) | 否 | 勤策销售区域id。此字段从2021年8月01日起,对新创建第三方应用不再返回真实store_district_id,使用store_district_waiqin365_id代替store_district_id |
store_district_code | VARCHAR(32) | 否 | 门店所属销售区域编码,来源于勤策的销售区域编码。 |
store_district_create_time | CHAR(19) | 否 | 销售区域创建时间。格式:yyyy-MM-dd HH:mm:ss |
store_district_modify_time | CHAR(19) | 否 | 销售区域修改时间。格式:yyyy-MM-dd HH:mm:ss |
store_district_creator_name | VARCHAR(100) | 否 | 销售区域创建人 |
store_district_modifyier_name | VARCHAR(100) | 否 | 销售区域修改人 |
store_district_status | CHAR(1) | 否 | 销售区域状态。1:正常,0:删除。默认值为1 |
store_rel_level_id | VARCHAR(100) | 否 | 勤策客户层级id。“-1”表示是根节点 |
store_label | VARCHAR(4000) | 否 | 门店分层标签名称。多分层标签名称以“,”分隔 |
store_label_id | VARCHAR(4000) | 否 | 门店分层标签id。多分层标签id以“,”分隔 |
store_assistant_id | VARCHAR(4000) | 否 | 门店协助员唯一标识。多协助员唯一标识以“,”分隔 |
store_assistant_name | VARCHAR(4000) | 否 | 门店协助员名称。多协助员名称以“,”分隔 |
store_road_msg | VARCHAR(4000) | 否 | 门店道路信息 |
store_house_number | VARCHAR(4000) | 否 | 门店门牌号信息 |
store_liscence_name | VARCHAR(4000) | 否 | 门店营业执照信息 |
store_registration_no | VARCHAR(4000) | 否 | 门店工商注册号信息 |
store_registration_date | VARCHAR(32) | 否 | 门店注册日期。格式:yyyy-MM-dd |
store_operator | VARCHAR(4000) | 否 | 门店经营者信息 |
store_sale_direct | VARCHAR(1) | 否 | 是否直接交易客户。0:是,1:否 |
store_modify_time | VARCHAR(4) | 否 | 门店修改时间。格式:yyyy-MM-dd HH:mm:ss |
store_modifyier_name | VARCHAR(19) | 否 | 门店修改人名称 |
store_create_approval_time | VARCHAR(32) | 否 | 新增门店最终审批通过时间。格式:yyyy-MM-dd HH:mm:ss |
store_modify_approval_time | VARCHAR(19) | 否 | 修改客户审批通过时间。格式:yyyy-MM-dd HH:mm:ss |
store_source_type | VARCHAR(32) | 否 | 创建方式 |
store_selling_area | VARCHAR(10) | 否 | 门店营业面积 |
store_cashiers_num | VARCHAR(10) | 否 | 门店收银台个数 |
store_shelf_num | VARCHAR(10) | 否 | 门店货架组数 |
store_total_num | VARCHAR(10) | 否 | 门店总排面数 |
store_self_product_num | VARCHAR(10) | 否 | 门店本品排面数 |
store_open_time | timestamp | 否 | 门店营业开始时间。格式:yyyy-MM-dd HH:mm:ss |
store_close_time | timestamp | 否 | 门店营业结束时间。格式:yyyy-MM-dd HH:mm:ss |
store_pictures | VARCHAR(4000) | 否 | 门店门头照信息,多个以“,”号隔开 |
store_liscence | VARCHAR(4000) | 否 | 门店营业执照信息,多个以“,”号隔开 |
store_manager_code | VARCHAR(4000) | 否 | 门店客户经理编码,即为员工登录账号,多客户经理唯一标识间以英文“,”隔开 |
store_creator_code | VARCHAR(100) | 否 | 创建人编码 |
store_modifier_code | VARCHAR(100) | 否 | 修改人编码,取最新修改记录操作人 |
sales_org_id | VARCHAR(100) | 否 | 销售组织id |
sales_org_name | VARCHAR(100) | 否 | 销售组织名称 |
linkmans | List | 否 | 门店联系人列表 |
linkmans .store_linkman_waiqin365_id | VARCHAR(32) | 是 | 终端门店联系人勤策Id |
linkmans .store_linkman_name | VARCHAR(100) | 是 | 门店联系人名称 |
linkmans .store_linkman_job | VARCHAR(32) | 否 | 门店联系人职务 |
linkmans .store_linkman_mobile | VARCHAR(32) | 否 | 门店联系人手机 |
linkmans .store_linkman_office_tel | VARCHAR(32) | 否 | 门店联系人固定电话, 如:02544550010或025-44550010 |
linkmans .store_linkman_fax | VARCHAR(32) | 否 | 门店联系人传真, 如:02544550010或025-44550010 |
linkmans .store_linkman_sex | VARCHAR(1) | 否 | 门店联系人性别。F:女性,M:男性。默认值为M |
linkmans .store_linkman_birthday | VARCHAR() | 否 | 门店联系人生日 |
linkmans .store_linkman_email | VARCHAR(100) | 否 | 门店联系人电子邮件 |
linkmans .store_linkman_remarks | VARCHAR(4000) | 否 | 门店联系人备注 |
linkmans .store_linkman_main | VARCHAR(1) | 是 | 是否为主联系人。0:否,1:是。默认值为0 |
linkmans .store_linkman_qq | VARCHAR(100) | 否 | 门店联系人qq |
linkmans .store_linkman_weixin | VARCHAR(100) | 否 | 门店联系人微信 |
linkmans .store_linkman_dept | VARCHAR(200) | 否 | 门店联系人部门 |
linkmans .store_linkman_id | VARCHAR(50) | 否 | 门店联系人第三方id |
linkmans .store_linkman_intimacy | VARCHAR(50) | 否 | 门店联系人亲密度 |
linkmans .store_linkman_importance | VARCHAR(50) | 否 | 门店联系人重要关系 |
linkmans .store_linkman _decision_relationship | VARCHAR(50) | 否 | 门店联系人决策关系 |
linkmans .store_linkman_modify_time | timestamp | 否 | 门店联系人修改时间。格式:yyyy-MM-dd HH:mm:ss |
linkmans .store_linkman_approval_status | CHAR(1) | 否 | 门店联系人审批状态。1:待审批,2:审批打回,3:审批通过 |
deliverys | List | 否 | 门店收货地址列表 |
deliverys .store_delivery_waiqin365_id | VARCHAR(32) | 否 | 经销商收货人勤策Id |
deliverys .store_delivery_main | VARCHAR(1) | 是 | 门店收获地址是否为默认收获地址可选值。0:否,1:是。当存在门店收货人信息时,此字段默认值为0 |
deliverys .store_delivery_name | VARCHAR(32) | 是 | 收货人名称 |
deliverys .store_delivery_tel | VARCHAR(32) | 否 | 收货电话 |
deliverys .store_delivery_phone | VARCHAR(32) | 否 | 收货手机号 |
deliverys .store_delivery_addr | VARCHAR(4000) | 否 | 收货地址 |
deliverys .store_delivery_province | VARCHAR(32) | 否 | 收货地址所属行政区域-省名称 |
deliverys .store_delivery_province_code | VARCHAR(32) | 否 | 收货地址所属行政区域-省编码 |
deliverys .store_delivery_city | VARCHAR(32) | 否 | 收货地址所属行政区域-市名称 |
deliverys .store_delivery_city_code | VARCHAR(32) | 否 | 收货地址所属行政区域-市编码 |
deliverys .store_delivery_area | VARCHAR(32) | 否 | 收货地址所属行政区域-区名称 |
deliverys .store_delivery_area_code | VARCHAR(32) | 否 | 收货地址所属行政区域-区编码 |
deliverys .store_delivery_street | VARCHAR(32) | 否 | 收货地址所属行政区域-街道名称 |
deliverys .store_delivery_street_code | VARCHAR(32) | 否 | 收货地址所属行政区域-街道编码 |
deliverys .store_delivery_ex1 | VARCHAR(200) | 否 | 收货地址扩展字段1 |
deliverys .store_delivery_ex2 | VARCHAR(200) | 否 | 收货地址扩展字段2 |
deliverys .store_delivery_ex3 | VARCHAR(200) | 否 | 收货地址扩展字段3 |
deliverys .store_delivery_id | VARCHAR(50) | 否 | 收货地址第三方id |
exts | List | 否 | 门店自定义字段列表 |
exts.store_ext_key | VARCHAR(100) | 是 | 门店扩展字段key值,门店扩展字段需先在我方系统门店管理中创建 |
exts.store_ext_value | VARCHAR(4000) | 否 | 门店扩展字段value值对多个选项值,以“,”分隔拼接 |
dealers | List | 否 | 所属经销商 |
dealers.waiqin365_dealer_order | VARCHAR(32) | 否 | 经销商排序序号 |
dealers.waiqin365_dealer_id | VARCHAR(32) | 是 | 所属的经销商勤策中唯一标识 |
dealers.dealer_id | VARCHAR(4000) | 否 | 所属经销商,来源于第三方系统的经销商唯一标识 |
dealers.dealer_name | VARCHAR(4000) | 是 | 所属的经销商名称 |
autarky | List | 否 | 自营所属经销商列表 |
autarky.autarky_dealer_name | VARCHAR(50) | 否 | 自营所属经销商名称 |
autarky.autarky_dealer_id | VARCHAR(50) | 否 | 自营经销商第三方唯一标识 |
autarky.autarky_waiqin365_dealer_id | VARCHAR(50) | 否 | 自营经销商勤策中唯一标识 |
store_approval_status | CHAR(1) | 是 | 门店审批状态。1:待审批,2:审批打回,3:审批通过 |
store_status | CHAR(1) | 是 | 门店删除状态。0:删除,1:正常 |
create_time | CHAR(19) | 是 | 创建日期。格式:yyyy-MM-dd HH:mm:ss |
store_receive_info | List | 否 | 门店收货方列表 |
store_receive_info .store_id | VARCHAR(32) | 否 | 来源于第三方系统门店收货方唯一标识 |
store_receive_info .store_waiqin_365_id | VARCHAR(32) | 是 | 门店收货方勤策的唯一ID |
store_receive_info .store_code | VARCHAR(32) | 是 | 门店编码 |
# 门店合作状态变更
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/store/v1/modifyStoreCooperateStatus/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
store_id | VARCHAR(32) | 否 | 来源于第三方系统的门店唯一ID,对应新增门店 (store_id )字段,只有当数据来源于新增接口时才有值,如果数据从勤策系统中直接创建则该字段值为空。 调用此接口时该字段值(store_id )和勤策的门店唯一ID(store_waiqin_id )作为更新数据的唯一标识,所以不能同时为空, 如果两个值同时存在则优先顺序为store_waiqin_id 、store_id |
store_waiqin365_id | VARCHAR(32) | 否 | 勤策的门店唯一ID,和来源于第三方系统门店唯一ID(store_id )作为更新数据的唯一标识,所以不能同时为空 |
store_cooperate_status | CHAR(1) | 否 | 合作状态编码。0:终止合作,1:合作中,2:未合作,3:有意向 |
store_cooperate_status_name | VARCHAR(32) | 否 | 合作状态:终止合作/合作中/未合作/有意向/{自定义的},store_cooperate_status_name、store_cooperate_status如果同时存在优先取store_cooperate_status |
响应示例:
{
"return_code": 0,
"msg_id": "{ msg_id }"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
# 门店分配到员工
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/store/v1/assignStoreToEmp/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
store_id | VARCHAR(32) | 否 | 来源于第三方系统的门店唯一ID,对应新增门店 (store_id )字段,只有当数据来源于新增接口时才有值,如果数据从勤策系统中直接创建则该字段值为空。 调用此接口时该字段值(store_id )和勤策的门店唯一ID(store_waiqin_id )作为更新数据的唯一标识,所以不能同时为空, 如果两个值同时存在则优先顺序为store_waiqin_id 、store_id |
store_waiqin365_id | VARCHAR(32) | 否 | 勤策的门店唯一ID,和来源于第三方系统门店唯一ID(store_id )作为更新数据的唯一标识,所以不能同时为空 |
emp_id | VARCHAR(4000) | 否 | 员工第三方唯一标识,多员工间以“,”分隔, 如:EMP0001, EMP0002。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如果同时存在,优先级依次降低 |
响应示例:
{
"return_code": 0,
"msg_id": "{ msg_id }"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
# 门店分配到部门
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/store/v1/assignStoreToOrg/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
store_id | VARCHAR(32) | 是 | 来源于第三方系统的门店唯一ID,对应新增门店 (store_id )字段,只有当数据来源于新增接口时才有值,如果数据从勤策系统中直接创建则该字段值为空 |
org_id | VARCHAR(4000) | 否 | 部门唯一标识,多个部门间以“,”分隔。 如:ORG0001, ORG0002, ORG0003 |
响应示例:
{
"return_code": 0,
"msg_id": "{ msg_id }"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |