微信開發(微信掃一掃)商品建立
微信公眾平臺開放“掃一掃”功能,同時開放相關介面供有許可權的品牌所有者呼叫。介面支援建立、管理併發布品牌所有者的商品資訊,品牌所有者可選擇商品條碼釋出。微信同時提供多種事件推送,幫助品牌所有者實現精準運營、資料分析等能力。
掃一掃介面主要呼叫流程如下:
許可權獲取
掃一掃功能申請只能在公眾平臺上完成,功能申請開通後將直接獲得介面許可權。許可權包括:商品經營類目許可權、商品條碼號段許可權。建立商品時只能使用擁有許可權的類目。
術語含義說明
術語概念 | 含義 |
---|---|
品牌所有者 | 也稱商戶、商家,是指合法擁有品牌的企業。可以申請“掃一掃”功能。 |
掃碼 | 使用微信“掃一掃”掃描條碼。 |
條碼 | 掃一掃支援錄入的條碼型別為EAN13和EAN8,國內常見的EAN13條碼是以69開頭的13位條碼,前7~9位數字標記該條碼的生產企業,被稱為號段;最後一位為校驗位,由前面的12位位數字計算得出,碼方式可參考國標GB-12094-1998。 |
號段 | 條碼號段為EAN13碼的前7~9位,用於確認廠商資訊,保護品牌的相關權益。申請“掃一掃”許可權時需提供對應資質。特別地,ENA8碼的號段為其本身。 |
商品主頁 | 通過微信“掃一掃”,在微信客戶端內開啟,由品牌商定義的商品資訊頁。 |
商品詳情 | 通過點選“商品主頁”頭部區域,在跳轉後的頁面展示,由品牌商設定的商品詳細資訊。包括多組商品圖片,多組文字描述。 |
購買區入口 | 位於商品主頁上部,點選後集中展示品牌商設定的“建議零售價”、“微信小店”、“電商連結”以及匹配到的“電商渠道”等入口和其對應價格。 |
推廣服務區 | 位於商品主頁中部,提供多媒體展示、文字介紹、跳轉外部連結、關注公眾號、領取微信卡券等多種自定義能力。 |
元件區 | 包括在“商品主頁”開啟前展示的彈窗頁,以及位於“商品主頁”下部的區域。用於快速突出展示該主頁的核心資訊,如防偽資訊等。 |
相關商品推薦 | 位於商品主頁底部,展示由品牌商設定推薦的其他商品主頁。 |
商品建立
獲取商戶資訊
使用該介面,商戶可獲取賬號下的類目與號段等資訊。
請求示例
HTTP請求方式:GET
https://api.weixin.qq.com/scan/merchantinfo/get?access_token=TOKEN
請求引數說明
引數 | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 公眾號的全域性憑據,用於介面呼叫。 |
返回示例
正確的JSON返回結果如下:
{
"errcode": 0,
"errmsg": "ok",
"verified_cate_list":[
{
"verified_cate_id": 200531967,
"verified_cate_name": "調味品"
}
],
"verified_firm_code_list":[8888],
"brand_tag_list":[
"小耿哥8",
"testtag"
]
}
返回引數說明
引數 | 是否必須 |
---|---|
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萬條商品資訊。
請求示例
HTTP請求方式:POST
https://api.weixin.qq.com/scan/product/create?access_token=tT8VqJWVX4C-WvIG41tyelMclMZsAPFbLxbECsJvIghceqQCMB83hI5bxcInUR-amUrVsKq4bcBmF9PgooNrFA
POST資料格式:JSON
POST資料例子:
{
"keystandard": "ean13",
"keystr": "6900000000000",
"brand_info":{
"base_info":{
"title": "掃一掃動態主頁demo",
"thumb_url":"http://mmbiz.qpic.cn/mmbiz/AhrnkhhK7rWevHib2pmq1phtply6JicADNrX6Yrvd7LzKERyic3kn3VdSsmFr5F5ibXzj9Al65yWFudmjqcWic1Qe9g/0",
"brand_tag": "小耿哥8",
"category_id": 0,
"store_mgr_type": "auto",
"store_vendorid_list":[],
"color": "auto",
},
"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": "price",
"retail_price":"12.00"
},
{
"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"
},
{
"type": "text",
"text": "此處可根據品牌商需要,用於簡單描述商品或活動。"
}
]
},
"module_info":{
"module_list":[
{
"type": "anti_fake",
"native_show": "fales",
"anti_fake_url": "weixin.qq.com"
}
]
}
}
}
請求引數說明
POST的主要結構為brand_info,包含商品基本資訊base_info、商品詳情資訊detail_info、推廣服務資訊action_info和元件資訊module_info四部分。
引數 | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 公眾號的全域性憑據,用於介面呼叫。 |
keystandard | 是 | 商品編碼標準,暫時只支援ean13和ean8兩種標準。 |
keystr | 是 | 商品編碼內容。直接填寫商品條碼,如“6900000000000”;注意:編碼標準是ean13時,編碼內容必須在商戶的號段之下,否則會報錯。 |
base_info | 是 | 商品的基本資訊。 |
detail_info | 是 | 商品的詳細描述資訊。 |
action_info | 是 | 商品的推廣服務區資訊。 |
module_info | 否 | 商品的元件資訊。 |
base_info部分
引數 | 是否必須 | 說明 |
---|---|---|
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個漢字。 |
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 | 是 | 京東商城 | 電商入口的名稱。 |
sale_price | 是 | 12.50 | 對應商品的價格,單位元。 |
型別:商品推薦
引數 | 是否必須 | 說明 |
---|---|---|
type | 是 | 服務欄型別,商品推薦的值為recommende。 |
recommend_type | 是 | 表示商品推薦的方式,目前只支援指定,值為appointed。 |
recommend_list | 是 | 表示指定要推薦的商品列表 |
keystandard | 是 | 表示被推薦的商品編碼格式。 |
keystr | 是 | 表示被推薦商品的編碼內容。 |
“商品推薦”的JSON示例:
{
"type": "recommend",
"recommend": {
"recommend_type": "appointed",
"recommend_list": [
{
"keystandard": "ean13",
"keystr": "6900000000001"
},
{
"keystandard": "ean13",
"keystr": "6900873042720"
}
]
}
}
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": "5g0B4A90aqc"
}
返回引數說明
引數 | 說明 |
---|---|
errcode | 0為呼叫成功,否則返回相關錯誤碼。 |
errmsg | ok為呼叫成功,否則返回錯誤提示。 |
pid | 轉譯後的商品id,在微信系統內唯一區分一個商品。 |