获取已添加到橱窗的商品列表

# 获取已添加到橱窗的商品列表

# 接口说明

通过该接口可获取已添加到橱窗的商品列表。

# 注意事项

接口限制了 page_size × page_index ≤ 10000。命中限制时建议改用传last_buffer顺序翻页的请求方式。
入参的 appid 字段与 query_cps_product 字段互斥。两者都存在时，会以 appid 字段优先，仅返回来源指定店铺的自营商品。

# 接口调用请求说明

POST https://api.weixin.qq.com/channels/ec/window/product/list/get?access_token=ACCESS_TOKEN

# 请求参数说明

参数	类型	是否必填	描述
appid	string	否	用于指定查询某个店铺来源的商品
branch_id	number	否	用于指定查询属于某个分店ID下的商品
page_size	number	是	单页商品数（不超过200）
page_index	number	否	页面下标，下标从1开始，默认为1
last_buffer	string	否	由上次请求返回，顺序翻页时需要传入, 会从上次返回的结果往后翻一页（填了该值后page_index不生效）
need_total_num	bool	否	是否需要返回满足筛选条件的商品总数
query_cps_product	bool	否	是否仅查询橱窗中的带货商品

# 请求参数示例

// 获取店铺商品
{
    "appid": "wxee9f94a3360ad25f",
    "page_size": 1,
    "page_index": 1,
    "need_total_num": true,
}

// 获取带货商品
{
    "page_size": 1,
    "page_index": 1,
    "need_total_num": true,
    "query_cps_product": true
}

# 返回参数说明

参数	类型	描述
errcode	number	错误码
errmsg	string	错误信息
products[].product_id	string(uint64)	橱窗商品id，对于带货商品则为带货商品id
products[].appid	string	对于自营商品会返回，代表商品来源店铺的appid
products[].out_product_id	string	对于带货商品会返回, 代表商品在货源小店中的商品id
products[].product_source	number	商品来源,枚举值详情请参考ProductSource
last_buffer	string	本次翻页的上下文，用于顺序翻页请求
total_num	number	商品总数

# 返回参数示例

// 自营商品返回示例
{
    "errcode": 0,
    "errmsg": "ok",
    "products": [
        {
            "product_id": "100234056",
            "appid": "wxee9f94a3360ad25f"
        }
    ],
    "last_buffer": "EB4YAg=",
    "total_num": 11
}

// 带货商品返回示例
{
    "errcode": 0,
    "errmsg": "ok",
    "products": [
        {
            "product_id": "439000124321",
            "out_product_id": "100234056",
            "product_source": 1
        }
    ],
    "last_buffer": "EB4YAg=",
    "total_num": 11
}

# 错误码

错误码	错误描述
公共错误码	-
48001	接口权限未开启，需前往视频号助手- 开放能力-开放场景打开开关
10022001	验证视频号身份失败, 请检查是否使用视频号橱窗ID请求
10022002	因违规行为, 橱窗被禁止使用, 请前往'带货中心->个人中心->带货权限'检查橱窗带货权限
10022006	请求参数错误，请检查请求参数是否符合限制

# 枚举值

ProductSource

# 商品来源

枚举值	描述
0	来源店铺的自营商品
1	来源选品中心的带货商品