通用场景
用于对搜索直达创建申请的入参和条件进行提前判断校验。
具体准入条件参考
具体准入条件参考
注意：
本咨询接口返回成功不代表创建搜索直达一定能成功，实际情况以创建接口结果为准
公共请求参数
业务请求参数
target_appid｜小程序id特殊可选string[1,16]
【描述】小程序id，小程序直达时必传，需要和申请的商户主体保持一致，且符合准入类目
【示例值】2018092561xxxxxx
brand_id｜品牌id可选string[1,32]
【描述】品牌id，参考品牌认证说明
【示例值】1000467882
service_infos｜服务信息列表可选array
【描述】服务信息，服务必须审核通过才能申请搜索直达。 内部字段均需设置。
service_code｜服务编码可选string[22,22]
【描述】服务编码
【示例值】2021012121000864802961
service_name｜服务名称可选string[1,12]
【描述】服务名称
【示例值】点餐
service_category_code｜服务类目编码可选string[1,12]
【描述】服务类目编码
【示例值】xs2075
service_category_name｜服务类目名称可选string[1,32]
【描述】服务类目名称
【示例值】点餐与排队
related_accounts｜关联账号信息可选array
【描述】关联账号信息，1-2个。 内部字段均需设置。
app_type｜应用类型可选string[1,12]
【描述】应用类型，tiny_app-小程序/public_app-生活号
【枚举值】
小程序: sp_mini_app
生活号: sp_public_app
【示例值】tiny_app
relate_appid｜小程序id可选string[16,16]
【描述】应用id
【示例值】2018061360108419
app_name｜小程序名称可选string[1,20]
【描述】应用名称
【示例值】小程序名称
custom_keywords｜自定义触发词可选array[1,6]
【描述】自定义触发词，最多可配置6个，限1-8个中文字符。
小程序直达不支持设置此项
【示例值】["自定义触发词"]
box_desc｜品牌介绍可选string[1,32]
【描述】品牌介绍，5-15个中文字符。
小程序直达不支持设置此项
【示例值】品牌介绍
image_id｜氛围图片id可选string[1,128]
【描述】氛围图片id，调用 上传图片获取图片id(bizcode：search_box_atmosphere)。
小程序直达不支持设置此项。
【示例值】a*ozqmt4xtbpuaaaaaaaaaaaaaaqaaaq
image_name｜氛围图片名可选string[1,64]
【描述】氛围图片名。
小程序直达不支持设置此项
【示例值】氛围图1
area_keywords｜简称触发词可选array[1,1]
【描述】小程序直达配置的常用服务中带有门店信息时，可添加简称触发词
【示例值】简称触发词
business_district_ids｜商圈id列表可选array[1,200]
【描述】小程序已关联商圈时，可添加商圈id（目前仅对品牌直达开放，小程序直达暂未开放）
【示例值】["商圈id"]
business_benefit_switch｜是否开启商圈权益模块可选boolean
【描述】可通过配置来开启商圈权益模块，关闭后搜索直达不展示商圈权益模块
【示例值】true
常见请求示例
品牌直达
小程序直达
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.search.box.consult&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'biz_content={
"brand_id":"1000467882",
"target_appid":"2018092561xxxxxx",
"service_infos":[
{
"service_code":"2021012121000864802961",
"service_name":"点餐",
"service_category_code":"xs2075",
"service_category_name":"点餐与排队"
}
],
"related_accounts":[
{
"app_type":"tiny_app",
"relate_appid":"2018061360108419",
"app_name":"小程序名称"
}
]
}' 说明：本示例仅供参考。
公共响应参数
业务响应参数
access｜是否准入必选boolean(5)
【描述】是否准入，false代表不准入
【示例值】true
not_pass_items｜不准入项列表可选string[](1024)
【描述】不准入项列表。不准入项用字符串描述，可参照接口文档和，进行调整以达到申请要求
【示例值】["小程序未设置搜索可见"]
响应示例
正常示例
异常示例
{
"alipay_open_search_box_consult_response": {
"code": "10000",
"msg": "success",
"access": true,
"not_pass_items": [
"小程序未设置搜索可见"
]
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}说明：本示例仅供参考。
公共错误码
业务错误码
| 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
|---|---|---|
| system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试 |
| input_argument_illegal | 输入参数非法 | 请参考接口文档检查参数是否正确 |
| isv_not_auth | 服务商未被商家授权 | 请找对应商家授权 |