商品管理接口

名称 功能说明
商品添加并提审 调用此接口上传并提审需要直播的商品信息,审核通过后商品录入【小程序直播】商品库
撤回商品审核 调用此接口,可撤回直播商品的提审申请,消耗的提审次数不返还
重新提交商品审核 调用此接口可以对已撤回提审的商品再次发起提审申请
删除商品 调用此接口,可删除【小程序直播】商品库中的商品,删除后直播间上架的该商品也将被同步删除,不可恢复
更新商品 调用此接口可以更新商品信息,审核通过的商品仅允许更新价格类型与价格,审核中的商品不允许更新,未审核的商品允许更新所有字段, 只传入需要更新的字段
获取商品状态 调用此接口可获取商品的信息与审核状态
获取商品列表 调用此接口可获取商品列表

一、简介

直播商品管理接口,是小程序直播提供给开发者对直播商品进行批量操作的接口能力。

开发者可以对商品批量进行添加、提审、删除以及更新等操作。

接口仅支持对通过接口添加的商品进行操作,开发者在小程序管理后台添加的商品,不支持通过接口操作。

开发者必须保存【商品ID】与【审核单ID】,如果丢失,则无法调用其他相关接口。

二、接口文档

1.商品添加并提审

接口说明

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

注意:开发者必须保存【商品ID】与【审核单ID】,如果丢失,则无法调用其他相关接口

调用频率

调用额度:500次/一天

请求方法

POST

请求地址

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

请求参数说明

参数 类型 默认值 必填 说明
access_token string 第三方平台调用令牌
goodsInfo object 商品信息

goodsInfo 的结构

参数 类型 默认值 必填 说明
coverImgUrl string 填入mediaID(mediaID获取后,三天内有效);图片mediaID的获取,请参考以下文档: https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html;图片规则:图片尺寸最大300像素*300像素;
name string 商品名称,最长14个汉字,1个汉字相当于2个字符
priceType number 价格类型,1:一口价,2:价格区间,3:显示折扣价;1:一口价,只需要传入price,price2不传;2:价格区间,price字段为左边界,price2字段为右边界,price和price2必传。3:显示折扣价,price字段为原价,price2字段为现价, price和price2必传
price number 最多保留两位小数,单位元
price2 number 最多保留两位小数,单位元,priceType为2或3时必填
url string 商品详情页的小程序路径,路径参数存在 url 的,该参数的值需要进行 encode 处理再填入

请求参数示例

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

返回参数说明

参数 类型 说明
goodsId number 商品ID
auditId number 审核单ID
errcode number 0表示成功

正确返回示例

{  
    "goodsId": 51,

    "auditId": 525022786,

    "errcode": 0 
}

2.撤回审核

接口说明

调用此接口,可撤回直播商品的提审申请,消耗的提审次数不返还

调用频率

调用额度:500次/一天

请求方法

POST

请求地址

https://api.weixin.qq.com/wxaapi/broadcast/goods/resetaudit?access_token=ACCESS_TOKEN

请求参数说明

参数 类型 默认值 必填 说明
access_token string 第三方平台调用令牌
goodsId number 商品ID
auditId number 审核单ID

请求参数示例

{    
    "auditId": 525022184, 

    "goodsId": 9
}

返回参数说明

参数 类型 说明
errcode number 0表示成功

正确返回示例

{  
    "errcode": 0 
}

3.重新提交审核

接口说明

调用此接口可以对已撤回提审的商品再次发起提审申请

调用频率

调用额度:500次/一天(与接口1共用500次限制)

请求方法

POST

请求地址

https://api.weixin.qq.com/wxaapi/broadcast/goods/audit?access_token=access_token

请求参数说明

参数 类型 默认值 必填 说明
access_token string 第三方平台调用令牌
goodsId number 商品ID

请求参数示例

{    
    "goodsId": 9
}

返回参数说明

参数 类型 说明
errcode number 0表示成功
auditId number 审核单ID

正确返回示例

{  
    "errcode": 0,  

    "auditId": 525022184
}

4.删除商品

接口说明

调用此接口,可删除【小程序直播】商品库中的商品,删除后直播间上架的该商品也将被同步删除,不可恢复;

调用频率

调用额度:1000次/一天

请求方法

POST

请求地址

https://api.weixin.qq.com/wxaapi/broadcast/goods/delete?access_token=access_token

请求参数说明

参数 类型 默认值 必填 说明
access_token string 第三方平台调用令牌
goodsId number 商品ID

请求参数示例

{    
    "goodsId": 9
}

返回参数说明

参数 类型 说明
errcode number 0表示成功

正确返回示例

{   
    "errcode": 0,   
}

5.更新商品

接口说明

调用此接口可以更新商品信息,审核通过的商品仅允许更新价格类型与价格,审核中的商品不允许更新,未审核的商品允许更新所有字段, 只传入需要更新的字段。

调用频率

调用额度:1000次/一天

请求方法

POST

请求地址

https://api.weixin.qq.com/wxaapi/broadcast/goods/update?access_token=access_token

