用户开通产品包权益2.0
拥有此API的权限集 |
---|
订购管理-增删改 |
接口描述
- 一步生成订购关系:合并下单和开通订购关系两个接口
请求方式及url
- 请求方式:
POST
- 请求头:
Content-Type:application/json
- 接口地址:
https://api.xiaoe-tech.com/xe.order.delivery/2.0.0
- 频率限制:
10秒500次
在线调试工具
请求
响应
请求参数
参数名 | 必选 | 类型 | 说明 | 备注(示例) |
---|---|---|---|---|
access_token | 是 | string | 专属token | xe_xxxx |
data.user_id | 是 | string | 用户ID | 可使用获取用户列表2.0获取user_id的值 |
data.with_package | 否 | int | 是否发放商品打包售卖权益 | 默认0, 0-不发放 1-发放 |
data.pay_way | 否 | string | 支付渠道,默认是0 | 0-线上微信,1-线上支付宝 |
data.out_order_id | 否 | string | 商家侧关联外部订单号 | 具有唯一性 |
data.transaction_id | 否 | string | 商家侧交易单号 | … |
data.product_infos | 是 | array | 商品列表 | 商品列表最多暂仅支持20个 |
data.product_infos[].spu_id | 是 | string | 统一商品ID | 可使用商品详情2.0获取spu_id的值 |
data.product_infos[].sku_id | 是 | string | 统一商品规格ID | 可使用商品详情2.0获取sku_id的值, 多规格可匹配有效期等获取相应sku_id |
data.product_infos[].buy_num | 否 | int | 购买份数 | 默认1,暂只支持实物、有价券设置购买份数,其他商品类型暂不支持多份购买 |
data.product_infos[].discount_price | 否 | int | api优惠金额 | 商品优惠金额 ,单位:分 |
data.product_infos[].period | 否 | int | 有效期 | 商品发放有效期,单位秒, 实物类、有价优惠券不支持 |
data.product_infos[].period_time | 否 | string | 权益开始生效时间 | period有值时有效,发放权益截止时间为 权益开始生效时间 + 权益有效期,不填默认当前时间开始生效,仅支持超级会员 |
data.express | 否 | array | 快递配送信息 | 当订单商品(包含带货发放商品)中含有实物时,必填 |
data.express.receiver | 是 | string | 收货人 | … |
data.express.phone | 是 | string | 收货人联系方式 | … |
data.express.province | 是 | string | 收货人地址省份 | … |
data.express.city | 是 | string | 收货人地址城市 | … |
data.express.county | 是 | string | 收货人地址所在区 | … |
data.express.detail | 是 | string | 收货人地址详细地址 | … |
备注
- 加密课程兑换暂只支持1个商品进行开通兑换,加密商品请单独调用,不能和其他商品混合,加密课程开通由于业务限制,暂不生成对应订单。 加密课程兑换暂只支持图文、音频、视频、会员、专栏、大专栏、训练营、电子书、大班课、课程(训练营pro)
- 会员、超级会员等商品支持有效期,重复调用相当于重复发放,可通过传递out_order_id字段进行幂等性处理,会对out_order_id判重
- 商品发放有效期可自定义,商品价格以传递sku_id对应的价格为准,如有有效期,可匹配对应的sku_id进行传递,因可自定义规则,不做转换。以商家传递为准。实物类、有价优惠券暂不支持自定义有效期
- 默认不发放商品打包售卖权益,可传递with_package参数调整。包含实物需要传收货人配置信息。
- 支持商品类型: 图文、音频、视频、直播、会员、专栏、大专栏、电子书、超级会员、训练营、课程(训练营pro)、圈子、有价优惠券、AI互动课、实物
- 商品发放有效期period、权益开始生效时间period_time对加密课程无效,加密课程兑换暂不支持自定义有效期发放
- 暂不支持自提配送方式
- 实物和有价券可购买多份,其他商品类型暂不支持
- 实物单运费为0,暂不支持设置运费
请求示例
{
"access_token": "xxxxx",
"user_id": "u_635b820c43bdc_ObiLUHdHKF",
"data": {
"user_id": "u_635b820c43bdc_ObiLUHdHKF",
"with_package": 1,
"product_infos": [
{
"spu_id": "s_642e2cff7422f_KEOxxxx",
"sku_id": "SKU_SVP_6807477758246iEqxxxx",
"period": "86400"
},
{
"spu_id": "p_642e2e3de4b06de2f8xxxx",
"sku_id": "SKU_SPC_6807480940544Wg5xxxx",
"period": "86400"
}
],
"express": {
"receiver": "哈哈哥",
"phone": "1382748xxxx",
"province": "广东省",
"city": "深圳市",
"county": "南山区",
"detail": "科兴科学园A2"
}
}
}
返回参数
参数名 | 必选 | 类型 | 说明 | 备注(示例) |
---|---|---|---|---|
code | 是 | int | 请求结果码 | 请求成功返回0,请求失败错误码请查看错误码描述说明 |
msg | 是 | string | 描述信息 | 无 |
data.orders | 是 | array | 生成订单信息 | |
data.orders[].price | 是 | int | 商品价格 | 单位是分 |
data.orders[].order_id | 是 | string | 订单编号 | 无, 加密课程兑换返回 password_commit,无生成对应订单 |
data.orders[].purchase_name | 是 | string | 订单名称 | 无 |
data.orders[].created_at | 是 | string | 创建时间 | 无 |
返回示例
{
"code": 0,
"msg": "",
"data": {
"orders": [
{
"created_at": "2023-03-29 15:15:28",
"order_id": "o_1680074128_6423e5906c221_018xxxxx",
"price": 1,
"purchase_name": "yeleon图文勿动-TEST006",
"user_id": "u_lp_1624268336_60d05e306e1c5_Vhxxxx"
}
]
}
}