查询通用佣金计划

小程序商品查询通用佣金计划

Scope: poi.cps.common 需要申请权限 不需要用户授权

该接口用于查询小程序商品关联的通用佣金计划列表。

使用限制

  • 仅可查询小程序商品(小程序商品定义见下)关联的通用佣金计划
  • 仅当调用接口的应用与商品存在以下关系时允许应用查询该商品的通用佣金计划列表 应用是商品的创建者 应用是商品所属的小程序

接口说明

小程序商品：通过/poi/v2/spu/sync/接口同步 SPU 时，entry_info.entry_type为 2 且填充了entry_info.entry_miniApp参数的商品为小程序商品。其中entry_info.entry_miniApp.app_id为商品所属的小程序。

通用佣金计划：原「CPS 商品佣金设置」升级为「通用佣金计划」，支持以下能力：

  • 设置商品通用分佣率，所有达人都可以带货该商品
  • 设置支持的带货场景（直播/短视频/均可）
  • 查询计划关联的带货信息

基本信息

HTTP URL

https://open.douyin.com/poi/plan/list/

HTTP Method

POST

Scope

poi.cps.common

权限要求

  • 需要申请权限  路径：抖音开放平台 > 管理中心 > 应用详情 > 特殊权限
  • 不需要用户授权

请求头

名称

类型

必填

描述

Content-Type

string

是

固定值 application/json

access-token

string

是

调用 /oauth/client_token/ 生成的 token，此 token 不需要用户授权。示例: clt.1d1021d2aee3d41fee2d2add43456badMFZnrhFhfWotu3Ecuiuka27L56lr

请求参数

Query 请求

无

Body 请求

名称

类型

是否必填

示例值

描述

spu_id

int

是

7089053269443495980

抖音商品ID

  • 使用多门店SPU同步接口(/poi/v2/spu/sync/)的对应返回数据中的spu_id字段
  • 使用新商品库接口(/life/goods/product/save/)的对应返回数据中的product_id字段

page_no

int

是

1

分页参数：页码，从1开始计数

page_size

int

是

10

分页参数：数量，1<=page_size<=100

请求示例

curl --location --request POST 'http://open.douyin.com/poi/plan/list/' \
--header 'access-token: clt.451b472ce4bebc54fefd926482863677GfqNFp4g8XvXodw3ffjRWfkJQF32' \
--header 'Content-Type: application/json' \
--data-raw '{
    "spu_id": 7088277603718563884,
    "page_no": 1,
    "page_size": 100
}'

响应参数

名称

类型

描述

示例值

page_count

int

总页数

10

total

int

总计划数

100

data

[]obejct

通用佣金计划列表

[{ "commission_rate": 2888, "content_type": 2, "create_time": "2022-04-22", "plan_id": 7089334664648722476, "status": 1 }]

commission_rate

int

分佣率，万分位

2900

content_type

int

计划支持的带货场景，可选以下的值：

  • 1：仅短视频
  • 2：仅直播间
  • 3：短视频和直播间

1

create_time

string

计划创建时间

2022-04-25

plan_id

int

计划ID

7089334664648722476

status

int

可选值：

  • 1：进行中
  • 2：暂停中
  • 3：已终止

3

响应示例

正常示例

{
  "data": {
    "data": [
      {
        "commission_rate": 2888,
        "content_type": 2,
        "create_time": "2022-04-22",
        "plan_id": 7089334664648722476,
        "status": 1
      }
    ],
    "page_count": 1,
    "total": 8,
    "error_code": 0,
    "description": ""
  },
  "extra": {
    "description": "",
    "error_code": 0,
    "logid": "20220426184533010225145152084C7731",
    "now": 1650969933,
    "sub_description": "",
    "sub_error_code": 0
  }
}

异常示例

{
  "data": {
    "error_code": 2100007,
    "description": "无权限操作"
  },
  "extra": {
    "description": "无权限操作",
    "error_code": 2100007,
    "logid": "20220426180719010225142142054AC378",
    "now": 1650967640,
    "sub_description": "没有发布/修改通用佣金计划的权限",
    "sub_error_code": 110003
  }
}

错误码

进入状态码排查工具，输入 API 名称和状态码，查询调用结果。

诚邀您对本文档易读易用性进行评价
好用
不好用