# 客户经销权接口
# 新增客户经销权
接口说明: 1、通过查询对象配置 (opens new window)接口,获得对象对应的fieldList --> 字段列表结构信息 2、详细字段入参规范说明参见 附录六:aPaaS字段类型样式说明 (opens new window) 3、部分预置字段的特殊逻辑,参考 fields特殊参数说明、slave_fields.ig_payment_received_trend、slave_fields.ig_payment_received_detail特殊参数说明
请求方式: POST(HTTPS)
**请求地址:
** https://openapi.qince.com/api/cm/v1/dealershipAdd/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
fields | VARCHAR | 是 | JSON格式字符串。格式:{字段key:value}, (非特殊字段数据格式参见附录六) |
slave_fields | VARCHAR | 是 | JSON格式字符串。数据中传入id为编辑,无id为新增, 格式:{对象key:[{字段key:字段值}]}(非特殊字段数据格式参见附录六) |
is_trigger | boolean | 否 | 是否触发工作流;true:触发,false:不触发 |
trigger_employee | VARCHAR(32) | 否 | 是否触发工作流为true的时候必填,员工id |
check_rule | boolean | 否 | 是否校验验证规则和查重规则;true:校验,false:不校验 |
fields特殊参数说明:
字段名称 | 字段key | 字段类型 | 必填 | 特殊说明 |
---|---|---|---|---|
客户名称 | customer | 客户 | 是 | 系统客户模板id |
开始日期 | start_date | 金额 | 是 | 日期格式 |
结束日期 | end_date | 日期 | 是 | 日期格式 |
商品范围 | pd_range_type | 单选框 | 是 | 1:全部商品;2:部分商品 |
商品组 | pd_range | 关联关系 | 否 | 商品范围是部分商品时,需传商品组 |
slave_fields.bas_cm_dealership_district 特殊参数说明:
字段名称 | 字段key | 字段类型 | 必填 | 特殊说明 |
---|---|---|---|---|
经销区域-国家 | country | 地区 | 是 | 对应国家编码 |
经销区域-省份 | province | 地区 | 是 | 对应省份编码 |
经销区域-城市 | city | 地区 | 是 | 对应市区编码 |
经销区域-区县 | district | 地区 | 是 | 对应区县编码 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": "",
"response_data": "6066483328179541690"
}
异常示例:
{
"msg_id": "X000001",
"return_code": 1,
"return_msg": "保存失败!"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
return_data | String |
# 修改客户经销权
接口说明: 1、通过查询对象配置 (opens new window)接口,获得对象对应的fieldList --> 字段列表结构信息 2、详细字段入参规范说明参见 附录六:aPaaS字段类型样式说明 (opens new window)
请求方式: POST(HTTPS)
**请求地址:
** https://openapi.qince.com/api/cm/v1/dealershipUpdate/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
fields特殊参数说明:
字段名称 | 字段key | 字段类型 | 必填 | 特殊说明 |
---|---|---|---|---|
id | 对应经销权ID | 经销权ID | 是 | 系统经销权ID |
客户名称 | customer | 客户 | 是 | 系统客户模板id |
开始日期 | start_date | 金额 | 是 | 日期格式 |
结束日期 | end_date | 日期 | 是 | 日期格式 |
商品范围 | pd_range_type | 单选框 | 是 | 1:全部商品;2:部分商品 |
商品组 | pd_range | 关联关系 | 否 | 商品范围是部分商品时,需传商品组 |
slave_fields.bas_cm_dealership_district 特殊参数说明:
字段名称 | 字段key | 字段类型 | 必填 | 特殊说明 |
---|---|---|---|---|
id | 经销权区域id | id | 是 | 系统经销权区域ID |
经销区域-国家 | country | 地区 | 是 | 对应国家编码 |
经销区域-省份 | province | 地区 | 是 | 对应省份编码 |
经销区域-城市 | city | 地区 | 是 | 对应市区编码 |
经销区域-区县 | district | 地区 | 是 | 对应区县编码 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": ""
}
异常示例:
{
"msg_id": "X000001",
"return_code": 1,
"return_msg": "保存失败!"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
# 查询客户经销权
接口说明 1、通过查询对象配置 (opens new window)接口,获得对象对应的fieldList --> 字段列表结构信息 2、请求入参操作符,详见附录操作符说明 (opens new window) 3、字段出参规范说明参见 附录六:aPaaS字段类型样式说明 (opens new window)
请求方式: POST(HTTPS)
**请求地址:
** https://openapi.qince.com/api/cm/v1/dealershipQuery/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
page | INT | 是 | 页数,默认值为1 |
rows | INT | 是 | 条数,默认值为100 |
sorts | List | 是 | 排序,默认按创建时间倒序排序 |
sorts.field_key | VARCHAR(30) | 是 | 排序字段 |
sorts.type | VARCHAR(4) | 是 | 排序类型:asc 正序,desc 倒序 |
query_group | List | 是 | 查询条件列表 |
query_group.connector | List | 是 | 组内查询条件,条件AND或OR |
query_group.filters | VARCHAR(4) | 是 | 组内查询条件 |
query_group.filters.field_key | VARCHAR(32) | 是 | 字段key |
query_group.filters.operator | VARCHAR(10) | 是 | 操作符,详见附录操作符说明 (opens new window) |
query_group.filters.field_values | List | 是 | 字段值集合 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": "",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"end_date": {
"format": "YYYY-MM-DD"
},
"owner": {
"name": "gm",
"id": "5766711811457451269",
"status": "1"
},
"pd_range_type": {
"code": "1",
"label": "全部商品"
},
"lock_status": {
"code": "UNLOCK",
"label": "未锁定"
},
"create_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-08-26 15:03:13"
},
"field_3kgN5__c": {
"code": "nPFlJR4S",
"label": "选项1"
},
"approval_status": {
"code": "APPROVED",
"label": "已通过"
},
"modify_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-08-26 15:03:13"
},
"source_type": {
"code": "LROPFXCJ",
"label": "自建"
},
"modifyier_id": {
"name": "gm",
"id": "5766711811457451269",
"status": "1"
},
"business_type": {
"code": "busitype_default__c",
"id": "6575269220736966451",
"label": "默认业务类型",
"status": "1"
},
"name": "JXQ2025082600016",
"creator_id": {
"name": "gm",
"id": "5766711811457451269",
"status": "1"
},
"id": "5353362790694384834",
"department": {
"name": "CPG",
"id": "10",
"status": "1"
},
"start_date": {
"format": "YYYY-MM-DD"
},
"status": {
"code": "NORMAL",
"label": "正常"
},
"customer": {
"objectKey": "bas_cm_dealer",
"name": "测试经销商改动",
"objectName": "经销商",
"id": "2814859286868529807",
"status": "1"
}
}
]
异常示例:
{
"msg_id": "X000001",
"return_code": 1,
"return_msg": "查询失败!"
}