# 添加并提审商品

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：addGoods

调用此接口上传并提审需要直播的商品信息，审核通过后商品录入【小程序直播】商品库。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxaapi/broadcast/goods/add?access_token=ACCESS_TOKEN
```

### 云调用

- 调用方法：liveBroadcast.goodsAdd

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：52

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "goodsInfo",
    "类型": "object",
    "必填": "是",
    "说明": "商品信息"
  }
]
```

### Body.goodsInfo `Object Payload`

商品信息

```json
[
  {
    "参数名": "coverImgUrl",
    "类型": "string",
    "必填": "是",
    "说明": "填入mediaID（mediaID获取后，三天内有效）；图片mediaID的获取，请参考[新增临时素材](/miniprogram/dev/server/API/kf-mgnt/kf-message/api_uploadtempmedia)；图片规则：图片尺寸最大300像素*300像素；"
  },
  {
    "参数名": "name",
    "类型": "string",
    "必填": "是",
    "说明": "商品名称，最长14个汉字，1个汉字相当于2个字符"
  },
  {
    "参数名": "priceType",
    "类型": "number",
    "必填": "是",
    "说明": "价格类型，1：一口价（只需要传入price，price2不传） 2：价格区间（price字段为左边界，price2字段为右边界，price和price2必传） 3：显示折扣价（price字段为原价，price2字段为现价， price和price2必传）"
  },
  {
    "参数名": "price",
    "类型": "number",
    "必填": "是",
    "说明": "数字，最多保留两位小数，单位元"
  },
  {
    "参数名": "price2",
    "类型": "number",
    "必填": "否",
    "说明": "数字，最多保留两位小数，单位元"
  },
  {
    "参数名": "url",
    "类型": "string",
    "必填": "是",
    "说明": "商品详情页的小程序路径，路径参数存在 url 的，该参数的值需要进行 encode 处理再填入"
  },
  {
    "参数名": "thirdPartyAppid",
    "类型": "string",
    "必填": "否",
    "说明": "当商品为第三方小程序的商品则填写为对应第三方小程序的appid，自身小程序商品则填空"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "goodsId",
    "类型": "number",
    "说明": "商品ID"
  },
  {
    "参数名": "auditId",
    "类型": "number",
    "说明": "审核单ID"
  }
]
```

## 4. 注意事项

- 开发者必须保存【商品ID】与【审核单ID】，如果丢失，则无法调用其他相关接口
- 调用额度：500次/一天

## 5. 代码示例

请求示例

``` json
{    
    "goodsInfo": {              
         "coverImgUrl": "ZuYVNKk9sMP1X4m7FXdcDCKra251KDZTjS502UTV7gwalgLZXcrOhG6oNYX6c7AR",        
         "name":"TIT茶杯",      
         "priceType":1,   
         "price":99.5,
         // "price2": 150.5, priceType为2或3时必填
         "url":"pages/index/index"  
    }
}
```

返回示例

```json
{
  "goodsId": 51,
  "auditId": 525022786,
  "errcode": 0
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "40001",
    "错误描述": "invalid credential  access_token isinvalid or not latest",
    "解决方案": "获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口"
  },
  {
    "错误码": "200002",
    "错误描述": "参数错误",
    "解决方案": ""
  },
  {
    "错误码": "300002",
    "错误描述": "名称长度不符合规则",
    "解决方案": ""
  },
  {
    "错误码": "300003",
    "错误描述": "价格输入不合规（如现价比原价大、传入价格非数字等）",
    "解决方案": ""
  },
  {
    "错误码": "300004",
    "错误描述": "商品名称存在违规违法内容",
    "解决方案": ""
  },
  {
    "错误码": "300006",
    "错误描述": "图片上传失败（如：mediaID过期）",
    "解决方案": ""
  },
  {
    "错误码": "300007",
    "错误描述": "线上小程序版本不存在该链接",
    "解决方案": ""
  },
  {
    "错误码": "300018",
    "错误描述": "商品图片尺寸过大",
    "解决方案": ""
  },
  {
    "错误码": "300021",
    "错误描述": "商品添加成功，审核失败",
    "解决方案": ""
  }
]
```

## 7. 适用范围

本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请以实际调用情况为准。