搜索直达创建预校验

开发环境

POST

/v3/alipay/open/search/box/consult

alipay.open.search.box

用于对搜索直达创建申请的入参和条件进行提前判断校验。
具体准入条件参考搜索直达准入条件

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/open/search/box/consult' \
--header 'Content-Type: application/json' \
--data-raw ''

响应示例

200 - 示例 1

{
  "access": true,
  "not_pass_items": "[\"小程序未设置搜索可见\"]"
}

请求参数

Body 参数application/json

area_keywords

string

可选

小程序直达配置的常用服务中带有门店信息时，可添加简称触发词

示例值:

简称触发词

box_desc

string

可选

品牌介绍，5-15个中文字符。小程序直达不支持设置此项

示例值:

品牌介绍

brand_id

string

可选

品牌id，参考品牌认证说明

示例值:

1000467882

business_benefit_switch

boolean

可选

可通过配置来开启商圈权益模块，关闭后搜索直达不展示商圈权益模块

示例值:

true

image_id

string

可选

氛围图片id，调用支付宝文件上传接口上传图片获取图片id(bizCode：search_box_atmosphere)。图片规范小程序直达不支持设置此项。

示例值:

A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ

image_name

string

可选

氛围图片名。小程序直达不支持设置此项

示例值:

氛围图1

merchant_id

string

可选

商户id，代运营模式下传入。代运营模式，需要服务商已获得商家"运营支付宝小程序"授权。

示例值:

2088xxxxxxxxxxxx

related_accounts

array[object (SearchBoxAppInfo) {3}]

可选

关联账号信息，1-2个。内部字段均需设置。

app_name

string

应用名称

可选

app_type

string

可选

应用类型，TINY_APP-小程序/PUBLIC_APP-生活号

relate_appid

string

应用ID

可选

service_infos

array[object (SearchBoxServiceInfo) {4}]

可选

服务信息，服务必须审核通过才能申请搜索直达。内部字段均需设置。

service_category_code

string

服务类目编码

可选

service_category_name

string

服务类目名称

可选

service_code

string

服务编码

可选

service_name

string

服务名称

可选

target_appid

string

可选

小程序id，小程序直达时必传，需要和申请的商户主体保持一致，且符合准入类目

示例值:

2018092561XXXXXX

business_district_ids

array[string]

可选

小程序已关联商圈时，可添加商圈id（目前仅对品牌直达开放，小程序直达暂未开放）

示例值:

["商圈id"]

custom_keywords

array[string]

可选

自定义触发词，最多可配置6个，限1-8个中文字符。小程序直达不支持设置此项

示例值:

["自定义触发词"]

示例

返回响应

🟢200common response

application/json

Body

access

boolean

可选

是否准入，false代表不准入

示例值:

true

not_pass_items

array[string]

可选

不准入项列表。不准入项用字符串描述，可参照接口文档和准入条件，进行调整以达到申请要求

示例值:

["小程序未设置搜索可见"]

🔴500请求失败

修改于 2023-11-21 03:54:20

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

申请创建搜索直达配置