请求参数说明

参数 类型 默认值 必填 说明
access_token string 第三方平台调用令牌
goodsInfo object 商品信息

goodsInfo 的结构

参数 类型 默认值 必填 说明
coverImgUrl string 填入mediaID(mediaID获取后,三天内有效);图片mediaID的获取,请参考以下文档: https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html;图片规则:图片尺寸最大300像素*300像素;
name string 商品名称,最长14个汉字,1个汉字相当于2个字符
priceType number 价格类型,1:一口价,2:价格区间,3:显示折扣价;1:一口价,只需要传入price,price2不传;2:价格区间,price字段为左边界,price2字段为右边界,price和price2必传。3:显示折扣价,price字段为原价,price2字段为现价, price和price2必传
price number 最多保留两位小数,单位元
price2 number 最多保留两位小数,单位元,priceType为2或3时必填
url string 商品详情页的小程序路径,路径参数存在 url 的,该参数的值需要进行 encode 处理再填入

请求参数示例

{    

    "goodsInfo": {        
        // 需要更新哪个字段就传入哪个字段,goodsId 必传        
        "coverImgUrl": "ZuYVNKk9sMP1X4m7FXdcDCKra251KDZTjS502UTV7gwalgLZXcrOhG6oNYX6c7AR",        
        "name":"TIT茶杯",        
        "priceType":1,
        "price":99.5,
        // "price2": 150.5, priceType为2或3时必填
        "url": "pages/index/index",       
        "goodsId": 9     
    }
}

返回参数说明

参数 类型 说明
errcode number 0表示成功

正确返回示例

{   
    "errcode": 0,   
}

6.获取商品状态

接口说明

调用此接口可获取商品的信息与审核状态

调用频率

调用额度:1000次/一天

请求方法

POST

请求地址

https://api.weixin.qq.com/wxa/business/getgoodswarehouse?access_token=access_token

请求参数说明

参数 类型 默认值 必填 说明
access_token string 第三方平台调用令牌
goods_ids Array 商品ID

请求参数示例

{"goods_ids": [1]
}

返回参数说明

参数 类型 说明
errcode number 0表示成功
goods Array.<Object> 商品信息
total number 商品个数

goods 的结构

参数 类型 说明
goods_id number 商品ID
cover_img_url string 图片url
name string 商品名称
price number 价格左区间,单位“元”
url string 商品详情页的小程序路径
priceType number 1:一口价,此时读price字段,2:价格区间,此时price字段为左边界,price2字段为右边界,3:折扣价,此时price字段为原价,price2字段为现价;
price2 number 价格右区间,单位“元”
audit_status number 0:未审核,1:审核中,2:审核通过,3审核失败
third_party_tag number 1、2:表示是为 API 添加商品,否则是直播控制台添加的商品

正确返回示例

{"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
}

7.获取商品列表

接口说明

调用此接口可获取商品列表

调用频率

调用额度:10000次/一天

请求方法

GET

请求地址

https://api.weixin.qq.com/wxaapi/broadcast/goods/getapproved?access_token=access_token

请求参数说明

参数 类型 默认值 必填 说明
access_token string 第三方平台调用令牌
offset number 分页条数起点
limit number 30 分页大小,默认30,不超过100
status number 商品状态,0:未审核。1:审核中,2:审核通过,3:审核驳回

返回参数说明

参数 类型 说明
errcode number 0表示成功
goods Array.<Object> 商品信息
total number 商品个数

goods 的结构

参数 类型 说明
goods_id number 商品ID
cover_img_url string 图片url
name string 商品名称
price number 价格左区间,单位“元”
url string 商品详情页的小程序路径
priceType number 1:一口价,此时读price字段,2:价格区间,此时price字段为左边界,price2字段为右边界,3:折扣价,此时price字段为原价,price2字段为现价;
price2 number 价格右区间,单位“元”
thirdPartyTag number 1,2:表示是为api添加商品,否则是在MP添加商品

正确返回示例

{"errcode":0,"total":68,"goods":[{"goodsId":9,"coverImgUrl":"xxxx","name":"xxxxx""price":12300,"url":"xxxxxxx","priceType":1,"price2":0,"thirdPartyTag":0}]
}

附录:错误码

-1:系统错误

1003:商品id不存在

47001:入参格式不符合规范

200002:入参错误

300001:禁止创建/更新商品(如:商品创建功能被封禁)

300002:名称长度不符合规则

300003:价格输入不合规(如:现价比原价大、传入价格非数字等)

300004:商品名称存在违规违法内容

300005:商品图片存在违规违法内容

300006:图片上传失败(如:mediaID过期)

300007:线上小程序版本不存在该链接

300008:添加商品失败

300009:商品审核撤回失败

300010:商品审核状态不对(如:商品审核中)

300011:操作非法(API不允许操作非API创建的商品)

300012:没有提审额度(每天500次提审额度)

300013:提审失败

300014:审核中,无法删除(非零代表失败)

300017:商品未提审

300021:商品添加成功,审核失败 更多错误码:请查看全局错误码