接口说明

小程序商品:

  • 通过/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 商品佣金设置」升级为「通用佣金计划」,支持以下能力:

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

使用限制

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

基本信息

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

请求参数

请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例:application/json
固定值"application/json"
Body
commission_rate必填Int64
示例:100

商品的抽佣率,万分数。

小程序商品可选值范围:100-2900

具有代运营商服合作关系的商品可选值范围:100-8000,须小于或等于商家确认的佣金比例

content_type必填Int32
示例:1

商品支持的达人带货场景,可选以下的值:

  • 1:仅短视频
  • 2:仅直播间
  • 3:短视频和直播间
spu_id必填Int64
示例:7088277603718563884

上传小程序商品时返回的抖音内部商品ID。

plan_idInt64
示例:7089053269443495980

计划ID,创建计划时,plan_id不传或传0。修改现有计划时,传入待修改计划的ID

请求示例
curl --location 'https://open.douyin.com/api/match/v2/poi/save_common_plan/' \ --header 'access-token: clt.92b211d508375eda61bea2c27e********************' \ --header 'Content-Type: application/json' \ --header 'Cookie: passport_csrf_token=2e89a3edbd25ad5***********; passport_csrf_token_default=2e89a3edb***************' \ --data '{ "spu_id": 7181296975965374505, "content_type": 3, "commission_rate": 100 }'

响应参数

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

错误信息

err_no必填Int32
示例:0

错误码

log_id必填String
示例:20230712165544FF934AF2108A6BDA927F

请求关联日志ID

响应示例
正常响应示例异常响应示例
{ "data": { "plan_id": 7088277603718564000 }, "err_msg": "", "err_no": 0, "log_id": "20230712165544FF934AF2108A6BDA927F" }
切换单列布局

错误码

HTTP 状态码错误码错误码描述排查建议
20028001005
系统内部错误,请重试
发起抖音开放平台Oncall工单,务必提供如下信息:开发者所请求的Http路径、请求体信息、Http响应体信息中返回的log_id字段
20028013017
佣金计划不存在,请检查计划ID是否正确
自检商品或计划绑定的商品与小程序对应的生活服务代运营服务商是否已建立商服合作关系
20028013013
商品不存在
①该字段必须为数字类型,不能传字符串 ②自检Http客户端出口请求体中的佣金计划ID,是否存在精度丢失问题,比如计划ID后3位变为0。
20028013012
未签署《撮合平台用户服务协议》,请在开发者平台的站内信中完成签署后重试(站内信标题为“撮合协议签署”),如已签署仍持续报错可联系平台技术oncall
①自检Http客户端出口请求体中的商品ID,是否存在精度丢失问题,比如商品ID后3位变为0。 ②自检商品是否已处于上架状态
20028013021
因系统升级,期间暂不支持此功能
按错误信息内容提示登录开发者平台操作即可
20028001007
参数不合法
自检请求参数是否符合接口文档的要求
20028013018
无权操作该商品,只有商品的创建者或所属小程序有权限,请检查access-token及对应的client_key是否满足条件
按错误信息内容提示自检
20028013011
暂无调用佣金计划相关接口的权限
自检小程序服务商的”生活服务代运营服务商“的行业身份是否认证成功
20028013020
暂无操作该商品的权限
自检商品与小程序对应的生活服务代运营服务商是否已建立商服合作关系