
微信公众平台开放“扫一扫”功能,同时开放相关接口供有权限的品牌所有者调用。接口支持创建、管理并发布品牌所有者的商品信息,品牌所有者可选择商品条码发布。微信同时提供多种事件推送,帮助品牌所有者实现精准运营、数据分析等能力。
扫一扫接口主要调用流程如下:
扫一扫功能申请只能在公众平台上完成,功能申请开通后将直接获得接口权限。权限包括:商品经营类目权限、商品条码号段权限。创建商品时只能使用拥有权限的类目。
术语概念 | 含义 |
---|
品牌所有者 | 也称商户、商家,是指合法拥有品牌的企业。可以申请“扫一扫”功能。 |
扫码 | 使用微信“扫一扫”扫描条码。 |
条码 | 扫一扫支持录入的条码类型为EAN13和EAN8,国内常见的EAN13条码是以69开头的13位条码,前7~9位数字标记该条码的生产企业,被称为号段;最后一位为校验位,由前面的12位位数字计算得出,码方式可参考国标GB-12094-1998。 |
号段 | 条码号段为EAN13码的前7~9位,用于确认厂商信息,保护品牌的相关权益。申请“扫一扫”权限时需提供对应资质。特别地,ENA8码的号段为其本身。 |
商品主页 | 通过微信“扫一扫”,在微信客户端内打开,由品牌商定义的商品信息页。 |
商品详情 | 通过点击“商品主页”头部区域,在跳转后的页面展示,由品牌商设置的商品详细信息。包括多组商品图片,多组文字描述。 |
购买区入口 | 位于商品主页上部,点击后集中展示品牌商设置的“建议零售价”、“微信小店”、“电商链接”以及匹配到的“电商渠道”等入口和其对应价格。 |
推广服务区 | 位于商品主页中部,提供多媒体展示、文本介绍、跳转外部链接、关注公众号、领取微信卡券等多种自定义能力。 |
组件区 | 包括在“商品主页”打开前展示的弹窗页,以及位于“商品主页”下部的区域。用于快速突出展示该主页的核心信息,如防伪信息等。 |
相关商品推荐 | 位于商品主页底部,展示由品牌商设置推荐的其他商品主页。 |
“商品主页”术语概念对照图:
使用该接口,商户可获取账号下的类目与号段等信息。
请求示例
请求参数说明
参数 | 是否必须 | 说明 |
---|
access_token | 是 | 公众号的全局凭据,用于接口调用。 |
返回示例
正确的JSON返回结果如下:
返回参数说明
参数 | 是否必须 |
---|
errcode | 0为调用成功,否则返回相关错误码。 |
errmsg | ok为调用成功,否则返回错误提示。 |
verified_cate_id_list | 商户类目列表,包含类目ID与对应的类目名称。 |
verified_cate_id | 商户类目ID,表示该账户下可用于创建商品的类目ID。 |
verified_cate_name | 商户类目名称,对应类目ID的名称。 |
verified_firm_code_list | 商户号段列表,包含该账户下有资质的条码号段。 |
brand_tag_list | 品牌标签列表,创建商品时传入,商户自定义生成的品牌标识字段。 |
注意:商户容易忽略verified_cate_id,导致下一步商品创建失败。
使用该接口,商户可以创建商品信息,设置商品主页。目前,一个账号最多支持创建10万条商品信息。
请求示例
请求参数说明
参数 | 是否必须 | 说明 |
---|
title | 是 | 商品名称,建议不超过15个字,超过部分在客户端上以省略号显示。 |
thumb_url | 是 | 商品缩略图,推荐尺寸为180px*180px,大小不超过50k,支持jpg、png、gif、jpeg格式。 |
brand_tag | 是 | 品牌字段,如“宝洁海飞丝”、“宝洁飘柔”。 |
category_id | 是 | 商品类目ID,通过“获取商户信息”接口获取。 |
store_mgr_type | 否 | 是否展示有该商品的电商渠道,识别条件是编码内容。auto为自动,由微信识别展示渠道;custom为自定义,商户可指定store_vendorid_list内的渠道出现。 |
store_vendorid_list | 否 | 电商渠道,如果store_mgr_type为custom,则可从以下电商渠道进行选择:2为亚马逊,3为当当网,4为京东,9为一号店,11为聚美优品,19为酒仙网 |
color | 否 | 主页头部背景色。设置“auto”或不填则自动取色;也支持传入十六进制颜色码自定义背景色。比如,“FFFFFF”代表纯白色。注意:颜色码不识别大小写,也不需要传入“#” |
detail_info部分
参数 | 是否必须 | 说明 |
---|
banner_list | 是 | 商品详情页中可设置多张图片。 |
link | 是 | 商品详情页顶端横幅图片,640px*320px,单张≤200k,支持jpg、png、gif、jpeg格式,最多可上传6张。 |
detail_list | 是 | 商品详情页中可设置多组商品属性。 |
title | 是 | 商品详情页中商品属性名称,≤6个汉字。 |
desc | 否 | 商品详情页中商品属性内容,≤80个汉字。 |
action_info部分
参数 | 是否必须 | 说明 |
---|
action_list | 是 | 商品主页中可设置多个服务栏。 |
type | 是 | 服务栏的类型,Media,视频播放;Text,文字介绍;Link,图片跳转;Link,普通链接;User,公众号;Card,微信卡券;Price,建议零售价;Product,微信小店;Store,电商链接;recommend,商品推荐。 |
类型:视频播放
参数 | 是否必须 | 说明 |
---|
type | 是 | 服务栏类型,视频类型的参数值为"media"。 |
link | 是 | 对应的视频链接,仅支持在v.qq.com上传的视频内容,格式请按JSON示例拼接。 |
image | 是 | 对应视频的封面,推荐尺寸690px*320px,大小不超过200k,支持jpg、png、gif、jpeg格式。 |
类型:文字介绍
参数 | 是否必须 | 示例值 | 说明 |
---|
type | 是 | text | 服务栏类型。 |
name | 否 | 商品介绍 | 对应文字介绍的标题。 |
text | 是 | 此处可根据品牌商需要,用于简单描述商品或活动。 | 对应文字介绍的内容。 |
类型:图片跳转
参数 | 是否必须 | 说明 |
---|
type | 是 | 服务栏类型,图片跳转类型的参数值为"link"。 |
link | 是 | 对应图片跳转后的网页链接。 |
image | 是 | 对应跳转入口的图片链接,请参考JSON示例。 |
showtype | 是 | 值为banner,设置图片跳转类型的服务栏时必填。 |
类型:普通链接
参数 | 是否必须 | 示例值 | 说明 |
---|
type | 是 | link | 服务栏类型。 |
name | 是 | 查看官网 | 链接入口的名称,不超过12个汉字。 |
link | 是 | http://www.qq.com | 对应跳转后的网页链接。 |
digest | 否 | 点击查看 | 服务栏右侧的引导语,不超过5个汉字。 |
类型:公众号
参数 | 是否必须 | 示例值 | 说明 |
---|
type | 是 | user | 服务栏类型。 |
类型:微信卡券
参数 | 是否必须 | 示例值 | 说明 |
---|
type | 是 | card | 服务栏类型。 |
cardid | 是 | pbLatjlZyVY2XCKfIDULuD_J_PKI | 卡券必须为非自定义code(概念说明见微信卡券接口文档)。 |
digest | 否 | 全场通用 | 服务栏右侧的引导语,不超过5个汉字。 |
类型:建议零售价
参数 | 是否必须 | 示例值 | 说明 |
---|
type | 是 | price | 服务栏类型。 |
retail_price | 是 | 12.00 | 表示商品的建议零售价,以“元”为单位。 |
类型:微信小店
参数 | 是否必须 | 示例值 | 说明 |
---|
type | 是 | product | 服务栏类型。 |
name | 是 | 官网商城 | 微信小店入口的名称。 |
productid | 是 | pLHCTjvXB6vIqUYUn51AWsK-sKA8 | 对应小店商品的id,需保证有效。 |
digest | 否 | 限时折扣 | 服务栏右侧的引导语,不超过5个汉字。 |
类型:电商链接
参数 | 是否必须 | 示例值 | 说明 |
---|
type | 是 | store | 服务栏类型。 |
name | 是 | 京东商城 | 电商入口的名称。 |
link | 是 | http://m.jd.com/product/14091549.html | 对应电商的链接,建议是可以直接购买该商品的页面。 |
sale_price | 是 | 12.50 | 对应商品的价格,单位元。 |
类型:商品推荐
参数 | 是否必须 | 说明 |
---|
type | 是 | 服务栏类型,商品推荐的值为recommende。 |
recommend_type | 是 | 表示商品推荐的方式,目前只支持指定,值为appointed。 |
recommend_list | 是 | 表示指定要推荐的商品列表 |
keystandard | 是 | 表示被推荐的商品编码格式。 |
keystr | 是 | 表示被推荐商品的编码内容。 |
“商品推荐”的JSON示例:
module_info部分
参数 | 是否必须 | 说明 |
---|
module_list | 否 | 未来可设置多个组件,目前仅支持防伪组件。 |
type | 否 | 组件的类型,目前仅包括防伪组件anti_fake。 |
native_show | 否 | 设置为true时,防伪结果使用微信提供的弹窗页面展示,商户仅需调用“商品管理”部分的组件消息接口回传产品真假信息。设置为false时,无防伪弹窗效果。 |
anti_fake_url | 否 | 商户提供的防伪查询链接,当native_show设置为false时必填。 |
注意:
1、推广服务区action_info部分,入口数量规则如下:
1)至少设置一个推广类型;
2)文字介绍、公众号和微信卡券三种推广类型,每种类型最多只能分别设置1个;
3)普通链接、公众号、微信卡券三种类型合计最多设置3个;
4)图片跳转链接和视频播放只能二选一展示;
2、商品主页中必须存在至少一个价格信息,价格的展示渠道有四种:
1)在base_info中定义store_mgr_type和store_vendorid_list字段。如果商品在设置的电商渠道有销售,则会有售卖入口在【购买区】展示。例如:“洋河-天之蓝 480ml”在“京东商城”有销售,假设京东商城又在该商品设置的电商渠道列表中,则会有“京东商城”的售卖入口出现。
2)在微信小店(Product)类型中设置productid,购买区将出现对应商品的微信小店售卖入口。
3)在电商链接(Store)类型中设置目标地址链接(link),购买区将出现所配置的外部商城售卖入口。
4)在建议零售价(Price)类型中设置retail_price字段。如果商品没有设置前文所述的任何一种购买渠道,也会有该商品建议零售价展示。
返回示例
正确的JSON返回结果如下:
返回参数说明
参数 | 说明 |
---|
errcode | 0为调用成功,否则返回相关错误码。 |
errmsg | ok为调用成功,否则返回错误提示。 |
pid | 转译后的商品id,在微信系统内唯一区分一个商品。 |