API开放平台

TIP

产品经销权新增
产品经销权修改
产品经销权查询
产品经销权删除
查询客户对应产品组
产品经销权相关数据同步

# 产品经销权新增

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


{
  "cm_id":"",
  "cm_code": "CUS000037",
  "group_id": "",
  "group_code": "GROUP002",
  "emp_id":"",
  "emp_code":"zhangsan",
  "start_date":"",
  "end_date":"",
  "contract_date":"",
  "is_enable":"1",
  "contract_no":"HT20220801003",
  "remark":"备注",
  "source_code":"",
  "areas":[
    {
      "province":"320000",
      "city":"320100",
      "county":""
    }
  ]
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
cm_id	VARCHAR(32)	是	客户id，客户id、客户编码、客户第三方唯一标识必须传一个，如果同时存在，优先级依次递减
cm_code	VARCHAR(100)	是	客户编码，客户id、客户编码、客户第三方唯一标识必须传一个，如果同时存在，优先级依次递减
cm_source_code	VARCHAR(100)	是	客户第三方唯一标识，客户id、客户编码、客户第三方唯一标识必须传一个，如果同时存在，优先级依次递减
group_id	VARCHAR(100)	是	产品组id，产品组id、产品组编码、产品组第三方唯一标识必须传一个，如果同时存在，优先级依次递减
group_code	VARCHAR(100)	是	产品组编码，产品组id、产品组编码、产品组第三方唯一标识必须传一个，如果同时存在，优先级依次递减
group_source_code	VARCHAR(100)	是	产品组第三方唯一标识，产品组id、产品组编码、产品组第三方唯一标识必须传一个，如果同时存在，优先级依次递减
emp_id	VARCHAR(32)	否	经办人id，经办人id和经办人账号编码都不传，默认取其中一个客户经理的
emp_code	VARCHAR(100)	否	经办人账号编码，经办人id和经办人账号编码都不传，默认取其中一个客户经理的
start_date	VARCHAR(32)	否	生效日期。格式：yyyy-mm-dd
end_date	VARCHAR(32)	否	到期日期。格式：yyyy-mm-dd
contract_date	VARCHAR(32)	否	签订日期。格式：yyyy-mm-dd
is_enable	VARCHAR(100)	否	生效状态。1：生效中；0：已失效
contract_no	VARCHAR(100)	是	合同编号
remark	text	否	备注
source_code	text	否	第三方唯一标识
areas	List	是	行政区划
areas.province	VARCHAR(100)	否	省行政编码
areas.city	VARCHAR(100)	否	市行政编码
areas.county	VARCHAR(100)	否	县、区行政编码
district_id	VARCHAR(32)	是	销售区域id，多个值以“,”分隔。销售区域id、销售区域编码、销售区域名称、销售区域第三方唯一标识如果同时存在，优先级依次递减
district_code	VARCHAR(100)	是	销售区域编码，多个值以“,”分隔。销售区域id、销售区域编码、销售区域名称、销售区域第三方唯一标识如果同时存在，优先级依次递减
district_name	VARCHAR(100)	是	销售区域名称，多个值以“,”分隔。销售区域id、销售区域编码、销售区域名称、销售区域第三方唯一标识如果同时存在，优先级依次递减
district_source_code	VARCHAR(100)	是	销售区域第三方唯一标识，多个值以“,”分隔。销售区域id、销售区域编码、销售区域名称、销售区域第三方唯一标识如果同时存在，优先级依次递减

响应示例：

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": "",
    "return_data": "{id:4750031022555803467}"
}

参数说明：

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

# 产品经销权修改

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


