cainiao.yima.marketing.merchant.list (查询商户列表)

查询商户列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user_id Number 必须 324234 企业账号id
execute_user_list ExecuteUserDTOList [] 必须
  • 最大列表长度:20
  • 用户列表
    • └ execute_user_id
    • Number
    • 可选
    • 234234
    • 用户id
    • └ execute_user_type
    • String
    • 可选
    • FWD
    • 账户类型服务度
    page_number Number 可选 1 页码
    page_size Number 可选 25 页大小
    personal_session String 必须 324ssds 个人session
    personal_user_id Number 必须 234234234 个人id

    响应参数

    名称 类型 示例值 描述
    data MarketingMerchantListDto data
    • └ current_page
    • Number
    • 当前页码,从1开始
    • └ has_more
    • Boolean
    • 是否还有数据
    • merchant_list
    • MarketingMerchantDto []
    • 自定义商家列表
    • └ address_code1_level
    • String
    • 1级地址编码
    • └ address_code2_level
    • String
    • 2级地址编码
    • └ address_code3_level
    • String
    • 3级地址编码
    • └ address_code4_level
    • String
    • 4级地址编码
    • └ address_detail
    • String
    • 详细地址
    • └ address_full_desc
    • String
    • 全部详细地址
    • └ contact_number
    • String
    • 联系电话
    • └ created_time
    • String
    • 创建事件
    • └ delivery_user_id
    • String
    • 小件员id
    • └ image_url
    • String
    • 商家图片url
    • └ last_month_total_order_count
    • String
    • 近一月单量
    • └ last_order_time
    • String
    • 最近下单时间
    • └ merchant_id
    • String
    • 商家id
    • └ name
    • String
    • 商家名称
    • └ qrcode_content
    • String
    • 二维码内容
    • └ total_order_count
    • String
    • 总下单量
    • └ address_desc4_level
    • String
    • 4级地址文案描述
    • └ address_desc3_level
    • String
    • 3级地址文案描述
    • └ address_desc2_level
    • String
    • 2级地址文案描述
    • └ address_desc1_level
    • String
    • 1级地址文案描述
    • └ next_page
    • Number
    • 下一页
    status_code String 2 statusCode
    status_message String statusMessage
    is_success Boolean false success

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    CainiaoYimaMarketingMerchantListRequest req = new CainiaoYimaMarketingMerchantListRequest();
    req.setUserId(324234L);
    List<CainiaoYimaMarketingMerchantListRequest.ExecuteUserDTOList> list2 = new ArrayList<CainiaoYimaMarketingMerchantListRequest.ExecuteUserDTOList>();
    CainiaoYimaMarketingMerchantListRequest.ExecuteUserDTOList obj3 = new CainiaoYimaMarketingMerchantListRequest.ExecuteUserDTOList();
    list2.add(obj3);
    obj3.setExecuteUserId(234234L);
    obj3.setExecuteUserType("FWD");
    req.setExecuteUserList(list2);
    req.setPageNumber(1L);
    req.setPageSize(25L);
    req.setPersonalSession("324ssds");
    req.setPersonalUserId(234234234L);
    CainiaoYimaMarketingMerchantListResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <cainiao_yima_marketing_merchant_list_response>
        <data>
            <current_page></current_page>
            <has_more></has_more>
            <merchant_list>
                <marketing_merchant_dto>
                    <address_code1_level></address_code1_level>
                    <address_code2_level></address_code2_level>
                    <address_code3_level></address_code3_level>
                    <address_code4_level></address_code4_level>
                    <address_detail></address_detail>
                    <address_full_desc></address_full_desc>
                    <contact_number></contact_number>
                    <created_time></created_time>
                    <delivery_user_id></delivery_user_id>
                    <image_url></image_url>
                    <last_month_total_order_count></last_month_total_order_count>
                    <last_order_time></last_order_time>
                    <merchant_id></merchant_id>
                    <name></name>
                    <qrcode_content></qrcode_content>
                    <total_order_count></total_order_count>
                    <address_desc4_level></address_desc4_level>
                    <address_desc3_level></address_desc3_level>
                    <address_desc2_level></address_desc2_level>
                    <address_desc1_level></address_desc1_level>
                </marketing_merchant_dto>
            </merchant_list>
            <next_page></next_page>
        </data>
        <status_code>2</status_code>
        <status_message></status_message>
        <is_success>false</is_success>
    </cainiao_yima_marketing_merchant_list_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

    返回
    顶部