完成接入准备后，商家/服务商可根据本文指引快速接入 搜索直达。

说明：

搜索直达 仅支持自研商家/服务商通过自研应用或第三方应用代调用（传入 app_auth_token）方式，调用 API 接入。

搜索直达 暂不支持沙箱调试。

认证品牌

使用 品牌直达 模式前，需先认证品牌获取 brand_id（品牌 id），用于后续搜索直达配置。

说明：

一个小程序仅支持认证一个品牌信息。

小程序直达 模式无需进行品牌认证，品牌直达 与 小程序直达 使用差异可查看使用说明。

上传资质图片

商家/服务商需调用 alipay.open.mini.miniapp.brand.upload（小程序品牌提交认证时上传用户资质以及身份信息），上传小程序品牌资质及身份信息图片内容。

**注意：**图片大小不能超过 5MB，暂仅支持 .jpg、.png、.jpeg 格式的本地图片。

提交品牌认证申请

商家/服务商完成资质文件上传获取 file_key 后，需调用 alipay.open.mini.miniapp.brand.submit（小程序品牌提交认证），提交品牌认证申请。

查询品牌审核状态及已有品牌

商家/服务商可调用 alipay.open.mini.miniapp.brand.query（小程序品牌提交认证后查询品牌审核结果以及商户已有品牌），查询当前小程序已有/审核中品牌信息。

取消品牌认证（可选）

商家/服务商可调用 alipay.open.mini.miniapp.brand.cancel（小程序品牌提交认证后取消品牌认证），在品牌认证提交后取消其认证。

配置搜索直达

商家/服务商可按如下指引调用接口，完成搜索直达的配置。

上传图片资料

商家/服务商需调用 alipay.open.file.upload（支付宝文件上传接口）将配置搜索直达所需的图片资料上传至支付宝，获取 file_id（文件 id）。

注意：

上传图片时，不同图片需使用对应的 biz_code（素材使用场景）且需要符合对应图片类型的规范，详情如下：

氛围图：biz_code = search_box_atmosphere，图片规范可查看氛围图视觉设计规范。

视频封面图：biz_code = ``search_box_videocover，图片规范可查看视频封面图规范。

活动 banner 图：biz_code = search_box_banner，图片规范可查看活动 banner 视觉设计规范。

接口调用频率限制为 10 QPM。

创建搜索直达配置

商家/服务商需调用 alipay.open.search.box.apply（申请创建搜索直达配置）创建搜索直达的基础信息，获取 box_id（搜索直达配置 id）。

注意：

创建搜索直达时，基础信息模块必填入参 service_infos（常用服务）和 related_accounts（官方账号），其它信息可创建后通过 alipay.open.search.box.modify（修改搜索直达配置）进行补充。

创建搜索直达可根据是否已关联品牌选择是否入参 brand_id（品牌 id），若应用未关联品牌，无需入参 brand_id。

brand_id（品牌 id）可通过上文 认证品牌 获取，当 brand_id 为空时，target_appid 必传。

image_id（氛围图片 id）非必填，可根据上文 上传图片资料 获取，若 brand_id 为空时，可不传氛围图。

service_infos（服务信息）需通过服务提报能力提报服务获取。

提报的服务需通过审核后（即服务为 PROMOTION 状态）才可配置常用服务。

service_infos.service_code（服务编码）为 服务提报 获取的 service_code（服务 id），服务状态可调用 alipay.open.app.service.query（服务查询接口）查询。

若需要配置商圈，可通过 alipay.open.searchbox.businessdistrict.query（查询可绑定的商圈查询）查询商圈 id，可在创建或修改直达时入参商圈 id。

创建小程序直达时，可配置 简称触发词 作为搜索直达的召回词。

若调用 alipay.open.search.box.apply（申请创建搜索直达配置）返回错误，可能是入参格式错误或不符合搜索直达准入规则，可以通过alipay.open.search.box.consult（搜索直达创建预校验）来快速校验参数格式及是否符合搜索直达准入，根据返回结果文案来做修改，通过预校验后再创建搜索直达

修改搜索直达配置

商家/服务商可调用 alipay.open.search.box.modify（修改搜索直达配置）修改搜索直达配置信息。

**注意：**每次仅支持修改一个搜索直达模块信息，支持修改模块如下：

品牌直达可修改模块：

BOX_EXCLUSIVE_FUNCTIONS：常用服务

BOX_EXCLUSIVE_ACCOUNTS：官方账号

BOX_ATMOSPHERE_IMAGE：氛围图

BOX_EXCLUSIVE_BASE：品牌介绍

BOX_EXCLUSIVE_KEYWORD：自定义触发词

小程序直达可修改模块：

BOX_EXCLUSIVE_FUNCTIONS：常用服务

查询搜索直达配置列表

商家/服务商可调用 alipay.open.search.box.batchquery（批量查询搜索直达配置列表）查询搜索直达列表信息。

**注意：**列表查询仅返回搜索直达配置基本信息，搜索直达配置详情需通过接口 alipay.open.search.box.query（查询搜索直达配置详情）进行查询。

查询搜索直达配置详情

商家/服务商可调用 alipay.open.search.box.query（查询搜索直达配置详情）查询搜索直达配置详情。

下架搜索直达

