扫码点餐场景,可以在用户点餐前向用户推荐菜品,也可以在用户点餐下单时,根据用户点餐情况,推荐可能喜欢的菜品,提升客单价
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | koubei.catering.dish.recommend.query |
format | String | 否 | 40 | 仅支持JSON | JSON |
charset | String | 是 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
sign_type | String | 是 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
sign | String | 是 | 344 | 商户请求参数的签名串,详见签名 | 详见示例 |
timestamp | String | 是 | 19 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
version | String | 是 | 3 | 调用的接口版本,固定为:1.0 | 1.0 |
app_auth_token | String | 否 | 40 | 详见应用授权概述 | |
biz_content | String | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
merchent_pid | String | 必须 | 64 | 点餐门店所属的商家PID | 商家PID |
shop_id | String | 必须 | 64 | 点餐的门店ID | 点餐门店ID |
user_id | String | 必须 | 64 | 用户ID | 2088xxxxxx |
dish_id | String | 可选 | 64 | 【已废弃】用户已点的主菜品ID,传入时作为推荐菜品参考。 | 2344XXJ |
type | String | 可选 | 64 | QUICK_ORDER:一键下单
DESIGN_FOR_YOU:为你定制 ASSOCIATION_RECOMAND:关联推荐 CART_RECOMAND:购物车菜品推荐 type为空默认设置为:DESIGN_FOR_YOU(为你定制) |
QUICK_ORDER |
people | String | 特殊可选 | 64 | 用餐人数(当type=QUICK_ORDER时,该字段必填) | 3 |
per_price | String | 可选 | 64 | 门店客单价(单位分) | 6500 |
dish_list | Dishes [] | 可选 | - | 当dish_list[]不为空的时候,dish_id是必填字段。
若type=QUICK_ORDER or DESIGN_FOR_YOU;则 dish_list内容为空。 若type=ASSOCIATION_RECOMAND;则dish_List为关联推荐的主菜品; 若type=CART_RECOMAND;则dish_list为购物车的已点菜品。 |
|
|
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 是 | - | 网关返回码,详见文档 | 40004 |
msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 否 | - | 业务返回码,详见文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 否 | - | 业务返回码描述,详见文档 | 交易已被支付 |
sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
dish_list | DishRecommend [] | 选填 | - | 推荐菜品列表 | |
|
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2"); KoubeiCateringDishRecommendQueryRequest request = new KoubeiCateringDishRecommendQueryRequest(); request.setBizContent("{" + "\"merchent_pid\":\"商家PID\"," + "\"shop_id\":\"点餐门店ID\"," + "\"user_id\":\"2088xxxxxx\"," + "\"dish_id\":\"2344XXJ\"," + "\"type\":\"QUICK_ORDER\"," + "\"people\":\"3\"," + "\"per_price\":\"6500\"," + " \"dish_list\":[{" + " \"dish_id\":\"2344***\"," + "\"dish_skuid\":\"菜品规格ID\"," + "\"dish_name\":\"鱼香肉丝\"," + "\"dish_price\":\"1800\"," + "\"dish_real_price\":\"1600\"," + "\"dish_num\":\"1\"" + " }]" + " }"); KoubeiCateringDishRecommendQueryResponse response = alipayClient.execute(request); if(response.isSuccess()){ System.out.println("调用成功"); } else { System.out.println("调用失败"); }
{ "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE", "koubei_catering_dish_recommend_query_response":{ "msg":"Success", "code":"10000", "dish_list":[ { "dish_id":"45688xxxxJ", "buy_posibility":"0.23", "dish_num":"菜品的个数", "dish_skuid":"菜品规格ID", "dish_name":"鱼香肉丝", "info_code":"推荐理由" } ] } }
{ "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE", "koubei_catering_dish_recommend_query_response":{ "msg":"Service Currently Unavailable", "code":"20000", "sub_msg":"系统繁忙", "sub_code":"isp.unknow-error" } }
错误码 | 错误描述 | 解决方案 |
---|---|---|
SYSTEM_ERROR | 系统繁忙 | 重试或联系技术支持,参考链接:http://support.open.alipay.com/alipay/support/index.htm |
INVALID_PARAMETER | 参数有误 | 检查参数或按照错误码描述修改校验不通过的参数 |
NO_RECOMMENDATION | 业务异常无推荐菜品 | 业务异常无推荐菜品,请检查该商家门店是否有菜品和点餐订单信息回传或联系口碑技术支持 |