门店列表查询API

拥有此API的权限集
门店管理-查询

请求方式及url

  • 请求方式：POST
  • 请求头：Content-Type:application/json
  • 接口地址：https://api.xiaoe-tech.com/xe.drp.cloud.distribute_team_list/1.0.0
  • 频率限制：10秒10次

在线调试工具

请求

响应

请求参数

参数名 必选 类型 说明
access_token 是 string 专属token
search_type 否 int 搜索类型，配合search字段使用(1:门店名称模糊匹配，2:门店队长昵称模糊匹配，3:门店ID精确匹配，4:门店队长用户ID精确匹配，5:门店队员昵称模糊匹配，6:门店队员ID精确匹配)
search 否 string 搜索值，配合search_type使用
group_ids 否 array[int] 分组ID
team_state 是 int 门店状态，默认值为-1(0:正常，1:解散，-1:不根据此条件筛选)
team_ids 否 array[string] 门店Id列表
hide_phone 否 bool 返回数据是否对手机号脱敏
page_index 是 string 页码
page_size 是 string 页容量

请求示例

{  
    "access_token":"xe_xxxxx",
    "search_type":1,
    "search":"",
    "group_ids":[],
    "team_state": -1,
    "team_ids":[],
    "page_index":1,
    "page_size":10
}

返回参数

参数名 必选 类型 说明
code 是 int 状态码（0表示成功）
msg 是 string 消息描述（"ok"表示成功）
data 是 object 响应数据对象
data.list 是 array 门店数据列表
data.list[].serial_number 是 int 序号
data.list[].team_id 是 string 门店唯一ID
data.list[].team_name 是 string 门店名称
data.list[].team_captain_id 是 string 门店队长ID
data.list[].team_captain_name 是 string 队长真实姓名
data.list[].team_captain_nickname 是 string 队长昵称
data.list[].team_captain_avatar 是 string 队长头像URL
data.list[].team_captain_phone 是 string 队长手机号
data.list[].team_state 是 int 门店状态，0:正常，1:解散
data.list[].team_created_at 是 string 门店创建时间（格式：YYYY-MM-DD HH:mm:ss）
data.list[].team_pickup_id 否 string 门店自提点ID
data.list[].team_captain_group_name 是 string 队长所属分组名称
data.list[].team_captain_group_id 是 int 队长所属分组ID
data.list[].team_order_count 是 int 门店订单总数
data.list[].team_order_price 是 int 门店成交金额
data.list[].team_customer_count 是 int 门店绑定客户总数
data.list[].team_user_count 是 int 门店成员总数
data.list[].pickup_detail 否 object 自提点详细信息
data.list[].pickup_detail.app_id 否 string 店铺ID
data.list[].pickup_detail.place_id 否 int 自提点ID
data.list[].pickup_detail.place_name 否 string 自提点名称
data.list[].pickup_detail.place_type 否 int 自提点类型
data.list[].pickup_detail.nation_code 否 string 国际区号
data.list[].pickup_detail.place_phone 否 string 自提点联系电话
data.list[].pickup_detail.province 否 string 省份信息
data.list[].pickup_detail.city 否 string 城市信息
data.list[].pickup_detail.county 否 string 区县信息
data.list[].pickup_detail.detail 否 string 详细地址
data.list[].pickup_address 否 string 自提点地址
data.list[].pickup_phone 否 string 自提点联系电话
data.list[].team_state_name 是 string 门店状态
data.list[].merge_team_state 是 int 合并门店状态
data.list[].manager_user_id 是 string 门店负责人id
data.list[].manager_wx_nickname 是 string 门店负责人昵称
data.list[].manager_wx_avatar 是 string 门店负责人头像
data.list[].region_id 是 int 区域id
data.list[].region_name 是 int 区域运营者名称
data.list[].total_balance 是 int 门店总余额
data.list[].open_user_id 否 string 企未员工ID
data.list[].is_wework 是 int 是否是企业微信员工
data.total 是 int 数据总条数

备注

  • code=0时，msg:
  • code!=0时，msg:拉取数据错误

返回示例

{
    "code": 0,
    "msg": "ok",
    "data": {
        "list": [
            {
                "serial_number": 0,
                "team_id": "dt_xxxx",
                "team_name": "克里斯的店",
                "team_captain_id": "u_xxxx",
                "team_captain_name": "xxxx",
                "team_captain_nickname": "xxxx",
                "team_captain_avatar": "https://xxxx.jpg",
                "team_captain_phone": "136****3300",
                "team_state": 0,
                "team_created_at": "2025-04-22 16:22:41",
                "team_pickup_id": "",
                "team_captain_group_name": "默认分组",
                "team_captain_group_id": 1179,
                "team_order_count": 0,
                "team_order_price": 0,
                "team_customer_count": 0,
                "team_user_count": 2,
                "pickup_detail": {
                    "app_id": "",
                    "place_id": 0,
                    "place_name": "",
                    "place_type": 0,
                    "nation_code": "",
                    "place_phone": "",
                    "province": "",
                    "city": "",
                    "county": "",
                    "detail": "",
                    "operating_cycle": null,
                    "business_hours": null
                },
                "pickup_address": "",
                "pickup_phone": "",
                "team_state_name": "运营中",
                "merge_team_state": 0,
                "region_id":0,
                "region_name":"",
                "total_balance": 0,
                "open_user_id": "",
                "is_wework": 0
            }
        ],
        "total": 1
    }
}

results matching ""

    No results matching ""