{
  "id":"4750031022555803467",
  "source_code":"",
  "cm_id":"",
  "cm_code": "CUS000037",
  "group_id": "",
  "group_code": "GROUP002",
  "emp_id":"",
  "emp_code":"zhangsan",
  "start_date":"2022-06-01",
  "end_date":"2022-12-01",
  "contract_date":"2022-08-01",
  "is_enable":"1",
  "contract_no":"HT20220801004",
  "remark":"备注",
  "areas":[
    {
      "province":"320000",
      "city":"320100",
      "county":""
    }
  ]
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
id	INT8	是	产品经销权id，产品经销权id和第三方唯一标识必须传一个，如果同时存在，优先级依次递减
source_code	text	是	第三方唯一标识，产品经销权id和第三方唯一标识必须传一个，如果同时存在，优先级依次递减
cm_id	VARCHAR(32)	是	客户id，客户id、客户编码、客户第三方唯一标识必须传一个，如果同时存在，优先级依次递减
cm_code	VARCHAR(100)	是	客户编码，客户id、客户编码、客户第三方唯一标识必须传一个，如果同时存在，优先级依次递减
cm_source_code	VARCHAR(100)	是	客户第三方唯一标识，客户id、客户编码、客户第三方唯一标识必须传一个，如果同时存在，优先级依次递减
group_id	VARCHAR(100)	是	产品组id，产品组id、产品组编码、产品组第三方唯一标识必须传一个，如果同时存在，优先级依次递减
group_code	VARCHAR(100)	是	产品组编码，产品组id、产品组编码、产品组第三方唯一标识必须传一个，如果同时存在，优先级依次递减
group_source_code	VARCHAR(100)	是	产品组第三方唯一标识，产品组id、产品组编码、产品组第三方唯一标识必须传一个，如果同时存在，优先级依次递减
emp_id	VARCHAR(32)	否	经办人id，经办人id和经办人账号编码都不传，默认取其中一个客户经理的
emp_code	VARCHAR(100)	否	经办人账号编码，经办人id和经办人账号编码都不传，默认取其中一个客户经理的
start_date	VARCHAR(32)	否	生效日期。格式：yyyy-mm-dd
end_date	VARCHAR(32)	否	到期日期。格式：yyyy-mm-dd
contract_date	VARCHAR(32)	否	签订日期。格式：yyyy-mm-dd
is_enable	VARCHAR(100)	否	生效状态。1：生效中；0：已失效。
contract_no	VARCHAR(100)	是	合同编号
remark	text	否	备注
areas	List	是	行政区划
areas.province	VARCHAR(100)	否	省行政编码
areas.city	VARCHAR(100)	否	市行政编码
areas.county	VARCHAR(100)	否	县、区行政编码
district_id	VARCHAR(32)	是	销售区域id，多个值以“,”分隔。销售区域id、销售区域编码、销售区域名称、销售区域第三方唯一标识如果同时存在，优先级依次递减
district_code	VARCHAR(100)	是	销售区域编码，多个值以“,”分隔。销售区域id、销售区域编码、销售区域名称、销售区域第三方唯一标识如果同时存在，优先级依次递减
district_name	VARCHAR(100)	是	销售区域名称，多个值以“,”分隔。销售区域id、销售区域编码、销售区域名称、销售区域第三方唯一标识如果同时存在，优先级依次递减
district_source_code	VARCHAR(100)	是	销售区域第三方唯一标识，多个值以“,”分隔。销售区域id、销售区域编码、销售区域名称、销售区域第三方唯一标识如果同时存在，优先级依次递减

响应示例：

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": "",
    "return_data": "{id:4750031022555803467}"
}

参数说明：

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

# 产品经销权查询

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

