API开放平台

TIP

# 商品品牌2.0接口

# 查询商品品牌

接口说明 1、返回参数兼容v1接口所有字段 2、apaas字段出参规范说明参见 附录六：aPaaS字段类型样式说明 (opens new window) 3、通过查询对象配置 (opens new window)接口，获得对象对应的fieldList --> 字段列表结构信息

请求方式： POST（HTTPS）
**请求地址： ** https://openapi.qince.com/api/pd/v2/brandQuery/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "page": 1,
  "rows": 100,
  "brand_id": "7136165210115328159",
  "brand_name": ""
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
page INT 否 页数，默认值为1
rows INT 否 条数，默认值为100
brand_id VARCHAR(30) 否 商品品牌勤策唯一标识
brand_name VARCHAR(200) 否 品牌名称

响应示例：

{
  "msg_id": "X000001",
  "return_code": 0,
  "return_msg": "",
  "response_data": "<<DATA>>"
}

数据DATA示例:

[
  {
    "brand_id": "7136165210115328159",
    "brand_name": "李宁",
    "sequ": "10",
    "depts": [
      {
        "dept_id": "5404208934443077487",
        "dept_name": "部门B",
        "dept_source_code": ""
      },
      {
        "dept_id": "8233198284131411873",
        "dept_name": "部门C",
        "dept_source_code": ""
      }
    ],
    "apaas_cuz_data": {
      "field_QxaDA__c": {
        "format": "YYYY-MM-DD",
        "value": "2025-03-13"
      },
      "field_T08db__c": "222",
      "field_dWPHL__c": [
        {
          "code": "91CIFbjO",
          "label": "选项1",
          "status": "1"
        }
      ]
    }
  }
]

参数说明：

参数 类型 必填 说明
brand_id VARCHAR(32) 是 商品品牌勤策唯一标识
brand_name VARCHAR (200) 否 商品品牌名称
sequ VARCHAR (32) 否 排序
depts List 否 所属部门信息列表
depts.dept_id VARCHAR (32) 否 所属部门勤策唯一标识
depts.dept_name VARCHAR (200) 否 所属部门名称
depts.dept_source_code VARCHAR (100) 否 所属部门第三方唯一标识
apaas_cuz_data VARCHAR 否 apaas自定义字段，JSON格式字符串。格式：{字段key:value}

异常示例：

{
  "msg_id": "X000001",
  "return_code": 1,
  "return_msg": "查询失败！"
}

# 新增商品品牌

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/pd/v2/addPdBrand/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "fields": {
        "name": "商品品牌1",
        "sequ": 1.0,
        "dept": "8999774590595176544,8999774590595176542",
        "fieldKey(自定义字段key)": "fieldValue(数据格式参见附录六)"
    },
    "is_trigger": false,
    "check_rule": false
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
name VARCHAR(32) 是 商品品牌名称
sequ NUMERIC(100) 是 排序号
dept VARCHAR 是 所属部门
is_trigger boolean 否 是否触发工作流；true:触发，false:不触发
trigger_employee VARCHAR(32) 否 是否触发工作流为true的时候必填，员工id
check_rule boolean 否 是否校验验证规则和查重规则；true:校验，false:不校验

响应示例：

{
    "msg_id": "PRD00001",
    "return_code": 0
}

异常示例：

{
    "msg_id": "PRD00001",
    "return_code": 100606,
    "return_msg": "商品品牌名称或者唯一标示已经存在"
}

参数说明：

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

# 修改商品品牌

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/pd/v2/editPdBrand/{openid}/{timestamp}/{digest}/{msg_id} 在线调试
请求示例：

{
  "fields": {
    "name": "品牌1",
    "sequ": 1.0,
    "dept":"8999774590595176544,8999774590595176542",
    "fieldKey(自定义字段key)": "fieldValue(数据格式参见附录六)"
  },
  "is_trigger": false,
  "check_rule": false
}
说明： 本示例仅供参考，具体以参数说明为准。
参数 类型 必填 说明
fields VARCHAR 是 对应商品品牌数据对象
fields.name VARCHAR(32) 是 商品品牌名称
fields.sequ NUMERIC(100) 是 商品品牌排序号
fields.dept VARCHAR 是 所属部门
is_trigger boolean 否 是否触发工作流；true:触发，false:不触发
trigger_employee VARCHAR(32) 否 是否触发工作流为true的时候必填，员工id
check_rule boolean 否 是否校验验证规则和查重规则；true:校验，false:不校验

响应示例：

{
    "msg_id": "PRD00001",
    "return_code": 0
}

异常示例：

{
    "msg_id": "PRD00001",
    "return_code": 100606,
    "return_msg": "商品类型名称或者唯一标示已经存在"
}

参数说明：

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

# 删除商品品牌

接口说明： 1、删除指定ID的商品品牌

请求方式： POST（HTTPS）
**请求地址： ** https://openapi.qince.com/api/pd/v2/deletePdBrand/{openid}/{timestamp}/{digest}/{msg_id} 在线调试
请求示例：

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

参数说明：

参数 类型 必填 说明
data_id VARCHAR 是 要删除的数据ID

响应示例：

{
  "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 响应说明

← 商品类型V2接口 →