API开放平台

TIP

# 连锁品牌(KA系统)接口

# 新增连锁品牌信息

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

{ 
    "propertyName": "测试品牌",
    "sequence": "0"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
propertyName VARCHAR(32) 是 连锁品牌名称，不可重复
sequence BigDecimal 否 排序号，数值型，支持两位小数，数值越小，排面越靠前

响应示例：

{
  "return_code": "0",
  "return_msg": "ka系统连锁品牌新增成功！值为：测试品牌",
  "msg_id": "msg_id",
  "response_data": "<<DATA>>"
}

数据DATA示例:

{
    "id": "7057863198755700572"
}

参数说明：

参数 类型 说明
msg_id VARCHAR(32) 请求消息id
return_code Int 响应编码，0:成功，1:失败
return_msg VARCHAR(32) 响应说明
response_data String 数据data,唯一标识

# 修改连锁品牌信息

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

{
  "id":"7073076923373303655",
  "propertyName": "测试品牌",
  "sequence": "0.00"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
id Long 是 id,唯一标识
propertyName VARCHAR(32) 否 连锁品牌名称,不可重复。名称和排序号至少有一个不为空
sequence BigDecimal 否 排序号，数值型，支持两位小数，数值越小，排面越靠前

响应示例：

{
  "return_code": "0",
  "return_msg": "ka系统连锁品牌修改成功！值为：测试品牌",
  "msg_id": "msg_id"
}

参数说明：

参数 类型 必填 说明
msg_id VARCHAR(32) 请求消息id
return_code Int 响应编码，0:成功，1:失败
return_msg VARCHAR(32) 响应说明

# 删除连锁品牌信息

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

{
  "id":"7073076923373303655"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
id Long 是 id, 唯一标识

响应示例：

{
  "return_code": "0",
  "return_msg": "连锁品牌删除成功",
  "msg_id": "msg_id"
}

参数说明：

参数 类型 必填 说明
msg_id VARCHAR(32) 请求消息id
return_code Int 响应编码，0:成功，1:失败
return_msg VARCHAR(32) 响应说明

# 查询连锁品牌

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

{
    "propertyName": "测试品牌",
    "page": "1",
    "rows": "100"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
propertyName VARCHAR(32) 否 连锁品牌名称，模糊查询
page INT 否 页数
rows INT 否 行数

响应示例：

[
  {
    "key_id": "8318122645830993205",
    "propertyName": "测试品牌1",
    "sequence": "1.00",
    "createTime": "2023-02-02 13:59:52",
    "creatorId": 996
  },
  {
    "key_id": "7054044403421377133",
    "propertyName": "测试品牌2",
    "sequence": "2.00",
    "createTime": "2023-02-02 15:59:12",
    "creatorId": 996,
    "modifyTime": "2023-02-02 15:59:59",
    "modifyierId": 996
  }
]

参数说明：

参数 类型 说明
key_id Long id,唯一标识
propertyName VARCHAR(32) 连锁品牌名称
sequence BigDecimal 排序号
createTime DATE 创建时间。格式：yyyy-MM-dd HH:mm:ss
creatorId Long 创建人id
modifyTime DATE 修改时间。格式：yyyy-MM-dd HH:mm:ss
modifyierId Long 修改人id

← 客户日志 →