创建开发者接口发券活动
收藏
我的收藏接口说明
使用接口发券活动需注意:
- 「接口发券活动」同「主播发放计划」一致,在创建活动/计划时均会预扣减库存,需要开发者自行控制券模板库存容量保障各活动/计划的正常创建和发放;
- 同个券模板可以创建多个「接口发券活动」,彼此间库存相互独立;
- 「接口发券活动」与券模板共享生命周期,开发者在创建「接口发券活动」并发放后应及时使用「删除开发者接口发券活动」释放预扣的库存,保证整体券模板库存的可用性。
使用限制
只可以使用状态为生效且库存充足的券模板创建活动。
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/api/promotion/v1/coupon/create_developer_activity/ |
HTTP Method | POST |
Scope | promotion.coupon.admin |
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例:application/json
固定值"application/json"
Body
app_id必填String
示例:ttec789ac573xxxxxx01
小程序appid
coupon_meta_id必填String
示例:721807xxxxxx5644204
已创建的抖音开放平台券模板id,通过/api/promotion/v2/coupon/create_coupon_meta/接口返回的coupon_meta_id字段获取
coupon_stock_number必填Int64
示例:100
发放活动计划使用的库存,要求不超过券模板剩余库存
merchant_activity_id必填String
示例:abc
商家活动ID,不超过20位,不支持中文,开发者自行定义(开发者内部系统的发放活动自增id或uuid,抖音开放平台会校验该值在小程序维度下 的唯一性,用于保证预扣库存的幂等性)
activity_nameString
示例:小程序内发券同步
开发者接口发券活动名称,开发者自行定义
请求示例
curl --location 'https://open.douyin.com/api/promotion/v1/coupon/create_developer_activity' \ --header 'access-token: clt.xxx' \ --header 'Content-Type: application/json' \ --data '{ "app_id":"ttec789ac573xxxxxx01", "coupon_meta_id":"721807xxxxxx5644204", "merchant_activity_id":"abc", "coupon_stock_number": 100, "activity_name": "小程序内发券同步" }'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
err_msg必填String
示例:"access_token无效"
错误描述
err_no必填Int32
示例:28001003
错误码
log_id必填String
示例:"202405291440576E078D8757B9"
日志id
响应示例
正常响应示例异常响应示例
{ "err_no": 0, "err_msg": "", "log_id": "20230602111931B8431F7C63978600E24C", "data": { "activity_id": "702345xxxxxx" } }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 28001005 | 系统内部错误,请重试 | 请求重试,若依然无解请向平台提交反馈 |
200 | 28001003 | access_token无效 | 重新请求生成access_token |
200 | 28001008 | access_token过期,请刷新或重新授权 | 重新请求生成access_token |
200 | 28001006 | 网络调用错误,请重试 | 重试即可 |
200 | 28001007 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |
200 | 29005026 | 无效券活动 | 当前券模板状态不属于「生效」,不允许创建活动 |
点击纠错