{
    "page_number": 1,
    "page_length": 1000,
    "id": "4750031022555803467",
    "status": "1",
    "after_create_date": "2017-05-01 00:00:00",
    "after_modify_date": "2017-05-31 00:00:00"
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
page_number	INT	否	页码默认1，每页默认1000条
page_length	INT	否	每页记录条数，默认最大是1000条，可以根据业务数据的大小自行优化调整
id	INT8	是	产品经销权id
status	CHAR(1)	否	记录状态。0：已删除，1：正常
source_code	text	是	第三方唯一标识
cm_id	VARCHAR(32)	是	客户id
cm_code	VARCHAR(100)	是	客户编码
cm_source_code	VARCHAR(100)	是	客户第三方唯一标识
is_enable	VARCHAR(100)	否	生效状态。1：生效中；0：已失效
contract_no	VARCHAR(100)	是	合同编号
after_create_date	TIMESTAMP	否	创建时间之后。格式：yyyy-MM-dd HH:mm:ss
after_modify_date	TIMESTAMP	否	修改时间之后。格式：yyyy-MM-dd HH:mm:ss
start_create_date	TIMESTAMP	否	创建时间开始。格式：yyyy-MM-dd
end_create_date	TIMESTAMP	否	创建时间结束。格式：yyyy-MM-dd
start_modify_date	TIMESTAMP	否	修改时间开始。格式：yyyy-MM-dd
end_modify_date	TIMESTAMP	否	修改时间结束。格式：yyyy-MM-dd

响应示例：

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

数据DATA示例:

[
  {
    "id":"4750031022555803467",
    "status":"1",
    "cm_id":"5180489366569320786",
    "cm_code":"CUS000037",
    "cm_name":"测试经销商",
    "cm_source_code":"",
    "end_date":"2022-12-01",
    "contract_date":"2022-08-01",
    "start_date":"2022-06-01",
    "contract_no":"HT20220801004",
    "emp_id":"8837676590074020139",
    "emp_code":"zhangsan",
    "emp_name":"zhangsan",
    "is_enable":"1",
    "group_id":"8046591662429639583",
    "group_code":"GROUP002",
    "group_name":"产品组002",
    "group_source_code":"",
    "remark":"备注",
    "areas":[
      {
        "city_name":"南京市",
        "province":"320000",
        "city":"320100",
        "province_name":"江苏省"
      }
    ]
  }
]

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	是	产品经销权id
status	VARCHAR(100)	否	状态。0：已删除，1：正常
source_code	text	否	第三方唯一标识
cm_id	VARCHAR(32)	否	客户id
cm_code	VARCHAR(100)	否	客户编码减
cm_source_code	VARCHAR(100)	否	客户第三方唯一标识
group_id	VARCHAR(100)	否	产品组id
group_code	VARCHAR(100)	否	产品组编码
group_name	VARCHAR(100)	否	产品组名称
group_source_code	VARCHAR(100)	否	产品组第三方唯一标识
emp_id	VARCHAR(32)	否	经办人id
emp_code	VARCHAR(100)	否	经办人账号编码
emp_name	VARCHAR(100)	否	经办人名称
start_date	VARCHAR(32)	否	生效日期。格式：yyyy-mm-dd
end_date	VARCHAR(32)	否	到期日期。格式：yyyy-mm-dd
contract_date	VARCHAR(32)	否	签订日期。格式：yyyy-mm-dd
is_enable	VARCHAR(100)	否	生效状态。1：生效中；0：已失效。默认1
contract_no	VARCHAR(100)	否	合同编号
remark	text	否	备注
areas	List	否	行政区划
areas.province	VARCHAR(100)	否	省行政编码
areas.city	VARCHAR(100)	否	市行政编码
areas.county	VARCHAR(100)	否	县、区行政编码
areas.province_name	VARCHAR(100)	否	省行政名称
areas.city_name	VARCHAR(100)	否	市行政名称
areas.county_name	VARCHAR(100)	否	县、区行政名称
districts	List	否	销售区域
districts.id	VARCHAR(32)	否	销售区域id
districts.code	VARCHAR(100)	否	销售区域编码
districts.name	VARCHAR(100)	否	销售区域名称
districts.source_code	VARCHAR(100)	否	销售区域第三方唯一标识

# 产品经销权删除

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

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
id	INT8	是	产品经销权id，产品经销权id和第三方唯一标识必须传一个，如果同时存在，优先级依次递减
source_code	text	是	第三方唯一标识，产品经销权id和第三方唯一标识必须传一个，如果同时存在，优先级依次递减

响应示例：

{
    "msg_id": "PRD00001",
    "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/product/distribution/v1/queryProductGroupByCm/{openid}/{timestamp}/{digest}/{msg_id} 在线调试
请求示例：

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
cm_id	VARCHAR(32)	是	客户id，客户id、客户编码、客户第三方唯一标识必须传一个，如果同时存在，优先级依次递减
cm_code	VARCHAR(100)	是	客户编码，客户id、客户编码、客户第三方唯一标识必须传一个，如果同时存在，优先级依次递减
cm_source_code	VARCHAR(100)	是	客户第三方唯一标识，客户id、客户编码、客户第三方唯一标识必须传一个，如果同时存在，优先级依次递减

响应示例：

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

数据DATA示例:

[
  {
    "id":"8046591662429639583",
    "code":"GROUP002",
    "name":"产品组002"
  }
]

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	是	产品组ID
code	VARCHAR(100)	是	产品组编码
name	VARCHAR(100)	是	产品组名称

# 产品经销权相关数据同步

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求示例：

{
  "id":"4750031022555803467",
  "status":"1",
  "cm_id":"5180489366569320786",
  "cm_code":"CUS000037",
  "cm_name":"测试经销商",
  "cm_source_code":"",
  "end_date":"2022-12-01",
  "contract_date":"2022-08-01",
  "start_date":"2022-06-01",
  "contract_no":"HT20220801004",
  "emp_id":"8837676590074020139",
  "emp_code":"zhangsan",
  "emp_name":"zhangsan",
  "is_enable":"1",
  "group_id":"8046591662429639583",
  "group_code":"GROUP002",
  "group_name":"产品组002",
  "group_source_code":"",
  "remark":"备注",
  "areas":[
    {
      "city_name":"南京市",
      "province":"320000",
      "city":"320100",
      "province_name":"江苏省"
    }
  ]
}

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	是	产品经销权id
status	VARCHAR(100)	否	状态。0：已删除，1：正常
source_code	text	是	第三方唯一标识
cm_id	VARCHAR(32)	是	客户id
cm_code	VARCHAR(100)	是	客户编码减
cm_source_code	VARCHAR(100)	是	客户第三方唯一标识
group_id	VARCHAR(100)	是	产品组id
group_code	VARCHAR(100)	是	产品组编码
group_name	VARCHAR(100)	是	产品组名称
group_source_code	VARCHAR(100)	是	产品组第三方唯一标识
emp_id	VARCHAR(32)	否	经办人id
emp_code	VARCHAR(100)	否	经办人账号编码
emp_name	VARCHAR(100)	否	经办人名称
start_date	VARCHAR(32)	否	生效日期。格式：yyyy-mm-dd
end_date	VARCHAR(32)	否	到期日期。格式：yyyy-mm-dd
contract_date	VARCHAR(32)	否	签订日期。格式：yyyy-mm-dd
is_enable	VARCHAR(100)	否	生效状态。1：生效中；0：已失效
contract_no	VARCHAR(100)	是	合同编号
remark	text	否	备注
areas	List	是	行政区划
areas.province	VARCHAR(100)	否	省行政编码
areas.city	VARCHAR(100)	否	市行政编码
areas.county	VARCHAR(100)	否	县、区行政编码
areas.province_name	VARCHAR(100)	否	省行政名称
areas.city_name	VARCHAR(100)	否	市行政名称
areas.county_name	VARCHAR(100)	否	县、区行政名称
districts	List	否	销售区域
districts.id	VARCHAR(32)	否	销售区域id
districts.code	VARCHAR(100)	否	销售区域编码
districts.name	VARCHAR(100)	否	销售区域名称
districts.source_code	VARCHAR(100)	否	销售区域第三方唯一标识

响应示例：

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

响应信息

参数	说明
return_code	响应编码
return_msg	响应消息内容
msg_id	消息ID

← 产品组接口竞品信息接口 →