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

开发环境

http://dev-cn.your-api-server.com

POST

https://open.douyin.com/api/apps/trade/v2/toolkit/button_white_setting

接口说明

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

使用限制

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

如需设置c端按钮全量用户可见，需先让运营同学验收。

access-token获取的方式获取access_token接口说明

错误码

错误码	描述	排查建议
28018002	参数错误	根据msg检查自己的参数
28018007	暂时无法设置全量白名单，需等待小程序验收后	原因：req请求open_all为true，但是该小程序未验收解决：联系运营同学验收
28018006	当前小程序app_id:xxxxx，不是（核销工具｜混合双开）类型	原因：传入的button_type不正确

Q&A

存量小程序是否还需要验收？

存量小程序如果已经全量放量则不需要，否则需要运营在后台验收。

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

{
    "err_msg": "string",
    "err_no": 0,
    "log_id": "string"
}

请求参数

Header 参数

content-type

string

必需

access-token

string

必需

Body 参数application/json

button_type

integer

必需

设置的按钮类型1-核销工具,2-外卖到家,3-外卖到店 0，1，3 核销工具小程序传入1 混合双开可传入2或3

uid_list

array[integer]

可选

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

open_all

boolean

可选

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

示例

返回响应

🟢200成功

application/json

Body

err_msg

string

必需

err_no

integer

必需

log_id

string

必需

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

修改于 2023-12-01 06:37:22

查询商家配置文案

设置小程序跳转path

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

接口说明#

使用限制#

错误码#

Q&A#

存量小程序是否还需要验收？#

请求参数

返回响应

接口说明

使用限制

错误码

Q&A

存量小程序是否还需要验收？