文档中心 > API类目 > 数据服务API

alipay.offline.provider.dish.query (口碑菜品热度查询)

口碑菜品热度分页查询,并根据热度升降序

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.offline.provider.dish.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 256 商户请求参数的签名串,详见签名 详见示例
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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
shop_id String 必须 200 口碑店铺id,商户订购开发者服务插件后,口碑会通过服务市场管理推送订购信息给开发者,开发者可通过其中的订购插件订单明细查询获取此参数值,或通过商户授权口碑开店接口来获取。 2016062900077000000016003316
outer_dish_id String 可选 200 ISV自己的菜品ID,数据的计算根据:alipay.offline.provider.shopaction.record接口中插入菜品与alipay.offline.provider.useraction.record上传用户点菜菜单作为元数据,通过分析得到的数据。当前的ID就是插入菜品中的outerDishId,同时也是上传用户点菜中的action_type是order_dishes里面的dish对象的goodsId 200
dish_type_name String 可选 200 数据是根据alipay.offline.provider.shopaction.record的插入菜品接口获取,对应字段是:dishTypeName。 中餐
order_by String 可选 16 order_by:1,菜品热度升序查询,order_by:2,菜品热度降序查询。不设置时默认为2(菜品热度降序查询) 1
page Number 可选 32 需要查询的第几页信息。非必填。默认为1 1
page_size Number 可选 32 分页查询每页的条数,默认为20条,每次最大拉去条数100,超过限制直接返回错误 20

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
list IsvShopDishModel [] 选填 - 菜品列表信息
  • └ shop_id
  • String
  • 选填
  • 200
  • 口碑店铺id,商户订购开发者服务插件后,口碑会通过服务市场管理推送订购信息给开发者,开发者可通过其中的订购插件订单明细查询获取此参数值,或通过商户授权口碑开店接口来获取。
  • 2016062900077000000016003316
  • └ platform
  • String
  • 选填
  • 256
  • 当前值来自于alipay.offline.provider.shopaction.record中的outer_shop_do对象里面的 type字段。
  • mike
  • └ outer_dish_id
  • String
  • 选填
  • 200
  • ISV自己的菜品ID,数据的计算根据:alipay.offline.provider.shopaction.record接口中插入菜品与alipay.offline.provider.useraction.record上传用户点菜菜单作为元数据,通过分析得到的数据。当前的ID就是插入菜品中的outerDishId,同时也是上传用户点菜中的action_type是order_dishes里面的dish对象的goodsId
  • 123
  • └ name
  • String
  • 选填
  • 256
  • alipay.offline.provider.shopaction.record回传点菜中的name
  • 菜品名称
  • └ price
  • Price
  • 选填
  • 32
  • alipay.offline.provider.shopaction.record回传点菜中的price,建议ISV在拿到推荐的菜品的ID后,直接使用自己的菜品元数据,口碑元数据是ISV上传,实时性无法保证。
  • 11
  • └ quantity
  • Number
  • 选填
  • 32
  • 菜品库存。
    alipay.offline.provider.shopaction.record回传点菜中的quantity,建议ISV在拿到推荐的菜品的ID后,直接使用自己的菜品元数据,口碑元数据是ISV上传,实时性无法保证。
  • 10
  • └ pict
  • String
  • 选填
  • 256
  • 废弃,请ISV使用自己的图
  • path,path2
  • └ content
  • String
  • 选填
  • 256
  • 菜品库存。 alipay.offline.provider.shopaction.record回传点菜中的desc。建议ISV在拿到推荐的菜品的ID后,直接使用自己的菜品元数据,口碑元数据是ISV上传,实时性无法保证。
  • XX菜很美观
  • └ sort_col
  • Number []
  • 选填
  • 32
  • 排序值。 alipay.offline.provider.shopaction.record回传点菜中的sort。建议ISV在拿到推荐的菜品的ID后,直接使用自己的菜品元数据,口碑元数据是ISV上传,实时性无法保证。
  • 10
  • └ unit
  • String
  • 选填
  • 256
  • 菜品显示的单位(份/斤/杯) alipay.offline.provider.shopaction.record回传点菜中的unit,建议ISV在拿到推荐的菜品的ID后,直接使用自己的菜品元数据,口碑元数据是ISV上传,实时性无法保证。
  • └ dish_type_id
  • String
  • 选填
  • 200
  • 菜品分类ID
    alipay.offline.provider.shopaction.record回传点菜中的dishTypeID,建议ISV在拿到推荐的菜品的ID后,直接使用自己的菜品元数据,口碑元数据是ISV上传,实时性无法保证。
  • 123
  • └ dish_type_name
  • String
  • 选填
  • 200
  • 商家定义菜品的分类名称 alipay.offline.provider.shopaction.record回传点菜中的dishTypeName,建议ISV在拿到推荐的菜品的ID后,直接使用自己的菜品元数据,口碑元数据是ISV上传,实时性无法保证。
  • 商家分类名称
  • └ sold_cnt_seven_d
  • Number
  • 选填
  • 32
  • 当前店铺最近7天销量(份)
  • 123
  • └ sold_cnt_thirty_d
  • Number
  • 选填
  • 32
  • 当前店铺最近30天销量(份)
  • 123
  • └ sold_usercnt_thirty_d
  • Number
  • 选填
  • 32
  • 当前店铺最近30天消费支付宝用户数
  • 123
  • └ sold_reusercnt_thirty_d
  • Number
  • 选填
  • 32
  • 当前店铺最近30天购买2次及以上的支付宝用户数
  • 123
  • └ merchant_sold_cnt_seven_d
  • Number
  • 选填
  • 32
  • 当前店铺的商家最近7天销量(份)
  • 123
  • └ merchant_sold_cnt_thirty_d
  • Number
  • 选填
  • 32
  • 当前店铺的商家最近30天销量(份)
  • 123
  • └ merchant_sold_usercnt_thirty_d
  • Number
  • 选填
  • 32
  • 当前店铺的商家最近30天消费支付宝用户数
  • 123
  • └ merchant_sold_reusercnt_thirty_d
  • Number
  • 选填
  • 32
  • 当前店铺的商家最近30天购买2次及以上的支付宝用户数
  • 123
  • └ good_level
  • String
  • 选填
  • 32
  • 菜品热度等级(0/0.5/1/1.5/2/2.5/3/3.5/4/4.5/5)该字段是对sort_col做离散化,数字越大越热
  • 3.5
