# 到餐API-商家列表接口

# 1. 概述

到餐API，实时查询商家列表。

# 2. 接口基本信息

名称	描述
请求方式	POST
调用地址	测试环境：https://waimai-openapi.apigw.test.meituan.com/api/sqt/open/supply/daocan/v1/queryRealTimePoiList 正式环境：https://bep-openapi.meituan.com/api/sqt/open/supply/daocan/v1/queryRealTimePoiList
调用方	第三方渠道
响应方	美团商企通
响应超时时间	5秒
调用方式	测试环境：https://waimai-openapi.apigw.test.meituan.com/api/sqt/open/supply/daocan/v1/queryRealTimePoiList?accessKey=SAQED&content=DFEDF 正式环境：https://bep-openapi.meituan.com/api/sqt/open/supply/daocan/v1queryRealTimePoiList?accessKey=SAQED&content=DFEDF

# 2.1 请求体

序号	字段名	字段类型	是否必填	示例	字段说明
1	accessKey	String	是		商企通分配给客户的接入密钥
2	content	String	是	UgxoCGPQIzoP	请求体内容，将请求参数JSON序列化后进行加密的结果值，参照：签名示例

content加密前数据结构

名称	类型	是否必填	示例	说明
ts	Long	是	1617085650321	13位时间戳。若请求发起时间与平台接受请求时间相差大于10分钟，平台将直接拒绝本次请求
entId	Long	是	46574	企业ID
gbCityId	String	是	"110114"	国标城市ID
keyWord	String	是	"火锅"	查询关键字
serviceTag	List<String>	否	["010110","010120"] 详见serviceTag定义	服务类型包含：买单、团购、订座，多个值表示：包含命中任意一项服务就会返回
averagePrice	Object	否	见averagePrice定义	人均价
sortType	String	否	"smart"	排序规则，单选，详细sortType见枚举定义
longitude	String	是	"116.42010122997081"	经度，必传，是GCJ02标准
latitude	String	是	"40.061998675107965"	纬度，必传，是GCJ02标准
pageNum	Integer	是	1	分页参数，当前页，1开始
pageSize	Integer	否	20	每页查询数量，最大支持数量为20；如果不传则默认查询20条
uuid	String	是	"123HGS"	用户设备uuid
staffIdentification	String	是	""	员工唯一标识（员工号/手机号/邮箱）
sceneType	Integer	是	见sceneType定义	场景类型

averagePrice字段说明

名称	类型	是否非空	示例	说明	注意
minPrice	Integer	否	0	最低价，应满足 > 0 且 < 最高价，需要为10的倍数；	人均价价格范围仅可精确指定0～200；如果需要查询200以上的餐厅，则以210代替
maxPrice	Integer	否	200	最高价，应满足 > 0 且 > 最低价，需要为10的倍数；	人均价价格范围仅可精确指定0～200；如果需要查询200以上的餐厅，则以210代替

serviceTag字段说明

key	value
"010110"	团购
"010120"	买单
"010130"	扫一扫
"010140"	付款码
"010160"	预定

sortType字段说明

key	value
smart	智能排序
distance	距离优先
rating	好评优先
price	低价优先
priceDesc	高价优先

sceneType字段说明

key	value
1	商务宴请
3	商务差旅
4	工作餐
5	团建用餐
8	员工福利
9	供给分销

# 2.2 响应参数

名称	类型	是否必填	示例	说明
traceId	String	是	56a0af18ae30a168d4006c7c	日志查询ID，用于排查问题，最好将此字段记录在日志中
status	Integer	是	0	接口响应编码，编码枚举值和解决方案详见第四章错误码
msg	String	否		错误描述信息
data	String	是	UgxoCGPQIzoP	响应数据，将响应参数JSON序列化后进行加密的结果值，解密密钥使用secretKey参数

data解密后数据结构

名称	类型	是否非空	示例	说明
poiList	List<Poi>	否	见Poi	商家列表
pageNum	Integer	否	1	当前页
hasNext	Boolean	否	false	是否有下一页

Poi字段说明

名称	类型	是否非空	示例	说明
poiId	String	否	"122211"	美团商家id
poiName	String	否	"**火锅"	门店名称
categoryName	String	否	"四川美食"	品类描述
headPicUrl	String	否		门店图片
starGrade	String	否	"4.5"	星级（0~5，一位小数点）
averagePrice	String	否	"45"	人均消费价格
serviceTag	List<String>	否	["010110","010120"] 详见serviceTag定义	当前商家支持的服务类型
poiDetailInfo	String	否	"{\"mtPoiId\":\"12345\"}"	跳转门店详情时，透传给免登接口的信息。

