# 定向计划接口
接口名称 | 说明 |
---|---|
查询定向计划详情 | 支持推客通过该接口获取定向计划的详细信息 |
申请加入定向计划 | 支持推客申请加入定向计划 |
查询定向计划申请状态 | 支持推客获取定向计划的申请状态 |
# 1.查询定向计划详情
# 接口说明
根据计划邀请链接获取定向计划的详细信息
# 请求地址
GET https://api.weixin.qq.com/union/promoter/target/plan_info?access_token=ACCESS_TOKEN
# 请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token | string | 是 | 接口调用凭证 | |
planInvitationUrl | string | 是 | 定向计划邀请链接 |
# 返回值
# Object
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
targetPlanInfo | object | 定向计划数据 |
productListInfo | Array.<Object> | 定向计划商品数据 |
targetPlanInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
planId | string | 计划ID |
planStatus | string | 计划状态 |
planName | string | 计划名称 |
planDesc | string | 计划描述 |
planStartTime | number | 计划开始时间(时间戳) |
planEndTime | number | 计划结束时间(时间戳) |
extInfo | string | 所属商店基本信息 |
planStatus 的枚举
值 | 类型 | 说明 |
---|---|---|
0 | number | 未生效 |
1 | number | 有效 |
2 | number | 失效 |
productListInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
planId | string | 计划ID |
productId | string | 商品ID |
productStatus | number | 商品状态 |
commissionRatio | number | 佣金率 |
productDetailInfo | object | 商品信息 |
leagueExInfo | object | 佣金信息 |
couponInfo | object | 优惠券信息 |
productDetailInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
title | string | 商品标题 |
subTitle | string | 商品子标题 |
headImg | Array.<string> | 商品主图 |
category | Array.<string> | 商品类目 |
category[].catId | Object | 类目ID |
category[].name | Object | 类目名称 |
brand | string | 品牌名称 |
brandId | string | 品牌ID |
model | string | 型号 |
detail | Object | 商品详细数据 |
detail.detailImg | Array.<string> | 商品详情图片 |
param | Array.<Object> | 商品参数 |
minPrice | number | 商品最低价格,单位分 |
totalStockNum | number | 总库存 |
totalSoldNum | number | 累计销量 |
skus | Array.<Object> | 商品SKU |
skus[].skuId | string | 商品SKU ID |
skus[].productSkuInfo.thumbImg | string | 商品SKU 小图 |
skus[].productSkuInfo.salePrice | Object | 商品SKU 销售价格,单位分 |
skus[].productSkuInfo.marketPrice | Object | 商品SKU 市场价格,单位分 |
skus[].productSkuInfo.stockInfo.stockNum | number | 商品SKU 库存 |
leagueExInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
hasCommission | number | 是否有佣金,1/0 |
commissionRatio | number | 佣金比例,万分之一 |
commissionValue | number | 佣金金额,单位分 |
couponInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
hasCoupon | number | 是否有联盟券,1为含券商品,0为全部商品 |
couponId | string | 券id |
couponDetail | Object | 券详情 |
couponDetail 的结构
属性 | 类型 | 说明 |
---|---|---|
restNum | number | 券库存 |
type | number | 券类型 |
discountInfo | Object | 券面额 |
validInfo | Object | 有效期 |
receiveInfo | Object | 领券时间 |
discountInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
discountCondition.productIds[] | string | 指定商品 id |
discountCondition.productCnt | number | 商品数 |
discountCondition.productPrice | number | 商品金额 |
discountNum | number | 折扣数,如 5.1 折 为 5.1 * 1000 |
discountFee | number | 直减金额,单位为分 |
validInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
validType | number | 有效期类型,1 为商品指定时间区间,2 为生效天数 |
validDayNum | number | 生效天数 |
startTime | string | 有效开始时间 |
endTime | string | 有效结束时间 |
receiveInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
startTime | string | 领取开始时间戳 |
endTime | string | 领取结束时间戳 |
limitNumOnePerson | number | 每人限领张数 |
# 返回示例
{
"errcode": 0,
"errmsg": "ok",
"targetPlanInfo": {
"planId": "1964112935262240768",
"planStatus": 1,
"planName": "TEST定向计划CR",
"planDesc": "TEST定向计划CR",
"planStartTime": 1629216000,
"planEndTime": 1630166399,
"extInfo": {
"bizBasicInfo": {
"headimgurl": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM77ia7ibuPAQBJgME8gFF9APicaSpd7evrLCVb5hn2zsUBOw",
"nickname": "猪腩肉小商店",
"appid": "wxb825f130c284597f"
},
"data": {}
}
},
"productListInfo": [
{
"planId": "1964112935262240768",
"productId": "37610006",
"productStatus": 1,
"commissionRatio": 700,
"productDetailInfo": {
"headImg": [
"https://store.mp.video.tencent-cloud.com/161/20304/snscosdownload/SZ/reserved/60a77aac00065bee000000006a849d09000000a000004f50"
],
"category": [
{
"catId": "1208",
"name": "宠物生活"
},
{
"catId": "1224",
"name": "猫狗出行"
},
{
"catId": "1227",
"name": "宠物鞋服"
}
],
"param": [],
"attr": [],
"shopcatId": [],
"qualificationUrl": [],
"thirdCategoryHistories": [],
"headVideoInfo": [],
"labels": [],
"title": "新商品哈哈中",
"subTitle": "",
"model": "",
"detail": {
"detailImg": [],
"detailVideos": [],
"detailVideoInfo": [],
"desc": ""
},
"brandId": "2100000000",
"skuIdList": {
"skuIds": [
"77255098"
]
},
"skuList": {
"skuInfo": [
{
"skuId": "77255098",
"price": 110
}
],
"minPrice": 110,
"maxPrice": 110
},
"listingTime": "1626181943",
"totalStockNum": "128",
"serviceDesc": {
"serviceList": [],
"desc": ""
},
"expressInfo": {
"templateId": "37926"
},
"totalSoldNum": "2",
"appidForMedia": "wx4aedf8c9edf9fd72",
"snapshotInfo": {
"snapshotId": "0"
},
"totalOrderNum": "2",
"totalVisitNum": "1",
"uploadSource": 5,
"spuLimited": {
"periodType": 0,
"limitedBuyNum": 0
},
"originUploadSource": 1,
"groupbuyInfo": {
"skuList": []
},
"virtualType": 0,
"productType": 1
},
"leagueExInfo": {
"hasCommission": 1,
"commissionRatio": 700,
"commissionValue": 7,
"banBizuin": 0,
"banCategory": 0,
"banProduct": 0
},
"couponInfo": {
"allCouponIds": [],
"hasCoupon": 0,
"couponId": "0",
"discount": "0"
}
}
]
}
# 错误码
值 | 说明 |
---|---|
202002 | 计划不存在 |
# 2.申请加入定向计划
# 接口说明
申请加入定向计划
# 请求地址
POST https://api.weixin.qq.com/union/promoter/target/apply_target?access_token=ACCESS_TOKEN
# 请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token | string | 是 | 接口调用凭证 | |
planId | string | 是 | 定向计划ID(base64格式) | |
applyReason | string | 是 | 申请原因 |
# POST 数据示例
{
"planId": "123LKAJSDLKJSADLKwqij21dsdsdsd312joewq=",
"applyReason": "推客申请加入原因"
}
# 返回值
# Object
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
# 返回示例
{
"errcode": 0,
"errmsg": "ok",
}
# 错误码
值 | 说明 |
---|---|
202001 | 计划已失效 |
202002 | 计划不存在 |
202004 | 推客已申请过该计划 |
202006 | 推客申请计划理由超出长度限制 |
# 3.查询定向计划申请状态
# 接口说明
查询推客申请定向计划的状态
# 请求地址
GET https://api.weixin.qq.com/union/promoter/target/apply_status?access_token=ACCESS_TOKEN
# 请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token | string | 是 | 接口调用凭证 | |
planId | string | 是 | 定向计划ID(base64格式) |
# 返回值
# Object
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
data | object | 申请状态数据 |
data 的结构
属性 | 类型 | 说明 |
---|---|---|
planId | string | 计划ID |
promoterStatus | number | 申请状态 |
applyTime | number | 申请时间(时间戳) |
joinTime | number | 加入时间(时间戳) |
applyReason | string | 申请原因 |
rejectTime | number | 拒绝时间(时间戳) |
promoterStatus 的枚举
值 | 类型 | 说明 |
---|---|---|
0 | number | 可以报名 |
1 | number | 待审核 |
2 | number | 已同意 |
3 | number | 已拒绝 |
999 | number | 不可报名 |
# 返回示例
{
"errcode": 0,
"errmsg": "ok",
"data": {
"planId": "1964112935262240768",
"promoterStatus": 1,
"applyTime": 1626692835,
"joinTime": 0,
"applyReason": "okok",
"rejectTime": 0,
"removeTime": 0
}
}
# 错误码
值 | 说明 |
---|---|
202001 | 计划已失效 |
202002 | 计划不存在 |
202005 | 该推客未申请计划 |