通用佣金计划查询带货数据
接口说明
小程序商品:
- 通过/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 时的商品。
抖音来客商品:商家(或该商家对应的代运营服务商)通过抖音来客创建的商品。
通用佣金计划:原「CPS 商品佣金设置」升级为「通用佣金计划」,支持以下能力:
- 设置商品通用分佣率,所有达人都可以带货该商品
- 设置支持的带货场景(直播/短视频/均可)
- 查询计划关联的带货信息
使用限制
查询的通用佣金计划 id 对应的商品必须满足以下条件:
- 没有代运营关系的商品使用条件如下:
- 商品所属的小程序须签署《撮合平台》协议
- 当调用接口的应用与商品存在以下任一关系时允许应用发布/修改该商品的通用佣金计划
- 开发者是商品所属的小程序
- 开发者是商品的创建者
- 具有代运营关系的商品使用条件如下:
- 开发者与商品归属的抖音来客商家建立代运营商服合作关系
- 开发者通过/goodlife/v1/partner/product_commission/save/接口设置商品的佣金,商家在抖音来客App确认该佣金比例
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/api/match/v2/poi/common_plan_sell_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
示例:[
7089334664648722476,
7089053269443495980,
7089050168758126636,
7088994684067907628
]
通用佣金计划ID列表,plan_id从此即可获取
展开子属性
请求示例
curl --location --request POST 'https://open.douyin.com/api/match/v2/poi/common_plan_sell_detail/' \ --header 'access-token: clt.451b472ce4bebc54fefd926482863677GfqNFp4g8XvXodw3ffjRWfkJQF32' \ --header 'Content-Type: application/json' \ --data-raw '{ "plan_id_list": [ 7089334664648722476, 7089053269443495980, 7089050168758126636, 7088994684067907628 ] }'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
err_msg必填String
示例:没有发布/修改通用佣金计划的权限
错误信息
err_no必填Int32
示例:0
错误码
log_id必填String
示例:20220426180719010225142142054AC378
本次请求的唯一标识,用于排查问题
响应示例
正常响应示例异常响应示例
{ "data": { "data": { "7089334664648722476": { "gmv": 722476, "plan_id": 7089334664648722000, "talent_commission": 22476, "used_gmv": 2476 }, "7088994684067907628": { "talent_commission": 7628, "used_gmv": 7628, "gmv": 907628, "plan_id": 7088994684067908000 }, "7089050168758126636": { "used_gmv": 6636, "gmv": 126636, "plan_id": 7089050168758127000, "talent_commission": 26636 }, "7089053269443495980": { "gmv": 495980, "plan_id": 7089053269443496000, "talent_commission": 95980, "used_gmv": 5980 } }, "date": "2022-04-26" }, "err_no": 0, "err_msg": "", "log_id": "202204261850470102251331420B4ED661" }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 0 | 成功 | |
200 | 28013011 | 暂无调用佣金计划相关接口的权限 | 自检小程序服务商的”生活服务代运营服务商“的行业身份是否认证成功 |
200 | 29002011 | 当前应用已被抖音授权禁用,无法授权 | |
200 | 28001005 | 系统内部错误,请重试 | 发起抖音开放平台Oncall工单,务必提供如下信息:开发者所请求的Http路径、请求体信息、Http响应体信息中返回的log_id字段 |
200 | 28013012 | 未签署《撮合平台用户服务协议》,请在开发者平台的站内信中完成签署后重试(站内信标题为“撮合协议签署”),如已签署仍持续报错可联系平台技术oncall | |
200 | 28001007 | 参数不合法 | 自检请求参数是否符合接口文档的要求 |
200 | 28013013 | 商品不存在 | |
200 | 28013014 | 任务不存在 | |
200 | 28013020 | 暂无操作该商品的权限 | 自检商品或计划绑定的商品与小程序对应的生活服务代运营服务商是否已建立商服合作关系 |
200 | 28013016 | 达人抖音ID不存在,请检查后重试 | 检查错误信息中提示不存在的抖音ID是否真实存在 |
200 | 28013017 | 佣金计划不存在,请检查计划ID是否正确 | |
200 | 28013018 | 无权操作该商品,只有商品的创建者或所属小程序有权限,请检查access-token及对应的client_key是否满足条件 | ①该字段必须为数字类型,不能传字符串。②自检Http客户端出口请求体中的佣金计划ID,是否存在精度丢失问题,比如计划ID后3位变为0。 |
200 | 28013021 | 因系统升级,期间暂不支持此功能 | |
200 | 28001033 | 访问接口QPS超过限制 | |
200 | 28013022 | 达人设置异常触发封禁,请明日再试 |