OPENAPI V3
登录控制台
首次登录赠送 10000 Token,可直接调试接口
充值、回调配置、调用日志、接口调试均在控制台完成

门店接口文档

本页专门展示门店接口,便于单独交付与维护;通用规则仍复用总览页内容。Long 型标识字段、分页游标等通用约定,请先参考总览页《对接说明》。

门店接口

查询门店

POST
/openapi/v3/user/page

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

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

请求参数

参数 类型 必填 说明
accountstring查询范围账号。传总部账号返回总部及全部子门店;传子门店或独立门店账号只返回该门店。
lastIdlong分页游标。首次传 0 或不传;后续传上一次响应中的 nextLastId
orderstring排序方向,仅支持 ascdesc,默认 asc
limitint分页大小,默认 100,最大 100

业务说明

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

请求示例

{
  "account": "store001",
  "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": "奶茶",
        "createdDatetime": "2026-04-01 10:00:00",
        "enable": 1,
        "self": true
      }
    ],
    "hasMore": false,
    "nextLastId": "10001"
  }
}

返回字段说明

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

字段 类型 说明
userIdstring门店 ID。
accountstring门店账号。
numberstring门店编号。
emailstring邮箱地址。
addressstring联系地址。
telstring联系电话。
companystring公司名称。
industrystring一级行业。
secondIndustrystring二级行业。
createdDatetimestring门店创建时间。
enableint启用状态。
selfboolean是否当前调用身份对应的门店。