接口说明

该接口主要控制抖音c端订单详情页跳转“核销工具”小程序去使用按钮可见性。

前提条件

需要是核销工具or混合双开的小程序

使用限制

•需要是核销工具or混合双开的小程序 •如需设置c端按钮全量用户可见，需先让运营同学验收。 •access-token获取的方式获取access_token接口说明

基本信息

名称	描述
HTTP URL	https://open.douyin.com/api/apps/trade/v2/toolkit/button_white_setting/
HTTP Method	POST
Scope	industry_solution.tool.button_white_setting
权限要求	需要是核销工具or混合双开的小程序

请求参数

请求头

access-token必填String

示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ

调用https://open.douyin.com/oauth/client_token/生成的token

content-type必填String

示例：application/json

固定值"application/json"

Body展开全部子属性

button_type必填Enum

设置的按钮类型1-核销工具,2-外卖到家,3-外卖到店,4-详情页

展开子属性

gray_rateInt64

灰度比例，0-100

open_allBool

全量用户可见字段 • true:代表所有用户都可以看到c端去使用按钮，从而跳转核销工具小程序 • False: 关闭

uid_listArray<Int64>

示例：[11111,22222,3333]

uid维度白名单，每次传入都是全量覆盖。 • uid_list&open_all 至少传入一个 • uid_list数量不能超过100 • 每次传入uid_list均为全量覆盖 ◦ 比如第一次传入[11,22] ◦ 第二次传入[33,44] ◦ 则最后只有[33,44]在白名单列表中

请求示例
curl --location --request POST 'https://open.douyin.com/api/apps/trade/v2/toolkit/button_white_setting/' \
--header 'content-type: application/json' \
--header 'access-token: 0801121846735352506a356a6' \
--data '{
{
    "button_type":1,
    "uid_list":[123, 4666],
    "open_all": true
}
}'

响应参数

Body

err_msg必填String

错误信息

err_no必填Int32

错误code

log_id必填String

示例：20230821172419537A2CC91C30Fxxxxxx

log_id：日志Id，发起Oncall时建议带在问题描述中

响应示例
正常响应示例异常响应示例
{
  "err_msg": "",
  "err_no": 0,
  "log_id": "202308281411468B45C32B08FA3C4FAEC8"
}

切换单列布局

错误码

HTTP 状态码	错误码	错误码描述	排查建议
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理
200	28001005	系统内部错误，请重试	请求重试，若依然无解请向平台提交反馈
200	28001003	access_token无效	重新请求生成access_token
200	28001008	access_token过期,请刷新或重新授权	重新请求生成access_token
200	28001016	当前应用已被封禁或下线	clientKey被封禁或者下线
200	28001006	网络调用错误，请重试	重试即可
200	28001014	应用未授权任何能力	确认应用是否授权能力
200	28001018	应用未获得该能力	开通相关能力
200	28003017	quota已用完	联系平台处理
200	28001019	应用该能力已被封禁	该能力被封禁，联系平台处理
200	28001007	参数不合法	根据错误信息检查请求参数是否填写正常

开发者文档

设置订单详情页按钮白名单接口

接口说明

前提条件

使用限制

基本信息

请求参数

响应参数

错误码

设置订单详情页按钮白名单接口在线调试

接口说明

前提条件

使用限制

基本信息

请求参数

响应参数

错误码

设置订单详情页按钮白名单接口