文档中心 > API类目 > 淘宝物流API

taobao.logistics.companies.get (查询物流公司信息)

查询淘宝网合作的物流公司信息,用于发货接口。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
fields String [] 必须 id,code,name,reg_mail_no
  • 最大列表长度:20
  • 需返回的字段列表。可选值:LogisticCompany 结构中的所有字段;多个字段间用","逗号隔开. 如:id,code,name,reg_mail_no
    说明:
    id:物流公司ID
    code:物流公司code
    name:物流公司名称
    reg_mail_no:物流公司对应的运单规则
    is_recommended Boolean 可选 true 是否查询推荐物流公司.可选值:true,false.如果不提供此参数,将会返回所有支持电话联系的物流公司.
    order_mode String 可选 offline 推荐物流公司的下单方式.可选值:offline(电话联系/自己联系),online(在线下单),all(即电话联系又在线下单). 此参数仅仅用于is_recommended 为ture时。就是说对于推荐物流公司才可用.如果不选择此参数将会返回推荐物流中支持电话联系的物流公司.

    响应参数

    名称 类型 示例值 描述
    logistics_companies LogisticsCompany [] 物流公司信息。返回的LogisticCompany包含的具体信息为入参fields请求的字段信息。
    • └ id
    • Number
    • 44555
    • 物流公司标识
    • └ code
    • String
    • AB15555
    • 物流公司代码
    • └ name
    • String
    • pingpaiming
    • 物流公司简称
    • └ reg_mail_no
    • String
    • 运单号验证正则表达式

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    LogisticsCompaniesGetRequest req = new LogisticsCompaniesGetRequest();
    req.setFields("id,code,name,reg_mail_no");
    req.setIsRecommended(true);
    req.setOrderMode("offline");
    LogisticsCompaniesGetResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <logistics_companies_get_response>
        <logistics_companies>
            <logistics_company>
                <id>44555</id>
                <code>AB15555</code>
                <name>pingpaiming</name>
                <reg_mail_no></reg_mail_no>
            </logistics_company>
        </logistics_companies>
    </logistics_companies_get_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>

    错误码解释

    错误码 错误描述 解决方案
    isv.logistics-query-companies-service-error:S01 查询订单系统出现异常,请重试 如果长时间一直出现,请联系平台技术,并提供api请求的requestId

    API工具

    如何获得此API

    FAQ

    返回
    顶部