定向计划接口 | 微信开放文档

# 定向计划接口

接口名称	说明
查询定向计划详情/列表	支持开发者通过该接口获取定向计划的详细信息
申请加入定向计划	支持开发者申请加入定向计划
查询定向计划申请状态	支持开发者获取定向计划的申请状态

# 1.查询定向计划详情/列表

# 接口说明

根据计划邀请链接获取定向计划的详细信息/列表

# 请求地址

GET https://api.weixin.qq.com/union/promoter/target/plan_info?access_token=ACCESS_TOKEN

# 请求参数（查询计划列表）

属性	类型	默认值	必填	说明
access_token	string		是	接口调用凭证
offset	number	0	否	定向计划列表查询偏移量
limit	number	10	否	定向计划列表每页项数
totalStatus	number		否	定向计划状态，不传则拉全部计划

# 请求参数（查询计划详情）

属性	类型	默认值	必填	说明
access_token	string		是	接口调用凭证
planInvitationUrl	string		否	定向计划邀请链接，与offset、limit、totalStatus二选一

totalStatus 的枚举

值	类型	说明
1	number	生效
2	number	失效

# 返回值

# Object

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息
planList	Array.<Object>	定向计划列表数据
totalCnt	number	定向计划总数
targetPlanInfo	object	定向计划详情数据
productListInfo	Array.<Object>	定向计划的商品详情数据

planList 的结构（计划列表）

属性	类型	说明
planId	string	计划ID
planName	string	计划名称
planDesc	string	计划描述
planStatus	string	计划状态
planType	number	计划类型
planStartTime	number	计划开始时间（秒级时间戳）
planEndTime	number	计划结束时间（秒级时间戳）
productListInfo	Array.<Object>	商品信息列表
productTotalCnt	number	商品总数
shopInfo	object	所属商家基本信息

shopInfo 的结构

属性	类型	说明
headimgurl	string	头像URL
nickname	string	商家名称
appid	string	商家APPID
username	string	商家用户名

planStatus 的枚举

值	类型	说明
0	number	未生效
1	number	有效
2	number	失效

planType 的枚举

值	类型	说明
0	number	小商店
1	number	小程序

productListInfo 的结构

属性	类型	说明
planId	string	计划ID
productId	string	商品ID
productStatus	number	商品状态
commissionRatio	number	佣金率
planType	number	计划类型
productDetailInfo	object	商品信息
leagueExInfo	object	佣金信息
couponInfo	object	优惠券信息（当前仅小商店商品有优惠券信息）

targetPlanInfo 的结构（计划详情）

属性	类型	说明
planId	string	计划ID
planStatus	string	计划状态
planName	string	计划名称
planDesc	string	计划描述
planStartTime	number	计划开始时间（时间戳）
planEndTime	number	计划结束时间（时间戳）
planType	number	计划类型
shopInfo	string	所属商家基本信息

productDetailInfo(planType=0，小商店商品) 的结构

属性	类型	说明
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 库存
skus[].productSkuInfo.stockInfo.stockNum	number	商品SKU 库存

productDetailInfo(planType=1，小程序商品) 的结构

属性	类型	说明
productId	string	商品SPUID
outProductId	string	商家自定义的商品SPUID
title	string	商品标题
headImg	Array.<string>	商品主图
cats	Array.<string>	商品类目
cats[].catId	Object	类目ID
cats[].name	Object	类目名称
brandId	string	品牌ID
descInfo	Object	商品描述信息
descInfo.imgs	Array.<string>	商品描述图片
descInfo.desc	Array.<string>	商品描述文本
path	string	商品详情页的路径
skus	Array.<Object>	商品SKU
skus[].skuAttrs	Array.<Object>	商品SKU 属性
skus[].skuAttrs.attrKey	string	商品SKU 属性key
skus[].skuAttrs.attrValue	string	商品SKU 属性value
skus[].skuId	string	商品SKU ID
skus[].outSkuId	string	商家自定义的商品SKU ID
skus[].thumbImg	string	商品SKU 小图
skus[].salePrice	Object	商品SKU 销售价格，单位分
skus[].marketPrice	Object	商品SKU 市场价格，单位分
skus[].stockNum	number	商品SKU 库存
minPrice	number	商品最低价格，单位分
totalStockNum	number	总库存

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	每人限领张数

# 返回示例（查询计划列表-传入offset/limit）

