查询定向佣金计划带货汇总数据

收藏
我的收藏

接口说明

  • 小程序商品:
    • 通过/poi/v2/spu/sync接口同步 SPU 时,entry_info.entry_type为 2 且填充了entry_info.entry_miniApp参数的商品为小程序商品。其中entry_info.entry_miniApp.app_id为商品所属的小程序;
    • 通过/life/goods/product/save/接口发布/创建团购商品时,product.biz_line传入值为 5 时的商品。
    • 通过/goodlife/v1/goods/product/save/接口创建/修改团购活动,product.biz_line传入值为 5 时的商品。
  • 抖音来客商品:商家(或该商家对应的代运营服务商)通过抖音来客创建的商品。
  • 带货数据 T+1日生成,返回的数据是该计划累计的带货数据。

使用限制

仅当调用接口的小程序/应用与计划关联的商品存在以下关系时允许调用本接口:

  • 没有代运营关系的商品使用条件如下:
    1. 商品所属的小程序须签署《撮合平台用户服务协议》
    2. 当调用接口的应用与商品存在以下任一关系时允许应用发布/修改该商品的通用佣金计划
      • 开发者是商品所属的小程序
      • 开发者是商品的创建者
  • 具有代运营关系的商品使用条件如下:
    1. 开发者与商品归属的抖音来客商家建立代运营商服合作关系
    2. 开发者通过/goodlife/v1/partner/product_commission/save/接口设置商品的佣金,商家在抖音来客App确认该佣金比例

基本信息

名称描述
HTTP URL
https://open.douyin.com/api/match/v2/poi/oriented_plan_detail/
HTTP Method
POST
Scope
poi.cps.common
权限要求
  • 需要申请权限
    • 移动/网站应用路径:抖音开放平台 > 控制台 > 移动应用/网站应用 > 应用详情 > 权限管理 > 特殊权限
    • 小程序路径:抖音开放平台 > 控制台 > 小程序 > 能力 > 授权 > 特殊权限
  • 不需要用户授权

请求参数

请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例:application/json
固定值"application/json"
Body展开全部子属性
plan_id_list必填List
示例:待查询的定向佣金计划ID列表

[7130067823413610541,7089334664648722476]

展开子属性
请求示例
curl --location --request POST 'https://open.douyin.com/api/match/v2/poi/oriented_plan_detail/' \ --header 'access-token: clt.6f3d96edd825ef65463706f18ac9ddcdFZfKNWDaRcErCdWxbSkoOJZ7O1Ph' \ --header 'Content-Type: application/json' \ --data-raw '{ "plan_id_list": [ 7130067823413610541 ] }'

响应参数

Body展开全部子属性
data必填Struct
展开子属性
err_msg必填String
示例:系统内部错误,请重试

错误信息

err_no必填Int32
示例:0

错误码

log_id必填String
示例:20230712165544FF934AF2108A6BDA927F

请求关联日志ID

响应示例
正常响应示例异常响应示例
{ "data": { "data": { "7130067823413610540": { "gmv": 2, "media_cnt": 1, "plan_info": { "content_type": 2, "create_time": "2022-08-10", "douyin_id_list": [ "38377163415" ], "end_time": 1661937164, "plan_name": "zzh_boe_test", "start_time": 1660097711, "commission_duration": 1, "plan_id": 7130067823413610000, "product_list": [ { "commission_rate": 2900, "product_id": 7088277603718564000 } ], "status": 3, "talent_status_map": { "38377163415": 3 }, "update_time": "2022-08-10" }, "used_gmv": 1 } }, "date": "2022/07/01" }, "err_msg": "", "err_no": 0, "log_id": "20230712165544FF934AF2108A6BDA927F" }
切换单列布局

错误码

HTTP 状态码错误码错误码描述排查建议
20028001005
系统内部错误,请重试
发起抖音开放平台Oncall工单,务必提供如下信息:开发者所请求的Http路径、请求体信息、Http响应体信息中返回的log_id字段
20028013017
佣金计划不存在,请检查计划ID是否正确
①该字段必须为数字类型,不能传字符串 ②自检Http客户端出口请求体中的佣金计划ID,是否存在精度丢失问题,比如计划ID后3位变为0。
20028001007
参数不合法
自检请求参数是否符合接口文档的要求
20028013011
暂无调用佣金计划相关接口的权限
自检小程序服务商的”生活服务代运营服务商“的行业身份是否认证成功