门店接口文档

查询门店

POST

范围规则：如果 account 是总部账号，返回总部和全部子门店；如果 account 是子门店或独立门店账号，则只返回该门店。

权限规则：调用方 appId 必须对请求体 account 有访问权限；总部 appId 可传总部或子门店账号，子门店/独立门店 appId 只能传自己的账号。

请求参数

参数	类型	必填	说明
account	string	是	查询范围账号。传总部账号返回总部及全部子门店；传子门店或独立门店账号只返回该门店。
userId	long	否	门店 ID 精确过滤。传哪家门店的userId,就只返回该门店的数据
needAddressInfo	boolean	否	是否返回门店地址扩展信息，包含国家、省、市、区/县、详细地址、纬度、经度。传 true 时额外消耗 20 token。
lastId	long	否	分页游标。首次传 0 或不传；后续传上一次响应中的 nextLastId。
order	string	否	排序方向，仅支持 asc、desc，默认 asc。
limit	int	否	分页大小，默认 100，最大 100。

业务说明

• 固定消耗 100 token。
• 传 needAddressInfo=true 时额外消耗 20 token。
• 分页按 user.id 主键游标推进，避免总部客户一次性拉取几千家门店带来的压力。
• 响应中的 self 用于标识当前调用身份对应的门店记录。

请求示例

{
  "account": "store001",
  "userId": 10001,
  "needAddressInfo": true,
  "lastId": 0,
  "order": "asc",
  "limit": 100
}

返回示例

{
  "status": "success",
  "errorCode": 0,
  "result": {
    "list": [
      {
        "userId": "10001",
        "account": "hq001",
        "number": "S001",
        "email": "demo@example.com",
        "address": "上海市浦东新区示例路 100 号",
        "tel": "13800138000",
        "company": "示例连锁有限公司",
        "industry": "餐饮",
        "secondIndustry": "奶茶",
        "country": "中国",
        "province": "上海市",
        "city": "上海市",
        "district": "浦东新区",
        "detailAddress": "示例路 100 号",
        "latitude": 31.230416,
        "longitude": 121.473701,
        "createdDatetime": "2026-04-01 10:00:00",
        "enable": 1,
        "self": true
      }
    ],
    "hasMore": false,
    "nextLastId": "10001"
  }
}

返回字段说明

status、errorCode 及分页公共字段请参考《公共响应格式》，此处仅补充 result.list[] 字段。

字段	类型	说明
userId	string	门店 ID。
account	string	门店账号。
number	string	门店编号。
email	string	邮箱地址。
address	string	联系地址。
tel	string	联系电话。
company	string	公司名称。
industry	string	一级行业。
secondIndustry	string	二级行业。
country	string	国家，仅 needAddressInfo=true 时返回。
province	string	省份，仅 needAddressInfo=true 时返回。
city	string	城市，仅 needAddressInfo=true 时返回。
district	string	区/县，仅 needAddressInfo=true 时返回。
detailAddress	string	详细地址，仅 needAddressInfo=true 时返回。
latitude	decimal	纬度，仅 needAddressInfo=true 时返回。
longitude	decimal	经度，仅 needAddressInfo=true 时返回。
createdDatetime	string	门店创建时间。
enable	int	启用状态。
self	boolean	是否当前调用身份对应的门店。