{
    "errcode": 0,
    "errmsg": "ok",
    "planList": [
        {
            "planId": "2018450394284179456",
            "planName": "test base name",
            "planDesc": "test base desc",
            "planStatus": 1,
            "planType": 0,
            "planStartTime": 1630425600,
            "planEndTime": 1632931200,
            "shopInfo": {
                "nickname": "测试小商店",
                "username": "gh_d39d8b94b",
                "headimgurl": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM77ia7ibuPAQBJgME8gFF9APicaSpd7evrLCVb5hn2zsUBOw",
                "appid": "wxb825f130c284"
            },
            "productListInfo": [
                {
                    "planId": "2018450394284179456",
                    "productId": "36078017",
                    "productStatus": 1,
                    "commissionRatio": 7000,
                    "planType": 0,
                    "productDetailInfo": {
                        "title": "竨dsu",
                        "subTitle": "",
                        "headImg": [
                            "https://store.mp.video.tencent-cloud.com/161/20304/snscosdownload/SZ/reserved/60a25c4100087e4a000000006a849d09000000a000004f50"
                        ],
                        "category": [
                            {
                                "catId": "1421",
                                "name": ""
                            },
                            {
                                "catId": "1443",
                                "name": ""
                            },
                            {
                                "catId": "1448",
                                "name": ""
                            }
                        ],
                        "brandId": "2100000000",
                        "model": "",
                        "detail": {
                            "detailImg": [],
                            "detailVideos": [],
                            "detailVideoInfo": [],
                            "desc": ""
                        },
                        "param": [],
                        "totalStockNum": "115",
                        "totalSoldNum": "5",
                        "skuList": {
                            "skuInfo": [
                                {
                                    "skuId": "70969103",
                                    "price": 140
                                }
                            ],
                            "minPrice": 140,
                            "maxPrice": 140
                        }
                    }
                }
            ],
            "productTotalCnt": 1
        },
        {
            "planId": "2025408324988452864",
            "planName": "参数加了plantype",
            "planDesc": "最后一个",
            "planStatus": 1,
            "planType": 1,
            "planStartTime": 1630339200,
            "planEndTime": 1631203200,
            "shopInfo": {
                "nickname": "医保非税小测试",
                "username": "gh_6e10896a3e3c",
                "headimgurl": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM6PxkhYKuFL3Xy6ibu3lJAhosuicqM92GLDdBRHySZuVibiag",
                "appid": "wx539e0b4872f196d1"
            },
            "productListInfo": [
                {
                    "planId": "2025408324988452864",
                    "productId": "411664954",
                    "productStatus": 1,
                    "commissionRatio": 1500,
                    "planType": 1,
                    "productDetailInfo": {
                        "productId": "411664954",
                        "outProductId": "1625193120000",
                        "title": "封面设计图兑换封面使用权(1625193120000)",
                        "headImg": [
                            "https://store.mp.video.tencent-cloud.com/161/20304/snscosdownload/SH/reserved/60cc6f6200022e3f0000000049ec7164000000a000004f50?imageView2/3/w/750"
                        ],
                        "cats": [
                            {
                                "catId": "1495",
                                "level": 1,
                                "name": "家用电器"
                            },
                            {
                                "catId": "1559",
                                "level": 2,
                                "name": "商用电器"
                            },
                            {
                                "catId": "1600",
                                "level": 3,
                                "name": "香肠/热狗机"
                            }
                        ],
                        "brandId": "2100000000",
                        "descInfo": {
                            "imgs": [
                                "https://store.mp.video.tencent-cloud.com/161/20304/snscosdownload/SH/reserved/60cc6f6200022e3f0000000049ec7164000000a000004f50?imageView2/3/w/750"
                            ],
                            "desc": "xxxxx"
                        },
                        "path": "pages/productDetail/productDetail?productId=1625193120000",
                        "skus": [
                            {
                                "skuAttrs": [
                                    {
                                        "attrKey": "选择颜色",
                                        "attrValue": "红蓝主机"
                                    },
                                    {
                                        "attrKey": "选择套装",
                                        "attrValue": "主机+保护套"
                                    }
                                ],
                                "skuId": "350313607",
                                "outSkuId": "1625193119990",
                                "thumbImg": "https://store.mp.video.tencent-cloud.com/161/20304/snscosdownload/SH/reserved/60de7aa2000440d900000000a3e04f09000000a100004f50",
                                "salePrice": 1,
                                "marketPrice": 1,
                                "stockNum": "100",
                                "skuCode": "A24525252",
                                "barcode": "13251454",
                                "outProductId": "1625193120000"
                            }
                        ],
                        "totalStockNum": 100,
                        "minPrice": 1
                    }
                }
            ],
            "productTotalCnt": 1
        },
    ],
    "totalCnt": 1
}

# 错误码

值	说明
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	拒绝时间（时间戳）
planType	number	计划类型

planType 的枚举

值	类型	说明
0	number	小商店
1	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	该推客未申请计划