activity_type 、 threshold_type 等 3 个字段,更新 show_scene 、 receive_limit 等字段描述接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:addgiftactivity
可通过该接口添加买赠活动 a可通过该接口创建赠品活动,支持买赠(主品加赠)与满赠(满足门槛后赠送)两种玩法。
POST https://api.weixin.qq.com/channels/ec/product/activity/add?access_token=ACCESS_TOKEN
本接口支持第三方平台代微信小店商家调用。第三方服务商调用模式介绍
该接口所属的权限集 id 为:129
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代微信小店商家进行调用,具体可查看 第三方调用 说明文档。
Query String Parameters| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token(微信小店商家)、authorizer_access_token(服务商代调用) |
Request Payload| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| activity_id | number | 否 | 买赠活动 id ,如果不填,则自动生成 |
| title | string | 是 | 买赠活动标题 |
| start_time | number | 是 | 买赠活动开始时间(秒级时间戳),只能取大于等于当前时间的值,且距离当前时间不得超过 30 天 |
| end_time | number | 是 | 买赠活动结束时间(秒级时间戳),必须大于当前时间以及 start_time ,且活动持续时间(end_time-start_time)需大于等于 10 分钟,小于等于 30 天 |
| detail | object | 是 | 活动详情 |
Object Payload活动详情
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| show_scene | number | 是 | 买赠活动生效场景。0=全场景展示,1=仅直播间展示。当前 Open API 仅支持传 0(全场景),传 1 可能无法生效 |
| receive_limit | object | 否 | 限领规则。赠品分享活动(activity_type=1)时建议传入;赠品独享/满赠门槛活动可不传或传空对象 |
| main_products | objarray | 是 | 买赠活动主商品列表,至少 1 个、最多 1000 个 |
| gift_set | object | 是 | 赠品详情,至少包含 1 个赠品;赠品分享活动(activity_type=1)时只能配置 1 种赠品 |
| activity_type | number | 否 | 活动类型。0=赠品独享(默认),1=赠品分享,2=满赠门槛。不传时按 0 处理 |
| threshold_type | number | 否 | 满赠门槛类型,activity_type=2 时必填。1=满金额,2=满件数 |
| threshold_money | number | 否 | 满赠门槛金额,单位:分。threshold_type=1 时必填;须为 100 的整数倍(即整元),大于 0 且不超过 10000000(10 万元) |
| threshold_product_num | number | 否 | 满赠门槛件数。threshold_type=2 时必填;须大于 1 且不超过 1000 |
Object Payload限领规则。赠品分享活动(activity_type=1)时建议传入;赠品独享/满赠门槛活动可不传或传空对象
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| is_limited | boolean | 是 | 是否限领 |
| limit_num | number | 是 | 限领套数 |
Object Payload买赠活动主商品列表,至少 1 个、最多 1000 个
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| product_id | number | 是 | 买赠活动的主品 id |
Object Payload赠品详情,至少包含 1 个赠品;赠品分享活动(activity_type=1)时只能配置 1 种赠品
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| gift_set_num | number | 是 | 买赠活动的赠品总套数 |
| gift_items | objarray | 是 | 单套赠品内的赠品 |
Object Payload单套赠品内的赠品
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| gift_id | number | 是 | 单套赠品内的赠品 id |
| give_num | number | 是 | 单套赠品内的赠品件数 |
Response Payload| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| activity_id | string | 买赠活动 ID ,创建成功后返回 |
本接口无特殊注意事项
请求示例
{
"gift_activity": {
"activity_id": 123456789147,
"detail": {
"gift_set": {
"gift_items": [
{
"gift_id": 121212,
"give_num": 1
}
],
"gift_set_num": 1
},
"main_products": [
{
"product_id":"10000000000001"
}
],
"receive_limit": {
"is_limited": true,
"limit_num": 111
},
"show_scene": 1
},
"end_time": 1704067200,
"start_time": 1704067200,
"title": "测试创建赠品活动"
}
}
{
"gift_activity": {
"title": "测试创建满赠门槛活动",
"start_time": 1783413600,
"end_time": 1784018400,
"detail": {
"show_scene": 0,
"activity_type": 2,
"threshold_type": 1,
"threshold_money": 9900,
"main_products": [
{
"product_id": 10000000000001
}
],
"gift_set": {
"gift_items": [
{
"gift_id": 121212,
"give_num": 1
}
],
"gift_set_num": 100
}
}
}
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"activity_id": "123456789147"
}
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 268560001 | 活动名称为空 |
| 268560002 | 活动主品列表为空 |
| 268560003 | 活动赠品列表为空 |
| 268560004 | 活动赠品商品不存在 |
| 268560005 | 活动赠品商品不是上架状态 |
| 268560006 | 活动赠品库存不足 |
| 268560007 | 活动赠品总价值太高 |
| 268560008 | 活动赠品价值比主品价值高 |
| 268560009 | 未来的活动太多 |
| 268560010 | 商品在未来的活动中已存在 |
| 268560011 | 主品或者赠品不满足类目规则的要求 |
| 268560012 | 不支持个人店铺类型 |
| 268560013 | 赠品活动参数数量异常 |
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。
activity_type 、 threshold_type 等 3 个字段,更新 show_scene 、 receive_limit 等字段描述