# 获取商品卡片的DOM结构
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:ecsgetproductcardinfo
本接口用于获取在文章中插入商品卡片所需的DOM结构
注:不同文章类型支持的卡片类型范围不同
- 图片消息:支持小卡、文字链接、条卡
- 图文消息:支持大卡、小卡、文字链接
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/service/product/getcardinfo?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
product_id | string | 是 | 1000000000 | 商品id |
article_type | string | 是 | newspic | 文章类型,当前支持:图片消息(newspic)、图文消息(news) |
card_type | number | 是 | 2 | 卡片类型,当前支持:大卡(0)、小卡(1)、文字链接(2)、条卡(3) |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
product_key | string | 商品 key,部分文章类型插入商品卡片需要该 key |
DOM | string | 商品卡DOM结构,多数文章类型插入商品卡片需要DOM结构 |
# 4. 注意事项
正常情况下调用成功时,errcode将为0。错误时微信会返回错误码等信息,请根据错误码查询错误信息。
product_key 和 DOM 只会在需要该字段的文章类型及卡片类型的请求中返回。
# 5. 代码示例
请求示例
{
"product_id": "1000000000",
"article_type": "newspic",
"card_type": 2
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"product_key": "PRODUCT_KEY",
"DOM": "DOM"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
0 | ok | 成功 |
10170001 | 不合法的商品ID | |
10170002 | 不支持的文章类型 | |
10170003 | 不支持的卡片类型 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
公众号 | 服务号 |
---|---|
✔ | ✔ |
- ✔:该账号可调用此接口
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;