# 获取店铺H5链接
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getshoph5url
通过该接口可以获取微信小店的店铺H5链接,支持传入企业微信参数。通过带企业微信参数的H5链接下单的订单会在成交来源展示该企业。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/basics/shop/h5url/get?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:129、131
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
wecom_corp_id | string | 否 | wpxxxxxxxx | 小店通过关联账号绑定的企业微信id,获取方式见获取关联账号企微id |
wecom_user_id | string | 否 | woxxxxxxxx | 小店通过关联账号绑定的企业微信下的成员id,获取方式见获取关联账号企微id |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 示例 | 说明 |
---|---|---|---|
errcode | number | 0 | 错误码 |
errmsg | string | ok | 错误信息 |
shop_h5url | string | https://channels.weixin.qq.com/shop/b/xsgVVZtSGpqwd45 | 店铺h5链接 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"wecom_corp_id": "wpxxxxxxxx",
"wecom_user_id": "woxxxxxxxx"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"shop_h5url": "https://channels.weixin.qq.com/shop/b/xsgVVZtSGpqwd45"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
10021404 | 企业微信未绑定店铺 | |
10021405 | 该成员不是该企业微信成员 | |
10021406 | 参数有误 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。