# 【小程序直播】直播商品管理接口
| 名稱 | 功能說明 |
|---|---|
| 商品添加并提審 | 調(diào)用此接口上傳并提審需要直播的商品信息，審核通過后商品錄入【小程序直播】商品庫 |
| 撤回商品審核 | 調(diào)用此接口，可撤回直播商品的提審申請，消耗的提審次數(shù)不返還 |
| 重新提交商品審核 | 調(diào)用此接口可以對已撤回提審的商品再次發(fā)起提審申請 |
| 刪除商品 | 調(diào)用此接口，可刪除【小程序直播】商品庫中的商品，刪除后直播間上架的該商品也將被同步刪除，不可恢復(fù) |
| 更新商品 | 調(diào)用此接口可以更新商品信息，審核通過的商品僅允許更新價格類型與價格，審核中的商品不允許更新，未審核的商品允許更新所有字段， 只傳入需要更新的字段 |
| 獲取商品狀態(tài) | 調(diào)用此接口可獲取商品的信息與審核狀態(tài) |
| 獲取商品列表 | 調(diào)用此接口可獲取商品列表 |
# 一、簡介
直播商品管理接口，是小程序直播提供給開發(fā)者對直播商品進(jìn)行批量操作的接口能力。
開發(fā)者可以對商品批量進(jìn)行添加、提審、刪除以及更新等操作。
接口僅支持對通過接口添加的商品進(jìn)行操作，開發(fā)者在小程序管理后臺添加的商品，不支持通過接口操作。
開發(fā)者必須保存【商品ID】與【審核單ID】，如果丟失，則無法調(diào)用其他相關(guān)接口。
# 二、接口文檔
# 1.商品添加并提審
# 接口說明
調(diào)用此接口上傳并提審需要直播的商品信息，審核通過后商品錄入【小程序直播】商品庫
注意：開發(fā)者必須保存【商品ID】與【審核單ID】，如果丟失，則無法調(diào)用其他相關(guān)接口
# 調(diào)用頻率
調(diào)用額度：500次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/add?access_token=
# 請求參數(shù)示例： json
{
"goodsInfo": {
"coverImgUrl": "ZuYVNKk9sMP1X4m7FXdcDCKra251KDZTjS502UTV7gwalgLZXcrOhG6oNYX6c7AR",
"name":"TIT茶杯",
"priceType":1,
"price":99.5,
// "price2": 150.5, priceType為2或3時必填
"url":"pages/index/index"
}
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| coverImgUrl | String | 是 | 填入mediaID（mediaID獲取后，三天內(nèi)有效）；圖片mediaID的獲取，請參考以下文檔： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html；圖片規(guī)則：圖片尺寸最大300像素*300像素； |
| name | String | 是 | 商品名稱，最長14個漢字，1個漢字相當(dāng)于2個字符 |
| priceType | Number | 是 | 價格類型，1：一口價（只需要傳入price，price2不傳） 2：價格區(qū)間（price字段為左邊界，price2字段為右邊界，price和price2必傳） 3：顯示折扣價（price字段為原價，price2字段為現(xiàn)價， price和price2必傳） |
| price | Number | 是 | 數(shù)字，最多保留兩位小數(shù)，單位元 |
| price2 | Number | 否 | 數(shù)字，最多保留兩位小數(shù)，單位元 |
| url | String | 是 | 商品詳情頁的小程序路徑，路徑參數(shù)存在 url 的，該參數(shù)的值需要進(jìn)行 encode 處理再填入 |
| thirdPartyAppid | String | 否 | 當(dāng)商品為第三方小程序的商品則填寫為對應(yīng)第三方小程序的appid，自身小程序商品則為'' |
# 正確返回示例
{
"goodsId": 51,
"auditId": 525022786,
"errcode": 0
}
# 返回參數(shù)含義
| 參數(shù) | 說明 |
|---|---|
| goodsId | 商品ID |
| auditId | 審核單ID |
# 2.撤回審核
# 接口說明
調(diào)用此接口，可撤回直播商品的提審申請，消耗的提審次數(shù)不返還
# 調(diào)用頻率
調(diào)用額度：500次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/resetaudit?access_token=
# 請求參數(shù)示例： json
{
"auditId": 525022184,
"goodsId": 9
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| goodsId | Number | 是 | 商品ID |
| auditId | Number | 是 | 審核單ID |
# 正確返回示例
{
"errcode": 0
}
# 3.重新提交審核
# 接口說明
調(diào)用此接口可以對已撤回提審的商品再次發(fā)起提審申請
# 調(diào)用頻率
調(diào)用額度：500次/一天（與接口1共用500次限制）
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/audit?access_token=
# 請求參數(shù)示例： json
{
"goodsId": 9
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| goodsId | Number | 是 | 商品ID |
# 正確返回示例
{
"errcode": 0,
"auditId": 525022184
}
# 返回參數(shù)含義
| 參數(shù) | 說明 |
|---|---|
| auditId | 審核單ID |
# 4.刪除商品
# 接口說明
調(diào)用此接口，可刪除【小程序直播】商品庫中的商品，刪除后直播間上架的該商品也將被同步刪除，不可恢復(fù)；
# 調(diào)用頻率
調(diào)用額度：1000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/delete?access_token=
# 請求參數(shù)示例： json
{
"goodsId": 9
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| goodsId | Number | 是 | 商品ID |
# 返回參數(shù)
{
"errcode": 0,
}
# 5.更新商品
# 接口說明
調(diào)用此接口可以更新商品信息，審核通過的商品僅允許更新價格類型與價格，審核中的商品不允許更新，未審核的商品允許更新所有字段， 只傳入需要更新的字段。
# 調(diào)用頻率
調(diào)用額度：1000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/update?access_token=
# 請求參數(shù)示例： json
{
"goodsInfo": {
// 需要更新哪個字段就傳入哪個字段，goodsId 必傳
"coverImgUrl": "ZuYVNKk9sMP1X4m7FXdcDCKra251KDZTjS502UTV7gwalgLZXcrOhG6oNYX6c7AR",
"name":"TIT茶杯",
"priceType":1,
"price":99.5,
// "price2": 150.5, priceType為2或3時必填
"url": "pages/index/index",
"goodsId": 9
}
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| coverImgUrl | String | 是 | 填入mediaID（mediaID獲取后，三天內(nèi)有效）；圖片mediaID的獲取，請參考以下文檔： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html；圖片規(guī)則：圖片尺寸最大300像素*300像素； |
| name | String | 是 | 商品名稱，最長14個漢字，1個漢字相當(dāng)于2個字符 |
| priceType | Number | 是 | 價格類型，1：一口價（只需要傳入price，price2不傳） 2：價格區(qū)間（price字段為左邊界，price2字段為右邊界，price和price2必傳） 3：顯示折扣價（price字段為原價，price2字段為現(xiàn)價， price和price2必傳） |
| price | Number | 是 | 數(shù)字，最多保留兩位小數(shù)，單位元 |
| price2 | Number | 否 | 數(shù)字，最多保留兩位小數(shù)，單位元 |
| url | String | 是 | 商品詳情頁的小程序路徑，路徑參數(shù)存在 url 的，該參數(shù)的值需要進(jìn)行 encode 處理再填入 |
| goodsId | Number | 是 | 商品ID |
| thirdPartyAppid | String | 否 | 當(dāng)商品為第三方小程序的商品則填寫為對應(yīng)第三方小程序的appid，自身小程序商品則為'' |
# 返回參數(shù)
{
"errcode": 0,
}
# 6.獲取商品狀態(tài)
# 接口說明
調(diào)用此接口可獲取商品的信息與審核狀態(tài)
# 調(diào)用頻率
調(diào)用額度：1000次/一天
# 請求方法
POST
# 請求URL
https://api.weixin.qq.com/wxa/business/getgoodswarehouse?access_token=
# 請求參數(shù)示例： json
{
? "goods_ids": [1] //最多支持一次獲取20個商品狀態(tài)
}
# 請求參數(shù)含義
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| goods_ids | Array<Number> | 是 | 商品ID |
# 返回參數(shù)
{
? "errcode":0,
? "errmsg":"ok",
? "goods":
? [
? {
? "goods_id":9,
? "cover_img_url":"xxxx",
? "name":"xxxxx"
? "price":12300,
? "url":"xxxxxxx",
? "price_type":1,
? "price2":0,
? "audit_status":1,
? "third_party_tag":0
? }
? ],
? "total":0
}
# 返回參數(shù)含義
| 參數(shù) | 說明 |
|---|---|
| goods_id | 商品ID |
| name | 商品名稱 |
| cover_img_url | 商品圖片url |
| url | 商品詳情頁的小程序路徑 |
| priceType | 1:一口價，此時讀price字段; 2:價格區(qū)間，此時price字段為左邊界，price2字段為右邊界; 3:折扣價，此時price字段為原價，price2字段為現(xiàn)價； |
| price | 價格左區(qū)間，單位“元” |
| price2 | 價格右區(qū)間，單位“元” |
| audit_status | 0：未審核，1：審核中，2:審核通過，3審核失敗 |
| third_party_tag | 1、2：表示是為 API 添加商品，否則是直播控制臺添加的商品 |
| thirdPartyAppid | 當(dāng)商品為第三方小程序的商品則為對應(yīng)第三方小程序的appid，自身小程序商品則為'' |
| total | 商品個數(shù) |
# 7.獲取商品列表
# 接口說明
調(diào)用此接口可獲取商品列表
# 調(diào)用頻率
調(diào)用額度：10000次/一天
# 請求方法
GET
# 請求URL
https://api.weixin.qq.com/wxaapi/broadcast/goods/getapproved?access_token=[access_token]
# URL query 參數(shù)
| 參數(shù) | 類型 | 必填 | 說明 |
|---|---|---|---|
| offset | Number | 是 | 分頁條數(shù)起點(diǎn) |
| limit | Number | 否 | 分頁大小，默認(rèn)30，不超過100 |
| status | Number | 是 | 商品狀態(tài)，0：未審核。1：審核中，2：審核通過，3：審核駁回 |
# 返回參數(shù)
{
? "errcode":0,
? "total":68,
? "goods":
? [
? {
? "goodsId":9,
? "coverImgUrl":"xxxx",
? "name":"xxxxx"
? "price":12300,
? "url":"xxxxxxx",
? "priceType":1,
? "price2":0,
? "thirdPartyTag":0
? }
? ]
}
# 返回參數(shù)含義
| 參數(shù) | 說明 |
|---|---|
| total | 商品數(shù)量 |
| goodsId | 商品ID |
| coverImgUrl | 商品圖片鏈接 |
| name | 商品名稱 |
| price | 價格左區(qū)間，單位“元” |
| price2 | 價格右區(qū)間，單位“元” |
| url | 商品小程序路徑 |
| priceType | 1:一口價，此時讀price字段; 2:價格區(qū)間，此時price字段為左邊界，price2字段為右邊界; 3:折扣價，此時price字段為原價，price2字段為現(xiàn)價； |
| thirdPartyTag | 1、2：表示是為 API 添加商品，否則是直播控制臺添加的商品 |
| thirdPartyAppid | 當(dāng)商品為第三方小程序的商品則為對應(yīng)第三方小程序的appid，自身小程序商品則為'' |
# 附錄：錯誤碼
-1：系統(tǒng)錯誤
1003：商品id不存在
47001：入?yún)⒏袷讲环弦?guī)范
200002：入?yún)㈠e誤
300001：禁止創(chuàng)建/更新商品（如：商品創(chuàng)建功能被封禁）
300002：名稱長度不符合規(guī)則
300003：價格輸入不合規(guī)（如：現(xiàn)價比原價大、傳入價格非數(shù)字等）
300004：商品名稱存在違規(guī)違法內(nèi)容
300005：商品圖片存在違規(guī)違法內(nèi)容
300006：圖片上傳失?。ㄈ纾簃ediaID過期）
300007：線上小程序版本不存在該鏈接
300008：添加商品失敗
300009：商品審核撤回失敗
300010：商品審核狀態(tài)不對（如：商品審核中）
300011：操作非法（API不允許操作非API創(chuàng)建的商品）
300012：沒有提審額度（每天500次提審額度）
300013：提審失敗
300014：審核中，無法刪除（非零代表失?。?/p>
300017：商品未提審
300018：商品圖片尺寸過大
300021：商品添加成功，審核失敗