文档中心 > API类目 > 子账号管理API

taobao.subusers.subaccount.search (根据子账号登录名后缀模糊搜索子账号列表)

根据子账号冒号后缀搜索子账号列表,支持中文单字、英文单词(不支持英文单字母) 分词规则搜索,该搜索词必传。模糊搜索使用阿里云搜索引擎所以该接口增值收费,如果不需要模糊搜索仅需要分页获取子账号列表,请使用taobao.sellercenter.subusers.page接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
main_nick String 必须 XXX旗舰店账号 主账号登录名
filter_key String 必须 小三 根据子账号冒号后缀的搜索词,支持中文单字、英文单词 分词规则搜索。该搜索词必传。如果不需要模糊搜索仅需要分页获取子账号列表,请使用taobao.sellercenter.subusers.page接口
page_size Number 必须 100
  • 默认值:20
  • 页大小,大于1小于200
    page_num Number 必须 1
  • 默认值:1
  • 页码,大于等于1

    响应参数

    名称 类型 示例值 描述
    subaccounts SubAccountInfo [] 子账号列表
    • └ sub_id
    • Number
    • 24531541
    • 子账号id
    • └ status
    • Number
    • 1
    • 子账号状态, 1正常 2冻结 3处罚
    • └ seller_id
    • String
    • 213453245
    • 主账号id
    • └ sub_nick
    • String
    • zhangsan:no1
    • 子账号登录名
    page_size Number 100 isv本次调用传入的页大小
    total_count Number 23 本次调用删选条件下的总子账号数量,除以页大小可得出最大页数
    page_num Number 1 isv本次调用传入的页码

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    SubusersSubaccountSearchRequest req = new SubusersSubaccountSearchRequest();
    req.setMainNick("XXX旗舰店账号");
    req.setFilterKey("小三");
    req.setPageSize(100L);
    req.setPageNum(1L);
    SubusersSubaccountSearchResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <subusers_subaccount_search_response>
        <subaccounts>
            <sub_account_info>
                <sub_id>24531541</sub_id>
                <status>1</status>
                <seller_id>213453245</seller_id>
                <sub_nick>zhangsan:no1</sub_nick>
            </sub_account_info>
        </subaccounts>
        <page_size>100</page_size>
        <total_count>23</total_count>
        <page_num>1</page_num>
    </subusers_subaccount_search_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部