用户开通产品包权益
拥有此API的权限集 |
---|
订购管理-增删改 |
接口描述
- 一步生成订购关系:合并下单和开通订购关系两个接口
- 该接口为较老版本,推荐使用新版开通产品权益包2.0接口
请求方式及url
- 请求方式:
POST
- 请求头:
Content-Type:application/json
- 接口地址:
https://api.xiaoe-tech.com/xe.order.delivery/1.0.0
- 频率限制:
10秒500次
在线调试工具
请求
响应
请求参数
参数名 | 必选 | 类型 | 说明 | 备注(示例) |
---|---|---|---|---|
access_token | 是 | string | 专属token | xe_xxxxx |
user_id | 是 | string | 用户 | ... |
data.payment_type | 是 | int | 付费类型 | payment_type =2为单品, payment_type =3为产品包,payment_type=15为超级会员(详细见备注) |
data.resource_type | 是 | int | 资源类型 | ... |
data.resource_id | 是 | string | 单品ID | 当payment_type=2时,必填,可使用 查询商品列表2.0获取resource_id的值 |
data.product_id | 是 | string | 产品包ID | 当payment_type=3时,必填,同上,可使用 查询商品列表2.0获取resource_id的值 |
data.user_id | 是 | string | 用户ID | 可使用 获取用户列表2.0获取user_id的值 |
data.out_order_id | 否 | string | 外部订单号 | ... |
data.pay_way | 否 | int | 支付渠道,默认是0 | 0-线上微信,2-线上支付宝,1-未指定方式 |
data.channel_id | 否 | string | 渠道ID | ... |
data.channel_info | 否 | string | 渠道来源 | ... |
data.period | 否 | string | 有效期 | 秒数,超级会员订单:必传,详情见备注 |
data.period_time | 否 | string | 买会员的开始时间 | 2019-02-20 15:15:00,超级会员订单:必传 |
data.agent | 否 | string | 用户设备信息 | ... |
data.discount_price | 否 | int | api优惠金额 | ... |
data.source | 否 | int | 开通知识带货商品必传:10 | 目前暂不支持知识带实物和实物带货 |
备注
- payment_type类型说明
- payment_type=2表示单品,包含:图文,音频,视频,直播,社群,课程(训练营pro);开通以上课程时,课程id通过data.resource_id传入;
- payment_type=3表示产品包,包含:专栏,会员,大专栏,训练营;开通以上课程时,课程id传data.product_id;
- payment_type=15表示超级会员,包含:超级会员;开通超级会员时,data.product_id传超级会员id;
- resource_type表示课程或资源类型
- 1-图文,2-音频,3-视频,4-直播,5-会员,6-专栏,7-社群,8-大专栏,23-超级会员,25-训练营,50-课程(训练营pro);
- 会员是有有效期的,当多次调取开课接口,在有效期内视为续费订单,有效期做累加
- 关于超级会员的时长计算
- period 过期时间(秒数)目前小鹅通可自定义类型:7天,一个月(30天),3个月(90天),半年(180天),一年(365天),示例:604800,开通超级会员必传;
- period_time购买超级会员的开始(生效)时间,类型:日期,示例:2019-02-20 15:15:00,开通超级会员必传;
- 超级会员过期时间:是购买超级会员的开始生效时间(period_time)加上period时长;
- 如果在当前用户超级会员过期时间内再次开通超级会员,算为续费订单,过期时间做累加;
请求示例
{
"access_token":"xe_xxxxx",
"user_id":"xxxx",
"data" : {
"payment_type":2,
"resource_type":6,
"resource_id":"i_xxxx",
"product_id":"p_xxxxxxxx",
"user_id":"xxxx",
"out_order_id":"order_xxx",
"pay_way":0,
"channel_id":"xxx",
"channel_info":"xxx",
"period":"xxx",
"period_time":"2020-01-07 12:00:00",
"agent":"Mozilla/5.0 (iPhone; CPU iPhone OS 12_1_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/16C101 MicroMessenger/7.0.3(0x17000321) NetType/3G Language/zh_CN"
}
}
返回参数
参数名 | 必选 | 类型 | 说明 | 备注 |
---|---|---|---|---|
code | 是 | int | 请求结果码 | 请求成功返回0,请求失败错误码请查看错误码描述说明 |
msg | 是 | string | 描述信息 | 无 |
data | 是 | class | 数据 | 无 |
data.price | 是 | int | 商品价格 | 单位是分 |
data.order_id | 是 | string | 订单编号 | 无 |
data.purchase_name | 是 | string | 商品名称 | 无 |
data.created_at | 是 | string | 创建时间 | 无 |
返回示例
{
"code": 0,
"msg": "success",
"data": {
"price": 1,
"user_id": "xxxxxxxx",
"order_id": "o_xxxx",
"purchase_name": "xxxxxxx",
"created_at": {
"date": "2019-04-26 17:16:52.000000", // 开通权益的创建时间
"timezone_type": 3,
"timezone": "PRC"
}
}
}