items Number 选填 32 总共有多少条菜品信息。可用于计算分页。 123
page Number 选填 32 当前数据所在的页码数 1
pages Number 选填 32 当前条件下查询结果总的页码数 5
page_size Number 选填 32 当前查询结果分页的条数,可用于计算分页 20

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOfflineProviderDishQueryRequest request = new AlipayOfflineProviderDishQueryRequest();
request.setBizContent("{" +
"\"shop_id\":\"2016062900077000000016003316\"," +
"\"outer_dish_id\":\"200\"," +
"\"dish_type_name\":\"中餐\"," +
"\"order_by\":\"1\"," +
"\"page\":1," +
"\"page_size\":20" +
"  }");
AlipayOfflineProviderDishQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_offline_provider_dish_query_response":{
		"msg":"Success",
		"code":"10000",
		"pages":5,
		"page":1,
		"list":[
			{
				"dish_type_name":"商家分类名称",
				"quantity":10,
				"dish_type_id":"123",
				"sold_cnt_seven_d":123,
				"good_level":"3.5",
				"sort_col":[
					10
				],
				"sold_reusercnt_thirty_d":123,
				"merchant_sold_usercnt_thirty_d":123,
				"platform":"mike",
				"content":"XX菜很美观",
				"sold_usercnt_thirty_d":123,
				"merchant_sold_cnt_seven_d":123,
				"shop_id":"2016062900077000000016003316",
				"merchant_sold_cnt_thirty_d":123,
				"unit":"份",
				"price":11,
				"sold_cnt_thirty_d":123,
				"name":"菜品名称",
				"outer_dish_id":"123",
				"merchant_sold_reusercnt_thirty_d":123,
				"pict":"path,path2"
			}
		],
		"items":123,
		"page_size":20
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

  • JSON示例
{
	"alipay_offline_provider_dish_query_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

错误码 错误描述 解决方案
SYSTEM_ERROR 系统繁忙 重试
INVALID_PARAMETER 参数有误。 检查参数

公共错误码

返回
顶部