商家/服务商可调用 alipay.open.search.box.offline（下架搜索直达）下架搜索直达。

上架搜索直达

商家/服务商可调用 alipay.open.search.box.online（上架搜索直达），将已下架的搜索直达重新上架。

搜索直达升/降级

商家/服务商已开通小程序直达，后续通过品牌认证后，可将小程序直达升级到品牌直达；反之，若已开通品牌直达，但品牌认证关系解除，可降级到小程序直达来自运营。

小程序直达升级品牌直达

小程序已开通小程序直达，且已认证品牌，可通过以下接口升级到品牌直达。

查询小程序直达是否可升级

商家/服务商可调用 alipay.open.searchbox.upgrade.preconsult（搜索直达升级准入）查询小程序直达是否满足升级品牌直达的条件。

小程序直达升级为品牌直达

商家/服务商可调用 alipay.open.searchbox.upgrade.save（小程序升级成品牌直达）将小程序直达升级到品牌直达。

品牌直达降级小程序直达

小程序已开通品牌直达，且品牌认证关系已解除，可通过以下接口降级到小程序直达。

查询品牌序直达是否可降级

商家/服务商可调用 alipay.open.searchbox.downgrade.preconsult（直达降级准入）查询品牌直达是否满足降级小程序直达的条件。

品牌直达降级小程直达

商家/服务商可调用 alipay.open.searchbox.downgrade.save（搜索直达降级）将品牌直达降级到小程序直达。

运营搜索直达活动

商家/服务商可按如下指引调用接口，完成搜索直达活动的运营。

上传图片资料

商家/服务商需调用 alipay.open.file.upload（支付宝文件上传接口）将配置搜索直达所需的图片资料上传至支付宝，获取 file_id（文件 id）。

创建搜索直达活动配置

商家/服务商需调用 alipay.open.search.boxactivity.apply（申请创建搜索直达活动配置）创建搜索直达活动，获取 box_activity_id（搜索直达活动 id）。

说明：

box_id（搜索直达配置 id）需通过上文 配置搜索直达 > 创建搜索直达配置获取。

搜索直达活动可创建图片类和视频类两种活动，搜索结果页最多可展示3个在线活动轮播，不允许图片类和视频类同时在线轮播。

创建视频类活动时，material_type = VIDEO，material_id 入参为 视频内容 ID（为 生活号+ 后台上传视频获取的 内容 id，操作详情可查看短视频创建指南）。

创建 banner 活动，可添加 底纹词展示词，审核通过后有机会被推广到首页搜索框内。

提交创建搜索直达活动请求后，支付宝将按规范进行审核。规范及时效详情可查看：

小程序直达规范

品牌直达规范

修改搜索直达活动配置

商家/服务商可调用 alipay.open.search.boxactivity.modify（修改搜索直达活动配置）修改搜索直达活动配置。

查询搜索直达活动配置列表

商家/服务商可调用 alipay.open.search.boxactivity.batchquery（批量查询搜索直达活动配置）查询搜索直达活动列表信息。

查询搜索直达活动配置详情

商家/服务商可调用 alipay.open.search.boxactivity.query（查询搜索直达活动配置详情）查询搜索直达活动详情。

下架搜索直达活动

商家/服务商需调用 alipay.open.search.boxactivity.offline（下架搜索直达活动）下架搜索直达活动。

搜索直达审核进度消息通知

当提交搜索直达的基础信息、banner 活动后，支付宝将在审核通过或被驳回时通过 alipay.open.search.box.changed（搜索直达审核进度消息通知）向商家/服务商应用网关地址发送审核结果通知涉及审核信息如下：

自定义触发词

直达介绍

品牌氛围图

banner活动（图片/视频）

接入指南

认证品牌#

上传资质图片#

提交品牌认证申请#

查询品牌审核状态及已有品牌#

取消品牌认证（可选）#

配置搜索直达#

上传图片资料#

创建搜索直达配置#

修改搜索直达配置#

查询搜索直达配置列表#

查询搜索直达配置详情#

下架搜索直达#

上架搜索直达#

搜索直达升/降级#

小程序直达升级品牌直达#

查询小程序直达是否可升级#

小程序直达升级为品牌直达#

品牌直达降级小程序直达#

查询品牌序直达是否可降级#

品牌直达降级小程直达#

运营搜索直达活动#

上传图片资料#

创建搜索直达活动配置#

修改搜索直达活动配置#

查询搜索直达活动配置列表#

查询搜索直达活动配置详情#

下架搜索直达活动#

搜索直达审核进度消息通知#

认证品牌

上传资质图片

提交品牌认证申请

查询品牌审核状态及已有品牌

取消品牌认证（可选）

配置搜索直达

上传图片资料

创建搜索直达配置

修改搜索直达配置

查询搜索直达配置列表

查询搜索直达配置详情

下架搜索直达

上架搜索直达

搜索直达升/降级

小程序直达升级品牌直达

查询小程序直达是否可升级

小程序直达升级为品牌直达

品牌直达降级小程序直达

查询品牌序直达是否可降级

品牌直达降级小程直达

运营搜索直达活动

上传图片资料

创建搜索直达活动配置

修改搜索直达活动配置

查询搜索直达活动配置列表

查询搜索直达活动配置详情

下架搜索直达活动

搜索直达审核进度消息通知