# 创建赠品活动
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:addgiftactivity
可通过该接口添加买赠活动
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/product/activity/add?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:129
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 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 | 是 | 活动详情 |
# Body.detail Object Payload
活动详情
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
show_scene | number | 是 | 买赠活动生效的场景值。0:全场景展示;1:仅直播间展示 |
receive_limit | object | 是 | 限领规则 |
main_products | objarray | 是 | 买赠活动的主品 |
gift_set | object | 是 | 赠品详情 |
# Body.detail.receive_limit Object Payload
限领规则
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
is_limited | boolean | 是 | 是否限领 |
limit_num | number | 是 | 限领套数 |
# Body.detail.main_products(Array) Object Payload
买赠活动的主品
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
product_id | number | 是 | 买赠活动的主品id |
# Body.detail.gift_set Object Payload
赠品详情
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
gift_set_num | number | 是 | 买赠活动的赠品总套数 |
gift_items | objarray | 是 | 单套赠品内的赠品 |
# Body.detail.gift_set.gift_items(Array) Object Payload
单套赠品内的赠品
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
gift_id | number | 是 | 单套赠品内的赠品id |
give_num | number | 是 | 单套赠品内的赠品件数 |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
activity_id | string | 买赠活动ID,创建成功后返回 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"gift_activity": {
"activity_id": 123456789147,
"detail": {
"gift_set": {
"gift_items": [
{
"gift_id": 121212,
"give_num": 1
}
],
"gift_set_num": 1
},
"main_products": [
{
"product_id": 121212
}
],
"receive_limit": {
"is_limited": true,
"limit_num": 111
},
"show_scene": 1
},
"end_time": "11111",
"start_time": "222222",
"title": "测试创建赠品活动"
}
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"activity_id": "123456789147"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
268560001 | 活动名称为空 | |
268560002 | 活动主品列表为空 | |
268560003 | 活动赠品列表为空 | |
268560004 | 活动赠品商品不存在 | |
268560005 | 活动赠品商品不是上架状态 | |
268560006 | 活动赠品库存不足 | |
268560007 | 活动赠品总价值太高 | |
268560008 | 活动赠品价值比主品价值高 | |
268560009 | 未来的活动太多 | |
268560010 | 商品在未来的活动中已存在 | |
268560011 | 主品或者赠品不满足类目规则的要求 | |
268560012 | 不支持个人店铺类型 | |
268560013 | 赠品活动参数数量异常 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。