API Doc

# 1. 餐厅列表查询接口

# 简要描述

  • 根据appId查询该开发者账户下的所有餐厅信息，包括餐厅编号、三方门店标识、餐厅推送URL和餐厅显示名称

# HTTP请求信息

# 请求方式

  • POST

# 请求地址

{domain}/open-api/merchant/restaurant/list

# 请求头

参数名 必选 类型 说明
Content-Type 是 string application/json

# 请求体参数

参数名 必选 类型 长度限制 示例 说明
param 是 string - {} 参数体
sign 是 string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 签名
appId 是 string - - APPID

# 请求体示例

{
  "appId": "123456",
  "sign": "abcdef",
  "param": "{}"
}

# 返回示例

# code 参考此列表

# 响应参数

参数名 类型 示例 说明
code int 10000 状态码 参考列表
message string success 状态码信息
data Object - 餐厅列表数据

# data参数说明

参数名 必选 类型 长度限制 示例 说明
pushUrl 是 string - https://example.com/webhook 餐厅推送URL
list 是 list - - 餐厅列表

# list参数说明

参数名 必选 类型 长度限制 示例 说明
storeKey 是 string - - 餐厅key
restaurantNo 是 string - REST123456 餐厅编号
branchIdentifier 是 string - BRANCH001 三方门店标识
restaurantName 是 string - Swifood Restaurant 餐厅名称
displayName 是 string - 美食餐厅 餐厅显示名称

# 成功响应示例

{
  "code": 10000,
  "message": "success",
  "data": {
    "pushUrl": "https://example.com/webhook",
    "list": [
      {
        "storeKey": "12332",
        "restaurantNo": "REST123456",
        "branchIdentifier": "BRANCH001",
        "restaurantName": "Swifood Restaurant",
        "displayName": "美食餐厅"
      },
      {
        "storeKey": "12333",
        "restaurantNo": "REST789012",
        "branchIdentifier": "BRANCH002",
        "restaurantName": "Snack Shop",
        "displayName": "小食馆"
      }
    ]
  }
}

# 失败响应示例

{
  "code": 21000,
  "message": "Service error, please contact administrator",
  "data": null
}

# 注意事项

  1. 身份验证：接口会自动验证appId和sign的有效性，验证失败将返回相应错误码
  2. 数据来源：返回的pushUrl是开发者账户级别的配置，该开发者下的所有餐厅共享同一个pushUrl
  3. 空结果处理：如果appId下没有关联的餐厅，data.list将返回空数组 []
  4. 数据完整性：返回的餐厅信息均为已激活并正常运营的餐厅，不包含已删除或停用的餐厅
  5. 调用频率：建议商户缓存查询结果，避免频繁调用本接口

←