# 3. 示例

# 3.1. 请求示例

# 3.1.1. 请求示例

{
  "accessKey":"B3KSWLDSKSKDMJ",
  "content":"UgxoCGPQIzoP"
}

# 3.1.2. 请求参数content解析

{
    "ts":123123,
    "entId":100746,
    "gbCityId":"320600",
    "keyword":"火锅",
    "serviceTag":[
        "010110",
        "010120"
    ],
    "averagePrice":{
        "minPrice":20,
        "maxPrice":200
    },
    "sortType":"smart",
    "longitude":"116.42010122997081",
    "latitude":"40.061998675107965",
    "pageNum":1,
    "pageSize":20,
    "uuid":"QWERTYF234",
    "staffIdentification":"123",
    "sceneType":1
}

# 3.2. 响应示例

# 3.2.1. 响应结果

{
    "traceId":"56a0af18ae30a168d4006c7c",
    "status":0,
    "data":"UgJn07uNgW7S7fJK0R0xVbaLxoCGPQIzoP"
}

# 3.2.2. 响应参数data解析

{
    "pageNum":1,
    "hasNext":false,
    "poiList":[
        {
            "poiId":"1646244",
            "poiName":"丽江庭院之爱在路上西单店",
            "categoryName":"云南火锅",
            "headPicUrl":"https://qcloud.dpfile.com/pc/BBDGC1S39IVTJHKMYH4ix2xQPM_bpY2zKTdRA1_t3JLR7Vgtxuf-v_GOtsJd4pCADxEm9rfL2yd5nyBLcd65sg.jpg",
            "starGrade":"4.5",
            "averagePrice":"159",
            "serviceTag":[
                "010110",
                "010120"
            ],
            "poiDetailInfo":"{\"mtPoiId\":\"1646244\"}"
        },
        {
            "poiId":"533615",
            "poiName":"羊大爷涮肉",
            "categoryName":"老北京火锅",
            "headPicUrl":"https://qcloud.dpfile.com/pc/qiqvTv1SnmZC-9WEvXFo5MPoFLRQaGEyvKOB0Odt801KTT7DfA2TTIP91vsaqA3xDxEm9rfL2yd5nyBLcd65sg.jpg",
            "starGrade":"4.0",
            "averagePrice":"105",
            "serviceTag":[
                "010110",
                "010120"
            ],
            "poiDetailInfo":"{\"mtPoiId\":\"533615\"}"
        }
    ]
}

# 4. 错误码

# 4.1. 公共错误码

错误码	错误描述	解决方案
10010002	企业已停止合作，请联系客户经理进行确认	将接口调用的entId参数给到客户经理，由客户经理确认企业状态是否在合作中
10010003	content不合法	详细阅读content参数加密说明（签名实例），确认content加密方式和content解密前传参是否正确
10010004	ts缺失或ts时间已过期	确认ts是否传值并为13位时间戳，如果正确传值，则确认请求发起时间与美团商企通接受请求的时间差是否超过10分钟
10010005	entId不能为空	entId参数不可为空，如果未拿到entId参数，可以咨询客户经理获取
20010001	accessKey不合法	检查accessKey是否为客户经理给到的值，如果accessKey值正确，确认调用环境是否和accessKey一致，如使用测试环境的accessKey调用线上的接口
20010002	请求path不合法	检查接口调用地址是否正确，如是否有非法字符
20010003	鉴权失败，无接口访问权限	将接口调用地址给到客户经理，由客户经理检查接口权限是否开通并保存成功
20010004	越权访问，无法访问该企业数据，请检查entId的正确性	检查accessKey和entId两个参数的对应关系是否正确
30010001	访问频率过高	请确认接口访问频率，每个接口默认调用限频为每分钟不超过100次，超出调用频率会调用此错误
30010002	访问次数超过配额	请确认接口的累计访问次数，每个接口的默认累计调用量为10w次，超出限额则会报错

# 4.2. 业务错误码

错误码	错误描述	解决方案
14001001	参数错误	请检查传入参数
14001002	内部服务错误	根据错误原因，排查是否为内部问题；如果不为内部问题，则联系美团RD排查
14001003	获取用户信息失败，请重新登录	需要请求免登接口
14001004	员工信息不存在，请联系企业管理员	员工信息不存在，请联系企业管理员

# 5. 版本记录

版本号	版本日期	更新内容
v1.0	2023-03-14	新增到餐API商家列表查询接口

← 合规详情查询对接说明 →