微信商品管理
商品管理
目录
商品管理
查询商品信息
调用该接口,商户可以查询创建成功的商品信息,用以检查商品状态或信息设置情况。
请求示例
HTTP请求方式:POST https://api.weixin.qq.com/scan/product/get?access_token=access_token POST数据格式:JSON POST数据例子: { "keystandard": "ean13", "keystr": "6900873042720" }
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 公众号的全局凭据,用于接口调用。 |
keystandard | 是 | 商品编码标准。 |
keystr | 是 | 商品编码内容。 |
返回示例
正确的JSON返回结果如下:
{ "errcode": 0, "errmsg": "ok", "brand_info":{ "base_info":{ "title": "扫一扫动态主页demo", "thumb_url":"http://mmbiz.qpic.cn/mmbiz/AhrnkhhK7rWevHib2pmq1phtply6JicADNrX6Yrvd7LzKERyic3kn3VdSsmFr5F5ibXzj9Al65yWFudmjqcWic1Qe9g/0", "brand_tag": "小耿哥8", "category_id": 0, "retail_price": "0.00", "store_mgr_type": "auto", "store_vendorid_list":[], "color": "auto", "status": "on" }, "detail_info":{ "banner_list":[ {"link":"http://mmbiz.qpic.cn/mmbiz/AhrnkhhK7rWevHib2pmq1phtply6JicADNic0LvlkCw7s6mZpicib7ict5MhoiaL3gPrYXpibnibOpViaYJFpic12nx4bNZcQ/0"}, {"link":"http://mmbiz.qpic.cn/mmbiz/AhrnkhhK7rWevHib2pmq1phtply6JicADNbTfwJmlVXp9k1A80UCFL1a9icwdthmSLh0RuJ5iaKcZBwdXbOicktkwPQ/0"}, {"link":"http://mmbiz.qpic.cn/mmbiz/AhrnkhhK7rWevHib2pmq1phtply6JicADNW4FD74oXjEyqHicE9U3H0nTCdLHibo7rRia2TFBQ6tx2Pvic92ica8Wns4Q/0"} ], "detail_list":[ { "title": "产品名称", "desc": "微信相框moment" }, { "title": "设计团队", "desc": "微信团队" }, { "title": "设计初衷", "desc": "做一个简单纯粹的电子相框" }, { "title": "产品诉求", "desc": "以相框为纽带,增加子女与父母长辈的沟通,用照片通过微信传递感情交流" } ] }, "action_info":{ "action_list":[ { "type": "link", "name": "banner", "link": "http://mp.weixin.qq.com", "image":"http://mmbiz.qpic.cn/mmbiz/AhrnkhhK7rWevHib2pmq1phtply6JicADNgjXTKn0j4TlfXjUOPYBDicVOmG0sdNfUOg9Lzia2g9cbjyTXmOiaB6L1g/0", "showtype": "banner" }, { "type": "link", "name": "自定义活动1", "link": "http://p.url.cn/wxscan.php", }, { "type": "link", "name": "自定义活动2", "link": "http://p.url.cn/wxscan.php", }, { "type": "user", "appid": "wx307e399609946068" }, { "type": "text", "text": "此处可根据品牌商需要,用于简单描述商品或活动。" } ] }, "module_info":{ "module_list":[ { "type": "anti_fake", "native_show": "true" } ] } } }
返回参数说明
参数 | 说明 |
---|---|
errcode | 0为调用成功,否则返回相关错误码。 |
errmsg | ok为调用成功,否则返回错误提示。 |
status | 商品主页的状态,on为发布状态,off为未发布状态,check为审核中状态,reject为审核未通过状态。 |
其他参数说明,请参考“创建商品”接口。
注意:商品状态(status)处于“审核中(check)”的商品,不可调用接口进行更新或取消发布,否则会报错。
批量查询商品信息
调用该接口,商户可以批量查询创建成功的商品信息,查询维度有商品状态和编码内容。
请求示例
HTTP请求方式:POST https://api.weixin.qq.com/scan/product/getlist?access_token=access_toke POST数据格式:JSON POST数据例子: { "offset": "1", "limit": "10", "status":"on", }
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 公众号的全局凭据,用于接口调用。 |
offset | 是 | 批量查询的起始位置,从0开始,包含该起始位置。 |
limit | 是 | 批量查询的数量。 |
status | 否 | 支持按状态拉取。on为发布状态,off为未发布状态,check为审核中状态,reject为审核未通过状态,all为所有状态。 |
keystr | 否 | 支持按部分编码内容拉取。填写该参数后,可将编码内容中包含所传参数的商品信息拉出。类似关键词搜索。 |
返回示例
正确的JSON返回结果如下:
{ "errcode": 0, "errmsg": "ok", "total": 2, "key_list": [ { "keystandard": "ean13", "keystr": "6390000000000", "category_id": 537117576, "category_name": "果泥/菜泥/肉泥", "update_time": 1413181580, "status": "on" }, { "keystandard": "ean13", "keystr": "6390000000002", "category_id": 537117576, "category_name": "果泥/菜泥/肉泥", "update_time": 1412834605, "status": "on" } ] }
返回参数说明
参数 | 说明 |
---|---|
errcode | 0为调用成功,否则返回相关错误码。 |
errmsg | ok为调用成功,否则返回错误提示。 |
total | 命中筛选条件的商品总数。 |
key_list | 商品信息列表。 |
keystandard | 商品编码标准。 |
keystr | 商品编码内容。 |
category_id | 商品类目ID。 |
category_name | 商品类目名称。 |
update_time | 商品信息的最后更新时间(整型)。 |
status | 商品主页的状态,on为发布状态,off为未发布状态,check为审核中状态,reject为审核未通过状态。 |
更新商品信息
调用该接口,可对商品的基本信息(base_info)、详情信息(detail_info)、推广服务区 (action_info)和组件区(modul_info)四部分进行独立或整体的更新。
注意:对处于“发布状态(on)”的商品进行更新,调用接口成功后,新的商品信息会自动进入扫一扫审核系统。对“审核中(check)”的商品,不可再更新或取消发布,否则会报错。
请求示例
HTTP请求方式:POST https://api.weixin.qq.com/scan/product/update?access_token=access_token POST数据格式:JSON POST数据例子: { "keystandard": "ean13", "keystr": "6390000000000", "brand_info": { "action_info": { "action_list": [ { "type": "link", "name": "banner", "link":"http://mp.weixin.qq.com", "image":"http://mmbiz.qpic.cn/mmbiz/AhrnkhhK7rWevHib2pmq1phtply6JicADNgjXTKn0j4TlfXjUOPYBDicVOmG0sdNfUOg9Lzia2g9cbjyTXmOiaB6L1g/0", "showtype": "banner" }, { "type": "link", "name": "更新的自定义活动1", "link": "http://p.url.cn/wxscan.php", }, { "type": "link", "name": "更新的自定义活动2", "link": "http://p.url.cn/wxscan.php", }, { "type": "user", "appid": "wx307e399609946068" }, { "type": "text", "text": "此处可根据品牌商需要,用于简单描述商品或活动。" } ] } } }
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 公众号的全局凭据,用于接口调用。 |
keystandard | 是 | 商品编码标准。 |
keystr | 是 | 商品编码内容。 |
action_info | 否 | 商品的推广服务区信息。 |
详细参数说明,请参考“创建商品”接口。
返回示例
正确的JSON返回结果如下:
{ "errcode": 0, "errmsg": "ok", "pid": "5g0B4A90aqc" }
返回参数说明
参数 | 说明 |
---|---|
errcode | 0为调用成功,否则返回相关错误码。 |
errmsg | ok为调用成功,否则返回错误提示。 |
pid | 转译后的商品id,将直接编入“获取商品二维码接口”返回的二维码内容。 |
清除商品信息
调用该接口,商户可以清除创建成功的商品信息。
请求示例
HTTP请求方式:POST https://api.weixin.qq.com/scan/product/clear?access_token=access_token POST数据格式:JSON POST数据例子: { "keystandard": "ean13", "keystr": "6900873042720" }
请求示例说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 公众号的全局凭据,用于接口调用。 |
keystandard | 是 | 商品编码标准。 |
keystr | 是 | 商品编码内容。 |
返回示例
正确的JSON返回结果如下:
{ "errcode": 0, "errmsg": "ok" }
返回参数说明
参数 | 说明 |
---|---|
errcode | 0为调用成功,否则返回相关错误码。 |
errmsg | ok为调用成功,否则返回错误提示。 |
跳转URL参数说明
场景说明:
用户点击商品推广服务区Link类型的链接后,外跳的URL会带上wxkeystand、wxkeystr、wxticket、wxextinfo这四个参数。通过检查wxticket可以确认访问用户的来源和身份信息,已实现精准运营。
URL示例:http://p.url.cn/wxscandemo/yangbanjian/fangweilanding?91eddae46161ae26a3e6e928f3c07147=scan&wxkeystandard=qrcode&wxkeystr=cosmetics1&wxticket=azlsdGljdXo4Ymow&wxextinfo=123
参数说明
参数 | 说明 |
---|---|
wxkeystand | 商品编码标准。 |
wxkeystr | 商品编码内容。 |
wxticket | 标识来源的凭证参数。可通过“检查wxticket参数接口”换取对应的商品信息和访问用户信息。特别地,当用户分享链接时,为确保安全,微信会将wxticket参数清空。 |
wxextinfo | 调用“获取商品二维码接口”时传入的extinfo,为标识参数。 |
检查wxticket参数
调用该接口,可检查当前访问用户来源的商品主页,以及在网页前端获取该用户的身份信息。为保证场景的正确性,wxticket参数作为临时签名仅在20分钟内有效,超过有效时长会检查失败。
请求示例
HTTP请求方式:POST https://api.weixin.qq.com/scan/scanticket/check?access_token=access_token POST数据格式:JSON POST数据例子: { "ticket": " Ym1haDlvNXJqY3Ru1", }
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 公众号的全局凭据,用于接口调用。 |
ticket | 是 | 请求URL中带上的wxticket参数。 |
返回示例
正确的JSON返回结果如下:
{ "errcode":0, "errmsg":"ok", "keystandard":"ean13", "keystr":"6901481811083", "openid":"otAzGjrS4AYCmeJM1GhEOcHXXTAo", "scene":"scan", "is_check": false, "is_contact": false }
返回参数说明
参数 | 说明 |
---|---|
errcode | 0为调用成功,否则返回相关错误码。 |
errmsg | ok为调用成功,否则返回错误提示。 |
keystandard | 商品编码标准。 |
keystr | 商品编码内容。 |
openid | 当前访问者的openid,可唯一标识用户。 |
scene | 打开商品主页的场景,scan为扫码,others为其他场景,可能是会话、收藏或朋友圈。 |
is_check | 该条码(二维码)是否被扫描,true为是,false为否。 |
is_contact | 是否关注公众号,true为已关注,false为未关注。 |
组件消息
调用该接口,需先在“创建商品”时设置组件内容,之后可通过该接口对组件区的展示结果进行控制。
目前,商户通过微信推送的“事件”,可获得被扫码查询的商品信息以及商户之前设置的“extinfo”内容。通过和本地信息进行校验,可判断用户所查询的商品真伪,并将结果通过该接口返回微信,最终由微信在客户端定制页面上展示真伪的查询结果。
商户设置组件内容后,【用户—微信—商户】的信息交互模式如下:
推送XML示例
<xml> <ToUserName><![CDATA[gh_fbe8a958756e]]></ToUserName> <FromUserName><![CDATA[otAzGjrJVN21mpDF4ZWQiYZwdK0Y]]></FromUserName> <CreateTime>1447848568</CreateTime> <MsgType><![CDATA[event]]></MsgType> <Event><![CDATA[scan_product_callback]]></Event> <KeyStandard><![CDATA[qrcode]]></KeyStandard> <KeyStr><![CDATA[weixin_antifake]]></KeyStr> <ExtInfo><![CDATA[hyhy]]></ExtInfo> <NeedAntiFake>true</NeedAntiFake> </xml>
推送参数说明
参数 | 说明 |
---|---|
ToUserName | 商户的公众号原始id。 |
FromUserName | 用户的openid。 |
CreateTime | 消息创建时间(整型)。 |
MsgType | 消息类型,event。 |
Event | 事件类型,scan_product_callback为组件消息事件。 |
KeyStandard | 商品编码标准。 |
KeyStr | 商品编码内容。 |
ExtInfo | 调用“获取商品二维码接口”时传入的extinfo,为标识参数。 |
NeedAntiFake | 请是否使用微信提供的弹窗页面展示防伪结果,true为使用,false为未使用。 |
返回XML示例
<xml> <ToUserName><![CDATA[otAzGjrJVN21mpDF4ZWQiYZwdK0Y]]></ToUserName> <FromUserName><![CDATA[gh_fbe8a958756e]]></FromUserName> <CreateTime>1447848568</CreateTime> <MsgType><![CDATA[scanproduct]]></MsgType> <ScanProduct> <KeyStandard><![CDATA[qrcode]]></KeyStandard> <KeyStr><![CDATA[weixin_antifake]]></KeyStr> <ExtInfo><![CDATA[hyhy]]></ExtInfo> <AntiFake> <CodeResult><![CDATA[real]]></CodeResult> </AntiFake> </ScanProduct> </xml>
返回参数说明
参数 | 说明 |
---|---|
ToUserName | 用户的openid。 |
FromUserName | 商户的公众号原始id。 |
CreateTime | 消息创建时间(整型)。 |
MsgType | 消息类型,scanproduct。 |
KeyStandard | 商品编码标准。 |
KeyStr | 商品编码内容。 |
ExtInfo | 调用“获取商品二维码接口”时传入的extinfo,为标识参数。 |
AntiFake | 防伪信息的内容。 |
CodeResult | 商品防伪查询的结果,real表示码为真,fake表示码为假,not_active表示该防伪码未激活。 |
清除扫码记录
当商品主页设置了“原生防伪组件”时(详情请查看【创建商品】),用户每一次扫码查看主页,均会被计数,进而展示在“防伪查询详情”中。如果商户希望某个码的扫码记录“归零”,可调用该接口,清除该码的被扫码记录。
请求示例
HTTP请求方式:POST https://api.weixin.qq.com/scan/scanticket/check?access_token=access_token POST数据格式:JSON POST数据例子: { "keystandard": "ean13", "keystr": "6900000000000", "extinfo":"extinfo" }
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 公众号的全局凭据,用于接口调用。 |
keystandard | 是 | 商品编码标准。 |
keystr | 是 | 商品编码内容。 |
extinfo | 是 | 调用“获取商品二维码接口”时传入的extinfo,为标识参数。 |
返回示例
正确的JSON返回结果如下:
{ "errcode":0, "errmsg":"ok" }
返回参数说明
参数 | 说明 |
---|---|
errcode | 0为调用成功,否则返回相关错误码。 |
errmsg | ok为调用成功,否则返回错误提示。 |